Automation Script for Integration
An Integration Automation Script in IBM Maximo provides a flexible way to add custom logic to the integration process. It allows you to validate, transform, or add integration data and apply business rules while messages are being exchanged between Maximo and external systems. Integration Automation Scripts are mainly useful when the standard integration configuration does not provide enough flexibility to meet a particular business requirement. Instead of modifying Maximo’s underlying Java code or introducing complex customizations, you can use an Automation Script to add the required logic at the appropriate point in the integration process.
Depending on the integration scenario, these scripts can be used alongside Maximo integration components such as Object Structures, Enterprise Services, Publish Channels, Invocation Channels. This approach helps to keep the overall solution easier to maintain and manage.
Execution Flow
Events
| Events | Details |
| Object Structure | Inbound Processing : – Processes data received from an external system into Maximo. – Supports validation, modification, and saving of incoming data. Outbound Definition : – Defines the data structure and content sent from Maximo to an external system. – Specifies the MBOs and attributes included in outbound messages. Query Clause : – Retrieves specific data based on defined query conditions. – Filters the data returned through the Object Structure. Action Processing : – Executes a Maximo action through an integration request. – Allows external systems to trigger supported business operations. |
| Publish Channel | External Exit: – Executes custom processing at a specific point during publish processing. – Supports custom logic when standard processing is insufficient. User Exit : – Executes custom logic before or after the publish process. – Allows additional processing during message publication. Event Filter : – Determines whether an event should be published based on configured conditions. – Prevents messages from being published when conditions are not met. |
| Enterprise Service | Request : – Receives inbound messages from external systems. – Processes incoming data in Maximo using the associated Object Structure. Response : – Returns a processing response to the external system when configured. – Communicates the result of inbound message processing. |
| Invocation Channel | Request : – Allows an external application to invoke a specific Maximo operation or service. – Processes the request using the configured invocation mechanism. Response : – Returns the result of the invoked operation to the external application. – Provides the requested data or operation status. |
Configuration Steps
- Navigate to System Configuration → Platform Configuration → Automation Scripts.
- Click Create → Script with Integration Launch Point.
- Provide a Launch Point Name and select the required Integration Object.
- Select the appropriate Integration Event on which the script should execute. Depending on the integration scenario, available events can include Before External Data Processing, After External Data Processing, Before Process, After Process, Before External Data Export, and After External Data Export.
- Select the required Event Option where applicable to define how the script should participate in the selected integration event.
- Provide the Script Name, select the required Script Language, and configure the Log Level if required.
- Configure Launch Point Variables and Bindings if values need to be passed between the launch point and the script.
- Enter the required Automation Script code in the script editor.
- Click Create to save the launch point and script.
- Test the integration to verify that the script executes at the expected point and processes the integration data as required.
- Activate the launch point when the configuration is ready for use.
Sample Code Snippet
Key Benefits
- Enable capabilities to add custom logic to integrations without changing the standard Maximo integration framework.
- Integration requirements can be handled using scripts instead of developing or modifying Java classes.
- Check incoming or outgoing data and prevent incorrect or incomplete information from being processed.
- Modify, format, or convert data to match the requirements of Maximo or an external system.
- Add business rules that are required for a various integration scenarios.
- Add additional information to integration data before it is sent to or processed by another system.
- Scripts can be executed at different points in the integration process.
- Compared to extensive Java customizations, Script-based customizations enables easier management and review
- Supports complex integration requirements which helps to address scenarios where standard integration configuration is not sufficient.
- Developers can implement smaller integration customizations using scripts without building a complete custom solution.
Leave a Reply