uCosminexus Service Platform, Basic Development Guide

[Contents][Glossary][Index][Back][Next]

8.6.4 Creating Binary Data (TP1/EE or JMS)

To send a request message to the standard asynchronous reception (MDB (database queue)), you create binary data in the format shown in the following table.

Table 8-17 Binary data format (request message)

Item No. Item Size (bytes) Data type#1 Explanation Required
1 Header tag 4 char Header tag for delivering service component request message (eye catcher).
Specify DBQH.
Use ASCII codes.
Y
2 Byte order flag 1 byte Byte order (endian) identification flag of the numeric data inside the header.
Specify either of the following methods for encoding the numeric data inside the header into the binary format:
  • 0b00000001: big endian
  • 0b00000010: little endian
Y
3 Reserved 3 byte Reserved area Y
4 Size 4 int Header size (size from Item 5 through Item 28) of the messaging of the service component request.
Specify a size in bytes.
Y
5 Tag 8 char Parameter identification tag (eye catcher).
Specify ServiceN.
Use ASCII codes.
P
6 Size 4 int Size of the next area (Item 7).
Specify a size in bytes.
7 Service name Optional String This is the service name of the request destination.
For the service name of the request destination, specify the adapter or business process defined in the development environment.
Use UTF-8 codes.
8 Tag 8 byte Parameter identification tag (eye catcher).
Specify ClientID.
Use ASCII codes.
P
9 Size 4 int Size of the next area (Item 10).
Specify a size in bytes.
10 Client correlation ID Optional String This is a correlation identifier for uniquely identifying the request message from the service requester.
Specify alphanumeric characters, underscore (_), period (.), and hyphen (-) up to 255 characters.
This parameter is used to map the request message from the service requester to the execution history, logs, and traces managed by the HCSC server. Therefore, specify a different ID for each request message sent to the HCSC server.
Use UTF-8 codes.
If this item is omitted, there is no need to assemble binary data having this parameter, size, and tag.
11 Tag 8 byte Parameter identification tag (eye catcher).
Specify ReqFmtID.
Use ASCII codes.
--
12 Size 4 int Size of the next area (Item 13).
Specify a size in bytes.
13 HCSC request format ID Optional String ID for uniquely identifying the request message format.
Do not assemble binary data having this parameter, size, and tag.
14 Tag 8 byte Parameter identification tag (eye catcher).
Specify ResFmtID.
Use ASCII codes.
--
15 Size 4 int Size of the next area (Item 16).
Specify a size in bytes.
16 HCSC response format ID Optional String ID for uniquely identifying the response message format.
Do not assemble binary data having this parameter, size, and tag.
17 Tag 8 byte Parameter identification tag (eye catcher).
Specify ReplyToQ.
Use ASCII codes.
P
18 Size 4 int Size of the next area (Item 19).
Specify a size in bytes.
19 Response queue name Optional String This is the queue name that receives a response from a service component or business process when the service component at the request destination is a synchronous service (Web Services or SessionBean) or business process.
By specifying this parameter when you cannot determine whether the service component at the request destination is synchronous or asynchronous, you can receive responses.
For details, see 8.6.9 Setting Up a Response Queue (TP1/EE or JMS).
Use UTF-8 codes.
If you omit this parameter, NULL is specified, and you cannot receive responses. If this item is omitted, there is no need to assemble binary data having this parameter, size, and tag.
20 Tag 8 byte Parameter identification tag (eye catcher).
Specify OperatiN.
Use ASCII codes.
P
21 Size 4 int Size of the next area (Item 22).
Specify a size in bytes.
22 Service operation name Optional String This is an operation name corresponding to the service name at the request destination.#2
This operation name specifies a service component defined in the development environment. Specify the operation name with NCName definition characters of XMLSchema within 255 bytes.
This parameter is required when the service component at the request destination is a synchronous service (Web Services or SessionBean) or business process.
Use UTF-8 codes.
When the service component at the request destination is an asynchronous service component, you can omit the response queue name. If this item is omitted, there is no need to assemble binary data having this parameter, size, and tag.
23 Tag 8 byte Parameter identification tag (eye catcher).
Specify MessageT.
Use ASCII codes.
P
24 Size 4 int Size of the next area (Item 25).
Specify a size in bytes.
25 Message type Optional String User message (request message) type.
For XML message (whose payload is TextMessage) specify XML. For binary message (whose payload is BytesMessage), specify Binary.
This parameter must be specified when there is a message (request message).
Use UTF-8 codes.
When there is no request message, you can omit this item. If this item is omitted, there is no need to assemble binary data having this parameter, size, and tag.
26 Tag 8 byte Parameter identification tag (eye catcher).
Specify MgLength.
Use ASCII codes.
Y
27 Size 4 int Size of the next area (Item 28).
Specify 4.
28 Message size 4 int Specify the message size for the user message (request message) following binary conversion.
If there is no user message (request message), specify 0.
29 Message Optional byte[] User message (request message).#2
Specify a binary-converted user message (request message) after the database queue headers (Items 1 through 28).
If an XML message has been converted to binary format, encode it using UTF-8 codes.
This item can be omitted if there is no user message (request message).
P

Legend:
Y: Required.
P: Required in some cases. Check the explanation.
--: Must not be specified.

#1
Java data type

#2
When the service component protocol of request destination is SOAP, decide an operation to be invoked from the name of a root element of user message (in the case of data transformation, it is the name of root element of the message after data transformation). Therefore, take note that if you specify an invalid name in the root element of user message, an unintended operation may be invoked.