Difference between revisions of "Import a Data Entry Form from a xml File"

From IMSMA Wiki
Jump to: navigation, search
(Version 6.0)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<p>To import a data entry form from an MaXML file to the Workbench (see [[Access and Use the Workbench Window]] for more information about the Workbench):</p>
+
The import feature allows you to import Data Entry Forms from one computer/database to another computer/database.
<ol>
+
 
<li>From the Workbench window, click the [[Image:Import.png | Import]] button.</li>
+
{{note| Before you import Data Entry Forms, ensure that:
:The Data Entry Form Import window displays.
+
* Custom Defined Fields and option selection values are the same in the exporting and importing databases
<li>Click the '''Browse''' button.</li>
+
* the Data Entry Form template name need to be published and active in the importing database
:The Open window displays.
+
* Auxiliary data used must also exist in the importing database with the same GUIDs. }}
<li>From the Open window:</li>
+
 
 +
{{Warning | Data will '''only''' be imported for attributes present on the Data Entry Form template in the importing computer/database. For example, if the Data Entry Form(s) that was exported used a template with 50 attributes, but the receiving-end template only contains 20 of the 50 attributes, data will only be imported for these 20 attributes.}}
 +
 +
The import Data Entry Form(s) from xml file(s) function is started from the [[Access and Use the Workbench Window|Workbench]].
 +
<ol><li>From the Workbench window, click the [[Image:Import.png | Import]] button.
 +
[[Image:WB Import xml.png|600px|center]]
 +
<div align="center"> '' Workbench window''</div></li>
 +
<li>The Data Entry Form Import window displays.</li>
 +
<li>Click the '''Browse''' button.
 +
[[Image:WB Import xml2.png|400px|center]]
 +
<div align="center"> '' Data Entry Form Import window''</div></li>
 +
<li>The Open window displays.</li>
 +
<li>Use one of the two import xml methods:
 
<ol type="a">
 
<ol type="a">
<li>Navigate to the directory where the file that you would like to import is located.</li>
+
<li>select a folder which will import '''all''' xml files in the folder</li>
<li>Select the file name.</li>
+
<li>select an xml file.</li>
 +
</ol>
 
<li>Click the '''Open''' button.</li>
 
<li>Click the '''Open''' button.</li>
:In the Data Entry Form Import window, the number of data entry forms and the number of objects associated with the reports are displayed in the XML Summary section of the window. The contents of the file are displayed in the Raw XML View section.   
+
<li>The Data Entry Form Import window is updated.</li>
 +
<ol type="a">
 +
<li>If the import folder method is used, XML Summary section of the window is filled with ''A directory has been selected''</li>
 +
<li>If the import file method is used, the number of data entry forms and the number of objects associated with the reports are displayed in the XML Summary section of the window. The contents of the file are displayed in the Raw XML View section.   
 +
<center>
 +
{|
 +
|- valign="top"
 +
|
 +
[[Image:WB Import xml4.png|300px]]
 +
[[Image:WB Import xml3.png|300px]]
 +
|
 +
|}
 +
</center></li>
 
</ol>
 
</ol>
 
[[Image:fig182.png|center|500px|''Data Entry Form Import window'']]
 
<div align="center">
 
''Data Entry Form Import window''
 
</div>
 
 
 
<li>Click the '''Import''' button.</li>
 
<li>Click the '''Import''' button.</li>
:The Data Entry Form Import Options window displays.  
+
<li>The Data Entry Form Import Options window displays.  
 
 
 
[[Image:FieldReportImportOptions2.png|500px|center|''Data Entry Form Import Options window'']]
 
[[Image:FieldReportImportOptions2.png|500px|center|''Data Entry Form Import Options window'']]
 
<div align="center">
 
<div align="center">
 
''Data Entry Form Import Options window''
 
''Data Entry Form Import Options window''
</div>
+
</div></li>
 
+
<li>Select one of the options listed in the following table.
<li>In the Data Entry Form Import Options window, select one of the options listed in the following table.</li>
 
:If you do not want to import the data entry forms, click the '''Cancel''' button.
 
</ol>
 
 
 
 
<center>
 
