Difference between revisions of "Add values to enumeration list"

From IMSMA Wiki
Jump to: navigation, search
 
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
{{note|Adding a custom option will not automatically update existing field report templates that use the custom options field.  
+
{{Warning | Several of the enumeration lists are used by more than one field. Adding a value to an enumeration list will affect '''ALL''' fields that use that same enumeration list.
−
}}
+
The enumeration list/category ''Yes No Answer'' are used by 86 fields. 42 of the 186 enumeration lists/categories are used by more than one field. }}
  
−
To add a custom option:
+
<center>
 +
{| class="wikitable"
 +
|-
 +
| [[Image:CustomOptionsList warning1.png|400px]]
 +
| width="10pt" |
 +
| [[Image:CustomOptionsList warning2.png|400px]]
 +
|-
 +
| The values ''Ferrimagnetic'' and ''Titanomagnetites'' are added.
 +
|
 +
| The other fields that uses the same enumeration list are also affected.
 +
|}
 +
</center>
 +
 
 +
Before adding values to enumeration lists:
 +
# consult the '''[[Data Dictionary]]'''
 +
# look up which enumeration list/category is used
 +
# consult the page [[Enumeration categories]] and verify that the category that you are about to update is not listed.
 +
# is it possible to edit slightly the translation of an existing enumeration value instead of adding a value?
 +
 
 +
As an example the field ''Type of Infrastructure Blocked'' which used the enumeration list/category ''InfrastructureBlock'' will be used.
 
<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.
+
[[Image:DIM enum.png|600px|center]]
−
<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 custom option.</li>
+
<li>In the left pane of the Data Inventory Manager window, expand the item and data category where the the field is which uses the enumeration list.</li>
−
<li>From the right pane, click the row associated with the item attribute that you would like add a custom option value.</li>
+
<li>In the right pane, click the row associated with the field that you would like to add a enumeration value to.
−
<li>Click the [[Image:FieldViewIcon.png]] button.</li>
+
: Only system fields of types Multiple Select or Single Select use enumeration lists.</li>
−
:The Custom Options List window displays.
+
<li>Click the [[Image:FieldViewIcon.png]] button. </li>
  
−
[[Image:CustomOptionsList.png|center|500px|''Custom Options List Window'']]
+
[[Image:CustomOptionsList.png|center|400px|''Custom Options List Window'']]
 
<div align="center">
 
<div align="center">
 
''Custom Options List Window''
 
''Custom Options List Window''
 
</div>
 
</div>
 +
<li>As an example: it has been decided that ''Medical Facility'' is not detailed enough. ''Health Care Center'' and ''Hospital'' should be used instead.</li>
 +
<li>In the Custom Options List window, click the [[Image:FieldTemplateIcon.png]] button.</li>
  
−
<ol start="5">
+
[[Image:UserManual_OptionsEditor.png|center|400px|''Options Editor'']]
−
From the Custom Options List window, click the [[Image:FieldTemplateIcon.png]] button.
 
−
:The Custom Options Editor window displays.
 
−
</ol>
 
−
 
 
−
[[Image:UserManual_OptionsEditor.png|center|500px|''Options Editor'']]
 
 
<div align="center">
 
<div align="center">
 
''Options Editor''
 
''Options Editor''
 
</div>
 
</div>
−
 
+
<li>Enter the option in the '''Option''' field. The value can be maximum 50 characters and can contain letters and numbers. Other characters should be avoided.</li>
−
<ol start="6">
+
<li>Click the '''Save''' button.</li>
−
<li>Enter the option in the '''Option''' field. The value can be less than or equal to 52 characters and can contain letters, numbers, and most special characters. However, the value should not contain a period (.).</li>
+
<li>Repeat until all values are added.</li>
−
<li>Do one of the following:</li>
+
<li>In this example the next step is to '''[[Inactivate values in enumeration lists | inactivate]]''' the value ''Medical facility''.</li>
−
*To save the option, click the '''Save''' button.
 
−
</ol>
 
−
 
 
−
{{note|After adding an option, you should update field report templates that use the custom options field.
 
−
}}
 
−
 
 
−
{{note|If you intend to translate the custom option via the IComboBox.Properties file, you will need to manually add the new custom option to the file.
 
−
}}
 
−
 
 
−
<ol>
 
−
*To discard the option, click the '''Cancel''' button.
 
 
</ol>
 
</ol>
−
<\li>
+
{{Note|Adding a value to an enumeration list will not automatically update existing Data Entry Form Templates that use the enumeration list.
 +
If the enumeration list/category that you would like to add a value to are used by more than one field and the value(s) you would like to add is '''not''' suitable for all affected fields <br/>
 +
then it is recommended to use a '''[[Add Custom Defined Fields | CDF]]''' instead.}}
 
{{NavBox HowTo Data Elements}}
 
{{NavBox HowTo Data Elements}}
 +
[[Category:NAA]]

Latest revision as of 19:16, 17 June 2017

Warning.jpg Several of the enumeration lists are used by more than one field. Adding a value to an enumeration list will affect ALL fields that use that same enumeration list.

The enumeration list/category Yes No Answer are used by 86 fields. 42 of the 186 enumeration lists/categories are used by more than one field.

CustomOptionsList warning1.png CustomOptionsList warning2.png
The values Ferrimagnetic and Titanomagnetites are added. The other fields that uses the same enumeration list are also affected.

Before adding values to enumeration lists:

  1. consult the Data Dictionary
  2. look up which enumeration list/category is used
  3. consult the page Enumeration categories and verify that the category that you are about to update is not listed.
  4. is it possible to edit slightly the translation of an existing enumeration value instead of adding a value?

As an example the field Type of Infrastructure Blocked which used the enumeration list/category InfrastructureBlock will be used.

  1. In the Customisation menu → Data Inventory Manager.
    2. DIM enum.png
  2. In the left pane of the Data Inventory Manager window, expand the item and data category where the the field is which uses the enumeration list.
  3. In the right pane, click the row associated with the field that you would like to add a enumeration value to.
    Only system fields of types Multiple Select or Single Select use enumeration lists.
  4. Click the FieldViewIcon.png button.
    5. Custom Options List Window

    Custom Options List Window

  5. As an example: it has been decided that Medical Facility is not detailed enough. Health Care Center and Hospital should be used instead.
  6. In the Custom Options List window, click the FieldTemplateIcon.png button.
    7. Options Editor

    Options Editor

  7. Enter the option in the Option field. The value can be maximum 50 characters and can contain letters and numbers. Other characters should be avoided.
  8. Click the Save button.
  9. Repeat until all values are added.
  10. In this example the next step is to inactivate the value Medical facility.
Note.jpg Adding a value to an enumeration list will not automatically update existing Data Entry Form Templates that use the enumeration list.

If the enumeration list/category that you would like to add a value to are used by more than one field and the value(s) you would like to add is not suitable for all affected fields
then it is recommended to use a CDF instead.

Data Inventory Manager
Search
Enumeration Lists
Retrieved from "http://mwiki.gichd.org:8090/mediawiki/index.php?title=Add_values_to_enumeration_list&oldid=23625"