uCosminexus Service Platform, Reception and Adapter Definition Guide

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

3.3.15 List of Settings in Adapter Definition

This sub section describes the settings to be performed on the "Service adapter settings screen" to be used in the service adapter definition.

Note
  • Do not specify a name that begins with "format" in the [Message format ID]. If you specify a name that begins with "format", it might overlap with the ID that is used internally by the system, and an error might occur.
  • If the message format of the message format definition file specified in the service adapter settings screen references an external XML schema, without fail, set a file that corresponds to the root schema. The external XML schema file referenced by the root schema is automatically taken.
  • The message format definition file specified in the service adapter settings screen must fulfill certain conditions. For details on the conditions of the schema, see 2.6.5 Scoping of XML schema in the manual Service Platform Basic Development Guide.
Organization of this subsection
(1) For SOAP adapters
(2) For the SessionBeanadapters
(3) For MDB (WS-R) adapters
(4) For MDB (DB queue) adapters
(5) For DB adapters
(6) For file adapters
(7) For Message Queue adapters
(8) For FTP adapters
(9) For file operations adapters
(10) For mail adapters
(11) For HTTP adapters
(12) For custom adapters

(1) For SOAP adapters

The following table lists the settings to be performed on the service adapter settings screen at the time of defining SOAP adapters:

Table 3-85 Settings to be performed on the service adapter settings screen of SOAP adapters

Classification Item Settings
Basic screen Service component control information Service name B
Service ID B
Service type N
Address N
Maximum instance count B
Service class name N
Operation B
Transform the system exception to a fault (check box) Y
Operation information Operation name N
Communication model N
Message format Header Root element Y
Name space N
Message format N
Body Use (Check box) Y
Standard format ID A#1
Standard message format A#1
Service component format ID B
Service component message format B
Data transformation definition A#1
Response message Header Root element Y
Name space N
Message format N
Body Use (Check box) Y
Standard format ID A#2
Standard message format A#2
Service component format ID B
Service component message format B
Data transformation definition A#2
Fault message Fault name A#3
Fault message format A#3
Detailed screen Web service control information Client definition file B
Use (Check box) Y
User name A#4
Password A#4
Password (confirm) A#4
SessionBean control information Client definition file -
User-defined class (JAR file) -
MDB control information JMS message type -
Remote invocation (radio button) -
Local invocation (radio button) -
Maximum message count -
Destination URL -
Basic authentication (Check box) -
User name -
Password -
Password (confirm) -
Transfer queue creation destination RD area name -
Order guarantee (Check box) -

Legend:
B: Must be set.
Y: Setting is optional.
A: Must be set as per the condition.
N: Confirm the displayed contents.
-: Not applicable.

Note# 1
You must set this item, if you have checked the [Use] (checkbox) of the request message.

Note#2
You must set this item, if you have checked the [Use] (checkbox) of the response message.

Note#3
Set this item only in case of the fault message of the service component message.

Note#4
You must set this item, if you have checked the [Use] (checkbox) of basic authentication.

Note
You cannot specify single byte spaces or double byte spaces before and after the input item in the service adapter setting screen.

(2) For the SessionBeanadapters

The following table lists the settings to be performed on the service adapter settings screen at the time of defining SessionBean adapters:

Table 3-86 Settings to be performed on the service adapter settings screen of SessionBean adapters

Classification Item Settings
Basic screen Service component control information Service name B
Service ID B
Service type N
Address B
Maximum instance count B
Service class name N
Operation B
Transform the system exception to a fault (Check box) Y
Operation information Operation name N
Communication model N
Message format Header Root element -
Name space -
Message format -
Body Use (Checkbox) Y
Standard format ID A#1
Standard message format A#1
Service component format ID B
Service component message format B
Data transformation definition A#1
Response message Header Root element -
Name space -
Message format -
Body Use (Checkbox) Y
Standard format ID A#2
Standard message format A#2
Service component format ID B
Service component message format B
Data transformation definition A#2
Fault message Fault name -
Fault message format -
Detailed screen Web service control information Client definition file -
Use (Checkbox) -
User name -
Password -
Password (confirm) -
SessionBean control information Client definition file B
User-defined class (JAR file) Y
MDB control information JMS message type -
Remote invocation (radio button) -
Local invocation (radio button) -
Maximum message count -
Destination URL -
Basic authentication (Checkbox) -
User name -
Password -
Password (confirm) -
Transfer queue creation destination RD area name -
Order guarantee (Checkbox) -

Legend:
B: Must be set.
Y: Setting is optional.
A: Must be set as per the condition.
N: Confirm the displayed contents.
-: Not applicable.

Note#1
You must set this item, if you have checked the [Use] (checkbox) of the request message.

Note# 2
You must set this item, if you have checked the [Use] (checkbox) of the response message.

Note
You cannot specify single byte spaces or double byte spaces before and after the input item in the service adapter setting screen.

