Difference between revisions of "IMSMA and maXML"
(Created page with "{{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}} use...") |
|||
| (7 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{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}}.}} |
| − | + | ==Artifacts ==__NOEDITSECTION__ | |
| + | The Artifact pages reflect the structure and sequence of elements as '''defined and exported''' by {{IMSMANG}}. The form of maXML exported and imported by {{IMSMANG}} '''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 {{IMSMANG}} maXML dictionary to construct or read a maXML file correctly formatted for {{IMSMANG}}. | ||
| − | The | + | {{IMSMANG}} 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 {{IMSMANG}} 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 {{IMSMANG}} each separate field report should then be contained within its own FieldReport tags. |
| − | + | 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 {{IMSMANG}} 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 {{IMSMANG}} field in question. The enumeration value is often translated to a different value when displayed in the application {{IMSMANG}}, 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 [[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. | ||
| − | + | 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]] | ||
Latest revision as of 14:39, 24 July 2019
 |
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. |
Artifacts
The Artifact pages reflect the structure and sequence of elements as defined and exported by IMSMANG. The form of maXML exported and imported by IMSMANG 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 IMSMANG maXML dictionary to construct or read a maXML file correctly formatted for IMSMANG.
IMSMANG 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 IMSMANG 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 IMSMANG each separate field report should then be contained within its own FieldReport tags.
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 IMSMANG 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 IMSMANG field in question. The enumeration value is often translated to a different value when displayed in the application IMSMANG, 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.
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.
| |||||||||||||||||||||||||||||||||||||||||||||||
