Configuration 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 workflows:

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
concept key	Specifies 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

Assign Instance ID to CI workflow

This workflow extracts the ID returned by an adapter in the <instance-id/> element and inserts it into the <id/> element of a concept.

Assign Instance ID to CI workflow inputs

Input	Description	Required
configuration item	Contains an XML concept document	Yes
adapter response	Contains the response returned after generating the entry ID	Yes

Assign Instance ID to CI workflow outputs

Output	Description
instance id	Contains the instance ID of the configuration item
exit code	Provides the return code that indicates whether the ID was successfully extracted Valid values: true, false
configuration item	Contains the XML concept with the `<id/>` populated if the exit code is true

Back to top

Create VM Configuration Items workflow

This workflow creates virtual machine configuration items.

Create VM Configuration Items workflow inputs

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid value: BMC_Atrium	Yes
configuration item name	Specifies the name of a configuration item	Yes
dataset id	Specifies the dataset ID of the configuration item Example: BMC.ASSET	Yes
submitter	Specifies the name of the person who submitted the VM configuration item creation request	No
description	Describes the configuration item	No

Create VM Configuration Items workflow outputs

Output	Description
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
computer system instance id	Provides the instance ID of the computer system created
virtual system instance id	Provides the instance ID of the virtual system created

Back to top

Create a Configuration Item workflow

This workflow creates a configuration item.

Create a Configuration Item workflow inputs

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid value: BMC_Atrium	Yes
configuration item name	Specifies the name of a configuration item	Yes
configuration item type	Specifies the type of configuration item Valid value: BMC_ComputerSystem	Yes

Create a Configuration Item workflow outputs

Output	Description
configuration items	Contains an XML document providing the details of the configuration items returned by the request; contains available values from the configuration management system for the elements of the configuration-item concept
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

Decommission a VM workflow

This workflow decommissions a virtual machine.

Decommission a VM workflow inputs

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid value: BMC_Atrium	Yes
configuration item name	Specifies the name of a configuration item	Yes
decommission date	Specifies the epoch time for the date on which the virtual machine is to be decommissioned	Yes
dataset id	Specifies the dataset ID of the configuration item Example: BMC.ASSET	Yes

Decommission a VM workflow outputs

Output	Description
configuration items	Contains an XML document providing the details of the configuration items returned by the request; contains available values from the configuration management system for the elements of the configuration-item concept
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

Delete by Class workflow

This workflow formats fields and values into a specific document structure (delete-operation) identified by the class name input.

Note

This workflow is used only by HP ServiceCenter.

Delete by Class workflow inputs

Input

Description

Required

configuration item name

Specifies the name of a configuration item

Yes

class name

Specifies the configuration item's class name
Valid values:

HPSC_ComputerSystem
HPSC_Contact
HPSC_NetworkDevice

Yes

Delete by Class workflow output

Output	Description
configuration items	Contains an XML document providing details for one or more fields and values

Back to top

Extend a VM Expiry Date workflow

This workflow extends the date on which a virtual machine is scheduled to expire.

Extend a VM Expiry Date workflow inputs

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid values: BMC_AR_System, BMC_Atrium, HP_ServiceCenter	Yes
configuration item name	Specifies the name of a configuration item	Yes
class name	Specifies the configuration item's class name Valid values for BMC_Atrium and BMC_AR_System: BMC_Account BMC_Activity BMC_AdminDomain BMC_ApplicationService BMC_ApplicationSystem BMC_BusinessService Valid values for HP_ServiceCenter: HPSC_ComputerSystem HPSC_NetworkDevice	Yes
vm expiry date	Specifies the epoch time for the date to which the VM expiry date should be extended	Yes
dataset id	Specifies the dataset ID of the configuration item Example: BMC.ASSET	Yes

Extend a VM Expiry Date workflow output

Output	Description
configuration items	Contains an XML document providing details for one or more fields and values

Back to top

Extract Configuration Class Mappings workflow

This workflow extracts mappings by class name.