(3) For MDB (WS-R) adapters

The following table lists the settings to be performed on the service adapter settings screen at the time of defining MDB (WS-R) adapters:

Table 3-87 Settings to be performed on the service adapter settings screen of MDB (WS-R) adapters

Classification Item Settings
Basic screen Service component control information Service name B
Service ID B
Service type N
Address B
Maximum instance count B
Service class name N
Operation B
Transform the system exception to a fault (Check box) Y
Operation information Operation name N
Communication model N
Request message Header Root element -
Name space -
Message format -
Body Use (Check box) Y
Standard format ID A#1
Standard message format A#1
Service component format ID B
Service component message format B
Data transformation definition A#1
Response message Header Root element -
Name space -
Message format -
Body Use (Check box) -
Standard format ID -
Standard message format -
Service component format ID -
Service component message format -
Data transformation definition -
Fault message Fault name -
Fault message format -
Detailed screen Web service control information Client definition file -
Use (Check box) -
User name -
Password -
Password (confirm) -
Sessionbean control information Client definition file -
User-defined class (JAR file) -
MDB control information JMS message type B
Remote invocation (radio button) B#2
Local invocation (radio button) B#2
Maximum message count A#3
Destination URL A#3
Basic authentication (Check box) Y#4
User name A#5
Password A#5
Password (confirm) A#5
Transfer queue creation destination RD area name Y#4
Order guarantee (Check box) Y#4

Legend:
B: Must be set.
Y: Setting is optional.
A: Must be set as per condition.
N: Confirm the displayed contents.
-: Not applicable.

Note#1
You must set this item, if you have checked the [Use] (checkbox) of the request message.

Note#2
You must select either the [Remote invocation] or the [Local invocation] radio button.

Note#3
You must set this item, if you have selected the [Remote invocation] radio button.

Note#4
Setup is optional only if you have selected the [Remote invocation] radio button.

Note#5
You must set this item, if you have selected the [Remote Invocation] (radio button), and checked the [Use] (checkbox) of basic authentication.

Note
You cannot specify single byte spaces or double byte spaces before and after the input item in the service adapter setting screen. However, you can specify single byte space at the end in [Transfer queue creation destination RD area name] of MDB (WS-R) of the detailed screen.

(4) For MDB (DB queue) adapters

The following table lists the settings to be performed on the service adapter settings screen at the time of defining MDB (DB queue) adapters:

Table 3-88 Settings to be performed on the service adapter settings screen of MDB (DB queue) adapters

Classification Item Settings
Basic screen Service component control information Service name B
Service ID B
Service type N
Address B
Maximum instance count B
Service class name N
Operation B
Transform the system exception to a fault (Check box) Y
Operation information Operation name N
Communication model N
Request message Header Root element -
Name space -
Message format -
Body Use (Check box) Y
Standard format ID A#
Standard message format A#
Service component format ID B
Service component message format B
Data transformation definition A#
Response message Header Root element -
Name space -
Message format -
Body Use (Check box) -
Standard format ID -
Standard message format -
Service component format ID -
Service component message format -
Data transformation definition -
Fault message Fault name -
Fault message format -
Detailed screen Web service control information Client definition file -
Use (Check box) -
User name -
Password -
Password (confirm) -
Sessionbean control information Client definition file -
User-defined class (JAR file) -
MDB control information JMS message type -
Remote invocation (radio button) -
Local invocation (radio button) -
Maximum message count -
Destination URL -
Basic authentication (Check box) -
User name -
Password -
Password (confirm) -
Transfer queue creation destination RD area name -
Order guarantee (Check box) -

Legend:
B: Must be set.
Y: Setting is optional.
A: Must be set as per the condition.
N: Confirm the displayed contents.
-:Not applicable.

Note#
You must set this item, if you have checked the [Use] (checkbox) of the request message.

Note
You cannot specify single byte spaces or double byte spaces before and after the input item in the service adapter setting screen.

(5) For DB adapters

The following table lists the settings to be performed on the service adapter settings screen at the time of defining DB adapters:

Table 3-89 Settings to be performed on the service adapter settings screen of DB adapters

Classification Item Settings
Synchronous Asynchronous
Basic screen Service component control information Service name B B
Service ID B B
Service type N N
Address N N
Maximum instance count #1 B B
Service class name N N
Operation B B
Transform the system exception to a fault (Check box) Y Y
Operation information Operation name N N
Communication model B #2 B #3
Request message Use (Check box) for any type - -
Use (Check box) Y Y
Standard format ID A#4 A#4
Standard message format A#4 A#4
Service component format ID B B
Service component message format#6 B B
Data transformation definition A#4 A#4
Response message Use (Check box) for any type - -
Use (Check box) Y -
Standard format ID A#5 -
Standard message format A#5 -
Service component format ID B -
Service component message format#6 B -
Data transformation definition A#5 -
Fault message Fault name - -
Service component message format - -
Detailed screen Service adapter control information Service adapter (EJB-JAR file) N N
Utility class (JAR file) - -
Self-defined file#7 B B

