Space banner

 

This documentation supports the 20.02 version of BMC Digital Workplace Advanced.

To view the latest version, select the version from the Product Version menu.

Remedy connector

The Remedy connector supplies elements to the process designer palette that you can embed into fulfillment workflows. The elements enable you to perform, create and update actions through any Remedy form, as well as specific actions to create work orders and service requests, incident requests, and change requests. 

The Remedy connector supports applications built by using Remedy 8.1 SP2 and later.

Configuration parameters for the Remedy connector

Before you can use the Remedy connector to import services (for resource mapping or in workflows), you must configure the integration to Remedy Action Request System, as described in Integrating Remedy applications with BMC Digital Workplace Catalog. Then, you must configure a connection, as described in Configuring service connectors. The following table describes the parameters required to create a connection:

ParameterExamplesDescription
Host

server-itsm-example.com

server-itsm-example

172.16.0.122

Name or IP address of the host Remedy server.
Port

0

2222

46262

Port number for service-level access.
UserAllen

Login name and password of a user with AR Administrator permission.

User passwordPassw0rd&

Resource mapping capabilities

The Remedy connector exposes the following resources that can be mapped to selection-type questions:

ResourceDescriptionExamples
Data sets

Map selection-type questions to existing SRD questions.

  • Priority
  • Type of Phone
  • Job Role
Forms

Map selection-type questions to Remedy forms. Filter the returned data using a custom query.

  • CTM:People
  • AP:Detail
  • CFG:Geography Country

With manual data lookup questions, action triggers are not supported.

Catalog import capabilities

The Remedy connector exposes the following items that can be imported in the Service Queue:

Importable itemDescription
Service Request Definitions (SRD)Import metadata for services, including fulfillment workflow, associated questionnaire forms, and action triggers.
Service categoriesImport service categories or map Remedy Service Request Management categories to existing categories in the catalog.

For more information, see Importing service catalog items from external systems.

Workflow actions available through the Remedy connector

The following table provides an overview of all Remedy connector actions:

Action categoryActionDescriptionInput parametersOutput parameters
Service request

Submit Service Request

Use these actions to submit a service request into a connected Remedy Service Request Management system.

The Submit Service Request With Identifiers action is similar to Submit Service Request, but includes additional output Identifier fields that can be referenced in the other actions in a workflow.

Submit Service Request input parameters

Submit Service Request output parameters

Submit Service Request With Identifiers

Submit Service Request With Identifiers output parameters

Update Service Request
Entry

Create Entry

Use this action to create a record through any form in a Remedy system.

When an entry is created, the system returns an Entry ID.

Create Entry input parameters

The returned object includes the Entry ID.

Get Entry

Use this action to retrieve a record by ID through any form in a Remedy application.Get Entry input parameters

The returned object includes a map with keys and values.

The specific fields that are returned depend on the specific record that is returned.

Get Entry By Query

Use this action to find a specific record that is submitted through a form, and to retrieve the specified record.

You can also use this action to retrieve some entry through a search query, so that the output result can be used in subsequent operations in a workflow.

To view the results of Get Entry by Query, use the subsequent Send In App Notification action. When a notification is sent to BMC Digital Workplace Catalog, it includes JSON output with the fields IDs to retrieve.

Get Entry by Query input parameters

The returned object includes field IDs and values specified in the Field IDs to retrieve.

Get Entries By Query

Use this action to find specific records submitted through a form, and to retrieve multiple records.

After you retrieve multiple data records, you can pass the data to other activities in a workflow by using a multi-instance loop. For more details about how to use a multi-instance loop to process multiple arrays of data, see Processing data sequentially and in parallel.

Get Entries by Query input parametersThe returned output includes a data array with multiple entries.

Set Entry

Use this action to update values for an existing record in any form in a connected Remedy system.Set Entry input parameters

The returned object includes a map with keys and values.

The specific fields that are returned depend on the specific record that is returned.

Delete Entry

Use this action to delete a record referenced by ID.

This action might be necessary when a catalog administrator needs to perform administrative tasks like cleaning up old or orphaned records or removing after archiving.

Delete Entry input parametersNo output parameters
Change request

Create Change Request

Use these actions to create change requests with optional attachments or through a template.

The Create Change Request With Identifiers action is similar to Create Change Request. It has the same parameters, but includes additional output Identifier fields that might be used in other actions in a workflow.

Create Change Request input parametersCreate Change Request output parameters

Create Change Request With Identifiers

Create Change Request With Identifiers output parameters

Get Change Request By ID

Use these actions to retrieve a change request by its IDs, and return an object that contains the details of a change request.

The Get Change Request By Identifiers action is similar to Get Change Request By ID. It has the same parameters, but includes additional input Identifier fields that might be used in other actions in a workflow.

Get Change Request by Id input parametersThe returned output object returns all available details of a change request.

Get Change Request By Identifiers

Get Change Request By Identifiers input parameters

Create Attachments For Change Request
Work order

Create Remedy Work Order

Use these actions to create work orders by defining mandatory fields (summary, description), and optional custom fields, such as attachments. You can also create a work order by applying a template.

The Create Remedy Work Order With Identifiers action is similar to Create Remedy Work Order. It has the same parameters, but includes additional output Identifier fields that might be used in other actions in a workflow.

Create Remedy Work Order input parameters

Create Work Order output parameters

Create Remedy Work Order With Identifiers

Create Work Order With Identifiers output parameters

Get Remedy Work Order By ID

Use these actions to retrieve a work order by its IDs, and return an object that contains the work order details.

The Get Remedy Work Order By Identifiers action is similar to Get Remedy Work Order By ID. It has the same parameters, but includes additional input Identifier fields that might be used in other actions in a workflow. 


