Scripts

This section details the Scripts interface in the IBM RPA Control Center.

The All scripts page provides information on all the scripts that were published to the current tenants in the IBM RPA server.

On versions prior to 21.0.7, the page is labeled Scripts.

Important:Starting from IBM RPA 23.0.7, Scheduling scripts is deprecated. Use Scheduling bots instead. For more information, see Deprecated.

Before you begin

To learn how to publish scripts to the IBM RPA server, see Publishing a script.

Attention:For IBM RPA on premises offering only: Due to an MSMQ limitation, when you use it as your system queue provider, you must install the IBM RPA server and the client on the same subnet in order to schedule or orchestrate scripts.

See the Scheduling and orchestration processes do not work when using MSMQ troubleshooting page.

Procedure for scheduling a script

Define the script

Important:Starting from IBM RPA 23.0.7, Scheduling scripts is deprecated. Use Scheduling bots instead. For more information, see Deprecated.
  1. Log in to IBM RPA Control Center.
  2. From the Define menu, click Scripts.
  3. Locate the script that you want to schedule.
  4. Click the vertical ellipsis button ⋮ > Create Schedule option.
  5. The Create schedule window prompts to the script selected. Enter the following values:
    1. From the Version list, select the script's version.
    2. In the Name field, enter the schedule's name.
    3. Optional: In the Description field, enter the schedule description.
    4. From the Computers list, select the computer to run the script.
    5. Optional: From the Credentials list, select the computer's credentials. You don't need to select a value if your computer already has a credential that is bound to it.
  6. Click Next.
Important:Scheduling does not take into consideration the production version.

Define the schedule

Define the script schedule based on how many times you want the script to run in weekdays. Follow the steps based on your schedule preferences:

Define the schedule to run once a day

  1. In the Execution Type field, select Execute once a day.
  2. In the Weekdays checkbox, select the weekdays you want to run the schedule.
  3. In the Start time field, enter the time that the script must start running.
  4. Optional: Set Unlock machine to On to unlock the machine when the schedule runs.

Define the schedule to run more than once a day

  1. In the Execution Type field, select Execute more than once a day.
  2. In the Weekdays checkbox, select the weekdays that you want to run the schedule.
  3. In the Start time field, enter the time that the script must start running.
  4. In the Stop time field, enter the time that the script must stop running.
  5. In the Interval field, enter the time interval that the script must take before to restart running. The script starts again based on the time that it takes to finish its runtime plus the time that is defined as time interval.
    Remember:The time format follows the 24-hour clock convention of time. You define the schedule times in hours and minutes, for example, 09:00 or 16:30.
  6. Optional: Set Unlock machine to On to unlock the machine when the schedule runs.

Analyzing the details of a script

  1. Next to the desired script, click the ellipsis button &vellip > Details button.

The tabs of the Script Details interface are:

Versions
Manage script versions.

Schedules
Manage script schedules.

Logs
See script execution logs.

Broker
Configure the script brokering system.

Procedure for deleting a script from the current environment

  1. Click the Scripts navigation menu.
  2. Find the desired script.
  3. Click the vertical ellipsis button ⋮ > Delete.
  4. Click Delete to confirm.

Procedure for editing execution times

  1. Click the Scripts navigation menu.
  2. Click on the desired script's name.
  3. Click the vertical ellipsis button ⋮ > Details.
  4. Click the Versions tab.
  5. Click the Edit button to edit execution times.
  6. Enter the new green time in the Green Time field.
  7. Enter the new yellow time in the Yellow Time field.
  8. Enter the new red time in the Red time field.
  9. Click Save.

A message indicates that the changes have been applied.

Procedure for configuring or removing the production version

  1. Click the vertical ellipsis button ⋮ > Details.
  2. Click the Versions tab.
  3. Locate the version to edit:
    1. In the Comment field, enter the description of the script publication to filter the versions with the same description.
    2. In the Interval field, enter a period of time to filter by versions produced in this time interval.
    3. Click the Search button.
  4. Next to the desired version, click the ellipsis button ⋮.
  5. Performance:
    • If you want to configure the current version as a production version, click Set as a production version.
    • If you want to remove the current production version, click Remove as production version.

A message indicates that the changes were applied.

Procedure for viewing script schedules

  1. Next to the desired version, click the vertical ellipsis button ⋮ > Details.
  2. Click the Schedules tab.
  3. In the Version, select the version of which you want to view schedules.
  4. In the Schedule, enter a description of the script scheduling to filter the schedules with the same description.
  5. Enable Enabled Only option to filter by currently active schedules.
  6. Click Search.

For more information about schedules, see Schedules.

Configuring the broker

Attention:Starting from version 21.0.4, the broker system is deprecated. Use script orchestration.

For more information about broker, see The broker system.