Changes

Jump to: navigation, search

UTA PDF Parser - Configuration Instructions

541 bytes removed, 15:14, 6 October 2017
no edit summary
{| class="wikitable"
|-
||[[Image:How.png|50px|link=|50px]]||This article will explain '''how''' you can implement this feature for use on your SmartSimple system.
|}
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 Integrations section. <br/>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]]. <br/>
A video describing the PDF Parser functionality has also been prepared and is available here: [[PDF Parser - Video|UTA PDF Parser - Video]]
==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 Integrations section, click on the hyperlink for UTA PDF Parser.<br/>Click on the "New Parser" button at the top of the page.
[[Image:UTAPDFParserEditPage.png|link=]]
==Enter XML details in Configuration Section of UTA PDF Parser==
The following is an example of the XML block required to automatically create {{l2}}s in SmartSimple from an uploaded PDF:
The following is an example of the XML block required to automatically create {{l2}}s in SmartSimple from an uploaded PDF<pre style="white-space:-o-pre-wrap; word-wrap: break-word;"><!--?xml version="1.0" encoding="UTF-8"?--><!--?xml version="1.0" encoding="UTF-8"?-->
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><?xml version="1.0" encoding="UTF-8"?>
<utaparser>
<leveltwo>
<defaults>
<typename>{39270}</typename>
<objecttype>{23}</objectnameobjecttype>
<statusid>{39233}</statusid>
<objectid>parentid</objectid>
</defaults>
</leveltwo>
</utaparser> </pre>
The above XML code can be broken out into the following sections:
'''[[#Header|Header]]''' {| style="background-color: #00FFFF00ffff;border-radius:10px;-moz-border-radius:10px;-webkit-border-radius:10px;width: 50%;"|+ align="right" + width: 10%; |:'''[[#Header|Header]]'''-||<br /><?xml version="1.0" encoding="UTF-8"?><br /><utaparser><br /><leveltwo>
|}
'''[[#File Locations|File Locations]]''' {| style="background-color: #FF6600ff6600;border-radius:10px;-moz-border-radius:10px;-webkit-border-radius:10px;width: 50%;"|+ align="right" + width: 10%; |:'''[[#File Locations|File Locations]]'''-||<br /><docid>DID</docid><br /><appid>102587</appid><br /><attachfieldid>1371520</attachfieldid><br /><parentid>Parentid</parentid>
|}
'''[[#Key Fields|Key Fields]]''' {| style="background-color: #9999CC9999cc;border-radius:10px;-moz-border-radius:10px;-webkit-border-radius:10px;width: 50%;"|+ align="right" + width: 10%; |:'''[[#Key Fields|Key Fields]]'''-|<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>
|}
'''[[#Form Fields / Field Mapping|Form Fields / Field Mapping]]''' {| style="background-color: #FFFF99ffff99;border-radius:10px;-moz-border-radius:10px;-webkit-border-radius:10px;width: 50%;"|+ align="right" + width: 10%; |:'''[[#Form Fields / Field Mapping|Form Fields / Field Mapping]]'''-|<formfields>|<br /><startdate>SubmissionDate</startdate><br /> <cf_1371453>MeetingDate</cf_1371453><br /> <cf_1371454>Time</cf_1371454><br /> <cf_1371456>Location</cf_1371456><br /> <cf_1371460>MetWith</cf_1371460><br /> <cf_1371462>MeetingPurpose</cf_1371462><br /> <cf_1371464>ReportDetails</cf_1371464><br /> <cf_1371465>Signature</cf_1371465> <br /> <cf_1371469>InvoiceAmount</cf_1371469><br /> <cf_1371472>ReportNo</cf_1371472><br /></formfields>
|}
'''[[#Defaults|Defaults]]''' {| style="background-color: #E0FFC2e0ffc2;border-radius:10px;-moz-border-radius:10px;-webkit-border-radius:10px;width: 50%;"|+ align="right" + width: 10%; |:'''[[#Defaults|Defaults]]'''-|<defaults>|<br /> <typename>{39270}</typename><br /> <objecttype>{23}</objectnameobjecttype><br /> <statusid>{39233}</statusid><br /> <objectid>parentid</objectid><br /> <eownerid>@userid@</eownerid><br /></defaults>
|}
'''[[#Footer|Footer]]''' {| style="background-color: #00FFFF00ffff;border-radius:10px;-moz-border-radius:10px;-webkit-border-radius:10px;width: 50%;"|+ align="right" + width: 10%; |:'''[[#Footer|Footer]]'''-||<br /leveltwo><br /leveltwo></utaparser>
|}
===Header===
The Header section will always contain the XML coding as shown:
 <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><?xml version="1.0" encoding="UTF-8"?><utaparser><leveltwo>  </pre>
