Audience & purpose

As an Automation Admin/privileged user you want to activate a created automation.

Audit details information

Key items

• Status: Successful/unsuccessful
• Time: <date-time>
• Action type: Activate Schedule

Audit view

Audit details

Return to top

Audience & purpose

As an Automation Admin/privileged user you want to get the details for a created automation.

Audit details information

Audit Landing page

• Status: Successful/unsuccessful
• Time: <date-time>
• Action type: Create automation

  

  • Audit details for "Run Robot now":

    

  • Audit details for "Schedule Robot":

    

Return to top

Audience & purpose

As a Product user, if any Robot runner is not in a connected state or any system error happens, a retry will give another opportunity to allow business continuity. You want an Audit log to reflect this action.

Audit information

Key items

• Status: Successful/unsuccessful
• Time: <date-time>
• Action type: Deactivate Schedule

Audit view

Audit details

Return to top

Audience & purpose

As a Product Admin or user having privileges, you want the details of a deleted automation.

Deleting automation Schedules

Note: Only Schedules can be deleted. See the following screenshots:

• Audit View details:

  

• Audit Details page:

  

Return to top

Audience & purpose

As a Product user editing an automation, you want the details for the edited automation.

Audit information

Audit Landing Page

• Status: Successful/Unsuccessful
• Time: <date-time>
• Action type: Edit Automation

Audit view

Audit details

Return to top

Audience & purpose

As a Product user while creating an automation, you want to specify a number of retries and a retry interval so that the automation will not skipped if there are any errors while deploying.

• For example, if any Robot runner is not in a connected state or any system error happens, a retry will give another opportunity to allow the business continuity.

Description

While creating/updating an automation, you want to specify number of retries (up to 3) and retry interval (in minutes from 1 to 99).

• If there is any error during the deployment, the system will retry the deployment on that Robot runner up to the maximum retries specified at the end of each interval.
• By default a retry will be set to blank and the maximum number of retries is hidden.
• If you specify a retry interval, the maximum retries will be shown and set to 1 by default.

Return to top

Audience & purpose

As a Product user you will be able to view all the schedules that you are entitled to so that you can act on them as required.

Landing table

You login to Product and go to the "Devices" → "RobotFarm" tab.

1. The system will display the "All master images" page with the following columns.

   

   • Status: "Available" if the image can be used to run/schedule a Robot. Otherwise, "Unavailable".
   • Name: Name of the image.
   • Description: Description.
   • Tags: Comma separated list of tags associated with the image.
   • Device version: Product Client version is available for this image.
   • Actions: Actions available for this image
   • Created on: Date the image was created
2. Only users with any of the following system roles can view this page:
   • Admin
   • RobotFarmAdmin

Page-level toolbar

The "Run" icon is displayed at the top of the page.

1. Click "Run" to show the following two options based on the user's privileges.
   • Run bot now…: Only if you have the "Run" privilege.
     • This will take you to the "Create automation" wizard for "Run now".
   • Schedule bot…: Only if you have the "Schedule" privilege.
     • This will take you to the "Create automation" wizard for "Schedule Robot".

Row-level toolbar

The Run icon will be displayed for each image with a status of "Available".

1. Click "Run" to show the following two options based on your privileges.
   • Run bot now…: Only if you have the "Run" privilege.
     • This will take you to the "Create automation" wizard for the "Run now" 2nd tab with the current image pre-selected (in the image section).
   • Schedule bot…: Only if you have the "Schedule add" privilege.
     • This will take you to the "Create automation" wizard for "Schedule Robot" with the current image pre-selected (in the image section).

Breadcrumbs

The system will display the path you took to reach the current page (at the top of the page): Devices → Robot Farm.

Return to top

Audience & purpose

As a Product user you want to view all of the schedules that you are entitled to so that you can act on them as required.

Landing table

You login to Product and go to the "Devices" → "RobotFarm" tab.

1. Click the "View" icon of an image to display the "Details" page.
2. Only users with any of the following system roles can view this page:
   • Admin
   • RobotFarmAdmin

Page Level Toolbar

The "Run" icon is displayed at the top of the page.

1. Click "Run" to show the following three options based on the your privileges.
   • Run bot now…: Only if you have the "Run" privilege. This will take you to the "Create automation" wizard for "Run now".
   • Schedule bot…: Only if you have the "Schedule" privilege. This will take you to the "Create automation" wizard for "Schedule Robot".
   • Run bot with queue…: Only if you have the "Run"/"Schedule" privilege. This will take you to the "Create automation" wizard for "Run Robot with queue".

Breadcrumbs

The system will display the path you took to reach the current page (at the top of the page): Devices → Robot Farm.

Return to top

Audience & purpose

As a Product user you will be able to view and add task dependencies before deploying a Robot so the Robot can successfully complete. Note:

• You will know what all the dependencies are for the selected Robot so you can make sure they are available while scheduling.

Creating from Automations → In progress or Scheduled

Use the following directions:

1. Login to Product with "Run/Schedule Add" privileges.
2. Go to the "In progress" tab under "Activity" and click the "Run" → "Run bot now" icon.
   1. The system takes you to the "Robot + Dependencies" tab in the "Create Automation" wizard.
   2. Select a Robot from the "Select Robot" section. See the following screenshot:

      

3. In the "Review dependencies for <bot name>" section, all dependencies of the selected Robot will be displayed in a tree structure, for example:
   • IQRobot, MetaRobot, Subtask, or a Task called using the "Run Task" command.
   • Any documents referenced in the task files (with the Product Repository path).
4. A task with a subtask that is unavailable in the Product repository is indicated by a red [ ! ] icon.

Using Robots with IQRobots

1. Create a Robot (in Product version 10 LTS) which calls an IQRobot.
2. Upload the Robot and IQRobot to Product in version 10 LTS.
3. When the Robot is shown in Product 11.0, the IQRobot will also be shown as a dependency.
   • Note: There will be no "My IQRobots" folder.
   • The IQRobot will be deployed along with the main Robot.

