File output cloud storage extension workflow test

This procedure explains how to set up and execute a functional test that invokes a file output cloud storage extension from a workflow. For this test, you configure and run a workflow that displays a document for signature and writes the signed document to a cloud storage system.

The high-level steps to create and run this test are:

• Step 1. Identify or create an eSignature template
• Step 2. Create and publish the workflow
• Step 3. Execute a workflow instance

This is one of many possible approaches to setting up a workflow. For additional options, see the workflow user documentation.

Step 1. Identify or create an eSignature template

Before you create the workflow, make sure that you have an eSignature template in your account that you can use in a signing step in the workflow. The document to be signed in that step will be derived from the template. You can use an existing eSignature template in your account, or create a new template.

When selecting or creating a template:

• For a simpler workflow setup, the template should have a single recipient instead of multiple recipients.
• The recipient type must be Needs to Sign.
• Do not hard-code a recipient name or email in the template.
• Make sure that the template document includes, at minimum, a Signature tab.

See Template Requirements for additional information about templates to be used with a workflow signing step.

Step 2. Create and publish the workflow

To create a workflow that tests a file output cloud storage extension:

1. Log in to the Workflow Designer.

2. Follow the steps in Create a Basic Workflow to create and save a workflow. When creating a workflow, select Blank Workflow. Your workflow should include:

   • The workflow start method From within Workflow Builder.

   • A participant who will sign a document that will be written to cloud storage. See Workflow participant for configuration guidelines.

   • A step that defines an eSignature template containing a document to be signed. See Prepare eSignature Template step for configuration guidelines.

   • A step that displays a document for signature. See Send Documents for Signature step for configuration guidelines.

   • A step that invokes your extension app to write the signed document to cloud storage. See File output cloud storage extension step for configuration guidelines.

   • A step that displays a message confirming that all workflow steps are complete. See Show a Confirmation Screen step for configuration guidelines.

     When youʼve finished configuring the start method, workflow participant, and the steps, the workflow should appear as shown.

3. Complete the steps in Review and Publish a Workflow. Then you can execute instances of the workflow to test your extension app.

Workflow participant

Although a workflow can have multiple participants, you only need a single participant for a workflow that invokes a file output cloud storage extension. Define Workflow Participants has information about configuring a participant. The participant role name that you enter will be displayed on configuration screens for workflow steps that require selection of a participant.

Prepare eSignature Template step

The first step in your workflow should be a Prepare eSignature Template step . A procedure for adding this type of step appears in Configure a Prepare eSignature Template step.

When you add this step, configure the settings as follows:

Send Documents for Signature step

The next step in your workflow should be a Send Documents for Signature step, which generates an eSignature envelope for the workflow participant to sign. A procedure for adding this type of step appears in Configure a Send Documents for Signature Step.

When you add this step, configure the settings as follows:

File output cloud storage extension step

This step will invoke your extension app.

To add this step, display the Apps tab on the Add New Step panel and select the extension thatʼs defined in your extension app registration. The Add New Step panel displays the values from the extensions.name and extensions.description properties in the app manifest.

Note: The step for your extension will not appear in the Connected Apps list if the extension app is not installed and connected to your account.

When you configure this step, these capabilities will be invoked if they are implemented in the extension app registration:

• List Drives: Enables the step configuration page to retrieve a list of drives (or similar structures that contain folders and files) on the cloud storage system. If the app registration does not include this capability, the UI will not display the drive selection control.
• List Directory Contents: Enables the step configuration page to retrieve a list of folders from the selected drive (or similar container type) or directory. If the app registration does not include this capability, the UI will not display folder selection controls.

When you execute an instance of the workflow, this step invokes the Write File action defined in the extension app registration.

When you add this step, configure the settings as follows:

Workflow variables

When defining the naming convention for files to be written or folders to be created on the cloud storage system, you can include workflow variables in the name. Variables will be populated with values at workflow instance run time. This enables you to define a naming convention that results in a unique name for each agreement to be stored.

The types of variables available for selection include:

• Workflow step variables. For example, variables associated with the Send Documents for Signature step include the unique ID of the eSignature envelope and values from the envelope fields.
• Workflow participant variables. These are values associated with the customer who completes the steps in a workflow instance. They include the participant name and email address.
• Workflow instance variables. These are values associated with the workflow instance, such as the instance ID and the start date and time.

Show a Confirmation Screen step

The last step in your workflow should be a Show a Confirmation Screen step, which displays a message to indicate that the workflow is complete. A procedure for adding this type of step appears in Configure a Show a Confirmation Screen Step.

When you add this step, configure the settings as follows:

Step 3. Execute a workflow instance

After you’ve published your test workflow, you can execute an instance of it, run through the steps as a customer would, and make sure that the file is written to the cloud storage system successfully. You can monitor the progress of the workflow instance as it executes.

To execute a workflow instance:

1. Follow the steps in the From Within Workflow Builder section of How to Start a Workflow to execute a workflow instance.

   The document to be signed is displayed in your browser.

2. Complete the signing process.

   The file output step is executed and the confirmation page is displayed.

3. Check the cloud storage location to which the external service stores files and confirm that the file output step succeeded.

Next steps

• Find out more about functional tests.
• Review the File output cloud storage extension contract reference.
• Learn how to run integration tests.