Step 4: Use screen designer to make final screen configuration changes - HxGN EAM - 11.07.01 - Feature Briefs - Hexagon

HxGN EAM Web Service Prompts

Language
English
Product
HxGN EAM
Search by Category
Feature Briefs
HxGN EAM Version
11.7.1

The web service prompt screen design feature is used to edit the layout of screens created using web service prompts. In addition, this user will be able to select the groups for which the changes apply.

Look, feel, and screen designer options are like the screen designer feature used on other Extended screens; however, there are some differences (see list below for details). If the user has screen designer privileges for normal screens they will have access to the feature for web service prompt screens.

Open screen designer by clicking the familiar icon in the HxGN EAM™ toolbar at the top of the prompt screen. Drag and drop fields to move then around the screen while right clicking fields will reveal additional options for the right clicked field. See the image on page 31.

Ability to change field boiler text, display type, set default values, and change section title bar text are there but remember, the ability to define these types of things also exists on the prompt setup screen (that is, Fields for Web Service Prompts).

The primary purpose for having screen designer for web service prompts is the ability to easily move fields around the screen (that is, change field Sequence) via the drag and drop action. Yes, you can define the layout, or order, of the screen by using the Sequence field when setting up the prompt; however, it is much more intuitive to perform this task using a visual representation of the screen rather than sequence numbers.

When a web service prompt screen is displayed in screen design mode, there will be 5 containers available for each web service in the prompt: 2 single wide containers, 2 double wide containers (delivered hidden), and 1 custom field container.

A section header bar will be displayed above the following: 1 header bar across the 2 single wide containers, 1 header bar across each of the 2 double wide containers (comprise the main web service body), and 1 header bar across the custom field container.

Section titles will be displayed for their respective blocks. If no title is available, the system will display "<Section Title>". Note that, by default, no title will be available for the double wide container blocks.

  • Changes to display type, field type, or sequence via screen designer will not be reflected on the web service prompt setup screen.

  • Changes to boiler text via screen designer are reflected on the web service prompt setup screen.

  • System administrator changes to the prompt setup can impact screen designer changes made for a prompt screen. See the Notes in c. Select specific fields for the user defined screen (Web Service Prompt > Fields tab on page .

  • Notice that the Pipe Depth custom field related to the Add Building Asset Screen web service is not displayed in screen designer mode. This is because changes to class specific custom fields (always displayed in the Custom Field container) cannot be made using screen designer, including moving these custom fields outside the Custom Field container. By contrast, the Pipe Diameter custom field is a custom field but is applicable to all classes; therefore, it is available in screen designer.

  • When right-clicking on the section title bar, the option to ‘show block’ or ‘hide block’ will be available, as will ‘Edit Block Name’.

  • If fields are moved into the double wide blocks (hidden by default) they will be displayed in a single column as these blocks have but a single container. A better use of these containers is to display large text fields, such as comments. In the image on page 31, comments fields are wider and show more rows than normal fields.

  • If comments are added to a prompt the system will always attempt to display them in the lower double wide container (more suitable for displaying comments) for the selected Process Group-Web Service, regardless of field Sequence.

  • The list of available field display types in the right click menu for screen designer will be based on the display type set by the administrator on the prompt definition screen. What this means is if the default display type for a web service fields is ‘optional’ in the web service, but the administrator changes is to ‘required’ on the prompt definition screen, the user will not see ‘optional’ in the screen designer right click menu as the system does not allow users to ‘loosen’ field restrictions. This is consistent with the rest of the application when it comes to available screen designer options versus the delivered display type of the field.

  • Assuming all 5 blocks for a web service are displayed and contain fields the system tabs from the top double wide block to the main body block (left container then the right container) to the lower double wide block to the custom field block, then to the next web service and so on.

The following is a list of items available in the base screen designer tool but are NOT AVAILABLE in the web service prompt screen designer tool:

  • Display types ‘system hidden’, ‘system required’, and ‘not available’ are not supported.

  • The ‘view field details’ option is not supported.

  • Multi-language translation pop-up for changing boiler text is not supported. A single field is provided for changing boiler text that is, web service prompts are not translatable.

  • If the entity is EVT or OBJ, all default UDFs will not be available in screen design mode. Only the UDFs selected for the prompt will be available in screen design mode.

  • Removed Translations link from the Define Lookup Values pop-up for UDFs.

  • Hyperlink option is not supported.

  • User defined field options are not supported.

  • User defined field lookup values are not supported.