SignatoryEmail | SignatoryEmailParameterName | SignatoryMobilePhone | SignatoryMobilePhoneParameterName | SignatoryInputType | SignatureFontSize | SignatureType | SigningOrder | SigningStep | SourceGroup | ValidationMessage | ValidationType | Value | VerticalAlignment | Width | WordWrap
SignatoryEmail
SignatoryEmail need not be specified if the JotBlock has been previously assigned in the workflow. For new JotBlocks one of SignatoryEmail, SignatoryEmailParameterName, SignatoryMobilePhone or SignatoryMobilePhoneParameterName must be specified. If SignatoryEmail is specified, it must match a signatory email being passed in the document submission XML.
| DATA TYPE | RESTRICTIONS (CASE SENSITIVE) | DEFAULT IF NOT SPECIFIED (NEW JOTBLOCKS) |
|---|---|---|
| String(128) | If provided, must be case-sensitive match to existing signatory | Submission will error if new JotBlock and SignatoryEmailParameterName not specified |
| JOTBLOCK TYPE | SUPPORTED | |
|---|---|---|
| Text Tag | yes | |
| XML | yes | |
| Written | yes | |
| Typed | yes |
SignatoryEmailParameterName
SignatoryEmailParameterName need not be specified if the JotBlock has been previously assigned in the workflow. For new JotBlocks one of SignatoryEmail, SignatoryEmailParameterName, SignatoryMobilePhone or SignatoryMobilePhoneParameterName must be specified. This must match the parameter name of a valid parameter for this document. If a value is provided for the SignatoryEmail attribute this attribute will be ignored.
| DATA TYPE | RESTRICTIONS (CASE SENSITIVE) | DEFAULT IF NOT SPECIFIED (NEW JOTBLOCKS) |
|---|---|---|
| String(50) | If provided, must be case-sensitive match to user-defined name or SystemName of existing signatory parameter | Submission will error if new JotBlock and SignatoryEmail not sent |
| JOTBLOCK TYPE | SUPPORTED | |
|---|---|---|
| Text Tag | yes | |
| XML | yes | |
| Written | yes | |
| Typed | yes |
SignatoryMobilePhone
SignatoryMobilePhone need not be specified if the JotBlock has been previously assigned in the workflow. For new JotBlocks one of SignatoryEmail, SignatoryEmailParameterName, SignatoryMobilePhone or SignatoryMobilePhoneParameterName must be specified. If SignatoryMobilePhone is specified, it must match a signatory mobile phone being passed in the document submission XML. This should be used only when SMS messages are configured.
| DATA TYPE | RESTRICTIONS (CASE SENSITIVE) | DEFAULT IF NOT SPECIFIED (NEW JOTBLOCKS) |
|---|---|---|
| String(128) | If provided, must be case-sensitive match to existing signatory | Submission will error if new JotBlock, and SMS is used, and SignatoryMobilePhoneParameterName not specified |
| JOTBLOCK TYPE | SUPPORTED | |
|---|---|---|
| Text Tag | yes | |
| XML | yes | |
| Written | yes | |
| Typed | yes |
SignatoryMobilePhoneParameterName
SignatoryMobilePhoneParameterName need not be specified if the JotBlock has been previously assigned in the workflow. For new JotBlocks one of SignatoryEmail, SignatoryEmailParameterName, SignatoryMobilePhone or SignatoryMobilePhoneParameterName must be specified. This must match the parameter name of a valid parameter for this document. If a value is provided for the SignatoryMobilePhone attribute this attribute will be ignored. This should be used only when SMS messages are configured.
| DATA TYPE | RESTRICTIONS (CASE SENSITIVE) | DEFAULT IF NOT SPECIFIED (NEW JOTBLOCKS) |
|---|---|---|
| String(50) | If provided, must be case-sensitive match to user-defined name or SystemName of existing signatory parameter | Submission will error if new JotBlock, and SMS is used, and SignatoryMobilePhone not sent |
| JOTBLOCK TYPE | SUPPORTED | |
|---|---|---|
| Text Tag | yes | |
| XML | yes | |
| Written | yes | |
| Typed | yes |
SignatoryInputType
SignatoryInputType indicates the type of method of input the signer will be prompted to use for this JotBlock. If not specified this value defaults to Auto. Possible values are:
- Auto – the application will attempt to determine the appropriate signatory input type based on other provided information. The Timestamp type must be explicitly set, however.
- FreeText – for typed JotBlocks for which there is no ValidationType specified.
- Prefill – for typed JotBlocks for which a ValidationType is specified.
- Timestamp – will render a Timestamp based on the detected client machine date and time at the conclusion of the assigned signatory's signing step.
- CustomValidation – for typed JotBlocks that will be validated using a user-defined Regex and ValidationMessage (both properties are required in order for to use this option.
- MultipleChoiceCheckbox – for JotBlocks for which one or more selections will be made from a list of checkboxes and where the specified text or graphic will be applied to the region of the document associated with each selected option. An Options element must be specified and each TypedJotBlockOption must have a FieldRegion set.
- MultipleChoiceGraphic – for JotBlocks for which a selection will be made from a dropdown list and where the applied information will be a graphic. An Options element must be specified and each TypedJotBlockOption must have a GraphicRenderType set.
- MultipleChoiceRadio – for JotBlocks for which a single selection will be made from a list of radio-buttons and where the specified text or graphic will be applied to the region of the document associated with the selected option. An Options element must be specified and each TypedJotBlockOption must have a FieldRegion set.
- MultipleChoiceText – for JotBlocks for which a selection will be made from a dropdown list and where the applied information will be text. An Options element must be specified.
A GraphicRenderType is required for 'MultipleChoiceGraphic' JotBlocks, optional for 'MultipleChoiceRadio' and 'MultipleChoiceCheckbox' JotBlocks, and not supported for 'MultipleChoiceText' JotBlocks. Valid enumerations are:
- None - will render nothing
- Empty - will render an empty square box
- Check - will render a check mark graphic in a box
- X - will render an X graphic in a box
- NoBoxEmpty
- NoBoxCheck - will render a check mark graphic
- NoBoxX - will render an X graphic
- Text - will render the text for the selected item
- Value - will render the value for the selected item
For examples of how GraphicRenderType is constructed for these types of JotBlocks see Defining Dynamic Multiple Choice JotBlocks In XML and Defining Multiple Choice JotBlocks By Embedded Text.
Note: It is possible to pre-populate a JotBlock with a SignatoryInputType of MultipleChoiceText, MultipleChoiceGraphic, MultipleChoiceRadio, or MultipleChoiceCheckbox by setting the value of the TypedProperties\Value element to match the TextValue attribute value of a TypedJotBlockOption present in the TypedProperties\Options element on the JotBlock.
| DATA TYPE | RESTRICTIONS (CASE SENSITIVE) | DEFAULT IF NOT SPECIFIED (NEW JOTBLOCKS) |
|---|---|---|
| String (TypedJotBlockSignatoryInputType) | Auto, FreeText,Prefill, MultipleChoiceText, MultipleChoiceGraphic, MultipleChoiceRadio, MultipleChoiceCheckbox, Timestamp, CustomValidation | Auto |
| JOTBLOCK TYPE | SUPPORTED | |
|---|---|---|
| Text Tag | yes | |
| XML | yes | |
| Written | no | |
| Typed | yes |
SignatureFontSize
SignatureFontSize must be one of the enumeration Six, Eight, Ten, Twelve, Fourteen. If not specified, the font of JotBlocks of FieldType Typed will be rendered as size Ten. This is only applicable to a written signature JotBlock that allows for typing of the signature or initials.
| DATA TYPE | RESTRICTIONS (CASE SENSITIVE) | DEFAULT IF NOT SPECIFIED (NEW JOTBLOCKS) |
|---|---|---|
| String (TypedJotBlockFontSizeType) | Six, Eight, Ten, Twelve, Fourteen | Ten |
| JOTBLOCK TYPE | SUPPORTED |
|---|---|
| Text Tag | yes |
| XML | yes |
| Written | yes |
| Typed | no |
SignatureType
SignatureType must be one of the enumeration Signature, Initials. If not specified, a full Signature will be requested. This is only applicable to a written signature JotBlock (where FieldType is written) that may allow for typing of the signature or initials. For more information on how to request basic signatures or initials, see here.
| DATA TYPE | RESTRICTIONS (CASE SENSITIVE) | DEFAULT IF NOT SPECIFIED (NEW JOTBLOCKS) |
|---|---|---|
| String (JotBlockSignatureType) | Signature, Initials | Signature |
| JOTBLOCK TYPE | SUPPORTED |
|---|---|
| Text Tag | yes |
| XML | yes |
| Written | yes |
| Typed | no |
SigningOrder
SigningOrder should be populated with an integer value. This may be important if numerous JotBlocks are being added dynamically that will not be signed in the top-down/left-right order they appear on their pages; else, the application will present JotBlocks for signature in the reading order they appear in the document.
| DATA TYPE | RESTRICTIONS (CASE SENSITIVE) | DEFAULT IF NOT SPECIFIED (NEW JOTBLOCKS) |
|---|---|---|
| Number | Attempt to determine based on page and position |
| JOTBLOCK TYPE | SUPPORTED | |
|---|---|---|
| Text Tag | yes | |
| XML | yes | |
| Written | yes | |
| Typed | yes |
SigningStep
SigningStep should be populated with an integer value that matches the number of an existing step previously defined in the workflow. In single-signatory documents, or cases where the signatory to whom the JotBlock will be presented only appears in one step, this property is irrelevant.
| DATA TYPE | RESTRICTIONS (CASE SENSITIVE) | DEFAULT IF NOT SPECIFIED (NEW JOTBLOCKS) |
|---|---|---|
| Number | Must match the number of an existing step in the workflow | Attempt to add to first signing step signatory is assigned to |
| JOTBLOCK TYPE | SUPPORTED | |
|---|---|---|
| Text Tag | yes | |
| XML | yes | |
| Written | yes | |
| Typed | yes |
SourceGroup
SourceGroup may be assigned a text value on multiple JotBlocks that may share input entered in the first JotBlock tagged with the SourceGroup value. For more information on how SourceGroup affects the signing process see Apply a signature to multiple locations.
| DATA TYPE | RESTRICTIONS (CASE SENSITIVE) | DEFAULT IF NOT SPECIFIED (NEW JOTBLOCKS) |
|---|---|---|
| String(255) | JotBlocks sharing a SourceGroup must be of the same type | n/a |
| JOTBLOCK TYPE | SUPPORTED | |
|---|---|---|
| Text Tag | yes | |
| XML | yes | |
| Written | yes | |
| Typed | yes |
ValidationMessage
If ValidationMessage provided in conjunction with a Regex, this specifies the validation text displayed to the signatory if the regular expression check fails on the provided JotBlock input text. If this property is specified, a Regex must also be provided.
| DATA TYPE | RESTRICTIONS (CASE SENSITIVE) | DEFAULT IF NOT SPECIFIED (NEW JOTBLOCKS) |
|---|---|---|
| String(255) | Regex must also be present if specified. | n/a |
| JOTBLOCK TYPE | SUPPORTED | |
|---|---|---|
| Text Tag | yes | |
| XML | yes | |
| Written | no | |
| Typed | yes |
ValidationType
ValidationType may only be specified when FieldType is set to Typed. Possible values are:
- None
- Date_CurrentDatePrefill – the JotBlock contents entered by the signatory must be a date, and it will be initially populated with the current date.
- DateDDMMYYYY_CurrentDatePrefill – the JotBlock contents entered by the signatory must be a date in the order day,month, year; and it will be initially populated with the current date in that form.
- Date – the JotBlock contents must be a date.
- Alphanumeric_FirstNamePrefill – the JotBlock contents must be alphanumeric, and it will be initially populated with the first name of the signatory.
- Alphanumeric_LastNamePrefill – the JotBlock contents must be alphanumeric, and it will be initially populated with the last name of the signatory.
- Alphanumeric_FullNamePrefill – the JotBlock contents must be alphanumeric, and it will be initially populated with the full name of the signatory.
- Alphanumeric_EmailPrefill – the JotBlock contents must be a valid email address, and it will be initially populated with the email of the signatory.
- Numeric – the JotBlock contents must be numeric.
- DateShort_CurrentDatePrefill – the JotBlock contents entered by the signatory must be a date, and it will be initially populated with the current date in the form MM/DD/YYYY.
- DateLong_CurrentDatePrefill – the JotBlock contents entered by the signatory must be a date, and it will be initially populated with the current date in the form MMMM DD. YYYY.
- TenDigitPhoneNumber – the JotBlock contents must be a valid 10 digit phone number.
| DATA TYPE | RESTRICTIONS (CASE SENSITIVE) | DEFAULT IF NOT SPECIFIED (NEW JOTBLOCKS) |
|---|---|---|
| String (TypedJotBlockValidationType) | None, Date_CurrentDatePrefill, DateDDMMYYYY_CurrentDatePrefill, Date, Alphanumeric_FirstNamePrefill, Alphanumeric_LastNamePrefill, Alphanumeric_FullNamePrefill, Alphanumeric_EmailPrefill, Numeric, DateShort_CurrentDatePrefill, DateLong_CurrentDatePrefill, TenDigitPhoneNumber | None |
| JOTBLOCK TYPE | SUPPORTED | |
|---|---|---|
| Text Tag | yes | |
| XML | yes | |
| Written | no | |
| Typed | yes |
Value
If InputType = Fixed then Value must be specified. The contents of Value will be written to the document at the specified location. This may also contain merge field elements enclosed in brackets.
| DATA TYPE | RESTRICTIONS (CASE SENSITIVE) | DEFAULT IF NOT SPECIFIED (NEW JOTBLOCKS) |
|---|---|---|
| String(8192) | If InputType = 'Fixed', this is required | If not provided and InputType = 'Fixed', throws error |
| JOTBLOCK TYPE | SUPPORTED | |
|---|---|---|
| Text Tag | yes | |
| XML | yes | |
| Written | no | |
| Typed | yes |
VerticalAlignment
VerticalAlignment must be one of Top, Center, Bottom. If not specified, JotBlocks of FieldType Typed will be rendered with VerticalAlignment Bottom.
| DATA TYPE | RESTRICTIONS (CASE SENSITIVE) | DEFAULT IF NOT SPECIFIED (NEW JOTBLOCKS) |
|---|---|---|
| String (TypedJotBlockVertAlignmentType) | Top, Center, Bottom | Bottom |
| JOTBLOCK TYPE | SUPPORTED | |
|---|---|---|
| Text Tag | yes | |
| XML | yes | |
| Written | no | |
| Typed | yes |
Width
Width must be a value between 0 and 1. This is calculated as the ratio of the width of the JotBlock to the overall width of the visible portion of the page in pixels:
Width = [JotBlock Width] / [Page Width]
Note that the AssureSign application will enforce a minimum height and width to ensure that all elements render correctly to the document.
| DATA TYPE | RESTRICTIONS (CASE SENSITIVE) | DEFAULT IF NOT SPECIFIED (NEW JOTBLOCKS) |
|---|---|---|
| Decimal Number | If provided, between 0 and 1 | Minimum field width (taking 'Certified' into account) |
| JOTBLOCK TYPE | SUPPORTED | |
|---|---|---|
| Text Tag | yes | |
| XML | yes | |
| Written | yes | |
| Typed | yes |
WordWrap
If WordWrap is true will wrap the contents of JotBlocks of FieldType Typed within the JotBlock frame.
| DATA TYPE | RESTRICTIONS (CASE SENSITIVE) | DEFAULT IF NOT SPECIFIED (NEW JOTBLOCKS) |
|---|---|---|
| Boolean | false |
| JOTBLOCK TYPE | SUPPORTED |
|---|---|
| Text Tag | yes |
| XML | yes |
| Written | no |
| Typed | yes |