0
edits
Changes
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..."
{{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, select '''Data Inventory Manager'''.</li>
:The Data Inventory Manager window displays.
<li>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.</li>
<li>From the right pane of the Data Inventory Manager window, click the [[Image:FieldTemplateIcon.png]] button.</li>
:The CDF Editor window displays.
</ol>
[[Image:UserManual_CDFEditorWindow.png|center|500px|''CDF Editor Window'']]
<div align="center">
''CDF Editor Window''
</div>
<ol start="4">
<li>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 (_).</li>
<li>Select the data type for the custom defined field from the '''Data Type''' list.</li>
</ol>
{| class="wikitable"
! colspan="2" | 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
|-
| 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.
|-
|}
<ol start="6">
<li>Enter a description for the custom defined field in the '''Description''' field.</li>
<li>If the CDF is active, check the '''Active''' checkbox.</li>
<li>If you selected the ''List Multiple Selection'' or ''List One Selection'' option, click the [[Image:FieldTemplateIcon.png]] button.</li>
:The Add window displays.
<li>Enter the value for the list in the '''Value''' field.</li>
</ol>
{{note|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
}}
<ol start="10">
<li>Do one of the following:</li>
*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.
<li>Enter a description for the custom defined field in the '''Description''' field.</li>
</ol>
{{note|You can also translate the label and, if applicable, list option values by clicking the '''Translate''' button at this time.
}}
<ol start="12">
<li>Do one of the following:</li>
*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.
</ol>
{{note|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.
}}
To add a custom defined field:
<ol>
<li>From the '''Customisation''' menu, select '''Data Inventory Manager'''.</li>
:The Data Inventory Manager window displays.
<li>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.</li>
<li>From the right pane of the Data Inventory Manager window, click the [[Image:FieldTemplateIcon.png]] button.</li>
:The CDF Editor window displays.
</ol>
[[Image:UserManual_CDFEditorWindow.png|center|500px|''CDF Editor Window'']]
<div align="center">
''CDF Editor Window''
</div>
<ol start="4">
<li>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 (_).</li>
<li>Select the data type for the custom defined field from the '''Data Type''' list.</li>
</ol>
{| class="wikitable"
! colspan="2" | 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
|-
| 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.
|-
|}
<ol start="6">
<li>Enter a description for the custom defined field in the '''Description''' field.</li>
<li>If the CDF is active, check the '''Active''' checkbox.</li>
<li>If you selected the ''List Multiple Selection'' or ''List One Selection'' option, click the [[Image:FieldTemplateIcon.png]] button.</li>
:The Add window displays.
<li>Enter the value for the list in the '''Value''' field.</li>
</ol>
{{note|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
}}
<ol start="10">
<li>Do one of the following:</li>
*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.
<li>Enter a description for the custom defined field in the '''Description''' field.</li>
</ol>
{{note|You can also translate the label and, if applicable, list option values by clicking the '''Translate''' button at this time.
}}
<ol start="12">
<li>Do one of the following:</li>
*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.
</ol>
{{note|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.