Configuring the Master Index EDM Appearance (Repository)

You can modify the configuration of the fields and objects to specify how they appear on the EDM pages by modifying the Enterprise Data Manager file. You can perform any of the following actions to customize the general appearance of the EDM. Though some appearance options can be configured using the Configuration Editor, it is best to modify the XML file directly.

Perform any of the following tasks to configure the appearance of the EDM.

• Adding Objects to the EDM

• Modifying EDM Objects

• Deleting Objects From the EDM

• Adding Fields to the EDM

• EDM Field Configuration Elements

• Removing Fields From the EDM

• Modifying EDM Field Display Options

• Specifying a Drop-Down List for an EDM Field

• Specifying an EDM Field's Length and Format

• Modifying an EDM Field's Data Type

• Defining Key Fields for an Object (Repository)

• Masking Field Values on the EDM

• Defining EDM Object Relationships (Repository)

• Defining EDM Local ID Labels (Repository)

Adding Objects to the EDM

You can define additional objects for the EDM as long as those objects are defined in the Object Definition file. Each object can only contain the fields that are also defined for that object in the Object Definition file. If you add objects to the object structure using the Configuration Editor, the new objects are automatically added to the the Enterprise Data Manager file and you do not need to perform these steps.

To Add an Object to the EDM

1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click the Enterprise Data Manager file.

   The file opens in the NetBeans XML editor.

2. In the nodes list of the file, create a new node-object element, substituting the object name for object, as shown below.

   <node-Phone>
   </node-Phone>

3. For any child objects, define the following attributes.

   • display-order – The order in which the child object types are displayed in the tree view pane on the EDM pages.

   • merge-must-delete – An indicator of whether EDM users must specify which the instances of the child object type to retain during a system record merge. Specify false to allow EDM users to select the child objects to retain or to accept the default objects (the default objects are those in the destination system). Specify true to force the user to select the child objects to retain. This allows you to hide certain child object types on the EDM while forcing the user to specify which visible child objects to retain.

     For example:

     <node-Phone display-order="3" merge-must-delete="false">
     </node-Phone>

4. Define fields for the new object, as described in Adding Fields to the EDM.
5. Define the relationship of the object, as described in Defining EDM Object Relationships (Repository).
6. Save and close the file.

Modifying EDM Objects

Once an object is defined in the Enterprise Data Manager file, you can modify the name or display order. Only modify the name of an object if you modify the corresponding object name in the Object Definition file and the remaining configuration files. Do not change the parent object name. If you modify an object in the object definition on the Configuration Editor, the the Enterprise Data Manager file is automatically updated as well.

To Modify an EDM Object

1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click the Enterprise Data Manager file.

   The file opens in the NetBeans XML editor.

2. Scroll to the node element naming the object to modify.
3. To modify the object name, change the value of the node element to node-object_name, where object_name is the new name for the object.
4. To modify the location of the object in the EDM tree structure, change the value of the display-order attribute.

   For example:

   <node-Alias display-order="2">

5. If necessary, renumber the order of other child objects so they are sequential.
6. Save and close the file.

Deleting Objects From the EDM

Once an object is defined in the Enterprise Data Manager file, you can remove the object. If the object remains defined in the Object Definition file, then the object is still a part of the enterprise record, but does not appear on the EDM. Before removing an object from the the Enterprise Data Manager file, make sure none of its fields are required in order to create a new record. If you delete an object using the Configuration Editor, the object is automatically deleted from the Enterprise Data Manager file.

To Delete an Object

1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click the Enterprise Data Manager file.

   The file opens in the NetBeans XML editor.

2. Scroll to the node element naming the object to delete.
3. Delete all text between and including the node element for that object.

   Using the sample below, to delete the Phone object, delete all the text in the sample.

   <node-Phone display-order="3" merge-must-delete="false">
      <field-PhoneType>
         <display-name>Phone Type</display-name>
         <display-order>1</display-order>
         <max-length>8</max-length>
         <gui-type>MenuList</gui-type>
         <value-list>PHONTYPE</value-list>
         <value-type>string</value-type>
         <key-type>true</key-type>
      </field-PhoneType>
      <field-Phone>
         <display-name>Phone</display-name>
         <display-order>2</display-order>
         <max-length>20</max-length>
         <gui-type>TextBox</gui-type>
         <value-type>string</value-type>
         <input-mask>(DDD)DDD-DDDD</input-mask>
         <value-mask>xDDDxDDDxDDDD</value-mask>
      </field>
   </node>

4. If necessary, renumber the order of the remaining objects so they are sequential.
5. Remove the object from the relationship definition, as described in Defining Relationships Between Master Index Objects (Repository).
6. Save and close the file.

Adding Fields to the EDM

