Foglight for Automation Action Packs 5.6.3.8 - BMC Remedy ActionPack User Guide

ActionPack for BMC Remedy Requirements ActionPack for BMC Remedy Actions

Using the ActionPack for BMC Remedy

This Foglight for BMC Remedy ActionPack User and Reference Guide provides requirements, configuration instructions, conceptual information and instructions on how to use the Foglight for BMC Remedy ActionPack to integrate Foglight for BMC Remedy ActionPack with BMC Remedy Action Request (AR) systems.

This guide is intended for any user who wants to communicate with BMC Remedy AR systems.

In this section you can read about requirements that need to be met for the ActionPack for BMC Remedy to work properly, and the Actions included in this actionpack.

ActionPack for BMC Remedy Requirements

Foglight for BMC Remedy ActionPack Support Matrix

Table 1. Support Matrix
ActionPack	ActionPack version	Requires Foglight version	Supported Target Systems
BMC Remedy	5.6.2	5.6.3.4 or later	BMC Remedy server version 7.0.01 or later

Support Limitations

Foglight for BMC Remedy ActionPack supports operations within Regular and Join forms only.

ActionPack for BMC Remedy Actions

This section describes the actions that are included in the ActionPack for BMC Remedy.

Close Request

Closes the specified request with the preferred close status. The action is applicable for the Regular and Join forms.

Pre-conditions

•

The specified form exists on the server.

•

A request with the specified ID exists.

•

The Close status is a valid value for the Status field of the request (enumeration type).

Table 2. Close Request Input Parameters
Name/Scripting name	Type	Description
Server/Server	Topologyobject	[BMCRemedyServer]. The BMC Remedy server.
FormName/FormName	String	Name of a form containing the request.
RequestID/RequestID	String	An ID of the request to be closed.
CloseStatus/CloseStatus	String	Preferred Close status for the request.

Post-conditions

None.

Create Request

Creates a new entry in the specified form of a BMC Remedy server. The action is applicable for the Regular and Join forms.

Pre-conditions

•

The specified form exists on the server.

•

All specified field IDs exist on the form.

•

All required fields are specified.

•

All limitations applied to field values are fulfilled.

Table 3. Create Request Input Parameters
Name/Scripting name	Type	Description
Server/Server	Topologyobject	[BMCRemedyServer]. The BMC Remedy server.
FormName/FormName	String	Name of a form, for which the request will be created.
ShortDescription/ShortDescription	String	Short description of the request being created.
Status/Status	String	An optional status to be set for the request being created.
AssignTo/AssignTo	String	An optional assignee for the request being created.
Submitter/Submitter	String	An optional submitter of the request being created.
FieldsIDs/FieldsIDs	Array of Integers	An optional list of fields’ IDs to be populated in the request being created (should match in size with FieldsValues parameter).
FieldsValues/FieldsValues	Array of Strings	An optional list of fields’ values to be populated in the request being created (should match in size with FieldsIDs parameter).

Table 4. Create Request Output Parameters
Name/Scripting name	Type	Description
RequestID/RequestID	String	The Request ID field value of the created request. (Field ID in the form is 1.)
Status/Status	String	The Status field value of the created request. (Field ID in the form is 7.)
Submitter/Submitter	String	The Submitter field value of the created request. (Field ID in the form is 2.)
CreateDate/CreateDate	String	The Create Date field value of the created request. (Field ID in the form is 3.)

Post-conditions

None.

Get Request

Retrieves core fields of the specified request. The action is applicable for the Regular and Join forms.

Pre-conditions

•

The specified form exists on the server.

•

A request with the specified ID exists.

Table 5. Get Request Input Parameters
Name/Scripting name	Type	Description
Server/Server	Topologyobject	[BMCRemedyServer]. The BMC Remedy server.
FormName/FormName	String	Name of a form containing the request.
RequestID/RequestID	String	An ID of the request to be retrieved.

Table 6. Get Request Output Parameters
Name/Scripting name	Type	Description
Status/Status	String	The Status field value of the request. (Field ID in the form is 7.)
Submitter/Submitter	String	The Submitter field value of the request. (Field ID in the form is 2.)
AssignedTo/AssignedTo	String	The Assigned To field value of the request. (Field ID in the form is 4.)
CreateDate/CreateDate	String	The Create Date field value of the request. (Field ID in the form is 3.)
ModifiedDate/ModifiedDate	String	The Modified Date field value of the request. (Field ID in the form is 6.)
LastModifiedBy/LastModifiedBy	String	The Last Modified By field value of the request. (Field ID in the form is 5.)
ShortDescription/ShortDescription	String	The Short Description field value of the request. (Field ID in the form is 8.)