Signature Component

Estimated Reading Time:  9 minutes

Overview

The Signature component creates a signature field for your module. In Express View Express View is how your end-user views you application. Express View also lets you preview your applications to test your configuration and view the styling. After configuring a module, click Preview in the Module Editor to interact with the module in Express View, the signature field displays as a box where end-users End-Users are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. can use their mouse to draw their signature. In the submission data, the drawn signature stores as a Base64 Base64 is an encoding and decoding technique used to convert binary data to an ASCII (American Standard for Information Interchange) text format. string.

WARNING  Do not use the Signature component for legally-binding signatures. Instead, we suggest you use third-party software like DocuSign and SignNow.

You'll find the component under the Secondary Fields group to the left of the Module Editor:

What You'll Learn

After completing this article, you’ll know when to use a Signature component and how to configure its settings.

About the Configuration Window

General

A static image displaying the Signature component's configuration window.

Setting Description

Property ID

A Property ID is the unique field ID used by Unqork to track and link components in your module.

The Property ID is how the software identifies your component. Using Property IDs lets you link components, creating logic-based configurations and API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. calls.

Property IDs must use camel case A naming convention for computer programming. Use camelCase for Property IDs, for example: newUser, lastName, & rdoButton. (stylized as camelCase) without spaces or punctuation.

Notes Note-Icon

Select this tab to display the component's Notes area. You can use notes to keep your teammates informed.

The Notes editor offers a semi-WYSIWYG (What You See is What You Get) content editor. Built to look like a word processor, this editor lets you create, edit, and format your notes. Notes save when saving the component.

Display Icon Display

Select this tab to manage your component's display settings.

Data Icon Data

Select this tab to manage your component's data settings.

Validation Icon Validation

Select this tab to manage your component's validation settings.

Advanced Icon Advanced

Select this tab to manage your component's advanced settings.

Permissions Icon Permissions

Select this tab to see the RBAC RBAC (Role-Based Access Control) is a method to control system access for authorized users. The role in RBAC refers to the levels of access employees have to a network. (role-based access control) settings of the component.

Field Tag Icon Field Tags

Assign components one-word labels to help organize, identify, and group the components in your application.

Consider an example from the API Specification Snippet: Field Tags are applied to Hidden components in the panelRequest and panelResponse Panels. The Field Tags identify the data type of parameters included in the API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. request and response. The API Docs Dashboard tool populates with information about each parameter’s data type, identified by the Field Tag.

Field Tags act as a type of Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. group and let you group components for configuration purposes. Field Tags let you target two or more components using a simple logic component.

For example, add the Field Tag tagForDecision to multiple components in your module. Open the Inputs table of a Decisions component and reference the tagForDecision Field Tag as the input of the Decisions component. The output of the Decisions component then affects all components with the tagForDecision Field Tag.

Save your Field Tags by pressing Enter (Return) or adding a comma after each entry.

Shortcuts Icon Shortcuts

Select this tab to open the list of supported keyboard shortcuts you can use in the component settings modal. Keyboard shortcuts include:

  • Cmd + S (Mac) / Ctrl + S (PC): Save and close the component settings modal.

  • Cmd + G (Mac) / Ctrl + G (PC): Opens a search window to find specific fields and settings in the component settings modal.

  • Tab: Tab to the next field or setting in the component settings modal. This keyboard shortcut tabs left to right and top to bottom.

  • Shift + Tab: Tab to the previous field or setting in the component settings modal. The keyboard shortcut tabs from right to left and bottom to top.

  • Enter (Return): When tabbing to a Tooltip Icon (tooltip), press Enter (Return) to display the field or setting tooltip. Press Enter (Return) again to hide the tooltip.

Additional keyboard shortcuts:

  • Drop-down menus: When you Tab to a settings drop-down, use the keyboard's Up-Arrow Icon (up)/ Down-Arrow icon (down) arrows to make a selection. Then, press Enter (Return) to confirm the selection.

Documentation Icon Documentation

Select this tab to access the component documentation in Unqork's In-Product Help.

Cancel

Click this button to undo any unsaved configuration changes and return to the canvas.

Save & Close

Click this button to save all settings as configured and return to the canvas.

Display Panel

A static image displaying the Signature Component's Display settings.
(click to expand image)

Field Text

Setting

Description

Footer Label

Like Label Text, a component’s Footer Label indicates the purpose of the corresponding field or component. Set under the Signature box, the Footer Label tells the end-user how to interact with the field. For example, giving the end-user instructions like "Sign above."

User-friendly labels make your module more accessible. Keep Labels short and descriptive (a word or two) using title case. For longer entries, use sentence case.

Default State Options

Setting

Description

Disable User Input

When set to Toggle On Icon (ON), end-users can’t interact with or edit the Express View's input field or element. When end-users hover over the field, their cursor changes to alert them to the status change.

By default, the Disable User Input toggle is set to Toggle Off icon (OFF).

Read Only View

