Project Configuration Guide

Prev Next

This guide provides a step-by-step walkthrough on how to configure a new project, starting with fundamental prerequisites and concluding with the final page setup, covering everything a user needs to create a new project from scratch.

How to create groups

Entities such as Data Sources, Lookups, Custom Actions, Roles, and Themes are organized within Groups. These Groups are typically configured to mirror specific project environments. For example, a Test Group contains test-specific entities for a Test Project, while a Prod Group contains prod-ready entities for a Prod Project.

  1. Press the groups tab (below Entities)

  2. Press the ‘x’ button

 3. Fill in the Name and Description (if needed) fields, and then press ‘Save’

 

Applying a group to an entity

Entities must be assigned to a Group during the initial creation process via the first row of settings. Please note that Groups cannot be retroactively applied to an existing entity 'from scratch' once it has been created

  1. Choose an entity (lookup, data source, custom action, etc.)

  2. Ensure that all required fields are filled in (Table key, field name, source, etc.).

  3. Select a group from the groups lookup

Reference link* 🔗 - Data Groups

*The reference link provides a deep dive into the different entities and widgets described in the article, in an external article

How to create data sources

Tables:

There are two ways to create tables:

1. From Portal:

  • After clicking the ‘+’ button, press ‘From Portal’

  • Select a feature service, and the group(s) that the table(s) will be included in

  • Select a table (or tables) that will be created

  • Press ‘Add’

2. Manually:

  • Fill all the required fields on the Properties tab

  • Make sure that all of the input data corresponds to the table’s data on the portal

  • After filling in all data on the Properties tab, review the configured table on the Data tab to ensure that it’s configured correctly

  • Press ‘Save’

Reference link 🔗 - Data Source

Adding Maps:

  1. Enter the Maps tab

  2. Press the ‘+’ button

  3. Fill the Groups, Name, Key, and Map ID fields (all fields are required)

  4. Ensure that the map key and ID match the values on the portal

  5. Press ‘Save’

Reference link 🔗 - Map

Adding Services:

  1. Enter the Services tab

  2. Press the ‘+’ button

  3. Fill the Groups, Name, Key, Service ID, Use Server (True or False), and portal fields (Service URL field isn’t required)

  4. Press ‘Save’

Adding Portals:

  1. Enter the Portals tab

  2. Press the ‘+’ button

  3. Fill the Groups, Name, Key, Portal URL, Portal Client ID, and Default (True or False) fields

  4. Press ‘Save’

How to create projects

  1. Head to the Projects List

  2. Name the newly created project, and choose a data group that the project will be included in

  3. Press ‘Save’

  4. The entered data can be edited by pressing the pencil icon

  5. The project can be added to the favorites by pressing the star icon

Reference link 🔗 - Project List Page

How to create pages

Pages are project-specific because they contain unique data. Consequently, you must create a project before you can begin adding pages to it

  1. Select a project where the pages need to be created

  2. Press the ‘Pages’ button to the left of the page

  3. Press the ‘+’ button

  4. On the ‘Create New Page’, fill in the Name, Slug, and Image fields.

  5. Set the Active field to ‘true’ to make the page visible on Clearion web. The page can be set to be the home page by setting the Home Page field to true

  6. Press ‘Save’

Reference link 🔗 - Project Structure

How to add a map and its settings

The Map and its settings are basic elements of a standard (together with the feature table and the navigation bar). The displayed features in the FT will be visibly shown on the map, as long as they have a geometry (e.g., Work Assessments, Work Groups, Worksites)

  1. Press the ‘Add’ button on the left on the page (below pages)

  2. Select the map widget

  3. Resize the map as desired using the arrow on the bottom right of the widget

  4. To enter the map settings:

  • Go to the widget list on the top right of the page (Under the ‘Structure’ title)

  • Press the pencil icon

  • A list of settings will be shown to the right of the page, featuring: The Name, Source, Modules, Zoom, Map visibility settings, and Roles

  • An expanded list of settings will be displayed after selecting one from the initial list

Reference link 🔗 - Map

Navigation bar + toolbar elements

  1. Press the ‘add’ button to the left

  2. Select the Navigation and toolbar widgets

  3. Resize the widgets as desired using the arrow on the bottom right of the widget, and move them by pressing & dragging to the desired location

  4. The Navigation and Toolbar widget can be edited using the widget settings

Reference link 🔗 - Navigation

Reference link 🔗 - Toolbar

