What's New in 9.4
KappZone™
Kapow Katalyst
Additional Features and Improvements
Support end-of-life notices
KappZone™
Kapow Katalyst
Additional Features and Improvements
Support end-of-life notices
Getting Started
Overview
Installation Guide
Installing Kapow Katalyst
Installing on Windows
Silent Installation on Windows
Installing on Linux
Important Folders in Kapow Katalyst
Entering License Information
Management Console (License Server)
Design Studio
Configuring Kapow Katalyst
Starting Servers Automatically
Starting Servers on Windows
Starting Servers on Linux
Supported Platforms
System Requirements
Notes for Users of Earlier Versions
Existing customers upgrading to 9.3
Data Migration Tutorial
New Excel Capabilities in 9.2
RoboRunner Discontinued in 9.1
Scheduling concepts
Bulk deploying to Management Console
Scheduling robots
Changes in 8.2
New Variables and Type System in 8.1
New Control Flow and Error Handling in 8.0
Error Handling
New Storage System in 7.2
The Old Storage System
The New Storage System
Legacy Options
Backwards Compatibility
Migration
Beginner Tutorials
Robot Beginner's Tutorial
Kapplet Beginner's Tutorial
Type Beginner's Tutorial
Advanced Tutorials
Branches, Robot States, and Execution Flow
Looping Basics
Loops in Forms
Repeat-Next
Try Step
Excel
Writing to Excel
Data Conversion
Patterns
Snippets
Date Extraction - Simple Case
Date Extraction - Tricky Case
API
Kapow Compute Units (KCUs)
License Keys
Kapow Katalyst Limitations
Overview
Installation Guide
Installing Kapow Katalyst
Installing on Windows
Silent Installation on Windows
Installing on Linux
Important Folders in Kapow Katalyst
Entering License Information
Management Console (License Server)
Design Studio
Configuring Kapow Katalyst
Starting Servers Automatically
Starting Servers on Windows
Starting Servers on Linux
Supported Platforms
System Requirements
Notes for Users of Earlier Versions
Existing customers upgrading to 9.3
Data Migration Tutorial
New Excel Capabilities in 9.2
RoboRunner Discontinued in 9.1
Scheduling concepts
Bulk deploying to Management Console
Scheduling robots
Changes in 8.2
New Variables and Type System in 8.1
New Control Flow and Error Handling in 8.0
Error Handling
New Storage System in 7.2
The Old Storage System
The New Storage System
Legacy Options
Backwards Compatibility
Migration
Beginner Tutorials
Robot Beginner's Tutorial
Kapplet Beginner's Tutorial
Type Beginner's Tutorial
Advanced Tutorials
Branches, Robot States, and Execution Flow
Looping Basics
Loops in Forms
Repeat-Next
Try Step
Excel
Writing to Excel
Data Conversion
Patterns
Snippets
Date Extraction - Simple Case
Date Extraction - Tricky Case
API
Kapow Compute Units (KCUs)
License Keys
Kapow Katalyst Limitations
Design Studio User's Guide
Design Studio Concepts
Robots
The Robot State
Steps
Connections and Execution Flow
Conditions and Error Handling
Location and Location Code
Snippets
Variables and Types
Libraries and Projects
Getting Started with Design Studio
A Tour of the Design Studio User Interface
The Menu Bar
The Tool Bar
The Projects View
The Editors View
The Robot Editor
The Robot View
The Windows View
The HTML Page View
The XML Page View
The JSON Page View
The Spreadsheet View
The Step View
The Variables View
The Debug Mode
The Type Editor
The Text Editor
General Editing
Types
Configuring Attributes
Step Actions and Data Converters
Patterns
Expressions
Working with Projects and Libraries
Interacting with Databases
Database Mappings
Types and Databases
Database Warnings
Creating and Deleting Database Tables
Storing Data in Databases
Putting It All Together
How to Write Well-Structured Robots
How to Determine the Type of a Page
How to Use the Tag Finders
Understanding Tag Paths
How the Tag Finder Works
Configuring the Tag Finders of the Current Step
How to Submit a Form
Simple Form Submission
Form Basics
Which Step Action Should I Use?
Using the Loop Form Actions
Uploading Files
Using the Pop-up Menu in the Page View
How to Loop Through Tags on a Page
Looping Through Tags with the Same Class
Looping Through Tags with Different Classes
How to Loop Through HTML Pages
Pages where First Page Links to All Other Pages
Pages where Each Page Links to Next
How to Extract Content from HTML
Extracting Text
Extracting Binary Data
Using the Pop-up Menu in the Page View
Performing Common Tasks
How to Extract Content From an HTML Table
Content Irregularities
Structure Irregularities
How To Use Local Files in Robots
How to Load an Excel Page from a Variable
How to Extract Content from Excel
Extracting Values from Cells
Extracting a Sheet Name
Extracting As HTML
How to Test Cell Types in Excel
How to Loop in Excel
How to Work with Variables in the Windows View
Open a Variable
Modifying a Variable
How to Work with JSON
JSON Terminology
JSON MIME-Type
Step Actions that Work on JSON
Notes on Converting JSON to a JavaScript Object
How to Handle Errors
Trying Several Alternatives
Shortcuts for Common Cases
"At" Target
Looping
Try-Catch
View Error Handling on Steps in the Robot View
How to Write a Robot with Input Variables
How to Create and Reuse Snippets
Variables and Snippets
Good Snippet Practice
How to Make Robots More Robust
How to Reuse Sessions
How to Modify an Existing Type
How to Configure Robots
Show Changes from Default
How to Configure Variables
How to Debug a Robot
Basic Debugging
Debugging from the Current Location in Design Mode
Going Back to Design Mode from a Debugging Location
Using Breakpoints
Single-Stepping
Stepping-Into
Design Studio Settings
General
Text Files
Robot Editor
Database
Database Connections
Proxy Servers
Certificates
Bug Reporting
Legacy
Design Studio Concepts
Robots
The Robot State
Steps
Connections and Execution Flow
Conditions and Error Handling
Location and Location Code
Snippets
Variables and Types
Libraries and Projects
Getting Started with Design Studio
A Tour of the Design Studio User Interface
The Menu Bar
The Tool Bar
The Projects View
The Editors View
The Robot Editor
The Robot View
The Windows View
The HTML Page View
The XML Page View
The JSON Page View
The Spreadsheet View
The Step View
The Variables View
The Debug Mode
The Type Editor
The Text Editor
General Editing
Types
Configuring Attributes
Step Actions and Data Converters
Patterns
Expressions
Working with Projects and Libraries
Interacting with Databases
Database Mappings
Types and Databases
Database Warnings
Creating and Deleting Database Tables
Storing Data in Databases
Putting It All Together
How to Write Well-Structured Robots
How to Determine the Type of a Page
How to Use the Tag Finders
Understanding Tag Paths
How the Tag Finder Works
Configuring the Tag Finders of the Current Step
How to Submit a Form
Simple Form Submission
Form Basics
Which Step Action Should I Use?
Using the Loop Form Actions
Uploading Files
Using the Pop-up Menu in the Page View
How to Loop Through Tags on a Page
Looping Through Tags with the Same Class
Looping Through Tags with Different Classes
How to Loop Through HTML Pages
Pages where First Page Links to All Other Pages
Pages where Each Page Links to Next
How to Extract Content from HTML
Extracting Text
Extracting Binary Data
Using the Pop-up Menu in the Page View
Performing Common Tasks
How to Extract Content From an HTML Table
Content Irregularities
Structure Irregularities
How To Use Local Files in Robots
How to Load an Excel Page from a Variable
How to Extract Content from Excel
Extracting Values from Cells
Extracting a Sheet Name
Extracting As HTML
How to Test Cell Types in Excel
How to Loop in Excel
How to Work with Variables in the Windows View
Open a Variable
Modifying a Variable
How to Work with JSON
JSON Terminology
JSON MIME-Type
Step Actions that Work on JSON
Notes on Converting JSON to a JavaScript Object
How to Handle Errors
Trying Several Alternatives
Shortcuts for Common Cases
"At" Target
Looping
Try-Catch
View Error Handling on Steps in the Robot View
How to Write a Robot with Input Variables
How to Create and Reuse Snippets
Variables and Snippets
Good Snippet Practice
How to Make Robots More Robust
How to Reuse Sessions
How to Modify an Existing Type
How to Configure Robots
Show Changes from Default
How to Configure Variables
How to Debug a Robot
Basic Debugging
Debugging from the Current Location in Design Mode
Going Back to Design Mode from a Debugging Location
Using Breakpoints
Single-Stepping
Stepping-Into
Design Studio Settings
General
Text Files
Robot Editor
Database
Database Connections
Proxy Servers
Certificates
Bug Reporting
Legacy
Management Console User's Guide
Management Console Structure Overview
Starting the Management Console
Management Console User Interface
Dashboard
Kapplets
Schedules
Adding Jobs
Adding a single Robot
Adding a group of robots based on name
Repository
Robots
Executing Robots
API
REST
SOAP
Types
Snippets
Resources
OAuth
Data
Logs
Admin
Task View
Clusters
Cluster Mode
Cluster Settings
Databases
Proxy Servers
Logging
Profiling
Robot Execution
Projects
Rest and SOAP Services
Users & Groups
Settings
Schedule Logs Cleanup
RoboServer Authentication
RoboServer Log Database
SMTP Server
Base URL
Proxy Server
Kofax Insight Dashboards
Single Sign-On
Shared Databases
Kapplet Results
Database Types
Database Drivers
Backup
License
JMX
OAuth
Supported Service Providers
Adding Applications
Adding Users
Writing Robots
Scheduling Robots with Credentials
Out of Band Applications
Facebook
LinkedIn
Salesforce
Google
Management Console Structure Overview
Starting the Management Console
Management Console User Interface
Dashboard
Kapplets
Schedules
Adding Jobs
Adding a single Robot
Adding a group of robots based on name
Repository
Robots
Executing Robots
API
REST
SOAP
Types
Snippets
Resources
OAuth
Data
Logs
Admin
Task View
Clusters
Cluster Mode
Cluster Settings
Databases
Proxy Servers
Logging
Profiling
Robot Execution
Projects
Rest and SOAP Services
Users & Groups
Settings
Schedule Logs Cleanup
RoboServer Authentication
RoboServer Log Database
SMTP Server
Base URL
Proxy Server
Kofax Insight Dashboards
Single Sign-On
Shared Databases
Kapplet Results
Database Types
Database Drivers
Backup
License
JMX
OAuth
Supported Service Providers
Adding Applications
Adding Users
Writing Robots
Scheduling Robots with Credentials
Out of Band Applications
Facebook
LinkedIn
Salesforce
Google
Kapow Kapplets User's Guide
Building and Maintaining Kapplets
Creating Kapplets
Using the Kapplet Studio
Configuring the Start Page
Using OAuth in Kapplets
Connecting to Kofax Insight Dashboards
Configuring the Result History Page
Configuring the Result Pages
Adding a Commit Action
Installing and Using Kapplets
Invoking Kapplets
Email Notifications from Kapplets
Scheduling Kapplets
Customizing the Branding
Building and Maintaining Kapplets
Creating Kapplets
Using the Kapplet Studio
Configuring the Start Page
Using OAuth in Kapplets
Connecting to Kofax Insight Dashboards
Configuring the Result History Page
Configuring the Result Pages
Adding a Commit Action
Installing and Using Kapplets
Invoking Kapplets
Email Notifications from Kapplets
Scheduling Kapplets
Customizing the Branding
Programming With Robots
Java Programmer's Guide
Basics
First Example
Robot Input
Attribute Types
Execution Parameters
Robot Libraries
Advanced
Load Distribution and Failover
Executor Logger
Data Streaming
SSL
Parallel execution
Repository Integration
Under the hood
RequestExecutor Features
Web applications
API Debugging
Repository API
Repository Client
Deployment via Repository Client
Repository REST API
.NET Programmer's Guide
Basics
First Example
Robot Input
Attribute Types
Execution Parameters
Robot Libraries
Advanced
Load Distribution
Executor Logger
Data Streaming
SSL
Repository Integration
Under the hood
RequestExecutor Features
Repository API
Repository Client
Deployment via Repository Client
Repository API as REST
Examples
Java Programmer's Guide
Basics
First Example
Robot Input
Attribute Types
Execution Parameters
Robot Libraries
Advanced
Load Distribution and Failover
Executor Logger
Data Streaming
SSL
Parallel execution
Repository Integration
Under the hood
RequestExecutor Features
Web applications
API Debugging
Repository API
Repository Client
Deployment via Repository Client
Repository REST API
.NET Programmer's Guide
Basics
First Example
Robot Input
Attribute Types
Execution Parameters
Robot Libraries
Advanced
Load Distribution
Executor Logger
Data Streaming
SSL
Repository Integration
Under the hood
RequestExecutor Features
Repository API
Repository Client
Deployment via Repository Client
Repository API as REST
Examples
Runtime
RoboServer User's Guide
Starting RoboServer
Production Configuration
Configuring RoboServer
Configuring the Embedded Management Console
Security
Restrictions
Requiring Authentication
Configuring Audit Logging
Certificates
HTTPS Certificates
HTTPS Client Certificates
API Client Certificates
API Server Certificate
Setting the Default RoboServer Project
Configuring the JMX Server
Configuring RoboServer in Headless Mode
Changing the RAM Allocation
Troubleshooting RoboServer Service Start-Up
RoboServer User's Guide
Starting RoboServer
Production Configuration
Configuring RoboServer
Configuring the Embedded Management Console
Security
Restrictions
Requiring Authentication
Configuring Audit Logging
Certificates
HTTPS Certificates
HTTPS Client Certificates
API Client Certificates
API Server Certificate
Setting the Default RoboServer Project
Configuring the JMX Server
Configuring RoboServer in Headless Mode
Changing the RAM Allocation
Troubleshooting RoboServer Service Start-Up
Management Console in Tomcat
Notes on Upgrading
Deploying into Tomcat
Creating a new Database
Creating a Tomcat context file
Starting Tomcat
Enter License
Project Permissions
Security
Deployment Checklist
Advanced Configuration
LDAP Integration
High Availability
Load balancer configuration
Tomcat Session Replication
Hazelcast configuration
URI Encoding
Password Encryption
SSL Endpoint verification
Notes on Upgrading
Deploying into Tomcat
Creating a new Database
Creating a Tomcat context file
Starting Tomcat
Enter License
Project Permissions
Security
Deployment Checklist
Advanced Configuration
LDAP Integration
High Availability
Load balancer configuration
Tomcat Session Replication
Hazelcast configuration
URI Encoding
Password Encryption
SSL Endpoint verification
Getting Support
Customer Support
Self-Service Portal and Knowledge Base
Support Policy
Customer Support
Self-Service Portal and Knowledge Base
Support Policy
License
End User License Agreement
Third Party and Open Source Code - License Terms
Product Privacy Policy
End User License Agreement
Third Party and Open Source Code - License Terms
Product Privacy Policy
Reference
Design Studio
Step Actions
Assign Variable
Branch Point
Calculate Key
Call REST Web Service
Call SOAP Web Service
Change Proxy
Clear Named Tags/Ranges
Clear Web Storage
Click
Close Window
Convert Variables
Copy File
Crawl Pages
Create Cookie
Create Page
Delete File
Delete from Database
Divide Table
Divide Text
Do Nothing
End Step
Enter Password
Enter Text
Execute Command Line
Execute JavaScript
Execute SQL
Extract
Extract As HTML
Extract Binary Content
Extract Cell
Extract Cookie
Extract Form Parameter
Extract from Flash
Extract from PDF
Extract Hyperlink
Extract Image
Extract JSON
Extract Path
Extract Property Name
Extract Screenshot
Extract Selected Option
Extract Sheet Name
Extract Source
Extract Tag Attribute
Extract Target
Extract URL
Extract Web Storage
Find in Database
For Each Browser Window
For Each File
For Each Item
For Each Option
For Each Property
For Each Radio Button
For Each Tag
For Each Tag Path
For Each Text Part
For Each URL
Generate Error
Get File Info
Get Iteration
Group Step
Hide Tag
Insert Columns
Insert Content
Insert JSON
Insert Rows
Insert Sheet
Insert Tag
Load File
Load Page
Load Web Storage
Loop Field Values
Loop in Excel
Make Directory
Make Snapshot
Move Mouse From
Move Mouse To
New Window
Next
Normalize Table
Open Variable
Press Key
Query Database
Raw HTTP
Refind Object
Remove Attribute
Remove Columns
Remove Content
Remove Cookie
Remove JSON
Remove Rows
Remove Sheet
Remove Table Rows
Remove Tag
Remove Tag Range
Remove Tags
Rename File
Repeat
Replace Tag
Restore Session
Return Value
Rewrite Page
Rewrite Style Sheet
Save Session
Scroll
Scroll To
Select File
Select Multiple Options
Select Option
Select Radio Button
Send Email
Set Attribute
Set Checkbox
Set Column Width
Set Content
Set Content of Cell
Set Content of Column
Set Content of Row
Set Current Window
Set Format of Cells
Set Hyperlink on Cell
Set Information Property
Set JSON
Set Named JSON
Set Named Range
Set Named Tag
Set Property Name
Set Row Height
Set Sheet Name
Set Tag
Set Tag Name
Set Text
Set Value of Cell
Snippet Step
Stop
Store in Database
Store in HBase Table
Test Cell Type
Test File Existence
Test JSON Type
Test Page Type
Test Row
Test Tag
Test URL
Test Value
Test Variables
Test Window
Transform XML
Transpose Table
Try
Unhide Tag
View As CSV
View As Excel
View As JSON
View As XML
Wait
Write File
Write Log
Data Converters
Add Text
Add To CSV
Advanced Extract
Ampersand Decode
Ampersand Encode
Base64 Decode
Base64 Encode
Capitalize
Compute MD5 Checksum
Convert Binary to Text
Convert from Excel Date
Convert HTML to Text
Convert Text to Binary
Convert to Excel Date
Convert to Lower Case
Convert to Upper Case
Convert Using JavaScript
Convert Using List
Count Tags
Evaluate Expression
Extract
Extract Date
Extract List
Extract Number
Extract Year
Format Date
Format HTML
Format Number
Get Property
Get Time Between Dates
Get Variable
If Then
Make URL Absolute
Make URL Relative
Modify Date
Remove Non-Printable Characters
Remove Spaces
Remove Special Characters
Remove Tags
Replace Pattern
Replace Text
Unquote Text
URL Decode
URL Encode
The Type Editor
Type Configuration
Attribute Configuration
Attribute Types
Properties Attribute Type
Creating and Deleting Tables
Deployment Wizards
Upload Robot to Management Console
Upload Resource to Management Console
Clipping Wizards
1st-Generation Clipping Wizards
Protocols
Robot Libraries
Other Topics
Robot Configuration
Options
Step Configuration
Windows
Named Tags, Ranges, and JSON
Tag, Range, and JSON Finders
Tag Finders
Range Finders
Cell Ranges
JSON Finders
Patterns
Expressions
Error Handling
Step References in "At"
Send Backwards (legacy)
POST Requests as URLs
The Library Protocol
Value Selector
URL Selector
Keyboard Help
Browser Tracer
Variable Validation Errors
XML Data Mapper
How to Create a Data Mapping
How to Edit a Data Mapping
RoboServer
Management Console
Other Topics
Cron Schedule
Java API
Environments
Robot Info Environments
Database Robot Info Environment
Simple Robot Info Environment
Storage Environments
Database Storage Environment
File Storage Environment
Multiple Files Storage Environment
Message Environments
Aggregate Message Environment
Database Message Environment
Email Message Environment
File Message Environment
Input Object Environment
Common Robot Environment
Design Studio
Step Actions
Assign Variable
Branch Point
Calculate Key
Call REST Web Service
Call SOAP Web Service
Change Proxy
Clear Named Tags/Ranges
Clear Web Storage
Click
Close Window
Convert Variables
Copy File
Crawl Pages
Create Cookie
Create Page
Delete File
Delete from Database
Divide Table
Divide Text
Do Nothing
End Step
Enter Password
Enter Text
Execute Command Line
Execute JavaScript
Execute SQL
Extract
Extract As HTML
Extract Binary Content
Extract Cell
Extract Cookie
Extract Form Parameter
Extract from Flash
Extract from PDF
Extract Hyperlink
Extract Image
Extract JSON
Extract Path
Extract Property Name
Extract Screenshot
Extract Selected Option
Extract Sheet Name
Extract Source
Extract Tag Attribute
Extract Target
Extract URL
Extract Web Storage
Find in Database
For Each Browser Window
For Each File
For Each Item
For Each Option
For Each Property
For Each Radio Button
For Each Tag
For Each Tag Path
For Each Text Part
For Each URL
Generate Error
Get File Info
Get Iteration
Group Step
Hide Tag
Insert Columns
Insert Content
Insert JSON
Insert Rows
Insert Sheet
Insert Tag
Load File
Load Page
Load Web Storage
Loop Field Values
Loop in Excel
Make Directory
Make Snapshot
Move Mouse From
Move Mouse To
New Window
Next
Normalize Table
Open Variable
Press Key
Query Database
Raw HTTP
Refind Object
Remove Attribute
Remove Columns
Remove Content
Remove Cookie
Remove JSON
Remove Rows
Remove Sheet
Remove Table Rows
Remove Tag
Remove Tag Range
Remove Tags
Rename File
Repeat
Replace Tag
Restore Session
Return Value
Rewrite Page
Rewrite Style Sheet
Save Session
Scroll
Scroll To
Select File
Select Multiple Options
Select Option
Select Radio Button
Send Email
Set Attribute
Set Checkbox
Set Column Width
Set Content
Set Content of Cell
Set Content of Column
Set Content of Row
Set Current Window
Set Format of Cells
Set Hyperlink on Cell
Set Information Property
Set JSON
Set Named JSON
Set Named Range
Set Named Tag
Set Property Name
Set Row Height
Set Sheet Name
Set Tag
Set Tag Name
Set Text
Set Value of Cell
Snippet Step
Stop
Store in Database
Store in HBase Table
Test Cell Type
Test File Existence
Test JSON Type
Test Page Type
Test Row
Test Tag
Test URL
Test Value
Test Variables
Test Window
Transform XML
Transpose Table
Try
Unhide Tag
View As CSV
View As Excel
View As JSON
View As XML
Wait
Write File
Write Log
Data Converters
Add Text
Add To CSV
Advanced Extract
Ampersand Decode
Ampersand Encode
Base64 Decode
Base64 Encode
Capitalize
Compute MD5 Checksum
Convert Binary to Text
Convert from Excel Date
Convert HTML to Text
Convert Text to Binary
Convert to Excel Date
Convert to Lower Case
Convert to Upper Case
Convert Using JavaScript
Convert Using List
Count Tags
Evaluate Expression
Extract
Extract Date
Extract List
Extract Number
Extract Year
Format Date
Format HTML
Format Number
Get Property
Get Time Between Dates
Get Variable
If Then
Make URL Absolute
Make URL Relative
Modify Date
Remove Non-Printable Characters
Remove Spaces
Remove Special Characters
Remove Tags
Replace Pattern
Replace Text
Unquote Text
URL Decode
URL Encode
The Type Editor
Type Configuration
Attribute Configuration
Attribute Types
Properties Attribute Type
Creating and Deleting Tables
Deployment Wizards
Upload Robot to Management Console
Upload Resource to Management Console
Clipping Wizards
1st-Generation Clipping Wizards
Protocols
Robot Libraries
Other Topics
Robot Configuration
Options
Step Configuration
Windows
Named Tags, Ranges, and JSON
Tag, Range, and JSON Finders
Tag Finders
Range Finders
Cell Ranges
JSON Finders
Patterns
Expressions
Error Handling
Step References in "At"
Send Backwards (legacy)
POST Requests as URLs
The Library Protocol
Value Selector
URL Selector
Keyboard Help
Browser Tracer
Variable Validation Errors
XML Data Mapper
How to Create a Data Mapping
How to Edit a Data Mapping
RoboServer
Management Console
Other Topics
Cron Schedule
Java API
Environments
Robot Info Environments
Database Robot Info Environment
Simple Robot Info Environment
Storage Environments
Database Storage Environment
File Storage Environment
Multiple Files Storage Environment
Message Environments
Aggregate Message Environment
Database Message Environment
Email Message Environment
File Message Environment
Input Object Environment
Common Robot Environment