SIGNiX Properties

The Quik! SIGNiX integration includes a comprehensive set of properties related to a SIGNiX account. All available properties are described below. (Note: These properties can also be found on the Quik! Forms Engine Properties List page)


Property Name

Type

Default Value

Description

SignixAuthTypeShowList of Signix Auth Typesempty 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
EmailOnlyWithVerifyCode
SecretCodeSentViaTextMessage
SecretCodeSentViaTextMessageWithOneClick
KnowledgeBasedWithInteractiveQuestions
KnowledgeBasedWithInteractiveQuestionsWithOneClick
KnowledgeBasedWithInteractiveQuestionsCanadians
   NOTE: Customers must contact SIGNiX in order to use this property, and agree to a minimum monthly service charge with SIGNiX. For use by Canadian nationals only.

SignEnvironmentIDint1

Required. Sets the Environment. Possible values:

7: SignixPROD
8: SignixDEMO

ESignMetaDataESignMetaDatanull

Sets the Sign MetaData, including:

  • ClientCode
    AccountCode
    RepCode
    FirmCode
SignMessagestring""Sets the SignMessage
SignMultipleDocsboolfalseEnables the Sign for Multiple Docs
HTMLButtonSignNamestring""Set the name of the Sign Button
SignAllDocsCombinedboolfalseEnables the Sign for Combining Docs (forms + attachments)
SignCallBackURLstring""Required. Sets the SignCallBackURL.
SignErrorMessagestring""Sets the error Message
SignHideEmptySignersboolfalseSets whether to display or hide the empty signers in the esign popup
SignJavascriptstring""Javascript to be run when clicking the Sign button
SignOrderLockboolfalseLocks the order column in the esign popup
SignSendJavascriptstring""Javascript to be run when clicking the Send button in the esign popup
SignixDateSignedFormatenum0

Specifies how to format the signing date/time. Required if DateSignedField present. Enumerators listed below:

none = -1
MM_dd_yyyy = 0
MMMM_dd_yyyy = 1
dd_MMMM_yyyy = 2
dd_MMM_yyyy = 3
dd_MM_yy = 4
dd_MM_yyyy = 5

SignixDateSignedTimeZoneenum7

Specifies the time zone in which to report the signing date and time. Enumerators listed below:

none = -1,
US_Eastern = 0,
US_Central = 1,
US_Mountain = 2,
US_Pacific = 3,
US_Alaska = 4,
US_Hawaii = 5,
GMT = 6,
UTC = 7

SignixDateSignedMilitaryOffboolfalseIf True, then the format of the time signed will NOT be in military time format (will show AM/PM). If False, then the format of the time signed WILL be in miltary format (will not show AM/PM).
SignixDateSignedHideTimeboolfalseIf True, removes the time and timezone from signature in SIGNiX
SignixDeliveryTypeenumSDDDCConfigures which type of delivery service is used with SIGNiX (SDDC vs SDD)
SignixDelDocsAfterint60Specifies the amount of days completed documents will be available in your MyDox account. After the final specified day, the document will be purged from the system.
SignixDemoboolfalseConfigures SIGNiX production server to behave like a demo
SignixDistributeToSubmitterboolfalseIndicate if the Submitter is to receive a copy of the distribution email when the
transaction completes.
SignixDistributionEmailContentstring""Text that is to be included in the distribution email sent when the transaction completes.
SignixDistributionEmailListstring""List of email recipients of the distribution email sent when the transaction completes
SignixDocSetDescriptionstring""

Description of forms in a transaction. If not provided, a default value will be used, following the following calculation:

"{First Signer name}: {Dealer Name}: {Form Short Name}"

SignixExpireAfterint10Transaction automatically cancelled if it is not completed within the specified number of days.
SignixShowSignNowbooltrueShow the Sign Now field in the E-Sign Pop-Up
SignixSubmitterEmailstring""Sets the Email of Submitter. If not provided Sign button won't be displayed in the Form Viewer.
SignixSubmitterEmailListstring""Sets the SIGNiX Submitter Email List
SignixSubmitterNamestring""

Sets the Name of Submitter. Assigned name can be seen in the Document History under your transaction in MyDox. 

If not provided Sign button won't be displayed in the Form Viewer.

SignixSuspendOnStartboolfalseIndicates if transaction preprocessing is to suspend the transaction instead of notifying
the first party.
SignixWorkgroupenumSDDSets the SIGNiX workgroup property
SignixBillingRefstring""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
SignixContactInfostring""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"

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 NameDescriptionAllowed Values
SignixClientPrefAllowSignatureGraphicDetermines whether a user can set up a signature graphic when they register.

yes

no

required

SignixClientPrefAuditTrailWithCCThe audit trail of the transaction will be included as a PDF attachment to the CC (Carbon Copy) email.

yes

no

SignixClientPrefAutoAdvanceToNextDocumentWhen the user finishes all required actions for the current document, the next document is automatically opened without first displaying the Document List.

yes

no

SignixClientPrefAutoAdvanceToNextSignatureWhen the user completes a signature line, the document is positioned to the next signature line.

yes

no

SignixClientPrefAutoOpenFirstDocumentWhen 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

SignixClientPrefBrowserAutofillToggles the browser's autocomplete attribute of HTML form input fields.

yes

no

SignixClientPrefDateSignedFormatSets 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
SignixClientPrefDateSignedTimeZoneThis 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
SignixClientPrefEnable21CFRPart11CompliantModeThis preference enables various UI components required
by 21 CFR Part 11 compliance.
no
yes, signer chooses reason
yes, submitter chooses reason
SignixClientPrefMiddleNameDetermines how middle names appear.no preference
as submitted
middle initial
full middle name
SignixClientPrefMustSignFirstDocumentFirstDetermines 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
SignixClientPrefNextPartyLinkThis 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
SignixClientPrefNotificationScheduleThe 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

For help regarding Quik! Forms and the Quik! API
Email: support@quikforms.com | Phone: (877) 456-QUIK