IBM BJ0NJML Integration Guide - Page 85

Add action, Delete action, Value, Description

Page 85 highlights

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 message and the processing that they require of the receiving system. An action attribute at the primary object level specifies the overall processing action that applies to the parent and child records. At the child object level, it indicates processing that is specific to that record. Business rules always take precedence over the action attribute. If business rules prohibit the action that is specified on an inbound XML message, an error occurs. For example, an inbound transaction that attempts to update a closed PO will result in an error. If a single XML document contains multiple instances of an object structure, each instance of the object structure can specify a different action attribute. In the following example, the COMPANIES record has multiple child COMPCONTACT records, each with its own action attribute. TEST4 test 100 Main Str SMITH MANAGER JONES ENGINEER An add action indicates that the corresponding data is added to a database. For inbound transactions, an error occurs if the data exists. The add action on a primary object extends to its child objects, so it is not necessary to specify the add action at the child object level. Outbound transactions contain an add action when the insert of an object generates the transaction. A delete action indicates that the corresponding object and its child objects are deleted from the database. The delete action on a primary object extends to its child objects, so it is not necessary to specify the delete action at the child object level. An outbound XML message with a delete action on the primary object may not include the child objects, but the receiving system is responsible for identifying and deleting them. When a primary object in an inbound XML message contains the delete action, the integration framework deletes the child objects that are related to the primary Integration XML and Schemas 71

  • 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

Object Structure Element
Integration XML and Schemas
71
The Change, Replace, and AddChange actions differ in the information that they
include in the XML message and the processing that they require of the receiving
system.
An action attribute at the primary object level specifies the overall processing
action that applies to the parent and child records. At the child object level, it
indicates processing that is specific to that record.
Business rules always take precedence over the action attribute. If business rules
prohibit the action that is specified on an inbound XML message, an error occurs.
For example, an inbound transaction that attempts to update a closed PO will
result in an error.
If a single XML document contains multiple instances of an object structure, each
instance of the object structure can specify a different action attribute. In the
following example, the COMPANIES record has multiple child COMPCONTACT
records, each with its own action attribute.
<MXVENDOR>
<COMPANIES
action="Change"
>
<COMPANY>TEST4</COMPANY>
<NAME>test</NAME>
<ADDRESS1>100 Main Str</ADDRESS1>
<COMPCONTACT
action="Add"
>
<NAME>SMITH</NAME>
<TITLE>MANAGER</TITLE>
</COMPCONTACT>
<COMPCONTACT
action="Change"
>
<NAME>JONES</NAME>
<TITLE>ENGINEER</TITLE>
</COMPCONTACT>
</COMPANIES>
</MXVENDOR>
Add action
An add action indicates that the corresponding data is added to a database. For
inbound transactions, an error occurs if the data exists. The add action on a
primary object extends to its child objects, so it is not necessary to specify the add
action at the child object level. Outbound transactions contain an add action when
the insert of an object generates the transaction.
Delete action
A delete action indicates that the corresponding object and its child objects are
deleted from the database. The delete action on a primary object extends to its
child objects, so it is not necessary to specify the delete action at the child object
level.
An outbound XML message with a delete action on the primary object may not
include the child objects, but the receiving system is responsible for identifying
and deleting them.
When a primary object in an inbound XML message contains the delete action,
the integration framework deletes the child objects that are related to the primary
Null
Add records or replace records in the receiving system,
depending on whether the primary record exists in the
database.
Value
Description