1.2.2 Service Adapter Definition Window

This subsection describes definitions of service adapters in the Service adapter definition window for each service type.

For details about how to display the window and how to define service adapters, see 3.3 Defining Adapter Contents in the uCosminexus Service Platform Reception and Adapter Definition Guide.

Important note

In the Service adapter definition window, an input item cannot be preceded or followed by a single-byte or double-byte space. However, a single-byte space can be specified at the end of Transmission queue creation place RD area name in the MDB/WS-R Detail window.
In the Service adapter definition window, you can click the Display button to display the message format. At this time, the file name displayed in the Message format text box in this window might be different from the file name displayed on the tab at the top of the text editor.

Organization of this subsection

(1) Web Services
(2) SessionBean
(3) MDB/WS-R
(4) MDB/DBQueue
(5) Custom adapter
(6) Other service adapters

(1) Web Services

The window for defining service adapters that correspond to Web Services is explained below.

(a) NonCustom Standard Editor

The items in the NonCustom Standard Editor are shown in the following figure and explained below.

Figure 1‒16: Service adapter definition window (NonCustom Standard Editor (Web Service))

(i) Service component control information

Displays information about the service components specified when a new service adapter was created.

Service name

Displays a HCSC component name.

Service ID

Displays a HCSC component ID. Use alphanumeric characters and underscores (_) to specify a service ID within eight bytes.

Service type

Displays Web Service as the service component type.

Address

Displays the URL for a service component.

Maximum instances

Displays the maximum number of instances of a service component.

Service class name

Displays the class name of a service component.

Operation

Displays an operation name. You can select the operation name of a service component from a drop-down list.

Convert system exception to fault checkbox

Checks to convert an exception occurring in a service component to a fault.

Note that exceptions that occur in the service adapter are not converted to faults.

For details, see 7.11 Handling of an exception that occurs in the service adapter in the Service Platform Setup and Operation Guide.

(ii) Operation information

Displays information about the operation of a service component.

Operation name: Displays the name of the operation selected in the Operation box in the service component control information.
Communication model: Displays Sync as the communication model of the operation selected in the Operation box in the service component control information.

(iii) Request message

Displays information about a request message sent from a service requester.

Body tab

• Standard

Use check box: Select this check box to check the contents of a message received from a service requester, or to convert message data to the format of the service component message.
Message format: Displays the format name of a message received from a service requester. You can change the message format.
Browse button: Opens the dialog for specifying a message format.
Display button: The message format is displayed.
Output button: Displays the dialog for specifying the output destination of the standard message format.

• Service component

Message format: Displays the message format name of a service component. The message format is automatiinvokey generated from the WSDL that matches the request message of the operation of the service component message. This message format cannot be modified.
Browse button: This button is not used.
Display button: The service component message format is displayed.
Output button: Displays the dialog for specifying the output destination of the message format of the service component.

• Data conversion

Data-conversion definition: Enter a definition file name to be used for data conversion from a message to a service component message.
Edit button: The Data Transformation Definition window opens. You can edit the contents of the definition files specified in the Data-conversion definition area. For the initial definition, the Root Element Selection dialog opens. If you change the message format, a confirmation dialog to apply the changes in the message format appears.
Delete button: Deletes the data conversion definition specified using the Edit button.

Header tab

• Root element

Displays the root element. Root elements displayed in the drop-down list can be added and deleted by using the Add and Delete buttons.

Add button: Opens the dialog box for specifying a message format. After the message format is specified, the root element contained in that message format can be added.
Delete button: Deletes the root element displayed in the Root element text box. Root elements to be deleted can be selected from the drop-down list.

• Namespace

Displays the namespace of the root element displayed in the Root element text box.

• Message format

Displays the message format name that contains the root element displayed in the Root element text box.

Display button: Displays the message format that contains the root element.
Output button: Displays the dialog for specifying the output destination of the message format.

(iv) Response message

Displays information about a response message sent from a service component.

Body tab

• Standard

