Add actions to a form or control

Actions describe different ways to initiate an event. For example, you can base a customer credit score check on two different actions:

  • DB Query action that reads customer details from a database

  • .NET Method action that calculates the appropriate score

You can configure multiple actions that execute upon an event firing on a form or form control, such as a form load, button click, or selection of a table row.

For example, in a Loan Application form, you can create DB Query, Web Service, and Redirect actions on the Credit Check button so that when the button is clicked, they are executed in sequence:

  • Retrieve customer details (DB Query action)

  • Get credit score for customer (Web Service action)

  • Take the user to the next relevant form (Redirect action)

Note If an action fails, a message appears and no further actions are called. For example, if the Logon fails the user is not redirected to the Work Queue page.

The following table outlines the actions you can add to a form or form control in TotalAgility.

Action Purpose

.NET Method

Call an API for performing actions, such as creating a new job.

Add Row

Add a row to a table.

Apply Form Variant

Apply the latest version of the form variant; the state and label text defined when creating the variant is reflected at runtime.

Apply Validation

Validate the available controls on the desktop, phone and tablet forms.

Begin Condition

Begin the conditional action.

Business Rule

Use a predefined business rule.

Alternative Extraction Search

When added to a document validation form, performs an alternative extraction search in a validation activity.

Calculation Rule

Calculate a field value.

Change Stack Order

Change the stack order value or remove or move an element towards the bottom of the stack.

Clear

Clear the specified form variables and fields.

Clear Selection

Clear the selections of a table or drop-down list.

Close

Close the currently opened form or pop-up window.

Composite

Include multiple actions for use on multiple controls.

Create Entity Instance

Create entity instances on a form at runtime.

DB Query

Access a database to view, insert, update, or delete records.

Delete Row

Delete a row from a table in a form.

Display Rule

Invoke a form’s display rules and automatically change display states, based on what the user enters into the form.

Else Condition

Make form actions more flexible and easier to read. At runtime, all the actions within the Else condition are executed if the Begin condition is not met.

End Condition

End the conditional action.

File Upload

Upload a file on a form at runtime.

Find Entity

Search for entity instances within a form based on the specified search criteria.

Fuzzy Search

Find strings that closely (but not exactly) match a pattern in a "fuzzy" database, which is a single table or view exported from a relational database.

Get Entity Attributes

Retrieve the required entity instance attribute values to the controls on a form.

Hide Action Menu

Conceal a menu when a touch-enabled Phone or Tablet form is opened on a touch-enabled device.

JavaScript

Give access to the Document Object Model (DOM).

Kapow

Execute a Kapow Robot from within a form.

Print

Download and print the document on a MFP device.

Scan

Scan a document on a MFP device.

Scan Settings

View and modify the scan settings on MFP devices.

Redirect

Redirect to another form or a pop-up window.

Refesh Capture Form action

Refresh the capture forms (Scan, Verification, Validation and Document review) and capture take activity forms to prevent the job with invalid fields being completed.

Refresh Page Rendition

Refresh page renditions on a form and accordingly enables or disables rendition buttons at runtime.

Reset Form Variables

Reset the data of one or more form variables.

RESTful Service

Integrate the form with external applications.

Same Page

Retrieve the required data on the same page.

Set Device

Switch the form factor (Desktop, Phone or Tablet) between a desktop, phone or tablet form.

Set Entity Attributes

Update the required entity instance attribute values using the controls on a form.

Set Focus

Set the focus on a form control.

Set Language from Job

Set the form language to the language of the job when the page loads.

Show Message

Alert or prompt a user or request confirmation from a user.

Show Action Menu

Display an action menu from the list of multiple action menus for a touch-enabled Phone or Tablet form.

Show Navigation

Select the site navigation or consume a menu for a touch-enabled Phone or Tablet form.

Update Control

Apply the current values of properties to the control and cause the control to reload and refresh the results list.

Update Row

Update a row in a table.

Web Capture

Save the pages that are scanned or uploaded using a Web Capture control.

Web Service

Call a web service to perform a certain action.

Note The Scan action is available by default for the MFP Scan Create New Job and MFP Scan Take Activity forms.