Change Management module search workflows

This section describes the following workflows, contained in the Searches folder, which provide prebuilt search workflows that can help you manage change.

Get Change Associations by Change ID workflow

This workflow finds change associations for a specified change ID.

Note:

This workflow is not applicable for BMC Remedyforce.

Get Change Associations by Change ID workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid values: BMC_AR_System, HP_ServiceCenter

Yes

change id

Specifies the unique identifier for the change

Yes

Get Change Associations by Change ID workflow outputs

Output

Description

changes

Displays an XML document that contains the information of the change record in a change management system; uses the change concept structure

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Get Change Associations workflow

This workflow finds change associations for a given set of variables. BMC Remedy ITSM supports simple queries in the form of a key 1/value 1 pair. For complex queries, a set of key 1/value 1 pair elements can be supplied as an XML document with a root element of <value> as shown in the following syntax:

<value> ' key 1 '= " value 1 "</value> or <value>' key 1 ' > " value 1 " and ' key 2 '' < " value 2 "</value>

Note

  • Key values are enclosed in single quotation marks ' '.
  • String values are enclosed in double quotation marks " ".
  • Numeric values are not enclosed.

Note:

This workflow is not applicable for BMC Remedyforce.


Get Change Associations workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid values: BMC_AR_System, HP_ServiceCenter

Yes

key 1

Contains the name or the ID of the field against which you want to search

Yes

value 1

Contains the value for which you are searching in the key 1 field

Yes

key 2

Contains a name or an ID of a field against which you want to search

No

value 2

Contains the value for which you are searching in the key 2 field

No

query

Contains a query based on the key and value fields

No


Get Change Associations workflow outputs

Output

Description

changes

Displays an XML document that contains the information of the change record in a change management system; uses the change concept structure

success status

Indicates whether the workflow finished successfully
Valid values: success, failure

status message

Provides a workflow-specific explanation for the value of success status

Back to top

Get Change by Change ID workflow

This workflow finds a change record for a specific change ID.


Get Change by Change ID workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid values: BMC_AR_System, HP_ServiceCenter, BMC_Remedyforce

Yes

change id

Specifies the unique identifier for the change

Yes


Get Change by Change ID workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully

status message

Provides a process-specific explanation for the value of the success status

changes

Displays an XML document containing the details on the changes returned by the request; contains available values from the change management system for the elements of the change concept

Back to top

Get Change by Description workflow

This workflow finds a change record with a specific description.

Note:

This workflow is not applicable for BMC Remedyforce.


Get Change by Description workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid values: BMC_AR_System, HP_ServiceCenter

Yes

description

Change description on which changes records can be searched.

Yes


Get Change by Description workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully

status message

Provides a process-specific explanation for the value of the success status

changes

Displays an XML document containing the details on the changes returned by the request; contains available values from the change management system for the elements of the change concept

Back to top

Get Change by Incident ID workflow

This workflow uses the Get Change Associations workflow to find related changes for a specified incident ID.

Note:

This workflow is not applicable for HP Service Center.


Get Change by Incident ID workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration

Valid value: BMC_AR_System, BMC_Remedyforce

Yes

incident id

Specifies the unique identifier for the incident

Example for BMC_AR_System: INC000000000001

Example for BMC_Remedyforce: 00000055

Yes


Get Change by Incident ID workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully

status message

Provides a process-specific explanation for the value of the success status

changes

Displays an XML document that contains the information of found change records in a change management system; uses the change concept structure

Back to top

Get Change by Instance ID workflow

This workflow finds change records for a specific instance ID.

Note:

This workflow is not applicable for HP Service Center and BMC Remedyforce.

Get Change by Instance ID workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid values: BMC_AR_System

Yes

instance id

Specifies the instance ID

Example: AG005056814303L9poSAeWEqXQMksG

Yes

Get Change by Instance ID workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully

status message

Provides a process-specific explanation for the value of the success status

changes

Displays an XML document that contains the information of found change records in a change management system; uses the change concept structure

Back to top

Get Changes by Assignee workflow

This workflow finds change records assigned to a specific person.

Note:

This workflow is not applicable for BMC Remedyforce.


Get Changes by Assignee workflow inputs

Input

Description

Required

assignee

Identifies the person to whom the changes are assigned
BMC_AR_System - sample value: orchestrationuser
HP_ServiceCenter - sample value: testuser

Yes

configuration name

Specifies a configuration group defined in the module configuration Valid values: BMC_AR_System, HP_ServiceCenter

Yes


Get Changes by Assignee workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully

status message

Provides a process-specific explanation for the value of the success status

changes

Displays an XML document that contains the information of found change records in a change management system; uses the change concept structure

Back to top

Get Changes by Customer Name workflow

