Documentation Index

Fetch the complete documentation index at: https://help.docfusioncloud.com/llms.txt

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

SigniFlow Workflow Activities

  • Updated on Apr 5, 2023
  • Published on Apr 4, 2023
  • 3 minute(s) read
Prev Next

These DocFusion workflow activities allows for the configuration and initiation of Signiflow signing requests for documents. All activities can be found in the SigniFlow section of the Workflow Designer Toolbox.

Exceptions are thrown for configuration settings that fail validation, or any other error condition.


For instructions to setup a typical DocFusion workflow that initiates SigniFlow signing requests, review this guide...

   

LogonToSigniflow

Authenticates and logs users on to the SigniFlow platform.

   


This activity must be used before initiating the signing process (InitiateSigniflowProcess).

   

Configuration:

ParameterData TypeDescription

Url [Required]

String

Service endpoint for SigniFlow.

DisplayName

String

Workflow activity display name.

Result [Out]

ISigniflowAuthenticatedClient

Resulting authenticated client session object. 


   Use this value for other SigniFlow activities in order to re-use logged-on sessions.

UserName [Required]

String

SigniFlow username.

Password [Required]

String

SigniFlow password.

   

CreateSigniflowWorkflow

Defines a SigniFlow signing request and creates an instance of it.

   

    

Configuration:

ParameterData TypeDescription

DisplayName

String

Workflow activity display name.

Result [Out]

FullWorklowRequest

SigniFlow workflow process definition instance.

FlattenDocument

bool

Flatten all fields when signing.

KeepContentSecurity

bool

Keep document content security when signing.

KeepCustomProperties

bool

Keep custom document properties when signing.

KeepXMLMetadata

bool

Keep embedded XMP metadata when signing.

AdditionalData

String

Additional data to be used for the signature process. 


   This is sent to the defined callback URL in order to share the transaction context.

Document [Required]

String

Document content in base64 format.

DocumentName [Required]

String

The document template filename.

Extension

DocExtension

Specifies document format. Available values:

  • pdf
  • xls
  • txt
  • xlsx
  • docx
  • doc
  • xml
  • png
  • jpg
  • gif

AutoRemind

DocAutoRemind

Send reminders. Available values:

  • Yes
  • No

SendFirstEmail

bool

Send email to the first user.

SendWorkflowStepsEmail

bool

Send an email on every user step completed. 

CustomMessage

String

Display message when the user opens the document for action.

Priority

DocPriority

Process completion priority. Available values:

  • Normal
  • Urgent
  • Very Urgent

DueDate

DateTime

When document signature is expected to be completed.

SLA

Integer

Defines the service level agreement priority. Available values: 1 to 8.

UseAutoTagsboolEnable or disable the use of AutoTagging (Dynamic creation of fields based on the text in the document).


E.g. A signature field for the first signer will be placed where the tag /s#1#200#60#-30#30/ appears in the document, with the settings:
  • Field Width: 200px
  • Field Height: 60px
  • Field X-Offset: 2px to the right
  • Field Y-Offset: 5px down. 

   

AddSigniflowWorkflowUser

Adds a collaborating user to the signing process.


Configuration:

ParameterData TypeDescription

SignatureWorkflow [Required]

FullWorklowRequest

Process definition instance.

DisplayName

String

Workflow activity display name.

Result [Out]

WorkflowUser

Resulting workflow user instance.


   Used to add field ownership.

Action

Actions

Specify the user action for this document. Available values:

  • SignDocument
  • ViewDocument
  • ApproveDocument

AllowProxy

ProxyAllowed

Allows or denies a user from nominating someone to sign on his behalf. Available values:

  • No
  • Yes

AutoSign

bool

Indicates if the document should be signed automatically by the first signatory.

SignatureType

eSignatureType

Signature Type. Available values:

  • Electronic
  • Digital

EmailAddress [Required]

String

Signatory's email address.

MobileNumber

String

Signatory's mobile telephone number.

SignReason

String

Reason for signing the document.

SignerPassword

