The Quik! SIGNiX integration includes a comprehensive set of properties related to a SIGNiX account. All available properties are described below:
...
Property Name | Type | Default Value | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| AuthTypeShow | List of Signix Auth Types | empty list | Limits the items displayed in the AuthType drop down lists within the esign popup. If the list is empty, all items are displayed. SignixAuthTypeShow is an enumerator that has the following values: EmailOnlySignAllDisabled | ||||||||||||||||
| SenderUserID | string | "" | Sets the CustomerUserID asociated to the token that will act as the Sender when using SOBO. If it's not provided the default token will be used. If SOBO is turned off, this is ignored | ||||||||||||||||
| SignEnvironmentID | int | 1 | Required. Sets the Environment | ||||||||||||||||
| ESignMetaData | ESignMetaData | null | Sets the Sign MetaData | ||||||||||||||||
| SignMessage | string | "" | Sets the SignMessage | ||||||||||||||||
| SignMultipleDocs | bool | false | Enables the Sign for Multiple Docs | ||||||||||||||||
| HTMLButtonSignName | string | "" | Set the name off the Sign Button | ||||||||||||||||
| SignAllDocsCombined | bool | false | Enables the Sign for Combining Docs | ||||||||||||||||
| SignCallBackURL | string | "" | Required. Sets the SignCallBackURL. | ||||||||||||||||
| SignErrorMessage | string | "" | Sets the error Message | ||||||||||||||||
| SignHideEmptySigners | bool | false | Sets whether to display or hide the empty signers in the esign popup. | ||||||||||||||||
| SignJavascript | string | "" | Javascript to be run when clicking the Sign button | ||||||||||||||||
| SignOrderLock | bool | false | Locks the order column in the esign popup | ||||||||||||||||
| SignSendJavascript | string | "" | Javascript to be run when clicking the Send button in the esign popup | ||||||||||||||||
| SignixDateSignedTimeZone | enum | UTC | Specifies the time zone in which to report the signing date and time. | ||||||||||||||||
| SignixDeliveryType | enum | SDDDC | Configures which type of delivery service is used with SIGNiX (SDDC vs SDD) | ||||||||||||||||
| SignixDemo | bool | false | |||||||||||||||||
| SignixDistributeToSubmitter | bool | false | Indicate if the Submitter is to receive a copy of the distribution email when the transaction completes. | ||||||||||||||||
| SignixDistributionEmailContent | string | "" | Text that is to be included in the distribution email sent when the transaction completes. | ||||||||||||||||
| SignixDistributionEmailList | string | "" | List of email recipients of the distribution email sent when the transaction completes | ||||||||||||||||
| SignixDocSetDescription | string | "" | Description of forms in a transaction | ||||||||||||||||
| SignixExpireAfter | int | 10 | Transaction automatically cancelled if it is not completed within the specified number of days. | ||||||||||||||||
| SignixShowSignNow | bool | true | Show the Sign Now field in the E-Sign Pop-Up | ||||||||||||||||
| SignixSubmitterEmail | string | "" | Sets the Email of Submitter | ||||||||||||||||
| SignixSubmitterEmailList | string | "" | Sets the SIGNiX Submitter Email List | ||||||||||||||||
| SignixSubmitterName | string | "" | Sets the Name of Submitter | ||||||||||||||||
| SignixSuspendOnStart | bool | false | Indicates if transaction preprocessing is to suspend the transaction instead of notifying the first party. | ||||||||||||||||
| SignixWorkgroup | enum | SDD | Sets the SIGNiX workgroup property | ||||||||||||||||
| SignixBillingRef | string | "" | SignixClientPrefAllowSignatureGraphic | SignixClientPrefAuditTrailWithCC | SignixClientPrefAutoAdvanceToNextDocument | SignixClientPrefAutoAdvanceToNextSignature | Identifies the Billing Party for this transaction. Primarily used by Clients that need to differentiate between different divisions, end-users, etc. in order to either bill them in return or to allocate cost for reporting purposes | ||||||||||||
| SignixContactInfo | string | "" | Text to display in the various SDD guides, including the login, coversheet, and PDFguides. For example, "If you need assistance, please call 1-800-000-0000" | ||||||||||||||||
| SignixDateSignedFormat | enum | dd_MM_yyyy_hh_mm_a_z | SignixClientPrefBrowserAutofill | SignixClientPrefEnable21CFRPart11CompliantMode | SignixClientPrefMiddleName | SignixClientPrefMustSignFirstDocumentFirst | SignixClientPrefNextPartyLink | SignixClientPrefNotificationSchedule | string | "" | SignixContactInfo | string | "" | SignixDateSignedFormat | enum | dd_MM_yyyy_hh_mm_a_z | SignixClientPrefAutoOpenFirstDocument | SignixClientPrefDateSignedFormat | SignixClientPrefDateSignedTimeZoneSpecifies how to format the signing date/time. Required if DateSignedField present |
The ClientPreference request element allows service configuration parameters to be overridden for a specific transaction. Each parameter is specified as a name/value pair.
The available parameters are shown in the following table:
| Property Name | Description | Allowed Values |
|---|---|---|
| SignixClientPrefAllowSignatureGraphic | Determines whether a user can set up a signature graphic when they register. | yes no required |
| SignixClientPrefAuditTrailWithCC | The audit trail of the transaction will be included as a PDF attachment to the CC (Carbon Copy) email. | yes no |
| SignixClientPrefAutoAdvanceToNextDocument | When the user finishes all required actions for the current document, the next document is automatically opened without first displaying the Document List. | yes no |
| SignixClientPrefAutoAdvanceToNextSignature | When the user completes a signature line, the document is positioned to the next signature line. | yes no |
| SignixClientPrefAutoOpenFirstDocument | When this preference is set to "yes", the Document List will not be displayed to the user logging in to a transaction if the user has an action to complete. In this case, the first document requiring an action will be displayed. If the user has completed all required actions, then the document list will be displayed. | yes no yesIfOneDoc |
| SignixClientPrefBrowserAutofill | Toggles the browser's autocomplete attribute of HTML form input fields. | yes no |
| SignixClientPrefDateSignedFormat | Sets the format of the date field associated with a signature line. | MM/dd/yyyy hh:mm a z MMMM dd, yyyy hh:mm a z dd MMMM yyyy hh:mm a z dd/MMM/yyyy hh:mm a z dd/MM/yy hh:mm a z dd/MM/yyyy hh:mm a z |
| SignixClientPrefDateSignedTimeZone | This preference sets the default time zone for the Wizard's date field Properties Dialog. | GMT US/Eastern US/Central US/Mountain US/Pacific US/Alaska US/Aleutian US/Hawaii |
| SignixClientPrefEnable21CFRPart11CompliantMode | This preference enables various UI components required by 21 CFR Part 11 compliance. | no yes, signer chooses reason yes, submitter chooses reason |
| SignixClientPrefMiddleName | Determines how middle names appear. | no preference as submitted middle initial full middle name |
| SignixClientPrefMustSignFirstDocumentFirst | Determines whether the first document of the document set must be signed before the user is allowed to access any other document. Typically, the first document might be a consent form or service agreement. | yes no |
| SignixClientPrefNextPartyLink | This preference determines whether the party completion page supports immediate login by the next party. When a party finishes all their signatures and other actions in a transaction, a completion page appears. If there is a next party, the next party is authenticated via interactive questions, and this preference is set to "yes", then the completion page will contain a link that the next party can click on to log in to the transaction. Otherwise, the completion page just indicates that the next party has been notified, but does not provide a login link. | yes no |
| SignixClientPrefNotificationSchedule | The Notification Schedule indicates how often the system will send a reminder email to a party that has not completed signing. The schedule also indicates when the transaction will expire. | A comma-separated list enclosed in curly braces, immediately followed by the units. For example: a schedule of '{3,5,7,10}days' indicates that reminder notifications will go out on days 3, 5 and 7, and that the transaction will expire |