Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Adding a Signature capture control

Updated on November 15, 2021
Applicable to Theme UI-Kit applications

You can add the Signature capture control to a cell, enabling users to capture a user signature, either through a mouse input or through a touch interaction on a mobile device. This control works when used in the context of a work object. Interacting with this control in an application occurs by displaying a field inline where a signature can be scribbled. It can take up a large portion of the screen.

You can define the minimum height and maximum width for the control. Aspect ratio is used to determine the height for the signature capture and is based on current width. The control is responsive and will automatically use 100 percent of the width when rendered on a mobile device. This control also contains the Accept and Clear actions. You can hide the default Accept and Clear actions for the control and use your own custom buttons instead - see Customizing a Signature Capture control for details.

When a user clicks Accept the entered signature is saved as an image attachment in the work object. Entering a signature and accepting it can be repeated as many times as necessary, however, only the last signature saved as an attachment is used when submitting an assignment. When a user clicks Clear, the current signature is wiped out so that a new one can be entered in the field. Multiple versions of a signature are not kept. In other words, only the last entered signature is saved as an attachment, no matter how many times you repeat this action on the same control.

You can make the Signature capture control:

  • read-only:
    • automatically, if it appears in a read-only section,
    • based on a defined expression,
    • based on a defined when rule,
  • force it to be always editable, even if it appears in a read-only section.

Refer to Customizing a Signature Capture control for details on the available presentation options.

Note: The Signature capture control is always disabled on a new harness or a portal harness.

Offline support

A user can also sign a work item using the Signature capture control while working offline if this capability has been enabled for the application. This includes adding a signature for work objects that were also created offline. Furthermore, previews of signatures entered while online are available when you are back offline. You can view the attachment of an offline signature in desktop after the next synchronization has taken place.

The thickness of the signature varies depending on the speed at which it is entered by the user in the application. An entered signature is automatically cleared when the control is resized - for instance, when changing the orientation of a device. This is a known limitation.

To show a captured signature once the object is resolved, for instance, in the Review harness, follow the steps listed in Packaging a signature after the work object is resolved.

Note: Using the Signature capture control is also supported for cases that were created in offline mode.
  1. On the Design tab, from the Data capture list, drag Signature capture onto the work area.
    If you are using a cell-based layout and you drag the control into a cell that is not empty, then the dropped control replaces the current contents of the cell.
  2. Click the View properties icon to display the Cell Properties dialog.
  3. On the Cell Properties dialog, customize the Signature capture control using the tabs described in the table in Customizing a Signature Capture control.
  • Customizing a Signature capture control

    The Cell Properties dialog for the Signature capture control consists of the following tabs. You can create or modify CSS base styles for the control and create custom Accept / Clear buttons, as described in the subsequent sections, below. See also Adding a Signature Capture control.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us