Legend:
B: Must be set.
Y: Setting is optional.
A: Must be set as per the condition.
N: Confirm the displayed contents.
-: Not applicable.

Note#1
The value set in the service adapter definition screen is not applied.
For the maximum instance count, the value set in the HITACHI Application Integrated Property File element "hitachi-application-all-property/ejb-jar/hitachi-session-bean-property/session-runtime/stateless/pooled-instance/maximum" is set.

Note#2
Set "Synchronous".

Note#3
Set "Asynchronous".

Note#4
You must set this item, if you have checked the [Use] (checkbox) of the request message.

Note#5
You must set this item, if you have checked the [Use] (checkbox) of the response message.

Note#6
Set the message format of the XML message for each message type.

Note#7
cscadapter_property.xml that is set is a template file. On selecting cscadapter_property.xml, click the [Edit] button to modify the contents, and then save the file. For details on the property file, see 3.3.5(4) Editing the HITACHI Application Integrated Property File.
Create the SQL operation definition file and add it to the self-defined file. For details on the SQL operation definition file, see 3.3.5(1) Creating the SQL operation definition file.

(6) For file adapters

The following table describes the settings to be performed on the service adapter settings (basic) screen at the time of defining file adapters. Settings are not required for the items that are not described in the table.

Table 3-90 Settings to be performed on the service adapter settings screen (basic) of file adapters

Classification Item Description Settings
Service component control information - The information on service components specified at the time of creating a file adapter is displayed. -
Service name The HCSC component name specified in the [Add service adapter settings (file adapter)] wizard is displayed. B
Service ID The HCSC component ID is displayed.#1 A
Service type The "File adapter" is displayed as the type of service component. N
Address Do not use this item. N
Maximum instance count The maximum instance count of the service component is displayed. B
Service class name Do not use this item. N
Operation The operation name is displayed. Select the operation name of service components from the drop-down list. B
Operation information - The information on service component operations is displayed. -
Operation name The name of the operation selected in the operation column of the service component control information is displayed. N
Communication model Select the communication model of the operation selected in the operation column of the service component control information. Select "Synchronous" in the file adapter. B
Request message - The information of the request message sent from the business process is displayed. -
Standard Use (Checkbox) Check this option when you transform the data of the standard message into the service component message format. Y
Format ID Enter the format ID of the standard message received from the business process. A#2
Message format Enter the format name of the standard message received from the business process. A#2
Service components Format ID Enter the format ID (message format definition file for the file adapter) of the service component message. B
Message format Enter the format (message format definition file for the file adapter) of the service component message.
adpff_read.xsd is set, if the definition pattern is "Read XML" or "Read Binary".
A
Data transformation definition Enter the definition file name to be used to transform the data from the standard message to the service components. A#2
Response message - The information of the response message sent from a service component is displayed. You can set this item in the communication model column of the operation information only if you have selected "Synchronous". You must set this item, since you select "Synchronous" in the file adapter. -
Standard Use (Checkbox) Check this option when you transform the data of the standard message into the service component message format. Y
Format ID Enter the format ID of the standard message received from service components. A#3
Message format Enter the format name of the standard message received from service components. A#3
Service component Format ID Enter the message format ID (message format definition file for the file adapter) of service components. B
Message format Enter the message format (message format definition file for the file adapter) name of service components.
adpff_result.xsd is set if the definition pattern is "Write XML" or "Write Binary".
A
Data transformation definition Enter the definition file name to be used to transform the data from the service component message to the standard message. A#3

Legend:
B: Must be set.
Y: Setting is optional.
A: Must be set as per the condition.
N: Confirm the displayed contents.
-: Not applicable.

Note#1
In the file adapter, the output path of the trace is decided on the basis of the service ID. Therefore, to edit the service ID, do not specify the service ID same as the service ID of the TP1 adapter that is already created once. Note that service ID is case-insensitive. When you specify the same service ID, since the trace is output to the trace information that was created in the past, it might become difficult to investigate the cause of failure.

Note#2
You must set this item, if you have checked the [Use] (checkbox) of the request message.

Note#3
You must set this item, if you have checked the [Use] (checkbox) of the response message.

The following table describes the settings to be performed on the service adapter settings (details) screen at the time of defining file adapters:

Table 3-91 Settings to be performed on the service adapter settings screen (details) of file adapters

Classification Item Description Settings
Service adapter control information Service adapter (EJB-JAR file) The information on service components specified at the time of creating a file adapter is displayed. N
Utility class (JAR file) The name of the EJB-JAR file of the file adapter is displayed.
In the file adapter, the following utility class is set:
  • adpffpc.jar(protocol converter archive file)#
N
Self-defined file Do not use the self-defined file in the file adapter. -

Legend:
N: Confirm the displayed contents.
-: Not applicable.