Return to top

Audience & purpose

As a Product user you will be able to deploy a task on an available Robot runner so that you can complete the tasks as per the business needs.

• This enables you to create a schedule so that automation can be pushed to a Robot runner.

From Automation → In-Progress or Scheduled

Login to Product with "Run/Schedule - Add" privileges.

1. Click "Run Robot" under the "Run" icon from the "Schedules" page.
2. The system takes you to the "Robot + Dependencies" tab in "Run Robot now" wizard. See the following screenshot.

   

   • The page title is "Run bot now".
3. Note the embedded Help message:
   • "When you run a Robot immediately (rather than schedule it to run later), we automatically use the latest version of the Robot and supporting files."
4. Under the "Select a Task Robot" section, display the Standard Robots tree/table.
   • Only show Task Robots. Nothing else is relevant.
   • Only show Task Robots that you have permission to see.
5. Use the "Select" button to select a Robot.
   • Once a Robot is selected, change the name to "Replace”.
6. In the "Select Robot" section, display all and only the folders that you have access to.
   • By default, select the "My Tasks" folder if you have access to it.
   • Otherwise, select the first folder from the top where you have access.
   • You will be able to select only one task file from the "Select Robot" section.
   • See the following screenshot.

     

VC (Version Control) on

If VC is turned on, the "Latest Version" and "Production Version" columns will be displayed.

1. The Production Version column will be grayed out for the "Run now" option.
2. The Latest Version column will be grayed out for the "Schedule" option.
3. Robots with no production version set cannot be selected for the "Schedule" option.
4. For the "Schedule" option, the Help message will be:
   • "When you schedule a Robot to run later, we automatically use the production version of the Robot and supporting files.
     Robots and supporting files without a production version are disabled."

Breadcrumbs

The system will display the path you have taken to reach the current page.

1. The breadcrumb trail depends on where you came from. For example:
   1. Robots → My Robots → Run Robot now
   2. Devices → My Robot runners and Robot creators → Run bot now
   3. Etc.
2. No matter which tab you are on, the breadcrumb trail stays the same.

Return to top

Audience & purpose

As a Product user you will be able to:

• Deploy a task on an available Robot runner to complete the tasks as per business needs.
• Add/delete any of the manual dependencies.

Creating automation for Robot supporting files

Login to Product with "Run/Schedule - Add" privileges.

1. In the "Create Automation" wizard under the "Review dependencies for <bot name>" section, the system will display all folders from the repository manager based on your privileges.
   • Note: Only those folders that you have access to will be shown. See the following screenshot:

     

2. The system will pre-populate the previously added supporting files for the selected Robot.
3. Click a particular folder to display all the files from that folder in the "Available Files" Section.
   • Note: This will be minus any files which were already selected from that folder as supporting files.
4. You can select/unselect any of the files from the list by clicking the check box next to it.
   1. Click the checkbox at the header level to select/unselect all the files from the list.
      • Clicking the ">>" icon, the system adds the selected files to "Selected Files" section (and the same will be removed from the "Available Files" section).
      • Clicking the "<<" box, the system removes the selected files from "Selected Files" section (and the same will be added to the "Available Files" section under the right folder).

Supporting dynamic dependencies

You will be able to add other TaskRobots, MetaRobots and IQRobots as a dependency to support dynamic dependencies (one with a variable name).

1. The selected Task Robot appears in the tree/table, but is disabled and cannot be selected.
2. If VC (Version Control) is on, the "Display Latest Version" and "Production Version" columns are shown.
3. If you come to this page by selecting the "Schedule bot" option:
   • Latest version column will be grayed out.
   • Robots with no production version will be grayed out and cannot be selected.
4. If you come to this page by selecting the "Run bot now" option:
   • The "Production Version" column will be grayed out.

Return to top

Audience & purpose

As an Admin or RobotFarm Admin you will be able to create an automation by selecting an image from the RobotFarm so that the Robot can be deployed onto the instances of these images.

• This will enable you to deploy Robots onto Robot runners from RobotFarm.

Understanding tab titles

Use the following guidelines regarding tab titles.

1. You (as an Admin/RobotFarmAdmin) with the "Run" or "Create Schedule" privileges login to a Product with the integrated Robot Farm app.
2. You come to the "Create automation wizard" by selecting either "Run bot now" or "Schedule bot".
   • If it is the "Run bot now" wizard, the 2nd tab title will be "DEVICES + IMAGE". Otherwise it will be the "SCHEDULE + DEVICES" tab title.
   • The system will display the image section in the 2nd tab as shown in the following screenshot.

     

Selecting an image

Under "Available images" the system will display all the images in the system.

1. Only images with a status of "Available" are enabled for selection. The rest of them will be grayed out (all available images will be at the top and sorted by name).
2. The image count will be displayed on the table header, for example, "Available images (4 of 4)".
3. Select an image from the list and click the "Select" button to select the image.
4. The selected image's details will be populated on the right side. The "Select" button name will change to "Replace".
5. Select another image and click the "Replace" button to change the image selection.
6. The selected image name and count of instances in brackets will be updated at the top of the tab (for the "Run bot wizard").

Providing an instance name

The system will auto-populate the instance name.

1. The default name will be:
   • Task Name.<date and time>.<user_id who created the automation>.
   • Note: Date and time should take this format: YY.MM.DD.HH.mm.ss, for example: HR Robot.17.07.04.23.45.15.admin.
2. You can update the name. It should contain only alphanumeric and underscore (_) and (.). It should not include any special characters.
3. The name cannot be blank or be an empty string, and it should be unique in the system.
4. If you did not update the automation name but changed the Robot selection, the name will change with the new Robot selected.
   • If you already modified the name, changing the Robot selection will not change the name.
5. The maximum length for the name is 255 characters. It should be at least the same size as from the 10.x version.

Providing the number of instances