Toolbar elements: zoom, highlight, query widget

  1. Zoom widget:

  • Enter the toolbar widget settings, and press the menu column

  • Press ‘Add Item’

  • Fill in the Text and Icon fields (usually the widget is named ‘Zoom’, and there is a designated icon named ‘Zoom’/’Zoom V2’)

  • In the ‘Action’ field lookup, select ‘ZOOM’

  • Check the Is Visible field to true, to make the widget visible

  • Check the Requires Selected Records field to true, to activate the zoom action only for specified records

  • Press ‘Save’

  1. Highlight widget:

  • Enter the toolbar widget settings, and press the menu column

  • Press ‘Add Item’

  • Fill in the Text and Icon fields (usually the widget is named ‘Highlight’, and there is a designated icon named ‘Highlight’/‘Highlight V2’)

  • In the ‘Action’ field lookup, select ‘HIGHLIGHT’

  • Check the Is Visible field to true, to make the widget visible

  • Check the Requires Selected Records field to true, to activate the highlight action only for specified records

  • Press ‘Save’

  1. Query widget:

  • Enter the ‘Modals’ tab, and ensure that editing mode is on

  • Press ‘Add New Modal’, and name the modal

  • Press the add button to the left of the screen, select ‘Query’, and resize the widget as desired

  • Press the created query on the modals list to the right of the screen, then press the arrow on the left of the column, and enter the widget settings

  • Add all the necessary data to the query (fields, target container, tab order, etc.), and press ‘Save’

  • Return to the layouts tab, and press the ‘Menu’ column on the toolbar widget settings

  • Press ‘Add Item’

  • Fill in the Text and Icon fields (usually the widget is named ‘Query’, and there is a designated icon named ‘Query’/‘Query V2’)

  • In the ‘Action’ field lookup, select ‘OPEN_MODAL’, and select the recently created query modal

  • Check the Is Visible field to true, to make the widget visible

  • Press ‘Save’

Reference link 🔗 - Query

FT > the slider (FA)

To add a Feature Table (FT):

  1. Press the ‘Add’ button to the left of the screen, and select the FT widget

  2. Resize the FT, ensuring that all widgets fit inside the page

  3. Add all the necessary data to the FT using the widget settings (sources, columns, table configuration, etc.)

  4. Press ‘Save’

Reference link 🔗 - Feature Table

To add Feature Attributes (FA):

  1. Enter the ‘Sliders’ tab

  2. Press ‘Add New Slider’, and name the widget as desired

  3. Press the ‘Add’ button to the left of the screen, select the FA widget, and resize the widget as desired

  4. Press the created slider on the sliders list to the right of the screen, then press the arrow on the left of the column, and enter the widget settings

  5. Add groups, and then all the necessary data to the FT using the widget settings (Name, Fields, Related Layers, etc.)

  6. Press ‘Save’

  7. Return to the Layouts tab, and enter the FT widget settings

  8. Press the ‘Slider Configuration’ column, and select the recently created slider in the slider field

  9. Add a title to the slider if desired

Reference link 🔗 - Feature Attributes

Notes for the user

  • Entities (Roles, Lookups, Data Source, Library) - Can be created on the entities tab and applied via the widget settings

Reference link 🔗 - Lookups page

  • Custom Actions - can be created on the ‘Custom Actions’ tab and applied to widgets and tabs via the ‘Custom Actions’ column. Pay Attention - when copying/merging CAs from test app to prod app (or vice versa), make sure that layers’ names/IDs match the corresponding data sources

Reference link 🔗 - Custom Actions page

  • Themes - can be created on the ‘Themes’ tab, and applied to fields via the widget settings. Pay attention - each theme can be applied to a single value, and the ‘Widget Preview’ square in the middle must be pressed before applying the theme

Reference link 🔗 - Themes page

  • Adding tabs (to the same page) can be done by pressing the ‘+’ button in the top-left corner, next to the ‘Main’ default tab. The tabs can be edited, deleted, and have child tabs added to them by pressing the three dots

Reference link 🔗 - Tabs

  • Adding Related Tables & Close Work tabs - can be done by navigating to the Sliders tab (next to the modals tab), and selecting the widget from the ‘Add’ page (below ‘Pages’). The order of the tabs can be changed by dragging them within the ‘Slider’ dropdown. Make sure that the slider is created before the addition of the tabs, and select the proper data source for each widget

  Reference links 🔗 - Related table, Close Work

  • When cloning/merging projects - When copying/merging from test app to prod app (or vice versa), make sure that the layers’ names/IDs, lookup names, match the corresponding data sources in the following entities:

  • Dynamic Lookups

  • Custom Actions