Documentation Index

Fetch the complete documentation index at: https://knowledgecenter.docuware.com/llms.txt

Use this file to discover all available pages before exploring further.

Service methods and parameters with DocuSign

Prev Next

DocuWare works with DocuSugn as a provider of trust services to sign documents in a workflow.

For each signature, a separate service method is stored in the workflow configuration. The service methods offer configuration options such as:

  • Signing a document in multiple places, for example in the case of contracts

  • Signing multiple clipped files in a DocuWare document. This is useful, for example, when a standard confidentiality agreement is to be signed along with a contract.

  • Setting a deadline for signing

DocuWare Signature Service

To sign documents in a workflow, the DocuWare Signature Service must be stored in the workflow via a Web Service activity.

Remote signing with DocuSign

Process: In order for a person to sign a document, the name, email address, and an SMS-capable phone number must be known. This information is passed from the workflow to DocuSign to request a signature. The signer receives an email with the link to the document. Depending on the authentication method, the signer can then trigger the signature.

The following service methods are all remote signatures and have the security level "advanced" - AES.

No registration with DocuSign is required for the signer with these methods.

The following methods are available for remote signing with DocuSign:

  • AddNewDocumentRemote

    This method sends one file of a document for signature by one person. The signature is placed at one position.

  • AddNewDocumentMultiSigners

    This method sends one file of a document for signature by multiple persons. The signatures are placed at multiple positions.

  • AddNewDocumentMultiPositionsRemote

    This method sends one file of a document for signature by one person. The signature is placed at multiple positions.

  • AddNewClippedDocument

    This method sends multiple files of a document for signature by one person. The signature is placed at multiple positions.

Method

Description

Files

Signer

Signature positions

AddNewDocumentRemote

Sends one file of a document for signature by one person. The signature is placed at one position.

1

1

1

AddNewDocumentMultiSigners

Sends one file of a document for signature by multiple persons. The signatures are placed at multiple position.

1

multiple

multiple

AddNewDocumentMultiPositionsRemote

Sends one file of a document for signature by one person. The signature is placed at multiple positions.

1

1

multiple

AddNewClippedDocument

Sends multiple files of a document for signature by one person. The signature is placed at multiple positions.

multiple

1

multiple

AddNewDocumentRemote

Sends one file of a document for signature by one person. The signature is placed at one position. Parameters must be specified. Exceptions are marked as optional.

  • The information about the signers and the signature positions in the document are contained in a list with delimiters. The delimiter is defined with a dedicated parameter.

  • In the examples in the table, the comma is used as a delimiter (see parameter MultiValueSeparator).

  • In the list parameters, the order and the number of values separated by "MultiValueSeparator" must be identical.

  • The file cabinet is updated after all persons have processed the document.

  • Parameters must be specified. Exceptions are marked as optional.

Parameter name

Workflow variable type

Mandatory/optional

Description

Values

AccessCode (string)

Text

Mandatory for RecipientAuthenticationType = Access Code

If the Authentication type is “AccessCode”, this parameter is required. This will be the access code (similar to a password) that will be required to sign the document. The access code must be provided to the signer in a separate communication channel (phone call or email, for example).

AnchorText (string)

Text

Mandatory

This is the piece of text the service can look for on the document. If specified and not found, an error will occur. If not specified, then the subsequent location information will be absolute, rather than relative to finding a piece of text.

AnchorTextOccurrence (int)

Integer

Mandatory

Which occurrence of the anchor text should be used to be the starting location for placing the signature

  • 0 or 1 is the first occurence

  • -1 is the last occurrence

  • Any other number is a specific occurrence

DateSignedAnchorText (string)

String

Optional

This is the piece of text the service can look for on the document. If specified and not found, an error will occur. If not specified, then the subsequent location information will be absolute, rather than relative to finding a piece of text.

DateSignedAnchorTextOccurrence (int)

Integer

Optional

Which occurrence of the anchor text should be used to be the starting location for placing the date signed.

  • 0 or 1 is the first occurence

  • -1 is the last occurrence

  • Any other number is a specific occurrence

