Difference between revisions of "Standardising Data Entry Forms"

From IMSMA Wiki
Jump to: navigation, search
 
(58 intermediate revisions by 5 users not shown)
Line 1: Line 1:
After the Data Inventory Manager is customized to include all the necessary elements for data collection, the next step is to create field report templates. The Field Report Template Designer provides the capability for information managers to create customised field report templates for use with IMSMA<sup>NG</sup>. The primary purposes of this tool are to:
+
{{TOC right}}
 +
{{Note | To add, change, deactivate, or publish a Data Entry Form template, your {{IMSMANG}} user account must belong to a User Role that has permission ''Form Template Design''. Contact your {{IMSMANG}} Administrator if you have questions on permissions. }}
 +
 
 +
After the Data Inventory Manager is customised to include all the necessary elements for data collection, the next step is to create Data Entry Form templates. [[Data Entry Form Templates]] are the predefined forms that are available from the Data Entry Form Template Selection window and can be used to add a Data Entry Form to IMSMA. The Data Entry Form Template Designer provides the capability for information managers to create customised Data Entry Form templates for use with {{IMSMANG}}. The primary purposes of this tool are to:
  
 
<ol>
 
<ol>
<li>Pick which data elements to collect for a programme</li>
+
<li>Pick which data elements to collect for a Mine Action Programme</li>
<li>Design templates for data entry that mimic paper forms</li>
+
<li>Design templates for data entry that will
 +
* facilitate high data quality and the data entry process
 +
* support the Mine Action Programme's processes / workflows / NMAS / strategy
 +
* implement good Information Management practice.</li>
 
</ol>
 
</ol>
 +
 +
{{Note| All objects on the Data Entry Form template are considered ''elements''. Elements include, but are not limited to, dates, images, labels, lines, option values, tables, text areas, and text fields.}}
 +
 
{{HowTo's
 
{{HowTo's
|[[HowTo:Access the Field Report Template Designer Window| Access the Field Report Template Designer Window]]
+
|[[Data Entry Form Templates|Data Entry Form Templates]]
|[[HowTo:Create a Field Report Template|Create a Field Report Template]]
+
|[[Access the Data Entry Form Template Designer Window| Access the Data Entry Form Template Designer Window]]
|[[HowTo:Change the Page Orientation, Margins, or Paper Size|Change the Page Orientation, Margins, or Paper Size]]
+
|[[Access and Use the Published Template List|Access and Use the Published Template List]]
|[[HowTo:Change an Existing Field Report Template|Change an Existing Field Report Template]]
 
|[[HowTo:Add Report Elements to the Design Pane|Add Report Elements to the Design Pane]]
 
|[[HowTo:Add Item Attributes to the Design Pane|Add Item Attributes to the Design Pane]]
 
|[[HowTo:Add Subobject Custom Defined Fields to the Design Pane|Add Subobject Custom Defined Fields to the Design Pane]]
 
|[[HowTo:Edit Single Select Lists on the Design Pane|Edit Single Select Lists on the Design Pane]]
 
|[[HowTo:Change Single Selection List Display Properties|Change Single Selection List Display Properties]]
 
|[[HowTo:Add Required Fields on the Design Pane|Add Required Fields on the Design Pane]]
 
|[[HowTo:Add Text to the Field Report Template|Add Text to the Field Report Template]]
 
|[[HowTo:Add an Image to the Field Report Template|Add an Image to the Field Report Template]]
 
|[[HowTo:Add a Scribe Panel to the Field Report Template|Add a Scribe Panel to the Field Report Template]]
 
|[[HowTo:Add a Line to the Field Report Template|HowTo Add a Line to the Field Report Template]]
 
|[[HowTo:Select Elements within the Design Pane|Select Elements within the Design Pane]]
 
|[[HowTo:Select Elements from the Logical Tree|Select Elements from the Logical Tree]]
 
|[[HowTo:Move Elements within the Design Pane|Move Elements within the Design Pane]]
 
|[[HowTo:Determine the Associated Item Record of an Item Attribute|Determine the Associated Item Record of an Item Attribute]]
 
|[[HowTo:Move Item Attributes to Another Item Record|Move Item Attributes to Another Item Record]]
 
|[[HowTo:Align Form Elements|Align Form Elements]]
 
|[[HowTo:Remove Selected Elements from the Field Report|Remove Selected Elements from the Field Report]]
 
|[[HowTo:Change Element Display Properties|Change Element Display Properties]]
 
|[[HowTo:Set Object ID Fields to Autogenerate Object ID Numbers|Set Object ID Fields to Autogenerate Object ID Numbers]]
 
|[[HowTo:Save a Field Report Template|Save a Field Report Template]]
 
|[[HowTo:Preview a Field Report Template|Preview a Field Report Template]]
 
|[[HowTo:Publish a Field Report Template|Publish a Field Report Template]]
 
|[[HowTo:Reconcile Custom Defined Fields When Publishing a Field Report|Reconcile Custom Defined Fields When Publishing a Field Report]]
 
|[[HowTo:Republish Existing Field Report Templates|Republish Existing Field Report Templates]]
 
|[[HowTo:Access and Use the Published Template List|Access and Use the Published Template List]]
 
|[[HowTo:View the Field Report Template|View the Field Report Template]]
 
|[[HowTo:Change the Status of a Published Field Report Template|Change the Status of a Published Field Report Template]]
 
|[[HowTo:Share Field Report Templates|Share Field Report Templates]]
 
 
}}
 
}}
  
