Teradata JMS Universal Connector. User Guide

Transcription

1 Teradata JMS Universal Connector User Guide B A January 2011

2 The product or products described in this book are licensed products of Teradata Corporation or its affiliates. Any person is hereby authorized to view, copy, print, and distribute this document subject to the following conditions: The document may be used for informational purposes only. The document may only be used for non-commercial purposes. Any copy of this document or portion thereof must include this copyright notice. Note that any product, process or technology described in the document may be the subject of other Intellectual Property rights reserved by Teradata and are not licensed hereunder. Use, duplication or disclosure by the United States government is subject to the restrictions set forth in DFARS (c) (1) (ii) and FAR Other brand and product names used herein are for identification purposes only and may be trademarks of their respective companies. Copyright by Teradata Corporation. All Rights Reserved

3 Table of Contents Administration UI...5 Overview... 5 Starting the Administration UI...5 Loader Management... 7 Create Service [Single Operation]... 7 Create Service [Multiple Operation]... 8 Starting and Stopping a Service Copy Service Manage Properties Manage Properties - Single Manage Properties - Multiple Extractor Management...16 Create Service Starting and Stopping a Service Copy Service Manage Properties Error Log View Error Log Environment Variables...22 Overview Manage Environment Variables Application Version [View only] Log Level Log Directory Log File Size Log File Count...23 Error File Path Maximum Retries Loader Receive Timeout Loader Pulling Interval Extractor

4 Query Timout...26 Extractor Pulling Interval System Administration...27 Upgrade from Previous Versions Status table Message Format...28 Extractor Service Template with a default namespace Template without a default namespace Examples Multiple Operation Loader Service Example Single Operation Loader Service Variable Fixed XML Special Attributes in the XML message format nil = {true/false} null = {true/false}

5 Administration UI Overview Once the EAR or WAR has been successfully deployed and configured on your Application Server, as described in the Teradata JMS Universal Connector Installationl Guide, you can use the Administration UI. This tool can be used to accomplish various administrative tasks forjms Universal Connector. These tasks include: Managing services and properties Managing the Environment Variables Monitor status and errors of services Starting the Administration UI To start the Administration UI, navigate to the following Root URL: HOST_NAME:PORT/terajmsa/Admin HOST_NAME: The host name of your Application Server. PORT: The port number for your Application Server. You should see the following web page: 5

6 Figure 1: Logon page At the logon page, enter a Teradata User name and password. 6

