Difference between revisions of "Custom Defined Fields"

From IMSMA Wiki
Jump to: navigation, search
 
(26 intermediate revisions by 5 users not shown)
Line 2: Line 2:
 
{{TOC right}}
 
{{TOC right}}
  
−
IMSMA allows you to create, change, and remove fields which are not predefined in IMSMA. These fields are referred to as custom defined fields (CDFs). CDFs can be added to field report items (accident, hazard, hazard reduction, location, MRE, QC, and victim) and to country structure area, explosive ordnance, organisation, and place.  
+
{{IMSMANG}} allows you to create, change, and delete fields which are not predefined in IMSMA. These fields are referred to as Custom Defined Fields (CDFs). CDFs can be added to items and Auxiliary data but not to the Data Entry Form item.  
  
−
CDFs added to accident, hazard, hazard reduction, location, MRE, QC, and victim can be added to field report templates so that they become part of the paper-based field report ([[:Image:uMFig142.png|Figure 142]]).
+
==Workflow==__NOEDITSECTION__
−
 
 
−
[[Image:uMFig142.png|center|''Figure 142. CDFs and Field Report Items'']]
 
−
 
 
−
After users add data to the field report and the field report is approved, the data entered into the custom defined field can be viewed in the Current View window ([[:Image:uMFig143.png|Figure 143]]).
 
−
 
 
−
[[Image:uMFig143.png|center|''Figure 143. Custom Defined Field Viewable in Current View Window'']]
 
−
 
 
−
You can enter data for CDFs that are added to place, explosive ordnance, organisation, or country structure area via their applicable Editor windows ([[:Image:uMFig144.png|Figure 144]]).
 
−
 
 
−
[[Image:uMFig144.png|center|''Figure 144. CDFs in the Editor Window'']]
 
−
 
 
−
===How to Add Custom Defined Fields===
 
−
{| class="wikitable"
 
−
|-
 
−
| [[File:Note.jpg | 40px]] || Custom defined fields must have a unique combination of item, label, and data type.
 
−
|}
 
−
 
 
−
To add a custom defined field:
 
 
<ol>
 
<ol>
−
<li>From the '''Customisation''' menu, select '''Data Inventory Manager'''.</li>
+
<li> [[Add Custom Defined Fields| Add the CDFs]] in the Data Inventory Manager.
−
:The Data Inventory Manager window displays.
+
<ol type=a>
−
<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> establish that the [[Filter Item Attributes| field does not already exists]]
−
<li>From the right pane of the Data Inventory Manager window, click the [[Image:FieldTemplateIcon.png]] button.</li>
+
<li> how will the data be used?
−
The CDF Editor window displays ([[:Image:uMFig145.png|Figure 145]]).
+
<li> which data type?
−
</ol>
+
</ol></li>
−
 
+
<li> Add them to [[Access the Data Entry Form Template Designer Window | Data Entry Form templates]] so users may add data into the CDFs.</li>
−
[[Image:uMFig145.png|center|''Figure 145. CDF Editor Window'']]
 
−
 
 
−
<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" width="600"
+
[[Image:uMFig142.png|center|600px|''CDFs and Data Entry Form Items'']]</li>
−
|-
 
−
| align="center" colspan="2" | '''Table 46. Data Types for Custom Defined Fields'''
 
−
|-
 
−
| width="225pt" | '''Data Type'''
 
−
| width="375pt" | '''Description and Comments'''
 
−
|-
 
−
| Text Field || ≤250 characters
 
−
|-
 
−
| Date || Month, day, year
 
−
|-
 
−
| Number || ≤15 decimal points
 
−
|-
 
−
| 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.
 
−
|}
 
  
−
<ol start="6">
+
<li> Add the CDFs to the [[Summary Templates | Summary window templates]] so the users may see the data they have entered. </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>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>
 
  
−
{| class="wikitable"
+
[[Image:uMFig143.png|center|500px|''Custom Defined Field Viewable in Summary Window'']]
−
|-
 
−
| [[File:Note.jpg | 40px]] || 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> Add the CDFs to the [[Use iReport | printing iReport templates]].</li>
−
<li>Do one of the following:</li>
+
<li> Consider if the CDF should be included in existing [[Building Searches | Saved searches]] or if a new Saved search should be created.</li>  
−
*If you would like to save the value and enter additional values, click the '''Save''' button.
+
<li> Consider if the CDFs should be included in statistic iReports.</li>
−
*If you have completed entering the values for the list, click the '''Done''' button.  
+
<li> Consider if a [[Customise Sub-Themes | sub-theme]] should be created for the CDFs.</li>
−
<li>Enter a description for the custom defined field in the '''Description''' field.</li>
+
<li> Consider if the CDF should be included in other statistic reports, maps, etc.</li>
 
</ol>
 
</ol>
  
−
{| class="wikitable"
+
{{Note |Auxiliary data and Task CDFs are automatically added to the to the designated area in the Editor windows. As administrator you cannot control placement nor size of the controls. }}
−
|-
 
−
| [[File:Note.jpg | 40px]] || 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>
 
  
−
{| class="wikitable"
+
[[Image:uMFig144.png|center|450px|''CDFs in the Editor Window'']]
−
|-
 
−
| [[File:Note.jpg | 40px]] || 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>
+
{{NavBox HowTo Data Elements}}
−
*To discard the custom defined field and close the CDF Editor window, click the '''Cancel''' button.
+
[[Category:NAA]]
−
</ol>
 

Latest revision as of 21:14, 19 June 2017

Contents

IMSMANG allows you to create, change, and delete fields which are not predefined in IMSMA. These fields are referred to as Custom Defined Fields (CDFs). CDFs can be added to items and Auxiliary data but not to the Data Entry Form item.

Workflow

  1. Add the CDFs in the Data Inventory Manager.
    1. establish that the field does not already exists
    2. how will the data be used?
    3. which data type?
  2. Add them to Data Entry Form templates so users may add data into the CDFs.
    3. CDFs and Data Entry Form Items
  3. Add the CDFs to the Summary window templates so the users may see the data they have entered.
    4. Custom Defined Field Viewable in Summary Window
  4. Add the CDFs to the printing iReport templates.
  5. Consider if the CDF should be included in existing Saved searches or if a new Saved search should be created.
  6. Consider if the CDFs should be included in statistic iReports.
  7. Consider if a sub-theme should be created for the CDFs.
  8. Consider if the CDF should be included in other statistic reports, maps, etc.
Note.jpg Auxiliary data and Task CDFs are automatically added to the to the designated area in the Editor windows. As administrator you cannot control placement nor size of the controls.
CDFs in the Editor Window
Data Inventory Manager
Search
Enumeration Lists
Custom Defined Fields
Retrieved from "http://mwiki.gichd.org:8090/mediawiki/index.php?title=Custom_Defined_Fields&oldid=23670"