Changes

Jump to: navigation, search

Add Custom Defined Fields

202 bytes added, 18:08, 15 June 2017
no edit summary
{{noteNew_6.0|Custom defined fields must have a unique combination of item, label, '''name''' and data type. }}
To add a custom defined field[[Image:DIM category.png|600px|center]]
<ol>
<li>From In the '''Customisation''' menu, select &rarr; '''Data Inventory Manager'''.</li>:The <li>'''[[Filter Item Attributes | Search]]''' the Data Inventory Manager window displaysbefore you add a CDF in order to make sure that a suitable system field does not already exist.</li><li>From 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>From In the right pane of the Data Inventory Manager window, click the [[Image:FieldTemplateIcon.png]] button.</li>:The CDF Editor window displays.</ol>
[[Image:CDFEditor.png|center|500px|''CDF Editor Window'']]
<div align="center">
''CDF Editor Window''
</div></li><li>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. <ol br/>::* cannot contain . , / \ ( ) ! ? - @ ::* cannot contain space/blanks::* cannot contain capital/upper case character::* cannot start="4"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 Field Report Data Entry Form 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.<The general recommendation is to avoid text fields if the CDF will be used for search/li><filter, statistics, maps and/ol>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"
! colspan="2" | Table 46. Data Types for Custom Defined Fields
|-
! Data Type
|-
| Text Field
| ≤250 unlimited characters
|-
| Date
| Month, day, yeartimestamp (2016-12-01 15:33:59.187)
|-
| Number
| ≤15 decimal pointswith 6 decimals
|-
| Organisation
| Allows the user to select organisational dataan Organisation
|-
| Place
| Allows the user to select place dataa Place
|-
| Country Structure
| Allows the user to select country from the Country structure level data
|-
| List Multiple SelectionsSelect| Allows the user to select zero or more values provided in the '''List CDF Values''' field.
|-
| List One SelectionSingle Select| Allows the user to select one value from provided values in the '''List CDF Values''' field.
|-
|}
</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.}}
<ol start="6">
<li>Enter a description for the custom defined field in the '''Description''' field.</li>
<li>If Go through the CDF is active, check the '''Active''' checkbox.</li><li>If you selected the ''List Multiple Selection'' or 'checklist for implementation of 'List One Selection'' option, click the [[Image:FieldTemplateIcon.pngCustom Defined Fields]] button.</li>:The Add window displays.<li>Enter the value for the list in the '''Value''' field.</li>
</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.}}
{{note|When entering === Adding 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 startmulti- and single-select CDFs==="10"><li>Do one of the following:</li>__NOEDITSECTION__ *If you would like to save the value and enter additional values, click selected the ''Multiple Select'' or 'Save'Single Select'' option, click the [[Image:FieldTemplateIcon.png]] button.*If you have completed entering the values for the list, click the [[Image:CDF value.png|center|300px|'''Done'Add multi- and single-select value window'' button.]]<lidiv align="center">If you selected the ''List Single SelectionAdd multi- and single-select value window'' 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.</lidiv> <li>Enter a description the value for the custom defined field list in the '''DescriptionValue''' field.</li></ol> {{note|You can also translate When you have completed entering the label and, if applicable, list option values by clicking for 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 windowlist, click the '''SaveDone''' 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>
{{noteNote|If you would like to add You can also translate the custom defined field to existing field report templateslabel and, if applicable, you will need to update and republish list option values by clicking the field report template'''Translate''' button at this time. See [[Translate Custom Defined Fields]] for more information.}}
<ol>{{NavBox HowTo Data Elements}}*To discard the custom defined field and close the CDF Editor window, click the '''Cancel''' button.</ol>[[Category:NAA]]
6,632
edits

Navigation menu