7 You should see the following web page: Figure 2: Home page Loader Management Create Service [Single Operation] On the left navigation under [Loader] click on [Create Services]. Enter a unique Service ID. Enter the JNDI name for the Source JMS queue or topic. For example, jmsqueues/default/myqueue. Enter the Source JMS Connection Factory name. For example, jmsfactory/default/myqcf. Select the source type: Queue, Durable Topic, or Non-Durable Topic Enter the Target Teradata Table name. For example, MYTABLE. Enter the Target Connection Datasource name. For example, jdbc/mydatasource. Select Service Type: Single, Multiple Select Rollback invalid format message to Queue/Topic: true, false Select Format: VARIABLE, FIXED, XML Enter Delimiter: Any text (that is,, Click on the [Create] button 7

8 Figure 3: Create Service - Single Create Service [Multiple Operation] On the left navigation under [Loader] click on [Create Services]. Enter a unique Service ID. Enter the JNDI name for the Source JMS queue or topic. For example, jmsqueues/default/myqueue. Enter the Source JMS Connection Factory name. For example, jmsfactory/default/myqcf. Select the source type: Queue, Durable Topic, or Non-Durable Topic Enter the Target Teradata Table name. For example, MYTABLE. 8

9 Enter the Target Connection Datasource name. For example, jdbc/mydatasource. Select Service Type: Single, Multiple Select Rollback invalid format message to Queue/Topic: true, false Note that the Format is only supported for XML Click on the [Create] button Figure 4: Create Service - Multiple 9

10 Starting and Stopping a Service On the left navigation under [Loader] click on [Display Services]. You should see a list of services along with the status (started or stopped) To start a service, click on [Start] under [Action] Figure 5: Starting and stopping a service Copy Service On the left navigation under [Loader] click on [Copy Service]. Select a service from the [Copy From] list. Enter a new Service ID in [Copy To] edit box. Click on [Copy] button. 10

11 Figure 6: Copy Service Manage Properties On the left navigation under [Loader] click on [Manage Properties]. A list of available services appears in the right pane. To edit the properties for a service, click on [Edit] for the service. 11

12 Figure 7: Display Properties 12

13 Manage Properties - Single Select [Rollback invalid format message to Queue/Topic] from the drop-down list. Possible value is false, true. Select [Format] from the drop-down list. Possible Format types are VARIABLE, FIXED, XML. Select [Action] from the drop-down list. Possible Action is INSERT, UPDATE, DELETE, and UPSERT. Enter a [Delimiter]. The Delimiter is only applicable for Format type XML. Select the columns JMS Universal Connector will insert data into. Click on the [->] button. Click on the [Modify] button to save changes. Figure 8: Manage Properties - Single Manage Properties - Multiple Enter Operation Name that will be used for Multiple Operation Click Modify button to modify the properties in next UI Click Remove button to remove the properties Select [Rollback invalid format message to Queue/Topic] from the drop down list. Possible value is false, true. 13

14 Click Modify button on the Service Attributes to apply [Rollback invalid format message to Queue/Topic] to all operations. Format will be displayed as read-only. Multiple Operation only supports XML. Figure 9: Manage Properties - Multiple Rollback invalid format message to Queue/Topic will be displayed as read-only. Format will be displayed as read-only. Multiple Operation only supports XML. Select [Action] from the drop-down list. Possible Action is INSERT, UPDATE, DELETE, and UPSERT. Select the columns JMS Universal Connector will insert data into. Click on the [->] button. Click on the [Modify] button to save changes. 14

15 Figure 10: Manage Properties - Multiple 15

16 Extractor Management Create Service On the left navigation under [Extractor] click [Create Services]. Enter a unique Service ID. Enter the Source Teradata Queue Table name. For example, MYQUEUETABLE. Enter the Source Connection Datasource name. For example, jdbc/mydatasource. Enter the JNDI name for the Target JMS queue or topic. For example, jmsqueues/default/myqueue. Enter the Target JMS Connection Factory name. For example, jmsfactory/default/myqcf. Select the Target Type: Queue, or Topic. Click the [Create] button Figure 11: Create Service 16

17 Starting and Stopping a Service On the left navigation under [Extractor] click [Display Services]. You should see a list of services along with the status (started or stopped) To start a service, click [Start] under [Action] Figure 12: Display Services 17

18 Copy Service On the left navigation under [Extractor] click [Copy Service]. Select a service from the [Copy From] list. Enter a new Service ID in [Copy To] edit box. Click [Copy] button. Figure 13: Copy Service 18

19 Manage Properties On the left navigation under [Extractor] click [Manage Properties]. You should see a list of services. To edit the properties for a service, click [Edit] for the service. Figure 14: Display Properties 19

20 Select the columns that JMS Universal Connector will query data from for the message payload. Select [Column contains XML] = [true or false] to make the Extractor treat the column value as xml or not. Enter a [Name Space]. If the value is specified, the value of the default namespace will be set in the XML message. Enter a [Delivery Mode]. The delivery mode in the JMS. 1 indicates non-persistent and 2 indicates persistent. Enter a [Priority]. The JMS defines ten levels of priority value, with 0 as the lowest priority and 9 as the highest. In addition, clients should consider priorities 0-4 as gradations of normal priority and priorities 5-9 as gradations of expedited priority. Enter a [Time to Live]. Specify how long the message will last in the queue. The value 0 represents unlimited. Enter [Rows per Message]. The number of table rows used to construct one JMS message payload. Note: Only 1 row per message is allowed. If applicable, add message properties using [Add Property]. Click on the [Modify] button to save changes. Figure 15: Create Properties 20

21 Error Log View Error Log On the left navigation under [Loader] or [Extractor], click [Display Services]. Click [View] in the right pane. If ErrorFile is displayed with empty, the message or record was rolled back to its source (jms queue/topic or TD queue table) If ErrorFile is displayed with a number, the message is moved to the error file with the displayed number as its name (for example, xml). Note: This is only for the Loader; the Extractor will not create the error file (it will always roll back). Figure 16: Error Log View 21

22 Environment Variables Overview All of the following environment variables are managed within the Administration UI. These variables are stored persistently in the TERAJMS_VARIABLES table. This table will reside in the default database specified in the default DataSource. This table does not need to be created manually. Manage Environment Variables Off the main screen of the Administration UI click [Environmental Variables]. This will bring up a screen of all the current environment variables. From here you can click either the [View] or [Edit] link next to the Environment Variable. Application Version [View only] Variable Name: version Type: java.lang.string Description: Repository version information of Teradata JMS Universal Connector. Log Level Variable Name: loggerlevel Type: java.lang.string Default: INFO Valid values: {DEBUG, INFO, WARN, ERROR} Description: Log level across all logging within JMS Universal Connector. Valid values are DEBUG, INFO, WARN, and ERROR, where ERROR is the most strict logging level followed by WARN, INFO, and DEBUG. 22

23 Log Directory Variable Name: logdir Type: java.lang.string Default: NULL Description: The file system directory that stores the log files generated by the JMS Universal Connector. Note: The application should be restarted to take effect. Default: null. Log File Size Log File Count Variable Name: logfilesize Type: java.lang.integer Default: 0 Valid values: { } Description: Maximum size of log file in Kilobytes. Value 0 sets the log file size to unlimited. Note: The application should be restarted for changes to take effect. Valid values: { }. Default: 0. Variable Name: logfilecount Type: java.lang.integer Default: 1 Valid values: { } Description: Rotation count of log files. Note: The application should be restarted for changes to take effect. Valid values: { }. Default: 1. 23

24 Error File Path Maximum Retries Variable Name: errorfilepath Type: java.lang.string Default: null Description: The file system directory where the invalid message is stored when the [Rollback invalid format message to Queue/Topic = false]. One file is generated for each invalid message which contains the whole jms message with error reasons. The file name can be traced in the Error log View of Display Service function. Default: null. Variable Name: maxretries Type: java.lang.integer Default: 10 Valid values: {1-1000} Description: Maximum number of system errors allowed. When a service reaches the maximum number of system errors allowed, the service will shut down. System errors do not include data-related errors. All services must be restarted for changes to take effect. Note: [The maxretries count is calculated for each service. If a service encountered 2 errors and each error is caused by same or different reason, the current error count for the service is 2. Also, if one message had a problem and is rolled back to the source queue when maxretries is set to 10, the service will continue until it reaches maxretries=10, then the service will be stopped.] Note: Note: [Exception Destination in WebSphere] When you create a queue or topic in WebSphere, System is selected with Maximum failed deliveries=5 by default in Exception Destination in Service Integration > Buses > [your_bus_name] > Destinations > [your_queue_or_topic_name]. You will see 3 values ( None, System, Specify ) in the Exception Destination option. This value selected determines where a message will be routed to by the JMS provider when the message is rolled back by the JMS Universal Connector. [Redelivery Limit in WebLogic] When you create a queue or topic in WebLogic, Redelivery Limit=-1 will be set by default in Home > JMS Modules > [your_jms_module_name] > [your_ queue_or_topic_name] > Delivery Failure. Redelivery Limit: The number of redelivery tries a message can have before it is moved to the error destination. This setting overrides any redelivery limit set by the message sender. If the redelivery limit is configured, but no error destination is configured, then persistent and non-persistent messages are simply dropped (deleted) when they reach their redelivery limit. 24

25 Error Destination: The name of the target error destination for messages that have expired or reached their redelivery limit. If no error destination is configured, then such messages are simply dropped. If a message has expired or reached its redelivery limit, and the Expiration Policy is set to Redirect, then the message is moved to the specified Error Destination. Note: Note: Note: [NetWeaver] There is no set-up required for exception destination in NetWeaver. By default, NetWeaver behaves as None in WebSphere or Redelivery limit=-1 in WebLogic. [ActiveMQ] There is no set-up required for exception destination for ActiveMQ. Please refer to deadletterstrategy in ActiveMQ. By default, ActiveMQ behaves as None in WebSphere or Redelivery Limit=-1 in WebLogic. [IBM WebSphere MQ] There is no set-up required for exception destination in IBM WebSphere MQ. By default, IBM WebSphere MQ behaves as None in WebSphere or Redelivery Limit=-1 in WebLogic. Loader Receive Timeout Variable Name: receivetimeout Type: java.lang.integer Default: 10 Valid values: {1-600} Loader Pulling Interval Description: Maximum number of seconds the Loader will wait on a JMS Queue or Topic. If the maximum number of seconds is reached and the Queue or Topic is still empty, the Loader will stop waiting on the JMS Queue or Topic in order to process outstanding work before attempting to wait on the JMS Queue or Topic. All loader services must be restarted for changes to take effect. Variable Name: loaderpullinginterval Type: java.lang.integer Default: 0 Valid values: {0-600} Description: Wating interval number of seconds the Loader will wait before it retrieves the message from a JMS Queue or Topic. If the number of seconds is 0, the Loader will attempt 25

26 to retrieve a message right after [receivetimeout] expired. if the number of secons is greater than 0, the Loader will wait for the specified number of seconds before it attempts to retrieve the message. All loader services must be restarted for changes to take effect. Valid values: {0-600}. Default: 0. Extractor Query Timout Variable Name: querytimeout Type: java.lang.integer Default: 10 Valid values: {1-600} Extractor Pulling Interval Description: Maximum number of seconds the Router will wait on the Queue Table for more data. If the maximum number of seconds is reached and the Queue Table is still empty, the Router will stop waiting on the Queue Table in order to process outstanding work before attempting to wait on the Queue Table. All router services must be restarted for changes to take effect. Variable Name: extractorpullinginterval Type: java.lang.integer Default: 0 Valid values: {0-600} Description: Maximum number of seconds the Extractor will wait before it retrieves the message from a queue table. If the number of seconds is 0, the Extractor will attempt to retrieve a record right after [querytimeout] expired. if the number of seconds is greater than 0, the Extractor will wait for the specified number of seconds before it attempts to retrieve a message. All extractor services must be restarted for changes to take effect. Valid values: {0-600}. Default: 0. 26

27 System Administration Upgrade from Previous Versions This release works with the services created from previous releases. In other words, you do not need to create a new database point with the jdbc/com.teradata.terajmsa.metads data source. This release provides new features/properties for the loader and extractor services. For a service created in the previous release, these new service features will not have any value assigned and the system will perform the default behavior. It is recommended to go over all services and specify the values for these new features by clicking the Modify button in the Manage Properties page. These new features for this release include Rollback invalid format message to Queue/Topic in the Loader, and Column contains XML and Name Space in the Extractor. The TERAJMS_ERRORS table will be deprecated and will not be removed from past installations. The new TERAJMS_STATUS table will be created. During the upgrade, new environment variable version is inserted into the TERAJMS_VARIABLES table and displayed on the Administration UI. During the upgrade, the old environment variable maxbatchsize will remain in the TERAJMS_VARIABLES table but it is not displayed on the Administration UI. Status table A new TERAJMS_STATUS table is created when the JMS Universal Connector is deployed. This table contains all the Loader and Extractor activities including successful and failed transactions. Thus, this table will continually grow while the service is running. The Administration UI only shows failed transactions. System Administrator should clean up the TERAJMS_STATUS table regularly. 27

28 Message Format Extractor Service The extractor service generates XML messages which contain the database records. Depending on whether you have the default namespace specified or not, the message templates look like the following: Template with a default namespace <?xml version="1.0" encoding="utf-8"?> <Message type="terajmsa" xmlns="{uri specified in the extractor}" > <records> {Database row}+ </records> </Message> Template without a default namespace <?xml version="1.0" encoding="utf-8"? > <Message type="terajmsa"> <records> {Database row}+ </records> </Message> {Database row}+ represents one to many {Database row}. In each {Database row}, the XML fragment is the following: <row> </row> <{name of the column 1}>{data of the column 1}</{name of the column 1}> <{name of the column 2}>{data of the column 2}</{name of the column 2}>... Examples The table columns = qits, f1, f2, f3, f4 The columns to be extracted = f2, f3 qits f1 f2 f3 f :12:

29 No default namespace Specified <?xml version="1.0" encoding="utf-8"?> <Message type="terajmsa"> <records> <row> <f2>222</f2> <f3>333</f3> </row> </records> </Message> Default namespace defined Default namespace = <?xml version="1.0" encoding="utf-8"?> <Message type="terajmsa" xmlns=" > <records> <row> <f2>222</f2> <f3>333</f3> </row> </records> </Message> Multiple Operation Loader Service This service only supports the XML format and the message template is as follows: <?xml version="1.0" encoding="utf-8"?> <Message type="terajmsa"> {Operation}+ </Message> {Operation}+ represents one to many {Operation}. Each {Operation} is represented with the following XML template: <Operation name = {Operation Name} > {Parameter element}+ </Operation> {Operation Name} is the name of the operation you specified in the loader service. {Parameter element}+ represents one to many {Parameter element}. Each {Parameter element} and its order corresponds to the parameter shown in the SQL definition for this operation. The XML fragment for the {Parameter element} is the following: <{name of the column}>{data of the column}</{name of the column}> For example, consider the following insert_op_1 operaton case: 29

30 The above SQL statement for this operation requires three parameters (f1, f2 and f3) with values represented here by?, which need to be replaced with the desired values. Therefore, the list of the {Parameter element} are the following: <f1> </f1> <f2> </f2> <f3> <f3> 30

31 Example XML Insert Payload: <?xml version="1.0" encoding="utf-8"?> <Message type="terajmsa"> <Operation name = "insert_op_1"> <f1>111</f1> <f3>333</f3> </Operation> </Message> Results with an insert of 2 records with f1=111 and f2=null and f3=333 31

32 XML - Update Payload: <?xml version="1.0" encoding="utf-8"?> <Message type="terajmsa"> <Operation name = "MyUpdateOp"> <f1>1xx</f1> <f2>2xx</f2> <f3>3xx</f3> <f1>111</f1> <f3>333</f3> </Operation> </Message> Results in the update of all records Setting f1=1xx f2=2xx f3=3xx Where f1=111 and f3=333 32

33 XML - Upsert Payload: <?xml version="1.0" encoding="utf-8"?> <Message type="terajmsa"> <Operation name = "MyUpsertOp"> <f2>2xx</f2> <f1>111</f1> <f3>333</f3> <f1>111</f1> <f2>222</f2> <f3>333</f3> </Operation> </Message> 33

34 Results in the update of all records Setting to f2=2xx Where f1=111 and f3=333 If there's no match with the where condition then insert 1 record With f1=111 and f2=222 and f3=333 XML - Delete <?xml version="1.0" encoding="utf-8"?> <Message type="terajmsa"> <Operation name = "MyDeleteOp"> <f1>111</f1> <f2>222</f2> <f3>333</f3> </Operation> </Message> Results in the deletion of all records Where (f1=111 and f2=222 and f3=333) 34

35 Single Operation Loader Service This service supports three types of message formats: Variable The database columns and the next records are separated by a delimiter. Examples Insert Operation Format = Variable Delimiter = (,) DML type = Insert Columns for Insert = f1, f2, f3 Payload: 111,222,333,444,555,666 Results with an insert of 2 record with f1=111 f2=222 f3=333 f1=444 f2=555 f3=666 Update Operation Format = Variable Delimiter = (,) DML type = Update Columns for Update = f1, f2, f3 Columns in Where clause = f1, f2, f3 Payload: 1xx,2xx,3xx,111,222,333 Results in the update of all records Setting f1=1xx f2=2xx f3=3xx Where f1=111 and f2=222 and f3=333 Upsert Operation Format = Variable Delimiter = (,) DML type = Upsert Columns for Update = f2 Columns in Where Clause = f1, f3 Columns for Insert = f1, f2, f3 Payload: 2xx,111,333,111,222,333 Results in the update of all records Setting f2=2xx Where f1=111 and f3=333 If there's no match with the where condition then insert 1 record with f1=111 f2=222 f3=333 Delete Operation Format = Variable Delimiter = (,) DML type = Delete Columns in Where Clause = f1, f2, f3 35

36 Payload: 111,222,333 Results in the deletion of all records Where f1=111 and f2=222 and f3=333 Fixed The width of each data element in the message is equal to the size of the corresponding database column. Examples: Insert Operation Format = Fixed DML type = Insert Columns for Insert = f1, f2, f3 Payload: Results with an insert of 1 record with f1= f2= f3= Update Operation Format = Fixed DML type = Update Columns for Update = f1, f2, f3 Columns in Where Clause = f1, f2, f3 Payload: 1xxxxxxxxx2xxxxxxxxx3xxxxxxxxx Results in the update of all records to (f1=1xxxxxxxxx f2=2xxxxxxxxx f3=3xxxxxxxxx) where (f1= f2= f3= ) 36

37 Upsert Operation Format = Fixed DML type = Upsert Columns for Update = f2 Columns in Where Clause = f1, f3 Columns for Insert = f1, f2, f3 Payload: "2xxxxxxxxx " Results in the update of all records Setting f2=2xxxxxxxxx Where f1=empty string and f3=empty string If there's no match with the where condition then insert 1 record with f1=10 spaces and f2= and f3=10 spaces Delete Operation Format = Fixed DML type = Delete Columns in Where Clause = f1, f2, f3 Payload: Results in the deletion of all records Where f1=111 and f2=222 and f3=333 XML Insert Operation The XML message template for the insert operation is the following: <?xml version="1.0" encoding="utf-8"? > <Message type="terajmsa"> <records> {Database row}+ </records> </Message> {Database row}+ represents one to many {Database row}. In each {Database row}, the XML fragment is the following: <row> </row> <{name of the column 1}>{data of the column 1}</{name of the column 1}> <{name of the column 2}>{data of the column 2}</{name of the column 2}>... Example Format = XML DML type = Insert Columns for Insert = f1, f3 Payload: <?xml version="1.0" encoding="utf-8"?> <Message type="terajmsa"> <records> 37

38 <row> <f1>111</f1> <f2>222</f2> <f3>333</f3> </row> <row> <f1>111</f1> <f2>222</f2> <f3>333</f3> </row> </records> </Message> Results with an insert of 2 records with f1=111 and f2=null and f3=333 Update Operation The XML message template for the insert operation is the following: <?xml version="1.0" encoding="utf-8"? > <Message type="terajmsa"> <records> {Update Command}+ </records> </Message> {Update Command}+ represents one to many {Update Command}. In each {Update Command}, the XML fragment is the following: <row> </row> {Update Cluse} {Where Clause} The XML fragment of {Update Clause} is the following: <update> <{name of the column 1}>{data of the column 1}</{name of the column 1}> <{name of the column 2}>{data of the column 2}</{name of the column 2}>... </update> The XML fragment of {Where Clause} is the following: <where> <{name of the column 1}>{data of the column 1}</{name of the column 1}> <{name of the column 2}>{data of the column 2}</{name of the column 2}>... </where> Example Format = XML DML type = Update Columns for Update = f1, f2, f3 Columns in Where Clause = f1, f2, f3 Payload: 38

39 <?xml version="1.0" encoding="utf-8"?> <Message type="terajmsa"> <records> <row> <update> <f1>1xx</f1> <f2>2xx</f2> <f3>3xx</f3> </update> <where> <f1>111</f1> <f2>222</f2> <f3>333</f3> </where> </row> </records> </Message> Results in the update of all records Setting f1=1xx f2=2xx f3=3xx Where f1=111 and f2=222 and f3=333 Upsert Operation The XML message template for the insert operation is the following: <?xml version="1.0" encoding="utf-8"? > <Message type="terajmsa"> <records> {Upsert Command}+ </records> </Message> {Upsert Command}+ represents one to many {Upsert Command}. In each {Upsert Command}, the XML fragment is the following: <row> </row> {Update Cluse} {Where Clause} {Insert Clause} The XML fragment of {Update Clause} is the following: <update> <{name of the column 1}>{data of the column 1}</{name of the column 1}> <{name of the column 2}>{data of the column 2}</{name of the column 2}>... </update> The XML fragment of {Where Clause} is the following: <where> <{name of the column 1}>{data of the column 1}</{name of the column 1}> <{name of the column 2}>{data of the column 2}</{name of the column 2}>... </where> 39

40 The XML fragment of {Insert Clause} is the following: <where> <{name of the column 1}>{data of the column 1}</{name of the column 1}> <{name of the column 2}>{data of the column 2}</{name of the column 2}>... </where> Example Format = XML DML type = Upsert Columns for Update = f2 Columns in Where Clause= f1, f3 Columns for Insert = f1, f2, f3 Payload: <?xml version="1.0" encoding="utf-8"?> <Message type="terajmsa"> <records> <row> <update> <f2>2xx</f2> </update> <where> <f1>111</f1> <f3>333</f3> </where> <insert> <f1>111</f1> <f2>222</f2> <f3>333</f3> </insert> </row> </records> </Message> Results in the update of all records Setting to f2=2xx Where f1=111 and f3=333 If there's no match with the where condition then insert 1 record With f1=111 and f2=222 and f3=333 Delete Operation The XML message template for the insert operation is the following: <?xml version="1.0" encoding="utf-8"? > <Message type="terajmsa"> <records> {Where AND-Condition}+ </records> </Message> { Where AND-Condition }+ represents one to many { Where AND-Condition }. 40

41 The {Where AND-Condition } represents the logical AND condition among the database columns and the XML fragment is the following: <row> </row> <{name of the column 1}>{data of the column 1}</{name of the column 1}> <{name of the column 2}>{data of the column 2}</{name of the column 2}>... The logical operator among multiple {Where AND-Condition} is OR logical operation. Example Format = XML DML type = Delete Columns in Where Clause = f1, f2, f3 Payload: <?xml version="1.0" encoding="utf-8"?> <Message type="terajmsa"> <records> <row> <f1>a</f1> <f2 null='false'>b</f2> <f3>c</f3> </row> <row> <f1>111_1</f1> <f2 null="true">222</f2> <f3>333_1</f3> </row> </records> </Message> Results in the deletion of all records Where (f1=a and f2=b and f3=c) or Where (f1=111_1 f2 is null and f3=333_1) Special Attributes in the XML message format nil = {true/false} This attribute can be applied to the database column name tag for both single operation loader services and multiple operation loader services. This attribute is used to indicate whether the value represents a null or empty value for the database column. This attribute has the same definition as the nil attribute of XML Schema. nil =true means that this element does NOT have value nil= false means that this element has value The following is a message of the insert operation for the single operation loader service: <?xml version="1.0" encoding="utf-8"?> <Message type="terajmsa"> <records> 41

42 <row> </row> </records> </Message> The result: F1 = null F2 = (Empty String) F3 is Invalid F4 = test <f1 nil="true"></f1> <f2 nil="false"></f1> <f3 nil="true">test</f2> <f4 nil="false">test</f3> null = {true/false} This attribute can be applied to the database column name tag only for single operation loader services. This attribute was designed to handle the same situation as the nil attribute; however, its implementation has caused some confusion depending on whether the data contains the value or not. This attribute is deprecrated and may not be supported in the future versions. The following is an example showing the different scenarios: <?xml version="1.0" encoding="utf-8"?> <Message type="terajmsa"> <records> <row> <f1 null ="true"></f1> <f2 null ="false"></f1> <f3 null ="true">test</f2> <f4 null ="false">test</f3> </row> </records> </Message> The result: F1 = null F2 = (Empty String) F3 = (Empty String) F4 = test 42