Note#
The destination directory for storing files is "Installation directory of the service platform\CSC\custom-adapter\File\lib".

(7) For Message Queue adapters

The following table describes the settings to be performed on the service adapter settings (basic) screen at the time of defining Message Queue adapters. Settings are not required for the items that are not described in the table.

Table 3-92 Settings to be performed on the service adapter settings screen (basic) of Message Queue adapters

Classification Item Description Settings
Service component control information - The information on service components specified at the time of creating a Message Queue adapter is displayed. -
Service name The HCSC component name specified in the [Add service adapter settings (Message Queue adapter)] wizard is displayed. B
Service ID The HCSC component ID is displayed.#1 B
Service type The "Message Queue adapter" is displayed as the type of service component. N
Address Does not use this item. N
Maximum instance count The maximum instance count of the service component is displayed. B
Service class name Does not use this item. N
Operation The operation name is displayed. Select the operation name of service components from the drop-down list. B
Operation information - The information on service component operations is displayed. -
Operation name The name of the operation selected in the operation column of the service component control information is displayed. N
Communication model Select the communication model of the operation selected in the operation column of the service component control information. Select "Synchronous" in the Message Queue adapter. B
Request message - The information of the request message sent from the business process is displayed. -
Standard Use (Checkbox) Check this option when you transform the data of the standard message into the service component message format. Y
Format ID Enter the format ID of the standard message received from the business process. A#2
Message format Enter the format name of the standard message received from the business process. A#2
Service component Format ID Enter the format ID (message format definition file for the Message Queue adapter) of the service component message. B
Message format Enter the format name (message format definition file for the Message Queue adapter) of the service component message.
When the definition pattern is "Receive message", adpmq_rcv_request.xsd#3 is set.
When the definition pattern is "Browse and receive message", adpmq_browse_request.xsd#3is set.
A
Data transformation definition Enter the definition file name to be used to transform the data from the standard message to the service components. A#2
Response message - The information of the response message sent from service components is displayed. You can set this item in the communication model column of the operation information, only if you have selected "Synchronous". Because you select "Synchronous" in the Message Queue adapter, set this item without fail -
Standard Use (Checkbox) Check this option when you transform the data of the standard message into the service component message format. Y
Format ID Enter the format ID of the standard message received from service components. A#4
Message format Enter the format name of the standard message received from service components. A#4
Service component Format ID Enter the message format ID (message format definition file for the Message Queue adapter) of service components. B
Message format Enter the message format name (message format definition file for the Message Queue adapter) of service components.
When the definition pattern is "Send message", adpmq_snd_response.xsd#3 is set.
A
Data transformation definition Enter the definition file name to be used to transform the data from the service component message to the standard message. A#4
Fault message - The information on the fault message of service components is displayed. -
Fault name The fault name of service components is displayed. B
Message format "adpmq_fault_response.xsd" #3 is set when the definition pattern of operation is as follows:
  • Receive message
  • Browse and receive message
  • Send and receive message
N

Legend:
B: Must be set.
Y: Setting is optional.
A: Must be set as per the condition.
N: Confirm the displayed contents.
-: Not applicable.

Note#1
In the Message Queue adapter, the output path of the trace is decided on the basis of the service ID. Therefore, to edit the service ID, do not specify the service ID same as the service ID of the Message Queue adapter that is already created once. Note that service ID is case-insensitive. When you specify the same service ID, since the trace is output to the trace information that was created in the past, it might become difficult to investigate the cause of failure.

Note#2
You must set this item, if you have checked the [Use] (checkbox) of the request message.

Note#3
The destination directory for storing files is "Installation directory of the service platform\CSC\custom-adapter\MQ\schema".

Note#4
You must set this item, if you have checked the [Use] (checkbox) of the response message.

The following table describes the settings to be performed on the service adapter settings (details) screen at the time of defining Message Queue adapters:

Table 3-93 Settings to be performed on the service adapter settings screen (details) of Message Queue adapters

Classification Item Description Settings
Service adapter control information Service adapter (EJB-JAR file) The information on service components specified at the time of creating a Message Queue adapter is displayed. N
Utility class(JAR file) The name of the EJB-JAR file of the Message Queue adapter is displayed.
The following utility class is set:
  • adpmqpc.jar(protocol converter archive file)#1
N
Self-defined file The following self-defined file is set:
  • customadapter_properties.xml
  • ( Message Queue adapter environment-definition file) #2
  • adpmq_communication.xml
  • (Message Queue adapter communication-configuration definition file)#3
  • cscadapter_property.xml
  • (HITACHI Application Integrated Property File)#4
B

Legend:
B: Must be set.
N: Confirm the displayed contents.

Note#1
The destination directory for storing files is "Installation directory of the service platform\CSC\custom-adapter\MQ\lib".