<center>
{| class="wikitable" width="500"
+
{| class="wikitable" width="900"
 
|-
 
|-
 
| align="center" colspan="2" | '''Description of Import Options'''
 
| align="center" colspan="2" | '''Description of Import Options'''
 
|-
 
|-
| width="125pt" | '''If you choose to…'''
+
| width="150pt" | '''If you choose to…'''
| width="375pt" | '''The data entry forms...'''
+
| width="750pt" | '''The data entry forms...'''
 
|-
 
|-
| Approve all data entry forms || <p>With no import errors and complete reconciliation are imported and marked as ''Approved''.</p>
+
| Approve all data entry forms || The Data Entry Forms will be imported with the current user as ''Approver'' and current date as ''Approved date''.
<p>With import errors and/or incomplete reconciliation are imported, marked as ''Saved'', and added to the Workbench.</p>
+
Data Entry Forms with no import errors and complete reconciliation are imported and marked as ''Approved''.
 +
Data Entry Forms with import errors and/or incomplete reconciliation are imported, marked as ''Saved'', and added to the Workbench.
 
|-
 
|-
| Use approval data in the Data Entry Forms || <p>That have been previously approved and unapproved are imported and marked as ''Approved''.</p>
+
| Use approval data in the Data Entry Forms || The Data Entry forms will be imported with the ''Approver'' and ''Approved date'' as specified in the Data Entry Forms.
<p>That have not been approved are imported, marked as ''Saved'', and are added to the Workbench.</p>
+
Data Entry Forms that have been previously approved are imported and marked as ''Approved''.
 +
Data Entry Forms that have not been approved are imported, marked as ''Saved'', and are added to the Workbench.  
 
|-
 
|-
| Import only  || <p>Are imported, marked as ''Saved'', and added to the Workbench.</p>
+
| Import only  || Data Entry Forms are imported, marked as ''Saved'', and added to the Workbench.
 
|}
 
|}
</center>
+
</center></li>
 +
<li>Click the '''OK''' button.</li>
 +
<li>The Information window displays a message stating that the data entry form import is complete.</li>
 +
<li>Click the '''Done''' button.</li></ol>
  
<ol start="8">
+
=== Option 1 and 2===__NOEDITSECTION__
<li>Click the '''OK''' button.</li>
+
If you chose the '''Approve all data entry forms''' option or the '''Use approval data in the Data Entry Forms''' option, the Approval Results window displays.  
:The Information window displays a message stating that the data entry form import is complete.
 
<li>Click the '''Done''' button.</li>
 
<li>If you chose the '''Approve all data entry forms''' option or the '''Use approval data in the Data Entry Forms''' option, the Approval Results window displays. </li>
 
</ol>
 
  
 
[[Image:ApprovalResults.png|center|500px|''Approval Results Window'']]
 
[[Image:ApprovalResults.png|center|500px|''Approval Results Window'']]
Line 60: Line 75:
 
</div>
 
</div>
  
<p>Data entry forms that were approved appear in the Approved Data Entry Forms section of the Approval Results window. The Approval Date column lists the date and time the reports were approved.</p>
+
Data entry forms that were approved appear in the Approved Data Entry Forms section of the Approval Results window. The Approval Date column lists the date and time the reports were approved.
<p>Reports that were not approved appear in the Non-Approved Data Entry Forms section. The Non-Approval column lists the reasons they were not approved. Possible reasons include ''Reconciliation Incomplete'', ''Import Error'', and ''Unknown Error''. </p>
+
Reports that were not approved appear in the Non-Approved Data Entry Forms section. The Non-Approval column lists the reasons they were not approved. Possible reasons include ''Reconciliation Incomplete'', ''Import Error'', and ''Unknown Error''.  
  
<ol>
 
 
<ol type="a">
 
<ol type="a">
 
<li>Click the '''Done''' button.</li>
 
<li>Click the '''Done''' button.</li>
 
<li>If a data entry form was not approved, open the Workbench window and double-click the row associated with the unapproved data entry form.</li>
 
<li>If a data entry form was not approved, open the Workbench window and double-click the row associated with the unapproved data entry form.</li>
:The Data Entry Form Editor window displays.
+
<li>The Data Entry Form Editor window displays.</li>
<li>Resolve the error on the Reconciliation tab if applicable. See the ''Data Entry Forms – [[Reconciling Items]]'' section for additional information.</li>
+
<li>Resolve the error on the Reconciliation tab if applicable. See the ''Data Entry Forms – [[Reconcile]]'' section for additional information.</li>
 
<li>Resolve the error on the Import Issues tab if applicable. When complete, check the '''All Import Issues have been resolved''' checkbox.</li>
 
<li>Resolve the error on the Import Issues tab if applicable. When complete, check the '''All Import Issues have been resolved''' checkbox.</li>
 
<li>Click the '''Approve''' button.</li>
 
<li>Click the '''Approve''' button.</li>
:The Information window displays confirming the data entry form was approved.
+
<li>The Information window displays confirming the data entry form was approved.</li>
</ol>
 
</ol>
 
 
 
<ol start="11">
 
<li>If you chose the '''Import Only''' option, the Data Entry Form Import Results window displays. </li>
 
 
</ol>
 
</ol>
  
 +
=== Option 3===__NOEDITSECTION__
 +
If you chose the '''Import Only''' option, the Data Entry Form Import Results window displays.
 
[[Image:FieldReportImportResultsWindow.png|center|500px|''Data Entry Form Import Results Window'']]
 
[[Image:FieldReportImportResultsWindow.png|center|500px|''Data Entry Form Import Results Window'']]
 
<div align="center">
 
<div align="center">
Line 84: Line 95:
 
</div>
 
</div>
  
