BMCs Remedy ITSM platform is one of the most commonly used and mature Service Management Systems - but automating it can be tough.
In our previous blog post we got you started with flint's orchestration platform. In this post we'll show you how to query Remedy Forms, how to handle the response, how to create new records or how to update existing ones.
Let's take a typical integration use case: An external system is called on a regular base. Depending on the response, new records are created in Remedy or existing records are updated.
In our example we have a custom build Remedy Application. This application requires up-to-date exchange rates between EUR and USD. We'll poll an external Webservice to get the current exchange rate and we'll store them in a Custom Remedy Interface Form. We'll check the form for existing records and update them if necessary.
To get this example running you need a BMC Remedy Server and a running copy of Flint. You'll also need:
A Restful API wrapper around the BMC Remedy Java API. For a quick start just run:
docker run -d -p 8080:8080 vipcon/arapi
on your docker environment. This will pull the latest Version from Docker Hub and deploy it in your environment.
Our Remedy Toolkit wraps up the AR Restful API calls and provides some basic call handling. We're going to provide a native Remedy connector in the near future. Contact us to get a copy.
Exchange Rate Webservice
We'll also make use of the Exchange Rate Webservice provided by Fixer.
Flint Configuration
In our example we'll use two different HTTP connectors. One for the Remedy connection and one for the Exchange Rate WebService call. You can get away with only one, but using two will give you more control about scalability and security. E.g. You might want to deploy the Remedy Connector on a separate Grid Node within your DMZ.
In our example the connector configuration is very basic and does not require anything else than the name.
Fixer exchange rate connector
AR Restful API connector
We'll also use a Global Configuration for the Remedy connection. You can also provide these values with each request, but storing them only ones seems to be more appropriate.
Sample configuration for the Remedy connection
You can configure the following values:
arapi - The URL of your AR Restful API
connector - The name of the HTTP Connector that should be used.
username - The Login ID of the Remedy User that should be used.
password - The password of the Remedy User.
port - The port of the Remedy Server. If you use a Portmapper, enter 0.
server - The name or IP of the BMC Remedy AR Server
Remedy Interface Form
We'll use a very simple Remedy Interface Form to store the conversion rate of the day.
Remedy Interface Form
You can download the .def File of the Form here.
The Code / Workflow
For our interface we'll just need a simple Flintbit to query the Webservice and update the interface form.
First we'll get the current Exchange rates from Fixer.
//call the connector def exchangeResponse=call.connector("Fixer") .set("method","get") .set("url",url) .set("timeout",15000) .sync()
This call will return something like this:
{
"base":"EUR",
"date":"2016-02-15",
"rates":{
"AUD":1.5624,
"HRK":7.62,
"USD":1.118,
"ZAR":17.6114
}
}Based on the Run Date we can check the Remedy Interface form for existing records:
def query = "'Run Date' = \"${runDate}\"" def queryResponse = call.bit("remedy:base:query.groovy") .set("form",interfaceForm) // Set arguments .set("query", query) .sync()
If we find existing entries, we'll update all of them:
queryResponse.data.each { myRecord -> log.debug "Update " + myRecord.getKey() def recordData = "{ \"${myRecord.getKey()}\": { \"Currency\": \"EUR -> USD\", \"Exchange Rate\":" + rate + ", \"Run Date\" : \"${runDate}\" } }" def updateResponse = call.bit("remedy:base:update.groovy") .set("form",interfaceForm) // Set arguments .set("data", recordData) .async() }
For better performance on multiple entries we do the update asynchronously. Be careful if you do this for large number of records.
If we didn't find any existing records we'll create a new one:
def recordData = "{ \"MyRefId01\": { \"Currency\": \"EUR -> USD\", \"Exchange Rate\":" + rate + ", \"Run Date\" : \"${runDate}\" } }" def createResponse = call.bit("remedy:base:create.groovy") .set("form",interfaceForm) // Set arguments .set("data", recordData) .sync()
The full code looks like this:
import groovy.json.* //build the url def url="http://api.fixer.io/latest" def targetRate = "USD" def interfaceForm = "manyos:currency" log.info "Query Fixer for latest Exchange Rates" //call the connector def exchangeResponse=call.connector("Fixer") .set("method","get") .set("url",url) .set("timeout",15000) .sync() //get the response def myBody = exchangeResponse.body //Create a Object out of the JSON response def jsonSlurper = new JsonSlurper() def myRates = jsonSlurper.parseText(myBody) log.info "Query Remedy for existing records" //Get the actual Values def rate = myRates.rates.USD def runDate = myRates.date def query = "'Run Date' = \"${runDate}\"" def queryResponse = call.bit("remedy:base:query.groovy") // Provide path for flintbit .set("form",interfaceForm) // Set arguments .set("query", query) .sync() //Check if record for today already exists - if yes: update, if not: create if (queryResponse.data.size() > 0) { log.info "Entry found for query: " + query + ". Update instead." //update all records queryResponse.data.each { myRecord -> log.debug "Update " + myRecord.getKey() def recordData = "{ \"${myRecord.getKey()}\": { \"Currency\": \"EUR -> USD\", \"Exchange Rate\":" + rate + ", \"Run Date\" : \"${runDate}\" } }" def updateResponse = call.bit("remedy:base:update.groovy") // Provide path for flintbit .set("form",interfaceForm) // Set arguments .set("data", recordData) .async() } } else { log.info "Create new Record" //Create a new Record def recordData = "{ \"MyRefId01\": { \"Currency\": \"EUR -> USD\", \"Exchange Rate\":" + rate + ", \"Run Date\" : \"${runDate}\" } }" def createResponse = call.bit("remedy:base:create.groovy") // Provide path for flintbit .set("form",interfaceForm) // Set arguments .set("data", recordData) .sync() }
You can download the code here.
Scheduling the Integration
To make sure that we'll always have the latest data, we'll let our integration run every hour. To do this we just need to place a schedules.conf in our FlintBox. To run hourly it should have the following content:
"my-schedule" { description = "runs our integration every hour" trigger = "ars:remedy.groovy" cron = "0 0 0/1 1/1 * ? *" enable = false input { } }
Conclusion
Integrating an external system into BMC Remedy is simple and fast forward with flint. Using an orchestration tool like Flint make developing integrations a lot faster and easier. For a simple interface like this you now only need a few lines of code.
In the next post we'll look into ITSM Automation by Configuration with flint and our Service Management toolkit. We'll also start building our own cloud with Microservices, BMCs ITSM Suite, Flint and Docker.