TotalAgility Designer Help
Welcome
Introduction
Log on to TotalAgility Designer
TotalAgility Designer basics
Home
Recent items
Edit profile
List pages
Common procedures
Lock or unlock an item
Open and modify an item
Close a dialog
Locate an item
Tag an item
Delete an item
Error handling of fields
Rule editor
Create metadata
Stop and start Kofax TotalAgility services
Common icons
Name conventions
Removed features
Log out of TotalAgility Designer
Workflow
Business processes
Process designer
Modeling bar
Action toolbar
Satellite
Process elements
Start node
Activity
Decision
Annotation
Attachment
End node
Pools and lanes
Work with process elements
Design a basic process
Add an activity
Add an activity
Activity properties
Configuration
Partial completion
Resource assignment
Assign resources manually
Assign resources by applying rules
Reuse resources
Set up a notification email
Execution
Inputs and outputs
Work queue automation
Time and cost
Service level agreement
Define the SLA status indicator
Activity triggers
Create an activity trigger
Dependents
Add dependents
Preconditions
Add preconditions
Advanced
Associate states
After processing
Associate a business event
Branching rules
Configure branching rules
Info
Activity types
Common activities
Ordinary activity
Configure an ordinary activity
Embedded process activity
Configure an Embedded process activity
.Net activity
Configure a .Net activity
.Net activity mapping parameters
Web service activity
Configure a Web service activity
Web service activity mapping parameters
Business rule activity
Configure a Business rule activity
Create subjob activity
Configure a Create subjob activity
Add a Create subjob activity with advanced workflow rules
Data access activity
Configure a Data access activity
Get records from a database table
Add records to a database table
Update records in a database table
Delete records from a database table
Get data from a database view
Get data from stored procedures of a database
Insert multiple records into a database
Synchronization activity
Configure a Synchronization activity
Expression activity
Configure an Expression activity
Math function
Text function
Date function
Create new job activity
Configure a Create new job activity
Loop activity
Configure a Loop activity
Use a Loop node to access repeating data
Email activity
Configure an Email activity
Create an inline template for email
Generative AI activity
Configure a Generative AI activity
Condition activity
Configure a Condition activity
Capture activities
Classification activity
Configure a Classification activity
Extraction activity
Configure an Extraction activity
Validation activity
Configure a Validation activity
Document review activity
Configure a Document review activity
Delete activity
Configure a Delete activity
Composite activity
Configure a Composite activity
Export activity
Configure an Export activity
PDF generation activity
Configure a PDF generation activity
Document conversion activity
Configure a Document conversion activity
Handle document conversion exceptions
Convert password-protected PDF files to TIFF
Bar code and patch code detection activity
Configure a Bar code and patch code detection activity
Image processing activity
Configure an Image processing activity
Image quality analysis activity
Configure an Image quality analysis activity
Scan activity
Configure a Scan activity
Verification Activity
Configure a Verification activity
Transfer activity
Configure a Transfer activity
Mark finished activity
Configure a Mark finished activity
OCR activity
Configure an OCR activity
Kofax activities
RPA activity
Configure an RPA activity
SignDoc activity
Configure a SignDoc activity
KCM compose activity
Configure a KCM compose activity
KCM distribute activity
Configure a KCM distribute activity
Configure the Output management distribution mechanism
KCM pack activity
Configure a KCM pack activity
ControlSuite activity
Configure a ControlSuite activity
Example - ControlSuite activity
Microsoft activities
SharePoint create site activity
Configure a SharePoint create site activity
SharePoint create folder activity
Configure a SharePoint create folder activity
SharePoint add item activity
Configure a SharePoint add item activity
SharePoint delete item activity
Configure a SharePoint delete item activity
SharePoint uploader activity
Configure a SharePoint uploader activity
SharePoint move item activity
Configure a SharePoint move item activity
SharePoint get document activity
Configure a SharePoint get document activity
Dynamics CRM activity
Create an entity instance in Dynamics CRM
Delete an entity instance from Dynamics CRM
Retrieve an entity instance details from Dynamics CRM
Update an entity instance in Dynamics CRM
Exchange server get attachments activity
Configure the Exchange server get attachments activity
CMIS activities
CMIS get document activity
Configure a CMIS get document activity
CMIS add document activity
Configure a CMIS add document activity
CMIS update document activity
Configure a CMIS update document activity
CMIS create folder activity
Configure a CMIS create folder activity
CMIS check in document activity
Configure a CMIS check in document activity
CMIS cancel checkout document activity
Configure a CMIS cancel check out activity
CMIS find document activity
Configure a CMIS find document activity
Micro Focus activities
Content Manager create folder activity
Configure Content Manager create folder activity
Content Manager add document activity
Configure the Content Manager add document activity
Content Manager get document activity
Configure a Content Manager get document activity
Script activities
Script activity
Configure a Script activity
C# activity
Configure a C# activity
VB.Net activity
Configure a VB.Net script activity
Other activities
RESTful service activity
Configure a RESTful service activity
Configure a RESTful service activity to retrieve data
Configure RESTful service activity to insert data
Configure RESTful service activity to update data
Configure RESTful service activity to delete data
Sleep activity
Configure a Sleep activity
Job owner activity
Configure a Job owner activity
Job variable activity
Configure a Job variable activity
XML activity
Configure an XML activity
Resource info activity
Configure a Resource info activity
Supporting info activity
Configure a Supporting info activity
Document creation activity
Configure a Document creation activity
Create a Placeholder in a Microsoft Word document
Ready for review activity
Configure a Ready for review activity
Complex variable activity
Configure a Complex variable activity
Manipulate repeating data within a data object variable
Data list activity
Configure a Data list activity
Design activity
Configure a Design activity
Add document to document set activity
Configure an Add document to document set activity
Custom service activity
Configure a Custom service activity
Cut, copy, and paste nodes
Add a decision
Add a decision
Decision properties
Add an annotation
Add an attachment
Add pools
Add lanes
Add an End node
Add an end node
Properties of an end node
Event types for an end node
Generate a process using Generative AI
Design a Capture process
Design a process map on the Integration Server
Process properties
General
Case completion
Capture
Time and cost
Service Level Agreement
Process triggers
Triggers
Triggers and escalation map initialization parameters
Create a process trigger
Create an alert
Access
Functional access
History, reporting and execution
Exceptions
Configure exceptions for a process
Process-level exception maps and initialization parameters
Maintenance access
Predictive model
Manage a predictive model
Default settings
Process debugging
Debug a process
Process associations
View process associations
Process documentation
Document a process
Generate the JSON payload
Clean up a process
Test plan
Create a test plan
Create a test script
Create an execution path
Add execution steps
Add assertions
Configure the test data
Execute a test plan
Work with test scripts
Work with processes
System processes
SYSTEM Active Directory synchronization
Synchronize Active Directory with TotalAgility
Split process map
Case definitions
Design a case
Create a case fragment
Work with case definitions
Business rules
Business rule types
Flow rule
Decision tree
Decision table
Work queue automation
Difference between decision table and decision tree
Business rule modeling bar
Business rule action toolbar
Create business rules
Create a flow rule
Create a decision tree
Create a decision table
Create a work queue automation rule
Properties of a business rule
Manage business data
Debug a business rule
Test a business rule
View business rule associations
Generate the JSON payload for a business rule
Work with business rules
Skins
Manage a process template
Create a skin
Manage skins
Manage skin versions
View skin associations
Custom services
Custom service modeling bar
Create a custom service
Properties of a custom service
Work with custom services
View custom service associations
Variables
Variable types
Create process variables
Create a checklist variable
Create a complex and a dynamic complex variable
Create a currency/decimal/double/float variable
Create a data backbone variable
Create a data object variable
Create a document variable
Create a date and nullable date variable
Create a folder variable
Create a JSON expression variable
Create a string and nullable string variable
Add a system variable to a process
Create a long/short/byte variable
Create an XML variable
Create an XML expression variable
Use document or folder variables
Manage process variables
States
Create a state
Milestones
Create a milestone
Milestone triggers
Create a milestone trigger
Roles
Types of roles
Create a role
Manage roles
Notes
Add or update notes
Process events
Create a process event
Data models
Create a local data model
Create a local data model using JSON
Document set
Configure a document set
Functions for document set fields
User interface
Forms
Form designer
Modeling bar
Action Toolbar
Toolbox
General controls
Properties of Label control
Properties of a Textbox control
Properties of a Multi-line text control
Properties of a Button control
Text appearing off-center for the Button control
Properties of a Checkbox control
Properties of a Table control
Add columns to a table
Add a Text box to a table column
Add a Drop-down list to a table column
Add a Check box to a table column
Add a Calendar to a table column
Add a Hyperlink to a table column
Add an Image to a table column
Add an Action list to a table column
Properties of a Dropdown list control
Add data to a dropdown list
Properties of a Calendar control
Properties of a Radio button list control
Configure the data for a Radio button list control
Properties of a Tab control
Add tabs to a Tab control
Properties of Hyperlink control
Properties of an Image control
Add images to a form
Properties of a Chart control
Examples - Chart control
Properties of a Tile control
Example - Applying dynamic filters on a Tile control
Properties of a Horizontal rule control
Properties of a List control
Configure the data store
Configure the swipe buttons
Configure a row
Design properties of a control
Configure a label for a control
Configure actions for a form control event
Move, cut, copy, and paste controls
Set common properties of controls
Set error properties for a control
Dynamically change the label of a control
Input types
Layout
Headings
Advanced controls
Job list control
Properties of a Job list control
Search properties
Configuration of a Job list control
Edit the Job list actions
Work queue control
Properties of a Work queue control
Search properties
Configuration of a Work queue control
Workload control
Properties of a Workload control
Search properties
Configuration of a Workload control
Document set control
Properties of a Document set control
Configuration of a Document set control
File upload control
Properties of a File upload control
Configuration of a File upload control
Change the size limit for uploaded files
Resource tree control
Properties of a Resource tree control
Configuration of a Resource tree control
Embedded page control
Properties of an Embedded page control
Process viewer control
Properties of a Process viewer control
Web capture control
Properties of a Web capture control
Configuration of a Web capture control
Configure buttons for a Web capture control toolbar
Thumbnail viewer control
Properties of a Thumbnail viewer control
KCM control
Properties of a KCM control
Configuration of a KCM control
Compose mode
Rerun and Review modes
Case health control
Properties of a Case health control
Checklist control
Properties of a Checklist control
Use a Checklist
Language selector control
Properties of a Language selector control
Custom action button control
Properties of Custom action button control
Configuration of a Custom action button control
Toolbar control
Properties of a Toolbar control
Configure items for a Toolbar control
Create new associated job control
Properties of a Create new associated job control
Summary control
Properties of a Summary control
Job action button control
Properties of a Job action button control
Configuration of a Job action button control
Activity action button control
Properties of an Activity action button control
Configuration of an Activity action button control
Capture Composite control
Properties of a Capture Composite control
Configure toolbar commands for a Composite control
Drill-down properties of Capture Composite controls
Mobile capture control
Properties of a Mobile capture control
Mobile capture barcode control
Properties of a Mobile capture barcode control
Configuration of a Mobile capture barcode control
Generative AI chat control
Properties of a Generative AI chat control
Configuration of a Generative AI chat control
Capture controls
Capture controls based on the fields for a document type
Add a mini-viewer
Manually create forms
Create a form
Generate a form using Generative AI
Build forms
Build a Create new job form
Build a Device create new job form
Additional information on Device create new job form
Build a Document form
Build a Folder form
Build a Logon form
Build a Multiview form
Build a Multiview activity form
Build a Scan create new job form
Build an Activity form
Build an MFP scan create new job form
Build an MFP form
Build an MFP work queue form
Build an MFP activity forms
Form properties
General
Initialization and events
Settings
Access
Properties specific to a touch-enhanced form
Define action menus for a touch-enhanced form
Define header or footer toolbar for a touch-enhanced form
Form events and actions
Form actions
.Net method action
Add row action
Alternative extraction search action
Apply form variant action
Apply validation action
Business rule action
Calculation rule action
Capture client action
Change stack order action
Clear action
Clear selection action
Close action
Composite action
Custom service action
Condition actions
Begin condition action
Else condition action
End condition action
Data object action
DB query action
DB query to get records from a database table
DB query to add records to a database table
DB query to update records in a database table
DB query to delete records in a database table
DB query to use stored procedures of a database
DB query to use the database views
Insert multiple records into a database
Delete row action
Display rule action
Use a display rule to collapse or expand a cell
File upload action
Fuzzy search action
Generative AI action
Hide action menu action
JavaScript action
MFP print action
MFP Scan action
MFP scan settings action
Redirect action
Refresh capture action
Refresh page rendition action
Reset form variables action
RESTful service action
RPA action
Same page action
Set device action
Set focus action
Set language from job action
Show action menu action
Show message action
Show navigation action
Update control action
Enumerations
Update control properties action
Update row action
Web capture action
Web service action
Form batch actions
Configure multilingual actions
Work with an action
Form events
Events and actions supported by form and basic controls
Events and actions supported by advanced controls
Auto-generated actions in Capture forms and composite controls
Events and actions supported by the tablet and phone forms
Events and actions supported by an MFP form
Events and actions supported by the Capture Client controls
Form variables
Manage form variables
Data models
Create a data model specific to a form
Create a local data model using JSON
Form debugging
Debug a form
Debug an activity within a form
Debug a form - example
Work with forms
Search for a form
Open and modify a form
Copy a form
Delete a form
Unlock a form
Open a form version
Regenerate a form
Style your forms
Customize the Capture forms
View form associations
Form templates
Create a form template
Manage a form template
Use a form template
Navigations
Create a navigation
Maintain navigations
Global variables
Create a global variable
Maintain a global variable
Themes
Create a theme
Maintain a theme
Style sheets
Upload a style sheet
Manage style sheets
Images
Upload an image
Manage images
Form variants
Create a form variant
Maintain a form variant
Sites
Create a site
Maintain a site
Custom pages
Upload a custom page
Manage custom pages
Security tokens
Manage a security token
Associate a security token with a control
Capture
Extraction groups
Extraction groups designer
Modeling bar
Design bar
Create an extraction group
Properties of an extraction group
Work with extraction groups
Document type
Add a document type
Properties of a document type
General
Validation
Field validation
Post validation handling
PDF generation
Forms
Validation methods
Business rule validation method
Date validation method
Regular expression validation method
Standard validation method
Field groups
Add field groups to a document type
System field group for document
Fields
Add fields to a field group
Properties of a field in a document type
General
Configure the verification settings for a document field
Validation
Add a table field to a field group
Macros for devices
Classification groups
Create a classification group
Properties of a classification group
Work with classification groups
Folders
Modeling bar
Add a folder type
Properties of a folder
General
Resources
Validation
Field validation
Forms
Add a field group
System field group for folder
Add fields to a field group
Properties of a folder type field
Maintain a folder type
Document and activity variants
Create a document variant
Maintain a document variant
Create an activity variant
Maintain an activity variant
Field formatters
Add a field formatter
Date formatter
Amount formatter
Percentage formatter
Business rule formatter
Maintain a field formatter
Field validators
Add a field validator
Maintain a field validator
Field zoom settings
Configure field zoom settings
Document conversion profiles
Add document conversion profiles
Sample XSLT
Sample XML
Maintain a document conversion profile
Configure Kofax Converter
PDF profiles
Create a PDF profile
Properties of a PDF profile
Work with PDF profiles
Scan/VRS profiles
Create a Scan/VRS profile
Properties of a Scan/VRS profile
Maintain a Scan/VRS profile
eVRS command string modules
Properties of specific image processing settings
Resolution of inconsistencies
Minimum image size
eVRS strings examples
MFP scan handling with or without image processing
Separation profiles
Create a separation profile
Properties of a separation profile
Configure a separation profile for a document
Configure a separation profile for a folder
Work with separation profiles
Bar code and patch code types supported by TotalAgility
Additional information about folder and document separation
Bar code and patch code profiles
Create Bar code and patch code profiles
Properties of a Bar code and patch code profile
Maintain Bar code and patch code profiles
Additional information on the deletion of scanned pages
Control layouts
Create a capture control layout
Resources
Individuals
Create an individual resource
Maintain an individual resource
Groups
Create a group resource
Maintain a group resource
External resources
Create an external resource
Maintain an external resource
Personas
Manage a persona
Associate a persona with group members
Import
Import a process
Import a form
Import languages
Map between XPDL notation and TotalAgility
Import a package
Solution rollback
Additional information on importing a package
Export
Export a process
Export a form
Export languages
Export a package
Export a test suite
Translation
Translate the elements into supported languages
Queries
Create a Job query
Create a Work queue query
Create a System query
Manage columns in queries
Provide access control for a query
Sort columns in a query
Job query filter fields
Work queue query filter fields
System query filter fields
Manage queries
Monitoring
Business events
Manage business events
Business alerts
Manage business alerts
Business targets
Manage business targets
System data
Server variables
Manage a server variable
Predefined server variables
Regular expressions
Manage regular expressions
Lookups
Manage a lookup
Create a multilingual lookup
Translate a lookup
Document templates
Upload a document template
Maintain a document template
Currency codes
Manage a currency code
Error codes
Manage error codes
Using error codes in business rules
Checklist templates
Create a checklist template
Maintain a checklist template
Associate a checklist template with a process
Checklist items
Manage a Checklist item
Add comments against defined responses
Apply response to all questions
Query the status of a checklist
Work types
Create a work type
Associate a work type with a map
Maintain a work type
Tags
Manage tags
Data models
Data model designer
Examples of data models using JSON sample
Modeling bar
Create a global data model
Create a global data model using Generative AI
Create a global data model using JSON
Maintain a data model
Access data in a nested list
Integration
Web service references
Manage a web service reference
Web services supported by TotalAgility
Use a web service
.Net assemblies
Add a .Net assembly
Use a .Net assembly in a store
Maintain a .Net assembly
RPA
Integrate TotalAgility with RPA
Maintain an RPA configuration
Custom service groups
Manage a custom service group
Add web service references
Add server variables
Generative AI
Integrate Generative AI with TotalAgility
Maintain a Generative AI integration
Insight
Integrate TotalAgility with Insight
SignDoc
Integrate TotalAgility with SignDoc
Maintain SignDoc integration
KCM
Integrate TotalAgility with KCM
Maintain a KCM integration
Import settings
Configure the import connection settings
FoIP server settings
SMTP server settings
Import sources
POP3
IMAP
MS Graph
EWS
External fax server
FoIP
SMTP
FILE
Cloud file
Kofax XML format
Maintain import connection settings
Handle import events
Step 1: Create a process map to handle import events
Step 2: Create a map for raising event
Step 3: Embed the process map to your map
Example: Import XML files
Configuration in Capture
Configuration in Import settings
Linked servers
Link the TotalAgility servers
Maintain a linked server
Micro Focus Content Manager
Link TotalAgility to Micro Focus Content Manager system
Configure TotalAgility actions resulting from Micro Focus Content Manager events
Change state action
Create job in case action
Create new case action
Create new job action
Raise event action
Search for documents in a Content Manager system
Maintain a Micro Focus Content Manager integration
CMIS
Add a CMIS-compliant site
Maintain a CMIS-compliant site
SharePoint
Create a Microsoft SharePoint integration site
Configure TotalAgility actions resulting from SharePoint events
Change state action
Create a Job in case action
Configure a create new case action
Create new job action
Raise event action
Work with SharePoint web parts
Define columns in a work queue web part
View all case jobs using the case reference
Maintain a SharePoint integration site
Dynamics CRM
Link TotalAgility to Microsoft Dynamics CRM
Configure TotalAgility actions resulting from Microsoft Dynamics CRM events
Change state action
Create job in case action
Create new case action
Create new job action
Raise event action
Maintain a Dynamics CRM integration
Dynamics AX
Link TotalAgility to Microsoft Dynamics AX
Configure the TotalAgility actions resulting from Microsoft Dynamics AX events
Change state action
Create job in case action
Create new case action
Create new job action
Raise event action
Maintain a Dynamics AX integration
Exchange
Link TotalAgility with Microsoft Exchange
Configure TotalAgility actions resulting from Microsoft Exchange events
Change state action
Create job in case action
Create new case action
Create new job action
Raise event action
Maintain an Exchange site integration
ControlSuite
Integrate ControlSuite with TotalAgility
Maintain a ControlSuite integration site
OAuth servers
OAuth Authorization Grant types
Authentication methods
Configure OAuth server
Configure OAuth server using Authorization code grant type
Configure OAuth server using Resource owner password grant type
Configure OAuth server using Client credentials grant type
Maintain an OAuth server integration
TotalAgility Rest API
TotalAgility SDK JSON payload
Generate the TotalAgility SDK JSON payload
TotalAgility OAuth clients
Configure TotalAgility OAuth clients
Packages
Modeling bar
Create a package
Configure package properties
Add items to a package
Add a deployment configuration to a package
Include or exclude package export options
Overview
Deploy a package to a deployment server
Compare and deploy a package
Add a package to GitHub
Check out an item added to GitHub
Get the latest version of an item added to GitHub
Check in an item checked out to GitHub
Patch package
Create a patch package
Miscellaneous files
Upload a miscellaneous file
Maintain a miscellaneous file
Work with packages or patch packages
Compare packages
Quick Apps
Manage a Quick Apps solution
System
Categories
Manage a category
Job schedules
Manage a job schedule
Deployment servers
Manage a deployment server
Deployment schedules
Manage a deployment schedule
System settings
Database, retention and reporting
Database settings
Retention policy
Configure the retention policy
Reporting server
Solution rollback
Utilities
Archive finished job
Protected items search
Process
Exceptions
Configure exception handling at the server level
System-level exception maps and initialization parameters
Process node colors
Scripting
Configure the Scripting settings
SLA and work assignment
Configure SLA and work assignment
Auto arrange
Logon and authentication
Password and logon
Multifactor authentication
Resource extensions
Add a resource extension
User sessions
Change the session IDs
System
General
Forms
Email server (SMTP)
Configure email server (SMTP)
Thread pools
Add a thread pool
Whitelist
Whitelist a web service URL or a database connection string
System tasks
Manage system tasks
Secure secret storage
Configure the secure secret storage
Security key
Generate the security key to encrypt data
External storage
Sample custom storage processes
User behavior
Scan forms
Activity forms
Capture configurable keys
Manage capture configurable keys
Excluded shortcut keys
Key combination with a modifier key
Cannot be overridden
Already in use by Capture Client
Capture operations
Manage Capture operations
License servers and statistics
Configure a backup license server and activate the license API keys
Reactivate license on primary
Reactivate license on backup
Set threshold for a primary server
License types
Additional information about decrementing volume
Set threshold for a backup server
Capture
Capture groups
Configure the capture groups
Web capture service
Thumbnail settings
Apps
Quick Capture
Quick Workflow/RPA solutions
Access settings
Access control list
Assign access permissions to different areas of TotalAgility
Assign access permissions for TotalAgility Designer
Assign access permissions for Transformation Designer
Assign access permissions for devices
Assign access permissions for Quick Apps
Additional settings
Database, retention and reporting
Reporting tags
Utilities
Job clear down
Lock status search
Logon and authentication
Federated security
Support for authentication without federated security
Configure the federated security
Capture
Page renditions
Edit page rendition name
Devices
Apps
App status search
Solution access default settings
GitHub
Repository
Configure GitHub integration
Check out status search
GitHub file manager
Use GitHub file manager
Testing
Create a test suite
Execute test suite
Maintain a test suite
Insight
References
Sample processes for populating document fields using external services
Populate a document using the response from Azure AI Document Intelligence
Populate a document using the response from Google Cloud Document AI
Supported formats
Document conversion file extraction use cases
Supported formats for document normalization
Supported formats for document conversion
Input and output formats for a Document Converter
Input and output formats for a Message Connector
Supported input formats and PDF output formats
Document conversion error codes
Numeric identifiers for the bar code types
Mime types
Getting help with Kofax products
Glossary
›
Log out of TotalAgility Designer
Log out of TotalAgility Designer
On the title bar, click the username and click
Logout
.
×
TotalAgility Designer HelpTotalAgility Designer Help