==Design Concept==
+
==Design Concept==__NOEDITSECTION__
The Field Report Template Designer is a “what–you-see-is-what-you-get” (WYSIWYG) application for creating data entry forms in IMSMA<sup>NG</sup>. With its drag-and-drop capability, the Field Report Template Designer lets information managers select from all of the data elements available in the Data Inventory Manager and position them on a template. Information managers can create wholly new data collection forms and forms that mimic existing paper forms using only the data elements that are valuable to their programme’s workflow. The resulting, streamlined templates—free from tabs and other confusing navigational concepts—can then be printed and used for data collection.
+
With the drag-and-drop capability, the Data Entry Form Template Designer lets information managers select from all of the data elements available in the Data Inventory Manager and position them on a template. Information managers can create new Data Entry Form templates from or adjust Data Entry Form templates that were provided in the installation package as inspiration using only the data elements that are valuable to their Mine Action Programme’s workflows.  
 +
 
 +
Because the design process is critical to the proper functioning of the Information Management system, {{IMSMANG}} provides several capabilities to facilitate the design and sharing of Data Entry Form templates. Information managers can save Data Entry Form templates to the file system in .FFML format. The templates can be exchanged with other {{IMSMANG}} users or Mine Action Programmes.
 +
 
 +
===Questionnaire vs Data Entry Form===__NOEDITSECTION__
 +
A questionnaire is designed for to be printed on '''paper''' and to be filled in by '''hand''' by an interviewer while conducting the interview in the field. The Data Entry Form templates are built to be filled in using {{IMSMANG}} and/or IMSMA Remote Entry. Questionnaires and Data Entry Form templates will have '''different''' layouts and elements.
 +
 
 +
* Questionnaires look like Data Entry Form templates but when data entry is done in {{IMSMANG}} the information updates more than one item e.g. Land, Accident and Victim.
 +
 
 +
* Country Structure information would need to be included on the Questionnaires but will '''not''' be included on Data Entry Form templates since in {{IMSMANG}} that will be obtained by assigning to a Location.
 +
 
 +
* Questionnaires contain information that in {{IMSMANG}} are links between objects e.g. Accident ID on Victim Questionnaire.
  
Because the design process is critical to the proper functioning of the information management system, IMSMA<sup>NG</sup> provides several capabilities to facilitate the design and sharing of field report templates. Information managers can save drafts to the file system prior to publishing. These drafts stored in .FFML format can then be exchanged with other IMSMA<sup>NG</sup> users or IMSMA<sup>NG</sup> systems and be used to design other templates so information managers do not have to start with a blank template.
+
* Questionnaire should have all alternatives as single select but Data Entry Form templates may have combobox.
  
{{note|
+
* Questionnaires do not have alternatives like ''Not specified'' but Data Entry Form templates do.
* After creating field report templates in IMSMA<sup>NG</sup>, it is recommended to use another application to build the same forms for handwritten data collection in the field. The templates are built to accommodate typewritten data which requires less space than handwritten data. Using templates to record data in the field may impose limitations on the amount or extent of information collected.
 
* When a general layout and design is determined for a programme’s field report templates, it is a good idea to save an .FFML file to the file system so it can be used as the basis for designing the rest of the programme’s templates. This should be done prior to adding item-specific data to the template}}
 
  
{{note| To add, change, deactivate, or publish a field report template, you must have access to the Form Template Design permission
+
* Questionnaires may have alternatives in chronological order because that is better for interviewer. Data Entry Form templates may have alphabetical order because easier for Data entry staff.
}}
 
  
Field report templates are the data entry forms that are available from the Field Report Template Selection window and are what you use to add a field report to IMSMA. IMSMA includes default form templates for accident and victim, hazard, hazard reduction, location, MRE, and QC. If the default form templates do not include the information you need on the field report or are in a format that is different from what you need, you can create and publish a new field report template.
+
* Questionnaires have instructions like ''If No, go to question 14''.
  
There are several steps to creating a field report template:
+
* Questionnaires are recommended to be translated to the language(s) that will be used during data collection and Data Entry Form templates are often mono- or bilingual.
1. Determine the layout of the field report template. This includes the field report template’s paper size, paper orientation, and margin sizes.
 
2. Add report data fields to the field report template. Report data fields include Date of Report, Report ID, and Reported By.
 
3. Add item attributes for which you would like to capture data to the field report template. You can also add images, lines, text areas, and scribe panels to the field report template.
 
4. Arrange the elements on the field report template. You can change the data element labels, move the data elements, and align the elements.
 
5. Save the field report template so that you can access it later to make additional changes.
 
6. Publish the field report template so that users can access the template.  
 
  
You can repeat these steps as necessary if you find that the field report template needs to be updated.  
+
{{Note|
 +
* It is recommended to use another software (e.g. Word or iReport) to build the Questionnaires.
 +
* Using printed Data Entry Form templates to record data with pen in the field may impose limitations on the amount or extent of information collected.}}
  
===How It Works===
+
===How It Works===__NOEDITSECTION__
  
[[Image:AdminGuide_ProcessForPreparingReportTemplate.png|center|500px|''Process for Preparing and Maintaining Field Report Templates'']]
+
[[Image:AdminGuide_ProcessForPreparingReportTemplate.png|center|800px|''Process for Preparing and Maintaining Data Entry Form Templates'']]
 
<div align="center">
 
<div align="center">
''Process for Preparing and Maintaining Field Report Templates''
+
''Process for Preparing and Maintaining Data Entry Form Templates''
 
</div>  
 
</div>  
  
