1.2.6 User-Defined Reception Definition Window

This subsection explains definitions of receptions in the User-Defined Reception Definition window for each reception type.

For details about how to display the window and how to define receptions, see 2. Defining User-Defined Reception in the uCosminexus BPM/ESB Service Platform Reception and Adapter Definition Guide.

Organization of this subsection
(1) SOAP reception types
(2) TP1/RPC, FTP, HTTP, Message Queue, and custom reception types

(1) SOAP reception types

The following explains the SOAP reception definition information displayed in the User-Defined Reception Definition window.

Figure 1-30 FigureUser-defined Reception Definition window

[Figure]

User defined reception information
Reception name
Displays the reception name specified in the Add User-Defined Reception wizard when adding a user-defined reception. Use NCName definition characters of the XMLSchema to specify the reception name within 40 bytes. Specify a reception name that is unique within the business process.
Reception ID
Displays the ID provided when a user-defined reception is added. Use alphanumeric characters and underscores (_) to specify a reception ID within 8 bytes. Specify a reception ID that is unique within the repository.
Reception type
Displays SOAP Reception as the reception type. You cannot change the reception type.
Port name
Displays the port name selected in Port specification of the wizard for adding a user-defined reception.
Context root
Displays the context root name. Note the following points when specifying a context root name:
  • Specify alphanumeric characters and any of the following symbols:
    / @ + - $ _ . ! ' ( ) % ~
  • Specify a name that is unique within the repository.
  • Specify a name conforming to the specifications of Application Server. If you specify the following values, an error will occur, when deploying.
    A delimiter (/) is specified at the beginning or end.
    (Example) /rcp, rcp/sub/
    Multiple delimiters (/) are specified.
    (Example) rcp//sub
    The absolute path is specified.
    (Example) rcp/./sub/..
    A percentage (%) is specified with a purpose other than percentage encoding.
    (Example) rcp%
  • Do not specify an HCSC server name, a service ID of the service adapter (Web Service) deployed in the HCSC server, and a value of the context root used in Reliable Messaging.
Operation name
Displays an operation name. The operation name defined in the user-defined reception can be selected from the drop-down list.
Request message
[Figure]Body tab
Message format
Displays the message format name of the request message. The message format is generated automatiinvokey from the WSDL.
Display button
Displays the message format of the request message.
Output button
Displays the dialog for specifying the output destination of the message format of the request message.
[Figure]Header tab
Root element
Displays the root element. If the request message does not contain header information, nothing is displayed for this item. 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.
Namespace
Displays the namespace of the root element displayed in the Root element text box. If the request message does not contain header information, nothing is displayed for this item.
Message format
Displays the message format name that contains the root element displayed in the Root element text box. If the request message does not contain header information, nothing is displayed for this item.
Display button
Displays the header information for the request message.
Output button
Displays the dialog box for specifying the output destination of the header information for the request message.
Response message
[Figure]Body tab
Message format
Displays the message format name of the response message. The message format is generated automatiinvokey from the WSDL.
Display button
Displays the message format of the response message.
Output button
Displays the dialog for specifying the output destination of the message format of the response message.
Message format
Displays the message format name of the response message. The message format is generated automatically from the WSDL.
Display button
Displays the message format of the response message.
Output button
Displays the dialog box for specifying the output destination of the response message format.
[Figure]Header tab
Root element
Displays the root element. If the response message does not contain header information, nothing is displayed for this item. 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.
Namespace
Displays the namespace of the root element displayed in the Root element text box. If the response message does not contain header information, nothing is displayed for this item.
Message format
Displays the message format name that contains the root element displayed in the Root element text box. If the response message does not contain header information, nothing is displayed for this item.
Display button
Displays the header information for the response message.
Output button
Displays the dialog box for specifying the output destination of the header information for the response message.
Fault message
Fault name
Displays the fault name of the user-defined reception.
Message format
Displays the format name of the fault message. The message format is generated automatiinvokey from the WSDL.
Display button
Displays the format of a fault message.
Output button
Displays the dialog for specifying the output destination of the fault message format.

(2) TP1/RPC, FTP, HTTP, Message Queue, and custom reception types

The following explains the items displayed in the window for the following reception types:

(a) Basic window for TP1/RPC reception, FTP reception, HTTP reception, Message Queue reception, and custom reception

The following explains the items of the basic window for TP1/RPC reception, FTP reception, HTTP reception, Message Queue reception, and custom reception.

Figure 1-31 User-Defined Reception Definition window (basic window for TP1/RPC reception, FTP reception, HTTP reception, Message Queue reception, and custom reception)

[Figure]

User defined reception information
Reception name
Displays the reception name. You can specify a reception name, which must be unique within the business process, by using 40 or fewer bytes.
Reception ID
Displays the reception ID. You can specify a reception ID by using 8 or fewer bytes of alphanumeric characters and underscores (_).
Reception type
Displays one of the reception types shown below. You cannot change the reception type.
  • TP1/RPC reception
  • FTP reception
  • HTTP reception
  • Message Queue reception
  • Custom reception
