Note: This documentation gets updated only when necessary, as the product is in sustained mode. For product updates see the Release Notes.

Void Envelope

This wizard is found in the DocuSign Event wizards node in K2 Studio and the K2 Designer for Visual Studio.

Theoretical and functional knowledge of DocuSign 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/. The documentation below assumes you are familiar with DocuSign as well as .

What does it do?

The Void Envelope wizard allows you to void an envelope that is no longer needed in a DocuSign instance.

The DocuSign Service Instance needs to be registered before using this wizard.

The Create Envelope wizard will mostly be the starting point when building a workflow containing DocuSign wizards.

How is it used?

This wizard can be used in the following type of scenarios but is not limited to these example scenarios:

When an envelope was sent to the wrong recipients
When a recipient indicates that the document is incorrect such as the amount in a contract or a specific paragraph
When a document contains invalid information in general

Specify Values

Specify the envelope to void.

Field	Description	Sample Value
DocuSign Service	This will be the Service Instance that you registered for integrating with K2. Multiple Service Instances can be registered in a scenario where a single DocuSign user wants to register his own service instance. In the case where multiple Service Instances exist and users want to make use of templates in another Service Instance, ensure that the templates created in DocuSign are shared.	Select the appropriate service instance from the drop-down list.
Envelope ID	The Envelope ID is a common identifier that is required in order to perform the functions for this wizard at runtime. The Envelope ID is returned after the creation of a new envelope or can be retrieved by executing the List method of the envelope service object. It is recommended that you store the Envelope ID in a data field and use that data field within the wizard to retrieve the correct Envelope ID. This data field can be used in any of the DocuSign wizards, where the Envelope ID is required, in the same workf	Type a value, or drag a value from the Context Browser such as a pre-configured Data Field, Item Reference or a SmartObject Load method property. Note that when a SmartObject Load method property is used, an input property is required for the correct data to load.
Void Reason	Reason for the voiding of the specified envelope. Type a value for the void reason or drag a data field or SmartObject property from the Context Browser to set the void reason.	Type a value, or drag a value from the Context Browser such as a pre-configured Data Field, Item Reference or a SmartObject Load method property. Note that when a SmartObject Load method property is used, an input property is required for the correct data to load.

Field

Description

Sample Value

DocuSign Service

This will be the Service Instance that you registered for integrating with K2. Multiple Service Instances can be registered in a scenario where a single DocuSign user wants to register his own service instance. In the case where multiple Service Instances exist and users want to make use of templates in another Service Instance, ensure that the templates created in DocuSign are shared.

Select the appropriate service instance from the drop-down list.

Envelope ID

The Envelope ID is a common identifier that is required in order to perform the functions for this wizard at runtime. The Envelope ID is returned after the creation of a new envelope or can be retrieved by executing the List method of the envelope service object. It is recommended that you store the Envelope ID in a data field and use that data field within the wizard to retrieve the correct Envelope ID. This data field can be used in any of the DocuSign wizards, where the Envelope ID is required, in the same workf

Type a value, or drag a value from the Context Browser such as a pre-configured Data Field, Item Reference or a SmartObject Load method property. Note that when a SmartObject Load method property is used, an input property is required for the correct data to load.

Void Reason

Reason for the voiding of the specified envelope.

Type a value for the void reason or drag a data field or SmartObject property from the Context Browser to set the void reason.

Specify Mappings

Specify mappings for the return properties.

Field	Description	Sample Value
Values	The return values are listed here can be mapped to a data field. Mapping these return properties allows you to make use of these values in other wizards in this workflow. Create a data field using the Context Browser and drag it to the return property. The value of this property is stored in the data field at runtime. This data field can be used in other DocuSign wizards to specify property value, where required, by dragging the data field from the Context Browser to the relevant field in the wizard.	Type a value, or drag a value from the Context Browser such as a pre-configured Data Field, Item Reference or a SmartObject Load method property. Note that when a SmartObject Load method property is used, an input property is required for the correct data to load.