Product Guide

The Clearion Web user guide outlines the application and its features to help users quickly adapt to working with the system.

This document describes the UVM V2 product.

Login to the application

1. When the user navigates to the CW link, the ArcGIS authorization page is displayed

2. A valid username and password must be entered to proceed 

3. Once logged in, the user will be prompted to select a role

4. When the role is selected, the Clearion Web homepage will open

Page Structure

A standard Clearion Web page consists of the following components:

1. Navigation Bar 

2. Tab(s)

3. Toolbar

4. Feature Table

5. Map

6. Slider

The set of components and their configurations may vary from page to page.

The following paragraphs will describe each component and its features in detail.

Navigation Bar

The ‘Navigation Bar’ contains a set of buttons that represent the application pages, allowing users to navigate between them.

The current page is highlighted in green for identification.

When hovering over a page icon, a tooltip appears displaying the page name.

Tabs

‘Tabs’ are page header elements that allow users to navigate between different sections or views without leaving the page.

Each tab can have its own set of components, data, and features. The information within the tabs placed on a single page is typically related from a business perspective.

A different number of tabs can be found on each page.

Toolbar

A ‘Toolbar’ is an element that contains a set of buttons allowing users to perform actions on the Feature Table records, such as creating, deleting, updating, querying, zooming, and highlighting.

The set of toolbar buttons differs from page to page.

The following sections provide a detailed description of how each of these features works.

Create

The ‘Create Feature’ widget allows users to create a record in one table based on a record from another table.

For example, on the Work Groups page, users can create a new Work Group based on the selected Work Territory.

In this case, some of the fields (that are pre-defined in the widget configuration settings) will be copied from the base table to the target table.

The ‘Create’ button is usually placed in the Toolbar.

To create a record, a user should follow these steps (the example of a Work Group creation):

1. Click the ‘Create’ button

2. Select a Work Territory in the displayed modal window and click ‘Next’

3. Fill in the fields in the creation form and click ‘Create’

4. A created record will be displayed in the table

Delete

The ‘Delete’ button allows users to remove one or more records from the table. 

By default, the button is disabled; it can be enabled by selecting at least one record in the table.

The ‘Delete’ button is usually placed in the Toolbar.

A confirmation pop-up with the number of selected records appears when the user clicks the ‘Delete’ button.

All selected records will be deleted from the table if deletion is confirmed.

The deletion is permanent.

A pop-up informing about a successful deletion will be shown.

Bulk Update

The ‘Bulk Update’ widget allows users to update the fields (that are pre-defined in the widget configuration settings) for one or more records.

By default, the ‘Update’ button is disabled; it can be enabled by selecting at least one record in the table.

The ‘Update’ button is usually placed in the Toolbar.

To update a record, the following steps should be done:

1. Select one or several records in the Feature Table

2. Click the ‘Update’ button

3. Update field values in the Update Modal and click ‘Update’

4. A pop-up informing about a successful update will be shown

• The field values will be displayed on the initial opening if they present and match in all selected records

• The field values will not be displayed on the initial opening if they present but do not match in selected records

Bulk Update buttons:

Query

The ‘Query’ widget allows users to search for records in the Feature Table based on specified parameters.

A widget consists of three tabs - Query, Parameters, and Favorites.

The user can specify search parameters in the Query tab, add/remove parameters in the Parameters tab, or use predefined sets in the Favorites tab (if they are configured).

The ‘Query’ widget is usually placed in the Toolbar.

To search records via the ‘Query’, a user should follow these steps:

1. Click the ‘Query’ button to open a Query Modal

2. In the modal window specify the query parameters

3. Any unnecessary parameters can be removed using the 'Bin' icon. Fields that are removed will not be included in the query

4. If any parameters are missing, they can be added in the ‘Parameters’ tab

5. When all necessary parameters are selected and specified, click the ‘Submit’ button.
   As a result, only the records matching the query parameters will be displayed in the Feature Table.
   The total number of records in the table and the number of records returned by the query will be shown on the page.

When the parameters are applied on the page, they will be saved even while navigating between pages, until the user reloads any page.

The Feature Table on the Clearion Web retrieves data from ArcGIS layers, but the number of records displayed may be limited.

For instance, while there could be 10,000 records available in ArcGIS, only 2,000 records may be shown in the web application.

In this case, the ‘Query’ widget allows users to search for specific records in the Feature Table that were not initially loaded in the Clearion Web.

The ‘Query’ widget has the following field types:

• Chips (single or multi-select)

• Dropdowns (single or multi-select)

• Date pickers

• Numeric field

Fields can also include operators to refine the query:

• Equal

• Not Equal

• Less

• Less Or Equal

• Greater

• Greater Or Equal

• Between

