3B Sign - How To Use

From 3B Knowledge
Revision as of 04:40, 4 March 2024 by Admin (talk | contribs)
Jump to navigation Jump to search

Intro

This article is created for end-users.

Creating a Document

Site Selection component on Document

To create a new document, switch your app launcher to "3B Sign" and click on the "Documents" tab. If you can't see the tab, your user does not have the right permissions. Then, click on the "New" button and give the document a name. The name of the document will be used for the generated PDF and it is publicly visible. Do not set or update the "Submitters" field - it is managed by the builder.

3B Sign Builder Interface

Once you have created a document, you need to assign the document to a public site. Use Site Selection component to pick a site to assign to the document.

After you have assigned a site to the document, you can click on the "Builder" tab in order to open the document builder.

Adding a PDF

The builder interface (see screenshot) will allow you to upload a PDF document by either dropping it into the dropzone area or by selecting a document from the file manager if you click on the dropzone area.

Adding Submitters

A submitter is a person that will be responsible for completing the document. You can have up to 10 submitters. Each submitter is assigned a color and the fields you drop onto the document will be assigned to the currently selected submitter. The submitters count is also stored on the Document record and shouldn't be updated manually.

Selecting Core Object

If you wish to pre-populate the document from the data of a record, you need to know the record's object in advance. Select your object from the "Select Object" dropdown. One document can only ever have a single core object.

Adding Fields

To add a field onto the document, just drag and drop it from the right hand side onto the document canvas. You can then resize and re-position the field.

Field Types

There are a few different field types that you need to be aware of.

Output

This is only an output field. You can select any field on the core object to be displayed (as long as you have permission to read the field).

Function

The function field allows you to select a Function Expression. This will return the output of the Javascript code on the document

Signature

The Signature field allows a user to e-sign the document and the signature will appear where you placed the merge field.

Input Types

You can also add input fields, like Text, Number, Date, Time etc - these will request the user to provide a value for the field

Pre-populating Fields

You can request document pre-population for input field types by selecting the field from the field settings on the right hand side.

Value Formatting

You can add value formatting on the final field value before the document is printed using Value Formatters. You can assign a value formatter from the field setting on the right-hand side.

Setting Default Value

You can set a field's default value in case the field is empty in salesforce or if the field is not linked to a salesforce field, the default state.You can set default value from the field settings.

Controlling Submission Flow

The submitter will be asked to complete the fields in the order in which the fields appear on the right hand side. You can make fields required/read only from the field settings.

Saving a Document

Once you have saved a document, a file will be created against the Document record with the name "PDFConfig.3bt". This file is not human readable. You can however migrate it to other orgs, and all of the document configuration will be maintained.

Moving Documents Between Environments

To move a document from Sandbox to Production or from one org to another, you need to first migrate the Document record and all of its fields and then upload the PDFConfig.3bt files to the corresponding new records.

Signing a Document

There are a few different ways to get a document completed. Here are the supported workflows

New Submitter Record Detail

Manually Create A Submission Request

Go to the Document, click on "New" against the Submission Requests related list and save the new record. You can also assign the "Record Id" field to the Id of a record that you want the document to pre-populate with.

Then, you can add a new Submitter from the "Submitters" related list on the new Submission Request. Add as many submitters as required by the document. Ensure that each submitter is assigned with the correct "Order" number (e.g. Submitter 1 = 1). This will control which fields are visible to the submitter.

You will be given a unique link in the Submit URL that will lead the user to the signing page. This URL can be used in email alerts, sms messages and UI buttons

Auto-Create First Submitter

If you want a Submission Request and First Submitter to be created automatically, you can pass the following parameters to the b3d__Submit pate:

templateId* - this is the ID of the document that we want to load

recordId* - this is the ID of the record to be used to pre-populate the document

contactId - if provided, the new Submitter record will be auto-linked to the contact

*params are required

Use Submitter as the context

Simply add the submitterId parameter after the b3d__Submit page, and the system will automatically determine the pre-population record (from the Record Id on the related Submission Request) and the Document Template. (effectively, we will auto-select the recordId and templateId params)

Use Submission Request as the context

You can add requestId parameter after the b3d__Submit page, and the system will auto relate the recordId and templateId

Using the Preview Page

We have created a page (b3d__Preview) specially dedicated for internal users, to allow them to generate a PDF document and save it against the pre-population record.

There are two parameters required in the URL for the page to load:

templateId - the id of the Document record

recordId - the id of the pre-population record

Email Alerts

3B Sign is delivered without any email alerts, and this is intentional. The admin/developer implementing 3B Sign must create email alerts sent out to the submitters based on actions or automations. Note: to control the flow, make sure that the previous submitter has completed the document before sending it to the next one.