INCOPTS

Purpose

The INCOPTS statement defines the default values for connecting to an incident notifying tool, such as ServiceNow or IBM Z ChatOps. This statement is optional and is used by the Z controller.

Format


1  INCOPTS  INCCHANNEL (
2.1 channel name
1 )  INCHOSTNAME (
2.1 hostname
1 )  INCJWTTOKEN (
2.1 JWT token
1 )?  INCPATH (
2.1 REST API path
2.1! ibm/bnz/v1/incident
1 )?  INCPORT (
2.1 port number
2.1! 4001
1 )?  INCTICKETCALLER (
2.1 ServiceNow caller
2.1! null
1 )?  INCTICKETHOSTNAME (
2.1 ServiceNow instance
1 )?  INCTICKETTOKEN (
2.1 ServiceNow OAuth token
1 )

Parameters

INCCHANNEL(channel name)
Name of the channel of the connected chat platform where the incident is to be posted. You can specify up to 80 alphanumeric characters. If the value that you specify is longer than one row, ensure that you always end at column 72 and begin at column 1. This parameter is required.
Note: Ensure that you specify an existing channel; if the channel does not exist the incident is not notified in the chat tool and no messages are stored in the EQQMLOG file.
INCHOSTNAME(hostname)
Host name or IP address used to connect to the incident notifying tool. You can specify up to 56 alphanumeric characters, enclosed between single quotation marks. If the value that you specify is longer than one row, ensure that you always end at column 72 and begin at column 1. This parameter is required.
INCJWTTOKEN(JWT token)
JWT token used to connect to the incident notifying tool. If the value that you specify is longer than one row, ensure that you always end at column 72 and begin at column 1. This parameter is required.
Note: The JWT token that you specify in this parameter corresponds to the token with which you authenticate to the incident notifying tool that you are using. For example, if you are integrating with IBM Z ChatOps it is the token that you generated by following the procedure described in the IBM Z ChatOps User's Guide.
INCPATH(REST API path | ibm/bnz/v1/incident)
Required if you are using an incident notifying tool such as IBM Z ChatOps. The path to the REST API to be used in the Web hook. You can specify up to 80 alphanumeric characters, blank characters are not allowed. If the value that you set is longer than one row, ensure that you always end at column 72 and begin at column 1.

If you do not set any value or specify a value that is not valid, the default ibm/bnz/v1/incident is used.

INCPORT(port number | 4001)
Required if you are using an incident notifying tool such as IBM zChat Ops. Number of the port used to connect to the incident notifying tool. The allowed range is from 0 to 65535; the default is 4001. If you specify a value out of the valid range, the default is used.
INCTICKETCALLER(ServiceNow caller | null)
Field of the Incident Table in ServiceNow that identifies the caller opening the incident. The caller is the ID (servicenow sys_id) that identifies an entity in your ServiceNow instance.

You can specify up to 32 alphanumeric characters. If the value that you specify is longer than one row, ensure that you always end at column 72 and begin at column 1. If you do not specify this value or the value is not valid, the default null is used.

INCTICKETHOSTNAME(ServiceNow instance)
Required if you are using ServiceNow. The URL of your ServiceNow instance (for example, inst1234.service-now.com).

You can specify up to 56 alphanumeric characters. If the value that you set is longer than one row, ensure that you always end at column 72 and begin at column 1.

INCTICKETTOKEN(ServiceNow OAuth token)
Required if you are using ServiceNow. The OAuth token that you created according to the procedure described in Opening incidents through ServiceNow. You can specify up to 86 alphanumeric characters. If the value that you set is longer than one row, ensure that you always end at column 72 and begin at column 1.