Difference between revisions of "MineActionFieldReport"

From IMSMA Wiki
Jump to: navigation, search
Line 1: Line 1:
 
{{Under construction| The xml documentation pages are under construction.  }}  
 
{{Under construction| The xml documentation pages are under construction.  }}  
Mine Action Field Report contains elements for all the items used by {{IMSMANG}} to gather and exchange information. Almost all export and import by {{IMSMANG}} is by Data Entry Forms in maXML format.  
+
Mine Action Field Report contains elements for almost all data used in {{IMSMANG}}. Almost all export and import from/to {{IMSMANG}} is Data Entry Forms in maXML format.  
  
{{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.  
+
The different types of Data Entry Forms are all collected under the grandparent '''MineActionFieldReport''' and parent '''FieldReport''' in maXML. In order to correctly build a maXML file for import to {{IMSMANG}} one would need to construct a maXML document containing the elements DocumenHeader (not required), FieldReportInfo and the desired type of item, there is also the option to include the element attachment. Multiple Data Entry Forms of various items can be included in one file and imported to{{IMSMANG}}. Each separate field report should then be contained within its own FieldReport tags.  
  
All types of Data Entry Forms within MineActionFieldReport have the field report info component in addition to the document header and information specific to the type of item used. The field report information contains information about Data Entry Form template name, version, by whom it was reported and approved, Date of Information and when it was approved. The field report information is stored the the table ''fieldreport'' and the item information are stored in several tables per item.
+
Auxiliary data is not possible to import to {{IMSMANG}} from maXML files. When Auxiliary data is exported from {{IMSMANG}}, each maXML file contains '''one''' type of Auxiliary data.
  
 
==DocumentHeader==__NOEDITSECTION__  
 
==DocumentHeader==__NOEDITSECTION__  
Line 14: Line 14:
 
* Item data
 
* Item data
  
Item data has ''FieldReport'' in ''maXML element level2'' and are differentiated in ''maXML element level3''.
+
Auxiliary data is is differentiated by the value in ''maXML element level2''.
 +
Item data has ''FieldReport'' in ''maXML element level2'' and is differentiated in ''maXML element level3''.
  
==FieldReportInfo ==__NOEDITSECTION__  
+
==Item data - FieldReportInfo ==__NOEDITSECTION__  
 
FieldReportInfo contains metadata describing '''item''' MineActionFieldReports. All item data reports contains a FieldReportInfo and an item data part. In {{IMSMANG}} FieldReportInfo isreferred to as Data Entry Form.  
 
FieldReportInfo contains metadata describing '''item''' MineActionFieldReports. All item data reports contains a FieldReportInfo and an item data part. In {{IMSMANG}} FieldReportInfo isreferred to as Data Entry Form.  
  

Revision as of 19:02, 13 June 2017

Ambox warning blue construction.png The xml documentation pages are under construction.

Mine Action Field Report contains elements for almost all data used in IMSMANG. Almost all export and import from/to IMSMANG is Data Entry Forms in maXML format.

The different types of Data Entry Forms are all collected under the grandparent MineActionFieldReport and parent FieldReport in maXML. In order to correctly build a maXML file for import to IMSMANG one would need to construct a maXML document containing the elements DocumenHeader (not required), FieldReportInfo and the desired type of item, there is also the option to include the element attachment. Multiple Data Entry Forms of various items can be included in one file and imported toIMSMANG. Each separate field report should then be contained within its own FieldReport tags.

Auxiliary data is not possible to import to IMSMANG from maXML files. When Auxiliary data is exported from IMSMANG, each maXML file contains one type of Auxiliary data.

DocumentHeader

The DocumentHeader is the first part of all maXML files and is described on the DocumentHeader Artifact page.

Data

The data is of two different types:

  • Auxiliary data
  • Item data

Auxiliary data is is differentiated by the value in maXML element level2. Item data has FieldReport in maXML element level2 and is differentiated in maXML element level3.

Item data - FieldReportInfo

FieldReportInfo contains metadata describing item MineActionFieldReports. All item data reports contains a FieldReportInfo and an item data part. In IMSMANG FieldReportInfo isreferred to as Data Entry Form.

FieldReportInfo data has FieldReport in maXML element level2 and FieldReportInfo in maXML element level3.
E.g. Land item data has FieldReport in maXML element level2 and Hazard in maXML element level3.