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:
Parameter | Examples | Description |
---|---|---|
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. |
User | Allen | Login name and password of a user with AR Administrator permission. |
User password | Passw0rd& |
Resource mapping capabilities
The Remedy connector exposes the following resources that can be mapped to selection-type questions:
Resource | Description | Examples |
---|---|---|
Data sets | Map selection-type questions to existing SRD questions. |
|
Forms | Map selection-type questions to Remedy forms. Filter the returned data using a custom query. |
|
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 item | Description |
---|---|
Service Request Definitions (SRD) | Import metadata for services, including fulfillment workflow, associated questionnaire forms, and action triggers. |
Service categories | Import 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 category | Action | Description | Input parameters | Output 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 output parameters | |
Submit Service Request With Identifiers | ||||
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. | 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 parameters | The 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 parameters | No 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 parameters | Create 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 parameters | The returned output object returns all available details of a change request. | |
Get Change Request By Identifiers | ||||
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 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. | 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 output parameters | |
Create Incident With Identifiers | ||||
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 parameters | The returned output object returns all available details of an incident. | |
Get Incident By Identifiers | ||||
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:
- A department manager submits a service request to set up a workplace for a new employee.
- A work order is created for the Facilities group to assign an office to the new employee.
- By using the Get Entry By Query action, the system retrieves the Office Number value assigned to the employee.
- 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
- A notification is sent to the service requester when the work is completed.
- 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:
Required | Parameter name | Data type | Examples | Description |
---|---|---|---|---|
Required | Connection Id | String | Connection > Remedy | Default Connection ID for this connector. |
Required | Srd Id | String | "SRD00001234" | SRD used to create the service request. The status must be Online. |
Required | Requested By Login Id | String | Process context > Requested By Login Name | Login ID of the user who submitted the request. |
Optional | Requested For Login Id | String | 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. |
Optional | Description | String | Process input > Text variable | Details to be sent to the request handler. |
Optional | Cart Id | String | Process context > Order ID | ID of the order's shopping cart. |
Optional | Cart GUID | String | Process context > Order GUID | GUID of the order's shopping cart. |
Optional | Cart Name | String | Process context > Order Description | Description of the order's shopping cart. |
Optional | Expected Date | Date | 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 | Attachments | String | 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 | Answers | String | Process context > Questions And Answers | String representation of all questions and responses, including those assigned to process inputs and created questions. |
Optional | Correlation Id | String | General > Process Correlation ID | System-generated key that identifies the service request to the integration component. For more information, see Waiting for a response. |
Optional | Quantity | Integer | Process context > Requested Item Quantity | Order quantity requested by the self-service user. |
Optional | One Time Cost | String | Process context > Service One Time Cost | Value of the one-time cost with the system currency appended, for example, 164.50 USD. |
Optional | Monthly Cost | String | 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 name | Data type | Example | Description |
---|---|---|---|
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 name | Data type | Examples | Description |
---|---|---|---|
Output | Object | 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:
Required | Parameter name | Data type | Example | Description |
---|---|---|---|---|
Required | Connection Id | String | Connection > Remedy | Default Connection ID for this connector. |
Required | Contact Login Id | String | Process context > Requested By Login Name | Login ID of the user who submitted the request. |
Required | Summary | String | Process input > Text variable | Summary to be sent to the request handler. |
Optional | Customer Login Id | String | 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. |
Optional | Work Order Type | String | Process input > Selection variable
| 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. |
Optional | Description | String | Process input > Text variable | Notes field to be sent to the request handler. |
Optional | Priority | String | Process input > Selection variable
| 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 | Template Name | String | "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 . |
Optional | Attachments | String | 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 | Correlation Id | String | General > Process Correlation ID | System-generated key that identifies the service request to the integration component. For more information, see Waiting for a response. |
Optional | Detail | Input 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 | Detail2 | Input Set | Build Input Set > Output > Inputs | |
Optional | Product Name | String | Microsoft 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) . |
Optional | Product Model Or Version | String | 2007 | 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 . |
Optional | Product Manufacturer | String | Microsoft | 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) . |
Optional | Operational Category Tier1 | String | Add | 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) . |
Optional | Operational Category Tier2 | String | User | |
Optional | Operational Category Tier3 | String | Account | |
Optional | Product Category Tier1 | String | Software | 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 . |
Optional | Product Category Tier2 | String | Application | |
Optional | Product Category Tier3 | String | Productivity | |
Optional | Site | String | HK IT | A specific site in a location. For more information, see Creating locations . |
Optional | Site Group | String | Hong 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. |
Optional | Region | String | Asia 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) Optional | Other Fields | String | 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:
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.) |
Create Remedy Work Order output parameters
Parameter name | Data type | Example | Description |
---|---|---|---|
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 name | Data type | Examples | Description |
---|---|---|---|
Output | Object | 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 name | Data type | Example | Description |
---|---|---|---|---|
Required | Connection ID | String | Connection > Remedy | Default Connection ID for this connector. |
Required | Work Order ID | String | "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 name | Data type | Example | Description |
---|---|---|---|---|
Required | Connection ID | String | Connection > Remedy | Default Connection ID for this connector. |
At least one of the parameters is required | Work Order ID | String | "WO10918" | Remedy shows this ID to end users as a work order number. The Remedy field ID for Work Order ID is 1000000182. |
Request ID | String | "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 ID | String | "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:
Required | Parameter name | Data type | Example | Description |
---|---|---|---|---|
Required | Connection Id | String | Connection > 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:
| 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:
| 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:
| 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:
| 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:
| 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 | String | Process input > Text variable | Summary to be sent to the request handler. |
Optional | Notes | String | Process input > Text variable | Notes 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 . |
Optional | Attachments | String | 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 | String | "Attachment for an incident entry" | When attachments are submitted, the default value is: Attachment for an incident entry. |
Optional | Work info type | String | Process input > Selection variable: Customer Inbound
Customer Outbound
General
Vendor
| 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. |
Optional | Correlation Id | String | General > Process Correlation ID | System-generated key that identifies the service request to the integration component. For more information, see Waiting for a response. |
Optional | Product Name | String | Microsoft 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)
. |
Optional | Product Model Or Version | String | 2007 | 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 . |
Optional | Product Manufacturer | String | Microsoft | 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)
. |
Optional | Resolution Details | String | <List of steps> | Steps that resolved the incident. For more information, see Configuring resolution settings for incident management templates . |
Optional | Resolution Product Name | String | Microsoft Word | Name of the company that manufactures the product provided as part of the resolution. |
Optional | Resolution Product Model Or Version | String | 2010 | The product model or version of the product provided as part of the resolution. |
Optional | Resolution Product Manufacturer | String | Microsoft | The manufacturer of the product provided as part of the resolution. |
Optional | Operational Category Tier1 | String | Add | 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) . |
Optional | Operational Category Tier2 | String | User | |
Optional | Operational Category Tier3 | String | Account | |
Optional | Resolution Operational Category Tier1 | String | Add | 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 . |
Optional | Resolution Operational Category Tier2 | String | User | |
Optional | Resolution Operational Category Tier3 | String | Account | |
Optional | Resolution Product Category Tier1 | String | Software | 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 . |
Optional | Resolution Product Category Tier2 | String | Application | |
Optional | Resolution Product Category Tier3 | String | Productivity | |
(Version 20.02.02 and later) Optional | Other Fields | String | 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:
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 name | Data type | Examples | Description |
---|---|---|---|
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 name | Data type | Examples | Description |
---|---|---|---|
Output | Object | 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 name | Data type | Example | Description |
---|---|---|---|---|
Required | Connection Id | String | Connection > Remedy | Default Connection ID for this connector. |
Required | Incident Number | String | "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 name | Data type | Example | Description |
---|---|---|---|---|
Required | Connection Id | String | Connection > Remedy | Default Connection ID for this connector. |
At least one of the parameters is required | Incident Number | String | "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. | |
Instance ID | String | "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:
Required | Parameter name | Data type | Example | Description |
---|---|---|---|---|
Required | Connection Id | String | Connection > Remedy | Default Connection ID for this connector. |
Required | Login | Process context > Requested For Login Name | Login ID of the user who requires the change. | |
Required | Company | Calbro Services | Company must exist in the Remedy system. | |
Optional | Status | Process input > Selection variable
| 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 | Priority | String | Process input > Selection variable
| 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 variable | Notes field to be sent to the change handler. | |
Required | Summary | Process input > Text variable | Summary to be sent to the change handler. | |
Optional | Location Company | String | 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 . | |
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 entry | When attachments are submitted, the default value is Attachment for a change request entry. | |
Optional | Work info type | Process input > Selection variable Requirements
Analysis
Build
Execution
Closure
Audit
General
| A known value from the list must be specified. | |
Optional | Correlation Id | String | General > Process Correlation ID | System-generated key that identifies the service request to the integration component. For more information, see Waiting for a response. |
Optional | Product Name | String | Microsoft 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) . |
Optional | Product Model Or Version | String | 2007 | 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 . |
Optional | Product Manufacturer | String | Microsoft | 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)
. |
Optional | Product Category Tier1 | String | Software | 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 . |
Optional | Product Category Tier2 | String | Application | |
Optional | Product Category Tier3 | String | Productivity | |
Optional | Operational Category Tier1 | String | Add | 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)
. |
Optional | Operational Category Tier2 | String | User | |
Optional | Operational Category Tier3 | String | Account | |
Optional | Class | String | Normal | Used to specify the impact of the change request. For more information, see Configuring classification settings for change templates . |
Optional | Timing Reason | String | Customer need | Used to specify the reason for the timing of the change request. For more information, see Timing Reasons . |
Optional | Change Reason | String | Upgrade | Used to specify the reason for the change request. For more information, see Configuring classification settings for change templates . |
Optional | Urgency | String | Critical | Used to specify the level of urgency. For more information, see Configuring classification settings for change templates . |
Optional | Risk Level | String | Level 3 | Used to specify the level of risk. For more information, see Configuring classification settings for change templates . |
(Version 20.02.03 and later) Optional | Other fields | String | 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:
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 name | Data type | Examples | Description |
---|---|---|---|
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 name | Data type | Examples | Description |
---|---|---|---|
Output | Object | 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 name | Data type | Example | Description |
---|---|---|---|---|
Required | Connection Id | String | Connection > Remedy | Default Connection ID for this connector. |
Required | Request Id | String | 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. |
Get Change Request by Identifiers input parameters
Required | Parameter name | Data type | Example | Description |
---|---|---|---|---|
Required | Connection Id | String | Connection > Remedy | Default Connection ID for this connector. |
At least one of the parameters is required | Request Id | String | "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 ID | String | "AGGAA5V0GFHPPAOUAFP5OTEBUST9UE" | A field for storing a GUID. The Remedy field ID for Instance ID is 179. |
Create Entry input parameters
Required | Parameter name | Data type | Example | Description |
---|---|---|---|---|
Required | Connection Id | String | Connection > Remedy | Default Connection ID for this connector. |
Required | Form Name | String | "WOI:WorkOrderInterface" | Form name to use for creating a record. |
Required | Field Values | Input 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. |
Optional | Correlation Id | String | General > Process Correlation ID | System-generated key that identifies the service request to the integration component. For more information, see Waiting for a response. |
Get Entry input parameters
Required | Parameter name | Data type | Example | Description |
---|---|---|---|---|
Required | Connection Id | String | Connection > Remedy | Default Connection ID for this connector. |
Required | Form Name | String | "WOI:WorkOrderInterface" | Remedy form with data to retrieve. |
Required | Request Id | String | "0001234" | ID of record with data to retrieve. |
Get Entry by Query input parameters
Required | Parameter name | Data type | Example | Description |
---|---|---|---|---|
Required | Connection Id | String | Connection > Connection ID | Default Connection ID for this connector. |
Required | Form Name | String | "SRD:ServiceRequestDefinition" | Remedy form with data to retrieve. |
Required | Query | String | "'SRD_Title'LIKE ""%SRD%""" | Search query. This action type uses BMC Remedy query syntax. For more information about this query syntax, see Operators, wildcards, keywords, and NULL values . |
Optional | Retrieve option | String | Process input > Selection variable:
| One of the following options:
Tip: Uppercase and lowercase characters are accepted. |
Optional | Field IDs to retrieve | String | 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
Required | Parameter name | Data type | Example | Description |
---|---|---|---|---|
Required | Connection Id | String | Connection > Connection ID | Default Connection ID for this connector. |
Required | Form Name | String | "SRD:ServiceRequestDefinition" | Remedy form with data to retrieve. |
Optional | Query | String | "'SRD_Title'LIKE ""%SRD%""" | Search query. This action type uses BMC Remedy query syntax. For more information about this query syntax, see Operators, wildcards, keywords, and NULL values . |
Optional | Limit | Integer | "100" | Maximum number of fields to retrieve. If not specified, 100 is the default value. |
Optional | Field IDs to retrieve | String | 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
Required | Parameter name | Data type | Example | Description |
---|---|---|---|---|
Required | Connection Id | String | Connection > Connection ID | Default Connection ID for this connector. |
Required | Form Name | String | "WOI:WorkOrderInterface" | Remedy form to update. |
Required | Request Id | String | "0001234" | ID of record to update. |
Required | Field Values | Input Set | Build Input Set > Output > Inputs | Object that contains custom field labels and values to populate fields required by the form. |
Delete Entry input parameters
Required | Parameter name | Data type | Example | Description |
---|---|---|---|---|
Required | Connection Id | String | Connection > Connection ID | Default Connection ID for this connector. |
Required | Form Name | String | "WOI:WorkOrderInterface" | Remedy form to delete. |
Required | Request Id | String | "0001234" | ID of record to update. |
Comments
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.
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
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?
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
Please give an example of syntax for this part in above document:
"Note: The Field IDs to retrieve field accepts integer values without quotes."
Jan Zacharjasiewicz, in the example, integer values are given without quotes → ""value"":1000000019.
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
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!
Thanks for your comment Marek Ceizel. We will validate this on our end and get back to you with an update.
Thanks,
Ravee
thank you for the quick response Ravee.
Thanks for your patience, Marek. We are updating this topic to remove "{""keyname1"":1000000019,""key2"":1000000018}".
Thanks, Ravee
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
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
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
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
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
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)
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
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
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.
Hello Marek Ceizel ,
Let me test this on our end and share some examples with you as well as update the docs.
Thanks,
Aaditi
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
Log in or register to comment.