We're updating some of our product names. K2 Five will soon be Automation On-Prem. You may see both product names in our help pages while we make this change.

DocuSign - Move Envelope to Folder step

Use the Move Envelope to Folder step to move a previously-created envelope to a specific folder in DocuSign.

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.

Similar envelopes can be stored in a DocuSign folder. You can use the Move Envelope to Folder step to move an envelope to a folder after the envelope was sent and the document signed. For example, you have all employees sign contracts that, when completed, are moved to a folder in DocuSign called Signed Employee Contracts.

Drag the Move Envelope to Folder step from the DocuSign category, Favorites bar, or the Recent category onto the canvas.

Example of a Move Envelope to Folder step in a workflow

How to add a Move Envelope to Folder step

From the Toolbox click the DocuSign category, the Envelope category and then drag the Move Envelope to Folder 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 Move Envelope to Folder tab. Use this tab to configure the DocuSign service instance, envelope ID, folder, and the return property mappings.

The following table explains the options available on this tab:

Option	Explanation	How to Use
Envelope
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 that is required to perform the functions for this step at runtime. The Envelope ID is returned creating a new envelope or is retrieved by executing the List method of the envelope service object. It is recommended that you store the Envelope ID in a variable and use it within the step to retrieve the correct Envelope ID. Use this variable in any of the DocuSign steps, in the same workflow, where the Envelope ID is required.	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.
Folder	Allows you to choose from the available folders. The default DocuSign folder is also included and any custom folders you've created in DocuSign. Select the folder you want to move the envelope to from the menu. The custom folders listed are based on the user information used when the service instance was registered. This means that if the service instance was registered for DocuSign User A, only folders created by User A in DocuSign are listed in the menu. If you have multiple users or identities in DocuSign, you may need to create separate service instances for each.	Select a folder from the menu.
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. Select a folder where the envelope is moved to from the Folder menu.
This section is optional. 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 Newfield.
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	If an error occurs when the step executes at runtime, this configuration specifies whether to continue to the next step in the workflow, or not.	Check the check box to continue the workflow even if an error occurs in the step. Uncheck the check box to stop workflow execution if an error occurs. In this case, the workflow will go into an Error state and an administrator will need to Retry the error before the workflow will resume.

The tab contains the following unhandled exception:

Exception	Explanation	How to Use
Log Exception	Logs the exception to the error log.	Check the box to log the exception.

Your changes are automatically saved.