• Is Null

• Is Not Null

The type of the field and the availability of operators are controlled by the configuration settings and can be adjusted if needed.

Map

The ‘Map’ allows users to view, interact with, and analyze spatial data. It provides tools for zooming, highlighting features, and accessing layers and objects, including territories, tasks, etc.

Zoom and Highlight

Using the ‘Zoom’ and ‘Highlight’ buttons, the user can locate and view a layer or object on the map.

The ‘Zoom’ and ‘Highlight’ buttons are usually placed in the Toolbar.

By default, the ‘Zoom’ and ‘Highlight’ buttons are disabled; they can be enabled by selecting one record in the table.

To ‘Zoom’ and ‘Highlight’ map objects, a user should follow these steps:

1. Click ‘Map Preview’ to load a map (it may take a few minutes for the map to load)

2. In the table, check the entry that needs to be found on the map

3. Click ‘Zoom’. The map automatically centers on the selected entry and adjusts the view to bring the object or layer into closer focus, allowing for a more detailed view of its location.

4. Click ‘Highlight’. When the highlight button is clicked, the selected object or layer on the map is visually emphasized, making it easier to locate within the map view.

Map Controls

Map Controls provide users with additional actions on the map:

Draw a Rectangle or a Polygon

These features allow users to draw shapes on the map - either a rectangle or a polygon.

Once the shape is drawn, any objects within the area will be marked as selected in the Feature Table, enabling further actions on those objects.

A Rectangle

A Polygon

Basemap Gallery Expand

This button opens a gallery of available basemaps, allowing users to select and switch between different background maps (e.g., imagery, streets) to enhance the visual context of the data.

Home Button

Clicking this button resets the map view to the default extent or initial view, making it easy for users to return to the starting point after navigating.

Layer List Expand

This button displays a list of all available layers on the map, allowing users to toggle visibility.

Search

Locate specific places or features within the map data.

Legend Expand

This button reveals the legend for the map, which explains the symbols and colors used to represent different features and data layers, aiding in map interpretation.

Scale Bar

The scale bar provides a visual representation of the distance on the map, allowing users to understand the scale of the map and estimate real-world distances easily.

Coordinates

This feature shows the geographic coordinates (latitude and longitude) of the current map location, allowing users to determine precise locations.

Locate

This button enables users to find their current location on the map, often using GPS functionality or IP address data.

Feature Table

The ‘Feature Table’ widget displays data from ArcGIS layers in a tabular format, allowing users to view, manage, and analyze data.

It enables actions like sorting, filtering, and editing records for efficient data interaction

Feature Table Functionalities

Resizer

An element that allows users to adjust the size of the map and table by dragging its edges.

Columns

Columns in the Feature Table represent specific attributes or data fields for each record. 

Users can rearrange the order of columns by dragging and dropping them to customize their view.

Users can resize the width of columns by dragging and dropping the resizer element.

However, when other actions are performed in the table, the column order and size will be reset to the default.

Column Picker

Allows users to select which columns to display in the Feature Table.

Sorting

Arrange the data in a specific order based on selected columns.

• Ascending (Asc): This option arranges the data from the lowest to the highest value, such as A to Z for text or smallest to largest for numbers.

• Descending (Desc): This option arranges the data from the highest to the lowest value, such as Z to A for text or largest to smallest for numbers.

To sort columns the corresponding option in the Column Menu must be selected or this can be done by clicking the arrow next to the column name.

Pinning

This option allows users to fix a column to the left or right side of the Feature Table, keeping it visible while scrolling through other columns.

The corresponding option in the Column Menu must be selected to pin the column.

Filter

This action opens a filter menu, enabling users to specify criteria to narrow down the displayed records based on selected column values.

Filter can also be enabled by clicking the corresponding button in the Feature Table.

One or several filters can be applied to a table. Various operators help create more complex filtering.

The total number of records in the table and the number of records returned by the filter will be shown at the bottom of the page.

Grouping

This feature allows users to group records by one or several columns, organizing the data into categories.

Grouped records can be expanded or collapsed to show or hide the details within each group.

Collapsed grouping

Expanded grouping

Hide

This option allows users to remove a column from the view without deleting it, providing a cleaner table layout based on user preferences.

The columns can also be hidden and revealed using the Column Picker.

Export

By clicking the export button, a menu appears, allowing users to choose the file type for the exported data.

Search

A simple search allows users to quickly find records in the Feature Table by entering keywords into a search field. 

It can only locate records that are currently loaded in the Feature Table.

In contrast, the ‘Query’ Widget searches all available data in the ArcGIS layers, allowing users to find records that may not have been initially loaded.

Pagination

In the Feature Table, pagination is implemented to help users navigate through large sets of data efficiently.

