After a change record is created through the inbound CHG_ChangeServiceInterface web service, a staging interface (CHG_ChangeOutboundInterface) is used to communicate the change record status and updates to an external automation system. This staging interface is an outbound web service. Every time there is an event or update is made to the change record, BMC Remedy Change Management system adds an entry to the staging interface.
To receive the change record updates, you must first access the web service and then poll it to receive updates.
The following topics are provided:
When is the staging interface updated?
The interface is updated when any of the following events occur:
- A change record is created
- The schedule of the change record changes
- The status of the change record changes
- The task status changes to Assigned
- The work log is updated
- After the Request For Change (RFC)is approved, if the use case is Change-Initiated Job
This web service can be accessed by an external automation system to get the change record updates and work log information updates.
Accessing the CHG_ChangeOutboundInterface web service
You can access the web service by using a web service client, such as the SOAP UI client.
To access the web service
- Open the SOAP UI client.
- Enter the web service URL in the following format to connect to the web service.
http://<midTier_Server>:<port>/arsys/WSDL/public/<ARserverName>/CHG_ChangeOutboundInterface
For example,
http://myMidtierServer:8080/arsys/WSDL/public/myARServer/CHG_ChangeOutboundInterface
The contents of the web service is displayed. You can periodically poll this web service to receive updates.
CHG_ChangeOutboundInterface field descriptions
Note: The following table does not include all the fields available in the web service.
| Field name | Description |
|---|---|
| Source ID | The source ID of the host that created the RFC. This could be a combination of product name, host name, and port number. For example, BSA:clm-pun-000001:1010. |
| Job ID | The unique ID of the job, which is generated by the automation system that is referred to when running that job. This value is used to update the job details in the automation system. |
| Job Version | The version number of the job. |
| Job Instance ID | The job instance for which change approval is requested. This field is specific for the Operator-Initiated Change use case. |
| Consolidated Status | The change record status. For example, the status could be New, Waiting For Approval, Approved and so on. Note: If the use case is Change-Initiated Job, the value in this field will not be set to Ready to Execute until the change record is approved and the schedule is reached. |
| Infrastructure Change ID | The unique ID of the RFC. |
| Change Instance ID | The unique ID of the particular change record. |
| Change Request Status | The status of the RFC. For example, Draft, Request for Authorization, Pending, Rejected and so on. |
| Change Request Status Reason | The reason for the change status. For example, Successful,To Be Rescheduled, No Longer Required and so on. |
| Approval Status | The approval status. For example, Pending, Approved, Rejected. |
| Task ID | The unique ID of the task that initiates the integration job. |
| Task Status | The status of the task. For example, Staged, Assigned, Pending, Waiting and so on. |
| Task Status Reason | The reason for the task status. For example, Success, Failed, Staging in Progress and so on. |
| CINameList | Semicolon separated list of CI names. For example, O1-asdfasfsafasfasfas;O2-wetgwcsdvwegtwecswerf; |
| CIReconIDList | Semicolon separated list of reconciliation IDs of the CIs. For example: CI1;CI2; |
| Use Case | The use case that is being implemented. For example, Operator-Initiated Change and Change-Initiated Job. |
| Status | The use case status. For example, New, In Progress, Completed, and Error. |
Polling to receive updates
Any external automation system that is integrated with Change Management can periodically access this web service and receive the change record updates and work log information updates.
In BMC Change Automation, BMC Atrium Orchestrator polls the web service periodically to receive the updates. The web service is polled periodically for every five minutes, and if certain qualifying criteria are satisfied, the information is received by BMC Atrium Orchestrator. The qualifying criteria to fetch the data can be the last modified time stamp or a condition such as if the source ID of the host changes.
Though the default polling interval is five minutes, the interval can be configured if you are using BMC Atrium Orchestrator. For more information, see Configuring polling interval.
If the use case is Change-Initiated Job, the automation system receives updates of the job to be executed only when the scheduled time is reached. BMC Atrium Orchestrator obtains the data from Change Management only after the RFC is approved and the consolidated job status is Ready to execute.
BMC Atrium Orchestrator polls the web service only when the following criteria is met:
Criteria | Value |
|---|---|
| Use Case | Change Initiated Job |
| ScheduleStartTime | ServerTimeStamp |
| CIReconIDList | Not NULL |
| ConsolidatedStatus | ReadyToExecute |
Additional information
Fields used in bidirectional communication
When the change record is created, there are some field values in the outbound web service that are sent as response from the web service. The values are updated in the underlying Change Management and Task Management forms and are synced with the transactional worklog of the outbound web service. The external automation system that is listening to this worklog polls for the values of the fields, which is communicated back to the automation system. This capability ensures bidirectional communication between the applications implementing BMC Change Automation.
The values and the fields that are sent as response of the web service and updated in the worklog are:
- Infrastructure Change ID
- Task ID
- Job ID
- Job Version
- Job Instance ID
- Source ID
- Last Modified By
- Last Modified Date
- Field Name
- Field Value
- Status
Additional fields for customization
The outbound web service includes ten additional fields that can be used to communicate the values in the custom fields. The custom fields are usually added to the change management form. You can populate custom field values in the following character fields.
- Character01
- Character02
- Character03
- Character04
- Character05
- Character06
- Character07
- Character08
- Character09
- Character10
Related topics
Overview
Content Tools
Apps
Reporter Replacement
com.bmc.atlassian.bmc-util-plugin-2.section.label
Tasks