Get Remedy Work Order By ID input parameters

The returned output object returns all available details of a work order.

Get Remedy Work Order By Identifiers

Get Remedy Work Order By Identifiers
Create Attachment For Work Order
Incident

Create Incident

Use these actions to create incidents by defining mandatory fields, and optional custom fields, such as attachments. You can also create an incident by applying a template.

The Create Incident With Identifiers action is similar to Create Incident. It has the same parameters, but includes additional output Identifier fields that might be used in other actions in a workflow.

Create Incident input parameters

Create Incident output parameters

Create Incident With Identifiers

Create Incident With Identifiers output parameters

Get Incident By ID

Use these actions to retrieve incidents by IDs.

The Get Incident By Identifiers action is similar to Get Incident By ID. It has the same parameters, but includes additional input Identifier fields that might be used in other actions in a workflow.

Get Incident by ID input parametersThe returned output object returns all available details of an incident.

Get Incident By Identifiers

Get Incident by Identifiers input parameters

Create Attachments For Incident

Use cases and workflow examples

The following use cases describe sample workflows with the Remedy connector actions.

Note

To understand the use cases described in this section, you must understand the generic elements of the workflow designer, and know the basic rules of creating workflows.

Use case 1: Create a workflow for a service that sets up a new employee's workplace

The process workflow for this service might consist of the following stages: 

  1. A department manager submits a service request to set up a workplace for a new employee. 
  2. A work order is created for the Facilities group to assign an office to the new employee.
  3. By using the Get Entry By Query action, the system retrieves the Office Number value assigned to the employee.
  4. The retrieved office number value is used as an input for other work orders assigned to teams who can perform their tasks in parallel:
    • Telecommunications group—to set up a phone 
    • Networking group—to set up the network
    • IT support—to provide a laptop with the installed software
  5. A notification is sent to the service requester when the work is completed.
  6. The service request is closed.

Use case 2: Create a workflow for a service that contains multiple tickets assigned to different teams

A single service might include tasks for different teams, such as a purchase, installation, provisioning, software installation, and configuration. The workflow needs to determine when steps are complete and pass the relevant information from one stage to the next, so that each team in the workflow can fulfill their assignments. 

The following workflows shows how a similar service request can be completed in different ways:

  • By using a Receive Task action

  • By using a Get Entry by Query action

 

Input and output parameters for actions

This section describes how you can use Remedy connector actions in the workflows that you build.

Note

You do not need to use parameters in the process designer element that are not listed.

Input parameters for Submit Service Request and  Submit Service Request With Identifiers actions

Both of these actions have the same input parameters described in the following table:

RequiredParameter nameData typeExamplesDescription
RequiredConnection IdStringConnection > RemedyDefault Connection ID for this connector.
Required

Srd Id

String"SRD00001234"SRD used to create the service request. The status must be Online.
RequiredRequested By Login IdString

Process context > Requested By Login Name

Login ID of the user who submitted the request.

OptionalRequested For Login IdString

Process context > Requested For Login Name

Login ID of the user who requires the service.

If a login ID is not specified, the value for Requested By Login Id is used.

OptionalDescriptionStringProcess input > Text variable

Details to be sent to the request handler.

OptionalCart IdString

Process context > Order ID

ID of the order's shopping cart.
OptionalCart GUIDString

Process context > Order GUID

GUID of the order's shopping cart.
OptionalCart NameString

Process context > Order Description

Description of the order's shopping cart.
Optional Expected DateDate

Process input > Date variable

User-submitted date for the service request to be completed.

If a date is not specified, the field is populated based on the SRD rules.

Optional AttachmentsString

Process input > Text variable

String array of attachment ID values that is submitted by using a Text process input.

In the associated questionnaire, map the Text process input to an Attachment question.


Optional AnswersString

Process context > Questions And Answers

String representation of all questions and responses, including those assigned to process inputs and created questions.
Optional Correlation IdString

General > Process Correlation ID

System-generated key that identifies the service request to the integration component. For more information, see Waiting for a response.
OptionalQuantityInteger

Process context > Requested Item Quantity

Order quantity requested by the self-service user.
OptionalOne Time CostString

Process context > Service One Time Cost

Value of the one-time cost with the system currency appended, for example, 164.50 USD.
OptionalMonthly CostString

Process context > Service Monthly Cost

Value of the monthly cost with the system currency appended, for example, 12.25 USD.

Submit Service Request output parameters

Parameter nameData typeExampleDescription

Output

Object

REQ1797

Request ID—A system field that is added by default to all Remedy forms and can be used in follow-on workflow activities. The Remedy field ID for Request ID is 1.

Submit Service Request With Identifiers output parameters

Parameter nameData typeExamplesDescription
OutputObject

REQ1797;

SRGAA5V0GFHPPAOUA6BOOTE2HB;

000000000001789;

Request ID—A system field that is added by default to all Remedy forms and can be used in follow-on workflow activities. The Remedy field ID for Request ID is 1.

Instance ID—A field for storing a GUID. The Remedy field ID for Instance ID is 179.

SysRequest—Remedy shows this ID to users as a service request number. The Remedy field ID for SysRequest is 1000000829.

Input parameters for Create Remedy Work Order and Create Remedy Work Order With Identifiers actions

The Create Remedy Work Order and Create Remedy Work Order With Identifiers actions have the same input parameters described in the following table:

RequiredParameter nameData typeExampleDescription
RequiredConnection IdStringConnection > RemedyDefault Connection ID for this connector.
RequiredContact Login IdString

Process context > Requested By Login Name

Login ID of the user who submitted the request.

RequiredSummaryStringProcess input > Text variableSummary to be sent to the request handler.
Optional Customer Login IdString

Process context > Requested For Login Name