The figure above shows how field report templates are prepared and maintained. Using the Field Report Template Designer, information managers build templates from the data elements in the Data Inventory Manager. The templates become the data entry screens for field reports. Information managers can design as many or as few templates as they desire, and they can save drafts or publish the templates as needed.
+
The figure above shows how Data Entry Form templates are prepared and maintained. Using the Data Entry Form Template Designer, information managers build templates from the data elements in the Data Inventory Manager. Information managers can design as many or as few templates as they desire, and they can save drafts or publish the templates as needed.
 
   
 
   
When a template is completed and ready to be used for data entry, information managers publish the template for use by data entry personnel. (Only published templates can be used for data entry.) Data entry clerks can choose the published template to enter data on, which, when approved in the system, permanently preserves the information. So, information managers can define not only the field report templates but also the format the information is displayed in when the data is approved.  
+
When a template is completed and ready to be used for data entry, information managers publish the template for use by data entry personnel. (Only published templates can be used for data entry.) Data entry personnel can choose the published template to enter data on, which, when approved in the system, the result is shown in [[Summary Window | Summary Windows]]. The Summary windows are also fully customisable using the [[Designing Summary Templates | Summary Manger]]. So, information managers can define not only the Data Entry Form templates but also the format the information is displayed in when the data is approved.
 +
 
 +
Information managers can also inactivate templates and/or delete templates that have never been used so they are no longer available for data entry, a capability that is particularly useful when older versions of a template needs to be replaced. In order to avoid confusion on which template that should be used for data entry it is strongly recommended to inactive old versions.
  
Information managers can also remove or deactivate templates so they are no longer available for data entry, a capability that is particularly useful when older versions of a template needs to be replaced.
+
Several important principles of template design assist information managers in building effective templates. These include
 +
# use only data elements from one item per template;
 +
# if the data collection for different types of an item is very different then it is recommended to create more than one template for the item (e.g. Non Technical Survey and Completion Report);
 +
# include the '''minimum''' recommended data elements on all templates
 +
:# Form ID,
 +
:# Item ID,
 +
:# Date of Information,
 +
:# Status of item (e.g. Open, Completed, Deceased/Alive), Status changed date and Status changed reason,
 +
:# Item Type (e.g. SHA, Completion Report, Demining Accident),
 +
# set important fields as required;
 +
# add guidance, instructions and page numbers to the templates.  
  
Several important principles of template design assist information managers in building effective templates. These include using data elements for one item per template, creating one template for each step of the workflow, including standard data elements on all templates, allowing only cosmetic changes to text labels, removing unnecessary elements from templates and using the text tool for instructions and versioning. Following these principles, information managers can achieve the correct balance of usability and data quality necessary for a well functioning programme.
+
Following these principles, information managers can achieve the correct balance of usability and data quality necessary for a well functioning Mine Action Programme.
  
===Use Data Elements for One Item Per Template===
+
It is important to evaluate/test the content of the template in order to avoid confusion such as
While the Field Report Template Designer allows information managers to include data elements from more than one item on a single template (for example, hazard data elements and hazard reduction data elements), it is recommended to have data elements from only one item per template. Limiting the type of information collected on each template reduces the complexity of the reconciliation and approval process and helps ensure data quality and integrity. If a programme, for example, wants to use a general survey that collects information about hazards, hazard reduction activities and accidents, it is advisable to consider creating three independent general survey templates–General Survey-Hazard, General Survey-Hazard Reduction and General Survey-Accidents–rather than creating one comprehensive template for all aspects of the general survey.
+
* questions/options that data collection staff or respondents do not understand or which are subject to different interpretations
 +
* redundant or unnecessary questions/options
 +
* how to better word questions/options.
  
Additionally, although a useful data element may exist for one item, avoid taking shortcuts and using that data element on a template for another item. Instead, consider creating a CDF for the second item rather than mixing and matching data elements from other items.
+
===Use Data Elements for One Item Per Template===__NOEDITSECTION__
 +
While the Data Entry Form Template Designer allows information managers to include data elements from more than one item on a single template (for example, Land data elements and Activity data elements), it is '''strongly''' recommended to have data elements from only one item per template. Limiting the type of information collected on each template reduces the complexity of the reconciliation and approval process and helps ensure data quality and integrity.  
  
===Create One Template for Each Step of a Workflow===
+
===Create More Than One Template for an Item===__NOEDITSECTION__
As discussed above, each template should be reserved for one purpose to reduce the complexity and length of the template. In addition to using data elements for one item per template, information mangers should create one template for each item subcategory in a workflow. For example, a hazard reduction workflow could include separate templates for the different items, including a CHA and minefield, and activities, including a technical survey, clearance, progress report and completion survey.
+
As discussed above, if the different types of an item are very different one template should be created per type in order to reduce the complexity and length of the template. For example, the Activity item could include separate templates for Non Technical Survey, Technical Survey, Progress Report, Completion Report, Handover Certificate and Post Clearance Survey.
  
While several of the templates may share similarities (for example, CHA and minefield), a separate template for each workflow step allows information managers to customise the templates to include only the information necessary for that step in the workflow. For example, all of the Mine Action Area Type values except for “Suspected Hazardous Area” could be removed from the CHA template, whereas all of the values except “Minefield” could be removed from the minefield template. This example is shown in the figure below.
+
For example, if the only difference between the different two types of Land, SHA and CHA, is e.g. two data elements there is no need to create a separate template for them.
  
[[Image:AdminGuide_IncludeRelevantInfoOnly.png|center|500px|''Example of How to Limit Templates to Include Relevant nformation Only'']]
+
[[Image:AdminGuide_IncludeRelevantInfoOnly.png|center|500px|''Example of How to Prevent Data Entry Mistakes'']]
 
<div align="center">
 
<div align="center">
''Example of How to Limit Templates to Include Relevant Information Only''
+
''Example of How to Prevent Data Entry Mistakes''
 
</div>  
 
</div>  
  
Information managers should also consider creating a template designed to update the status of each item when administrative changes to items may be required. For example, in a typical hazard workflow, a completion survey may be submitted that creates a hazard reduction to mark the end of clearance operations on a hazard. In this case, it is necessary to update the status of the hazard from “Worked On” to “Closed.” By using a template with only a handful of fields for status updates (like Local ID, Date of Report and State), an information manager can ensure that all items of a customised workflow are updated properly and with minimal effort.
+
If the information manager decides to create more than one template for an item it is important to prevent users to make mistakes / wrong combination at data entry / data collection.
 +
 
 +
