Change Management module utility workflows

The Utilities folder contains workflows grouped by similar function, such as applying mappings, extracting information, or translating values. This section describes the following Change Management utility workflows:

Append Log to Journal workflow

This workflow updates the log (notes) for an existing change record.

Note

This workflow does not support BMC Remedy ITSM.

Append Log to Journal workflow inputs

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid value: HP_ServiceCenter	Yes
change id	Specifies the unique identifier for the change	Yes
log	Contains a free text field	Yes
summary	Contains a free text field	Yes

Append Log to Journal workflow outputs

Output	Description
success status	Indicates whether the workflow finished successfully Valid values: success, failure
status message	Provides a process-specific explanation for the value of the success status
changes	Displays an XML document that contains the information of updated logs in change records in a change management system; uses the change concept structure

Back to top

Apply Mappings workflow

This workflow translates the input key/value pairs from concept element names to the system-defined fields.

Apply Mappings workflow inputs

Input	Description	Required
key	Contains any concept element that has a query mapping	Yes
mappings	Contains one of the mappings defined in the module configuration for translating between concept elements and system fields	Yes

Apply Mappings workflow output

Output	Description
translated key	Provides the input concept key translated into a system-defined field

Back to top

Build Date Query workflow

This workflow retrieves changes created within a specified date range.

Note

This workflow does not support HP ServiceCenter.

Build Date Query 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	Contains the name or the ID of the field against which you want to search; specifically, the planned or actual start date of changes for which you want to search Valid values: planned start date actual start date	Yes
field name date 1	Specifies the date and time (requires epoch format)	Yes
query field name 2	Contains the name or the ID of the field against which you want to search; specifically, the planned or actual finish date of changes for which you want to search Valid values: planned finish date actual finish date	Yes
field name date 2	Specifies the date and time (requires epoch format)	Yes

Build Date Query workflow outputs

Output	Description
success status	Indicates whether the workflow finished successfully Valid values: success, failure
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

Create Change Record workflow

This workflow creates a change record in a change management system.

Create Change Record workflow inputs

Input	Description	Required
change platform	Contains the name of a configuration entry defined in a configuration module	Yes
change description	Contains a description of the change	Yes
detailed description	Contains a detailed description of the change	No
scheduled start date	Specifies the scheduled start date of the change	No
requested by user name	Specifies the user name of the person who requested the change	No
requested for user name	Specifies the user name for whom the change is being requested	No
template name	Specifies the change template	No
ci name	Specifies the configuration item name	No

Create Change Record workflow outputs

Output	Description
changes	Displays an XML document that contains the information of found change records 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 process-specific explanation for the value of the success status

Back to top

Extract Change Association ID workflow

This workflow extracts the change association ID. Because the key 1/value 1 inputs are passed during run time by the calling workflow, they can vary depending on the form on which the search takes place.

Extract Change Association ID workflow inputs

Input	Description	Required
schema	An XML document that contains the schema names used by the Change Management module	Yes
key 1	Contains the name or the ID of the field against which you want to search	Yes
value 1	Contains the value you are searching for in the key 1 field	Yes
create mappings	Contains an XML document that maps the normalized concept values to the target application-specific values	Yes
adapter	Specifies the name of the adapter to be used by this workflow	Yes
version	Specifies the version of the adapter in use	Yes

Extract Change Association ID workflow output

Output	Description
change id	Provides a unique identifier for the change

Back to top

Extract Change ID workflow

This workflow extracts the change ID.

Extract Change ID workflow inputs

Input	Description	Required
schema	Contains an XML document that contains the schema names used by the Change Management module	Yes
key 1	Contains the name or the ID of the field against which you want to search	Yes
value 1	Contains the value you are searching for in the key 1 field	Yes
create mappings	Contains an XML document that maps the normalized concept values to the target application-specific values	Yes
adapter	Specifies the name of the adapter to be used by this workflow	Yes
version	Specifies the version of the adapter in use	Yes

Extract Change ID workflow output

Output	Description
change id	Provides a unique identifier for the change

Back to top

Extract Change Template ID workflow

This workflow extracts the change template ID.

Note

This workflow does not support HP ServiceCenter.

