Skip to main content

Cyware Orchestrate

BMC Helix

App Vendor: BMC Helix

App Category: Case/Ticket Management, IT Services

Connector Version: 1.0.2

API Version: 21.3

About App

BMC Helix is a comprehensive IT service management platform that aims to deliver streamlined and intelligent service operations. It offers end-to-end support, from incident management to self-service, ensuring efficient and adaptive IT service delivery.

The BMC Helix app is configured with Orchestrate to perform the following actions

Action Name

Description

Create Incident 

This action creates an incident in BMC Helix.

Get an Incident 

This action retrieves details of an incident.

List Incidents 

This action retrieves a list of incidents.

Update an Incident 

This action updates an incident.

Configuration Parameters

The following configuration parameters are required for the BMC Helix app to communicate with the BMC Helix enterprise application. The parameters can be configured by creating instances in the app.

Parameter

Description

Field Type

Required/Optional

Comments

Base URL 

Enter the base URL to access BMC Helix.

Example: 

https://<host>

Text

Required

Server 

Enter the server name. 

Example: onbmc-s

Text

Required

Username 

Enter the username.

Text

Required

Password 

Enter the password to authenticate with BMC Helix.

Password

Required

Verify 

Choose the SSL/TLS verification status. 

Boolean

Optional

Default: 

True

Timeout 

Enter the timeout value in seconds. This is the number of seconds that requests will wait to establish a connection with BMC Helix. 

Integer

Optional

Available range:

15-120 seconds 

Default value:

20 seconds

Action: Create Incident

This action creates an incident in BMC Helix.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

First Name 

Enter the first name.

Text

Required

Last Name 

Enter the last name.

Text

Required

Impact 

Enter the impact.

Example:

4-Minor/Localized

Text

Required

Available values:

1-Extensive/Widespread

2-Significant/Large

3-Moderate/Limited

4-Minor/Localized

Incident Type 

Enter the incident type.

Text

Required

Available values:

User Service Restoration, User Service Request, Infrastructure Restoration, Infrastructure Event

Status 

Enter the status.

Text

Required

Available values:

New, Assigned, In Progress, Pending, Resolved, Closed, Cancelled

Summary 

Enter the summary.

Text

Required

Urgency 

Enter the urgency.

Text

Required

Available value:

1-Critical, 2-High, 3-Medium, 4-Low

Reported Source 

Enter the reported source.

Text

Optional

Available values:

Email, Systems Management, Phone, Web, SMS, BMC Impact Manager Event

Default value:

Web

Extra Fields 

Enter any additional fields that need to be added in the payload. 

Example: 

{"Notes":"This is a dummy note"}

Key Value

Optional

Example Request 

[
  {
    "impact": "4-Minor/Localized",
    "status": "Assigned",
    "summary": "Creating using secops",
    "urgency": "4-Low",
    "last_name": "Test_Last_Name",
    "first_name": "Test_User",
    "incident_type": "User Service Request",
    "reported_source": "Web",
    "extra_fields": {
		"Notes": "This is a dummy note"
		}
  }
]
Action: Get an Incident

This action retrieves the details of an incident.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Incident ID

Enter the incident ID.

Text

Required

Example Request

[
  {
    "incident_id": "INC000094929891"
  }
]
Action: List Incidents

This action retrieves a list of incidents.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Filter 

Enter the value to filter the data.

Example:

{"Impact":"4-Minor/Localized"}

Key Value

Optional

Available keys:

Impact, Status, Company, Assigned Group

You can apply only one filter simultaneously.

Offset 

Enter the start record.

Integer

Optional

Default:

0

Limit 

Enter the limit.

Integer

Optional

Default:

100

Example Request 

[
  {
    "limit": "1",
    "filter": {
      "Impact": "4-Minor/Localized"
    }
  }
]
Action: Update an Incident

This action updates an incident.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Incident ID 

Enter the incident ID to update.

Example:

INC000094929876

Text

Required

Summary 

Enter the summary to update.

Text

Required

Impact 

Enter the impact.

Example:

4-Minor/Localized

Text

Optional

Available values:

1-Extensive/Widespread, 2-Significant/Large, 3-Moderate/Limited, 4-Minor/Localized

Urgency 

Enter the urgency.

Text

Optional

Available value:

1-Critical, 2-High, 3-Medium, 4-Low

Incident Type 

Enter the incident type.

Text

Optional

Available values:

User Service Restoration, User Service Request, Infrastructure Restoration, Infrastructure Event

Status 

Enter the status.

Text

Optional

Available values:

New, Assigned, In Progress, Pending, Resolved, Closed, Cancelled

Company 

Enter the company name.

Example:

IBM

Text

Optional

Extra Fields 

Enter any additional fields that need to be added in the payload.

Example:

{"Notes": "This is a dummy note"}

Key Value

Optional

Example Request 

[
  {
    "summary": "changing through Secops",
    "incident_id": "INC000094929891",
    "extra_fields": {
		"Notes": "This is a dummy note"
		}
  }
]