Information managers could also consider creating a minimal information ''administration'' template designed to update the type and/or status of each item when administrative changes to items may be required. For example, in a land release workflow, when a progress report (Activity) is submitted the linked Land should change status from ''Open'' to ''Worked On''. In most Mine Action Programmes the operator will not submit an updating Land nor will the Operations section of the NMAA issues a PM on that the status of the Land should be changed. It is considered as an IM administrative action to change the status of the land and therefore the information manager may find it useful to design an ''administrative'' Data Entry Form template with only a few fields for status updates (like the '''minimum''' recommended), an information manager can hence ensure that all steps of a Land Release workflow are reflected properly and with minimal effort in the {{IMSMANG}} database.
  
===Include Standard Data Elements on All Templates===
+
===Include the '''Minimum''' Recommended Data Elements on all Templates===__NOEDITSECTION__
Some data elements should always appear on field report templates to preserve data integrity and searchability. By standardising these data elements, information managers ensure that the elements at a minimum can be used to find data within IMSMA<sup>NG</sup>.  
+
As discussed above, some data elements should always appear on Data Entry Form templates to preserve data integrity, searchability and reportability. These are considered to be the absolute minimum that should be included on all Data Entry Form templates.By increasing minimum required data elements, information managers ensure high data quality and that the data the Mine Action Programme consider to be valuable are collected and stored in {{IMSMANG}}.  
  
 
<center>
 
<center>
 
{| class="wikitable" width="600"
 
{| class="wikitable" width="600"
 
|-
 
|-
| align="center" colspan="2" | '''Standard Data Elements'''
+
| align="center" colspan="2" | '''Minimum Recommended Data Elements'''
 
|-
 
|-
| width="300pt" | '''Data Element'''
+
| width="200pt" | '''Data Element'''
| width="300pt" | '''Rationale'''
+
| width="400pt" | '''Rationale'''
 
|-
 
|-
| align="left" | Date of Report || align="left" | A data element used in current view calculations and for searching for field reports by the date they were created
+
| Form ID
 +
| (Data Entry) Form ID should be a unique identifier for each Data Entry Form which facilitates searching for and displaying Data Entry Forms in the Workbench
 
|-
 
|-
| align="left" | Report ID || align="left" | A local ID that provides a unique identifier for searching for and displaying field reports in the Workbench
+
| Item ID
 +
| Item ID should be a unique identifier for each item e.g. Land which clearly identifies the item and also facilitates searching for them
 
|-
 
|-
| align="left" | Item ID (for example, Hazard ID) || align="left" | A local ID that provides a unique identifier for searching for and displaying field report items in lists
+
| Date of Information
 +
| Date of Information is used in the calculation / creation of the Summary and it stands for how old is the information in the Data Entry Form (which may '''not''' be the same as the date reported to the NMAA nor the same date as entered into {{IMSMANG}})
 
|-
 
|-
| align="left" | Geographical Reference || align="left" | A table for adding geospatial information about field report items for displaying the items on the map
+
| Status, Status changed Date & Status changed reason
 +
| These three facilitates reporting on e.g. how many Land were closed in year X and reason they became closed
 +
|-
 +
| Type of item
 +
| Facilitates also reporting on e.g. how many SHA and CHA there is.
 
|}
 
|}
 
</center>
 
</center>
  
The table below lists other useful data elements to include on data entry forms. Most of the data elements are predefined in the Data Inventory Manager.
+
{{Note | ''Date of Information'' and ''Form ID'' are vital for the function of {{IMSMANG}} and should always be filled in. The easiest way to ensure that is to included them as '''required''' fields in all Date Entry Form templates.}}
 +
 
 +
The table below lists other useful data elements to include on data entry forms.  
  
 
<center>
 
<center>
{| class="wikitable" width="650"
+
{| class="wikitable" width="600"
 
|-
 
|-
| align="center" colspan="4" | '''Other Useful Data Elements'''
+
| align="center" colspan="2" | '''Other Useful Data Elements'''
 
|-
 
|-
| width="125pt" | '''Item'''  
+
| width="200pt" | '''Data Element'''  
| width="200pt" | '''Data Element'''
+
| width="400pt" | '''Rationale/Example'''
| width="125pt" | '''Item'''
+
|-
| width="200pt" | '''Data Element'''
+
| Area size
 +
| How big is the contamination? How much is cleared with which method/asset?
 +
|-
 +
| Date
 +
| Date of Accident, Start Date & End Date of Activities
 +
|-
 +
| Geographical Reference
 +
| Without any geospatial information about an item, it is difficult to plan actions and impossible to display the items on a map
 
|-
 
|-
| align="left" | Hazard || align="left" | Name
+
| Ordnance
Mine Action Area Type
+
| Which asset to use? Which IHL to report to?
Status
 
Area Size
 
Priority
 
| align="left" | Victim || align="left" | First Name
 
Last Name
 
Gender
 
Age
 
Date of Birth
 
Killed/Injured
 
Victim Type
 
 
|-
 
|-
| align="left" | Hazard Reduction || align="left" | Name
+
| Organisation  
Start Date
+
| It gives higher credibility to information if it is known which organization reported it and it also makes it possible to follow up and produce output per organization.
End Date
 
Type of Activity
 
Organisation
 
Status
 
Ordnance Found
 
Hours Spent
 
Size of Area
 
| align="left" | MRE || align="left" | Start Date
 
End Date
 
Organisation
 
MRE Detail ID
 
MRE Type
 
% Male
 
% Female
 
Audience Number
 
Audience Age Info
 
 
|-
 
|-
| align="left" | Accident || align="left" | Date of Accident
+
| Sex and Age Disaggregated Data (SADD)
Accident Type
+
| The needs of Victims are quite different depending on sex and age. The Education message and he needs/priorities for beneficiaries are also depending on sex and age.
| align="left" | QM || align="left" | Start Date
 
End Date
 
Organisation
 
Results
 
 
|}
 
|}
 
