Difference between revisions of "IMSMA and maXML"

From IMSMA Wiki
Jump to: navigation, search
Line 1: Line 1:
−
{{IMSMANG}} exchanges data by exporting and importing maXML files containing information in the form of Data Entry Forms or Auxiliary Data. Data Entry Forms in {{IMSMANG}} uses a selection of fields from a certain topic depending on needs to collect or enter information ex. Accident can either use fields for civilian accidents in non-surveyed areas or for demining accidents in Land during clearance activities.
+
{{Note | The selection of fields used for Data Entry Forms differs between countries. Mine Action Programs also have the possibility to add its own fields or modify the existing standard ones. This means that {{IMSMANG}} data can be very different between countries. It is therefore necessary to understand a country’s specific set of data collection forms in order to be able to exchange information with that country’s {{IMSMANG}}.}}
−
 
 
−
Currently {{IMSMANG}} can only export auxiliary data, not import it. The latest review of maXML has focused mainly on updating the maXML schema for those parts that can be imported into {{IMSMANG}}. The schemas description of auxiliary data still differs in many cases from how {{IMSMANG}} exports this information and should not be considered representative of {{IMSMANG}}.
 
−
 
 
−
The selection of fields used for Data Entry Forms usually differs between countries. Mine Action Programs also have the possibility to add its own fields or modify the existing standard ones. This means that {{IMSMANG}} data can be very different between countries. It is therefore necessary to understand a country’s specific set of data collection forms in order to be able to exchange information with that country’s {{IMSMANG}}.
 
−
 
 
−
==Documentation structure==__NOEDITSECTION__
 
−
The elements in each Artifact are explained in detail in the sub pages by specifying all elements within the Artifacts.
 
  
 
Some elements are used by several Artifacts such as DocumentHeader, GeospatialInfo etc. and they are specified in the Common pages. The common elements are listed in the artifacts they appear to reflect their location in maXML but with a reference to find their specification in common elements.  
 
Some elements are used by several Artifacts such as DocumentHeader, GeospatialInfo etc. and they are specified in the Common pages. The common elements are listed in the artifacts they appear to reflect their location in maXML but with a reference to find their specification in common elements.  
Line 13: Line 6:
 
   
 
   
 
An enumeration list may be obtained by contacting your [[Information Management Team | GICHD IM advisor]]. Choices in {{IMSMANG}} can be customised to fit the needs of specific mine Action programmes. Customised values are added to the IMSMA enumeration list when created. It is therefore recommended to request specific lists of enumeration values from each country.
 
An enumeration list may be obtained by contacting your [[Information Management Team | GICHD IM advisor]]. Choices in {{IMSMANG}} can be customised to fit the needs of specific mine Action programmes. Customised values are added to the IMSMA enumeration list when created. It is therefore recommended to request specific lists of enumeration values from each country.
 +
 +
