DocuSign - Add Document step

Use the Add Document step to add a document to a DocuSign envelope. The envelope is sent for signature using the Send Envelope step.

Knowledge of how DocuSign works is required to use the DocuSign integration provided by K2. You may learn more about DocuSign from the DocuSign website at https://www.docusign.com.

You can, for example, use the Add Document step in an Employee Onboarding workflow, as part of an Employee Onboarding type scenario. The first step would be for a candidate to sign a contract of employment. To do this in the workflow, you first need to use the Create Envelope step to create the envelope, and then add the document to be signed to the envelope.

Drag the Add Document step from the DocuSign category, Favorites bar, or the Recent category onto the canvas.

Example of an Add Document step in a workflow

How to add an Add Document step

From the Toolbox click the DocuSign category, the Document category and then drag the Add Document step onto the canvas.

Error Console

Select the added step and click the expand / collapse toggle to expand the Configuration Panel. You can also double click the step to expand the panel.
Select the Add Document tab. Use this tab to configure the DocuSign service instance, envelope ID, document, and the return property mappings.

The following table explains the options available on this tab:

Option	Explanation	How to Use
DocuSign Service	This is the service instance you registered to integrate with K2. You can register multiple service instances when needed, but only one is required. In the case where you have multiple service instances, and you have templates in another service instance, make sure the templates created in DocuSign are shared if you need them available for all service instances.	Select the service instance from the menu.
Envelope ID	The Envelope ID is a common identifier required to perform the functions for this step. It is returned after creating a new envelope. You can store the envelope ID in a variable and use it within this step to retrieve the unique envelope ID corresponding to the workflow instance.	Type values or create dynamic values by dragging Functions, Fields, SmartObjects and Workflow-related items from the Context Browser into the fields. When a SmartObject Load method property is used, an input property is required for the correct data to load.
Document: File	Allows you to specify the location of the document you want to add to the envelope. Using an Item Reference, variable, inline function, or SmartObject to specify this value.	Type values or create dynamic values by dragging Functions, Fields, SmartObjects and Workflow-related items from the Context Browser into the fields. When a SmartObject Load method property is used, an input property is required for the correct data to load.
Optional Settings
Document ID	Allows you to specify the ID for the document to be added to an envelope using a non-negative, whole number. The value must be sequential in nature. Note: If a value of 1 is specified and another document with the same ID exist in the same envelope, the document is overwritten. If this value is not specified, the step specifies a value sequentially at runtime.	Type values or create dynamic values by dragging Functions, Fields, SmartObjects and Workflow-related items from the Context Browser into the fields. When a SmartObject Load method property is used, an input property is required for the correct data to load.
Order	Use this field in the case where multiple documents are added to an envelope. Specify the order in which the document is added using a numerical value. If this value is not specified, the step specifies a value sequentially at runtime.	Type values or create dynamic values by dragging Functions, Fields, SmartObjects and Workflow-related items from the Context Browser into the fields. When a SmartObject Load method property is used, an input property is required for the correct data to load.
Return Property Mappings	Return properties listed here are mapped to variables. This allows you to make use of these values in other steps in the workflow. Create a field and drag it from the Context Browser to the return property. The value of this property is stored in the variable for each workflow instance.	Select properties and supply return values. Type values or create dynamic values by dragging Functions, Fields, SmartObjects and Workflow-related items from the Context Browser into the fields. When a SmartObject Load method property is used, an input property is required for the correct data to load. Click Add to add additional property fields.

From the DocuSign Service menu, select the service instance. Add the Envelope ID and type a value, use inline functions, or use dynamic fields by clicking the expand or collapse toggle to expand the Context Browser. Within the Context Browser, select inline functions from the Functions, Fields, SmartObjects or the Workflow categories to define your function. Click and drag the function on to the field.
Specify the document source. This can be a reference, inline function, or SmartObject.
In the Optional Setting section, specify the ID for the document to be added to the envelope.
Specify the order in which to add the document.
Configure the Return Properties Mappings. Click Add (+) to add properties. Select a value from the property menu.
To add additional properties, click Add.
To delete properties, select them and click the Trash bin.
With the step selected, select the Properties tab.

The following table explains the options available on this tab:

Option	Explanation	How to Use
Title / Name	By default, each step on the canvas has a step title. You can change this title to suit your workflow logic and show it on the canvas by checking the Show Label box.	Enter a value into the Title/Name field.
Reset link	Use the link to reset any changes to the title.	Click the Reset link to reset the Title/Name field to default value.
Show Label	Allows you to see the step label on the canvas. The label shows the value of the title.	Check the check box to display step label on the canvas.
Description	Allows you to add a detailed description for the step.	Enter a value into the Create New field.
Notes	Allows you to add additional notes for the step.	Enter a value into the Notes field.

Click the Errors tab.

Different types of exceptions can occur on a step, such as:

Type	Description
Known exceptions	Any SmartWizard or standard wizard that has Boolean options for handling known exceptions have these options displayed as check boxes in the Known exceptions section of the Exceptions tab.
Unhandled exceptions	Any unknown runtime exceptions.

The tab contains the following known exceptions:

Exception	Explanation	How to Use
Continue on error	On step execution and an error occurs, continue to the next step in the workflow.	Check the check box to continue if an error occurs. Uncheck the check box to stop workflow execution if an error occurs.

The tab contains the following unhandled exceptions:

Exception	Explanation
Log Exception	Logs the exception to the error log.
Force error when required SmartObject inputs are missing	Will forcefully throw an error if a SmartObject method has input missing.
Continue on error	Will force the workflow to continue running the SmartObject method, even if it runs into an error.

The exceptions in the table above is an example of those available in Workflow steps. The exceptions available depend on the Workflow step used in the design canvas.

Your changes are automatically saved.