Integration system properties

System properties define the behavior and characteristics of the integration framework. To review or change integration framework properties, filter for the properties in the System Properties application.

General integration properties

To see a list of general integration properties, specify mxe.int as a filter term in the System Properties application. For Boolean properties (true/false), a value of 0 means false, and a value of 1 means true.

Table 1. General integration properties
Property Description Default value
mxe.int.containerdeploy

Deploy web services to the application server container. When set to 0 (false), web services are deployed to the product container.

0
mxe.int.credentialmapperclassname

Credential mapper classname is a class file that can be used for mapping credential information when an integration module is implemented.

 
mxe.int.genboolasbool

Generate Boolean as schema Boolean.

1
mxe.int.globaldir

Specifies the Integration Global Directory.

1
mxe.int.queueusercachesize

Number of users that are cached for inbound queue messages.

10
mxe.int.resolveschema

Resolves all schema includes to contain inline schema definition.

1
mxe.int.servicedeployer

Web services deployer class is a custom Java class for web service deployment when the default deployer class is not used.

 
mxe.int.uddiinqurl

Represents the integration UDDI registry inquiry URL.

 
mxe.int.uddiname

Represents the integration UDDI registry user ID.

 
mxe.int.uddipassword

Integration UDDI registry password.

 
mxe.int.uddipuburl

Integration UDDI registry publish URL.

 
mxe.int.validatedbupdates

Validates the database updates completed by integration. When set to 1 (true), the deletion of business objects, attributes, indexes, and relationships by a user through the Database configuration application are validated against integration content. The validation ensures that the data that is deleted is not referenced by an integration component. If a reference exists, the user is not able to complete the delete action.

1
mxe.int.validatemmpackage

Validates the Migration Manager database updates by integration.

0
mxe.int.verifywebappurl

Verifies web application URL when schema files are generating.

1
mxe.int.webappurl

Represents the integration web application URL. Configure this property to contain the correct host name and port number.

http://localhost:9998/meaweb
mxe.int.wsdlcurrentschema

Shows the current schema definition in WSDL.

1
mxe.int.wsdlincludesschema

Includes the schema directly in the WSDL.

1
mxe.int.wsdlnamespace

Represents the integration WSDL namespace.

http://www.ibm.com/maximo/wsdl
mxe.int.xmlnamespace

Represents the integration XML namespace.

http://www.ibm.com/maximo
mxe.int.binarytext

Converts a text value to base 64 encoded value.

10
mxe.int.defaultaction

The default action for flat file import.

AddChange
mxe.int.defaultoperation

The default operation for the application export.

Sync
mxe.int.dfltuser

Represents the Integration default login user.

mxintadm
mxe.int.doclink.maxfilesize

Represents the maximum file size (MB) for attachments that are included as part of an integration message.

10
mxe.int.enabledatemillis

Enables the dates with milliseconds part.

0
mxe.int.expupdatesender

Updates the SENDERSYSID field on the primary object during data export.

0
mxe.int.extracttrycount

The File Extract Retry Count is the number of times an error message is retried during data import when using file-based error management.

0
mxe.int.flatfiledelimiter

Integration flat file text delimiter is the default delimiter value that is used for application import enablement and for data import.

,
mxe.int.flatfilenewline

Retains new line character in flat files. For fields, such as descriptions, that can contain new line characters, the characters are retained in the integration messages when the property value is 1 (true).

0
mxe.int.interactiveimport

Performs the application import as interactive.

0
mxe.int.keyresponse

Provides response content for inbound integration messages for all operations. When set to 1 (true), response content, that includes the primary object key values, is provided for all service operations. When set to 0 (false), response content is provided for Query and Create operations only.

1
mxe.int.maxextractdocs

Represents the number of error documents that are written to each temporary file when an extract file is building .

1000
mxe.int.mdbdelay

Represents the wait time in milliseconds before a message from the error queue is processed.

