| Namespace | http://www.mulesoft.org/schema/mule/maximo |
| Schema Location | http://www.mulesoft.org/schema/mule/maximo/current/mule-maximo.xsd (View Schema) |
| Schema Version | 1.1.0 |
| Minimum Mule Version | 3.2 |
Module Overview
Maximo Anypoint Cloud Connector - Connect to Maximo MIF exposed web services
Summary
Message Processors
|
|---|
|
<maximo:query>
Query operation on a Maximo web service
|
|
<maximo:update>
Update operation on a Maximo web service (Create, Insert, Delete, Update, Sync)
|
Configuration
To use the this module within a flow the namespace to the module must be included. The resulting flow will look
similar to the following:
<mule xmlns="http://www.mulesoft.org/schema/mule/core"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:maximo="http://www.mulesoft.org/schema/mule/maximo"
xsi:schemaLocation="
http://www.mulesoft.org/schema/mule/core
http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/maximo
http://www.mulesoft.org/schema/mule/maximo/current/mule-maximo.xsd">
<!-- here goes your flows and configuration elements -->
</mule>
Message Processors
<maximo:query>
Query operation on a Maximo web service
XML Sample
<maximo:query webServiceName="MXINVOICE" rsStart="0" maximumItems="100" uniqueResult="false" orderBy="INVOICENUM" operandMode="AND" query="INVOICENUM='100'" config-ref="maximoconnection"/>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
|---|
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| webServiceName |
|
Name of web service as configured in Maximo |
String |
*/* |
UTF-8 |
| objectStructureName |
|
Optional. Name of underlying object structure as configured in Maximo (Defaulted to webServiceName) |
String |
*/* |
UTF-8 |
| query |
|
Optional. An SQL WHERE clause based on the root object exposed in the Maximo service (use instead of queryConditions) |
String |
*/* |
UTF-8 |
| queryConditions |
|
Optional. List of Maximo query conditions on root object (instead of query clause) |
MaximoQueryEntry |
*/* |
|
| operandMode |
AND |
Defines whether Maximo query is run in AND or OR operand mode |
MaximoConnector.OperandMode |
*/* |
|
| orderBy |
|
Optional. Field name of Maximo root object field to order results by |
String |
*/* |
UTF-8 |
| uniqueResult |
false |
Set to true when Maximo should filter duplicate results |
boolean |
*/* |
|
| rsStart |
0 |
The row number to start returning results from |
Integer |
*/* |
|
| maximumItems |
|
Optional. The maximum number of items to be returned |
Integer |
*/* |
|
| creationDateTime |
|
Optional. Timestamp of request (yyyy-MM-dd hh:mm:ss.SSS) |
String |
*/* |
UTF-8 |
| baseLanguage |
|
Optional. Optional base language field |
String |
*/* |
UTF-8 |
| transLanguage |
|
Optional. Optional transfer language field |
String |
*/* |
UTF-8 |
| messageId |
|
Optional. Optional field used to keep track of requests and responses |
String |
*/* |
UTF-8 |
| maximoVersion |
|
Optional. Optional concatenated string that identifies the major version, minor version, build and dbbuild |
String |
*/* |
UTF-8 |
Returns
| Return Type |
Description |
| String |
XML containing Maximo returned results |
Exception Payloads
| Payload Class | Description |
|---|
| Exception |
Maximo exception during execution
|
<maximo:update>
Update operation on a Maximo web service (Create, Insert, Delete, Update, Sync)
XML Sample
<maximo:update webServiceName="MXGLCOMP" action="Sync" config-ref="maximoconnection">
<maximo:udpate-entries>
<maximo:udpate-entry action="Add" objectName="GLCOMPONENTS">
<maximo:condition-fields ref="#[payload]"/>
<maximo:fields ref="#[flowVars.changefields2]"/>
</maximo:udpate-entry>
<maximo:udpate-entry action="AddChange" objectName="GLCOMPONENTS">
<maximo:condition-fields ref="#[payload]"/>
<maximo:fields ref="#[flowVars.changefields]"/>
</maximo:udpate-entry>
</maximo:udpate-entries>
</maximo:update>
Attributes
| Name | Default Value | Description | Java Type | MIME Type | Encoding |
|---|
| config-ref |
|
Optional. Specify which configuration to use. |
|
|
|
| webServiceName |
|
Name of web service as configured in Maximo |
String |
*/* |
UTF-8 |
| objectStructureName |
|
Optional. Name of underlying object structure as configured in Maximo (Defaulted to webServiceName) |
String |
*/* |
UTF-8 |
| action |
CheckEntries |
Type of global action to perform (select Sync if action is specified at entry level) |
MaximoConnector.Action |
*/* |
|
| creationDateTime |
|
Optional. Timestamp of request (yyyy-MM-dd hh:mm:ss.SSS) |
String |
*/* |
UTF-8 |
| baseLanguage |
|
Optional. Optional base language field |
String |
*/* |
UTF-8 |
| transLanguage |
|
Optional. Optional transfer language field |
String |
*/* |
UTF-8 |
| messageId |
|
Optional. Optional field used to keep track of requests and responses |
String |
*/* |
UTF-8 |
| maximoVersion |
|
Optional. Optional concatenated string that identifies the major version, minor version, build and dbbuild |
String |
*/* |
UTF-8 |
Child Elements
| Name | Default Value | Description | Java Type |
|---|
| <maximo:udpate-entries> |
#[payload] |
List of object entries (or entry conditions) to update |
List<MaximoUpdateEntry> |
Returns
| Return Type |
Description |
| String |
XML containing Maximo returned results |
Exception Payloads
| Payload Class | Description |
|---|
| Exception |
Maximo exception thrown during execution
|
Message Sources
Transformers