</center>
 
</center>
  
===Make Cosmetic Text Changes Only in the Field Report Template Designer===
+
===Make Cosmetic Text Changes Only in the Data Entry Form Template Designer===__NOEDITSECTION__
Like the Data Inventory Manager, the Field Report Template Designer provides the capability to modify the text of existing data elements. This includes creating and editing labels, changing fonts and sizes and editing pick list values. This functionality can be used to ensure templates are laid out correctly and represent a programme’s data needs. Using this functionality in the Field Report Template Designer, however, should be limited to performing cosmetic changes only, and should not be used to change the meaning or substance of a text element. Cosmetic changes include:
+
Like the Data Inventory Manager, the Data Entry Form Template Designer provides the capability to modify the text of existing data elements. This includes creating and editing labels, changing fonts and sizes and editing pick list values. This functionality can be used to ensure templates are laid out correctly and represent a Mine Action Programme’s data needs. Using this functionality in the Data Entry Form Template Designer, however, should be limited to performing cosmetic changes only, and should not be used to change the meaning or substance of a text element. Cosmetic changes include:
  
Cosmetic change Example
 
 
* Abbreviating text “Number” to “No.”
 
* Abbreviating text “Number” to “No.”
 
* Adding instructions “Pick one of the following:”
 
* Adding instructions “Pick one of the following:”
* Correcting misspellings “Anml” to “Animal”
+
* Make labels bilingual “Minas / Mines“
* Translating terms “Mines to “Minas”
 
  
Using the text changing functionality in the Field Report Template Designer to change the substance or meaning of a text label or value can cause serious confusion and data quality problems. Examples of problematic or dangerous substantive changes to text during template design include changing:
+
Using the text changing functionality in the Data Entry Form Template Designer to change the substance or meaning of a text label or value can cause serious confusion and data quality problems. Examples of problematic or dangerous substantive changes to text during template design include changing:
  
Existing text Substantive change
 
 
* “Number of Mines” “Number of Clearance Teams Recommended”
 
* “Number of Mines” “Number of Clearance Teams Recommended”
 
* “% Female” “Number of Females”
 
* “% Female” “Number of Females”
Line 188: Line 172:
 
Any substantive change to a data element should instead be made in the Data Inventory Manager, either by editing an existing data element or by creating a new CDF.
 
Any substantive change to a data element should instead be made in the Data Inventory Manager, either by editing an existing data element or by creating a new CDF.
  
===Remove Unnecessary Elements from Field Report Templates===
+
===Use the Text Tool for Instructions and Page number===__NOEDITSECTION__
By removing unnecessary or invalid choices from forms, information managers can improve the quality of data collected and entered into IMSMA<sup>NG</sup>. For example, if a form is designed to be a Minefield form, then there is no need to keep other possible values for the “Mine Action Area Type” that are not “Minefield.” In this case, values such as “SHA,” “Dangerous Area” and “Other” can be removed from the form, leaving “Minefield” as the only possible choice. This helps improve data quality while reducing the size and complexity of data entry forms.
+
Using the Text Tool in the Data Entry Form Template Designer, information managers can add text to data entry forms independently of other data elements. This allows information managers to add additional instructions to Data Entry Form templates to help improve the quality of data entry. These instructions can include simple statements such as “Choose only one” or longer sentences e.g. “If the accident happened before January 2010, enter the following...
  
===Use the Text Tool for Instructions and Versionning===
+
It is also useful to add page number to the Data Entry Form template.
Using the Text Tool in the Field Report Template Designer, information managers can add text to data entry forms independently of other data elements. This allows information managers to add additional instructions to field report templates to help improve the quality of data entry. These instructions can include simple statements such as “Choose only one” or longer sentences such as “If the reported date occurs before January 2010, enter the following...” The Field Report Template Designer even supports paragraphs or lists of instructions as needed.
+
 +
[[Image:Instructions DEF.png|center|500px|''Example of Instructions'']]
 +
<div align="center">
 +
''Example of Instructions''
 +
</div>
  
Additionally, information managers should include versioning information on field report templates. By creating a simple versioning system and displaying the version number on the template (as shown below), it is easy to determine whether information is being entered on the current version of the template or a previous version.
+
===Not Possible to Use the same Data Element Twice in a Template===__NOEDITSECTION__
 +
{{IMSMANG}} does not allow you to drag the same element to a template twice. For example, if the template you are designing already includes the ''Type of Accident'', you cannot add it again to the template.
  
+
[[Image:AddingSameElementTwiceAlternateMessage.png|center|600px|''Adding the Same Element Twice'']]
[[Image:AdminGuide_VersionNumberFieldReportTemplate.png|center|500px|''Example of a Version Number on a Field Report Template'']]
 
 
<div align="center">
 
<div align="center">
''Example of a Version Number on a Field Report Template''
+
''Adding the Same Element Twice''
 
</div>  
 
</div>  
  
==Template Publishing==
+
==Template Publishing==__NOEDITSECTION__
When the field report templates are designed, information managers can publish them for use. The publication process includes choosing an organisation that the template belongs to and providing a version number. When an individual template is designed to support the needs of a specific organisation, information managers can select the organisation as the owner of the template. For example, if organisation XYZ uses a specific template to collect information, the template can be assigned to XYZ when it is published. Note that setting the owner of the template does not restrict data entry personnel from using the template. The template that is published and assigned to XYZ is accessible to all IMSMA<sup>NG</sup> users, not just XYZ personnel. Also, if a template is for general use or not designed to support a specific organisation, the owner of the template can be set to “IMSMA” or any other organisation created in IMSMA<sup>NG</sup>.
+
[[Image:Publish template version number.png|center|300px]]
 +
 
 +