Note#2
customadapter_properties.xml (Message Queue adapter environment-definition file) that is set is a template file. On selecting customadapter_properties.xml, click the [Edit] button to modify the contents, and then save the file. For details on the Message Queue adapter environment-definition file Message Queue, see Message Queue adapter environment-definition file in the manual Service Platform Reference Guide.

Note#3
adpmq_communication.xml (Message Queue adapter communication-configuration definition file) that is set is a template file. On selecting adpmq_communication.xml, click the [Edit] button to modify the contents, and then save the file, if necessary. For details on the Message Queue adapter communication-configuration definition file, see Message Queue adapter communication-configuration definition file in the manual Service Platform Reference Guide.

Note#4
cscadapter_property.xml (HITACHI Application Integrated Property File) that is set is a template file. On selecting cscadapter_property.xml, click the [Edit] button to modify the contents, and then save the file. For details on the HITACHI Application Integrated Property File, see 3.3.9(6) Editing HITACHI Application Integrated Property File.

(8) For FTP adapters

The following table describes the settings to be performed on the service adapter settings (basic) screen at the time of defining FTP adapters. Settings are not required for the items that are not described in the table.

Table 3-94 Settings to be performed on the service adapter settings screen (basic) of FTP adapters

Classification Item Description Settings
Service component control information Operation Add the operation to be used from among the following operations:
PUT: PUT (STOR or APPE) process
GET:GET (RETR) process
GETINFO:GETINFO (LIST or NLST) process
B
Operation information Communication model Set "Synchronous". B
Request message Service component Message format The following message format definition files are set as per [Operation] settings:
  • When the definition pattern is "Send file (PUT operation)"
    ftpadp_put_request.xsd#1
  • When the definition pattern is "Receive and Send file (GET operation)"
    ftpadp_get_request.xsd#1
  • When the definition pattern is "Acquire file information (GETINFO operation)"
    ftpadp_getinfo_request.xsd#1#2
N
Response message Service component Message format The following message format definition files are set as per [Operation] settings:
  • When the definition pattern is "Send file (PUT operation)"
    ftpadp_put_response.xsd#1
  • When the definition pattern is "Receive and Send file (GET operation)"
    ftpadp_get_response.xsd#1
  • When the definition pattern is "Acquire file information (GETINFO operation)"
    ftpadp_getinfo_response.xsd#1#2
N

Legend:
B: Must be set.
N: Confirm the displayed contents.

Note#1
The destination directory for storing files is "Installation directory of the service platform\CSC\custom-adapter\FTP\schema".

Note#2
To edit the FTP adapter defined in Service Platform version 09-50-01 or earlier, you must re-specify the message format. Click the [Browse] button of the message format, specify ftpadp_getinfo_request.xsd (or ftpadp_getinfo_response.xsd), and re-set in the message format.

The following table describes the settings to be performed on the service adapter settings (details) screen at the time of defining FTP adapters. Settings are not required for the items that are not described in the table.

Table 3-95 Settings to be performed on the service adapter settings screen (details) of FTP adapters

Classification Item Description Settings
Service adapter control information Utility class(JAR file) In the FTP adapter, the following utility class is set:
  • adpftppc.jar#
N
Self-defined file Do not use self-defined file in the FTP adapter. -

Legend:
N: Confirm the displayed contents.
-: Do not set.

Note#
The destination directory for storing files is "Installation directory of the service platform\CSC\custom-adapter\FTP\lib".

(9) For file operations adapters

The operation-wise settings to be performed on the service adapter settings screen at the time of defining file operations adapters are described here.

(a) File transformation operation

The following table describes the settings to be performed on the service adapter settings (basic) screen in the case of the file transformation operation. Settings are not required for the items that are not described in the table.

Table 3-96 Settings (file transformation operation) on the service adapter settings screen (basic) of the file operations adapter

Classification Item Description Settings
Service component control information Operation Add "Transform file (TRANSFORM operation)". B
Operation information Communication model Set "Synchronous". B
Request message Standard [Use] checkbox Do not check this check box. -
Service component Message format adpfop_transform_request.xsd# is set. N
Response message Standard [Use] checkbox Do not check this check box. -
Service component Message format adpfop_transform_response.xsd# is set. N
Fault message Message format Do not set. (Fault message is not used). -

Legend:

B: Must be set.

N: Confirm the displayed contents.

-: Do not set.

Note#
The destination directory for storing files is "Installation directory of the service platform\CSC\schema\adpfop".

The following table describes the settings to be performed on the service adapter settings (details) screen in the case of the file transformation operation. Settings are not required for the items that are not described in the table.

Table 3-97 Settings (file transformation operation) on the service adapter settings screen (details) of file operations adapters

Classification Item Description Settings
Service adapter control information Utility class (JAR file) adpfoppc.jar#1 is set. N
Self-defined file Common settings in batch processing method and segmentation method cscFileOperation.properties (file operations adapter definition file)#2 is set.
Add the following files when the character code conversion UOC references the self-defined file:
  • csc_owncodeconvert.properties
  • csc_owncodeconvert_in.properties (for input file)
  • csc_owncodeconvert_out.properties (for output file)