Extract Configuration Class Mappings workflow inputs

Input

Description

Required

configuration name

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

Yes

configuration item

Specifies the class of a configuration mapping that is defined in a configuration module

Example of valid values:

ComputerSystem_Mappings
Person_Mappings

Yes

Extract Configuration Class Mappings workflow output

Output	Description
class mappings	Extracts mapping of the specified class

Back to top

Configuration Management module Extract Configuration Data workflow

This workflow extracts all configuration data by configuration name for this module.

Configuration 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, BMC_Atrium, HP_ServiceCenter	Yes

Configuration Management module Extract Configuration Data workflow output

Output	Description
configuration items	Contains an XML document providing detail for one or more fields and values

Back to top

Extract Configuration Item Number workflow

This workflow finds a configuration item ID by its request ID.

Extract Configuration Item Number workflow inputs

Input	Description	Required
key 1	Specifies the name or the ID of the field against which you want to search	Yes
value 1	Specifies the value you are searching for in the key 1 field	Yes
schema	Specifies the schema name Example: BMC.CORE:BMC_BaseElement	Yes
create mappings	Displays an XML file containing mappings	Yes

Extract Configuration Item Number workflow output

Output	Description
ci name	Provides the configuration item number

Back to top

Extract Entry ID workflow

This workflow extracts the ID returned by an adapter in the <entry-id/> element and inserts it into the <id/> element of a concept.

Extract Entry ID workflow inputs

Input	Description	Required
adapter response	Contains an XML document returned by the request executed on the configuration management system	Yes
configuration item	Contains an XML document that contains the configuration item information; uses the configuration-item concept structure	Yes

Extract Entry ID workflow outputs

Output	Description
entry id	Provides the ID generated by the request
exit code	Indicates whether the ID was successfully extracted Value values: true, false
configuration item	Contains an XML document that provides the configuration item information; uses the configuration-item concept structure

Back to top

Extract Instance ID by Creation Date

This workflow finds a configuration item by its creation date.

Extract Instance ID by Creation Date workflow inputs

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid values: BMC_AR_System, BMC_Atrium, HP_ServiceCenter	Yes
class name	Specifies the configuration item's class name Example: BMC_ComputerSystem	Yes
ci name	Specifies the configuration item's name	Yes
query item	Contains an XML document that is required by BMC Remedy CMDB and might include parameters that are used to refine and control queries Sample XML with default values `<query-item> <soap> <username /> <password /> </soap> <login-info> <user-id>Demo</user-id> <password>Demo</password> <lang>English</lang> </login-info> <class-name-id> <namespace-name>BMC.CORE</namespace-name> <class-name>BMC_ComputerSystem</class-name> <dataset-id>BMC.ASSET</dataset-id> <get-mask>GET_MASK_NONE</get-mask> </class-name-id> <first-retrieve>0</first-retrieve> <max-retrieve>0</max-retrieve> <sort-by>SerialNumber</sort-by> <sort-order>ASCENDING</sort-order> </query-item>`	No

Extract Instance ID by Creation Date workflow outputs

Output	Description
instance id	Contains an XML document providing detail for one or more configuration items
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

Extract Instance ID workflow

This workflow finds an instance ID of a specific configuration item.

Extract Instance ID workflow inputs

Input	Description	Required
key 1	Specifies the name or the ID of the field that you want to search against	Yes
value 1	Specifies the value that you are searching for in the key 1 field	Yes
schema	Specifies the schema name Example: BMC.CORE:BMC_BaseElement	Yes
create mappings	Specifies the XML file containing mappings	Yes

Extract Instance ID workflow output

Output	Description
instance id	Provides the configuration item number

Back to top

Extract Job ID workflow

This workflow extracts the ID returned by the adapter and inserts it into the <id/> element of a concept.

Extract Job ID workflow inputs

Input	Description	Required
adapter response	Specifies the response returned after generating the entry ID	No
configuration item	Contains an XML document that contains the configuration item information; uses the configuration-item concept structure	No