Login ID of the user who requires the service.

If a login ID is not specified, the value for Requested By Login Id is used.

OptionalWork Order TypeString

Process input > Selection variable

  • Project
  • General

Default: General

Specify the most appropriate value, or offer the user a selection.

Tip: In the questionnaire, you can build a list of values by using Map to Dataset to select a list that matches the parameter name.

OptionalDescriptionStringProcess input > Text variable Notes field to be sent to the request handler.
OptionalPriorityString

Process input > Selection variable

  • Critical
  • High
  • Medium
  • Low

Default: Low

Specify the most appropriate value, or offer the user a selection.

Tip: In the questionnaire, you can build a list of values by using Map to Dataset to select a list that matches the parameter name.

OptionalTemplate NameString"IT Process Template"

Name of a work order template to use when creating the work order. Can be used in conjunction with custom fields in the Detail and Detail2 fields.

For details about how these templates are created, see Creating work order templates Open link .

OptionalAttachmentsString

Process input > Text variable

String array of attachment ID values that is submitted by using a Text process input.

In the associated questionnaire, map the Text process input to an Attachment question.


OptionalCorrelation IdStringGeneral > Process Correlation IDSystem-generated key that identifies the service request to the integration component. For more information, see Waiting for a response.
OptionalDetailInput Set

Build Input Set > Output > Inputs

Object that contains custom field labels and values to populate the Detail and Detail 2 tabs of a work order.

For information about preparing custom field sets, see Submitting custom fields.


Optional Detail2Input Set

Build Input Set > Output > Inputs

OptionalProduct NameStringMicrosoft Word

A term used to reference a product. This depends on the options selected for Product Category Tier 1, 2, and 3.

For more information, see Creating product categories (optional) Open link .

OptionalProduct Model Or VersionString2007

Product models and versions are used to differentiate the available models or versions for a given product.

For more information, see Adding product models and versions Open link .

OptionalProduct ManufacturerStringMicrosoft

Name of the company that manufactures the product. Each product can have only one manufacturer, but each manufacturer can have multiple products.

For more information, see Creating product categories (optional) Open link .

OptionalOperational Category Tier1StringAdd

Operational categories are used to list the operational services that a typical help desk provides.

Tier 1 determines which tier 2 categories are available, and tier 2 determines which tier 3 categories are available.

For more information, see Creating operational categories (optional) Open link .

OptionalOperational Category Tier2StringUser
OptionalOperational Category Tier3StringAccount
OptionalProduct Category Tier1StringSoftware

Product categories are used for categorization of products, and can be used for setting associations with different processes for different companies. It can represent hardware, software, or a service.

Tier 1 determines which tier 2 categories are available, and tier 2 determines which tier 3 categories are available.

For more information, see Product categorization structure Open link .

OptionalProduct Category Tier2StringApplication
OptionalProduct Category Tier3StringProductivity
OptionalSiteStringHK IT

A specific site in a location.

For more information, see Creating locations Open link .

OptionalSite GroupStringHong Kong

Geographic areas can be subdivided into site groups, which are collections of individual locations. A company can have any number of site groups, depending on how many locations it has and where they are. An example of a company site group is ABC Europe Region.

OptionalRegionStringAsia Pacific

Geographic areas can be divided into regions. A company can have several regions, depending on how many sites it has and where the sites are located. Examples of company regions are Northwest, Atlantic, and Pacific. Creating regions under a company is done only for reporting in Remedy ITSM.

(Version 20.02.03 and later) OptionalOther FieldsString

Key5 = "ADateTime"

Value5 = "Actual End Date"

Specify any other input mappings that are not available in the default input map list and Remedy Service Request Management. This parameter consumes the inputs of the Build Input Set activity. You can create any number of custom parameters through Build Input Set and feed them into the Create Remedy Work Order and Create Remedy Work Order With Identifiers activities.

To add custom parameters through Other Fields:

  1. Add the Build Input Set activity to the canvas, and click it.
  2. Add Key-Value pairs (for example, Key1 = "Status", Value1 = "Completed").
    Use double quotation marks to indicate strings.
  3. In the Create Remedy Work Order or Create Remedy Work Order With Identifiers activity, select Other Fields > Activities > Build Input Set > Output > Inputs.
    You have bound the inputs of Build Input Set with the Work Order activity.

Although Build Input Set has only ten Key-Value pairs, you can chain as many as you want. (Add Build Input Set 1 to the canvas, and feed the output of Build Input Set into Input Set1 of Build Input Set 1. You can feed the output of Build Input Set 1 into Create Remedy Work Order or Create Remedy Work Order With Identifiers.)

Submitting custom fields

The Detail and Detail2 parameters take the output of one or more chained Build Input Set activities to assign labels and values for custom fields in the work order to be created. The custom fields are given an index number in the order that the field labels are specified. Populate up to 34 custom fields in a work order by specifying unique field labels the Build Input Set elements that populate either or both Detail or Detail2 fields.

Tip

The first 15 WO Type fields need to be appended to one input set and added to the detail input parameter, and the next 19 WO Type fields to another input set and added to the detail2 input parameter.


If a field label is declared twice in a process before creating the work order, then the process will update the value of the field that was created earlier.

Details and Details 2 field data types

The custom fields expect values in strict data types. The following table shows the data types expected for each of the 34 fields based on the field index order.

Note

Only the variable data types specified in the following list are supported with the Remedy connector.


Field indexData typeWork order field relationship
1 to 5TextWO Type Field 1 to WO Type Field 5
6 to 7Date/TimeWO Type Field 6 to WO Type Field 7
8 to 9IntegerWO Type Field 8 to WO Type Field 9
10 to 23TextWO Type Field 10 to WO Type Field 23
24 to 27IntegerWO Type Field 24 to WO Type Field 27
28 to 30TextWO Type Field 28 to WO Type Field 30
31 to 32DateWO Type Field 48 to WO Type Field 49
33 to 34TimeWO Type Field 50 to WO Type Field 51

