Difference between revisions of "Standardising Data Entry Forms"

From IMSMA Wiki
Jump to: navigation, search
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:
+
After the Data Inventory Manager is customized to include all the necessary elements for data collection, the next step is to create Data Entry Forms templates. The Data Entry Form Template Designer provides the capability for information managers to create customised Data Entry Form templates for use with IMSMA<sup>NG</sup>. The primary purposes of this tool are to:
  
 
<ol>
 
<ol>
Line 6: Line 6:
 
</ol>
 
</ol>
 
{{HowTo's
 
{{HowTo's
|[[HowTo:Access the Field Report Template Designer Window| Access the Field Report Template Designer Window]]
+
|[[HowTo:Access the Field Report Template Designer Window| Access the Data Entry Form Template Designer Window]]
|[[HowTo:Create a Field Report Template|Create a Field Report Template]]
+
|[[HowTo:Create a Field Report Template|Create a Data Entry Form Template]]
 
|[[HowTo:Change the Page Orientation, Margins, or Paper Size|Change the Page Orientation, Margins, or Paper Size]]
 
|[[HowTo:Change the Page Orientation, Margins, or Paper Size|Change the Page Orientation, Margins, or Paper Size]]
|[[HowTo:Change an Existing Field Report Template|Change an Existing Field Report Template]]
+
|[[HowTo:Change an Existing Field Report Template|Change an Existing Data Entry Form Template]]
 
|[[HowTo:Add Report Elements to the Design Pane|Add Report Elements to the Design Pane]]
 
|[[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 Item Attributes to the Design Pane|Add Item Attributes to the Design Pane]]
Line 17: Line 17:
 
|[[HowTo:Set a Default Value|Set a Default Value]]
 
|[[HowTo:Set a Default Value|Set a Default Value]]
 
|[[HowTo:Add Required Fields on the Design Pane|Add Required Fields on the Design Pane]]
 
|[[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 Text to the Field Report Template|Add Text to the Data Entry Form Template]]
|[[HowTo:Add an Image to the Field Report Template|Add an Image to the Field Report Template]]
+
|[[HowTo:Add an Image to the Field Report Template|Add an Image to the Data Entry Form Template]]
|[[HowTo:Add a Scribe Panel to the Field Report Template|Add a Scribe Panel to the Field Report Template]]
+
|[[HowTo:Add a Scribe Panel to the Field Report Template|Add a Scribe Panel to the Data Entry Form Template]]
|[[HowTo:Add a Line to the Field Report Template|HowTo Add a Line to the Field Report Template]]
+
|[[HowTo:Add a Line to the Field Report Template|HowTo Add a Line to the Data Entry Form Template]]
 
|[[HowTo:Select Elements within the Design Pane|Select Elements within the Design Pane]]
 
|[[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:Select Elements from the Logical Tree|Select Elements from the Logical Tree]]
Line 27: Line 27:
 
|[[HowTo:Move Item Attributes to Another Item Record|Move Item Attributes to Another Item Record]]
 
|[[HowTo:Move Item Attributes to Another Item Record|Move Item Attributes to Another Item Record]]
 
|[[HowTo:Align Form Elements|Align Form Elements]]
 
|[[HowTo:Align Form Elements|Align Form Elements]]
|[[HowTo:Remove Selected Elements from the Field Report|Remove Selected Elements from the Field Report]]
+
|[[HowTo:Remove Selected Elements from the Field Report|Remove Selected Elements from the Data Entry Form]]
 
|[[HowTo:Change Element Display Properties|Change Element Display Properties]]
 
|[[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:Set Object ID Fields to Autogenerate Object ID Numbers|Set Object ID Fields to Autogenerate Object ID Numbers]]
 
|[[HowTo:Customise Tables|Customize Tables]]
 
|[[HowTo:Customise Tables|Customize Tables]]
|[[HowTo:Save a Field Report Template|Save a Field Report Template]]
+
|[[HowTo:Save a Field Report Template|Save a Data Entry Form Template]]
|[[HowTo:Preview a Field Report Template|Preview a Field Report Template]]
+
|[[HowTo:Preview a Field Report Template|Preview a Data Entry Form Template]]
|[[HowTo:Publish a Field Report Template|Publish a Field Report Template]]
+
|[[HowTo:Publish a Field Report Template|Publish a Data Entry Form Template]]
|[[HowTo:Remove a Field Report Template|Remove a Field Report Template]]
+
|[[HowTo:Remove a Field Report Template|Remove a Data Entry Form Template]]
|[[HowTo:Reconcile Custom Defined Fields When Publishing a Field Report|Reconcile Custom Defined Fields When Publishing a Field Report]]
+
|[[HowTo:Reconcile Custom Defined Fields When Publishing a Field Report|Reconcile Custom Defined Fields When Publishing a Data Entry Form]]
|[[HowTo:Republish Existing Field Report Templates|Republish Existing Field Report Templates]]
+
|[[HowTo:Republish Existing Field Report Templates|Republish Existing Data Entry Form Templates]]
 
|[[HowTo:Access and Use the Published Template List|Access and Use the Published Template List]]
 
|[[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:View the Field Report Template|View the Data Entry Form Template]]
|[[HowTo:Change the Status of a Published Field Report Template|Change the Status of a Published Field Report Template]]
+
|[[HowTo:Change the Status of a Published Field Report Template|Change the Status of a Published Data Entry Form Template]]
|[[HowTo:Share Field Report Templates|Share Field Report Templates]]
+
|[[HowTo:Share Field Report Templates|Share Data Entry Form Templates]]
 
}}
 
}}
  
 
==Design Concept==
 