Extract Job ID workflow outputs

Output	Description
entry id	Provides the ID generated by the request
exit code	Indicates whether the ID was successfully extracted. Valid values: true, false
configuration item	Contains an XML document that contains the configuration item information; uses the configuration-item concept structure

Back to top

Extract Login ID Details workflow

This workflow extracts details of a login ID.

Extract Login ID Details workflow inputs

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid values: BMC_AR_System, BMC_Atrium, HP_ServiceCenter	Yes
login id	Specifies the user ID	Yes

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
instance id	Provides the instance ID of the user
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

Extract Lookup Keyword workflow

This workflow finds configuration items by lookup keyword.

Extract Lookup Keyword workflow inputs

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

Extract Lookup Keyword workflow outputs

Output	Description
lookup keyword	Provides the lookup keyword Example: BMC_COMPUTERSYSTEM
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

Extract Request ID workflow

This workflow extracts the request ID returned by the adapter in the <entry-id/> element and inserts it into the <id/> element of a concept.

Extract Request ID workflow inputs

Input	Description	Required
adapter response	Contains an XML document returned by the requested executed on the configuration management system after generating the entry ID	No
configuration item	Contains an XML document that provides the configuration item information; uses the configuration-item concept structure	No

Extract Request ID workflow outputs

Output	Description
entry id	Provides the ID generated by the request
exit code	Indicates whether the ID was successfully extracted Value values: true, false
configuration item	Contains an XML document that provides the configuration item information; uses the configuration-item concept structure

Back to top

Format Create Items by Class workflow

This workflow formats the fields and values into a given document structure (create-operation) identified by class name.

Note

This workflow is used only by HP ServiceCenter.

Format Create Items by Class workflow inputs

Input

Description

Required

class name

Specifies the configuration item's class name

Valid values for HP_ServiceCenter:

HPSC_ComputerSystem
HPSC_Contact
HPSC_NetworkDevice

Yes

fields

Contains an XML document providing detail for one or more fields

Yes

Format Create Items by Class workflow output

Output	Description
items	Contains an XML document providing detail for one or more fields and values

Back to top

Format Delete Items by Class workflow

This workflow formats the fields and values into a given document structure (delete-operation) identified by class name.

Note

This workflow is used only by HP ServiceCenter.

Format Delete Items by Class workflow inputs

Input

Description

Required

class name

Specifies the configuration item's class name

Valid values for HP_ServiceCenter:

HPSC_ComputerSystem
HPSC_Contact
HPSC_NetworkDevice

Yes

fields

An XML document providing detail for one or more fields

Yes

Format Delete Items by Class workflow output

Output	Description
items	Contains an XML document providing detail for one or more fields and values

Back to top

Format Output by Class workflow

This workflow formats fields and values into a specified output document structure identified by class name.

Note

This workflow is used only by HP ServiceCenter.

Format Output by Class workflow inputs

Input

Description

Required

class name

Specifies the configuration item's class name

Valid values for HP_ServiceCenter:

HPSC_ComputerSystem
HPSC_Contact
HPSC_NetworkDevice

Yes

class mappings

Specifies the class mappings

Yes

adapter response

Contains an XML document returned by the request executed on the configuration management system

Yes

Format Output by Class workflow output

Output	Description
configuration item	Contains an XML document that provides the configuration item information; uses the configuration-item concept structure

Back to top

Format Search Items by Class workflow

This workflow formats fields and values into a specified document structure (find-operation) identified by class name.

Note

This workflow is used only by HP ServiceCenter.

Format Search Items by Class workflow inputs

Input	Description	Required
class name	Specifies the class name	Yes
class mappings	Specifies the class mappings	Yes
fields	Contains an XML document providing detail for one or more fields	Yes
value 1	Specifies the value	Yes
translated key 1	Specifies the first translated key	Yes
translated key 2	Specifies the second translated key	No
query	Provides the query	No

