| FieldName |
string |
The name of the field generated through Expere. Also: the name of the fillable checkbox. |
| ToolTip |
string |
The text for the tooltip that is displayed when the user hovers over the field on the PDF. |
| Checked |
string |
Indicates if the fillable checkbox is selected (true) or deselected (false). If the element is not authored, the element value in the assembly output is set to false. |
| PageNumber |
string |
Automatically calculated and included in the assembly output. Represents the physical page the fillable checkbox resides on the PDF. |
| X Coordinate / Y Coordinate |
string |
Automatically calculated and included in the assembly output. Represents the physical location the fillable checkbox resides on the PDF. |
| Sequencing |
ExpereInteger |
Element used to provide a unique identification to the field name so Expere can merge PDF documents that use signature, date, initial, and fillable text fields.The name of the fillable checkboxThe text for the tooltip that is displayed when the user hovers over the field on the PDF.Indicates if the fillable checkbox is selected (true) or deselected (false). If the element is not authored, the element value in the assembly output is set to false. Automatically calculated and included in the assembly output. Represents the physical page the fillable checkbox resides on the PDF.Automatically calculated and included in the assembly output. Represents the physical location the fillable checkbox or text field resides on the PDF.The name of the fillable field.The Width of the field in points where each point is 1/72 of an inch. May be authored in points or inches. If authored as inches, the value is converted and output as points.The Height of the field in points where each point is 1/72 of an inch. May be authored in points or inches. If authored as inches, the value is converted and output as points.The name of the font authored. The font value is True Type Font (TTF). Below is the Font value authored in Requirements Editor (RE) Tool and the corresponding output value in the API response files.The size of the font authored represented in points (i.e. 10 represents 10pt font).The Number of Characters allowed. If the element is not authored, the element value in the assembly output is set to 0 (zero). The prepopulated text for the field. If FieldText element is not authored, an empty element is included in the assembly output response as follows: <r:FieldText/>Indicates the horizontal alignment so of the text in the fillable field. Values are: left, right, center. If the horizontal alignment attribute is not authored, the element value in the assembly output is set to left.Indicates if the fillable field is underlined (true) or not underlined (false). If the underline element is not authored, the element value in the assembly output is set to false.The name of the organization in OPPSA.A type of identifier (ID) for the OPPSA product name (this is not typically the name viewed by the OPPSA user).An indicator for work-in-progress items.Object defining eSignature functionality that enables and disables eSignatures, returns X/Y Coordinates, and enables and disables Non-signature fillable fields.Sets the output to render eSignature and non-signature fields.An object determining if a cover page will appear for documents that cannot handle barcodes in the taglines.An object determining if a barcode appears on the first or only page of a document.Optional settings for configuring the Barcode 2D element.The transaction file name.The transaction date as a string.The file name of the customer transaction.The date of the customer transaction as a string.The database connection URL. In the interest of security, the default configuration is to NOT return this information.The database connection user name. In the interest of security, the default configuration is to NOT return this information.The name of the DBMS product.The version of the DBMS product.The name of the JDBC driver used to connect to the DBMS.The version of the JDBC driver used to connect to the DBMS.The name of the database implementation/DSL. This is reserved for future use.The version of the database implementation/DSL. This is reserved for future use.A string of data containing a unique discrete party ID.Object defining the Signer.Object defining the Fillable Checkbox and FillableText field.Total number of packets in the DocSet.Total number of DocInstances in the DocSet.Total number of Pages in the paginated documents in the DocSet. This does NOT include any count for documents that are not paginated. Total number of recordable pages in the paginated documents in the DocSet. This does NOT include any count for documents that are duplicated.The current date and time this DocSet was created (with timezone).An object containing an AncillaryOuputOption object.If set to "true," eSignature fields are suppressed on the form and X/Y coordinates are returned.Allows users to enable or disable the date field in an eSignature. Setting the element to "true" enables the date field; setting the element to "false" disables the date field.Allows users to pass a string as a help popup.Allows users to pass a string as a help popup.If set to "true," other Non-Signatures fillable fields (textboxes and checkboxes) are suppressed on the form and X/Y coordinates are returned.A message returned by the system.The name of the field generated through Expere. The text for the tooltip that is displayed when the user hovers over the field on the PDF.Indicates if the fillable checkbox is selected (true) or deselected (false). If the element is not authored, the element value in the assembly output is set to false.Automatically calculated and included in the assembly output. Represents the physical page the fillable checkbox resides on the PDF.Automatically calculated and included in the assembly output. Represents the physical location the fillable checkbox resides on the PDF. An object containing information about the specific FillableField including height, weight, field name, tooltip, font, font size, etc. An object containing information about the specific FillabeCheckbox including field name, tooltip, page number, and checked data.A short description of the phase associated with the line of business.(Default) No requirements information should be returned. Only the names of data requirements should be returned.Return all available information for data requirements, including description and question information.A string of data containing the Signer's user name.The email address of the Signer.A string of data containing the description of the Signer (e.g. borrower)The Content URI value.The username and password.A string of data containing the username. This parameter is optional; however, if providing a username, a password must be provided.A string of data containing the password. This parameter is optional.A string of data containing the name of the Document Generation Services certificate. This parameter is optional; if not supplied, no certificate will be sent with the callback request.A string of information containing the product name.Form default attributerestricted to intAn object containing a document (binary) and location information about the attached document.The output document as a PDF.An object containing the name and ID for a particular form.An object containing information about the recipient: name, address, city, state, zipInformation about the submitted transaction: state, API call, Delivery Status, Delivery Date.An object containing information about a particular package of forms and an array containing document information (ArrayOfDocumentInfo).An array, ArrayofDocumentInfo, containing DocumentInfo objects for each document in the requested packet. An object containing information about a particular form including the label, name, number of copies included, and an identifier (ID).The unique identifier for the form.The label associated with the form.The number of copies of the form generated.An object containing a name-value pairs or sets (NVSet).The name of the submitted NVset.The value of the submitted NVset.An object indicating the Callback URL, Username, and Password.An object containing return address information, including: name, address, city, state, zipAn object containing information about configuration settings.This is new descriptionMakes each field unique so Expere can merge PDF documents that use signature, date, initial, and fillable text fields |