-1
mxe.int.propagateuser

Propagate authenticated user through the inbound queue. When set to 1 (true), the user of the integration message is saved with the queue message and used during the processing of the message because it is processed from the queue to the business objects.

0
mxe.int.savemessage

Indicates the save JMS message.

0
mxe.int.setclobasaln

Controls the truncation of characters that are sent to interface tables.

0
mxe.int.textqualifier

The flat file text qualifier is the default text qualifier value in application import enablement and in data import.

"
mxe.int.updatecoafromglcomp

Updates the Chart of Accounts that contain an identified component. When set to 1 (true), processing of inbound GL component data initiates related updates to any chart of account data that references the GL component.

1
mxe.int.usescientific

Uses scientific notation for double values.

1
mxe.int.validatexmltext

Validates XML element value for invalid XML characters. When set to 1 (true), an outbound message is validated to ensure that all data in the message uses valid XML characters. If messages contains invalid characters, the operation stops and no outbound message is delivered.

0
mxe.int.whereclausepolicy

Sets the where-clause policy for an integration query.

parse
mxe.int.adminfromemail

The email address FROM integration administration, which is used as the From email address when integration initiates an email. Must be a valid email address format, such as from@example.com.

 
mxe.int.admintoemail

The email address TO integration administration, which is used as the To email address when integration initiates an email. Must be a valid email address format, such as to@example.com. You can provide more than one email address in a comma-separated list.

 
Table 2. General integration properties
Property Description Default value Who can edit property?
mxe.int.containerdeploy

Deploy web services to the application server container. When set to 0 (false), web services are deployed to the product container.

0 Global administrator
mxe.int.credentialmapperclassname

Credential mapper classname is a class file that can be used for mapping credential information when an integration module is implemented.

  Global administrator
mxe.int.genboolasbool

Generate Boolean as schema Boolean.

1 Global administrator
mxe.int.globaldir

Specifies the Integration Global Directory.

1 Global administrator
mxe.int.queueusercachesize

Number of users that are cached for inbound queue messages.

10 Global administrator
mxe.int.resolveschema

Resolves all schema includes to contain inline schema definition.

1 Global administrator
mxe.int.servicedeployer

Web services deployer class is a custom Java class for web service deployment when the default deployer class is not used.

  Global administrator
mxe.int.uddiinqurl

Represents the integration UDDI registry inquiry URL.

  Global administrator
mxe.int.uddiname

Represents the integration UDDI registry user ID.

  Global administrator
mxe.int.uddipassword

Integration UDDI registry password.

  Global administrator
mxe.int.uddipuburl

Integration UDDI registry publish URL.

  Global administrator
mxe.int.validatedbupdates

Validates the database updates completed by integration. When set to 1 (true), the deletion of business objects, attributes, indexes, and relationships by a user through the Database configuration application are validated against integration content. The validation ensures that the data that is deleted is not referenced by an integration component. If a reference exists, the user is not able to complete the delete action.

1 Global administrator
mxe.int.verifywebappurl

Verifies web application URL when schema files are generating.

1 Global administrator
mxe.int.webappurl

Represents the integration web application URL. Configure this property to contain the correct host name and port number.

http://localhost:9998/meaweb Global administrator
mxe.int.wsdlcurrentschema

Shows the current schema definition in WSDL.

1 Global administrator
mxe.int.wsdlincludesschema

Includes the schema directly in the WSDL.

1 Global administrator
mxe.int.wsdlnamespace

Represents the integration WSDL namespace.

http://www.ibm.com/maximo/wsdl Global administrator
mxe.int.xmlnamespace

Represents the integration XML namespace.

http://www.ibm.com/maximo Global administrator
mxe.int.binarytext

Converts a text value to base 64 encoded value.

10 Global administrator,
tenant administrator
mxe.int.defaultaction

The default action for flat file import.

AddChange Global administrator,
tenant administrator
mxe.int.defaultoperation

