Difference between revisions of "Documenting Customisations"

From IMSMA Wiki
Jump to: navigation, search
 
(24 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
{{TOC right}}
 
{{TOC right}}
 
__NOEDITSECTION__
 
__NOEDITSECTION__
−
==Document Workflows and Business Rules==
+
==Document Workflows and Business Rules==__NOEDITSECTION__
−
After the desired data elements and field report templates are customised and published, the next step is to define and document the information workflow for each type of field report. This is a critical step for ensuring the quality of the data stored in IMSMA<sup>NG</sup>. It involves combining the workflow rules identified in Chapter 1 with the field report templates defined in Chapter 2 to create a set of workflows that can be documented as instructions or SOPs for entering and reconciling data in IMSMA<sup>NG</sup>. Each workflow and SOP should include rules for:
+
After the desired [[Data Inventory Manager|data elements]] and [[Standardising Data Entry Forms|Data Entry Form templates]] are customised and published, the next step is to define and document the information workflow for each type of Data Entry Form. This is a critical step for ensuring the quality of the data stored in {{IMSMANG}}. It involves combining the [[Understanding IMSMA Workflows and Business Rules|workflow rules]] with the Data Entry Form templates to create a set of workflows that can be documented as instructions or SOPs for reconciling and entering data in {{IMSMANG}}. Each workflow and SOP should include rules for:
  
 
*assigning locations  
 
*assigning locations  
−
*updating and replacing items
+
*creating and updating items
 
*linking items  
 
*linking items  
  
Line 15: Line 15:
 
</div>  
 
</div>  
  
−
==Creating a Programme Specific User Guide==
+
==Creating a Programme Specific User Guide==__NOEDITSECTION__
−
Creating a programme-specific user guide is a critical step in communicating information management concepts and decisions to IMSMA<sup>NG</sup> users, particularly because IMSMA<sup>NG</sup> is so customisable. With a programme-specific user guide information managers can:
+
Creating a programme-specific user guide is a critical step in communicating information management concepts and decisions to {{IMSMANG}} users, particularly because {{IMSMANG}} is so customisable. With a programme-specific user guide information managers can:
  
 
*ensure faster training of information management and operations staff
 
*ensure faster training of information management and operations staff
 
*reduce the likelihood and impact of data quality problems
 
*reduce the likelihood and impact of data quality problems
−
*provide an easy reference for data entry personnel and users of IMSMA<sup>NG</sup> information
+
*provide an easy reference for data entry personnel and users of {{IMSMANG}} information
  
−
The following sections provide guidance on creating a programme-specific user guide that supplements the IMSMA<sup>NG</sup> User Guide with specialised steps for how information should be managed within the programme.
+
===Content to Include===__NOEDITSECTION__
−
{{HowTo's
+
The guide should document the programme-specific customisations of {{IMSMANG}}. It should provide straightforward, task-specific guidance and avoid complicated discussions of possible options and conditions. Ideally, the guide is an intermediate document that bridges the gap between the goals, objectives and terms of reference of information management and the specific “how-to” instructions in the {{IMSMANG}} User Guide.
−
|[[HowTo:Customise the Help Menu|Customise the Help Menu]]
 
−
}}
 
  
−
===Content to Include===
+
===Overview===__NOEDITSECTION__
−
The guide should document the programme-specific customisations of IMSMA<sup>NG</sup> as discussed in Chapter 1 and Chapter 2 of this manual. It should provide straightforward, task-specific guidance and avoid complicated discussions of possible options and conditions. Ideally, the guide is an intermediate document that bridges the gap between the goals, objectives and terms of reference of information management and the specific “how-to” instructions in the IMSMA<sup>NG</sup> User Guide.  
+
The Overview section should cover basic information about the guide, its purpose and intent and about information management responsibilities. It should describe the overall workings of IMSMA<sup>NG</sup> including the configuration of the {{IMSMANG}} system within the programme as well as the number of users and basic roles and responsibilities.
  
−
===Overview===
+
===Items and Processes===__NOEDITSECTION__
−
The Overview section should cover basic information about the guide, its purpose and intent and about information management responsibilities. It should describe the overall workings of IMSMA<sup>NG</sup> including the configuration of the IMSMA<sup>NG</sup> system within the programme as well as the number of users and basic roles and responsibilities.
+
In this section, information managers should define each item and process that will be tracked in {{IMSMANG}}. This information should include:
  
−
===Items and Processes===
+
*description of each item category and subcategory that will be used
−
In this section, information managers should define each item and process that will be tracked in IMSMA<sup>NG</sup>. Following the recommendations in XXX, this information should include:
+
*definition of what each item category and subcategory will be used for
 +
*list of key data elements including custom-defined fields
 +
*description of the relationships among items
 +
*list of the status values for each item
 +
*direction for how locations will be used
 +
*description for how tasking will be used
  
−
*description of each item category and subcategory that will be used (see Items)
+
===Workflow and Business Rules===__NOEDITSECTION__
−
*definition of what each item category and subcategory will be used for (see Items)
+
This section should define the workflows and business rules that are to be followed when collecting and updating land and activity information. Workflows identify the processes (activities) undertaken on a land and the resulting status changes, from identification to clearance and completion. Include a workflow for each different kind of land in use
−
*list of key data elements including custom-defined fields (see Items)
 
−
*description of the relationships among items (see Assigning and Linking)
 
−
*list of the status values for each item (see Status Changes)
 
−
*direction for how locations will be used (see Location)
 
−
*description for how tasking will be used (see Tasking Tool)
 
  
−
===Workflow and Business Rules===
+
===Data Entry Process and Guidelines===__NOEDITSECTION__
−
This section should define the workflows and business rules that are to be followed when collecting and updating hazard and hazard reduction information. Workflows identify the processes (hazard reductions) undertaken on a hazard and the resulting status changes, from identification to clearance and completion. Include a workflow for each different kind of hazard in use
+
When the relevant items, processes and workflows are identified and documented, information managers should provide guidelines to assist data entry personnel in correctly reconciling, entering and linking data according to the processes. The guidelines should include an entry for each of the Data Entry Form templates to be used and a description for how each should be entered. At a minimum, these guidelines should include:
  
−
===Data Entry Process and Guidelines===
+
*name and description for each Data Entry Form template
−
When the relevant items, processes and workflows are identified and documented, information managers should provide guidelines to assist data entry personnel in correctly entering, reconciling and linking data according to the processes. The guidelines should include an entry for each of the field report templates to be used and a description for how each should be entered. At a minimum, these guidelines should include:
 
−
 
 
−
*name and description for each field report template
 
 
*list of required fields and what the values should be
 
*list of required fields and what the values should be
−
*definition of how the items in the field report should be reconciled (as new or as updates)
+
*definition of how the items in the Data Entry Form should be reconciled  
 
*description of how to determine the location for each item in the form if it is new
 
*description of how to determine the location for each item in the form if it is new
−
*definition of which existing items should be linked to the items in the field report
+
*definition of which existing items should be linked to the items in the Data Entry Form
  
−
===Outline to Follow===
+
===Outline to Follow===__NOEDITSECTION__
 
Below is an outline of a programme-specific user guide with suggestions for content to include in each section.  
 
Below is an outline of a programme-specific user guide with suggestions for content to include in each section.  
  
Line 64: Line 59:
 
<ol type="a">
 
<ol type="a">
 
<li>Locations</li>
 
<li>Locations</li>
−
<li>Hazards</li>
+
<li>Land</li>
 
<ol type="i">
 
<ol type="i">
 
<li>Suspected hazardous areas (SHA)</li>
 
<li>Suspected hazardous areas (SHA)</li>
 
<li>Confirmed hazardous areas (CHA)</li>
 
<li>Confirmed hazardous areas (CHA)</li>
−
<li>Minefields</li>
+
<li>EOD spots</li>
−
<li>UXO spots</li>
 
 
</ol>
 
</ol>
−
<li>Hazard reductions</li>
+
<li>Activities</li>
 
<ol type="i">
 
<ol type="i">
 
<li>Technical surveys</li>
 
<li>Technical surveys</li>
Line 78: Line 72:
 
<li>Completion reports</li>
 
<li>Completion reports</li>
 
</ol>
 
</ol>
−
<li>MRE activities</li>
+
<li>Education activities</li>
 
<li>Quality management</li>
 
<li>Quality management</li>
 
<ol type="i">
 
<ol type="i">
Line 91: Line 85:
 
<li>Demining victims</li>
 
<li>Demining victims</li>
 
</ol>
 
</ol>
 +
<li>Assistance</li>
 
<li>Auxiliary data</li>
 
<li>Auxiliary data</li>
 
<ol type="i">
 
<ol type="i">
 +
<li>Country Structure</li>
 
<li>Places</li>
 
<li>Places</li>
 
<li>Organisations</li>
 
<li>Organisations</li>
 
<li>Ordnance</li>
 
<li>Ordnance</li>
 +
<li>Assistance Classifications</li>
 +
<li>Cause Classifications</li>
 +
<li>Needs Classifications</li>
 
</ol>
 
</ol>
 
</ol>
 
</ol>
 
<li>Workflow and business rules</li>
 
<li>Workflow and business rules</li>
 
<ol type="a">
 
<ol type="a">
−
<li>CHA/minefield clearance workflow</li>
+
<li>CHA clearance workflow</li>
−
<li>Spot UXO clearance workflow</li>
+
<li>EOD Spot Task workflow</li>
 
</ol>
 
</ol>
 
<li>Data entry guide</li>
 
<li>Data entry guide</li>
 
<ol type="a">
 
<ol type="a">
−
<li>Entering a new minefield form</li>
+
<li>Entering a new CHA form</li>
−
<li>Entering a minefield update form</li>
+
<li>Entering a CHA update form</li>
−
<li>Entering a hazard status change form</li>
+
<li>Entering a land status change form</li>
 
<li>Entering a new clearance form</li>
 
<li>Entering a new clearance form</li>
 
<li>Entering progress reports</li>
 
<li>Entering progress reports</li>
Line 113: Line 112:
 
</ol>
 
</ol>
  
−
{{NavBox Getting started with IMSMA}}
+
{{NavBox IMSMA NG Administration}}
 +
 
 +
[[Category:NAA]]

Latest revision as of 10:26, 18 March 2019

Document Workflows and Business Rules

After the desired data elements and Data Entry Form templates are customised and published, the next step is to define and document the information workflow for each type of Data Entry Form. This is a critical step for ensuring the quality of the data stored in IMSMANG. It involves combining the workflow rules with the Data Entry Form templates to create a set of workflows that can be documented as instructions or SOPs for reconciling and entering data in IMSMANG. Each workflow and SOP should include rules for:

  • assigning locations
  • creating and updating items
  • linking items

With these rules defined, information managers can help improve data consistency and ease of searching and reporting while reducing data entry errors and the effort to correct them later. Information managers can also develop data quality searches and reports that identify and enforce the information workflows. The diagram below identifies a basic information workflow, but information managers should provide guidance to data entry personnel for how the workflow should proceed in their programmes.

Example of a Basic Information Workflow

Example of a Basic Information Workflow

Creating a Programme Specific User Guide

Creating a programme-specific user guide is a critical step in communicating information management concepts and decisions to IMSMANG users, particularly because IMSMANG is so customisable. With a programme-specific user guide information managers can:

  • ensure faster training of information management and operations staff
  • reduce the likelihood and impact of data quality problems
  • provide an easy reference for data entry personnel and users of IMSMANG information

Content to Include

The guide should document the programme-specific customisations of IMSMANG. It should provide straightforward, task-specific guidance and avoid complicated discussions of possible options and conditions. Ideally, the guide is an intermediate document that bridges the gap between the goals, objectives and terms of reference of information management and the specific “how-to” instructions in the IMSMANG User Guide.

Overview

The Overview section should cover basic information about the guide, its purpose and intent and about information management responsibilities. It should describe the overall workings of IMSMANG including the configuration of the IMSMANG system within the programme as well as the number of users and basic roles and responsibilities.

Items and Processes

In this section, information managers should define each item and process that will be tracked in IMSMANG. This information should include:

  • description of each item category and subcategory that will be used
  • definition of what each item category and subcategory will be used for
  • list of key data elements including custom-defined fields
  • description of the relationships among items
  • list of the status values for each item
  • direction for how locations will be used
  • description for how tasking will be used

Workflow and Business Rules

This section should define the workflows and business rules that are to be followed when collecting and updating land and activity information. Workflows identify the processes (activities) undertaken on a land and the resulting status changes, from identification to clearance and completion. Include a workflow for each different kind of land in use

Data Entry Process and Guidelines

When the relevant items, processes and workflows are identified and documented, information managers should provide guidelines to assist data entry personnel in correctly reconciling, entering and linking data according to the processes. The guidelines should include an entry for each of the Data Entry Form templates to be used and a description for how each should be entered. At a minimum, these guidelines should include:

  • name and description for each Data Entry Form template
  • list of required fields and what the values should be
  • definition of how the items in the Data Entry Form should be reconciled
  • description of how to determine the location for each item in the form if it is new
  • definition of which existing items should be linked to the items in the Data Entry Form

Outline to Follow

Below is an outline of a programme-specific user guide with suggestions for content to include in each section.

  1. Overview
  2. Items and Processes
    1. Locations
    2. Land
      1. Suspected hazardous areas (SHA)
      2. Confirmed hazardous areas (CHA)
      3. EOD spots
    3. Activities
      1. Technical surveys
      2. Clearances
      3. Progress reports
      4. Completion reports
    4. Education activities
    5. Quality management
      1. Quality assurance reports
      2. Quality management reports
    6. Accidents and victims
      1. Demining accidents
      2. Mine accidents
      3. Civilian victims
      4. Demining victims
    7. Assistance
    8. Auxiliary data
      1. Country Structure
      2. Places
      3. Organisations
      4. Ordnance
      5. Assistance Classifications
      6. Cause Classifications
      7. Needs Classifications
  3. Workflow and business rules
    1. CHA clearance workflow
    2. EOD Spot Task workflow
  4. Data entry guide
    1. Entering a new CHA form
    2. Entering a CHA update form
    3. Entering a land status change form
    4. Entering a new clearance form
    5. Entering progress reports
Installing IMSMANG
English
Français
Español
Customising IMSMANG
Manage Information
Retrieved from "http://mwiki.gichd.org:8090/mediawiki/index.php?title=Documenting_Customisations&oldid=24242"