Format Search Items by Class workflow output

Output	Description
items	Contains an XML document providing detail for one or more fields and values

Back to top

Format Update Items by Class workflow

This workflow formats fields and values into a given document structure (update-operation) identified by class name.

Note

This workflow is used only by HP ServiceCenter.

Format Update Items by Class workflow inputs

Input

Description

Required

class name

Specifies the configuration item's class name

Valid values for HP_ServiceCenter:

HPSC_ComputerSystem
HPSC_Contact
HPSC_NetworkDevice

Yes

fields

Contains an XML document providing detail for one or more fields

Yes

Format Update Items by Class workflow output

Output	Description
items	Contains an XML document providing detail for one or more fields and values

Back to top

Mark as Deleted workflow description, inputs, and outputs

This workflow tags the configuration item as a configuration item that can be deleted.

Mark as Deleted workflow inputs

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid values: BMC_AR_System, BMC_Atrium, HP_ServiceCenter	Yes
configuration item name	Specifies the configuration item name
class name	Specifies the configuration item's class name Valid values for BMC_Atrium and BMC_AR_System: BMC_Account BMC_Activity BMC_AdminDomain BMC_ApplicationService BMC_ApplicationSystem BMC_BusinessService Valid values for HP_ServiceCenter: HPSC_ComputerSystem HPSC_NetworkDevice	Yes
dataset id	Dataset ID of the configuration item Example: BMC.ASSET	Yes

Mark as Deleted workflow outputs

Output	Description
configuration items	Contains an XML document providing the details of the configuration item updated by the request This contains available values from the configuration management system for the elements of the configuration-item concept.
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

Query User Information workflow description, inputs, and outputs

This workflow extracts the details of the specified user ID.

Query User Information workflow inputs

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid values: BMC_AR_System, BMC_Atrium	Yes
user name	Specifies the name of the user whose details are to be extracted	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 location of the company
person id	Provides the person ID of the user
instance id	Provides the instance ID of the user
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

Configuration Management module Translate Enumerated Values to Field Values

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

Configuration Management module Translate Enumerated Values to Field Values workflow inputs

Input	Description	Required
configuration items	Contains an XML document providing the details of the configuration item; contains available values from the configuration management system for the elements of the configuration-item concept	Yes
configuration name	Specifies a configuration group defined in the module configuration Valid value: BMC_AR_System	Yes

Configuration Management module Translate Enumerated Values to Field Values workflow outputs

Output	Description
configuration item collection	Contains an XML document providing detail for one or more configuration items
failed configuration item collection	Contains an XML document providing detail for one or more failed configuration items
success counter	Provides a count of successfully created configuration items
failure counter	Provides a count of failed configuration items
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

Configuration Management module Translate Field Values to Enumerated Values

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

Configuration Management module Translate Field Values to Enumerated Values workflow inputs

Input	Description	Required
configuration name	Specifies a configuration group defined in the module configuration Valid value: BMC_AR_System	Yes
configuration items	Contains an XML document that provides the translated configuration item information; uses the configuration-item concept structure	Yes

Configuration Management module Translate Field Values to Enumerated Values workflow outputs

Output	Description
configuration item collection	Contains an XML document providing detail for one or more configuration items
failed configuration item collection	Contains an XML document providing detail for one or more failed configuration items
success counter	Provides a count of successfully created configuration items
failure counter	Provides a count of failed configuration items
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

Configuration Management module Translate Key Value to Enumerated Value

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

Configuration Management module Translate Key Value to Enumerated Value workflow inputs

Input	Description	Required
key	Specifies the name of the field	Yes
value	Specifies the value of the field	Yes

Configuration 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

Update Status by Class workflow

This workflow formats the fields and values into a document structure (update-operation) identified by class name.

Note

Only HP_ServiceCenter uses this workflow.

Update Status by Class workflow inputs

Input

Description

Required

configuration item name

Specifies the name of the configuration item

Yes

class name

Specifies the configuration item's class name

Example of valid values:

