Falcon Robot Template
This content applies solely to Appian RPA, which must be purchased separately from the Appian base platform.

If your robotic process will need to capture images or search for existing images on a screen, you will use the Falcon module to configure your process. To get started, the Image Recognition template provides beginner level steps on using the Falcon module. This template details how to search and click on an image defined in your support files.

When you use a template to create a robotic process, you are provided with a zip file containing your source code and a pre-built workflow in the robotic process configuration page. Within the source code of this template, the robotic process references a sample image. For the robotic process to locate this image, you will need to use the support image creation tool from the Appian RPA agent to capture the sample image.

The following page explains the contents of the Falcon template workflow and the source code generated by the template.

Prerequisite

For the robotic process to locate the sample image referenced in this template, you will need to use the support image creation tool to capture a screenshot of an image on your resource.

The template comes with the image test.png attached, which is an image of the Firefox icon. Before making changes to the template code, you can capture your own image instead of using the Firefox icon.

To create a support image on your resource:

  1. Right-click the agent icon and click Create support image.
  2. Click and drag your mouse over an area of the screen to take a partial screenshot.
  3. In the side panel, under Save image, select the dropdown and choose to save your image to your robotic process.
  4. Enter test as the name of your image.
  5. Click Save image. The image will be sent to the console and available as a robot support file.

falcon-template-2.png

Workflow

falcon-workflow2.png

The Falcon template's workflow includes three actions: Init, Search, and End.

Similar to an Appian process model, each workflow has a start and end action. This is represented by the Init and End actions. The Search action is where most of the configuration will occur.

If you click the list icon on any action, you'll see it is associated with a method. These methods are in the source code generated from the template. Within the source code, Appian has provided an outline of how you can configure each method.

Source code

Within the downloaded ZIP file, you will see two files: JidokaImageSupport.java and RobotFalconTemplate.java.

The JidokaImageSupport class allows you to obtain an IFalconImage instance of the image test.png that is stored in your support files. The RobotFalconTemplate class contains the main methods used to configure the Init and Search actions within your robotic process.

JidokaImageSupport

The JidokaImageSupport class allows you to obtain supporting code for your images. Within the template, the getTestPng() method is a method specifically created for the test.png image saved as a support file. This method will return an object of type IFalconImage, an image abstraction used by the Falcon module. Images must be of type IFalconImage to work directly with the Falcon module.

Within the source code, you'll see the following:

  • IFalconImage (line 102) is used to instantiate the getTestPng() method.
  • getTestPng() (line 102) is the method specific to calling the test.png image that is stored as a support file. This method will return an object of type IFalconImage.
  • getImage (line 103) is responsible for returning the image specified.
  • Paths.get(server.getCurrentDir(), "test.png") (line 103) is the file path to the support file containing the test.png image.
97
98
99
100
101
102
103
104
/**
 * Returns a falcon image referencing image resource test.png
 * @return
 * @throws IOException
 */
public IFalconImage getTestPng() throws IOException {
	return getImage(Paths.get(server.getCurrentDir(), "test.png"));
}

The JidokaImageSupport class can be automatically created during the Maven build process using the Appian RPA Maven plugin. It's recommended to use this plugin when using the Falcon module in your robotic process. To use the plugin, you will need to configure the plugin in your robotic process's pom.xml. See the Falcon module for steps to configure the plugin.

RobotFalconTemplate

The RobotFalconTemplate class implements the IRobot interface and is annotated by @Robot. Every Appian RPA robotic process must have the IRobot interface and @Robot annotation to allow the Appian RPA API to identify the class as a robot.

Open in Github Built: Fri, May 20, 2022 (01:29:28 AM)

On This Page

FEEDBACK