Difference between revisions of "Add Custom Defined Fields"
From IMSMA Wiki
(Version 6.0) |
|||
(13 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | {{ | + | {{New_6.0|Custom defined fields must have a unique combination of item, '''name''' and data type. }} |
− | }} | ||
− | + | [[Image:DIM category.png|600px|center]] | |
<ol> | <ol> | ||
− | <li> | + | <li>In the '''Customisation''' menu → '''Data Inventory Manager'''.</li> |
− | + | <li>'''[[Filter Item Attributes | Search]]''' the Data Inventory Manager before you add a CDF in order to make sure that a suitable system field does not already exist.</li> | |
− | <li> | + | <li>In the left pane of the Data Inventory Manager window, select the item and the data category to which you would like to add a CDF.</li> |
− | <li> | + | <li>In the right pane of the Data Inventory Manager window, click the [[Image:FieldTemplateIcon.png]] button.</li> |
− | |||
− | |||
[[Image:CDFEditor.png|center|500px|''CDF Editor Window'']] | [[Image:CDFEditor.png|center|500px|''CDF Editor Window'']] | ||
<div align="center"> | <div align="center"> | ||
''CDF Editor Window'' | ''CDF Editor Window'' | ||
− | </div> | + | </div></li> |
− | + | <li>Enter a name in the Name field. The name should be | |
− | < | + | # maximum 60 characters long |
− | <li>Enter a name in the Name field. The name should be | + | # only allowed characters are a - z and 0 - 9 i.e. <br/> |
+ | ::* cannot contain . , / \ ( ) ! ? - @ | ||
+ | ::* cannot contain space/blanks | ||
+ | ::* cannot contain capital/upper case character | ||
+ | ::* cannot start with a digit.</li> | ||
<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 Data Entry Form Manager window. </li> | <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 Data Entry Form Manager window. </li> | ||
− | <li>Select the data type for the custom defined field from the '''Data Type''' list. | + | <li>Select the data type for the custom defined field from the '''Data Type''' list. The general recommendation is to avoid text fields if the CDF will be used for search/filter, statistics, maps and/or data quality. Users will enter data differently in text fields e.g. many different spellings of an organisation name so it is preferable to use data entry widgets where the user selects over text widget. |
− | |||
{| class="wikitable" | {| class="wikitable" | ||
− | ! colspan="2" | | + | ! colspan="2" | Data Types for Custom Defined Fields |
|- | |- | ||
! Data Type | ! Data Type | ||
Line 29: | Line 29: | ||
|- | |- | ||
| Text Field | | Text Field | ||
− | | | + | | unlimited characters |
|- | |- | ||
| Date | | Date | ||
− | | | + | | timestamp (2016-12-01 15:33:59.187) |
|- | |- | ||
| Number | | Number | ||
− | | | + | | with 6 decimals |
|- | |- | ||
| Organisation | | Organisation | ||
− | | Allows the user to select | + | | Allows the user to select an Organisation |
|- | |- | ||
| Place | | Place | ||
− | | Allows the user to select | + | | Allows the user to select a Place |
|- | |- | ||
| Country Structure | | Country Structure | ||
− | | Allows the user to select | + | | Allows the user to select from the Country structure |
|- | |- | ||
| Multiple Select | | Multiple Select | ||
Line 53: | Line 53: | ||
|- | |- | ||
|} | |} | ||
+ | </li> | ||
+ | {{note| When creating single-select enumeration lists, information managers should include a “Not specified” value, which users can select when no value was provided in the data collection. This value facilitate creating statistics and data quality work. | ||
+ | Data type cannot be changed after creation of the CDF.}} | ||
− | |||
<li>Enter a description for the custom defined field in the '''Description''' field.</li> | <li>Enter a description for the custom defined field in the '''Description''' field.</li> | ||
− | <li> | + | <li>Go through the checklist for implementation of '''[[Custom Defined Fields]]'''.</li> |
− | |||
− | |||
− | |||
</ol> | </ol> | ||
+ | === Display options for single-select and text CDFs===__NOEDITSECTION__ | ||
+ | [[Image:CDF display format.png|center|500px|''Display formats'']] | ||
+ | <div align="center"> | ||
+ | ''Display formats'' | ||
+ | </div> | ||
+ | For Text and Single Select CDFs, there are two different display formats to choose between. | ||
+ | {{New_6.0 | In version 6.0 two different display formats for Text fields has been introduced.}} | ||
− | + | === Adding values for multi- and single-select CDFs===__NOEDITSECTION__ | |
− | + | If you selected the ''Multiple Select'' or ''Single Select'' option, click the [[Image:FieldTemplateIcon.png]] button. | |
− | + | [[Image:CDF value.png|center|300px|''Add multi- and single-select value window'']] | |
− | + | <div align="center"> | |
− | + | ''Add multi- and single-select value window'' | |
− | + | </div> | |
− | + | Enter the value for the list in the '''Value''' field. | |
− | + | When you have completed entering the values for the list, click the '''Done''' button. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | < | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | {{Note|You can also translate the label and, if applicable, list option values by clicking the '''Translate''' button at this time. See [[Translate Custom Defined Fields]] for more information. }} | |
− | |||
− | |||
{{NavBox HowTo Data Elements}} | {{NavBox HowTo Data Elements}} | ||
+ | [[Category:NAA]] |
Latest revision as of 17:08, 15 June 2017
Custom defined fields must have a unique combination of item, name and data type. |
- In the Customisation menu → Data Inventory Manager.
- Search the Data Inventory Manager before you add a CDF in order to make sure that a suitable system field does not already exist.
- In the left pane of the Data Inventory Manager window, select the item and the data category to which you would like to add a CDF.
- In the right pane of the Data Inventory Manager window, click the button.
- Enter a name in the Name field. The name should be
- maximum 60 characters long
- only allowed characters are a - z and 0 - 9 i.e.
- cannot contain . , / \ ( ) ! ? - @
- cannot contain space/blanks
- cannot contain capital/upper case character
- cannot start with a digit.
- Enter a label in the Label field. The label is the default custom defined field’s name that the user will see in the Data Entry Form Manager window.
- Select the data type for the custom defined field from the Data Type list. The general recommendation is to avoid text fields if the CDF will be used for search/filter, statistics, maps and/or data quality. Users will enter data differently in text fields e.g. many different spellings of an organisation name so it is preferable to use data entry widgets where the user selects over text widget.
Data Types for Custom Defined Fields Data Type Description and Comments Text Field unlimited characters Date timestamp (2016-12-01 15:33:59.187) Number with 6 decimals Organisation Allows the user to select an Organisation Place Allows the user to select a Place Country Structure Allows the user to select from the Country structure Multiple Select Allows the user to select zero or more values provided in the CDF Values field Single Select Allows the user to select one value from provided values in the CDF Values field - Enter a description for the custom defined field in the Description field.
- Go through the checklist for implementation of Custom Defined Fields.
CDF Editor Window
Display options for single-select and text CDFs
Display formats
For Text and Single Select CDFs, there are two different display formats to choose between.
In version 6.0 two different display formats for Text fields has been introduced. |
Adding values for multi- and single-select CDFs
If you selected the Multiple Select or Single Select option, click the button.
Add multi- and single-select value window
Enter the value for the list in the Value field. When you have completed entering the values for the list, click the Done button.
You can also translate the label and, if applicable, list option values by clicking the Translate button at this time. See Translate Custom Defined Fields for more information. |
|