Signature Component

Give users the ability to use e-sign as a way to capture an approval for a record .

Updated over a week ago

The Signature component will capture an approval for any type of record within Method, for example, an estimate or a work order.

NOTE: The validity of a legal e-signature captured by this component is dependent on your locale and country. It is up to you and your legal council to determine whether or not you can deem them a legal signature.


Accessing values of the Signature Component

When a user has entered in their name, the signature component will retain:

  • IP Address

  • Signed DateTime

  • Signed Name

  • Signature URL: This will be a URL link to an image of the signature

  • Screen Capture URL: This is a URL link to screenshot of the Method screen with the signed signature component

If you need these values, you can assign them to an action result, but note the values are stored in their own section of the dropdown called Signature Component, below the Session values.

Example:

The below image shows an Assign Value to Action Result action. In order to access the values for for the signature component, you need to scroll to the bottom of the dropdown.


Signature Component Notes

A few things to keep in mind for the signature component:

  • Only one signature component per screen: A signature component cannot be duplicated and once on the screen, you cannot add another.

  • Data is captured by a Save All action: This is usually done in the components Accept even.

  • Data captured is attached to the record: Once the signature has been captured, it will be attached to the record. If the signature component is on a Method screen, it will display the captured signature if the Screen Active Record ID is set.

  • An image of the captured signature is created: When the signature component is showing a captured signature, a user can click on it to show an image of the entire screen with the captured signature.

  • Once a signature is captured, it is permanent: Users will need to create a new document (estimate, invoice, work order) if they need to "re-capture" a new signature.


How the Signature Component Works

There are two states to the Signature Component: unsigned and signed.

Signature Component is Unsigned

When viewed on the screen, the user is presented with a clickable area where they can Add a signature.

When this is clicked, a new pop-up appears:

The user can type in their signature, as shown above, or they can select the Draw tab at the top and then draw in their signature as shown below.

Accepting the signature closes the pop-up, and the user can accept it or cancel. If they need to make changes, they can also Edit the signature.

Signature Component is Signed

Once signed, it is permanent and attached to the current record it was signed on. By clicking View signed document, you will be able to view a PDF of a screenshot of the screen it was signed on.


Signature Component Properties

As shown above, there are two states to the Signature Component: signed and unsigned.


Settings

  • Caption: The text used to caption the control.

  • Hide Caption: Hide the caption so it doesn't show on the Method screen.

  • Load State: The initial state when the screen loads.

  • Placeholder: This is sample text to help prompt the user on the input (e.g. “type your name here”).

  • Accept Button Text: The text used for the Accept button.

  • Cancel Button Text: The text used for the Cancel button.

  • Hide Cancel: Check this to hide the Cancel button.

Validation Rules

You can create validation rules to restrict a user's input. For more information, please see our article "Field Validation." Available for the Signature Component are:

  • Field Is Required

    Validate that a field has been populated.

  • Field Contains a Valid Email Address

    Validate that a field contains a valid email address. Multiple addresses may be separated by a comma.

  • Field Maximum Length

    Validate that a field does not exceed a certain number of characters.

  • Field Minimum Length

    Validate that a field is at least a certain number of characters.

  • Field Contains No Malicious Values

    Validate that a field does not contain malicious values.

Style

There are no style properties for this control.

Actions / Events

The signature component has unique events that trigger based on how the user interacts with it.

  • Accept - Triggered when the user clicks the Accept button. Normally, this will be a Save All action.

  • Cancel - Triggered when the user clicks the Cancel button.

Did this answer your question?