The Configuration Settings interface streamlines the management of critical application settings, including connection strings, config values, email templates, field settings, and map settings. This tool can be accessed by clicking on the Administration icon on the Utility Bar. Only users with the System Administrator security role, the TIP Coordinator security role, or users assigned a role that includes the Manage Config Values permissions will have this option available.
Setup
There are four tabs on the Configuration Settings interface: Config Values, Field Settings, Map Settings, and Rules Engine. When "Configuration Settings" is selected in the Administration picklist, the Config Values tab will be shown by default.
Config Values
The Config Values tab (first tab) will allow authorized users to view and edit key configuration values for the application, including email and notification templates.
At the top of the screen, the radio buttons allow the user to easily filter the table: All, Application Admin (only available to PMG Domain Users), Application Settings, and Email Templates.
On the left side of the screen, the user can view a table listing each configuration value in the system. The fields in the Config Values table are described below.
| Field | Description |
| ID | This is the unique database ID for the record; this field is read-only. |
| Name | This is the name of the Configuration Value record; this field is read-only. |
| Value | This is the associated Configuration Value; this field is editable on the Detail window. |
| Category | This is the category of the Configuration Value: Application Admin (only available to PMG Domain Users), Application Settings, or Email Templates. |
To view more information about a specific Configuration Value, the user can click on its row in the table. Then, the Detail window on the righthand side will be filled with its information. This area will include the Name of the selected Configuration Value in the header and all associated fields below. All fields in this interface will be disabled with the exception of the Value field. If changes are made to the Value field, the user can confirm the new values by clicking "Save" or revert the values to their former state by clicking "Cancel".
Email Templates
The Email Template configuration value type has additional elements that help with its creation. When the Email Templates radio button is selected, the Value field in the Detail window will be an html editor for composing the email template.
The Value field can be used in conjunction with the variable attribute buttons in order to create an email template. These variables appear below the table and, when clicked, will insert a placeholder text (ex. {{Revision Number}}) into the Value field. When the email is generated, this placeholder text will be replaced by values based on the selected STIP/TIP, the selected Revision, and the rules surrounding the selected variable attribute. The table below outlines the current variables and the information they provide in the email.
| When this variable is inputted in the Email Template value field: | This information will appear on the Email: |
| STIP/TIP Years | STIP/TIP Start Year – STIP/TIP End Year (ex. 2022 – 2027) |
| Constrained Years | STIP/TIP First 4 Years (ex. 2022 – 2025) |
| Revision Number | Revision Number (ex. Amendment 1) |
| State | State’s Full Name (ex. New Mexico) |
| MPO Name | MPO Name (ex. El Paso) |
| Total Change | Total Programmed Amount Change over STIP/TIP window (ex. $10,000,000) |
| Constrained Change | Total Programmed Amount Change over First 4 Years (ex. $5,000,000) |
| Projects Modified | Total Number of Projects Modified (ex. 4) |
Field Settings
The Field Settings tab (second tab) will allow authorized users to configure labels to display for many of the fields related to a project. This customization empowers users to tailor the application to better suit their needs.
At the top of the screen, the radio buttons allow the user to easily filter the table: All, Active, and Inactive.
On the left side of the screen, the user can view a table listing each of the application's "fields". The columns in the List of Fields table are read-only and described below.
| Field | Description |
| ID | This is the unique ID for the field in the Column Definition database table. |
| Column Name | This is the system-generated Field Name. |
| Column Display Name | This is the user-defined label for the Field Name. |
| Active | This shows whether the field is active (checkmark) or inactive ("x"). |
Edit Field Settings
To edit a field, the user can click on its row in the table. Then, the Detail window on the righthand side will be filled with its information. This area will include the "Column Name" in the header, and these fields below:
| Field | Description |
| ID | This read-only field is the unique ID for the field in the Column Definition database table. |
| Required (switch) | This switch allows the user to designate whether the field will be required prior to saving a project record. |
| Active (switch) | This switch allows the user to designate the field as active or inactive. |
| Name | This read-only field displays the System Field Name for the field. |
| Display Name | This field allows the user to change the label for the field name (limit of 127 characters). |
| Column Description | This field contains the Description of the field (limit of 127 characters). |
| Field Type | This is a picklist of the custom field types that can be added to the system, including String, Integer, Currency, Percent, Date, Boolean, and Lookup. This field will only be enabled for changes for custom fields. |
| Minimum Display Width | This is the minimum display width in pixels for the field (limit of 400 pixels). |
| Code List | This field displays an association between the field and an existing code list. This field will only be enabled for custom fields with a Field Type = Lookup. |
| Display in Map Filters (switch) | This switch allows the user to designate whether the field will be included in the Map Filters. |
| Display in Map Tooltip (switch) | This switch allows the user to designate whether the field will be included in the Map Pop-Up on both the Manager and Viewer applications. |
| Display in Viewer Filters (switch) | This switch allows the user to designate whether the field will be included as a Search Criteria filter in the Viewer application. |
| Display in Project Table (switch) | This switch allows the user to designate whether the field will be included in the Projects Table. |
Create/Delete Custom Fields
The "Add Custom Field" button will be included to the right of the filter radio buttons for the user to add custom project fields. When this button is selected, the Detail window will be cleared, and all its fields will be enabled (except ID and Name) to allow the user to create the custom field. Once all the required fields (Display Name, Column Description, and Field Type) have values, the user can select Save to solidify the new field and add it to the List of Fields table.
Custom Fields can also be deleted. To delete a custom field, the user can select the delete icon in the Detail window header. Before deletion, the system will check to see if any data is stored in the field. If the Custom field has no related data, it will simply be deleted from the system. If the Custom field has related data, the field will be marked "Inactive" instead, and all data will be retained but no longer displayed.
Map Settings
The Map Settings tab (third tab) allows users with the System Administrator security role, the TIP Coordinator security role, or the Manage Map Settings permission to configure and manage the various map services and location attributes that the application utilizes for the map legend, spatial analysis, and project location information table.
At the top of the screen, the Map Service picklist allows the user to easily filter the table. This picklist hosts the Map Services added through the "Add Service" button.
On the left side of the screen, the user can view a table listing each Layer found in the Map Service selected. The fields in the Map Settings table are read-only and described below.
| Field | Description |
| Re-Arrange | The six dots to the right of each record will allow the user to drag and drop the values into the desired Display Order. This order will be reflected in the Map Legend. |
| Layer No. | This is the Layer Number for the map layer. |
| Layer Name | This is the Layer Name for the map layer. |
To view more information about a specific Map Layer, the user can click on its row in the table. Then, the Detail window on the righthand side will be filled with its information:
| Field | Description |
| Name | This is the Layer Name for the map layer. |
| Display in Legend | When switched on, this toggle ensures that the selected Map Layer appears in the Map Legend. |
| Set as Milepost | When switched on, this toggle ensures that the selected Map Layer is set as a milepost. |
| Layer No. | This is the Layer No. for the map layer. This field will automatically be derived from the service and disabled. |
| Layer URL | This is the related ArcGIS URL for the layer. This field will automatically be derived from the service and disabled. |
| Layer Type | This is the Layer Type for the map layer. This field will automatically be derived from the service and disabled. |
| Geometry Type | This is the Geometry Type for the map layer. This field will automatically be derived from the service and disabled. |
| Get Attribute | This toggle determines if the layer is used to derive segment attribute data when a project location is added/edited. If the user hovers over the information icon beside this toggle ("i"), the tooltip will reiterate its purpose. |
| Boundary Type | This is the Boundary Type for the map layer (None, County, District, or MPO). |
| Mapped Fields | The "Mapped Fields" table is composed of these columns:
The "Add Field Mapping" button will allow the user to add an additional row to the Mapped Fields table. |
Add Field Mapping
To add a new row/entry to the Mapped Fields table, the user can click the "Add Field Mapping" button. This new row will be added to the bottom of the table, and it will show three blank fields: Field, Table Name, and Column Name.
All three fields are required to be filled before saving. Once these fields have values, the user can select the "Save Field Mapping" button to solidify the new row.
Add Service
The "Add Service" button allows the user to connect map services. When selected, the user will be redirected to this screen:
Then, the user can enter the URL (Service Directory) and click the "Locate Map Services" button. The interface will automatically update to show all available map services found based on the entered URL.
Once the Save button is selected, the user will be navigated back to the Map Settings interface which will be updated with the related information.
Rules Engine
The Rules Engine tab (fourth tab) allows System Administrators and TIP Coordinators to configure a list of rules for classifying a change in the system. These rules will clearly define what constitutes a change and the change type.
On the left side of the screen, the user can view a table listing the current rules defined in the system. The version number and date saved will be displayed above the Rules table. Each row in the table is defined by three columns: Number, Name, and Change Type. If the user selects a row here, the detailed criteria for that rule will be displayed in a table to its right and will be editable. The columns in the Criteria table are Sequence (number) and Criterion (specification/details of rule).
Edit Rules
All items in the Detail pane and Criteria table can be edited if the rules have not yet been finalized. If a value is changed, the "Save Criterion" button can be used to solidify the new values. A rule’s definition will be preserved when it is updated. So, when users view the rule used for triggering a change, they will be shown the specific version of the Rules table that was used at the time the change was made. When making edits to the Rules Engine, it is important to make all needed modifications before saving a new version.
The values available in the Left and Right columns are outlined below.
| Left Condition | Type | Right Condition |
| Add Phase | Y/N | Yes, No <picklist> |
| Add Project | Y/N | Yes, No <picklist> |
| Approved Agency | <blank> | Pending Agency |
| Approved Description | <blank> | Pending Description |
| Approved Fund Source | <blank> | Pending Fund Source |
| Approved Mode | <blank> | Pending Mode |
| Approved Name | <blank> | Pending Name |
| Approved Phase Fund Subtype | <blank> | Fund Subtype <picklist> |
| Approved Phase Fund Type | <blank> | Fund Type <picklist> |
| Approved Phase Programmed | $ | Text box allowing user to enter Amount |
| Approved Phase Start Year | Yr. | Text box allowing user to enter STIP Year # |
| <blank> | STIP Start Year, STIP End Year, Pending Phase Start Year <picklist> | |
| Approved Program | <blank> | Pending Program |
| Approved Project Estimate | <blank> | Pending Project Estimate |
| Approved Project Fund Subtype | <blank> | Fund Subtype <picklist> |
| Approved Project Fund Type | <blank> | Fund Type <picklist> |
| Approved Project Location(s) | <blank> | Pending Project Location(s) |
| Approved Project Manager | <blank> | Pending Project Manager |
| Approved Project Oversight | <blank> | Pending Project Oversight |
| Approved Project Start Year | Yr. | Text box allowing user to enter STIP Year # |
| <blank> | STIP Start Year, STIP End Year, Pending Project Start Year <picklist> | |
| Approved Total Programmed | $ | Text box allowing user to enter Amount |
| Approved Work Type | <blank> | Pending Work Type |
| Pending Phase Fund Subtype | <blank> | Fund Subtype <picklist> |
| Pending Phase Fund Type | <blank> | Fund Type <picklist> |
| Pending Phase Programmed | $ | Text box allowing user to enter Amount |
| Pending Phase Start Year | Yr. | Text box allowing user to enter STIP Year # |
| <blank> | STIP Start Year, STIP End Year <picklist> | |
| Pending Project Fund Subtype | <blank> | Fund Subtype <picklist> |
| Pending Project Fund Type | <blank> | Fund Type <picklist> |
| Pending Project Start Year | Yr. | Text box allowing user to enter STIP Year # |
| <blank> | STIP Start Year, STIP End Year <picklist> | |
| Pending Total Programmed | $ | Text box allowing user to enter Amount |
| Remove Phase | Y/N | Yes, No <picklist> |
| Remove Project | Y/N | Yes, No <picklist> |
| Total Change | $ | Text box allowing user to enter Amount |
| % | Text box allowing user to enter Percentage | |
| Total Phase Change | $ | Text box allowing user to enter Amount |
| % | Text box allowing user to enter Percentage |
Add Rule
The "Add Rule" button allows the user to create a new rule. If the user selects this tool, a new, blank row will be added to the Rules Table, allowing the user to enter the next Rule No., Rule (Name), and Change Type. Rules will be evaluated using a top-down approach; therefore, it is critical to ensure that the most restrictive rules are placed with the highest Rule No.
Delete Rule
To delete a rule from the system, the user can select the delete icon located to the right of the desired rule in the Rules table. Once the Save Changes button is selected, a new version of the entire Rules table will be created, and the version number and date will be saved at the top.
View Rules
The "View Rules" link in the bottom left of the Rules Table will allow users to view the various Rule Versions in a summarized format. All information in this window will be read-only. The user can use the "Select Version" picklist at the top left to choose the Rule Version they wish to view. Only changes made after the new Rule Version is saved are evaluated against the latest rules; changes already in the approval process continue using the Change Type evaluated with the previous rules.
Finalize Rules Version
The "Finalize Rules Version" button will appear when there is a new rules version in progress that has not been saved. The user can make all desired changes to the version, then click this button to solidify the new rules set.
Add Rules Version
The "Add Rules Version" button allows the user to create a new set of rules. Once selected, a confirmation message will appear that says, "Are you sure you want to create a new version of the enter set of rules?" When this message is confirmed, the user will be able to construct a new set of rules for the changes and Actions workflow to follow.
Comments
0 comments
Please sign in to leave a comment.