Creating a Transaction from a Template

To download the full code sample see our Code Share site.

Templates and Layouts fulfill the same goal of automating the e-signature process by shortening the time it takes to send documents that include several signature blocks and data fields. Templates are ideal to use at the transaction level – you can pre-define your signers, documents, signature locations and e-signature workflows to streamline the e-signature process. A Layout on the other hand, is a type of template that allows you to create pre-defined locations for your signature blocks and data fields within a document. It acts like a ‘marker’ where signature blocks and data fields will sit in the document. Layouts are helpful for users who frequently send forms that may be slightly different per recipient but signature blocks and data fields remain in the same location throughout the document. What’s more, you can use multiple Layouts per document, and apply them to individual pages within your transaction.

This topic explains how to create a transaction using an existing template. If you haven't yet created a template, see Creating a Template.

To begin, retrieve the Template ID of the template that you want to use for your transaction. Your Template ID can be found by browsing to the template in the UI and looking in the address bar, or by using the OneSpan Sign client.

Once you have retrieved your Template ID you can create a new PackageID. The following code will do this:

PackageId templateId = new PackageId("ncE7Lf7h9EMvqEm7FMayLvJTJ68=");

Then, create your DocumentPackage object with any parameters you wish to update, as shown in the sample code below. Any parameter that is not specified in the DocumentPackage object will use the parameters in the template. In this example, signature placeholders are replaced with a signer.

Finally, use the OneSpan Sign TemplateService to create your transaction from your template.

DocumentPackage newPackage = PackageBuilder.newPackageNamed(PACKAGE_NAME)
    .describedAs(PACKAGE_DESCRIPTION)
    .withEmailMessage(PACKAGE_EMAIL_MESSAGE)
    .withSigner(SignerBuilder.newSignerWithEmail(email2)
        .withFirstName(PACKAGE_SIGNER_FIRST)
        .withLastName(PACKAGE_SIGNER_LAST)
        .replacing(new Placeholder(PLACEHOLDER_ID)))
    .build();

PackageId packageId = eslClient.getTemplateService().createPackageFromTemplate(templateId, newPackage);

Results

After running your code, you will see your newly created transaction on the OneSpan Sign Drafts page.

To download the full code sample see our Code Share site.

Templates and Layouts fulfill the same goal of automating the e-signature process by shortening the time it takes to send documents that include several signature blocks and data fields. Templates are ideal to use at the transaction level – you can pre-define your signers, documents, signature locations and e-signature workflows to streamline the e-signature process. A Layout on the other hand, is a type of template that allows you to create pre-defined locations for your signature blocks and data fields within a document. It acts like a ‘marker’ where signature blocks and data fields will sit in the document. Layouts are helpful for users who frequently send forms that may be slightly different per recipient but signature blocks and data fields remain in the same location throughout the document. What’s more, you can use multiple Layouts per document, and apply them to individual pages within your transaction.

This topic explains how to create a transaction using an existing template. If you haven't yet created a template, see Creating a Template.

To begin, retrieve the Template ID of the template that you want to use for your transaction. Your Template ID can be found by browsing to the template in the UI and looking in the address bar, or by using the OneSpan Sign client.

Once you have retrieved your Template ID you can create a new PackageID. The following code will do this:

PackageId templateId = new PackageId("ncE7Lf7h9EMvqEm7FMayLvJTJ68=");

Then, create your DocumentPackage object with any parameters you wish to update, as shown in the sample code below. Any parameter that is not specified in the DocumentPackage object will use the parameters in the template. In this example, signature placeholders are replaced with a signer.

Finally, use the OneSpan Sign TemplateService to create your transaction from your template.

DocumentPackage newPackage = PackageBuilder.NewPackageNamed(PackageName)
    .DescribedAs(PACKAGE_DESCRIPTION)
    .WithEmailMessage(PACKAGE_EMAIL_MESSAGE)
    .WithSigner(SignerBuilder.NewSignerWithEmail(email2)
        .WithFirstName(PACKAGE_SIGNER_FIRST)
        .WithLastName(PACKAGE_SIGNER_LAST)
        .Replacing(new Placeholder(PLACEHOLDER_ID)))
    .Build();

packageId = eslClient.CreatePackageFromTemplate(templateId, newPackage);

Results

After running your code, you will see your newly created transaction on the OneSpan Sign Drafts page.

To download the full code sample see our Code Share site.

Templates and Layouts fulfill the same goal of automating the e-signature process by shortening the time it takes to send documents that include several signature blocks and data fields. Templates are ideal to use at the transaction level – you can pre-define your signers, documents, signature locations and e-signature workflows to streamline the e-signature process. A Layout on the other hand, is a type of template that allows you to create pre-defined locations for your signature blocks and data fields within a document. It acts like a ‘marker’ where signature blocks and data fields will sit in the document. Layouts are helpful for users who frequently send forms that may be slightly different per recipient but signature blocks and data fields remain in the same location throughout the document. What’s more, you can use multiple Layouts per document, and apply them to individual pages within your transaction.

This topic explains how to create a transaction using an existing template. If you haven't yet created a template, see Creating a Template.

To begin, retrieve the Template ID of the template that you want to use for your transaction. Your Template ID can be found by browsing to the template in the UI and looking in the address bar, or by using the OneSpan Sign client.

Once you have retrieved your Template ID you can create a new PackageID. Create your DocumentPackage object with any parameters you wish to update, as shown in the sample code below. Any parameter that is not specified in the DocumentPackage object will use the parameters in the template. In this example, signature placeholders are replaced with a signer.

ESignLiveAPIObjects.Package_x pkg = new ESignLiveAPIObjects.Package_x();

// Set basic package info
pkg.name = 'Create Package From Template - ' + Datetime.now().format();
pkg.description = 'This is a package created from template.';
pkg.emailMessage = 'This is an email message.';

// Build actual Role in replacement of placeholder
String placeholder1Id = 'placeholder1';
ESignLiveAPIObjects.Role role1 = new ESignLiveAPIObjects.Role();
ESignLiveAPIObjects.Signer signer1 = new ESignLiveAPIObjects.Signer();

signer1.firstName = 'signer1_firstname';
signer1.lastName = 'signer1_lastname';
signer1.email = 'signer1@mailiantor.com';
signer1.id = placeholder1Id;

role1.signers = new List<ESignLiveAPIObjects.Signer>{signer1};
role1.id = placeholder1Id;

// Use role id to match placeholder
pkg.roles = new List<ESignLiveAPIObjects.Role>{role1};
pkg = sdk.helper.createPackageFromTemplate(pkg, 'E-_tmDsICwCkM2vqFuzVxF7NVQQ=');

System.debug('Package id: ' + pkg.id);

Results

After running your code, you will see your newly created transaction on the OneSpan Sign Drafts page.