Difference between revisions of "UTA PDF Parser - Configuration Instructions"

From SmartWiki
Jump to: navigation, search
(→‎Create a UTA PDF Parser in Global Settings)
(→‎Enter XML details in Configuration Section of UTA PDF Parser)
Line 21: Line 21:
  
 
==Enter XML details in Configuration Section of UTA PDF Parser==
 
==Enter XML details in Configuration Section of UTA PDF Parser==
 +
 +
{| border="0"
 +
|'''XML Section'''
 +
|'''Purpose'''
 +
|-
 +
|<?xml version="1.0" encoding="UTF-8"?><br />
 +
<utaparser><br />
 +
<leveltwo>
 +
|''Mandatory header''
 +
|-
 +
|<docid>DID</docid><br />
 +
<appid>102587</appid><br />
 +
<attachfieldid>1371520</attachfieldid><br />
 +
<parentid>Parentid</parentid>
 +
|* Specify PDF field name that stores unique Document ID, Parent ID
 +
* Custom Field ID of Single/Multi-file upload field (must be on same level)
 +
|-
 +
|<keyfields><br />
 +
<typename>{32588}</typename><br />
 +
<description>DID</description><br />
 +
<eownerid>@userid@</eownerid><br />
 +
<objectid>Parentid</objectid><br />
 +
<objecttype>{23}</objecttype><br />
 +
<subject>@userid@</subject><br />
 +
<startdate>Date</startdate><br />
 +
</keyfields>
 +
|* Specify duplicate check criteria when uploading multiple PDFs
 +
:* Determines if uploads should update existing record, or create new record
 +
* Can be Standard Fields or Custom Fields (to be enabled)
 +
* Field has to exist under <formfields> section
 +
|-
 +
|<formfields><br />
 +
<cf_1371451>Q1</cf_1371451><br />
 +
<cf_1371453>Q2</cf_1371453><br />
 +
<cf_1371454>Q3</cf_1371454><br />
 +
<cf_1371456>Q4</cf_1371456><br />
 +
<cf_1371460>Eli-1</cf_1371460><br />
 +
<cf_1371462>Eli-2</cf_1371462><br />
 +
<cf_1371464>Eli-3</cf_1371464><br />
 +
<cf_1371465>Eli-4</cf_1371465><br />
 +
<cf_1371469>Eli-5</cf_1371469><br />
 +
<cf_1371472>Eligibility_Comment</cf_1371472><br />
 +
<cf_1371496>Score_FocusArea</cf_1371496><br />
 +
<cf_1371498>Score_Eligibility</cf_1371498><br />
 +
<cf_1371519>Reviewer</cf_1371519><br />
 +
<cf_1371521>Date</cf_1371521><br />
 +
<startdate>Date</startdate><br />
 +
</formfields>
 +
|* Mapping PDF field names to SmartSimple standard fields, custom field ID
 +
|-
 +
|<defaults><br />
 +
<typename>{32588}</typename><br />
 +
<objecttype>{23}</objecttype><br />
 +
<statusid>{20985}</statusid><br />
 +
<objectid>Parentid</objectid><br />
 +
<eownerid>@userid@</eownerid><br />
 +
</defaults>
 +
|* Specify type/template created and status
 +
|-
 +
|</leveltwo><br />
 +
</utaparser>
 +
|}
 +
 +
 +
 +
 +
  
 
<pre style="white-space: pre-wrap;  
 
<pre style="white-space: pre-wrap;  
Line 35: Line 102:
 
<parentid>Parentid</parentid>
 
<parentid>Parentid</parentid>
  
−
<keyfields>
 
−
<typename>{32588}</typename>
 
−
<description>DID</description>
 
−
<eownerid>@userid@</eownerid>
 
−
<objectid>Parentid</objectid>
 
−
<objecttype>{23}</objecttype>
 
−
<subject>@userid@</subject>
 
−
<startdate>Date</startdate>
 
−
</keyfields>
 
  
−
<formfields>
 
−
<cf_1371451>Q1</cf_1371451>
 
−
<cf_1371453>Q2</cf_1371453>
 
−
<cf_1371454>Q3</cf_1371454>
 
−
<cf_1371456>Q4</cf_1371456>
 
−
<cf_1371460>Eli-1</cf_1371460>
 
−
<cf_1371462>Eli-2</cf_1371462>
 
−
<cf_1371464>Eli-3</cf_1371464>
 
−
<cf_1371465>Eli-4</cf_1371465>
 
−
<cf_1371469>Eli-5</cf_1371469>
 
−
<cf_1371472>Eligibility_Comment</cf_1371472>
 
−
<cf_1371496>Score_FocusArea</cf_1371496>
 
−
<cf_1371498>Score_Eligibility</cf_1371498>
 
−
<cf_1371519>Reviewer</cf_1371519>
 