You can define new fields for an object in the Enterprise Data Manager file, but the field must correspond with a field defined for that object in the Object Definition file. Only the fields defined in the Enterprise Data Manager file appear on the EDM windows. If you add a field to the object structure using the Configuration Editor, it is automatically added to the Enterprise Data Manager file.

To Define New Fields

1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click the Enterprise Data Manager file.

   The file opens in the NetBeans XML editor.

2. Scroll to the node element that defines the object to which you want to add a field.
3. In the node element, create a new element named field-, where field_name is the name of the field as it appears in the Object Definition file.

   For example:

   <node-Person>
      <field-LastName>
      </field-LastName>
   </node>

4. Define and configure the elements listed inEDM Field Configuration Elements for the new field-field_name element.

   For example:

   <field-LastName>
      <display-name>LastName</display-name>
      <display-order>2</display-order>
      <max-length>40</max-length>
      <gui-type>TextBox</gui-type>
      <value-type>string</value-type>
      <is-sensitive>false</is-sensitive> 
      <key-type>false</key-type>
   </field-LastName>

5. If necessary, renumber any existing fields to keep the numbering sequential.
6. Save and close the file.

EDM Field Configuration Elements

The following table lists and describes the XML elements that define the fields that appear on the Enterprise Data Manager.

Removing Fields From the EDM

If a field is defined for an object in the Enterprise Data Manager file, that field appears on the EDM windows. If there are any fields defined in the object structure that you do not want to display on the EDM, you can remove the field definition from the Enterprise Data Manager file. If you remove a field from the object structure using the Configuration Editor, it is automatically removed from the Enterprise Data Manager file.

To Remove a Field From the EDM

1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click the Enterprise Data Manager file.

   The file opens in the NetBeans XML editor.

2. Scroll to the field element that defines the field you want to remove.
3. Delete the field elements that define the field you want to remove.
4. If necessary, renumber the remaining fields, as described in Modifying EDM Field Display Options.
5. Save and close the file.

Modifying EDM Field Display Options

Once a field is defined for an object in the Enterprise Data Manager file, you can change the name that appears on the EDM for that field, the location of the field, and the type for the field (such as text box, menu list, and so on).

To Modify a Field’s Display Options

1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click the Enterprise Data Manager file.

   The file opens in the NetBeans XML editor.

2. Scroll to the node element that defines the object that contains the field you want to modify.
3. Scroll to the field element you want to modify, .
4. To modify the field label, change the value of the display-name element.

   For example:

   <display-name>Last Name</display-name>

5. To modify the location of the field on the EDM, change the value of the display-order element.

   For example:

   <display-order>1</display-order>

   ---

   Note - If you change the order of one field, you must change the order of at least one other field to maintain sequential numbering. For example, if you change a field’s location from “2” to “1”, you must then change the location of the field originally specified for location 1.

   ---

6. To modify the type of field to display, change the value of the gui-type element.

   For example:

   <gui-type>TextBox</gui-type>

   ---

   Note - You can enter TextBox (for a standard field), MenuList (for a field whose value must be selected from a drop-down list), or TextArea (for a long field that requires a scrollbar).

   ---

7. Save and close the file.

Specifying a Drop-Down List for an EDM Field

Once a field is defined for an object in the Enterprise Data Manager file, you can specify or change the name of the drop-down list for the field. If you modify the Code Module for the field in the Configuration Editor, the drop–down list is automatically updated in the Enterprise Data Manager file.

To Specify a Drop-Down List

1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click the Enterprise Data Manager file.

   The file opens in the NetBeans XML editor.

2. Scroll to the node element that defines the object containing the field you want to modify.
3. Scroll to the field element you want to modify.
4. Enter the name of the drop-down list in the value-list element.

   If the element does not exist for the field, create a new value-list element. For example:

   <value-list>STATE</value-list>

   ---

   Note - The value of the gui-type element for the field must be “MenuList” if you specify a drop-down list. The value-list element must match a code column value in the sbyn_common_header database table unless the drop-down list is populated by information in the sbyn_user_code table (as they might be for auxiliary IDs). In this case, the value-list element must match a code_list column value in sbyn_user_code.

   ---

5. Save and close the file.

Specifying an EDM Field’s Length and Format

Once a field is defined for an object in the Enterprise Data Manager file, you can change the number of characters that can be entered for the field in the EDM. You can also specify whether to automatically enter punctuation into a field on the EDM, but remove the punctuation in the database. If you modify the field's length and format in the object structure using the Configuration Editor, the Enterprise Data Manager file is automatically updated as well.

To Modify a Field’s Length and Format

1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click the Enterprise Data Manager file.

   The file opens in the NetBeans XML editor.

2. Scroll to the node element that defines the object containing the field you want to modify.
3. Scroll to the field element you want to modify.
4. To modify the length of a field, change the value of the max-length element.

   For example:

   <max-length>100</max-length>

