This action plugin is a tool to manage a limited pool of resources. It provides a way to pause a workflow until the resource becomes available.
Saved Parameters Description
- Name: The name used to identify a saved ResourceManager configured instance.
- Comments: Some comments about this saved ResourceManager configured instance.
- Generic resources maximum number: The number of resources in the pool to be provided.
- Resource list: List of resources that will be provided to the items in the queue.
- Resource unique name: A unique ID to identify the resource of the current template.
- Unicity scope: This decides at what level a given pool of resources are shared globally.
- Polling frequency: Polling interval in seconds. If not set, the default value of 5 will be used.
- Keep trigger ongoing?: To use this plugin as a trigger, set a non-null polling frequency in the text field.
- Wait timeout: Maximum time the item in queue will wait for the resource. Defaults to 0 value, meaning infinite wait time.
- Hold timeout: Maximum time the resource will be kept on hold state. After the hold timeout, the resource is released. Defaults to 0 value, meaning infinite hold time.
- Return token as output?: Token file path is returned if this check box is checked.
Advanced Parameters
Queue: The ID of the linked queue.
Inputs Description
The list of inputs depends on the configuration of the ResourceManager action template.
- Resource unique name is a mandatory field.
- Either a Generic resources maximum number OR Resource list must be provided.
- The same Resource Manager template can be re-used among multiple workflows to globally share a given pool of resources. In this case, use the absolute Unicity scope.
- Use the workflow unicity scope to share the resources at the workflow level. The use case is 2 different workflows (separate workflow ids) using the same pool of resources (e.g. a unique resource name with r1,r2 resource list) but gaining independent access to (r1,r2). A total of 4 resources may be used concurrently.
- Use the workorder group unicity scope to share the resources within a workorder group. The use case is a workflow with a trigger (e.g local file watcher). All triggered workorders gain access to a pool of resources (e.g. a unique resource name with r1,r2 resource list). Another workorder group will gain its own independent access to (r1,r2). A workorder group is created manually when creating a new workorder or via a Workflow Launcher call from another workflow.
- Use the step unicity scope to share the resources at the workflow step level.
Outputs description
- Resource_ID: Resource id
- Token_path: If Return token as output? is checked, this output field will have the the token file path populated.
- Queued_item: Current queued item of the given queue id.
- Queued_item_description: Description of the current queued item of the given queue id.
Supported Actions
None
Dependencies
None
- Managed queue and Resource Manager Plugin go hand in hand.
- Example of the a Resource Manager Template:
Generic resources maximum number: 2
Resource unique name: tango_charlie
Unicity scope: absolute
Polling frequency: 15
Hold timeout: 1200
Return token as output?: true
Queue: QUEUE_name -
Maximum number of resources are 2.
Unicity scope is absolute, thus the resources can be shared amongst mulitple workflows.
Wait time out is not given. So the queue item will wait forever for the resource to be available.
Hold time out is 1200 seconds. Resources will be released after 1200 seconds of idle time.
Return token as output? is checked. Meaning the token file path will be returned as output and will be populated against Token_path.
Here the Queue name comes from as a runtime input (Usually from a previous step. In our case it is name as 'QUEUE_name').