Extract Change Template ID workflow inputs

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid value: BMC_AR_System	Yes
key 1	Contains the name or the ID of the field against which you want to search; for example, change-template-name	Yes
value 1	Contains the value you are searching for in the key 1 field; for example, Install Software Application	Yes

Extract Change Template ID workflow outputs

Output	Description
change template name	Provides the name of the change template; for example, Install Software Application
change instance id	Provides the change instance ID; for example, ID0050560C63F2Bh60RAChjgAArV8A
change template id	Provides the change template ID; for example, CTP000000000004

Back to top

Change Management module Extract Configuration Data workflow

This workflow extracts all configuration data by module configuration name.

Change Management module Extract Configuration Data workflow input

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid values: BMC_AR_System, HP_ServiceCenter	Yes

Change Management module Extract Configuration Data workflow outputs

Output	Description
adapter	Provides the name of the adapter to be used by this workflow
schema	Provides the name of the schema with which to interact
system type	Provides the type of system defined within the module configuration
concept template	Contains an XML document used to format an adapter response that has been mapped from the application field names to the concept elements
version	Provides the version of the adapter in use
query mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
status mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
urgency mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
impact mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
collection	Contains an XML document that contains collection data
priority mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
change timing mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
type mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
risk level mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
create mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
update mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
field mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
service level mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
report mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
change template mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
field id mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
status reason mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
timing reason mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
create association mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
request type mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
incident management platform	Provides the configuration name to be supplied to the Incident Management Module
query association mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
workinfo type mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
workinfo securelog mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
workinfo viewaccess mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
change key	Provides the change id used as a key value for incident and change associations
incident key	Provides the incident id used as a key value for incident and change associations
category mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
approval status mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
current phase mappings	Contains an XML document that maps the normalized concept values to the target application-specific values
default change status	Provides the default change status
default change type	Provides the default change type
default change impact	Provides the default change impact
default change risk level	Provides the default change risk level
default change timing	Provides the default change timing
default change urgency	Provides the default change urgency
default authentication schema	Provides the default authentication schema
default authentication query mappings	Provides the default authentication query mappings
default authentication user name	Provides the default authentication user name
success status	Indicates whether the workflow finished successfully Valid values: success, failure
success message	Provides a process-specific explanation for the value of the success status

Back to top

Extract Login ID Details workflow

Extracts details from a logon ID

Extract Login ID Details workflow inputs

Input	Description	Required
login id	Specifies the user login ID	Yes
authentication adapter	Specifies the adapter used for authenticating the user	No
authentication platform	Specifies a configuration group defined in the module configuration Valid values: BMC_AR_System, HP_ServiceCenter	No
authentication query mappings	Specifies the authentication query mappings	No
authentication schema	Specifies the schema used for authentication	No
authentication version	Specifies the authentication version	No

Extract Login ID Details workflow outputs

Output	Description
login id	Provides the user ID
first name	Provides the first name of the user
last name	Provides the last name of the user
company	Provides the company name
person id	Provides the person ID of the user
success status	Indicates whether the workflow finished successfully Valid values: success, failure
status message	Provides a process-specific explanation for the value of the success status

Back to top

Query User Information

This workflow retrieves information about a user.

Query User Information workflow inputs

Input	Description	Required
user name	Specifies the user name	Yes
authentication adapter	Specifies the adapter used for authenticating the user	Yes
authentication platform	Specifies a configuration group defined in the module configuration Valid values: BMC_AR_System, HP_ServiceCenter	Yes
authentication query mappings	Specifies the authentication query mappings	Yes
authentication schema	Specifies the schema used for authentication	Yes
authentication version	Specifies the authentication version	Yes

Query User Information workflow outputs

Output	Description
login id	Provides the user ID
first name	Provides the first name of the user
last name	Provides the last name of the user
company	Provides the company name
company location	Provides the company location
success status	Indicates whether the workflow finished successfully Valid values: success, failure
status message	Provides a process-specific explanation for the value of the success status

Back to top

Set Change Version Flag workflow

This workflow creates the change flag global variable and sets its initial value to 0. This workflow has no inputs.

Set Change Version Flag workflow output

Output	Description
change flag	Creates the `change flag` global variable and sets its initial value to the string value 0

Back to top

Change Management module Translate Enumerated Values to Field Values workflow

This workflow translates entered enumerated values into field values by using the module configuration mappings.