Use check box: Select this check box to check the contents of a service component message received from a service component, or to convert service component message data to the format of a standard message.
Message format: Displays the format name of a message received from a service component. You can change the message format.
Browse button: Opens the dialog for specifying a message format.
Display button: The message format is displayed.
Output button: Displays the dialog for specifying the output destination of the standard message format.

• Service component

Message format: Displays the message format name of a service component. The message format is automatiinvokey generated from the WSDL that matches the response message of the operation of the service component message. This message format cannot be modified.
Browse button: This button is not used.
Display button: The service component message format is displayed.
Output button: Displays the dialog for specifying the output destination of the message format of the service component.

• Data conversion

Data-conversion definition: Enter a definition file name to be used for data conversion from a service component message to a message.
Edit button: The Data Transformation Definition window opens. You can edit the contents of the definition files specified in the Data-conversion definition area. For the initial definition, the Root Element Selection dialog opens. If you change the message format, a confirmation dialog for applying the changes in the message format appears.
Delete button: Deletes the data conversion definition specified with the Edit button.

Header tab

• Root element

Displays the root element. Root elements displayed in the drop-down list can be added and deleted by using the Add and Delete buttons.

Add button: Opens the dialog box for specifying a message format. After the message format is specified, the root element contained in that message format can be added.
Delete button: Deletes the root element displayed in the Root element text box. Root elements to be deleted can be selected from the drop-down list.

• Namespace

Displays the namespace of the root element displayed in the Root element text box.

• Message format

Displays the message format name that contains the root element displayed in the Root element text box.

Display button: Displays the message format that contains the root element.
Output button: Displays the dialog for specifying the output destination of the message format.

(v) Fault message

Displays information about a fault message of a service component.

Fault name: Displays the fault name of a service component.
Message format: Displays the format name of a fault message of a service component.
Browse button: This button is not used.
Display button: Displays the format of a fault message.
Output button: Displays the dialog for specifying the output destination of the fault message format.

(b) Web Services Detail Editor

The items in the Web Services Detail Editor are shown in the following figure and explained below.

Figure 1‒17: Service adapter definition window (Web Services Detail Editor)

(i) Web Service control information

Displays information for each type of service component specified when a new service adapter was created.

• Client definition file

Client definition file

Displays the client definition file name specified with the Browse button.

Browse button

Opens the dialog for specifying a client definition file.

Edit button

Starts the editor for editing a client definition file. To apply edited information to the repository after the client definition file is saved on the editor, you need to save the service adapter.

If you attempt to save the service adapter while editing the client definition file, a confirmation dialog box appears, asking whether you want to save the client definition file.

Output button

Displays the dialog for specifying the output destination of the client definition file.

• Basic authentication

Basic authentication

Use check box

Select this check box if the service component uses basic authentication.

User name