The Artifact pages reflect the structure and sequence of elements as '''defined and exported''' by {{IMSMANG}. The form of maXML exported and imported by IMSMA differs slightly from the maXML defined by the generic maXML schema and therefore some exports will not validate to the original schema. Anyone who would like to exchange information with {{IMSMANG}} should follow IMSMA maXML dictionary to construct or read a maXML file correctly formatted for {{IMSMANG}}.
 +
 +
IMSMA imports its main objects in the form of field reports. The different types of field reports are all collected under the parents MineActionFieldReport, FieldReport in maXML. In order to correctly form a field report for import by an IMSMA system one would need to construct a maXML document containing the elements DocumenHeader (not required see below), FieldReportInfo and the desired type of field report, there is also the option to include the element attachment if relevant. The different types of field report are Accident, Hazard, HazardReduction, Location, MREActivity, QAActivity, Victim, and VictimAssistance.  Multiple field reports of various types can be included in one file and imported by IMSMA each separate field report should then be contained within its own FieldReport tags.
 +
 +
In addition to the field reports there are eight elements for Auxiliary data. {{IMSMANG}} does not currently import Auxiliary data but it does export it. It will be of interest to read Auxiliary data from {{IMSMANG}} for any system that intends to exchange information with {{IMSMANG}} as there are often many references to Auxiliary data in a field report. Information about organisations, places, country structure and more are referred to in a field report through GUIDs which can only be obtained from an {{IMSMANG}}installation.
 +
 +
==Required/recommended elements and attributes ==__NOEDITSECTION__
 +
There are very few elements in maXML that are absolutely required in order for {{IMSMANG}} to import the data. Non required elements can be excluded from an import but obviously any information they may contain will not be imported. The attribute ''originalValue'' is used and exported by {{IMSMANG}} for all multiple and single select fields in {{IMSMANG}}. They are always the same as the value of the element and can be excluded without any loss of information. The element ''UnitOfMeasure'' and all children of the same are exported by {{IMSMANG}} but are automatically set to default values during import and can therefore be excluded without any loss of information. 
 +
 +
The only value within ''DocumentHeader'' that will be stored by {{IMSMANG}} if included is the ''FileCreationDateTime'', all others will have values automatically assigned by {{IMSMANG}} whether they contain anything or not. If left out the ''FileCreationDateTime'' will be assigned to the moment of import by {{IMSMANG}}. The ''DocumentHeader'' element can be left out entirely from a xml file and {{IMSMANG}} will still import it without errors or information lost.
  
 
{{NavBox XML Documentation}}
 
{{NavBox XML Documentation}}
 
[[Category:NAA]]
 
[[Category:NAA]]

Revision as of 19:46, 12 June 2017

Note.jpg The selection of fields used for Data Entry Forms differs between countries. Mine Action Programs also have the possibility to add its own fields or modify the existing standard ones. This means that IMSMANG data can be very different between countries. It is therefore necessary to understand a country’s specific set of data collection forms in order to be able to exchange information with that country’s IMSMANG.

Some elements are used by several Artifacts such as DocumentHeader, GeospatialInfo etc. and they are specified in the Common pages. The common elements are listed in the artifacts they appear to reflect their location in maXML but with a reference to find their specification in common elements.

For radiobuttons and checkboxes IMSMA uses enumeration values retrieved from an enumeration table to restrict the choices available. IMSMA Enum Category refers to the category of enumeration values for the IMSMA field in question. The enumeration value is often translated to a different value when displayed in the application IMSMA, either in a different language or in the same language but with another value (e.g. the Land status enumeration list/category contains Active (a.k.a. Base Term) but the value displayed in IMSMANG is Open.

An enumeration list may be obtained by contacting your GICHD IM advisor. Choices in IMSMANG can be customised to fit the needs of specific mine Action programmes. Customised values are added to the IMSMA enumeration list when created. It is therefore recommended to request specific lists of enumeration values from each country.

The Artifact pages reflect the structure and sequence of elements as defined and exported by {{IMSMANG}. The form of maXML exported and imported by IMSMA differs slightly from the maXML defined by the generic maXML schema and therefore some exports will not validate to the original schema. Anyone who would like to exchange information with IMSMANG should follow IMSMA maXML dictionary to construct or read a maXML file correctly formatted for IMSMANG.

IMSMA imports its main objects in the form of field reports. The different types of field reports are all collected under the parents MineActionFieldReport, FieldReport in maXML. In order to correctly form a field report for import by an IMSMA system one would need to construct a maXML document containing the elements DocumenHeader (not required see below), FieldReportInfo and the desired type of field report, there is also the option to include the element attachment if relevant. The different types of field report are Accident, Hazard, HazardReduction, Location, MREActivity, QAActivity, Victim, and VictimAssistance. Multiple field reports of various types can be included in one file and imported by IMSMA each separate field report should then be contained within its own FieldReport tags.

In addition to the field reports there are eight elements for Auxiliary data. IMSMANG does not currently import Auxiliary data but it does export it. It will be of interest to read Auxiliary data from IMSMANG for any system that intends to exchange information with IMSMANG as there are often many references to Auxiliary data in a field report. Information about organisations, places, country structure and more are referred to in a field report through GUIDs which can only be obtained from an IMSMANGinstallation.

Required/recommended elements and attributes

There are very few elements in maXML that are absolutely required in order for IMSMANG to import the data. Non required elements can be excluded from an import but obviously any information they may contain will not be imported. The attribute originalValue is used and exported by IMSMANG for all multiple and single select fields in IMSMANG. They are always the same as the value of the element and can be excluded without any loss of information. The element UnitOfMeasure and all children of the same are exported by IMSMANG but are automatically set to default values during import and can therefore be excluded without any loss of information.

The only value within DocumentHeader that will be stored by IMSMANG if included is the FileCreationDateTime, all others will have values automatically assigned by IMSMANG whether they contain anything or not. If left out the FileCreationDateTime will be assigned to the moment of import by IMSMANG. The DocumentHeader element can be left out entirely from a xml file and IMSMANG will still import it without errors or information lost.

Introduction
MaXML Architecture · IMSMA and maXML
MineActionFieldReport
Auxiliary artifacts
Item artifacts
DEFs
Other
Retrieved from "http://mwiki.gichd.org:8090/mediawiki/index.php?title=IMSMA_and_maXML&oldid=23321"