Last modified: 2023-01-28

Auto-Populating Fields

After a OneSpan Sign Convention has been defined, users who create transactions manually can use the Convention to automate certain tasks. Instead of having to perform those tasks manually, having them performed automatically saves users time.

Specifically, users can automatically:

  • Position OneSpan Sign fields in multiple documents for multiple signers via Text Tags
  • Update OneSpan Sign fields with CRM data via Field Mappings (the Insert feature)
  • Update CRM fields with OneSpan Sign data via Field Mappings(the Writeback feature)

The following sections describe how to do these things:

Updating OneSpan Sign Fields

The Insert feature copies a value of a CRM field (e.g., First Name) into a corresponding field of a OneSpan Sign document when a transaction is being prepared. That data can then be retrieved from the signed document. The data in question can be either data about a signer, or data about a CRM "related entity".

There are two ways of auto-populating OneSpan Sign documents with OneSpan Sign for Microsoft Dynamics CRM data:

Updating OneSpan Sign Fields via the User Interface

To employ the User Interface to automatically insert data from the OneSpan Sign for Microsoft Dynamics CRM database into an input field in a OneSpan Sign document:

  1. Creating a Convention.
  2. Creating a Field Mapping, and copy its OneSpan Sign Field Name into a buffer.
  3. Create a Signer Label, and under this label create two Text Tags as follows:
    1. Create a Text Tag of type Signature.
    2. Still under that label, create a second Text Tag of type Input – Text Field.
    3. Additional options appear.

    4. Paste the name copied in Step 2 into the OneSpan Sign Field Name.
    5. Save the Text Tag.
  4. The Convention automatically creates a Signature Block, and attaches input text to this block. The Convention then retrieves the data from the CRM entity's field that was defined in the Field Mapping, and inserts it in the input field.

  5. To use your new Convention, create a OneSpan Sign transaction. On the Advanced Options section, link your Convention to the transaction.
  6. Optionally, select Auto-Prepare with Text Tags.
  7. Add documents and signers to the transaction, and assign a Signer Label to each signer .
  8. If you didn't select Auto-Prepare with Text Tags above, click Prepare to prepare the transaction.
  9. When finished, click Send.
  10. The application will then: (1) create both a Signature Block and an input field attached to that block; (2) retrieve the data from the field of the OneSpan Sign for Microsoft Dynamics CRM entity defined on the Field Mapping; (3) insert that data into the input field of the OneSpan Sign document.

    At the end of this procedure, you should see all inserted OneSpan Sign for Microsoft Dynamics CRM data in the created transaction.

Updating OneSpan Sign Fields Programmatically

To use a program to automatically insert data from the OneSpan Sign for Microsoft Dynamics CRM database into an input field in a OneSpan Sign document:

  1. Write code that will: (a) create the transaction; (b) attach to the transactiona suitable Convention, suitable documents, suitable signers, etc.

    If your Convention contains Text Tags, fields will automatically be created and positioned inside OneSpan Sign documents.

  2. Add the following JavaScript code to the esl_packageParameterSettings Web resource file. Your code should resemble the following example:
  3. <Package> <autoPrepare="true"> <insert="true"> <template="my-template"> <writeBack="true"> <autoSend="true"> <inPersonSigning="true"> <reviewAfterCompletion="true"> <enforceSigningOrder="true"> </Package>

  4. Click New OneSpan Sign Transaction, or create a Custom Button (for a custom entity) that runs the code. When that button is clicked, you should see all inserted OneSpan Sign for Microsoft Dynamics CRM data in the created transaction.

Updating CRM Fields (Writeback)

A Field Mapping's Write Back feature can automatically update data in OneSpan Sign for Microsoft Dynamics CRM fields from OneSpan Sign documents.

For example, suppose that: (1) a signer notices during the Signer Experience that his address is wrong in a OneSpan Sign transaction document; (2) the signer corrects his address in that document.

If that OneSpan Sign address is mapped to a field of a OneSpan Sign for Microsoft Dynamics CRM related entity, and the Write Back option has been checked for that mapping, when the OneSpan Sign transaction is complete, the updated address is written into the OneSpan Sign for Microsoft Dynamics CRM field.

There are two ways of updating OneSpan Sign for Microsoft Dynamics CRM fields with data from OneSpan Sign documents:

For both of these methods, the data to be written back into OneSpan Sign for Microsoft Dynamics CRM must be entered during the Signer Experience.

Updating CRM Fields via the User Interface

To employ the User Interface to update a OneSpan Sign for Microsoft Dynamics CRM field with data from a OneSpan Sign document when the associated transaction is completed:

  1. Select the Write Back option for the associated Field Mapping.
  2. When the OneSpan Sign transaction is complete, verify that the data updated during the Signer Experience appears in the associated OneSpan Sign for Microsoft Dynamics CRM field.

Updating CRM Fields Programmatically

To use a program to update a CRM field with data from a OneSpan Sign document when the associated transaction is completed:

  1. Write code that will: (a) create the transaction; (b) attach to the transaction a suitable Convention, suitable documents, suitable signers, etc.
  2. If your Convention contains Text Tags, fields will automatically be created and positioned inside OneSpan Sign documents.

  3. Add the following JavaScript code to the esl_packageParameterSettings Web resource file. Your code should resemble the following example:
  4. <Package>  
            <autoPrepare="true">
            <insert="true">
            <template="my-template">
            <writeBack="true"autoSend="true">
            <inPersonSigning="true">
            <reviewAfterCompletion="true">
            <enforceSigningOrder="true">
    </Package>
    			
  5. Click the New OneSpan Sign Transaction button, or create a Custom Button (for a custom entity) that runs the code. When that button is clicked after the OneSpan Sign transaction is complete, the data that was updated during the Signer Experience will appear in the associated OneSpan Sign for Microsoft Dynamics CRM field.
Was this information helpful?
X