DateSignedFieldName (string)

Text

Mandatory

Identifies a file cabinet field on the document that will be updated with the date the document was signed by the user. It can be a text, date or datetime field.
Date is provided in UTC, if the field is a text field, the date will be displayed in UTC, if the field is a date or datetime field, DocuWare will display the date in the local format and timezone.

DateSignedPageNumber (int)

Integer

Optional

Page number within the file to start looking for the anchor text. -1 indicates to look on the last page. If no anchor text is specified, it is the absolute page number.

DateSignedPositionX (int)

Integer

Optional

Relative to the left side of the anchor text, this is the horizontal location of the date signed text be placed on the document (millimeters again). Positive numbers are to the right. Negative numbers are to the left.

DateSignedPositionY (int)

Integer

Optional

Relative to the top of the anchor text, this is the vertical location of the date signed text to be placed on the document (millimeters again). Positive numbers are down. Negative numbers are up.

DaysBeforeExpiration (int)

Integer

Mandatory

If the value provided is greater than 0, there will be a time limit of this number of days before the document expires. If the time limit is passed, the document will be considered declined. It will be deleted from the VIDsigner service and the signer will no longer be able to sign it.

DocId (int)

Integer

Mandatory

ID of the document to be signed

EmailSubject (string)

Text

Mandatory

Subject of the email

FailureStatusValue (string)

Text

Mandatory

This provides a value to be set in the above field when a document is rejected by the user in DocuSign.

FileCabinetId (string)

Text

Mandatory

GUID of the file cabinet with the document

IncludeDateSigned (boolean)

Text

Optional

This parameter is optional but when set to “True”, the date signed will be included in the document and the parameters below for locating the date signed will be required.

  • True

  • False

IncludeReport (boolean)

Text

Optional

This parameter is optional but if provided must have a value of ‘true’ or ‘false’. Setting it to true will append a second PDF to the document after the signed document. This PDF has information regarding the signer and the digital certificate that was added to the document.

  • True

  • False

PageNumber (int)

Integer

Mandatory

Page number within the file to start looking for the anchor text. -1 indicates to look on the last page. If no anchor text is specified, it is the absolute page number.

PhoneNumber (string)

Text

Mandatory

Phone number used for two-factor authentication (use international phone number format, ex. +18455639045) during the signing process

PositionX (int)

Integer

Mandatory

Relative to the left side of the anchor text, this is the horizontal location of the signature image to be placed on the document (millimeters again). Positive numbers are to the right. Negative numbers are to the left.

PositionY (int)

Integer

Mandatory

Relative to the top of the anchor text, this is the vertical location of the signature image to be placed on the document (millimeters again). Positive numbers are down. Negative numbers are up.

PostSigningAction (string)

Text

Mandatory

This specifies what is to be done with the signed document after the user signs it in DocuSign.

  • ClipBefore

  • ClipAfter

  • Replace

RecipientAuthenticationType (string)

Text

Mandatory

This allows the workflow to specify what type of DocuSign authentication is required to allow a signer to sign a document.

  • None

  • AccessCode

  • Phone

  • SMS

  • KBA

RecipientMayProvideNumber (Boolean)

Text

Mandatory for RecipientAuthenticationType = Phone or SMS

Only for Phone/SMS authentication. If set to true, it ignores any value the user sets in the phone number. Then, at the time of signing the signer can provide the number to be called to receive the code by entering it in the DocuSign application.

  • True

  • False

RejectionReasonFieldName (string)

Text

Optional

This parameter will specify an Index Field on the document that must be a text field. When the user declines to sign the document, the DocuSign application can be configured to ask them to provide a reason. If they decline to sign and enter a reason, the text they enter will be placed in this field.

Report Language (string)

Text

Mandatory for IncludeReport = True

This parameter is optional and only can be included if IncludeReport is set to “true”. When specified, it ensures the generated report that will be appended to the signed file is in the desired language.