Default operation name
Displays the name of the operation that is invoked by default. From the drop-down list, you can select the operation that is invoked by default.
Operation
Displays an operation name. From the drop-down list, you can select an operation name defined for the reception.
  • Add button
    Opens the dialog box for adding an operation.
  • Delete button
    Deletes the operation selected in the Operation text box.
Operation information
Displays information about the operation of a service component.
Operation name
Displays the operation name selected in the Operation text box under User defined reception information.
Communication model
Displays the communication model of the operation. You can select Sync or Async from the drop-down list. For TP1/RPC reception and FTP reception, you need to select Sync.
Request message
Displays information about a request message that the reception receives from a service requester.
Use any type check box
Select this check box to create a user-defined reception without specifying a data type.
Reception
  • Message format
    Displays the format name of a request message that the reception receives from a service requester. The displayed message format depends on the reception type as follows:
    - TP1/RPC reception: fdx file
    - FTP reception: xsd file
    - Other than the above: fdx file or xsd file
    You can change the message format.
  • Browse button
    Displays the dialog box for setting the format of the request message.
  • Display button
    Displays the request message format.
  • Output button
    Displays the dialog box for specifying the output destination of the request message format.
Service component
  • Use check box
    Select this check box to convert data in the request message that the reception sends to a business process. For TP1/RPC reception, you need to select this check box.
  • Message format
    Displays the format name of a request message that the reception sends to a business process. The displayed message is in xsd file format.
    You can change the message format.
  • Browse button
    Displays the dialog box for specifying the format of a request message.
  • Display button
    Displays the request message format.
  • Output button
    Displays the dialog box for specifying the output destination of the request message format.
Data-conversion definition
Displays the definition file name used for converting data in the request message. For TP1/RPC reception, you need to specify the definition file for data conversion.
  • Edit button
    Displays the Data Transformation Definition window. You can edit the contents of the definition file specified in the Data-conversion definition text box. For the initial definition, the Select Root Element dialog box appears. If you have changed the message format, a confirmation dialog box for applying the changes in the message format appears.
  • Delete button
    Deletes the data conversion definition specified with the Edit button.
Response message
Displays information about a response message that the reception returns to a service requester. This information can be specified only when Sync is selected in the Communication model box under Operation information.
Use any type check box
Select this check box to create a user-defined reception without specifying a data type.
Reception
  • Message format
    Displays the format name of a response message that the reception returns to a service requester. The displayed message format depends on the reception type as follows:
    - TP1/RPC reception: fdx file
    - FTP reception: xsd file
    - Other than the above: fdx file or xsd file
    You can change the message format.
  • Browse button
    Displays the dialog box for specifying the format of a response message.
  • Display button
    Displays the response message format.
  • Output button
    Displays the dialog box for specifying the output destination of the response message format.
Service component
  • Use check box
    Select this check box to convert the data of a response message that the reception receives from a business process. For TP1/RPC reception, you need to select this check box.
  • Message format
    Displays the format name of a response message that the reception receives from a business process. The displayed message is in xsd file format.
    You can change the message format.
  • Browse button
    Displays the dialog box for specifying the format of a response message.
  • Display button
    Displays the response message format.
  • Output button
    Displays the dialog box for specifying the output destination of the request message format.
Data-conversion definition
Displays the definition file name used for converting response message data. For TP1/RPC reception, you need to specify a definition file for data conversion.
  • Edit button
    Displays the Data Transformation Definition window. You can edit the contents of the definition file specified in the Data-conversion definition text box. For the initial definition, the Select Root Element dialog box appears. If you have changed the message format, a confirmation dialog box for applying the changes in the message format appears.
  • Delete button
    Deletes the data conversion definition specified with the Edit button.
(b) Details window for TP1/RPC reception, FTP reception, HTTP reception, Message Queue reception, and custom reception

The following explains the items of the details window for TP1/RPC reception, FTP reception, HTTP reception, Message Queue reception, and custom reception.

Figure 1-32 User-Defined Reception Definition window (details window for TP1/RPC reception, FTP reception, HTTP reception, Message Queue reception, and custom reception)

[Figure]

User defined reception control information
Displays the names of the self-defined file and EAR file.
Self-defined file
Displays the self-defined file, which is specified depending on the reception type as follows:
- TP1/RPC reception: TP1/RPC reception definition file
- FTP reception: FTP reception definition file
- HTTP reception: HTTP reception definition file
- Message Queue reception: Message Queue reception definition file
- Other than above: Custom reception user file
You can add, edit, and delete the self-defined file and change its output destination by using the following buttons:
  • Add button
    Opens the dialog box for adding self-defined files.
  • 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. After self-defined files are saved on the editor, you need to save the user-defined reception to apply the edited information to the repository. If you attempt to save the user-defined reception 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 box for specifying the output destination of the self-defined file.
  • Delete button
    Deletes the file selected in the Self-defined file text box.
EAR file
Displays the name of the EAR file set by using the Browse button.
  • Browse button
    Displays the dialog box for setting the EAR file to be imported.