IBM BJ0NJML Integration Guide
IBM BJ0NJML - Service And Asset Management Manual
 |
View all IBM BJ0NJML manuals
Add to My Manuals
Save this manual to your list of manuals |
IBM BJ0NJML manual content summary:
- IBM BJ0NJML | Integration Guide - Page 1
IBM Maximo Asset Management 7.1 IBM Tivoli Asset Management for IT 7.1 IBM Tivoli Change and Configuration Management Database 7.1.1 IBM Tivoli Service Request Manager 7.1 Integration Guide - IBM BJ0NJML | Integration Guide - Page 2
this information and the product it supports, read the information in "Notices" on page 307. This edition applies to version 7, release 1, modification 0 of IBM Maximo Asset Management, IBM Tivoli Asset Management for IT, and IBM Tivoli Service Request Manager, and version 7, release 1, modification - IBM BJ0NJML | Integration Guide - Page 3
24 Object Structure Identification 24 User Exit Preprocessing 25 Enterprise Service Class Processing 26 User Exit Postprocessing 27 XSL Map 27 Inbound Integration Processing 32 Enterprise Services 32 Inbound Integration Process Initiation 32 © Copyright IBM Corp. 2007, 2008 iii - IBM BJ0NJML | Integration Guide - Page 4
Exit Object Processing 39 Object Processing 39 Enterprise Service Response Processing 39 Enterprise Service Web Services 40 Object Structure Services 41 Inbound Integration Process Initiation 41 Object 63 Object Structure Element 67 Key Fields 67 Field Attributes 68 iv Integration Guide - IBM BJ0NJML | Integration Guide - Page 5
Groups 79 Content, Query Data, and Supporting Data Types 80 Object Structure Schemas 82 Service Level Schemas 86 Schema Name 86 Schema Generation 86 Service Level Schema Elements 86 Standard Services 87 Object Structure and Enterprise Services 88 Object Structure and Enterprise Services - IBM BJ0NJML | Integration Guide - Page 6
Processing Properties 134 FLATFILECONSUMER Cron Task Parameters 135 FLATFILECONSUMER Cron Task Processing Properties 135 Integration Components 136 Configuring External Systems 136 Endpoints 137 vi Integration Guide - IBM BJ0NJML | Integration Guide - Page 7
Configuring Object Structures 137 Configuring Enterprise Services 137 Configuring Publish Channels 138 Configuring Invocation Properties 171 Message Body 172 Queue Selectors 172 Queue Utilities 173 IBM WebSphere MQ 174 Configuring JMS Endpoints and Handlers 174 Configuring the Integration - IBM BJ0NJML | Integration Guide - Page 8
Directory 195 Inbound Message Receipt 195 Enterprise Beans 196 HTTP Servlet 196 Integration Web Services 196 Chapter 15: Integration Framework Customization with Processing Rules 199 Objects and Records Java Exits 216 User Exit Preprocessing 216 Processing Class 217 viii Integration Guide - IBM BJ0NJML | Integration Guide - Page 9
Exit Postprocessing 217 XSL Mapping 218 Handler Exits 218 The Enterprise Bean Processing Exit Class 220 The Java Message Service Processing Exit Class 221 The Web Service Processing Exit Class 221 Inbound Customization 223 Interface Table User Exit 223 Java Exits 225 User Exit Preprocessing - IBM BJ0NJML | Integration Guide - Page 10
Schema Generation 254 Web Service Definition Language Generation 255 UDDI Registration 256 Integration Web Service Invocations 256 Chapter 20: Multiple Language Support 259 Default Processing for Control ID 289 System ID 1 and System ID 2 290 Process Control Value 290 x Integration Guide - IBM BJ0NJML | Integration Guide - Page 11
Default Collaboration Switches 290 Collaboration Switch Retrieval 291 View Collaboration Switches 292 Collaboration Switch Modification 293 Collaboration Switch Additions 293 Modifying the MXCOLLAB Table 294 Inventory Collaboration Switches 296 Invoice Collaboration Switches 298 Labor - IBM BJ0NJML | Integration Guide - Page 12
xii Integration Guide - IBM BJ0NJML | Integration Guide - Page 13
and how to configure, integrate, and create business flows between the system and your framework applications. Intended Audience The guide is intended for the following people: T Developers T Implementation analysts T Support personnel T System administrators © Copyright IBM Corp. 2007, 2008 xiii - IBM BJ0NJML | Integration Guide - Page 14
xiv Integration Guide - IBM BJ0NJML | Integration Guide - Page 15
3: Inbound Integration Processing Chapter 4: Outbound Integration Processing Chapter 5: Integration XML and Schemas Chapter 6: Interface Tables Chapter 7: Message Tracking Chapter 8: Error Management Chapter 9: Basic Configuration © Copyright IBM Corp. 2007, 2008 - IBM BJ0NJML | Integration Guide - Page 16
- IBM BJ0NJML | Integration Guide - Page 17
and inbound (services) integration components Support for multiple communication modes, including: „ Web services „ HTTP „ Java™ Message Service Support for the integration to operational management products (OMPs). T Support for the bulk export of data by using a user-defined SQL query. T Support - IBM BJ0NJML | Integration Guide - Page 18
generation for all integration interfaces. T Dynamic generation of Web Services Interoperability (WS-I) compliant Web services, including Web Service Definition Language (WSDL). T Provides the concept of an Predefined adapters for Oracle® and SAP® are available as add-ons. 4 Integration Guide - IBM BJ0NJML | Integration Guide - Page 19
applications must be familiarized with the integration framework architecture. Familiarity with the architectural concepts is essential for using the application and implementing framework components. © Copyright IBM Corp. 2007, 2008 5 - IBM BJ0NJML | Integration Guide - Page 20
support the integration with operational management products, such as IBM Web services „ Hypertext Transfer Protocol (HTTP) „ Java Message Service support data integration: Component Object structures Services with external applications. Modes include Web services, HTTP, Enterprise JavaBean™ (EJB), - IBM BJ0NJML | Integration Guide - Page 21
product integration facilitates the automation of information technology services, such as software deployment. A process management application that you use to define the actions that the integration module supports for an operational management product, such as software deployment. An application - IBM BJ0NJML | Integration Guide - Page 22
content of an XML message. You can use the message content of a single object structure to support inbound and outbound messages. When you define multiple objects in the object structure, the objects must have normal integration framework insert, update, and delete processing. 8 Integration Guide - IBM BJ0NJML | Integration Guide - Page 23
data You also can use the object structure as a service to support inbound message processing. You can invoke the object structure service as a Web service, as an Enterprise JavaBean, or by using HTTP. The object structure service supports system data updates, and queries that are started outside - IBM BJ0NJML | Integration Guide - Page 24
use of external services to process data from multiple sources. Invocation channels support a generic service-oriented architecture capability by enabling the system to call an external service synchronously. The to the caller of the channel for subsequent processing. The 10 Integration Guide - IBM BJ0NJML | Integration Guide - Page 25
The system then can process the message successfully. The enterprise service can use the following processing layers: T Processing rules - implement business logic. Adapters for Oracle and SAP provide processing classes to support integration to these products. T XSL Map - Represents an XSLT style - IBM BJ0NJML | Integration Guide - Page 26
a processing layer which is available to enterprise services. An object structure Web service supports five operations: create, delete, query, sync, and update. T Enterprise Web service - Enterprise Web services are created from an enterprise service and provide exit processing and optional JMS - IBM BJ0NJML | Integration Guide - Page 27
One external system that is configured to use all the predefined enterprise services and publish channels. T Eight predefined handlers that support different communication protocols, such as Web services and HTTP. Integration Framework for Operational Management Product Integration The integration - IBM BJ0NJML | Integration Guide - Page 28
product created by an integration module would identify the actions that the integration module supports for an operational management product. A logical management product created by a process management the process management product and the operational management product. 14 Integration Guide - IBM BJ0NJML | Integration Guide - Page 29
installed, integration modules include the logical management operations that they support for an operational management product. Depending upon the level technology services. IBM® Tivoli® Application Dependency Discovery Manager (TADDM), Tivoli Provisioning Manager (TPM), and IBM® Tivoli - IBM BJ0NJML | Integration Guide - Page 30
Integration Framework for User Interface Integration the classification value of current data being processed in the user interface) T Operational management product-specific features including the automatic substitution of operational management product host name, and the configuration item source - IBM BJ0NJML | Integration Guide - Page 31
Integration Framework for User Interface Integration Integration Framework Architecture 17 - IBM BJ0NJML | Integration Guide - Page 32
Integration Framework for User Interface Integration 18 Integration Guide - IBM BJ0NJML | Integration Guide - Page 33
inbound data exchange asynchronously or synchronously. Asynchronous messages are processed through the Java Message Service (JMS) queues. JMS queues can process messages in order of priority, or in expects all XML messages to be encoded in a Unicode format. © Copyright IBM Corp. 2007, 2008 19 - IBM BJ0NJML | Integration Guide - Page 34
structures, services, and external : „ External system „ Applicable enterprise services with operations other than QUERY „ If services cannot be processed asynchronously in the integration framework. Enterprise Services The following diagram gives an overview of the asynchronous enterprise service - IBM BJ0NJML | Integration Guide - Page 35
file processing. External systems with enabled enterprise services. Data import cron task Enterprise service object structure must support flat structures. External systems with enabled enterprise services. Enterprise service object structure must support flat structures. Messages in the Inbound - IBM BJ0NJML | Integration Guide - Page 36
system and the enterprise service are valid and enabled. enterprise service is valid and enabled, go to the Enterprise Services tab assigned to the selected enterprise service and external system. TIP To system and enterprise service names. Data Import and the enterprise service are valid and enabled - IBM BJ0NJML | Integration Guide - Page 37
integration framework updates the JMS message header with the external system and enterprise service names. You can preview the data that you want to import to check enterprise service are valid and enabled. The integration framework checks that the enterprise service object structure supports flat - IBM BJ0NJML | Integration Guide - Page 38
that the enterprise service object structure supports flat structures. If that is assigned to the enterprise service and the external system, and writes in-first-out basis. The continuous queue supports multithreaded processing of messages. When an enterprise service and creates a copy - IBM BJ0NJML | Integration Guide - Page 39
with the object structure specifies the sequence in which the subsequent object structure processing is to be performed on the enterprise service. The integration framework inbound integration can process numbers in either standard or scientific notation. TIP To see the processing sequence of - IBM BJ0NJML | Integration Guide - Page 40
exists. The user exit class skips the record (due to non-applicable data). Output The unchanged enterprise service. None; processing ends and the message is deleted from the queue. The user exit class stops the processing ends and the message in error remains in the queue. 26 Integration Guide - IBM BJ0NJML | Integration Guide - Page 41
The user exit class skips the record. The user exit class stops the record. The user exit class completes successfully. Output is The unchanged enterprise service object. None; processing ends and the message is deleted from the queue. If there are multiple records in one XML file, the class skips - IBM BJ0NJML | Integration Guide - Page 42
). TIP To see if a cross-reference control exists, go to the Enterprise Service tab in the Enterprise Services application. The following steps describe the steps the integration framework takes when it multiplies or site that is specified in the cross-reference control. 28 Integration Guide - IBM BJ0NJML | Integration Guide - Page 43
processing rules exist for the object structure, go to the Object Structure Processing Rules tab of the Enterprise Service tab in the Enterprise Services application. The following table shows the possible object structure rule processing outcomes. Condition No object structure processing rules - IBM BJ0NJML | Integration Guide - Page 44
message in error remains in the queue. The predefined enterprise services do not implement the stop action. The updated object. User customization exists, go to the Enterprise Service tab in the Enterprise Services application. If the Enterprise Service Configuration table window shows a user exit - IBM BJ0NJML | Integration Guide - Page 45
Output Object Processing Summary Asynchronous Inbound Integration Processing The same processing class contains the enterprise service user exit preprocessing, enterprise service user exit postprocessing, and user exit object processing methods. The following table shows the possible user exit - IBM BJ0NJML | Integration Guide - Page 46
services that support query and create operations, return XML content as part of the synchronous response. The response processing layer supports Java and XSL customization, but the response does not support post the transactions to enterprise services that process synchronously: hostname: - IBM BJ0NJML | Integration Guide - Page 47
The context derives the provider URL and the context factory from the environment. 3 The integration framework checks that the external system and enterprise service are valid an enabled. If the verification fails, the integration framework notifies the sender of the error and does not process the - IBM BJ0NJML | Integration Guide - Page 48
service, go to the Add/Modify Additional Object Structures dialog box in the Enterprise Services Service tab in the Enterprise Services application. If the Enterprise Service Configuration and Enterprise Service successfully. Output The existing enterprise service, unchanged. None; processing ends. - IBM BJ0NJML | Integration Guide - Page 49
user exit classes. TIP To see if any postprocessing customization exists, go to the Enterprise Service tab in the Enterprise Services application. If the Enterprise Service Configuration and Enterprise Service Response Configuration table windows show user exit classes, check these class files for - IBM BJ0NJML | Integration Guide - Page 50
The user exit class stops the record. The user exit class completes successfully. Output The unchanged enterprise service object. None; processing ends. If there are multiple records in one XML file, the class skips must stop a duplicated object structure because of an error 36 Integration Guide - IBM BJ0NJML | Integration Guide - Page 51
(every copy of the original object structure). TIP To see if a cross-reference control exists, go to the Enterprise Service tab in the Enterprise Services application. The following steps describe the steps the integration framework takes when it multiplies an object structure: 1 The integration - IBM BJ0NJML | Integration Guide - Page 52
for the object, go to the Object Processing Rules tab of the Enterprise Service tab in the Enterprise Services application. Output The following table shows the possible object rule processing outcomes. the class skips the current record and processes the next record. 38 Integration Guide - IBM BJ0NJML | Integration Guide - Page 53
final custom logic to the object. TIP To see if object processing customization exists, go to the Enterprise Service tab in the Enterprise Services application. If the Enterprise Service Configuration table window shows a user exit class, check that class file for an object processing method. The - IBM BJ0NJML | Integration Guide - Page 54
of the query by using Java and XSL. Enterprise Service Web Services You can access enterprise services by using HTTP or an enterprise bean. You can deploy enterprise services as Web services. External applications can use Web services to query or to send messages to the integration framework - IBM BJ0NJML | Integration Guide - Page 55
enables the external systems to post messages to the system. You can use the following URL to post the transactions to object structure services that process synchronously: hostname:port/meaweb/os/osname „ osname is the name of the object structure. 2 J2EE™ clients can invoke Enterprise JavaBeans - IBM BJ0NJML | Integration Guide - Page 56
Identification Summary The integration framework identifies the object structure that are associated with the service and creates a copy of the message. The following activities identify the object structure and an error is sent to the caller. The object, possibly updated. 42 Integration Guide - IBM BJ0NJML | Integration Guide - Page 57
the object structure to the caller of the service. Object Structure Web Services You can access object structure services by using HTTP or an enterprise bean. You can deploy object structure services as Web services. External applications can use Web services to query or to send messages to the - IBM BJ0NJML | Integration Guide - Page 58
URL to post the transactions to standard services that process synchronously: hostname:port/meaweb/ss/maximo service name „ maximo service name is the name of the application service. 2 J2EE™ clients can invoke following settings: „ Access to the Home and Remote class files 44 Integration Guide - IBM BJ0NJML | Integration Guide - Page 59
the system, and standard system processing is applied. Standard Web Services You can access standard services by using HTTP or an enterprise bean. You can deploy standard services as Web services. External applications can use Web services to query or to send messages to the integration framework - IBM BJ0NJML | Integration Guide - Page 60
Synchronous Inbound Integration Processing 46 Integration Guide - IBM BJ0NJML | Integration Guide - Page 61
exchange asynchronously or synchronously. Asynchronous messages are processed through the Java Message Service (JMS) queue. JMS queues can process messages in the queues in The external application returns a response to the service invoker that confirms success or failure of message processing. © - IBM BJ0NJML | Integration Guide - Page 62
Publish Channels The following diagram illustrates an overview of the asynchronous publish channel processing activities. Not every activity applies to every outbound message. 48 Integration Guide - IBM BJ0NJML | Integration Guide - Page 63
Asynchronous Outbound Integration Processing Outbound Integration Process Initiation Summary You initiate the outbound integration process by using event-based activities or by using the data export feature that you access in the External Systems application. Event-based messages are sent when a - IBM BJ0NJML | Integration Guide - Page 64
event="0" xmlns:xsi="http://www.w3.org/2001/ XMLSchema-instance" xmlns="http://www.ibm.com/maximo"> . . . - IBM BJ0NJML | Integration Guide - Page 65
per external system - publish channel" event="0" xmlns:xsi="http:// www.w3.org/2001/XMLSchema-instance" xmlns="http://www.ibm.com/ maximo"> . . . The actions listed in each stage apply to each copy of - IBM BJ0NJML | Integration Guide - Page 66
a publish channel, go to the Publish Channel tab in the Publish Channels application. On the Publish Channel tab look for a processing class value. 52 Integration Guide - IBM BJ0NJML | Integration Guide - Page 67
Output Asynchronous Outbound Integration Processing The following table shows the possible publish channel class processing outcomes. Condition Output No processing class exists. The existing object structure, unchanged. The processing class skips the record. None; processing ends. The - IBM BJ0NJML | Integration Guide - Page 68
Action menu in the End Points application. 4 The processing class that is associated with the handler sends the data to the external system. 54 Integration Guide - IBM BJ0NJML | Integration Guide - Page 69
Synchronous Outbound Integration Processing Synchronous Outbound Integration Processing As a prerequisite, you must define all applicable object structures and endpoints on the invocation channel. Invocation Channels The following diagram illustrates an overview of the synchronous invocation channel - IBM BJ0NJML | Integration Guide - Page 70
of data processing from multiple data sources. Invocation channels support this generic service-oriented architecture capability by enabling the integration framework to call ://www.w3.org/2001/ XMLSchema-instance" xmlns="http://www.ibm.com/maximo"> . . . - IBM BJ0NJML | Integration Guide - Page 71
if request class processing exists for an invocation channel, go to the Invocation Channel tab in the Invocation Channels application. On the Service Request Configuration table window look for a request processing class value. Output The following table shows the possible request class processing - IBM BJ0NJML | Integration Guide - Page 72
invocation channel, go to the Invocation Channel tab in the Invocation Channel application. Look on the Service Request Configuration table window for a request XSL map. Output The output of this activity must processing class invokes an external application or system. 58 Integration Guide - IBM BJ0NJML | Integration Guide - Page 73
. TIP To see if preprocessing customization exists, go to the Invocation Channel tab in the Invocation Channels application. If the Service Response Configuration table window shows a response user exit class, check that class file for a preprocessing method. Outbound Integration Processing 59 - IBM BJ0NJML | Integration Guide - Page 74
an invocation channel, go to the Invocation Channel tab in the Invocation Channel application. Look on the Service Response Configuration table window for a response XSL map. Output The output of this activity must be channel response before it performs the database commit. 60 Integration Guide - IBM BJ0NJML | Integration Guide - Page 75
structures, elements, and attributes for XML messages. The content of an XML message is based on the object structure that you associate with a service or a channel. Additionally, the elements are formed based on the service or the channel operation behavior. © Copyright IBM Corp. 2007, 2008 61 - IBM BJ0NJML | Integration Guide - Page 76
structure within a root element. Standard services do not support the use of object structures. For service performs. The following channels and services are available. T Invocation channel T Publish channel T Enterprise service T Object structure service T Standard service 62 Integration Guide - IBM BJ0NJML | Integration Guide - Page 77
Root Element The following operations are available. T Create T Delete T Invoke T Publish T Query T Sync T Update Integration XML Content The root element of an XML message contains one or more object structures. The name of the root element is the concatenation of the operation and the name of - IBM BJ0NJML | Integration Guide - Page 78
11 through 20, resend the query with rsStart=11. Applicable to All output operations Queries (input) Queries (input) Queries (input) and responses (output) 64 Integration Guide - IBM BJ0NJML | Integration Guide - Page 79
Attribute rsStart rsCount rsTotal Description In responses to queries: Type integer This value matches the rsStart value in the corresponding query. If the corresponding query contains a maxItems value, the rsStart value in requests for additional records is rsStart + rsCount + 1. If this - IBM BJ0NJML | Integration Guide - Page 80
. - IBM BJ0NJML | Integration Guide - Page 81
Object Structure Element Object Structure Element Every XML document contains one or more object structure elements. The following table lists the attributes that can apply to the object structure element. All attributes in this table are optional. Attribute action relationship deleteForInsert - IBM BJ0NJML | Integration Guide - Page 82
glorder="0">6600 800 SAF Fields that identify general ledger accounts have the following XML structure. 68 Integration Guide - IBM BJ0NJML | Integration Guide - Page 83
account number and its individual components, the system ignores the components. The langenabled Attribute For information about the langenabled attribute, see Chapter 20, "Multiple Language Support," on page 259. Integration XML and Schemas 69 - IBM BJ0NJML | Integration Guide - Page 84
system. Update existing records in the database in the receiving system. Add or update existing records in the database in the receiving system. 70 Integration Guide - IBM BJ0NJML | Integration Guide - Page 85
Add action Delete action Object Structure Element Value Null Description Add records or replace records in the receiving system, depending on whether the primary record exists in the database. The Change, Replace, and AddChange actions differ in the information that they include in the XML - IBM BJ0NJML | Integration Guide - Page 86
a child level record contains a replace action when the parent contains any action other than change, the system ignores the action on the child record. Integration Guide - IBM BJ0NJML | Integration Guide - Page 87
where the object structure definition contains elements that are not available in the external system. For example, the MXVENDORInterface enterprise service contains both vendor and contact information. If the database maintains the contacts for a vendor, and external systems maintain the vendor - IBM BJ0NJML | Integration Guide - Page 88
records) In the diagram, the PO with the action value equal to Replace has records that accompany a replace action on the primary object. 74 Integration Guide - IBM BJ0NJML | Integration Guide - Page 89
Records accompanying the add change action Valid action attribute combinations Object Structure Element For the sample PO, the sending system sends the following records. Some may contain updated information; some may contain the same data that are in the database. T The PO header T POLINE 1 and - IBM BJ0NJML | Integration Guide - Page 90
entire error XML that is written is encoded as UTF-8. The integration XML supports the following ISO 8601 date format. 2004-12-06T10:11:58-05:00 If a tag in an inbound transaction 738,593.64 must be in the following format: 1738593.64 76 Integration Guide - IBM BJ0NJML | Integration Guide - Page 91
T Invocation Channels T Object Structures T Publish Channels You also can view XML on the Web Service Library tab in the Web Services Library application. Integration Schemas Key Fields The following circumstances dictate whether the system generates XML schemas: T Publish channels publish - IBM BJ0NJML | Integration Guide - Page 92
space property value is: http://www.ibm.com/maximo If you change the service is deployed. You can manually generate or regenerate schemas in the following applications: T Enterprise Services T Invocation Channels T Object Structures T Publish Channels T Web Services Library 78 Integration Guide - IBM BJ0NJML | Integration Guide - Page 93
in incorrect schemas and problems with Web services. Besides actual data content , the metadata schema file includes the following properties that provide additional information about messages. T Attribute groups T Content types T Query data types T Supporting - IBM BJ0NJML | Integration Guide - Page 94
types. Content, Query Data, and Supporting Data Types The following tables list the content, query data, and supporting data types. Type MaximoVersionType MXBooleanType changed maxvalue changed changed changed glorder changed changed languageEnabled changed changed 80 Integration Guide - IBM BJ0NJML | Integration Guide - Page 95
1, the published structure is the result of an event. EventType is an extension of BooleanType. Processing actions that the integration services support. Identifies the Query by Example action to be performed on the corresponding field. Restricted Values T 0 (false) T 1 (true) 1 (true) T 0 (false - IBM BJ0NJML | Integration Guide - Page 96
Object structure schemas are not used directly as input or output for any service. They are used by system services while defining input or output types. The naming convention for object structure schemas delete Element Name MXPERSON MXPERSONSet MXPERSONQuery MXPERSONDelete 82 Integration Guide - IBM BJ0NJML | Integration Guide - Page 97
applications such as Deployment Manager use schemas comparable to MXPERSON and MXPERSONSet. Integration users must use object structure services within the context of a service level schema. The following content is in the object element: T Element MXPERSON has type MXPERSONType T Complex type - IBM BJ0NJML | Integration Guide - Page 98
nonpersistent columns. T The query element allows two occurrences of the elements to support a query on a range, such as a date range. Since the query directly as input and output for any system service. They are used by system services while defining input and output types. Each object Guide - IBM BJ0NJML | Integration Guide - Page 99
the following components: T Object structure schema that contains the object T Object structure service or enterprise service schema where the object structure referenced by the service includes the object T Standard service schema that contains the object All object schemas include the MXMeta.xsd - IBM BJ0NJML | Integration Guide - Page 100
operations they support. Multiple services can perform the same operation using the same input and output. For example, two AddMXPERSON services can have ). The input and output schema types for enterprise services and object structure services are generally reusable. The system defines the input - IBM BJ0NJML | Integration Guide - Page 101
methods that can be exposed as Web services. Standard services are available only for methods that are properly annotated within the service. The service schemas that are generated for standard services are used only by the corresponding actions. Service schemas that are generated for objects and - IBM BJ0NJML | Integration Guide - Page 102
the content for both object structure and enterprise services. Since an enterprise service provides additional capability outside of the data content, a single schema can support both services. However, the object structure service supports all the defined operations (Create, Delete, Update, and - IBM BJ0NJML | Integration Guide - Page 103
CreateMXPERSON Element Integration Schemas The following diagram represents the content of the CreateMXPERSON element: T The CreateMXPERSON element is type CreateMXPERSONType. T The CreateMXPERSONType has element MXPERSONSet, which is type MXPERSONSetType. MXPERSONSet is derived from the object - IBM BJ0NJML | Integration Guide - Page 104
element PERSON, which is type PERSONKeyType. T The PERSONKeyType contains only the PERSONID attribute of the PERSON object (the Primary Key of the PERSON). 90 Integration Guide - IBM BJ0NJML | Integration Guide - Page 105
DeleteMXPERSONType. T The DeleteMXPERSONType has element MXPERSONDelete, which is type MXPERSONDeleteType. T MXPERSONDeleteType has elements for all the configured attributes of the PERSON object. Delete supports only the top object of the object structure (PERSON). Integration XML and Schemas 91 - IBM BJ0NJML | Integration Guide - Page 106
object structure. The Publish element is like the Create element, but it uses the additional attribute event, which is defined in the PublishingContentGroup. 92 Integration Guide - IBM BJ0NJML | Integration Guide - Page 107
has element MXPERSONQuery, which is type MXPERSONQueryType. T MXPERSONQueryType has elements for all the configured attributes of the PERSON object. Query supports only querying against the top object of the object structure (PERSON). The Query element uses the additional attributes uniqueResults - IBM BJ0NJML | Integration Guide - Page 108
objects (PHONE, EMAIL, and SMS). The Query Response element uses the additional attributes rsStart, rsCount, and Total, which are defined in the ResponseContentGroup. 94 Integration Guide - IBM BJ0NJML | Integration Guide - Page 109
the definition of the object structure that is associated with an enterprise service or publish channel. Invocation channels, object structure services, standard services, and query operations do not support interface tables. Data synchronization messages can be exchanged by using interface tables - IBM BJ0NJML | Integration Guide - Page 110
You must configure the object structure that is associated with the enterprise service or publish channel to support flat files. The Support Flat Structure check box must be selected on the object structure. with a given TRANSID value in the corresponding interface table. 96 Integration Guide - IBM BJ0NJML | Integration Guide - Page 111
be resolved before an interface table is created. You can create interface tables for data synchronization on enterprise services and on publish channels. Interface tables do not support Query and Invoke operations. You can create interface tables for a specific endpoint. You must identify where the - IBM BJ0NJML | Integration Guide - Page 112
queue table. This means that the transaction was delivered successfully to the inbound Java Message Service (JMS) queue. Records are deleted from the MXIN_INTER_TRANS queue table, never from the object structure. If necessary, a system administrator can drop the table. 98 Integration Guide - IBM BJ0NJML | Integration Guide - Page 113
flat file record is generated. To resolve the duplicate column name problem, change the system alias for duplicate column names. Every system database have an alias, but some columns have aliases that support the predefined enterprise services or publish channels. A database column can have only - IBM BJ0NJML | Integration Guide - Page 114
IFACENAME Column The IFACENAME column in the interface queue table contains the name of the enterprise service or the publish channel that is used in a transaction. The IFACENAME column is populated in interface table as part of that enterprise service or the publish channel. 100 Integration Guide - IBM BJ0NJML | Integration Guide - Page 115
Format of Interface Tables For example, assume that you create a purchase order with one line item. This transaction uses the predefined MXPOInterface, and it increments the TRANSID value that is associated with the MXOUT_INTER_TRANS queue table to 1065. The transaction produces the following - IBM BJ0NJML | Integration Guide - Page 116
share the same TRANSID value, the TRANSSEQ column provides a secondary sequence number that indicates the sequence in which those records should be processed. 102 Integration Guide - IBM BJ0NJML | Integration Guide - Page 117
Format of Interface Tables For example, if a purchase order has three line items, that transaction might produce the following records: T One entry in the MXOUT_INTER_TRANS queue table, with the IFACENAME value equal to the MXPOInterface value, and the TRANSID value equal to 1065. T Three entries in - IBM BJ0NJML | Integration Guide - Page 118
For an inbound transaction, this value indicates the language of the transaction. Any attributes that support a multilanguage environment are expected to be in the language that the TRANSLANGUAGE value defines. MESSAGEID null; otherwise, the value in the CLOB column is used. 104 Integration Guide - IBM BJ0NJML | Integration Guide - Page 119
JMS queue. Then, individual records in the JMS queue are processed. The interface table polling process checks that the record external system and enterprise service names are valid and currently enabled. If they are not, the record is marked in error and remains in the interface table. If you - IBM BJ0NJML | Integration Guide - Page 120
„ The same TRANSID value that is contained the interface table record „ The name of the enterprise service that corresponds to the interface table, in the IFACENAME column „ Optional: The ACTION value „ The object adds a null value to the field in the system database. 106 Integration Guide - IBM BJ0NJML | Integration Guide - Page 121
Outbound Processing Configuring External Systems To configure the external system to perform outbound interface queue table and inbound interface table processing: 1 Set up a process to retrieve interface table transactions by using the MXOUT_INTER_TRANS queue table. You can use a polling program, - IBM BJ0NJML | Integration Guide - Page 122
Configuring External Systems 108 Integration Guide - IBM BJ0NJML | Integration Guide - Page 123
Tracking application tracks and displays the processing history of queue-based enterprise service messages, and queue-based publish channel messages. The Message Tracking application works application to take appropriate action to correct erroneous data. © Copyright IBM Corp. 2007, 2008 109 - IBM BJ0NJML | Integration Guide - Page 124
logic. Messages have the following attributes, and values are assigned based on the originating enterprise service or publish channel data: T Integration mode - Name of the integration mode used in processing message identifier that is assigned by an external application. 110 Integration Guide - IBM BJ0NJML | Integration Guide - Page 125
channels or that are received from enterprise services. By using the Message Tracking action in the Publish Channels and Enterprise Services applications, you can track messages and perform as the EXTMSGIDFIELDDATA attribute in the MAXINTMSGTRK table. © Copyright IBM Corp. 2007, 2008 111 - IBM BJ0NJML | Integration Guide - Page 126
messages for the MXPERSONInterface enterprise service, create the following fully qualified XPATH expression as the External Message ID: /{http://www.ibm.com/maximo}SyncMXPERSON/@messageID Multi- of the stored messages is: ExternalSystemName_IntegrationComponent_UniqueId.xml 112 Integration Guide - IBM BJ0NJML | Integration Guide - Page 127
Status ERROR DELETED PROCESSED RECEIVED Description Message processing failed due to validation problems. Message was deleted from the queue. Message was successfully processed. Message are updated according to event type: T STATUS T STATUDATETIME T ERRORMSGR © Copyright IBM Corp. 2007, 2008 113 - IBM BJ0NJML | Integration Guide - Page 128
delete the message from the queue, the system sets the message record status to DELETED. The message tracking table is no longer updated. 114 Integration Guide - IBM BJ0NJML | Integration Guide - Page 129
Error Management 8 The integration framework uses Java Message Service (JMS) queues as a staging mechanism. Inbound messages from external systems are first stored in a queue, can be managed without the need to access error files on the application server. © Copyright IBM Corp. 2007, 2008 115 - IBM BJ0NJML | Integration Guide - Page 130
failure between the queue and external system, or a problem with database configuration when writing to interface tables or files informing the recipient that an error occurred. On an IBM WebSphere Application Server environment, the integration framework sends an . 116 Integration Guide - IBM BJ0NJML | Integration Guide - Page 131
for one of the following reasons: T The JMS queue is deactivated or free space is not available. T The enterprise service or external system name is not valid. T The enterprise service is not enabled for the external system. T The external system is not enabled. When an error occurs during inbound - IBM BJ0NJML | Integration Guide - Page 132
the host that runs the SMTP server. This property is not unique to the integration framework, and can be configured for other applications. 118 Integration Guide - IBM BJ0NJML | Integration Guide - Page 133
External Systems Configuration Properties Error Management Configuration The following error management properties are configurable in the Add/Modify Queues action in the External Systems application: T Maximum Try Count This property specifies the number of times that the system tries to - IBM BJ0NJML | Integration Guide - Page 134
a clustered environment, the system administrator might receive one e-mail error notification per application server, depending upon the timing of the transactions in error. 120 Integration Guide - IBM BJ0NJML | Integration Guide - Page 135
in either the Publish Channels application or the Enterprise Services application. In the Message Tracking application, you can messages that are flagged with an error. Until you correct the processing problem, the system continues to reprocess the message according to the configured queue retry - IBM BJ0NJML | Integration Guide - Page 136
transactions, and only if enterprise service processing and user exit processing object structure created during enterprise service and user exit processing. The > - IBM BJ0NJML | Integration Guide - Page 137
Process Message Save Message Cancel Message Message Reprocessing HARRIER-042" event="1" messageid="11798570432652428"> . . . After you complete your error XML changes in the Error Data window, you can resubmit the message. - IBM BJ0NJML | Integration Guide - Page 138
to the endpoint that is specified for the external system. Typical problems are disruptions of the communication link between the system and the in an object or in the inbound processing of the enterprise service. The following table describes the most common message errors that Integration Guide - IBM BJ0NJML | Integration Guide - Page 139
The system successfully reprocesses the message and successfully saves the data. In another example, an outbound transaction encounters a communication error. When the communication problem is resolved, the message is sent to the external system and the error file is deleted. When an error occurs in - IBM BJ0NJML | Integration Guide - Page 140
-001" event="0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.ibm.com/maximo"> 0 760 Unity Blvd. not process the message until you correct the incorrect data. 126 Integration Guide - IBM BJ0NJML | Integration Guide - Page 141
application must receive the response, correct the error, and retry the transaction. You can use the system log as an aid in troubleshooting your synchronous transaction errors. The system log contains the processing exception that the integration framework issues to the caller of the process - IBM BJ0NJML | Integration Guide - Page 142
Non-queue Error Management 128 Integration Guide - IBM BJ0NJML | Integration Guide - Page 143
with preexisting integration components, or user-defined components to meet your business needs. Before you start the basic configuration, create and configure the Java Message service (JMS) queues on your application server. © Copyright IBM Corp. 2007, 2008 129 - IBM BJ0NJML | Integration Guide - Page 144
An external system (EXTSYS1) T An adapter (MAXIMO) T Object structures T Enterprise services T Publish channels T Endpoints In addition, the following JMS queues are defined: T which the systems send outbound data T The queues that the enterprise services use to receive data 130 Integration Guide - IBM BJ0NJML | Integration Guide - Page 145
policy is registered. When you define a value, the system provides this class with user and endpoint information to be used to connect to the external service. If a value is not defined, the system uses the user name and password that are specified in the endpoint to connect to the external - IBM BJ0NJML | Integration Guide - Page 146
JMS queues when you are working with the integration processes, based on the enterprise services and the publish channels, including data import and data export. Queue-based integration scenarios for the sequential queues. 3 Enable the message bean for the continuous queue. 132 Integration Guide - IBM BJ0NJML | Integration Guide - Page 147
Queue Properties JMS Queues The maximum try count property represents the number of times the system retries to process a failed message before sending an e-mail notification. The maximum try count default value is 5; the integration framework retries a failed message five times. The integration - IBM BJ0NJML | Integration Guide - Page 148
identifies the enterprise service name that the cron a specific external system - enterprise service when you add a value to specific external system - enterprise service and are loaded into the ) specified at the external system and enterprise service level. The cron task creates an index - IBM BJ0NJML | Integration Guide - Page 149
name to identify the file that was processed before the server or queue problem was encountered. The cron task continues to process the XML file starting value to the SOURCEDIRECTORY parameter. The external system and the enterprise service are identified from the first record in the flat file that - IBM BJ0NJML | Integration Guide - Page 150
processed before the server or queue problem was encountered. The cron task services and publish channels. 3 Specify the inbound JMS queue the enterprise services use. 4 Optional: Specify the endpoint that the publish channel uses to override the external system endpoint. 136 Integration Guide - IBM BJ0NJML | Integration Guide - Page 151
the object structure. Configuring Enterprise Services Use the Enterprise Service tab in the Enterprise Services application to perform the following configuration activities: 1 Create an enterprise service. 2 Specify the object structure. 3 Assign the supported operation. 4 Assign a multiplication - IBM BJ0NJML | Integration Guide - Page 152
following XPATH expression shows a Split Tag field value: {http://www.ibm.com/xmlns/prod/tivoli/swkb}SoftwareCatalog/ Products/Product The bracketed content the schema files to describe the enterprise service. Enterprise service configuration is required when you are working . 138 Integration Guide - IBM BJ0NJML | Integration Guide - Page 153
Integration Components 2 Configure the publish channel integration controls and assign the default values. 3 Generate the schema files to describe the publish channel. 4 Enable and disable the listener for the outbound integration events Publish channel configuration is required if you are working - IBM BJ0NJML | Integration Guide - Page 154
Integration Components 140 Integration Guide - IBM BJ0NJML | Integration Guide - Page 155
Framework Customization with Java and XSL Chapter 17: Integration Component Additions and Modifications Chapter 18: Integration Queries Chapter 19: Integration Web Services Chapter 20: Multiple Language Support Chapter 21: Integration Modules Chapter 22: Launch-in-Context Feature © Copyright - IBM BJ0NJML | Integration Guide - Page 156
- IBM BJ0NJML | Integration Guide - Page 157
Endpoints and their handlers facilitate the routing of outbound messages from the outbound Java Message Service (JMS) queue to its destination. Endpoints also route outbound data from an invocation specified by the endpoint with which the handler is associated. © Copyright IBM Corp. 2007, 2008 143 - IBM BJ0NJML | Integration Guide - Page 158
for those properties. Use the predefined handlers or create new ones to enable additional physical entities, such as FTP servers. For more information and detailed instructions for adding or modifying endpoints, refer to the online help in the End Points application. 144 Integration - IBM BJ0NJML | Integration Guide - Page 159
default context factory to use. The CONTEXTFACTORY uses the following property when the target client runs on an IBM WebSphere Application Server: com.ibm.websphere.naming.WsnInitialContextFactory This optional property is used for customization. This property specifies the fully qualified name of - IBM BJ0NJML | Integration Guide - Page 160
server Java Naming and Directory Interface (JNDI) tree. Server IBM WebSphere Application Server File name ibm-ejb-jar-bnd.xml Property - IBM BJ0NJML | Integration Guide - Page 161
Properties Handlers The following example is an IBM WebSphere Application Server provider URL. corbaloc:iiop The object structure that you associate with a publish channel must be marked as flat supported. Resolve all object structure alias conflicts and format the XML message according to the - IBM BJ0NJML | Integration Guide - Page 162
XML document to a URL by using HTTP or HTTPS protocols. The HTTP handler also evaluates the response code received from the external system. 148 Integration Guide - IBM BJ0NJML | Integration Guide - Page 163
HTTPEXIT Property Handlers This optional property is used for customization. This property specifies the fully qualified name of a Java class that interprets the HTTP response. This property also helps implement the code that is required for an external system to interpret the HTTP response. The - IBM BJ0NJML | Integration Guide - Page 164
default implementation returns a null value. This optional property specifies the HTTP method that you use. The supported values are POST and GET. The default value is POST when no value is specified. This optional schema or in a different schema. Its value can be 0 or 1. 150 Integration Guide - IBM BJ0NJML | Integration Guide - Page 165
user name and password, these properties specify those values. These properties apply only when the value of ISREMOTE is 1. The Java Messaging Service (JMS) handler is a Java component that consists of several properties. The handler delivers XML data into a messaging system that is enabled through - IBM BJ0NJML | Integration Guide - Page 166
on the local application server, a remote application server, or a remote dedicated queuing system such as IBM WebSphere MQ. To use this handler, enable the messaging systems by using JMS. The messaging system . The default compression uses the standard Java Deflator() class. 152 Integration Guide - IBM BJ0NJML | Integration Guide - Page 167
. The WEBSERVICE handler has the following properties: This optional property specifies the message exchange pattern for the Web service. The property supports the following values. If you do not provide a value, the default value sendreceive is used. Value sendreceive sendrobust fireandforget - IBM BJ0NJML | Integration Guide - Page 168
in milliseconds. The default value for this property is 60000 milliseconds. If the specified Web service is secured (if HTTP basic authentication is enabled), specify a user name and password. This publish channel. T uniqueidentifier is a number based on current system time. 154 Integration Guide - IBM BJ0NJML | Integration Guide - Page 169
Handlers For example, the file name MX_MXASSETInterface_10971102668641398.xml indicates that the file was generated from a system to send data to the external system EXTSYS1. The file name also indicates that the file contains the MXASSETInterface publish channel. CMDLINE Handler The CMDLINE handler - IBM BJ0NJML | Integration Guide - Page 170
the RouterPropsInfo object indicates whether to encrypt the property value while storing data. For password properties, the value of this attribute is True. 156 Integration Guide - IBM BJ0NJML | Integration Guide - Page 171
Writing Custom Handlers The following method sends data to the specified endpoint. T Metadata provides information about the external system and the interface. T Data is the XML data. T DestinationMap specifies the endpoint. sendData(Map metaData, byte[] data, Map destinationMap) The handler class - IBM BJ0NJML | Integration Guide - Page 172
Writing Custom Handlers 158 Integration Guide - IBM BJ0NJML | Integration Guide - Page 173
table polling process to improve its performance when reading data from interface tables. If you send inbound messages through the continuous Java Message Service (JMS) queue and do not require messages to be maintained in first-in-first-out sequence, you can improve the performance of interface - IBM BJ0NJML | Integration Guide - Page 174
once. For more information about cron tasks, refer to the System Administrator Guide, and the online help for the Cron Task Setup application. Selectors You values to the EXTSYSNAME (external system) and ENTERPRISESERVICE (enterprise service) parameters in the Cron Task Setup application. You can - IBM BJ0NJML | Integration Guide - Page 175
the cron task: T The selectors must be mutually exclusive, so messages are not processed multiple times. T The selectors must retrieve all the enterprise service transactions that you use, so no messages are left unprocessed. Queue Tables One method of improving interface table processing is to use - IBM BJ0NJML | Integration Guide - Page 176
Queue Tables 162 Integration Guide - IBM BJ0NJML | Integration Guide - Page 177
(JMS) queues to exchange data with an external system. When an enterprise service message is received, it writes the message to a JMS queue. Messages remain in queues: T One outbound sequential queue and two inbound queues T One sequential T One continuous © Copyright IBM Corp. 2007, 2008 163 - IBM BJ0NJML | Integration Guide - Page 178
that you use. Queues can be configured for use with publish channels and enterprise services that integrate with one or more external systems. Queue creation and configuration involves configuration. Use the System and Enterprise Services tabs in the External Systems application. 164 Integration - IBM BJ0NJML | Integration Guide - Page 179
Continuous Queue The continuous queue is a JMS queue with a message-driven bean (MDB) as a consumer. By default, this queue is configured for enterprise services only. The queue does not process messages in first-in-first-out sequence, as the sequential inbound queue does. Messages are processed in - IBM BJ0NJML | Integration Guide - Page 180
transaction> --> Uncomment the following lines in the ...\applications\maximo\mboejb\ejbmodule\META-INF\ibm-ejb-jar-bnd.xmi file on a WebSphere Application Server environment. - IBM BJ0NJML | Integration Guide - Page 181
is processed and Item A is added to the system. The failed message can then be successfully processed. In this case, the error is corrected without manual intervention. This type of situation can occur when you load related messages in the continuous queue at the same time. Such a situation is more - IBM BJ0NJML | Integration Guide - Page 182
for example two to three message-driven beans. You then determine whether that amount provides proper support for the volume of messages in your system. You can incrementally increase the number of message-driven Server error queue, use the default value for the batch size. 168 Integration Guide - IBM BJ0NJML | Integration Guide - Page 183
Continuous Queue Errors Continuous Queue You can use different application server configurations to manage error messages. When you are loading a large volume of messages, you can encounter a large number of errors. The continuous queue continues to reprocess the messages at the top of the queue - IBM BJ0NJML | Integration Guide - Page 184
trans-attribute>Required --> You also need to uncomment the following code in the ibm-ejb-jar-bnd.xmi to enable the message-driven beans on the error queue. - IBM BJ0NJML | Integration Guide - Page 185
framework. The name of the queue or topic that the message is written to. The name of the publish channel (outbound queue) and the enterprise service (inbound queue). The external system name for outbound messages. The external system name for the inbound messages. JMS Queue Configuration 171 - IBM BJ0NJML | Integration Guide - Page 186
field name message key. A comma-separated search field value. Indicates whether the publish channel or enterprise service contains a sync, create, update, or delete operation. Indicates whether the message has a RECEIVED, task In the ejb-jar.xml of the message-driven bean 172 Integration Guide - IBM BJ0NJML | Integration Guide - Page 187
provide better performance. You can add the following statement to the SELECTOR property of the SEQQIN instance of the JMSQSEQCONSUMER to instruct the cron task to process the MXPOInterface and MXPRInterface transactions from the corresponding external system: SENDER='EXTSYS1' and INTERFACE in - IBM BJ0NJML | Integration Guide - Page 188
Optional Optional Optional Optional IBM WebSphere MQ You can use IBM WebSphere MQ as a standard for your queuing activities. The integration framework supports WebSphere MQ Version 6. ) T The provider URL (PROVIDERURL) T The initial context factory (CONTEXTFACTORY) 174 Integration Guide - IBM BJ0NJML | Integration Guide - Page 189
IBM WebSphere MQ Configuring the Integration Queues and WebSphere MQ Provider You can replace the integration framework queues with the WebSphere MQ queues. The queue setup is supported when you configure the WebSphere Application Server and the integration framework queue definitions. To configure - IBM BJ0NJML | Integration Guide - Page 190
IBM WebSphere MQ 176 Integration Guide - IBM BJ0NJML | Integration Guide - Page 191
and password authentication is necessary for queue access. Security can also be set at a component level, which controls access to component or method calls. © Copyright IBM Corp. 2007, 2008 177 - IBM BJ0NJML | Integration Guide - Page 192
Integration Queue Integration Queue The Java Message Service (JMS) queues that are used by integration processing support basic J2EE security (user ID and password-based authentication and maximouser 178 Integration Guide - IBM BJ0NJML | Integration Guide - Page 193
an external system. An enterprise bean supports the basic J2EE security. Securing Enterprise service mapping is: enterpriseservice mosservice actionservice Service Enterprise Service Object Structure Service Standard Service The following code illustrates that the enterprise service - IBM BJ0NJML | Integration Guide - Page 194
-value> Application Users maximouser maximouser Integration Guide - IBM BJ0NJML | Integration Guide - Page 195
the secure version of the enterprise bean methods for each service type: T Enterprise Service: secureProcessExtnernalDataAsync(..) , secureProcessExtnernalDataSync(..) T Object Structure Service: secureProcessMOS(..) T Standard Service: secureAction(..) 2 To create a secure context for invoking the - IBM BJ0NJML | Integration Guide - Page 196
service: enterprise service, object structure service, and standard service. The to service mapping is: Enterprise Service Servlet App Service Servlet Object Structure Service Servlet Service Enterprise Service Standard Service -collection> Integration Guide - IBM BJ0NJML | Integration Guide - Page 197
by using SSL (HTTPS). Set up the SSL in the application server with the appropriate digital certificates. Web Services You can secure integration Web services by using HTTP basic authentication in standard J2EE security. These security settings let authorized users with a valid user name and - IBM BJ0NJML | Integration Guide - Page 198
username); call.setProperty(Call.PASSWORD_PROPERTY, password); You can securely deploy a Web service by using SSL (HTTPS). Set up the SSL in the application server T processExternalData(..) (both versions) T query(..) T viewQueueData(..) T loadData(..) T loadSystemData(..) 184 Integration Guide - IBM BJ0NJML | Integration Guide - Page 199
handler. Outbound Router Handler Security The outbound router handlers have support for authorization and confidentiality. The enterprise bean, HTTP, JMS, Web service, and interface table handlers have support for security. Object-Level Authorization The system provides object-level authorization - IBM BJ0NJML | Integration Guide - Page 200
. To run the standard service by using HTTP, enterprise bean, or SOAP, you need authorization to the STATUS option. Standard service authorization does not support the use of a condition that you associate with the signature option. Any condition that you assign is ignored. 186 Integration Guide - IBM BJ0NJML | Integration Guide - Page 201
14 The system can be implemented within a cluster of application servers, and integration services can run across the cluster. You can implement a cluster of application servers based configurations facilitate the processing of messages in large volumes. © Copyright IBM Corp. 2007, 2008 187 - IBM BJ0NJML | Integration Guide - Page 202
interface table cron task, the data import cron task, and the Java Message Service (JMS) queue cron task are cluster-aware functions. By default, the cron server that resumes the polling. To configure a group of servers to support failover, set the -D crontaskname.instance1 value to 1 in each server - IBM BJ0NJML | Integration Guide - Page 203
-out processing. The continuous queue is multi-threaded on the consumer side. The queue supports message processing in high volumes. In this queue, the message processing order is not considered. Enterprise service messages that use the sequential queue, are processed in a strict sequential order - IBM BJ0NJML | Integration Guide - Page 204
cluster configuration on the IBM WebSphere Application Server. The the integration framework receives enterprise service messages by using the HTTP, load balancer directs the enterprise service messages to an application server, its own message store. Enterprise service messages that are sent using - IBM BJ0NJML | Integration Guide - Page 205
JMS Queues Integration cron tasks deliver enterprise service messages from flat or XML files and interface tables. The cron task places messages into the queue store on the server where the cron task - IBM BJ0NJML | Integration Guide - Page 206
queue implementations, messages may be unprocessed or may be processed out of order. The load balancer directs the application server to drop enterprise service messages into the sequential queue. When messages are in the queue, the application server that is running the JMS consumer cron task - IBM BJ0NJML | Integration Guide - Page 207
queue. Each member of the cluster places messages into the queue, which exists on one member of the cluster. An integration cron task delivers enterprise service messages from flat or XML files and interface tables. The cron tasks that place messages into the queue can run on any server in the - IBM BJ0NJML | Integration Guide - Page 208
when the integration framework receives enterprise service messages by using HTTP, enterprise directs the application server to drop enterprise service messages into the sequential queue. Each . An integration cron task delivers enterprise service messages from flat or XML files and interface - IBM BJ0NJML | Integration Guide - Page 209
the mxe.int.globaldir system property in the System Properties application. Inbound Message Receipt All object structure, enterprise, and standard services can be accessed by using the following components: T Java™ remote method invocation (RMI), Internet Inter-ORB Protocol™ (IIOP), and enterprise - IBM BJ0NJML | Integration Guide - Page 210
the object structure service, enterprise service, and standard service. The integration service: object structure, enterprise, and standard service. The URL formats for each service service access for a cluster is the same as for a single server, except that the Web service URL and Web Service - IBM BJ0NJML | Integration Guide - Page 211
UDDI Registry Inquiry URL mxe.int.uddiinurl T Integration UDDI Registry Publish URL mxe.int.uddipuburl The URL to access a Web service is http://hostname:port/meaweb/services/web service name where the meaweb value represents the mxe.int.webappurl system property value. Cluster Configuration 197 - IBM BJ0NJML | Integration Guide - Page 212
Inbound Message Receipt 198 Integration Guide - IBM BJ0NJML | Integration Guide - Page 213
services, or standard services. Processing rules can access and evaluate the values in XML and object fields, object sets, and integration and system controls. Processing rules also can change the values in XML and object fields, or stop or skip processing all or part of a message. © Copyright IBM - IBM BJ0NJML | Integration Guide - Page 214
record. „ If an inbound rule evaluates or manipulates an object or object field, apply rules to the object. Apply all rules for enterprise services to either objects or to object structure records. Avoid applying rules to both objects and object structure records. If you apply processing rules to - IBM BJ0NJML | Integration Guide - Page 215
the action attribute of the primary object that is represented in the XML message. Processing Rule Action A processing rule can act on an enterprise service or publish channel as a whole. For example, a rule can bypass a message, or it can manipulate the value in a data field within the message - IBM BJ0NJML | Integration Guide - Page 216
in the inbound JMS queue. If the error was the result of a synchronous invocation of the enterprise service, the calling program is notified about the error. Predefined rules are not provided with a stop action. to a single field or multiple fields in the selected record. 202 Integration Guide - IBM BJ0NJML | Integration Guide - Page 217
system definition of an entity, for example, a two-part external system key that maps to a single part key in the system. An enterprise service processing rule can combine a vendor ID and a vendor location field from an external system into the COMPANY field. A publish channel processing rule with - IBM BJ0NJML | Integration Guide - Page 218
depends on the successful result of an earlier rule. If a rule with a stop or skip action is successfully applied, no further checking occurs. 204 Integration Guide - IBM BJ0NJML | Integration Guide - Page 219
Conditions and Evaluations Conditions and Evaluations Processing rules are applied conditionally. Any conditions must be met before the processing or action that is specified in the rule can be performed. Conditions can involve one or more of the following evaluations or comparisons: T XML field - IBM BJ0NJML | Integration Guide - Page 220
Conditions and Evaluations Because enterprise service processing rules are applied before objects are built, the processing rules cannot evaluate object fields or object sets. value does not contain the expected value. The specified field contains no value or a null value. 206 Integration Guide - IBM BJ0NJML | Integration Guide - Page 221
Conditions and Evaluations Type of Evaluation ISNOTNULL NONE EXISTS NOTEXISTS Description The specified field contains a value. This option is available only if the When to Evaluate field is configured as Changed or Not Changed. If NONE is selected, no further evaluation is necessary. Records - IBM BJ0NJML | Integration Guide - Page 222
control (a value in the MAXVARS database table). Boolean Comparison field Evaluate the OWNERSYSID on any enterprise service or publish channel to determine if it is the same as MAXVARS.MXSYSID. Compare the value in the item-storeroom values on a receipt line or a PO Line. 208 Integration Guide - IBM BJ0NJML | Integration Guide - Page 223
integration controls for evaluation purposes. Integration controls are defined at the system level. You can assign controls to one or more enterprise service and publish channel. The control values can be configured at the external system level. Two external systems that process the same enterprise - IBM BJ0NJML | Integration Guide - Page 224
an external system value. In an enterprise service, an external system value is converted to a multiplication control on an enterprise service, one-to-many mappings can Service tab in the Enterprise Services application -reference control in an enterprise service can translate business unit EX001 - IBM BJ0NJML | Integration Guide - Page 225
rule, and to set a value at the external system level, associate controls with a publish channel or enterprise service. T When you associate a publish channel or enterprise service to an external system, all associated controls are copied to the external system level. You can assign values at - IBM BJ0NJML | Integration Guide - Page 226
Integration Controls 212 Integration Guide - IBM BJ0NJML | Integration Guide - Page 227
use one or more of these placeholders, or user exits, for your customizations. You can download sample Java classes or XSL files from the IBM® Tivoli® Open Process Automation Library (OPAL). After changing the Java class files, rebuild and redeploy the application EAR file. You can reference the XSL - IBM BJ0NJML | Integration Guide - Page 228
exit. The same level of customization is available to the transaction response component. The exit layer can map the response from the external service back to an object structure which can be used to update system business objects. Processing rules are not available to an invocation channel. 214 - IBM BJ0NJML | Integration Guide - Page 229
Outbound Customization The primary difference between an invocation channel and a publish channel is that application code invokes the invocation channel, while an event or a data export initiates a publish channel. Additionally, the synchronous processing of an invocation channel can return a - IBM BJ0NJML | Integration Guide - Page 230
the first user exit by using the following method: public StructureData setUserValueOut(StructureData irData) This method can perform the following processing: T Validate data 216 Integration Guide - IBM BJ0NJML | Integration Guide - Page 231
Outbound Customization T Change system data by changing the IR record to be sent to the external system T Stop the message from being saved in the database by throwing a system exception. The entire message is rolled back, including any changes you make in the application that initiated the event. - IBM BJ0NJML | Integration Guide - Page 232
an external system, including HTTP, Enterprise JavaBean (EJB) call, and interface tables. Some of these methods have user exit placeholders available for customization. 218 Integration Guide - IBM BJ0NJML | Integration Guide - Page 233
The HTTP Processing Exit Class Outbound Customization You can use an HTTP exit placeholder for customization when sending transactions from the system to an external system using HTTP. This exit class is optional and is called as part of the response from the HTTP call. The following figure shows - IBM BJ0NJML | Integration Guide - Page 234
. You enter the fully qualified name of the Java class in the EJBEXIT property of the endpoint that implements the enterprise bean handler. 220 Integration Guide - IBM BJ0NJML | Integration Guide - Page 235
Processing Exit Class You can use an exit placeholder for customization when sending transactions from the system to an external system using Java Message Service (JMS). This exit class is optional and is called before the JMS is called. The following figure shows the JMS processing exit class the - IBM BJ0NJML | Integration Guide - Page 236
service. public void responseError(Exception e) throws MXException If an error was encountered during the Web service the Web service being invoked be used while invoking the Web service. You enter the fully qualified the endpoint that implements the Web service handler. There is a default - IBM BJ0NJML | Integration Guide - Page 237
In a business object user exit The following diagram shows the flow of a message that uses an enterprise service. The process flow starts at the receipt of a message that uses one of multiple protocols supported by the framework, through to the setting of the data in the object structure and system - IBM BJ0NJML | Integration Guide - Page 238
queue. T Log the transaction The user exit that uses the afterCommit or afterRollback method can perform the following processes: T Perform custom processing and cleanup Integration Guide - IBM BJ0NJML | Integration Guide - Page 239
your custom logic. User Exit Preprocessing The user exit class consists of two methods: one exit runs before and one exit runs after the enterprise service processing class. If you have an ERP adapter that provides a processing class, your user exit logic can be implemented to run before or after - IBM BJ0NJML | Integration Guide - Page 240
T Log the transaction You identify the interface processing class on the Enterprise Service tab in the Enterprise Services application. User Exit Postprocessing In the second exit, both the IR and public StructureData setUserValueIn(StructureData irData, StructureData erData) 226 Integration Guide - IBM BJ0NJML | Integration Guide - Page 241
always called with the XML message that is output from the Java exit processing. You identify the XSL file on the Enterprise Service tab in the Enterprise Services application. The XSL file can be a part of the EAR and must be under the businessobjects/ classes/. . . folder structure. The XSL file - IBM BJ0NJML | Integration Guide - Page 242
In this case, the transaction remains in the queue and is retried. T Log the transaction You identify the interface user exit class on the Enterprise Service tab in the Enterprise Services application. 228 Integration Guide - IBM BJ0NJML | Integration Guide - Page 243
entity, and modification restrictions that apply to the predefined component do not apply to the copy. The original version of the component is unchanged. © Copyright IBM Corp. 2007, 2008 229 - IBM BJ0NJML | Integration Guide - Page 244
work management, and inventory. You can create an object structure, an enterprise service, and a publish channel to support the exchange of data to and from the integration framework. Required Object Determinations clause that applies to the relationship that you are creating. 230 Integration Guide - IBM BJ0NJML | Integration Guide - Page 245
Alternate Keys Specifying an alternate key Required Fields Persistent Fields Nonpersistent Fields Object Structure Creations 3 Repeat the preceding steps for the remaining required objects. Indicate the relationship between those two objects. Define PERSON as the parent to EMAIL and as the parent - IBM BJ0NJML | Integration Guide - Page 246
columns are processed successfully. If the object columns are not processed successfully, add an enterprise service processing class to handle the inbound processing. If you use the object structure in interface tables with the endpoint location when you create an endpoint. 232 Integration Guide - IBM BJ0NJML | Integration Guide - Page 247
that you create determine how the adapter processes inbound integration messages. The enterprise service specifies the type of operation that the service supports. Processing rules change data in the enterprise service before objects are created. You can change data without having to use Java - IBM BJ0NJML | Integration Guide - Page 248
business requirements. Interface Tables If necessary, you can change the interface table name for the service or channel. Object Structure Services Object structure services support the following operations: CREATE, UPDATE, DELETE, SYNC, and QUERY. Object Structures The object structure is - IBM BJ0NJML | Integration Guide - Page 249
values are used in publish channel implementations to meet your business requirements. If necessary, you can change the interface table name for the service or channel. You can create an invocation channel in the Invocation Channels application. You can use an object structure to define the data - IBM BJ0NJML | Integration Guide - Page 250
Service Service and Channel Modifications Rather than create a service or channel, you can duplicate predefined services record. You can work with the service configurations to redefine the following characteristics: the data source and how the service and channel handle customized data processing, - IBM BJ0NJML | Integration Guide - Page 251
through the sequential or continuous JMS queue. You import data by using the Data Import button on the Enterprise Services tab. 2 Enable the enterprise service for inbound processing. 3 Identify the action attribute that the external application uses to submit an inbound message. The attribute - IBM BJ0NJML | Integration Guide - Page 252
Predefined External System Modifications 238 Integration Guide - IBM BJ0NJML | Integration Guide - Page 253
Integration Queries 18 The integration framework supports external system queries. The external system Method Invocation (RMI), or a Simple Object Access Protocol (SOAP) request in a Web service. Support for XML queries is based on the system Query By Example (QBE) capability. XML-based queries - IBM BJ0NJML | Integration Guide - Page 254
Query Services Query Services Object structure services and enterprise services support query operations. An external source can use a service to run a query and to retrieve data from a system. In both cases, the object structure schema defines the XML content for the query request and - IBM BJ0NJML | Integration Guide - Page 255
Attribute uniqueResult maxItems rsStart rsStart Query Services The following table lists the attributes that can apply specifically to the root element of a query, a response to a query, or both. All attributes in this - IBM BJ0NJML | Integration Guide - Page 256
Services the maxItems value to 10. - IBM BJ0NJML | Integration Guide - Page 257
Query Operator Query Services QueryMXPERSON Element The QueryOperatorType data type supports the use of different operators. Your query request XML can use the different operators to filter the data that is returned to the querying external - IBM BJ0NJML | Integration Guide - Page 258
Query Services QueryMXPERSONRespo nse Element T rsStart - When this value is set to 11 on the query, all the records in the result set are returned attributes of the PERSON object and elements for child objects defined in the object structure (PHONE, EMAIL, XYZ, and SMS). 244 Integration Guide - IBM BJ0NJML | Integration Guide - Page 259
request contains the selection criteria for the query. A query can select records based on a single value or a range of values. The integration framework supports the use of query operators such as = or >. Selection criteria applies only to attributes of objects in the top two levels of the object - IBM BJ0NJML | Integration Guide - Page 260
is like %ATI%. The operand represents the default behavior and requires no operator value. ATI 246 Integration Guide - IBM BJ0NJML | Integration Guide - Page 261
Object Structure Element The following query searches for the inventory balances where the bin number is not null. The following query searches for the inventory balances - IBM BJ0NJML | Integration Guide - Page 262
/services/web service name T host:port/meaweb is the value of the Integration Web Application URL property. T web service name is the name of the Web service. You deploy query enterprise and object structure services as Web services using the Web Services Library Application. 248 Integration Guide - IBM BJ0NJML | Integration Guide - Page 263
Web Service Queries Integration Queries 249 - IBM BJ0NJML | Integration Guide - Page 264
Web Service Queries 250 Integration Guide - IBM BJ0NJML | Integration Guide - Page 265
Organization (WS-I) Basic Profile 1.1. When XML schema files are generated, they contain the content of each service and a Web Service Definition Language (WSDL) file to describe the service. The system uses Apache Axis 2.0 as the Web service engine. © Copyright IBM Corp. 2007, 2008 251 - IBM BJ0NJML | Integration Guide - Page 266
for both the invocation and the response. T Provide response content only for the Create and Query operations that are processed in the queue. T The enterprise service definition notes whether the service supports a response by using a ProcessResponse flag. 252 Integration Guide - IBM BJ0NJML | Integration Guide - Page 267
process) or bypass the JMS queue (synchronous process). Enterprise Web services that are processed in a JMS queue do not support the Query operation and do not provide any response content to the caller. Enterprise Web services that are configured with the Query or Create operations provide XML - IBM BJ0NJML | Integration Guide - Page 268
/MBO T SERVICE If you set Services Description Language file. If both the properties value are set to true (1), the generated Web Services SERVICE Contains service level service to deploy an enterprise service as a Web service, place the service MBO SERVICE URL http /shema/web service name T hostname - IBM BJ0NJML | Integration Guide - Page 269
generated file refers to the XML Schema Interface file in schema import. The Web Service Definition Language file defines the operation which varies depending upon the type of Web service. The Web Service Definition Language also uses the schema definitions to specify the XML structure of the input - IBM BJ0NJML | Integration Guide - Page 270
the Web service in the UDDI Web Service Definition services tool of your choice, such as IBM WebSphere Application Server or Microsoft® .NET Framework. The Web service tool must reference the system generated Web Service Web services, you have configured the enterprise service to use a JMS queue, - IBM BJ0NJML | Integration Guide - Page 271
Service Invocations For all operations, except for the Query and Create operations, the SOAP body returns empty: - IBM BJ0NJML | Integration Guide - Page 272
Integration Web Service Invocations 258 Integration Guide - IBM BJ0NJML | Integration Guide - Page 273
Multiple Language Support 20 Your system database can contain some elements, such as descriptions and long descriptions, in multiple languages. Publish channels and enterprise services can include receive non-base language data to and from external systems. © Copyright IBM Corp. 2007, 2008 259 - IBM BJ0NJML | Integration Guide - Page 274
structures. Provide the base language values as a service input to object structures that have the L_tablename as part of their object definition. Your service input must be in the core object, and are not available and are processed for the multilanguageenabled fields. 260 Integration Guide - IBM BJ0NJML | Integration Guide - Page 275
Multilanguage Attributes Multilanguage Attributes Service or channel root elements use the following attributes to manage multilanguage processing: The baseLanguage , or if the value does not identify a valid language, an error is returned to the service requester. Multiple Language Support 261 - IBM BJ0NJML | Integration Guide - Page 276
Multilanguage Attributes 262 Integration Guide - IBM BJ0NJML | Integration Guide - Page 277
modules may be available for your use when you own an IBM operational management product. You can access integration modules on the operational operational management product. The operational management product automates a service management process, such as a software deployment. The implementation - IBM BJ0NJML | Integration Guide - Page 278
T The logical management operations that the integration module supports. T The integration module properties that are unique , such as software deployment. Operational management product services are run on assets, such as servers. the IBM® Tivoli® Integration Composer 264 Integration Guide - IBM BJ0NJML | Integration Guide - Page 279
services configured in the integration framework. Logical Management Operations Logical management operations identify the actions that integration modules support Status) T Namespace - The unique qualifier (for example, com.ibm.tivoli.deployment) T Invocation pattern: „ Synchronous - The process - IBM BJ0NJML | Integration Guide - Page 280
The match must occur when you configure the invocation channel to process a response. Operational Management Product Associations The integration module can support multiple logical management operations for an operational management product. When you run the integration module, you pass the logical - IBM BJ0NJML | Integration Guide - Page 281
the logical management operation that is invoked. The name space of the logical management operation that is invoked. The globally unique identifier (GUID) of the operational management product that the integration module uses. The name of the endpoint that the integration module uses to communicate - IBM BJ0NJML | Integration Guide - Page 282
. If the external service is a long-running service, the integration module must service, such as an operational management product service a custom approach to external service invocations. Endpoints contain URL example, an endpoint with a Web service handler has different properties than an - IBM BJ0NJML | Integration Guide - Page 283
that can use one of the available handler protocols. An alternative solution is to write a custom handler that supports the operational management product service protocol. Configure a different endpoint for each operational management product to establish individual protocols for each product. The - IBM BJ0NJML | Integration Guide - Page 284
different logical management operations and operational management products. T Supports the use of another thread to accommodate a long-running service. T Can implement multiple logical management operations, even , such as an endpoint handler, must be coded in the Java class. 270 Integration Guide - IBM BJ0NJML | Integration Guide - Page 285
It requires additional coding to support multiple invocations. T Requires additional coding to support a long-running service. By default, the module Java class in the system class path at run time. The service invoker Java interface has variations of the following method signature: public - IBM BJ0NJML | Integration Guide - Page 286
: String guid = sourceMbo.getString("GUID"); int and a Boolean attribute called HASSUBS. Service invoker methods can take a MboSetRemote related objects, such as planned material or job plans. The objects that are identified in Processing Invocation channels support optional inbound and outbound - IBM BJ0NJML | Integration Guide - Page 287
XML with the MXINTOBJECT object structure to create object structures as part of the installation process. For more information and detailed instructions on adding or modifying object structures, see the online help for the Object Structures application. Integration Module Invocation Integration - IBM BJ0NJML | Integration Guide - Page 288
record identifies which logical management operations are supported on an operational management product. When the configuration items that it uses. Service Utility Methods The integration framework includes a service that provides the following utility methods products. 274 Integration Guide - IBM BJ0NJML | Integration Guide - Page 289
caller. The invocation of the integration module by the caller is the same, regardless of the underlying implementation. getServiceInvoker Property Map The get service invoker utility methods return a map of name and value pairs. The psdi.iface.omp.IMConstants Java interface defines the names of the - IBM BJ0NJML | Integration Guide - Page 290
to the integration module with the mapping that is returned by the get service invoker utility method. The action class provides the logical management operation response object metaData, MboSetRemote sourceMboSet, MboSetRemote targetMboSet, int action, String endPointName) 276 Integration Guide - IBM BJ0NJML | Integration Guide - Page 291
invoker. Property metaData Source object and object set Target object and object set Action Endpointname Description The property map that the get service invoker utility method returns. The object with the input attributes that are defined on the logical management operation. This property can - IBM BJ0NJML | Integration Guide - Page 292
ompGUID, String lmoName, String lmoNamespace, psdi.security.UserInfo userInfo) Retrieves the service invoker for the preferred integration module for the specified operational management product and primary application object, the action class saves and commits the changes. 278 Integration Guide - IBM BJ0NJML | Integration Guide - Page 293
Integration Module Invocation Integration Modules 279 - IBM BJ0NJML | Integration Guide - Page 294
Integration Module Invocation 280 Integration Guide - IBM BJ0NJML | Integration Guide - Page 295
to the external console. You can configure a console URL for any application with a Web-based console, such as the IBM Tivoli Provisioning Manager or the IBM Tivoli Configuration Manager. Additionally, you can configure console URLs for consoles that use Java™ Web Start, such as Tivoli Application - IBM BJ0NJML | Integration Guide - Page 296
a navigation, the external application console must support the landin-context capability. To support context sharing, the land-in-context capability you can pass the name of a view and the globally unique identifier (GUID) of a configuration item to show in the view. If the external application - IBM BJ0NJML | Integration Guide - Page 297
business objects. T Launch entry classification value attributes. The classification value can restrict the displayed launch entries. Multiple business objects support the classification attribute. The classification restriction is implemented at run time when you use system conditions. Out of box - IBM BJ0NJML | Integration Guide - Page 298
attribute in the business object that you are viewing. If you are viewing the configuration item business object, the globally unique identifier (GUID) attribute is used instead. „ Operational management product source token. The source token is an attribute of the configuration item and operational - IBM BJ0NJML | Integration Guide - Page 299
Associating the Launch Entry with a Signature Option Associating the Launch Entry with a Signature Option Before you add a launch point to an application, you must associate the launch entry record with a signature option. To associate the launch entry with a signature option: 1 Open the - IBM BJ0NJML | Integration Guide - Page 300
to grant user and group access privileges to the new launch entry menu item. For more detailed instructions about granting access privileges to the menu item, refer to the online help in the Security Groups . Launch entry menu items can also be hidden when the operational 286 Integration Guide - IBM BJ0NJML | Integration Guide - Page 301
Associating a Condition with a Signature Option management product that is configured on the launch entry does not manage the configuration item. This condition applies to launch entries that you associate with a configuration item object or actual configuration item object. You can configure a - IBM BJ0NJML | Integration Guide - Page 302
Associating a Condition with a Signature Option 288 Integration Guide - IBM BJ0NJML | Integration Guide - Page 303
does not specify any value in this field, and processing of enterprise services proceed as per standard system functionality. Format of Collaboration Switches Collaboration switches provide blanket PO release, and the update of a physical inventory count. © Copyright IBM Corp. 2007, 2008 289 - IBM BJ0NJML | Integration Guide - Page 304
default collaboration switches, with different combinations of system ID values for each process control ID. Authorized users can create additional switches as needed. 290 Integration Guide - IBM BJ0NJML | Integration Guide - Page 305
Collaboration Switch Retrieval The default switches use various combinations of the following values in the System ID 1 and System ID 2 fields: System ID Value THISMX EXT Meaning The system identified in MAXVARS.MXSYSID The collaboration switches do not use the actual value in MXSYSID. Any system - IBM BJ0NJML | Integration Guide - Page 306
pcid, owner1sysid, owner2sysid; To display a short description of the process control IDs, use the following SQL query: select * from mxcollabref order by pcid; 292 Integration Guide - IBM BJ0NJML | Integration Guide - Page 307
Collaboration Switch Modification Collaboration Switch Modification Authorized users can use any database tool to modify the process control value of a collaboration switch. Do not change the value of PCID, OWNER1SYSID, or OWNER2SYSID on existing collaboration switches. To change the process - IBM BJ0NJML | Integration Guide - Page 308
perform the processing described in steps 3, 4 and 5, use the following SQL statement: insert into mxcollab (pcid, owner1sysid, owner2sysid, pcvalue) values ('INV', 'ORC', 'THISMX', 0); 294 Integration Guide - IBM BJ0NJML | Integration Guide - Page 309
Collaboration Switch Additions After you perform this procedure, the INV collaboration switches will have the following values. Process Control ID System ID 1 INV THISMX INV EXT INV EXT INV ORC System ID 2 EXT THISMX EXT THISMX Process Control Value 1 1 1 0 For example, when you set the - IBM BJ0NJML | Integration Guide - Page 310
exist on related open PRs, POs, RFQs, work orders, and so on. This might result in problems receiving/approving these lines. Enter item issues. 0 Used when issuing material. 1 Enter item issue returns System ID 2 INVENTORY INVENTORY INVENTORY INVENTORY WORKORDER INVENTORY 296 Integration Guide - IBM BJ0NJML | Integration Guide - Page 311
: If value is 1, the item will still exist on related open PRs, POs, RFQs, work orders, and so on. This might result in problems receiving/approving these lines. Do not update INVBALANCES in the From storeroom. Delete item if it passes normal system validations. "THISMX" Delete item without any - IBM BJ0NJML | Integration Guide - Page 312
that do not have a PO reference. Do not generate a service receipt for the invoice lines that do not have a PO reference. Derivation of System ID 1 INVOICE INVOICE "THISMX" INVOICE "THISMX" "THISMX" Derivation of System ID 2 INVENTORY INVENTORY INVOICE PO INVOICE INVOICE 298 Integration Guide - IBM BJ0NJML | Integration Guide - Page 313
Collaboration Switches Process Control ID IVRCY IVTOL IVVLC IVWO Description Value and Action Create service receipts for invoice lines with a 0 PO reference and RECEIPTREQD = N. Generate a service receipt for the invoice line. Derivation of System ID 1 INVOICE Used when approving invoices - IBM BJ0NJML | Integration Guide - Page 314
Transaction Collaboration Switches Labor Transaction Collaboration Switches Process Control ID LTSRC Description Generate service receipts for POs. Used when creating labor transactions or changing status. PO Derivation of System ID 2 PO LOCATIONS, where vendor is the storeroom Integration Guide - IBM BJ0NJML | Integration Guide - Page 315
Purchase Order Collaboration Switches Process Control ID POIVM POPR POREL PORES Description Create inventory vendor information for inventory. Used when approving POs. Update status of PRs. Used when copying PR lines to POs, creating POs from PRs, reopening PRs. Value and Action 0 Update or - IBM BJ0NJML | Integration Guide - Page 316
standard validation for the location. Derivation of System ID 1 "THISMX" PR Derivation of System ID 2 PR LOCATIONS, where vendor is the internal storeroom 302 Integration Guide - IBM BJ0NJML | Integration Guide - Page 317
Purchase Requisition Collaboration Switches Process Control ID PRPAB Description Value and Action Do not allow unreferenced external purchase 0 agreements / blankets. Used when adding or updating PR lines and changing the status of PRs. 1 If PRLINE.AGREEMENTPONUM is not in PO, error. If - IBM BJ0NJML | Integration Guide - Page 318
. Update work order. Do not update work order. MATRECTRANS or SERVRECTRANS Derivation of System ID 2 PO INVENTORY INVENTORY PO PO PO INVVENDOR WORKORDER 304 Integration Guide - IBM BJ0NJML | Integration Guide - Page 319
Work Order Collaboration Switches Process Control ID WORES Description Process material reservations. Used when changing the status of a work order. Inventory must exist in this system. Value and Action 0 Generate inventory reservation. 1 Do not generate inventory reservation. Work Order - IBM BJ0NJML | Integration Guide - Page 320
Work Order Collaboration Switches 306 Integration Guide - IBM BJ0NJML | Integration Guide - Page 321
right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not - IBM BJ0NJML | Integration Guide - Page 322
one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Corporation 2Z4A/101 11400 Burnet Road Austin, TX 78758 U.S.A. Such information may be available, subject softcopy, the photographs and color illustrations may not appear. 308 Integration Guide - IBM BJ0NJML | Integration Guide - Page 323
The following terms are trademarks of International Business Machines Corporation in the United States, other countries, or both: IBM AIX DB2 developerWorks Everyplace ibm.com Lotus Maximo Notes QuickPlace Tivoli WebSphere Adobe, the Adobe logo, PostScript, and the PostScript logo are either - IBM BJ0NJML | Integration Guide - Page 324
310 Integration Guide - IBM BJ0NJML | Integration Guide - Page 325
controls 210 business object user exit processing customization 228 © Copyright IBM Corp. 2007, 2008 Index C channels create 235 invocation 235 inbound message receipt 195 enterprise beans 196 HTTP servlet 196 web services 196 JMS queues 189 message processing servers 195 WebLogic continuous queue - IBM BJ0NJML | Integration Guide - Page 326
146 METHODNAME property 146 PROVIDEURL property 146 USERNAME, PASSWORD property 147 enterprise services configuring 137 data exchange 11 integration controls 234 interface tables 234 object structure HASLD column 100 HTTP handler 219 CONNECTTIMEOUT property 150 definition 148 Integration Guide - IBM BJ0NJML | Integration Guide - Page 327
fields 77 metadata schema 79 namespace property 78 object schemas 84 object structure schemas 82 schema directory and files 79 schema generation 78 service level schemas 86 xml validation 78 integration xml content root element 63 interface queue tables 96 interface tables ACTION column 103 alias - IBM BJ0NJML | Integration Guide - Page 328
68 glorder attribute 68 langenabled attribute 69 maxvalue attribute 70 field comparison 245 field selection 246 key fields 67 range selection 247 object structure services object structure 234 object structure processing 234 object structures alternate keys 231 build 230 configuring 137 Integration - IBM BJ0NJML | Integration Guide - Page 329
servlet 181 integration queue 178 interface tables 185 object-level authorization 185 outbound router handler 185 remote integration APIs 184 web services 183 selectors, cron task 160 sequential queues cron task parameters 165 definition 165 overview 163 WebLogic cluster 194 WebSphere cluster 192 - IBM BJ0NJML | Integration Guide - Page 330
interface integration land in context 16 launch entries 15 V value controls 210 W web services customization 221 data exchange 12 deployment actions 253 enterprise 234 invocations 256 object structure 234 parameters 133 processing properties 134 XSL mapping customization 218, 227 Integration Guide
-
1 -
2 -
3 -
4 -
5 -
6 -
7 -
8
-
9
-
10
-
11
-
12
-
13
-
14
-
15
-
16
-
17
-
18
-
19
-
20
-
21
-
22
-
23
-
24
-
25
-
26
-
27
-
28
-
29
-
30
-
31
-
32
-
33
-
34
-
35
-
36
-
37
-
38
-
39
-
40
-
41
-
42
-
43
-
44
-
45
-
46
-
47
-
48
-
49
-
50
-
51
-
52
-
53
-
54
-
55
-
56
-
57
-
58
-
59
-
60
-
61
-
62
-
63
-
64
-
65
-
66
-
67
-
68
-
69
-
70
-
71
-
72
-
73
-
74
-
75
-
76
-
77
-
78
-
79
-
80
-
81
-
82
-
83
-
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
-
94
-
95
-
96
-
97
-
98
-
99
-
100
-
101
-
102
-
103
-
104
-
105
-
106
-
107
-
108
-
109
-
110
-
111
-
112
-
113
-
114
-
115
-
116
-
117
-
118
-
119
-
120
-
121
-
122
-
123
-
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
-
132
-
133
-
134
-
135
-
136
-
137
-
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
-
152
-
153
-
154
-
155
-
156
-
157
-
158
-
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
-
174
-
175
-
176
-
177
-
178
-
179
-
180
-
181
-
182
-
183
-
184
-
185
-
186
-
187
-
188
-
189
-
190
-
191
-
192
-
193
-
194
-
195
-
196
-
197
-
198
-
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
-
209
-
210
-
211
-
212
-
213
-
214
-
215
-
216
-
217
-
218
-
219
-
220
-
221
-
222
-
223
-
224
-
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
-
233
-
234
-
235
-
236
-
237
-
238
-
239
-
240
-
241
-
242
-
243
-
244
-
245
-
246
-
247
-
248
-
249
-
250
-
251
-
252
-
253
-
254
-
255
-
256
-
257
-
258
-
259
-
260
-
261
-
262
-
263
-
264
-
265
-
266
-
267
-
268
-
269
-
270
-
271
-
272
-
273
-
274
-
275
-
276
-
277
-
278
-
279
-
280
-
281
-
282
-
283
-
284
-
285
-
286
-
287
-
288
-
289
-
290
-
291
-
292
-
293
-
294
-
295
-
296
-
297
-
298
-
299
-
300
-
301
-
302
-
303
-
304
-
305
-
306
-
307
-
308
-
309
-
310
-
311
-
312
-
313
-
314
-
315
-
316
-
317
-
318
-
319
-
320
-
321
-
322
-
323
-
324
-
325
-
326
-
327
-
328
-
329
-
330
 |
 |
Integration Guide
IBM Maximo Asset Management 7.1
IBM Tivoli Asset Management for IT 7.1
IBM Tivoli Change and Configuration Management Database 7.1.1
IBM Tivoli Service Request Manager 7.1