This workflow finds change records for a specified customer name.

Note:

This workflow is not applicable for BMC Remedyforce.


Get Changes by Customer Name workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid values: BMC_AR_System, HP_ServiceCenter

Yes

customer name

Specifies the name of the customer whose change records are to be retrieved

Yes


Get Changes by Customer Name workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully

status message

Provides a process-specific explanation for the value of the success status

changes

Displays an XML document that contains the information of found change records in a change management system; uses the change concept structure

Back to top

Get Changes by Requester workflow

This workflow finds change records created by a specific user.


Get Changes by Requester workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid values: BMC_AR_System, HP_ServiceCenter, BMC_Remedyforce

Yes

first name

Specifies the first name of the requester

Conditional; required only if you use BMC_AR_System

last name

Specifies the last name of the requester

Conditional; required only if you use BMC_AR_System

requester

Specifies the name of the requester

Example for HP Service Center: Allen

Example for BMC Remedyforce: allen_brooke@bmcremedyforce.com

Conditional; required if you use HP Service Center and BMC Remedyforce


Get Changes by Requester workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully

status message

Provides a process-specific explanation for the value of the success status

changes

Displays an XML document that contains the information of found change records in a change management system; uses the change concept structure

Back to top

Get Changes by Status workflow

This workflow finds change records with a specified status.


Get Changes by Status workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration

Valid values: BMC_AR_System, HP_ServiceCenter, BMC_Remedyforce

Yes

status

Specifies the status of the change records to be retrieved
Valid values for BMC Remedy ITSM Change Management:

  • 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

    Valid values for HP ServiceCenter:
  • Initial
  • Pending
  • Closed
  • Waiting
  • Reopened

    Valid values for BMC Remedyforce:
  • Approved
  • Completed
  • Closed
  • In Progress
  • Opened
  • Pending Approval
  • Risk and Impact
  • Registered
  • Rejected

Yes


Get Changes by Status workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully

status message

Provides a process-specific explanation for the value of the success status

changes

Displays an XML document that contains the information of found change records in a change management system; uses the change concept structure

Back to top

Get Changes in Date Range workflow

This workflow finds change records for the specified date range, including the start and end dates.

Note

This workflow is not applicable for HP Service Center and BMC Remedyforce.


Get Changes in Date Range workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration
Valid value: BMC_AR_System

Yes

query field name 1

Specifies the name of the date field to search (the low end of the inclusive range)
Valid values:

  • planned-start-date
  • planned-finish-date
  • actual-start-date
  • actual-finish-date

Yes

field name date 1

Specifies the first date for the search; the date must be in epoch time

Yes

query field name 2

Specifies the name of the date field to search (the high end of the inclusive range)
Valid values:

  • planned-start-date
  • planned-finish-date
  • actual-start-date
  • actual-finish-date

Yes

field name date 2

Specifies the last date for the search; the date must be in epoch time

Yes


Get Changes in Date Range workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully

status message

Provides a process-specific explanation for the value of the success status

changes

Displays an XML document that contains the information of found change records in a change management system; uses the change concept structure

Back to top

Get Changes workflow

This workflow finds change records matching a specified set of variables. BMC Remedy ITSM supports a simple or complex query; HP ServiceCenter supports a simple or Advanced Find query.

Note

Samples of each type of query are discussed in Simple query sample through Advanced Find sample.


Get Changes workflow inputs

Input

Description

Required

configuration name

Specifies a configuration group defined in the module configuration

Valid values: BMC_AR_System, HP_ServiceCenter, BMC_Remedyforce

Yes

key 1

Contains the name or the ID of the field to search

No

value 1

Specifies the value of the key 1 field for which to search

No

key 2

Specifies a name or ID for another field to search; used for complex queries requiring comparisons between multiple keys and values

HP Service Center does not support multiple key-value pairs.

No

value 2

Specifies the value of the key 2 field; used for complex queries requiring comparisons between multiple keys and values

HP Service Center does not support multiple key-value pairs.

No

query

Contains the query as a string or as an XML document with a root element of <value>, depending on the change management system
Note: This parameter is not applicable for HP Service Center and BMC Remedyforce.

BMC Remedy ITSM Change Management sample formats: <value> 'key 1'= 'value 1'</value> or <value>'key 1' > "value 1" and 'key 2' < "value2"</value>

Note

Key values are enclosed in single quotes ' ', and string values are enclosed in double quotes " ". Numeric values do not need to be enclosed.

No

Get Changes workflow outputs

Output

Description

success status

Indicates whether the workflow finished successfully

status message

Provides a process-specific explanation for the value of the success status

changes

Displays an XML document that contains the information of found change records in a change management system; uses the change concept structure

Back to top

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments