http://mwiki.gichd.org:8090/mediawiki/api.php?action=feedcontributions&user=Ocottray&feedformat=atomIMSMA Wiki - User contributions [en]2024-03-28T08:32:02ZUser contributionsMediaWiki 1.28.0http://mwiki.gichd.org:8090/mediawiki/index.php?title=Export_Auxiliary_Data&diff=11364Export Auxiliary Data2013-09-20T13:40:14Z<p>Ocottray: </p>
<hr />
<div>{| style="border:2px solid lightgray; margin:10px;"<br />
|align="left" style="padding: 5px 10px 5px 10px"| To export Country Structure Areas, Explosive Ordnance, Organisation, Place Data, Assistance Classification, Cause Classification or Needs Classification you must have the [[Principles for Defining Roles, Permissions and Users|''Auxiliary Data Export'' permission]].<br />
|}<br />
<br />
<p>Auxiliary data include country structure areas, ordnance, organisations, places, assistance classifications, cause classifications and needs classifications. By exporting auxiliary data, users can transfer them between systems.</p><br />
<p>To export any auxiliary data you must first create a [[Add a Search Definition|'''search''']] on the data you want to export. Once this is done:</p><br />
<ol><br />
<li>From the '''Search Results''' window, click the '''Export''' button.</li><br />
<li>In the '''Export Options''' window:</li><br />
<ol type = "a"><br />
<li>choose if you want to export as text or XML.</li><br />
<li>choose if you want to include colum headings.</li><br />
<li>pick the colums you want to include or exclude from the colum picker frame.</li><br />
</ol><br />
</ol><br />
<br />
[[Image:fig178.png|center|500px|''Auxiliary Data Export Window'']]<br />
<div align="center"><br />
''Auxiliary Data Export Window''<br />
</div><br />
<br />
<ol start="3"><br />
<li>Click OK.</li><br />
:If you chose to export as XML, you can now choose how many records are written to a file before it is broken up into several files<br />
<li>Click OK.</li><br />
:The Save window displays. <br />
<li>From the Save window:</li><br />
<ol type="a"><br />
<li>Navigate to the directory where you would like to save the files.</li><br />
<li>Enter the name prefix for the files in the '''File Name''' field.</li><br />
<li>Click the '''Save''' button.</li><br />
:The .XML or .txt files for the auxiliary data are saved to the file and directory that you specified. When the export has completed, the Export Complete window displays. <br />
</ol><br />
<li>Click the '''OK''' button.</li><br />
:The Export Complete window closes. <br />
</ol><br />
<br />
{{NavBox HowTo Import and Export}}</div>Ocottrayhttp://mwiki.gichd.org:8090/mediawiki/index.php?title=Export_Auxiliary_Data&diff=11363Export Auxiliary Data2013-09-20T13:39:24Z<p>Ocottray: </p>
<hr />
<div>{| style="border:2px solid lightgray; margin:10px;"<br />
|align="left" style="padding: 5px 10px 5px 10px"| To export Country Structure Areas, Explosive Ordnance, Organisation, Place Data, Assistance Classification, Cause Classification or Needs Classification you must have the [[Principles for Defining Roles, Permissions and Users|''Auxiliary Data Export'' permission]].<br />
|}<br />
<br />
<p>Auxiliary data include country structure areas, ordnance, organisations, places, assistance classifications, cause classifications and needs classifications. By exporting auxiliary data, users can transfer them between systems.</p><br />
<p>To export country structure areas, explosive ordnance, organisations, places, assistance classifications, cause classifications or needs classifications you must first create a [[Add a Search Definition|'''search''']] on the data you want to export. Once this is done:</p><br />
<ol><br />
<li>From the '''Search Results''' window, click the '''Export''' button.</li><br />
<li>In the '''Export Options''' window:</li><br />
<ol type = "a"><br />
<li>choose if you want to export as text or XML.</li><br />
<li>choose if you want to include colum headings.</li><br />
<li>pick the colums you want to include or exclude from the colum picker frame.</li><br />
</ol><br />
</ol><br />
<br />
[[Image:fig178.png|center|500px|''Auxiliary Data Export Window'']]<br />
<div align="center"><br />
''Auxiliary Data Export Window''<br />
</div><br />
<br />
<ol start="3"><br />
<li>Click OK.</li><br />
:If you chose to export as XML, you can now choose how many records are written to a file before it is broken up into several files<br />
<li>Click OK.</li><br />
:The Save window displays. <br />
<li>From the Save window:</li><br />
<ol type="a"><br />
<li>Navigate to the directory where you would like to save the files.</li><br />
<li>Enter the name prefix for the files in the '''File Name''' field.</li><br />
<li>Click the '''Save''' button.</li><br />
:The .XML or .txt files for the auxiliary data are saved to the file and directory that you specified. When the export has completed, the Export Complete window displays. <br />
</ol><br />
<li>Click the '''OK''' button.</li><br />
:The Export Complete window closes. <br />
</ol><br />
<br />
{{NavBox HowTo Import and Export}}</div>Ocottrayhttp://mwiki.gichd.org:8090/mediawiki/index.php?title=Export_Auxiliary_Data&diff=11353Export Auxiliary Data2013-09-20T12:15:51Z<p>Ocottray: </p>
<hr />
<div>{| style="border:2px solid lightgray; margin:10px;"<br />
|align="left" style="padding: 5px 10px 5px 10px"| To export country structure areas, explosive ordnance, organisation, or place data, you must have the [[Principles for Defining Roles, Permissions and Users|''Auxiliary Data Export'' permission]].<br />
|}<br />
<br />
<p>Auxiliary data include country structure areas, ordnance, organisations, and places. By exporting auxiliary data, users can transfer them between systems.</p><br />
<p>To export country structure areas, explosive ordnance, organisations, or places you must first create a [[Add a Search Definition|'''search''']] on the data you want to export. Once this is done:</p><br />
<ol><br />
<li>From the '''Search Results''' window, click the '''Export''' button.</li><br />
<li>In the '''Export Options''' window:</li><br />
<ol type = "a"><br />
<li>choose if you want to export as text or XML.</li><br />
<li>choose if you want to include colum headings.</li><br />
<li>pick the colums you want to include or exclude from the colum picker frame.</li><br />
</ol><br />
</ol><br />
<br />
[[Image:fig178.png|center|500px|''Auxiliary Data Export Window'']]<br />
<div align="center"><br />
''Auxiliary Data Export Window''<br />
</div><br />
<br />
<ol start="3"><br />
<li>Click OK.</li><br />
:If you chose to export as XML, you can now choose how many records are written to a file before it is broken up into several files<br />
<li>Click OK.</li><br />
:The Save window displays. <br />
<li>From the Save window:</li><br />
<ol type="a"><br />
<li>Navigate to the directory where you would like to save the files.</li><br />
<li>Enter the name prefix for the files in the '''File Name''' field.</li><br />
<li>Click the '''Save''' button.</li><br />
:The .XML or .txt files for the auxiliary data are saved to the file and directory that you specified. When the export has completed, the Export Complete window displays. <br />
</ol><br />
<li>Click the '''OK''' button.</li><br />
:The Export Complete window closes. <br />
</ol><br />
<br />
{{NavBox HowTo Import and Export}}</div>Ocottrayhttp://mwiki.gichd.org:8090/mediawiki/index.php?title=Export_Auxiliary_Data&diff=11351Export Auxiliary Data2013-09-20T12:12:10Z<p>Ocottray: </p>
<hr />
<div>{| style="border:2px solid lightgray; margin:10px;"<br />
|align="left" style="padding: 5px 10px 5px 10px"| To export country structure areas, explosive ordnance, organisation, or place data, you must have the [[Principles for Defining Roles, Permissions and Users|''Auxiliary Data Export'' permission]].<br />
|}<br />
<br />
<p>Auxiliary data include country structure areas, ordnance, organisations, and places. By exporting auxiliary data, users can transfer them between systems.</p><br />
<p>To export country structure areas, explosive ordnance, organisations, or places you must first create a [[Add a Search Definition|'''search''']] on the data you want to export. Once this is done:</p><br />
<ol><br />
<li>From the '''Search Results''' window, click the '''Export''' button.</li><br />
<li>In the '''Export Options''' window:</li><br />
<ol type = "a"><br />
<li>choose if you want to export as text or XML.</li><br />
<li>choose if you want to include colum headings.</li><br />
<li>pick the colums you want to include or exclude from the colum picker frame.</li><br />
</ol><br />
</ol><br />
<br />
[[Image:fig178.png|center|500px|''Auxiliary Data Export Window'']]<br />
<div align="center"><br />
''Auxiliary Data Export Window''<br />
</div><br />
<br />
<ol start="3"><br />
<li>Click OK.</li><br />
:The Save window displays. <br />
<li>From the Save window:</li><br />
<ol type="a"><br />
<li>Navigate to the directory where you would like to save the files.</li><br />
<li>Enter the name prefix for the files in the '''File Name''' field.</li><br />
<li>Click the '''Save''' button.</li><br />
:The .XML or .txt files for the auxiliary data are saved to the file and directory that you specified. When the export has completed, the Export Complete window displays. <br />
</ol><br />
<li>Click the '''OK''' button.</li><br />
:The Export Complete window closes. <br />
</ol><br />
<br />
{{NavBox HowTo Import and Export}}</div>Ocottrayhttp://mwiki.gichd.org:8090/mediawiki/index.php?title=Add_a_Search_Definition&diff=11336Add a Search Definition2013-09-20T10:11:54Z<p>Ocottray: </p>
<hr />
<div>To add a search definition:<br />
<ol><br />
<li>From the '''Search''' menu, select '''Advanced Search'''.</li><br />
:The Search (Add) window displays.<br />
<li>Enter a name for the search definition in the '''Name''' field.</li><br />
<li>Enter a description of the search definition in the Description field.</li><br />
<li>From the Search Target list, select the item that you would like to search.</li><br />
<li>The search condition defaults to ''OR''. You can change the search condition by clicking the condition in the search criteria pane and selecting ''OR'' or ''AND'' from the list. For more information on the AND/OR search condition, refer to ''[[And Versus Or]]''.</li><br />
</ol><br />
<br />
[[Image:fig72.png|center|500px|''Changing the AND/OR Condition'']]<br />
<div align="center"><br />
''Changing the AND/OR Condition''<br />
</div><br />
<br />
<ol start="6"><br />
<li>To add a criteria to the search definition, click the [[Image:FieldTemplateIcon.png | Add]] button.</li><br />
<li>A row is added to the criteria pane. Each row in the pane represents a criterion. A criterion is comprised of an attribute, operator, and value.</li><br />
</ol><br />
<br />
[[Image:fig73.png|center|500px|''Figure 73. Criterion Components'']]<br />
<div align="center"><br />
''Criterion Components''<br />
</div><br />
<br />
<ol start="8"><br />
<li>Select the attribute on which you would like to apply a constraint from the leftmost list. The attributes in the list are determined by the item selected from the Search Target list.</li><br />
<li>Select the operator that you would like to apply to the attribute from the list. The available operators are determined by the data type of the selected attribute.</li><br />
<li>Do one of the following to specify the value(s) that the attribute must meet:</li><br />
*Enter a value in the text field beside the Operator list.<br />
*If the selected attribute has predefined values such as those available from a list of options, you can click the '''Options''' button to view the available options. <br />
*If you would like to wait until you run the search to specify the value, check the '''Prompt''' checkbox. <br />
<li>Repeat steps 7–12 for each criterion you would like to add to the search definition.</li><br />
</ol><br />
<br />
{{note|To change the order of a single criterion or an AND/OR group in the search definition (except the first criterion and group combination), select the criterion or group and click the [[Image:UpBlueArrow.png | Move Up]] or the [[Image:DownBlueArrow.png | Move Down]] button.}}<br />
<br />
{{note|To remove a criterion or an AND/OR group from the search definition, select the criterion or group and click the [[Image:EcksButton.png | Delete]] button.}}<br />
<br />
<ol start="12"><br />
<li>When you have finished adding criteria to the search definition, do one of the following:</li><br />
*To save the search definition, click the '''Save''' button. <br />
*To execute the search, click the '''Run''' button. <br />
</ol><br />
{{NavBox HowTo Search}}</div>Ocottrayhttp://mwiki.gichd.org:8090/mediawiki/index.php?title=Export_Auxiliary_Data&diff=11335Export Auxiliary Data2013-09-20T10:07:38Z<p>Ocottray: </p>
<hr />
<div>{| style="border:2px solid lightgray; margin:10px;"<br />
|align="left" style="padding: 5px 10px 5px 10px"| To export country structure areas, explosive ordnance, organisation, or place data, you must have the [[Principles for Defining Roles, Permissions and Users|''Auxiliary Data Export'' permission]].<br />
|}<br />
<br />
<p>Auxiliary data include country structure areas, ordnance, organisations, and places. By using the export auxiliary data feature, users can transfer files between systems.</p><br />
<p>To export country structure areas, explosive ordnance, organisations, or places:</p><br />
<ol><br />
<li>From the '''File''' menu, select '''Export'''.</li><br />
<li>From the '''Export''' menu, select '''Auxiliary Data'''.</li><br />
:The Auxiliary Data Export window displays.<br />
<li>In the '''Exported By''' field, enter a value to display in the Workbench window after the data entry form is imported.</li><br />
</ol><br />
<br />
[[Image:fig178.png|center|500px|''Auxiliary Data Export Window'']]<br />
<div align="center"><br />
''Auxiliary Data Export Window''<br />
</div><br />
<br />
<ol start="4"><br />
<li>Check the items that you would like to export.</li><br />
<li>If you would like to include inactive items, check the export inactive objects checkbox.</li><br />
<li>Click the '''Next''' button.</li><br />
:The Export Summary displays the number of records that will be exported for each item.<br />
<li>Click the Export button.</li><br />
:The Save window displays. <br />
<li>From the Save window:</li><br />
<ol type="a"><br />
<li>Navigate to the directory where you would like to save the files.</li><br />
<li>Enter the name prefix for the files in the '''File Name''' field.</li><br />
<li>Click the '''Save''' button.</li><br />
:The .XML files for the auxiliary data are saved to the file and directory that you specified. When the export has completed, the Export Complete window displays. <br />
</ol><br />
<li>Click the '''OK''' button.</li><br />
:The Export Complete window closes. An .XML file is created for each item that you chose to export. The file is prefixed with the name that you entered in step 8b. <br />
</ol><br />
<br />
{{NavBox HowTo Import and Export}}</div>Ocottrayhttp://mwiki.gichd.org:8090/mediawiki/index.php?title=Language_and_Translations&diff=11333Language and Translations2013-09-20T09:03:14Z<p>Ocottray: </p>
<hr />
<div>__FORCETOC__<br />
{{TOC right}}<br />
{{HowTo's<br />
|[[Change the Language|How does IMSMA know which language to use?]]<br />
|[[Update the Localisation Files|Update the Localisation Files]]<br />
}}<br />
<br />
In order to use other languages than English, three files are used for localization of the messages and terms used in {{IMSMANG}}. If you would like to run {{IMSMANG}} in a language other than English, you will need to enter translations into the following properties files:<br />
* IMessages.properties;<br />
* ITerms.properties.<br />
<br />
These two files are stored as files and are not imported into the database nor included in the database backup. Please, refer to [[Considerations for Backup and Restore]].<br />
<br />
The third file is created by the [[Export and Translate the Terms|Export Translations]] in the File menu and should be [[Import the Translated Terms|imported]] back into the database after the translation is done.<br />
<br />
{{note| To modify the localisation files, you '''should''' use Rosetta-J. For information on using Rosetta-J, contact your GICHD IM advisor.}}<br />
<br />
{{NavBox Getting started with IMSMA}}</div>Ocottrayhttp://mwiki.gichd.org:8090/mediawiki/index.php?title=Documenting_Customisations&diff=11229Documenting Customisations2013-09-19T13:42:59Z<p>Ocottray: </p>
<hr />
<div>{{TOC right}}<br />
__NOEDITSECTION__<br />
==Document Workflows and Business Rules==__NOEDITSECTION__<br />
After the desired [[Principles for Managing the Data Inventory Manager|data elements]] and [[Principles for Standardizing 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 entering and reconciling data in {{IMSMANG}}. Each workflow and SOP should include rules for:<br />
<br />
*assigning locations <br />
*updating and replacing items<br />
*linking items <br />
<br />
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.<br />
<br />
[[Image:AdminGuide_ExampleBasicInformationWorkflow.png|center|500px|''Example of a Basic Information Workflow'']]<br />
<div align="center"><br />
''Example of a Basic Information Workflow''<br />
</div> <br />
<br />
==Creating a Programme Specific User Guide==__NOEDITSECTION__<br />
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:<br />
<br />
*ensure faster training of information management and operations staff<br />
*reduce the likelihood and impact of data quality problems<br />
*provide an easy reference for data entry personnel and users of {{IMSMANG}} information<br />
<br />
===Content to Include===__NOEDITSECTION__<br />
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. <br />
<br />
===Overview===__NOEDITSECTION__<br />
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.<br />
<br />
===Items and Processes===__NOEDITSECTION__<br />
In this section, information managers should define each item and process that will be tracked in {{IMSMANG}}. This information should include:<br />
<br />
*description of each item category and subcategory that will be used<br />
*definition of what each item category and subcategory will be used for<br />
*list of key data elements including custom-defined fields<br />
*description of the relationships among items<br />
*list of the status values for each item<br />
*direction for how locations will be used<br />
*description for how tasking will be used<br />
<br />
===Workflow and Business Rules===__NOEDITSECTION__<br />
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<br />
<br />
===Data Entry Process and Guidelines===__NOEDITSECTION__<br />
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 Data Entry Form templates to be used and a description for how each should be entered. At a minimum, these guidelines should include:<br />
<br />
*name and description for each Data Entry Form template<br />
*list of required fields and what the values should be<br />
*definition of how the items in the Data Entry Form should be reconciled (as new or as updates)<br />
*description of how to determine the location for each item in the form if it is new<br />
*definition of which existing items should be linked to the items in the Data Entry Form<br />
<br />
===Outline to Follow===__NOEDITSECTION__<br />
Below is an outline of a programme-specific user guide with suggestions for content to include in each section. <br />
<br />
<ol><br />
<li>Overview</li><br />
<li>Items and Processes</li><br />
<ol type="a"><br />
<li>Locations</li><br />
<li>Land</li><br />
<ol type="i"><br />
<li>Suspected hazardous areas (SHA)</li><br />
<li>Confirmed hazardous areas (CHA)</li><br />
<li>Minefields</li><br />
<li>UXO spots</li><br />
</ol><br />
<li>Activities</li><br />
<ol type="i"><br />
<li>Technical surveys</li><br />
<li>Clearances</li><br />
<li>Progress reports</li><br />
<li>Completion reports</li><br />
</ol><br />
<li>Education activities</li><br />
<li>Quality management</li><br />
<ol type="i"><br />
<li>Quality assurance reports</li><br />
<li>Quality management reports</li><br />
</ol><br />
<li>Accidents and victims</li><br />
<ol type="i"><br />
<li>Demining accidents</li><br />
<li>Mine accidents</li><br />
<li>Civilian victims</li><br />
<li>Demining victims</li><br />
</ol><br />
<li>Auxiliary data</li><br />
<ol type="i"><br />
<li>Places</li><br />
<li>Organisations</li><br />
<li>Ordnance</li><br />
</ol><br />
</ol><br />
<li>Workflow and business rules</li><br />
<ol type="a"><br />
<li>CHA/minefield clearance workflow</li><br />
<li>Spot UXO clearance workflow</li><br />
</ol><br />
<li>Data entry guide</li><br />
<ol type="a"><br />
<li>Entering a new minefield form</li><br />
<li>Entering a minefield update form</li><br />
<li>Entering a land status change form</li><br />
<li>Entering a new clearance form</li><br />
<li>Entering progress reports</li><br />
</ol><br />
</ol><br />
<br />
{{NavBox Getting started with IMSMA}}</div>Ocottrayhttp://mwiki.gichd.org:8090/mediawiki/index.php?title=Documenting_Customisations&diff=11228Documenting Customisations2013-09-19T13:41:43Z<p>Ocottray: </p>
<hr />
<div>{{TOC right}}<br />
__NOEDITSECTION__<br />
==Document Workflows and Business Rules==__NOEDITSECTION__<br />
After the desired [[Principles for Managing the Data Inventory Manager|data elements]] and [[Principles for Standardizing 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 workflow rules with the Data Entry Form templates to create a set of workflows that can be documented as instructions or SOPs for entering and reconciling data in {{IMSMANG}}. Each workflow and SOP should include rules for:<br />
<br />
*assigning locations <br />
*updating and replacing items<br />
*linking items <br />
<br />
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.<br />
<br />
[[Image:AdminGuide_ExampleBasicInformationWorkflow.png|center|500px|''Example of a Basic Information Workflow'']]<br />
<div align="center"><br />
''Example of a Basic Information Workflow''<br />
</div> <br />
<br />
==Creating a Programme Specific User Guide==__NOEDITSECTION__<br />
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:<br />
<br />
*ensure faster training of information management and operations staff<br />
*reduce the likelihood and impact of data quality problems<br />
*provide an easy reference for data entry personnel and users of {{IMSMANG}} information<br />
<br />
===Content to Include===__NOEDITSECTION__<br />
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. <br />
<br />
===Overview===__NOEDITSECTION__<br />
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.<br />
<br />
===Items and Processes===__NOEDITSECTION__<br />
In this section, information managers should define each item and process that will be tracked in {{IMSMANG}}. This information should include:<br />
<br />
*description of each item category and subcategory that will be used<br />
*definition of what each item category and subcategory will be used for<br />
*list of key data elements including custom-defined fields<br />
*description of the relationships among items<br />
*list of the status values for each item<br />
*direction for how locations will be used<br />
*description for how tasking will be used<br />
<br />
===Workflow and Business Rules===__NOEDITSECTION__<br />
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<br />
<br />
===Data Entry Process and Guidelines===__NOEDITSECTION__<br />
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 Data Entry Form templates to be used and a description for how each should be entered. At a minimum, these guidelines should include:<br />
<br />
*name and description for each Data Entry Form template<br />
*list of required fields and what the values should be<br />
*definition of how the items in the Data Entry Form should be reconciled (as new or as updates)<br />
*description of how to determine the location for each item in the form if it is new<br />
*definition of which existing items should be linked to the items in the Data Entry Form<br />
<br />
===Outline to Follow===__NOEDITSECTION__<br />
Below is an outline of a programme-specific user guide with suggestions for content to include in each section. <br />
<br />
<ol><br />
<li>Overview</li><br />
<li>Items and Processes</li><br />
<ol type="a"><br />
<li>Locations</li><br />
<li>Land</li><br />
<ol type="i"><br />
<li>Suspected hazardous areas (SHA)</li><br />
<li>Confirmed hazardous areas (CHA)</li><br />
<li>Minefields</li><br />
<li>UXO spots</li><br />
</ol><br />
<li>Activities</li><br />
<ol type="i"><br />
<li>Technical surveys</li><br />
<li>Clearances</li><br />
<li>Progress reports</li><br />
<li>Completion reports</li><br />
</ol><br />
<li>Education activities</li><br />
<li>Quality management</li><br />
<ol type="i"><br />
<li>Quality assurance reports</li><br />
<li>Quality management reports</li><br />
</ol><br />
<li>Accidents and victims</li><br />
<ol type="i"><br />
<li>Demining accidents</li><br />
<li>Mine accidents</li><br />
<li>Civilian victims</li><br />
<li>Demining victims</li><br />
</ol><br />
<li>Auxiliary data</li><br />
<ol type="i"><br />
<li>Places</li><br />
<li>Organisations</li><br />
<li>Ordnance</li><br />
</ol><br />
</ol><br />
<li>Workflow and business rules</li><br />
<ol type="a"><br />
<li>CHA/minefield clearance workflow</li><br />
<li>Spot UXO clearance workflow</li><br />
</ol><br />
<li>Data entry guide</li><br />
<ol type="a"><br />
<li>Entering a new minefield form</li><br />
<li>Entering a minefield update form</li><br />
<li>Entering a land status change form</li><br />
<li>Entering a new clearance form</li><br />
<li>Entering progress reports</li><br />
</ol><br />
</ol><br />
<br />
{{NavBox Getting started with IMSMA}}</div>Ocottrayhttp://mwiki.gichd.org:8090/mediawiki/index.php?title=Documenting_Customisations&diff=11216Documenting Customisations2013-09-19T13:11:49Z<p>Ocottray: </p>
<hr />
<div>{{TOC right}}<br />
__NOEDITSECTION__<br />
==Document Workflows and Business Rules==__NOEDITSECTION__<br />
After the desired [[Principles for Managing the Data Inventory Manager|data elements]] and [[Principles for Standardizing 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 IMSMA<sup>NG</sup>. It involves combining the workflow rules identified in Chapter 1 with the Data Entry Form 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:<br />
<br />
*assigning locations <br />
*updating and replacing items<br />
*linking items <br />
<br />
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.<br />
<br />
[[Image:AdminGuide_ExampleBasicInformationWorkflow.png|center|500px|''Example of a Basic Information Workflow'']]<br />
<div align="center"><br />
''Example of a Basic Information Workflow''<br />
</div> <br />
<br />
==Creating a Programme Specific User Guide==__NOEDITSECTION__<br />
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:<br />
<br />
*ensure faster training of information management and operations staff<br />
*reduce the likelihood and impact of data quality problems<br />
*provide an easy reference for data entry personnel and users of IMSMA<sup>NG</sup> information<br />
<br />
===Content to Include===__NOEDITSECTION__<br />
The guide should document the programme-specific customisations of IMSMA<sup>NG</sup>. 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. <br />
<br />
===Overview===__NOEDITSECTION__<br />
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.<br />
<br />
===Items and Processes===__NOEDITSECTION__<br />
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:<br />
<br />
*description of each item category and subcategory that will be used (see Items)<br />
*definition of what each item category and subcategory will be used for (see Items)<br />
*list of key data elements including custom-defined fields (see Items)<br />
*description of the relationships among items (see Assigning and Linking)<br />
*list of the status values for each item (see Status Changes)<br />
*direction for how locations will be used (see Location)<br />
*description for how tasking will be used (see Tasking Tool)<br />
<br />
===Workflow and Business Rules===__NOEDITSECTION__<br />
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<br />
<br />
===Data Entry Process and Guidelines===__NOEDITSECTION__<br />
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 Data Entry Form templates to be used and a description for how each should be entered. At a minimum, these guidelines should include:<br />
<br />
*name and description for each Data Entry Form template<br />
*list of required fields and what the values should be<br />
*definition of how the items in the Data Entry Form should be reconciled (as new or as updates)<br />
*description of how to determine the location for each item in the form if it is new<br />
*definition of which existing items should be linked to the items in the Data Entry Form<br />
<br />
===Outline to Follow===__NOEDITSECTION__<br />
Below is an outline of a programme-specific user guide with suggestions for content to include in each section. <br />
<br />
<ol><br />
<li>Overview</li><br />
<li>Items and Processes</li><br />
<ol type="a"><br />
<li>Locations</li><br />
<li>Land</li><br />
<ol type="i"><br />
<li>Suspected hazardous areas (SHA)</li><br />
<li>Confirmed hazardous areas (CHA)</li><br />
<li>Minefields</li><br />
<li>UXO spots</li><br />
</ol><br />
<li>Activities</li><br />
<ol type="i"><br />
<li>Technical surveys</li><br />
<li>Clearances</li><br />
<li>Progress reports</li><br />
<li>Completion reports</li><br />
</ol><br />
<li>Education activities</li><br />
<li>Quality management</li><br />
<ol type="i"><br />
<li>Quality assurance reports</li><br />
<li>Quality management reports</li><br />
</ol><br />
<li>Accidents and victims</li><br />
<ol type="i"><br />
<li>Demining accidents</li><br />
<li>Mine accidents</li><br />
<li>Civilian victims</li><br />
<li>Demining victims</li><br />
</ol><br />
<li>Auxiliary data</li><br />
<ol type="i"><br />
<li>Places</li><br />
<li>Organisations</li><br />
<li>Ordnance</li><br />
</ol><br />
</ol><br />
<li>Workflow and business rules</li><br />
<ol type="a"><br />
<li>CHA/minefield clearance workflow</li><br />
<li>Spot UXO clearance workflow</li><br />
</ol><br />
<li>Data entry guide</li><br />
<ol type="a"><br />
<li>Entering a new minefield form</li><br />
<li>Entering a minefield update form</li><br />
<li>Entering a land status change form</li><br />
<li>Entering a new clearance form</li><br />
<li>Entering progress reports</li><br />
</ol><br />
</ol><br />
<br />
{{NavBox Getting started with IMSMA}}</div>Ocottrayhttp://mwiki.gichd.org:8090/mediawiki/index.php?title=Documenting_Customisations&diff=11215Documenting Customisations2013-09-19T13:10:21Z<p>Ocottray: </p>
<hr />
<div>{{TOC right}}<br />
__NOEDITSECTION__<br />
==Document Workflows and Business Rules==__NOEDITSECTION__<br />
After the desired data elements and [[Principles for Standardizing 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 IMSMA<sup>NG</sup>. It involves combining the workflow rules identified in Chapter 1 with the Data Entry Form 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:<br />
<br />
*assigning locations <br />
*updating and replacing items<br />
*linking items <br />
<br />
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.<br />
<br />
[[Image:AdminGuide_ExampleBasicInformationWorkflow.png|center|500px|''Example of a Basic Information Workflow'']]<br />
<div align="center"><br />
''Example of a Basic Information Workflow''<br />
</div> <br />
<br />
==Creating a Programme Specific User Guide==__NOEDITSECTION__<br />
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:<br />
<br />
*ensure faster training of information management and operations staff<br />
*reduce the likelihood and impact of data quality problems<br />
*provide an easy reference for data entry personnel and users of IMSMA<sup>NG</sup> information<br />
<br />
===Content to Include===__NOEDITSECTION__<br />
The guide should document the programme-specific customisations of IMSMA<sup>NG</sup>. 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. <br />
<br />
===Overview===__NOEDITSECTION__<br />
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.<br />
<br />
===Items and Processes===__NOEDITSECTION__<br />
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:<br />
<br />
*description of each item category and subcategory that will be used (see Items)<br />
*definition of what each item category and subcategory will be used for (see Items)<br />
*list of key data elements including custom-defined fields (see Items)<br />
*description of the relationships among items (see Assigning and Linking)<br />
*list of the status values for each item (see Status Changes)<br />
*direction for how locations will be used (see Location)<br />
*description for how tasking will be used (see Tasking Tool)<br />
<br />
===Workflow and Business Rules===__NOEDITSECTION__<br />
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<br />
<br />
===Data Entry Process and Guidelines===__NOEDITSECTION__<br />
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 Data Entry Form templates to be used and a description for how each should be entered. At a minimum, these guidelines should include:<br />
<br />
*name and description for each Data Entry Form template<br />
*list of required fields and what the values should be<br />
*definition of how the items in the Data Entry Form should be reconciled (as new or as updates)<br />
*description of how to determine the location for each item in the form if it is new<br />
*definition of which existing items should be linked to the items in the Data Entry Form<br />
<br />
===Outline to Follow===__NOEDITSECTION__<br />
Below is an outline of a programme-specific user guide with suggestions for content to include in each section. <br />
<br />
<ol><br />
<li>Overview</li><br />
<li>Items and Processes</li><br />
<ol type="a"><br />
<li>Locations</li><br />
<li>Land</li><br />
<ol type="i"><br />
<li>Suspected hazardous areas (SHA)</li><br />
<li>Confirmed hazardous areas (CHA)</li><br />
<li>Minefields</li><br />
<li>UXO spots</li><br />
</ol><br />
<li>Activities</li><br />
<ol type="i"><br />
<li>Technical surveys</li><br />
<li>Clearances</li><br />
<li>Progress reports</li><br />
<li>Completion reports</li><br />
</ol><br />
<li>Education activities</li><br />
<li>Quality management</li><br />
<ol type="i"><br />
<li>Quality assurance reports</li><br />
<li>Quality management reports</li><br />
</ol><br />
<li>Accidents and victims</li><br />
<ol type="i"><br />
<li>Demining accidents</li><br />
<li>Mine accidents</li><br />
<li>Civilian victims</li><br />
<li>Demining victims</li><br />
</ol><br />
<li>Auxiliary data</li><br />
<ol type="i"><br />
<li>Places</li><br />
<li>Organisations</li><br />
<li>Ordnance</li><br />
</ol><br />
</ol><br />
<li>Workflow and business rules</li><br />
<ol type="a"><br />
<li>CHA/minefield clearance workflow</li><br />
<li>Spot UXO clearance workflow</li><br />
</ol><br />
<li>Data entry guide</li><br />
<ol type="a"><br />
<li>Entering a new minefield form</li><br />
<li>Entering a minefield update form</li><br />
<li>Entering a land status change form</li><br />
<li>Entering a new clearance form</li><br />
<li>Entering progress reports</li><br />
</ol><br />
</ol><br />
<br />
{{NavBox Getting started with IMSMA}}</div>Ocottrayhttp://mwiki.gichd.org:8090/mediawiki/index.php?title=Template:NavBox_HowTo_Produce_Reports&diff=10074Template:NavBox HowTo Produce Reports2013-08-29T08:19:32Z<p>Ocottray: </p>
<hr />
<div>{{Navbox<br />
| name = Produce Reports<br />
| state = {{{state|<includeonly>autocollapse</includeonly><noinclude>uncollapsed</noinclude>}}}<br />
| title = [[Portal:Using IMSMA/Categories|Using IMSMA]]<br />
| liststyle = line-height:1.3em;<br />
| bodyclass = hlist<br />
<br />
| group1 = [[Producing Reports Using IMSMANG]]<br />
| list1 =[[Associate a Name and a Description to an i-Report Template in IMSMA]]&nbsp;· [[I-Report Templates]]&nbsp;· [[Preview an i-Report Template in IMSMA]]&nbsp;· [[Add an i-Report Template in IMSMA]]&nbsp;· [[View or Change an i-Report Template in IMSMA]]&nbsp;· [[Remove an i-Report Template in IMSMA]]&nbsp;· [[Execute i-Reports in IMSMA]]&nbsp;· [[Add i-Reports in IMSMA]]&nbsp;· [[View or Change i-Reports in IMSMA]]&nbsp;· [[Remove i-Reports in IMSMA]]&nbsp;· [[Olivier]]<br />
<br />
<br />
<br />
}}</div>Ocottray