Please provide the number of instances for this automation.

• By default, the value will be 1.
• You can provide any value up to the maximum allowed by the RobotFarm Robot runner license.

Selecting a device user

The system will populate the list of device users in the drop-down.

• Only users with "RobotAgentUser" privilege will be shown in this drop down, and by default it will select the user associated with the image.
• You can change the a device user from within the list.
• The check box of "Automatically release VM when bot is finished" will be checked by default. You can un-check it if it suits you to do so.
  • If you un-check it, a message will be displayed asking you to confirm this action.

Return to top

Audience & purpose

As a Product user you want to deploy a task on an available Robot runner so that you can complete the tasks as per business needs.

• You will be able to select the required devices for a given automation.

Run a Robot now

Login to Product with "Run/Schedule - Add" privileges.

1. Go to the "In Progress" tab under "Activity" and click the "Run" → "Run Robot now" icon.
   • The system takes you to the first tab in the "Create Automation" wizard.
2. Go to the second tab "Devices". See the following screenshot.

   

   1. On the "Devices" Tab, the system displays the list of devices (Robot runners) that you have access to under the "Select one or more Robot runners" section.
   2. The following data table contains these columns:

      Status	Name
      Upcoming Schedule	"Scheduled" if any schedule exists, or "No schedule" if no schedule exists.
      User name	The user (you) who connected on this device.

   3. You can select one or more connected devices (Robot runners) from the list.
   4. Devices that are not currently connected will be disabled and you cannot select them.
   5. The System displays the first two selected device names in the tab header.
      • If more than two devices are selected, it will display the remaining count.
      • Note: An ellipsis ( ... ) will be displayed if the name cannot fit, and a tooltip will display the full name.
   6. Your Product device (the one on which you logged in) will be shown at the top. The rest can be ordered based on their status (the first one connected) followed by the name of the device by default.
   7. The system will show:
      • the count of available devices and
      • the count of selected devices
      at the top of their respective tables.
   8. You will be able to filter/sort the devices in the "Available Robot runners" section.

Schedule Robot

You come to this wizard by clicking on "Schedule Robot". See the following screenshot

1. The tab title will be "SCHEDULE + DEVICES".
2. You can select any device from the list (connected/disconnected).

Breadcrumbs

There will not be any change in the breadcrumb trail when you change tabs.

Return to top

Audience & purpose

As a Product user you will be able to deploy a task on an available Robot runner so that you can complete tasks as per business needs.

• You can decide whether to use the selected device or not, based on the upcoming schedules of that device.

Run from Automations → In Progress or Scheduled

Login to Product with "Run/Schedule - Add" privileges.

1. You come to the "Create automation" wizard by selecting the "Run bot now" or "Schedule bot" option under "Run".
2. On the "Devices" tab, in order to view the upcoming schedules you have to click on the device row. See the following screenshot:

   

3. You can only select one row at a time to see the upcoming schedules, and only show the schedule of the selected device. (if there is a schedule).
4. Checked devices (the ones with select check box checked on "Available Robot runners" section or the ones in the "Selected Robot runners" section) are irrelevant to what is showing in the "Upcoming schedules" table.
5. The system displays the upcoming schedules for the selected device under "Upcoming schedules for selected device: <Device Name>". See the following screenshot.

   

6. The data table named "Scheduled activity (#count of schedules)" contains the following columns.
   • Type
   • Next Occurrence (the default sort on this column shows the earliest one first)
   • Robot
   • Activity name
   • Schedule
7. If a device has no schedule, the data table will be shown with 0 items and the message: "There is no scheduled activity for this device."
8. You will be able to sort the items in the table.
9. The count of schedules will be shown at the table header.

Return to top

Audience & purpose

As a Product user you want to schedule an automation into the future so that a task can be executed at a specified time as per the business needs.

• This will also enable you to create an automation to run immediately.

Description

By default the system populates the automation name as follows. See the following screenshot.

1. Automation name: Task Name.<date and time>.<user_id who created the automation>
2. Date and time: YY.MM.DD.HH.mm.ss. For example, HR Robot.17.07.04.23.45.15.admin
3. You can update the "Automation name".
   • It should only contain alphanumeric and underscore (_) and '.'.
   • It should not include any special characters.
   • It cannot be blank or be an empty string.
   • It must be unique in the system.
4. If you did not update the Automation name but changed the Robot selection, the Automation name will change with the new Robot selected.
   • If you already modified the name, changing the Robot selection will not change the name.
5. You will be able to provide a description for the given automation.
6. Note:
   • The maximum length for the "Automation name" is: 255 characters (it should be at least the schedule name size from Product version 10.x).
   • The maximum length of the "Automation description field" is: 255 characters (this is the standard size of the description field as in Credential Vault).

Return to top

Audience & purpose

As a Product user you want to deploy a task on an available Robot Runner so that you can complete the tasks as per business needs.

You can arrive at the Create Automation wizard from different pages of the Product. See the following options:

1. From the Robots page → My Robots tab (using the Run icon)

Login to Product with "Run/Schedule" privileges and with access to a "Task Robot" folder.

1. Go to the "Robots" page, click the "My Tasks" folder, and select a Task Robot from the list.
2. Click the "Run" icon.
   • The system:
     • Takes you to the "Robot + Dependencies" tab in "Create Automation" wizard.
     • Auto-populates details of the selected Robot in "Select Robot" section and its dependencies (if any) in "Robot Dependencies" section.
3. The breadcrumb trail will be displayed as follows:
   • Robots → My bots → New automation

2. From the Robots page → My Robots tab (using the Schedule icon)

Login to Product with "Run/Schedule" privileges and with access to a "Task Robot" folder.

1. Go to the "Robots" page, click the "My Tasks" folder, and select a Task Robot from the list.
2. Click the "Schedule" icon in the "Actions" tool-bar.
   • The system:
     • Takes you to the "Robot + Dependencies" tab in "Create Automation" wizard.
     • Auto-populates details of the selected Robot in "Select Robot" section and its dependencies (if any) in "Robot Dependencies" section.
