Difference between revisions of "Add Custom Defined Fields"

From IMSMA Wiki
Jump to: navigation, search
 
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
{{note|Custom defined fields must have a unique combination of item, label, and data type.  
+
{{New_6.0|Custom defined fields must have a unique combination of item, '''name''' and data type. }}
−
}}
 
  
−
To add a custom defined field:
+
[[Image:DIM category.png|600px|center]]
 
<ol>
 
<ol>
−
<li>From the '''Customisation''' menu, select '''Data Inventory Manager'''.</li>
+
<li>In the '''Customisation''' menu &rarr; '''Data Inventory Manager'''.</li>
−
:The Data Inventory Manager window displays.
+
<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>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>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 the right pane of the Data Inventory Manager window, click the [[Image:FieldTemplateIcon.png]] button.</li>
+
<li>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'']]
 
[[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
−
<ol start="4">
+
# maximum 60 characters long
−
<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. The label should be no longer than 50 characters and should not contain periods (.) or underscores (_).</li>
+
# only allowed characters are a - z and 0 - 9 i.e. <br/>
−
<li>Select the data type for the custom defined field from the '''Data Type''' list.</li>
+
::* cannot contain . , /  \ ( ) ! ? - @
−
</ol>
+
::* 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>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" | Table 46. Data Types for Custom Defined Fields
+
! colspan="2" | Data Types for Custom Defined Fields
 
|-
 
|-
 
! Data Type
 
! Data Type
Line 28: Line 29:
 
|-
 
|-
 
| Text Field  
 
| Text Field  
−
| ≤250 characters
+
| unlimited characters
 
|-
 
|-
 
| Date
 
| Date
−
| Month, day, year
+
| timestamp (2016-12-01 15:33:59.187)
 
|-
 
|-
 
| Number
 
| Number
−
| ≤15 decimal points
+
| with 6 decimals
 
|-
 
|-
 
| Organisation
 
| Organisation
−
| Allows the user to select organisational data
+
| Allows the user to select an Organisation
 
|-
 
|-
 
| Place
 
| Place
−
| Allows the user to select place data
+
| Allows the user to select a Place
 
|-
 
|-
 
| Country Structure
 
| Country Structure
−
| Allows the user to select country structure level data
+
| Allows the user to select from the Country structure  
 
|-
 
|-
−
| List Multiple Selections
+
| Multiple Select
−
| Allows the user to select zero or more values provided in the '''List Values''' field.
+
| Allows the user to select zero or more values provided in the '''CDF Values''' field  
 
|-
 
|-
−
| List One Selection
+
| Single Select
−
| Allows the user to select one value from provided values in the '''List Values''' field.
+
| Allows the user to select one value from provided values in the '''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>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>Go through the checklist for implementation of '''[[Custom Defined Fields]]'''.</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>
 
</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 values for lists, be sure to:
+
=== Adding values for multi- and single-select CDFs===__NOEDITSECTION__
−
*Enter values in the order that you would like them to display to the user
+
If you selected the ''Multiple Select'' or ''Single Select'' option, click the [[Image:FieldTemplateIcon.png]] button.
−
*Enter values in the language in which the users will use IMSMA
+
[[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.
  
−
<ol start="10">
+
{{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. }}
−
<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>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.</li>
 
−
<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 Data Entry Form Manager.
 
−
</ol>
 
−
 
 
−
{{note|If you would like to add the custom defined field to existing data entry form templates, you will need to update and republish the data entry form template.
 
−
}}
 
−
 
 
−
<ol>
 
−
*To discard the custom defined field and close the CDF Editor window, click the '''Cancel''' button.
 
−
</ol>
 
  
 
{{NavBox HowTo Data Elements}}
 
{{NavBox HowTo Data Elements}}
 +
[[Category:NAA]]

Latest revision as of 17:08, 15 June 2017

New 6.0.png Custom defined fields must have a unique combination of item, name and data type.
DIM category.png
  1. In the Customisation menu → Data Inventory Manager.
  2. Search the Data Inventory Manager before you add a CDF in order to make sure that a suitable system field does not already exist.
  3. 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.
  4. In the right pane of the Data Inventory Manager window, click the FieldTemplateIcon.png button.
    5. CDF Editor Window

    CDF Editor Window

  5. Enter a name in the Name field. The name should be
    1. maximum 60 characters long
    2. 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.
  6. 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.
  7. 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
    8. Note.jpg 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.

  8. Enter a description for the custom defined field in the Description field.
  9. Go through the checklist for implementation of Custom Defined Fields.

Display options for single-select and text CDFs

Display formats

Display formats

For Text and Single Select CDFs, there are two different display formats to choose between.

New 6.0.png 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 FieldTemplateIcon.png button.

Add multi- and single-select value window

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.

Note.jpg 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.
Data Inventory Manager
Search
Enumeration Lists
Retrieved from "http://mwiki.gichd.org:8090/mediawiki/index.php?title=Add_Custom_Defined_Fields&oldid=23514"