When the Data Entry Form templates are designed, information managers publish them for use. The publication process includes choosing an organisation that the template belongs to and providing a version number. It is good practice to include more in the version number than template version. In the above image there are three parts:
 +
# {{IMSMANG}} version it is designed with and for
 +
# date it is published
 +
# version of the template itself.
 +
 
 +
When an individual template is designed to support the needs of a specific organisation, information managers can select the organisation as the owner of the template. For example, if organisation XYZ uses a specific template to collect information, the template can be assigned to XYZ when it is published. Another reason for making organization specific templates is to include the logotype of the organization in the page header. Note that setting the owner of the template does not restrict data entry personnel from using the template. The template that is published and assigned to XYZ is accessible to all {{IMSMANG}} users, not just XYZ personnel. If a template is for general use, the owner of the template can be set to “IMSMA” or the NMAA.
  
When a template is published using the same name as another published template, IMSMA<sup>NG</sup> automatically deactivates the previously published template. Note that this does not change the format of any data already entered into IMSMA<sup>NG</sup> using the previously published template. IMSMA<sup>NG</sup> preserves the integrity of data as it was entered. Subsequent field reports, however, are entered and displayed using the updated version of the template.  
+
When a template is published using the same name as another published template, {{IMSMANG}} automatically deactivates the previously published template. Note that this does not change the format of any data already entered into {{IMSMANG}} using the previously published template. {{IMSMANG}} preserves the integrity of data as it was entered. Subsequent Data Entry Forms, however, are entered and displayed using the updated version of the template.  
  
To ensure the most recent and useful templates are available for data entry, information managers should periodically review the status of the published templates and deactivate or delete any templates no longer needed. If a template has already been used to enter data into IMSMA<sup>NG</sup>, the template cannot be deleted from the system. But, information managers can deactivate the template so it cannot be used for data entry. Templates that have not already been used can be deleted.
+
To ensure the most recent and useful templates are available for data entry, information managers should periodically review the status of the published templates and deactivate or delete draft templates no longer needed. If a template has already been used to enter data into {{IMSMANG}}, the template cannot be deleted from the system. It is possible to [[Switch Templates | switch]] templates later if deemed necessary.
  
==Translating Templates (Multilingual Environment)==
+
==Translating Templates (Multilingual Environment)==__NOEDITSECTION__
When running IMSMA<sup>NG</sup> in a multilingual environment where different users run IMSMA<sup>NG</sup> in different languages, information managers have two options for creating templates:  
+
When running {{IMSMANG}} in a multilingual environment where different users run {{IMSMANG}} in different languages, information managers have two options for creating templates:  
  
 
* creating multilingual templates  
 
* creating multilingual templates  
 
* creating multiple versions of each template
 
* creating multiple versions of each template
  
Either approach works successfully and gives users of multiple languages full access to IMSMA<sup>NG</sup> data.
+
Either approach works successfully and gives users of multiple languages full access to {{IMSMANG}} data.
  
===Multilingual Templates===
+
===Multilingual Templates===__NOEDITSECTION__
 
Using this approach, information managers can create a single template with multiple languages in it. Each data element label has two or more translations, as shown below. This option lets all users read the same template without any modification.
 
Using this approach, information managers can create a single template with multiple languages in it. Each data element label has two or more translations, as shown below. This option lets all users read the same template without any modification.
  
[[Image:AdminGuide_MultilingualFieldReportTemplate.png|center|500px|''Example of a Multilingual Field Report Template'']]
+
[[Image:AdminGuide_MultilingualFieldReportTemplate.png|center|600px|''Example of a Multilingual Data Entry Form Template'']]
 
<div align="center">
 
<div align="center">
''Example of a Multilingual Field Report Template''
+
''Example of a Multilingual Data Entry Form Template''
 
</div>  
 
</div>  
  
===Multiple Versions of Each Template===
+
===Multiple Versions of Each Template===__NOEDITSECTION__
An alternative approach to template design is to create a separate version of the same template for each language. Benefits of this approach include reduced form size since each piece of text is only represented once and simplified template creation since users can change their locale settings and begin designing templates that take advantage of the translations already provided in IMSMA<sup>NG</sup>.
+
An alternative approach to template design is to create a separate version of the same template for each language. Benefits of this approach include reduced form size since each piece of text is only represented once and simplified template creation since users can change their locale settings and begin designing templates that take advantage of the translations already provided in {{IMSMANG}}.
 +
 
 +
{{Note| Remember that socio-economic data such as number of beneficiaries needs to be kept up-to-date if the data should be useful for prioritisation and/or impact analysis.}}
 +
{{NavBox IMSMA NG Administration}}
 +
 
 +
[[Category:NAA]]

Latest revision as of 18:10, 17 June 2017

Note.jpg To add, change, deactivate, or publish a Data Entry Form template, your IMSMANG user account must belong to a User Role that has permission Form Template Design. Contact your IMSMANG Administrator if you have questions on permissions.

After the Data Inventory Manager is customised to include all the necessary elements for data collection, the next step is to create Data Entry Form templates. Data Entry Form Templates are the predefined forms that are available from the Data Entry Form Template Selection window and can be used to add a Data Entry Form to IMSMA. The Data Entry Form Template Designer provides the capability for information managers to create customised Data Entry Form templates for use with IMSMANG. The primary purposes of this tool are to:

  1. Pick which data elements to collect for a Mine Action Programme
  2. Design templates for data entry that will
    • facilitate high data quality and the data entry process
    • support the Mine Action Programme's processes / workflows / NMAS / strategy
    • implement good Information Management practice.
Note.jpg All objects on the Data Entry Form template are considered elements. Elements include, but are not limited to, dates, images, labels, lines, option values, tables, text areas, and text fields.

Design Concept