de, en, es, fr, it, ja, ko, nl, pt, pt_BR, ru, zh_CH, zh_TW

  • SectionNumber (int)

Integer

Mandatory

Index of the section within the document to be signed.

A section is one file in a clipped document consisting of multiple files.

  • 0 or 1 will be the first section

  • -1 is the last section

  • Any other number is a specific section

SignerEmail (string)

Text

Mandatory

Email address of the signer of the document

SignerName (string)

Text

Mandatory

Name of the person signing the document

StatusFieldName (string)

Text

Mandatory

This identifies an index field of the document that will be updated when a document is signed or rejected by the user in DocuSign.

SuccessStatusValue (string)

Text

Mandatory

This provides the value to be set in the above field when a document is signed.

Token (string)

Text

Mandatory

Token received in the registration step that identifies the customer organization and provides user credentials.

AddNewDocumentMultiSigners

Sends one file of a document for signature by multiple persons. The signatures are placed at multiple position.

  • The information about the signers and the signature positions in the document are contained in a list with delimiters. The delimiter is defined with a dedicated parameter.

  • In the examples in the table, the comma is used as a delimiter (see parameter MultiValueSeparator).

  • In the list parameters, the order and the number of values separated by "MultiValueSeparator" must be identical.

  • The file cabinet is updated after all persons have processed the document.

  • Parameters must be specified. Exceptions are marked as optional.

Parameter name

Workflow variable type

Mandatory/optional

Description

Values

AccessCode (string)

Text

Mandatory for RecipientAuthenticationType = Access Code

If the Authentication type is “AccessCode”, this parameter is required. This will be the access code (similar to a password) that will be required to sign the document. The access code must be provided to the signer in a separate communication channel (phone call or email, for example).

DateSignedFieldName (string)

Text

Mandatory

Identifies a file cabinet field on the document that will be updated with the date the document was signed by the user. It can be a text, date or datetime field.

Date is provided in UTC, if the field is a text field, the date will be displayed in UTC, if the field is a date or datetime field, DocuWare will display the date in the local format and timezone.

DaysBeforeExpiration (int)

Integer

Mandatory

If the value provided is greater than 0, there will be a time limit of this number of days before the document expires. If the time limit is passed, the document will be considered declined. It will be deleted from the DocuSign service and the signer will no longer be able to sign it.

DocId (int)

Integer

Mandatory

ID of the document to be signed

EmailMessage (string)

Text

Mandatory

Text that is displayed in the contents of the email

EmailSubject (string)

Text

Mandatory

Subject of the email

FailureStatusValue (string)

Text

Mandatory

This provides a value to be set in the above field when a document is rejected by the user in DocuSign.

FileCabinetId (string)

Text

Mandatory

GUID of the file cabinet with the document

IncludeDateSigned (boolean)

Text

Optional

This parameter is optional but when set to “True”, the date signed will be included in the document and the parameters below for locating the date signed will be required.

  • True

  • False

IncludeReport (boolean)

Text

Optional

This parameter is optional but if provided must have a value of ‘true’ or ‘false’. Setting it to true will append a second PDF to the document after the signed document. This PDF has information regarding the signer and the digital certificate that was added to the document.

  • True

  • False

MultiAnchorText (string)

Text

Mandatory

This parameter holds the anchor texts for the multiple signing locations.

MultiAnchorTextOccurrence (string)

Text

Mandatory

This parameter holds the anchor texts for the multiple signing locations.

MultiDateSignedAnchorText (string)

Text

Mandatory

This parameter holds the anchor texts for the multiple date signed locations..

MultiDateSignedAnchorTextOccurrence (string)

Text

Mandatory

This parameter holds the anchor texts for the multiple date signed locations.

MultiDateSignedPageNumber (string)

Text

Mandatory

This parameter holds a delimited list of page numbers where date signed are located.

MultiDateSignedPositionX (string)

Text

Mandatory

This parameter holds a list of X positions for date signed placement.

MultiDateSignedPositionY (string)

Text

Mandatory

This parameter holds a list of Y positions for date signed placement.