==Design Concept==
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.
+
The Data Entry Form 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 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 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.
  
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.
+
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 Data Entry Form 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.
  
 
{{note|
 
{{note|
* 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.
+
* After creating Data Entry Form 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}}  
+
* When a general layout and design is determined for a programme’s Data Entry Form 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
+
{{note| To add, change, deactivate, or publish a Data Entry Form template, you must have access to the Form Template Design permission
 
}}  
 
}}  
  
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, land, activity, location, education, and QM. 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.
+
Data Entry Form templates are the data entry forms that are available from the Data Entry Form Template Selection window and are what you use to add a Data Entry Form to IMSMA. IMSMA includes default form templates for accident and victim, land, activity, location, education, and QM. If the default form templates do not include the information you need on the Data Entry Form or are in a format that is different from what you need, you can create and publish a new Data Entry Form template.
  
There are several steps to creating a field report template:
+
There are several steps to creating a Data Entry Form template:
1. Determine the layout of the field report template. This includes the field report template’s paper size, paper orientation, and margin sizes.  
+
1. Determine the layout of the Data Entry Form template. This includes the Data Entry Form 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.  
+
2. Add report data fields to the Data Entry Form 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.
+
3. Add item attributes for which you would like to capture data to the Data Entry Form template. You can also add images, lines, text areas, and scribe panels to the Data Entry Form 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.  
+
4. Arrange the elements on the Data Entry Form 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.  
+
5. Save the Data Entry Form 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.  
+
6. Publish the Data Entry Form 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.  
+
You can repeat these steps as necessary if you find that the Data Entry Form template needs to be updated.  
  
 
===How It Works===
 
===How It Works===
  
