Steps to prepare to Integrate XL Release and/or XL Deploy with Change Management Tools
We're quite frequently asked by users who are investigating or implementing XL Release or XL Deploy what steps, permissions, configuration etc. are required to integrate XL Release/XL Deploy with change management systems such as BMC Remedy, CA Harvest Software Change Manager and the like. My first comment in response is usually to ask which kind of interaction between the systems the user is trying to achieve. There is no One Right Answer: how exactly the integration should work depends very much on the business process(es) of which XL Release and/or XL Deploy are part. There are a couple of very common integration scenarios, however, and I'd like to briefly describe these, to hopefully give some helpful guidance.
Common change management integration scenarios for XL Release
- Creating a new item (change ticket, service ticket, whatever) from XL Release at any time during the release
- Updating an existing item from XL Release at any time during the release
- Waiting for the existence/status of an existing item at any time during the release
Common change management integration scenarios for XL Deploy
- Verifying the existence and status of an item (change ticket, service ticket, whatever) from XL Deploy at the beginning of a deployment
- Updating an item (again, change ticket, service ticket, whatever) from XL Deploy at the end of a deployment
Preparation stepsAs a first step in your preparation, it is useful to determine:
- Which of these scenarios, or other ones, are you looking to implement?
- Which object types in the target system need to be created/updated/verified? Change tickets? Service tickets? Configuration items in a CMDB? Other?
- Which API/client calls do you need to make in order to create/update/verify these items?
- Which credentials are available/which permissions are needed in order to make the required API/client calls?
General requirementsIrrespective of the precise answers to the above questions, there are a few items that are almost always required, and which are worth considering up front:
- We need to have some kind of way of calling the target system automatically. This may mean installing a client library or similar
- We need to be able to make these calls either from the XL Release or XL Deploy server directly, or from another machine to which the XL Release/XL Deploy server has access