Create Remedy Work Order output parameters

Parameter nameData typeExampleDescription

Output

Object

REQ1797

Request ID—A system field that is added by default to all Remedy forms and can be used in follow-on workflow activities. The Remedy field ID for Request ID is 1.

Create Remedy Work Order With Identifiers output parameters

Parameter nameData typeExamplesDescription
OutputObject

000000000010792;

AGGAA5V0GFHPPAOUAGHYOTEC30T9X6;

WO10918;

Request ID—A system field that is added by default to all Remedy forms and can be used in follow-on workflow activities. The Remedy field ID for Request ID is 1. The Request ID in the output is from the WOI:WorkOrderInterface_Create form.

Instance ID—A field for storing a GUID. The Remedy field ID for Instance ID is 179. The Instance ID in the output is from the WOI:WorkOrder form.

Work Order ID —Remedy shows this ID to users as a work order number. The Remedy field ID for Work Order ID is 1000000182. The Work Order ID in the output is from the WOI:WorkOrder form.

Get Remedy Work Order By ID input parameters

Required

Parameter nameData typeExampleDescription
RequiredConnection IDStringConnection > RemedyDefault Connection ID for this connector.

Required

Work Order IDString"WO10918"

Remedy shows this ID to end users as a work order number.

The Remedy field ID for Work Order ID is 1000000182.

Get Remedy Work Order By Identifiers

Required

Parameter nameData typeExampleDescription
RequiredConnection IDStringConnection > RemedyDefault Connection ID for this connector.

At least one of the parameters is required

Work Order IDString"WO10918"

Remedy shows this ID to end users as a work order number.

The Remedy field ID for Work Order ID is 1000000182.
Request IDString"000000000010792"

A system field added by default to all Remedy forms. It might be useful in certain follow-on workflow activities. The Remedy field ID for Request ID is 1.

Instance IDString"AGGAA5V0GFHPPAOUAGHYOTEC30T9X6"

A field for storing a GUID.

The Remedy field ID for Instance ID is 179.

Input parameters for Create Incident and Create Incident With Identifiers actions

Both of these actions have the same input parameters described in the following table:

RequiredParameter nameData typeExampleDescription
RequiredConnection IdStringConnection > Remedy Default Connection ID for this connector.
Required

Login

String

Process context > Requested For Login Name

Login ID of the user who requires the service.

Required

Service Type

String

Process input > Selection variable:

  • User Service Restoration
  • User Service Request
  • Infrastructure Restoration
  • Infrastructure Event

Specify the most appropriate value, or offer the user a selection.

Tip: In the questionnaire, you can build a list of values by using Map to Dataset to select a list that matches the parameter name.

Optional 

Status

String

Process input > Selection variable:

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

Default: Assigned

Specify the most appropriate value, or offer the user a selection.

Tip: In the questionnaire, you can build a list of values by using Map to Dataset to select a list that matches the parameter name.

Required

Impact

String

Process input > Selection variable:

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

Specify the most appropriate value, or offer the user a selection.

Tip: In the questionnaire, you can build a list of values by using Map to Dataset to select a list that matches the parameter name.

Required

Urgency

String

Process input > Selection variable:

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

Specify the most appropriate value, or offer the user a selection.

Tip: In the questionnaire, you can build a list of values by using Map to Dataset to select a list that matches the parameter name.

Required

Reported Source

String

Process input > Selection variable:

  • Direct Input
  • Email
  • External Escalation
  • Fax
  • Systems Management
  • Phone
  • Voice Mail
  • Walk In
  • Web
  • Other
  • BMC Impact Manager Event

Specify the most appropriate value, or offer the user a selection.

Example: Most self-service requests should be reported as from Web or Direct Input.

Tip: In the questionnaire, you can build a list of values by using Map to Dataset to select a list that matches the parameter name.

Required

Summary

StringProcess input > Text variableSummary to be sent to the request handler.
Optional

Notes

StringProcess input > Text variableNotes field to be sent to the request handler.
Optional

Submitter

String

Process context > Requested By Login Name

Login ID of the user who submitted the request.

If a login ID is not specified, the value for Requested By Login Id is used instead.

Optional

Template Name

String<Project template name>

Name of an incident template to use. For more details about how these templates are created in BMC Remedy IT Service Management, see Configuring Incident Management templates Open link .

OptionalAttachmentsString

Process input > Text variable

String array of attachment ID values that is submitted by using a Text process input.

In the associated questionnaire, map the Text process input to an Attachment question.

If you specify this field, you must also specify the Work Info Type field.

OptionalWork info notesString"Attachment for an incident entry"

When attachments are submitted, the default value is: Attachment for an incident entry.

OptionalWork info typeString

Process input > Selection variable:

Customer Inbound

  • Customer Communication
  • Customer Follow-up
  • Customer Status Update

Customer Outbound

  • Closure Follow Up
  • Detail Clarification
  • General Information
  • Resolution Communications
  • Satisfaction Survey
  • Status Update

General

  • Incident Task / Action
  • Problem Script
  • Working Log
  • Email System
  • Paging System
  • BMC Impact Manager Update
  • Chat

Vendor

  • Vendor Communication

Default: None

Specify the most appropriate value, or offer the user a selection.

Tip: In the questionnaire, you can build a list of values by using Map to Dataset to select a list that matches the parameter name.


OptionalCorrelation IdString

General > Process Correlation ID