MultiPageNumber (string)

Text

Mandatory

This parameter holds a delimited list of page numbers where signatures are located.

MultiPositionX (string)

Text

Mandatory

This holds a list of X positions for signature placement.

MultiPositionY (string)

Text

Mandatory

This holds a list of Y positions for signature placement

MultiSignerCount (int)

Text

Mandatory

This is the number of signatures being requested

MultiSignerEmail (string)

Text

Mandatory

This parameter holds the email addresses for the signers.

MultiSignerName (string)

Text

Mandatory

This parameter holds the names of the signers of the document.

Example: “Peter Sanders,BrianFlorent”

MultiSignerPhoneNumber (string)

Text

Mandatory

Holds a delimited list of phone numbers that can be used for SMS verification.

MultiValueSeparator (string)

Text

Mandatory

This parameter is required and tells the service how the list of signers and their information will be separated. A common choice is a comma, a caret ^ or a pipe |

OrderedSignature (bool)

Text

Mandatory

When true, the signatures will be requested in the order that they are specified in the above fields. The first signer will receive an email, can sign and then the second signer will be sent an email and may sign, and so on. When false, all signers are notified parallel and may sign in any order. In both cases, the file cabinet is not updated with the signed document until all signatures are obtained.

  • True

  • False

PostSigningAction (string)

Text

Mandatory

This specifies what is to be done with the signed document after the user signs it in DocuSign.

  • ClipBefore

  • ClipAfter

  • Replace

RecipientAuthenticationType (string)

Text

Mandatory

This allows the workflow to specify what type of DocuSign authentication is required to allow a signer to sign a document. See section 2.1 for more information about these authentication types.

  • None

  • AccessCode

  • Phone

  • SMS

  • KBA

RecipientMayProvideNumber (Boolean)

Text

Mandatory for RecipientAuthenticationType = Phone or SMS

Only for Phone/SMS authentication. If set to true, it ignores any value the user sets in the phone number. Then, at the time of signing the signer can provide the number to be called to receive the code by entering it in the DocuSign application.

  • True

  • False

Report Language (string)

Text

Mandatory for IncludeReport = True

This parameter is optional and only can be included if IncludeReport is set to “true”. When specified, it ensures the generated report that will be appended to the signed file is in the desired language.

de, en, es, fr, it, ja, ko, nl, pt, pt_BR, ru, zh_CH, zh_TW

SectionNumber (int)

Integer

Mandatory

Index of the section within the document to be signed.

A section is one file in a clipped document consisting of multiple files.

  • 0 or 1 will be the first section

  • -1 is the last section

  • Any other number is a specific section

StatusFieldName (string)

Text

Mandatory

This identifies an index field of the document that will be updated when a document is signed or rejected by the user in DocuSign.

SuccessStatusValue (string)

Text

Mandatory

This provides the value to be set in the above field when a document is signed.

Token (string)

Text

Mandatory

Token received in the registration step that identifies the customer organization and provides user credentials.

AddNewDocumentMultiPositionsRemote

Sends one file of a document for signature by one person. The signature is placed at multiple positions.

  • The information about the signers and the signature positions in the document are contained in a list with delimiters. The delimiter is defined with a dedicated parameter.

  • In the examples in the table, the comma is used as a delimiter (see parameter MultiValueSeparator).

  • In the list parameters, the order and the number of values separated by "MultiValueSeparator" must be identical.

  • Parameters must be specified. Exceptions are marked as optional.

Parameter name

Workflow variable type

Mandatory/optional

Description

Values

AccessCode (string)

Text

Mandatory for RecipientAuthenticationType = Access Code

If the Authentication type is “AccessCode”, this parameter is required. This will be the access code (similar to a password) that will be required to sign the document. The access code must be provided to the signer in a separate communication channel (phone call or email, for example).

DateSignedFieldName (string)

Text

Mandatory

Identifies a file cabinet field on the document that will be updated with the date the document was signed by the user. It can be a text, date or datetime field.