Change Management module Translate Enumerated Values to Field Values workflow inputs

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid values: BMC_AR_System, HP_ServiceCenter	Yes
changes	Displays an XML document that contains the information of a change record in a change management system; uses the change concept structure	Yes

Change Management module Translate Enumerated Values to Field Values workflow outputs

Output	Description
change collection	Displays an XML document that contains the information of a change record in a change management system; uses the change concept structure
failed change collection	Displays an XML document containing failed changes
success counter	Provides the number of successful changes
failure counter	Provides the number of failed changes
success status	Indicates whether the workflow finished successfully Valid values: success, failure
status message	Provides a process-specific explanation for the value of the success status

Back to top

Change Management module Translate Field Values to Enumerated Values workflow

This workflow translates entered field values into enumerated values by using the module configuration mappings.

Change Management module Translate Field Values to Enumerated Values workflow inputs

Input	Description	Required
changes	Contains an XML document that provides the field information to be translated into database record values; uses the change concept structure	Yes
configuration name	Specifies a configuration group defined in the module configuration Valid values: BMC_AR_System, HP_ServiceCenter	Yes

Change Management module Translate Field Values to Enumerated Values workflow outputs

Output	Description
change collection	Displays an XML document that contains the information of a change record in a change management system; uses the change concept structure
failed change collection	Displays an XML document containing failed changes
success counter	Provides the number of successful changes
failure counter	Provides the number of failed changes
success status	Indicates whether the workflow finished successfully
status message	Provides a process-specific explanation for the value of the success status

Back to top

Translate Field Values to Enumerated Values for Single Change workflow

This workflow translates input field values to enumerated values for a single change using the module configuration mappings.

Translate Field Values to Enumerated Values for Single Change workflow inputs

Input	Description	Required
configuration name	Specifies a configuration item defined in a configuration module Example: BMC_ARS_System, HP_ServiceCenter	Yes
change	Contains an XML document that provides the data template for concept elements	Yes
extracted mappings flag	Indicates whether extract configuration is executed; this flag is set at run time during create or update change workflow	No

Translate Field Values to Enumerated Values for Single Change workflow outputs

Input	Description
mapped change	Provides an XML document that contains the data template for a single change concept element
failed change	Contains an XML document providing details of failed changes
success status	Indicates whether the workflow finished successfully Valid values: success, failure
status message	A process-specific string that explains the value of success status

Back to top

Change Management module Translate Key Value to Enumerated Value workflow

This workflow translates entered key values into enumerated values by using the module configuration mappings.

Change Management module Translate Key Value to Enumerated Value 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	Specifies the name of the field	Yes
value	Specifies the value of the field	Yes

Change Management module Translate Key Value to Enumerated Value workflow outputs

Output	Description
key	Provides the name of the field
value	Provides the translated value of the field

Back to top

Change Management module Translate Key Value to Field Value workflow

Translates key values to mapped field values

Change Management module Translate Key Value to Field Value workflow inputs

Input	Description	Required
mappings	Specifies the concept mappings	No
key 1	Specifies the name or ID of the field	No
key 2	Specifies the value of the key 1 field	No

Change Management module Translate Key Value to Field Value workflow outputs

Output	Description
key 1	Provides the name or ID of the field
key 2	Provides the value of the key 1 field

Back to top

Change Management module Truncate Input workflow

This workflow automatically truncates user input when the entered data exceeds the maximum field length (100 characters).

Change Management module Truncate Input workflow input

Input	Description	Required
input	Contains a character string	No

Change Management module Truncate Input workflow output

Output	Description
output	Provides a truncated character string

Back to top

Change Management module utility workflows

Append Log to Journal workflow

Apply Mappings workflow

Build Date Query workflow

Create Change Record workflow

Extract Change Association ID workflow

Extract Change ID workflow

Extract Change Template ID workflow

Change Management module Extract Configuration Data workflow

Extract Login ID Details workflow

Query User Information

Set Change Version Flag workflow

Change Management module Translate Enumerated Values to Field Values workflow

Change Management module Translate Field Values to Enumerated Values workflow

Translate Field Values to Enumerated Values for Single Change workflow

Change Management module Translate Key Value to Enumerated Value workflow

Change Management module Translate Key Value to Field Value workflow

Change Management module Truncate Input workflow

Comments