System-generated key that identifies the service request to the integration component. For more information, see Waiting for a response.
OptionalProduct NameStringMicrosoft Word

A term used to reference a product. This depends on the options selected for Product Category Tier 1, 2, and 3.

For more information, see Creating product categories (optional) Open link .

OptionalProduct Model Or VersionString2007

Product models and versions are used to differentiate the various models or versions that are available for a given product.

For more information, see Adding product models and versions Open link .

OptionalProduct ManufacturerStringMicrosoft

Name of the company that manufactures the product. Each product can have only one manufacturer, but each manufacturer can have multiple products.

For more information, see Creating product categories (optional) Open link .

OptionalResolution DetailsString<List of steps>

Steps that resolved the incident.

For more information, see Configuring resolution settings for incident management templates Open link .

OptionalResolution Product NameStringMicrosoft WordName of the company that manufactures the product provided as part of the resolution.
OptionalResolution Product Model Or VersionString2010The product model or version of the product provided as part of the resolution.
OptionalResolution Product ManufacturerStringMicrosoftThe manufacturer of the product provided as part of the resolution.
OptionalOperational Category Tier1StringAdd

Operational categories are used to list the operational services that a typical help desk provides.

Tier 1 determines which tier 2 categories are available, and tier 2 determines which tier 3 categories are available.

For more information, see Creating operational categories (optional) Open link .

OptionalOperational Category Tier2StringUser
OptionalOperational Category Tier3StringAccount
OptionalResolution Operational Category Tier1StringAdd

Resolution operational categories are used to list the resolution for incidents.

Tier 1 determines which tier 2 categories are available, and tier 2 determines which tier 3 categories are available.

For more information, see Creating a resolution categorization from the Generic Catalog Update form Open link .

OptionalResolution Operational Category Tier2StringUser
OptionalResolution Operational Category Tier3StringAccount
OptionalResolution Product Category Tier1StringSoftware

Resolution categorizations are associated with existing operational and product categorization.

Tier 1 determines which tier 2 categories are available, and tier 2 determines which tier 3 categories are available.

For more information, see Creating a resolution categorization from the Generic Catalog Update form Open link .




OptionalResolution Product Category Tier2 StringApplication
OptionalResolution Product Category Tier3 StringProductivity
(Version 20.02.02 and later) OptionalOther FieldsString

Key5 = "Urgency"

Value5 = "3-Medium"

Specify any other input mappings that are not available in the default input map list and BMC Service Request Management. This parameter consumes the inputs of the Build Input Set activity. You can create any number of custom parameters through Build Input Set and feed them into the Create Incident or Create Incident With Identifiers activities.

To add custom parameters though Other Fields:

  1. Add the Build Input Set activity to the canvas, and click it.
  2. Add Key-Value pairs (for example, Key1 = "Vendor Ticket Number", Value1 = "55501").
    Use double quotation marks to indicate strings.
  3. In the Create Incident or Create Incident With Identifiers activity, select Other Fields > Activities > Build Input Set > Output > Inputs.
    You have bound the inputs of Build Input Set with the Incident activity.

Although Build Input Set has only ten Key-Value pairs, you can chain as many of them as you want. (Add Build Input Set 1 to the canvas, feed the output of Build Input Set into Input Set1 of Build Input Set 1. The output of Build Input Set 1 can be fed into Create Incident or Create Incident With Identifiers).

Create Incident output parameters 

Parameter nameData typeExamplesDescription

Output

Object

REQ1797

Request ID—A system field that is added by default to all Remedy forms and can be used in follow-on workflow activities. The Remedy field ID for Request ID is 1.

Create Incident With  Identifiers output parameters 

Parameter nameData typeExamplesDescription
OutputObject

000000000010792;

AGGAA5V0GFHPPAOUAGHYOTEC30T9X6;

WO10918;

Request ID—A system field that is added by default to all Remedy forms and can be used in follow-on workflow activities. The Remedy field ID for Request ID is 1.

Instance ID—A field for storing a GUID. The Remedy field ID for Instance ID is 179.

Incident Number—Remedy shows this ID to users as an incident number. The Remedy field ID for Incident Number is 1000000161.

Get Incident by ID input parameters

Required

Parameter nameData typeExampleDescription
RequiredConnection IdStringConnection > Remedy Default Connection ID for this connector.
RequiredIncident NumberString"INC1221"

Remedy shows this ID to users as an incident number.

The Remedy field ID for Incident Number is 1000000161.

Get Incident by Identifiers input parameters

Required

Parameter nameData typeExampleDescription
RequiredConnection IdStringConnection > Remedy Default Connection ID for this connector.

At least one of the parameters is required

Incident NumberString"INC1221"

Remedy shows this ID to users as an incident number.

The Remedy field ID for Incident Number is 1000000161.
Request ID String"000000000001097"

A system field that is added by default to all Remedy forms and can be used in follow-on workflow activities.
The Remedy field ID for Request ID is 1.


Instance IDString"AGGAA5V0GFHPPAOUAHB4OTEDGQTKB4"

A field for storing a GUID. The Remedy field ID for Instance ID is 179.


Input parameters for Create Change Request and Create Change Request With Identifiers actions

Both of these actions have the same input parameters described in the following table:

RequiredParameter nameData typeExampleDescription
RequiredConnection IdStringConnection > Remedy Default Connection ID for this connector.
RequiredLogin 

Process context > Requested For Login Name

Login ID of the user who requires the change.
RequiredCompany Calbro Services

Company must exist in the Remedy system.

Optional Status 

Process input > Selection variable

  • Draft
  • Request For Authorization
  • Request For Change
  • Planning In Progress
  • Scheduled For Review
  • Scheduled For Approval
  • Scheduled
  • Implementation In Progress
  • Pending
  • Rejected
  • Completed
  • Closed
  • Cancelled