Date is provided in UTC, if the field is a text field, the date will be displayed in UTC, if the field is a date or datetime field, DocuWare will display the date in the local format and timezone.

DaysBeforeExpiration (int)

Integer

Mandatory

If the value provided is greater than 0, there will be a time limit of this number of days before the document expires. If the time limit is passed, the document will be considered declined. It will be deleted from the DocuSign service and the signer will no longer be able to sign it.

DocId (int)

Integer

Mandatory

ID of the document to be signed

EmailMessage (string)

Text

Mandatory

Text that is displayed in the contents of the email

EmailSubject (string)

Text

Mandatory

Subject of the email

FailureStatusValue (string)

Text

Mandatory

This provides a value to be set in the above field when a document is rejected by the user in DocuSign.

FileCabinetId (string)

Text

Mandatory

GUID of the file cabinet with the document

IncludeDateSigned (boolean)

Text

Optional

This parameter is optional but when set to “True”, the date signed will be included in the document and the parameters below for locating the date signed will be required.

  • True

  • False

IncludeReport (boolean)

Text

Optional

This parameter is optional but if provided must have a value of ‘true’ or ‘false’. Setting it to true will append a second PDF to the document after the signed document. This PDF has information regarding the signer and the digital certificate that was added to the document.

  • True

  • False

MultiDateSignedAnchorText (string)

Text

Mandatory

This parameter holds the anchor texts for the multiple date signed locations..

MultiDateSignedAnchorTextOccurrence (string)

Text

Mandatory

This parameter holds the anchor texts for the multiple date signed locations.

MultiDateSignedCount (int)

Integer

Mandatory

This parameter holds the occurrence of the anchor texts used for placing the multiple date signed tabs

MultiDateSignedPageNumber (string)

Text

Mandatory

This parameter holds a delimited list of page numbers where date signed are located.

MultiDateSignedPositionX (string)

Text

Mandatory

This parameter holds a list of X positions for date signed placement.

MultiDateSignedPositionY (string)

Text

Mandatory

This parameter holds a list of Y positions for date signed placement.

MultiInitialAnchorText (string)

Text

Mandatory

This parameter holds the anchor texts for the multiple initials locations

  • 0 or 1 is the first occurence

  • -1 is the last occurrence

  • Any other number is a specific occurrence

MultiInitialAnchorTextOccurrence (string)

Text

Mandatory

Page number within the file to start looking for the anchor text. -1 indicates to look on the last page. If no anchor text is specified, it is the absolute page number.

MultiInitialCount (int)

Numeric

Mandatory

This is the number of initials tabs being placed on the document

MultiInitialPageNumber (string)

Text

Mandatory

Relative to the left side of the anchor text, this is the horizontal location of the date signed text be placed on the document (millimeters again). Positive numbers are to the right. Negative numbers are to the left.

MultiInitialPositionX (string)

Text

Mandatory

Relative to the top of the anchor text, this is the vertical location of the date signed text to be placed on the document (millimeters again). Positive numbers are down. Negative numbers are up.

MultiInitialPositionY (string)

Text

Mandatory

This holds a list of Y positions for initials placement.

MultiSignatureAnchorText (string)

Text

Mandatory

This parameter holds the anchor texts for the multiple signing locations.

MultiSignatureAnchorTextOccurrence (string)

Text

Mandatory

This parameter holds the anchor text occurrences (i.e. first, second or third time etc. text occurs in the document) for the multiple signature locations.

MultiSignatureCount (int)

Numeric

Mandatory

This is the number of signature tabs being placed on the document

MultiSignaturePageNumber (string)

Text

Mandatory

This holds a delimited list of page numbers where signatures are located

MultiSignaturePositionX (string)

Text

Mandatory

This holds a list of X positions for signature placement.

MultiSignaturePositionY (string)

Text

Mandatory

This holds a list of Y positions for signature placement

MultiValueSeparator (string)

Text

Mandatory

This parameter is required and tells the service how the list of signers and their information will be separated. A common choice is a comma, a caret ^ or a pipe |

PhoneNumber (string)

Text