===File Locations===
The XML tags in the File Locations sections must contain values as follows:
 
* ''docid'' - contains the value "DID"
:** The docid stands for “Document ID” which is a unique text string generated for each PDF generated from SmartSimple. Using the Document ID as one of the key fields will ensure that there will always be a new record created as no document will have the same DID.
* ''appid'' - contains the [[application ID]] of the {{UTA}} in which the new {{l2}}s will be created.
* ''attachfieldid'' - contains the [[custom field ID]] of the [[Custom Field Type: Link – Single File|single file]] or [[Custom Field Type: Link – Multiple Files|multiple file]] upload field to which the PDF to be parsed will be uploaded.  <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">It is recommended that the "File Type Restriction" in the custom field specified be set to "pdf", in order to prevent files not in PDF format being uploaded to this field and creating parsing errors.</pre>
* ''parentid'' - contains the value "parentid"
:** The parent ID is the Opportunity ID of the level 1 record. This is used by the parser to know which L1 record to attach the activity to. This is pre-populated when the PDF is generated from the L1 record.
===Key Fields===
** This section will begin with the ''<keyfields>'' tag and will end with the closing ''</keyfields>'' tag.** The keyfields section functions as a method of duplication checking.:*** If a PDF is uploaded to SmartSimple, and the fields specified in the keyfields section match an existing SmartSimple record, that record will be updated.:*** If the fields in the uploaded PDF do not match with an existing SmartSimple record, a new record will be created.** The syntax is as follows::*** ''typename'' refers to the [[typeid]] of the {{l2}} being uploaded.:*** ''objecttype'' should be set to ''{23}''. See [[Entity IDs]] for further information.:*** See the article [[Database Field Names]] for further examples of fields that can be specified.** Any field that is added in the ''keyfields'' section will also have to be referenced in the ''formfields'' section below.
===Form Fields / Field Mapping===
This section will begin with the ''<formfields>'' tag and will end with the closing ''</formfields>'' tag.Within the ''<formfields>'' tags, the fillable PDF fields are matched up with (or "mapped to") the relevant fields in SmartSimple, using the following syntax: ** For [[standard fields]], the XML tag will be the [[Database Field Names|database field name]] of the standard field. The value within the tags will be the name given to the fillable field on the PDF. <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">Example: <startdate>SubmissionDate</startdate></pre>** For [[custom fields]], the XML tag will be the [[custom field ID]] of the custom field, prefaced by "cf_". The value within the tags will be the name given to the fillable field on the PDF. <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">Example: <cf_2676299>MeetingDate</cf_2676299></pre>** Autonumber fields can be included using the following syntax (note the letter ''''a'''' after the field ID): <pre> <cf_a3379275>~0</cf_a3379275></pre>
===Defaults===
** The ''defaults'' section tells the system which [[Level 2 Type]] to use for the creation of the SmartSimple record, and to which [[status]] it should be set.** The following syntax is used::*** ''typename'' refers to the [[typeid]] of the {{l2}} being uploaded. :*** ''objecttype'' should be set to ''{23}''. See [[Entity IDs]] for further information.:*** ''statusid'' should be set to the status ID of the status to which the {{l2}} to be created should be set. See [[Determining the statusid]] for more information.:*** ''objectid'' should be set to the value ''parentid''.:*** ''eownerid'' should be set to the value ''@userid@''.
===Footer===
The Footer section will always contain the XML coding as shown:
 <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"></leveltwo></utaparser> </pre>
==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]]*** For information on creating fillable PDF forms, please visit Adobe's help pages, for example: http://www.adobe.com/content/dam/Adobe/en/products/acrobat/pdfs/adobe-acrobat-xi-convert-forms-into-fillable-pdf-tutorial_ue.pdf
==See Also==
*** [[UTA PDF Parser]]*** [[PDF Parser - Video|UTA PDF Parser - Video]]
{| class="wikitable"
|-
||[[Image:Why.jpeg|50px|link=|50px]]||Click [http://wiki.smartsimple.com/wiki/PDF_Parser_-_Why%3F here] to learn why this feature is a benefit to your organization.
|}
[[Category:Data Import]][[Category:PDF]][[Category:Global Settings]][[Category:How]]
0
edits

Navigation menu