Default: Scheduled

Specify the most appropriate value, or offer the user a selection.

Tip: In the questionnaire, you can build a list of values by using Map to Dataset to select a list that matches the parameter name.

Optional PriorityString

Process input > Selection variable

  • Critical
  • High
  • Medium
  • Low

Default: Low

Specify the most appropriate value, or offer the user a selection.

Tip: In the questionnaire, you can build a list of values by using Map to Dataset to select a list that matches the parameter name.

Optional Desc Process input > Text variableNotes field to be sent to the change handler.
RequiredSummary Process input > Text variableSummary to be sent to the change handler.
Optional Location CompanyString

Calbro Services US

The Location Company must exist in the Remedy system. The Location Company is defined in the Company+ field in the Create Change Request form.
Optional Template Name Project template name

Name of a template to use when creating the change request. For more details about how these templates are created in Remedy IT Service Management, see Configuring change templates Open link .

Optional Attachments 

Process input > Text variable

String array of attachment ID values that is submitted by using a Text process input.

In the associated questionnaire, map the Text process input to an Attachment question.

If you specify this field, you must also specify the Work Info Type field.

Optional Work info notes Attachment for a change request entryWhen attachments are submitted, the default value is Attachment for a change request entry.
Optional Work info type 

Process input > Selection variable

Requirements

  • Business Justification
  • Requirements

Analysis

  • Change Assessment
  • Potential Problems
  • Risk Assessment
  • Service Impact Assessment

Build

  • Backout Plan
  • Business Design
  • Development
  • Install Plan
  • Technical Design
  • Test Plan

Execution

  • Backout Results - Details
  • Install Results - Details
  • Test Results - Details

Closure

  • Cancellation Information
  • Post implementation Review

Audit

  • Configuration Audit
  • SLM Compliance Audit
  • SLM Process Review

General

  • General Information
  • Rejection Information
  • Email System
  • Paging System
  • Chat
A known value from the list must be specified.
Optional Correlation IdString

General > Process Correlation ID

System-generated key that identifies the service request to the integration component. For more information, see Waiting for a response.
OptionalProduct NameStringMicrosoft Word

A term used to reference a product. This depends on the options selected for Product Category Tier 1, 2, and 3.

For more information, see Creating product categories (optional) Open link .

OptionalProduct Model Or VersionString2007

Product models and versions are used to differentiate the available models or versions for a given product. For more information, see Adding product models and versions Open link .


OptionalProduct ManufacturerStringMicrosoft

Name of the company that manufactures the product. Each product can have only one manufacturer, but each manufacturer can have multiple products.

For more information, see Creating product categories (optional) Open link .

OptionalProduct Category Tier1StringSoftware

Product categories are used to categorize products, and can be used for setting associations with different processes for different companies. It can represent hardware, software, or a service.

Tier 1 determines which tier 2 categories are available, and tier 2 determines which tier 3 categories are available.

For more information, see Product categorization structure Open link .

OptionalProduct Category Tier2StringApplication
OptionalProduct Category Tier3StringProductivity
OptionalOperational Category Tier1StringAdd

Operational categories are used to list the operational services that a typical help desk provides.

Tier 1 determines which tier 2 categories are available, and tier 2 determines which tier 3 categories are available.

For more information, see Creating operational categories (optional) Open link .

OptionalOperational Category Tier2StringUser
OptionalOperational Category Tier3StringAccount
OptionalClassStringNormal

Used to specify the impact of the change request.

For more information, see Configuring classification settings for change templates Open link .

OptionalTiming ReasonStringCustomer need

Used to specify the reason for the timing of the change request.

For more information, see Timing Reasons Open link .

OptionalChange ReasonStringUpgrade

Used to specify the reason for the change request.

For more information, see Configuring classification settings for change templates Open link .

OptionalUrgencyStringCritical

Used to specify the level of urgency.

For more information, see Configuring classification settings for change templates Open link .

OptionalRisk LevelStringLevel 3

Used to specify the level of risk.

For more information, see Configuring classification settings for change templates Open link .

(Version 20.02.03 and later) OptionalOther fieldsString

Key5 = "Vendor Ticket Number"

Value5 = "abc"

Specify any other input mappings that are not available in the default input map list and BMC Service Request Management. This parameter consumes the inputs of the Build Input Set activity. You can create any number of custom parameters through Build Input Set and feed them into the Create Change Request and Create Change Request With Identifiers activities.

To add custom parameters through Other Fields:

  1. Add the Build Input Set activity to the canvas, and click it.
  2. Add Key-Value pairs (for example, Key1 = "Description", Value1 = "Other field").
    Use double quotation marks to indicate strings.
  3. In the Create Change Request or Create Change Request With Identifiers activity, select Other Fields > Activities > Build Input Set > Output > Inputs.
    You have bound the inputs of Build Input Set with the Change Request activity.

Although Build Input Set has only ten Key-Value pairs, you can chain as many of them as you want. (Add Build Input Set 1 to the canvas, feed the output of Build Input Set into Input Set1 of Build Input Set 1. The output of Build Input Set 1 can be fed into Create Change Request or Create Change Request With Identifiers.)

Create Change Request output parameters

Parameter nameData typeExamplesDescription

Output

Object

REQ1797

Request ID—A system field added by default to all Remedy forms that can be used in follow-on workflow activities. The Remedy field ID for Request ID is 1.

Create Change Request With Identifiers output parameters

Parameter nameData typeExamplesDescription
OutputObject

000000000010792;

AGGAA5V0GFHPPAOUAGHYOTEC30T9X6;

CR10918;

Request ID—A system field that is added by default to all Remedy forms and can be used in follow-on workflow activities. The Remedy field ID for Request ID is 1.

