uCosminexus Service Platform, Reception and Adapter Definition Guide

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

Appendix B.4 Custom adapter definition screen

This section describes the service adapter definition screens you use to define General custom adapters.

Organization of this subsection
(1) Service adapter definition (standard) screen
(2) Service adapter definition (details) screen

(1) Service adapter definition (standard) screen

The items in the Service adapter definition (standard) screen are described below.

Figure B-3 Service adapter definition (standard) screen

[Figure]

(a) Service component control information

This area displays information about the service component specified when a General custom adapter is created.

Service name
Displays the service name set in the Service adapter definition addition screen.

Service ID
Enter a service ID. Specify the service ID using no more than 8 bytes of alphanumeric characters and underscores (_).

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 the service component.

Service class name
This item is not used.

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

Convert a system exception into a fault message check box
Select this check box if you want exceptions that occur in the service component to be converted to faults.

Add button
Displays a dialog box in which you can add an operation.

Delete button
Deletes the operation selected in the Operation field.
(b) Operation information

This area displays information about the operations of the service component.

Operation name
Displays the name of the operation selected in the Operation field in the Service component control information area.

Communication model
Displays the communication model of the operation selected in the Operation field in the Service component control information area. You can select Sync or Async from the drop-down list. The information displayed in the Service adapter definition (standard) screen changes according to the option you select.
  • If you select Sync, information about the response message and fault message is displayed.
  • If you select Async, information about the response message and fault message is not displayed. If you save the adapter definition with Async selected as the communication model, all fields relating to the response message and fault message are deleted.
(c) Request message

This area displays information about the request message sent from the service requester.

Use any type check box
Select this check box to create request messages without specifying a data type.

Standard
Use check box
Select this check box if you want the service to check the contents of standard messages received from the service requester, or to transform standard messages to the message format of the General custom adapter.
Format ID
Displays the format ID of standard messages received from the service requester.
Message format
Displays the format name of standard messages received from the service requester.
Browse button
Displays a dialog box in which you can set the standard message format.
Display button
Displays the format of the standard message.
Acquire button
Displays a dialog box in which you can specify the output destination of the standard message format.

Service component
Format ID
Displays the format ID of the message format of request messages received by the protocol converter of the General custom adapter.
Message format
Displays the name of the message format of request messages received by the protocol converter of the General custom adapter.
Browse button
Displays a dialog box in which you can set the message format of request messages received by the protocol converter of the General custom adapter.
Display button
Displays the message format of request messages received by the protocol converter of the General custom adapter.
Acquire button
Displays a dialog box in which you can specify the output destination of the message format of request messages received by the protocol converter of the General custom adapter.

Data-conversion definition
Enter the name of the definition file used to transform the standard message to the request message received by the protocol converter of the General custom adapter. This item is unavailable when the Use check box is cleared in the Standard message area.
Edit button
Displays the Data-conversion definition screen. In this screen, you can edit the contents of the definition file set in the Data-conversion definition field. If you are creating a new data transformation definition, the Select Root Element dialog box appears. This item is unavailable when the Use check box is cleared in the Standard message area.
Delete button
Deletes the data transformation definition set by using the Edit button. This item is unavailable when the Use check box is cleared in the Standard message area.
(d) Response message

This area displays information about the response message sent from the service component.

You can set the information in this area when Sync is selected as the communication model in the Operation information area.

Use any type check box
Select this check box to create response messages without specifying a data type.

Standard
Use check box
Select this check box if you want to check the contents of messages for the General custom adapter received from the service component or to transform messages for the General custom adapter to standard message format.
Format ID
Displays the format ID of the standard message used when responding to the service requester.
Message format
Displays the name of the format of the standard message used when responding to the service requester.
Browse button
Displays a dialog box in which you can set the standard message format.
Display button
Displays the format of the standard message.
Acquire button
Displays a dialog box in which you can specify the output destination of the standard message format.

Service component
Format ID
Displays the format ID of the message format of response messages sent by the protocol converter of the General custom adapter.
Message format
Displays the name of the message format of response messages sent by the protocol converter of the General custom adapter.
Browse button
Displays a dialog box in which you can set the message format of response messages sent by the protocol converter of the General custom adapter.
Display button
Displays the message format of response messages sent by the protocol converter of the General custom adapter.
Acquire button
Displays a dialog box in which you can specify the output destination of the message format of response messages sent by the protocol converter of the General custom adapter.

Data-conversion definition
Enter the name of the definition file used to transform the response message sent from the protocol converter of the General custom adapter to a standard message. This item is unavailable when the Use check box is cleared in the Standard message area.
Edit button
Displays the Data-conversion definition screen. In this screen, you can edit the contents of the definition file set in the Data-conversion definition field. If you are creating a new data transformation definition, the Select Root Element dialog box appears. This item is unavailable when the Use check box is cleared in the Standard message area.
Delete button
Deletes the data transformation definition set by using the Edit button. This item is unavailable when the Use check box is cleared in the Standard message area.
(e) Fault message

This area displays information about the fault message of the service component.

Add button
Displays a dialog box in which you can add a fault name. This button is unavailable when defining a General custom adapter.

Delete button
Deletes the file selected in the Fault name field. This button is unavailable when defining a General custom adapter.

Fault name
Displays the fault name of the service component. This field is unavailable when defining a General custom adapter.

Message format
Displays the name of the format of the fault message of the service component. This field is unavailable when defining a General custom adapter.

Browse button
Displays a dialog box in which you can set the fault message format. This button is unavailable when defining a General custom adapter.

Display button
Displays the format of the fault message. This button is unavailable when defining a General custom adapter.

Acquire button
Displays a dialog box in which you can specify the output destination of the fault message format. This button is unavailable when defining a General custom adapter.

(2) Service adapter definition (details) screen

The items in the Service adapter definition (details) screen are described below.

Figure B-4 Service adapter definition (details) screen

[Figure]

(a) Service adapter control information

This area displays information about the service component specified when a General custom adapter is created.

Service adapter
Service adapter (EJB-JAR file)
Displays the name of the EJB-JAR file of the General custom adapter.
Browse button
Displays a dialog box in which you can set the file name of the EJB-JAR file of the General custom adapter.

Utility class
Utility class (JAR file)
Displays the utility classes set by the Add button.
Add button
Displays a dialog box from which you can add a utility class. Add the JAR file you created in 3.3.14 Defining custom adapters.
Acquire button
Displays a dialog box in which you can specify the output destination of the utility class.
Delete button
Deletes the file selected in the Utility class field.

Self-defined file
Self-defined file
Displays the protocol converter self-defined file, custom adapter property file, HITACHI Application Integrated Property File for custom adapter, and custom adapter definition file you set using the Add button.
Add button
Displays a dialog box in which you can add self-defined files (protocol converter self-defined files, custom adapter property files, custom adapter HITACHI Application Integrated Property files, and custom adapter definition files).
Edit button
Displays an editor in which you can edit self-defined files (protocol converter self-defined files, custom adapter property files, custom adapter HITACHI Application Integrated Property files, and custom adapter definition files). If you click the Edit button with multiple self-defined files selected, an editor window opens for each file. After making changes in the editor, you can apply the changes to the repository by saving the self-defined file in the editor and then saving the General custom adapter. If you attempt to save the General custom adapter while editing a self-defined file, a dialog box appears asking if you want to save the self-defined file.
Acquire button
Displays a dialog box in which you can specify the output destination for self-defined files (protocol converter self-defined files, custom adapter property files, custom adapter HITACHI Application Integrated Property files, and custom adapter definition files).
Delete button
Deletes the file selected in the Self-defined file field.