B
When batch processing method is selected Add the files specified in the following keys of the file operations adapter definition file:
  • csc.adapter.fileOperation.transform.all.inFormat
  • csc.adapter.fileOperation.transform.all.outFormat
  • csc.adapter.fileOperation.transform.all.styleSheet
B
When segmentation method is selected Add the files specified in the following keys of the file operations adapter definition file:
  • csc.adapter.fileOperation.transform.data.inFormat
  • csc.adapter.fileOperation.transform.data.outFormat
  • csc.adapter.fileOperation.transform.data.styleSheet

When you use the header record part (csc.adapter.fileOperation.transform.headerRecord=ON),add the files specified in the following keys of the file operations adapter definition file:
  • csc.adapter.fileOperation.transform.header.inFormat
  • csc.adapter.fileOperation.transform.header.outFormat
  • csc.adapter.fileOperation.transform.header.styleSheet

When you use the trailer record part (csc.adapter.fileOperation.transform.trailerRecord=ON),add the files specified in the following keys of the file operations adapter definition file:
  • csc.adapter.fileOperation.transform.trailer.inFormat
  • csc.adapter.fileOperation.transform.trailer.outFormat
  • csc.adapter.fileOperation.transform.trailer.styleSheet

When the output file is in XML format (csc.adapter.fileOperation.transform.output=xml), add the output template XML file specified with the csc.adapter.fileOperation.transform.outputTemplateXmlFile key.
B

Legend:
B: Must be set.
N: Confirm the displayed contents.

Note#1
The destination directory for storing files is "Installation directory of the service platform\CSC\lib".

Note#2
cscFileOperation.properties (file operations adapter definition file) that is set is a template file. On selecting cscFileOperation.properties, click the [Edit] button to modify the contents, and then save the file, if necessary. For details on the file operations adapter definition file, see File operations adapter definition file in the manual Service Platform Reference Guide.

(b) File replication operation

The following table describes the settings to be performed on the service adapter settings (basic) screen for the file replication operation. Settings are not required for the items that are not described in the table.

Table 3-98 Settings (file replication operation) on the service adapter settings screen (basic) of file operations adapters

Classification Item Description Settings
Service component control information Operation Add "Copy file (COPY operation)". B
Operation information Communication model Set "Synchronous". B
Request message Standard [Use] checkbox Do not check this check box. -
Service component Message format adpfop_copy_request.xsd#is set. N
Response message Standard [Use] checkbox Do not check this check box. -
Service component Message format adpfop_copy_response.xsd#is set. N
Fault message Message format Do not set. (Fault message is not used). -

Legend:
B: Must be set.
N: Confirm the displayed contents.
-: Do not set.

Note#
The destination directory for storing files is "Installation directory of the service platform\CSC\schema\adpfop".

The following table describes the settings to be performed on the service adapter settings (details) screen for the file replication operation. Settings are not required for the items that are not described in the table.

Table 3-99 Settings (file replication operation) on the service adapter settings screen (details) of file operations adapters

Classification Item Description Settings
Service adapter control information Utility class (JAR file) adpfoppc.jar#1 is set. N
Self-defined file cscFileOperation.properties (file operations adapter definition file)#2 is set. Y

Legend:
Y: Setting is optional.
N: Confirm the displayed contents.

Note#1
The destination directory for storing files is "Installation directory of the service platform\CSC\lib".

Note#2
cscFileOperation.properties (file operations adapter definition file) that is set is a template file. On selecting cscFileOperation.properties, click the [Edit] button to modify the contents, and then save the file, if necessary. For details on the file operations adapter definition file, see File operations adapter definition file in the manual Service Platform Reference Guide.

(c) File and folder deletion operation

The following table describes the settings to be performed on the service adapter settings (basic) screen for the file and folder deletion operation. Settings are not required for the items that are not described in the table.

Table 3-100 Settings (file and folder deletion operation) on the Service adapter settings screen (basic) of file operations adapters

Classification Item Description Settings
Service component control information Operation Add "Delete file (DELETE Operation)". B
Operation information Communication model Set "Synchronous". B
Request message Standard [Use] checkbox Do not check this check box. -
Service component Message format adpfop_delete_request.xsd#is set. N
Response message Standard [Use] checkbox Do not check this check box. -
Service component Message format adpfop_delete_response.xsd#is set. N
Fault message Message format Do not set. (Fault message is not used). -

Legend:
B: Must be set.
N: Confirm the displayed contents.
-: Do not set.

Note#
The destination directory for storing files is "Installation directory of the service platform\CSC\schema\adpfop".

The following table describes the settings to be performed on the service adapter settings (details) screen for the file and folder deletion operation. Settings are not required for the items that are not described in the table.

Table 3-101 Settings (file and folder deletion operation) on the service adapter settings screen (details) of file operations adapters