With the drag-and-drop capability, the Data Entry Form Template Designer lets information managers select from all of the data elements available in the Data Inventory Manager and position them on a template. Information managers can create new Data Entry Form templates from or adjust Data Entry Form templates that were provided in the installation package as inspiration using only the data elements that are valuable to their Mine Action Programme’s workflows.

Because the design process is critical to the proper functioning of the Information Management system, IMSMANG provides several capabilities to facilitate the design and sharing of Data Entry Form templates. Information managers can save Data Entry Form templates to the file system in .FFML format. The templates can be exchanged with other IMSMANG users or Mine Action Programmes.

Questionnaire vs Data Entry Form

A questionnaire is designed for to be printed on paper and to be filled in by hand by an interviewer while conducting the interview in the field. The Data Entry Form templates are built to be filled in using IMSMANG and/or IMSMA Remote Entry. Questionnaires and Data Entry Form templates will have different layouts and elements.

  • Questionnaires look like Data Entry Form templates but when data entry is done in IMSMANG the information updates more than one item e.g. Land, Accident and Victim.
  • Country Structure information would need to be included on the Questionnaires but will not be included on Data Entry Form templates since in IMSMANG that will be obtained by assigning to a Location.
  • Questionnaires contain information that in IMSMANG are links between objects e.g. Accident ID on Victim Questionnaire.
  • Questionnaire should have all alternatives as single select but Data Entry Form templates may have combobox.
  • Questionnaires do not have alternatives like Not specified but Data Entry Form templates do.
  • Questionnaires may have alternatives in chronological order because that is better for interviewer. Data Entry Form templates may have alphabetical order because easier for Data entry staff.
  • Questionnaires have instructions like If No, go to question 14.
  • Questionnaires are recommended to be translated to the language(s) that will be used during data collection and Data Entry Form templates are often mono- or bilingual.
Note.jpg
  • It is recommended to use another software (e.g. Word or iReport) to build the Questionnaires.
  • Using printed Data Entry Form templates to record data with pen in the field may impose limitations on the amount or extent of information collected.

How It Works

Process for Preparing and Maintaining Data Entry Form Templates

Process for Preparing and Maintaining Data Entry Form Templates

The figure above shows how Data Entry Form templates are prepared and maintained. Using the Data Entry Form Template Designer, information managers build templates from the data elements in the Data Inventory Manager. Information managers can design as many or as few templates as they desire, and they can save drafts or publish the templates as needed.

When a template is completed and ready to be used for data entry, information managers publish the template for use by data entry personnel. (Only published templates can be used for data entry.) Data entry personnel can choose the published template to enter data on, which, when approved in the system, the result is shown in Summary Windows. The Summary windows are also fully customisable using the Summary Manger. So, information managers can define not only the Data Entry Form templates but also the format the information is displayed in when the data is approved.

Information managers can also inactivate templates and/or delete templates that have never been used so they are no longer available for data entry, a capability that is particularly useful when older versions of a template needs to be replaced. In order to avoid confusion on which template that should be used for data entry it is strongly recommended to inactive old versions.

Several important principles of template design assist information managers in building effective templates. These include

  1. use only data elements from one item per template;
  2. if the data collection for different types of an item is very different then it is recommended to create more than one template for the item (e.g. Non Technical Survey and Completion Report);
  3. include the minimum recommended data elements on all templates
  1. Form ID,
  2. Item ID,
  3. Date of Information,
  4. Status of item (e.g. Open, Completed, Deceased/Alive), Status changed date and Status changed reason,
  5. Item Type (e.g. SHA, Completion Report, Demining Accident),
  1. set important fields as required;
  2. add guidance, instructions and page numbers to the templates.

Following these principles, information managers can achieve the correct balance of usability and data quality necessary for a well functioning Mine Action Programme.

It is important to evaluate/test the content of the template in order to avoid confusion such as

  • questions/options that data collection staff or respondents do not understand or which are subject to different interpretations
  • redundant or unnecessary questions/options
  • how to better word questions/options.

Use Data Elements for One Item Per Template

While the Data Entry Form Template Designer allows information managers to include data elements from more than one item on a single template (for example, Land data elements and Activity data elements), it is strongly recommended to have data elements from only one item per template. Limiting the type of information collected on each template reduces the complexity of the reconciliation and approval process and helps ensure data quality and integrity.

Create More Than One Template for an Item

As discussed above, if the different types of an item are very different one template should be created per type in order to reduce the complexity and length of the template. For example, the Activity item could include separate templates for Non Technical Survey, Technical Survey, Progress Report, Completion Report, Handover Certificate and Post Clearance Survey.

For example, if the only difference between the different two types of Land, SHA and CHA, is e.g. two data elements there is no need to create a separate template for them.

Example of How to Prevent Data Entry Mistakes

Example of How to Prevent Data Entry Mistakes

If the information manager decides to create more than one template for an item it is important to prevent users to make mistakes / wrong combination at data entry / data collection.

Information managers could also consider creating a minimal information administration template designed to update the type and/or status of each item when administrative changes to items may be required. For example, in a land release workflow, when a progress report (Activity) is submitted the linked Land should change status from Open to Worked On. In most Mine Action Programmes the operator will not submit an updating Land nor will the Operations section of the NMAA issues a PM on that the status of the Land should be changed. It is considered as an IM administrative action to change the status of the land and therefore the information manager may find it useful to design an administrative Data Entry Form template with only a few fields for status updates (like the minimum recommended), an information manager can hence ensure that all steps of a Land Release workflow are reflected properly and with minimal effort in the IMSMANG database.

Include the Minimum Recommended Data Elements on all Templates

As discussed above, some data elements should always appear on Data Entry Form templates to preserve data integrity, searchability and reportability. These are considered to be the absolute minimum that should be included on all Data Entry Form templates.By increasing minimum required data elements, information managers ensure high data quality and that the data the Mine Action Programme consider to be valuable are collected and stored in IMSMANG.