3. The breadcrumb trail will be displayed as follows:
   • Robots → My bots → New automation

From the Devices page (using the New Automation icon)

Login to Product with "Run" privileges and with access to one or more devices.

1. Go to the "Devices" page.
2. Select one or more devices from the list.
3. Click the "New Automation" icon.
   • The system:
     • Takes you to the "Robot + Dependencies" tab in the "Create Automation" wizard.
     • Auto-populates Device details in the "Devices" tab of the "Create Automation" wizard.
4. The breadcrumb trail will be displayed as follows:
   • Devices → Robot runners → New automation

Return to top

Audience & purpose

As a Product user you want to schedule an automation into the future so that a task can be executed at a future specified time as per business needs.

• You will also be able to create an automation to run immediately.

Run now process

Login to Product with only the "Run" privilege.

1. Open the "New Automation" wizard by clicking the "Run Robot now" option (from any of Activity/Devices/Robots or other tabs). See the following screenshot:

   

2. Select a Task Robot, go to the "Device" tab, and select a device.
3. The "Run now" button at the top will be enabled only if all the required data for the activity is present:
   • Robot
   • Device
   • Name

   

4. Clicking the "Run now" button will enable the system to validate the data.
5. If no errors found, a toast message will be displayed.
6. Any changes made to the supporting files will be saved.
   • All existing schedules will see these new changes.
   • Any schedule that is going to fire will get the new set of supporting files.
7. The system will deploy the Robot along with the required files on the selected devices.
8. You will be taken to the page from which you launched the wizard.

Error messages

The following messages will be displayed if errors are found.