Classification Item Description Settings
Service adapter control information Utility class(JAR file) adpfoppc.jar#1 is set. N
Self-defined file cscFileOperation.properties (file operations adapter definition file)#2 is set. Y

Legend:
Y: Setting is optional.
N: Confirm the displayed contents.

Note#1
The destination directory for storing files is "Installation directory of the service platform\CSC\lib".

Note#2
cscFileOperation.properties (file operations adapter definition file) that is set is a template file. On selecting cscFileOperation.properties, click the [Edit] button to modify the contents, and then save the file, if necessary. For details on the file operations adapter definition file, see File operations adapter definition file in the manual Service Platform Reference Guide.

(d) File compression operation

The following table describes the settings to be performed on the service adapter settings (basic) screen for the file compression operation. Settings are not required for the items that are not described in the table.

Table 3-102 Settings (file compression operation) on the Service adapter settings screen (basic) of file operations adapters

Classification Item Description Settings
Service component control information Operation Add "Compress file (COMPRESS Operation)". B
Operation information Communication model Set "Synchronous". B
Request message Standard [Use] checkbox Do not check this check box. -
Service component Message format adpfop_compress_request.xsd# is set. N
Response message Standard [Use] checkbox Do not check this check box. -
Service component Message format adpfop_compress_response.xsd# is set. N
Fault message Message format Do not set. (Fault message is not used). -

Legend:
B: Must be set.
N: Confirm the displayed contents.
-: Do not set.

Note#
The destination directory for storing files is "Installation directory of the service platform\CSC\schema\adpfop".

The following table describes the settings to be performed on the service adapter settings (details) screen for the file compression operation. Settings are not required for the items that are not described in the table.

Table 3-103 Settings (file compression operation) on the service adapter settings screen (details) of file operations adapters

Classification Item Description Settings
Service adapter control information Utility class(JAR file) adpfoppc.jar#1is set. N
Self-defined file cscFileOperation.properties (File operations adapter definition file) #2 is set. Y

Legend:
Y: Setting is optional.
N: Confirm the displayed contents.

Note#1
The destination directory for storing files is "Installation directory of the service platform\CSC\lib".

Note#2
cscFileOperation.properties (file operations adapter definition file) that is set is a template file. On selecting cscFileOperation.properties, click the [Edit] button to modify the contents, and then save the file, if necessary. For details on the file operations adapter definition file, see File operations adapter definition file in the manual Service Platform Reference Guide.

(e) File extraction operation

The following table describes the settings to be performed on the service adapter settings (basic) screen for the file extraction operation. Settings are not required for the items that are not described in the table.

Table 3-104 Settings (file extraction operation) on the Service adapter settings screen (basic) of file operations adapters

Classification Item Description Settings
Service component control information Operation Add "Extract file (EXTRACT Operation)". B
Operation information Communication model Set "Synchronous". B
Request message Standard [Use] checkbox Do not check this check box. -
Service component Message format adpfop_extract_request.xsd#is set. N
Response message Standard [Use] checkbox Do not check this check box. -
Service component Message format adpfop_extract_response.xsd# is set. N
Fault message Message format Do not set. (Fault message is not used). -

Legend:
B: Must be set.
N: Confirm the displayed contents.
-: Do not set.

Note#
The destination directory for storing files is "Installation directory of the service platform\CSC\schema\adpfop".

The following table describes the settings to be performed on the service adapter settings (details) screen for the file extraction operation. Settings are not required for the items that are not described in the table.

Table 3-105 Settings (file extraction operation) on the Service adapter settings screen (details) of file operations adapters

Classification Item Description Settings
Service adapter control information Utility class(JAR file) adpfoppc.jar#1is set. N
Self-defined file cscFileOperation.properties (file operations adapter definition file) #2 is set. Y

Legend:
Y: Setting is optional.
N: Confirm the displayed contents.

Note#1
The destination directory for storing files is "Installation directory of the service platform\CSC\lib".

Note#2
cscFileOperation.properties (file operations adapter definition file) that is set is a template file. On selecting cscFileOperation.properties, click the [Edit] button to modify the contents, and then save the file, if necessary. For details on the file operations adapter definition file, see File operations adapter definition file in the manual Service Platform Reference Guide.

(10) For mail adapters

The following table describes the settings to be performed on the service adapter settings (basic) screen at the time of defining mail adapters. Settings are not required for the items that are not described in the table.

Table 3-106 Settings to be performed on the service adapter settings screen (basic) of mail adapters

Classification Item Description Settings
Service component control information Operation Add "SEND". B
Operation information Communication model Set "Synchronous". B
Request message Service component Format ID Specify any format ID. B
Message format adpmail_smtp_request.xsd # is set. N
Response message Service component Format ID Specify any format ID. B
Message format adpmail_smtp_response.xsd # is set. N
Fault message Do not set. (Fault message is not used). -

