Difference between revisions of "Add Subobject Custom Defined Fields"

From IMSMA Wiki
Jump to: navigation, search
(Created page with "{{note|Custom defined fields must have a unique combination of item, label, and data type. }} To add a custom defined field: <ol> <li>From the '''Customisation''' menu, sele...")
 
 
(29 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{note|Custom defined fields must have a unique combination of item, label, and data type.
+
{{Rewrite| This page is under review. Add example Coordinates, depth for each ordnance}}  
}}
+
{{note|You can only add subobject CDFs to ''subobject tables'' - data categories that display as tables on a data entry form template. Examples of these subobject tables are listed below. }}
 
 
To add a custom defined field:
 
<ol>
 
<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 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>
 
:The CDF Editor window displays.
 
</ol>
 
 
 
[[Image:CDFEditor.png|center|500px|''CDF Editor Window'']]
 
<div align="center">
 
''CDF Editor Window''
 
</div>
 
 
 
<ol start="4">
 
<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 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.</li>
 
</ol>
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! colspan="2" | Table 46. Data Types for Custom Defined Fields
+
! colspan="2" | Subobject Tables
 
|-
 
|-
! Data Type
+
! Object
! Description and Comments
+
! Subobject Table Name
 
|-
 
|-
| Text Field
+
| Land
| ≤250 characters
+
|
 +
*Ordnance
 
|-
 
|-
| Date
+
| Activity
| Month, day, year
+
|
 +
*Ordnance
 
|-
 
|-
| Number
+
| Victim
| ≤15 decimal points
+
|
 +
*Cause/Event
 +
*Needs Assessment
 
|-
 
|-
 
| Organisation
 
| Organisation
| Allows the user to select organisational data
+
|  
|-
+
*Organisation Competence
| Place
 
| Allows the user to select place data
 
|-
 
| Country Structure
 
| Allows the user to select country structure level data
 
|-
 
| List Multiple Selections
 
| Allows the user to select zero or more values provided in the '''List Values''' field.
 
|-
 
| List One Selection
 
| Allows the user to select one value from provided values in the '''List Values''' field.
 
|-
 
 
|}
 
|}
 +
To add a subobject custom defined field (CDF):
 +
#In the '''Customisation''' menu &rarr; '''Data Inventory Manager'''.
 +
#From the left pane of the Data Inventory Manager window, select a subobject table.
 +
#Expand the subobject table and select the data category to which you want to add a subobject CDF. If there is no data category under the specific subobject table select Uncategorised.
 +
#In the right pane of the Data Inventory Manager window, click the [[Image:FieldTemplateIcon.png|Add]] button.
 +
#In the CDF Editor window, add and save the subobject CDF in the same way you [[Add Custom Defined Fields|add CDFs to the main objects]].
  
<ol start="6">
+
{{NavBox HowTo Data Elements}}
<li>Enter a description for the custom defined field in the '''Description''' field.</li>
+
[[Category:NAA]]
<li>If the CDF is active, check the '''Active''' checkbox.</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>
 
 
 
{{note|When entering 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 start="10">
 
<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 Field Report Manager.
 
</ol>
 
 
 
{{note|If you would like to add the custom defined field to existing field report templates, you will need to update and republish the field report template.
 
}}
 
 
 
<ol>
 
*To discard the custom defined field and close the CDF Editor window, click the '''Cancel''' button.
 
</ol>
 

Latest revision as of 19:18, 17 June 2017

600px-Ambox rewrite.svg.png This page is under review. Add example Coordinates, depth for each ordnance
Note.jpg You can only add subobject CDFs to subobject tables - data categories that display as tables on a data entry form template. Examples of these subobject tables are listed below.
Subobject Tables
Object Subobject Table Name
Land
  • Ordnance
Activity
  • Ordnance
Victim
  • Cause/Event
  • Needs Assessment
Organisation
  • Organisation Competence

To add a subobject custom defined field (CDF):

  1. In the Customisation menu → Data Inventory Manager.
  2. From the left pane of the Data Inventory Manager window, select a subobject table.
  3. Expand the subobject table and select the data category to which you want to add a subobject CDF. If there is no data category under the specific subobject table select Uncategorised.
  4. In the right pane of the Data Inventory Manager window, click the Add button.
  5. In the CDF Editor window, add and save the subobject CDF in the same way you add CDFs to the main objects.