Mandatory

Phone number used for two-factor authentication (use international phone number format, ex. +18455639045) during the signing process

PostSigningAction (string)

Text

Mandatory

This specifies what is to be done with the signed document after the user signs it in DocuSign.

  • ClipBefore

  • ClipAfter

  • Replace

RecipientAuthenticationType (string)

Text

Mandatory

This allows the workflow to specify what type of DocuSign authentication is required to allow a signer to sign a document. See section 2.1 for more information about these authentication types.

  • None

  • AccessCode

  • Phone

  • SMS

  • KBA

RecipientMayProvideNumber (Boolean)

Text

Mandatory for RecipientAuthenticationType = Phone or SMS

Only for Phone/SMS authentication. If set to true, it ignores any value the user sets in the phone number. Then, at the time of signing the signer can provide the number to be called to receive the code by entering it in the DocuSign application.

  • True

  • False

Report Language (string)

Text

Mandatory for IncludeReport = True

This parameter is optional and only can be included if IncludeReport is set to “true”. When specified, it ensures the generated report that will be appended to the signed file is in the desired language.

de, en, es, fr, it, ja, ko, nl, pt, pt_BR, ru, zh_CH, zh_TW

SectionNumber (int)

Integer

Mandatory

Index of the section within the document to be signed.

A section is one file in a clipped document consisting of multiple files.

  • 0 or 1 will be the first section

  • -1 is the last section

  • Any other number is a specific section

SignerEmail (string)

Text

Mandatory

Email address of the signer of the document

SignerName (string)

Text

Mandatory

Name of the person signing the document

StatusFieldName (string)

Text

Mandatory

This identifies an index field of the document that will be updated when a document is signed or rejected by the user in DocuSign.

SuccessStatusValue (string)

Text

Mandatory

This provides the value to be set in the above field when a document is signed.

Token (string)

Text

Mandatory

Token received in the registration step that identifies the customer organization and provides user credentials.

AddNewClippedDocument

Sends multiple files of a document for signature by one person. The signature is placed at multiple positions.

  • The information about the signers and the signature positions in the document are contained in a list with delimiters. The delimiter is defined with a dedicated parameter.

  • In the examples in the table, the comma is used as a delimiter (see parameter MultiValueSeparator).

  • In the list parameters, the order and the number of values separated by "MultiValueSeparator" must be identical.

  • Parameters must be specified. Exceptions are marked as optional.

Parameter name

Workflow variable type

Mandatory/optional

Description

Values

AccessCode (string)

Text

Mandatory for RecipientAuthenticationType = Access Code

If the Authentication type is “AccessCode”, this parameter is required. This will be the access code (similar to a password) that will be required to sign the document. The access code must be provided to the signer in a separate communication channel (phone call or email, for example).

DateSignedFieldName (string)

Text

Mandatory

Identifies a file cabinet field on the document that will be updated with the date the document was signed by the user. It can be a text, date or datetime field.

Date is provided in UTC, if the field is a text field, the date will be displayed in UTC, if the field is a date or datetime field, DocuWare will display the date in the local format and timezone.

DaysBeforeExpiration (int)

Integer

Mandatory

If the value provided is greater than 0, there will be a time limit of this number of days before the document expires. If the time limit is passed, the document will be considered declined. It will be deleted from the DocuSign service and the signer will no longer be able to sign it.

DocId (int)

Integer

Mandatory

ID of the document to be signed

EmailMessage (string)

Text

Mandatory

Text that is displayed in the contents of the email

EmailSubject (string)

Text

Mandatory

Subject of the email

FailureStatusValue (string)

Text

Mandatory

This provides a value to be set in the above field when a document is rejected by the user in DocuSign.

FileCabinetId (string)

Text

Mandatory

GUID of the file cabinet with the document

IncludeReport (boolean)

Text

Optional

This parameter is optional but if provided must have a value of ‘true’ or ‘false’. Setting it to true will append a second PDF to the document after the signed document. This PDF has information regarding the signer and the digital certificate that was added to the document.

  • True

  • False

