Templates
Use the Templates page to create, sort, and edit templates, which function as the base for Kapplets.
Templates can be created by developers, administrators, and global administrators.
For information about templates, see the following topics:
Create templates
-
Navigate to the Templates page.
-
Select the plus sign to create a new template.
-
On the General page, configure the following information.
-
Name: Type the template name.
-
Workspace: Select the workspace from the drop-down list.
-
Description: Type a short description to add more information about the template.
-
Timeout value and Time unit: Set the preferred timeout value and select the time unit to specify how long robots remain in a queue on RoboServer. The timeout applies to all robots in a template. Default is 600 seconds.
-
Icon: Add an icon to make the template unique and easy to distinguish. By default, the icon is inherited from the workspace. To change the icon, either select an image from the Gallery or upload a new one. Tag the uploaded image to make it easy to find among the other images.
The image Gallery supports only .png and .jpeg files.
-
-
Select Next.
-
On the Robots page, select one or more robots.
If the robot list is long, use the search field to find the robots you want.
-
When selecting multiple robots, select the Selected robots
button on the toolbar to view robots you have selected. The number of selected robots is shown on the button.
-
On the Selected robots pane, use the Run sequentially button to define the robot execution order.
-
Filter robots by a Management Console project on the Settings pane.
-
-
Select Next.
-
On the Inputs page, configure input parameters for the selected robots.
This step is added to the procedure if one of the selected robots contains input parameters.As you set input parameters and validation rules on the Inputs page, they are automatically validated. If an error is returned, correct the input parameter and/or corresponding validation rule. When the input is valid, the Next button is active.
-
Select a robot to see its variable types.
-
On the window with robot variables, select a variable to configure its attributes.
-
All of the attributes are listed on the window next to the variables window.
-
To change the input field order, configure the order on the Start page (see Pages step that follows), then enable the Template sort option after saving the template. See Sort templates.
-
On the Inputs pane, type in a Field label and Field hint for display on the Start page.
-
Select the Required and Hidden check boxes as needed to configure how the fields are represented on the Start page.
-
Configure individual parameters. The set of parameters depends on each attribute.
-
-
Select Next.
-
On the Pages pane, configure the following as needed.
-
On the Start page, edit the page title and type a description for the page in the Page text field.
-
Drag an item on the Fields order list to change its order.
-
On the Status page, edit the page title.
-
To see the execution result in a table, select the Add table page
icon on the toolbar.
-
On the Table page, edit the page title and description.
-
Select a robot from the list to configure its parameters. The Return Type list consists of the output types of the selected robot.
-
Select a parameter to define its fields for the table.
-
Use the Available Commit Action option to assign different robots for committing an action for each of them. See Select robots for Commit Action.
-
-
To see the execution result in a chart, select the Add chart page
icon on the toolbar.
-
On the Chart page, edit the page title and description.
-
Select a robot from the list to configure the parameters that display on the chart.
- Select the following parameters:
-
Chart type
-
Color scheme
-
Label axis
-
Data axis
-
- Configure other chart parameters.
-
Preview the chart by selecting the Preview button.
-
-
-
Select Save to save the template.
A template object looks similar to the following. To create a Kapplet from the template, see Create Kapplets.
Sort templates
The Template view contains the robot name, input variable name, and input fields. By default, the "Template sort" button is disabled on the Kapplets run page. When you enable this option, the view includes only the input fields.
To change the default view, enable the Template sort option. Note that this option doesn't sort the order of input fields for existing templates.
To sort the input fields:
-
When creating a template, configure the input field order on the Start page.
-
Select run Kapplets, and when the new Start page is opened, the robot names, variable names, and input fields appear.
The input fields are displayed in the default view.
-
Select Template sort to change the default input field view so that it matches the order that you configured on the Start page of the template.
Edit templates
To modify or remove a template, select the Open context menu button.
When you edit input parameters and validation rules on the Inputs page, they are automatically validated. If an error is returned, correct the input parameter and/or corresponding validation rule. When the input is valid, the Next button is active.
Select robots for Commit Action
When you use two robots consecutively, you might need to use the output data of the main robot as the input data for one or more supporting robots. Design each supporting robot so that it has only one input and one output type. If the primary robot has several output types, assign other robots for committing actions. The input and output types must match in the supporting robots.
The following procedure describes how to pass data between robots.
-
Navigate to the Templates page.
-
Create a new template or edit an existing one.
-
Navigate through the configuration panes until you reach the Pages pane.
-
Locate the Return Types list, which consists of the output types of a selected robot.
Available and unavailable types for committing an action appear in separate cards.
-
On the Available Commit Action pane, select a robot from the list.
You can assign all the robots for the available return types at the same time.
It is vital that the input and output types are identical. Check them carefully if a notification "No Robots available for Commit Action" appears in front of the types you want to use.
-
Execute the primary robot.
-
After the primary robot has finished its execution, select the History page.
-
On the Table page tab, view a list of the supporting robots configured in the previous steps.
-
Select one or more supporting robots by checking the Select for Commit Action box.
-
When the Commit Action button becomes active, select it to view the results of the execution.
You cannot execute the same robot twice.
-