Flex Configuration Help
Flex Operations provides built-in configuration reference and inspection tools. These tools are available when the URL includes the ?config=<personal configuration folder> parameter. The parameter value identifies the personal Flex configuration folder described in Testing Changes.
When configuration help is available, the title bar of each Flex tool and dialog contains a button with the tooltip Flex UI Configuration Help. Select the button to display the following options. Each option opens or updates the Flex Configuration Help tool in a separate browser window:
• Inspect Elements: Enables inspection mode in the original Flex window and opens the Inspector tab. Hover over an element to highlight it and display its configured name. The Inspector tab displays its element hierarchy, configuration definition, instance data, and metadata. Hovering over a table row also makes the row data available. Select an element to leave inspection mode with that element selected.
• View Product Configuration File: Opens the Config Files tab and displays the product configuration source for the current tool. It also allows chunks of that configuration to be copied in a JSON format which can be used directly in the JSON configuration files - see "Converting Product Configuration to JSON Overrides" below for more information.
• View NLS Strings: Opens the Localized NLS Strings tab and displays the NLS strings for the current tool.
• View UI Element Documentation: Opens the Elements tab, which describes the configuration supported by each type of Flex UI element. Links in the element definitions open related type definitions.
Some tools such as the Map also have additional options specific to that tool's configuration
Flex Configuration Help Toolbar
The Flex Configuration Help toolbar provides the following controls:
• Help & Quick Links: Opens shortcuts to commonly used configuration references.
• Back and Forward: Moves through recently viewed tabs, files, definitions, and inspected elements.
• Inspect Elements: Enables or disables element inspection in the originating Flex Operations window.
Help & Quick Links
The Help & Quick Links menu contains the following entries:
• Config Cheat Sheet: Opens the configuration cheat sheet in the Examples tab. The cheat sheet contains examples for overriding UI elements and functions; replacing, merging, adding, removing, and reordering object or array content; finding and updating child elements; and making larger table-column changes.
• View Flex Image Library: Opens the Flex image catalogue in a separate browser window. Use this catalogue to browse and filter available Flex icons and CNV symbols and to identify the image names used in configuration.
• NMS Constants: Opens the generated NMS constants file in the Config Files tab. These constants can be referenced in expressions to make configuration more readable. They are internal NMS values, are not individually documented, and can change without notice.
• Map Configuration: Opens the MapConfig definition in the Types tab. This definition describes the top-level structure and options supported by the map configuration.
• Map Feature Style: Opens the NmsFeatureStyle definition in the Types tab. This definition describes the styling options available for map features.
• Map Line Style: Opens the NmsLineStyle definition in the Types tab. This definition describes the styling options available for map lines.
Flex Configuration Help Tabs
The Flex Configuration Help tool contains the following tabs:
• Inspector: Displays information about the element selected with Inspect Elements. The navigation tree shows the element hierarchy and the configuration that produced the selected element. Details can include field or action definitions, element definitions, instance data, and metadata. Links in the header open the applicable UI element definition or product configuration file. When inspecting a table, the Inspector can also display the selected row data, column configuration, column metadata, and expressions used by calculated columns.
• Expressions: Documents the functions and properties that can be used in Flex expressions. Expression capabilities vary between tools and product areas, so the navigation list is organized by expression factory, representing the context in which an expression is evaluated. Selecting an expression factory displays the functions defined by that factory together with functions inherited from its parent factories.
The expression table displays the function Name, Description, and Example(s). Function names are shown with the `$` prefix used in configuration. Use the table search to locate a function by name or description.
For map-related expressions, use the following expression factories:
• NetworkViewerExpressionFactory: Functions available to expressions in the Flex map screen configuration.
• MapExpressionFactory: Functions available when evaluating mapConfig.jsonc and its associated configuration files.
• InteractionExpressionFactory: Additional map functions available when evaluating user-interaction expressions, such as selection and movement filters.
NMS constants can also be referenced from expressions. Select Help & Quick Links, and then select NMS Constants to view the available constants.
Recognized expression functions are displayed as links when they appear in product configuration in the Config Files tab or in configuration and table-expression data shown in the Inspector tab. Select a linked function to open the Expressions tab, select the applicable expression factory for the originating tool or product area, and filter the table to the function's description and examples. Clear the function-specific filter to return to the complete list for that expression factory.
• Elements: Describes the configuration properties supported by each Flex UI element type. Select an element type in the navigation tree to view its property names, data types, and descriptions. References to shared types are links that open the corresponding definition in the Types tab.
• Types: Describes shared configuration structures, choice lists, and enumerations referenced by element and application configuration. Definitions show property names, accepted types or enumeration values, and descriptions. References to other documented types are links that open those definitions.
• Config Files: Displays the generated source for the product configuration files. Use the navigation tree to select a file and view its full configuration and source path. Recognized UI element types and expression functions in the source are displayed as links to their documentation. When related configuration files are available, use Related Configuration to move between them.
Use Copy Full Contents to copy the complete file. To create JSON override content from part of a product JavaScript configuration file, select the required source and use the JSON copy action. Select either two or four spaces for the generated JSON indentation.
• Localized NLS Strings: Displays the product National Language Support files and their complete localized string structures. Use the navigation tree to select a file and Copy Full Contents to copy it for use when preparing NLS overrides.
• Examples: Displays the configuration examples and reference material packaged with the product, including the configuration README and Config Cheat Sheet. Select an example in the navigation tree and use Copy Full Contents when adapting it for customer configuration.