Enter halfwidth alphanumeric characters, halfwidth symbols (0x21 to 0x7E in ASCII encoding^#), or halfwidth spaces (0x20 in ASCII encoding). There is no limit for the byte length.

In SOAP1.1 mode, you cannot use a hash mark (#), colon (:), question mark (?), at mark (@), or forward slash (/). In SOAP1.1/1.2 combined mode, you cannot use a colon (:) or forward slash (/).

Password

You can enter 40 or fewer bytes of halfwidth alphanumeric characters, halfwidth symbols (0x21 to 0x7E in ASCII encoding^#), or halfwidth spaces (0x20 in ASCII encoding).

In SOAP1.1 mode, you cannot use a hash mark (#), colon (:), question mark (?), at mark (@), or forward slash (/). In SOAP1.1/1.2 combined mode, you cannot use a colon (:) or forward slash (/).

Password(Re-enter)

Re-enter the password entered in the Password box.

To Page Top

(2) SessionBean

The window for defining service adapters that correspond to SessionBean is explained below.

(a) NonCustom Standard Editor

The items in the NonCustom Standard Editor are shown in the following figure and explained below.

Figure 1‒18: Service adapter definition window (NonCustom Standard Editor (SessionBean))

(i) Service component control information

Displays information about the service components specified when a new service adapter was created.

Service type

Displays SessionBean as the service component type.

Address

Enter the name of the service component that is registered in the JNDI name space and that is to be invoked.

Specify an address for remote invocation (local invocation is not allowed).

In SessionBean, information about fault messages is not displayed.

The items other than those described above are the same as those in the NonCustom Standard Editor as described earlier. For details about other items in the NonCustom Standard Editor, see 1.2.2(1)(a) NonCustom Standard Editor.

(b) SessionBean Detail Editor

The items in the SessionBean Detail Editor are shown in the following figure and explained below.

Figure 1‒19: Service adapter definition window (SessionBean Detail Editor)

(i) SessionBean control information

Displays information for each type of service component specified when a new service adapter was created.

• Client definition file

Client definition file

Displays a client definition file name.

Browse button

Opens the dialog for specifying a client definition file.

Edit button

Starts the editor for editing a client definition file. To apply edited information to the repository after the client definition file is saved on the editor, you need to save the service adapter.

If you attempt to save the service adapter while editing the client definition file, a confirmation dialog box appears, asking whether you want to save the client definition file.

Output button

Displays a dialog for specifying the output destination of a client definition file.

• User definition class

User definition class (JAR file): Displays the user definition class (JAR file) name specified using the Add button.
Add button: Opens the dialog for specifying a user definition class (JAR file). The extension of the JAR file to be selected must be jar (all lower-case letters).
Output button: Displays a dialog for specifying an output destination of a user definition class (JAR file).
Delete button: Deletes the JAR file selected in the User definition class area.

To Page Top

(3) MDB/WS-R

The window for defining service adapters that correspond to MDB/WS-R is explained below.

(a) NonCustom Standard Editor

The items in the NonCustom Standard Editor are shown in the following figure and explained below.

Figure 1‒20: Service adapter definition window (NonCustom Standard Editor (MDB/ WS-R))

(i) Service component control information

Displays information about the service components specified when a new service adapter was created.

Service type: Displays MDB/WS-R as the service component type.
Address: Enter the queue name that is associated with the service component.
Service class name: This item is not used.

(ii) Operation information

Displays information about the operation of a service component.

Communication model: Displays Async as the communication model of the operation selected in the Operation box in the service component control information.

(iii) Request message

• Service component

Message format: Specify the format name of a service component message. You can change the message format.
Browse button: Opens the dialog for specifying a service component message format.

In MDB/WS-R, information about response messages and fault messages is not displayed.

(b) MDB/WS-R Detail Editor

The items in the MDB/WS-R Detail Editor are shown in the following figure and explained below.

Figure 1‒21: Service adapter definition window (MDB/WS-R Detail Editor)

(i) MDB control information

Displays information for each type of service component specified when a new service adapter was created.

JMS message classification

Displays a JMS message classification for a service component. Select one of the following message classifications from the drop-down list:

Text
Bytes
Object

• Call setting

Remote invoke radio button: Select if invoking a service component remotely. If you select this item, each item of Remote invoke settings is activated and input can be performed.
Local invoke radio button: Select this item to invoke a service component loinvokey. If you select this item, each item of Remote invoke settings is deactivated, and input cannot be performed.

• Remote invoke settings

The number of the maximum messages: Specify the maximum number of messages that can be sent by a service component. You can set a value in a range from 1 to 65535.
Destination URL: Specify the destination URL for receiving response results during an asynchronous operation.

• Basic authentication

Use check box: Select this check box if the service component uses basic authentication.
User name: Enter single-byte alphanumeric characters and symbols. There is no limit for the byte length.
Password: Enter a maximum of 40 bytes of single-byte alphanumeric characters and symbols.
Password(Re-enter): Re-enter the password entered in the Password box.

Transmission queue creation place RD area

Specify a transmission queue creation place RD area. You can specify a single-byte space at the end of this item.

Sequence guarantee check box

Select this check box when Reliable Messaging guarantees the transmission sequence.

To Page Top

(4) MDB/DBQueue

The window for defining service adapters that correspond to MDB/DBQueue is explained below.

(a) NonCustom Standard Editor

The items in the NonCustom Standard Editor are shown in the following figure and explained below.

Figure 1‒22: Service adapter definition window (NonCustom Standard Editor (MDB/DBQueue))

(i) Service component control information

Displays information about the service components specified when a new service adapter was created.

Service type: Displays MDB/DBQueue as the service component type.

Note that there is no detail editor for MDB/DBQueue.

To Page Top

(5) Custom adapter

The window for defining custom adapters (DB adapters) is explained below.

(a) Custom Adapter Basic window

The items of the Custom Adapter Basic window are shown and explained in the following figure:

Figure 1‒23: Service adapter definition window (Custom Adapter Basic window)

(i) Service component control information

Displays information about the service components specified when a new database adapter was created.

Service name

Displays a HCSC component name.

Service ID

Displays a HCSC component ID. Use alphanumeric characters and underscores (_) to specify a service ID within 8 bytes.

Service type

Displays Custom adapter as the service component type.

Address

This item is not used.

Maximum instances

Displays the maximum number of instances of a service component.

Service class name

This item is not used.

Operation

Displays an operation name. You can select the operation name of a service component from a drop-down list.

Add button

Opens the dialog for adding operations.

Delete button

Deletes the operation selected in the Operation box.

Convert system exception to fault checkbox

Checks to convert an exception occurring in a service component to a fault.

Note that exceptions that occur in the service adapter are not converted to faults.

For details, see 7.11 Handling of an exception that occurs in the service adapter in the Service Platform Setup and Operation Guide.

(ii) Operation information

Displays information about the operation of a service component.

Operation name

Displays the name of the operation selected in the Operation box in the service component control information.

Communication model

Displays the communication model of the operation selected in the Operation box in the service component control information. You can select either Sync or Async from the drop-down list. The display changes according to the selected contents as follows:

When Sync is selected: The information about the response message and fault message is displayed.
When Async is selected: The information about the response message and fault message is not displayed. If you save the adapter definition with async as it is, all items of the response message and fault message are deleted.

(iii) Request message

Displays information about a request message sent from a service requester.

Use any type check box: Select this check box to create a service adapter without specifying a data type.

• Standard

Use check box: Select this check box to check the contents of a message received from a service requester or to convert message data to the format of the database adapter message.
Message format: Displays the format name of a message received from a service requester. You can change the message format.
Browse button: Opens the dialog for specifying a message format.
Display button: The message format is displayed.
Output button: Displays the dialog for specifying the output destination of the standard message format.

• Service component

Message format: Enter the format (XML format definition file for database adapter) name of a database adapter message. You can change the message format.
Browse button: Opens the dialog for specifying a format file (XML format definition file for database adapter) for a database adapter message.
Display button: Displays the format (XML format definition file for database adapter) of a database adapter message.
Output button: Displays the dialog for specifying the output destination of the DB adapter message format (XML format definition file for DB adapters).

• Data conversion

Data-conversion definition: Enter a definition file name to be used for data conversion from a message to a database adapter message.
Edit button: The Data Transformation Definition window opens. You can edit the contents of the definition files specified in the Data-conversion definition area. For the initial definition, the Root Element Selection dialog opens. If you change the message format, a confirmation dialog for applying the changes in the message format appears.
Delete button: Deletes the data conversion definition specified using the Edit button.

(iv) Response message

Displays information about a response message sent from a service component.

This information can be specified only when Sync is selected in the Communication model box in the operation information.

Use any type check box: Select this check box to create a service adapter without specifying a data type.

• Standard

Use check box: Select this check box to check the contents of a database adapter message received from a service component or to convert database adapter message data to the format of the message.
Message format: Displays the format name of a message received from a service component. You can change the message format.
Browse button: Opens the dialog for specifying a message format.
Display button: Displays a message format.
Output button: Displays the dialog for specifying the output destination of the standard message format.

• Service component

Message format: Displays the message format (XML format definition file for database adapter) name of a service component. You can change the message format.
Browse button: Opens the dialog for specifying a format file (XML format definition file for database adapter) for a database adapter message.
Display button: Displays the format (XML format definition file for database adapter) of a database adapter message.
Output button: Displays the dialog for specifying the output destination of the DB adapter message format (XML format definition file for DB adapters).

• Data conversion

Data-conversion definition: Enter a definition file name to be used for data conversion from a database adapter message to a message.
Edit button: The Data Transformation Definition window opens. You can edit the contents of the definition files specified in the Data-conversion definition area. For the initial definition, the Root Element Selection dialog opens. If you change the message format, a confirmation dialog for applying the changes in the message format appears.
Delete button: Deletes the data conversion definition specified with the Edit button.

(v) Fault message

Displays information about a fault message of a service component.

Add button: Opens the dialog for adding a fault name. This button is not used in database adapter definition.
Delete button: Deletes the fault name selected in the fault box. This button is not used in database adapter definition.
Fault name: Displays the fault name of a service component. This box is not used in database adapter definition.
Message format: Displays the format name of a fault message of a service component. This box is not used in database adapter definition.
Browse button: Opens the dialog for specifying the format of a fault message. This button is not used in database adapter definition.
Display button: Displays the format of a fault message. This button is not used in database adapter definition.
Output button: Displays the dialog for specifying the output destination of the fault message format.

(b) Custom Adapter Details window

The items of the Custom Adapter Details window are shown and explained in the following figure:

Figure 1‒24: Custom Adapter Definition window (Custom Adapter Details window)

(i) Custom adapter control information

Displays information about the service components specified when a new database adapter was created.

• Custom adapter

Custom adapter (EJB-JAR file): Displays the EJB-JAR file name of a database adapter.
... button: Opens the dialog for setting EAR file name for custom adapter.

• Utility class

Utility class (JAR file): Displays the utility class specified using the Add button. This box is not used in database adapter definition.
Add button: Opens the dialog for adding utility classes. This button is not used in database adapter definition.
Output button: Displays the dialog for specifying the output destination of the utility class. Do not use this button in the DB adapter definition.
Delete button: Deletes the utility class selected in the utility class area. This button is not used in database adapter definition.

• Self-defined file

Self-defined file

Displays the SQL operation definition files specified using the Add button and the HITACHI Application Integrated Property File.

Add button

Opens the dialog for adding self-defined files (SQL operation definition files and HITACHI Application Integrated Property File)

Edit button

Starts the editor for editing a self-defined file. If you select multiple self-defined files and then click the Edit button, editors are started for all the selected self-defined files.

To apply edited information to the repository after self-defined files are saved on the editor, you need to save the service adapter. If you attempt to save the service adapter while editing a self-defined file, a confirmation dialog box appears, asking whether you want to save the self-defined file.

Output button

Displays the dialog for specifying the output destination of the self-defined file (SQL operation definition file and Hitachi Application Integrated Property File).

Delete button

Deletes the files selected in the self-defined file area.

To Page Top

(6) Other service adapters

The following describes the windows used to define the following service adapters:

DB adapter
TP1 adapter
File adapter
Object Access adapter
Message Queue adapter
FTP adapter
File operations adapter
Mail adapter
HTTP adapter
Command adapter
SFTP adapter

(a) Basic window for other service adapters

The basic window is the same as the Custom Adapter Basic window, except for some items displayed in the window. For details about the items of the Custom Adapter Basic window, see 1.2.2(5)(a) Custom Adapter Basic window.

The following describes the items that are different from those of the Custom Adapter Basic window.

(i) Service component control information

Service type

Displays one of the following service types as the service component type:

DB adapter
TP1 adapter
File adapter
Object Access adapter
Message Queue adapter
FTP adapter
File operations adapter
Mail adapter
HTTP adapter
Command adapter
SFTP adapter

(b) Details window for other service adapters

The items of the Details window are the same as those of the Custom Adapter Details window. For details, see 1.2.2(5)(b) Custom Adapter Details window.

To Page Top