×
OTRS Storm
OTRS

Overview

The OTRS Storm plugin adds the ability to manage tickets.

Functionality

The Security Flow OTRS Storm plugin provides the ability to

  • create a ticket
  • find (search for) tickets
  • retrieve a ticket by ticket ID
  • retrieve a set of tickets by ticket IDs
  • update an existing ticket

Instance Configuration Parameters

Property
Description

Instance Name

Name for the OTRS Storm plugin instance.


Unique ID

A system-wide unique identifier for this plugin instance used to locate the service.


Authentication Mechanism

The authentication mechanism to use for accessing the OTRS Storm Server.


Server Name

OTRS host name.


Username

The user’s or customer’s username.


Password

The user’s or customer’s password.

Flow Node

This node provides access to the ticket operations with the OTRS API. See the OTRS 8.0 API Reference Perl page for the overview of options.
Property
Description

Name

The display name of the node within the flows.


Unique ID

A system-wide unique identifier for this plugin instance used to locate the service.


Action

Configuration option determining the type of operation to perform:

  • Create Ticket: Creates a new ticket.
  • Create Ticket Advanced: Creates a new ticket by specifying the JSON values directly.
  • Find Tickets: Searches for tickets.
  • Get Ticket(s): Retrieves one or more tickets based on their ticket IDs.
  • Update Ticket : Updates an existing ticket.
  • Update Ticket Advanced: Updates an existing ticket by specifying the JSON values directly.

Successful results for an action are placed in msg.payload.otrs.[uniqueId].response.


Ticket ID

The ID number of an existing ticket used when updating.


Ticket Title

The ticket’s title. This is a required field when creating a ticket.


Queue

The ticket’s queue. This is a required field when creating a ticket.


State

The ticket’s state. This is a required field when creating a ticket. Allowed values are close successful, closed unsuccessful, merged, new, open, pending reminder, and removed.


Priority

The ticket’s priority. This is a required field when creating a ticket. Allowed values are 1 very low, 2 low, 3 normal, 4 high, and 5 very high.


TLP

The optional TLP is color coded value. Allowed values are TLP:AMBER, TLP:CLEAR, TLP:GREEN, and TLP:RED.


Lock

The ticket’s lock state. Allowed values are lock and unlock.


Type

The type of the ticket. Possible allowed values are Event, Incident, Task, and Unclassified.


Service

The ticket’s service type.


SLA

The ticket’s service level agreement.


Owner

The login of the ticket owner.


Responsible

The login of the ticket’s responsible user.


Customer User

The customer affected by the ticket. This is a required field when creating a ticket.


Pending Time (in minutes)

The ticket’s pending time in minutes.


Subject

The subject of the new Communication Stream (Article) entry. This is a required field when creating a ticket. Mustache template substitution is applied to generate the final value. Visit the Template Engine and Formatters page to learn more.


Body

The body of the new Communication Stream (Article) entry. This is a required field when creating a ticket. Mustache template substitution is applied to generate the final value. Visit the Template Engine and Formatters page to learn more.


Is Visible for Customer

Flag to indicate if the customer will see the new Communication Stream (Article) entry.


Ticket ID(s)

Used for retrieving one or tickets by their ticket ID. Ticket ID(s) must evaluate to a single ticket ID, a string of comma separate list of ticket IDs, or an array of ticket IDs. When Ticket ID(s) is set to Standard Ticket ID Location, the ticket ID is pulled from the standard response location at ticket.TicketID, which is set by the create and update actions. When Ticket ID(s) is set to Standard Ticket IDs Find Location, the ticket IDs are pulled from the standard response location at ticketIds, which is set by the Find Ticket action.


Include Dynamic Fields

If Include Dynamic Fields evaluates to a JavaScript truthy value, the dynamic fields are included in the results when retrieving tickets.


Included Extended Information

If Included Extended Information evaluates to a JavaScript truthy value, extended information is included in the results when retrieving tickets.


Retrieve Articles

If Retrieve Articles evaluates to a JavaScript truthy value, article information (communication stream) information is included in the results when retrieving tickets. The other remaining article related parameters are only relevant when Retrieve Articles evaluates to a JavaScript truthy value.


Retrieve Article Attachments (includes content)

If Retrieve Article Attachments evaluates to a JavaScript truthy value, all articles with attachments will have the file attachments automatically associated with the message traversing the flow.


Article Limit

The maximum number of articles to retrieve.


Article Sort Order

When retrieving a ticket or set of tickets, the ascending or descending order the retrieved articles.


Search Sub Queues

If Search Sub Queues evaluates to a JavaScript truthy value, the search action will also search within the sub queues of specified queue.


Create Time Older (minutes)

When searching, used to find tickets with a create time older than the number of minutes specified.


Create Time Newer (minutes)

When searching, used to find tickets with a create time newer than the number of minutes specified.


Content Search Condition (for Subject and Body)

When searching within the Subject and Body fields, determines if the search criteria is an AND or an OR condition.


Full Article Text Search

If Full Article Text Search evaluates to a JavaScript truthy value, the search action will search the full text of the articles.


Attachment Name

Article attachment names are searched based on the supplied value. Use % as a filename’s wildcard. For example, a value of %file.txt% will match Thisfile.txt1.


Article Create Time Older (minutes)

When searching, used to find articles with a create time older than the number of minutes specified.


Article Create Time Newer (minutes)

When searching, used to find articles with a create time newer than the number of minutes specified.


Sort By Field

When searching, the name of the field to sort matching results by.


Order By

When searching, the ascending or descending order of matching results.


Result Limit

When searching, the maximum number of tickets to return.


Dynamic Field Template

For advanced creation or update actions, the template for setting dynamic fields. Mustache template substitution is applied to generate the final value. Visit the Template Engine and Formatters page to learn more.


Ticket Template

For advanced creation or update actions, the template for setting the ticket fields. Mustache template substitution is applied to generate the final value. Visit the Template Engine and Formatters page to learn more.


Article Template

For advanced creation or update actions, the template for creating a new article. When creating a ticket, this is required. Mustache template substitution is applied to generate the final value. Visit the Template Engine and Formatters page to learn more.


Included Attachment(s)

Attachments may be added by specifying the Included Attachment(s) glob value. The Included Attachment(s) setting takes precedence over the Excluded Attachment(s) setting. If neither value is glob value is defined, no attachments are included. Filename globbing is configured to be case insensitive.


Excluded Attachment(s)

Attachments may be excluded by specifying the Exclude Attachment(s) glob value. The Included Attachment(s) setting takes precedence over the Excluded Attachment(s) setting. If neither value is glob value is defined, no attachments are included. Filename globbing is configured to be case insensitive.

Nevelex Labs, Main Office

Metro Office Park
2950 Metro Drive, Suite 104
Bloomington, MN 55425
Phone: +1 952-500-8921

©Nevelex Labs, LLC. 2018-2024, All Rights Reserved.

EULA