▲ Top

Auto-Preparing Transactions

The Auto-Prepare feature enables users to automatically prepare a OneSpan Sign package for sending. When Auto-Prepare is activated on a package, the Send button appears automatically on the package page. Thus the package can be sent through a single click on that button, without clicking Prepare.

The Auto-Prepare feature saves time for end-users because clicking Prepare inaugurates a time-consuming process (the Recipient page opens, documents and recipients must be added manually, etc.).

There are two ways of activating the Auto-Prepare feature:

This chapter also describes how to take automation one step further by automatically sending a package:

Auto-Preparing via the User Interface

Prerequisite

  • The relevant OneSpan Sign package must have a Convention with a Recipient Label. This in turn implies the presence of at least one of the following Text Tag types: static position, text anchor, or PDF form field.

Action

To activate the Auto-Prepare feature for a package via the User Interface:

  • On the package's Advanced Options tab, check the field Auto-prepare with text tags. The Send button should now appear on the package page.

Auto-Preparing Programmatically

Prerequisite

  • The relevant OneSpan Sign package must have a Convention with a Recipient Label. This in turn implies the presence of at least one of the following Text Tag types: static position, text anchor, or PDF form field. This in turn implies that the parameters ConventionId and RecipientNLabel must be specified.

Action

To activate the Auto-Prepare feature for a package programmatically:

  1. Write code that will: (a) create the package; (b) attach to the package a suitable Convention, suitable documents, suitable recipients, etc.
  2. Add to that code the following URL parameter: AutoPrepare=1” ORAutoPrepare=true”. Your code should resemble the following example:
  3. /apex/esl__package?ParentId={!Account.Id}&Name={!Account.Name}%20Agreement&
    			Documents=00P36000000wwrd&ConventionId=a0836000000nfRo&
    		Signer1=00336000003gBYX&Signer1Label=a0K36000001j8V&AutoPrepare=1
  4. Create a Custom button that will run that code. Once that button is clicked, the package will be created, and the Send button should appear on the package page.

Automatically Sending a Transaction

The following procedure uses a program to automatically send a package once the package has been created.

To automatically send a package once it's created:

  1. Write code that will: (a) create the package; (b) attach to the package a suitable Convention, suitable documents, suitable recipients, etc.
  2. Add to that code the following URL parameter: Send=1ORSend=true”. Your code should resemble the following example:
  3. /apex/esl__package?ParentId={!Account.Id}&Name={!Account.Name}%20Agreement&
    			Documents=00P36000000wwrd&ConventionId=a0836000000nfRo&
    		Signer1=00336000003gBYX&Signer1Label=a0K36000001j8V&Send=1
  4. Create a Custom button that will run that code. Once that button is clicked, the package will automatically be sent after it is created.