Adding fields to the user defined screen - HxGN EAM - Version 11.07.01 - Feature Briefs - Hexagon

HxGN EAM User Defined Screens

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

Once the new screen is defined and the table name is established, create and configure the following fields on the Fields tab:

  • Field Name - The Field Name is the actual column name in the user defined table associated to this screen. The system has some restrictions on Field Names; there cannot be an existing field name of the same name, database reserved words cannot be used, and no special characters can be included.

  • Description - The Description is a more detailed name or brief definition of the Field Name.

  • Field Label - The label that will be displayed on the screen. Can still be fine-tuned with screen designer later.

  • Sequence - This number represents the order of the field as it appears on the user defined screen.

  • Field Type - The user can define a new field to be Alphabetic, Numeric, Free Format Text, Checkbox, Date, Date Time, or Time.

    • Choosing Alphabetic will enable the Field Length field. The user will designate the total length of the text field.

    • Choosing Numeric will enable the Total Digits and Decimal Places fields. The Total Digits field value represents the total number of digits on both the left and right of the decimal, summed together. The Decimal Places field value represents the total number of digits after the decimal place.

    • Choosing Free Format Text will support having a field for general text and comments. Free Format Text fields will be sized as a CLOB in the database.

  • Is Primary Key - The primary key check box indicates the field is a unique identifier of the record in the table. Primary keys for a record may consist of a single field or may be a combination of several fields.

  • Is Nullable - This check box determines if the field value can be blank. Note, if the same field is marked as a primary key field, this check box will be protected and unselected.

  • Uppercase - If the field type is marked as Alphabetic, the system will allow the field to be optionally marked as uppercase. When checked, the field value must be entered in uppercase.

  • Computed Value - Designating a field as Computed Value will enable the Computed Data field, allowing the user to enter a database SELECT statement used to populate the field value when the record is saved. Computed Value fields will be generated as protected fields.

    • Computed Data - The Computed Data field stores the database SELECT statement. These SELECT statements can contain various operators as well as Oracle and SQL functions. Theoretically, if the statement can run successfully on the database, it can be used.

      For example, if the field should always be populated with today’s date the administrator can make the field computed and enter a SELECT statement such as

      SELECT sysdate FROM dual

      Or say you want to display the personnel name in this field, based on another field on the screen where the user enters the personnel code. In this example the personnel code is entered in the field with Sequence 3, which can be referenced as ‘:3’.

      SELECT per_desc FROM r5personnel WHERE per_code = :3

  • Retrieved Value - Designating a field as Retrieved Value will enable the Source Field and Retrieved Value Query fields, allowing the user to trigger a select statement, the retrieved value query, that is used to populate the field value after the user has entered a value in the source field.

    • Source Field - The Source Field references the field that triggers the retrieved value query to be executed when the user leaves that field. For example, entering the employee code in the source field could trigger the Retrieved Value Query to find the employee name and then populate the ‘target’ field, designated as the retrieved value field, with that name.

    • Retrieved Value Query - The Retrieved Value Query references a database SELECT statement defined on the Queries screen. These SELECT statements can contain various operators as well as Oracle and SQL functions. Theoretically, if the statement can run successfully on the database, it can be used.

      For example, if you want to display the personnel name in the ‘Name’ field, based on the entry of the employee code in the ‘Employee’ field then update the ‘Name’ field as follows:

      • Select the ‘Employee’ field as the Source Field. Say this field has Sequence 3, which can be referenced as ‘:3’.

      • Reference a query from the Queries screen in the Retrieved Value Query field.
        The query could look like:
        SELECT per_desc FROM r5personnel WHERE per_code = :3

  • Query Code - With the Query Code you can make the field a lookup. The Query Code field will show all queries defined the Queries screen. Typically, these queries are flagged as Data Collection, Normal or Lookup.

    For example, if you want the equipment field on your user defined screen to display installed assets only you could create the following query:

    SELECT obj_code, obj_desc FROM r5objects WHERE obj_obrtype = 'A' AND obj_status = 'I'

  • Out of Service - This field is currently not used.

  • Parent Screen Key Field - If the user defined screen is a tab, you must bind the records inserted on this tab to the header record on the record view. Otherwise, records entered on this tab would show on all header records. Depending on the Parent Screen selected one or more values may be required. For example, a new tab on the Parts screen would require the use of both the Part Code and Part Organization to uniquely identify the header. That means two fields are required on the Fields tab, simply to map to the header record. The system will also want a unique field on the tab to differentiate among records. Ultimately that means you will end with three fields on the Fields tab where primary key is selected, one of those referencing the part code from the parent screen and one referencing the organization from the parent screen.

    Note that the parent screen key fields on the actual tab can be hidden with screen designer, if desired.