Endpoint script

You can write Maximo Integration Framework (MIF) endpoint handlers using automation scripts. For example, you might want to write a handler for sending emails, which is something that is not there in Maximo. To write a handler for sending emails:

The following table shows the implicit variables specific to these endpoint scripts.

All endpoint metaData content is set as variables to the script. This means that in case of Publish Channel endpoints, all JMS/Kafka messages headers are set as variables in the script. Variables like destination would be available and set to the external system name for that endpoint script.

It is possible to write the following simple code:

You can define the from and to as literal variables in the script and then set the email addresses there. You can also define another literal variable called “subject” to define a static subject for the email like “Email from Maximo”. You can make it more dynamic and fancy by getting the to email from the data, and set other properties.

The following example shows how to write a custom web service handler that uses WS-Security UserNameToken, which is not supported in MIF WebService Handler. The following script code leverages the JAXWSClient utility to set WS-Security UserNameToken.

The code leverages the jdom library that ships with Maximo Manage to create the security header. The script code hard codes the username and password, but they can be set as script literal variables. This is also applicable with the URLs to invoke, in this case, /meaweb/services/SYSTEM, and other input parameters to the cl.invoke(..) call. The code shows how to add the soap headers as well as HTTP headers as an example.

HTTP handler provides an exit that can be leveraged to intercept and modify the request and response. The HTTPEXIT property of the handler endpoint can be set to a value like script:{script name} to register a scripted exit for the HTTP endpoint. A script will support the following set of callback functions.

One common use case that we face from customers being needing to do a custom authentication before invoking the target URL. One way to do that would be to attempt that authentication call in the headerProps(req) call back as that will provide the script oppertunity to set that custom authentication header (say was fetched from the authentication call) to the request. A sample code is shown below. Note that the script would invoke the token api to set the generated token to the request header of the request for the target url.

Similar to HTTP Handler, Web Service handler also provides an exit that can be leveraged to intercept and modify the SOAP request and response. The WSEXIT property of the handler endpoint can be set to a value like script:{script name} to register a scripted exit for the web service endpoint. The following callback functions are supported by a script.

The following sample code shows how a WS Security header can be set using the setupHeaders.

Customers often need to write an outbound integration message to an external queue. They can leverage the JMSHandler for this purpose. Customers can create an endpoint for this. The endpoint allows an exit to customize the JMS message properties as well as process the response, whether it is success or error. Like other endpoint exits, this is an interface type script.

The following sample script demonstrates this.