Difference between revisions of "Add Custom Defined Fields"

From IMSMA Wiki
Jump to: navigation, search
Line 1: Line 1:
 
{{New_6.0|Custom defined fields must have a unique combination of item, '''name''' 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>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 the 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.
 
  
 
[[Image:CDFEditor.png|center|500px|''CDF Editor Window'']]
 
[[Image:CDFEditor.png|center|500px|''CDF Editor Window'']]
Line 55: Line 54:
 
|}
 
|}
 
</li>
 
</li>
−
<li>Enter a description for the custom defined field in the '''Description''' field.
+
<li>Enter a description for the custom defined field in the '''Description''' field.</li>
−
[[Image:CDF display format.png|center|500px|''Disply formats'']]
+
</ol>
 +
=== Display options for single-select and text CDFs===__NOEDITSECTION__
 +
[[Image:CDF display format.png|center|500px|''Display formats'']]
 
<div align="center">
 
<div align="center">
 
''Display formats''
 
''Display formats''
−
</div></li>
+
</div>
−
<li>For Text and Single Select CDFs, there are two different display formats to choose between.
+
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.}}</li>
+
{{New_6.0 | In version 6.0 two different display formats for Text fields has been introduced.}}
−
<li>If you selected the ''Multiple Select'' or ''Single Select'' option, click the [[Image:FieldTemplateIcon.png]] button.
 
−
:The Add window displays.</li>
 
−
<li>Enter the value for the list in the '''Value''' field.
 
  
−
{{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
+
<li>If you selected the ''Multiple Select'' or ''Single Select'' option, click the [[Image:FieldTemplateIcon.png]] button.</li>
−
*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'']]
−
}}</li>
+
<div align="center">
−
<li>Do one of the following:
+
''Add multi- and single-select value window''
−
*If you would like to save the value and enter additional values, click the '''Save''' button.
+
</div>
−
*If you have completed entering the values for the list, click the '''Done''' button.</li>
+
<li>Enter the value for the list in the '''Value''' field.</li>
−
<li>If you selected the ''Single Select'' 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>When you have completed entering the values for the list, click the '''Done''' button.</li>
−
 
 
−
{{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 Field Labels]] for more information.
 
−
}}</li>
 
−
<li>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.
 
  
−
{{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.
+
{{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 Field Labels]] for more information. }}
−
}}
 
−
*To discard the custom defined field and close the CDF Editor window, click the '''Cancel''' button.
 
−
</li></ol>
 
  
 
{{NavBox HowTo Data Elements}}
 
{{NavBox HowTo Data Elements}}
 +
[[Category:NAA]]

Revision as of 23:43, 11 June 2017

New 6.0.png Custom defined fields must have a unique combination of item, name and data type.
DIM category.png
  1. From the Customisation menu, select Data Inventory Manager.
  2. 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.
  3. In the right pane of the Data Inventory Manager window, click the FieldTemplateIcon.png button.
    4. CDF Editor Window

    CDF Editor Window

  4. 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.
  5. 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.
  6. Select the data type for the custom defined field from the Data Type list.
    Data Types for Custom Defined Fields
    Data Type Description and Comments
    Text Field unlimited 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
    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
  7. Enter a description for the custom defined field in the Description field.

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 Field Labels 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=23258"