5. To modify the format of the field, change the value of the input-mask and value-mask elements.

   If these element do not exist for the field, create new input-mask and value-mask elements. For example:

   <input-mask>(DDD)DDD-DDDD</input-mask>
   <value-mask>xDDDxDDDxDDDD</value-mask>

   ---

   Note - If an input mask is defined, in most cases a value mask must also be defined. For information about input and value masks, see EDM Field Configuration Elements.

   ---

6. Save and close the file.

Modifying an EDM Field's Data Type

Each field on the EDM requires a specific type of data to be entered. For example, name fields generally require a data string and date fields require a valid date or numeric characters. The type of data defined for each field must correspond with the field type defined for that field in the Object Definition file and in the database. If you modify a field's data type in the object structure using the Configuration Editor, the Enterprise Data Manager file is automatically updated as well.

To Modify the Data Type

1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click the Enterprise Data Manager file.

   The file opens in the NetBeans XML editor.

2. Scroll to the node element that defines the object that contains the field you want to modify.
3. Scroll to the field element you want to modify.
4. Change the value of the value-type element.

   For example:

   <value-type>string</value-type>

5. Save and close the file.

Defining Key Fields for an Object (Repository)

You can specify that a certain field or combination of fields be unique in a system object or SBR. An example of a unique fields would be the address type if only one address of each type is allowed. A field’s key type status in the Enterprise Data Manager file must match its key type status in the Object Definition file. If you modify a field's key type status in the object structure using the Configuration Editor, the Enterprise Data Manager file is automatically updated as well.

To Modify the Key Status

1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click the Enterprise Data Manager file.

   The file opens in the NetBeans XML editor.

2. Scroll to the node element that defines the object containing the field you want to modify.
3. Scroll to the field element you want to modify.
4. To specify that a field must be unique in a system object, change the value of the key-type element to true.
5. To specify that a field does not need to be unique in a system object, change the value of the key-type element to false.

   For example:

   <key-type>false</key-type>

6. To specify that a combination of fields must be unique for an object rather than just one single field, set the key-type element to true for each field.
7. Save and close the file.

Masking Field Values on the EDM

You can specify that the values of certain fields be hidden on the EDM from users without the appropriate access permissions. You can create a custom plug-in that uses the value of the VIP Flag field to determine whether the values of specified fields are hidden (typically in records with a VIP status of “VIP” or “Employee”). In records with any other VIP status, the field values would be visible regardless of whether the field is marked for masking.

This option is only available if the object-sensitive-plug-in-class element in the impl-details section is populated with the custom plug-in class (by default, this element is empty).

To Mask Field Values on the EDM

1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click the Enterprise Data Manager file.

   The file opens in the NetBeans XML editor.

2. Scroll to the node element that defines the object containing the field you want to modify.
3. Scroll to the field element you want to modify.
4. Change the value of the is-sensitive element to true.

   If the element does not exist for the field, create a new is-sensitive element. For example:

   <is-sensitive>true</is-sensitive>

   ---

   Note - The is-sensitive element must appear before the key-type element in the field definition.

   ---

5. Save and close the file.

Defining EDM Object Relationships (Repository)

The relationships in the Enterprise Data Manager file are predefined based on the information you provided when you created the object structure definition (the Object Definition file). The relationship structure in the Enterprise Data Manager file should match that of the Object Definition file.

To Define Relationships

1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click the Enterprise Data Manager file.

   The file opens in the NetBeans XML editor.

2. Scroll to the relationships element.
3. Specify the name of the parent object in the name element.
4. Specify the name of the child objects in the children elements.

   For example:

   <relationships>
      <name>Person</name>
      <children>Alias</children>
      <children>Address</children>
      <children>Phone</children>
      <children>AuxId</children>
   </relationships>

5. To remove a child object from the relationships list, delete the children element defining the object you want to delete.
6. Save and close the file.

Defining EDM Local ID Labels (Repository)

The system-display-name-overrides element, which is nested in the gui-definition element, defines alternate names for the local ID headings and labels. The name defined here replaces the default local ID heading and field names on all pages, including the search result column names. This element is optional, and if it does not exist the label names default to “Local ID”. If the value of either of the sub-elements is missing, the label names also default to “Local ID”.

To Define Local ID Labels

1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click the Enterprise Data Manager file.

   The file opens in the NetBeans XML editor.

2. Scroll to the system-display-name-overrides element in the gui-definition element.
3. Modify any of the following elements.

   • local-id-header – The name to use for the header label of the local ID search section of the EDM Lookup window.

   • local-id – The name to use for all fields and columns containing local IDs. In fields where the local ID label is abbreviated to “LID1” or “LID2”, the name becomes local-id1 or local-id2 (where local-id is the value specified for this element).

   For example:

      <gui-definition>
         <system-display-name-overrides>
            <local-id-header>System Identifier</local-id-header>
            <local-id>System ID</local-id>
         </system-display-name-overrides>
         ...

4. Save and close the file.