−
<cf_1371521>Date</cf_1371521>
 
−
<startdate>Date</startdate>
 
−
</formfields>
 
  
−
<defaults>
+
 
−
<typename>{32588}</typename>
+
 
−
<objecttype>{23}</objecttype>
+
</pre>
−
<statusid>{20985}</statusid>
 
−
<objectid>Parentid</objectid>
 
−
<eownerid>@userid@</eownerid>
 
−
</defaults>
 
−
</leveltwo>
 
−
</utaparser></pre>
 
  
 
==Create a Fillable PDF Form==
 
==Create a Fillable PDF Form==

Revision as of 12:35, 14 August 2013

SmartSimple's UTA PDF Parser allows for fillable forms in PDF format to be downloaded from SmartSimple, completed offline and then re-uploaded to create records within SmartSimple.

The settings page for the UTA PDF Parser is accessed through the Global Settings page, under the Business & System Configuration section.
A walkthrough of the steps end users will take to utilize a fully-functional UTA PDF Parser are available at this page: UTA PDF Parser.
A video describing the PDF Parser functionality has also been prepared and is available here: UTA PDF Parser - Video

Detailed configuration instructions are as follows:

Create a UTA PDF Parser in Global Settings

To create a new type of UTA PDF Parser, go to the Global Settings page. Under the Business & System Configuration section, click on the hyperlink for UTA PDF Parser.
Click on the "New Parser" button at the top of the page.

UTAPDFParserEditPage.png

The settings on this New Parser page are as follows:

  • Prefix - The Prefix you set in this field serves to differentiate different types of UTA PDF Parsers. The file name of the PDF template used in conjunction with this parser must begin with the "prefix" you specify.
  • Active - The Active switch exists so that you can enable or disable UTA PDF Parsers. The default for new types of parser is "disabled" ("Active" is not selected).
  • Configuration - This section contains the XML code that maps the field names in the stored PDF document to the fields for the SmartSimple record to be created.
  • Error - This non-editable section contains a timestamped log of all files uploaded to the system using the UTA PDF Parser. This section can be cleared by clicking the "Clear Error" button at the bottom of the page.

Enter XML details in Configuration Section of UTA PDF Parser

XML Section Purpose
<?xml version="1.0" encoding="UTF-8"?>

<utaparser>
<leveltwo>

Mandatory header
<docid>DID</docid>

<appid>102587</appid>
<attachfieldid>1371520</attachfieldid>
<parentid>Parentid</parentid>

* Specify PDF field name that stores unique Document ID, Parent ID
  • Custom Field ID of Single/Multi-file upload field (must be on same level)
<keyfields>

<typename>{32588}</typename>
<description>DID</description>
<eownerid>@userid@</eownerid>
<objectid>Parentid</objectid>
<objecttype>{23}</objecttype>
<subject>@userid@</subject>
<startdate>Date</startdate>
</keyfields>

* Specify duplicate check criteria when uploading multiple PDFs
  • Determines if uploads should update existing record, or create new record
  • Can be Standard Fields or Custom Fields (to be enabled)
  • Field has to exist under <formfields> section
<formfields>

<cf_1371451>Q1</cf_1371451>
<cf_1371453>Q2</cf_1371453>
<cf_1371454>Q3</cf_1371454>
<cf_1371456>Q4</cf_1371456>
<cf_1371460>Eli-1</cf_1371460>
<cf_1371462>Eli-2</cf_1371462>
<cf_1371464>Eli-3</cf_1371464>
<cf_1371465>Eli-4</cf_1371465>
<cf_1371469>Eli-5</cf_1371469>
<cf_1371472>Eligibility_Comment</cf_1371472>
<cf_1371496>Score_FocusArea</cf_1371496>
<cf_1371498>Score_Eligibility</cf_1371498>
<cf_1371519>Reviewer</cf_1371519>
<cf_1371521>Date</cf_1371521>
<startdate>Date</startdate>
</formfields>

* Mapping PDF field names to SmartSimple standard fields, custom field ID
<defaults>

<typename>{32588}</typename>
<objecttype>{23}</objecttype>
<statusid>{20985}</statusid>
<objectid>Parentid</objectid>
<eownerid>@userid@</eownerid>
</defaults>

* Specify type/template created and status
</leveltwo>

</utaparser> 




<?xml version="1.0" encoding="UTF-8"?>
<utaparser>
<leveltwo>
<docid>DID</docid>
<appid>102587</appid>
<attachfieldid>1371520</attachfieldid>
<parentid>Parentid</parentid>

Create a Fillable PDF Form

  • Fillable PDFs can be created using:
  • Adobe LiveCycle
  • Adobe Acrobat
  • Any other software that allows for the modification of form XML

See Also

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=UTA_PDF_Parser_-_Configuration_Instructions&oldid=17597’