Minimum Recommended Data Elements
Data Element Rationale
Form ID (Data Entry) Form ID should be a unique identifier for each Data Entry Form which facilitates searching for and displaying Data Entry Forms in the Workbench
Item ID Item ID should be a unique identifier for each item e.g. Land which clearly identifies the item and also facilitates searching for them
Date of Information Date of Information is used in the calculation / creation of the Summary and it stands for how old is the information in the Data Entry Form (which may not be the same as the date reported to the NMAA nor the same date as entered into IMSMANG)
Status, Status changed Date & Status changed reason These three facilitates reporting on e.g. how many Land were closed in year X and reason they became closed
Type of item Facilitates also reporting on e.g. how many SHA and CHA there is.
Note.jpg Date of Information and Form ID are vital for the function of IMSMANG and should always be filled in. The easiest way to ensure that is to included them as required fields in all Date Entry Form templates.

The table below lists other useful data elements to include on data entry forms.

Other Useful Data Elements
Data Element Rationale/Example
Area size How big is the contamination? How much is cleared with which method/asset?
Date Date of Accident, Start Date & End Date of Activities
Geographical Reference Without any geospatial information about an item, it is difficult to plan actions and impossible to display the items on a map
Ordnance Which asset to use? Which IHL to report to?
Organisation It gives higher credibility to information if it is known which organization reported it and it also makes it possible to follow up and produce output per organization.
Sex and Age Disaggregated Data (SADD) The needs of Victims are quite different depending on sex and age. The Education message and he needs/priorities for beneficiaries are also depending on sex and age.

Make Cosmetic Text Changes Only in the Data Entry Form Template Designer

Like the Data Inventory Manager, the Data Entry Form Template Designer provides the capability to modify the text of existing data elements. This includes creating and editing labels, changing fonts and sizes and editing pick list values. This functionality can be used to ensure templates are laid out correctly and represent a Mine Action Programme’s data needs. Using this functionality in the Data Entry Form Template Designer, however, should be limited to performing cosmetic changes only, and should not be used to change the meaning or substance of a text element. Cosmetic changes include:

  • Abbreviating text “Number” to “No.”
  • Adding instructions “Pick one of the following:”
  • Make labels bilingual “Minas / Mines“

Using the text changing functionality in the Data Entry Form Template Designer to change the substance or meaning of a text label or value can cause serious confusion and data quality problems. Examples of problematic or dangerous substantive changes to text during template design include changing:

  • “Number of Mines” “Number of Clearance Teams Recommended”
  • “% Female” “Number of Females”
  • “Heavy” “Flail” (for the type of mechanical device recommended)

Any substantive change to a data element should instead be made in the Data Inventory Manager, either by editing an existing data element or by creating a new CDF.

Use the Text Tool for Instructions and Page number

Using the Text Tool in the Data Entry Form Template Designer, information managers can add text to data entry forms independently of other data elements. This allows information managers to add additional instructions to Data Entry Form templates to help improve the quality of data entry. These instructions can include simple statements such as “Choose only one” or longer sentences e.g. “If the accident happened before January 2010, enter the following...”

It is also useful to add page number to the Data Entry Form template.

Example of Instructions

Example of Instructions

Not Possible to Use the same Data Element Twice in a Template

IMSMANG does not allow you to drag the same element to a template twice. For example, if the template you are designing already includes the Type of Accident, you cannot add it again to the template.

Adding the Same Element Twice

Adding the Same Element Twice

Template Publishing

Publish template version number.png

When the Data Entry Form templates are designed, information managers publish them for use. The publication process includes choosing an organisation that the template belongs to and providing a version number. It is good practice to include more in the version number than template version. In the above image there are three parts:

  1. IMSMANG version it is designed with and for
  2. date it is published
  3. version of the template itself.

When an individual template is designed to support the needs of a specific organisation, information managers can select the organisation as the owner of the template. For example, if organisation XYZ uses a specific template to collect information, the template can be assigned to XYZ when it is published. Another reason for making organization specific templates is to include the logotype of the organization in the page header. Note that setting the owner of the template does not restrict data entry personnel from using the template. The template that is published and assigned to XYZ is accessible to all IMSMANG users, not just XYZ personnel. If a template is for general use, the owner of the template can be set to “IMSMA” or the NMAA.

When a template is published using the same name as another published template, IMSMANG automatically deactivates the previously published template. Note that this does not change the format of any data already entered into IMSMANG using the previously published template. IMSMANG preserves the integrity of data as it was entered. Subsequent Data Entry Forms, however, are entered and displayed using the updated version of the template.

To ensure the most recent and useful templates are available for data entry, information managers should periodically review the status of the published templates and deactivate or delete draft templates no longer needed. If a template has already been used to enter data into IMSMANG, the template cannot be deleted from the system. It is possible to switch templates later if deemed necessary.

Translating Templates (Multilingual Environment)

When running IMSMANG in a multilingual environment where different users run IMSMANG in different languages, information managers have two options for creating templates:

  • creating multilingual templates
  • creating multiple versions of each template

Either approach works successfully and gives users of multiple languages full access to IMSMANG data.

Multilingual Templates

Using this approach, information managers can create a single template with multiple languages in it. Each data element label has two or more translations, as shown below. This option lets all users read the same template without any modification.

Example of a Multilingual Data Entry Form Template

Example of a Multilingual Data Entry Form Template

Multiple Versions of Each Template

An alternative approach to template design is to create a separate version of the same template for each language. Benefits of this approach include reduced form size since each piece of text is only represented once and simplified template creation since users can change their locale settings and begin designing templates that take advantage of the translations already provided in IMSMANG.

Note.jpg Remember that socio-economic data such as number of beneficiaries needs to be kept up-to-date if the data should be useful for prioritisation and/or impact analysis.