MultiAnchorText (string)

Text

Mandatory

This parameter holds the anchor texts for the multiple signing locations.

MultiAnchorTextOccurrence (string)

Text

Mandatory

This parameter holds the anchor texts for the multiple signing locations.

MultiPageNumber (string)

Text

Mandatory

This holds a delimited list of page numbers where initials are located

MultiPositionX (string)

Text

Mandatory

This holds a list of X positions for signature placement.

MultiPositionY (string)

Text

Mandatory

This holds a list of Y positions for signature placement

MultiSectionCount (int)

Integer

Mandatory

Holds a delimited list of sections where signatures are located

MultiSectionNumber (string)

Text

Mandatory

This holds a delimited list of sections where signatures are located

MultiValueSeparator (string)

Text

Mandatory

This parameter is required and tells the service how the list of signers and their information will be separated. A common choice is a comma, a caret ^ or a pipe |

PhoneNumber (string)

Text

Mandatory

Phone number used for two-factor authentication (use international phone number format, ex. +18455639045) during the signing process

PostSigningAction (string)

Text

Mandatory

This specifies what is to be done with the signed document after the user signs it in DocuSign.

  • ClipBefore

  • ClipAfter

  • Replace

RecipientAuthenticationType (string)

Text

Mandatory

This allows the workflow to specify what type of DocuSign authentication is required to allow a signer to sign a document. See section 2.1 for more information about these authentication types.

  • None

  • AccessCode

  • Phone

  • SMS

  • KBA

RecipientMayProvideNumber (Boolean)

Text

Mandatory for RecipientAuthenticationType = Phone or SMS

Only for Phone/SMS authentication. If set to true, it ignores any value the user sets in the phone number. Then, at the time of signing the signer can provide the number to be called to receive the code by entering it in the DocuSign application.

  • True

  • False

Report Language (string)

Text

Mandatory for IncludeReport = True

This parameter is optional and only can be included if IncludeReport is set to “true”. When specified, it ensures the generated report that will be appended to the signed file is in the desired language.

de, en, es, fr, it, ja, ko, nl, pt, pt_BR, ru, zh_CH, zh_TW

SignerName (string)

Text

Mandatory

Name of the person signing the document

SignerEmail (string)

Text

Mandatory

Email address of the signer of the document

StatusFieldName (string)

Text

Mandatory

This identifies an index field of the document that will be updated when a document is signed or rejected by the user in DocuSign.

SuccessStatusValue (string)

Text

Mandatory

This provides the value to be set in the above field when a document is signed.

Token (string)

Text

Mandatory

Token received in the registration step that identifies the customer organization and provides user credentials.

Withdrawal of the signature request

This method from Validated ID is not a signature procedure in a workflow. Instead, it allows a signature request to be withdrawn in any procedure, for example, if the wrong document was submitted by mistake.

DeleteUnsignedDocuments

Parameter name

Workflow variable type

Mandatory/optional

Description

Values

DocId (int)

Integer

Mandatory

ID of the document to be signed

FileCabinetId (string)

Text

Mandatory

GUID of the file cabinet with the documentt

Token (string)

Text

Mandatory

Token received in the registration step that identifies the customer organization and provides user credentials.

After the signature

After the signer has signed or declined the document, DocuSign notifies the DocuWare Signature Service, which then loads the document from DocuSign. The PostSigningAction parameter determines how the document is handled, for example whether it is clipped to the original or replaced by the new file.

  • If the document has been signed, the DocuWare Signature Service uses the SuccessStatusValue parameter to write a corresponding value, such as "Signed", into the field defined by StatusFieldName.

  • If an error occurred during the signature process, the value from the FailedStatusValue parameter is entered into the field defined by StatusFieldName.

  • If the signer has declined to sign, the reason for the rejection is stored in the field defined by RejectionReasonFieldName.

The workflow can then continue. The Signature Service removes the document from DocuSign.

Supported versions: DocuWare Cloud + 7.14 + 7.13 + 7.12 + 7.11 + 7.10