When set to Toggle On Icon (ON), the component is display-only. If another component pushes content to the field, the end-user sees that content. Otherwise, end-users see the word None.

By default, the Read Only View toggle is set to Toggle Off icon (OFF).

Hide Field

Shows or hides the component from view. Setting the Hide Field toggle to Toggle On Icon (ON) hides the component in Express View. Setting the toggle to Toggle Off icon (OFF) shows the component. The component is always visible in the Module Editor.

By default, the Hide Field toggle is set to Toggle Off icon (OFF).

Formatting

Setting

Description

Set Width

Adjusts the width of the Signature box. The width value is specified in conjunction with the Width Unit type.

Width Unit

Select the type of unit for the Width value. Width Unit types include:

  • px (Pixel): Sets the signature box width to an absolute value in pixels.

The value range is 0px to 9999px.

  • % (Percentage): Sets the signature box width to a percentage of the column or page.

The value range is 0% to 100%.

By default, the width unit type is set to % (Percentage).

Set Height

This setting adjusts the height of the signature box. Set the number of pixels to apply to the box height.

Background Color

You can customize the background color of the signature box using an HTML color picker. Enter the color’s RGB code (for example, rgb (245,245,235)) in the Background Color field. Your chosen color displays in the Module Editor as well as Express View.

You can find plenty of color code resources online to help you pick the right color for your signature box.

Data Panel

A static image displaying the Signature component's Data settings.

Data Storage

Setting

Description

Store Data in Database

The Store Data in Database setting affects how data persists through your application. When set to Toggle On Icon (ON), Unqork stores values entered into the field to the database (server-side submission). This occurs in three scenarios:

  • Navigating between Panels in a Navigation component. On navigation between pages (Panels), the component’s value saves to the database.

  • Triggering a module save event using a Button component with an Action Type of Save.

  • Navigating between screens of a workflow. On navigation between screens, the component’s value saves to the database.

NOTE  By default, workflows persist data from all fields in the client-side submission when navigating between screens. However, only values from fields with Store Data in Database enabled store in the server-side submission.

Set the toggle to Toggle Off icon (OFF) when you don’t want to store the values from this field in the database.

NOTE  When using a Plug-In to remote execute a module, ensure data moving between modules is persistent. You can optionally enable Store Data in Database for components in the source module. But any components in the API module whose values are included in an API response must have Store Data in Database enabled. When a component’s data is not persistent, the data isn't included in an API call's response. So, Plug-Ins or external services requesting data from the API module can't receive non-persistent data in the response. To learn more about Store Data in Database in the context of API modules, see the panelResponse Panel section of the API Specification Snippet article in our In-Product Help.

TIP  Store Data in Database also affects what data is tracked using Unqork’s built-in tracker. When the Enable Tracker and Track Value toggles are set to Toggle On Icon (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked.

By default, this toggle is set to Toggle On Icon (ON).

Validation Panel

A static image displaying the Signature Component's Validation Settings.

User Input

Setting

Description

Required

When set to Toggle On Icon (ON), the end user must enter a value in the component's visible fields. Set the toggle to Toggle Off icon (OFF) when an entry is optional.

By default, the Required toggle is set to Toggle Off icon (OFF).

Required Error Message

A custom error message that displays below a required field. The error message displays when the end-user tries to save or submit the module without completing the required field.

Advanced Panel

The Signature component's Advanced Settings.

Additional Styling

Setting

Description

Custom CSS Class

Enter a Custom CSS Cascading Style Sheets (CSS) is a style sheet language used for presenting how a HTML or XML document looks to end-users. Class to apply to your component. Use custom CSS to maintain a consistent look and feel if the field or element is part of a template or more than one module.

Updated CSS styling applies to all components that reference this custom class name.

Adding a Signature Component

Let's configure a Signature component to provide a signature field for your end-user. We'll use a light blue color for the field background and set the component as Required. These instructions assume that you have an open module saved with a title.

1. In the Module Editor, drag and drop a Signature Icon Signature component onto your canvas.
2. In the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. field, enter sign.
3. In the Footer Label field, enter Sign above.
4. In the Background Color field, enter rgb(204,245,255). This color makes the field background light blue.

A static image displaying the Signature component's configuration window, the Footer Label and Background Color fields are highlighted.

5. From the Signature component configuration window, click the Advanced Icon Advanced tab.
6. Set Required to Toggle On Icon (ON).
7. Click Save & Close.
8. Save your module.

Preview your module in Express View Express View is how your end-user views you application. Express View also lets you preview your applications to test your configuration and view the styling. After configuring a module, click Preview in the Module Editor to interact with the module in Express View. You'll see the following functionality:

Structure of a Signature Component's Data

A signature component stores its data as key/value pair. The value contains the data type and the signature drawing in Base64 Base64 is an encoding and decoding technique used to convert binary data to an ASCII (American Standard for Information Interchange) text format. format.

A static image displaying the Developer console. The Angular Command displays the Submission Contol, the Signature component's data is displayed.

Resources