Users can click on the page numbers to move between different pages of records.

Additionally, the number of records displayed on each page can be adjusted using the pagination settings element.

Pagination is automatically turned off when the grouping is applied to a ‘Feature Table’.

Data Counter

The data counter can display three types of information:

• the total amount of data loaded into the table

• the amount of data filtered by the filter

• the amount of data filtered by the query

Records Selection

Records in the Feature Table can be selected or activated through the following methods:

• Clicking the checkbox next to a record selects it and activates toolbar buttons such as Update, Zoom, Highlight, and Delete. One or more records can be selected at a time

• Double-clicking on a record activates it and opens the associated slider, if available. Only one record can be activated at a time

Inline Editing

Allows users to work with a specific record by adding, editing, or deleting it directly within the table.

Add Record

Clicking the button opens a special form that includes fields corresponding to the ‘Feature Table’ columns.

The user is prompted to enter data into the fields, thereby creating a new record in the table.

Unlike the ‘Create Feature’ widget, this process does not use a baselayer or copy its fields.

This option is available for both regular table entries and geometric entries tied to spatial data.

For the tables linked to layers on the map, when the button is clicked, the map will be automatically loaded, and the user will be asked to draw the geometry.

The type of geometry - point, line, or polygon, will be determined based on the associated layer.

Edit

If the editing option is enabled for the ‘Feature Table’, a pencil icon will appear next to each record.

By clicking on the icon, users can edit the selected record fields, making it easy to update or change data directly within the table.

Fields that are configured as read-only will not be editable.

Once editing is complete, the ‘Save’ button must be pressed to apply and save the changes.

A pop-up informing about a successful editing will be shown.

If editing needs to be canceled, the ‘Cancel’ button should be pressed to discard the changes.

Unlike the ‘Update’ button in the toolbar, inline editing does not support bulk editing; it allows users to update records one at a time directly within the table.

Delete

If the deleting option is enabled for the ‘Feature Table’, a ‘Bin’ icon will appear next to each record. By clicking on the icon, users can delete a selected record.

A confirmation pop-up appears when the user clicks the ‘Delete’ icon.

A selected record will be deleted from the table if deletion is confirmed.

The deletion is permanent.

A pop-up informing about a successful deletion will be shown.

Unlike the ‘Delete’ button in the toolbar, inline deleting does not support bulk deletion; it allows users to remove records one at a time directly within the table.

Slider

The ‘Slider’ is a component that opens when a record in the Feature Table is activated (double-clicked).

Inside the ‘Slider’, various sets of widgets are displayed, providing data related to the active record. For example, it may include such widgets as ‘Details’, ‘Related Table’, ‘Assign Panel’, and ‘Close Work’.

The set of ‘Slider’ widgets differs from page to page.

The following sections provide a detailed description of how each of these features works.

The ‘Slider’ size can be changed by dragging the resizer component.

Details

The ‘Details’ widget displays a list of fields for a specific record from the Feature Table.

The values in these fields can be edited, and when changes are saved, they will also be reflected in the Feature Table.

Fields that are configured as read-only will not be editable.

Related Table

The ‘Related Table’ widget represents another layer or table within ArcGIS. It displays only those records that are related to the active record in the Feature Table.

These relationships are typically established through shared fields, such as foreign keys (FK), primary keys (PK), IDs, or other identifiers.

This widget enables users to easily access related data.

For example, on the Work Territories page, the slider may display three related tables:

• Work Assessments - assessments associated with the selected Work Territory

• Work Groups - groups associated with the selected Work Territory

• Restrictions - restriction areas associated with the selected Work Territory

Typically, users can perform the following actions in the ‘Related table’:

• Reorder columns

• Expand columns

• Hide and display columns

• Sort data

• Filter data

• Search data

• Export data

• Zoom

• Highlight

Assign Tasks

The ‘Assign Tasks’ widget presents users with two tabs: one for ‘Available’ tasks and another for ‘Assigned’ tasks.

Both tabs display data from several different tables used for storing task records, which are filtered by specific queries set in the configuration.

Users can manipulate tasks within the widget, e.g. moving tasks from the ‘Available’ tab to the ‘Assigned’ tab and vice versa.

By default  Assign / Unassign buttons are disabled, to enable the buttons at least one task should be selected.

The counter next to each tab displays the number of records.

To assign/unassign tasks, a user should follow these steps:

1. Select needed tasks in the appropriate tab

2. Click the ‘Assign’ button

3. At this point, selected tasks will be moved to the ‘Assigned’ tab, the counters will be updated, and the success pop-up will be shown

4. Navigate to the ‘Assigned’ tab to see the moved tasks

5. Perform similar actions to unassign tasks

