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 - Create Tab in Document step

Use the Create Tab in Document step when you need a DocuSign tab (a signature indicator) in the document.

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 Create Tab in Document step to create a tab in the document to indicate signers where to sign. Drag the Create Tab in Document step from the DocuSign category, Favorites bar, or the Recent category onto the canvas.

Example of a Create Tab in Document step in a workflow

How to add a Create Tab in Document step

From the Toolbox click the DocuSign category, the Document category and then drag the Create Tab in 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 Create Tab tab. Use this tab to configure the DocuSign service instance, envelope ID, recipient ID, document ID, tab details, tab position, 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	Allows you to specify the ID of the envelope containing the document to which you want to add the tab. Use a variable to retrieve this ID, such as when you've stored the envelope ID in a variable (in a previous step).	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.
Recipient ID	Allows you to specify the ID of the recipient that needs to sign the document. Use a variable to retrieve this ID, such as when you've stored the recipient ID in a variable (in a previous step).	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 ID	Allows you to specify the ID of the document the tab is added to. Use a variable to retrieve this ID, such as when you've stored the document ID in a variable (in a previous step).	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.
Tab Details
Label	Allows you to specify the tab name that shows when added to the document.	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.
Type	Allows you to select the type of tab to add to the document. The following types are typically available: • Name • Approve • Checkbox • Company • Date • DateSigned • Decline • Email • EmailAddress • FirstName • FullName • InitialHere • LastName • Note • Number • SignerAttachment • SignHere • SSN • Text • Title • Zip	Select the tab type from the menu.
Tab Positioning
Anchored	Allows you to specify an anchored position for the tab in the document. This option is selected by default.	Select the Anchored radio button.
Anchor String	Allows you to specify the anchor text for placing the tab in the document.	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.
X Offset	Allows you to specify the X offset for the tab location, where it's offset from the anchor string. Allows you to move the tab to the right.	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.
Y Offset	Allows you to specify the Y offset for the tab location, where it's offset from the anchor string. Allows you to move the tab to down the page.	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.
Units	Allows you to specify the units of the offset values. Pixels is the default, but units can be pixels, mms, cms, or inches.	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.
Ignore anchor if not present	Allows you to ignore the anchor values if the anchor can't be found in the document.	N/A
Absolute	Allows you to use absolute positioning values to create the tab on a specific page in the document.	Select the Absolute radio button.
Page Number	Allows you to specify the page number where the tab is added in the document.	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.
X Position	Use this to set the X position in pixels	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.
Y Position	Use this to set the Y position in pixels	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	Use the listed optional setting values and map them to variables. Mapping these optional properties allows you to make use of these values in other steps in this workflow. Create a field and dragged it from the Context Browser to the return property. The value of this property is stored in the variable at runtime. Use this variable in other DocuSign steps to specify the specific property value, where required. For more information on Optional Settings, please refer to the DocuSign Optional Attributes help content.	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.
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.
In the Recipient section add the Recipient ID. Type values or create dynamic values by dragging Functions, Fields, SmartObjects and Workflow-related items from the Context Browser into the fields.
In the Document section, add the Document ID. Type values or create dynamic values by dragging Functions, Fields, SmartObjects and Workflow-related items from the Context Browser into the fields.
In the Tab Details section, specify the tab appearance by adding a Label. Type values or create dynamic values by dragging Functions, Fields, SmartObjects and Workflow-related items from the Context Browser into the fields. Select the tab type from the Type menu.
In the Tab Positioning section, specify where on the document the tab shows. Add the Anchor String, X Offset, Y Offset and Units. Check the check box if you want to ignore the anchor values.
Select the Absolute radio button to create a tab on a specific page in the document. Add the Page Number, X Position and Y Position.
Configure the Optional Settings. These settings are not required but it may be useful to configure them. Click Add to add properties. Type values or create dynamic values by dragging Functions, Fields, SmartObjects and Workflow-related items from the Context Browser into the fields.

Optional Settings

DocuSign Optional Attributes

To add additional properties, click Add.
To delete properties, select them and click the Trash bin.
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.