Difference between revisions of "Inactivate values in enumeration lists"

From IMSMA Wiki
Jump to: navigation, search
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
To inactivate a custom option:
+
{{Warning | Several of the enumeration lists are used by more than one field. Inactivating a value in 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. }}
 +
 
 +
Deactivating existing values does not delete the values from the database nor does it change existing data or Data Entry Form templates. Rather, it removes the values from the Source Tree in the Data Entry Form Template Designer so that the values can no longer be added to new templates.
 +
 
 +
Before inactivating values in 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.
 +
 
 
<ol>
 
<ol>
<li>From the '''Customisation''' menu, select '''Data Inventory Manager'''.
+
<li>In the '''Customisation''' menu &rarr; '''Data Inventory Manager'''.</li>
:The Data Inventory Manager window displays.</li>
+
[[Image:DIM enum.png|600px|center]]
<li>From the left pane of the Data Inventory Manager window, select the item or data category to which you would like to inactivate 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 you would like to inactivate an enumeration value for.</li>
<li>From the right pane, click the row associated with the item attribute that you would like inactivate a custom option value.</li>
+
<li>In the right pane, click the row associated with the field that you would like to inactivate an enumeration value for.</li>
<li>Click the [[Image:FieldViewIcon.png]] button.
+
<li>Click the [[Image:FieldViewIcon.png]] button. </li>
:The Custom Options List window displays. </li>
+
[[Image:CustomOptionsList.png|center|400px|''Custom Options List Window'']]
<li>From the Custom Options List window, click the row for the option that you would like to inactivate.</li>
+
<div align="center">
 +
''Custom Options List Window''
 +
</div>
 +
<li>In the Custom Options List window, select the row for the enumeration value that you would like to inactivate.</li>
 
<li>Click the [[Image:UserManual_CDFStatusIndicator.png]] Toggle Status button.
 
<li>Click the [[Image:UserManual_CDFStatusIndicator.png]] Toggle Status button.
:The option display changes from ''(Active)'' to ''(Inactive)''.</li>
+
:The enumeration value status changes from ''(Active)'' to ''(Inactive)''.</li>
 
<li>Click the '''Done''' button.</li>
 
<li>Click the '''Done''' button.</li>
 
</ol>
 
</ol>
  
{{note|After inactivating an option, you should update Data Entry Form templates that use the option. }}
+
{{note|After inactivating an enumeration value, you should update Data Entry Form templates that use the enumeration list. }}
  
 
{{NavBox HowTo Data Elements}}
 
{{NavBox HowTo Data Elements}}
 +
[[Category:NAA]]

Latest revision as of 21:50, 17 June 2017

Warning.jpg Several of the enumeration lists are used by more than one field. Inactivating a value in 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.

Deactivating existing values does not delete the values from the database nor does it change existing data or Data Entry Form templates. Rather, it removes the values from the Source Tree in the Data Entry Form Template Designer so that the values can no longer be added to new templates.

Before inactivating values in 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.
  1. In the Customisation menu → Data Inventory Manager.
  2. DIM enum.png
  3. In the left pane of the Data Inventory Manager window, expand the item and data category where the the field is which you would like to inactivate an enumeration value for.
  4. In the right pane, click the row associated with the field that you would like to inactivate an enumeration value for.
  5. Click the FieldViewIcon.png button.
  6. Custom Options List Window

    Custom Options List Window

  7. In the Custom Options List window, select the row for the enumeration value that you would like to inactivate.
  8. Click the UserManual CDFStatusIndicator.png Toggle Status button.
    The enumeration value status changes from (Active) to (Inactive).
  9. Click the Done button.
Note.jpg After inactivating an enumeration value, you should update Data Entry Form templates that use the enumeration list.