Add Subobject Custom Defined Fields

From IMSMA Wiki
Revision as of 17:33, 6 March 2013 by Joe (talk | contribs) (Created page with "{{note|Custom defined fields must have a unique combination of item, label, and data type. }} To add a custom defined field: <ol> <li>From the '''Customisation''' menu, sele...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Note.jpg Custom defined fields must have a unique combination of item, label, and data type.

To add a custom defined field:

  1. From the Customisation menu, select Data Inventory Manager.
  2. The Data Inventory Manager window displays.
  3. From the left pane of the Data Inventory Manager window, select the item and data category to which you would like to add a CDF.
  4. From the right pane of the Data Inventory Manager window, click the FieldTemplateIcon.png button.
  5. The CDF Editor window displays.
CDF Editor Window

CDF Editor Window

  1. Enter a label in the Label field. The label is the default custom defined field’s name that the user will see in the Field Report Manager window. The label should be no longer than 50 characters and should not contain periods (.) or underscores (_).
  2. Select the data type for the custom defined field from the Data Type list.
Table 46. Data Types for Custom Defined Fields
Data Type Description and Comments
Text Field ≤250 characters
Date Month, day, year
Number ≤15 decimal points
Organisation Allows the user to select organisational data
Place Allows the user to select place data
Country Structure Allows the user to select country structure level data
List Multiple Selections Allows the user to select zero or more values provided in the List Values field.
List One Selection Allows the user to select one value from provided values in the List Values field.
  1. Enter a description for the custom defined field in the Description field.
  2. If the CDF is active, check the Active checkbox.
  3. If you selected the List Multiple Selection or List One Selection option, click the FieldTemplateIcon.png button.
  4. The Add window displays.
  5. Enter the value for the list in the Value field.
Note.jpg When entering values for lists, be sure to:
  • Enter values in the order that you would like them to display to the user
  • Enter values in the language in which the users will use IMSMA
  1. Do one of the following:
    • If you would like to save the value and enter additional values, click the Save button.
    • If you have completed entering the values for the list, click the Done button.
  2. If you selected the List Single Selection option, chose an option from the Selection Display field to display the CDF as either a list of radio buttons or as a combo box.
  3. Enter a description for the custom defined field in the Description field.
Note.jpg You can also translate the label and, if applicable, list option values by clicking the Translate button at this time.
  1. Do one of the following:
    • To save the custom defined field and close the CDF Editor window, click the Save button.
    If the custom defined field information is successfully saved, the CDF Editor window closes and the custom defined field is listed in the Data Inventory Manager window. After the custom defined field is added, it becomes available from the folder of the data category in which it was created in the Field Report Manager.
Note.jpg If you would like to add the custom defined field to existing field report templates, you will need to update and republish the field report template.
    • To discard the custom defined field and close the CDF Editor window, click the Cancel button.