Schedules tab
The "Schedules" tab allows:
- viewing the list of previously created conditions of launching by schedule
- creating a new launch condition
- switching to the card of a launch condition
- deleting a launch condition
- enabling or disabling a launch condition
- switching to the list of production calendars
Description of the table of launch conditions
The "Schedules" tab provides a table with a list of all robot launch conditions that run on a schedule.
Column name / button name | Description |
|---|---|
| "Launch condition" column | Launch condition name This is a link (button) that opens the card of the selected launch condition |
| "Robot" column | Displayed:
If no robot is found that was specified in the launch condition, the value in this column will become empty and the launch condition will be disabled |
| "Host" column | The name and IP address of the host under whose account the robot will be launched |
| "Account" column | The account of the host on which the robot will be launched |
| "Next launch" column | Display the closest dates and times that Orchestrator will launch the robot according to the launch conditions This value is calculated by the system based on the launch time parameters from the launch condition card If the next start date cannot be calculated, the column will be blank and the launch condition will be disabled |
| "Author" column | Name of the user who created the launch condition or was the last person to modify this condition |
"Disable all" button
| By clicking this button you can disable all launch conditions from the list at once This button is displayed if there is at least one launch condition in the list that is enabled. If all launch conditions are disabled, the "Enable all" button is displayed instead of this button |
"Enable all" button
| By clicking on this button you can enable all launch conditions from the list at once This button is displayed if all launch conditions in the list are disabled. If there is at least one launch condition enabled, the "Disable all" button is displayed instead of this button |
"Delete" button
| When clicked, a window appears confirming the deletion of the selected launch condition: |
"Enable" button
| By clicking on it, you can turn on the selected launch condition If the robot or calendar specified in the launch condition is not found, or the date of the nearest launch could not be calculated, the launch condition will be turned off. If you try to turn it on, Orchestrator will generate an error |
"Disable" button
| By clicking, you can turn off the selected launch condition |
Use the Columns dropdown list to select which columns will be hidden or displayed, with the "Launch condition" column always displayed.
Launch condition card
Launch condition card description
Button name / field name | Description |
|---|---|
| "Back" button | Clicking this button closes the launch condition card without saving the changes made |
| "Edit" button | This button is displayed only in the card of an already created condition when it is opened (read mode) By clicking on the button, the card is switched to the editing mode:
|
| "Launch condition name" field | Launch condition name Duplicates in launch condition names are prohibited. The maximum number of characters allowed is 60 |
| "Robot" field | If the robot is not yet selected, only the "Select" button is displayed in the field. If the robot is already selected, it displays:
By clicking on the cross-shaped button, you can remove the selected robot |
| "Log level" field | A dropdown list that displays the possible logging level options for the workflow by level of importance that the robot will execute Default value: "Business" Available values:
More details on log levels can be found here: Log types |
| "Host" field | A dropdown list that displays the names and IP addresses of hosts for which there is data in the platform database. Only hosts to which you have configured access are displayed (for more information, see section Access control) |
| "Account" field | A dropdown list of accounts:
To be able to edit the current field, the host in the "Machine" field must be selected |
| "Launch time" field | If the launch time has not yet been configured, only the "Edit launch time" button is displayed in the field. If the launch time has already been configured, it is displayed:
By clicking on the cross-shaped button, you can clear the selected launch time settings |
"Choose" button | Clicking on the button opens the "Select robot" window. It is available only in edit mode. It is described in more detail below |
"Edit robot input parameters" button | When you click on it, the "Edit robot input parameters" window opens. It is available only in edit mode. It is described in detail below The button is displayed only if a robot that has input parameters is selected in the "Robot" field |
"Edit launch time" button | When clicked, the "Launch time" window opens. It is available only in edit mode. Details are described below |
"Create" button | This button is displayed in the card only when a new launch condition is created A new launch condition is created by clicking on the button |
"Save" button | This button is displayed in the card only when editing an already created launch condition. Clicking on the button saves the changes made to the launch condition parameters and puts the card in read mode:
|
"Cancel" button | This button is displayed in the card only when creating or editing an already created launch condition Clicking on the button opens a window with confirmation of canceling the changes made:
|
"Select a robot" window description
If you click the "Select" button in the "Robot" field of the launch condition card, the "Select a robot" window will open.
To select the robot that will be launched under this launch condition, you must:
- Click on the row with the desired robot version in the table.
- Click the "Select" button.
Robot table description
The table in the window contains a list of ready robots that are published to the platform's remote storage. Only those robots to which you have configured access are displayed (more details in the Access Control section).
Column name / button name | Description |
|---|---|
| "Robot" column | The name of the robot is displayed |
| "Version" column | Each row displays a specific version of the robot. If the robot has several versions, each of them is located on a separate row in the table. At the same time, all versions are always displayed in the order of their publication - from the newest to the oldest from bottom/top: The list of versions can be minimized or maximized using the Next to the version, there is an indicator that shows whether the host account needs a GUI to run this version of the robot. If |
| "Average time" column | If the robot version has been launched less than 2 times, the column indicates "No data" If this version of the robot has been launched 2 or more times, the column shows the average run time of this version of the robot, which Orchestrator automatically calculated based on the duration of previous launches. |
| "Author" column | The name of the user who published the robot version. Different versions of the same robot can have different authors |
| "Date of publication" column | Displays the date and time when the robot version was published |
Button | The records in the table are updated as soon as you click on it |
Use the "Columns" drop-down list to select which columns will be hidden or displayed, with the "Robot" and "Version" columns always displayed.
Configure robot input parameters
If the selected robot has input parameters, the "Edit input parameters" button will be displayed in the launch condition card. Clicking on this button will open the "Configure robot input parameters" window:
At the moment, only input parameters of type "String", "Number" and "Boolean" can be displayed in this window. If the robot has at least one input parameter with a data type other than "String", "Number" or "Boolean", the window will display a warning text along with fields of a valid type:
The selected robot contains input parameters with a data type whose transfer is not supported. Only parameters with the type "String", "Boolean" and "Number" can be configured, so the fields below are available to fill in only such parameters.
However, the absence of some parameters does not affect the ability to launch the robot.
The presence of the warning does not prevent the robot from launching or displaying fields of type "String", "Number" and/or "Boolean".
"Configure robot input parameters" window description
Button name / field name | Description |
|---|---|
| Robot name | The name of the robot that is selected in the launch condition card Not editable |
| Type: String | If the robot has a variable with type "String" marked as an input parameter, the window will display fields for entering the value of this parameter: The number of fields in the subsection is unlimited and depends on how many input variables with the type "String" have been created in the selected robot. The name of each such field is the name of the corresponding variable in the robot. Next to the field there is a hint about the parameter data type |
| Type: Number | If the robot has a variable with type "Number" marked as an input parameter, the window will display fields for entering the value of this parameter: The number of fields in the subsection is unlimited and depends on how many input variables with type "Number" have been created in the selected robot. The name of each such field is the name of the corresponding variable in the robot. Next to the field there is a hint about the data type of the parameter |
| Type: Boolean | If the robot has a variable with type "Boolean" marked as an input parameter, the window will display fields for entering the value of this parameter: The number of fields in the subsection is unlimited and depends on how many input variables with type "Boolean" have been created in the selected robot. The name of each such field is the name of the corresponding variable in the robot. Next to the field there is a hint about the parameter data type |
| "Save" button | When you click on it, the values specified in the input parameter fields are saved and the window closes |
| "Cancel" button | Clicking this button will cancel the changes made and close the "Configure robot input parameters" window |
Launch time setting
If you click on the "Edit launch time" button in the "Launch time" field in the launch condition card, the "Дaunch time" window will open:
In this window, you can configure how often the robot is launched.
"Launch time" setting window description
Button/field name | Description |
|---|---|
| Launch time | A string specifying the month(s), day(s), and hours\minutes at which the robot will be launched. Orchestrator generates the string automatically based on a combination of the launch time parameters specified in the other fields of the window |
| "Timezone" field | A dropdown list showing the possible time zone options The robot will be launched based on the selected time zone |
| "Start date" field | Field for entering the date and time when the launch condition as a whole will start to function The required date/time value can be specified manually or by using the date and time selection form, which is opened by clicking on the calendar button:
|
| "End date" checkbox | If the checkbox is enabled, a field is displayed below for entering the date and time at which the launch condition will stop working and will be automatically turned off: The required date/time value can be specified manually or by using the date and time selection form, which is opened by clicking on the calendar button: |
| Checkbox "Use business calendar" | If the checkbox is enabled, the fields are displayed below: When using a business calendar, Orchestrator will consider weekends and weekdays according to the specified calendar when calculating the nearest robot launch date |
| "Calendar" field | A dropdown list that displays the names of business calendars that have been added to Orchestrator. More information about calendars in the "Business calendars" subsection The field is displayed only if the "Use business calendar" checkbox is activated |
| "Launch rule" field | A dropdown list that displays the options for using the business calendar:
The field is displayed only if the "Use business calendar" checkbox is activated |
| Radiobutton "Every month" | The button is displayed only on the "Month" tab If it is active, the robot will be launched every month, taking into account the other parameters of the launch time |
| "Specific months" radio button | The button is only displayed on the "Month" tab If this radio button is activated, a field for selecting the month or months appears below:
The robot will only launch in the selected months, taking into account the other launch time parameters |
| "Everyday" radio button | The button is displayed only on the "Day" tab If this button is active, the robot will be launched every day, taking into account the other parameters of the launch time |
| "Specific weekdays" radio button | The button is only displayed on the "Day" tab If this radio button is activated, a field for selecting the day or days of the week appears below:
The robot will only launch on the selected days of the week, taking into account the other launch time parameters |
| "Specific month days" radio button | The button is only displayed on the "Day" tab If this radio button is activated, a field for selecting the day number or days of the month appears below:
The robot will only launch on the selected days, taking into account the other launch time parameters |
Radio button | The button is displayed only on the "Day" tab If this radio button is activated, in the dropdown list (located in the name of the button itself) you can select on which "first day", first Monday, first Tuesday, etc. of the month the robot will be launched, taking into account the other parameters of the launch time:
|
Radio button | The button is displayed only on the "Day" tab If this radio button is activated, in the dropdown list (located in the name of the button itself) you can select on which "last day", "last Monday", "last Tuesday", etc. of the month the robot will be launched, taking into account the other parameters of the launch time:
|
Radio button | The button is displayed only on the "Hours-minutes" tab If this radio button is activated, in the dropdown list (located in the name of the button itself) you can select after how many hours the robot launch will be repeated, taking into account the other parameters of the launch time: "Every hour", "Every 2 hours", "Every 3 hours" etc.:
|
Radio button | The button is displayed only on the "Hours-minutes" tab If this radio button is activated, you can select in the dropdown list (located in the name of the button itself) how many minutes the robot will be launched again, taking into account the other parameters of the launch time: "Every minute", "Every 30 minutes", "Every 40 minutes" etc.:
|
| Radio button "At specific time of the day" | The button is displayed only on the "Hours-minutes" tab If this radio button is activated, 2 dropdown lists are activated below, where you can select the exact time (hour and minute) when the robot will launch, taking into account the other launch time parameters:
|
| "Save" button | When the button is clicked, the window is closed, the selected combination of parameters is saved and displayed in the "Launch time" field in the launch condition card |
| "Cancel" button | When you click on it, a window appears confirming that you want to cancel the changes you have made: |
Creating a new launch condition
To create a new robot launch condition, follow the steps:
- Нажать на вкладке "Расписания" на кнопку "Создать условие Click the "Create launch condition" button on the "Schedules" tab. An empty card of the launch condition will open in the creation mode:
The card is described in the "Launch condition card" subsection.
Viewing and changing the launch condition
To view and change a previously created launch condition, you need to:
- On the "Schedules" tab, select the necessary launch condition in the table and click on its name. The card of this launch condition will be opened in the reading mode:
- Click on the button
if there is no need to make changes to the card. This will return to the "Schedules" tab in the "Launch conditions" section. If the launch condition card has been accessed via the host account card, clicking on 
, will take you back to the account card. - Click on the "Edit" button if you want to make changes to the parameters of the launch condition. The card will be switched to the edit mode:
- Make the necessary adjustments.
- Click the "Save" button to save the changes made. Or click the "Cancel" button if you decide not to save the changes. The card will be switched back to the reading mode.
Business calendars
When setting the launch condition (scheduled), you can use business calendars, so that the robots are launched only on working days or only on non-working days.
The calendar itself contains only the dates of days that are considered non-working days in the company. All other days that are not listed on the calendar are considered working days.
To work with the calendars themselves you need to:
- Go to the "Launch conditions" section, to the "Schedules" tab.
- Click on the "Customize business calendars" button. A page with calendars will be opened, where you can:
- viewing the list of previously created calendars
- creating a new calendar
- calendar deletion
Calendars table description
The table contains a list of previously added calendars.
Column/button name | Note |
|---|---|
| "Calendar" column | The name of the calendar is displayed There is always one standard calendar in the list of calendars, the "Default calendar (Robin)". This calendar contains the dates of all Saturdays and Sundays as days off, and the list of dates is endlessly updated by the Orchestrator itself. This calendar cannot be deleted, but can be used when setting the launch condition |
| "Author" column | Full name of the user who created the calendar |
| "Last updated date" column | Displays the date and time when the calendar was added to Orchestrator |
"Delete" button | When you click on it, a window appears to confirm deletion of the calendar: If the remote calendar was previously used in any launch conditions, those launch conditions will be automatically turned off |
You can use the "Columns" dropdown list to select which columns will be hidden or displayed, with the "Calendar" column always displayed.
Creating a business calendar
Example of a business calendar:
To create a new business calendar, you need to:
- Click on the "Create calendar" button. The "Upload calendar" window will be opened:
- Click on the "Choose file" button. An explorer window will open, where only CSV files are available for selection.
The following date formats are available in the business calendar file:
- dd.MM.yyyy
- dd-MM-yyyy
- dd/MM/yyyy
- dd.MM.yy
- dd-MM-yy
- dd/MM/yy
- The user selects the calendar file and confirms the selection in the explorer window. Alternatively, you can simply drag and drop the desired file into the Load Calendar window without invoking Explorer.
- The orchestrator starts checking the selected file:
- if the file is correct and the dates in it are in the correct format, and there is no calendar with the same name in Orchestrator yet (the name of the csv file is the name of the production calendar), the window will display a successful result of the check:
- The name of the selected csv file contains the phrase "(Robin)" (only a standard Orchestrator calendar can have this phrase). If there are problems with the selected file, the window will list the reasons why the calendar cannot be created in Orchestrator:
Reasons why creating a calendar will not be allowed:
- File formatting is incorrect
- The dates in the file are in an invalid format
- Orchestrator already has a calendar with the same name as the selected csv file (the file name will be used as the name for the new calendar).
- if the file is correct and the dates in it are in the correct format, and there is no calendar with the same name in Orchestrator yet (the name of the csv file is the name of the production calendar), the window will display a successful result of the check:
- If the file check was successful, you should press the "Confirm" button - the window will close and the new calendar will be added to the Orchestrator. If the verification was unsuccessful, you should click the button
- the selected calendar will be deleted, the original view of the "Upload calendar" window will return, and you can select another file.
Обзор
Инструменты контента