Task Reference

Provides reference information for tasks.

Leave Feedback

Introduction

A task refers to a single unit of work to be performed in a process.

The following tasks are supported:

  • Send task
  • Script task
  • Service task

Send task properties

A send task sends a notification to one or more users at a specific point in the process.

The send task is represented as a rectangle with rounded corners with a small notification icon at the corner:

A send task has the following properties:

Send Task Properties
PropertyDescription
NameThe name of the task.
IdA unique identifier of the task generated by the system. An ID cannot be modified.
InputThe object from the previous element's object.
Notification TemplateThe user who is sent a notification.
Notification PriorityThe priority that determines the channel (email) to deliver notifications.

Script task properties

A script task is used to run a script in the process. A script can be agent-based or agentless via Ansible control node. Agent-based scripts can be created in the following languages:

  • POWERSHELL
  • Python
  • SHELL

The script task is represented with a rectangle with rounded corners and a script icon:

To run an agentless script, integrate Ansible must be integrated with the system.

To configure Ansible integration:

  1. From All Clients, select the client.
  2. Go to Setup > Integrations> Integrations.
  3. From Available Integrations > Configuration Automation > Ansible Integration, click Install.
  4. Enter a name for the integration and select the controller host name.
  5. Click Install.

A script task has the following properties:

Script Task Properties
PropertyDescription
NameThe name of the task.
IdA unique identifier of the task generated by the system. An ID cannot be modified.
Configuration
  • Agent: The execution of a script on a resource with an installed agent. The data from the resource is collected and sent to the system via the agent.
  • Agentless: The execution of a script on a script on a standalone device via an Ansible control node.
Script Name (applicable for an agent)The script name to execute.
Resource Id (applicable for agent)The resource ID used to execute the script.
Run As (applicable for agent)The execution of the script with proper authorization.
  • Default User: Executing the script as an administrator.
  • Credential Set: Executing the script with specific user credentials.
Integration (applicable for agentless)A created Ansible integration name.
Playbook (applicable for agentless)A Playbook created as part of the integration.
Input (applicable for agentless)Commands for executing the script.
Preview (applicable for agentless)The fully-qualified path entered in a selected playbook.

Service task properties

A service task is used to perform a service. The service can either be a service provided by OpsRamp or an external service. The service task is represented as a rectangle with rounded corners with a settings icon:

Service tasks have the following properties:

PropertyDescription
NameThe name of the task.
IdA unique identifier for the task generated by the system. An ID cannot be modified.
ServiceThe mode of service for completing a task:
  • REST Web Service: The triggering of an element's output as a third-party event. This can be used to call an external service via an API to invoke a Lambda function or to perform an external integration.
  • Platform Service: This refers to using OpsRamp’s native services. For example, update an existing incident with the output captured from another element or create an alert with the output captured from another element.
    Note: Sub-property fields vary for each service.

REST web services

REST web services have the following properties:

PropertyDescription
Asynchronous Service InvocationAn asynchronous service invocation follows the Request, Acknowledge, and Callback pattern. Once invoked, the process is blocked for this task until the REST application performs a callback.
IntegrationThe integration of an external web service API endpoints that is configured.
EventAn integration event.
InputThe input for the service task that can be an output of the previously configured elements (like the start event).
Example: $startevent.alert or $updatealert.alert.
OutputThe mappings of response fields configured for the selected event.

This is an example of the REST web services properties dialog box:

Service Task Properties - REST Web Service

Service Task Properties - REST Web Service

Platform services

The platform services has the following properties:

PropertyDescription
TaskRefers to one of the OpsRamp’s native services. The sub-fields vary for each task that you select.
For example, if Update Incident is selected, the Incident Unique Id needs to provided, select Priority and Status.
Enter the comments to add to the incident as part of the response.

This is an example of the platform service properties dialog box:

Service Task Properties - Platform Service

Service Task Properties - Platform Service