Instance ID—A field for storing a GUID. The Remedy field ID for Instance ID is 179.

Infrastructure Change ID—Remedy shows this ID to users as an change request number. The Remedy field ID for Infrastructure Change ID is 1000000182.

Get Change Request by Id input parameters

Required

Parameter nameData typeExampleDescription
RequiredConnection IdStringConnection > Remedy Default Connection ID for this connector.
RequiredRequest IdString000000000000646

A system field that is added by default to all Remedy forms and can be used in follow-on workflow activities. The Remedy field ID for Request ID is 1.

Get Change Request by Identifiers input parameters

Required

Parameter nameData typeExampleDescription
RequiredConnection IdStringConnection > Remedy Default Connection ID for this connector.

At least one of the parameters is required

Request IdString"000000000000646"

A system field that is added by default to all Remedy forms and can be used in follow-on workflow activities. The Remedy field ID for Request ID is 1.


Infrastructure Change ID String"CR005678"

Remedy shows this ID to users as a change request number. The Remedy field ID for Infrastructure ID is 1000000182.

Instance IDString"AGGAA5V0GFHPPAOUAFP5OTEBUST9UE"

A field for storing a GUID. The Remedy field ID for Instance ID is 179.

Create Entry input parameters

RequiredParameter nameData typeExampleDescription
RequiredConnection IdStringConnection > Remedy Default Connection ID for this connector.
RequiredForm NameString"WOI:WorkOrderInterface"Form name to use for creating a record.
RequiredField ValuesInput Set

Build Input Set > Output > Inputs

Object that contains custom field labels and values to populate fields that the form requires. See Building a custom input map in a workflow.

OptionalCorrelation IdStringGeneral > Process Correlation IDSystem-generated key that identifies the service request to the integration component. For more information, see Waiting for a response.

Get Entry input parameters

RequiredParameter nameData typeExampleDescription
RequiredConnection IdStringConnection > RemedyDefault Connection ID for this connector.
RequiredForm NameString"WOI:WorkOrderInterface"Remedy form with data to retrieve.
RequiredRequest IdString"0001234"ID of record with data to retrieve.

Get Entry by Query input parameters

RequiredParameter nameData typeExampleDescription
RequiredConnection IdStringConnection > Connection IDDefault Connection ID for this connector.
RequiredForm NameString"SRD:ServiceRequestDefinition"Remedy form with data to retrieve.
RequiredQueryString"'SRD_Title'LIKE ""%SRD%"""

Search query.
The example shows a search query that returns all entries that have "SRD" characters in the SRD title.

This action type uses BMC Remedy query syntax. For more information about this query syntax, see Operators, wildcards, keywords, and NULL values Open link .

Optional Retrieve optionString

Process input > Selection variable:

  • FIRST
  • SINGLE

One of the following options:

  • FIRST (the default) returns only the first results from the list.
  • SINGLE validates the result list of entries, and displays an error if there is more than one entry.

Tip: Uppercase and lowercase characters are accepted.

OptionalField IDs to retrieveString

Activities > Build Input Set > Output > Inputs

Enter the input set that contains the field IDs that should be returned.

The Field IDs to retrieve field accepts integer values without quotes.

Get Entries by Query input parameters

RequiredParameter nameData typeExampleDescription
RequiredConnection IdStringConnection > Connection IDDefault Connection ID for this connector.
RequiredForm NameString"SRD:ServiceRequestDefinition"Remedy form with data to retrieve.
OptionalQueryString"'SRD_Title'LIKE ""%SRD%"""

Search query.
The example shows a search query that returns all entries that have "SRD" characters in the SRD title.

This action type uses BMC Remedy query syntax. For more information about this query syntax, see Operators, wildcards, keywords, and NULL values Open link .

OptionalLimitInteger"100"

Maximum number of fields to retrieve.

If not specified, 100 is the default value.

OptionalField IDs to retrieveString

Activities > Build Input Set > Output > Inputs

Enter the input set that contains the field IDs that should be returned.

The Field IDs to retrieve field accepts integer values without quotes.


Set Entry 
input parameters

RequiredParameter nameData typeExampleDescription
RequiredConnection IdStringConnection > Connection IDDefault Connection ID for this connector.
RequiredForm NameString"WOI:WorkOrderInterface"Remedy form to update.
RequiredRequest IdString"0001234"ID of record to update.
RequiredField ValuesInput SetBuild Input Set > Output > Inputs

Object that contains custom field labels and values to populate fields required by the form.

See Building a custom input map in a workflow.

Delete Entry input parameters

RequiredParameter nameData typeExampleDescription
RequiredConnection IdStringConnection > Connection IDDefault Connection ID for this connector.
RequiredForm NameString"WOI:WorkOrderInterface"Remedy form to delete.
RequiredRequest IdString"0001234"ID of record to update.
Was this page helpful? Yes No Submitting... Thank you