During these data manipulations, tasks can change their statuses, receive additional information related to the active record, and experience other updates as needed.

In addition, users can perform the following actions in the ‘Assing Tasks’ widget:

• Reorder columns

• Expand columns

• Hide and display columns

• Sort data

• Filter data

• Export data

• Zoom

• Highlight

Close Work

The ‘Close Work’ widget presents users with two tabs, both displaying tasks related to the active record.

One tab represents tasks that are not yet completed, while the other represents tasks that are ready to be completed.

The names of these tabs may vary depending on the page where the widget is located. For example, on the Work Groups page, the tabs are named ‘Open Tasks’, ‘Ready to Close’ and ‘To Unassign‘.

The tabs display data from several different tables used for storing task records, which are filtered by specific queries set in the configuration.

Users can manipulate tasks within the widget, e.g. moving tasks from the ‘Open Tasks’ tab to the ‘Ready to Close’ or to ‘To Unassign‘ and vice versa.

The counter next to each tab displays the number of records.

When all tasks are moved from the ‘Open Tasks’ tab to the ‘Ready to Close’ or ‘To Unassign‘, the user can close the work.

The process closes the active record by assigning the appropriate status to it and finalizing any associated tasks.

By default buttons are disabled, to enable the buttons at least one task should be selected.

There are two flows to close the work - simple close and close and create new.

Simple close work:

1. Select tasks in the ‘Open Tasks’ tab

2. Click the ‘To Close’

3. At this point, selected tasks will be moved to the ‘Ready to Close’ tab, and the counters will be updated.

4. Navigate to the ‘Ready to Close’ tab to see the tasks that can be finalized

5. Select all tasks and click the ‘Close Work’ button

6. A confirmation pop-up will display the following information:

• The ID of the active record being closed

• The status that will be assigned to the closed active record

• The status that will be assigned to the finalized tasks

7. If the action is confirmed the described in the pop-up actions will be performed and the success pop-up will be shown

If some tasks should be unassigned, they can be moved to To Unassign‘. In this case, such tasks won’t be closed.

Close work and create new:

1. Select tasks in the ‘Open Tasks’ tab

2. Click the ‘To Close’

3. At this point, selected tasks will be moved to the ‘Ready to Close’ tab, and the counters will be updated.

4. Navigate to the ‘Ready to Close’ tab to see the tasks that can be finalized

5. Select all tasks and click the ‘Close Work and Create New’ button

6. A confirmation pop-up will display the following information:

• The ID of the active record being closed

• The status that will be assigned to the closed active record

• The status that will be assigned to the finalized tasks

• The information that a new record will be created

7. If the action is confirmed the success pop-up will be shown and the Create New Work form will be displayed in the slider

7. After filling in all required information in the Create New Work form click the ‘Create’ button

8. The slider will be closed, tasks will be closed, new work will be shown in the table, and success status notifications will be displayed

If some tasks should be unassigned, they can be moved to To Unassign‘. In this case, such tasks won’t be closed.

In addition, users can perform the following actions in the ‘Close Work’ widget:

• Reorder columns

• Expand columns

• Hide and display columns

• Sort data

• Filter data

• Export data

• Zoom

• Highlight

Attachments

The ‘Attachment’ widget allows users to view, add, edit, delete, and manage attachments for every single entry in the table.

To add an attachment, a user should follow these steps:

1. Activate a record where an attachment should be added by double-clicking

2. Navigate to the Attachments tab

3. Click the ‘Add’ button to select an attachment

4. In the pop-up window select one or several attachments from the user’s device and click ‘Open’

5. A pop-up informing that the attachment was successfully added will be shown and selected items will be displayed in the slider

View the attachments:

1. Activate a record where an attachment should be added by double-clicking

2. Navigate to the Attachments tab

3. By default a gallery view is applied

4. The view can be switched between the gallery and the list

5. Click on the ‘Eye ’icon to expand the attachment

10. Clicking on the attachment itself will open a carousel view

The attachments can be downloaded via the ‘Download’ button.

The attachments can be deleted via the ‘Delete’ button.

The deletion is permanent.

The following formats are supported by the ‘Attachment’ widget:

• PDF

• PNG

• JPG

• XLSX

• XLS

The following types of attachments are available for a preview mode:

• PNG

• JPG

The following are not available:

• PDF

• XLSX

• XLS

The file size can range from 0 bytes to 32 megabytes.

Settings and Roles

The Settings page allows users to switch between roles.

Its icon is located at the bottom of the Navigation Bar.

The roles available to a user depend on their access level, which is defined in the configuration settings.

Depending on the number of roles available to a specific user, they can switch between those roles and view the configuration and data associated with each role.

To switch between user roles, the user should navigate to the Settings page and select the desired role from the Roles dropdown.