Legend:
B: Must be set.
N: Confirm the displayed contents.
-: Do not set.

Note#
The destination directory for storing files is "Installation directory of the service platform\CSC\schema\mail".

The following table describes the settings to be performed on the service adapter settings (basic) screen at the time of defining mail adapters:

Table 3-107 Settings to be performed on the service adapter settings screen (details) of mail adapters

Classification Item Description Settings
Service adapter control information Service adapter (EJB-JAR file) cscmsg_adpejb.jar is set. N
Utility class(JAR file) The following utility class is set:
  • adpmailpc.jar#
N
Self-defined file Self-defined file is not used in the mail adapter. -

Legend:
N: Confirm the displayed contents.
-: Do not set.

Note#
The destination directory for storing files is "Installation directory of the service platform\CSC\lib".

To edit the added mail adapter, select the corresponding mail adapter from the service definition list in the tree view, and then double-click.

(11) For HTTP adapters

The following table lists and describes the settings to be performed on the service adapter settings (basic) screen at the time of defining the HTTP adapter. Settings are not required for the items that are not described in the table.

Table 3-108 Settings to be performed on the service adapter settings screen (basic) of HTTP adapters

Classification Item Description Settings
Service component control information Transform the system exception to a fault (Check box) Check when the system exception such as communication error is processed as a fault. Y
Operation information Communication model Set "synchronous". B
Request message Body Service component message format Specify following message formats as per the data to be sent:
B
Response message Body Service component message format Specify the message format according to the received data:
B
Fault message Fault message format adphttp_fault.xsd # is set. N

Legend:
B: Must be set.
Y: Setting is optional.
N: Confirm the displayed contents.

Note#
The destination directory for storing files is "Installation directory of the service platform\CSC\custom-adapter\HTTP\schema".

The following table lists and describes the settings to be performed on the service adapter settings (details) screen at the time of defining HTTP adapters:

Table 3-109 Settings to be performed on service adapter settings screen (details) of HTTP adapters

Classification Item Description Settings
Service adapter control information Service adapter (EJB-JAR file) cscmsg_adpejb.jar is set. N
Utility class(JAR file) adphttppc.jar#1 is set. N
Self-defined file cscadphttp.properties#2 is set. Y
Add the customer adapter definition file (csccustomadapter.properties)#3, if necessary. Y

Legend:
Y: Set this item, if necessary.
N: Confirm the displayed contents.

Note#1
The destination directory for storing files is "Installation directory of the service platform\CSC\custom-adapter\HTTP\lib".

Note#2
cscadphttp.properties (HTTP-adapter definition file) that is set is a template file. On selecting cscadphttp.properties, click the [Edit] button to modify the contents, and then save the file if necessary. For details on the HTTP-adapter definition file, see
HTTP-adapter definition file in the manual Service Platform Reference Guide.

Note#3
For details on the custom adapter definition file (csccustomadapter.properties), see "Appendix B.2(4) Custom adapter definition file".

To edit the added HTTP adapter, select the corresponding HTTP adapter from the service definition list in the tree view, and then double-click.

(12) For custom adapters

The following table describes the settings to be performed on the service adapter settings screen at the time of defining custom adapters:

Table 3-110 Settings to be performed on the service adapter settings screen of custom adapters

Classification Item Settings
Synchronous Asynchronous
Basic screen Service component control information Service name B B
Service ID B B
Service type N N
Address N N
Maximum instance count #1 A A
Service class name N N
Operation B B
Transform the system exception to a fault (Check box) Y Y
Operation information Operation name A A
Communication model B #2 B #3
Request message Use (Checkbox) for any type Y Y
Use (Checkbox) Y Y
Standard format ID A#4 A#4
Standard message format A#4 A#4
Service component format ID B B
Service component message format B B
Data transformation definition A#4 A#4
Response message Use (Checkbox) for any type Y -
Use (Checkbox) Y -
Standard format ID A#5 -
Standard message format A#5 -
Service component format ID B -
Service component message format B -
Data transformation definition A#5 -
Fault message Fault name - -
Service component message format - -
Detailed screen Service adapter control information Service adapter (EJB-JAR file) N N
Utility class(JAR file) B B
Self-defined file B B

Legend:
B: Must be set.
Y: Setting is optional.
A: Must be set as per the condition.
N: Confirm the displayed contents.
-: Not applicable.

Note#1
If you have added the element of the HITACHI Application Integrated Property File as the self-defined file, the value set in the service adapter setting screen is not applied.
For the maximum instance count, the value specified in the element "hitachi-application-all-property/ejb-jar/hitachi-session-bean-property/session-runtime/stateless/pooled-instance/maximum"in the HITACHI Application Integrated Property File is set.

Note#2
Set "Synchronous".

Note#3
Set "Asynchronous".

Note#4
You must set this item, if you have checked the [Use] (checkbox) of the request message.

Note#5
You must set this item, if you have checked the [Use] (checkbox) of the response message.