StringSignatory's password to sign the document.

FirstName [Required]

String

User's first name.

FullName [Required]

String

User's full name.

LastName [Required]

String

User's last name.

   

AddSigniflowUserField

Adds a field to the user to fill or take action on.

   

Configuration:

ParameterData TypeDescription

FieldType

FieldType

SigniFlow Field type. Available values:

  • Signature
  • NameText
  • DateText
  • EmailAddressText
  • ContactNumberText
  • PlainText
  • PlainTextOptional
  • FaceToFace
  • Initial
  • CheckBox
  • F2FInitial
  • AddressText
  • CompanyNameText

DisplayName

String

Workflow activity display name.

Name

String

Field name to add.

TagName [Required]

string

Tag text to search for in target document.

Value

string

Initial field value.

Width [Required]

String

Field width in pixels.

Height [Required]

String

Field height in pixels.

XOffset

String

Field Offset from x position in pixels.

YOffset

String

Field Offset from Y position in pixels.

User [Required]

String

Field owner.


   Instance returned from AddSigniflowWorkflowUser.

Result [Out]

WorkflowUserField

Resulting field instance.

   

InitiateSigniflowProcess

Start a signature signing process using the specified process object.

   


You must use the LogonToSigniflow activity before initiating the signing process.

   

Configuration:

ParameterData TypeDescription

AuthenticatedClient [Required]

ISigniflowAuthenticatedClient

Authenticated client returned from LogonToSigniflow workflow activity.

DisplayName

String

Workflow activity display name.

SignatureProcess [Required]

FullWorkflowRequest

Defined SigniFlow process object.

Result [Out]

Integer

Document ID returned from the initiated process.

    

GetSigniflowDocumentStatus

Retrieves the document status for a given workflow.

   

Configuration Settings:

ParameterData TypeDescription

AuthenticatedClient [Required]

ISigniflowAuthenticatedClient

Authenticated client returned from LogonToSigniflow workflow activity.

DisplayName

String

Workflow activity display name.

DocumentId [Required]

Integer

Document ID returned from the InitiateSigniflowProcess activity.

Result [Out]

Integer

The document status.

   

GetSigniflowDocument

Retrieves the document for a given workflow.

   

Configuration Settings:

ParameterData TypeDescription

AuthenticatedClient [Required]

ISigniflowAuthenticatedClient

Authenticated client returned from LogonToSigniflow workflow activity.

DisplayName

String

Workflow activity display name.

DocumentId [Required]

Integer

Document ID returned from the InitiateSigniflowProcess activity.

Document [Out]StringBase64 encoded document.
DocumentExtension [Out]StringDocument extension name.
DocumentName [Out]StringThe document filename.
Error [Out]StringAPI Error code or message.

Result [Out]

String

Base64 encoded document.

   

DeleteSigniflowDocument

Removes a document.

   

Configuration:

ParameterData TypeDescription

AuthenticatedClient [Required]

ISigniflowAuthenticatedClient

Authenticated client returned from LogonToSigniflow workflow activity.

DisplayName

String

Workflow activity display name.

DocumentId [Required]

Integer

Document ID returned from the InitiateSigniflowProcess activity.

Result [Out]

String

Status of the delete operation.

   

CreateSigniflowGatewayAdditionalDataContext

Prepares the SigniFlow ADF (Additional Data Field) that is sent when initiating a workflow. This binds the callback/webhook context to a given endpoint that is registered on the DocFusion Signature Gateway. 

By creating the ADF context, webhook notifications can be filtered to notify specific endpoints when events occur, such as Document Signed, Completed, Added, Cancelled etc. The result is used by the CreateSigniflowWorkflow activity.

   

   

Configuration:

ParameterData TypeDescription

CallbackContext [Required]

String

Callback context key provided by the DocFusion Signature Gateway when registering the client.

DisplayName

String

Workflow activity display name.

SystemReference [Required]

String

System filter.

TransactionReference[Required]StringTransaction reference, such as a record ID from a source system.

Result [Out]

String

ADF to be used.

   

References