<p>The Imported Items section of the window lists the items that were imported. Any errors that occurred during the import are noted in the Error Log section of the window. You can save the error log to a file by clicking the Save Log button.  You can also view import errors on the Import Issues tab of the Data Entry Form Editor window.</p>
+
The Imported Items section of the window lists the items that were imported. Any errors that occurred during the import are noted in the Error Log section of the window. You can save the error log to a file by clicking the Save Log button.  You can also view import errors on the Import Issues tab of the Data Entry Form Editor window.
  
<ol start="12">
+
<ol type="a">
 
<li>Click the '''Done''' button.</li>
 
<li>Click the '''Done''' button.</li>
:The imported Data Entry Forms will be listed in the Workbench. You will need to reconcile the item records in the Data Entry Forms.
+
<li>The imported Data Entry Forms will be listed in the Workbench. You will need to reconcile the item records in the Data Entry Forms. </li></ol>
</ol>
 
  
 
{{NavBox HowTo Field Reports}}
 
{{NavBox HowTo Field Reports}}
  
[[Category:ELR]]
+
[[Category:NAA]]

Latest revision as of 09:39, 29 May 2017

The import feature allows you to import Data Entry Forms from one computer/database to another computer/database.

Note.jpg Before you import Data Entry Forms, ensure that:
  • Custom Defined Fields and option selection values are the same in the exporting and importing databases
  • the Data Entry Form template name need to be published and active in the importing database
  • Auxiliary data used must also exist in the importing database with the same GUIDs.
Warning.jpg Data will only be imported for attributes present on the Data Entry Form template in the importing computer/database. For example, if the Data Entry Form(s) that was exported used a template with 50 attributes, but the receiving-end template only contains 20 of the 50 attributes, data will only be imported for these 20 attributes.

The import Data Entry Form(s) from xml file(s) function is started from the Workbench.

  1. From the Workbench window, click the Import button.
    WB Import xml.png
    Workbench window
  2. The Data Entry Form Import window displays.
  3. Click the Browse button.
    WB Import xml2.png
    Data Entry Form Import window
  4. The Open window displays.
  5. Use one of the two import xml methods:
    1. select a folder which will import all xml files in the folder
    2. select an xml file.
  6. Click the Open button.
  7. The Data Entry Form Import window is updated.
    1. If the import folder method is used, XML Summary section of the window is filled with A directory has been selected
    2. If the import file method is used, the number of data entry forms and the number of objects associated with the reports are displayed in the XML Summary section of the window. The contents of the file are displayed in the Raw XML View section.

      WB Import xml4.png WB Import xml3.png

  8. Click the Import button.
  9. The Data Entry Form Import Options window displays.
    Data Entry Form Import Options window

    Data Entry Form Import Options window

  10. Select one of the options listed in the following table.
    Description of Import Options
    If you choose to… The data entry forms...
    Approve all data entry forms The Data Entry Forms will be imported with the current user as Approver and current date as Approved date.

    Data Entry Forms with no import errors and complete reconciliation are imported and marked as Approved. Data Entry Forms with import errors and/or incomplete reconciliation are imported, marked as Saved, and added to the Workbench.

    Use approval data in the Data Entry Forms The Data Entry forms will be imported with the Approver and Approved date as specified in the Data Entry Forms.

    Data Entry Forms that have been previously approved are imported and marked as Approved. Data Entry Forms that have not been approved are imported, marked as Saved, and are added to the Workbench.

    Import only Data Entry Forms are imported, marked as Saved, and added to the Workbench.
  11. Click the OK button.
  12. The Information window displays a message stating that the data entry form import is complete.
  13. Click the Done button.

Option 1 and 2

If you chose the Approve all data entry forms option or the Use approval data in the Data Entry Forms option, the Approval Results window displays.

Approval Results Window

Approval Results Window

Data entry forms that were approved appear in the Approved Data Entry Forms section of the Approval Results window. The Approval Date column lists the date and time the reports were approved. Reports that were not approved appear in the Non-Approved Data Entry Forms section. The Non-Approval column lists the reasons they were not approved. Possible reasons include Reconciliation Incomplete, Import Error, and Unknown Error.

  1. Click the Done button.
  2. If a data entry form was not approved, open the Workbench window and double-click the row associated with the unapproved data entry form.
  3. The Data Entry Form Editor window displays.
  4. Resolve the error on the Reconciliation tab if applicable. See the Data Entry Forms – Reconcile section for additional information.
  5. Resolve the error on the Import Issues tab if applicable. When complete, check the All Import Issues have been resolved checkbox.
  6. Click the Approve button.
  7. The Information window displays confirming the data entry form was approved.

Option 3

If you chose the Import Only option, the Data Entry Form Import Results window displays.

Data Entry Form Import Results Window

Data Entry Form Import Results Window

The Imported Items section of the window lists the items that were imported. Any errors that occurred during the import are noted in the Error Log section of the window. You can save the error log to a file by clicking the Save Log button. You can also view import errors on the Import Issues tab of the Data Entry Form Editor window.

  1. Click the Done button.
  2. The imported Data Entry Forms will be listed in the Workbench. You will need to reconcile the item records in the Data Entry Forms.