Signature Component (a!signatureField)

Inputs

Signature Component

Function

a!signatureField( label, labelPosition, instructions, helpTooltip, target, fileName, fileDescription, value, saveInto, required, requiredMessage, buttonStyle, buttonSize, readOnly, disabled, validationGroup, accessibilityText, showWhen )

Allows users to capture and save a .png signature file. You can only enable signature on start and task forms. The signature field cannot upload multiple signature captures or a pre-existing signature file.

Parameters

Name	Keyword	Types	Description
Label	`label`	Text	Text to display as the field label.
Label Position	`labelPosition`	Text	Determines where the label appears. Valid values: `"ABOVE"` (default) Displays the label above the component. `"ADJACENT"` Displays the label to the left of the component. `"COLLAPSED"` Hides the label. The label will still be read by screen readers; see accessibility considerations for more information. `"JUSTIFIED"` Aligns the label alongside the component starting at the edge of the page
Instructions	`instructions`	Text	Supplemental text about this field.
Help Tooltip	`helpTooltip`	Text	Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is `"COLLAPSED"`.
Target Folder	`target`	Document or Folder	Determines the eventual location of the saved signature file.
File Name	`fileName`	Text	Determines the name for the signature file. When not provided, the timestamp will be used.
File Description	`fileDescription`	Text	Determines the description for the signature file. When not provided, the description of the new file is empty.
Display Value	`value`	Document	The signature file associated with this field.
Save Input To	`saveInto`	Save	Variable that is updated with the signature file when the user saves a signature. Removing a signature file removes the document and saves a null. Use `a!save()` to save a modified or alternative value to a variable.
Required	`required`	Boolean	Determines if a value is required to submit the form. Default: false.
Required Message	`requiredMessage`	Text	Custom message to display when the value of the field is required but not provided.
Button Style	`buttonStyle`	Text	Determines the style of the signature button. Valid values: `"PRIMARY"`, `"SECONDARY"` (default), `"STANDARD"`, `"LINK"`.
Button Size	`buttonSize`	Text	Determines the size of the signature button. Valid values: `"SMALL"` (default), `"STANDARD"`, `"LARGE"`.
Read-only	`readOnly`	Boolean	Determines if the field should display as not editable. Default: false.
Disabled	`disabled`	Boolean	Determines if the field should display as potentially editable but grayed out. When a signature is present in this state, it may not be deleted. Default: false.
Validation Group	`validationGroup`	Text	When present, the requiredness of the field is only evaluated when a button in the same validation group is pressed. The value for this parameter cannot contain spaces. For example, `“validation group”` is not a valid value. You need to add an underscore between words: `“validation_group”`. See the following recipes for more information: Configure Buttons with Conditional Requiredness Validation Groups for Buttons with Multiple Validation Rules'
Accessibility Text	`accessibilityText`	Text	Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
Visibility	`showWhen`	Boolean	Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.

Usage considerations

File names & disabled signature components

By default, the signature file uses the time stamp of when the signature was captured as a file name. You can define a custom file name in the fileName parameter. Check out the provided example to see a custom file name in use.
If any of the following characters appear in a signature's file name, they are replaced by underscores: \, /, ", ;, :, |, ?, ', <, >, or *.
If the signature component is included in a record view or report, the field will be disabled.

File & target folder access

Any user submitting a form containing a signature must have at least author access to the target folder or document.
Any issue with creating or updating the target folder or document will cancel the signature submission and display an error.
Between uploading a signature file and submitting a form, the signature file is an inactive temporary document and not accessible.

Saving & canceling task forms with signatures

Task forms with one or more signature components can only be saved as a draft if there is no signature file uploaded.
Uploaded signature files on forms that have never been submitted will be deleted after 30 days.
When you cancel submitting a form, the uploaded signature file will be moved to its target folder or document. If you don't want the file to be saved, revert it to a new version using a process.

Example

Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.

Employee signature field

a!localVariables(
  local!signature,
  a!signatureField(
    label: "Employee Signature",
    labelPosition: "ABOVE",
    fileName: loggedInUser() & "_signature_" & today(),
    fileDescription: loggedInUser() & "'s signature on" & today(),
    value: local!signature,
    saveInto: local!signature
  )
)

Displays the following:

screenshot showing the signature component with a label reading Employee Signature

Feature compatibility

The table below lists this component's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Compatible
Offline Mobile	Compatible
Sync-Time Custom Record Fields	Incompatible
Real-Time Custom Record Fields	Incompatible	Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports	Incompatible	Cannot be used to configure a process report.
Process Events	Incompatible	Cannot be used to configure a process event node, such as a start event or timer event.

Signature Component