Comments

  1. Shekhar Raj

    Can we have more examples of queries which uses a process variable as a qualification for 'Get Entries by Query'. Also more detailed information around 'Field IDs to retrieve', if it is optional, how can I retrieve a field value in the following steps of the workflow etc.

    Jul 08, 2020 09:19
    1. Olha Horbachuk

      Hi Shekhar Raj, thanks for the questions.

      Could you please clarify what you mean by "a process variable as a qualification for 'Get Entries by Query'"? Examples of using the Get Entries by Query action in the workflow?

      If you leave the Field IDs to Retrieve input parameter empty, you will get all the information about the query. 

      Regards,

      Olha Horbachuk 

      Jul 28, 2020 03:24
      1. Jan Zacharjasiewicz

        And what is the syntax for the field: Field IDs to Retrieve ? Because typing there a plain number does not work. I want to retrive only one field ID. How to do it?

        Nov 11, 2020 04:34
        1. Olha Horbachuk

          Hi Jan Zacharjasiewicz, please use "[{""key"":""must be unique"",""value"":1000000019},{""key"":""must be unique2"",""value"":1000000018}]" or built an input set and try using this. If further assistance is needed, contact BMC Support.

          Regards,

          Olha

          Nov 12, 2020 11:47
          1. Jan Zacharjasiewicz

            Please give an example of syntax for this part in above document:

            "Note: The Field IDs to retrieve field accepts integer values without quotes."

            Nov 17, 2020 02:12
            1. Olha Horbachuk

              Jan Zacharjasiewicz, in the example, integer values are given without quotes → ""value"":1000000019.

              Nov 24, 2020 12:58
  2. Hemanthini Mirapakayala anjappa

    Hi, Could you please add input and output parameters for actions Create Attachments For Incident, Create Attachments For Change Request and Create Attachment For Work Order.

    Thanks, Hema

    Oct 27, 2020 09:21
  3. Marek Ceizel

    Field IDs to Retrieve works only with Build Input Set. If I define a Field (e.g. "{""Schema Name"":230000000}" form SHR:Schema Names) right after save the definition changes to "com.bmc.myservice.api.process.InputSet@1f77f5d1[inputs={Schema Name=com.bmc.myservice.api.process.Input@5ec58d16}]" which could be ok but I get always all fields. there is a bug!

    Jan 14, 2021 09:21
    1. Ravee Panjwani

      Thanks for your comment Marek Ceizel. We will validate this on our end and get back to you with an update.

      Thanks,
      Ravee

      Jan 14, 2021 11:28
      1. Marek Ceizel

        thank you for the quick response Ravee.

        Jan 14, 2021 11:35
        1. Ravee Panjwani

          Thanks for your patience, Marek. We are updating this topic to remove "{""keyname1"":1000000019,""key2"":1000000018}".

          Thanks, Ravee

          Feb 04, 2021 07:56
          1. Marek Ceizel

            I did get all values from getentry also with this:

            "[{""key"":""must be unique"",""value"":1000000019},{""key"":""must be unique2"",""value"":1000000018}]"

            it is still in discussion with support

            Feb 16, 2021 02:44
  4. Ariel Manka

    Hi,

    This document incorrectly describes "Set Entry input parameters" process with WOI:WorkOrderInterface example. WOI:WorkOrderInterface is a join form and RequestID is a compound key in a "WO0000000000442|WO0000000000442" format. Supplying Request ID of a work order results in "ERROR (302): Entry does not exist in database; " error. Is there a way to use Set Entry on join forms? What format of Request ID would work?

    Ariel

    Jun 02, 2021 10:10
    1. Olha Horbachuk

       Hi,

      You can do a Get Entry By Query of the WOI:WorkOrderInterface form to get the request ID. Then, you should be able to do a Set Entry with that Request Entry.

      Olha

      Jun 04, 2021 01:18
      1. Ariel Manka

        Hi Olha,

        I understand that yet my comment was to point out the error in the documentation in a hope that it will be corrected.

        Thanks Ariel

        Jun 07, 2021 10:47
        1. Olha Horbachuk

          Hi Ariel Manka, can you please confirm what exact change you need? What do you mean by joint forms? Do you expect the documentation team to update the example of the Request ID parameter name? 

          Thanks,

          Olha

          Dec 01, 2021 08:42
  5. Marek Ceizel

    I'm pretty sure the documentation is wrong in the part "Create Change Request and Create Change Request With Identifiers actions" field "Login" example. In example is written: "Process context > Requested For Login Name" then in description "Login ID of the user who requires the change.". User who requires is Requested by, not Requested for. Additionally it would be nice to mention that it makes no sense to map extra field "Requestor ID" as thet one will be always overwritten by the value of the "Login" field (that is also the proof that the login field should contain requested by login name)

    Jun 23, 2022 12:57
    1. Aaditi Lakade

      Hello, Marek Ceizel

      Thank you for pointing out these errors. Let me verify these changes along with a general accuracy of this topic, after which I will update the relevant sections in the docs. 

      Aaditi

      Jun 24, 2022 06:24
      1. Aaditi Lakade

        Hello, Marek Ceizel

        Regarding the first query about Requested For or Request By, the docs are correct. If A is submitting a change request on behalf of B, then A is the "Requested By" and B is the "Requested For". 

        The second query about the "requestor ID" field, could you point me to the exact section that you are talking about? There is no "Requestor ID" mentioned on this page. 

        Thanks, 

        Aaditi

        Jul 12, 2022 06:04
        1. Marek Ceizel

          Hello Aaditi,

          I'm afraid you are mixing this. Requested For is not the requestor but the customer. RequestorID = Requested by / Customer Login = Requested for

          Here in documentation these two are mixed. - Example: Process context > Requested For Login Name / - Description: Login ID of the user who requires the change.

          The user who requires the change is the requested by. The user for whom he requires this is requested for. The wording is important. In change Create the Login Name is put into requestorID.

          Jul 12, 2022 10:44
          1. Aaditi Lakade

            Hello Marek Ceizel

            Let me test this on our end and share some examples with you as well as update the docs. 

            Thanks, 

            Aaditi

            Jul 13, 2022 12:34
            1. Aaditi Lakade

              Hello, Marek Ceizel

              Requested For appears only if impersonation is enabled, otherwise, it will be Requested By. We have a confirmation from the R&D team that the wording is not errored. If you still have any confusion, you can contact BMC Customer support. 

              Thanks, 

              Aaditi

              Sep 19, 2022 01:04