The default operation for the application export.

Sync Global administrator,
tenant administrator
mxe.int.dfltuser

Represents the Integration default login user.

mxintadm Global administrator,
tenant administrator
mxe.int.doclink.maxfilesize

Represents the maximum file size (MB) for attachments that are included as part of an integration message.

10 Global administrator,
tenant administrator
mxe.int.enabledatemillis

Enables the dates with milliseconds part.

0 Global administrator,
tenant administrator
mxe.int.expupdatesender

Updates the SENDERSYSID field on the primary object during data export.

0 Global administrator,
tenant administrator
mxe.int.extracttrycount

The File Extract Retry Count is the number of times an error message is retried during data import when using file-based error management.

0 Global administrator,
tenant administrator
mxe.int.flatfiledelimiter

Integration flat file text delimiter is the default delimiter value that is used for application import enablement and for data import.

, Global administrator,
tenant administrator
mxe.int.flatfilenewline

Retains new line character in flat files. For fields, such as descriptions, that can contain new line characters, the characters are retained in the integration messages when the property value is 1 (true).

0 Global administrator,
tenant administrator
mxe.int.interactiveimport

Performs the application import as interactive.

0 Global administrator,
tenant administrator
mxe.int.keyresponse

Provides response content for inbound integration messages for all operations. When set to 1 (true), response content, that includes the primary object key values, is provided for all service operations. When set to 0 (false), response content is provided for Query and Create operations only.

1 Global administrator,
tenant administrator
mxe.int.maxextractdocs

Represents the number of error documents that are written to each temporary file when an extract file is building .

1000 Global administrator,
tenant administrator
mxe.int.mdbdelay

Represents the wait time in milliseconds before a message from the error queue is processed.

-1 Global administrator,
tenant administrator
mxe.int.propagateuser

Propagate authenticated user through the inbound queue. When set to 1 (true), the user of the integration message is saved with the queue message and used during the processing of the message because it is processed from the queue to the business objects.

0 Global administrator,
tenant administrator
mxe.int.savemessage

Indicates the save JMS message.

0 Global administrator,
tenant administrator
mxe.int.setclobasaln

Controls the truncation of characters that are sent to interface tables.

0 Global administrator,
tenant administrator
mxe.int.textqualifier

The flat file text qualifier is the default text qualifier value in application import enablement and in data import.

" Global administrator,
tenant administrator
mxe.int.updatecoafromglcomp

Updates the Chart of Accounts that contain an identified component. When set to 1 (true), processing of inbound GL component data initiates related updates to any chart of account data that references the GL component.

1 Global administrator,
tenant administrator
mxe.int.usescientific

Uses scientific notation for double values.

1 Global administrator,
tenant administrator
mxe.int.validatexmltext

Validates XML element value for invalid XML characters. When set to 1 (true), an outbound message is validated to ensure that all data in the message uses valid XML characters. If messages contains invalid characters, the operation stops and no outbound message is delivered.

0 Global administrator,
tenant administrator
mxe.int.whereclausepolicy

Sets the where-clause policy for an integration query.

parse Global administrator,
tenant administrator
mxe.int.adminfromemail

The email address FROM integration administration, which is used as the From email address when integration initiates an email. Must be a valid email address format, such as from@example.com.

  Tenant administrator
mxe.int.admintoemail

The email address TO integration administration, which is used as the To email address when integration initiates an email. Must be a valid email address format, such as to@example.com. You can provide more than one email address in a comma-separated list.

  Tenant administrator

REST integration properties

To see a list of REST API integration properties, specify mxe.rest as a filter term in the System Properties application. For Boolean properties (true/false), a value of 0 means false, and a value of 1 means true.

Table 3. REST API integration properties
Property Description Default value
mxe.rest.format.json.mimetypes

The REST supported mime types for JSON.

application/json
mxe.rest.format.xml.mimetypes

The REST supported mime types for JSON.