Reason	Message
Selected Robot got deleted.	<name of object> wasn't found. It may have been renamed, moved, or deleted. To continue, please contact your system administrator.
Access removed for the selected Robot's folder.	You no longer have permissions for the Robot/file <name of bot/file> To continue, please contact your system administrator.
Dependency/Supporting file got deleted	<name of object> wasn't found. It may have been renamed, moved, or deleted. To continue, please contact your system administrator.
Access removed for the Dependency/Supporting file	You no longer have permissions for the bot/file <name of bot/file>. To continue, please contact your system administrator.
Password not provided	Please provide a valid password.
Password invalid	Password for <name of bot/file> is invalid.
Device not present in the system	<name of object> wasn't found. It may have been renamed, moved, or deleted. To continue, please contact your system administrator.
Access to devices removed	You no longer have permissions for device(s) <Device1> <Device2> To continue, please contact your system administrator.
Name not unique	Name should be unique.
No Run privilege	You no longer have permission to run a Robot. To continue, please contact your system administrator.
Device not active	The device(s) below are disconnected and cannot be selected. <Device1> <Device2>
Toast message	<name of bot> successfully scheduled to start now.
No Schedule privilege	You no longer have permission to schedule a Robot. To continue, please contact your system administrator.
Production version not set for selected Robot	Production version for <Robot name> is not set. To continue, please contact your system administrator.
Production version not set for Dependent/Supporting Robot files	Production version for <Robot name> is not set. To continue, please contact your system administrator.
Invalid Schedule (There won't be any occurrence)	The schedule recurrence pattern is invalid.
Toast Message	<name of bot> successfully scheduled.

Return to top

Audience & purpose

As a Product user you want to schedule an automation into the future so that a task can be executed at a specified time as per business needs.

• The will also enable you to create an automation to run immediately.

Schedule a Robot

You have the "Schedule Add" privilege and login via your browser to Product.

1. Open the "New Automation" wizard by clicking the "Schedule bot" option (from any of Activity/Devices/Robots or other tabs).
2. Select a Task Robot, go to the Device tab, and select a Device.
3. The "Schedule bot" button at the top will only be enabled if all of the following required data for the activity is present:
   • Robot
   • Device
   • Name

Scheduling an automation

1. Clicking the "Schedule bot" button tells the system to validate the data.
2. If no errors are found, the system will save the schedule in an "Active state" and take you from where you launched the wizard.
3. A toast message will be displayed when the automation scheduling is successfully saved. See the following screenshot.

   

4. Any changes made to the supporting files will be saved against the selected Robot.
   • All existing schedules will see these new changes.
   • Any schedule on this Robot that is going to fire after this change will get the new set of supporting files.

Return to top

Audience & purpose

As a Product user you want to schedule your automation to run every X minutes/hours on a given day.

Schedule automation

Step-by-step

1. Login to Product with "Schedule - Add" privileges.
2. Select the "Schedule bot" option to open the "Create new automation" wizard.
   • While creating a schedule, you can schedule an automation to run every X minute(s) or hours for recurring options.
3. To support a schedule, select the checkbox "Repeat every". By default the checkbox is unchecked.
4. When selected, specify a number in the text box.
   • It accepts any integer between 1 and 999 (inclusive).
   • A drop-down menu next to this text box will have two options: minute and hour. It defaults to "hour".
5. If you select the "Repeat every" checkbox:
   • "End time" is required.
   • "End time" must be greater than the "Start time".
   • "End time" defaults to 11:59 PM.
6. The Repeat interval must be less than the (End time - Start time).
   • For example, if the schedule starts at 5 pm and ends at 11 pm, the "repeat interval" must be less than 6 hours.
7. If the "Start date" is invalid (e.g., 30th Feb), then the tool-tip will be:

   The start date is empty or invalid. Please provide a valid start date.

   This will be the same for the "End date".

Return to top

Audience & purpose

As a Product user, you want to schedule an automation into the future so that a task can be executed at a specified time in a future date, as per business needs.

Default actions

Login to Product with "Schedule - Add" privileges.

1. Open the "New Automation" wizard (from any of the Activity/Devices/Robots tabs) by clicking "Schedule Robot" under the "Run" icon.
   • This will open the "Schedule + Devices" tab.
2. Under the "Create Schedule" section you have the following options:
   • Run once (the default)
   • Recurring
3. By default, "Run once" will be selected. See the following screenshot:

   

Run once option

If you select "Run once" (the default as shown in the preceding screenshot), the following items are required.

• Start date and time
  • The "Start date" should default to today's date.
  • The "time" should default to:
    • Round up to the closest half-hour that is at least 15 minutes away. For example:
      • If it is 1:43, go to 2:00.
      • If it is 1:31, go to 2:00.
      • If it is 1:55, go to 2:30.
    • You can change the date and time.
      • The Start date should be later than or equal to the current date.
      • If the Start date is today's date, the schedule time cannot be less than the current time.

Run repeatedly option

When you select the "Run repeatedly" option, you can select "Start date", "End date", and "Start time".

• The "Start date" will default to today's date.
• The "Start time" will default to:
  • Round up to the closest half-hour that is at least 15 minutes away. For example:
    • If it is 1:43, go to 2:00.
    • If it is 1:31, go to 2:00.
    • If it is 1:55, go to 2:30.
  • The "End date" will be blank by default.
  • You can change the date and time.
  • The Start date should be later than or equal to the current date.
  • If Start date is today's date, the schedule time cannot be less than the current time.
  • The "End date" will be later than or equal to the "Start date".

Schedule options

Daily

Every X day(s)

This should occur every X day from the start day.

• X should be an integer, greater than 0, and up to 99.
• The default value should be 1.

The label in the tab header under "SCHEDULE" will change to "Run every day at <start time>" if X is 1; else "Run every <X> days at ". For example:

• If X = 1, it happens every day from the "Start day" to the "End day" (inclusive).
• If X = 2, it happens every other day starting from the "Start day".
• See the following screenshot.

  

Weekly

Every X week(s) on:

Monday, Tuesday, …., Saturday, Sunday

• The week starts on Monday and ends on Sunday.
  • X is an integer, greater than 0, and up to 52.
  • The default will be 1.
• The label in tab header under "SCHEDULE" will change to "Run every <Tue, Wed> at <start time>" if X is 1; else "Run every <X> weeks <Tue, Wed> at <start time>". For example:
  • If X = 1, and you selected Monday and Tuesday, it will occur every Monday and Tuesday between the Start and End days (inclusive).
  • If X = 2, and you selected Tuesday and Thursday, it will happen every other week on Tuesday and Thursday.
  • If the "Start date" falls on Wednesday for that week, it will only be scheduled on Thursday; the Tuesday event for that week will not happen. There will not be any event on Tuesday/Thursday next week since X = 2.
• See the following screenshot.

  

Monthly

Day X of January, February,…,December

X should be integer greater than 0 and less than or equal to 31.

It will occur on every X day of the selected month(s).

• This will be the default option with X = 1.
• The current month as the month.

The label in the tab header under "SCHEDULE" will change to "Run every <Jan, Feb ...> <X> at <start time>". For example:

• If X = 5 and you selected February and March, it will happen on every 5th of February and March between the Start and End dates (inclusive).

The First/Second/Third/Fourth/last Monday/Tuesday/.../Saturday/Sunday of January, February,…,December.

• In this option, default to:
  • "First" in the 1st drop down.
  • "Monday" in the 2nd drop down.
  • Current month for the month.
• The label in the tab header under "SCHEDULE" will change to "Run every <First> <Mon> of <Jan, Feb ...> at <start time>".
  • For example, if you select the 2nd Saturday of February and March, it will happen on every 2nd Saturday of February and March between the Start and End dates (inclusive).
• See the following screenshot.

  

Return to top

Audience & purpose

As a Product user creating an automation, you want to specify a number of retries and a retry interval.

• This is to ensure that the automation will not be skipped if there are any errors while deploying.
• For example, if any Robot runner is not in a connected state, or if any system error happens, the retry will give another opportunity to allow business continuity.

Specify retries

While creating/updating an automation, you will be able to specify the number of retries (up to 3) and the retry interval (in minutes from 1 to 99).

• If there is any error during the deployment, the system will retry the deployment on that Robot runner up to the maximum number of retries specified at the end of each interval.
• By default, "Retry after" will be set to blank and "Max retries" is hidden.
• If you specify a retry interval, "Max retries" will be shown and set to 1 by default.
• See the following screenshot.

  

Return to top

Audience & purpose

This is used to deploy an automation package on Product Clients.

Process

When it is time for an automation to execute, the system will deploy the Robot and all of its dependencies and supporting files.

• If the automation is for "Run now", and VC (Version Control) is on, the system will deploy the latest versions of all files (Robots/dependencies/supporting files) on the respective devices.
• If the automation is for "Schedule", and VC is on, the system will deploy the production versions for Robots (Task, IQ, and Meta Robots) and latest versions for all other types of files.
• Automaton will be deployed to the specified user session on the specified machine.

Return to top

Audience & purpose

As a Product Admin you need authorization for the "Schedule and run" module, integrating with the "User management" module, to enable authorization on an automation resource.

Landing table authorizations

"View my scheduled bots"

▸ You will ONLY get to view the schedules that you have created, AND ONLY for Robots to which you have folder access.

▸ The mouse-over tip (right panel text) is:

Users will see the schedules which they have created on the Robots which they have access to.

"Schedule my bots to run"

▸ You will ONLY get to schedule the Robots to which you have folder access. The mouse-over tip is shown in the following screenshot.

"Edit my scheduled activity"

▸ You will ONLY get to edit the schedules that you have created, AND ONLY the Robots to which you have folder access.

▸ The mouse-over tip (right panel text) is:

Users can edit their schedules.

"Delete my scheduled activity"

▸ You will ONLY get to delete the schedules that you have created, AND ONLY the Robots to which you have folder access.

▸ The mouse-over tip (right panel text) is:

Users can delete their schedules.

"View and manage ALL scheduled activity"

▸ You will get to view, edit, and delete all the schedules that have been created for the Robots to which you have folder access.

▸ The mouse-over tip (right panel text) is:

Users can view, edit and delete all the schedules on the Robots which the user has access to.
This includes the schedules that the user has created and those created by others.

Return to top

Audience & purpose

As a Product user with "Update schedule" or "Manage all schedules" privileges, you want to activate a schedule that is currently inactive in order to have the system start deployments as per the schedule.

Activation

1. Login to Product with the "Update schedule" or "Manage all schedules" privilege.
2. On the "Schedule" landing page, there will be a provision to "Deactivate" schedules for all Active schedules.
3. The "Activate" / "Deactivate" is a toggle button (in the Actions bar).
   • Note: It is the same icon/toggle button that we have to activate / deactivate a user with the tool-tip "Activate schedule" (for deactivated schedules), and "Deactivate schedule" (for active schedules).
4. The system:
   • Will start the deployments for the activated schedules.
   • Will display an error if the operation fails.
5. If the schedule is deactivated, then its entry from the "next occurrence" section will be removed.
6. If the schedule is activated, its entry will be added to the "next occurrence" section.
7. The "Activate/Deactivate schedule" will be an option (toggle) in the "View schedule" page.
8. There will be one more column in the Schedules landing page named "Status".
   • The status will either be "Active" or "Deactive".
   • By default, this column will be before the "Modified by" column.

Security

Only schedules to which you have access can be activated. See the following privilege and schedules data table.

Privilege	Schedules
Only "Update schedule"	Only "Inactive" schedules created by this user.
Only "Manage all schedules"	Any "Inactive" schedule in the system.
Robot "Update Schedule" and "Manage all schedules"	Any "Inactive" schedule in the system.

Audit log

For reference, see the "Audit: Activate automation" topic at the beginning of this page.

Return to top

Audience & purpose

As a Product user with the "Update schedule" or "Mange all schedules" permission want to deactivate a currently-active schedule in order to halt any feature deployments for it.

• This is important if you see any issue with a particular active scheduled automation, that you can deactivate it so that it will no longer be fired.

Deactivation

1. Login to Product with the "Update schedule" or "Manage all schedules" privilege.
2. On the "Schedule" landing page, there will be a provision to "Activate" schedules for all deactivated schedules.
3. "Activate" / "Deactivate" is a toggle button (in the Actions bar).
   • Note: It is the same icon/toggle button that we have to activate/deactivate a user with the tool-tip "Activate schedule" (for deactivated schedules), and "Deactivate schedule" (for active schedules).
4. The system:
   • Will start the deployments for the activated schedules.
   • Will display an error if the operation fails.
5. If the schedule is deactivated, then its entry from the "next occurrence" section will be removed.
6. If the schedule is activated, its entry will be added to the "next occurrence" section.
7. The "Activate/Deactivate schedule" will also be an option (toggle) in the "View schedule" page.
8. If a schedule is deactivated, and if it is past its triggering time, then it will be removed from the list.
9. There will be one more column in the Schedules landing page named "Status".
   • The "Status" will either be "Active" or "Inactive".
   • By default, this column will be displayed before the "Modified by" column.

Security

Only schedules to which you have access can be deactivated. They are noted in the following data table.

Privilege	Schedules
Only "Update schedule"	Active schedules only created by this user.
Only "Manage all schedules"	Any active schedule in the system.
Robot "Update schedule" and "Manage all schedules"	Any active schedule in the system.

Audit log

For reference, see the "Audit: Deactivate automation" topic at the beginning of this page.

Return to top

Audience & purpose

As a Product user with the "Delete/mange all schedules" permission, you want to delete a schedule that is no longer required.

Deleting an automation schedule

Login to Product with the "Delete schedule" or "Manage all schedules" privilege.

1. On the "Schedule" landing page, there will be a "Delete" icon for each schedule.
2. Clicking the icon will prompt the system to ask for a confirmation. See the following screenshot.

   

3. If you confirm, the schedule will be removed from the system (database) and it will not show up in the User Interface.
4. If the operation fails, the system will display an error message.
5. If you do not confirm, there will not be any change to this schedule.

Security

Only schedules you have access to can be deleted. See the following data table.

Privilege	Schedules
Only "Delete schedule"	Schedules only created by this user.
Only "Manage all schedules"	Any schedule in the system.
Robot "Delete Schedule" and "Manage all schedules"	Any schedule in the system.

Error messages

The following messages will be displayed if errors are found.

Reason	Message
Selected Robot got deleted.	<name of object> wasn't found. It may have been renamed, moved, or deleted. To continue, please contact your system administrator.
Access removed for the selected Robot's folder.	You no longer have permissions for the Robot/file <name of bot/file> To continue, please contact your system administrator.
Dependency/Supporting file got deleted	<name of object> wasn't found. It may have been renamed, moved, or deleted. To continue, please contact your system administrator.
Access removed for the Dependency/Supporting file	You no longer have permissions for the bot/file <name of bot/file>. To continue, please contact your system administrator.
Password not provided	Please provide a valid password.
Password invalid	Password for <name of bot/file> is invalid.
Device not present in the system	<name of object> wasn't found. It may have been renamed, moved, or deleted. To continue, please contact your system administrator.
Access to devices removed	You no longer have permissions for device(s) <Device1> <Device2> To continue, please contact your system administrator.
Name not unique	Name should be unique.
No Run privilege	You no longer have permission to run a Robot. To continue, please contact your system administrator.
Device not active	The device(s) below are disconnected and cannot be selected. <Device1> <Device2>
Toast message	<name of bot> successfully scheduled to start now.
No Schedule privilege	You no longer have permission to schedule a Robot. To continue, please contact your system administrator.
Production version not set for selected Robot	Production version for <Robot name> is not set. To continue, please contact your system administrator.
Production version not set for Dependent/Supporting Robot files	Production version for <Robot name> is not set. To continue, please contact your system administrator.
Invalid Schedule (There won't be any occurrence)	The schedule recurrence pattern is invalid.
Toast Message	<name of bot> successfully scheduled.

Return to top

Audience & purpose

As a Product user with the "Update/mange all schedules" privilege, you want to activate a currently inactive schedule so that the system can start the deployments as per the schedule.

• This will enable you to activate any previously deactivated automations so that the system will start deploying them.

Activate an inactive schedule

Use the following guidelines to activate an inactive schedule.

1. Login to Product with the "Update schedule" or "Manage all schedules" privilege.
2. On the "Schedule" landing page, there is an "Activate" icon at the table level.
3. Click the "Activate" icon to prompt the system to ask for a confirmation.
4. If you confirm, the schedule "Status" will be changed to "Active" and a success message will be shown.
5. The system will start the deployments for this schedule as per the schedule.
   • If there are no occurrences left, for example the "Start date" already passed for "Run once", or the "End date" already passed for recurring schedules, the "Status" will be changed to "Completed".
   • The system will display an error message if the operation fails.
   • If you do not confirm, there will not be any change to this schedule.
6. If the list contains automations of mixed status ("Draft", "Active", "Inactive"), activate all the "Inactive" automations and ignore the rest.
   • Error/Success messages will only be shown for the those automations that were acted upon.

Security

Only schedules to which you have access can be deleted. See the following data table for privileges and schedules.

Privilege	Schedules
Only "Update schedule"	Only Inactive schedules created by this user.
Only "Manage all schedules"	Any schedule in the system.
Robot "Update Schedule" and "Manage all schedules"	Any schedule in the system.

Return to top

Audience & purpose

As a Product user with "Update/mange all schedules" privileges, you want to deactivate a currently active schedule to halt any feature deployments for it.

• For example, if you see any issue with a particular active scheduled automation, you can deactivate it so that it will no longer be fired.

Deactivating a scheduled automation

Use the following guidelines to perform this action.

1. Login to Product with the "Update schedule" or "Manage all schedules" privilege.
2. On the "Schedule" landing page, there is a "Deactivate" icon at the table level.
3. Clicking the "Deactivate" icon prompts the system for a confirmation.
   1. If you confirm, the schedule's "Status" will be changed to "Inactive" and a success message will be shown.
   2. The system will not fire any new automations for this schedule.
   3. There will be no affect on any automation that was already fired.
   4. The system will display an error message if the operation fails.
4. If you do not confirm, there will not be any change to this schedule. You will stay on the same page.
5. If the list contains automations of mixed "Status" (Draft, Active, Inactive), deactivate all the "Active" automations and ignore the rest.
   • Error/Success messages will only be shown for the ones which were acted upon.

Security

Note: Only schedules to which you have access can be deactivated. See the following data table for the privileges and schedules.

Privilege	Schedules
Only "Update schedule"	Active schedules only created by this user.
Only "Manage all schedules"	Any active schedule in the system.
Robot "Update Schedule" and "Manage all schedules"	Any active schedule in the system.

Return to top

Audience & purpose

As a Product user you want to view all of the schedules that you are entitled to, so that you can act on them as required.

Landing table: "Scheduled automations" page

Use the following guidelines to view all schedules to which you have permission.

1. Login to Product and go to the "Scheduled automations" page. See the following screenshot.

   

2. The system will display the following columns as per the screenshot.
   • Select all checkbox.
   • Type (with icon): Values = Robot automation, Recurring; Robot automation, One time).
   • Next occurrence (default sort): Top of the list should be the next one to start.
     • If you create a schedule, that schedule will get inserted as per its next occurrence.
     • You should not expect the newly created schedule to be shown on the top.
   • Activity name: Name of the automation.
   • Robot: Name of the task file.
   • Schedule: Schedule details.
   • Device: List of devices.
   • Modified by.
   • Last modified.
3. Schedules which are deleted or completed will not be shown here.
4. Schedules which are created last will be shown on the top, i.e., the default sorting will be by "last modified date-time".

Landing table: "Schedule" column

The "Schedule" column will describe the schedule (not shown in the screenshot):

1. Every day at 12:30:00 PST.
2. Every X days at 12:30:00 PST.
3. On YYYY-MM-DD at 12:30:00 PST.
4. Every X weeks Mon, Tue, Wed, Thu, Fri, Sat, Sun at 12:30:00 PST.
5. Every month on day X at 12:30:00 PST.
6. Every month on the first/second/third/fourth/last Mon/Tue/Wed at 12:30:00 PST.
7. See the following screenshot:

   

Page-level toolbar

At the top of the page, the "Run" icon will be displayed.

1. Clicking the "Run" icon will give you the following three options based on the your user privileges:
   Run →
   1. Run bot now… (If your have the Run privilege)
   2. Schedule bot… (if you have the Schedule privilege)
   3. Run bot with queue… (If you have the Run/Schedule privilege)

Breadcrumb trail

The system will display the path the user took to reach the current page: "Activity" → "Scheduled".

Return to top

Audience & purpose

As a Product user you want to select more than one automation and simultaneously delete them.

Delete

1. Login to Product with the "Delete schedule" or "Manage all schedules" privilege.
2. On the "Schedule" landing page there will be a "Delete" icon at the table level.
3. A tooltip will display: "Delete selected automations…"
4. Click the "Delete" icon and the system will ask for a confirmation. See the following screen shot.

   

5. If you confirm, the schedule will be deleted from the system and a success message will be shown.
   • Note: These automations will no longer appear in the landing page.
6. The system will display an error if the operation fails.
7. If you do not confirm, there will not be any change to this schedule.

Security

Only schedules that you have access to can be deleted. See the following data table for the privileges and schedules.

Privilege	Schedules
Only "Delete schedule"	Only schedules created by this user.
Only "Manage all schedules"	Any schedule in the system.
Roboth "Delete schedule" and "Manage all schedules"	Any schedule in the system.

Return to top

Audience & purpose

As a Product user creating an automation, you want to specify the number of retries and retry interval so that the automation will not skipped if there are any errors while deploying.

For example, you want to:

• Change the schedule type/date/time.
• Add/remove Robot runners from the schedule.
• Change the retry settings.

Editing an inactive automation

You have "Update schedule" or "Manage All Schedules" privileges and are able to edit an automation.

1. On the "Schedule" landing page, there is an "Edit" icon for each automation in the "Inactive" status.
2. Click the "Edit" icon to open the "Edit automation" wizard.
3. Click on a tab to edit it. When editing, push the Read-Only information down.
   1. You can add/delete supporting files in the Robot tab.
   2. You cannot change the Robot selected or change the automation name.
   3. You can change schedule details.
   4. You can change occurrence, frequency, time, and date.
   5. You can add/delete devices.
4. Click "Save" at the top to save the automation if no errors are found.

Editing draft automation

You have the "Update schedule" or "Manage All Schedules" privileges and are able to edit an automation.

• On the "Schedule" landing page, there is an "Edit" icon for each automation in "Draft" status.
• While editing an automation with "Draft" status, you can change any/all of the automation's details.

Security

Only schedules to which you have access can be edited. See the following data table for privileges and schedules.

Privilege	Schedules
Only "Update schedule"	Only "Inactive" or "Draft" schedules created by this user.
Only "Manage all schedules"	Any "Inactive" or "Draft" schedule in the system.
Robot "Update Schedule" and "Manage all schedules"	Any "Inactive" or "Draft" schedule in the system.

Return to top

Audience & purpose

As a Product user you want to export the "Schedule" page details to share it with others offline.

• This will enable you to export the contents of the table for offline review/sharing.

Export table contents

The system will display the "Export" icon at the table level.

1. Click the "Export" icon to export the table's contents.
2. You will be given an option to upload "All" or "Selected items" from the table.
3. If you did not select any record, "Selected items" will be disabled.
4. The system:
   • Will export all/selected records (as per your selection) to a CSV (Comma Separated Values) file.
   • Will let you save the file to your local file system.
   • The CSV must contain a semi-colon separated list of all devices (on which the Robot has been deployed).

Return to top

Audience & purpose

As a Product user, you want to view the details of a scheduled automation so that you can pause/resume/delete an automation as required.

Viewing general details

Click the "View Details" icon to display the details of the given automation.

1. In the General details section of the view page, the following details will be shown. See the following screenshot.
   • Last modified = date and time when this automation was started or paused
   • Modified by = username of person who started or paused this automation
   • Object type = Automation

   

Return to top

Audience & purpose

As a Product user, you want to manage automations so that you can pause/resume/delete an automation as required.

• You will be able to see what happened to the last three executions while looking at the schedule.

Run Details

Use the following guidelines regarding run details.

1. Login to Product and go to the "Schedule" landing page.
2. Click the "View details" icon of a schedule to prompt the system to display details of the given automation.
3. In the "Run details" section of the "View" page, the following details will be shown:
   1. If the schedule has not run, it will show a message: "The run details for the schedule will appear here when the schedule has run at least once."
   2. If the schedule has run, it will show at maximum the last three occurrences.

By default, it shows the high-level status of each execution.

1. Occurrence → The count of this occurrence.
2. Date → The date and time this event was fired.
3. Status → In Progress if any task is still under progress on any device in this schedule.
   • "Completed" if the task was executed successfully on all the devices.
   • Multiple device deployment: "Partially Completed" if the task was successfully executed on at least one device and failed on others.
   • Single device deployment: "Partially Completed" if the task is in progress.
   • Failed if the task was not successfully executed on any devices.

     Occurrence no.	Date	Status
     Occurrence 47	3/25/2017 05:00:00 PDT	Completed.
     Occurrence 46	3/24/2017 05:00:00 PDT	Partially completed.
     Occurrence 45	3/23/2017 05:00:00 PDT	Failed.

4. You can expand each occurrence to see the status on individual machines.
5. The following details will be shown when an individual item is clicked:
   • Device Name → Name of the device where the task is pushed.
   • Status → Status of the deployment.
   • Deployed On → Date and time the task was deployed
   • Completed
   • Failed
   • Deployed on → Date and time the task was deployed.

     Device Name	Status	Deployed On
     Device 1	Completed	3/25/2016 04:30:00 PDT
     Device 2	Failed	3/25/2016 05:00:00 PDT

Return to top

Audience & purpose

As a Product user, you want to view the details of a scheduled automation so that you can pause/resume/delete an automation as required.

• This will enable you to view the automation schedule details before taking any action on the schedule.

General details

Use the following guidelines regarding the "Schedule" general details.

1. Click the "View details" icon to prompt the system to display the details of the given automation.
2. In the "General details" section of the "View" page, the following details will be shown.
   • Schedule type = "One time" or "Recurring".
   • Next occurrence = Double dash for "One time", or "Next occurrence" date and time for a recurring automation.
   • Start date = "Start time" and "Start date".
   • End date = "End time" and "End date" or a double dash (--) for empty values.

Return to top

Audience & purpose

As a Product user, you want to view automation details so that you can pause/resume/delete an automation as required, before taking any action on it.

Details

Use the following guidelines to view and take action with an automation's details.

1. Click the "View details" icon to display the details of the automation. The system will display the "Automaton" icon along with the name in the title.
   See the following screenshot.

   

2. Display the top tabs with the details. All fields are Read Only.
3. For an "Active scheduled "automation:
   • You will be able to edit or inactivate the automation from this view, provided you have the required privileges.
4. For an "Inactive scheduled" automation:
   • You will be able to edit or deactivate the automation from this view, provided you have the required privileges.
5. Click the "Back" button to take you to the previous page.

Breadcrumbs

The system will display the path you have taken to reach the current page. For example, if you are viewing the details of an automation.

Return to top