[[Image:AdminGuide_ProcessForPreparingReportTemplate.png|center|500px|''Process for Preparing and Maintaining Field Report Templates'']]
+
[[Image:AdminGuide_ProcessForPreparingReportTemplate.png|center|500px|''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. The templates become the data entry screens for Data Entry Forms. 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 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 Data Entry Form templates but also the format the information is displayed in when the data is approved.  
  
 
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.
 
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.
Line 83: Line 83:
  
 
===Use Data Elements for One Item Per Template===
 
===Use Data Elements for One Item Per Template===
While the Field Report 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 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 land areas, activities and accidents, it is advisable to consider creating three independent general survey templates–General Survey-Land, General Survey-Activity and General Survey-Accidents–rather than creating one comprehensive template for all aspects of the general survey.
+
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 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 land areas, activities and accidents, it is advisable to consider creating three independent general survey templates–General Survey-Land, General Survey-Activity and General Survey-Accidents–rather than creating one comprehensive template for all aspects of the general survey.
  
 
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.
 
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.
Line 100: Line 100:
  
 
===Include Standard Data Elements on All Templates===
 
===Include Standard Data Elements on All Templates===
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>.  
+
Some data elements should always appear on Data Entry Form 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>.  
  
 
<center>
 
<center>
Line 110: Line 110:
 
| width="300pt" | '''Rationale'''
 
| width="300pt" | '''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
+
| align="left" | Date of Report || align="left" | A data element used in summary calculations and for searching for Data Entry Forms by the date they were created
 
|-
 
|-
| align="left" | Report ID || align="left" | A local ID that provides a unique identifier for searching for and displaying field reports in the Workbench
+
| align="left" | Report ID || align="left" | A local ID that provides a unique identifier for searching for and displaying Data Entry Forms in the Workbench
 
|-
 
|-
| align="left" | Item ID (for example, Land ID) || align="left" | A local ID that provides a unique identifier for searching for and displaying field report items in lists
+
| align="left" | Item ID (for example, Land ID) || align="left" | A local ID that provides a unique identifier for searching for and displaying Data Entry Form items in lists
 
|-
 
|-
| align="left" | Geographical Reference || align="left" | A table for adding geospatial information about field report items for displaying the items on the map
+
| align="left" | Geographical Reference || align="left" | A table for adding geospatial information about Data Entry Form items for displaying the items on the map
 
|}
 
|}
 
</center>
 
</center>
Line 173: Line 173:
 
</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===
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 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
 
Cosmetic change Example
Line 182: Line 182:
 
* Translating terms “Mines to “Minas”
 
* 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
 
Existing text Substantive change
Line 191: Line 191:
 
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===
+
===Remove Unnecessary Elements from Data Entry Form Templates===
 
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.
 
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.
  
 
===Use the Text Tool for Instructions and Versionning===
 
===Use the Text Tool for Instructions and Versionning===
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.
+
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 such as “If the reported date occurs before January 2010, enter the following...” The Data Entry Form Template Designer even supports paragraphs or lists of instructions as needed.
  
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.
+
Additionally, information managers should include versioning information on Data Entry Form 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.
  
 
   
 
   
[[Image:AdminGuide_VersionNumberFieldReportTemplate.png|center|500px|''Example of a Version Number on a Field Report Template'']]
+
[[Image:AdminGuide_VersionNumberFieldReportTemplate.png|center|500px|''Example of a Version Number on a Data Entry Form Template'']]
 
<div align="center">
 
<div align="center">
''Example of a Version Number on a Field Report Template''
+
''Example of a Version Number on a Data Entry Form Template''
 
</div>  
 
</div>  
  
 
==Template Publishing==
 
==Template Publishing==
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>.
+
When the Data Entry Form 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>.
  
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, 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 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 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.
Line 223: Line 223:
 
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|500px|''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>  
  

Revision as of 21:36, 1 May 2013

After the Data Inventory Manager is customized to include all the necessary elements for data collection, the next step is to create Data Entry Forms templates. 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 programme
  2. Design templates for data entry that mimic paper forms

Design Concept

The Data Entry Form Template Designer is a “what–you-see-is-what-you-get” (WYSIWYG) application for creating data entry forms in IMSMANG. With its 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 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.

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 drafts to the file system prior to publishing. These drafts stored in .FFML format can then be exchanged with other IMSMANG users or IMSMANG systems and be used to design other templates so information managers do not have to start with a blank template.

Note.jpg
  • After creating Data Entry Form templates in IMSMANG, 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 Data Entry Form 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.jpg To add, change, deactivate, or publish a Data Entry Form template, you must have access to the Form Template Design permission

Data Entry Form templates are the data entry forms that are available from the Data Entry Form Template Selection window and are what you use to add a Data Entry Form to IMSMA. IMSMA includes default form templates for accident and victim, land, activity, location, education, and QM. If the default form templates do not include the information you need on the Data Entry Form or are in a format that is different from what you need, you can create and publish a new Data Entry Form template.

There are several steps to creating a Data Entry Form template: 1. Determine the layout of the Data Entry Form template. This includes the Data Entry Form template’s paper size, paper orientation, and margin sizes. 2. Add report data fields to the Data Entry Form 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 Data Entry Form template. You can also add images, lines, text areas, and scribe panels to the Data Entry Form template. 4. Arrange the elements on the Data Entry Form template. You can change the data element labels, move the data elements, and align the elements. 5. Save the Data Entry Form template so that you can access it later to make additional changes. 6. Publish the Data Entry Form template so that users can access the template.

You can repeat these steps as necessary if you find that the Data Entry Form template needs to be updated.

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. The templates become the data entry screens for Data Entry Forms. 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 Data Entry Form templates but also the format the information is displayed in when the data is approved.

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 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.

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 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 land areas, activities and accidents, it is advisable to consider creating three independent general survey templates–General Survey-Land, General Survey-Activity and General Survey-Accidents–rather than creating one comprehensive template for all aspects of the general survey.

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.

Create One Template for Each Step of a Workflow

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, an activity workflow could include separate templates for the different items, including a CHA and minefield, and activities such as a technical survey, clearance, progress report and completion 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.

Example of How to Limit Templates to Include Relevant nformation Only

Example of How to Limit Templates to Include Relevant Information Only

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 land workflow, a completion survey may be submitted that creates an activity to mark the end of clearance operations on a land. In this case, it is necessary to update the status of the land 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.

Include Standard Data Elements on All Templates

Some data elements should always appear on Data Entry Form 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 IMSMANG.

Standard Data Elements
Data Element Rationale
Date of Report A data element used in summary calculations and for searching for Data Entry Forms by the date they were created
Report ID A local ID that provides a unique identifier for searching for and displaying Data Entry Forms in the Workbench
Item ID (for example, Land ID) A local ID that provides a unique identifier for searching for and displaying Data Entry Form items in lists
Geographical Reference A table for adding geospatial information about Data Entry Form items for displaying the items on the map

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.

Other Useful Data Elements
Item Data Element Item Data Element
Land Name

Mine Action Area Type Status Area Size Priority

Victim First Name

Last Name Gender Age Date of Birth Killed/Injured Victim Type

Activity Name

Start Date End Date Type of Activity Organisation Status Ordnance Found Hours Spent Size of Area

Education Start Date

End Date Organisation Education Detail ID Education Type % Male % Female Audience Number Audience Age Info

Accident Date of Accident

Accident Type

QM Start Date

End Date Organisation Results

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 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.”
  • Adding instructions “Pick one of the following:”
  • Correcting misspellings “Anml” to “Animal”
  • Translating terms “Mines to “Minas”

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”
  • “% 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.

Remove Unnecessary Elements from Data Entry Form Templates

By removing unnecessary or invalid choices from forms, information managers can improve the quality of data collected and entered into IMSMANG. 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.

Use the Text Tool for Instructions and Versionning

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 such as “If the reported date occurs before January 2010, enter the following...” The Data Entry Form Template Designer even supports paragraphs or lists of instructions as needed.

Additionally, information managers should include versioning information on Data Entry Form 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.


Example of a Version Number on a Data Entry Form Template

Template Publishing

When the Data Entry Form 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 IMSMANG 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 IMSMANG.

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 IMSMANG, 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.

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.

Template:NavBox Getting started with IMSMA