HPSC_ComputerSystem
HPSC_NetworkDevice

Yes

new status

Specifies the new status of the configuration item

Yes

Update Status by Class workflow outputs

Output	Description
configuration items	Contains an XML document providing detail for one or more fields and values
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

Update VM Lifecycle Data workflow

This workflow updates the virtual machine lifecycle data.

Update VM Lifecycle Data workflow inputs

Input	Description	Required
configuration name	Specifies the name of a configuration item defined in a configuration module Valid values: BMC_AR_System, BMC_Atrium, HP_ServiceCenter	Yes
configuration item name	Specifies the name of the configuration item	Yes
computer system instance id	Specifies the instance ID of the configuration item for BMC_ComputerSystem class	Yes
virtual system instance id	Specifies the instance of the configuration item for BMC_VirtualSystemSettingData class	Yes
vm expiry date	Specifies the virtual machine expiry date Example value for BMC_Atrium: 1249910998	Yes
vm creation date	Specifies the virtual machine creation or provision date	Yes
vm uuid	Specifies the identifier of the VM on the server management system	Yes
vm system type	Specifies the virtual machine system type Allowed value: VMWare	Yes
dataset id	Specifies the dataset ID of the configuration item Example: BMC.ASSET	Yes
vm owner	Specifies the virtual machine's owner name	No

Update VM Lifecycle Data workflow outputs

Output	Description
configuration items	Contains an XML document providing detail for one or more fields and values
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

Update a Configuration Item workflow

This workflow updates the status of the configuration item.

Note

HP_ServiceCenter - HPSC_Contact class does not support the Update Status function.

Update a Configuration Item workflow inputs

Input	Description	Required
configuration name	Specifies the name of a configuration item defined in a configuration module Valid values: BMC_AR_System, BMC_Atrium, HP_ServiceCenter	Yes
configuration item name	Specifies the name of the configuration item Note This input is required only for HP_ServiceCenter.	No
class name	Specifies the configuration item's class name Examples of valid values for BMC_AR_System and BMC_Atrium: BMC_Account BMC_Activity BMC_AdminDomain Examples of valid values for HP_ServiceCenter: HPSC_ComputerSystem HPSC_NetworkDevice	Yes
new status	Specifies the new status Valid values for BMC_AR_System and BMC_Atrium: Ordered Received Being Assembled Deployed In Repair Down End of Life Transferred Delete In Inventory On Loan Disposed Reserved Return to Vendor Valid values for HP_ServiceCenter: Installed Available Warehouse Transfer RMA Replaced Reserved Retired	Yes
instance id	Specifies the instance ID of the configuration item Note This input is required only for BMC_AR_System.	No

Update a Configuration Item workflow outputs

Output	Description
configuration items	Contains an XML document providing detail for one or more fields and values
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

Configuration Management module utility workflows

Apply Mappings workflow

Assign Instance ID to CI workflow

Create VM Configuration Items workflow

Create a Configuration Item workflow

Decommission a VM workflow

Delete by Class workflow

Extend a VM Expiry Date workflow

Extract Configuration Class Mappings workflow

Configuration Management module Extract Configuration Data workflow

Extract Configuration Item Number workflow

Extract Entry ID workflow

Extract Instance ID by Creation Date

Extract Instance ID workflow

Extract Job ID workflow

Extract Login ID Details workflow

Extract Lookup Keyword workflow

Extract Request ID workflow

Format Create Items by Class workflow

Format Delete Items by Class workflow

Format Output by Class workflow

Format Search Items by Class workflow

Format Update Items by Class workflow

Mark as Deleted workflow description, inputs, and outputs

Query User Information workflow description, inputs, and outputs

Configuration Management module Translate Enumerated Values to Field Values

Configuration Management module Translate Field Values to Enumerated Values

Configuration Management module Translate Key Value to Enumerated Value

Update Status by Class workflow

Update VM Lifecycle Data workflow

Update a Configuration Item workflow

Comments