/
Virtual Resources

Virtual Resources

Nov 01, 2024

Overview

A virtual resource allows you to set up a throttling scheme that will manage the number of specific tasks that can run at one time.

Using a Virtual Resource

Outlined below is the basic procedure and processing flow for using a virtual resource:

Step 1

Create a virtual resource.
 

There are three types of virtual resources:

  1. Renewable
    Resources that renew; that is, when a task has finished using them, they can be returned and made available to other tasks sharing the same resources.

  2. Boundary
    Resources that are like "windows." Only those tasks defined to fit through that window (or Resource Limit) will run.
    For example, if you define a Boundary Resource with Resource Limit of 5, and Task A requires a window (amount) of 5, Task B requires a window (amount) of 5, and Task C requires a window (amount) of 10, both A and B will run. However, C will go into a Resource Wait state. If the Boundary Resource is updated to a Resource Limit of 10, C will run.

  3. Depletable
    Resources that do not renew. Once consumed by a task, they are gone.

Step 2

Assign a resource limit to the virtual resource as appropriate for the resource type.

Step 3

Assign tasks to the virtual resource.

Step 4

Specify the number of resource units that each task will consume. For example, a task that requires a small amount of processing power might consume one unit; a task that requires a high amount of resources might consume three units. The number of units you specify for each task is relative to the maximum number that you assign to the resource.

Step 5

Save the virtual resource record.

Step 6

When a task with a virtual resource requirement launches, Universal Controller checks the virtual resource record to see if enough units are available to run the task, based on what other tasks assigned to that virtual resource are currently running.

  • If enough units are available, the task runs and the number of available units is decremented by the amount specified in the task. For example, if the resource has a maximum of ten and the task uses two, the remaining amount available on that virtual resource for use by other tasks is eight.

  • If there are not enough units available, the task is put into Resource Wait status and is listed in the Outstanding Requests tab in the virtual resource. When the required amount of resource becomes available, the task is launched.

  • If multiple tasks are in Resource Wait status, the virtual resource priority is used to determine which task will be first to acquire the resource when it becomes available.

Step 7

Tabs on the Virtual Resource record keep track of tasks that are currently "running" on this virtual resource and tasks that are waiting to "run" on this virtual resource.

Creating a Virtual Resource

Step 1

From the Automation Center navigation pane, select Other > Virtual Resources. The Virtual Resources list displays:
 
To the right of the list, Virtual Resource Details for a new Virtual Resource record displays.

Step 2

Enter / select Details for a new Virtual Resource, using the field descriptions below as a guide.

  • Required fields display an asterisk ( * ) after the field name.

  • Default values for fields, if available, display automatically.

To display more of the Details fields on the screen, you can either:

  • Use the scroll bar.

  • Temporarily hide the list above the Details.

  • Click the 

    button above the list to display a pop-up version of the Details.

Step 3

Click a 

button. The Virtual Resource record is added to the database, and all buttons and tabs in the Virtual Resource Details are enabled.

Note

To open an existing record on the list, either:

  • Click a record in the list to display its record Details below the list. (To clear record Details below the list, click the 

     button that displays above and below the Details.)

  • Clicking the Details icon next to a record name in the list, or right-click a record in the list and then click Open in the Action menu that displays, to display a pop-up version of the record Details.

  • Right-click a record in the a list, or open a record and right-click in the record Details, and then click Open In Tab in the Action menu that displays, to display the record Details under a new tab on the record list page (see Record Details as Tabs).

Virtual Resource Details

The following Virtual Resource Details is for an existing Virtual Resource. See the field descriptions, below, for a description of all fields that display in the Virtual Resource Details.

Note

This sample Virtual Resource Details shows a Resource Limit of 1. Because each task has a minimum value of 1, this virtual resource would be limited to running only one task at a time.

For information on how to access additional details - such as Metadata and complete database Details - for Virtual Resources (or any type of record), see Records.

Virtual Resource Details Field Descriptions

The following table describes the fields, buttons, and tabs that display in the Virtual Resource Details.