Updating Data via Field Mappings

A Field Mapping is an object that enables the following features:

  • Insert — This feature copies a value of a Salesforce field (e.g., Street Address) into a corresponding field of a OneSpan Sign document when a package is being prepared. That data can then be retrieved from the signed document. The data in question can be either data about a recipient, or data about a Salesforce "related object".

    The relevant OneSpan Sign field must exist before you can insert a Salesforce value into it. You can create the required OneSpan Sign field by using a Text Tag.

  • Writeback — This feature copies a value of a OneSpan Sign field (e.g., Street Address) into a corresponding Salesforce field. Using it, data entered by recipients during the Signing Ceremony can be written back into Salesforce fields, based on Field Mappings defined when the package is completed.
  • The Writeback feature is disabled by default.

The rest of this section describes:

Inserting Salesforce Recipient Data into OneSpan Sign Fields

The following procedure illustrates how to insert into OneSpan Sign documents Salesforce data from a recipient's record (e.g., data about a Salesforce user, contact, or lead).

In particular, it describes how to insert into a OneSpan Sign package the address of a Salesforce contact who is also a recipient.

To insert a Salesforce contact’s address into a OneSpan Sign package:

Creating a Convention

  1. Click the Conventions tab.
  2. Click New.
  3. Enter a name for the new Convention, and click Save.

Creating a Field Mapping

  1. On the Field Mapping related list, click New Field Mapping, and give a name to the mapping.
  2. In the Mapping Type drop-down list, select Recipient.
  3. In the OneSpan Sign Document Field Reference section, give the OneSpan Sign field name.
  4. In the Salesforce Object Field Reference section, click Add new.
  5. Choose the desired object. In this case, the object is Contact. A list of the contact’s fields appears on the right.
  6. Choose the field to be mapped to a OneSpan Sign field (e.g., the contact's City), and then click Add.
  7. Ensure that the Insert option is checked when the field is added. This will enable the system to insert data from the Salesforce object’s field into the OneSpan Sign documents.

  8. Click Save to save the Field Mapping.
  9. Repeat Steps 4-10 to create a new Field Mapping for each address field (City, Zip Code, etc.).

Creating a Transaction and Inserting Salesforce Data into It

  1. Create a OneSpan Sign package (giving it a name), and then click the Advanced Options tab.
  2. On the OneSpan Sign Convention section, click Lookup and choose the Convention created above.
  3. Click the Details tab.
  4. From the Related object type drop-down menu, choose Account (if it is not already selected).
  5. Add documents to the package, and add the contact as a recipient.
  6. Click Prepare. The Designer appears in a dialog box.
  7. Add a Signature Block for the contact.
  8. To display more options, click the gear icon on the right side of the Signature Block. Then click the + sign to add fields. The list of available fields appears.
  9. Click text field to add a text field.
  10. To display more options, click the gear icon on the right side of the text field. Then click Settings to see the field settings.
  11. Give a name to the Convention Field Names, which are displayed on the left side of the Designer. Then click Save.
  12. Repeat Steps 19-22 for each of the Convention's fields.
  13. When finished, close the overlay and click Send.
  14. The package will be sent. When the package is complete, its signed documents should contain the contact's address. Thanks to this procedure, that address in OneSpan Sign documents will have been inserted directly from Salesforce.

Inserting Salesforce Related-Object Data into OneSpan Sign Fields

The following procedure illustrates how to insert into OneSpan Sign documents Salesforce data from a record linked to a OneSpan Sign package object.

In particular, it describes how to insert an address from an Account record into a OneSpan Sign package.

To insert a Salesforce Account’s address into a OneSpan Sign package:

Creating a Convention

  1. Click the Conventions tab.
  2. Click New.
  3. Enter a name for the new Convention, and then click Save.

Creating a Field Mapping

  1. On the Field Mapping related list, click New Field Mapping, and give a name to the mapping.
  2. In the Mapping Type drop-down list, select Related object.
  3. In the OneSpan Sign document field reference section, give the OneSpan Sign field name.
  4. In the Salesforce Object Field Reference section, click Add New.
  5. Choose the desired object. In this case, the object is Account. A list of the Account’s fields appears to the right.
  6. Choose the field to be mapped (e.g., the Account's City), and then click Add.
  7. Ensure that the Insert option is checked when the field is added. This will enable the system to insert data from the Salesforce object’s field into the OneSpan Sign documents.

  8. Click Save to save the Field Mapping.
  9. Repeat Steps 4-10 to create a new Field Mapping for each address field (City, Zip Code, etc.).

Creating a Transaction and Inserting Salesforce Data into It

  1. Create a OneSpan Sign package (giving it a name), and click the Advanced Options tab.
  2. On the Conventions field, click Lookup and choose the Convention created above.
  3. Click the Details tab.
  4. From the Related object type drop-down menu, choose Account (if it is not already selected).
  5. Click Lookup to choose the Account record.
  6. Add documents to the package, and add recipients to the package.
  7. Click Prepare. The Designer page appears. Add your Signature Blocks.
  8. To display more options, click the gear icon on the right side of the Signature Block. Then click the + sign to add fields.
  9. Click Settings to see the field settings. The list of available fields appears.
  10. Click Text Field to add a text field.
  11. To display more options, click the gear icon on the right side of the text field.
  12. Type the name of the desired Convention field name. These field names are displayed on the left side of the overlay. Then click Save.
  13. Repeat Steps 19-23 for each Convention field.
  14. Close the Designer. Then click Send to send the package. When the package is complete, its signed documents should contain the Account's address. With this procedure, the address will be inserted into OneSpan Sign documents directly from Salesforce.

Updating Salesforce Fields with OneSpan Sign Data (Writeback)

A Field Mapping's Writeback feature can update data in Salesforce fields from OneSpan Sign documents.

For example, suppose that: (1) a recipient notices during the Signing Ceremony that his address is wrong in a OneSpan Sign package document; (2) the recipient corrects his address in that document.

If that OneSpan Sign address is mapped to a field of a Salesforce related object, and the Writeback option has been checked for that mapping, when the OneSpan Sign package is complete, the updated address will be written into the Salesforce field.

The data to be written back into Salesforce must be entered during the Signing Ceremony.

To update a Salesforce field with data from a OneSpan Sign document when the associated package is completed:

  1. Select the Writeback option for the associated Field Mapping.
  2. When the OneSpan Sign package is complete, verify that the data updated during the Signing Ceremony appears in the associated Salesforce field.
Was this information helpful?
X