application/xml,text/xml
mxe.rest.handler.mbo

The REST MBO resource handler.

com.ibm.tivoli.maximo.rest.
MboResourceRequestHandler
mxe.rest.handler.os

The REST object structure resource handler.

com.ibm.tivoli.maximo.rest.
OSResourceRequestHandler
mxe.rest.handler.ss

The REST standard service resource handler.

com.ibm.tivoli.maximo.rest.
MaxServiceResourceRequestHandler
mxe.rest.serializer.mbo.
imglib.image

The REST serializer for the imagelib MBO for image format.

com.ibm.tivoli.maximo.rest.
ImageLibSerializer
mxe.rest.serializer.mbo.json

The REST serializer for MBO for JSON format.

com.ibm.tivoli.maximo.rest.
MboJSONSerializer
mxe.rest.serializer.mbo.xml

The REST serializer for MBO for xml format.

com.ibm.tivoli.maximo.rest.
MboXMLSerializer
mxe.rest.serializer.os.json

The REST serializer for object structures for JSON format.

com.ibm.tivoli.maximo.rest.
OSJSONSerializer
mxe.rest.serializer.os.xml

The REST serializer for object structures for xml formats.

com.ibm.tivoli.maximo.rest.
OSXMLSerializer
mxe.rest.serializer.ss.json

The REST serializer for standard services for JSON format.

com.ibm.tivoli.maximo.rest.
ServiceMethodResponseJSONSerializer
mxe.rest.serializer.ss.xml

The REST serializer for standard services for xml format.

com.ibm.tivoli.maximo.rest.
ServiceMethodResponseXMLSerializer
mxe.rest.webappurl

Token Authentication on Web Application URL.

 
mxe.rest.mbo.blockaccess

Blocks access to the comma-separated list of MBOs.

 
mxe.rest.mbo.defaultformat

The REST default format for all MBOs.

xml
mxe.rest.mbo.imglib.defaultformat

The REST default format for the MBO imglib.

image
mxe.rest.os.blockaccess

Blocks access to the separated list of object structures.

10
mxe.rest.os.defaultformat

The REST default format for all object structures.

xml
mxe.rest.ss.defaultformat

The REST default format for all standard service response

xml
mxe.rest.supportedformats

The REST supported formats for a response.

xmljsonimage
mxe.rest.whereclausepolicy

Sets the where clause policy for REST query.

parse

OSLC integration properties

To see a list of OSLC integration properties, specify mxe.oslc as a filter term in the System Properties application. For Boolean properties (true/false), a value of 0 means false, and a value of 1 means true.

Table 4. OSLC integration properties
Property Description Default value
mxe.oslc.dfltconsumerversion

The default OSLC version that the consumer uses.

2
mxe.oslc.dfltversion

The default OSLC version for an OSLC provider.

2
mxe.oslc.enableprovider

Enables the OSLC provider.

1
mxe.oslc.idleexpiry

Indicates the idle expiry time.

300
mxe.oslc.webappurl

The provider's public URL.

http://localhost/maximo/oslc/
mxe.oslc.collectioncount

Adds the total count in the OSLC collection.

0
mxe.oslc.defaultep

The default OSLC Endpoint.

OSLCDEFAULT
mxe.oslc.defaultformat

The default format for OSLC.

oslcjson
mxe.oslc.errorresponse

The OSLC Error Response Format.

1
mxe.oslc.preferproviderdesc

Prefers OSLC provider description for resource registry reconciled URLs

false
mxe.oslc.prefersmallpreview

Prefers small preview for OSLC consumer.

false
mxe.oslc.prettyjson

Pretty printed JSON.

0
mxe.oslc.prettyrdf

Pretty printed RDF.

0
mxe.oslc.prqueryep

The Provider Registry Query Endpoint.

PROVIDERREGISTRY
mxe.oslc.prcreateep

Represents the Provider Registry Create Endpoint.

 


Feedback