uCosminexus Service Platform Reference Guide

3021-3-J46-10(E)

Notices

Relevant program products

See the Release Notes.

Export restrictions

If you export this product, please check all restrictions (for example, Japan's Foreign Exchange and Foreign Trade Law, and USA export control laws and regulations), and carry out all required procedures.

If you require more information or clarification, please contact your Hitachi sales representative.

Trademarks

HITACHI, Cosminexus, HiRDB, OpenTP1,uCosminexus are either trademarks or registered trademarks of Hitachi, Ltd. in Japan and other countries.

AIX is a trademark of International Business Machines Corporation, registered in many jurisdictions worldwide.

IBM is a trademark of International Business Machines Corporation, registered in many jurisdictions worldwide.

Linux is the registered trademark of Linus Torvalds in the U.S. and other countries.

Microsoft, Excel are trademarks of the Microsoft group of companies.

Microsoft, Microsoft 365 are trademarks of the Microsoft group of companies.

Microsoft, Windows are trademarks of the Microsoft group of companies.

Microsoft is a trademark of the Microsoft group of companies.

Oracle, Java, and MySQL are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

UNIX is a trademark of The Open Group.

Other company and product names mentioned in this document may be the trademarks of their respective owners.

Eclipse is an open development platform for tools integration provided by Eclipse Foundation, Inc., an open source community for development tool providers.

This product includes software developed by the Apache Software Foundation (http://www.apache.org/).

About Eclipse menu item names

The Eclipse menu item names used in this manual might be different from those actually displayed in Eclipse, depending on the version of Eclipse.

Issued

Aug. 2022: 3021-3-J46-10(E)

Copyright

All Rights Reserved. Copyright (C) 2022, Hitachi, Ltd.

Preface

For details on the prerequisites before reading this manual, see the Release Notes.

Part 1: Development Environment Reference

1 Windows (Development Environment)

This chapter explains the windows used in the development environment of a Service platform.

1.1 Window configuration (development environment)

This section explains the configuration of the windows used in the development environment.

1.1.1 Configuration of the window for creating binary format definition files

The following window is used to define elements for binary format definition files created by using a wizard. The following describes the configuration of the window.

Figure 1‒1: Configuration of the window for creating binary format definition files

Package Explorer

Displays a list of binary format definition files.

Binary Format Definition window

You use this window for defining the contents of binary format definition files. It consists of the Binary Format Definition Editor and an outline view.

For details about the Binary Format Definition window, see 1.2.1 Binary Format Definition Window.

Properties view

Displays the information about the binary format definition files defined in the Binary Format Definition window and information about various elements.

Console view

Displays the validation results of binary format definition files.

Problems view

Displays a list of problems when the validation of binary format definition files detects problems.

Reference note

Depending on the Eclipse perspective, some of the views may not be displayed in their initial states. In this case, on the Eclipse Window menu, choose Show Views, and open the necessary view.

1.1.2 Configuration of the window for creating HCSC components and defining data transformation

The following window is used to create HCSC components and define data transformation. The following describes the configuration of the window.

Figure 1‒2: Configuration of the window for creating HCSC components and defining data transformation

Tree view

Displays a service definition list, a published services list, and a system configuration list.

You can filter the items displayed in the tree view by entering an item name in the text box at the top of the tree view.

Definition area

Displays one of the following definition windows and information display windows according to the operation:

Service adapter definition window

Business Process Definition window

Data Transformation Definition window

User-Defined Reception Definition window

HCSC Component Information Display window

User-Defined Reception Information Display window

For details about each window, see 1.2 Definition windows and information display windows.

Properties view

Displays the information about the HCSC components defined in the definition area.

Problems view

Displays a list of problems when the validation of HCSC components and data transformation definitions detects a problem.

Console view

Displays the following information:

Output time in [yyyy/MM/dd HH:mm:ss] format

Error information

Validation results

HCSCTE result view

Displays the following information as a result of processing that causes validation, packaging, publication, and disassociation:

Service name

Service type

Message

1.1.3 Configuration of the Debug Business Process screen

The following shows the configuration of the window used for debugging business processes.

Figure 1‒3: Configuration of the Debug Business Process screen

(1) Debug view

The Debug view displays the name of the business process being debugged and the name of the interrupted activity. The Debug view also performs operations such as step execution, restart, and termination.

Figure 1‒4: Debug view

The Debug view displays the following icons:

Table 1‒1: Debug view icons

Icon

Name

Explanation

Debug configuration

Displays the name specified in the Debug dialog [HCSC-BP].

Business process

Displays the name of the business process during debug.

Process instance#

Displays the name of the process instance.

Activity

Displays the name of the interrupted activity.

HCSC server

Displays the HCSC server normally.

Step in

Performs step execution and restart of the interrupted activity.

For details about the processing during step in, step over, step return, and restart, see the contents related to debugging of business processes in the manual Service Platform Basic Development Guide.

Step over

Step return

Restart

End

Debugging of the business process ends.

#

If the processing of the process instance is interrupted, the icon appears. If the process instance is being processed, the icon appears.

(2) Variable view

Use the Variable view for checking the variables and correlation sets currently in use in the business process, and also for updating the value of the variables.

Figure 1‒5: Variable view

Name

Displays the names of the variables () and correlation sets ().

Value

Displays the value of the variables and correlation sets. When the value of a variable changes due to the execution of a business process, and when the value of a variable is updated, the Name and Value cells of the variable with the changed value appear in Yellow color. If a variable is not initialized, <uninitialized> is displayed. Note that if the name of the variable and correlation set is the same in both the executing scope and parent scope, the variable view displays the variable and correlation set of the executing scope.

(3) Break point view

Use the Break point view for enabling or disabling the break point settings:

Figure 1‒6: Break point view

The break point set in an activity is displayed in the business-process-name [activity-name] format. If you have specified a conditional expression in the break point, the break point is displayed in the business-process-name [activity-name]:conditional-expression format.

Select the checkbox to enable a set break point. Deselect the checkbox to disable a set break point.

Note that you cannot use the functionality for skipping all break points (), when debugging a business process.

(4) Business process editor

The business process editor displays the business process during debug.

Figure 1‒7: Business process editor

If the processing of the process instance interrupts, the interrupted activity appears in Green color.

Note that a mark indicating the break point appears in an activity in which you have specified a break point. If the break point is enabled, the mark is selected as shown in the following figure. If the break point is disabled, the mark is deselected.

Figure 1‒8: Activity in which a break point is specified

(5) HCSC automatic emulation view

Use the HCSC automatic emulation view, when setting automatic emulation of a service.

Figure 1‒9: HCSC automatic emulation view

Valid

Select the checkbox to enable the automatic emulation settings of the service.

Priority

Displayed in the order of 1, 2, 3, ... starting from the first line.

Service name

If you select a cell, a list of services that can be selected appears as a drop down list.

Operation name

If you select a cell, a list of operations of the service selected in Service name appears as the drop down list.

Response type

If you select a cell, you can select a normal response or fault response from the drop down list.

Response message

If you select a cell, the ... button appears. If you click the ... button, a dialog for setting the response message appears. If the response message is already set up, the file name of the response message appears.

Condition

Enter the conditional expression for emulating the service in XPath. Note the following points for entering the conditional expression:

You need not specify the variable name to set up the conditions for the request message of the service.

You cannot use blank characters (0x00) and extension functions, such as csc:getVariableData.

If the conditional expression is not specified, true is assumed always.

Add button

Adds rows to the table.

Delete button

If you select a cell and click the Delete button, the row containing the selected cell is deleted.

Up button

Increases the priority order of the selected row.

Down button

Decreases the priority order of the selected row.

Save button

Displays the dialog for saving the information set up in the HCSC automatic emulation view.

Load button

Displays the dialog for acquiring the information set up in the HCSC automatic emulation view.

(6) HCSC emulation view

Use the HCSC emulation view, when setting and executing manual emulation of the service.

Figure 1‒10: HCSC emulation view

Response type

If you select a cell, a drop down list appears and you can select a normal response or a fault response.

Response message

If you select a cell, the ... button appears. If you click the ... button, a dialog for setting the response message appears. If the response message is already set up, the file name of the response message appears.

Add button

Adds rows to the table.

Delete button

If you select a cell and click the Delete button, the row containing the selected cell is deleted.

Restart button

The service is emulated, and then debugging of the business process restarts.

Step over button

The service is emulated, and then step over of debugging of the business process occurs.

Save button

Displays the dialog for saving the information set up in the HCSC emulation view.

Load button

Displays the dialog for acquiring the information set up in the HCSC emulation view.

(7) HCSC XPath evaluation view

Use the HCSC XPath evaluation view, when evaluating the conditional expression of the switch start and assign activities.

Figure 1‒11: HCSC XPath evaluation view

XPath expression

Enter the conditional expression in XPath. Note the following points while entering the conditional expression:

You cannot use blank characters (0x00).

You cannot perform equivalence judgment of values included in linefeed.

For example, the value of element /y/z of the variable x is assumed as follows:

"a
b"

At this stage, even if you execute XPath evaluation with the following XPath expression, the evaluation result is not true:

$x/y/z="a
b"

This can be avoided by using the normalize-space() function of XPath to remove a linefeed character and space.

Evaluate button

Evaluates the conditional expression entered in the XPath expression.

Evaluation result

Displays the evaluation result of the conditional expression entered in the XPath expression.

(8) Outline view

The outline view displays the names of the variables and activities defined in a business process that is being debugged.

Figure 1‒12: Outline view

1.2 Definition windows and information display windows

Table 1-1 lists the windows that are used in the development environment.

Table 1‒2: List of windows used in the development environment

Window

Explanation

Window name

Window components (tabs, etc.)

Binary Format Definition window

Binary Format Definition Editor

Defines the contents of binary format definition files.

Outline view

Displays the relationship among the elements defined by the Binary Format Definition Editor.

Service adapter definition window

(Web Service)

Basic definitions

Defines the basic items for Web Services.

Detailed definitions

Defines the detailed items for Web Services.

Service adapter definition window

(SessionBean)

Basic definitions

Defines the basic items for SessionBean.

Detailed definitions

Defines the detailed items for SessionBean.

Service adapter definition window

(MDB /WS-R)

Basic definitions

Defines the basic items for MDB/WS-R.

Detailed definitions

Defines the detailed items for MDB/WS-R.

Service adapter definition window

(MDB/DBQueue))

Basic definitions

Defines the basic items for MDB/DB Queue).

Service adapter definition window (for custom adapter)

Basic definitions

Defines the basic items for a database adapter.

Detailed definitions

Defines the detailed items for a database adapter.

Service adapter definition window

(for other adapters)

Basic definitions

Defines the basic items for the following adapters:

DB adapter

TP1 adapter

File adapter

Object Access adapter

Message Queue adapter

FTP adapter

File operations adapter

Mail adapter

Command adapter

HTTP adapter

SFTP adapter

Detailed definitions

Defines the detailed items for the following adapters:

DB adapter

TP1 adapter

File adapter

Object Access adapter

Message Queue adapter

FTP adapter

File operations adapter

Mail adapter

Command adapter

HTTP adapter

SFTP adapter

Business Process Definition window

Defines business processes.

Data Transformation Definition window

Defines data transformation.

User-Defined Reception Definition window

Displays the definition contents of a user-defined reception.

HCSC Component Information Display window

Displays HCSC server configuration and HCSC component information.

User-Defined Reception Information Display window

Displays the information of a user-defined reception.

The following table describes the symbols used in the explanations of windows and operations in this chapter.

Symbol

Meaning

< >

Angle brackets (< >) indicate that the enclosed name varies depending on the user environment.

Italic

Italic characters indicate input values, variables, or text to be provided by the user (such as in messages).

Important note

HCSCTE does not support concurrent operations from multiple windows. Therefore, do not open a new window by selecting Window, and then New Window on the Eclipse menu.

If an attempt to open the Business Process Definition window or Service adapter definition window fails, an invalid editor might open. Immediately close this editor in order to prevent malfunction.

1.2.1 Binary Format Definition Window

This subsection explains the Binary Format Definition window used to define binary format definition files.

For details about how to create binary format definition files, see 4.4 Creating Message Formats (Binary Format Definition File) in the Service Platform Basic Development Guide.

Figure 1‒13:  Binary Format Definition window

The Binary Format Definition window consists of the Binary Format Definition Editor and an Outline view.

The display contents of each of these window components are explained below.

(1) Binary Format Definition Editor

The Binary Format Definition Editor defines the contents of a binary format definition file by specifying its elements. The defined contents are displayed in a tree format.

The display contents of the Binary Format Definition Editor are shown in the following figure and explained below.

Figure 1‒14: Binary Format Definition Editor

Binary format definition file name

This is the name of a binary format definition file.

Using the Binary Format Definition Editor, you can open and edit multiple binary format definition files. Clicking the name of the binary format definition file to be edited makes the editing target active. The display in the outline view also changes.

Format ()

This is the format name of a binary format definition file.

Node

This is an element defined inside a binary format definition file.

The first hierarchy within a node consists of globally defined elements. The second hierarchy consists of components of complex content elements. An icon and an element name are displayed for each node.

When you select a node in the Binary Format Definition Editor, the same node also becomes selected in the outline view.

The following table lists the display contents of each node.

Table 1‒3:  Nodes displayed in the Binary Format Definition Editor

Classification

Icon

Explanation

Globally defined element

Simple content element

Complex content element with a sequential configuration

Complex content element with a sequential configuration specified as the root element

Complex content element with a selective configuration

Complex content element with a selective configuration specified as the root element

Component of a complex content element

Simple content element specified as a component

Complex content element with a sequential configuration specified as a component

Complex content element with a selective configuration specified as a component

Loinvokey defined simple content element

If a warning or error occurs in a node as a result of validation, the node is displayed with the corresponding icon (warning: ; error: ).

Occurrence count

If an occurrence count is specified for a node, it is displayed in the following format:

minimum-occurrence-count:maximum-occurrence-count

How the occurrence count is displayed depends on how the occurrence count was specified when a component was specified. The following table lists the relationship between the occurrence count display and the setting contents.

Table 1‒4:  Relationship between the occurrence count display and the setting contents

Display format

Occurrence count specification method

Explanation

[n:n]

Fixed

n is a fixed occurrence count.

The same value is displayed in the minimum occurrence count and maximum occurrence count. For example, if the occurrence count is fixed to 3, [3:3] is displayed.

[n:*]

Until end of data

When the data can be omitted:

The minimum occurrence count n becomes 0, and [0:*] is displayed.

When the data cannot be omitted:

The minimum occurrence count n becomes 1, and [1:*] is displayed.

[0:*]->

Node specification

The minimum occurrence count and the maximum occurrence count are displayed as 0 and *, respectively. Additionally, -> is displayed, indicating that this node references another node.

[n:m]

Range specification

Indicates that the occurrence count is in the range of n to m.

Dependence relationship

For a node, that references another node (dependent node), -> is displayed. However, nothing is displayed for the referenced node (target node).

The detailed information (such as paths) of a dependent relationship is displayed in the Properties view.

(2) Outline view

In the outline view, you can verify the relationship among the various elements that were defined in the Binary Format Definition Editor. The element relationship is expressed in a tree format, with the root element as the starting point.

The display contents of the outline view are automatiinvokey updated when an element is defined in the Binary Format Definition Editor. You cannot define an element in the outline view.

When you select a node (root element or component) displayed in the outline view, the same node also becomes selected in the Binary Format Definition Editor.

The display contents of the outline view are shown in the following figure and explained below.

Figure 1‒15:  Outline view

Node

This is an element defined inside a binary format definition file.

The following table lists the display contents of each node.

Table 1‒5:  Nodes displayed in the outline view

Classification

Icon

Explanation

Root element

Complex content element with a sequential configuration specified as the root element

Complex content element with a selective configuration specified as the root element

Component

Simple content element specified as a component

Complex content element with a sequential configuration specified as a component

Complex content element with a selective configuration specified as a component

Loinvokey defined simple content element

If a warning or error occurs in a node as a result of validation, the node is displayed with the corresponding icon (warning: ; error: ).

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.

(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.

(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.

(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.

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) 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.

(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.

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(3)(a) NonCustom Standard Editor.

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

(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.

(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.

1.2.3 Business Process Definition Window

This section explains the Define Business Process window used to define business processes.

For details about the operation method, see 1.12 Operations in the Business Process Definition Window.

Figure 1‒25: Business Process Definition window

(1) Palette

From the tools on the palette, select the activities and connections to be deployed on the canvas.

The items on the palette are shown in the following figure and explained below.

Figure 1‒26: Palette (Business Process Definition window)

Group

Connections or activities of the same type are gathered into a group. A group is preceded by a folder icon ().

Tool

A tool is an activity, connection, or comment contained in a group. You can deploy selected activities on the canvas by clicking the desired location or by using drag and drop operations.

When you select a connection and then select two activities deployed on the canvas, those activities are linked.

The following table lists the groups and tools on the palette.

Table 1‒6: Groups and tools on the palette (Business Process Definition window)

Icon

Display name

Explanation

Select node

Selects an activity or connection on the canvas

Connection

Groups together normal connections, link connections, and fault connections

Connection

Connection that links normal activities

Link

Link connection that links activities for defining a link

Fault

Fault connection that links activities for defining fault processing

Basic Activity#

Groups together basic activities, such as receive activities and response activities, that are defined in business processes

Receive

Receive activity

Reply

Reply activity

Invoke Service

Invoke service activity

Invoke Java

Invoke Java activity

Data Transformation

Data transformation activity

Assign

Assign activity

Empty

Empty activity

Throw

Throw activity

Standby

Standby activity

Validation

Validation activity

Structure Activity#

Groups together activities, such as scope activities and while activities, that are structurally defined in business processes

Scope

Scope activity

While

While activity

Switch Start

Switch Start activity

Switch End

Switch End activity

Flow Start

Flow Start activity

Flow End

Flow End activity

Utility

Group of utilities

Comment

Create a comment

#

For details, see the uCosminexus Application Server and BPM/ESB Platform Terminology Guide.

(2) Canvas

Activities selected from the palette can be deployed on the canvas. You can also link deployed activities through connections. With the activity auto connect function enabled, if an activity being deployed or moved on the canvas is placed near another activity, a preview of the connection between the activities appears. When the activity is deployed in this state, the connection is determined and the activities are linked. For details about the auto connect function, see 1.12.15 Enabling and disabling the activity auto connect function.

Variable-Correlation, Start Activity, which indicates the beginning of a business process, and End Activity, which indicates the end of the business process, are already deployed on the canvas.

Figure 1‒27: Canvas

Variable-Correlation ()

Use this for defining variable-correlation sets. Clicking this item opens the List Of Variables And Correlation Sets dialog.

Start Activity ()

This is a start activity. This activity cannot be deleted.

End Activity ()

This is an end activity. This activity cannot be deleted.

(3) Tab

You can use the tab for the following activities to close open tabs and open higher-order tabs:

Scope activity

While activity

Data transformation activity

(a) Closing open tabs

There are the following three methods of closing open tabs:

For the Scope activity and While activity, right-click the canvas in which no items are selected, and then select Close Tab in the context menu.

Right-click the tab to be closed, and then select Close Tab in the context menu.

Click the mouse wheel on the tab to be closed.

Note that if you attempt to close a tab that is being edited by the Data transformation activity, a message asking you whether you can abort the changes appears. Select the Yes button if you want to abort the changes.

(b) Opening higher-order tabs

There are the following two methods of opening a higher-order tab for an activity:

For the Scope activity and While activity, right-click the canvas in which no items are selected, and then select Open Tab of Definition Canvas in the context menu.

Right-click the tab you want to open, and then select Open Tab of Definition Canvas.

After the operation, the tab you opened becomes active.

(4) Outline view

The outline view displays a list of variables and activities defined in a business process. The display of the outline view is automatically updated when a business process is defined.

Double-clicking a variable in the outline view opens the List Of Variables And Correlation Sets dialog box in which the items selected in the outline view are also selected. In addition, when you select an activity in the outline view, the same item will also be selected in the Define Business Process window.

You can filter the items displayed in the outline view by entering an item name in the text box at the top of the outline view. The filter functions include a variable list filter and an activity filter. For details about these filters, see 1.14 Filter function settings of the outline view.

The following describes the information displayed in the outline view.

Figure 1‒28: Outline view (Define Business Process window)

Group

A group of variables or activities

Variable or activity

A variable or activity defined in the business process

The following table lists the groups, variables, and activities displayed in the outline view.

Table 1‒7: Groups, variables, and activities in the outline view (Define Business Process window)

Icon

Display name

Explanation

Variable list

Group of variables

variable-names

Variable

Activity list

Group of activities

receive-activity-name

Receive activity

reply-activity-name

Reply activity

invoke-service-activity-name

Invoke service activity

invoke-Java-activity-name

Invoke Java activity

data-transformation-activity-name

Data transformation activity

assign-activity-name

Assign activity

empty-activity-name

Empty activity

throw-activity-name

Throw activity

standby-activity-name

Standby activity

validation-activity-name

Validation activity

scope-activity-name

Scope activity. Variables and activities defined in a scope activity are displayed in a tree format with the scope activity as the starting point.

while-activity-name

While activity. Activities defined in a while activity are displayed in a tree format with the while activity as the starting point.

Switch-Start-activity-name

Switch Start activity

Switch-end-activity-name

Switch End activity

Flow-Start-activity-name

Flow Start activity

Flow-End-activity-name

Flow End activity

contents-of-the-first-line-of-a-comment

Comment

1.2.4 Data Transformation Definition Window

You can define data transformation by using the mapping definition editor.

For the operation method, see 1.13 Operations in the Data transformation definition Window.

Figure 1‒29: Data Transformation (Mapping) Definition window

(1) Source schema tree viewer, mapping viewer, and target schema tree viewer

Map nodes in the source schema tree viewer to nodes in the target schema tree viewer. In the mapping viewer, you can deploy functions selected from the palette, and connect node adapters and functions with mapping lines.

The items in the source schema tree viewer, the mapping viewer, and the target schema tree viewer are shown in the following figure and explained below.

Figure 1‒30: Source schema tree viewer, mapping viewer, and target schema tree viewer

Node

These are the schema logical names, elements, and attributes of XML schemas.

The icons displayed for nodes and their meanings are explained below.

Schema logical name ()

Indicates a logical name for identifying an XML schema file.

Complex content ()

Indicates a complex element that has a complex content.

Simple content ()

Indicates a complex element that has both a simple element and simple content.

Attribute ()

Indicates the attribute of an element.

The value inside the square brackets ([ ]) following the node indicates the occurrence count of the node. The occurrence count is displayed in the following format:

[minimum-occurrence-count:maximum-occurrence-count]

If there is no upper limit for the maximum occurrence count, an asterisk (*) is displayed.

If both the minimum occurrence count and the maximum occurrence count are 1, no occurrence count is displayed.

You can copy a path to the clipboard by selecting and right-clicking the path and then clicking Copy Element Path in the context menu. In the case of N-to-one transformation, the path including $schema-logical-name (business-process-variable-name) is copied.

Node-mapping line

A line that indicates mapping between a node and a node adapter.

Node adapter

Node adapters are displayed for all nodes. Map the source node adapters to target node adapters by connecting those using mapping lines. There are two types of node adapters. One type is a mapping-target node adapter () and the other type is a non-mapping-target node adapter (). For details about the mapping targets and non-mapping targets, see the description of mapping conditions in the manual Service Platform Basic Development Guide.

Note that you cannot scroll node adapters with the scroll bar displayed in the mapping viewer. You can move the scroll bar displayed in the transformation destination schema tree viewer scroll to scroll the node adapters.

(2) Palette

From the tools on the palette, select the functions to be deployed in the mapping viewer. Also select mapping lines to connect node adapters and functions.

The items on the palette are shown in the following figure and explained below.

Figure 1‒31: Palette (Data Transformation Definition window)

Group

Functions of the same type are gathered into a group. A group is preceded by a folder icon (). Clicking a group hides the tool list under the group. When the tool list is hidden, a list of tools is displayed.

Tool

A tool can be a function or a mapping line, for example. You can deploy the functions that you have selected in the mapping viewer, or map node adapters and functions with mapping lines.

The following table lists the groups and tools on the palette.

Table 1‒8: Groups and tools on the palette (Data Transformation Definition window)

Icon

Display name

Explanation

Select node

Selects functions and mapping lines in the mapping viewer.

Marquee

Selects the functions and mapping lines contained inside the rectangular frame.

Mapping

Mapping lines for connecting nodes and functions.

Character string

Group made up of all string-related functions.

concat

String-concatenating function.

substr

Substring-acquiring function.

length

String-length-acquiring function.

contain

String-checking function.

trim

Node-trimming function.

Number

Group made up of all number-related functions.

format

Number format conversion function.

calc

Node operation function.

round

Node-rounding function.

sum

Node summing-up function.

bit

Group made up of all bit-related functions

not

NOT operation function

bitop

Logical operation function

shift

Shift operation function

node

Group made up of all node-related functions.

name

Node name-acquiring function.

count

Node count-acquiring function.

exist

Node-checking function.

Control

Group made up of all functions that control mapping.

loop

Node-looping function.

choose

Node-choosing function.

Other

Group made up of all functions that do not belong to any other group.

replace

Change value function.

radix

Radix conversion function

custom

Custom function.

const

Constant-setting function.

xpath

XPath function.

1.2.5 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 Service Platform Reception and Adapter Definition Guide.

(1) SOAP reception types

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

(a) Basic window for SOAP reception

The following explains the items of the basic window for SOAP reception.

Figure 1‒32: User-Defined Reception Definition window

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

• 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.

• 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

• 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.

• 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.

(b) Details window for SOAP reception

The following explains the items of the details window for SOAP reception. This window is used in SOAP1.1/1.2 combined mode only.

Figure 1‒33: User-Defined Reception Definition window (details window for SOAP reception)

User-defined reception control information

Displays the names of self-defined files.

Self-defined file

Displays self-defined files.

You can add, edit, and delete self-defined files and specify the 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 the 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 you whether you want to save the self-defined file.

Output button

Opens the dialog box for specifying the output destination of the self-defined file.

Delete button

Deletes the file selected in the Self-defined file field.

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

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

TP1/RPC reception

FTP reception

HTTP reception

Message Queue reception

File event reception

Custom reception

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

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

Figure 1‒34: User-Defined Reception Definition window (basic window for TP1/RPC reception, FTP reception, HTTP reception, Message Queue reception, file event reception, and custom reception)

User defined reception information

Reception name

Displays the reception name. You can specify a reception name by using 40 or fewer bytes. For the user-defined reception (invocation target selected), the reception name must be unique within the repository. For any other reception, the reception name must be unique within the business process.

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

File event 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 or file event 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 or file event 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, file event reception, and custom reception

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

Figure 1‒35: User-Defined Reception Definition window (details window for TP1/RPC reception, FTP reception, HTTP reception, Message Queue reception, file event reception, and custom reception)

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:

Reception type

Self-defined file

TP1/RPC reception

TP1/RPC reception definition file

FTP reception

FTP reception definition file

HTTP reception

HTTP reception definition file

HTTP Response Header definition file

HTTP-reception service-selection definition file (for user-defined reception (invocation target selected))

Message Queue reception

Message Queue reception definition file

File event reception

File-event-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.

1.2.6 HCSC Component Information Display Window

This subsection explains the HCSC Component Information Display window, which you use for displaying HCSC component information.

Figure 1‒36: HCSC Component Information Display window

(1) Interface information

The items on the palette are shown in the following figure and explained below.

Service name

Displays the name of the HCSC component selected from the published services list in the tree view.

Operation

Displays the operation name of the HCSC component displayed in Service name. From the drop-down list, select the operation whose information is to be displayed.

(2) Server information

The items on the palette are shown in the following figure and explained below.

Server name

Displays the HCSC server that can invoke a service component. From the drop-down list, select the HCSC server whose information is to be displayed.

Web Service

Displays the receiving destination information of the Web Service of the HCSC server selected in Server name. A URL is displayed as the destination information. Select the WSDL definition style (binding style) and the version of SOAP specifications (SOAP version) to be acquired.

Note that the displayed receiving address information (URL) is applicable only for SOAP1.1. For SOAP1.2, select the SOAP version, and then check the location of <soap12:address> of the acquired WSDL.

WSDL acquisition button

Opens the WSDL file saving dialog for acquiring the WSDL to be used by the Web Service.

EJB#1

Displays the receiving destination information of the SessionBean of the HCSC server selected in Server name. A JNDI name is displayed as the destination information.

Stub acquisition button

Opens the stub file saving dialog for acquiring the RMI-IIOP stub file to be used by SessionBean.

MDB/WS-R#2

Displays the receiving destination information of the MDB/WS-R of the HCSC server selected in Server name. A URL is displayed as the destination information.

MDB/DBQueue#2

Displays the receiving destination information of the MDB/DBQueue of the HCSC server selected in Server name. A queue name is displayed as the destination information.

#1

If the cluster consists of HCSC servers that have different J2EE server names, information about only a specific HCSC server is displayed.

#2

When HCSC servers are in a load-balancing cluster configuration, asynchronous execution requests (MDB/WS-R or MDB/DBQueue) cannot be accepted via the load-balancing cluster. Asynchronous execution requests are accepted directly by individual HCSC servers.

Therefore, when the HCSC servers are in a load-balancing cluster configuration, the receiving destination information of the individual HCSC servers is displayed, delimited by commas (,).

(3) Operation information

Displays the information about the operation selected in Operation under Interface information.

Operation name

Displays the operation name selected in Operation under Interface information.

Communication model

Displays the communication model of the operation selected in Operation under Interface information. Sync or Async is displayed.

(4) Request message

Displays the information about the operation selected in Operation under Interface information.

Message format

Displays the format name of the standard request message.

Display button

Displays the contents of the request message displayed in Message format.

Output button

Displays the dialog for specifying the output destination of the request message displayed in Standard message format.

Format ID

Displays the format ID of the standard request message.

(5) Response message

Displays the information about the operation selected in Operation under Interface information.

Message format

Displays the format name of the standard response message.

Display button

Displays the contents of the response message displayed in Message format.

Output button

Displays the dialog for specifying the output destination of the response message displayed in Standard message format.

Format ID

Displays the format ID of the standard response message.

(6) Fault message

Displays the information about the operation selected in Operation under Interface information.

Fault name

Displays a fault name. From the drop-down list, select the fault name whose information is to be displayed.

Message format

Displays the format name of the message selected in Fault name.

Display button

Displays the contents of the message displayed in Message format.

Output button

Displays the dialog for specifying the output destination of the message displayed in Message format.

1.2.7 User-Defined Reception Information Display Window

This subsection explains the User-Defined Reception Information Display window that displays the definition information of a user-defined reception after packaging.

Figure 1‒37: User-defined Reception Information Display window

User defined reception information

Reception name

Displays the reception name specified in the Add User-Defined Reception wizard when adding a user-defined reception.

Reception type

Displays the reception type specified in the Add User-Defined Reception wizard.

Port name

Displays the port name specified in the Add User-Defined Reception wizard when adding a user-defined reception.

Synchronous

The information is not displayed.

Web Service

Displays the URL to be set in the service location value of the WSDL (value set in the location attribute of the soap-address element in the wsdl:port element).

Before creating a service requester, edit the WSDL and set a value displayed in this item as the value of the service location.

For details about editing the WSDL, see the manual Service Platform Basic Development Guide.

1.3 Dialogs Related to Binary Format Definition

This section explains the dialogs related to binary format definition.

1.3.1 Format dialog

Use the [Format] dialog to specify a format name or character code for a binary format definition file.

For operating procedure, see "4.4.4 Defining Elements (for Non-CSV Format) " in "Service Platform Basic Development Guide".

Figure 1‒38:  [Format] dialog

[Information]

If there is any problem in the information entered in the [Format] dialog, a message indicating the problem is displayed in the top part of the dialog. For details on the messages displayed and the measures to be taken, see "4.4.7 Validating the binary format definition file" in "Service Platform Basic Development Guide".

[Format name]

Specify a format name for the binary format definition file. Specify a name having maximum 256 characters that can be used in the NCName format.

Format: CSV

This item appears when CSV format is used.

[Character code]

Character code (when using Code Converter)

To use Code Converter for binary data, select the character code from the drop-down list.

The following table describes the type of character codes that you can select. For details on character codes, see "Appendix A. Character Code Mapping".

Table 1‒9: Character code types that can be selected (when using Code Converter)

Character code type

Code system

Range of character that are supported

Supplement

MS932

SJIS

UCS-2

Microsoft code page 932

However, IBM selected characters, NEC specified IBM extended characters are not included. If you want to use IBM selected characters, NEC specified IBM selected characters, then the user mapping definition is required.

UTF8

Unicode

UCS-4#1

Unicode UTF-8 encoding#2

UTF16_BIG

Unicode

UCS-2

Unicode UTF-16 encoding #2 handled in Big Endian.

UTF16_LITTLE

Unicode

UCS-2

Unicode UTF-16 encoding#2handled in Little Endian.

JIS

JIS Kanji code

UCS-2

JIS X 0201, JIS C 6226, JIS X 0208, JIS X 0212, and ASCII

EUC#3

EUC

UCS-2

EUC (EUC-JP) available for ASCII and JIS X0208,

including the code set 3 region#4

EUC_HJ#3

EUC

UCS-2

EUC that is uniquely extended to use user-defined characters in the 2-byte region

KEIS+EBCDIC

KEIS

UCS-2

KEIS'83, and EBCDIC for single byte alphanumeric characters

KEIS+EBCDIK

KEIS

UCS-2

KEIS'83, and EBCDIK for single byte alphanumeric characters

KEIS#⁵

KEIS

UCS-2

KEIS'83

IBM_CODE+EBCDIC(LATIN)

IBM Kanji code

UCS-2

IBM Kanji code + Standard or extended lowercase character set

IBM_CODE+EBCDIC(KANA)

IBM Kanji code

UCS-2

IBM Kanji code + Standard or Extended Katakana set

IBM_CODE#⁵

IBM Kanji code

UCS-2

IBM Kanji code

JEF+EBCDIC

JEF

UCS-2

JEF Kanji code + JEF EBCDIC

JEF+EBCDIK

JEF

UCS-2

JEF Kanji code + JEF EBCDIK

JEF#⁵

JEF

UCS-2

JEF Kanji code

CUSTOM

Character code conversion UOC

UCS-2

External program created by the user to convert the character code

#1

Since the mapping process (XLST) is processed by encoding in UTF-16, Unicode supplementary characters (0x10000~0x10FFFF) are encoded in surrogate pair.

#2

Data with BOM cannot be handled. BOM (Byte Order Mark) is the code expressing the order of data bytes.

#3

When binary data is input and output, the byte size of EUC code characters is determined by the first byte. The following table lists the number of character bytes at the first byte:

Character code

First byte

Number of character bytes

Remarks

EUC

0x00 to 0x7E

1 byte

ASCII

0xA1 to 0xFE

2 bytes

JIS X 0208 (supplementary code set 1)

0x8E

2 bytes

JIS X 0201 Katakana (supplementary code set 2)

0x8F

3 bytes

JIS X 0212 supplementary Kanji (supplementary code set 3)

For details about default conversion support, see #4.

EUC-HJ

0x00 to 0x7E

1 byte

ASCII

0xA1 to 0xFE

2 bytes

EUC-HJ area or JIS X 0208 (supplementary code set 1)

0x8E

2 bytes

JIS X 0201 Katakana (supplementary code set 2)

When you define data in fixed format, carefully determine the data length so that the length of the input string or output string does not exceed the data length specified in the binary format definition.

#4

For conversion mapping of characters in the EUC code set 3 region, characters are mapped to Unicode private areas by default. To map the characters to JIS X 0212, create user mapping by using a stand-alone version of Code Converter. For details about the version of Code Converter to be used, see Appendix A. Character Code Mapping.

#5

Cannot be used in CSV format.

Use Java-provided encoder/decoder check box

Select this check box to use the Java-provided encoder and decoder to encode and decode binary data.

Character code (when using the Java-provided encoder and decoder)

To use the Java-provided encoder and decoder for binary data, select the character code from the drop-down list.

The following table describes the types of character codes that you can select. For details on character codes, see Appendix A. Character Code Mapping.

Table 1‒10: Character code types that can be selected (when using Java-provided encoder and decoder)

Character code type

Explanation

windows-31j

Windows Japanese

UTF-8

8-bit Unicode (UCS) Transformation Format

UTF-16BE

16-bit Unicode (UCS) Transformation Format, big endian byte order

UTF-16LE

16-bit Unicode (UCS) Transformation Format, little endian byte order

ISO-2022-JP

ISO 2022 format JIS X 0201, 0208, Japanese

EUC-JP

JISX 0201, 0208, 0212, EUC encoding, Japanese

x-IBM939

Japanese Latin Kanji including 4370 UDC characters, superset of 5035

x-IBM930

Japanese Katakana and Kanji including 4370 UD, superset of 5026

[Process when replacing undefined code]

When telegram-undefined-character-code=REPLACE (converting undefined character code to space) is specified in the HCSC server runtime definition file, select one of the following options for conversion to spaces or predetermined characters.

Convert to fullwidth or halfwidth spaces

Spaces or predetermined characters are converted to fullwidth or halfwidth characters according to the conversion type in the following table. To convert undefined character codes to any characters of your choice, you need to specify the characters in the user property file for the J2EE server. For details about how to specify the setting, see Converting undefined character codes to any characters in 2.3.9 Setting up the user property file for the J2EE server (usrconf.properties) in the Service Platform Setup and Operation Guide.

Binary character code

Conversion type

MS932

Halfwidth

UTF8

Halfwidth

UTF16_BIG

UTF16_LITTLE

Halfwidth

JIS

Fullwidth if the escape status is JISC6226_1978, JISX0208_1983, or JISX0212_1990

Halfwidth if the escape status is JISX0201_LATIN, JISX0201_JIS8, or ASCII

EUC

EUC_HJ

Halfwidth

KEIS+EBCDIC

KEIS+EBCDIK

Halfwidth if the shift status is halfwidth

Fullwidth if the shift status is fullwidth

KEIS

Fullwidth

IBM_CODE+EBCDIC(LATIN)

IBM_CODE+EBCDIC(KANA)

Halfwidth if the shift status is halfwidth

Fullwidth if the shift status is fullwidth

IBM_CODE

Fullwidth

JEF_EBCDIC

JEF_EBCDIK

Halfwidth if the shift status is halfwidth

Fullwidth if the shift status is fullwidth

JEF

Fullwidth

[Replace with double byte space]

All spaces and predetermined characters are converted to fullwidth characters.

[Binary integer endian]

Use the radio button to select the appropriate binary integer endian to be included in the binary data.

You can select this item only when the binary data to be used is not in CSV format.

[Custom definition of numeric values in pack format]

Custom definition of numerical values in pack format is applied when the specifications in the [Simple contents element] dialog satisfies all the following conditions:

[Numeric value in pack format] is selected in [Data type]

[Custom] is selected in [Code specification]

[Exists] is selected for [Code existence]

[Bit value (hexadecimal)]

Specify the coding bit for numeric value in pack format in hexadecimal.

[Plus code]

Specify the plus code bit of numerical values in pack format in alphanumeric hexadecimal.

[Minus code]

Specify the minus sign bit of numerical values in pack format in alphanumeric hexadecimal.

[No code]

Specify no code bit (absolute value) of numerical values in pack format in alphanumeric hexadecimal.

[Custom definition of numeric values in zone format]

The custom definition of numeric values in zone format are applied when the settings in [Simple contents element] dialog satisfy all the following conditions:

[Numeric value in zone format] is selected in [Data type]

[Custom] is selected in [Code specification]

[Exists] is selected for [Code existence]

[Bit value (hexadecimal)]

Specify the bit value of zone format numbers in hexadecimal.

This is applied when [Code specifications] is [Code bit].

[Plus code]

Specify the plus code bit of numerical values in pack format in alphanumeric hexadecimal.

[Minus code]

Specify the minus sign bit of numerical values in pack format in alphanumeric hexadecimal.

[No code]

Specify no code bit (absolute value) of numerical values in pack format in alphanumeric hexadecimal.

[Zone]

Specify the zone bit of zone format numbers in alphanumeric hexadecimal.

[Code character (hexadecimal)]

Specify the characters that express code in zone format numbers, in hexadecimal.

This is applied when [Code specifications] is [Code character].

[Plus code]

Specify plus code characters in 1-2 digit alphanumeric hexadecimals.

[Minus code]

Specify minus code characters in 1-2 digit alphanumeric hexadecimals.

[Separator]

[Escape character]

Specify the characters to be used as escape characters when characters used as separators are included in the data. You can use single Latin characters (0x21 to 0x7E of JIS X 0201) or single-byte spaces (0x20 of JIS X 0201) as escape characters.

This item can be specified when the binary data to be used is not in CSV format

[Line feed code]

Select the linefeed characters to be used as separators from the drop-down list. The linefeed codes that you can use are CR+LF, or LF.

[Delete extra separators] checkbox

Select this check box to delete the last separator.

[CSV format]

[Enclose the output in double quotes (")] checkbox

Select this checkbox to enclose data items in double quotes (").

However, even if this check box is selected, data items are not enclosed in double quotes if the value is an empty string.

[Code conversion table]

[Change the default] check box

Select this check box to change the storage directory of the code conversion table to be referenced by the code conversion library of Code Converter. The default directory is as follows:

service-platform-installation-directory\CSC\lib\external\table

[Storage directory name]

If the Change the default check box is selected, specify the name of the storage directory of the code conversion table.

The root path of the code conversion table storage path has been specified in the code-table-root-path property of the HCSC server runtime definition file. Here, specify the name of the directory to be placed under that root path.

You can specify a directory name by using 64 or fewer alphanumeric characters (0 to 9, A to Z, a to z) and underscores (_).

[OK] button

Commits the specified contents and closes the [Format] dialog.

[Cancel] button

Closes the [Format] dialog, without committing the specified contents.

1.3.2 Simple content element dialog

Use the [Simple Content Element] dialog to specify simple content elements in the binary format definition file.

For operating procedure see "4.4.4 Defining Elements (for Non-CSV Format)" in "Service Platform Basic Development Guide".

Tabs displayed in the [Simple Content Element] dialog differ depending on whether you specify globally or locally defined simple content elements.

(1) Simple content element tab

The simple content element tab is displayed regardless of whether you specify globally or locally defined simple content elements. Use this tab to specify simple content element information.

Figure 1‒39:  [Simple content element] dialog (simple content element tab)

[Data type]

Select the data type to be used for the simple content element from the drop-down list. The following table describes the data types that can be selected and the contents displayed in [Details]:

Data type

Contents displayed in [Details]

String

See "(a) In case of string type".

Integer

See "(c) For integer, real numbers and numeric value with fixed decimal part".

Real number

Fixed decimal number

Numeric value in zone-format#

See "(b) For numeric values zone-format and pack format".

Numeric value in pack format#

Signed binary integer#

Nothing is displayed in [Details].

Unsigned binary integer#

Byte string#

See "(d) For byte string type".

Bit string#

Nothing is displayed in [Details].

Date/time

See "(e) For date/time".

#

You cannot select these items when you handle binary data in CSV format.

[Size]

Specify a size for the data to be used as simple content elements.

For a fixed value

Select the [Fixed] radio button and, specify a size.

The range of sizes that can be specified differs depending on the data type and character code. The following table describes the range of sizes that can be specified:

Table 1‒11:  Size ranges that can be specified for simple content elements with fixed values

Data type

Character code

Range that can be specified

Unit

String, integer, real numbers, fixed decimal number

Not UTF16

1#~2,147,483,647

Byte

UTF16

2#~2,147,483,646

Byte

Numerical value in zone and packed format

-

1~2,147,483,647

Byte

Signed binary integer, unsigned binary integer

-

1~8

Byte

Byte string

-

1~2,147,483,647

Byte

Bit string

-

1~64

Bit

Date/time

CCYYMMDD

Not UTF16

8~2,147,483,647

Byte

UTF16

16~2,147,483,646

Byte

YYMMDD

Not UTF16

6~2,147,483,647

Byte

UTF16

12~2,147,483,646

Byte

hhmmss

Not UTF16

6~2,147,483,647

Byte

UTF16

12~2,147,483,646

Byte

CCYYMMDDhhmmss

Not UTF16

14~2,147,483,647

Byte

UTF16

28~2,147,483,646

Byte

YYMMDDhhmmss

Not UTF16

12~2,147,483,647

Byte

UTF16

24~2,147,483,646

Byte

#

For local simple content elements with the string data type, you can also specify 0 that indicates data whose size is 0 bytes. You cannot specify 0 in binary format definitions in CSV format.

Legend:

-: Indicates that the range that you can specify is independent of the character code.

In case of a variable value

Select the [Variable] radio button. Specify the size determination method in [Size] on the Component tab (or [Component] dialog).

[Details]

Contents displayed in [Details] differ depending on the contents selected in [Data type] as follows:

(a) In case of string type

The following figure shows the [Simple content element] dialog which is displayed when you have selected [String] in [Data type]. If you specify 0 for Size, the items under Details are disabled and cannot be specified.

Figure 1‒40:  [Simple content element] dialog (when you select "String" for [Data type] in the Simple content element tab)

[Individual character code]

Specify individual character code, if the character code of the data to be used as simple content element is different than the character code set in the [Format] dialog.

If you select Variable for Size, you can specify the individual character code if Until end of data or Size node is selected in the component size setting.

[Specify] checkbox

Check the checkbox, when you want to specify the individual character code.

[Format setting value]

Displays the character code specified for Character code in the Format dialog box.

[Character code]

Select the character code to be specified from the dropdown list.

For details about the character code types you can select, see Table 1-9 Character code types that can be selected (when using Code Converter) or Table 1-10 Character code types that can be selected (when using Java-provided encoder and decoder). And for details about character codes, see "Appendix A. Character Code Mapping".

[Embedding]

If the data to be used as simple content element is smaller in size than the specified size, select the characters to fill the excess portion, from the dropdown list. Select [Space] to fill in a blank and select [Blank character (0x00)] to fill in blank characters (0x00).

[Null-terminated byte string] checkbox

Check this checkbox to treat the characters till blank characters (0x00) as data.

You can specify this checkbox only when you have selected [Blank characters (0x00)], in [Embedding].

[Left-Right alignment]

Select the direction for aligning data with the [Left] or [Right] radio button. You can specify this item in case of one of the following:

When the [Consider characters till blank character (0x00) as data] checkbox is inactive

When the [Consider characters till blank character (0x00) as data] checkbox is activated and is not checked

[Unwanted characters]

Specify if the unwanted characters are to be deleted with this radio button. You can specify this item in case of one the following:

When the [Consider characters till blank character (0x00) as data] checkbox is inactive

When the [Consider characters till blank character (0x00) as data] checkbox is activated and is not checked

For details on how to delete unwanted characters, see "4.4.1 Types of data type and character code of binary format definition file" in "Service Platform Basic Development Guide".

[Unavailable characters]

Specify characters to be used in place of the characters in XML that cannot be used. The characters that cannot be used are as follows:

0x00~0x1F (Except 0x09, 0x0A, 0x0D)

Control code

0xFFFE~0xFFFF

Undefined characters (Use prohibited originally as Unicode)

[Substitute with a Replacement Character] checkbox

Select this checkbox to replace unavailable characters with replacement characters.

[Leading replacement character (Hexadecimal)]

Specify the replacement character to be used in hexadecimal. You can specify this item if the [Substitute with a Replacement Character] checkbox is selected.

If you specify the first character of a replacement character, the following 34 characters are used as replacement characters for 0x00 to 0x1F and 0xFFFE to 0xFFFF respectively. Specify hexadecimal without putting the prefix "0x". For example, in case of 0x2400, hexadecimal will be 2400.

The values that you can specify as leading replacement characters are as follows:

0020~D7DE

E000~FFDC

The default value is 2400. These characters are not case-sensitive.

[CSV format]

[Differentiate between empty data and Null] check box

Select this check box to identify "" (empty string) and Null (no data) during transformation of binary data in CSV format. You can specify this check box when a binary format definition file has been created in CSV format or when CSV is selected as the separator format of the parent complex content element.

For details, see the manual Service Platform Basic Development Guide.

[COBOL data format]

[LOW-VALUE conversion] check box

Select this check box to covert LOW-VALUE (data padded with 0x00), which is COBOL-specific data format.

You can specify this check box when the size is not fixed (not 0) and Space is selected for Embedding.

(b) For numeric values zone-format and pack format

The following figure shows the [Simple content element] dialog which is displayed when [Numeric value in zone format] or [Numeric value in pack format] is selected in [Data type].

Figure 1‒41:  [Simple content element] dialog (when you select "Numeric value in zone format" or "Numeric value in pack format" for [Data type] in the Simple content element tab)

[Number of digits]

Specify the number of digits.

[Total] checkbox

Always passive for zone and pack format numeric values. As a result, you cannot specify a maximum value for the total number of digits.

[Decimal part] checkbox

You can specify the maximum value of digits in decimal part, in the range of 0~33.

[Code specification]

Select [Automatic] or [Custom] as the method for setting decimal code.

If you select [Custom], items specified in the [Format] dialog are used.

[Code existence]

Select [Does not exist] when you do not use code and select [Exists] when you use code.

You can specify this item if you have specified [Custom] in [Code specification].

[Code type]

Select [Code bit] to add the code with code bit and select [Code character] to add the symbol with code character.

You can specify this item if the following conditions are satisfied:

[Numeric value in zone format] is selected in [Data type]

[Custom] is selected in [Code specification]

[Exists] is selected in [Code existence]

[Code position]

Select [Before] to add the code before item and select [After] to add the code after item.

You can specify this item if the following conditions are satisfied:

[Numeric value in zone format] is selected in [Data type]

[Custom] is selected in [Code specification]

[Exists] is selected in [Code existence]

(c) For integer, real numbers and numeric value with fixed decimal part

The following figure shows the [Simple content element] dialog which is displayed when "Integer", "Real number" or "Fixed decimal number" is selected in [Data type].

Figure 1‒42: Simple Content Element dialog box (when "Integer" or "Real number" is specified for [Data type] in the [Simple Content Element] tab)

Figure 1‒43: Simple Content Element dialog box (when "Fixed decimal number" is specified for [Data type] in the [Simple Content Element] tab)

[Individual character code]

Specify the individual character code if the character code of the data to be used as a simple content element is different from the character code set in the Format dialog box. You can specify this item when Integer or Real number is selected for Data type.

You cannot specify KEIS, IBM_CODE, or JEF for the character code.

If you select Variable for Size, you can specify the individual character code if Until end of data or Size node is selected in the component size setting.

[Specify] check box

Select this check box to specify the individual character code.

[Format setting value]

Displays the character code specified for Character code in the Format dialog box.

[Character code]

From the drop-down list, select the character code to be specified. The specified character code is also used for the following data:

Plus signs (+) and minus signs (-) that are added to data according to the Code existence setting in the Simple Content Element dialog box

Spaces and 0s that are added to the data according to the Embedding setting in the Simple Content Element dialog box

For details about the character code types you can select, see Table 1-9 Character code types that can be selected (when using Code Converter) or Table 1-10 Character code types that can be selected (when using Java-provided encoder and decoder) in 1.3.1 Format dialog. For details about Code Converter character codes, see Appendix A. Character Code Mapping.

[Number of digits]

Specify the number of digits.

[Total] checkbox

If you select this checkbox, you can specify the maximum value for number of digits in a range of 1~34. The number of digits that you can specify differ as per settings for [Size] as follows:

If [Fixed] is selected in [Size]

The total number of digits will be the total of the integer part, code, and decimal part.

Note that when you specify a numeric value above 1 in the [Decimal part] of number of digits for a real number, the total number of digits includes the decimal point.

If [Variable] is selected in [Size]

The total number of digits does not include the number of digits for code and decimal point.

[Decimal part] checkbox

If you select this checkbox, you can specify the maximum value for number of digits in the decimal part in a range of 0~33.

You can specify this item when data type is real number or numeric value with a fixed decimal part.

You cannot uncheck the checkbox, in case of numeric value with a fixed decimal part.

[Code existence]

When the data type is integers, real numbers or numeric value with a fixed decimal part, select the existence of plus and minus code with Radio button.

When there is no code

Select [None].

When there is only a minus code

Select [Only minus exists].

When there is always a plus or minus code

Select [Always exists].

[Embedding]

When the data type is integer, real number or numeric value with fixed decimal part, and when the data to be used as simple content element is small in size than the specified size, select the characters to fill the excess portion from the dropdown list. Select [Space] when filling in a blank with space and select [0] when filling in a blank with 0.

[Left-Right alignment]

Select the direction for aligning data with the [Left] or [Right] radio button.

You cannot select [Left] radio button, when [Embedding] is set to [0].

[Unwanted characters]

Specify if the unwanted characters are to be removed with this radio button.

[CSV format]

Differentiate between empty data and Null check box

Select this check box to identify "" (empty string) and Null (no data) during transformation of binary data in CSV format. You can specify this check box when a binary format definition file has been created in CSV format or when CSV is selected as the separator format of the parent complex content element.

For details, see the manual Service Platform Basic Development Guide.

[COBOL data format]

LOW-VALUE conversion check box

Select this check box to covert LOW-VALUE (data padded with 0x00), which is COBOL-specific data format.

You can specify this check box when the size is fixed.

(d) For byte string type

The following figure shows the [Simple content element] dialog which is displayed when "Byte string" is selected in [Data type].

Figure 1‒44:  [Simple content element] dialog (when you select "Byte string" for [Data type] in the Simple content element tab)

[Encoding format]

Set the hexBinary or base64Binary which is data type of schema, with radio button, as the encoding format.

(e) For date/time

The following figure shows the [Simple content element] dialog which is displayed when "Date/time" is selected in [Data type]:

Figure 1‒45:  [Simple content element] dialog (when you select "Date/time" for [Data type] in the Simple content element tab)

[Date/time]

Specify the format of date/time for the date/time data type.

[Format]

Select a date/time format from the drop-down list.

[Decimal digits - seconds]

When the date/time format includes the time (hhmmss), specify a value between 0 and 3 for the number of decimal digits for the seconds.

[Left-Right alignment]

Select the direction for aligning data with the [Left] or [Right] radio button.

[CSV format]

Differentiate between empty data and Null check box

Select this check box to identify "" (empty string) and Null (no data) during transformation of binary data in CSV format. You can specify this check box when a binary-format definition file has been created in CSV format or when CSV is selected as the separator format of the parent complex content element.

For details, see the manual Service Platform Basic Development Guide.

(2) Component tab

Use the Component tab to specify component information.

The Component tab is displayed only when you specify locally defined simple content elements. This tab is deactivated when 0 is specified for Size in the Simple Content Element tab.

Figure 1‒46:  [Simple content element] dialog (Component tab)

The contents to be specified are same as the Component tab of the Component dialog.

For details about the component tab in [Component] dialog, see "1.3.4(3) Component tab (Simple content element)".

(3) Contents common to both tabs

The following contents are common to both tabs:

[Information]

If there is a problem in the information that is entered in the [Simple content element] dialog, a message indicating the problem is displayed in the title bar of the dialog. For details about the displayed messages and measures to be taken, see "4.4.7 Validating the binary format definition file" in "Service Platform Basic Development Guide".

[Name]

Specify a name for the simple content element. Specify a name that consist of not more than 256 characters that can be used in the NCName format.

[OK] button

Commits the specified contents and closes the [Simple content element] dialog.

[Cancel] button

Closes the Simple Content Element dialog without committing the specified contents.

1.3.3 Complex Content Element Dialog

Use the Complex Content Element dialog to specify complex content elements in the binary format definition file. Moreover, use this dialog to specify separators in the complex content elements.

For details about the operating procedure, see the description of complex content element settings or separator settings in the manual Service Platform Basic Development Guide.

The Complex Content Element dialog has two tabs, the complex contents elements tab and separator tab. The contents displayed in both the tabs are different and are described below:

(1) Complex Content Element tab

Use the Complex Content Element tab, while specifying the information of the complex content elements.

If the component type is Selection, the windows to be displayed will change depending on the location from where the component to be used is selected.

Figure 1‒47: Complex Content Element tab of the Complex Content Element dialog (When selecting components from the selection condition node value)

Figure 1‒48: Complex Content Element tab of the Complex Content Element dialog (When selecting components from the start separator value)

Component type

Select the appropriate radio button to select a component type for the components to be specified in the complex content element.

For the Sequential type

Select Sequential.

For the Selection type

Select Selection.

Selection Type

If the Component type is Selection, you select Selection type of Select Configuration using the radio button.

To select the component to be used from the selection condition node value

You select Selection condition node, click the Select Node button, and then specify the selection condition node.

To select the component to be used from the start separator value of the component

You select Initial separator of component.

Select Node button

Opens the Select Node dialog. Use this dialog to select a selection condition node for the component.

The node selected in the Select Node dialog is displayed as follows:

When the node is selected from Base path

Displays a relative path from the base node.

When the node is selected from Absolute path

Displays a path from the root element.

Components

A list of the components specified in the complex content element is displayed.

Name

Displays the names of the simple content elements and complex content elements specified in the component.

Selection condition value

Displays the selection condition value set up for a component when the Component type is Selection and the selection type is Selection condition node. This item is not displayed when the component type is Sequential, and when the Component type is Selection and the selection type is Initial separator of component.

If multiple selection condition values are set for one element, they are separated by delimiters.

When the Component type is Selection and the selection type is Selection condition node and if none of the values displayed in Selection condition value are applicable, the components for which the Selection condition value is not displayed will appear. Only a single such component can be set up.

Initial separator

Displays the start separator value set up for a component when the component type is Selection and the selection type is Initial separator of component. This item is not displayed when the component type is Sequential, and when the component type is Selection and the selection type is Selection condition node.

When the component type is Selection and the selection type is Initial separator of component and if none of the values displayed in Initial separator are applicable, the following components will appear:

Component for which the start separator value is not displayed

Component that is a simple content element

Only a single such component can be set up.

Up button

Moves up by one line the component selected in Components.

Down button

Moves down by one line the component selected in Components.

Set Condition Value button

Displays the Set Condition Value dialog if you click this button when the component type is Selection and the selection type is Selection. This button is not displayed when the component type is Sequential and the selection type in Selection is Initial separator of component. Use this dialog to specify a selection condition value for a component selected in Components.

(2) Separator tab

Use the Separator tab to specify separators in the complex content elements.

Figure 1‒49: Complex Content Element dialog (Separator tab)

Separator format

Select the Separator Format that you want to use from the drop-down list. You can select the following separators:

User-specified: The user sets up each separator.

CSV: The CSV format separator is automatiinvokey set up.

Note that when you select CSV in the Separator format, the start separator and intervening separator are set up as follows:

Start separator: None

Intervening separator: Comma (,)

Specify the separators used as a start separator, intervening separator, and end separator respectively, with the following items:

Use checkbox

To use the respective separator, select the corresponding checkbox.

Separator name

Specify the name of the separator to be used.

Select Separator button

Displays the Select Separator dialog.

Separator value

Displays the value of the defined separator, when the Separator name is specified. The value of the separator is enclosed within [ ].

(3) Contents common to both tabs

The following contents are common to both tabs:

Information

If there is a problem in the information that is entered in the Complex Content Element dialog, a message indicating the problem is displayed in the title bar of the dialog. For details about the displayed messages and measures to be taken, see the description for validating binary format definition files in the manual Service Platform Basic Development Guide.

Name

Specify a name of the complex content element. Specify a name consisting of a maximum of 256 characters that can be used in the NCName format.

OK button

Commits the specified contents and closes the Complex Content Element dialog.

Cancel button

Closes the Complex Content Element dialog without committing the specified contents.

1.3.4 Component dialog

Use the Component dialog to specify a globally defined simple content element or complex content element for a component of a complex content element.

For details on operating procedure see "4.4.4 Defining Elements (for Non-CSV Format)" in "Service Platform Basic Development Guide".

The tabs displayed in the Component dialog differ depending on whether you specify a globally defined simple content element or a complex content element for a component.

(1) Simple content element tab

The Simple content element tab is displayed only when you specify a simple content element for the component. The information of the simple content element to be specified for the component is displayed. You cannot modify these contents.

Figure 1‒50:  [Component] dialog (Simple content element tab)

The information displayed here are the values that were specified on the simple content element tab of the simple content element dialog when the globally defined simple content element, to be set for the component was specified.

For details about the simple content element tab of the [Simple content element] dialog, see "1.3.2(1) Simple content element tab".

(2) Complex content element tab

The Complex Content Element tab is displayed only when you specify a complex content element for the component. The information of the complex content element to be specified for the component is displayed. You cannot modify these contents.

Figure 1‒51:  [Component] dialog (Complex content element tab)

The information displayed here are the values that were specified in the Complex Content Element dialog when the complex content element, to be set for the component was specified.

For details about the complex content element dialog, see "1.3.3 Complex Content Element Dialog".

(3) Component tab (Simple content element)

Use this tab to specify component information. The Component tab is displayed regardless of whether the elements to be specified for the component are globally defined simple content elements or complex content elements. The following figure shows the component dialog which is displayed when the component is simple content element:

Figure 1‒52:  [Component] dialog (Component tab for Simple content element)

[Occurrence count]

Specify the occurrence count of component.

When the occurrence count is fixed

Select the [Fixed] radio button and, specify an occurrence count between 1 and 2,147,483,647.

When a range is specified for the occurrence count

Select the [Range] radio button and, specify the range of occurrence count in Minimum and Maximum. You can set a value in the range of 1 - 2,147,483,647.

When the element is considered to be until end of data

Select the [Until end of data] radio button. Note that for a minimum one-time occurrence of data, select the Do not omit data checkbox.

Reference note

The following implies the end of data:

When a separator that can be determined as end of data is detected from among the combination of separators for the specified elements

When the entire data has been read

When data of the specified size has been read from the size node of the specified complex content element

When occurrence count is to be made dependent on another element

Select the [Occurrence-count node] radio button and, click the [Select Node] button to select the node that will depend on another element. When handling the CSV format data as binary data, this radio button will be passive.

[Select node] button

Opens the [Select node] dialog. To make the component occurrence count dependent on another element, use this dialog.

The node selected in the [Select node] dialog is displayed as follows:

When the node is selected from Base path

A relative path from the base node is displayed.

When the node is selected from Absolute path

A path from the root element is displayed.

[Size]

Specify the size of the data that is used as a simple content element (which is a Component), when you select [Variable] under [Size] in the Simple content element tab. When CSV format data is handled as binary data, this area is deactivated.

When the data is considered an element until the end

Select the [Until end of data] radio button. Active only in case of simple content element tab.

Reference note

The following implies the end of data:

When a separator that can be determined as end of data is detected from among the combination of separators for the specified elements

When the entire data has been read

When data of the specified size has been read from the size node of the specified complex content element

When the size is to be made dependent on an another element

Select the [Size node] radio button and, by clicking the [Select node] button, select the node that will depend on another element.

[Select node] button

Opens the Select Node dialog. To make the size of a simple content element (which is a Component) dependent on another element, use this dialog when selecting a node that will depend on another element.

The node selected in the [Select node] dialog is displayed as follows:

When the node is selected from Base path

A relative path from the base node is displayed.

When the node is selected from Absolute path

A path from the root element is displayed.

[Size calculation method]

From the drop-down list, select one of the following values as the method of calculating the size of the size node. If you use a binary format definition of an earlier version that does not have the Size calculation method setting, System default value is assumed.

Specification value

Size node value

System default value

The extended size node function is enabled or disabled according to the value set in the csc.dt.sizeNode.includeSelfSize property of the user property file for the J2EE server (usrconf.properties) in the execution environment.

For details about the settings of the user property file for the J2EE server, see 2.3.9 Setting up the user property file for the J2EE server (usrconf.properties) in the Service Platform Setup and Operation Guide.

Data length only

The extended size node function is disabled and the size of the setting source element of the size node is applied to the size node length.

Include the size node length

The extended size node function is enabled and the sum of the size of the setting source element of the size node and the size of the size node is applied to the size node length.

[Unit of size node values]

Select the unit of size node values from the following:

Number of bytes (default)

The value of the size node is converted to bytes.

Number of digits

The value of the size node is converted to the digits of data.

If you select Number of digits, Size calculation method is deactivated.

This item is activated when all the following conditions are met:

- Numeric value in pack format is selected for Data type and the Variable radio button is selected for Size in the Simple Content Element tab.

- The Size node radio button is selected for Size in the Component tab.

(4) Component tab (Complex content element)

Use this tab to specify component information. The Component tab is displayed regardless of whether the elements to be specified for the component are globally defined simple content elements or complex content elements. The following figure shows the component dialog displayed when the component is complex content element:

Figure 1‒53:  [Component] dialog (Component tab for Complex content element)

[Occurrence count]

When the occurrence count is fixed

When there is a header element in CSV format, select [Fixed] radio button and, specify occurrence count between 0~1.

When there is a record element in CSV format or in case of a non-CSV format, select [Fixed] radio button and, set occurrence count between 1~2,147,483,647.

When a range is specified for the occurrence count

When there is a record element in CSV format or in case of a non-CSV format, select the [Range] radio button and, specify the range of occurrence count in [Minimum] and [Maximum]. You can set a value in the range of 1 - 2,147,483,647.

When there is a header element in CSV format, [Range] radio button is passive.

When the element is considered to be until end of data

When there is a record element in CSV format or in case of a non-CSV format, Select the [Until end of data] radio button. Note that for a minimum one-time occurrence of data, select the Do not omit data checkbox.

When there is a header element in CSV format, [Until end of data] radio button is passive.

Reference note

The following implies the end of data:

When a separator that can be determined as end of data is detected from among the combination of separators for the specified elements

When the entire data has been read

When data of the specified size has been read from the size node of the specified complex content element

When occurrence count is to be made dependent on another element

In case of non-CSV format, select [Occurrence count node] radio button and click the [Select Node] button to select the nodes , which depend on another element.

When there is a header element or record element in CSV format, [Occurrence count node] radio button is passive.

[Select node] button

Opens the [Select node] dialog. To make the component occurrence count dependent on another element, use this dialog.

The node selected in the [Select node] dialog is displayed as follows:

When the node is selected from Base path

A relative path from the base node is displayed.

When the node is selected from Absolute path

A path from the root element is displayed.

[Size]

Specify the size of the data that is used as a complex content element (which is a Component), when the occurrence count of Component tab is Fixed and is Once. This item will be passive if you treat data in CSV format as binary data.

[Select node] button

To make the size of a complex content element (which is a Component) dependent on another element, use this dialog to select a node that will depend on another element.

The node selected in the [Select node] dialog is displayed as follows:

When the node is selected from Base path

A relative path from the base node is displayed

When the node is selected from Absolute path

A path from the root element is displayed.

[Delete] button

Deletes the [Size node] value.

[Size calculation method]

From the drop-down list, select one of the following values as the method of calculating the size of the size node.

Specification value

Size node value

System default value

The extended size node function is enabled or disabled according to the value set for the csc.dt.sizeNode.includeSelfSize property of the user property file for the J2EE server (usrconf.properties) in the execution environment.

For details about the settings of the user property file for the J2EE server, see 2.3.9 Setting up the user property file for the J2EE server (usrconf.properties) in the Service Platform Setup and Operation Guide.

Data length only

The extended size node function is disabled and the size of the setting source element of the size node is applied to the size node length.

Include the size node length

The extended size node function is enabled and the sum of the size of the setting source element of the size node and the size of the size node is applied to the size node length.

(5) Separator tab

The Separator tab is displayed only when you want to specify a complex content element in the component. The information about the separators of the complex content elements specified in Component is displayed. You cannot modify these contents.

Figure 1‒54:  [Component] dialog (Separator tab)

The information displayed here are the values specified in the Complex content element dialog, when separators are set in the complex content elements, to be set in the component.

For details about the Complex content element dialog, see "1.3.3 Complex Content Element Dialog".

(6) Contents common to both tabs

The following contents are common to both tabs:

[Information]

If there is a problem in the information that is entered in the Component dialog, a message indicating the problem is displayed in the title bar of the dialog. For details about displayed messages and measures to be taken, see "4.4.7 Validating the binary format definition file" in "Service Platform Basic Development Guide".

[Name]

Displays the name of the element to be specified in the component.

[OK] button

Commits the specified contents and closes the Component dialog.

[Cancel] button

Closes the Component dialog without committing the specified contents.

1.3.5 Condition Value Setting Dialog

Use the Condition Value Setting dialog to specify a selection condition value for the component of a complex content element for which Selection is specified.

For details about operating procedures, see the description about component selection conditions in the manual Service Platform Basic Development Guide.

Figure 1‒55: Condition Value Setting dialog

Information

If there is a problem in the information that is entered in the Condition Value Setting dialog, a message indicating the problem is displayed in the title bar of the dialog. For details about displayed messages and measures to be taken, see the description for validating binary format definition files in the manual Service Platform Basic Development Guide.

Selection condition

Node

Displays the selection condition node.

Data type

Displays a data type for the selection condition node.

Invalid character

When the data type of the selection condition node is string, either of the following is displayed to indicate whether characters that cannot be used in XML are replaced with alternate characters:

Replace alternate character

Do not replace alternate character

First alternate character

When the data type of the selection condition node is string and Replace alternate character is displayed for Invalid character, the first alternate character is displayed in 0xXXXX format.

Format

When the data type of the selection condition node is date/time, a date/time format is displayed.

all digits

When the data type of the selection condition node is integer, real number, or fixed-decimal number, the total number of digits specified is displayed.

Decimal digits

When the data type of the selection condition node is fixed-decimal number, zone-format number, packed-format number, or date/time (format that includes time), the number of decimal digits is displayed. Nothing is displayed if the number of decimal digits has not been specified.

Sign usage

When the data type of the selection condition node is integer, real number, or fixed-decimal number, whether a sign is present is displayed.

When the data type is zone-format number or pack-format number and Custom is selected for Code specification, whether a sign is present is displayed.

Encoding format

When the data type of the selection condition node is byte string, either of the following schema data type is displayed as the encoding format.

hexBinary

base64Binary

Size (unit)

When the size of the selection condition node is fixed, that value is displayed. If the size is variable, Variable is displayed.

In unit, either in bytes or in bits is displayed depending on the data type.

Name

Displays the name of the component for which a selection condition value is to be specified.

Condition value

Select Single condition specified to specify one selection condition value for one element. Select Multiple conditions specified to specify multiple selection condition values for one element.

The condition values that can be specified vary according to the data type of the selection condition node.

For details about condition values that can be specified, see the description for validating binary format definition files in the manual Service Platform Basic Development Guide.

Single condition specified

To specify one selection condition value for one element, specify the selection condition value by using 1,024 characters or less.

Multiple conditions specified

To specify multiple selection condition values for one element, specify the selection condition values and delimiter.

Condition values

Specify the selection condition values separated by delimiters. There is no limit on the number of characters in selection condition values.

Delimiter

If you want to change the default delimiter , (halfwidth comma), specify a new delimiter. You can use a single Latin character (0x21 to 0x7E) or halfwidth space (0x20).

The character specified as the delimiter cannot be used for a selection condition value. There is no definition method like an escape sequence.

For example, if you specify aaa,bbb,ccc as the selection condition value and specify , (halfwidth comma) as the delimiter for a component, this component will be selected when aaa, bbb, or ccc is entered for the selection condition node.

The following shows an example of specifying multiple selection condition values separated by , (halfwidth comma).

aaa,bbb,ccc,zzz

OK button

Commits the specified contents and closes the Condition Value Setting dialog.

Cancel button

Closes the Condition Value Setting dialog without committing the specified contents.

1.3.6 Select Node Dialog (Binary Format Definition)

Use the Select Node dialog (binary format definition) to select the target node for referencing the occurrence count or size of a component from another element, or to select a selection condition node that has the selection condition value of the component.

The Select Node dialog opens when you click the Select Node button in any of the following dialogs:

Simple Content Element dialog (Component tab)

Component dialog (Component tab)

Complex Content Element dialog

Figure 1‒56: Select Node dialog (binary format definition)

Information

If there is a problem in the information that is entered in the Select Node dialog, a message indicating the problem is displayed in the title bar of the dialog. For details about displayed messages and measures to be taken, see the description for validating binary format definition files in the manual Service Platform Basic Development Guide.

Path specification

Select the appropriate radio button to select the method of specifying the target node or selection condition node.

Base path radio button

Choose this option to use a path from the base node for specifying the target node or selection condition node.

The base node is the node located at the highest position in a tree structure when there are multiple reference-source components (dependent nodes) in the entire tree.

When Base path is selected, Node structure shows a structure from the base node in a tree format.

The following figure shows an example in which Base path is selected.

Figure 1‒57: Example in which Base path is selected

Absolute path radio button

Choose this option to use the path from the root element for specifying the target node or selection condition node.

When Absolute path is selected, Node structure shows a structure from the root node in a tree format.

The following figure shows an example in which Absolute path is selected.

Figure 1‒58: Example in which Absolute path is selected

Node structure

The node structure is displayed in a tree format according to the option selected in Path specification. From the displayed tree, select the target node or selection condition node.

OK button

Commits the specified contents and closes the Select Node dialog.

Cancel button

Closes the Select Node dialog without committing the specified contents.

1.3.7 Select Element Dialog

Use the Select Element dialog to select the globally defined element to be specified as a component.

For details about operating procedures, see the description for component settings in the manual Service Platform Basic Development Guide.

Figure 1‒59: Select Element dialog

Information

If there is a problem in the information that is entered in the Select Element dialog, a message indicating the problem is displayed in the title bar of the dialog. For details about displayed messages and measures to be taken, see the description for validating binary format definition files in the manual Service Platform Basic Development Guide.

Elements

Select the element to be specified as the component.

Name

Displays globally defined elements that can be specified as components.

Element

Simple content and Complex content are displayed for a simple content element and a complex content element, respectively.

OK button

Commits the specified contents and closes the Select Element dialog.

Cancel button

Closes the Select Element dialog without committing the specified contents.

1.3.8 Select Separator Dialog

The Select Separator dialog is used to select separators that are specified as start separator, intervening separator, and end separators of a complex content element.

This dialog is displayed when you click the Select button present in the specification column of each separator in the Complex Content Element dialog (Separator tab).

Figure 1‒60: Select Separator dialog

Information

If there is a problem in the information that is entered in the Select Separator dialog, a message indicating the problem is displayed in the title bar of the dialog. For details about displayed messages and measures to be taken, see the description for validating binary format definition files in the manual Service Platform Basic Development Guide.

Separator name list

Name

Displays the name of a defined separator.

Value

Displays the value of a defined separator. The value of the separator is enclosed within [ ].

Add button

Used when you want to add new characters as separators. The Add or Change Separator dialog is displayed.

Change button

Used when you want to change the name or value of an already defined separator. When you select a separator for changing the information from the Separator name list, and then click it, the Add or Change Separator dialog is displayed.

Note that you cannot change the information of the following separators:

LineFeed and Comma (separators that are initially specified)

A separator that is already specified as another separator in the same complex content element

Delete button

Used when you want to delete an already defined separator. When you select a separator from the Separator name list that you want to delete, and then click it, the selected separator is deleted.

Note that you cannot delete the following separators:

LineFeed and Comma (separators that are initially specified)

A separator that is already specified as another separator in the same complex content element

OK button

Commits the specified contents and closes the Select Separator dialog.

Cancel button

Closes the Select Separator dialog without committing the specified contents.

1.3.9 Add or Change Separator Dialog

The Add or Change Separator dialog is used either to add a separator that is to be used as a start separator, intervening separator, and end separator of a complex content element, or to change the information about a separator.

This dialog is displayed when you click the Add or Change button in the Select Separator dialog.

Figure 1‒61: Add or Change Separator Dialog

Information

If there is a problem in the information that is entered in the Add or Change Separator dialog, a message indicating the problem is displayed in the title bar of the dialog. For details about displayed messages and measures to be taken, see the description for validating binary format definition files in the manual Service Platform Basic Development Guide.

Separator name

Specify the name of the separator. Specify a name consisting of a maximum of 256 characters that can be used in the NCName format.

When changing the information about an already defined separator, the initial display of the separator name is executed. When adding a new separator, the initial display of a name, wherein a serial number is added to the prefix Sepa-, is executed.

Separator value

String radio button

Select, when you use a character string as the separator value.

Byte array radio button

Select, when you use a byte string as the separator value.

Value

Specify the character string or byte string to be used as the separator value. In the case of a character string, you can specify Latin characters (0x21 to 0x7E of JIS X 0201) or single-byte spaces (0x20 of JIS X 0201), within 1,024 characters.

An example of specification when you want to represent the ASCII character string 012 as the separator value is described below:

In the case of a character string

Specify the character string as it is, specify 012.

In the case of a byte string

Specify in the format without the hexadecimal 0x notation, specify 303132.

OK button

Commits the specified contents and closes the Add/ Change Separator dialog.

Cancel button

Closes the Add/ Change Separator dialog without committing the specified contents.

1.3.10 Conversion dialog from COBOL Library Text

This section describes the screen used in generating functionality of the binary format definition file from COBOL Library Text file.

(1) COBOL Library Text settings page

This page is used to specify the COBOL Library Text file to be converted and the information required at the time of conversion.

Figure 1‒62:  COBOL Library Text Settings page

[File name of COBOL Library Text]

Specify the name of COBOL Library Text file which is to be converted.

[Browse] button

A dialog to specify COBOL Library Text file is displayed.

[PICTURE clause currency symbol]

Specify the currency symbol used in PICTURE clause character string. The default specified value is "\".

The characters that you can specify in PICTURE clause currency symbol are as follows:

"!", "#", "$", "%", "&", "<", ">", "?", "@", "F", "G", "H", "I, "J", "K", "L", "M", "O", "Q", "T", "U", "W", "Y", "[", "\", "]", "^", "_", "`", "{", "|", "}", "~" and one-byte Katakana (0xA1~0xDF from MS932 code).

[Basic item character code]

Select the character code used in basic items. The default selected value is "MS932". The character code selected here is set as the character code for binary format definition file.

The character codes that you can select in basic items are as follows:

MS932

UTF8

UTF16_BIG

UTF16_LITTLE

JIS

EUC

EUC-HJ

KEIS+EBCDIC

KEIS+EBCDIK

KEIS

IBM_CODE+EBCDIC(LATIN)

IBM_CODE+EBCDIC(KANA)

IBM_CODE

JEF+EBCDIC

JEF+EBCDIK

JEF

CUSTOM

[Binary type Endian]

Select Big Endian or Little Endian as binary type Endian. The default selected value is "Little Endian".

(2) Data item settings page

The result of converting a COBOL Library Text file is displayed on this page. All items are displayed in a tree view of multiple columns.

Figure 1‒63:  Data items settings page

[Defined items]

[Level number]

Displays the level number of items that were specified in COBOL Library Text file. If you do not want to display the subordinate items in group item, click the button on the left side of [Level number].

[Data name]

Displays the data name of items that were specified in COBOL Library Text file.

[Optional name]

Displays the name used as element name for binary format definition file. You can change the name by clicking on the cell. If you do not specify [Optional name], the name displayed in [Data name] will become element name for binary format definition file.

The character string that you can input in [Optional name] must satisfy the following conditions. If the following conditions are not satisfied, [Optional name] is not set.

Character that can be used in NCName

If a character that cannot be used in NCName is used, such a character is replaced by "_".

Should not duplicate with the data name or optional name of sibling data item having the same parent

Note that in case of FILLER, for each sibling data item having same parent, the optional name is set such that the First two Characters will be "_." and the remaining 5 characters will be numbers in ascending order as in "_.00001", "_.00002".

If the name displayed in [Data name] duplicates with the data name or optional name of sibling data item having the same parent, the name having a number added in the end of [Data name] is set as optional name.

[Data type]

Displays the attributes of the binary format definition file after conversion. For details about the correspondence between the COBOL data type and the data type of the binary-format definition file after conversion, see the description of the corresponding data types in the manual Service Platform Basic Development Guide.

[Occurrence count]

Displays the specified value when a value larger than 2 is specified in the OCCURS clause of COBOL Library Text file.

(3) Output file settings page

Use this page to output the binary format definition file.

Figure 1‒64:  Output file settings page

[Enter or select parent folder]

Displays the parent folder name that you entered or selected.

[File name]

You can specify the binary format definition file name here. The default specified value is "(Format name) +".fdx"". You can enter characters that can be used in NCName.

[Format name]

You can specify the format name of the binary format definition file here. The default value will be a character string without the extension from [File name]. You can enter characters that can be used in NCName. On entering characters in [Format name] its associated [File name] is also set as [Characters entered in format name + ".fdx"].

1.4 Dialogs Related to Business Processes

This section explains the dialogs related to business processes.

Important note

In the dialogs related to business processes, you cannot specify a preceding or trailing single-byte or double-byte space for an input item.

1.4.1 List Of Variables And Correlation Sets Dialog

Use the List Of Variables And Correlation Sets dialog to add or modify variables and correlation sets, or to display a list.

For details about operating procedures, see the description for defining variables and correlation sets in the manual Service Platform Basic Development Guide.

Figure 1‒65:  List Of Variables And Correlation Sets dialog (for displaying variable information)

Figure 1‒66: List Of Variables And Correlation Sets dialog (for displaying variable information)

Variable List

Displays a list of already defined variables that belong to the process or scope.

Variable name

Specify a variable name consisting of a maximum of 64 bytes.

Type

Select the type of variables from the following six types:

XML

Binary (non-XML)

Any

Numeric

String

Boolean

Message format

For message-type (XML or non-XML) variables, the file containing the message format is displayed.

Get Format button

For message-type (XML or non-XML) variables, use this button to set the message format (specified in the request, response, or fault message of the service component to be invoked or the user-defined reception) in the variable.

The Take In Message Format dialog opens. In the Take In Message Format dialog, you specify the message format to be set in the variable.

... button

For message-type (XML or non-XML) variables, specify the file to be used as the message format.

Display button

For message-type (XML or non-XML) variables, use this button to acquire paths to variables. Clicking this button opens the Showing Variable dialog box.

Output button

Displays the dialog box for specifying the output destination of the message format file.

Part Specifications check box

For message-type (XML or non-XML) variables, select this check box to enable part specification.

Part name

Specify a part name for part specification.

Specify the part name according to the following conditions:

When the part type is message (XML)

Part names must be unique in the business process.

When the part type is numeric (numeric), string (string), or Boolean (boolean)

The same part name can be used for variables that have different message formats but the same part type.

In all other cases, part names must be unique.

Expression

When performing part specification, specify an expression that corresponds to the part name. For the expression, specify the path acquired in Selected path in the Showing Variable dialog.

Type

Select the type corresponding to the part name.

For message-type (XML) variables

Select from message type (XML), numeric, string, and Boolean.

For message-type (non-XML) variables

Select from numeric, string, and Boolean.

CorrelationSet List

Displays a list of already defined correlation sets that belong to the process or scope.

CorrelationSet Name

Specify a correlation set name consisting of a maximum of 64 bytes.

Acquisition Part

Variable name

Specify variables that have the message format to be used for defining the correlation set. Message type variables that are already defined in the scope to which they belong or the parent scope and which have basic-type parts are displayed.

Part name

For the variable selected in Variable name, specify a part name of the basic-type part that is to be used as a correlation set.

Add Line button

Adds a line for specifying a part or acquisition part.

Delete Line button

Deletes unneeded part or acquisition part specification lines.

Add button

Adds information about the defined variables and correlation sets.

Delete button

Deletes information about the defined variables and correlation sets.

Update button

Updates the contents of the information about the defined variables and correlation sets.

OK button

Commits the defined contents and closes the List Of Variables And Correlation Sets dialog.

Cancel button

Cancels the defined contents and closes the List Of Variables And Correlation Sets dialog, leaving the previous contents intact.

1.4.2 Header allocated variable dialog

[Header allocated variable] dialog is used to set header allocated variable.

This dialog is displayed when you click the [Set] button for header allocated variable in receive activity, reply activity and invoke service activity.

Figure 1‒67:  [Header allocated variable] dialog

[Allocated variable]

Displays allocated variables in an ascending order.

[Root element]

Displays the root element defined in allocated variable.

[Name space]

Displays the name space of the root element.

[Add] button

Adds a new row below the last row of the table.

[Delete] button

Deletes all rows of allocated variable displayed in [Allocated variable]. You can select and delete rows of multiple allocated variables at a time.

[OK] button

Commits the specified contents and closes the [Header allocated variable] dialog.

[Cancel] button

Closes the [Header allocated variable] dialog without committing the defined contents.

1.4.3 Allocating Correlation Set Group Dialog

Use the Allocating Correlation Set Group dialog to allocate the correlation set groups defined in the List Of Variables And Correlation Sets dialog to activities.

The Allocating Correlation Set Group dialog opens when you click the Setting button for a receive activity, reply activity, or invoke service activity.

For details about operating procedures, see the description for defining correlation sets in the manual Service Platform Basic Development Guide.

Figure 1‒68: Allocating Correlation Set Group dialog

Correlation set

From the drop-down list, select the correlation sets to be allocated to request messages and response messages. The drop-down list shows only those correlation sets that are already defined in the List Of Variables And Correlation Sets dialog.

Add button

Adds the correlation sets selected in Correlation set to Correlation set name.

Edit button

Opens the List Of Variables And Correlation Sets dialog.

Delete button

Deletes the entire row for a selected correlation set displayed in Correlation set name. You can select and delete multiple lines of correlation sets at the same time.

Correlation set Name

Displays the correlation sets selected in Correlation set.

Initialize

Choose whether to initialize a correlation set. To initialize, choose yes. To not initialize, choose no.

Pattern

Select the pattern of a correlation set. If the correlation set is allocated from the receive and reply activities, - is displayed.

OK button

Commits the defined contents and closes the Allocating Correlation Set Group dialog.

Cancel button

Cancels the defined contents and closes the Allocating Correlation Set Group dialog, leaving the previous contents intact.

1.4.4 Showing Variable Dialog

Use the Showing Variable dialog to acquire paths to variables.

This dialog opens when you click Show Tree in the List Of Variables And Correlation Sets dialog.

For details about operating procedures, see the description for displaying variables and acquiring paths in the manual Service Platform Basic Development Guide.

Figure 1‒69: Showing Variable dialog

Contents of variable

Displays the contents of the variable selected in the List Of Variables And Correlation Sets dialog in a tree view.

Select and right-click a displayed variable, and then choose Get Path to acquire the absolute path from the root element. You can paste the acquired path in the desired location.

Selected path

Select a variable displayed in the tree view to display the path of the selected variable as the absolute path from the root element.

Close button

Closes the Showing Variable dialog.

1.4.5 Take In Message Format Dialog

Use this dialog to set the message format specified in the request, response, or fault message of the service component to be invoked or the user-defined reception, in the variable.

This dialog is displayed when you click the Get Format button in the List Of Variables and Correlation Sets dialog.

For details about operating procedures, see the description for defining variables in the manual Service Platform Basic Development Guide.

Figure 1‒70: Take In Message Format dialog

Service/ Reception

Service name radio button

Select this button to set the message format specified in the request, response, or fault message of the service component to be invoked, in the variable. From the drop-down list, select the service component to be invoked.

Reception name radio button

Select this button to set the message format specified in the user-defined reception in the variable. From the drop-down list, select the user-defined reception to be acquired.

Target for take in

Operation name

Amongst the operations of the service component or user-defined reception specified in Service/ Reception, select the operation name to be acquired from the drop-down list.

Message type

Select one of the following types of message format to be set in the variable from the drop-down list:

Request message (Body)

Response message (Body)

Request message (Header)

Response message (Header)

Fault message

Header root element

Displays the root elements set in the selected header in ascending order.

Namespace

Displays a namespace if Request message (Header) or Response message (Header) is selected for Message type.

Fault name

When Fault message is selected in the Message type, select the fault name to be acquired from the operations selected in Operation name.

Message format

Enter the name of the XML schema file that is the message format.

OK button

Closes the dialog. The specified contents are applied to the List Of Variables and Correlation Sets dialog.

Cancel button

Closes the dialog without saving the specified contents.

1.4.6 Fault Handler Dialog

Use this dialog to specify fault-handling conditions.

This dialog opens when you perform one of the following operations:

Double-click a link line (set by using a fault connection).

Select and right-click a link line (set by using a fault connection), and then click Set.

For details about operating methods, see the description of fault-handling definitions in the manual Service Platform Basic Development Guide.

Figure 1‒71: Fault Handler dialog

Allocated variable

In the list box, select the variable subject to fault handling. The list shows the variables defined for the applicable business process.

To specify fault handling to be executed when an undefined fault occurs, choose catch-all in the list.

Transition destination

Select the name of the activity for which fault handling is defined to be executed when the fault specified in Allocated variable occurs.

Clear button

Clears the contents specified for the selected Allocated variable line.

OK button

Saves the defined contents and closes the dialog.

Cancel button

Closes the dialog without saving the defined contents.

1.4.7 Receive Activity Dialog

You use this dialog for defining receive activity details.

This dialog opens when you perform one of the following operations:

Double-click a receive activity on the canvas.

Select and right-click a receive activity on the canvas, and choose Setting.

For details about how to define receive activity details, see the description of the receive activity in the manual Service Platform Basic Development Guide.

Figure 1‒72: Receive Activity dialog

Activity name

Specify an activity name. You can use the NCName definition characters of XMLSchema. Specify an activity name that is unique inside a business process or scope.

Operation name

Specify the operation name used when invoking a service component from a service requester, within 255 bytes. You can use the NCName definition characters of XMLSchema.

For the operation name, specify a name that is not specified for another receive activity inside the business process.

Body allocated variable

From the drop-down list, select the variable to be allocated to the request message of the business process. The drop-down list shows only the variables that can be used of those defined in the List Of Variables And Correlation Sets dialog.

Edit button

The Variable-Correlation Set dialog opens. Click this button to edit the contents of the variable specified in Body allocated variable.

For details about the List Of Variables And Correlation Sets dialog, see 1.4.1 List Of Variables And Correlation Sets Dialog.

Header allocated variable

Click the Setting button to allocate an already defined header allocated variable to an activity.

Setting button

Opens the Header allocated variable dialog box. As needed, use this dialog to specify the header allocated variable to be allocated to an activity.

For details about the Header allocated variable dialog box, see 1.4.2 Header allocated variable dialog.

Correlation set group

Click the Setting button to allocate an already defined correlation set group to an activity.

Setting button

Opens the Allocating Correlation Set Group dialog box. As needed, use this dialog box to specify the correlation set to be allocated to an activity. Also specify whether to initialize the correlation set to be allocated.

If you select no for Instance generation, you must specify a single correlation set that is not to be initialized.

For details about the Allocating Correlation Set Group dialog box, see 1.4.3 Allocating Correlation Set Group Dialog.

Communication model

Select Sync or Async for the operation.

Instance generation

Select whether to initialize the process when a request message is received.

OK button

Saves the defined contents and closes the dialog.

Cancel button

Closes the dialog without saving the defined contents.

1.4.8 Reply Activity Dialog

You use this dialog for defining reply activity details.

This dialog opens when you perform one of the following operations:

Double-click a reply activity on the canvas.

Select and right-click a reply activity on the canvas, and choose Setting.

For details about how to define reply activity, see the description of the reply activity in the manual Service Platform Basic Development Guide.

Figure 1‒73: Reply Activity dialog

Activity name

Specify an activity name. You can use the NCName definition characters of XMLSchema. Specify an activity name that is unique inside a business process or scope.

Operation name

Specify the operation name set in the corresponding receive activity, within 255 bytes. You can use the NCName definition characters of XMLSchema.

Body allocated variable

From the drop-down list, select the variable to be allocated to the response message. The drop-down list shows only the variables that can be used of those defined in the List Of Variables And Correlation Sets dialog.

Edit button

The Variable-Correlation Set dialog opens. Click this button to edit the contents of the variable specified in Body allocated variable.

For details about the List Of Variables And Correlation Sets dialog, see 1.4.1 List Of Variables And Correlation Sets Dialog.

Header allocated variable

Click the Setting button to allocate an already defined header allocated variable to an activity.

Setting button

Opens the Header allocated variable dialog box. As needed, use this dialog box to specify the header allocated variable to be allocated to an activity.

For details about the Header allocated variable dialog box, see 1.4.2 Header allocated variable dialog.

Correlation set group

Click Setting to allocate an already defined correlation set group to an activity.

Setting button

Opens the Allocating Correlation Set Group dialog. As needed, use this dialog to specify the correlation set to be allocated to an activity. Also specify whether to initialize the correlation set to be allocated.

For details about the Allocating Correlation Set Group dialog, see 1.4.3 Allocating Correlation Set Group Dialog.

Fault name

Specify a fault name if you are defining a reply activity for fault handling such that a response message indicating a fault occurrence is sent to the service requester in the event of a fault. Specify a local name in the NCName definition characters of the XMLSchema.

If no fault name is specified, the response message becomes a normal response.

OK button

Saves the defined contents and closes the dialog.

Cancel button

Closes the dialog without saving the defined contents.

1.4.9 Invoke Service Activity Dialog

You use this dialog for defining invoke service activity details.

This dialog opens when you perform one of the following operations:

Double-click a service invocation activity on the canvas.

Select and right-click a service invocation activity on the canvas, and choose Setting.

For details about how to define invoke service activity, see the description of the invoke service activity in the manual Service Platform Basic Development Guide.

Figure 1‒74: Invoke Service Activity dialog

Activity name

Specify an activity name. You can use the NCName definition characters of XMLSchema. Specify an activity name that is unique inside a business process or scope.

Service name

From the drop-down list, select the service component to be invoked by sending a request message. The drop-down list shows the service components displayed in Service Definition List in the tree view.

Operation name

From the operations of the service component specified in Service name, select the name of the operation that is to be actually invoked.

Communication model

Displays the communication model (Sync or Async) specified for the operation selected in Operation name.

Request message

Use the following items to specify the variables relating to request messages.

Body allocated variable

From the drop-down list, select the variable to be allocated to the request message that invokes a service component. The drop-down list shows only the variables (defined in the List Of Variables And Correlation Sets dialog box) that can be used.

Edit button

Opens the List Of Variables And Correlation Sets dialog box.

For details about this dialog box, see 1.4.1 List Of Variables And Correlation Sets Dialog.

Header allocated variable

Opens the Header allocated variable dialog box. As needed, use this dialog box to specify the header allocated variable to be allocated to an activity.

For details about the Header allocated variable dialog box, see 1.4.2 Header allocated variable dialog.

Response message

Use the following items to specify the variables relating to response messages.

Body allocated variable

From the drop-down list, select the variable to be allocated to a response message received from synchronous operation. The drop-down list shows only the variables (defined in the List Of Variables And Correlation Sets dialog box) that can be used.

Edit button

Opens the List Of Variables And Correlation Sets dialog box.

For details about this dialog box, see 1.4.1 List Of Variables And Correlation Sets Dialog.

Header allocated variable

Opens the Header allocated variable dialog box. As needed, use this dialog box to specify the header allocated variable to be allocated to an activity.

For details about the Header allocated variable dialog box, see 1.4.2 Header allocated variable dialog.

Correlation set group

Click Setting to allocate an already defined correlation set group. Correlation set groups are allocated to both request messages that invoke service components and response messages received from service components.

Setting button

Opens the Allocating Correlation Set Group dialog. Use this dialog to specify the correlation sets to be allocated to request messages that invoke service components and response messages received from service components. Moreover, you specify whether to initialize the correlation sets to be allocated, and set up the pattern.

For details about the Allocating Correlation Set Group dialog, see 1.4.3 Allocating Correlation Set Group Dialog.

OK button

Saves the defined contents and closes the dialog.

Cancel button

Closes the dialog without saving the defined contents.

1.4.10 Invoke Java Activity Dialog

You use this dialog for defining invoke Java activity details.

This dialog opens when you perform one of the following operations:

Double-click a Java invocation activity on the canvas.

Select and right-click a Java invocation activity on the canvas, and choose Setting.

For details about how to define invoke Java activity, see the description of the invoke Java activity in the manual Service Platform Basic Development Guide.

Figure 1‒75: Invoke Java Activity dialog

Activity name

Specify an activity name. You can use the NCName definition characters of XMLSchema. Specify an activity name that is unique inside a business process or scope.

Java class name

Specify a Java class name. The Java class name to be specified must include a package name. Do not specify an extension (.class, or .java, for example).

Variable for argument

Specify the variable to be allocated to the argument when the Java class specified in Java class name is invoked. You can also specify multiple variables.

Variable

From the drop-down list, select the variable to be allocated to the argument when the Java class specified in Java class name is invoked. The drop-down list contains only the variables that can be used from those defined in the List Of Variables And Correlation Sets dialog box.

The selected variable appears in the List field when you click the Add button.

Add button

Adds the variable selected in Variable to the List field.

List

Displays the variables that are to be allocated to the arguments when the Java class specified in Java class name is invoked. The order of arguments when the Java class is invoked is the same as the order of Index.

Index

Displays the index of the Java class variable argument (array) for using allocated variables.

This value is not used when an interface whose version is 09-70 or earlier is used.

Type

Displays the value of the variable to be allocated to the Java class argument.

Variable name

Displays the variable name to be allocated to the Java class argument.

Delete button

Deletes the variable selected in the List field. If you select multiple variables and click the Delete button, all the selected variables are deleted.

Up button

Moves up by one line the position of the variable selected in the List field.

Down button

Moves down by one line the position of the variable selected in the List field.

Variable for return value

From the drop-down list, select the variable to be allocated to the return value when the Java class specified in Java class name is invoked. The drop-down list shows only the variables that can be used of those defined in the List Of Variables And Correlation Sets dialog.

Edit button

The Variable-Correlation Set dialog opens. Click this button to edit the contents of the variable to be specified in Variable for argument or Variable for return value.

For details about the List Of Variables And Correlation Sets dialog, see 1.4.1 List Of Variables And Correlation Sets Dialog.

OK button

Saves the defined contents and closes the dialog.

Cancel button

Closes the dialog without saving the defined contents.

1.4.11 Data Transformation Activity Dialog

You use this dialog for defining data transformation activity details.

This dialog opens when you perform one of the following operations:

Double-click a data transformation activity on the canvas.

Select and right-click a data transformation activity on the canvas, and choose Setting.

For details about how to define data transformation activity, see the description of the data transformation activity in the manual Service Platform Basic Development Guide.

Figure 1‒76: Data Transformation Activity dialog

Activity name

Specify an activity name. You can use the NCName definition characters of XMLSchema. Specify an activity name that is unique inside a business process or scope.

Source Variables

Using the items listed below, specify the variable that becomes the data transformation source. You can specify multiple variables. You can make changes even after defining the data transformation.

Variable

From the drop-down list, select the variable that becomes the data transformation source. The drop-down list shows only the variables that can be used of those defined in the List Of Variables And Correlation Sets dialog.

Clicking Add displays the selected variable(s) in List.

Add button

Adds the variables selected in Variable to List.

Edit button

The Variable-Correlation Set dialog opens. Click this button to edit the contents of the variable specified in Variable.

For details about the List Of Variables And Correlation Sets dialog, see 1.4.1 List Of Variables And Correlation Sets Dialog.

List

Shows the variables that become data transformation sources.

Delete button

Deletes the variable selected in List. Selecting multiple variables and clicking Delete deletes all the selected variables.

Destination Variable

Using the items listed below, specify the variable that becomes the data transformation destination. You can make changes even after defining the data transformation.

Variable

From the drop-down list, select the variable that becomes the data transformation destination. The drop-down list shows only the variables that can be used of those defined in the List Of Variables And Correlation Sets dialog.

Edit button

The Variable-Correlation Set dialog opens. Click this button to edit the contents of the variable specified in Variable.

For details about the List Of Variables And Correlation Sets dialog, see 1.4.1 List Of Variables And Correlation Sets Dialog.

DataTransDefnFile

Specify a logical name for a data transformation definition file. You cannot specify characters that are invalid in XML. Furthermore, specify a data transformation definition file name in such a way so that the name is unique within a business process.

A logical name is a name that is virtually assigned to a data transformation definition file. A corresponding file name is automatiinvokey assigned to a logical name.

In the Data Transformation Definition window, create a data transformation definition under the name of the specified data transformation definition file.

Delete File button

Deletes the data transformation definition file specified in DataTransDefnFile.

OK button

Saves the defined contents and closes the dialog.

Cancel button

Closes the dialog without saving the defined contents.

Important note

If you change transformation source variables and destination variables after defining the data transformation, redefine the data transformation. For details about how to redefine the data transformation, see the definition procedure for changing the message format in the manual Service Platform Basic Development Guide.

1.4.12 Assign Activity Dialog

You use this dialog for defining assign activity details.

This dialog opens when you perform one of the following operations:

Double-click an assign activity on the canvas.

Select and right-click an assign activity on the canvas, and choose Setting.

For details about how to define assign activity, see the description about the assign activity in the manual Service Platform Basic Development Guide.

Figure 1‒77: Assign Activity dialog

Activity name

Specify an activity name. You can use the NCName definition characters of XMLSchema. Specify an activity name that is unique inside a business process or scope.

Copy source

Shows variables or values that become the assignment sources. Specify copy sources in the Assign Activity sub dialog, which opens when you click the Add button.

Copy destination

Shows variables or values that become the assignment destinations. Specify copy sources in the Assign Activity sub dialog, which opens when you click the Add button.

Add button

Opens the Assign Activity sub dialog. Click this button to add variables or values to Copy source and Copy destination. For details about the Assign Activity sub dialog, see 1.4.13 Assign Activity Sub Dialog.

Edit button

Opens the Assign Activity sub dialog. Click this button to edit the variables or values in Copy source and Copy destination. For details about the Assign Activity sub dialog, see 1.4.13 Assign Activity Sub Dialog.

Delete button

Deletes the line selected in Copy source and Copy destination. Selecting multiple lines and clicking Delete deletes all the selected lines.

OK button

Saves the defined contents and closes the dialog.

Cancel button

Closes the dialog without saving the defined contents.

1.4.13 Assign Activity Sub Dialog

You use this dialog for adding or editing the Copy source and Copy destination to be defined in the Assign Activity dialog.

This dialog opens when you perform one of the following operations:

Click Add in the Assign Activity dialog

Click Edit in the Assign Activity dialog

For details about how to define assign activity, see the description of the assign activity in the manual Service Platform Basic Development Guide.

Figure 1‒78: Assign Activity Sub dialog

Copy source

Using the items listed below, specify the value to be specified in Copy Source of the Assign Activity dialog.

Variable radio button

Click this button to specify a variable in Copy Source, using a variable name or a variable name and a part name.

Name

From the drop-down list, select the variable name to be specified in Copy Source. The drop-down list shows only the variables that can be used of those defined in the List Of Variables And Correlation Sets dialog.

Edit button

The Variable-Correlation Set dialog opens. Click this button to edit the contents of the variable specified in Name.

For details about the List Of Variables And Correlation Sets dialog, see 1.4.1 List Of Variables And Correlation Sets Dialog.

Part name

When the variable selected in Name is message type, you can select a part name from the drop-down list. The drop-down list shows only the part names specified for the variable selected in Name.

Expression radio button

Select this radio button to specify a value (number, string, or Boolean value) or part of a message-type variable in the absolute path (in XPath) in Copy source.

Variable contents

To use a variable in Expression in Copy source, select the variable name to be displayed from the drop-down list. The drop-down list shows only the variables that can be used of those defined in the List Of Variables And Correlation Sets dialog.

Display button

Click to open the Showing Variable dialog. In the Showing Variable dialog, you can select the contents to be specified for the copy source from the contents of a variable of the message type specified in Variable contents, and acquire an absolute path (in XPath).

For details about the Showing Variable dialog, see 1.4.4 Showing Variable Dialog.

Value

To specify a number, string, or Boolean value in Copy source, specify the respective value.

The value to be specified differs depending on whether a message-type or non-message-type variable was selected in Variable contents. For details about the value to be specified, see the manual Service Platform Basic Development Guide.

Copy destination

Using the items listed below, specify the value to be specified in Copy Destination in the Assign Activity dialog.

Variable

From the drop-down list, select the variable name to be specified in Copy Destination. The drop-down list shows only the variables that can be used of those defined in the List Of Variables And Correlation Sets dialog.

Edit button

The Variable-Correlation Set dialog opens. Click this button to edit the contents of the variable specified in Variable.

For details about the List Of Variables And Correlation Sets dialog, see 1.4.1 List Of Variables And Correlation Sets Dialog.

Part name

When the variable selected in Variable is message type, you can select a part name from the drop-down list. The drop-down list shows only the part names specified for the variable selected in Variable.

OK button

Commits the defined contents to the Assign Activity dialog and closes the dialog.

Cancel button

Closes the dialog without committing the defined contents to the Assign Activity dialog.

1.4.14 Empty Activity Dialog

You use this dialog for defining empty activity details.

This dialog opens when you perform one of the following operations:

Double-click an empty activity on the canvas.

Select and right-click an empty activity on the canvas, and choose Setting.

For details about how to define empty activity, see the description of the empty activity in the manual Service Platform Basic Development Guide.

Figure 1‒79: Empty Activity dialog

Activity name

Specify an activity name. You can use the NCName definition characters of XMLSchema. Specify an activity name that is unique inside a business process or scope.

OK button

Saves the defined contents and closes the dialog.

Cancel button

Closes the dialog without saving the defined contents.

1.4.15 Throw Activity Dialog

You use this dialog for defining throw activity details.

This dialog opens when you perform one of the following operations:

Double-click a throw activity on the canvas.

Select and right-click a throw activity on the canvas, and choose Setting.

For details about how to define throw activity, see the description of the throw activity in the manual Service Platform Basic Development Guide.

Figure 1‒80: Throw Activity dialog

Activity name

Specify an activity name. You can use the NCName definition characters of XMLSchema. Specify an activity name that is unique inside a business process or scope.

Allocated variable

From the drop-down list, select the variable to be allocated to the fault to be thrown to a higher-order scope or business process. The drop-down list shows only the variables that can be used of those defined in the List Of Variables And Correlation Sets dialog.

Edit button

The Variable-Correlation Set dialog opens. Click this button to edit the contents of the variable specified in Allocated variable.

For details about the List Of Variables And Correlation Sets dialog, see 1.4.1 List Of Variables And Correlation Sets Dialog.

OK button

Saves the defined contents and closes the dialog.

Cancel button

Closes the dialog without saving the defined contents.

1.4.16 Standby Activity dialog

A Standby Activity dialog defines details about a standby activity.

When you perform any of the following operations, a Standby Activity dialog appears:

Double click a standby activity on the canvas

Select and right-click a standby activity on the canvas, and then select Preferences

For details about defining a standby activity, see the contents related to the standby activity in the manual Service Platform Basic Development Guide.

Figure 1‒81: Standby Activity dialog

Activity name

Specify an activity name. NCName definition characters of XMLSchema can be used. Specify an activity name that is unique to the business process or scope.

Standby time

Use the following items to specify the standby time for the processing of the business process:

Interval radio button

Select this radio button to stop a process for any arbitrary period of time. For example, select the Interval radio button to stop a process for five minutes.

Term radio button

Select this radio button to stop a process up to any arbitrary period of time. For example, select the Term radio button to stop a process until June 31, 2009.

Variable

To use a variable in the Expression of Standby time, select the displayed variable name from the drop down list. The drop down list displays only variables that can be used from among the variables of the message type defined in the List of Variables and Correlation Sets dialog.

Display button

Displays the Display Variables dialog. In the Display Variables dialog, you can select the contents to be set up in Standby time from the contents of message type variables specified in Display Variables, and acquire the absolute path (XPath expression).

For details about the Display Variables dialog, see the subsection 1.4.4 Showing Variable Dialog.

Expression

Specify the expression displaying the intervals and period of standby time in the XPath. For details about the values to be specified, see the manual Service Platform Basic Development Guide.

OK

Saves the defined contents, and then closes the dialog.

Cancel button

Closes the dialog without saving the defined contents.

1.4.17 Validation activity dialog

This dialog is used to define the details of validation activity.

This dialog is displayed if you perform one of the following operations:

Double click the validation activity for canvas

Select and right click the validation activity for canvas and, select [Set]

For details about how to define validation activity see "5.6.11 Validate activity" in "Service Platform Basic Development Guide".

Figure 1‒82:  [Validation activity] dialog

[Activity name]

Specify the name of activity. You can use NCName defined character of XMLSchema to specify activity name. Specify an activity name which is unique within a business process (also includes scope).

[Validate variable]

Specify the variable that validates the processing of business process, using the following items:

[Variable]

Select a variable from the drop down list. The drop down list displays the "XML" type variables from among the variables defined in the Define Business Process window. Displays the empty element in the end.

[Add] button

Adds the variable selected in [Variable].

[Edit] button

Displays the [List Of Variables And Correlation Sets] dialog. Edit the selected variable with [Variable] in the [List Of Variables And Correlation Sets] dialog.

For details on the [List Of Variables And Correlation Sets] dialog see "1.4.1 List Of Variables And Correlation Sets Dialog".

[List]

Displays the added variables in the order of addition.

If you want to delete a variable, select the target variable to be deleted from this list. You can also select multiple variables.

[Delete] button

Deletes the variable selected in [List].

[OK] button

Saves the specified contents and closes the dialog.

[Cancel] button

Closes the dialog without saving the specified contents.

1.4.18 Scope Activity Dialog

You use this dialog for defining scope activity details.

This dialog opens when you perform one of the following operations:

Double-click a scope activity on the canvas.

Select and right-click a scope activity on the canvas, and choose Setting.

For details about how to define scope activity, see the description of the scope activity in the manual Service Platform Basic Development Guide.

Figure 1‒83: Scope Activity dialog

Figure 1‒84: Scope Activity dialog box (when the "Commit only at the beginning and end of this scope" radio button is selected for a higher-order scope)

Activity name

Specify an activity name. You can use the NCName definition characters of XMLSchema. Make sure that the activity name is unique within a business process (also includes a scope).

Advanced settings

Click ▼ to show and hide the Transaction Control area in the dialog box.

Transaction Control

Select either of the following radio buttons to determine when to commit a transaction.

Commit after each activity radio button (default)

Select this to commit a transaction after each activity.

Commit only at the beginning and end of this scope radio button

Select this to commit a transaction only at the beginning and end of the scope. When you define a scope activity with this button selected, note that a validation error occurs if a reception activity, response activity, or standby activity is defined in the scope activity.

For details about the notes on defining scope activities, see 5.6.12 Scope activity in the Service Platform Basic Development Guide.

If the Commit only at the beginning and end of this scope radio button is selected for a higher-order scope, you cannot use the above radio buttons to specify the time to commit a transaction.

OK button

Saves the defined contents and closes the dialog.

Cancel button

Closes the dialog without saving the defined contents.

1.4.19 While Activity Dialog

You use this dialog for defining while activity details.

This dialog opens when you perform one of the following operations:

Double-click a while activity.

Select and right-click a while activity on the canvas, and choose Setting.

For details about how to define while activity, see the description of the while activity in the manual Service Platform Basic Development Guide.

Figure 1‒85: While Activity dialog

Activity name

Specify an activity name. You can use the NCName definition characters of XMLSchema. Make sure that the activity name is unique within a business process (and includes a scope).

Loop mode

Condition setting

Click the Loop condition setting button to open the Loop condition setting dialog box, and then specify the loop condition. For details about this dialog box, see 1.4.21 Repeat condition setting dialog.

List setting

Click the Loop list setting button to open the Loop list setting dialog box, and then select the list to be looped. For details about this dialog box, see 1.4.20 Repeat list setting dialog.

OK button

Saves the defined contents and closes the dialog.

Cancel button

Closes the dialog without saving the defined contents.

1.4.20 Repeat list setting dialog

Use this dialog to define for using a while activity to specify loop processing.

This dialog is displayed when you click the [Repeat list setting] button on the [While activity] dialog.

For details about how to define while activity see "5.6.13 While activity" in "Service Platform Basic Development Guide".

Figure 1‒86:  [Repeat list setting] dialog (While activity)

[Repeat list]

[Display variable]

Select a variable from the drop down list to set a format that uses a variable in repeat list. The drop down displays only those variables that can be used from the message type variables defined in the [List Of Variables And Correlation Sets] dialog.

[Display] button

Displays the [Showing Variable] dialog. In the [Showing Variable] dialog, you can verify the contents of the message type variables (XML, non-XML) that you specified in [Display variable].

For details about [Showing Variable] see "1.4.4 Showing Variable Dialog".

[Format]

For the evaluation result, specify a format, which is a path of an element of the variable that defines the repeat element, in XPath format. For details about how to specify an XPath expression, see the manual Service Platform Basic Development Guide. Note that extension function cannot be used.

[Variable name]

Select a variable that saves repeat element from the drop down list. The drop down list displays only those variables which can be used from among the XML variables defined in the [List Of Variables And Correlation Sets] dialog.

For details about the [List Of Variables And Correlation Sets] dialog, see "1.4.1 List Of Variables And Correlation Sets Dialog".

[Edit] button

Displays the [List Of Variables And Correlation Sets] dialog. You can add or delete variables in the [List Of Variables And Correlation Sets] dialog.

[Maximum loop count]

[Specify] checkbox

Select this checkbox when you want to specify the maximum loop count.

If you do not check the checkbox, the maximum loop count an go up to 2,147,483,647 times.

[Count]

Specify the maximum value for repeat count in one byte numerical characters. You can specify any integer from 1 to 2,147,483,647.

[OK] button

Reflects the defined contents in [While activity] dialog and closes the dialog.

[Cancel] button

Closes the dialog without reflecting the defined contents in [While activity] dialog.

1.4.21 Repeat condition setting dialog

You use this dialog for defining the condition for using a while activity to specify loop processing.

This dialog is displayed when you click the [Repeat condition setting] button in [While activity] dialog.

For details about how to define while activity see "5.6.13 While activity" in "Service Platform Basic Development Guide".

Figure 1‒87:  [Repeat condition setting] dialog (While Activity)

[Condition format]

[Display variable]

Select variable from the drop down list when setting a formula, in which variables are used in condition. The dropdown list displays only available variables, from among the variables of message format (XML) defines in the [List Of Variables And Correlation Sets] dialog.

[Display] button

Displays the [View variable] dialog. In the [View variable] dialog, you can check the message type (XML) variable contents specified in the [View variable] dialog.

For details about [Showing variable] dialog, see "1.4.4 Showing Variable Dialog".

[Format]

Specify a condition format of a loop condition in XPath. Inside the XPath expression, you can use the extension function to acquire and utilize the information inside a variable. For details about how to use the extension function, see the manual Service Platform Basic Development Guide.

[Max loop count]

Use the following items to specify the maximum loop count in the while activity:

[Specify] checkbox

Select to specify the maximum loop count.

If you do not select the checkbox, the maximum loop count can go up to 2,147,483,647 times.

[Count]

Specify the maximum value of the loop count in one-byte numeric characters. You can set a value in integers from 1 to 2,147,483,647.

[OK] button

Reflects the defined contents to the [While activity] dialog and closes the dialog.

[Cancel] button

Closes the dialog without reflecting the defined contents to [While activity] dialog.

1.4.22 Switch Activity Dialog

You use this dialog for defining switch activity details.

This dialog opens when you perform one of the following operations:

Double-click a switch activity on the canvas.

Select and right-click a switch activity on the canvas, and choose Setting.

For details about how to define switch activity, see the description about the switch activity in the manual Service Platform Basic Development Guide.

Figure 1‒88: Switch Activity dialog

Activity name

Specify an activity name. You can use the NCName definition characters of XMLSchema. Specify an activity name that is unique inside a business process or scope.

Priority

Displays the priority order of the conditions specified in Condition name from high to low. You can click the To Upper and To Lower buttons to change the priority order of the conditions.

Condition name

Displays condition names. To specify a condition, use the Condition Setting dialog, which opens when you click the Condition Setting button.

Transition destination

Select the activity name of the activity that is executed when the conditions are fulfilled.

Condition Setting button

The Condition Settings dialog opens. Click this button to specify a switch condition. For details about the Condition Setting dialog, see 1.4.23 Condition Setting Dialog (Switch Activity).

Clear button

Clears the selected condition.

To Upper button

Increases the priority of the selected condition by one line.

To Lower button

Lowers the priority of the selected condition by one line.

OK button

Saves the defined contents and closes the dialog.

Cancel button

Closes the dialog without saving the defined contents.

1.4.23 Condition Setting Dialog (Switch Activity)

You use this dialog for specifying the switch conditions for the switch processes to be defined in the Switch Activity dialog.

The Condition Setting dialog opens when you click the Condition Setting button in the Switch Activity dialog.

For details about how to define switch activity, see the description of the switch activity in the manual Service Platform Basic Development Guide.

Figure 1‒89: Condition Setting dialog (Switch activity)

Condition name

Specify the name of the condition to be specified in Condition name of the Switch Activity dialog. The condition name must be unique within the switch activity definition.

Variable

To specify an expression that uses a variable for the condition, select the variable from the drop-down list. The drop-down list shows only the variables that can be used of those defined in the List Of Variables And Correlation Sets dialog.

Show Tree button

Click to open the Showing Variable dialog. In the Showing Variable dialog, you can check the contents of the message-type variable specified in Variable.

For details about the Showing Variable dialog, see 1.4.4 Showing Variable Dialog.

Condition Expression

Specify a condition expression of a switch condition in XPath. Inside the XPath expression, you can use the extension function to acquire and utilize the information inside a variable. For details about how to use the extension function, see the manual Service Platform Basic Development Guide.

OK button

Commits the defined contents to the Switch Activity dialog and closes the dialog.

Cancel button

Closes the dialog without committing the defined contents to the Switch Activity dialog.

1.4.24 Flow Activity Dialog

You use this dialog for defining flow activity details.

This dialog opens when you perform one of the following operations:

Double-click a flow start activity on the canvas.

Select and right-click a flow start activity on the canvas, and choose Setting.

For details about how to define flow activity, see the description of the flow activity in the manual Service Platform Basic Development Guide.

Figure 1‒90: Flow Activity dialog

Activity name

Specify an activity name. You can use the NCName definition characters of XMLSchema. Specify an activity name that is unique inside a business process or scope.

Link name

Specify a link name. The link name must be unique inside a business process.

Add button

Add an input line to Link name.

Delete button

Deletes the selected link name. You can select multiple link names to be deleted.

OK button

Saves the defined contents and closes the dialog.

Cancel button

Closes the dialog without saving the defined contents.

1.4.25 Link Dialog

You use this dialog for defining the links among multiple sequences to be flow-processed.

This dialog opens when you perform one of the following operations:

Double-click a link line that links link-target activities together

Select and right-click a link line that links link-target activities together, and click Setting

For details about how to define links for flow processing, see the description of the flow activity in the manual Service Platform Basic Development Guide.

Figure 1‒91: Link dialog

Link name to be allocated

From the drop-down list, select the name of the link to be allocated. The drop-down list shows the link names specified within the applicable scope.

Link source

Of the activities linked using link connections, the name of the activity that is used as the link source is displayed.

Link destination

Of the activities linked using link connections, the name of the activity that is used as the link destination is displayed.

Transition condition

Select the yes or no radio button to specify whether to define a condition for link-based transition.

Set Transition Condition button

The Condition Settings dialog opens. Click this button to specify a link-based transition condition. You can specify a condition only if yes is selected in Transition condition. For details about the Condition Setting dialog, see 1.4.26 Condition Setting Dialog (Flow Activity).

OK button

Saves the defined contents and closes the dialog.

Cancel button

Closes the dialog without saving the defined contents.

1.4.26 Condition Setting Dialog (Flow Activity)

You use this dialog for defining a link condition when a link is specified in flow processing.

This dialog opens when you click the Set Transition Condition button in the Link dialog.

For details about how to define links for flow processing, see the description of the flow activity in the manual Service Platform Basic Development Guide.

Figure 1‒92: Condition Setting dialog (Flow activity)

Variable

To specify an expression that uses a variable for the condition, select the variable from the drop-down list. The drop-down list shows only the variables that can be used of those defined in the List Of Variables And Correlation Sets dialog.

Display button

Click to open the Showing Variable dialog. In the Showing Variable dialog, you can check the contents of the message-type variable specified in Variable.

For details about the Showing Variable dialog, see 1.4.4 Showing Variable Dialog.

Condition Expression

Specify a condition expression of a loop condition in XPath. Inside the XPath expression, you can use the extension function to acquire and utilize the information inside a variable. For details about how to use the extension function, see the manual Service Platform Basic Development Guide.

OK button

Commits the defined contents to the Link dialog and closes the dialog.

Cancel button

Closes the dialog without committing the defined contents to the Link dialog.

1.4.27 Palette Settings Dialog

You use the Palette Settings dialog for specifying palette display settings.

This dialog opens when you right-click a group or tool on the palette and choose Setting.

For the operational procedure, see 1.12.11 Specifying Palette Display Settings.

Figure 1‒93: Palette Settings dialog

Font

Change button

Click this button to change the group or tool on the palette. This action opens the Setting dialog.

Restore Default button

Click this button to restore the default font specified in Eclipse if you used the Change button to change the font.

Layout

Select one of the following radio buttons to specify a layout for the groups and tools on the palette:

Columns radio button

Arranges all groups and tools horizontally.

List radio button

Arranges all groups and tools vertiinvokey.

Icons only radio button

Shows all tools as icons without tool names.

Details radio button

Shows all tools in a detailed format along with their descriptions.

List Layout Options

Use large icons check box

Select this check box to increase the size of the tool icons on the palette.

Drawer options

Select one of the following radio buttons to specify how to display the tool list on the palette:

Always close when opening another drawer radio button

Shows a tool list for a single group only.

Close automatiinvokey when there is not enough room radio button

If the palette runs out of space when displaying tool lists for multiple groups, the tool lists automatiinvokey close.

Never close radio button

Always shows tool lists.

OK button

Commits the specified contents and closes the dialog.

Cancel button

Cancels the specified contents and closes the dialog.

1.5 Dialogs related to debugging of business processes

This section describes the dialogs related to debugging of business processes.

1.5.1 Debug Configuration dialog

The Debug Configuration dialog defines the configuration of debugging a business process.

When you perform any of the following operations, this dialog appears:

Selecting Debug configuration from the Debug menu of Eclipse

Right clicking the business process to be debugged from the list of service definitions in the tree view, and selecting Debug configuration

Right clicking the target project from package explorer, and selecting Debug - Debug configuration

Selecting Debug configuration from the Run menu of Eclipse

For details about how to debug a business process, see the contents related to debugging of a business process in the manual Service Platform Basic Development Guide.

The following figure shows the configuration of the Debug Configuration dialog:

Figure 1‒94: Debug Configuration dialog

A Debug Configuration dialog includes Business Process Settings and Debug Settings tabs.

(1) Business Process Settings tab

The following figure shows items of the Business Process Settings tab:

Figure 1‒95: Business Process Settings tab

Debug target

Select the business process to be debugged from the drop down list.

(2) Debug Settings tab

The following figure shows items of the Debug Settings tab:

Figure 1‒96: Debug Settings tab

Socket settings

Specify a IP address and a port number to be used for debugging the business process.

IP address

Specify the IP address to be used for debugging the business process. To specify an IP address, select the Others radio button, and then enter the IP address in the text box.

Port number

Specify the port number to be used for debugging the business process. To specify a port number, select the Others radio button, and then enter the port number in the text box. You can enter a numeric character from 0 to 65535 in the port number. If you specify 0 in the port number, a free port number will set up automatically.

Communication settings

Specify the maximum size and a timeout value of communication.

Maximum size of communication (MB)

Specify the maximum communication size (unit: MBs) of the data such as messages. To specify an arbitrary maximum size, select the Others radio button, and then enter the maximum size of communication in the text box. You can enter a numeric character from 1 to 2,000 in the maximum size of communication. If you send and receive the data in excess of the size entered in Maximum size of communication (MB), debugging of the business process terminates forcibly.

Reference note

This parameter affects the length of variable values (messages), length of the XPath expression, and length of the XPath expression evaluation result that can be handled for debugging of the business process. This parameter also affects the size of debug information that is received during debugging.

Timeout (seconds)

Set up a timeout value (unit: seconds) until a connection is established for debugging the business process between the development environment and the execution environment. To specify a timeout value, select the Others radio button, and then enter the timeout value in the text box. You can enter a numeric value from 1 to 1,800 in the timeout value.

1.5.2 Condition Setting dialog

Use the Condition Setting dialog to change the condition settings of the break point.

Figure 1‒97: Condition Setting dialog

Specify the conditional expression in XPath for interrupting the processing of the process instance in XPath. You cannot use blank characters (0x00) in the conditional expression.

1.5.3 Value Setting dialog

The Value Setting dialog displays different contents for message type variables and non-message type variables.

(1) Value Setting dialog (message type variables)

Use this dialog for updating the value of message type variables.

Right-click the message type variable in Variables view and select Change Value to view this dialog.

Figure 1‒98: Value Setting dialog (message type variables)

Enter the value of the variable in the input field. You cannot use blank characters (0x00) in the variable value. If you update a message type variable, the XML character code always changes to UTF-8 (even if a character code other than UTF-8 is specified, the character code is converted to UTF-8).

Read XML button

Displays the dialog for setting an XML file.

Save XML button

Displays the dialog for saving the XML file.

OK button

Enables the entered contents, and then closes the dialog.

Cancel button

Disables the specified contents, and then closes the dialog.

(2) Value Setting dialog (non-message type variables)

Use this dialog for updating the value of non-message type variables.

Right-click the non-message type variable in the Variables view, and then select Change Value to view this dialog.

Figure 1‒99: Value Setting dialog (non-message type variables)

Enter the value of the variable in the input field. The following table describes the range of values that you can enter in each variable type:

Table 1‒12: Range of values that can be entered in each variable type

Variable type

Range of value

numeric type

Values that can be interpreted by the valueOf (java.lang.String) method of java.lang.Double (example:+1, 3.14, 1e-2d)

boolean type

True or false

string type

Any character string (example: 15inch LCD display)

OK button

Enables the entered contents, and then closes the dialog.

Cancel button

Disables the set up contents, and then closes the dialog.

1.6 Dialogs Related to Data Transformation

This section explains the dialogs related to data transformation. The dialog boxes are roughly divided into two types: those displayed during mapping definition in the Data Transformation Definition window and those displayed during function operations.

1.6.1 Settings for Source Schema File dialog box

In the Settings for Source Schema File dialog box, you can specify the source schema file when performing N-to-one data transformation.

This dialog box opens when you perform one of the following operations:

In the Settings for Source and Target Schema File page of the new mapping definition file wizard, select the N-to-one transformation radio button, and then click the Add or Edit button.

When you create an N-to-one data transformation definition, click the Edit button in the Settings for Source and Target Schema File dialog box.

Figure 1‒100: Settings for Source Schema File dialog box

(1) Displayed items

Source schema

Specify the file path of the source schema.

Select button

Displays the dialog box for selecting a source schema file.

Schema logical name

Specify a schema logical name that is unique within the source schema.

OK button

After validation of the specified settings, saves the settings and then closes the dialog box.

Cancel button

Cancels the specified settings and closes the dialog box.

(2) Operations that can be performed in this dialog box

In the Settings for Source Schema File dialog box, you can add or change source schema files used for N-to-one data transformation. For details about how to define data transformation, see 6.3.1 Procedure for Defining Data Transformation in the Service Platform Basic Development Guide.

1.6.2 Settings for Source and Target Schema File dialog box

In the Settings for Source and Target Schema File dialog box, you can specify the source schema file and the target schema file.

This dialog box opens when you right-click a schema logical name in the source schema tree viewer or target schema tree viewer, and then click Select Root Element. A different dialog box appears for one-to-one data transformation and for N-to-one data transformation.

Figure 1‒101: Settings for Source and Target Schema File dialog box (for one-to-one data transformation)

Figure 1‒102: Settings for Source and Target Schema File dialog box (for N-to-one data transformation)

(1) Displayed items

(a) For one-to-one data transformation

Source schema

Specify the file path of the source schema. You can select a source schema file in the dialog box displayed by clicking the Select button.

Select button

Displays the dialog box for selecting a source schema file.

Target schema

Specify the file path of the target schema. You can select a target schema file in the dialog box displayed by clicking the Select button.

Select button

Displays the dialog box for selecting a target schema file.

OK button

After validation of the specified settings, saves the settings and then closes the dialog box.

Cancel button

Cancels the specified settings and closes the dialog box.

(b) For N-to-one data transformation

Source schema

File path

Displays the file path of the previously specified source schema.

Schema logical name

Displays the previously specified schema logical name of the source schema.

Edit button

When a source schema selected, clicking this button opens the Settings for Source Schema File dialog box in which you can change the source schema file and schema logical name. For details about the Settings for Source Schema File dialog box, see 1.6.1 Settings for Source Schema File dialog box.

Target schema

Specify the file path of the target schema. You can select a target schema file in the dialog box displayed by clicking the Select button.

Select button

Displays the dialog box for selecting a target schema file.

OK button

Enables the specified settings and closes the dialog box.

Cancel button

Cancels the specified settings and closes the dialog box.

(2) Operations that can be performed in this dialog box

In the Settings for Source and Target Schema File dialog box, you can specify the source schema files and target schema file. For details about how to define data transformation, see 6.3.1 Procedure for Defining Data Transformation in the Service Platform Basic Development Guide.

1.6.3 Select Root Element Dialog

In the Select Root Element dialog, select the root element of the schema logical name to be mapped.

This dialog opens when you perform one of the following operations:

Open the Data Transformation Definition window from a data transformation activity in the Adapter Definition window or Business Process Definition window (when newly defining data transformation)

Displays the Data Transformation Definition screen after the root element of schema (message format) is changed or deleted.

Right-click a schema logical name in the source schema tree viewer or target schema tree viewer, and then click Select Root Element.

The following figure shows the Select Root Element dialog.

Figure 1‒103: Select Root Element dialog

(1) Displayed items

Schema logical name

Shows the schema logical names of the mapping-target XML schema files.

Root element

Select a root element from the drop-down list. The schema of the selected root element is displayed in a tree format in the Data Transformation Definition window.

Source/Target

Shows Source when the mapping-target XML schema file is a source XML schema file, and shows Target when the mapping-target XML schema file is a target XML schema file.

OK button

Commits the specified contents and closes the dialog.

Cancel button

Cancels the specified contents and closes the dialog. Disables the specified contents, and closes the dialog. An error occurs, when you click this button in the following cases:

When you select the root element for the first time

When you change the message format and redefine the data transformation

(2) Operations that can be performed in this dialog

In the Select Root Element dialog, you can select or change the root element. When the root element is selected or modified, the schema of the root element is displayed in a tree format in the Data Transformation Definition window. For details about how to select and change the root element, see the description of procedures for defining data transformation in the manual Service Platform Basic Development Guide.

1.6.4 Settings for Mapping Source Dialog

In the Settings for Mapping Source dialog, specify a source node or function that becomes a mapping source.

The Settings for Mapping Source dialog opens when you right-click a target node and choose Mapping source.

The following figure shows the Settings for Mapping Source dialog.

Figure 1‒104: Settings for Mapping Source dialog

(1) Displayed items

Path/Function name

Specify the target node or function that becomes the mapping source. If the node is already mapped, its mapping source is displayed.

For details about the display format in Path/Function Name, see the description of the display format for the mapping source in the manual Service Platform Basic Development Guide.

Dependent target

When you use a loop node function, the looping dependent target that corresponds to the loop node function specified in Path/Function name is displayed. For details about the looping Dependent Target, see the description for loop settings in the manual Service Platform Basic Development Guide.

Add Node button

The Node Selection dialog opens. Click this button to add a source node that becomes the mapping source to Path/Function name.

For details about the Select Node dialog, see 1.6.8 Select Node Dialog (Data Transformation).

Set Node Condition button

The Set Node Condition dialog opens. Click this button to specify a condition for the source node and allow mapping to take place only when that condition is satisfied.

For details about the Set Node Condition dialog, see 1.6.11 Set Node Condition Dialog. Also, for details about how to set up the conditions for transformation source node, see the description about node condition settings in the manual Service Platform Basic Development Guide.

Add Function button

The Select Function dialog opens. Click this button to add a function that becomes the mapping source to Path/Function name.

For details about the Select Function dialog, see 1.6.9 Select function dialog.

Remove button

Deletes the source node or function selected in Path/Function name from Path/Function name.

OK button

Commits the specified contents and closes the dialog.

Cancel button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

In the Settings for Mapping Source dialog, you can perform the following operations:

Mapping

For details about mapping methods with the settings for the Mapping Source dialog, see the description for mapping in the manual Service Platform Basic Development Guide.

Checking looping dependent targets

For details about how to check looping dependent targets, see the description for checking the looping dependent targets in the manual Service Platform Basic Development Guide.

Changing looping dependent targets

For details about how to change looping dependent targets, see the description for changing the looping dependent targets in the manual Service Platform Basic Development Guide.

1.6.5 Settings for Automatic Mapping Source dialog

In the Settings for Automatic Mapping Source dialog, specify the range of transformation source nodes and the range of transformation destination nodes to be mapped automatically.

The Settings for Automatic Mapping Source dialog appears, when you right-click the transformation destination node element (the top element of the range to be mapped automatically) and select Automatic Mapping.

The Settings for Automatic Mapping Source dialog is as follows:

Figure 1‒105: Settings for Automatic Mapping Source dialog

(1) Display items

Path

Displays the element to be mapped selected by the Add node button.

If you close the Settings for Automatic Mapping Source dialog, the contents displayed in Path are reset, and nothing is selected in Path, when you view the Settings for Automatic Mapping Source dialog again.

Add node button

Displays the Select Node dialog. Click to add an element of the transformation source node in Path that acts as the mapping source.

For details about the Select Node dialog, see the subsection 1.6.8 Select Node Dialog (Data Transformation).

Remove button

Deletes the element selected in Path from Path.

OK button

Enables the specified contents, and then closes the dialog.

Cancel button

Disables the specified contents, and then closes the dialog.

(2) Operations that can be performed in this dialog

In the Settings for Automatic Mapping Source dialog, if you specify the range of the transformation-source node and transformation-destination node, elements in the transformation-source node and transformation-destination node with a high degree of similarity are mapped automatically. If mapping options do not exist within the range or if a mapping line is already connected to the transformation-destination node adapter, the mapping is not performed.

1.6.6 Select Automatic Mapping Options dialog

In the Select Automatic Mapping Options dialog, specify the proposed elements to be mapped automatically.

The Select Automatic Mapping Options dialog appears, when you right-click the element of the transformation-destination node, and then select Select Automatic Mapping Option.

The following figure shows the Select Automatic Mapping Options dialog:

Figure 1‒106: Select Automatic Mapping Options dialog

(1) Display items

Automatic Mapping Options List

Displays a list of elements of the transformation-source node that act as the mapping options with respect to the selected elements of the transformation-destination node. The mapping options are displayed in an order starting with the high-priority options at the top.

If no options are available for automatic mapping, nothing appears in the Automatic Mapping Options List.

OK button

Enables the specified contents, and then closes the dialog.

Cancel button

Disables the specified contents, and then closes the dialog.

(2) Operations that can be performed in this dialog

In the Select Automatic Mapping Options dialog, if you specify a proposed element of the transformation-source node, the selected proposed element is mapped and the mapping line (assigned line) is set up automatically. Even if the mapping line is already connected to the node adapter of the selected element, mapping to the specified option is performed, when mapping lines with different dependence can be connected in the same element.

1.6.7 Loop Settings Dialog

The Loop Settings dialog specifies the loop node function that configures the mapping source. The following figure shows the Loop Settings dialog.

When you are using a loop node function, the Loop Settings dialog opens when you right-click a target node and choose Loop.

The following figure shows the Loop Settings dialog.

Figure 1‒107: Loop Settings dialog

(1) Displayed items

Function name

Specify a loop node function that becomes the mapping source. Loop node function names are displayed.

Dependent target

The looping dependent target that corresponds to the loop node function specified in Function name is displayed. For details about looping dependent targets, see the description for loop settings in the manual Service Platform Basic Development Guide.

Add Function button

The Select Function dialog opens. Click this button to add a loop node function that becomes the mapping source to Function name.

For details about the Select Function dialog, see 1.6.9 Select function dialog.

Up button

Moves up by one line the position of the loop node function selected in Function name. This button is sometimes used for synthesizing a loop.

Down button

Moves down by one line the position of the loop node function selected in Function name. This button is sometimes used for synthesizing a loop.

Remove button

Deletes the loop node function selected in Function name from Function name.

OK button

Commits the specified contents and closes the dialog.

Cancel button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

In the Loop Settings dialog, you can perform the following operations:

Mapping

Synthesizing a loop

Checking looping dependent targets

Changing looping dependent targets

For details about the above methods, see the description for loop settings in the manual Service Platform Basic Development Guide.

1.6.8 Select Node Dialog (Data Transformation)

In the Select Node dialog (data transformation), specify a source node that becomes a mapping source or a target node that is the copy destination of the mapping definition.

The Select Node dialog (data transformation) for selecting the source node is displayed when you perform one of the following operations:

In the Settings for Mapping Source dialog, click Add Node

In the setting dialog box for each function, click Add Node or Select Node

In the Settings for Automatic Mapping Source dialog, click Add Node

In the Settings for Duplicate Mapping Source dialog, click Add Node

In the Settings for duplicate mapping range dialog, from Source node, click Select node

The Select Node dialog (data transformation) for selecting the transformation destination node is displayed when you perform the following operation:

In the Settings for duplicate mapping range dialog, from Target node, click Select node

The following figure shows the Select Node dialog (data transformation):

Figure 1‒108: Select Node dialog (Data transformation)

(1) Displayed items

Source node

Shows source nodes that are candidate of mapping definitions.

Nodes that cannot be selected as mapping sources are shown in gray. When you select a node displayed in gray, the OK button is disabled.

Target node

Shows target nodes that are candidate of mapping definitions.

Nodes that cannot be selected as mapping targets are shown in gray. When you select a node displayed in gray, the OK button is disabled.

OK button

Commits the specified contents and closes the dialog.

Cancel button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

With the Select Node dialog, you can perform the following operations:

Specify the transformation source node that acts as the mapping source

If this dialog is displayed from the Settings for Mapping Source dialog or from the setting dialog box for each function, specify the transformation source node that are the mapping source, and set up the transformation source node in the Settings for Mapping Source dialog or in each function.

Automatically specify the transformation source node that acts as the mapping source

If this dialog is displayed from the Settings for Automatic Mapping Source dialog, specify elements of the transformation source node that are to be mapped automatically, and set up the element of the transformation source node in the path of the Settings for Automatic Mapping Source dialog.

Specify transformation source node that is the copy destination of mapping definitions with the same structure

If this dialog is displayed from the Setting for Duplicate Mapping Source dialog, specify the transformation source node that is the copy destination, and set up the transformation source node in the Setting for Duplicate Mapping Source dialog.

Specify transformation source node that is the copy source or the copy destination of mapping definitions with the same element name

If this dialog is displayed from the Source node in the Settings for duplicate mapping range dialog, specify the transformation source node that is the copy source or destination of mapping definitions, and set up the transformation source node in the Settings for duplicate mapping range dialog.

Specify transformation destination node that is the copy source or the copy destination of mapping definitions with the same element name

If this dialog is displayed from the Target node in the Settings for duplicate mapping range dialog, specify the transformation destination node that is the copy source or destination of mapping definitions, and set up the transformation target node in the Settings for duplicate mapping range dialog.

1.6.9 Select function dialog

Use the [Select function] dialog to specify function that will become a mapping source.

This dialog is displayed when you perform one of the following operations:

Click the [Add function] button in the [Settings for Mapping source] dialog

Click the [Add function] or [Select function] button in the settings dialog of each function

The following figure shows the [Select function] dialog:

Figure 1‒109:  [Select function] dialog

(1) Displayed items

[Function]

Displays the functions that can be selected as mapping source.

[OK] button

Enables the specified contents and closes the dialog.

[Cancel] button

Closes the dialog without enabling the specified contents.

(2) Operations that can be performed in this dialog

By specifying function that will become mapping source in the [Select function] dialog, you set the functions specified in the [Mapping source settings] dialog or the settings dialog of each function.

1.6.10 Search element name dialog

Use the [Search element name] dialog to search for partial matches of element name and display the search results path list. You can also edit mapping definition while the [Search element name] dialog is displayed.

The [Search element name] dialog is displayed when you right click the appropriate place in the tree viewer on the data transformation definition screen and select [Search element name].

The following figure shows the [Search element name] dialog:

Figure 1‒110:  [Search element name] dialog

(1) Displayed items

[Search]

Specify the search string here. By clicking the [Search] button, you can search nodes that contain the search string.

The nodes that will be searched are as follows:

Logical name

Complex content element

Simple content element

Attributes

any element

anyAttribute

#(sequence), #(choice)

#anonymous

Note the following points while performing search:

Search string characters are not case sensitive.

You cannot perform search with regular expressions

The entire path of node does not become search target. Only the end of element name becomes search target.

Search results display paths of node in a list format in [List of Search results].

[Search] button

Searches for nodes that contain the search string specified in [Search]. Search results are displayed in [List of search results].

[Search target]

Select the [Transformation source node] or [Transformation destination node] as the search target.

[List of search results]

Path of the nodes in the search results are listed according to the node display order on the screen. If you choose a displayed path, node is selected as follows:

If the [Search target] is Transformation source node, the corresponding node on the Transformation source schema tree viewer is selected.

If the [Search target] is Transformation destination node, the corresponding node on the Transformation destination schema tree viewer is selected.

You can copy a path to the clipboard by selecting and right-clicking the path and then clicking Copy Element Path in the context menu. In the case of N-to-one transformation, the path including $schema-logical-name (business-process-variable-name) is copied. Note that Copy Element Path is not displayed by right-clicking a schema logical name shown in the search results.

[Search number of elements]

Number of search results is displayed.

Note that this item is displayed below [List of search results] after you have clicked on the [Search] button.

[Close] button

Closes the [Search element name] dialog.

(2) Operations that can be performed in this dialog

You can search for partial matches od element name with the [Search element name] dialog. If there is a large number of Transformation source nodes and Transformation destination nodes, you can easily search for the node that you want to use.

1.6.11 Set Node Condition Dialog

In the Set Node Condition dialog, specify the source node for which to specify a node condition, and then specify the condition.

This dialog opens when you perform one of the following operations:

Click Set Node Condition in the Settings for Mapping Source dialog

Click Set Node Condition in the dialog for specifying each function

The following figure shows the Set Node Condition dialog.

Figure 1‒111: Set Node Condition dialog

(1) Displayed items

Node

Shows the node selected in the Settings for Mapping Source dialog or the dialog for specifying each function, and its descendant nodes.

Condition

Shows the condition specified in the Condition Settings dialog.

Set Condition button

The Condition Settings dialog opens. Click this button to specify a condition for the source node.

For details about the Condition Settings dialog, see 1.6.12 Condition Settings Dialog (Set Node Condition).

Remove Condition button

Deletes the condition selected in Condition from Condition.

OK button

Commits the specified contents and closes the dialog.

Cancel button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

In the Set Node Condition dialog, you can specify the source node for which to specify a node condition, and then specify the node condition. A source node for which the condition is specified is mapped only when that condition is satisfied. For details about how to set up the conditions for transformation source nodes, see the description of node condition settings in the manual Service Platform Basic Development Guide.

1.6.12 Condition Settings Dialog (Set Node Condition)

In the Condition Settings dialog, specify condition details.

This dialog opens when you perform one of the following operations:

Click Set Condition in the Set Node Condition dialog

Click Set Node Condition in the Add/Edit Condition dialog

Click Set Condition in the Condition Settings dialog

The following figure shows the Condition Settings dialog (Set Node Condition).

Figure 1‒112: Condition Settings Dialog (Set Node Condition)

(1) Displayed items

Condition to be generated

Shows the condition specified in Condition.

If the Negate the condition check box is selected, not is displayed at the head of the condition.

Negate the condition check box

Select this check box to use a condition that has the opposite contents from the condition specified in Condition.

Condition

Node or function to return the boolean value radio button

Click this button to specify a Boolean value as a condition.

One of the following Boolean values is set depending on the value of the mapping source specified using the Select Node or Select Function button:

When the mapping source value is true or a numeric value other than 0, -0, or NaN

true is set as the condition.

When the mapping source value is a string other than true, or a numeric value 0, -0, or NaN

False is set as the condition.

Select Node button

The Node Selection dialog opens. Click this button to specify a source node for a mapping source.

For details about the Select Node dialog, see 1.6.8 Select Node Dialog (Data Transformation).

Select Function button

The Select Function dialog opens. Click this button to specify a function for a mapping source.

For details about the Select Function dialog, see 1.6.9 Select function dialog.

Condition format radio button

Click this button to set the specified condition expression as a condition.

Left side

Position radio button

Click this button to set the order in which the mapping source instances occur as a condition.

For example, if Position=2 is specified (by selecting this radio button and specifying 2 for the value on the right side), the instance that appears second is set as the condition.

Node or function radio button

Select this button to set the value of a source node or function as a condition.

Select Node button

The Node Selection dialog opens. Click this button to specify a source node for the left side of a condition expression.

For details about the Select Node dialog, see 1.6.8 Select Node Dialog (Data Transformation).

Select Function button

The Select Function dialog opens. Click this button to specify a function for the left side of a condition expression.

For details about the Select Function dialog, see 1.6.9 Select function dialog.

Operator drop-down list box

Shows the following operators that can be specified in a condition expression. The displayed operators are as follows:

=

!=

>

<

>=

<=

Right side

Value radio button

Select this button to set a user-specified value as a condition. A maximum of 1,024 characters can be specified.

Node or function radio button

Select this button to set the value of a source node or function as a condition.

Select Node button

The Node Selection dialog opens. Click this button to specify a source node for the right side of a condition expression.

For details about the Select Node dialog, see 1.6.8 Select Node Dialog (Data Transformation).

Select Function button

The Select Function dialog opens. Click this button to specify a function for the right side of a condition expression.

For details about the Select Function dialog, see 1.6.9 Select function dialog.

Logical operation of two conditions radio button

Select this button to specify two conditions and set the logical product or logical sum of these two conditions as a condition.

Condition 1

Shows the first condition.

Set Condition button

Opens another instance of the Condition Settings dialog. Click this button to specify the first condition.

Operator drop-down list box

Shows and (logical product) or (logical sum).

Condition 2

Shows the second condition

Set Condition button

Opens another instance of the Condition Settings dialog. Click this button to specify the second condition.

OK button

Commits the specified contents and closes the dialog.

Cancel button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

In the Condition Settings dialog, you can perform the following operations:

Specify node conditions

For details about how to set up node conditions, see the description of node condition settings in the manual Service Platform Basic Development Guide.

Specify a condition for the choose node function

For details about how to set up the conditions for the choose node function, see the description for processing values using functions in the manual Service Platform Basic Development Guide.

1.6.13 Register Mapping Definitions dialog

In the Register Mapping Definitions dialog, specify the mapping definition file (extension: .mdo) that you will register as the copy source while copying the mapping definitions.

The Register Mapping Definitions dialog appears, when you right-click the applicable location of the transformation-source schema tree viewer, mapping viewer, or transformation-destination schema tree viewer, and then select Register Mapping Definition.

The following figure shows the Register Mapping Definitions dialog:

Figure 1‒113: Register Mapping Definitions dialog

(1) Display items

Mapping definition file

Specify the mapping definition file that acts as the copy source. If the mapping definition file is already registered, the registered mapping definition file appears.

Select button

Displays the dialog for selecting a file. The directory displayed first in the dialog for selecting the file can be set up at any location in the Preferences dialog. For details about the Preferences dialog box, see 1.6.18 Preferences dialog box (Data transformation settings).

OK button

Enables the specified contents, and then closes the dialog.

Cancel button

Disables the specified contents, and then closes the dialog.

(2) Operations that can be performed in this dialog

In the Register Mapping Definitions dialog, you can set up the mapping definition file (extension: .mdo) registered as the copy source while copying the mapping definition. For details about copying mapping definitions, see the manual Service Platform Basic Development Guide.

1.6.14 Settings for duplicate mapping range dialog

Use this dialog to specify the nodes that become copy source and copy destination (Transformation source node and Transformation destination node) at the time of copying mapping definition.

This dialog is displayed when you right click the complex content element in the Transformation source schema tree viewer on the data transformation definition screen and then select [Element name match] from [Duplicate mapping].

Figure 1‒114:  [Settings for duplicate mapping range] dialog

(1) Displayed items

[Duplicate mapping source]

[Transformation source node]

Specify the Transformation source node for duplicate mapping source.

To change the Transformation source node, click the [Select node] button on the right side and, specify the desired node on the [Select Node] dialog that is displayed. For details about [Select Node] dialog see "1.6.8 Select Node Dialog (Data Transformation)".

[Transformation destination node]

Specify the transformation destination node for duplicate mapping source.

To change the transformation destination node, click the [Select node] button on the right side and, specify the desired node on the [Select Node] dialog that is displayed. For details about [Select Node] dialog see "1.6.8 Select Node Dialog (Data Transformation)".

[Duplicate mapping destination]

[Transformation source node]

Specify the transformation source node for duplicate mapping destination.

To change the transformation source node, click the [Select node] button on the right side and, specify the desired node on the [Select Node] dialog that is displayed. For details about [Select Node] dialog see "1.6.8 Select Node Dialog (Data Transformation)".

[Transformation destination node]

Specify the transformation destination node for duplicate aping destination.

To change the transformation destination node, click the [Select node] button on the right side and, specify the desired node on the [Select Node] dialog that is displayed. For details about [Select Node] dialog see "1.6.8 Select Node Dialog (Data Transformation)".

[OK] button

Enables the specified contents and closes the dialog.

[Cancel] button

Does not enable the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

In this dialog, you can specify the nodes that will become the copy source and copy destination of mapping definition. Specify the transformation source node and transformation destination node for each item.

For details about copying mapping definition see "6.8.4 Copying mapping definition" in "Service Platform Basic Development Guide".

1.6.15 Settings for Duplicate Mapping Source dialog

In the Settings for Duplicate Mapping Source dialog, specify the node (transformation-source node) that acts as the copy destination de) while copying the mapping definitions.

The Settings for Duplicate Mapping Source dialog appears, when you right-click a complex content element in the transformation-destination schema tree viewer of the Data Transformation Definition window, and then select Duplicate mapping.

The following figure shows the Settings for Duplicate Mapping Source dialog:

Figure 1‒115: Settings for Duplicate Mapping Source dialog

(1) Display items

Path

Specify the node (transformation-source node) that acts as the copy destination while copying the mapping definitions.

For details about the display format in Path, see the contents related to the display format of the mapping source in the manual Service Platform Basic Development Guide.

Add node button

Displays the Select Node dialog. Click to add a node (transformation-source node) in Path.

For details about the Select Node dialog, see 1.6.8 Select Node Dialog (Data Transformation).

Remove button

Deletes the node selected in Path (transformation-source node) from Path.

OK button

Enables the specified contents, and then closes the dialog.

Cancel button

Disables the specified contents, and then closes the dialog.

(2) Operations that can be performed in this dialog

In the Settings for Duplicate Mapping Source dialog, you can set up the node (transformation-source node) that acts as the copy destination while copying the mapping definitions. For details about copying the mapping definitions, see the manual Service Platform Basic Development Guide.

1.6.16 Import mapping definition dialog

After you have exported the mapping contents that were defined in Excel, in table format XML file, use [Import mapping definition ] dialog, to import those definition contents to data transformation definition screen.

[Import mapping definition] dialog is displayed when you right on the mapping viewer on data transformation definition screen and, select [Import mapping definition].

The following figure shows the [Import mapping definition] dialog:

Figure 1‒116:  [Import mapping definition] dialog

(1) Displayed items

[Table format XML file name]

Specify the table format XML filename to be imported.

[Reference] button

Displays dialog to specify the table format XML file.

[Finish] button

Closes the [Import mapping definition] dialog.

Functions and mapping lines defined in Excel are reflected on the data transformation definition screen.

[Cancel] button

Closes the dialog without enabling the specified contents.

(2) Operations that can be performed in this dialog

You can import the mapping defined in Excel with [Import mapping definition] dialog. For details about importing mapping definition see "6.12 Importing mapping definition using Excel" in "Service Platform Basic Development Guide".

1.6.17 Export Mapping Definition dialog box

Use the Export Mapping Definition dialog box to export mapping information defined with the mapping definition editor to a table format XML file.

The Export Mapping Definition dialog box opens when you right-click anywhere in the mapping viewer in the Data Transformation Definition window, and then click Export Mapping Definition.

The following shows the Export Mapping Definition dialog box.

Figure 1‒117: Export Mapping Definition dialog box

(1) Displayed items

File name

Specify the name of the table format XML file to be exported.

File type

Select Table format XML file (*.xml).

Save button

Displays the dialog box for starting the export of the mapping definition.

Cancel button

Cancels the specified settings and closes the dialog box.

(2) Operations that can be performed in this dialog box

In the Export Mapping Definition dialog box, you can export the defined mapping to a table format XML file. For details about how to export the mapping definition by using Excel, see the manual Service Platform Basic Development Guide.

1.6.18 Preferences dialog box (Data transformation settings)

The steps to display Preferences dialog box for data transformation related settings, are as follows:

From Eclipse menu, select [Window] - [Settings].

Preferences dialog box is displayed.

From the left side of the dialog, select [HCSC-Definer] and - [Data transformation].

The setting items of data transformation definition screen are displayed on the right side of the dialog.

The mapping tab and custom function tab displayed on the right side of the dialog are described as follows:

(1) Displayed items

(a) Mapping tab

The following figure shows the mapping tab of data transformation in the Preferences dialog box:

Figure 1‒118:  Preferences dialog box (Mapping tab of data transformation)

The items displayed are as follows:

[Line color]

[Assign]

When you click the button on the right side of [Assign], [Color settings] dialog is displayed.

[Loop]

When you click the button on right side of [Loop], [Color settings] dialog is displayed.

[Condition]

When you click the button on the right side of [Condition], [Color settings] dialog is displayed.

[Mapping definition folder]

[Folder]

Specify the folder to be displayed first when you save mapping definition and register mapping definition.

[Reference] button

Displays the folder selection screen.

[Restore Defaults] button

Reverts data transformation to default settings. The default settings of data transformation are as follows:

Mapping line color: Grey

Mapping definition folder: Blank

Transformation function definition file: Blank

For details about transformation function definition file see " (b) Custom function tab".

[Apply] button

Enables the specified contents. This button does not close the dialog.

[Apply and Close] button

Enables the specified contents and closes the dialog.

[Cancel] button

Closes the dialog without enabling the specified contents.

(b) Custom function tab

The following figure shows the custom function tab of data transformation in the Preferences dialog box:

Figure 1‒119:  Preferences dialog box (Custom function tab of data transformation)

The items displayed are as follows:

[Transformation function definition file]

[File]

Specify the transformation function definition file to be used in the definition of a custom function.

[Reference] button

Displays the file selection screen.

[Remove] button

Deletes the transformation function definition file that you specified in [File], from [File].

[Restore Defaults] button

Reverts data transformation to default settings. The default settings for data transformation are as follows:

Mapping line color: Grey

Mapping definition folder: Blank

Transformation function definition file: Blank

For details on mapping line color and mapping definition folder, see "(a) Mapping tab".

[Apply] button

Enables the specified contents. This button does not close the dialog.

[Apply and Close] button

Enables the specified contents and closes the dialog.

[Cancel] button

Closes the dialog without enabling the specified contents.

(2) Operations that can be performed in this dialog

You can perform the following operations in the Preferences dialog box:

In Mapping tab

You can change the color of mapping line. For details see "1.13.5 Changing the Mapping Line Color".

You can specify the directory to be referenced first from [Register Mapping Definitions] dialog and [Save Mapping Definitions] dialog. For details about [Register Mapping Definitions] dialog, see "1.6.13 Register Mapping Definitions dialog".

In Custom function tab

You can register the transformation function definition file that is required when custom functions are defined. For details about how to define custom functions, see "6.5 Processing value or node in which function is used" in "Service Platform Basic Development Guide".

1.6.19 Concatenate Dialog

In the Concatenate dialog, specify the strings to be concatenated.

This dialog opens when you perform one of the following operations:

Right-click the concatenate function, and choose Setting

Double-click the concatenate function

The following figure shows the Concatenate dialog.

Figure 1‒120: Concatenate dialog

(1) Displayed items

Function name

Displays the function name. To change the function name, you can specify a name by using 64 or fewer characters. You can use NCName definition characters of XMLSchema.

Input

Specify the source node and function of the string to be concatenated. If a concatenation target is already mapped to the concatenate function, that concatenation target is displayed.

For details about the display format in Input, see the description for display format of the mapping source in the manual Service Platform Basic Development Guide.

Add Node button

The Node Selection dialog opens. Click this button to add the source node of the concatenation target string to Input.

For details about the Select Node dialog, see 1.6.8 Select Node Dialog (Data Transformation).

Set Node Condition button

The Set Node Condition dialog opens. Click this button to specify a condition for the source node and allow mapping to take place only when that condition is satisfied.

For details about the Set Node Condition dialog, see 1.6.11 Set Node Condition Dialog.For details about how to set up the conditions for transformation source nodes, see the description of node condition settings in the manual Service Platform Basic Development Guide.

Add Function button

The Select Function dialog opens. Click this button to add the function of the concatenation target string to Input.

For details about the Select Function dialog, see 1.6.9 Select function dialog.

Up button

Moves up by one line the position of the source node or function selected in Input.

Down button

Moves down by one line the position of the source node or function selected in Input.

Remove button

Deletes the source node or function selected in Input from Input.

OK button

Commits the specified contents and closes the dialog.

Cancel button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

In the Concatenate dialog, you can set up the concatenate function. For details about how to set up the acquire substring function, see the description for processing values using functions in the manual Service Platform Basic Development Guide.

1.6.20 Acquire Substring Dialog

In the Acquire Substring dialog, specify a substring to be acquired from a string.

This dialog opens when you perform one of the following operations:

Right-click the acquire substring function, and choose Setting

Double-click the acquire substring function

The following figure shows the Acquire Substring dialog.

Figure 1‒121: Acquire Substring dialog

(1) Displayed items

Function name

Displays the function name. To change the function name, you can specify a name by using 64 or fewer characters. You can use NCName definition characters of XMLSchema.

Input

Specify the source node and function from which a substring is to be extracted. If an extraction source is already mapped to substring acquisition, that extraction source is displayed.

For details about the display format in Input, see the description for the display format of the mapping source in the manual Service Platform Basic Development Guide.

Select Node button

The Node Selection dialog opens. Click this button to specify in Input a source node from which a substring is to be extracted.

For details about the Select Node dialog, see 1.6.8 Select Node Dialog (Data Transformation).

Set Node Condition button

The Set Node Condition dialog opens. Click this button to specify a condition for the source node and allow mapping to take place only when that condition is satisfied.

For details about the Set Node Condition dialog, see 1.6.11 Set Node Condition Dialog. For details about how to set up the conditions for transformation source nodes, see the description of node condition settings in the manual Service Platform Basic Development Guide.

Select Function button

The Select Function dialog opens. Click this button to specify in Input a function from which a substring is to be extracted.

For details about the Select Function dialog, see 1.6.9 Select function dialog.

Acquisition method

Specify range from left side radio button

Select this button to specify the extraction range from the start of the string.

Start position

Specify the start position of the substring to be extracted.

Count

Specify the character count of the substring to be extracted, in the range between 0 and 2,147,483,647.

Acquire from start position to end of string check box

Select this check box to extract the substring that begins at the start character specified in Start position to the end of the string.

Specify range from end radio button

Select this button to specify the extraction range from the end of the string.

Start position

Specify the start position of the substring to be extracted.

Count

Specify the character count of the substring to be extracted, in the range between 0 and 2,147,483,647.

Acquire from start position to beginning of string check box

Select this check box to extract the substring that begins at the start character specified in Start position to the beginning of the string.

Specify division string radio button

Select this button to divide a string into two segments and specify either the initial or subsequent segment.

Division string

Specify a string to use for dividing the string in the mapping source. A maximum of 1,024 characters can be specified.

Acquired Part

Select either Pre or Post.

Pre

Acquires the substring that begins at the beginning character and ends at the character preceding the string specified in Division string.

Post

Acquires a string succeeding the string specified in Division string.

OK button

Commits the specified contents and closes the dialog.

Cancel button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

In the Acquire Substring dialog, you can set up the acquire substring function. For details about how to set up the acquire substring function, see the description for processing values using functions in the manual Service Platform Basic Development Guide.

1.6.21 Acquire String Length Dialog

In the Acquire String Length dialog, specify the string whose length is to be acquired.

This dialog opens when you perform one of the following operations:

Right-click the acquire string length function, and choose Setting

Double-click the acquire string length function

The following figure shows the Acquire String Length dialog.

Figure 1‒122: Acquire String Length dialog

(1) Displayed items

Function name

Displays the function name. If you want to change the name, specify 64 or less characters. You can use NCName definition characters of XML schema.

Input

Specify the source node or function whose string length is to be acquired. If a string length acquisition target is already mapped to the acquire string length function, that string length acquisition target is displayed.

For details about the display format in Input, see 6.4.6 Mapping Source Display Format in the Service Platform Basic Development Guide.

Select Node button

The Node Selection dialog opens. Click this button to specify in Input a source node for the string whose string length is to be acquired.

For details about the Select Node dialog, see 1.6.8 Select Node Dialog (Data Transformation).

Set Node Condition button

The Set Node Condition dialog opens. Click this button to specify a condition for the source node and allow mapping to take place only when that condition is satisfied.

For details about the Set Node Condition dialog, see 1.6.11 Set Node Condition Dialog. For details about how to set up the conditions for transformation source nodes, see the description of node condition settings in the manual Service Platform Basic Development Guide.

Select Function button

The Select Function dialog opens. Click this button to specify in Input a function for the string whose string length is to be acquired.

For details about the Select Function dialog, see 1.6.9 Select function dialog.

OK button

Commits the specified contents and closes the dialog.

Cancel button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

In the Acquire String Length dialog, you can set up the acquire string length function. For details about how to set up the acquire string length function, see the description for processing value using functions in the manual Service Platform Basic Development Guide.

1.6.22 Check string dialog

In the Check String dialog, you check whether a string contains a specified string or begins with a specified string, and you specify the string to be checked.

This dialog is displayed when you perform one of the following operations:

Right-click the check string function, and select Settings

Double-click the check string function

The following figure shows the [Check string] dialog:

Figure 1‒123:  [Check string] dialog

(1) Displayed items

[Function name]

Displays the function name. If you want to change to any name, specify within 64 characters. You can use NCName definition characters of XML schema.

[Input]

Specify the transformation source node and function of string to be checked. If the check target and check string function are already mapped, that particular search target is displayed.

For the details about the display format in [Input] see "6.4. Mapping Source Display Format" in "Service Platform Basic Development Guide".

[Select Node] button

Displays the [Select node] dialog. Click when you want to specify in [Input], the transformation source node of string to be checked.

For details about [Select Node] dialog, see "1.6.8 Select Node Dialog (Data Transformation)".

[Set node condition] button

Displays the [Set Node Condition] dialog. Click this button to specify a condition for the source node and allow mapping to take place only when that condition is satisfied.

For details about [Set Node Condition] dialog, see "1.6.11 Set Node Condition Dialog". For details about how to set conditions for transformation source node see "6.7 Specifying Node Conditions" in "Service Platform Basic Development Guide".

[Select function] button

Displays the [Select Function] dialog. Click this button to specify in [Input[, the function of the string to be checked.

For details about the [Select Function] dialog, see "1.6.9 Select function dialog".

[Check type]

Shows the check type for the string specified in String. One of the following check types is displayed:

Include specified string

Start with specified string

[Check string]

Specify the string to be checked. A maximum of 1,024 characters can be specified.

[OK] button

Enables the specified contents and closes the dialog.

[Cancel] button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

You can set up the check string function in [Check string] dialog. For details about how to set up the check string function, see "6.5 Processing value or node in which function is used" in "Service Platform Basic Development Guide".

1.6.23 Trim Node dialog

In the Trim Node dialog, specify the string from which spaces are to be removed.

This dialog opens when you perform one of the following operations:

Right-click the trim node function, and choose Setting

Double-click the trim node function

The following figure shows the [Trim Node] dialog:

Figure 1‒124:  [Trim Node] dialog

(1) Displayed items

[Function name]

Displays the function name. If you want to change to any name, specify within 64 characters. You can use NCName definition characters of XML schema.

[Input]

Specify the transformation source node or function of the string from which spaces are to be removed. If the node-trimming target is already mapped to the trim node function, that node-trimming target is displayed

For details about the display format in [Input], see "6.4.6 Mapping Source Display Format" in "Service Platform Basic Development Guide".

[Select Node] button

Displays the [Select Node] dialog. Click this button to specify in [Input] the transformation source node of the node-trimming target string.

For details about [Select Node] dialog, see "1.6.8 Select Node Dialog (Data Transformation)".

[Set Node Condition] button

The Set Node Condition dialog opens. Click this button to specify a condition for the source node and allow mapping to take place only when that condition is satisfied.

For details about [Set Node Condition] dialog, see "1.6.11 Set Node Condition Dialog". For details about how to set up conditions for transformation source nodes, see "6.7 Specifying Node Conditions" in "Service Platform Basic Development Guide".

[Select function] button

Displays the Select function dialog. Click this button to specify in [Input] the function of the node-trimming target string.

For details about [Select Function] dialog, see "1.6.9 Select function dialog".

[OK] button

Commits the specified contents and closes the dialog.

[Cancel] button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

In the Trim Node dialog, you can set up the trim node function. For details about how to set up the trim node function, see "6.5 Processing value or node in which function is used" in "Service Platform Basic Development Guide".

1.6.24 Convert number format dialog

Specify pattern string of the java.text.DecimalFormat class after conversion, in the [Covert numeric value format] dialog.

This dialog opens when you perform one of the following operations:

Right-click the convert number format function, and choose Setting

Double-click the convert number format function

The following figure shows the [Convert number format] dialog:

Figure 1‒125:  [Convert number format] dialog

(1) Displayed items

[Function name]

Displays the function name. If you want to change to any name, specify within 64 characters. You can use NCName definition characters of XML schema.

[Input]

Specify the transformation source node and function of the number whose format is to be converted. If the conversion target is already mapped to the convert number format function, that conversion target is displayed.

For details about the display format in [Input], see "6.4.6 Mapping Source Display Format" in "Service Platform Basic Development Guide".

[Select Node] button

The Node Selection dialog opens. Click this button to specify in Input the source node of the conversion target number.

For details about the [Select Node] dialog, see "1.6.8 Select Node Dialog (Data Transformation)".

[Set Node Condition] button

The Set Node Condition dialog opens. Click this button to specify a condition for the source node and allow mapping to take place only when that condition is satisfied.

For details about the [Set Node Condition] dialog, see "1.6.11 Set Node Condition Dialog". For details about how to set up conditions for transformation source node, see "6.7 Specifying Node Conditions" in "Service Platform Basic Development Guide".

[Select Function] button

Displays the [Select Function] dialog. Click this button to specify in [Input] the function of the conversion target number.

For details about the [Select Function] dialog, see "1.6.9 Select function dialog".

[Pattern]

Specify the pattern string in the java.text.DecimalFormat class format to be applied following conversion. A maximum of 1,024 characters can be specified.

If Change Symbols is specified, describe the pattern using the symbols following the conversion.

[Change Symbols]

[Change symbol] checkbox

Select this check box to change the decimal separator or grouping separator from the default.

[Decimal separator]

To change the decimal separator, specify the symbol for the decimal separator to be applied following the change.

[Group separator]

To change the grouping separator, specify the symbol for the grouping separator to be applied following the change.

[OK] button

Commits the specified contents and closes the dialog.

[Cancel] button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

In the Convert Number Format dialog, you can set up the convert number format function. For details about how to set up the convert number format function, see " 6.5 Processing value or node in which function is used" in "Service Platform Basic Development Guide".

1.6.25 Perform Node Operation Dialog

In the [Perform Node Operation] dialog, specify two numbers and the type of operation to be performed using them.

This dialog opens when you perform one of the following operations:

Right-click the perform node operation function, and choose Setting

Double-click the perform node operation function

The following figure shows the Perform Node Operation dialog:

Figure 1‒126:  [Perform Node Operation] dialog

(1) Displayed items

[Function name]

Displays the function name. If you want to change to any name, specify within 64 characters. You can use NCName definition characters of XML schema.

[Input 1]

Specify the source node or function of the first operation-target number. If the operation target is already mapped to the perform node operation function, that operation target is displayed.

For details about the display format in [Input 1], see "6.4.6 Mapping Source Display Format" in "Service Platform Basic Development Guide".

[Select Node] button

Displays the [Select Node] dialog. Click this button to specify in Input 1 the source node of the operation target number.

For details about the [Select Node] dialog, see, "1.6.8 Select Node Dialog (Data Transformation)".

[Set Node Condition] button

Displays the [Set Node Condition] dialog. Click this button to specify a condition for the source node and allow mapping to take place only when that condition is satisfied.

For details about the [Set Node Condition] dialog, see "1.6.11 Set Node Condition Dialog". For details about how to set node condition, see "6.7 Specifying Node Conditions" in "Service Platform Basic Development Guide".

[Select function] button

Displays the [Select function] dialog. Click this button to specify the function of the operation target number in Input 1.

For details about the [Select function] dialog, see "1.6.9 Select function dialog".

[Operation] dropdown list

Shows the operation that can be executed. One of the following operations is displayed.

+ (addition)

- (subtraction)

* (multiplication)

/ (division)

% (remainder)

[Input 2]

Specify the source node or function of the second operation-target number. The display format is the same as that of Input 1.

[Select Node] button

Displays the [Select Node] dialog. Click this button to specify the source node of the operation target number in Input 2.

For details about the [Select Node] dialog, see, "1.6.8 Select Node Dialog (Data Transformation)".

[Set Node Condition] button

Displays the [Set Node Condition] dialog. Click this button to specify a condition for the source node and allow mapping to take place only when that condition is satisfied.

For details about the [Set Node Condition] dialog, see "1.6.11 Set Node Condition Dialog". For details about how to set node condition, see "6.7 Specifying Node Conditions" in "Service Platform Basic Development Guide".

[Select function] button

Displays the [Select function] dialog. Click this button to specify the function of the operation target number in Input 2.

For details about the [Select function] dialog, see "1.6.9 Select function dialog".

[OK] button

Enables the specified and closes the dialog.

[Cancel] button

Closes the dialog without enabling the specified contents.

(2) Operations that can be performed in this dialog

With the [Perform Node Operation] dialog, you can set the perform node operation function. For details on how to set the perform node operation see "6.5 Processing value or node in which function is used" in "Service Platform Basic Development Guide".

1.6.26 Round Node Dialog

In the Round Node dialog, specify a number to be rounded.

This dialog opens when you perform one of the following operations:

Right-click the round node function, and choose Setting

Double-click the round node function

The following figure shows the Round Node dialog:

Figure 1‒127:  [Round node] dialog

(1) Displayed items

[Function name]

Displays the function name. If you want to change to any name, specify within 64 characters. You can use NCName definition characters of XML schema.

[Input]

Specify the source node or function of the number to be rounded. If the rounding target is already mapped to the round node function, that number is displayed.

For details about the display format in [Input], see "6.4.6 Mapping Source Display Format" in "Service Platform Basic Development Guide".

[Select Node] button

Displays the [Select Node] dialog. Click this button to specify the source node of the rounding-target number in Input.

For details about the [Select Node] dialog, see "1.6.8 Select Node Dialog (Data Transformation)".

[Set Node Condition] button

Displays the [Set Node Condition] dialog. Click this button to specify a condition for the source node and allow mapping to take place only when that condition is satisfied.

For details about the [Set Node Condition] dialog, see "1.6.11 Set Node Condition Dialog". For details about to set condition in source node, see "6.7 Specifying Node Conditions" in "Service Platform Basic Development Guide".

[Select function] button

Displays the [Select function] dialog. Click this button to specify the function of the rounding-target number in [Input].

For details about the [Select function] dialog, see "1.6.9 Select function dialog".

[Rounding type]

Select the rounding operation to be executed. Three types of rounding operations are displayed:

round off

round down

round up

[OK] button

Commits the specified contents and closes the dialog.

[Cancel] button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

In the Round Node dialog, you can set up the round node function. For details about how to set the rounding node function, see "6.5 Processing value or node in which function is used" in "Service Platform Basic Development Guide".

1.6.27 Sum Up Nodes Dialog

In the Sum Up Nodes dialog, specify the node set that contains the nodes to be summed up.

This dialog opens when you perform one of the following operations:

Right click the Sum up nodes function and choose [Setting]

Double click the round nodes function

The following figure shows the sum up nodes dialog:

Figure 1‒128:  Sum up nodes dialog

(1) Displayed items

[Function name]

Displays the function name. If you want to change to any name, specify within 64 characters. You can use NCName definition characters of XML schema.

[Input]

Specify a node that contains the nodes that you want to sum up. If a node set is already mapped to sum up nodes function, the same is displayed.

For details about display format in [Input], see "6.4.6 Mapping Source Display Format" in "Service Platform Basic Development Guide".

[Add node] button

Displays the [Select Node] dialog. Click this button when you want to add the node that contains the nodes for sum up.

For details about the [Select Node] dialog, see "1.6.8 Select Node Dialog (Data Transformation)".

[Set Node Condition] button

Displays the [Set Node Condition] dialog. Click this button to specify a condition for the source node and allow mapping to take place only when that condition is satisfied.

For details about the [Set Node Condition] dialog, see "1.6.11 Set Node Condition Dialog". For details about to set condition in source node, see "6.7 Specifying Node Conditions" in "Service Platform Basic Development Guide".

[Remove] button

Removes the node set which was specified in [Input] from [Input].

[OK] button

Enables the specified contents and closes the dialog.

[Cancel] button

Closes the dialog without enabling the specified contents.

(2) Operations that can be performed in this dialog

You can set the sum up nodes function in the [Sum up nodes] dialog. For details about how to set the sum up nodes function see "6.5 Processing value or node in which function is used" in "Service Platform Basic Development Guide".

1.6.28 NOT Operation dialog

In the [NOT operation] dialog, specify the node you want to select for NOT operation.

This dialog is displayed when you perform one of the following operations:

Right click the NOT operation function and select [Setting]

Double click the NOT operation function

The following figure shows the [NOT operation] dialog:

Figure 1‒129:  [NOT operation] dialog

(1) Displayed items

[Function name]

Displays the function name. If you want to change to any name, specify within 64 characters. You can use NCName definition characters of XML schema.

[Input]

Specify the node for as NOT operation target. If a node is already mapped to NOT operation, that node is will be displayed.

For details about the display format in [Input], see "6.4.6 Mapping Source Display Format" in "Service Platform Basic Development Guide".

[Select Node] button

Displays the [Select Node] dialog. Click when you want to specify a node for NOT operation.

For details about the [Select Node] dialog, see "1.6.8 Select Node Dialog (Data Transformation)".

[Set Node Condition] button

Displays the [Set Node Condition] dialog. Click this button to specify a condition for the node and allow only mapping to take place only when that condition is satisfied.

For details about [Set Node Condition] dialog, see "1.6.11 Set Node Condition Dialog". For details about how to set conditions for nodes, see "6.7 Specifying Node Conditions" in "Service Platform Basic Development Guide".

[Select function] button

Displays the [Select function] dialog. Click this button when you want to specify a function for NOT operation in [Input].

For details about [Select function] dialog, see "1.6.9 Select function dialog".

[OK] button

Enables the specified contents and closes the dialog.

[Cancel] button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

You can set the NOT operation function with the [NOT operation] dialog. For details about how to set the NOT operation function, see "6.5 Processing value or node in which function is used" in "Service Platform Basic Development Guide".

1.6.29 Logical operation dialog

Specify a transformation source node or function that will be target for logical operation in the [Logical operation] dialog.

This dialog is displayed when you perform one of the following operations:

Right click the logical operation function and select [Settings]

Double click the logical operation function

The following figure shows the logical operation dialog:

Figure 1‒130:  [Logical operation] dialog

(1) Displayed items

[Function name]

Displays the function name. If you want to change to any name, specify within 64 characters. You can use NCName definition characters of XML schema.

[Input 1]

Specify a node that contains the node you want to target for logical operation. If a node is already mapped to logical operation, that node is displayed.

For details about the display format in [Input 1], see "6.4.6 Mapping Source Display Format" in "Service Platform Basic Development Guide".

[Select Node] button

Displays the [Select Node] dialog. Click this button when you want to specify a node in [Input 1] for logical operation.

For details about the [Select Node] dialog , see "1.6.8 Select Node Dialog (Data Transformation)".

[Set Node Condition] button

Displays the [Set Node Condition] dialog. Click this button to specify a condition for the node and allow only mapping to take place only when that condition is satisfied.

For details about the [Set Node Condition] dialog, see "1.6.11 Set Node Condition Dialog". For details about how to set node condition, see "6.7 Specifying Node Conditions" in "Service Platform Basic Development Guide".

[Select function] button

Displays the [Select function] dialog. Click this button when you want to specify a function for Logical operation in [Input 1].

For details about the [Select function] dialog, see "1.6.9 Select function dialog".

[Operation] drop down list

Displays the operator to be specified in condition format. The displayed operators are as follows:

AND (Logical conjunction)

OR (Logical disjunction)

XOR (Exclusive disjunction)

[Input 2]

Specify a node that contains the node you want for logical operation. If a node is already mapped to logical operation, that node is displayed.

For details about the display format in [Input 2], see "6.4.6 Mapping Source Display Format" in "Service Platform Basic Development Guide".

[Select Node] button

Displays the [Select Node] dialog. Click this button when you add the node set that contains the nodes that you want to sum up in [Input 2].

For details about the [Select Node] dialog, see "1.6.8 Select Node Dialog (Data Transformation)".

[Set Node Condition] button

Displays the [Set Node Condition] dialog. Click this button to specify a condition for the node and allow only mapping to take place only when that condition is satisfied.

For details about the [Set Node Condition] dialog, see "1.6.11 Set Node Condition Dialog". For details about how to set node conditions, see "6.7 Specifying Node Conditions" in "Service Platform Basic Development Guide".

[Select function] button

Displays the [Select function] dialog. Click this button when you want to specify a function for Logical operation in [Input 1].

For details about the [Select function] dialog, see "1.6.9 Select function dialog".

[OK] button

Commits the specified contents and closes the dialog.

[Cancel] button

Does not commit the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

You can set the logical operation function with the [Logical operation] dialog. For details about how to set logical function, see "6.5 Processing value or node in which function is used" in "Service Platform Basic Development Guide".

1.6.30 Shift operation dialog

Specify the transformation source node or function for shift operation in the [Shift operation] dialog.

This dialog is displayed when you perform one of the following operations:

Right click the Shift operation function and select [Setting]

Double click the Shift operation function

The following figure shows the [Shift operation] dialog:

Figure 1‒131:  [Shift operation] dialog

(1) Displayed items

[Function name]

Displays the function name. If you want to change to any name, specify within 64 characters. You can use NCName definition characters of XML schema.

[Input]

Specify a node that contains the node you want for shift operation. If a node is already mapped to logical operation, that node is displayed.

For details about the display format in [Input], see "6.4.6 Mapping Source Display Format" in "Service Platform Basic Development Guide".

[Select Node] button

Displays the [Select Node] dialog. Click this button when you want to specify the node for shift operation in [Input].

For details about the [Select Node] dialog, see "1.6.8 Select Node Dialog (Data Transformation)".

[Set Node Condition] button

Displays the [Set Node Condition] dialog. Click this button to specify a condition for the node and allow only mapping to take place only when that condition is satisfied

For details about the [Set Node Condition] dialog, see "1.6.11 Set Node Condition Dialog". For details about how to set node condition, see "6.7 Specifying Node Conditions" in "Service Platform Basic Development Guide".

[Select function] button

Displays the [Select function] dialog. Click this button when you want to specify a function for Logical operation in [Input].

For details about the [Select function] dialog, see "1.6.9 Select function dialog".

[Details]

Specify the detailed items for shift operation function.

[Shift volume]

Specify the number of bits to be shifted. You can specify the number of bits in a range of 0 to 64.

[Output size]

Specify the range to be outputted. The amount of size specified is acquired from the lower bit. You can specify the number of bits from 1 to 64.

[Shift direction]

Specify the direction for shifting, with [Right] or [Left] radio button.

[Shift type]

If the shift direction is [Right], specify the method to shift from one of the following:

[Arithmetic shift] radio button

The higher bit (code bit) is not shifted and is retained.

[Logical shift] radio button

Higher bit (code bit) is shifted. To the bits that become vacant by shift, "0" is complemented to them.

In case of left shift, since the resulting values of arithmetic shift and logical shift are same, there is no need to set shift type.

The specifications for every shift operation are as follows:

Shift classification

Left shift

Right shift

Arithmetic shift

Logical shift

Shifting code bit

Shifts

Does not shift

Shift

Empty bits smaller than output size

Fills with "0"

Fills with code bit

Fills with "0"

Empty bits during shifts

Fills with "0"

Fills with code bit

Fills with "0"

[OK] button

Commits the specified contents and closes the dialog.

[Cancel] button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

You can set the shift operation function with the [Shift operation] dialog. For details about how to set the shift operation function, see "6.5 Processing value or node in which function is used" in "Service Platform Basic Development Guide".

1.6.31 Acquire Node Name Dialog

In the [Acquire Node Name] dialog, specify the source node whose node name is to be acquired.This dialog opens when you perform one of the following operations:

Right-click the acquire node name function, and choose Setting

Double-click the acquire node name function

The following figure shows the [Acquire Node Name] dialog:

Figure 1‒132:  [Acquire Node Name] dialog

(1) Displayed items

[Function name]

Displays the function name. If you want to change to any name, specify within 64 characters. You can use NCName definition characters of XML schema.

[Input]

Specify the source node whose node name is to be acquired. If the source node whose node name is to be acquired is already mapped to the acquire node name function, that source node is displayed.

For details about the display format in [Input], see "6.4.6 Mapping Source Display Format" in "Service Platform Basic Development Guide".

[Select Node] button

The [Select Node] dialog opens. Click this button to specify in [Input] the source node whose node name is to be acquired.

For more details about the [Select Node] dialog, see "1.6.8 Select Node Dialog (Data Transformation)".

[Set Node Condition] button

Displays the [Set Node Condition] dialog. Click this button to specify a condition for the node and allow only mapping to take place only when that condition is satisfied.

For details about the [Set Node Condition] dialog, see "1.6.11 Set Node Condition Dialog". For details about how to set node condition, see "6.7 Specifying Node Conditions" in "Service Platform Basic Development Guide".

[OK] button

Commits the specified contents and closes the dialog.

[Cancel] button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

In the Acquire Node Name dialog, you can set up the acquire node name function. For details about how to set up the acquire node name function, see "6.5 Processing value or node in which function is used" in "Service Platform Basic Development Guide".

1.6.32 Acquire Node Count Dialog

In the [Acquire Node Count] dialog, specify the node set whose node count is to be acquired.

This dialog opens when you perform one of the following operations:

Right-click the acquire node count function, and select [Setting]

Double-click the acquire node count function

The following figure shows the [Acquire Node Count] dialog:

Figure 1‒133:  [Acquire Node Count] dialog

(1) Displayed items

[Function name]

Displays the function name. If you want to change to any name, specify within 64 characters. You can use NCName definition characters of XML schema.

[Input]

Specify the node set whose node count is to be acquired. If a node set is already mapped to the acquire node count function, that node set is displayed.

For details about the display format in [Input], see "6.4.6 Mapping Source Display Format" in "Service Platform Basic Development Guide".

[Select Node] button

Displays the [Select Node] dialog. Click this button to specify in [Input] the node set whose node count is to be acquired.

For details about the [Select Node] dialog, see "1.6.8 Select Node Dialog (Data Transformation)".

[Set Node Condition] button

Displays the [Set Node Condition] dialog. Click this button to specify a condition for the node and allow only mapping to take place only when that condition is satisfied.

For details about the [Set Node Condition] dialog, "1.6.11 Set Node Condition Dialog". For details about how to set up conditions for transformation source nodes, see "6.7 Specifying Node Conditions" in "Service Platform Basic Development Guide".

[OK] button

Commits the specified contents and closes the dialog.

[Cancel] button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

You can set up the acquire node count function with the [Acquire Node Count] dialog. For details about how to set up the acquire node count function, see "6.5 Processing value or node in which function is used" in "Service Platform Basic Development Guide".

1.6.33 Check Node dialog

Specify a mapping-source transformation source node that is to be checked to determine whether it contains a node in the [Check Node] dialog.

This dialog opens when you perform one of the following operations:

Right-click the check node function, and choose Setting

Double-click the check node function

The following figure shows the Check Node dialog:

Figure 1‒134:  [Check Node] dialog

(1) Displayed items

[Function name]

Displays the function name. If you want to change to any name, specify within 64 characters. You can use NCName definition characters of XML schema.

[Input]

Specify the source node that is to be checked to determine whether it contains a node. If the check-target source node is already mapped to the check node function, that source node is displayed.

For details about the display format in [Input], see "6.4.6 Mapping Source Display Format" in "Service Platform Basic Development Guide".

[Select Node] button

Displays the [Select Node] dialog. Click this button to specify in [Input] the source node that is to be checked to determine whether it contains a node.

For details about the [Select Node] dialog, see "1.6.8 Select Node Dialog (Data Transformation)".

[Set Node Condition] button

Displays the [Set Node Condition] dialog. Click this button to specify a condition for the node and allow only mapping to take place only when that condition is satisfied.

For details about the [Set Node Condition] dialog see "1.6.11 Set Node Condition Dialog". For details about how to set up conditions for transformation source nodes, see "6.7 Specifying Node Conditions" in "Service Platform Basic Development Guide".

[OK] button

Commits the specified contents and closes the dialog.

[Cancel] button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

In the [Check Node] dialog, you can set up the check node function. For details about how to set up the check node function, see "6.5 Processing value or node in which function is used" in "Service Platform Basic Development Guide".

1.6.34 Loop Node Dialog

In the [Loop Node] dialog, specify a source node to be repeatedly mapped to a target node. Also specify a sort condition for the instances of a source node that appears multiple times.

This dialog opens when you perform one of the following operations:

Right-click the loop node function, and choose Setting

Double-click the loop node function

The following figure shows the [Loop Node] dialog.

Figure 1‒135:  [Loop Node] dialog

(1) Displayed items

[Function name]

Displays the function name. If you want to change to any name, specify within 64 characters. You can use NCName definition characters of XML schema.

[Base path]

Specify a source node that is to be repeatedly mapped to a target node. If a source node that is to be repeatedly mapped is already mapped to the loop node function, that source node is displayed.

For details about the display format in [Base path] see "6.4.6 Mapping Source Display Format" in "Service Platform Basic Development Guide".

[Select Node] button

Displays the [Select Node] dialog. Click this button to specify in [Base path], a source node that is to be repeatedly mapped.

For details about the [Select Node] dialog, see "1.6.8 Select Node Dialog (Data Transformation)".

[Set Node Condition] button

Displays the [Set Node Condition] dialog. Click this button to specify a condition for the node and allow only mapping to take place only when that condition is satisfied.

For details about the [Set Node Condition] dialog, see "1.6.11 Set Node Condition Dialog". For details about how to set up conditions for transformation source node, see "6.7 Specifying Node Conditions" in "Service Platform Basic Development Guide".

[Relational paths]

Displays all the specified linkage paths. Select linkage path when you want to set up or remove conditions.

[Add node] button

Displays the [Select Node] dialog. On selecting an linkage path and clicking the [OK] button, the specified linkage path is added in the lowermost part of [Relational paths].

For details about the [Select Node] dialog, see "1.6.8 Select Node Dialog (Data Transformation)".

[Set Node Condition] button

Displays the [Set Node Condition] dialog. Click this button to specify a condition for the linkage path and allow mapping to take place only when that condition is satisfied

For details about the [Set Node Condition] dialog, see "1.6.11 Set Node Condition Dialog". For details about how to set up conditions for linkage path, see "6.7 Specifying Node Conditions" in "Service Platform Basic Development Guide".

[Remove] button

Removes the path selected in [Relational paths] from [Relational paths].

[Sort conditions]

Shows the contents specified in the [Add/Edit Sort Condition] dialog. You can specify a maximum of eight keys in Sort conditions.

For details about the [ Add/Edit Sort Condition] dialog, see "1.6.35 Add/Edit Sort Condition Dialog".

[Add] button

Displays the [Add/Edit Sort Condition] dialog. Click this button when you want to specify a sort condition by adding keys to [Sort conditions].

For details about the [Add/Edit Sort Conditions] see, "1.6.35 Add/Edit Sort Condition Dialog".

[Edit] button

Displays the [Add/Edit Sort Condition] dialog. Click this button to edit the sort condition of the keys specified in Sort conditions].

For details about the [Add/Edit Sort Conditions] see, "1.6.35 Add/Edit Sort Condition Dialog".

[Up] button

Moves up by one line the position of the key selected in [Sort conditions].

[Down] button

Moves down by one line the position of the key selected in [Sort conditions].

[Remove] button

Deletes the key selected in Sort conditions from [Sort conditions].

[OK] button

Commits the specified contents and closes the dialog.

[Cancel] button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

In the [Loop Node] dialog, you can set up the loop node function. For details about how to set up the loop node function, see "6.5 Processing value or node in which function is used" in "Service Platform Basic Development Guide".

1.6.35 Add/Edit Sort Condition Dialog

In the Add/Edit Sort Condition dialog, specify sort conditions by adding keys to Sort conditions in the Loop Node dialog. You also edit the sort conditions specified for keys.

The Add/Edit Sort Condition dialog opens when you click Add or Edit in the Loop Node dialog.

The following figure shows the Add/Edit Sort Condition dialog.

Figure 1‒136: Add/Edit Sort Condition dialog

(1) Displayed items

Sort key

Specify a source node that becomes the source of the instances that are to be sorted.

Select Node button

The Node Selection dialog opens. Click this button to specify in Sort key a source node that becomes the source of the instances that are to be sorted.

For details about the Select Node dialog, see 1.6.8 Select Node Dialog (Data Transformation).

Order

Choose the order in which to sort the instances. The displayed orders are as follows:

ascending

descending

Language

Choose a language to be used for sorting the instances. The displayed languages are as follows:

ja

en

Automatic

If auto is selected, the language code corresponding to the system locale specified as the default is specified.

Data type

Choose a data type to be used for sorting the instances. The displayed data types are as follows:

Text

Number

Case order

Choose the priority order for sorting the instances when Data type is text. Select when Data Type is Text. The displayed priorities are as follows:

Upper case

Lower case

OK button

Commits the specified contents and closes the dialog.

Cancel button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

In the Add/Edit Sort Condition dialog, you can specify sort conditions for the loop node function. For details about how to set up node conditions for the loop node function, see the description for processing values using functions in the manual Service Platform Basic Development Guide.

1.6.36 Choose Node Dialog

In the [Choose Node] dialog, specify a condition and the source node or function to be output according to the condition.

This dialog opens when you perform one of the following operations:

Right-click the choose node function, and choose Setting

Double-click the choose node function

The following figure shows the [Choose Node] dialog:

Figure 1‒137:  [Choose Node] dialog

(1) Displayed items

[Function name]

Displays the function name. If you want to change to any name, specify within 64 characters. You can use NCName definition characters of XML schema.

[Condition and output value]

[Condition]

Displays the conditions specified in [Add/Edit Condition] dialog. For details about [Add/Edit Condition] dialog, see "1.6.37 Add/Edit Condition Dialog". The specified conditions are evaluated starting from the top.

[Output value]

Specify the source node or function of the value to be output when the condition is satisfied. If the source node or function of an output value is already mapped to the choose node function, that source node or function is displayed.

For details about transformation source nodes or functions displayed in [Output value], see "6.4.6 Mapping Source Display Format" in "Service Platform Basic Development Guide". If you select the [Empty node] radio button in this dialog, Empty node is displayed. If you select the [Do not output the node] radio button, No output is displayed.

[Add] button

Displays the [Add/Edit Condition] dialog. Click this button to add condition and output value to [Condition and output value].

[Edit] button

Displays the [Add/Edit Condition] dialog. Click this button to edit condition or output value in [Condition and output value].

[Up] button

Moves up by one line the position of the condition and output value selected in [Condition and output] value.

[Down] button

Moves down by one line the position of the condition and output value selected in [Condition and output] value.

[Remove] button

Deletes the condition and output value selected in [Condition and output value] from [Condition and output value].

[When no condition matches]

Specify the output to be used when none of the conditions in [Condition and output value] is satisfied.

[Output the node] radio button

Select this button to output the transformation destination node.

[Do not output the node] radio button

Select this button to not output the transformation destination node.

[Output value]

Specify a value when the [Output the node] radio button is selected under [When no condition matches].

[Output the value] radio button

Select when you want to output a value for transformation source node or function.

[Value]

Specify the transformation source node or function of the output value.

For details about the display format of output value, see "6.4.6 Mapping Source Display Format" in "Service Platform Basic Development Guide".

[Select Node] button

Displays the [Select Node] dialog. Click this button when you want to specify the output value of transformation source node in [Value].

For details about the [Select Node] dialog, see "1.6.8 Select Node Dialog (Data Transformation)".

[Set Node Condition] button

Displays the [Set Node Condition] dialog. Click this button to specify a condition for the node and allow only mapping to take place only when that condition is satisfied

For details about [Set Node OCNdition] dialog, see "1.6.11 Set Node Condition Dialog". For details about how to set up conditions for transformation source node, see "6.7 Specifying Node Conditions" in "Service Platform Basic Development Guide".

[Select function] button

Displays the [Select function dialog. Click this button when you want to specify a function for output value in [Value].

For details about the [Select function] dialog, see "1.6.9 Select function dialog".

[Empty node] radio button

Select this button to not output a value at the transformation source node (to output an empty node).

[OK] button

Commits the specified contents and closes the dialog.

[Cancel] button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

You can setup the choose node function with the [Choose Node] dialog. For details about how to set up the choose node function , see "6.5 Processing value or node in which function is used" in "Service Platform Basic Development Guide".

1.6.37 Add/Edit Condition Dialog

In the Add/Edit Condition dialog, add conditions to Condition & output value of the Choose Node dialog. You can also edit conditions or output values in Condition & output value.

The Add/Edit Condition dialog opens when you click Add or Edit in the Choose Node dialog.

The following figure shows the Add/Edit Condition dialog.

Figure 1‒138: Add/Edit Condition dialog

(1) Displayed items

Condition

Shows the condition specified in the Condition Settings dialog. For details about the specification method in the Condition Settings dialog, see 1.6.12 Condition Settings Dialog (Set Node Condition).

When condition is true

Specify the output to be used when the condition specified in Condition is satisfied.

Output the node radio button

Select this button to output the target node.

Do not output the node radio button

Select this button to not output the target node.

Output value

Specify a value when the Output the node radio button is selected under When condition is true.

Output the value radio button

Select this button to output the value of the source node or function.

Value

Specify the source node or function of the output value.

For details about the display format of output values, see the description for display format of the mapping source in the manual Service Platform Basic Development Guide.

Select Node button

The Node Selection dialog opens. Click this button to specify the source node of an output value for Value.

For details about the Select Node dialog, see 1.6.8 Select Node Dialog (Data Transformation).

Set Node Condition button

The Set Node Condition dialog opens. Click this button to specify a condition for the source node and allow mapping to take place only when that condition is satisfied.

For details about the Set Node Condition dialog, see 1.6.11 Set Node Condition Dialog. For details about how to set up conditions for transformation source nodes, see the description for node condition settings in the manual Service Platform Basic Development Guide.

Select Function button

The Select Function dialog opens. Click this button to specify in Value the function of an output value.

For details about the Select Function dialog, see 1.6.9 Select function dialog.

Empty node radio button

Select this button to not output a value at the target node (to output an empty node).

OK button

Commits the specified contents and closes the dialog.

Cancel button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

In the Add/Edit Condition dialog, you can add conditions for the choose node function and edit them. For details about how to add or edit conditions for the choose node function, see the description for processing values using functions in the manual Service Platform Basic Development Guide.

1.6.38 Replace value Dialog

In the Replace value dialog, you specify the conversion table for replacing the values entered from the mapping source and assigning the values in the mapping destination. This dialog also specifies the rows for searching the change-source string and the actions to be taken when the change-source string does not exist in the conversion table.

This dialog opens when you perform one of the following operations:

Right-click the Replace value function and choose Setting

Double-click the Replace value function

The following figure shows the Replace value dialog:

Figure 1‒139:  [Replace value] dialog

(1) Displayed items

[Function name]

Displays the function name. If you want to change to any name, specify within 64 characters. You can use NCName definition characters of XML schema.

[Input]

Specify the conversion-source node and function of the string to be changed. If the change target and Replace value function are already mapped, the change target will be displayed.

For details about the display format in [Input], see "6.4.6 Mapping Source Display Format" in "Service Platform Basic Development Guide".

[Select node] button

Displays the [Select Node] dialog. Click this button when you want to specify in [Input] the transformation source node of the string to be replaced.

For details about the [Select Node] dialog, see "1.6.8 Select Node Dialog (Data Transformation)".

[Set Node Condition] button

Displays the [Set Node Condition] dialog. Click this button to specify a condition for the node and allow only mapping to take place only when that condition is satisfied.

For details about the [Set Node Condition] dialog, see "1.6.11 Set Node Condition Dialog". For details about how to set node conditions, see "6.7 Specifying Node Conditions" in "Service Platform Basic Development Guide".

[Select function] button

Displays the [Select function] dialog. Click this button when you want to specify the function of the string to be changed in [Input].

For details about the [Select function] dialog see "1.6.9 Select function dialog".

[Replace value]

[Conversion table ID]

Specify the conversion table ID of the conversion table to be used for changing the value. The conversion table ID is the name of the conversion table coded in the user property file for the J2EE server (usrconf.properties) after the conversion table is created.

[Path property]

Displays the property (key of usrconf.properties) wherein the storage destination of the conversion table specified in [Conversion table ID] is set. The path property is displayed in the following format:

csc.dt.valueTable.<conversion table ID>

[Code property]

Displays the property (key of usrconf.properties) wherein the character code used in the conversion table specified in the Conversion table ID is set. The path property is displayed in the following format:

csc.dt.encodeType.< conversion table ID>

[Key columns]

[Left column] radio button

Select this button when you want to search for the string to be replaced in the left column of the conversion table and replace it with a string in the right column.

[Right column] radio button

Select this button when you want to search for the string to be replaced in the right column of the conversion table and replace it with a string in the left column.

[Operation if search fails]

[Assign default value] radio button

This radio button to assign a newly specified value to mapping destination , when the search for the string to be replaced fails.

[Value]

Specify the default value to be assigned in the mapping destination, when the search for the string to be replaced fails. Specify this when you select [Assign default value].

[Conversion error] radio button

Select in the case of a conversion error, when the search for the string to be replaced fails.

[OK] button

Commits the specified contents and closes the dialog.

[Cancel] button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

You can set the replace value function with the [Replace value] dialog. For details about how to set up the replace value function, see "6.5 Processing value or node in which function is used" in "Service Platform Basic Development Guide".

1.6.39 Base conversion dialog

Specify the transformation source node or function for base conversion in the [Base conversion] dialog.

This dialog is displayed when you perform one of the following operations:

Right click the base conversion function and select [Setting]

Double click the base conversion dialog

The following figure shows the [Base conversion] dialog:

Figure 1‒140:  [Base conversion] dialog

(1) Displayed items

[Function name]

Displays the function name. If you want to change to any name, specify within 64 characters. You can use NCName definition characters of XML schema.

[Input]

Specify node for base conversion. If the change target and base conversion function are already mapped, the change target will be displayed.

For details about the display format in [Input], see "6.4.6 Mapping Source Display Format" in "Service Platform Basic Development Guide".

[Select node] button

Displays the [Select Node] dialog. Click this button when you want to specify in [Input], the node for base conversion.

For details about the [Select Node] dialog, see "1.6.8 Select Node Dialog (Data Transformation)".

[Set Node Condition] button

Displays the [Set Node Condition] dialog. Click this button to specify a condition for the node and allow only mapping to take place only when that condition is satisfied.

For details about the [Set Node Condition] dialog see "1.6.11 Set Node Condition Dialog". For details about how to set up condition for transformation source node, see "6.7 Specifying Node Conditions" in "Service Platform Basic Development Guide".

[Select function] button

Displays the [Select function] dialog. Click this button when you want to specify in [Input], a function for base conversion.

For details about the [Select function] dialog, see "1.6.9 Select function dialog".

[Input radix] dropdown list

Specify the base of input value. You can specify from the following options. You cannot specify the same value for input base and output base.

16 (hexadecimal)

10 (Decimal)

2 (Binary digit)

[Output radix] dropdown list

Specify the base of output value. You can specify from the following options. You cannot specify the same value for input base and output base.

16 (hexadecimal)

10 (Decimal)

2 (Binary digit)

[OK] button

Commits the specified contents and closes the dialog.

[Cancel] button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

You can set up the base conversion function with the [Base conversion] dialog. For details about how to set up base conversion, see "6.5 Processing value or node in which function is used" in "Service Platform Basic Development Guide".

1.6.40 Custom dialog

In the Custom dialog, set up the Java program (transformation function) to be invoked from the custom function.

This dialog is displayed when you perform one of the following operations:

Right click the custom function and select [Setting]

Double click the custom function

The following figure shows the [Custom] dialog:

Figure 1‒141:  [Custom] dialog

(1) Displayed items

[Function name]

Displays the function name. If you want to change to any name, specify within 64 characters. You can use NCName definition characters of XML schema.

[jar file]

Displays the jar file that contains the method selected in the [Select Transformation Function] dialog.

[Select transformation function] button

Displays the [Select Transformation function] dialog. For details about the [Select Transformation Function] dialog, see "1.6.43 Select Transformation Function dialog".

[Class]

Displays the class containing the method selected in the [Select Transformation Function] dialog.

[Method]

Displays the method that is selected in the Select Transformation Function dialog. Displayed in the format for the method name (argument-1, argument-2, ...) format.

[Return type]

Displays the type of return value for the method of transformation function selected in the [Select Transformation Function] dialog.

[Argument type]

Displays the type of argument for the method of transformation function selected in the [Select Transformation Function] dialog. Does not display if there is no argument.

[Method description]

Displays the comment of the method that is selected in the [Select Transformation Function] dialog.

[Arguments]

[Argument name]

Displays the argument name of the method that is selected in the [Select Transformation Function] dialog.

[Input value]

Select the value to be entered in the argument of method.

[Select node] button

Displays the [Select Node] dialog. For details about the [Select Node] dialog, see "1.6.8 Select Node Dialog (Data Transformation)".

[Set Node Condition] button

Displays the [Set Node Condition] dialog. For details about the [Set Node Condition] dialog, see "1.6.11 Set Node Condition Dialog".

[Select function] button

Displays the [Select function] dialog. For details about the [Select function] dialog, see "1.6.9 Select function dialog".

[increase input value] button

Increases the position of the value selected in [Input value] by 1.

[Decrease input value] button

Decreases the position of the value selected in [Input value] by 1.

[Remove input value] button

Displays the [Remove Input Value] dialog. For details about the [Remove Input Value] dialog, see "1.6.44 Remove Input Value dialog".

[Explanation of argument]

Displays the comment of the argument selected in the [Select Transformation Function] dialog.

[OK] button

Commits the specified contents and closes the dialog.

[Cancel] button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

You can perform the following operations with the [Custom] dialog:

Selecting the method of the transformation function to be invoked from the custom function

Selecting the value entered in the argument of the method of the transformation function to be invoked from the custom function

For details about how to set the custom function, see "6.5 Processing value or node in which function is used" in "Service Platform Basic Development Guide".

1.6.41 Set constant dialog

Specify value to be assigned to the aping destination in the [Set constant] dialog.

This dialog is displayed when you perform one of the following operations:

Right click the Set constant function and select [Setting]

Double click the set constant function

The following figure shows the [Set constant] dialog:

Figure 1‒142:  [Set constant] dialog

(1) Displayed items

[Function name]

Displays the function name. If you want to change to any name, specify within 64 characters. You can use NCName definition characters of XML schema.

[String] radio button

Select if the value to be assigned to mapping destination is a string.

[Number] radio button

Select if the value to be assigned to the mapping destination is a number.

[Value]

Specify the string or numeric to be assigned to the mapping destination. You can specify a string of up to 1,024 characters. If the String radio button is selected, you can specify an empty string by clearing this text box.

[Boolean] radio button

Select if the value to be assigned to the mapping destination is a boolean value.

[Boolean]

[True] radio button

Select if the boolean value to be assigned to the mapping destination is true.

[False] radio button

Select if the boolean value to be assigned to the mapping destination is false.

[Specific node] radio button

Select if the value to be assigned to the mapping destination is a specific node.

[Value]

[Do not output the node] radio button

Select if you do not want to output the node to the mapping destination.

[Empty node] radio button

Select if you do not want to assign a value (empty node) to the node at the mapping destination.

[OK] button

Commits the specified contents and closes the dialog.

[Cancel] button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

You can set the Set constant function in the [Set constant] dialog. For details about how to set the set constant function, see "6.5 Processing value or node in which function is used" in "Service Platform Basic Development Guide".

1.6.42 XPath dialog box

In the XPath dialog box, you can specify an input value to the target node or function by using an XPath expression (XPath function).

This dialog box opens when you perform one of the following operations:

Right-click an XPath function and then select Settings.

Double-click an XPath function.

The following figure shows the XPath dialog box.

Figure 1‒143: XPath dialog box

(1) Displayed items

Function name

Displays the function name. To change the function name, you can specify a name by using 64 or fewer characters. You can use NCName definition characters of XMLSchema.

Expression

Specify the XPath expression. There is no limit on the number of characters that can be entered.

(2) Operations that can be performed in this dialog box

In the XPath dialog box, you can specify XPath functions. For details about how to do this, see 6.5 Using Functions to Process Values in the Service Platform Basic Development Guide.

1.6.43 Select Transformation Function dialog

In the Select Transformation Function dialog, select the method of the Java program (transformation function) to be invoked from the custom function.

The Select Transformation Function dialog appears, when you click the Select Transformation Function button in the Custom dialog.

The following figure shows the Select Transformation Function dialog:

Figure 1‒144: Select Transformation Function dialog

(1) Display items

Transformation function

Displays the method of the jar file specified in the transformation function definition file. Select the transformation function method to be invoked from the custom function.

Explanation of method

Displays the explanation of the method selected in Transformation function.

OK button

Enables the specified contents, and then closes the dialog.

Cancel button

Disables the specified contents, and closes the dialog.

(2) Operations that can be performed in this dialog

You can set up the method of the transformation function to be invoked from the custom function. For details about how to define the custom function, see the contents related to processing of values by using functions in the manual Service Platform Basic Development Guide.

1.6.44 Remove Input Value dialog

Use the Remove Input Value dialog to remove a value entered in the custom function.

When you click the Remove input value button in the Custom dialog, the Remove Input Value dialog appears.

The following figure shows the Remove Input Value dialog:

Figure 1‒145: Remove Input Value dialog

(1) Display items

Input value

The connection order displays the nodes and functions connected to the custom function. Select the checkbox of the input value to be removed.

Argument name

Displays the argument name, if the Input value is entered for an argument.

OK button

Deletes the input value selected in the checkbox of the Input value, and closes the dialog.

Cancel button

Disables the specified contents, and then closes the dialog.

(2) Operations that can be performed in this dialog

You can remove the value entered in the custom function. For details about how to define the custom function, see the contents related to processing of values by using functions in the manual Service Platform Basic Development Guide.

1.6.45 DB adapter mapping settings dialog

In the [DB adapter mapping settings] dialog, by specifying the column definition file defined in the mapping contents, the data acquired by DB adapter can be automatically mapped to a format that will change the acquired column names to element names.

The [DB adapter mapping settings] dialog is displayed when in the DB adapter search results, you right click the parent element (complex content element) of the element to be mapped for the transformation destination, and select, [Special mapping] and [DB adapter].

The following figure shows the [DB adapter mapping settings] dialog:

Figure 1‒146:  [DB adapter mapping settings] dialog

(1) Displayed items

[Mapping destination]

The nodes of transformation source schema are listed in the full path from the root of transformation source schema. Select the node to be mapped from among the list.

[Column definition file]

Specify the column definition file that defines the transformation source column numbers and the transformation destination element names that will be mapped. When you click the [Reference] button, a dialog to specify the column definition file is displayed.

[Finish] button

Completes mapping and closes the dialog.

[Cancel] button

Cancels the specified contents and closes the dialog.

(2) Operations that can be performed in this dialog

By specifying the column definition file, the data acquired by DB adapter is automatically mapped to a format that will change the column names to element names. For details about how to create a column definition file and how to map DB adapter, see "Appendix J Auto mapping of data acquired by DB adapter" in "Service Platform Basic Development Guide".

1.7 Dialog Related to the User-defined Reception

This section explains the dialog related to the user-defined reception.

1.7.1 Delete User Defined Reception Dialog

This is a dialog to delete a user-defined reception.

For details about how to delete a user-defined reception, see 2.13 Deleting a User-Defined Reception in the uCosminexus Service Platform Reception and Adapter Definition Guide.

Figure 1‒147: Delete User Defined Reception dialog

Select the user defined receptions to delete

Displays a list of the user-defined receptions that are defined. Select the checkbox of the user-defined reception you want to delete.

Select All button

All checkboxes in the list of user-defined receptions are checked.

Deselect All button

All checkboxes in the list of user-defined receptions are unchecked.

OK button

Deletes the specified user-defined reception and closes the dialog.

Cancel button

Closes the dialog without deleting the user-defined reception.

1.8 Dialog boxes for operating multiple services

This section describes dialogs for operating multiple services.

1.8.1 Multiple packaging dialog

This dialog is for selecting appropriate services when you package multiple services.

For details about multiple packaging, see the manual, "7.2 Packaging" in "Service Platform Basic Development Guide".

Figure 1‒148:  [Multiple packaging] dialog

When filtering or sorting, sort by prioritizing the selected services check box

Select this checkbox and click the column header portion, when you want to sort the selected services to the top of the service list. The following figure shows an example of sorting in the Name column.

Filter string

Input when you want to filter services with unique keywords. With this you can display only those services that contain appropriate information.

List of services

Lists service names and their information. The user-defined reception (invocation target selected) is displayed at the same level as business processes and service adapters. You can also sort rows with the column information by clicking the column header.

From the list of services, select the check boxes for the services you want to package in the Name column. You cannot select services that have error displayed in [Message] column.

Selection of service names can be changed according to the following rules:

When you change the selection status of a business process that has user-defined reception

The selection status of all user-defined reception that belongs to the business process whose selection status is to be changed, also changes to the same status.

When you change the selection status of user-defined reception

Business process that invokes the user-defined reception, status of which is to be replaced as well as all user-defined reception depending on invoking source business process change to the same check status.

When you change the selection status of the unselected services when multiple services are selected

Services selected other than the service for which check box is clicked, change to the same check status.

If the unselected services include 1. or 2., operation will be as per 1. or 2.

You can also change the selection status collectively with the following buttons:

[Select all the displayed services]

Selects all the services in filtering result.

[Delete all the displayed services] button

Deletes the selection status of the filtered services.

[OK] button

Packages the selected services and closes the dialog.

[Cancel] button

Closes the dialog without packaging.

1.8.2 Add multiple services dialog

Use this dialog to select services when you want to add multiple services.

For details about how to add multiple services, see 7.3.2 Adding HCSC Components to a Cluster in the Service Platform Basic Development Guide.

Figure 1‒149:  [Add multiple services] dialog

When filtering or sorting, sort by prioritizing the selected services check box

If you want to sort the selected services to the top of the service list, select this check box and then click the column header. The following figure shows an example of sorting in the Name column.

Filter string

Input when you want to filter services with unique keywords. With this you can display only those services that contain appropriate information.

List of services

Lists service names and their information. The user-defined reception (invocation target selected) is displayed at the same level as business processes and service adapters. You can also sort rows with the column information by clicking the column header.

From the list of services, select the check boxes for the services you want to add in the Name column. You cannot select services that have error displayed in [Message] column.

You can change the selection status as follows:

If you change the selection status of business process with a user-defined reception

The selection status of all user-defined reception that belongs to the business process whose selection status is to be changed, also changes to the same status.

If you change the selection status of user-defined reception

Business process that invokes the user-defined reception, status of which is to be replaced as well as all user-defined reception depending on invoking source business process change to the same check status.

If you change the selection status of the unselected services when multiple services are selected

Services selected other than the service for which check box is clicked, change to the same check status.

If the unselected services include 1. or 2., operation will be as per 1. or 2.

You can also change the selection status collectively with the following buttons:

[Select all the displayed services] button

Selects all the filtered services.

[Delete all the displayed services] button

Deletes the selection status of the filtered services.

[OK] button

Adds the services and closes the dialog.

[Cancel] button

Closes the dialog without adding services.

1.8.3 Delete multiple services dialog

Use this dialog to select services, when you want to delete multiple services.

For details about how to delete multiple services, see 7.3.3 Deleting HCSC Components from a Cluster in the Service Platform Basic Development Guide.

Figure 1‒150:  [Delete multiple services] dialog

When filtering or sorting, sort by prioritizing the selected services check box

Select this checkbox when you want the selected services to be sorted to the top of the list. The following figure shows an example of sorting in the Name column.

Filter string

Input when you want to filter services with unique keywords. With this you can display only those services that contain appropriate information.

List of services

Lists service names and their information. The user-defined reception (invocation target selected) is displayed at the same level as business processes and service adapters. You can also sort rows with the column information by clicking the column header.

From the list of services, select the check boxes for the services you want to delete in the Name column. You cannot select services that have error displayed in [Message] column.

You can change the selection status as follows:

If you change the selection status of business process with a user-defined reception

The selection status of all user-defined reception that belongs to the business process whose selection status is to be changed, also changes to the same status.

If you change the selection status of user-defined reception

Business process that invokes the user-defined reception, status of which is to be replaced as well as all user-defined reception depending on invoking source business process change to the same check status.

If you change the selection status of the unselected services when multiple services are selected

Services selected other than the service for which check box is clicked, change to the same check status.

If the unselected services include 1. or 2., operation will be as per 1. or 2.

You can also change the selection status collectively with the following buttons:

[Select all the displayed services] button

Selects all the filtered services.

[Delete all the displayed services] button

Deletes the selection status of the filtered services.

[OK] button

Deletes the services and closes the dialog.

[Cancel] button

Closes the dialog without deleting services.

1.9 WSDL custom binding file related dialog

This sub-section describes WSDL custom binding file related dialog.

1.9.1 Setting dialog (Setting up WSDL custom binding file)

Use this dialog is to set up WSDL custom binding file. You can also use this dialog box to create a SOAP adapter or user-defined reception (SOAP reception) in SOAP1.1/1.2 combined mode.

For details about WSDL custom binding file that uses an external binding file, see "Appendix K Customizing WSDL using the external binding file" in "Service Platform Basic Development Guide".

The steps to display the [Setting] dialog when setting up WSDL custom binding file are as follows:

From the Eclipse menu, select [Window] - [Setting]

This displays the [Setting] dialog.

From left side of the dialog, select [HCSC-Definer] and [WSDL custom binding].

This displays the setting items for WSDL custom binding on the right side.

The following describes the setting items for WSDL custom binding.

Figure 1‒151:  [Setting] dialog (Setting items for WSDL custom binding)

The displayed items are as follows:

[External binding file]

Displays the absolute path of the external binding file. If you do not specify an external binding file from the [Reference] button, nothing is displayed.

[Reference] button

Displays the folder selection screen and you can then specify an external binding file.

Specify the following file used in version prior to 09-00, if an external binding file is used in version prior to 09-00 and you upgrade the version to 09-50 or higher version through update installation.

<Service platform installation directory>\CSCTE\config\tools\custom\custombinding.xml

[Remove] button

Clears the path displayed in [External binding file].

[Restore Defaults] button

Returns WSDL custom binding to default settings. Default value is as follows:

[External binding file]: Blank

[Apply] button

Commits the specified contents. Does not close the dialog.

[Apply and Close] button

Commits the specified contents and closes the dialog.

[Cancel] button

Cancels the specified contents and closes the dialog.

1.10 Dialog boxes related to validation and packaging

1.10.1 Preferences dialog box (validation and packaging operation settings)

You can change some items of validation and packaging operations. To open the Preferences dialog box:

Method

From the Eclipse menu, select Window, and then Preferences.

The Preferences dialog box opens.

In the left pane, select HCSC-Definer, and then Validation/Packaging.

The window for setting up validation and packaging operations appears in the right pane.

The following explains the setting of each item.

(1) Settings related to Java source build

You can change the following settings related to the Java class. To apply changes in the settings, click the Apply button or Apply and Close button in the Preferences dialog box.

Always perform a build at validation or packaging of a business process

The build results of the Java class are updated when validation and packaging are performed. The recommended setting is to have the Always perform a build at validation or packaging of a business process check box selected. If you want to set operation for 09-70 or earlier, clear this check box (not recommended).

When build errors occur for Java source files in the src directory, output the errors as validation messages

Errors in a Java class are output when validation and packaging are performed. The recommended setting is to have the When build errors occur for Java source files in the src directory, output the errors as validation messages check box selected. If you want to set operation for 09-70 or earlier, clear this check box (not recommended).

The following describes the operations when the check box is selected and when it is cleared:

Operation item

Check box selected

Check box cleared

Condition to perform error detection

The validation target business process contains an invoke Java activity.

The validation target business process contains an invoke Java activity.

Scope of error detection

All Java classes under the src directory

Only the Java class specified for Java-class-name of the invoke Java activity

(2) Setting related to the invoke Java activity

You can enhance the validation level of the validation items related to the invoke Java activity. To apply changes in the settings, click the Apply button or Apply and Close button in the Preferences dialog box.

Advanced validation items for Java classes

The recommended setting is Error. If you want to set operation for 09-70 or earlier, specify Warning (not recommended). The following table describes the items to be checked during validation:

No.

Validation details

1

Check whether the class specified for Java class name of the invoke Java activity exists in the classes directory of the HCSCTE project.

2

Check whether the class specified for Java class name of the invoke Java activity exists in each of the following locations (only one class can exist in each location):

classes directory of the HCSCTE project

JAR file within a library of the HCSCTE project

3

Check whether the class specified for Java class name of the invoke Java activity has implemented the dedicated interface (jp.co.Hitachi.soft.csc.bp.receiver.ejb.CustomClassInterfaceM or jp.co.Hitachi.soft.csc.bp.receiver.ejb.CustomClassInterface).

4

Check whether the class or interface required for the validation in No. 3 exists.#

5

Check whether at least two variables are specified in the Variable for argument field of the invoke Java activity and the class specified for Java class name of the invoke Java activity has implemented jp.co.Hitachi.soft.csc.bp.receiver.ejb.CustomClassInterfaceM.

#

If the JAR file containing the class required for usrconf.cfg (option definition file for the J2EE server) in the execution environment is specified in add.class.path, you can ignore the error in No. 4. In this case, specify Warning or Ignore.

(3) Setting related to the validation activity

You can change the level of the validation items related to the validation activity. To apply changes in the settings, click the Apply button or Apply and Close button in the Preferences dialog box.

Variable to be validated is not specified

Specify the operation to be performed when no variables are set for the validation activity. The recommended setting is Error. If you want to set operation for 09-70 or earlier, specify Warning (not recommended).

1.11 Operations in the Binary Format Definition Window

This section explains the operations in the Binary Format Definition window.

Important note

The following subsections explain the operations of the Binary Format Definition Editor inside the Binary Format Definition window. The outline view inside the Binary Format Definition window shows the operation results of the Binary Format Definition Editor.

1.11.1 Copying and Pasting Elements

You can copy and paste the elements in the Binary Format Definition Editor.

Important note

A copied element cannot be pasted to Binary Format Definition Editor being used to edit a different binary format definition file. The copied element can be pasted only to the Binary Format Definition Editor in which the copied element exists.

To copy and paste an element:

Select the element to be copied.

Right-click and select Copy, or press CTRL + C.

Select the paste destination element.

Right-click and select Paste, or press CTRL + V.

The name of the pasted element is automatiinvokey set in the following format (where n is a serial integer for uniquely identifying each element name):

Copy-n-copy-source-element-name

When pasting a loinvokey defined simple content element as a component of another complex content element, if there is no component having the same name, the name of the copy-source element is used for the pasted element.

The following table lists the correspondence between copy-source elements and paste-destination elements.

Table 1‒13: Correspondence between copy-source elements and paste-destination elements

Copy-source element

Paste-destination element

Format

Simple content element (globally defined)

Complex content element

Component

(simple content element (globally defined))

Component

(complex content element)

Component (simple content element (loinvokey defined))

Format

--

--

--

--

--

--

Simple content element (globally defined)

(1)

(2)

(2)

--

--

--

Complex content element

(1)

(2)

(2)

--

--

--

Component (simple content element (globally defined))

--

--

--

--

--

--

Component (complex content element)

--

--

--

--

--

--

Component (simple content element (loinvokey defined))

--

--

(3)

(4)

(4)

(4)

Legend:

--: Copying or pasting is not allowed.

(1)

A globally defined simple content element or complex content element having the same contents as the copied globally defined simple content element or complex content element is added. The element is added to the end of all globally defined elements.

When a complex content element is copied, the components that are set in the complex content element are also copied.

(2)

A globally defined simple content element or complex content element having the same contents as the copied globally defined simple content element or complex content element is added. The element is added on top of the globally defined element selected as the paste target.

When a complex content element is copied, the components that are set in the complex content element are also copied.

(3)

A loinvokey defined simple content element having the same contents as the copied loinvokey defined simple content element is added to the selected complex content element. The element is added to the end of the selected complex content element.

(4)

A loinvokey defined simple content element having the same contents as the copied loinvokey defined simple content element is added. The element is added on top of the component selected as the paste target.

Important note

You cannot copy a globally defined simple content element and paste it as a loinvokey defined simple content element. Conversely, you cannot copy a loinvokey defined simple content element and paste it as a globally defined simple content element.

When you use the CSV format data as binary data, you can copy only the simple content elements specified as components of the complex content elements (header or record elements).

1.11.2 Deleting Elements

This subsection explains how to delete elements from the Binary Format Definition Editor.

To delete an element:

Select the element to be deleted.

Right-click the element and click Delete, or press the Delete key.

The following elements cannot be deleted:

Globally defined simple content elements and complex content elements that are referenced from components

A complex content element that is specified as the root element

For the following types of elements, a deletion confirmation warning message is displayed:

A simple content element (target node) that determines the occurrence count or size of another element

A simple content element (selection condition node) that has a selection condition value for another element

1.11.3 Moving Elements

You can move an element in the Binary Format Definition Editor by dragging it to another destination. While you are dragging an element, you can cancel the drag-and-drop operation by pressing the ESC key.

The result of the drag-and-drop operation differs depending on the destination type and whether the CTRL key is held down while the element is being dragged.

Important note

The scope of drag-and-drop operations is limited to within the Binary Format Definition Editor. You can neither drag an element from inside the Binary Format Definition Editor to another view or editor, nor drag an element from another view or editor to the Binary Format Definition Editor.

Even if a drag-and-drop operation causes a dependent relationship between elements such as selection conditions, no error occurs during the drag-and-drop operation. An error is output when the binary format file is validated.

When you use the CSV format data as a binary data, you can drag only the local simple content elements. The dragged local simple content elements can be dropped either above or below the complex content elements (header elements or record elements), or over the components.

Reference note

If the tree does not fit within the Binary Format Definition Editor, thereby hiding the destination element, you can drag the cursor to the frame of the Binary Format Definition Editor to automatiinvokey scroll the display, revealing the hidden elements.

If the tree is folded, thereby hiding the destination element, you can hold the cursor near the folded element to automatiinvokey open the tree.

(1) Destination types

Element, above, and below are available as destinations in a drag-and-drop operation.

When you make an element the destination, moving the cursor to the destination element reverses the display color of the element.

When you select above or below as the destination, a line () is displayed at the destination.

The following figure shows an example in which an element is dragged to a location above a component and below another component.

Figure 1‒152: Example of dropping an element above a component and below another component

In the example shown in the figure above, the destination is below a component Sequence01 and above a component Sequence03.

(2) Drag-and-drop operation result

The result of a drag-and-drop operation differs depending on whether or not the CTRL key is held down.

Drag-and-drop operation without holding down the CTRL key

Move

Moves an element. The source element is deleted and added to the destination.

Reference addition

Adds a component to a globally defined complex content element. The default value is used as the contents of the component added through the drag-and-drop operation.

The following table lists the relationship between the source and the destination when a drag-and-drop operation is executed without holding down the CTRL key.

Table 1‒14: Drag-and-drop operation result (without holding down the CTRL key)

Source

Destination

Simple content element (globally defined)

Complex content element (globally defined)

Component

Abv

Elmt

Blw

Abv

Elmt

Blw

Abv

Elmt

Blw

Simple content element (globally defined)

Move

--

Move

Move

Reference addition

Move

Reference addition

--

Reference addition

Complex content element (globally defined)

Move

--

Move

Move

Reference addition

Move

Reference addition

--

Reference addition

Component (simple content element)

--

--

--

--

--

--

Move

--

Move

Component (complex content element)

--

--

--

--

--

--

Move

--

Move

Component (simple content element (loinvokey defined))

--

--

--

--

--

--

Move

--

Move

Legend:

Abv: Above Elmt: Element Blw: Below Cannot perform drag-and-drop.

Drag-and-drop operation while holding down the CTRL key

Copying and addition

Copies and adds an element.

The information of the source element is inherited as the configuration information of the added element.

The name of the added element is automatiinvokey set in the following format (where n is a serial integer for uniquely identifying each element name):

Copy-n-drag-source-element-name

When a complex content element is copied and added, the components specified in the source complex content element are also inherited.

The following table lists the relationship between the source and the destination when a drag-and-drop operation is executed while holding down the CTRL key.

Table 1‒15: Drag-and-drop operation result (while holding down the CTRL key)

Source

Destination

Format

Simple content element (globally defined)

Complex content element (globally defined)

Component

Abv

Elmt

Blw

Abv

Elmt

Blw

Abv

Elmt

Blw

Abv

Elmt

Blw

Simple content element (globally defined)

--

P

--

P

--

P

P

--

P

--

--

--

Complex content element (globally defined)

--

P

--

P

--

P

P

--

P

--

--

--

Component (simple content element)

--

--

--

--

--

--

--

--

--

--

--

--

Component (complex content element)

--

--

--

--

--

--

--

--

--

--

--

--

Component (simple content element (loinvokey defined))

--

--

--

--

--

--

--

P

--

P

--

P

Legend:

Abv: Above Elmt: Element Blw: Below Cannot perform drag-and-drop.

P: Can be copied and added.

1.11.4 Undoing operations

You can undo the operations you have performed in the Binary Format Definition Editor. You can undo as many operations as you wish.

You can use either of the following methods for undoing operations:

Method 1

Right-click anywhere in the Binary Format Definition Editor, and choose Undo.

Method 2

Press CTRL + Z.

1.11.5 Redoing operations

You can redo the operations you have performed in the Binary Format Definition Editor. You can redo as many operations as you wish.

You can use either of the following methods for redoing operations:

Method 1

Right-click anywhere in the Binary Format Definition Editor, and choose Redo.

Method 2

Press CTRL + Y.

1.12 Operations in the Business Process Definition Window

This section explains the operations in the Business Process Definition window.

1.12.1 Copying objects

You can copy objects (activities, connections, fault connections, and link connections) on the canvas. When you select multiple objects, all the selected objects are copied. You can copy objects within the canvas of the business process window, as well as to other applications such as Word and Excel. Note that you can copy start activities and end activities to other applications, but not within the canvas of the business process window.

To copy an object:

Select the object to be copied.

When copying a connection, select the connection-source and connection-target activities as well. If you do not also select the connection-source and connection-target activities, you cannot copy the connection.

Use one of the following copy methods:

Select and right-click the object, and choose Copy.

Press CTRL + C.

1.12.2 Cutting objects

You can cut objects (activities, connections, fault connections, and link connections) on the canvas. The objects that can be cut are the same as those that can be copied. For details, see 1.12.1 Copying objects.

To cut an object:

Select the object to be cut.

When cutting a connection, select the connection-source and connection-target activities as well. If you do not also select the connection-source and connection-target activities, you cannot cut the connection.

Use one of the following cut methods:

Select and right-click the object, and choose Cut.

Press CTRL + X.

1.12.3 Pasting objects

You can paste copied or cut objects (activities, connections, fault connections, link connections and comments) to the canvas of the business process screen or to other applications.

(1) How to paste

The following describes the methods to paste objects to the pasting destinations canvas and other applications:

For canvas

Use one of the following paste methods:

With no activity selected, right-click anywhere in the canvas, and choose Paste.

Press [Ctrl] + [V].

For other applications

Press [Ctrl] + [V].

(2) Paste result

Depending on the object, the paste results differ as follows:

Important note

When you paste, a simple check is carried out and in case any inconsistency occurs in any activity or connection, a warning message is generated to the console view. For details about the contents of consistency checks for each activity ad connection, see "5.6 Defining Activities" in "Service Platform Basic Development Guide".

(a) Paste results for when you cut or copy an activity or comment

The contents of the activity that can be pasted from a copy or cut source differ depending on the paste destination. The following table lists the difference in activity and comment contents that can be pasted according to the paste destination:

Table 1‒16:  Difference in activity and comment contents according to the paste destination

Copy or cut source

Paste destination

Within the same canvas

Within the definition of the same business process (another scope or loop)

Definition of another business process

Another application

Start activity

N

N

N

A

End activity

N

N

N

A

Data transformation activity

B

B#1

B#1

A

Scope activity

B

B#2

B#2

A

While activity

B

B#2

B#2

A

All other activities

B

B

B

A

Comments

B

B

B

A

Legend:

B: The following contents can be pasted:

Activity or comment icon

Activity or comment definition information

Only names of variables, correlation sets and link names can be pasted. Therefore, if definition does not exist in the pasting destination, reference status becomes invalid.

A: The following contents can be pasted:

Activity icon

Cannot be defined at the copy destination.

N: Cannot be pasted.

However, if you want to copy scope activity or while activity, activiry on the canvas is pasted.

#1

If mapping defined editor is open while you execute copy or cut operation, pasting is done with the edited contents.

#2

You can also paste the variable information that you defined and the activity defined in canvas.

(b) Paste results for when you cut or copy a connection

From the defined information of a connection, any link and variable names can be pasted. Therefore, if definition does not exist in the pasting destination, reference status becomes invalid.

1.12.4 Deleting Objects

You can delete objects (activities, connections, fault connections, and link connections) from the canvas. If multiple objects are selected, all of them are deleted.

To delete an object:

Select the object to be deleted.

Use one of the following deletion methods:

Right-click the object, and choose Delete.

Click Delete.

When you delete a link-source or link-destination activity, the connection, fault connection, or link connection that was connected is also deleted.

1.12.5 Aligning Objects

You can align multiple objects (activities, connections, fault connections, and link connections) selected on the canvas. Choose any of the following alignment types:

Auto alignment

Left justify

Center (horizontal direction)

Right justify

Top justify

Center (vertical direction)

Bottom justify

Note that connections, fault connections, and link connections are simply moved as activities are aligned.

When auto alignment is used, all bending points set in connections between aligned activities (including fault connections and link connections) are canceled. Comments are not subject to auto alignment.

Bending points are automatically set in some connections.

To align objects:

Select the objects to be aligned.

You must include at least two activities among the objects to be aligned.

Use one of the following methods to align objects.

Right-click an object, choose Alignment, and choose an alignment type.

Automatically align the objects by pressing the Ctrl+Shift+F.

1.12.6 Undoing Operations

You can undo the operations you have performed on the canvas. The undoing-target operations are managed for each business process. Therefore, you can undo the operations of another scope activity or while activity within the same business process. You can undo up to the last 20 operations. You cannot undo the following operations:

Operations in the Properties view

Operations that open or close the Scope tab or While tab. If you delete a scope activity or while activity by undoing an operation, the Scope tab or While tab is deleted.

Operations in the Data Transformation Definition window

Operations that zoom the displayed contents in or out

Application of message format changes in mapping definitions.

You can use either of the following methods for undoing operations:

Method 1

With no activity selected, right-click anywhere in the canvas, and choose Undo.

Method 2

Press CTRL + Z.

Important note

When a business process is saved, operations are initialized. Therefore, after the business process is saved, you cannot undo any operation.

1.12.7 Redoing Operations

You can redo an operation that has been undone. Like undo operations, redoing-target operations are managed for each business process. You can redo as many operations as were sequentially undone.

You can use either of the following methods for redoing operations:

Method 1

With no activity selected, right-click anywhere in the canvas, and choose Redo.

Method 2

Press CTRL + Y.

Important note

When a business process is saved, operations are initialized. Therefore, after the business process is saved, you cannot redo any operation.

1.12.8 Zooming In

The display of canvas will be zoomed in. You can zoom in the display up to 200%.

You can use any of the following zoom-in methods:

Method 1

With no activity selected, right-click anywhere in the canvas, and choose Zoom-in.

Method 2

Press CTRL + [PLUS SIGN].

Method 3

Hold down CTRL and rotate the mouse wheel.

1.12.9 Zooming Out

The display of canvas will be zoomed out. You can zoom out the display up to 10%.

You can use any of the following zoom-out methods:

Method 1

With no activity selected, right-click anywhere in the canvas, and choose Zoom-out.

Method 2

Press CTRL + [MINUS SIGN].

Method 3

Hold down CTRL and rotate the mouse wheel.

1.12.10 Restoring the Default Display Size

You can restore zoomed-in or zoomed-out display contents to the default size (100%).

Use the following method to restore the default display size:

Method

With no activity selected, right-click anywhere in the canvas, and choose Back To Default size.

1.12.11 Specifying Palette Display Settings

You can specify palette display settings. You can specify the following contents:

Group and tool layout

Icon size

Font

Showing or hiding tool lists under groups

For details about the items displayed on the palette, see 1.2.3(1) Palette. The contents specified here apply to all business process windows.

(1) Specifying group and tool layout

You can specify the layout of the groups and tools on the palette as follows.

Columns

Arranges all groups and tools horizontally.

List

Arranges all groups and tools vertiinvokey.

Icons only

Shows only icons for all tools, without showing tool names.

Details

Shows all tools in a detailed format along with their descriptions.

You can use either of the following methods for specifying group and tool layout:

Method 1

Right-click a group or tool on the palette, and select the item to be specified from Layout.

Method 2

Right-click a group or tool on the palette, and choose Setting.

The Palette Settings dialog opens.

In Layout, select the item to be specified.

(2) Specifying an icon size

You can increase the size of the tool icons on the palette.

You can use either of the following methods for increasing the tool icon size:

Method 1

Right-click a group or tool on the palette, and choose Use large icons.

Method 2

Right-click a group or tool on the palette, and choose Setting.

The Palette Settings dialog opens.

In List Layout Options, select the Use large icons check box.

(3) Specifying a font

You can change the font for the groups and tools on the palette. You can also return to the default font.

The method for setting a font and the method for returning to the default font are described separately below.

To change the font

Right-click a group or tool on the palette, and choose Setting.

The Palette Settings dialog opens.

Click the Change button under Font.

To return to the default font

Right-click a group or tool on the palette, and choose Setting.

The Palette Settings dialog opens.

In Font, click the Restore Default button.

(4) Specifying whether to show or hide tool lists

You can hide the tool lists displayed on the palette. You can also show hidden tool lists. The following figure shows examples in which a tool list is shown and a tool list is hidden.

Figure 1‒153: Showing or hiding a tool list

You can use either of the following methods for showing or hiding a tool list:

Method 1

Click a group on the palette.

Method 2

Right-click a group on the palette, and choose Setting.

The Palette Settings dialog opens.

Select one of the following radio buttons for Drawer options:

Always close when opening another drawer radio button

Select this button to show the tool list of only a single group.

Close automatiinvokey when there is not enough room radio button

Select this button to automatiinvokey close tool lists if the palette runs out of space when tools lists of multiple groups are being displayed. However, the tool list of any group that is tacked# is not closed even if the palette runs out of space.

Never close radio button

Select this button to never close tools lists regardless of the number of groups being displayed or how much display space is available.

#

The following two methods are available for tacking a group:

Method 1

Click the (thumbtack) icon located to the right of a group on the palette.

Method 2

Right-click a group on the palette, and choose Tack.

1.12.12 Minimizing comments

You can minimize comments by using either of the following methods:

Method 1 (minimizing a selected comment)

Select and right-click a comment that is not minimized, and then select Minimize comment.

Method 2 (minimizing all comments in the canvas)

With no activity selected, right-click anywhere in the canvas, and then select Minimize all comments.

1.12.13 Restoring the size of comments

You can restore the size of minimized comments by using either of the following methods:

Method 1 (restoring the size of a selected minimized comment)

Select and right-click a minimized comment, and then select Restore the size of comment.

Method 2 (restoring the size of all minimized comments in the canvas)

With no activity selected, right-click anywhere in the canvas, and then select Restore the size of all comments.

1.12.14 Enabling and disabling the activity snapping function

The activity snapping function aligns activities on a business process editor. With the snapping function enabled, when an activity in a business process is dragged to a location near the vertical or horizontal line of other activities, the activity is automatically aligned to the line.

The snapping function is enabled by default.

You can use either of the following methods to disable the snapping function.

Method 1

Drag an activity while holding down the Alt key.

Method 2 (cancel the snapping function for all activities)

From the Eclipse menu, select Window, and then Preferences.

The Preferences dialog box opens.

In the left pane, select HCSC-Definer, and then Business process editor.

The Business process editor page appears in the right pane.

Clear the Enable snapping of activities check box.

Click the Apply and Close button.

1.12.15 Enabling and disabling the activity auto connect function

The activity auto connect function displays a preview of the connection between activities when an activity being deployed or moved in a business process editor is placed near another activity.

In addition, when the activity is dragged to a location near linked activities, a preview of another connection with those activities appears.

When the activity is deployed in this state, the connection is determined and the activities are linked.

The auto connect function is enabled by default. To disable the auto connect function or change the settings:

From the Eclipse menu, select Window, and then Preferences.

The Preferences dialog box opens.

In the left pane, select HCSC-Definer, and then Business Process Editor.

The Business Process Editor page appears in the right pane.

If necessary, change the settings of the items under Auto-connect.

Whether to enable connections with existing activities and whether to enable insertion to existing connections (these settings are specified when creating a new activity and when moving an activity)

Distance for showing a preview of the connection

Whether to display a circle indicating the scope of auto connection while the activity is dragged

Click the Apply and Close button.

1.12.16 Changing the setting of the activity auto align function

To change the setting of the activity auto align function:

From the Eclipse menu, select Window, and then Preferences.

The Preferences dialog box opens.

In the left pane, select HCSC-Definer, and then Business Process Editor.

The Business Process Editor page appears in the right pane.

If necessary, change the settings of the items under Auto-layout.

Selection of the auto align direction

Vertical (top to bottom)

Horizontal (left to right)

Activity interval after alignment

Whether to generate bending points

Click the Apply and Close button.

1.13 Operations in the Data transformation definition Window

This section explains the operations in the Data Transformation Definition window.

1.13.1 Undoing operations

You can undo the operations you have performed in the Data Transformation Definition window. You can undo as many operations as you wish. You can undo operations even after you have saved a definition.

You can use either of the following methods for undoing operations:

Method 1

Right-click anywhere in the Data Transformation Definition window, and choose Undo.

Method 2

Press CTRL + Z.

1.13.2 Redoing operations

You can redo the operations you have performed in the Data Transformation Definition window. You can redo as many operations as you wish. You can redo operations even after you have saved a definition.

You can use either of the following methods for redoing operations:

Method 1

Right-click anywhere in the Data Transformation Definition window, and choose Redo.

Method 2

Press CTRL + Y.

1.13.3 Output of namespace prefix to XML

In the Data Transformation Definition window, you can specify whether to output a namespace prefix to XML by using the following method:

Method

Right-click anywhere in the Data Transformation Definition window, and then select Output Namespace Prefix to XML.

If a check mark is added on the left side of Output Namespace Prefix to XML, a namespace prefix is output to XML.

1.13.4 Saving a definition

The method of saving a data transformation definition is described below.

Method 1

From the Eclipse menu, select File, and then Save.

Method 2

From the Eclipse menu, select File, and then Save All.

Method 3

On the Eclipse toolbar, click the Save icon.

Method 4

In the User-Defined Reception Definition window, press Ctrl+S.

You can re-edit a saved data transformation definition. To re-edit it, open the Data Transformation Definition window from a data transformation activity in the Adapter Definition window or Business Process Definition window.

1.13.5 Changing the Mapping Line Color

To change the mapping line color:

Method

On the Eclipse Window menu, choose Setting.

The Preferences dialog opens.

On the left side of the dialog, choose HCSC-Definer, and then Data Transformation.

The setting items in the Data Transformation Definition window are displayed on the right side of the dialog. For details about the items specified in the Data Transformation Definition window, see 1.6.18 Preferences dialog box (Data transformation settings).

Click one of the following buttons appropriate for the type of mapping lines, and then set the color:

- To set the color of assigned lines, click the button on the right side of Substitution.

- To set the color of loop mapping lines and loop link lines, click the button on the right side of Loop.

- To set the color of condition lines, click the button on the right side of Condition.

The color selection dialog box corresponding to the operating system appears. In this dialog box, select the color you want to set.

Click Apply.

Click Apply and Close.

1.13.6 Copying an element path from the schema tree viewer

To copy an element path from the schema tree viewer:

Method

In the source schema tree viewer or target schema tree viewer, select and right-click the element you want to copy, and then select Copy Element Path in the context menu.

This causes the full path of the selected element to be saved in the clipboard.

In the case of N-to-one transformation, the path including $schema-logical-name (business-process-variable-name) is copied.

1.14 Filter function settings of the outline view

In the outline view, you can enable and disable the variable list display and activity list display by using the filter function.

1.14.1 Enabling and disabling the variable list display

The variable list display is enabled by default. To enable or disable the display:

Method

Select Show Variable List from the menu of the outline view.

To show the list of variables, make sure that a check mark is added on the left side of Show Variable List. To hide the list of variables, clear the check mark by clicking Show Variable List.

1.14.2 Enabling and disabling the activity list display

You can enable and disable the activity list display for each activity type. The display of all types of activity lists is enabled by default. To enable or disable the display:

Method

Select Filters from the menu of the outline view.

The Filters dialog box opens.

Select the activity type you want to display in the outline view.

Under Activity type, select the check box for items you want to display, and clear the check box for items you do not want to display.

Click the OK button.

2 Commands

This chapter explains the commands used for developing a service platform system.

2.1 Types of commands

The following table lists the commands to be used in a development environment of Service Platform:

Table 2‒1: List of commands used in a development environment of Service Platform

Command

Explanation

csamkxmls

Creates an XML format definition file used for DB adapters to execute service components of the DB adapters.

cscbinaryparse

Transforms DOM data to binary data or vice versa, and then outputs a file after transformation.

cscfdx2xsd

Generates an XML format definition file from a binary format definition file.

cscgenbinary

Generates a binary message from a binary format definition file.

cscjson2xsd

Transforms JSON format data to an XSD file, and then outputs a file after transformation.

cscjsonxmlconv

Transforms JSON format data to XML format data or vice versa, and then outputs a file after transformation.

cscsoapmode

Set up a SOAP mode to be used.

csctransform

Tests data transformation, and then outputs a file after transformation.

2.2 Command Input Format

The following command input format is used:

command-name [argument...]

Each of these items is explained below. Note that $ and cmd denote the command prompt and a command name, respectively.

Command name

Specify the file name of the command to be executed.

To execute a command by specifying a path containing a space, you must enclose the entire path inside double quotation marks ("").

Incorrect specification example: $ C:\Program Files\Hitachi\Cosminexus\CC\server\bin\cmd

Correct specification example: $ "C:\Program Files\Hitachi\Cosminexus\CC\server\bin\cmd"

Arguments

Arguments include options. The input formats and specification rules for options are described below.

Option input formats

An option is a character string that begins with a hyphen (-). Two option input formats are available. In one, no option argument is specified; in the other, a single option argument is specified.

Format without option argument specification

$ cmd -option-flag

Format with a single option argument specified

$ cmd -option-flag<space or tab>option-argument

Legend:

option-flag

One alphanumeric character that is case sensitive

option-argument

Argument corresponding to the option flag

Option specification rules

Multiple option flags cannot be specified together following a single hyphen (-).

Incorrect specification example: $ cmd -abc

Correct specification example: $ cmd -a -b -c

The option argument of an option flag that requires the option argument cannot be omitted.

A space or tab is required between an option flag and an option argument.

Incorrect specification example: $ cmd -afile

Correct specification example: $ cmd -a file

The same option flag cannot be specified more than once.

Incorrect specification example: $ cmd -a 1 -a 2

When an option argument contains a space, the entire option argument must be enclosed inside double quotation marks ("").

Incorrect specification example: $ cmd -a file 1

Correct specification example: $ cmd -a "file 1"

2.3 Command Syntax and Description Format

The command syntax is explained in the following format:

Format

Shows the command input format.

Function

Explains the function of the command.

Argument

Explains the arguments and options of the command.

Usage example

Describes the usage examples of commands.

Return value

Explains the return value of the command.

Notes

Describes all the points to be considered to execute the commands.

Note

Not all the above items are described for each command. In addition to the above items, information specific to individual commands might be described.

The following table explains the symbols used in syntax explanations in this chapter.

Symbol

Convention

|

In syntax explanations, a vertical bar separates multiple items, and has the meaning of OR.

For example: A|B|C means A, or B, or C.

{ }

In syntax explanations, curly brackets indicate that only one of the enclosed items is to be selected. If the items are arranged horizontally and separated by a vertical bar (|), select one of the items.

For example: {A|B|C} means only one of A, or B, or C.

[ ]

In syntax explanations, square brackets indicate that the enclosed item or items are optional.

For example: [A] means that you can specify A or nothing.

Italic

In syntax explanations, italic characters indicate an element that must be specified.

For example: property means that you must specify a property.

...

In coding, an ellipsis (...) indicates that one or more lines of coding have been omitted.

For example: ABC ... means that the coding after ABC has been omitted.

~

In syntax explanations, a swung dash (~) indicates that the items preceding the swung dash comply with the rules mentioned in < >, (( )), and << >> following the swung dash.

< >

In syntax explanations, angle brackets indicate the syntax elements that must be complied with when items are coded. For details on syntax elements, see the following table.

(( ))

In syntax explanations, double-parentheses indicate the range of values that you can specify for an item.

<< >>

In syntax explanations, double-angle brackets indicate the default value that the system assumes when an item is omitted.

The following table lists the types and definitions of the syntax elements used in this chapter.

Type

Definition

Alphabetic characters

A to Z, a to z

Lowercase alphabetic characters

a to z

Uppercase alphabetic characters

A to Z

Numeric characters

0 to 9

Alphanumeric characters

A to Z, a to z, 0 to 9

Symbols

_, ., -

Character string

An array of strings

2.4 Commands used in the development environment of a service platform

csamkxmls (Creating XML Format Definition File for Database Adapter)

Format

csamkxmls -o SQL-operation-definition-file-name
          -x name-of-XML-format-definition-file-for-database-adapter
         [-f]

Function

Creates an XML format definition file for a database adapter; used for executing a service module of the database adapter.

This command is saved in the following location:

service-platform-installation-directory\CSC\bin

When executing the command, move to this location or specify the path.

Arguments

-o SQL-operation-definition-file-name ~~ <path name> ((1 - 200 bytes))

Specify the name of the SQL operation definition file that describes the SQL execution format. For the name of the SQL operation definition file, specify an absolute path to a file that has the csa_sql_any-name.xml format.

-x DB-name-of-xml-format-definition-file-for-database-adapter ~~ <path name> ((1- 200 bytes))

Specify the name of the XML format definition file for a database adapter to be created. For the name of the XML format definition file for a database adapter, specify an absolute path to a file that has the .xsd extension. Specify the name of the XML format definition file within 200 bytes#.

#

This is the byte count after converting the absolute path of the XML format definition file to UTF-8.

-f

Overwrites the existing XML format definition file for a database adapter if it has the same name as the file being created. If you do not specify this option when an XML format definition file for a database adapter having the same name as the file being created already exists, an error occurs.

Return value

Return value

Meaning

0

Normally terminated.

1

Abnormally terminated.

9

An error occurred when checking the execution permission.

cscbinaryparse (Mutually transforming DOM and binary data)

Format

(1) To directly specify the arguments in the command

cscbinaryparse -format path-of-binary-format-definition-file
               -infile path-of-input-data-file
               -outfile path-of-output-data-file
               [-inverse]
               [-uocclass class-name-of-character-code-conversion-UOC
                [-uocproperty path-of-self-defined-file-for-character-code-conversion-UOC]]
               [-codetablerootpath root-path-of-code-conversion-table-storage-path]
               [-debugtrace [-debugtracefilepath path-to-output-debug-information]]
               [-cscdtsysprop path-of-system-properties-file-for-data-transformation]
               [-undefinedcode {ERROR|REPLACE}]

(2) To specify the command arguments in a file

cscbinaryparse -f path-of-binary-parse-command-properties-file

Function

Transforms DOM data to binary data or vice versa, and then outputs the transformation result to a file.

This command is saved in the following location:

service-platform-installation-directory\CSCTE\bin

When executing the command, move to this location or specify the path.

The following two methods are available for specifying arguments of the command.

Directly specify the arguments in the command

Specify the arguments when executing the command. If the -f option is also specified, all the directly specified arguments are invalid and the arguments in the binary-parse command properties file specified in the -f option are valid.

Specify the command arguments in a file

Enter the command arguments in the property format in the binary-parse command properties file, and then specify the file name in the -f option.

If the system environment variable COSMINEXUS_HOME is not set correctly, executing the command causes an error.

Arguments

(1) To directly specify the arguments in the command

-format path-of-binary-format-definition-file

Specifies the path of the binary format definition file (.fdx) as an absolute or relative path. You cannot omit this argument.

-infile path-of-input-data-file

Specifies the path of the input data file as an absolute or relative path. You cannot omit this argument.

You can specify any of the following data types:

Binary data

Either of the following DOM data (XML)

DOM data generated from binary data by using DOM transformation

DOM data that complies with the XML schema file generated by using the cscfdx2xsd command with the binary format definition file (specified in the -format option) specified

-outfile path-of-output-data-file

Specifies the path of the output data file as an absolute or relative path. If the output destination directory does not exist, an error occurs. You cannot omit this argument.

If a file with the specified name exists in the specified path, the existing file is overwritten. If there is no file with the specified name, a new file is created.

-inverse

Specifies the transformation operation between binary data and DOM data. You can omit this argument.

If this argument is specified:

DOM data is transformed to binary data.

If this argument is not specified:

Binary data is transformed to DOM data

-uocclass class-name-of-character-code-conversion-UOC

Specifies the class name of the character code conversion UOC by using a fully qualified name. You can omit this argument.

The class name of the character code conversion UOC can also be specified in the system properties file for data transformation, in addition to this argument and the binary-parse command properties file. If the specifications are duplicated, the specified value is applied according to the following priority:

Priority

Property file or command name

Relevant property or argument

1

System properties file for data transformation

csc.dt.ownCodeConverter.className

2

Binary-parse command properties file

csctransform.uoc.class

3

cscbinaryparse command

-uocclass

For details about the csc.dt.ownCodeConverter.className setting in the system properties file for data transformation, see 3.14.2 System properties file for data transformation.

To use the character code conversion UOC, you need to specify a JAR file of the character code conversion UOC in the system environment variable CSC_DATA_TRANSFORM_CLASSPATH. When invoking a class defined in an external JAR file from a custom function or character code conversion UOC, you also need to specify the relevant JAR file in the environment variable.

-uocproperty path-of-self-defined-file-for-character-code-conversion-UOC

If the -uocclass option is specified, this argument specifies the path of the self-defined file for the character code conversion UOC as an absolute or relative path. You can omit this argument.

If the -uocclass option is not specified, this argument is invalid. If you specify the -uocclass option and omit this argument, the class of the character code conversion UOC is executed without reading the self-defined file during data transformation.

-codetablerootpath root-path-of-code-conversion-table-storage-path

Specifies, as an absolute or relative path, the root path of the storage path of the code conversion table to be used by the code conversion library. You can omit this argument.

-debugtrace

Specify this argument to output debug information. You can omit this argument.

-debugtracefilepath path-to-output-debug-information ~ <<current directory in which the command was executed>>

If the -debugtrace option is specified, this argument specifies the output destination path of debug information as an absolute or relative path. You can omit this argument.

If this argument is not set, if the output destination is not specified, or if the specified directory does not exist, debug information is output to the current directory in which the command was executed.

-cscdtsysprop path-of-system-properties-file-for-data-transformation

Specifies the path of the system properties file for data transformation as an absolute or relative path. You can omit this argument.

The system properties file for data transformation contains the system properties specified for data transformation in Service Platform. For details about how to specify the system properties, see 3.14.2 System properties file for data transformation.

-undefinedcode {ERROR|REPLACE} ~ <<ERROR>>

Specifies the operation to be performed when an undefined character code is detected during character code conversion of binary data. You can omit this argument.

You can specify one of the following values:

ERROR

When an undefined character code is detected, an error occurs and the processing ends.

REPLACE

The character code of undefined portions is converted to a blank character code, and the processing continues.

(2) To specify the command arguments in a file

-f path-of-binary-parse-command-properties-file

Specifies the path of the binary-parse command properties file as a relative or absolute path. If this option is specified, any other options are ignored.

Binary-parse command properties file

This file contains the arguments of the cscbinaryparse command specified in the Java property file format. The available character code is UTF-8 only.

For details about how to define the binary-parse command properties file, see 3.14.5 Binary-parse command properties file.

Return value

Return value

Meaning

0

Normally terminated.

1

Abnormally terminated.

Notes

If a stack overflow or OOM (Out Of Memory) occurs during execution of the command, specify the Java VM start options in the system environment variable CSC_DATA_TRANSFORM_OPT to set the values for the stack area and heap area.

The following describes the Java VM start options you can specify in the system environment variable:

Java VM start option

Description

-Xms

Initial value of the heap area (New area + Old area)

-Xmx

Maximum value of the heap area (New area + Old area)

-Xss

Stack size of the thread

-XX:MetaspaceSize

Standard value for Full GCs that originate in the Metaspace area

-XX:MaxMetaspaceSize

Maximum value of the Metaspace area

If you use a wildcard to specify a path, operations are not guaranteed.

cscfdx2xsd (Creating XML format definition files from binary format definition files)

Format

cscfdx2xsd fdx-file-path [xsd-file-path]

Function

Creates an XML format definition file from a binary format definition file.

This command is saved in the following location:

Cosminexus-installation-directory\CSCTE\bin

When executing the command, specify the path to move the file to this location.

Arguments

fdx-file-path

Specify the path of the binary format definition file for input.

You can specify only one file. If multiple files are selected specifying a wild card, an error will occur.

xsd-file-path

Specify the path of the XML format definition file for output.

If not specified, a path will be assumed with .xsd as the extension of the path specified in fdx-file-path.

Usage example

(1) To create an XML format definition file CSVFormat.xsd from a binary format definition file CSVFormat.fdx

C:\> cscfdx2xsd CSVFormat.fdx
KECT91001-I The XML schema file was created successfully. (file = CSVFormat.xsd)
C:\>

(2) To create an XML format definition file XMLFormat.xsd from a binary format definition file BinFormat.fdx, and then overwrite the existing XML format definition file XMLFormat.xsd

C:\> cscfdx2xsd BinFormat.fdx XMLFormat.xsd
KECT91002-Q The specified XML schema file already exists. Do you want to overwrite it? [Y/N]:y
KECT91001-I The XML schema file was created successfully. (file = XMLFormat.xsd)
C:\>

Return value

There is no return value with this command. The message output in standard output.

Notes

An error will occur in the following cases:

If authentication of a binary format definition file is not complete

If the extension of the binary format definition file is other than .fdx

If the specified binary format definition file does not exist

If the file cannot be read as a binary format definition file

If a wild card is used to specify a binary format definition file or an XML format definition file

If an error has occurred in the transformation process

cscgenbinary (Generating binary messages from binary format definition files)

Format

(1) To directly specify the arguments in the command

cscgenbinary -format path-of-binary-format-definition-file
              {-outbinfile path-of-output-binary-file
                [-inxmlfile path-of-input-XML-file]
               | -outxmlfile path-of-output-XML-file}
              [-genproperty path-of-binary-message-generation-definition-file]
              [-uocclass class-name-of-character-code-conversion-UOC
               [-uocproperty path-of-self-defined-file-for-character-code-conversion-UOC]]
              [-codetablerootpath root-path-of-code-conversion-table-storage-path]
              [-debugtrace [-debugtracefilepath path-to-output-debug-information]]
              [-cscdtsysprop path-of-system-properties-file-for-data-transformation]
              [-undefinedcode {ERROR|REPLACE}]

(2) To specify the command arguments in a file

cscgenbinary -f path-of-binary-message-generation-command-properties-file

Function

Generates a binary message from a binary format definition file.

This command is saved in the following location:

service-platform-installation-directory\CSCTE\bin

When executing the command, move to this location or specify the path.

The following two methods are available for specifying arguments of the command:

Directly specify the arguments in the command

Specify the arguments when executing the command. If the -f option is also specified, all the directly specified arguments are invalid and the arguments in the binary-message-generation command properties file specified in the -f option are valid.

Specify the command arguments in a file

Enter the command arguments in the property format in the binary-message-generation command properties file, and then specify the file name in the -f option.

If the system environment variable COSMINEXUS_HOME is not set correctly, executing the command causes an error.

For details about how to use the cscgenbinary command, see the manual Service Platform Basic Development Guide.

Arguments

(1) To directly specify the arguments in the command

-format path-of-binary-format-definition-file

Specifies an absolute or relative path of a binary format definition file (.fdx) for which validation in the editor is completed. The extension is not case sensitive. You cannot omit this argument.

-outbinfile path-of-output-binary-file

Specifies the path of the output binary file as an absolute or relative path. If the output destination directory does not exist, an error occurs.

You must specify either the -outbinfile option (path of the output binary file) or -outxmlfile option (path of the output XML file).

If a file with the specified name exists in the specified path, the existing file is overwritten. If there is no file with the specified name, a new file is created.

-inxmlfile path-of-input-XML-file

Specifies the path of the input XML file as an absolute or relative path if binary messages are to be generated from XML files. You can omit this argument.

This argument is invalid if specified along with the -outxmlfile option.

The specified input XML file must comply with the XML schema file generated by using the cscfdx2xsd command based on the binary format definition file (specified in the -format option). If the input XML file does not comply with the XML schema file, operations are not guaranteed.

-outxmlfile path-of-output-XML-file

Specifies the path of the output XML file as an absolute or relative path. If the output destination directory does not exist, an error occurs. You cannot omit this argument.

You must specify either the -outbinfile option (path of the output binary file) or -outxmlfile option (path of the output XML file).

If a file with the specified name exists in the specified path, the existing file is overwritten. If there is no file with the specified name, a new file is created.

-genproperty path-of-binary-message-generation-definition-file

Specifies the path of the binary-message-generation definition file as an absolute or relative path. You can omit this argument.

This argument is invalid if specified along with the -inxmlfile option.

You can use the binary-message-generation definition file to change the element value of a simple content element from the default value. For details about the binary-message-generation definition file, see 3.14.4 Binary-message-generation definition file.

-uocclass class-name-of-character-code-conversion-UOC

Specifies the class name of the character code conversion UOC by using a fully qualified name. You can omit this argument.

You can also specify the class name of the character code conversion UOC in the following files and command. The following shows the priority by which the value will be applied if specifications are duplicated:

Priority

Property file or command name

Relevant property or argument

1

System properties file for data transformation

csc.dt.ownCodeConverter.className

2

Binary-message-generation command properties file

csctransform.uoc.class

3

cscgenbinary command

-uocclass

For details about the csc.dt.ownCodeConverter.className setting in the system properties file for data transformation, see 3.14.2 System properties file for data transformation.

To use the character code conversion UOC, you need to specify a JAR file of the character code conversion UOC in the system environment variable CSC_DATA_TRANSFORM_CLASSPATH. When invoking a class defined in an external JAR file from a custom function or character code conversion UOC, you also need to specify the relevant JAR file in the environment variable.

-uocproperty path-of-self-defined-file-for-character-code-conversion-UOC

If the -uocclass option is specified, this argument specifies the path of the self-defined file for the character code conversion UOC as an absolute or relative path. You can omit this argument.

If the -uocclass option is not specified, this argument is invalid. If you specify the -uocclass option and omit this argument, the class of the character code conversion UOC is executed without reading the self-defined file during data transformation.

-codetablerootpath root-path-of-code-conversion-table-storage-path

Specifies, as an absolute or relative path, the root path of the storage path of the code conversion table to be used by the code conversion library. You can omit this argument.

-debugtrace

Specify this argument to output debug information. You can omit this argument.

-debugtracefilepath path-to-output-debug-information ~ <<current directory in which the command was executed>>

If the -debugtrace option is specified, this argument specifies the output destination path of debug information as an absolute or relative path. You can omit this argument.

If this argument is not set, if the output destination is not specified, or if the specified directory does not exist, debug information is output to the current directory in which the command was executed.

-cscdtsysprop path-of-system-properties-file-for-data-transformation

Specifies the path of the system properties file for data transformation as an absolute or relative path. You can omit this argument.

The system properties file for data transformation contains the system properties specified for data transformation in Service Platform. For details about how to specify the system properties, see 3.14.2 System properties file for data transformation.

-undefinedcode {ERROR|REPLACE} ~ <<ERROR>>

Specifies the operation to be performed when an undefined character code is detected during character code conversion of binary data. You can omit this argument.

You can specify one of the following values:

ERROR

When an undefined character code is detected, an error occurs and the processing ends.

REPLACE

The character code of undefined portions is converted to a blank character code, and the processing continues.

(2) To specify the command arguments in a file

-f path-of-binary-message-generation-command-properties-file

Specifies the path of the binary-message-generation command properties file as a relative or absolute path. If this option is specified, any other options are ignored.

Binary-message-generation command properties file

This file contains the arguments of the cscgenbinary command specified in the Java property file format. The available character code is UTF-8 only.

For details about how to define the binary-message-generation command properties file, see 3.14.3 Binary-message-generation command properties file.

Return value

Return value

Meaning

0

Normally terminated.

1

Abnormally terminated.

Notes

If a stack overflow or OOM (Out Of Memory) occurs during execution of the command, specify the Java VM start options in the system environment variable CSC_DATA_TRANSFORM_OPT to set the values for the stack area and heap area.

The following describes the Java VM start options you can specify in the system environment variable:

Java VM start option

Description

-Xms

Initial value of the heap area (New area + Old area)

-Xmx

Maximum value of the heap area (New area + Old area)

-Xss

Stack size of the thread

-XX:MetaspaceSize

Standard value for Full GCs that originate in the Metaspace area

-XX:MaxMetaspaceSize

Maximum value of the Metaspace area

If you use a wildcard to specify a path, operations are not guaranteed.

cscjson2xsd (Transforming JSON format data to XSD files)

Format

cscjson2xsd -in {JSON-file-path
               |path-of-directory-containing-JSON-file}
            -out XSD-file-path
           [-f path-of-JSON-XML-transformation-definition-file]

Function

Generates XSD files from JSON format data.

This command is saved in the following location:

service-platform-installation-directory\CSCTE\bin

When executing the command, move to this location or specify the path.

Arguments

-in {JSON-file-path|path-of-directory-containing-JSON-file}

Specifies the storage location of JSON files (extension: .json) as an absolute or relative path. For a relative path, the current directory is the starting point of the path. Specify one of the following:

Path of the JSON file

Specify the path of the JSON file to be input.

Path of the directory containing JSON files

Specify the path of the directory that contains JSON files to be input.

All JSON files directly under the specified directory will be input. If there is no JSON file directly under the specified directory, an error occurs.

-out XSD-file-path

Specifies the path of the XSD file to be output (extension: .xsd) as an absolute or relative path. For a relative path, the current directory is the starting point of the path.

If the specified directory does not exist, a directory is generated and files are output. If a file having the specified name already exists, the existing file is overwritten.

-f path-of-JSON-XML-transformation-definition-file ~ <<service-platform-installation-directory\CSCTE\config\tools\json\csc_json_converter.properties>>

Specifies, as an absolute or relative path, the path of the JSON-XML transformation definition file in which the transformation operation between JSON format data and XML format data is specified. For a relative path, the current directory is the starting point of the path.

To apply the JSON-XML transformation definition file, the following two methods are available:

Use the -f argument to specify a JSON-XML transformation definition file

You can specify the file name of the desired JSON-XML transformation definition file.

Omit the -f argument so that the specified file is automatically read

If you omit the -f argument, the following file is read. You must store the JSON-XML transformation definition file with the following file name in advance. You can also edit the file contents.

service-platform-installation-directory\CSCTE\config\tools\json\csc_json_converter.properties

If this file does not exist, operation is performed with the default values of the JSON-XML transformation library. For details about the JSON-XML transformation library, see the manual Service Platform Basic Development Guide.

JSON-XML transformation definition file

In this file, the transformation operation between JSON format data and XML format data is specified in the Java property file format. The available character code is UTF-8 only. You can specify this file in both the cscjson2xsd command and cscjsonxmlconv command.

The following shows the template file. To specify the -f argument after editing the template file, save the file with the desired file name.

service-platform-installation-directory\CSC\config\msg\templates\csc_json_converter.properties

For details about how to define the JSON-XML transformation definition file, see 3.13.1 JSON-XML transformation definition file.

Return value

Return value

Meaning

0

Normally terminated.

1

Abnormally terminated.

9

An error occurred when checking the execution permission.

Notes

This command must be executed by a user with administrator's permission.

The system environment variable COSMINEXUS_HOME must be set correctly.

cscjsonxmlconv (Mutually transforming JSON format data and XML format data)

Format

cscjsonxmlconv -in path-of-input-file
               -out path-of-output-file
              [-f path-of-JSON-XML-transformation-definition-file]

Function

Generates a file from the result of mutually transforming JSON format data and XML format data.

This command is saved in the following location:

service-platform-installation-directory\CSCTE\bin

When executing the command, move to this location or specify the path.

Arguments

-in path-of-input-file

Specifies the path of the input file as an absolute or relative path. You can specify files whose extension is .json or .xml.

-out path-of-output-file

Specifies the path of the output file as an absolute or relative path. The files that can be specified depend on the file specified in the -in option.

If the extension of the file specified in the -in option is .json:

Files with .xml extension can only be specified.

If the extension of the file specified in the -in option is .xml:

Files with .json extension can only be specified.

If the specified directory does not exist, a directory is generated and files are output. If a file having the specified name already exists, the existing file is overwritten.

-f path-of-JSON-XML-transformation-definition-file ~ <<service-platform-installation-directory\CSCTE\config\tools\json\csc_json_converter.properties>>

Specifies, as an absolute or relative path, the path of the JSON-XML transformation definition file in which the transformation operation between JSON format data and XML format data is specified.

To apply the JSON-XML transformation definition file, the following two methods are available:

Use the -f argument to specify a JSON-XML transformation definition file

You can specify the file name of the desired JSON-XML transformation definition file.

Omit the -f argument so that the specified file is automatically read

If you omit the -f argument, the following file is read. You must store the JSON-XML transformation definition file with the following file name in advance. You can also edit the file contents.

service-platform-installation-directory\CSCTE\config\tools\json\csc_json_converter.properties

If this file does not exist, operation is performed with the default values of the JSON-XML transformation library. For details about the JSON-XML transformation library, see the manual Service Platform Basic Development Guide.

JSON-XML transformation definition file

In this file, the transformation operation between JSON format data and XML format data is specified in the Java property file format. The available character code is UTF-8 only. You can specify this file in both the cscjson2xsd command and cscjsonxmlconv command.

The following shows the template file. To specify the -f argument after editing the template file, save the file with a desired file name.

service-platform-installation-directory\CSC\config\msg\templates\csc_json_converter.properties

For details about how to define the JSON-XML transformation definition file, see 3.13.1 JSON-XML transformation definition file.

Return value

Return value

Meaning

0

Normally terminated.

1

Abnormally terminated.

9

An error occurred when checking the execution permission.

Notes

This command must be executed by a user with administrator's permission.

The system environment variable COSMINEXUS_HOME must be set correctly.

cscsoapmode (Setting up a SOAP mode)

Format

cscsoapmode {only|both|-h}

Function

Sets up a SOAP mode to be used.

This command is saved in the following location:

Cosminexus-installation-directory\CSCTE\bin

When executing the command, specify the path to move the file to this location.

Arguments

only

Specify, if SOAP1.1 mode is to be used.

both

Specify, if SOAP1.1/1.2 combined mode is to be used.

-h

Displays how to use the command and the current SOAP mode.

Return value

Return value

Meaning

0

Successfully terminated.

1

The command is terminated abnormally.

Notes

This command must be executed by a user with administrator's permission.

This command must be executed before creating an HCSCTE project. If the HCSCTE project is already created, for details about the setup, see the description for changing the SOAP mode in the manual Service Platform Basic Development Guide.

Eclipse must be restarted to execute the command and apply the SOAP mode settings.

csctransform (Testing data transformation)

Format

(1) To directly specify the arguments in the command

csctransform -xsl path-of-XSL-file-(mapping-definition)
             -informat path-of-input-format-definition-file
             -infile path-of-input-file
             -outformat path-of-output-format-definition-file
             -outfile path-of-output-file
            [-uocclass class-name-of-character-code-conversion-UOC
             [-uocproperty path-of-self-defined-file-for-character-code-conversion-UOC]]
            [-codetablerootpath root-path-of-code-conversion-table-storage-path]
            [-validate]
            [-debugtrace [-debugtracefilepath path-to-output-debug-information]]
            [-cscdtsysprop path-of-system-properties-file-for-data-transformation]
            [-undefinedcode {ERROR|REPLACE}]

(2) To specify the command arguments in a file

csctransform -f path-of-data-transformation-command-properties-file

Function

Transforms XML format data to binary data or vice versa, and then outputs the transformation result to a file.

This command is saved in the following location:

service-platform-installation-directory\CSCTE\bin

When executing the command, move to this location or specify the path.

The following two methods are available for specifying arguments of the command:

Directly specify the arguments in the command

Specify the arguments when executing the command. If the -f option is also specified, all the directly specified arguments are invalid and the arguments in the data-transformation command properties file specified in the -f option are valid.

You can perform one-to-one transformation only.

Specify the command arguments in a file

Enter the command arguments in the property format in the data-transformation command properties file, and then specify the file name in the -f option.

You can perform N-to-one transformation and one-to-one transformation.

If the system environment variable COSMINEXUS_HOME is not set correctly, executing the command causes an error.

Arguments

(1) To directly specify the arguments in the command

-xsl path-of-XSL-file-(mapping-definition)

Specifies the path of the XSL file (mapping definition) as an absolute or relative path. You cannot omit this argument.

-informat path-of-input-format-definition-file

Specifies the path of the input format definition file as an absolute or relative path. You cannot omit this argument.

You can specify files whose extension is .xsd (XML format) or .fdx (binary format).

-infile path-of-input-file

Specifies the path of the input file as an absolute or relative path. You cannot omit this argument.

-outformat path-of-output-format-definition-file

Specifies the path of the output format definition file as an absolute or relative path. You cannot omit this argument.

You can specify files whose extension is.xsd (XML format) or .fdx (binary format).

-outfile path-of-output-file

Specifies the path of an existing output file as an absolute or relative path. If the output destination directory does not exist, an error occurs. You cannot omit this argument.

If a file with the specified name exists in the path, the existing file is overwritten. If there is no file with the specified name, a new file is created.

-uocclass class-name-of-character-code-conversion-UOC

Specifies the class name of the character code conversion UOC by using a fully qualified name. You can omit this argument.

The class name of the character code conversion UOC can also be specified in the system properties file for data transformation, in addition to this argument and the data-transformation command properties file. If the specifications are duplicated, the specified value is applied according to the following priority:

Priority

Property file or command name

Relevant property or argument

1

System properties file for data transformation

csc.dt.ownCodeConverter.className

2

Data-transformation command properties file

csctransform.uoc.class

3

csctransform command

-uocclass

For details about the csc.dt.ownCodeConverter.className setting in the system properties file for data transformation, see 3.14.2 System properties file for data transformation.

To use the character code conversion UOC, you need to specify a JAR file of the character code conversion UOC in the system environment variable CSC_DATA_TRANSFORM_CLASSPATH. When invoking a class defined in an external JAR file from a custom function or character code conversion UOC, you also need to specify the relevant JAR file in the environment variable.

-uocproperty path-of-self-defined-file-for-character-code-conversion-UOC

If the -uocclass option is specified, this argument specifies the path of the self-defined file for the character code conversion UOC as an absolute or relative path. You can omit this argument.

If the -uocclass option is not specified, this argument is invalid. If you specify the -uocclass option and omit this argument, the class of the character code conversion UOC is executed without reading the self-defined file during data transformation.

-codetablerootpath root-path-of-code-conversion-table-storage-path

Specifies, as an absolute or relative path, the root path of the storage path of the code conversion table to be used by the code conversion library. You can omit this argument.

-validate

Specify this argument to perform the following schema validation.

Perform schema validation for input files (XML) by using an input format definition file (XML Schema).

Perform schema validation for output files (XML) by using an output format definition file (XML Schema).

You can omit this argument.

-debugtrace

Specify this argument to output debug information. You can omit this argument.

-debugtracefilepath path-to-output-debug-information ~ <<current directory in which the command was executed>>

If the -debugtrace option is specified, this argument specifies the output destination path of debug information as an absolute or relative path. You can omit this argument.

If this argument is not set, if the output destination is not specified, or if the specified directory does not exist, debug information is output to the current directory in which the command was executed.

-cscdtsysprop path-of-system-properties-file-for-data-transformation

Specifies the path of the system properties file for data transformation as an absolute or relative path. You can omit this argument.

The system properties file for data transformation contains the system properties specified for data transformation in Service Platform. For details about how to specify the system properties, see 3.14.2 System properties file for data transformation.

-undefinedcode {ERROR|REPLACE} ~ <<ERROR>>

Specifies the operation to be performed when an undefined character code is detected during code conversion for binary data. You can omit this argument.

You can specify one of the following values:

ERROR

When an undefined character code is detected, an error occurs and the processing ends.

REPLACE

The character code of undefined portions is converted to a blank character code, and the processing continues.

(2) To specify the command arguments in a file

-f path-of-data-transformation-command-properties-file

Specifies the path of the data-transformation command properties file as a relative or absolute path. If this option is specified, any other options are ignored.

Data-transformation command properties file

This file contains the arguments of the csctransform command specified in the Java property file format. The available character code is UTF-8 only.

For details about how to define the data-transformation command properties file, see 3.14.1 Data-transformation command properties file.

Return value

Return value

Meaning

0

Normally terminated.

1

Abnormally terminated.

Notes

If a stack overflow or OOM (Out Of Memory) occurs during execution of the command, specify the Java VM start options in the system environment variable CSC_DATA_TRANSFORM_OPT to set the values for the stack area and heap area.

The following describes the Java VM start options you can specify in the system environment variable:

Java VM start option

Description

-Xms

Initial value of the heap area (New area + Old area)

-Xmx

Maximum value of the heap area (New area + Old area)

-Xss

Stack size of the thread

-XX:MetaspaceSize

Standard value for Full GCs that originate in the Metaspace area

-XX:MaxMetaspaceSize

Maximum value of the Metaspace area

If you use a wildcard to specify a path, operations are not guaranteed.

3 Definition file (development environment)

This chapter describes the syntax of the definition files that are used in the development environments of a service platform.

3.1 Types of definition files

The following table lists and describes the types of development environment definition file

Table 3‒1:  List of definition files (Development environment)

Type

File name

Overview

File to be used in TP1 linkage

TP1/RPC reception definition file

Sets up the parameters that control operations such as tuning parameters of TP1/RPC reception.

TP1 adapter environment definition file

Sets up the information required in TP1 adapter environment definition file

TP1 adapter communication configuration definition file

Defines required information in TP1 adapter communication configuration definition.

File to be used in FTP linkage

FTP reception definition file

Sets up the contents for which setting can be changed after setting up FTP reception.

File operations adapter definition file

Sets up the operating information of file operations adapter.

File to be used in SOAP linkage

SOAP reception definition file

Defines the operation when a user-defined reception (SOAP reception) is invoked in SOAP1.1/1.2 combined mode.

Client definition file

Defines the operation when Web service is invoked from service adapter in SOAP1.1/1.2 combined mode.

File to be used in Object Access adapter

Object Access adapter communication configuration definition file

Sets up the communication definition of Object Access adapter.

File to be used in Message Queue adapter

Message Queue adapter environment-definition file

Sets up the environment definition information of Message Queue adapter.

Message Queue adapter communication-configuration definition file

Sets up the communication definition of Message Queue adapter.

File to be used in Message Queue reception

Message Queue reception definition file

Sets up the operating information of Message Queue reception.

File to be used in HTTP adapter

HTTP adapter definition file

Sets up the operating information of HTTP adapter.

File used for HTTP reception

HTTP response header definition file

Sets up the HTTP response header information which is to be used as the default value when the response message format of HTTP reception (for header variable) is omitted

HTTP-reception service-selection definition file

Specifies the information for a business process to be invoked from HTTP reception of a user-defined reception (invocation target selected) and the invocation condition.

HTTP reception definition file

Sets up the operating information of HTTP reception.

File used for file event linkage

File-event-reception definition file

Specifies the operating information of file event reception.

File used for transformation between JSON format data and XML format data

JSON-XML transformation definition file

Specifies the JSON-XML transformation operations.

This file is used by the JSON transformation tools (cscjson2xsd command and cscjsonxmlconv command).

Files used for data-transformation unit test commands

Data-transformation command properties file

Specifies the same information as that for the csctransform command arguments by using the property format.

System properties file for data transformation

Specifies the system properties for data transformation in Service Platform.

The file that has been set up can be specified when the cscbinaryparse command, csctransform command, or cscgenbinary command is executed.

Binary-message-generation command properties file

Specifies the same information as that for the cscgenbinary command arguments by using the property format.

Binary-message-generation definition file

Sets a new value when an element value of a simple content element is to be changed from the default value.

Binary-parse command properties file

Specifies the same information as that for the cscbinaryparse command arguments by using the property format.

3.2 Input format of definition file

Create or edit the definition files, except for some elements, listed in Table 3-1 in the following Java property file format.

Format

The input format of definition files is as follows:

key-name = value

#comment

The following describes each item. Use the ISO-8859-1 character encoding for each item.

Key name

Specify the key name to be defined.

Value

Specify a value, if any, you want to define. Because the string up to the linefeed is considered as a value, you cannot specify strings such as spaces or comments after the value.

Comment

A line that begins with a hash mark (#) is treated as a comment.

3.3 Description format of definition file syntax

This chapter describes the syntax of definition files coded hereafter in the below format. Note that not all the files are coded in this format. In addition to the following items, information specific to individual files might also be provided.

Format

Indicates the format for describing a file.

Function

Describes the function of a file.

File storage location

Indicates the location where a file is stored.

Specifiable elements

Describes the XML elements that can be specified in a file.

Specifiable parameters

Describes the parameters that can be specified in a file.

Specifiable properties

Describes the properties that can be specified in a file. Italic characters in a property name indicate variables.

Example of coding

Indicates a coding example for the file contents.

Notes

Provides notes on setting up and using a file.

The following table lists and describes the symbols used in syntax explanations in this chapter.

Symbol

Convention

|

In syntax explanations, a vertical bar separates multiple items, and has the meaning of OR.

For example: A|B|C means A, or B, or C.

{ }

In syntax explanations, curly brackets indicate that only one of the enclosed items is to be selected. If the items are arranged horizontally and separated by a vertical bar (|), select one of the items.

For example: {A|B|C} means only one of A, or B, or C.

[ ]

In syntax explanations, square brackets indicate that the enclosed item or items are optional.

For example: [A] means that you can specify A or nothing.

Italics

In syntax explanations, italic characters indicate an element that must be specified.

For example: property means that you must specify a property.

...

In coding, an ellipsis (...) indicates that one or more lines of coding have been omitted.

For example: ABC ... means that the coding after ABC has been omitted.

~

In syntax explanations, a swung dash (~) indicates that the items preceding the swung dash comply with the rules mentioned in < >, (( )), and << >> following the swung dash.

< >

In syntax explanations, angle brackets indicate the syntax elements that must be complied with when items are coded. For details on syntax elements, see the following table.

(( ))

In syntax explanations, double-parentheses indicate the range of values that you can specify for an item.

<< >>

In syntax explanations, double-angle brackets indicate the default value that the system assumes when an item is omitted.

The following table lists the types and definitions of the syntax elements used in this chapter.

Type

Definition

Alphabetic characters

A to Z, a to z

Lowercase alphabetic characters

a to z

Uppercase alphabetic characters

A to Z

Numeric characters

0 to 9

Alphanumeric characters

A to Z, a to z, 0 to 9

Symbols

_, ., -

Character string

An array of strings

3.4 File to be used in TP1 linkage

INTENTIONALLY DELETED

3.5 File to be used in FTP linkage

3.5.1 FTP reception definition file

(1) Format

[urecp-ftp.resource-adapter=Display name of the FTP inbound adapter used by reception process]
[urecp-ftp.pooled-instance.minimum=Minimum number of instances within the custom reception framework pool]
[urecp-ftp.pooled-instance.maximum=Maximum number of instances within the pool of reception process and custom reception framework]
[urecp-ftp.ejb-transaction-timeout=Timeout period for EJB transaction of reception process and custom reception framework]
[urecp-ftp.work-dir.auto-delete={true|false}]
[urecp-ftp.common-dir-file.auto-delete={true|false}]
[urecp-ftp.list-command-path-extraction={true|false}]

(2) Function

Set up the setting contents that can be changed after setting up FTP reception. When FTP reception starts, the contents set up in FTP reception definition file becomes valid

Note that if FTP reception definition file for FTP reception is not set up, default values are assumed for all the properties that can be set in the FTP reception definition file. In that case, message KDEC00410-W is output at the time of deploying FTP reception and during the start of FTP reception.

FTP reception definition file is created with the file name "cscurecpftp.properties". If the definition file is created with a file name other than "cscurecpftp.properties", then that file will be ignored.

(3) File storage location

<Service platform installation directory>\CSC\config\ftprecp\templates\cscurecpftp.properties

(4) Specifiable properties

Display name of the FTP inbound adapter that is used by urecp-ftp.resource-adapter=reception process ~<one-byte alphanumeric characters and underscore (_)> ((0-240 characters)) <<Value set in the display-name tag of Connector attribute file>>

Specify the display name of the FTP inbound adapter that is used by reception process. The display name is case sensitive. You can omit this property.

Here you must specify the setting value of the display name tag of Connector attribute file.

If you omit this property or if you do not specify any value for this property, the value check process is not carried out during the implementation of operating command and command control (MBean).

urecp-ftp.pooled-instance.minimum=Minimum number of instances in the pool of custom reception framework ~<Number> ((0-2147483647))<<0>>

Specify the minimum number of instances in the pool of custom reception framework. Note that the minimum number of instances in the pool of reception processing is a fixed value. No changes can be made in this property.

Set this value lower than the value of urecp-ftp.pooled-instance.maximum property (maximum number of instances in reception process and in the pool of custom reception framework).

If you omit this property or if you do not specify any value for this property, the value check process is not carried out during the implementation of operating command and command control (MBean). Also during the implementation of command control (MBean), value is not applied to an element for HITACHI application integrated property file for FTP reception custom adapter.

urecp-ftp.pooled-instance.maximum=Maximum number of instances in the pool of reception process and custom reception framework ~<Number> ((0-2147483647))<<0>>

Specify the maximum number of instances in the pool of reception process and custom reception framework.

Set a value larger than the value of urecp-ftp.pooled-instance.minimum property (Minimum number of instances in the pool of custom reception framework).

If you specify 0, the maximum number of instances set up in reception process and in the pool of custom reception framework is 1.

If you omit this property or if you do not specify any value for this property, the value check process is not carried out during the implementation of operating command and command control (MBean). Also, during the implementation of command control (MBean), value is not applied to an element for HITACHI application integrated property file for custom adapter of FTP reception.

urecp-ftp.ejb-transaction-timeout=Timeout duration for EJB transaction of reception process and custom reception framework ~<Number>((0-2147483647))<<0>>

Specify the timeout duration for EJB transaction of reception process and custom reception framework in the unit of seconds. If you specify 0, operation is performed with the default timeout value set up in J2EE server.

If you omit this property or if you do not specify any value for this property, the value check process is not carried out during the implementation of operating command and command control (MBean). Also, during the implementation of command control (MBean), value is not applied to an element for HITACHI application integrated property file for custom adapter of FTP reception.

If you specify a value other than numeric value or a value outside the range, an error occurs during the implementation of operating command and command control (MBean).

urecp-ftp.work-dir.auto-delete={true|false} ~<<true>>

Specify if work folder is to be deleted automatically by FTP reception.

true

Work folder is automatically deleted in FTP reception. After FTP reception has received the response from business process, and FTP reception process is successfully completed then work folder is deleted.

false

Does not delete work folder in FTP reception.

Important note

When the business process is asynchronous, you must specify false for this property.

urecp-ftp.common-dir-file.auto-delete={true|false} ~ <<false>>

Specify whether to automatically delete files in the common folder by FTP reception.

true

The files in the common folder are deleted by FTP reception. After FTP reception has received a response from the business process and the FTP reception process is successfully completed, the files are deleted.

false

Files in the common folder are not deleted by FTP reception.

urecp-ftp.list-command-path-extraction={true|false} ~ <<false>>

Specify whether to extract the information-acquisition path information of the GETINFO operation by FTP reception.

true

Information-acquisition path information of the GETINFO operation is extracted by FTP reception.

false

Information-acquisition path information of the GETINFO operation is not extracted by FTP reception.

(5) Example of coding

An example of description is as follows:

urecp-ftp.resource-adapter=FTP_Inbound_Adapter
urecp-ftp.work-dir.auto-delete=true

(6) Notes

If the contents of FTP reception definition file are wrong, an error will occur during the deployment of FTP reception.

3.5.2 File operations adapter definition file

(1) Format

[csc.adapter.fileOperation.transform.splitLoad={ON|OFF}]
[csc.adapter.fileOperation.transform.input={non-xml|xml}]
[csc.adapter.fileOperation.transform.output={non-xml|xml}]
[csc.adapter.fileOperation.transform.format={fixed|separate}]
[csc.adapter.fileOperation.transform.outputTemplateXmlFile=File name of the template XML file for output]

[csc.adapter.fileOperation.transform.headerRecord={ON|OFF}]
[csc.adapter.fileOperation.transform.trailerRecord={ON|OFF}]

[csc.adapter.fileOperation.transform.header.inFormat=Binary format definition file name for header record input]
[csc.adapter.fileOperation.transform.header.outFormat= Binary format definition file name for the header record output]
[csc.adapter.fileOperation.transform.header.inElement=Path of an input XML file element of the corresponding header record]
[csc.adapter.fileOperation.transform.header.outElement= Path of an output XML file element of the corresponding header record]
[csc.adapter.fileOperation.transform.header.styleSheet=XSL file name for header record transformation]
[csc.adapter.fileOperation.transform.header.fixedSize=Fixed length of header record]
[csc.adapter.fileOperation.transform.header.batchSize=Top record number considered as header record during split processing]

[csc.adapter.fileOperation.transform.data.inFormat=Binary format definition file name for data record input]
[csc.adapter.fileOperation.transform.data.outFormat=Binary format definition file name for data record output]
[csc.adapter.fileOperation.transform.data.inElement=Path of an input XML file element corresponding to data code]
[csc.adapter.fileOperation.transform.data.outElement= Path of an output XML file element corresponding to data code]
[csc.adapter.fileOperation.transform.data.styleSheet=XSL file name for data record transformation]
[csc.adapter.fileOperation.transform.data.fixedSize=Fixed length size of data record]
[csc.adapter.fileOperation.transform.data.batchSize=Number of data record transformations at a time]

[csc.adapter.fileOperation.transform.trailer.inFormat=Binary format definition file name for trailer record input]
[csc.adapter.fileOperation.transform.trailer.outFormat=Binary format definition file name for trailer record output]
[csc.adapter.fileOperation.transform.trailer.inElement=Path of an input XML file element corresponding to trailer record]
[csc.adapter.fileOperation.transform.trailer.outElement= Path of an output XML file element corresponding to trailer record]
[csc.adapter.fileOperation.transform.trailer.styleSheet=XSL file name for trailer record transformation]
[csc.adapter.fileOperation.transform.trailer.fixedSize=Fixed length size of trailer record]

[csc.adapter.fileOperation.transform.all.inFormat=Binary format definition file name for the input during batch processing]
[csc.adapter.fileOperation.transform.all.outFormat=Binary format definition file name for the output during batch processing]
[csc.adapter.fileOperation.transform.all.styleSheet=XSL file name for transformation during batch processing]

[csc.adapter.fileOperation.transform.existFile={overwrite|error}]
[csc.adapter.fileOperation.copy.existFile={overwrite|error}]
[csc.adapter.fileOperation.move.existFile={overwrite|error}]
[csc.adapter.fileOperation.compress.existFile={overwrite|error}]
[csc.adapter.fileOperation.extract.existFile={overwrite|error}]
[csc.adapter.fileOperation.writeList.existFile={overwrite|error}]

(2) Function

Set the operating information of file operations adapter.

Create file operations adapter definition file with file name "cscFileOperation.properties".

The contents set in the file operations adapter definition file are enabled when file operations adapter starts.

(3) Specifiable properties

csc.adapter.fileOperation.transform.splitLoad={ON|OFF} ~<<ON>>

Specify if split processing is to be done for each record during file input and output.

ON

Split processing

OFF

Batch processing

If you specify a value other than ON or OFF, batch processing is performed.

csc.adapter.fileOperation.transform.input={non-xml|xml} ~<<non-xml>>

Specify the type of input file.

non-xml

Binary format

xml

XML format

If you specify a value other than non-xml or xml, binary format is considered as the type of input file.

csc.adapter.fileOperation.transform.output={non-xml|xml} ~<<non-xml>>

Specify the type of output file.

non-xml

Binary format

xml

XML format

If you specify a value other than non-xml or xml, binary format is considered as the type of output file.

csc.adapter.fileOperation.transform.format={fixed|separate} ~<<fixed>>

Specify the format of input file.

When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (Batch processing of input file format) or, xml (XML format) in property csc.adapter.fileOperation.transform.input, the specification in this property is ignored.

fixed

Fixed length format

separate

Line feed separator format

If you specify any other value, line feed separator format will be taken as the format of input file.

csc.adapter.fileOperation.transform.outputTemplateXmlFile= File name of the template XML file for output ~<Character string><<cscOutputTemplate.xml>>

Specify the file name of the template XML file for output. You cannot specify a path in this property.

When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (Batch processing of input file format), or non-xml in the property csc.adapter.fileOperation.transform.output (Binary format output file), the specification in this property is ignored.

csc.adapter.fileOperation.transform.headerRecord={ON|OFF} ~<<ON>>

Specify if header record is to be used for file.

When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (Batch processing of input file format), the specification of this property is ignored.

ON

Use header record

OFF

Do not use header record

When you specify a value other than ON or OFF, header record is not used.

csc.adapter.fileOperation.transform.trailerRecord={ON|OFF} ~<<ON>>

Specify if trailer record is to be used for file.

When you specify OFF (Batch processing for input file format) in the property csc.adapter.fileOperation.transform.splitLoad, the specification in this property is ignored.

ON

Use trailer record

OFF

Do not use trailer record

If you specify a value other than ON or OFF, trailer record is not used.

csc.adapter.fileOperation.transform.header.inFormat=Binary format definition file name for header record input ~<Character string>

Specify the binary format definition file name for header record input.

When you specify ON (Use header record for file) in the property csc.adapter.fileOperation.transform.headerRecord, you cannot omit this property.

The specification in this property is ignored if you specify OFF (batch processing of input file format) in the property csc.adapter.fileOperation.transform.splitLoad or specify xml (XML format input file) in the property csc.adapter.fileOperation.transform.input.

csc.adapter.fileOperation.transform.header.outFormat=Binary format definition file name for header record output ~<Character string>

Specify the binary format definition file name for header record output.

When you specify ON in the property csc.adapter.fileOperation.transform.headerRecord (use header record for file), you cannot omit this property.

When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (Batch processing of input file format), or xml in the property csc.adapter.fileOperation.transform.output (XML format output file), the specification in this property is ignored.

csc.adapter.fileOperation.transform.header.inElement= Path of an input XML file element of the corresponding header record ~<Character string>

Specify the path of an input XML file element of the corresponding header record, in the following format.

Path of element ::= ( '/' [ '{' namespace URI '}' ] Element name)+

You cannot omit this property when input file is in XML format and, you have specified ON in the property csc.adapter.fileOperation.transform.headerRecord (use header record for file).

When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (Batch processing of input file format), or non-xml in the property csc.adapter.fileOperation.transform.input (Input file in binary format), the specification in this property is ignored.

Error occurs, if the path specified in this property overlaps with the path of the element specified in the properties, csc.adapter.fileOperation.transform.data.inElement or csc.adapter.fileOperation.transform.trailer.inElement.

csc.adapter.fileOperation.transform.header.outElement= Path of an output XML file element of the corresponding header record~<Character string>

Specify the path for the element in output XML file of the corresponding header record, in the following format.

Path of element::= ( '/' [ '{' namespace URI '}' ] element name)+

You cannot omit this property if the input file is XML format and ON (use header record for file) is specified in the property csc.adapter.fileOperation.transform.headerRecord.

When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (Batch processing of input file format) or, non-xml in the property csc.adapter.fileOperation.transform.output (Binary format output file), the specification in this property is ignored.

Error occurs, if the path specified in this property overlaps with the path specified in either of the properties, csc.adapter.fileOperation.transform.data.outElement or csc.adapter.fileOperation.transform.trailer.outElement.

csc.adapter.fileOperation.transform.header.styleSheet=XSL file name for header record transformation ~<Character string>

Specify XSL file name (user can specify any name) for header record transformation. You cannot omit this property when you have specified ON in the property csc.adapter.fileOperation.transform.headerRecord (use header record for file).

When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (Batch processing of input file format), the specification in this property is ignored.

csc.adapter.fileOperation.transform.header.fixedSize=Fixed length size of header record ~<Number>((from 1 to 2147483647))

Specify a fixed length for header record (Unit: bytes). You cannot omit this property when both of the following properties are set.

Value of property csc.adapter.fileOperation.transform.format is fixed (Input file format with fixed length)

Value of property csc.adapter.fileOperation.transform.headerRecord is ON (use header record)

When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (Batch processing of input file format) or, xml in the property csc.adapter.fileOperation.transform.input (Input file in XML format), the specification in this property is ignored. You can omit this property if separate (input file in linefeed separator format) is specified in the property csc.adapter.fileOperation.transform.format.

csc.adapter.fileOperation.transform.header.batchSize= Top record number considered as header record during split processing ~<Number>((0-524288000))<<0>>

Specify the number of records in the beginning which are to be considered as header record in the split processing method. When you specify 0, 1 record is considered as header record.

The treatment of linefeed characters is different when you specify 0 and when you specify a value between 1 and 524288000 in this property

When you specify 0 (also when you do not specify a value, or specify an invalid value or an outside of range value)

The end of header record is judged by line feed characters (LF: 0x0a or CRLF: 0x0d 0x0a). The part excluding the line feed characters from header record, is transformed as 1 record.

When you specify a value between 1 and 524288000

The header record separator is determined by line feed characters (LF: 0x0a or CRLF: 0x0d 0x0a). The header record is transformed including the line feed characters.

The specification in this property is ignored if any of the following conditions is applicable:

Value of the property csc.adapter.fileOperation.transform.splitLoad is OFF (batch processing of input file format)

Value of the property csc.adapter.fileOperation.transform.input is xml (input file in XML format)

Value of the property csc.adapter.fileOperation.transform.format is fixed (input file format is fixed)

Value of the property csc.adapter.fileOperation.transform.headerRecord is OFF (do not use header record)

csc.adapter.fileOperation.transform.data.inFormat=Binary format definition file name for data record input ~<Character string>

Specify the binary format definition file name for data record input.

When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format) or, xml in the property csc.adapter.fileOperation.transform.input (Input file in XML format), the specification in this property is ignored.

csc.adapter.fileOperation.transform.data.outFormat=Binary format definition file name for data record output ~<Character string>

Specify the binary format definition file name for data record output.

When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format) or, xml in the property csc.adapter.fileOperation.transform. output (output file in XML format), the specification in this property is ignored.

csc.adapter.fileOperation.transform.data.inElement= Path of an input XML file element corresponding to data code ~<Character string>

Specify the path of the element in the input XML file corresponding to data record, in the following format.

Path of element ::= ( '/' [ '{' namespace URI '}' ] element name)+

When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format), or non-xml in the property csc.adapter.fileOperation.transform.input (binary format input file), the specification in this property is ignored.

Error occurs, if the path specified in this property overlaps with the path specified in either of the properties, csc.adapter.fileOperation.transform.header.inElement or csc.adapter.fileOperation.transform.trailer.inElement.

csc.adapter.fileOperation.transform.data.outElement= Path of an output XML file element corresponding to data code ~<Character string>

Specify path for the element in output XML file of the corresponding data record, in following format.

Path of element ::= ( '/' [ '{' namespace URI '}' ] element name)+

When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (Batch processing of input file format), or non-xml in the property csc.adapter.fileOperation.transform.output (output file in binary format), the specification in this property will be ignored.

Error occurs, if the path specified in this property overlaps with the path specified in either of the properties, csc.adapter.fileOperation.transform.header.outElement or csc.adapter.fileOperation.transform.trailer.outElement.

csc.adapter.fileOperation.transform.data.styleSheet=XSL file name for data record transformation ~<Character string>

Specify the XSL file name for data record transformation (user can specify any name). When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format), the specification in this property is ignored.

csc.adapter.fileOperation.transform.data.fixedSize=Fixed length size of data record ~<Number>((Between 1 and 2147483647))

Specify the fixed length for data record (Unit: bytes). When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format), or xml in the property csc.adapter.fileOperation.transform.input (input file in XML format), the specification in this property is ignored. You can omit this property if separate (input file in linefeed separator format) is specified in the property csc.adapter.fileOperation.transform.format.

csc.adapter.fileOperation.transform.data.batchSize=Number of one time data record transformations~<Number>((Between 0 and 524288000))<<0>>

Specify the count at which data records are to be transformed every time. If quantity of data per record is smaller and you transform multiple records concurrently, instead of transforming one record at a time, the transformation performance might improve. For details see "8.7.3 File conversion operation" in "Service Platform Overview".

When you specify 0, one record is transformed at a time (transformation process for small data)

When you specify 1 or more in this property, the transformation process is optimized for large scale data.

csc.adapter.fileOperation.transform.trailer.inFormat=Binary format definition file name for trailer record input ~<Character string>

Specify the binary format definition file name for trailer record input.

You cannot omit this property when you have specified ON in the property csc.adapter.fileOperation.transform.trailerRecord (use trailer record for file).

When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format), or xml in the property csc.adapter.fileOperation.transform.input (input file in XML format), the specification in this property is ignored.

csc.adapter.fileOperation.transform.trailer.outFormat= Binary format definition file name for trailer record output ~<Character string>

Specify the binary format definition file name for trailer record output.

You cannot omit this property when you have specified ON in the property csc.adapter.fileOperation.transform.trailerRecord (use trailer record for file).

When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format), or xml in the property csc.adapter.fileOperation.transform.output (output file in XML format), the specification in this property is ignored.

csc.adapter.fileOperation.transform.trailer.inElement= Path of an input XML file element corresponding to trailer record ~<Character string>

Specify path for the element in the input XML file of the corresponding trailer record, in following format.

Path of element ::= ( '/' [ '{' namespace URI '}' ] element name)+

You cannot omit this property when you have specified ON in the property csc.adapter.fileOperation.transform.trailerRecord (use trailer record for file).

When if you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format), or non-xml in the property csc.adapter.fileOperation.transform.input (input file in binary format), the specification in this property is ignored.

There will be an error if the path specified in this property overlaps with the path specified either of the properties csc.adapter.fileOperation.transform.header.inElement or csc.adapter.fileOperation.transform.data.inElement.

csc.adapter.fileOperation.transform.trailer.outElement= Path of an output XML file element corresponding to trailer record ~<Character string>

Specify the path for element in the output XML file of the corresponding trailer record, in the following format.

Path of element::= ( '/' [ '{' Namespace URI '}' ] Element name)+

You cannot omit this property when you have specified ON in the property csc.adapter.fileOperation.transform.trailerRecord (use trailer record for file).

When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format), or non-xml in the property csc.adapter.fileOperation.transform.output (output file in binary format), the specification in this property is ignored.

Error occurs if the path specified in this property overlaps with the path specified either of the properties csc.adapter.fileOperation.transform.header.outElement or csc.adapter.fileOperation.transform.data.outElement.

csc.adapter.fileOperation.transform.trailer.styleSheet=XSL file name for trailer record transformation ~<Character string>

Specify the XSL file name for trailer record transformation (user can specify any name).

You cannot omit this property when you have specified ON in the property csc.adapter.fileOperation.transform.trailerRecord (use trailer record for file).

When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format), the specification in this property is ignored.

csc.adapter.fileOperation.transform.trailer.fixedSize=Fixed length size of trailer record ~<Number>((between 1 and 2147483647))

Specify a fixed length for trailer record (unit: bytes). You cannot omit this property when both of the following properties are set as follows:

Value of the property csc.adapter.fileOperation.transform.format is fixed (Input file format with fixed length)

Value of the property csc.adapter.fileOperation.transform.trailerRecord is ON (use trailer record)

When you specify OFF in the property csc.adapter.fileOperation.transform.splitLoad (batch processing of input file format), or xml in the property csc.adapter.fileOperation.transform.input (input file in XML format), the specification in this property is ignored. You cannot omit this property when separate is specified in the property csc.adapter.fileOperation.transform.format.

csc.adapter.fileOperation.transform.all.inFormat=Binary format definition file name for input during batch processing ~<Character string)

Specify the binary format definition file name for input during batch processing, in the following format.

When you specify ON in the property csc.adapter.fileOperation.transform.splitLoad (Split processing of input file format), or xml in the property csc.adapter.fileOperation.transform.input (input file in XML format), the specification in this property will be ignored.

csc.adapter.fileOperation.transform.all.outFormat= Binary format definition file name for output during batch processing ~<Character string)

Specify the binary format definition file name for output during batch processing, in the following format.

When you specify ON in the property csc.adapter.fileOperation.transform.splitLoad (Split processing of input file format), or xml in the property csc.adapter.fileOperation.transform. output (output file in XML format), the specification in this property is ignored.

csc.adapter.fileOperation.transform.all.styleSheet=XSL file name for transformation during batch processing ~<Character string>

Specify XSL file name for transformation during batch processing (user can specify any name).

When you specify ON in the property csc.adapter.fileOperation.transform.splitLoad (split processing of input file format), the specification in this property is ignored.

csc.adapter.fileOperation.transform.existFile={overwrite|error} ~<<overwrite>>

If there is a file with the same name as that of the file to be output after file transformation, specify whether you want to overwrite.

overwrite

Overwrites to the existing contents of the file

error

Cancels file transformation and issues an exception

If you specify value other than overwrite or error, system aborts file transformation and issues an exception.

csc.adapter.fileOperation.copy.existFile={overwrite|error} ~<<overwrite>>

If a file with the same name exists at the time of copying a file, specify whether you want to overwrite.

overwrite

Overwrite to the existing contents of the file

error

Cancels copy operation and issues an exception

If you specify a value other than overwrite or error, system aborts the copy operation and issues an exception.

csc.adapter.fileOperation.move.existFile={overwrite|error} ~<<overwrite>>

Specify whether to overwrite any existing file that has the same name as that of the file to be output during the move file operation.

overwrite

Overwrites the existing contents of the file.

error

Cancels the move operation and issues an exception.

If you specify a value other than overwrite or error, the system cancels the move operation and issues an exception.

csc.adapter.fileOperation.compress.existFile={overwrite|error} ~<<overwrite>>

If there is a file with the same name as that of the file to be output during file compression operation, specify whether you want to overwrite.

overwrite

Overwrites with compression to the existing contents of the file

error

Cancels compression and issues an exception

If you have specified any value other than overwrite or error, the system aborts compression and issues an exception.

csc.adapter.fileOperation.extract.existFile={overwrite|error} ~<<overwrite>>

If there is a file with the same name as that of the file to be output during file extraction operation, specify whether you want to overwrite.

overwrite

Overwrites with extraction to the existing contents of the file

error

Aborts extraction and issues exception

If you specify a value other than overwrite or error, the system issues an exception.

csc.adapter.fileOperation. writeList.existFile={overwrite|error} ~<<overwrite>>

Specify whether to overwrite any existing file that has the same name as that of the file to be output during the file list write operation.

overwrite

Overwrites the existing contents of the file.

error

Cancels the list write operation and issues an exception

If you specify a value other than overwrite or error, the system cancels the list write operation and issues an exception.

(4) Example of coding

A description example is shown as follows:

csc.adapter.fileOperation.transform.splitLoad=on
csc.adapter.fileOperation.transform.format=fixed
csc.adapter.fileOperation.transform.header.inFormat=in_hdr.fdx
csc.adapter.fileOperation.transform.header.outFormat=out_hdr.fdx
csc.adapter.fileOperation.transform.header.styleSheet=trans_hdr.xsl
csc.adapter.fileOperation.transform.header.fixedSize=64
  :

3.6 File to be used in SOAP linkage

3.6.1 SOAP reception definition file

(1) Format

[urecp-soap.switchover.file-transfer.mode={true|false}]

(2) Function

Defines the operation when a user-defined reception (SOAP reception) is invoked in SOAP1.1/1.2 combined mode. The settings are enabled when a user-defined reception (SOAP reception) starts. If the file contains an invalid definition, an error occurs during initialization processing but the start command ends normally. For details about operations during initialization of Web Services, see 10.9 Initializing and destroying the Web Service in the Application Server Web Service Development Guide.

Note that if a SOAP reception definition file is not set up for a user-defined reception (SOAP reception), the default values are assumed for all properties that can be specified in the SOAP reception definition file.

Create the SOAP reception definition file with the file name cscurecpsoap.properties.

(3) File storage location

service-platform-installation-directory\CSC\config\soaprecp\templates\cscurecpsoap.properties

Important note

The file stored here is a template file. To edit the SOAP reception definition file, click the Edit button for Self-defined file in the User-Defined Reception Definition window (detailed) when adding a user-defined reception (SOAP reception), and then modify the contents of definition file.

(4) Specifiable parameters

urecp-soap.switchover.file-transfer.mode={true|false} ~ <<false>>

Specify whether a work folder is to be created by SOAP reception when a request is received. This property is not case sensitive.

This property is valid for requests that contain no attachments. A work folder is always created if a request contains an attachment.

true

A work folder is created no matter whether the request contains an attachment. Note that the created work folder cannot be deleted in SOAP reception.

false

A work folder is created if the request contains an attachment. A work folder is not created in any other case.

(5) Example of coding

An example of coding is as follows.

urecp-soap.switchover.file-transfer.mode=true

3.6.2 Client definition file

(1) Format

[com.cosminexus.csc.connect.timeout=Connection-timeout-value]
[com.cosminexus.csc.request.timeout=Read-timeout-value]
[com.cosminexus.csc.session.maintain={true | false}]
[com.cosminexus.csc.auto-delete-incomplete-file={true | false}]
[com.cosminexus.csc.file.read-lock.retry.count=lock-retry-count]
[com.cosminexus.csc.file.read-lock.retry.interval=lock-retry-interval]

(2) Function

Define operations when a Web service is invoked from the service adapter in SOAP1.1/1.2 combined mode. The setting is enabled, when the service adapter starts.

The client definition file is created by the file name cscwsconf.properties.

(3) Specifiable parameters

com.cosminexus.csc.connect.timeout=Connection-timeout-value~~<numeric>((0-86400))<<60>>

Specify the connection timeout value of the socket in seconds units while accessing service components from the Web Service adapter. If you specify 0, a timeout does not occur. The timeout value specified by this property is applicable while invoking the Web Service.

com.cosminexus.csc.request.timeout=Read-timeout-value~~<numeric> ((0-86400))<<300>>

Specify the read timeout value of the socket in seconds units while accessing service components from the Web Service adapter. If you specify 0, a timeout does not occur. The timeout value specified by this property is applicable while invoking the Web Service.

com.cosminexus.csc.session.maintain={true | false} ~~<<false>>

Specify the existence of HTTP session support.

true

Session is supported.

false

Session is not supported.

com.cosminexus.csc.auto-delete-incomplete-file={true|false} ~ <<true>>

Specify whether to automatically delete the incomplete files which are generated due to an error during output of files to a work folder or common folder after the SOAP adapter has received attachments from a service component.

true

Incomplete files are automatically deleted.

false

Incomplete files are not automatically deleted.

com.cosminexus.csc.file.read-lock.retry.count =lock-retry-count ~ <Numeric> ((0-1024))<<0>>

Specify the number of times the lock is to be retried when an attempt to acquire a shared lock for files in the common folder fails.

com.cosminexus.csc.file.read-lock.retry.interval =lock-retry-interval ~ <Number>((1-1024))<<1>>

Specify, in seconds, the interval between lock retries when an attempt to acquire a shared lock for files in the common folder fails.

(4) Example of coding

com.cosminexus.csc.connect.timeout=120
com.cosminexus.csc.request.timeout=480
com.cosminexus.csc.session.maintain=false
com.cosminexus.csc.auto-delete-incomplete-file=true
com.cosminexus.csc.file.read-lock.retry.count=5
com.cosminexus.csc.file.read-lock.retry.interval=1

(5) Notes

Multiple descriptions of the same property must not be made. In such cases, validity of values is not guaranteed.

3.7 File to be used in Object Access adapter

INTENTIONALLY DELETED

3.8 File to be used in Message Queue adapter

3.8.1 Message Queue adapter environment-definition file

(1) Format

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
  <entry key="adpmq_deffile">Message-Queue-adapter-communication-configuration-definition-file-name</entry>
</properties>

(2) Function

Specifies the environment definition information for a Message Queue adapter in XML format.

Use the following procedure to create a Message Queue adapter environment-definition file and apply it to the runtime environment:

Copy the following template file to any directory, and then define the Message Queue adapter environment-definition file:

service-platform-installation-directory\CSC\custom-adapter\MQ\config\templates\customadapter_properties.xml

Save the edited file with the file name customadapter_properties.xml.

Package the defined Message Queue adapter environment-definition file in the HCSC development environment, and then import the package to the runtime environment.

If you have changed the definitions in the Message Queue adapter environment-definition file, perform step 2 to import the file to the runtime environment.

(3) Specifiable elements

<?xml version="1.0" encoding="UTF-8"?>

An XML declaration indicating that this file is an XML file

<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">

An element-type definition declaration indicating a DTD subset

<properties>

The root element of the Message Queue adapter environment definition

<entry key="adpmq_deffile"> ~ Message-Queue-adapter-communication-configuration-definition-file-name

An element that specifies the name of the Message Queue adapter communication-configuration definition file. For the value of this element, specify the name of the Message Queue adapter communication-configuration definition file in which the communication configuration in a runtime environment is specified. For details about the Message Queue adapter communication-configuration definition file, see 3.8.2 Message Queue adapter communication-configuration definition file.

3.8.2 Message Queue adapter communication-configuration definition file

(1) Format

(2) Function

Specifies the communication definition of a Message Queue in XML format. The types of communication definitions are as follows:

Operation definition for sending messages

Operation definition for receiving messages

Operation definition for sending and receiving messages

Operation definition for receiving browsed messages

Use the following procedure to create a Message Queue adapter communication-configuration definition file, and then apply it to the runtime environment.

Copy the following template file to any directory, and then define the Message Queue adapter communication-configuration definition file:

service-platform-installation-directory\CSC\custom-adapter\MQ\config\templates\adpmq_communication.xml

Save the edited file with any file name.

Package the file in the HCSC development environment, and then import the package to the runtime environment.

The name of the Message Queue adapter communication-configuration definition file you created must be specified as the value of the <entry key="adpmq_deffile"> element in the Message Queue adapter environment-definition file. For details, see 3.8.1 Message Queue adapter environment-definition file.

If you have changed the definitions in the Message Queue adapter communication-configuration definition file, perform step2 to import the file to the runtime environment.

(3) Specifiable elements

<?xml version="1.0" encoding="UTF-8"?>

An XML declaration indicating that this file is an XML file.

<adaptermq_properties>

The root element of the Message Queue adapter communication-configuration definition.

<res_ref_name> ~ <alphanumeric characters and level separators> ((1-255 bytes))

Specifies the resource adapter specific information. For the value of this element, specify the same value as the <res-ref-name> element including jms/, contained in <hitachi-session-bean-property> in the HITACHI Application Integrated Property File. You cannot omit this specification.

For definition items that must match the values specified in the HITACHI Application Integrated Property File, see the description of how to specify the HITACHI Application Integrated Property File in the uCosminexus Application Server Application and Resource Definition Reference Guide.

<operation>

The operation element. You can specify this element as many times as the number of operations. You cannot omit this specification.

<op_name> ~ <alphanumeric characters> ((1-256 bytes))

This element specifies an operation name. For the value of this element, specify the operation name that is to be specified for the HCSC development environment. You cannot omit this specification.

<char_code> ~{UTF8|UTF16_BIG|UTF16_LITTLE|MS932|JIS|KEIS+EBCDIC|KEIS+EBCDIK}<<UTF8>>

Specifies a character code when transmission queue specific information and reception queue specific information are specified for a binary-format message that requests message transmission or reception. You can omit this specification.

<send_operation>

This element specifies message transmission. You can omit this specification.

You must specify this element when you specify a message transmission definition.

<receive_operation>

This element specifies message reception. You can omit this specification.

You must specify this element when you specify a message reception definition.

<sndrcv_operation>

This element specifies message transmission and reception. You can omit this specification.

You must specify this element when you specify a message transmission and reception definition.

<browse_operation>

This element specifies browsed message reception. You can omit this specification.

You must specify this element when you specify a browsed message reception definition.

<res_name> ~ <alphanumeric characters and level separators> ((1-255 bytes)) <<request message setting information>>

Specifies transmission queue specific information or reception queue specific information. For the value of this element, specify the same value as the <resource-env-ref-name> element contained in <hitachi-session-bean-property> in the HITACHI Application Integrated Property File.

You can omit this specification if you specify transmission queue specific information or reception queue specific information for request messages.

For definition items that must match the values specified in the HITACHI Application Integrated Property File, see the description of how to specify the HITACHI Application Integrated Property File in the uCosminexus Application Server Application and Resource Definition Reference Guide.

<res_inf>

When you execute a request for sending and receiving messages, specify the transmission queue specific information (<snd_res_name>) and reception queue specific information (<rcv_res_name>) elements. You can omit this specification.

When you specify this element, you must specify both transmission queue specific information and reception queue specific information. Specification of only one of them is not possible.

<snd_res_name> ~ <alphanumeric characters and level separators> ((1-255 bytes)) <<request message setting information>>

Specifies the transmission queue specific information. For the value of this element, specify the same value as the <resource-env-ref-name> element contained in <hitachi-session-bean-property> in the HITACHI Application Integrated Property File.

You can omit this specification if you specify transmission queue specific information for request messages.

For definition items that must match the values specified in the HITACHI Application Integrated Property File, see the description of how to specify the HITACHI Application Integrated Property File in the uCosminexus Application Server Application and Resource Definition Reference Guide.

<rcv_res_name> ~ <alphanumeric characters and level separators> ((1-255 bytes)) <<request message setting information>>

Specifies the reception queue specific information. For the value of this element, specify the same value as the <resource-env-ref-name> element contained in <hitachi-session-bean-property> in the HITACHI Application Integrated Property File.

You can omit this specification if you specify reception queue specific information for request messages.

For definition items that must match the values specified in the HITACHI Application Integrated Property File, see the description of how to specify the HITACHI Application Integrated Property File in the uCosminexus Application Server Application and Resource Definition Reference Guide.

<id_type> ~ {Type1 | Type2} <<Type1>>

Select either of the following options to specify whether to set a message correlation identifier. You can omit this specification.

Type1

A message correlation identifier is not set.

Type2

A message correlation identifier is set.

The operation for a message transmission request is different from the operation for a message reception or browsed message request, as shown below.

Value

Message transmission request

Message reception or browsed message reception request

Type1

The message is sent without a message correlation identifier set.

The message is received without a message correlation identifier set.

Type2

The message is sent with the message correlation identifier set for JMSCorrelationID. The message identifier is automatically created by the Message Queue adapter.

The message is received with the user-defined message identifier (CorrelationID) set.

<message_type> ~ {BytesMessage | TextMessage} <<BytesMessage>>

Specifies the transmission message type. You can omit this specification.

BytesMessage

The message is sent by using javax.jms.BytesMessage.

TextMessage

The message is sent by using javax.jms.TextMessage. However, an error occurs if the message transmission request (request message) is in binary format.

<JMSDeliveryMode> ~ {PERSISTENT|NONPERSISTENT} <<PERSISTENT>>

Specify whether sent messages are persistent. You can omit this specification.

PERSISTENT

Messages are persistent. After the queue manager restarts, the messages remain in the transmission queue.

NONPERSISTENT

Messages are not persistent. After the queue manager restarts, the messages do not remain in the transmission queue.

<JMSExpiration> ~ <numeric character> ((0-65535000)) <<0>>

Specify, in milliseconds, the retention time of messages to be sent. You can omit this specification.

If you omit this property or specify 0, messages will be retained in the transmission queue until they are obtained.

If you specify a value of less than 1 second, the value might be interpreted as 0 milliseconds. Check the JMS provider specifications.

<JMSType> ~ <alphanumeric characters>

Specifies a message type. For the value of this element, specify the message type that identifies a message to be sent or received. You can omit this specification.

This specification is invalid if you specify MQ for targetClient of the Queue property of the resource adapter.

<JMSCorrelID_PFX> ~ <alphanumeric characters> ((1-6 bytes))

Specifies the prefix of a message correlation identifier (CorrelationID). You can omit this specification.

For the value of this element, specify the prefix of a message correlation identifier. The value of this element takes effect if Type2 is selected for the <id_type> element of a message transmission or reception request.

<receive_timeout> ~ <numeric character> ((1000-65535000)) <<180000>>

Specify, in milliseconds, the message response monitoring time. You can omit this specification.

For the value of this element, specify the period of time until the reception of a message is completed. If a message cannot be received within the time specified for this element, fault response information returns.

(4) Example of coding

If you want to omit the value of an element, you must also omit the start and end tags of that element. If you specify only the start and end tags, you cannot omit the value or change the order of definitions between the tags.

Correct description

    :
<JMSExpiration>0</JMSExpiration>
<JMSDeliveryMode>PERSISTENT</JMSDeliveryMode>
    :

Incorrect description (No value is specified for <JMSDeliveryMode>)

    :
<JMSExpiration>0</JMSExpiration>
<JMSDeliveryMode></JMSDeliveryMode>
    :

3.9 Message QueueFile to be used in Message Queue reception

3.9.1 Message Queue reception definition file

(1) Format

  resource-adapter=display-name-of-the-MQ-resource-adapter-used-by-Message-Queue-reception
[pooled-instance.minimum=minimum-number-of-instances-within-the-custom-reception-framework-pool]
[pooled-instance.maximum=maximum-number-of-instances-within-the-pool-of-Message-Queue-reception-and-custom-reception-framework]
[ejb-transaction-timeout=timeout-period-for-EJB-transaction-of-Message-Queue-reception-and-custom-reception-framework]
  activation-config.destination=message-destination
  activation-config.username=default-user-name-for-connecting-the-queue-manager
[activation-config.ccdtURL=property-value]
[activation-config.CCSID=property-value]
[activation-config.channel=property-value]
[activation-config.clientID=property-value]
[activation-config.failIfQuiesce=property-value]
[activation-config.headerCompression=property-value]
[activation-config.hostName=property-value]
[activation-config.localAddress=property-value]
[activation-config.messageBatchSize=property-value]
[activation-config.messageCompression=property-value]
[activation-config.messageRetention=property-value]
[activation-config.password=property-value]
[activation-config.pollingInterval=property-value]
[activation-config.port=property-value]
[activation-config.providerVersion=property-value]
[activation-config.queueManager=property-value]
[activation-config.rescanInterval=property-value]
[activation-config.shareConvAllowed=property-value]
[activation-config.transportType=property-value]
[activation-config.maxMessages=property-value]
[activation-config.maxPoolDepth=property-value]
[activation-config.messageSelector=property-value]
[activation-config.poolTimeout=property-value]
[activation-config.readAheadAllowed=property-value]
[activation-config.readAheadClosePolicy=property-value]
[activation-config.startTimeout=property-value]
[activation-config.useJNDI=property-value]

(2) Function

Specifies the operation information for Message Queue reception.

When Message Queue reception starts, the contents specified in the Message Queue reception definition file become valid.

Note that if a Message Queue reception definition file for Message Queue reception has not been set up, an error occurs when Message Queue reception is deployed.

A Message Queue reception definition file must be created with the file name cscurecpmq.properties. A Message Queue reception definition file created with a file name other than cscurecpmq.properties will be ignored.

(3) File storage location

service-platform-installation-directory\CSC\custom-reception\mq\config\templates\cscurecpmq.properties

(4) Specifiable properties

resource-adapter=display-name-of-the-MQ-resource-adapter-used-by-Message-Queue-reception ~ <alphanumeric characters and underscores (_)> ((1-240 characters))

Specify the display name of the MQ resource adapter that is used by Message Queue reception.

pooled-instance.minimum=minimum-number-of-instances-within-the-custom-reception-framework-pool ~ <numeric character> ((0 or 1-2147483647)) <<0>>

Specify the minimum number of instances in the pool of the custom reception framework, as an integer. If you specify 0, the minimum number is not restricted.

pooled-instance.maximum=maximum-number-of-instances-within-the-pool-of-Message-Queue-reception-and-custom-reception-framework ~ <numeric character> ((0 or 1-2147483647)) <<0>>

Specify the maximum number of instances in the pool of Message Queue reception and custom reception framework, as an integer. If you specify 0, the maximum number of instances in reception process is set to 1.

ejb-transaction-timeout=timeout-period-for-EJB-transaction-of-Message-Queue-reception-and-custom-reception-framework ~ <numeric character> ((0 or 1-2147483647)) <<0>>

Specify, in seconds, the timeout period for EJB transaction of Message Queue reception and custom reception framework. If you specify 0, operation is performed with the default timeout value set up in the J2EE server.

activation-config.destination= message-destination ~ <alphanumeric characters and symbols>

Sets a value for the destination property of the ActivationSpec object used for connection with IBM MQ. For the property value, specify the destination that receives messages (the queue name created by IBM MQ).

activation-config.username=default-user-name-for-connecting-the-queue-manager~ <alphanumeric characters and symbols> <<null>>

Sets a value for the username property of the ActivationSpec object used for connection with IBM MQ. For the property value, specify the default user name used to establish a connection to the queue manager.

activation-config.ccdtURL=property-value

Sets a value for the ccdtURL property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

Identify the name and location of the file that stores the client channel definition table, and then specify how to access this file.

activation-config.CCSID=property-value

Sets a value for the CCSID property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

activation-config.channel=property-value

Sets a value for the channel property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

activation-config.clientID=property-value

Sets a value for the clientID property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified for this property, see the IBM MQ documentation.

activation-config.failIfQuiesce=property-value

Sets a value for the failIfQuiesce property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified,, see the IBM MQ documentation.

activation-config.headerCompression=property-value

Sets a value for the headerCompression property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified,, see the IBM MQ documentation.

activation-config.hostName=property-value

Sets a value for the hostName property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

activation-config.localAddress=property-value

Sets a value for the localAddress property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

activation-config.messageBatchSize=property-value

Sets a value for the messageBatchSize property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

activation-config.messageCompression=property-value

Sets a value for the messageCompression property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

activation-config.messageRetention=property-value

Sets a value for the messageRetention property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

activation-config.password=property-value

Sets a value for the password property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBMe MQ documentation.

activation-config.pollingInterval=property-value

Sets a value for the pollingInterval property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

activation-config.port=property-value

Set a value for the port property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

activation-config.providerVersion=property-value

Set a value for the providerVersion property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

activation-config.queueManager=property-value

Sets a value for the queueManager property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

activation-config.rescanInterval=property-value

Sets a value for the rescanInterval property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

activation-config.shareConvAllowed=property-value

Sets a value for the shareConvAllowed property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

activation-config.transportType=property-value

Sets a value for the transportType property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

activation-config.maxMessages=property-value

Sets a value for the maxMessages property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

activation-config.maxPoolDepth=property-value

Sets a value for the maxPoolDepth property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

activation-config.messageSelector=property-value

Sets a value for the messageSelector property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

activation-config.poolTimeout=property-value

Sets a value for the poolTimeout property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

activation-config.readAheadAllowed=property-value

Sets a value for the readAheadAllowed property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

activation-config.readAheadClosePolicy=property-value

Sets a value for the readAheadClosePolicy property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

activation-config.startTimeout=property-value

Sets a value for the startTimeout property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

activation-config.useJNDI=property-value

Sets a value for the useJNDI property of the ActivationSpec object used for connection with IBM MQ. For details about this property, such as the values that can be specified, see the IBM MQ documentation.

3.10 File used for HTTP adapter

3.10.1 HTTP adapter definition file

(1) Format

[adphttp.protocol.encoding-type=Encoding format]
[adphttp.protocol.connect-timeout=Connection timeout time]
[adphttp.protocol.read-timeout=Reading timeout time]
[adphttp.protocol.chunked-encoding-size=Chunk size]
[adphttp.protocol.https-server-authentication={true|false}]
[adphttp.protocol.https-hostname-verification={true|false}]

[adphttp.file.read-lock.retry.count=Lock retry count in case of failure in shared lock acquisition]
[adphttp.file.read-lock.retry.interval=Lock retry interval in case of failure in shared lock acquisition]

[adphttp.data-size-limit.body-message=Maximum size of HTTP response body]
[adphttp.data-size-limit.file=Maximum size for file]

[adphttp.response-code.normal=Status code treated as normal processing]
[adphttp.response-code.fault=Status code treated as faulty processing]

[adphttp.auto-delete-incomplete-file={true|false}]

[adphttp.request.switchover.json-transfer.mode={true|false}]
[adphttp.response.switchover.json-transfer.mode={true|false}]

[adphttp.oauth.authentication={true|false}]

(2) Function

Sets up the operating information of HTTP adapter.

Create HTTP adapter definition file with file name as "cscadphttp.properties".

The contents that you have specified in HTTP adapter definition file become effective when HTTP adapter starts.

(3) File storage location

<Service platform installation directory>\CSC\custom-adapter\HTTP\config\templates\cscadphttp.properties

Important note

The file saved here is a template file. After copying this template file to any directory, edit the file and then create definition file.

(4) Specifiable properties

(a) Properties related to protocol operation specification

adphttp.protocol.encoding-type=Encoding format ~((gzip))

Specify the encoding format for the HTTP body to be sent and received. "gzip" is the only encoding format that you can specify. This format is not case-sensitive. Encoding format is not defined by default.

gzip

HTTP body is automatically encoded.

Specify this property only when sending or receiving HTTP body in gzip format. When you do not want to send or receive HTTP body in gzip format, comment out or delete this property.

adphttp.protocol.connect-timeout=Connection timeout time ~<Number>((0 or between1 and 2147483647))<<60000>>

Specify connection timeout time in milliseconds. Connection does not timeout if you have specified 0 in the value.

adphttp.protocol.read-timeout=Read timeout time ~<Number>((0 or between 1 and 2147483647))<<300000>>

Specify read timeout time in milliseconds. Connection does not timeout if you have specified 0 in the value.

adphttp.protocol.chunked-encoding-size=Chunk size ~<Number>((0 or between 1 and 2147483647))<<0>>

Specify the value to be set for java.net.HttpURLConnection#setChunkedStreamingMode(Integer). Note, however, that whether a chunk with the specified size is sent depends on the JDK operation. If you do not want to send chunks, specify 0 or comment out this property.

Specify the chunk size as "4096" and increase or decrease it as and when required. When you specify any value for chunk size, consider the following points according to the environment to be used:

If you specify an extremely small value for chunk size (like a single digit number), chunk might not be sent.

If the chunk size is too small, overhead accompanying the chunk encoding becomes large.

If the chunk size is too big, memory becomes insufficient and an error occurs.

adphttp.protocol.https-server-authentication={true|false} <<true>>

Specify if server is to be validated during HTTPS communication. This property is not case sensitive.

true

Validates server during HTTPS communication.

false

Does not validate server during HTTPS communication.

adphttp.protocol.https-hostname-verification={true|false} ~<<true>>

Specify whether to verify the host during HTTPS communication. This property is not case sensitive.

true

Verifies host name during HTTPS communication.

false

Does not verify host name during HTTPS communication.

(b) Properties related to exclusive file access acquisition

adphttp.file.read-lock.retry.count=Lock retry count in case of failure in shared lock acquisition ~<Number>((0-1024))<<0>>

Specify the count of lock retries when there is a failure in acquiring shared lock for common folder.

adphttp.file.read-lock.retry.interval=Lock retry interval count in case of failure in shared lock acquisition~<Number>((1-1024))<<1>>

Specify the interval between lock retries when there is a failure in acquiring shared lock for common folder.

(c) Properties related to data size control

adphttp.data-size-limit.body-message=Maximum size of HTTP response body ~<Number>((Between -1 and 2147483647))<<-1>>

Specify the maximum size of data to be allowed when setting up HTTP response in response message (body), in bytes unit. If you specify -1, data size is not restricted.

adphttp.data-size-limit.file=Maximum size for file ~<Number>(Between -1 and 2147483647))<<-1>>

Specify the maximum size of data to be allowed when writing HTTP response to file, in bytes unit. If you have specified-1 in the value, data size is not restricted.

(d) Properties related to response code

adphttp.response-code.normal=Status code treated as normal processing ~<3-digit status code><<200>>

Specify a 3-digit status code, which is to be treated as normal process. When HTTP response of the specified status code is returned to HTTP adapter, status code is processed in a response message.

Status code is treated as normal process, fault process and system exception according to the judgment criteria. For details on the judgment criteria, see the description for setting normal process or fault process in status code, under "2.14.4 Relationship between HTTP responses and response messages" in "Service Platform Overview".

Specify multiple status codes in regular expression. The following snippet shows a setting example when a 200-series status code is treated as normal process.

adphttp.response-code.normal=2[0-9][0-9]

If a status code, which is not set to normal process or fault process, is passed to HTTP adapter the status code will become a system exception. If the key and value are omitted or if the value is omitted, operation is performed with the default value.

adphttp.response-code.fault=Status code treated as faulty processing ~<3-digit status code>

Specify a 3-digit status code which is to be treated as faulty processing. When the HTTP response of the status code specified here is returned to HTTP adapter, the status code is processed in a fault message. If you do not specify any value, the status code is not set.

Status code is treated as normal process, fault process and system exception according to the judgment criteria. For details on the judgment criteria, see the description for setting normal process or fault process in status code, under "2.14.4 Relationship between HTTP responses and response messages" in "Service Platform Overview".

Specify multiple status codes in regular expression. The following snippet shows a setting example, in which, all the status codes except the status codes specified in adphttp.response-code.normal property, are considered as fault response.

adphttp.response-code.fault=[1-9][0-9][0-9]

If a status code, which is not set to normal process or fault process, is passed to HTTP adapter the status code will become a system exception.

(e) Properties related to extension function

adphttp.auto-delete-incomplete-file={true|false} ~<<true>>

Specify whether to automatically delete the received files, in incomplete files are generated in common folder or work folder due to errors like network fault, I/O error or exceeded data size limit. This property is not case-sensitive.

true

Automatically deletes received incomplete files.

false

Does not automatically delete received incomplete files.

Select true, when you want to avoid storage consumption due to received incomplete files and select false, when you prefer to save (hold) the state when a fault occurs.

When the received incomplete files are not automatically deleted, to make sure that the free space in storage is not exhausted, you must manually delete the unwanted files as and when required. For details on how to delete, see "5.4.20 Deleting the work folder" and "5.4.22 Deleting files in the common folder" in "Service Platform Setup and Operation Guide".

(f) Properties related to JSON-XML transformation

adphttp.request.switchover.json-transfer.mode={true|false} ~ <<false>>

Specify whether to perform JSON-XML transformation during request processing of the HTTP adapter.

true

JSON-XML transformation is performed during request processing of the HTTP adapter.

false

JSON-XML transformation is not performed during request processing of the HTTP adapter.

adphttp.response.switchover.json-transfer.mode={true|false} ~ <<false>>

Specify whether to perform JSON-XML transformation during response processing of the HTTP adapter.

true

JSON-XML transformation is performed during response processing of the HTTP adapter.

false

JSON-XML transformation is not performed during response processing of the HTTP adapter.

(g) Properties related to OAuth 2.0 authentication

adphttp.oauth.authentication={true|false} ~ <<false>>

Specify whether to use the OAuth 2.0 authentication flow during execution of the HTTP adapter.

true

The OAuth 2.0 authentication flow is used during execution of the HTTP adapter.

false

The OAuth 2.0 authentication flow is not used during execution of the HTTP adapter.

Note

If you use the OAuth 2.0 authentication flow without specifying true, authentication information becomes invalid. If authentication information is invalid, an HTTP request might cause an error response or an access token might not be stored in the response message (header).

(5) Example of coding

An example of description is as follows:

adphttp.protocol.encoding-type=gzip
adphttp.protocol.connect-timeout=60000
adphttp.protocol.read-timeout=300000
adphttp.protocol.chunked-encoding-size=0
adphttp.protocol.https-server-authentication=true
adphttp.protocol.https-hostname-verification=true
adphttp.file.read-lock.retry.count=0
adphttp.file.read-lock.retry.interval=1
adphttp.data-size-limit.body-message=-1
adphttp.data-size-limit.file=-1
adphttp.response-code.normal=200
adphttp.response-code.fault=500
adphttp.auto-delete-incomplete-file=true
adphttp.request.switchover.json-transfer.mode=true
adphttp.response.switchover.json-transfer.mode=true

(6) Notes

Save property file character code to UTF-8. If you use a character code apart from UTF-8, the setting values may not be interpreted correctly.

3.11 File used for HTTP reception

3.11.1 HTTP response header definition file

(1) Format

<Key name>=<Value>

(2) Function

Sets up the HTTP response header information to be used as default values, when response message format (for header variable) of HTTP reception is omitted.

(3) File storage location

<Service platform installation directory>\CSC\custom-reception\http\config\templates\cscurecphttp_header.properties

Important note

The file saved here is a template file. To edit HTTP response header definition file, click [Edit] button of the [Self-defined file] in User-defined reception settings window (Details), at the time of adding HTTP reception, and modify the contents of definition file.

(4) Example of coding

An example of description is as follows:

Connection=close
extension-header=extension-header1

(5) Notes

If HTTP response header definition file is blank or if httprecp.response.header.filename property is not set in HTTP reception definition file, see "2.13.5 HTTP reception response process"in "Service Platform Overview".

If the value for httprecp.response.header.filename property in HTTP reception definition file is blank or if the value has no matching HTTP response header definition file in repository, an error occurs.

3.11.2 HTTP-reception service-selection definition file

(1) Format

HTTP-method-name[,host-name]=business-process-name

(2) Function

For HTTP reception of a user-defined reception (invocation target selected), this file specifies the business process to be invoked from HTTP reception and the conditions for invoking the business process. This file is specified as a self-defined file when HTTP reception of a user-defined reception (invocation target selected) is defined in the User-Defined Reception Definition window in the development environment.

For details about how to define HTTP reception of a user-defined reception (invocation target selected), see the manual Service Platform Reception and Adapter Definition Guide. For details about the items displayed in the User-Defined Reception Definition window, see 1.2.5(2) TP1/RPC, FTP, HTTP, Message Queue, file event, and custom reception types.

(3) File storage location

service-platform-installation-directory\CSC\custom-reception\http\config\templates\cscurecphttp_selection.properties

Important note

The file stored here is a template file. To edit the HTTP-reception service-selection definition file, click the Edit button for Self-defined file in the User-Defined Reception Definition window (detailed) when adding HTTP reception as a user-defined reception (invocation target selected), and then modify the definition file contents.

(4) Specifiable properties

HTTP-method-name[,host-name]

Specify the HTTP method or the HTTP method and host as a condition of the business process to be invoked from HTTP reception.

Host name specifications are case-sensitive.

business-process-name

Specify the name of the business process to be invoked from HTTP reception.

(5) Example of coding

Examples of coding are as follows.

This example shows how to specify HTTP methods and hosts as the keys.

PUT,GyoumuKanri.jpo.go.jp=BP1
DELETE,GyoumuKanri.jpo.go.jp=BP2
GET,GyoumuKanri.jpo.go.jp=BP3

This example shows how to specify HTTP methods as the keys.

PUT=BP1
DELETE=BP2
GET=BP3

(6) Notes

Do not delete the HTTP-reception service-selection definition file from HTTP reception defined as a user-defined reception (invocation target selected). If you delete the file, operations are not guaranteed.

Do not add an HTTP-reception service-selection definition file to HTTP reception defined as a user-defined reception (invocation target fixed). If you add this file, operations are not guaranteed.

3.11.3 HTTP reception definition file

(1) Format

[urecp-http.context-root=Context root of HTTP reception]
[urecp-http.max-threads=Max. threads in HTTP reception]
[urecp-http.exclusive-threads=Number of HTTP reception occupied execution threads]
[urecp-http.queue-size=Size of pending queue in HTTP reception]
[urecp-http.pooled-instance.minimum=Minimum number of instances in the pool of HTTP reception]
[urecp-http.pooled-instance.maximum=Maximum number of instances in the pool of HTTP reception]
[urecp-http.ejb-transaction-timeout= EJB transaction timeout time of HTTP reception

[httprecp.switchover.pass-through.mode={true|false}]
[httprecp.switchover.file-transfer.mode={true|false}]
[httprecp.http.charset={Shift_JIS|UTF-8}]
[httprecp.response.ignore-bodymsg={true|false}]
[httprecp.response.header.filename=HTTP response header definition file name]
[httprecp.system-exception.status-code=Status code when there is a system exception]
[httprecp.response.generate.content-length={true|false}]
[httprecp.file-trans.temp-file.partsize-threshold=Threshold value size to output temporary files]
[httprecp.file-trans.maxsize.part=Size limit for 1 file of the file data that can be received]
[httprecp.file-trans.maxsize.requestSize limit for HTTP request body that can be received]
[httprecp.work-dir.auto-delete={true|false}]
[httprecp.response.download.disposition-type=Value to be set in Content-Disposition header of HTTP response header
[httprecp.pass-through.parameter-use={true|false}]

[httprecp.request.switchover.json-transfer.mode={true|false}]
[httprecp.response.switchover.json-transfer.mode={true|false}]

[httprecp.response.compression.url-patternURL-pattern-identification-number=URL-pattern-of-request-URL]
[httprecp.response.compression.rulecompression-rule-identification-number.url-mappingURL-mapping-identification-number=URL-pattern-of-HTTP-response-compression-rule]
[httprecp.response.compression.rulecompression-rule-identification-number.conditioncompression-condition-identification-number=media-type:compression-threshold]

(2) Function

Specify the operating information of HTTP reception. The contents that you specify in HTTP reception definition file become effective when HTTP reception starts.

Create HTTP reception definition file with the file name "cscurecphttp.properties".

(3) File storage location

<Service platform installation directory>\CSC\custom-reception\http\config\templates\cscurecphttp.properties

Important note

The file stored here is a template file. To edit HTTP response header definition file, click [Edit] button of the [Self-defined file] in User-defined reception settings window (Details), at the time of adding HTTP reception, and modify the contents of definition file.

(4) Specifiable properties

(a) HTTP reception related

urecp-http.context-root=Context root of HTTP reception ~<<Reception ID of HTTP reception>>

Specify the context root of HTTP reception with one-byte alphanumeric characters and single byte symbols shown as follows:

Hyphen (-)

Period (.)

Underscore (_)

Swung dash (~)

Forward slash (/)

At mark (@)

Plus sign (+)

Dollar sign ($)

Exclamation mark (!)

Single quotation mark (')

Parentheses (( ))

Percent sign (%)

An error will occur if you specify symbols other than those mentioned above and in case of the following:

Separator (/) is specified as the first or last character

Too many separators (/) are specified

Specified with a relative path

Percentage (%) is specified with a purpose other than percentage encoding

If you do not specify this property, reception ID of HTTP reception is set.

urecp-http.max-threads= Max. threads in HTTP reception ~<Number>((1-1024))<<10>>

Specify the maximum number of threads in HTTP reception. The value you specify for this property must be larger than the HTTP reception occupied threads count (value specified in the property urecp-http.exclusive-threads).

urecp-http.exclusive-threads=HTTP reception occupied execution threads count~<Number>((0-1024))<<0>>

Specify the HTTP reception occupied threads count. The value you specify for this property must not exceed the max. threads in HTTP reception (value specified in the property urecp-http.max-threads).

urecp-http.queue-size=size of waiting queue of HTTP reception~<Number>((0 - 2147483647))<<8192>>

Specifies the size for pending queue of HTTP reception.

urecp-http.pooled-instance.minimum=minimum number of the instances within the pool of HTTP reception~<Number>((0 or 1 - 2147483647))<<0>>

Specify the minimum number of instances in the pool of HTTP reception, in integers. If you specify 0 for this property, the minimum number of instances in the pool of HTTP reception is not restricted.

Specify a value which is smaller than the value specified in the property urecp-http.pooled-instance.maximum (maximum number of instances in the pool of HTTP reception). If the specified value is larger than the value specified in the property urecp-http.pooled-instance.maximum, there will be an error during execution of operating command.

urecp-http.pooled-instance.maximum=maximum number of instances within the pool of HTTP reception<number>((0 or 1-2147483647))<<0>>

Specify the maximum number of instances in the pool of HTTP reception, in integer. If you specify 0, the maximum number of instances is not restricted.

Specify a value that is greater than the value of the property urecp-http.pooled-instance.minimum (minimum number of instances in the pool of HTTP reception). If the specified value is smaller than the value specified in the property urecp-http.pooled-instance.minimum, an error occurs during the execution of operating command.

urecp-http.ejb-transaction-timeout=EJB transaction timeout time of HTTP reception~<number>((0 or 1-2147483647))<<0>>

Specify the EJB transaction timeout time of HTTP reception, in seconds. If you specify 0, operation is performed with the default timeout value specified in J2EE server.

(b) Properties related to reception settings

httprecp.switchover.pass-through.mode={true|false} ~<<false>>

Specify the mode that generates body variable at the time of passing message body to business process. This property is not case-sensitive.

true

Uses pass-through mode.

false

Uses standard mode.

httprecp.switchover.file-transfer.mode={true|false} ~<<false>>

Specify if work folder is to be created during request reception by HTTP reception. This property is not case-sensitive.

This property is valid for requests other than multi-part type requests. For multi-part type data, work folder is always created.

true

Work folder is created irrespective of whether the request is multi-part type.

false

Work folder is created when request is multi-part type. Otherwise, work folder is not created.

httprecp.http.charset={Shift_JIS|UTF-8} ~<<UTF-8>>

Specify the character code to be used for encoding message body and query. This property is not case-sensitive.

httprecp.response.ignore-bodymsg={true|false} ~<<false>>

Specify if the response message (body) received from business process is to be ignored by HTTP reception (Do not set the response message in HTTP response). This property is not case-sensitive.

true

Response message (body) is not set in HTTP response.

false

Response message (body) is set in the body part of HTTP response.

httprecp.response.header.filename=HTTP response header definition file name

Specify the name of HTTP response header definition file. This property is case-sensitive.

httprecp.system-exception.status-code=status code in case of system exception~<Number>((000-999))<<500>>

Specify the status code during system exception with a 3 digit number.

httprecp.response.generate.content-length={true|false} ~<<true>>

Specify whether to generate the contents length in HTTP reception. This property is not case-sensitive.

true

Generates contents length.

false

Does not generate contents length.

httprecp.file-trans.temp-file.partsize-threshold=threshold size to output the temporary file~<Number>((0 or 1 - 2147483647))<<0>>

Specify the size serving as the threshold size during the output of HTTP request in temporary file, in case of a multi-part type HTTP request, in bytes unit.

If the size of HTTP request received by HTTP reception exceeds the value of this property, the received HTTP request is output in a temporary file. Temporary file is always generated when you have specified 0 in this property.

httprecp.file-trans.maxsize.part=size limit of 1 file of the file data that can be received~<number>((0 or 1-2147483647))<<2147483647>>

Specify the size limit for 1file in file data that can be received through HTTP reception, in bytes unit.

If the size of a part which is to be handled in file format, from among all the parts of multi-part HTTP request received by HTTP reception, exceeds the value specified for this property, a system exception occurs.

httprecp.file-trans.maxsize.request=size limit of HTTP request body that can be received~<number>((0 or 1-2147483647))<<2147483647>>

Specify the size limit for HTTP request body that can be received through HTTP reception, in bytes unit.

If the size of HTTP request body received by HTTP reception exceeds this value, a system exception occurs.

httprecp.work-dir.auto-delete={true|false} ~<<true>>

Specifies if work folder is to be deleted automatically after process completion. This property is not case-sensitive.

true

Work folder is automatically deleted after business process is processed successfully.

false

Work folder is not deleted automatically.

If you specify a value other than false or do not specify a key or a value, value is considered as true is considered. Specify false in this property, when business process is asynchronous type.

httprecp.response.download.disposition-type=value to be specified in the Content-Disposition header of HTTP response header~<<attachment>>

Specify a value which is to be set for Content-Disposition header of HTTP response header when sending data from HTTP reception to HTTP client. This property is not case-sensitive. Note that the validity of specified value is not verified.

The header value set in this property is used only when 1 file is to be downloaded by HTTP client.

httprecp.pass-through.parameter-use={true|false} ~<<true>>

Specify whether to use msg key for HTTP request body, in pass-through mode. This property is not case-sensitive.

This property is enabled only when you have specified true for the httprecp.switchover.pass-through.mode property.

true

Uses msg key.

false

Does not use msg key. The contents of HTTP request body are directly passed on as request message to business process.

(c) Properties related to JSON-XML transformation

httprecp.request.switchover.json-transfer.mode={true|false} ~ <<false>>

Specify whether to perform JSON-XML transformation during request processing of HTTP reception.

true

JSON-XML transformation is performed during request processing HTTP reception.

false

JSON-XML transformation is not performed during request processing HTTP reception.

httprecp.response.switchover.json-transfer.mode={true|false} ~ <<false>>

Specify whether to perform JSON-XML transformation during response processing of HTTP reception.

true

JSON-XML transformation is performed during response processing of HTTP reception.

false

JSON-XML transformation is not performed during response processing of HTTP reception.

(d) Properties related to the HTTP response compression function

httprecp.response.compression.url-patternURL-pattern-identification-number=URL-pattern-of-request-URL

This property corresponds to the <url-pattern> tag in the <filter-mapping> tag that specifies URL mapping of the HITACHI Application Integrated Property File. For details about the HITACHI Application Integrated Property File and the HTTP response compression function, see 10.2 HTTP response compression functionality in the manual uCosminexus Application Server Compatibility Guide.

If you omit this property, no judgement is performed based on the HTTP response compression rule. If you specify the same property multiple times, operations are not guaranteed.

URL-pattern-identification-number

Specify a unique sequential number starting from 1. If the numerical sequence is interrupted, the properties before the point of interrupt are valid.

URL-pattern-of-request-URL

Specify a relative path from the context root of the request URL.

The characters are case sensitive.

If the specified value matches multiple URL patterns, the setting with the smallest URL pattern identification number is applied.

If you specify /*, all request URLs are considered as a match.

If the request URL matches the URL pattern specified here, whether to perform the compression processing is determined based on the HTTP response compression rules specified in the following properties:

httprecp.response.compression.rulecompression-rule-identification-number.url-mappingURL-mapping-identification-number=URL-pattern-of-HTTP-response-compression-rule

httprecp.response.compression.rulecompression-rule-identification-number.conditioncompression-condition-identification-number=media-type:compression-threshold

To specify multiple URL patterns, specify multiple properties having different URL pattern identification numbers.

Example of specifying two URL patterns

httprecp.response.compression.url-pattern1=/app1/*
httprecp.response.compression.url-pattern2=/app2/*

httprecp.response.compression.rulecompression-rule-identification-number.url-mappingURL-mapping-identification-number=URL-pattern-of-HTTP-response-compression-rule ~ <</*>>

This property corresponds to the <param-value> tag (under the <init-param> tag under the <hitachi-filter-property> tag) that specifies the URL pattern for the HITACHI Application Integrated Property File. For details about the HITACHI Application Integrated Property File and the HTTP response compression function, see 10.2 HTTP response compression functionality in the manual uCosminexus Application Server Compatibility Guide.

If you omit this property, all request URLs are considered as a match. If you specify the same property multiple times, operations are not guaranteed.

compression-rule-identification-number

Specify a unique sequential number starting from 1. If the compression rule identification number corresponding to the sequential number is not specified in any property, the subsequent properties are invalid.

To specify the media type and compression threshold to be added to the HTTP response compression rule by using the following property, specify the same compression rule identification number.

httprecp.response.compression.rulecompression-rule-identification-number.conditioncompression-condition-identification-number=media-type:compression-threshold

URL-mapping-identification-number

For one compression rule identification number, specify a unique sequential number starting from 1. If the numerical sequence is interrupted, the properties before the point of interrupt are valid.

URL-pattern-of-HTTP-response-compression-rule

Specify a relative path from the context root of the request URL.

The characters are case sensitive.

If the specified value matches multiple URL patterns, the setting with the smallest URL pattern identification number is applied.

If you specify /*, all request URLs are considered as a match.

You can specify multiple HTTP response compression rules by combining compression rule identification numbers and URL mapping identification numbers.

To specify multiple URL patterns for one HTTP response compression rule:

Specify multiple properties that have the same compression rule identification number and different URL mapping identification numbers. The following example shows how to specify two URL patterns for compression rule 1.

httprecp.response.compression.rule1.url-mapping1=/app/dir1/*
httprecp.response.compression.rule1.url-mapping2=/app/dir2/*

To specify multiple HTTP response compression rules:

Specify multiple properties that have different compression rule identification numbers. The following example shows how to specify two compression rules. Because their compression rule identification numbers are different, both URL mapping identification numbers are 1, indicating the start number.

httprecp.response.compression.rule1.url-mapping1=/app/dir1/*
httprecp.response.compression.rule2.url-mapping1=/app/dir2/*

httprecp.response.compression.rulecompression-rule-identification-number.conditioncompression-condition-identification-number=media-type:compression-threshold ~ <<*:100>>

This property corresponds to the <param-value> tag (under the <init-param> tag under the <hitachi-filter-property> tag) that specifies the compression rules for the HITACHI Application Integrated Property File. For details about the HITACHI Application Integrated Property File and the HTTP response compression function, see 10.2 HTTP response compression functionality in the manual uCosminexus Application Server Compatibility Guide.

If you omit this property, all HTTP responses of any media type are applicable if the response body exceeds 100 bytes.

If you specify the same property multiple times, operations are not guaranteed.

compression-rule-identification-number

Specify a unique sequential number starting from 1. If the compression rule identification number corresponding to the sequential number is not specified in any property, the subsequent properties are invalid.

To specify the URL pattern to be added to the HTTP response compression rule by using the following property, specify the same compression rule identification number:

httprecp.response.compression.rulecompression-rule-identification-number.url-mappingURL-mapping-identification-number=URL-pattern-of-HTTP-response-compression-rule

compression-condition-identification-number

For one compression rule identification number, specify a unique sequential number starting from 1. If the numerical sequence is interrupted, the properties before the point of interrupt are valid.

media-type:compression-threshold

Specify the media type and compression threshold delimited by a halfwidth colon (:).

media-type

The characters are not case sensitive.

If you specify the same media type multiple times, the setting with the largest compression condition identification number is applied.

If you specify an asterisk (*), all media types are applied. However, any setting specified for an individual media type has priority.

compression-threshold

Specify an integer in the range from 100 to 2,147,483,647 (unit: bytes).

You can specify multiple HTTP response compression rules by combining compression rule identification numbers and compression condition identification numbers.

To specify multiple media types and compression thresholds for one HTTP response compression rule:

Specify multiple properties that have the same compression rule identification number and different compression condition identification numbers. The following example shows how to specify two media types and compression thresholds for compression rule 1.

httprecp.response.compression.rule1.condition1=text/html:500
httprecp.response.compression.rule1.condition2=*:1000

To specify multiple HTTP response compression rules:

Specify multiple properties that have different compression rule identification numbers. The following example shows how to specify two compression rules. Because their compression rule identification numbers are different, both compression condition identification numbers are 1, indicating the start number.

httprecp.response.compression.rule1.condition1=text/html:500
httprecp.response.compression.rule2.condition1=*:1000

(5) Example of coding

(a) Example of coding 1

An example of description is as follows:

urecp-http.max-threads=10
urecp-http.exclusive-threads=0
urecp-http.queue-size=8192
urecp-http.pooled-instance.minimum=0
urecp-http.pooled-instance.maximum=0
urecp-http.ejb-transaction-timeout=0
httprecp.switchover.pass-through.mode=false
httprecp.switchover.file-transfer.mode=false
httprecp.http.charset=UTF-8
httprecp.response.ignore-bodymsg=false
httprecp.response.header.filename=cscurecphttp_header.properties
httprecp.system-exception.status-code=500
httprecp.response.generate.content-length=true
httprecp.request.switchover.json-transfer.mode=true
httprecp.response.switchover.json-transfer.mode=true

(b) Example of coding 2: Compressing the response body in gzip format

The following example shows how to compress the response body in gzip format by specifying multiple compression conditions.

# Setting of compression target HTTP request
httprecp.response.compression.url-pattern1=/app/*

# Compression rule 1
httprecp.response.compression.rule1.url-mapping1=/app/dir1/*
httprecp.response.compression.rule1.condition1=text/html:100
httprecp.response.compression.rule1.condition2=application/pdf:1000

# Compression rule 2
httprecp.response.compression.rule2.url-mapping1=/app/dir2/*
httprecp.response.compression.rule2.url-mapping2=/app/dir3/*
httprecp.response.compression.rule2.condition1=text/html:200

This example specifies that HTTP requests for which a relative path from the context root of the request URL begins with /app/ will be compressed. In addition, the following two compression rules are specified.

Compression rule 1

For the HTTP request, the relative path from the context root of the request URL begins with /app/dir1/.

The media type of the HTTP request is text/html and the body size of the HTTP response exceeds 100 bytes.

The media type of the HTTP request is application/pdf and the body size of the HTTP response exceeds 1,000 bytes.

Compression rule 2

For the HTTP request, the relative path from the context root of the request URL begins with /app/dir2/ or /app/dir3/.

The media type of the HTTP request is text/html and the body size of the HTTP response exceeds 200 bytes.

3.12 File used for file event linkage

3.12.1 File-event-reception definition file

(1) Format

[urecp-fileevent.thread-pool.minimum=minimum-number-of-threads-for-file-event-reception-process]
[urecp-fileevent.thread-pool.maximum=maximum-number-of-threads-for-file-event-reception-process]

[urecp-fileevent.sub-folder=path-of-subfolder-to-store-monitored-files]
[urecp-fileevent.common-folder.definition-name=common-folder-definition-name]
[urecp-fileevent.monitored-file-name.regex=regular-expression-of-monitored-file-name]
[urecp-fileevent.monitored.common-folder={true|false}]
[urecp-fileevent.file.auto-delete={true|false}]

(2) Function

Specifies the operating information for file event reception. This file is specified as a self-definition file when file event reception is created in the development environment.

To change the settings after file event reception is set up, edit the contents of the following template file, and then save the file with the same file name cscurecpfileevent.properties. Any other file names specified for a self-defined file are invalid.

(3) File storage location

service-platform-installation-directoryCSC\custom-reception\fileevent\config\templates\cscurecpfileevent.properties

Important note

To edit the file-event-reception definition file, click the Edit button for Self-defined file in the User-Defined Reception Definition window (detailed) when adding a file event reception, and then modify the contents of the definition file.

The specified settings are enabled when file event reception starts. If the definition is invalid, an error occurs during deployment or startup of file event reception.

(4) Specifiable properties

(a) Number of threads that can be executed concurrently

urecp-fileevent.thread-pool.minimum=minimum-number-of-threads-for-file-event-reception-process ~ <Integer>((1-2147483647))<<1>>

For threads that invoke file event reception, this property specifies the minimum number of threads that can be executed concurrently in a thread pool.

urecp-fileevent.thread-pool.maximum=maximum-number-of-threads-for-file-event-reception-process ~<Integer>((1-2147483647))<<32>>

For threads that invoke file event reception, this property specifies the maximum number of threads that can be executed concurrently in a thread pool. You must specify a value equal to or greater than the minimum number of threads.

(b) Monitored files

urecp-fileevent.sub-folder=path-of-subfolder-to-store-monitored-files ~ <Character strings (including two-byte characters) and spaces>

When you store monitored files in a subfolder, specify the subfolder name as a relative path. Use a forward slash (/) as a folder delimiter.

If the specified folder does not exist, the request processing for file event reception fails.

Make sure that the total path length of the monitored files does not exceed the maximum path length of the OS. For details about the upper limit of the path length for the OS, see the documentation of the relevant OS.

urecp-fileevent.common-folder.definition-name=common-folder-definition-name ~ <Alphanumeric characters (0 to 9, a to f, and A to F), underscore (_)> ((1-64 characters))<<default>>

Specify the common folder definition name to be referenced when the file event reception checks for the existence of an acquisition target file.

You must specify the common folder definition name specified for common-folder-common-folder-definition-name in the HCSC server runtime definition file.

urecp-fileevent.monitored-file-name.regex=regular-expression-of-monitored-file-name ~ <Character string>

Specify the name of the file to be monitored by the file event reception, by using a regular expression. The coding format of the regular expression must comply with the java.util.regex.Pattern class specification.

If you omit this property, all files whose name does not contain .csc are monitored.

urecp-fileevent.monitored.common-folder={true|false} ~ <<false>>

Specify whether to monitor the common folder by the file event reception.

true

Monitors acquisition target files in the common folder.

false

Monitors update completion notification files in the monitored folder.

urecp-fileevent.file.auto-delete={true|false} ~ <<true>>

Specify whether to automatically delete acquisition target files when a response from a business process is normal.

This property is valid only when the monitoring target is the common folder.

true

Deletes acquisition target files.

false

Does not delete acquisition target files.

(5) Example of coding

An example of coding of the file-event-reception definition file is as follows.

urecp-fileevent.thread-pool.minimum=1
urecp-fileevent.thread-pool.maximum=32
urecp-fileevent.sub-folder=folder1
urecp-fileevent.common-folder.definition-name=common
urecp-fileevent.monitored-file-name.regex=file[0-9]*\.txt
urecp-fileevent.monitored.common-folder=false

3.13 File used for transformation between JSON format data and XML format data

3.13.1 JSON-XML transformation definition file

(1) Format

[json-xml-convert.arrays.parent-element-name=root-element-name-of-XML-format-data]
[json-xml-convert.arrays.child-element-name=repeat-element-name-of-XML-format-data]
[json-xml-convert.arrays.child-simple-element-name=child-element-name-defined-in-repeat-element-of-XML-format-data]
[json-xml-convert.root-element-name=root-element-name-of-XML-format-data]
[json-xml-convert.json-type.include={true|false}]

(2) Function

Specifies the operations related to transformation between JSON format data and XML format data. This file is specified as a self-defined file when HTTP reception and the HTTP adapter are created in the development environment.

This file is used by the JSON transformation tools (cscjson2xsd command and cscjsonxmlconv command). The file is not used by a JSON-XML transformation API. Note that you can also use this file in the execution environment. Use the same file in the development environment and execution environment so that the same execution results are obtained from the JSON transformation tools.

Edit and use the following template file.

Location of the template file

service-platform-installation-directory\CSC\config\msg\templates\csc_json_converter.properties

To edit the JSON-XML transformation definition file to be used by the HTTP adapter or HTTP reception:

In the Service adapter definition window (detailed), click the Add button for Self-defined file and then add the template file of the JSON-XML transformation definition file.

Click the Edit button for Self-defined file.

The editor for editing the JSON-XML transformation definition file starts.

Edit the JSON-XML transformation definition file in the editor.

From the Eclipse menu, select File, and then Save to save the edited information.

The file name is fixed to csc_json_converter.properties. Any other file names specified for a self-defined file are invalid. If csc_json_converter.properties is not specified for the self-defined file, JSON-XML transformation is performed with the default settings.

To read the defined JSON-XML transformation definition file during transformation of JSON format data, you need to execute the cscjson2xsd command or cscjsonxmlconv command by using one of the following methods:

Execute the command with the JSON-XML transformation definition file name specified in the -f argument.

Store the JSON-XML transformation definition file in the following path in advance, and then execute the command without specifying the -f argument.

service-platform-installation-directory\CSCTE\config\tools\json\csc_json_converter.properties

With the file stored in this directory, when you execute the command with the -f argument specified, the JSON-XML transformation definition file specified in the -f argument will be applied.

For details about data transformation using a JSON transformation tool (cscjson2xsd command or cscjsonxmlconv command), see the manual Service Platform Basic Development Guide.

The specified settings are enabled when HTTP reception and the HTTP adapter start. If the definition is invalid, an error occurs during deployment or startup of HTTP reception and the HTTP adapter.

(3) Specifiable properties

json-xml-convert.arrays.parent-element-name=root-element-name-of-XML-format-data ~ <Character string of NCName type><<csc-array>>

Specify the name of the root element of XML format data that is generated if the JSON format data begins from an array.

json-xml-convert.arrays.child-element-name=repeat-element-name-of-XML-format-data ~ <Character string of NCName type><<csc-element>>

Specify the name of the repeat element of XML format data corresponding to the array of JSON format data.

json-xml-convert.arrays.child-simple-element-name=child-element-name-defined-in-repeat-element-of-XML-format-data ~<Character string of NCName type><<csc-simple>>

Specify the child element name defined in the repeat element of XML format data corresponding to the array value of string type, numeric type, or boolean type of JSON format data.

json-xml-convert.root-element-name=root-element-name-of-XML-format-data ~ <Character string of NCName type><<csc-object>>

Specify the name of the root element of XML format data that is generated if the JSON format data begins from the object type.

json-xml-convert.json-type.include={true|false} ~ <<false>>

Specify whether the JSON data type is to be included in the attributes of XML format data.

true

The data type of JSON format data is included in the attributes of XML format data.

false

The data type of JSON format data is not included in the attributes of XML format data.

(4) Example of coding

An example of coding is as follows.

json-xml-convert.arrays.parent-element-name=csc-array
json-xml-convert.arrays.child-element-name=csc-element
json-xml-convert.arrays.child-simple-element-name=csc-simple
json-xml-convert.root-element-name=csc-object
json-xml-convert.json-type.include=false

3.14 Files used for data-transformation unit test commands

3.14.1 Data-transformation command properties file

(1) Format

  csctransform.xsl=path-of-XSL-file-(mapping-definition)
  csctransform.input.formatn=path-of-input-format-definition-file
  csctransform.input.datan=path-of-input-file
[csctransform.input.namen=logical-name-of-input-schema]
  csctransform.output.format=path-of-output-format-definition-file
  csctransform.output.data=path-of-output-file
[csctransform.uoc.class=class-name-of-character-code-conversion-UOC]
[csctransform.uoc.property=path-of-self-defined-file-for-character-code-conversion-UOC]
[csctransform.code.table.root.path=root-path-of-code-conversion-table-storage-path]
[csctransform.validate={true|false}]
[csctransform.debugtrace={ON|OFF}]
[csctransform.debugtrace.filepath=path-to-output-debug-information]
[csctransform.system.properties=path-of-system-properties-file-for-data-transformation]
[csctransform.undefined.code={ERROR|REPLACE}]

(2) Function

Specifies the arguments of the csctransform command in the property format. The file that has been set up can be specified in the -f option of the csctransform command. For details about the csctransform command, see csctransform (Testing data transformation).

Correspondence with the arguments of the csctransform command

The following shows the correspondence between the properties specified in this file and the arguments of the csctransform command.

No.

Property key name

Corresponding command argument

Settings

1

csctransform.xsl

-xsl

Path of the XSL file (mapping definition)

2

csctransform.input.format<n>

-informat

Path of the input format definition file

3

csctransform.input.data<n>

-infile

Path of the input file

4

csctransform.input.name<n>

None

Logical name of the input-schema

5

csctransform.output.format

-outformat

Path of the output format definition file

6

csctransform.output.data

-outfile

Path of the output file

7

csctransform.uoc.class

-uocclass

Class name of the character code conversion UOC

8

csctransform.uoc.property

-uocproperty

Path of the self-defined file for the character code conversion UOC

9

csctransform.code.table.root.path

-codetablerootpath

Root path of the code conversion table storage path

10

csctransform.validate

-validate

Whether to validate the schema for input files or output files

11

csctransform.debugtrace

-debugtrace

Whether to output debug information

12

csctransform.debugtrace.filepath

-debugtracefilepath

Output destination path of debug information

13

csctransform.system.properties

-cscdtsysprop

Path of the system properties file for data transformation

14

csctransform.undefined.code

-undefinedcode

Handling of undefined character codes

How to edit the file

Specify the file in the Java property file format. The available character code is UTF-8 only.

Edit the following template file, and then save it with any file name.

Location of the template file

service-platform-installation-directory\CSCTE\template\cscdt_csctransform.properties

(3) Specifiable properties

csctransform.xsl=path-of-XSL-file-(mapping-definition)

Specify the path of the XSL file (mapping definition) as an absolute or relative path.

If you specify the same property multiple times, which property is valid is not guaranteed.

csctransform.input.formatn=path-of-input-format-definition-file

Specify the path of the input format definition file (extension: .xsd or .fdx) as an absolute or relative path.

For n, specify 1 or greater integer (halfwidth) as a sequential number starting from 1. If you specify duplicate integers for n, which property is valid is not guaranteed.

The following settings are interpreted that sequential numbers from 1 to 5 are specified for n.

csctransform.input.format1 = c:\\temp\\format1.xsd
csctransform.input.format2 = c:\\temp\\format2.xsd
csctransform.input.format3 = c:\\temp\\format3.xsd
csctransform.input.format4 = c:\\temp\\format4.xsd
csctransform.input.format5 = c:\\temp\\format5.xsd

The following settings, in which the values of n are not sequential (5 is missing), are interpreted that numbers from 1 to 4 are specified.

csctransform.input.format1 = c:\\temp\\format1.xsd
csctransform.input.format2 = c:\\temp\\format2.xsd
csctransform.input.format3 = c:\\temp\\format3.xsd
csctransform.input.format4 = c:\\temp\\format4.xsd
csctransform.input.format6 = c:\\temp\\format6.xsd

The following settings, in which 1 is not specified for n, are determined to be invalid and an error occurs.

csctransform.input.format2 = c:\\temp\\format2.xsd
csctransform.input.format3 = c:\\temp\\format3.xsd
csctransform.input.format4 = c:\\temp\\format4.xsd

csctransform.input.datan=path-of-input-file

Specify the path of the input file as an absolute or relative path.

For n, specify 1 or greater integer (halfwidth) as a sequential number. If you specify duplicate integers for n, which property is valid is not guaranteed.

csctransform.input.namen=logical-name-of-input-schema

Specify the logical name of input schema when N-to-one transformation is to be performed. If you omit this property, an error occurs during data transformation.

For n, specify 1 or greater integer (halfwidth) as a sequential number starting from 1. If you specify duplicate integers for n, which property is valid is not guaranteed.

For one-to-one transformation, there is no need to specify this priority. If specified, this priority is ignored.

csctransform.output.format=path-of-output-format-definition-file

Specify the path of the output format definition file (extension: .xsd or .fdx) as an absolute or relative path.

If you specify the same property multiple times, which property is valid is not guaranteed.

csctransform.output.data=path-of-output-file

Specify the path of an output file as an absolute or relative path. If the output destination directory does not exist, an error occurs.

If a file with the specified name exists in the specified path, the existing file is overwritten. If there is no file with the specified name, a new file is created.

If you specify the same property multiple times, which property is valid is not guaranteed.

csctransform.uoc.class=class-name-of-character-code-conversion-UOC

Specify the class name of the character code conversion UOC by using a fully qualified name.

If the specified class name of the character code conversion UOC is duplicated, the specified value is applied according to the following priority.

Priority

Property file or command name

Relevant property or argument

1

System properties file for data transformation

csc.dt.ownCodeConverter.className

2

Data-transformation command properties file

csctransform.uoc.class

3

csctransform command

-uocclass

For details about the csc.dt.ownCodeConverter.className setting in the system properties file for data transformation, see 3.14.2 System properties file for data transformation. For details about the csctransform command, see csctransform (Testing data transformation).

csctransform.uoc.property=path-of-self-defined-file-for-character-code-conversion-UOC

Specify the path of the self-defined file for the character code conversion UOC as an absolute or relative path.

This property is valid only when the csctransform.uoc.class property (class name of the character code conversion UOC) is specified.

If you specify the same property multiple times, which property is valid is not guaranteed.

csctransform.code.table.root.path=root-path-of-code-conversion-table-storage-path

Specify, as an absolute or relative path, the root path of the storage path of the code conversion table to be used by the code conversion library.

csctransform.validate={true|false} ~ <<false>>

Specify whether to perform schema validation.

true

The following schema validation is performed:

Schema validation for input files (XML) is performed by using an input format definition file (XML Schema).

Schema validation for output files (XML) is performed by using an output format definition file (XML Schema).

false

Schema validation is not performed.

If you specify the same property multiple times, which property is valid is not guaranteed.

csctransform.debugtrace={ON|OFF} ~ <<OFF>>

Specify whether to output debug information.

ON

Output debug information.

OFF

Do not output debug information.

csctransform.debugtrace.filepath=path-to-output-debug-information ~ <<current directory in which the csctransform command was executed>>

Specify the output destination path of debug information as an absolute or relative path.

This property is valid only when ON is specified for the csctransform.debugtrace property.

In the following cases, the default value is applied and the debug information is output to the current directory in which the csctransform command was executed:

This property is not set.

The output destination is not specified for this property.

The specified directory does not exist.

csctransform.system.properties=path-of-system-properties-file-for-data-transformation

To enable the system properties for Service Platform specified in the system properties file for data transformation, this property specifies the path of the file as an absolute or relative path.

For details about the settings in the system properties file for data transformation, see 3.14.2 System properties file for data transformation.

If you specify the same property multiple times, which property is valid is not guaranteed.

csctransform.undefined.code={ERROR|REPLACE} ~ <<ERROR>>

Specifies the operation to be performed when an undefined character code is detected during code conversion for binary data.

ERROR

When an undefined character code is detected, an error occurs and the processing ends.

REPLACE

The character code of undefined portions is converted to a blank character code, and the processing continues.

If you specify the same property multiple times, which property is valid is not guaranteed.

(4) Notes

If you use a wildcard to specify a path, operations are not guaranteed.

To use a backslash (\) as a path separator, add an escape character.

3.14.2 System properties file for data transformation

(1) Format

[csc.dt.codetablepath=storage-path-of-code-conversion-table]
[csc.dt.ownCodeConverter.className=class-name-of-character-code-conversion-UOC]
[csc.dt.customFuncDir=storage-path-of-JAR-files-used-for-custom-functions]
[csc.dt.valueTable.conversion-table-ID=file-path-of-conversion-table-used-by-change-value-function]
[csc.dt.valueTableSize=total-file-size-of-conversion-table-used-by-change-value-function]
[csc.dt.encodeType.conversion-table-ID={MS932|UTF8|UTF16_BIG|UTF16_LITTLE}]
[csc.dt.undefined.replace.data-transformation-type=conversion-destination-character-code]
[csc.dt.sizeNode.includeSelfSize={true|false}]

(2) Function

Specifies the system properties for data transformation in Service Platform. The file that has been set up can be specified when the cscbinaryparse command, csctransform command, or cscgenbinary command is executed.

(3) File storage location

The template file is stored in the following location. Copy the template file to any directory, edit the file, and then save it with any file name.

Location of the template file:

service-platform-installation-directory\CSCTE\template\csctransform_sys.properties

(4) Specifiable properties

csc.dt.codetablepath=storage-path-of-code-conversion-table

To use a code conversion API with the character code conversion UOC, specify the storage path of the code conversion table of Code Converter in the following format:

code-conversion-table-storage-directory-path/table

For details about how to specify this, see the manual Service Platform Basic Development Guide.

csc.dt.ownCodeConverter.className=class-name-of-character-code-conversion-UOC

Register the class name of the character code conversion UOC created in the development environment, by using a fully qualified name. You must specify this property when using this character code conversion UOC in the execution environment. For details about how to specify the settings, see the manual Service Platform Basic Development Guide.

You can also specify this property in the cscbinaryparse, csctransform, and cscgenbinary commands and their command properties files. If this property is specified in multiple commands or files, the value specified in the system properties file for data transformation overrides other values. The following shows the relevant properties and arguments.

Property file or command name

Relevant property or argument

System properties file for data transformation

csc.dt.ownCodeConverter.className

Binary-parse command properties file (command property file for the cscbinaryparse command)

Data-transformation command properties file (command property file for the csctransform command)

Binary-message-generation command properties file (command property file for the cscgenbinary command)

csctransform.uoc.class

cscbinaryparse command

csctransform command

cscgenbinary command

-uocclass

csc.dt.customFuncDir=storage-path-of-JAR-files-used-for-custom-functions

To change the storage location of the JAR files used for the custom functions, specify the path.

Important note

If a directory under the service platform installation directory is specified as the JAR file storage location, the JAR files might be deleted when the service platform is uninstalled. To prevent such problems, specify a location that is not under the installation directory.

csc.dt.valueTable.conversion-table-ID=file-path-of-conversion-table-used-by-change-value-function

If the data transformation definition created in the development environment contains the change value function, specify the file path of the conversion table to be used by the change value function.

conversion-table-ID

Specify the conversion table ID of the conversion table.

file-path-of-conversion-table

Specify the file path of the conversion table as an absolute path.

total-file-size-of-conversion-table-used-by-change-value-function ~ <Number>((1-2097151))<<10>>

If the data transformation definition created in the development environment contains the change value function, specify the upper limit of the total file size of the conversion table (unit: KB) that can be used by the change value function. You can use positive integers.

If you omit this property, 10 is assumed. If an attempt is made to read a conversion table larger than the upper limit, a KDEC40730-E message is output to the log file of the J2EE server and the startup of the HCSC server is canceled.

csc.dt.encodeType.conversion-table-ID ={MS932|UTF8|UTF16_BIG|UTF16_LITTLE}

If the data transformation definition created in the development environment contains the change value function, specify the character code to be used by the change value function.

csc.dt.undefined.replace.data-transformation-type=conversion-destination-character-code

During conversion between binary data and Unicode characters, undefined character codes are converted to space characters by default. However, they can be converted to any characters specified in this property.

To convert undefined character codes to any characters of your choice, you must specify REPLACE in one of the following:

-undefinedcode argument of the csctransform command

csctransform.undefined.code property of the data-transformation command properties file

The property to be specified differs as follows depending on the character code to be converted and the conversion type. Specify the character after conversion by using a hexadecimal number.

To convert binary data to Unicode characters

Specify the conversion-destination character code by using a hexadecimal number in Unicode big endian format for the relevant system property.

The following table lists the system properties that can be specified. You can specify one of these system properties for each conversion type of input binary data.

Table 3‒2: List of system properties (for conversion from binary data to Unicode characters)

No.

Key name

Conversion type

Conversion-destination Unicode character code

1

csc.dt.undefined.replace.bin2xml

Halfwidth

Unicode big endian

2

csc.dt.undefined.replace.bin2xml.full

Fullwidth

To convert Unicode characters to binary data

Specify the conversion character code by using a hexadecimal number for the relevant system property.

The following table lists the system properties that can be specified. You can specify one of these system properties for each character code and conversion type of conversion-destination binary data.

Table 3‒3: List of system properties (for conversion from Unicode characters to binary data)

No.

Key name

Conversion type

Character code of conversion-destination binary data

1

csc.dt.undefined.replace.xml2utf16be

Halfwidth

UTF16 big endian

2

csc.dt.undefined.replace.xml2utf16be.full

Fullwidth

3

csc.dt.undefined.replace.xml2utf16le

Halfwidth

UTF16 little endian

4

csc.dt.undefined.replace.xml2utf16le.full

Fullwidth

5

csc.dt.undefined.replace.xml2utf8

Halfwidth

UTF8

6

csc.dt.undefined.replace.xml2utf8.full

Fullwidth

7

csc.dt.undefined.replace.xml2ms932

Halfwidth

MS932

8

csc.dt.undefined.replace.xml2ms932.full

Fullwidth

9

csc.dt.undefined.replace.xml2keisC

Halfwidth

KEIS + EBCDIC

10

csc.dt.undefined.replace.xml2keisC.full

Fullwidth

11

csc.dt.undefined.replace.xml2keisK

Halfwidth

KEIS + EBCDIK

12

csc.dt.undefined.replace.xml2keisK.full

Fullwidth

13

csc.dt.undefined.replace.xml2keis.full

Fullwidth

KEIS

14

csc.dt.undefined.replace.xml2ibmC.latin

Halfwidth

IBM + EBCDIC (LATIN)

15

csc.dt.undefined.replace.xml2ibmC.latin.full

Fullwidth

16

csc.dt.undefined.replace.xml2ibmC.kana

Halfwidth

IBM + EBCDIC (KANA)

17

csc.dt.undefined.replace.xml2ibmC.kana.full

Fullwidth

18

csc.dt.undefined.replace.xml2ibm.full

Fullwidth

IBM

19

csc.dt.undefined.replace.xml2jefC

Halfwidth

JEF + EBCDIC

20

csc.dt.undefined.replace.xml2jefC.full

Fullwidth

21

csc.dt.undefined.replace.xml2jefK

Halfwidth

JEF + EBCDIK

22

csc.dt.undefined.replace.xml2jefK.full

Fullwidth

23

csc.dt.undefined.replace.xml2jef.full

Fullwidth

JEF

24

csc.dt.undefined.replace.xml2jis

Halfwidth

JIS

25

csc.dt.undefined.replace.xml2jis.full

Fullwidth

26

csc.dt.undefined.replace.xml2euc

Halfwidth

EUC

27

csc.dt.undefined.replace.xml2euc.full

Fullwidth

28

csc.dt.undefined.replace.xml2euchj

Halfwidth

EUC_HJ

29

csc.dt.undefined.replace.xml2euchj.full

Fullwidth

csc.dt.sizeNode.includeSelfSize={true|false} ~ <<false>>

Specify whether to use the extended size node function.

true

The extended size node function is used.

false

The extended size node function is not used.

3.14.3 Binary-message-generation command properties file

(1) Format

  csctransform.format=path-of-binary-format-definition-file
  csctransform.output.binary.data=path-of-output-binary-file
  csctransform.output.xml.data=path-of-output-XML-file
[csctransform.input.xml.data=path-of-input-XML-file]
[csctransform.generate.property=path-of-binary-message-generation-definition-file]
[csctransform.uoc.class=class-name-of-character-code-conversion-UOC]
[csctransform.uoc.property=path-of-self-defined-file-for-character-code-conversion-UOC]
[csctransform.code.table.root.path=root-path-of-code-conversion-table-storage-path]
[csctransform.debugtrace={ON|OFF}]
[csctransform.debugtrace.filepath=path-to-output-debug-information]
[csctransform.system.properties=path-of-system-properties-file-for-data-transformation]
[csctransform.undefined.code={ERROR|REPLACE}]

(2) Function

Specifies the arguments of the cscgenbinary command in the property format. The file that has been set up can be specified in the -f option of the cscgenbinary command that is to be executed. For details about the cscgenbinary command, see cscgenbinary (Generating binary messages from binary format definition files).

Correspondence with the arguments of the cscgenbinary command

The following shows the correspondence between the properties specified in this file and the arguments of the cscgenbinary command.

No.

Property key name

Corresponding command argument

Settings

1

csctransform.format

-format

Path of the binary format definition file

2

csctransform.output.binary.data

-outbinfile

Path of the output binary file

3

csctransform.output.xml.data

-outxmlfile

Path of the output XML file

4

csctransform.input.xml.data

-inxmlfile

Path of the input XML file

5

csctransform.generate.property

-genproperty

Path of the binary-message-generation definition file

6

csctransform.uoc.class

-uocclass

Class name of the character code conversion UOC

7

csctransform.uoc.property

-uocproperty

Path of the self-defined file for the character code conversion UOC

8

csctransform.code.table.root.path

-codetablerootpath

Root path of the code conversion table storage path

9

csctransform.debugtrace

-debugtrace

Whether to output debug information

10

csctransform.debugtrace.filepath

-debugtracefilepath

Path to output debug information

11

csctransform.system.properties

-cscdtsysprop

Path of the system properties file for data transformation

12

csctransform.undefined.code

-undefinedcode

Handling of undefined character codes

How to edit the file

Specify the file in the Java property file format. The available character code is UTF-8 only.

Edit the following template file and save it with any file name.

Location of the template file

service-platform-installation-directory\CSCTE\template\cscdt_cscgenbinary.properties

(3) Specifiable properties

csctransform.format=path-of-binary-format-definition-file

Specify, as an absolute or relative path, the path of the binary format definition file that has been validated in the editor.

The available file extension is .fdx only. The file extension is not case sensitive.

csctransform.output.binary.data=path-of-output-binary-file

Specify the path of the output binary file as an absolute or relative path. If the output destination directory does not exist, an error occurs.

You must specify either csctransform.output.binary.data (path of the output binary file) or csctransform.output.xml.data (path of the output XML file).

If a file with the specified name exists in the specified path, the existing file is overwritten. If there is no file with the specified name, a new file is created.

csctransform.output.xml.data=path-of-output-XML-file

Specify the path of the output XML file as an absolute or relative path. If the output destination directory does not exist, an error occurs.

You must specify either csctransform.output.binary.data (path of the output binary file) or csctransform.output.xml.data (path of the output XML file).

If a file with the specified name exists in the specified path, the existing file is overwritten. If there is no file with the specified name, a new file is created.

csctransform.input.xml.data=path-of-input-XML-file

Specify the input XML file as an absolute or relative path to generate a binary message from an XML file.

This property is invalid if specified along with csctransform.output.xml.data.

The specified input XML file must comply with the XML schema file generated by using the cscfdx2xsd command based on the binary format definition file (specified in csctransform.format). If the input XML file does not comply with the XML schema file, operations are not guaranteed.

csctransform.generate.property=path-of-binary-message-generation-definition-file

Specify the path of the binary-message-generation definition file as an absolute or relative path.

This property is invalid if specified along with csctransform.input.xml.data.

Create the binary-message-generation definition file if you want to change element values of a simple content element from the default values. For details about the binary-message-generation definition file, see 3.14.4 Binary-message-generation definition file.

csctransform.uoc.class=class-name-of-character-code-conversion-UOC

Specify the class name of the character code conversion UOC by using a fully qualified name.

You can also specify the class name of the character code conversion UOC in the following files or command. The following shows the priority by which the value will be applied if specifications are duplicated.

Priority

Property file or command name

Relevant property or argument

1

System properties file for data transformation

csc.dt.ownCodeConverter.className

2

Binary-message-generation command properties file

csctransform.uoc.class

3

cscgenbinary command

-uocclass

For details about the csc.dt.ownCodeConverter.className setting in the system properties file for data transformation, see 3.14.2 System properties file for data transformation. For details about the cscgenbinary command, see cscgenbinary (Generating binary messages from binary format definition files).

To use the character code conversion UOC, you need to set the JAR file of the character code conversion UOC in the system environment variable CSC_DATA_TRANSFORM_CLASSPATH. To invoke a class defined in an external JAR file from a custom function or character code conversion UOC, you also need to specify the relevant JAR file in the environment variable.

csctransform.uoc.property=path-of-self-defined-file-for-character-code-conversion-UOC

Specify the path of the self-defined file for the character code conversion UOC as an absolute or relative path.

This property is invalid if the csctransform.uoc.class property is not specified. If you specify the csctransform.uoc.class property and omit this property, the class of the character code conversion UOC is executed without reading the self-defined file during data transformation.

csctransform.code.table.root.path=root-path-of-code-conversion-table-storage-path

Specify, as an absolute or relative path, the root path of the storage path of the code conversion table to be used by the code conversion library.

csctransform.debugtrace={ON|OFF} ~ <<OFF>>

Specify whether to output debug information.

ON

Output debug information.

OFF

Do not output debug information.

csctransform.debugtrace.filepath=path-to-output-debug-information ~ <<current directory in which the cscgenbinary command was executed>>

Specify the output destination path of debug information as an absolute or relative path.

This property is valid only when ON is specified for the csctransform.debugtrace property.

In the following cases, the default value is applied and the debug information is output to the current directory in which the cscgenbinary command was executed:

This property is not set.

The output destination is not specified for this property.

The specified directory does not exist.

csctransform.system.properties=path-of-system-properties-file-for-data-transformation

To enable the system properties for Service Platform specified in the system properties file for data transformation, this property specifies the path of the file as an absolute or relative path.

For details about the settings specified in the system properties file for data transformation, see 3.14.2 System properties file for data transformation.

csctransform.undefined.code={ERROR|REPLACE} ~ <<ERROR>>

Specify the operation to be performed when an undefined character code is detected during code conversion for binary data. You can omit this argument.

ERROR

When an undefined character code is detected, an error occurs and the processing ends.

REPLACE

The character code of undefined portions is converted to a blank character code, and the processing continues.

(4) Notes

If you use a wildcard to specify a path, operations are not guaranteed.

To use a backslash (\) as a path separator, add an escape character.

3.14.4 Binary-message-generation definition file

(1) Format

You can code the file by using any of the following three formats.

Specification format 1

element-name-as-absolute-path-from-root=set-value

Specification format 2

element-name=set-value

Specification format 3

[CSCDT_STRING=set-value-of-data-type-String]
[CSCDT_INT=set-value-of-data-type-Integer]
[CSCDT_DOUBLE=set-value-of-data-type-Real-number]
[CSCDT_IMPLICIT=set-value-of-data-type-Fixed-decimal-number]
[CSCDT_ZONE=set-value-of-data-type-Numeric-value-in-zone-format]
[CSCDT_PACK=set-value-of-data-type-Numeric-value-in-pack-format]
[CSCDT_SIGNED=set-value-of-data-type-Signed-binary-integer]
[CSCDT_UNSIGNED=set-value-of-data-type-Unsigned-binary-integer]
[CSCDT_BINARY_HEX=set-value-of-data-type-Byte-string-(hexBinary)]
[CSCDT_BINARY_BASE64=set-value-of-data-type-Byte-string-(base64Binary)]
[CSCDT_BIT=set-value-of-data-type-Bit-string]
[CSCDT_DATETIME=set-value-of-data-type-Date/time]

If the same element is coded in different specification formats, the value is applied according to the following priority:

Specification format 1

Specification format 2

Specification format 3

(2) Function

If you want to change an element value of a simple content element from the default value when generating a binary message, this value sets a new value. The available character code is UTF-8 only.

Specify this file when generating a binary message by using the following command or property file. When generating a binary message with the default values, you do not have to set up this file. If this file is not set up, the default element values are applied.

cscgenbinary command

Specify the name of the binary-message-generation definition file in the -genproperty option.

For details about the cscgenbinary command, see cscgenbinary (Generating binary messages from binary format definition files).

binary-message-generation command properties file

Specify the name of the binary-message-generation definition file in the csctransform.generate.property property.

For details about the binary-message-generation command properties file, see 3.14.3 Binary-message-generation command properties file.

(3) File storage location

The template file is stored in the following location.

Location of the template file:

service-platform-installation-directory\CSCTE\template\cscdt_generatedef.properties

The template file is coded in the property format (specification format 3). Copy the template file to any directory, edit the file, and then save it with any file name.

(4) Specifiable values

The following shows the default element values for a simple content element and the XML types. Specify an appropriate value in the file according to the relevant XML type.

Table 3‒4: Set values of a binary-message-generation definition file

Data type

XML type

Default value

Property name in specification format 3

String

xsd:string

Empty string (length 0 bytes)

CSCDT_STRING

Integer

xsd:decimal

0

CSCDT_INT

Real number

xsd:decimal

0

CSCDT_DOUBLE

Fixed decimal number

xsd:decimal

0

CSCDT_IMPLICIT

Numeric value in zone-format

xsd:decimal

0

CSCDT_ZONE

Numeric value in pack format

xsd:decimal

0

CSCDT_PACK

Signed binary integer

xsd:integer

0

CSCDT_SIGNED

Unsigned binary integer

xsd:integer

0

CSCDT_UNSIGNED

Byte string (hexBinary)

xsd:hexBinary

00 (0x00)

CSCDT_BINARY_HEX

Byte string (base64Binary)

xsd:base64Binary

AA== (0x00)

CSCDT_BINARY_BASE64

Bit string

xsd:hexBinary

00 (0x00)

CSCDT_BIT

Date/time

xsd:date

YYMMDD format

2000-01-01

(000101 after binary conversion)

CCYYMMDD format

2000-01-01

(20000101 after binary conversion)

CSCDT_DATETIME

xsd:time

hhmmss format

00:00:00

(000000 after binary conversion)

xsd:dateTime

YYMMDDhhmmss format

2000-01-01T00:00:00

(000101000000 after binary conversion)

CCYYMMDDhhmmss format

2000-01-01T00:00:00

(20000101000000 after binary conversion)

The following describes the specification formats and shows specification examples. If no value is specified for set-value after =, the element will be an empty element.

Specification format 1

element-name-as-absolute-path-from-root=set-value

Specify an element name as an absolute path from the root and the set value after the change.

The specification example is as follows.

Example: /root/complex/element=abc

Specification format 2

element-name=set-value

Specify an element name without a path and the set value after the change.

The specification example is as follows.

Example: element=abc

Specification format 3

property-name=set-value

Specify a property name in Table 3-4 Set values of a binary-message-generation definition file and the set value after the change according to the data type.

The specification example is as follows.

Example: CSCDT_STRING=abc

3.14.5 Binary-parse command properties file

(1) Format

  csctransform.format=path-of-binary-format-definition-file
  csctransform.input.data=path-of-input-data-file
  csctransform.output.data=path-of-output-data-file
[csctransform.inverse={true|false}]
[csctransform.uoc.class=class-name-of-character-code-conversion-UOC]
[csctransform.uoc.property=path-of-self-defined-file-for-character-code-conversion-UOC]
[csctransform.code.table.root.path=root-path-of-code-conversion-table-storage-path]
[csctransform.debugtrace={ON|OFF}]
[csctransform.debugtrace.filepath=path-to-output-debug-information]
[csctransform.system.properties=path-of-system-properties-file-for-data-transformation]
[csctransform.undefined.code={ERROR|REPLACE}]

(2) Function

Specifies the arguments of the cscbinaryparse command in the property format. The file that has been set up can be specified in the -f option of the cscbinaryparse command to be executed. For details about the cscbinaryparse command, see cscbinaryparse (Mutually transforming DOM and binary data).

Correspondence with the arguments of the cscbinaryparse command

The following shows the correspondence between the properties specified in this file and the arguments of the cscbinaryparse command.

No.

Property key name

Corresponding command argument

Settings

1

csctransform.format

-format

Path of the binary format definition file

2

csctransform.input.data

-infile

Path of the input data file

3

csctransform.output.data

-outfile

Path of the output data file

4

csctransform.inverse

-inverse

Transformation operation between binary and DOM data

5

csctransform.uoc.class

-uocclass

Class name of the character code conversion UOC

6

csctransform.uoc.property

-uocproperty

Path of the self-defined file for the character code conversion UOC

7

csctransform.code.table.root.path

-codetablerootpath

Root path of the code conversion table storage path

8

csctransform.debugtrace

-debugtrace

Whether to output debug information

9

csctransform.debugtrace.filepath

-debugtracefilepath

Output destination path of debug information

10

csctransform.system.properties

-cscdtsysprop

Path of the system properties file for data transformation

11

csctransform.undefined.code

-undefinedcode

Handling of undefined character codes

How to edit the file

Specify the file in the Java property file format. The available character code is UTF-8 only.

Edit the following template file, and then save it with any file name.

Location of the template file

service-platform-installation-directory\CSCTE\template\cscdt_cscbinaryparse.properties

(3) Specifiable properties

csctransform.format=path-of-binary-format-definition-file

Specify the path of the input format definition file as an absolute or relative path.

The available file extension is .fdx only.

csctransform.input.data=path-of-input-data-file

Specify the path of the input data file as an absolute or relative path.

You can specify any of the following types of data as the input data file:

Binary data

Either of the following DOM data (XML)

DOM data generated from binary data by using DOM transformation

DOM data that complies with the XML schema file generated by using the cscfdx2xsd command in which the binary format definition file (specified in csctransform.format) is specified

csctransform.output.data=path-of-output-data-file

Specify the path of the output data file as an absolute or relative path. If the output destination directory does not exist, an error occurs.

If a file with the specified name exists in the specified path, the existing file is overwritten. If there is no file with the specified name, a new file is created.

csctransform.inverse={true|false} ~ <<false>>

This property switches the transformation operation between binary data and DOM data.

true

DOM data is transformed to binary data.

false

Binary data is transformed to DOM data.

csctransform.uoc.class=class-name-of-character-code-conversion-UOC

Specify the class name of the character code conversion UOC by using a fully qualified name.

If the specified class name of the character code conversion UOC is duplicated, the specified value is applied according to the following priority.

Priority

Property file or command name

Relevant property or argument

1

System properties file for data transformation

csc.dt.ownCodeConverter.className

2

Binary-parse command properties file

csctransform.uoc.class

3

cscbinaryparse command

-uocclass

For details about the csc.dt.ownCodeConverter.className setting in the system properties file for data transformation, see 3.14.2 System properties file for data transformation. For details about the cscbinaryparse command, see cscbinaryparse (Mutually transforming DOM and binary data).

csctransform.uoc.property=path-of-self-defined-file-for-character-code-conversion-UOC

Specify the path of the self-defined file for the character code conversion UOC as an absolute or relative path.

This property is invalid if the csctransform.uoc.class property is not specified.

csctransform.code.table.root.path=root-path-of-code-conversion-table-storage-path

Specify, as an absolute or relative path, the root path of the storage path of the code conversion table to be used by the code conversion library.

csctransform.debugtrace={ON|OFF} ~ <<OFF>>

This property specifies whether to output debug information.

ON

Output debug information.

OFF

Do not output debug information.

csctransform.debugtrace.filepath=path-to-output-debug-information

Specify the output destination path of debug information as an absolute or relative path.

This property is valid only when the csctransform.debugtrace property is specified.

In the following cases, the default value is applied and the debug information is output to the current directory in which the ccscbinaryparse command was executed:

This property is not set.

The output destination is not specified for this property.

The specified directory does not exist.

csctransform.system.properties=path-of-system-properties-file-for-data-transformation

To enable the system properties for Service Platform specified in the system properties file for data transformation, this property specifies the path of the file as an absolute or relative path.

For details about the settings in the system properties file for data transformation, see 3.14.2 System properties file for data transformation.

csctransform.undefined.code={ERROR|REPLACE} ~ <<ERROR>>

Specify the operation to be performed when an undefined character code is detected during code conversion for binary data.

ERROR

When an undefined character code is detected, an error occurs and the processing ends.

REPLACE

The character code of undefined portions are converted to a blank character code, and the processing continues.

(4) Notes

If you use a wildcard to specify a path, operations are not guaranteed.

To use a backslash (\) as a path separator, add an escape character.

Part 2: Execution Environment and Operating Environment Reference

4 Windows (Operating Environment)

This chapter describes the windows that are used in the operating environment of a service platform.

4.1 Window structure (Operating environment)

This section describes how the windows used in the operating environment are organized.

Figure 4‒1: Window structure used in the operating environment

Menu bar

This is Eclipse's menu bar. The menu specific to the operating environment is HCSC-Manager.

Tree view

The tree view displays the icons that indicate the system configuration managed by the HCSC-Manager and the managed target (such as adapters and business processes). In the tree view, the icons displaying status are combined and displayed with the icons indicating management targets. The following table lists and describes icons displayed in the tree view:

Table 4‒1: Icons displayed in the tree view

Classification

Icon status

Explanation

Icon

Indicates the HCSC-Manager.

Indicates the HCSC-Domain.

Indicates a load-balancing cluster or HA cluster.

Indicates an HCSC server.

Indicates a business process.

Indicates a service adapter or database adapter.

Indicates a user-defined reception.

Status

Indicates one of the following:

active status for an HCSC server

active status for a service adapter or database adapter

Indicates inactive status.

Indicates shutdown status.

Indicates undeployed status.

Indicates an acquisition error.

If you select the management target in the tree view and right click, the context menu opens and you can perform operations for the management target.

Editor area

This editor is used for displaying and operating the information of the management targets displayed in the tree view. The following table lists and describes the types of editors:

Table 4‒2: Types of editors

Editor name

Page name

Function

HCSC server editor

Information page

Displays basic information about the HCSC server.

Definition information page

Displays definition information about the HCSC server.

Operations page

Executes HCSC server operations.

Resource Information page

Checks the resource information for HCSC server resources.

Business process editor

Information page

Displays basic information about the business process.

Operations page

Executes business process operations.

Tracking page

Manages process instance execution logs.

Service adapter editor

Information page

Displays basic information about the service adapter.

Operations page

Executes service adapter operations.

User-defined reception editor

Information page

Displays basic information about the user-defined reception.

Definition information page

Displays definition information about the user-defined reception.

Operations page

Displays operations about the user-defined reception.

Tab

Each tab displays one of the pages listed in Table 4-2 next to the editor names.

Console view

Log information is displayed here.

In the console view, log information is displayed in the following format:

yyyy/mm/ddΔhh:mm:ssΔapplication-nameΔmessage-IDΔmessage-text (Δ indicates a single-byte space.)

The application name is displayed as follows:

For logs of window operations: Plug-in

For log information from Manager: the Manager name that was specified at setup

If the message to be displayed exceeds 64 KB, 4KB of the oldest message is deleted in rows.

Shortcut

In the tree view and dialog boxes, if you press a key that is the same as the character with an underline such as (G) while pressing the Alt key, you can select the management target.

4.2 Information Page

The Information page displays the current basic information of the target managed by the HCSC-Manager. You can use this information to check the settings.

The Information page for each management target opens, if you select the management target from the tree view and choose the Basic Information tab in the editor area.

The Information page is explained for each management target below:

4.2.1 HCSC server basic information

In the Information page for an HCSC server, the information used for building the HCSC server is displayed. With this information, you can check the settings after the HCSC server is set up.

The following figure shows the Information page for the HCSC server and the items displayed on the page:

Figure 4‒2: Information page for an HCSC server

HCSC-Server display name

Displays the display name for the HCSC server. If the display name for the HCSC server is not specified, the name for the HCSC server is displayed.

HCSC-Server Name

Displays the name of the HCSC server.

Standard Reception Setup Status

Displays whether the following items are set up. If items are set up, On is displayed. If items are not set up, OFF is displayed. If an attempt to acquire the basic information fails, Acquisition Failed is displayed.

Synchronous (Web Service (SOAP1.1))

Synchronous (Web Service) (SOAP1.2))

Synchronous (SessionBean)

Asynchronous (MDB (WS-R))

Asynchronous (MDB (DBQ))

Dependency User-Defined Reception

Displays the name of the user-defined reception dependent on the HCSC server.

Dependency Business Processes

Displays the service name of the business process dependent on the HCSC server.

Dependency Service Adapter

Displays the service name of the service adapter dependent on the HCSC server.

4.2.2 Business process basic information

The Information page for a business process displays the basic information about the business process and enables you to check the business process settings. The following figure shows the Information page for a business process and the items displayed on the page:

Figure 4‒3: Information page for a business process

Service name

Displays the business process definition name or service name.

Service ID

Displays the service ID of the business process.

Modified time

Displays the date and time when the deployed business process was last updated. If the acquisition of the basic information fails, acquisition error is displayed, and - is displayed before the deployment of the business process.

Version

Displays the business process version.

Dependency HCSC-Server

Displays the display name of the dependent HCSC server.

Dependency User-Defined Reception

Displays the name of the dependent user-defined reception.

4.2.3 Service adapter basic information

The Information page for a service adapter displays the basic information about the service adapter and enables you to check the service adapter settings. The following figure shows the Information page for service adapters and the items displayed on the page:

Figure 4‒4: Information page for service adapters (When the service type is Web Service)

Service name

Displays the service name of the service adapter.

Service ID

Displays the service ID of the service adapter.

Service type

Displays the service type of the service adapter. Displays any one of the following types:

Web Service (SOAP1.1)

Web Service (SOAP1.2)

SessionBean

MDB (WS-R)

MDB (DBQ)

Custom adapter

Source queue name

In the case of an asynchronous adapter, displays the name of the queue used by the service adapter. - is displayed before the service adapter is deployed.

Modified time

Displays the date and time when the deployed service adapter was last updated. If the acquisition of the basic information fails, acquisition error is displayed and - is displayed before the service adapter is deployed.

Information for the Service

Displays the information according to the service types.

The following table lists and describes the service types and the corresponding service information:

Table 4‒3: Items displayed for the service information corresponding to service types

Service type

Service information

Item

Meaning

Web Service (SOAP1.1)

Web Service (SOAP1.2)

SessionBean

URL

Displays the Web Service URL.

Connection timeout(sec)

Displays a connection timeout value of the socket during the service module call

Read timeout(sec)

Displays a reading timeout value of the socket during the service module call

Write timeout(sec)

Displays a writing timeout value of the socket during the service module call

HTTP session support

Specify whether to support the HTTP session.

true

Support session.

false

Do not support session.

Check if basic authentication is required

Displays whether the service adapter uses basic authentication. One of the following is displayed:

true

Used.

false

Not used.

Basic authentication user

Displays The value has already been set., if the basic authentication user ID is set up.

Basic authentication password

Displays The value has already been set., if the basic authentication password is set up.

Non-proxy server host

Displays the host name or IP address to be used when the proxy server is not used.

Proxy server host

Displays the host name or IP address of the proxy server.

Proxy server port

Displays the port number of the proxy server.

Proxy server user

Displays The value has already been set., if the authentication user ID is set up for the proxy server.

Proxy server password

Displays The value has already been set., if the password corresponding to the authentication user ID is set up for the proxy server.

Performance trace level

Displays whether the performance analysis trace is output. One of the following is displayed:

ALL

The performance analysis trace is output at trace collection points.

NONHANDLER

The performance analysis trace is not output at trace collection points.

For details about trace collection points, see the description of client definition file settings in the manual Application Server SOAP Application Development Guide.

Max. receivable SOAP envelope size

Displays the maximum number of bytes that can be received for SOAP envelope.

Max. sendable SOAP envelope size

Displays the maximum number of bytes that can be sent for a SOAP envelope.

URL

Displays URL of Web Service.

Connection timeout [seconds]

Displays a connection timeout value of the socket during the service module call.

Read timeout [seconds]

Displays a reading timeout value of the socket during the service module call.

HTTP session support

Specify whether to support the HTTP session.

true

Support session.

false

Do not support session.

Check if basic authentication use is required

Displays whether the service adapter uses basic authentication. Displays one of the following:

true

Used.

false

Not used.

Basic authentication user

Displays The value has already been set., if the basic authentication user ID is set up.

Basic authentication password

Displays The value has already been set., if the basic authentication password is set up.

URL

Displays the Naming Service URL.

Lookup name

Displays a name of the service module that is registered in the JNDI name space and that is to be invoked.

EJB call timeout

Displays a timeout value of business method call during the service module call

Performance trace level

Displays whether the performance analysis trace is output. One of the following is displayed:

ALL

The performance analysis trace is output at trace collection points.

NONHANDLER

The performance analysis trace is not output at trace collection points.

For details about trace collection points, see the description of client definition file settings in the manual Application Server SOAP Application Development Guide.

MDB (WS-R)

Sender queue name

Displays the queue name to which a service adapter sends messages.

Call settings

Displays whether to connect to service components of the remote host or to service components of the local host. When connecting to service components of the remote host, Remote Call is displayed. When connecting to service components of the local host, Local Call is displayed.

URL

Displays the message transfer destination URL for the transmit queue used by service adapters. If Call Settings is Local Call, nothing is displayed.

The number of the maximum messages

Displays the maximum number of messages that you can store in the transmit queue used by service adapters. If Call Settings is Local Call, nothing is displayed.

Order guarantee

Displays whether to guarantee that the transmit queue used by the service adapter transmits messages in the correct order. One of the following is displayed:

ON

Order is guaranteed.

OFF

Order is not guaranteed.

If Call Settings is Local Call, nothing is displayed.

RD area for creating a transmit queue

Displays name of the RD area for creating a transmit queue used by service adapters. If Call Settings is Local Call, nothing is displayed.

MDB (DBQ)

Sender queue name

Displays the queue name associated with service components.

Dependency HCSC-server

Displays the display name of the dependent HCSC server.

4.2.4 User-defined reception basic information

The User-defined reception information page displays the basic information about the user-defined reception and enables you to check the user-defined reception settings. The following figure shows the User-defined reception information page and the items displayed on the page:

Figure 4‒5: User-defined reception information page

Reception name

Displays the reception name of the user-defined reception.

Reception ID

Displays the reception ID of the user-defined reception.

Reception type

Displays the reception type of the user-defined reception. Either of the following type is displayed.

Web Service

Custom

Modified time

Displays the date and time when the user-defined reception was last updated. If the acquisition of the basic information fails, acquisition error is displayed, and - is displayed before the deployment of the user-defined reception.

Dependency HCSC-server

Displays the display name of the dependent HCSC server.

Dependency Business Process

Displays the service name of the dependent business process. A hyphen (-) is displayed for the user-defined reception (invocation target specified).

4.3 Definition information Page

The definition information page displays the definition information specified for the management target and applied in the execution environment. You can change this information even after building the HCSC server.

The definition information page for each management target opens, if you select the management target from the tree view and choose the definition information tab in the editor area. Also, to display the changed definition information on the window, switch to another page and then re-open the definition information page.

The definition information page for each management target is explained below:

4.3.1 HCSC server definition information

The following figure shows the Definition information page for the HCSC server and the items displayed on the page:

Figure 4‒6: Definition information page for an HCSC server

HCSC-Server display Name

Displays the display name for the HCSC server.

Synchronous standard reception (WebService (SOAP1.1))

Displays the following information. If the acquisition of definition information fails, acquisition error is displayed. - is displayed if this reception is not set up.

Maximum number of concurrent threads

Displays the maximum number of concurrent executions of synchronous reception (Web Services (SOAP1.1)).

Number of exclusive threads

Displays the number of occupied threads of synchronous reception (Web Services (SOAP1.1)).

Size of queue for threads waiting to be acquired

Displays the execution-waiting queue size of the synchronous reception (Web Services (SOAP1.1)).

Synchronous reception (Web Service (SOAP1.2))

Displays the following information. Displays Collection failed, if an attempt to collect the definition information fails. Displays -, if this reception is not set up.

Maximum concurrent executions

Displays maximum concurrent executions of the synchronous reception (Web Service (SOAP1.2)).

Number of dedicated threads

Displays the number of dedicated threads of the synchronous reception (Web Service (SOAP1.2)).

Pending queue size

Displays pending queue size of the synchronous reception (Web Service (SOAP1.2)).

Synchronous standard reception (SessionBean)

Displays the following information. If the acquisition of definition information fails, acquisition error is displayed. - is displayed if this reception is not set up.

Minimum number of instances

Displays the minimum number of instances of synchronous reception (SessionBean).

Maximum number of instances

Displays the maximum number of instances of synchronous reception (SessionBean).

CTM linkage

Displays whether the CTM is linked.

Number of CTM threads

Displays the number of threads provided for CTM to invoke an application.

Asynchronous standard reception (MDB (WS-R))

Displays the following information. If the acquisition of definition information fails, acquisition error is displayed. - is displayed if this reception is not set up.

Maximum number of instances

Displays the maximum number of instances of asynchronous reception (MDB (WS-R)).

4.3.2 User-defined reception definition information

The following figure shows the screen of Definition information page for user-defined reception and the items displayed on the page:

Figure 4‒7: Definition Information page for the user-defined reception

If the acquisition of information fails, acquisition error is displayed in the items other than the Reception name item. When the user-defined reception has not been deployed, - is displayed in the items other than the Reception name item.

Reception name

Displays the name of the user-defined reception.

Maximum number of concurrent threads

Displays the number of maximum concurrent executions defined in the user-defined reception.

Number of exclusive threads

Displays the number of occupied threads defined in the user-defined reception.

Size of queue for threads waiting to be acquired

Displays the size of the execution-waiting queue defined in the user-defined reception.

4.4 Operations Page

The Operations page opens, if you select the management target from the tree view and choose the Operations tab in the editor area. The operations for HCSC server and standard reception will be executed through the Operations page. The contents displayed in the HCSC server, service adapter, business process, or user-defined reception is different.

The Operations page for each management target is explained below.

4.4.1 HCSC server operations

The following figure shows the Operations page for the HCSC server and the items displayed on the page:

Figure 4‒8: Operations page of HCSC server

HCSC-Server display name

Displays the display name of the HCSC server on which you are performing operations using this window.

Status

Displays the operating status of the HCSC server. Displays one of the following:

inactive

active

stopping

starting

acquisition error

Even in cases other than starting or stopping of the HCSC server, the status might change with the reporting from the execution environment.

Standard reception status

Displays the operating status of the standard reception. Displays one of the following:

inactive

active

stopping

starting

stop error

start error

acquisition error

Even in cases other than starting or stopping of standard reception, the status might change with the reporting from the execution environment.

Dependency User-Defined Reception

Displays the status of the user-defined reception dependent on the HCSC server, in a list.

Reception name

Displays the name of the dependent user-defined reception.

Dependency service name

Displays the service name on which the user-defined reception depends. A hyphen (-) is displayed for the user-defined reception (invocation target specified).

Status

Displays the status of the dependent user-defined reception. Displays one of the following:

inactive

active

stopping

starting

stop error

start error

acquisition error

HCSC-Server

Start button

The HCSC-Server will now start.

Stop button

The HCSC-Server will now stop.

Standard reception

Start button

Start the standard reception.

Normal Stop button

Terminate the standard reception. Use this button to stop the standard reception during normal operations.

Planned Stop button

Terminate the standard reception. Use this button to cancel HCSC server setup.

4.4.2 Service adapter operations

The following figure shows the Operations page for service adapters and the items displayed on the page:

Figure 4‒9: Operations page for service adapters

Service name

Displays the service name of the service adapter on which you are performing operations using this window.

Status

Displays the operating status of service adapters. Displays one of the following:

inactive

active

stopping

starting

stop error

start error

acquisition error

pre-deployment status

Even in cases other than starting or stopping of service adapters, the status might change with reporting from the execution environment.

Dependency HCSC-Server

Displays the information about the dependent HCSC server.

HCSC-Server display name

Displays the display name of the dependent HCSC server.

Status

Displays the operating status of the HCSC server on which service adapters are deployed. Displays one of the following:

inactive

active

stopping

starting

acquisition error

Even in cases other than starting or stopping of service adapters, the status might change with reporting from the execution environment.

Start button

The service adapter will now start.

Stop button

The service adapter will now stop.

4.4.3 Business process operations

The following figure shows the screen of Operations page for business processes and the items displayed on the page:

Figure 4‒10: Operations page for business processes

Service name

Displays the service name of the business process on which you are performing operations using this window.

Status

Displays the operating status of the business process. Displays one of the following:

inactive

active

stopping

starting

stop error

start error

acquisition error

pre-deployment status

Even in cases other than starting or stopping of business processes, the status might change with reporting from the execution environment.

Dependency HCSC-Server

Displays the information about the dependent HCSC server.

HCSC-Server display name

Displays the display name of the dependent HCSC server.

Status

Displays the operating status of the HCSC server on which business processes are deployed. Displays one of the following:

inactive

active

stopping

starting

acquisition error

Even in cases other than starting or stopping of business processes, the status might change with reporting from the execution environment.

Dependency User-Defined Reception

Displays the information about the dependent user-defined reception.

Reception name

Displays the reception name of the user-defined reception. The reception name is displayed only for the defined user-defined reception.

Status

Displays the operating status of the user-defined reception. The reception name is displayed only for the defined user-defined reception. Displays one of the following:

inactive

active

stopping

starting

acquisition error

pre-deployment status

Even in cases other than starting or stopping of business processes, the status might change with reporting from the execution environment.

Start button

The business process will now start.

Stop button

The business process will now stop.

4.4.4 User-defined reception operations

The following figure shows the screen of Operations page for the user-defined reception and the items displayed on the page:

Figure 4‒11: Operations page for the user-defined reception

Reception name

Displays the name of the user-defined reception to be operated using this window.

Status

Displays the operating status of the user-defined reception. Displays one of the following:

inactive

active

stopping

starting

stop error

start error

acquisition error

pre-deployment status

Even in cases other than starting or stopping of the user-defined reception, the status might change with reporting from the execution environment.

Dependency HCSC-Server

Displays the information about the dependent HCSC server.

HCSC-Server display name

Displays the display name of the dependent HCSC server.

Status

Displays the operating status of the HCSC server on which the user-defined reception is deployed. Displays one of the following:

inactive

active

stopping

starting

acquisition error

Even in cases other than starting or stopping of the user-defined reception, the status might change with reporting from the execution environment.

Dependency Business Process

Displays the information about the dependent business processes.

Service name

Displays the service name of the dependent business process. A hyphen (-) is displayed for the user-defined reception (invocation target specified).

Status

Displays the operating status of the business process. Displays one of the following:

inactive

active

stopping

starting

stop error

start error

acquisition error

pre-deployment status

A hyphen (-) is displayed for the user-defined reception (invocation target specified).

Even in cases other than starting or stopping of the user-defined reception, the status might change with reporting from the execution environment.

Start button

Start the user-defined reception.

Stop button

Terminate the user-defined reception.

4.5 Resource Information page

The Resource Information page displays the resource information for the HCSC server. The Resource Information page opens if you choose the Resource information tab in the editor area.

The following figure shows the Resource Information page and the items displayed on the page:

Figure 4‒12: Resource Information page

HCSC-Server Display name

Displays the display name for the HCSC server.

HCSC-Server Status

Displays the operating status of the HCSC server. Displays one of the following:

inactive

active

stopping

starting

acquisition error

Resource Notification

Displays whether the statistic information is reported from the execution environment to the HCSC server. When the statistic information is reported, ON is displayed and when the statistic information is not reported, OFF is displayed.

Time that resource information was collected

Displays the time at which the statistic information is acquired. Hyphen (-) is displayed if the HCSC server is not in the active status. If the acquisition of operating information fails, acquisition error is displayed.

As shown in the figure, the statistic information is the information that is acquired 60 seconds (default) before the displayed statistics information acquisition time.

Figure 4‒13: Relationship between the statistics information acquisition time and the acquired statistic information

Java VM Heap Size(MB)

Displays the Java VM heap size of the HCSC server. Displays the size in the format Maximum-Java-VM-heap-size-acquired / Upper-limit-of-the-Java-VM-heap-size.

Displays an integer truncated after the decimal point. Hyphen (-) is displayed if the HCSC server is not in the active status. If the acquisition of operating information fails, acquisition error is displayed.

Note that the value, excluding a part of the Survivor area size from the value specified in the -Xmx option of Java VM, is displayed.

Database Connection Count

Displays the information about all the resource adapters running on the J2EE server. The information is not displayed if the HCSC server is not in the active status. If the acquisition of operating information fails, acquisition error is displayed.

Resource Adapter Name

Displays the display name of the resource adapter.

Connection Count

Displays the number of DB connections on the HCSC server. Displays number-of-connections in the format Maximum-number-of-DB-connections-acquired / Upper-limit-of-the-number-of-DB-connections. The upper limit for the number of DB connections displays the value specified in the range of 1 to 2,147,483,647. If -1 (indefinite) is specified in the upper limit of the number of DB connections, the number of connections are displayed in the format Maximum-number-of-DB-connections-acquired / NA. NA indicates that the number is indefinite. Also, in the following cases, NA / NA (invalid value) is displayed:

When 0 is specified in the upper limit of the number of DB connections

When the relevant resource adapter is the root resource adapter or the DB connector for Reliable Messaging integration

Reception

Displays the information of a standard reception or user-defined reception. For standard reception, the information is not displayed if the standard reception is not set up.

Reception name

Displays the reception name of standard reception or the reception name of user-defined reception. For standard reception, displays Standard reception (Web Service (SOAP1.1)) or Standard reception (Web Service(SOAP1.2)). For the user-defined reception, displays the reception name defined by the user.

Status

Displays the operating status of the standard reception or user-defined reception. Displays one of the following:

inactive

active

stopping

starting

stop error

start error

acquisition error

Hyphen (-) is displayed if the HCSC server is not in active status. For the user-defined reception, Not deployed is displayed if the user-defined reception is not deployed.

Service Name

Displays the service name of the dependent business process or service adapter. Always displays hyphen (-) in case of standard reception. A hyphen (-) is displayed for the user-defined reception (invocation target specified).

Waiting Queue Count

Displays the queue retention count of standard reception or user-defined reception. Displays the count in the format Maximum-queue-retention-count-acquired / Upper-limit-of-the-queue-retention-count. The queue retention count of standard reception or user-defined reception displays values in the range of 0 to 2,147,483,647. Hyphen (-) is displayed if the HCSC server is not in the active status and if the relevant reception is in the stopping status. For the user-defined reception, - is displayed if the user-defined reception has not been deployed yet. If the acquisition of operating information fails, acquisition error is displayed.

Active Thread Count

Displays the number of executions of standard reception or user-defined reception. Displays the number-of-executions in the format Maximum-number-of-executions-collected / Upper-limit-of-the-number-of-executions. The number-of-executions of standard reception or user-defined reception displays values in the range of 1 to 1,024. Hyphen (-) is displayed if the HCSC server is not in the active status and if the relevant reception is in the stopping status. For the user-defined reception, - is displayed if the user-defined reception has not been deployed yet. If the acquisition of operating information fails, acquisition error is displayed.

Dependency Business Process

Displays information about the business process dependent on the HCSC server.

Service Name

Displays the service name of the dependent business process.

Status

Displays the operating status of the business process. Displays one of the following:

inactive

active

stopping

starting

stop error

start error

acquisition error

Pre-deployment status

Hyphen (-) is displayed if the HCSC server is not in the active status.

Active Thread Count

Displays the number-of-executions of the business process. Displays the number-of-executions in the format Maximum-number-of-executions-acquired / NA. NA indicates that the number is indefinite. The maximum-number-of-executions-acquired displays values in the range of 0 to 2,147,483,647. Hyphen (-) is displayed if the HCSC server is not in the active status and if the business process is in the pre-deployment or stopping status. If the acquisition of operating information fails, acquisition error is displayed.

Dependency Service Adapter

Displays information about the service adapter dependent on the HCSC server.

Service Name

Displays the service name of the service adapter.

Status

Displays the operating status of the service adapter. Displays one of the following:

inactive

active

stopping

starting

stop error

start error

acquisition error

pre-deployment status

Hyphen (-) is displayed if the HCSC server is not in the active status.

Active Thread Count

Displays the number-of-executions of the service adapter. Displays the number-of-executions in the format Maximum-number-of-executions-acquired / Upper-limit-of-the-number-of-executions. NA might also be displayed in the Upper-limit-of-the-number-of-executions. NA indicates that the number is indefinite. The maximum-number-of-executions-acquired displays values in the range of 0 to 2,147,483,647. Hyphen (-) is displayed if the HCSC server is not in the active status and if the service adapter is in the pre-deployment or stopping status. If the acquisition of operating information fails, acquisition error is displayed.

Resource Notification

ON button

The report of the statistic information from the execution environment will start.

OFF button

The report of the statistic information from the execution environment will stop.

4.6 Tracking Page

The Tracking page opens if you select the business process for management target from the tree view, and choose the Tracking tab. In the Tracking page, you can search the execution log of the process instances, delete, re-execute, and acquire the detailed information. This section describes the structure of the Tracking page.

Figure 4‒14: Structure of the Tracking page

• Search condition tab

You switch the search conditions between date and time or status search, correlation set search or identifier search.

• Search condition field

Select or enter search conditions; and executes a search.

• Search Results field

Displays the search results, deletes execution logs, or re-executes execution logs.

• Detailed Information field

Selects detailed information from the search results, or displays detailed information.

4.6.1 Search condition field

Use this field to select or enter search conditions, or perform a search.

(1) Search by Date/Time or Status

Figure 4‒15: Search condition field when (Search by DATE/Time or Status) tab is selected

Search by Date/Time or Status tab

This tab displays a page for searching process instances using date/time or status as the search condition.

ProcessInstance start time

Search process instances with the process instance start date/time specified.

Specify radio button

Searches process instances with the process instance start date/time specified.

Do not specify radio button

Searches process instances without specifying the process instance start date/time.

Start date/time condition entry field

Enter the start date/time for the search range. The time zone for the machine that is running is assumed for the specified date/time.

(year)

Specifies the start year for the search range as a 4-digit integer. The permitted value range is from 1970 to 9999.

(month)

Selects the start month for the search range from the drop-down list. The permitted value range is from 1 to 12.

(date)

Selects the start date for the search range from the drop-down list. The permitted value range is from 1 to 31.

(hour)

Selects the start hour for the search range from the drop-down list. The permitted value range is from 0 to 23.

(minute)

Selects the start minute for the search range from the drop-down list. The permitted value range is from 0 to 59.

(second)

Selects the start second for the search range from the drop-down list. The permitted value range is from 0 to 59.

End date/time condition entry field

Enters the end date/time for the search range.

The year, month, date, hour, minute, and second are the same as for the start date/time condition entry field.

• ProcessInstance status

Search process instances with the process instance status specified. You can also select multiple statuses and search for those process instances that are in any of the statuses you select.

Executing check box

Searches for the process instances that are currently executing.

Completed check box

Searches for the process instances whose global scope has been completed.

Faulted check box

Searches for the process instances that have terminated with fault and that cannot be detected by the global scope.

Error check box

Checks to search for completed process instance in which an error occurred while executing the service invocation activity.

• Sort condition

Specifies the order in which the search results are displayed.

ASC of start time. radio button

Displays the search results in ascending order by start date/time.

DESC of start time. radio button

Displays the search results in descending order by start date/time.

Do not specify radio button

Displays the search results without specifying the sort condition.

• Search button

Executes the search according to the specified condition.

• Reset button

Resets the search condition that was entered on the selected page to the initial value.

(2) Search by Correlation Set

Figure 4‒16: Search condition field when the Search by Correlation Set tab is selected

Search by Correlation Set tab

Displays the window for searching process instances from a correlation set as the search condition. You must enter the value in both Correlation Set Name and Correlation Set Value.

Correlation Set Name

Enters the correlation set definition name to be searched, expressed in alphanumeric characters.

Correlation Set Value

Enters the correlation set value to be searched, expressed in alphanumeric characters.

(3) Search by identifier

Figure 4‒17: Search condition field when the Search by Identifier tab is selected

Search by Identifier tab

As the search condition of this tab, select a screen searching the process instance from the process instance identifier.

Process Instance Identifier

Enter the process instance identifier to be searched.

4.6.2 Search Results field

Search Results

Displays the total number of items in the search results.

Display range

Displays the location of the current item with respect to the beginning of the search results.

< button

Displays the previous 20 items in the search results.

> button

Displays the next 20 items in the search results.

List of Search Results

Displays the items that satisfy the search condition. A maximum of 20 items can be displayed at a time.

#

The number displayed corresponds to the number of items in the search results.

Process Definition Name

Displays the business process definition name.

Process Definition Version

Displays the business process version.

State

Displays the status of the process instance.

Start Time

Displays the date and time at which the process instance began executing, in the same format yyyy/mm/dd hh:mm:ss as when the search condition was specified. If execution has not begun, this information is not displayed.

End Time

Displays the date and time at which the process instance finished executing, in the same format yyyy/mm/dd hh:mm:ss as when the search condition was specified. If execution is not finished, this information is not displayed.

HCSC Server Name

Displays the name of the last executed HCSC server name.

Delete button

Deletes the execution log of a single process instance that has been selected from the search results.

Reexec button

Re-executes a single process instance that has been selected from the search results.

4.6.3 Detailed Information field

Use this field to select or display detailed information from the search results.

(1) Correlation set information

Detailed Information

Displays the total number of detailed information items for the process instance that was selected from the list of search results, and the type of detailed information (Correlation Set Info., Variable Info., or Activity Info.).

Display range

Displays the location of the current item with respect to the beginning of the search results.

< button

Displays the previous 20 items in the search results.

> button

Displays the next 20 items in the search results.

List of Detailed Information

Displays detailed information about the item that was selected, and the type of detailed information (Correlation Set Info., Variable Info., or Activity Info.). A maximum of 20 items can be displayed at a time.

Figure 4‒18: List of detailed information (Correlation Set Info)

Figure 4‒19: List of detailed information (Variable Info)

Figure 4‒20: List of detailed information (Activity Info)

#

The number displayed corresponds to the item number in the detailed information list.

Correlation Set Name

Displays correlation set definition names when the Correlation Set Info. button is clicked. The correlation set definition names are displayed in ascending order.

Correlation Set Value

Displays the correlation set values when the Correlation Set Info. button is clicked.

Variable Name

Displays the variable definition name when the Variable Info. button is clicked. The variable definition names are displayed in ascending order.

Variable Type

Displays the variable's data type (Boolean, Numeric, String, or Message) when the Variable Info. button is clicked.

Variable Value

Displays the variable value when the Variable Info. button is clicked. The value depends on the variable type, as shown below:

Boolean: Displays either 1 (true) or 0 (false).

Numeric: Displays a numeric value (64-bit floating-point number).

String: Displays a character string.

Message: Displays a message (XML).

Activity Definition Name

Displays the activity definition names when the Activity Info. button is clicked. The activity definition names are displayed in ascending order by start date/time. If the start date/time is blank, the corresponding item is placed at the end of the list.

Activity Type

Displays the following activity types when the Activity Info. button is clicked:

Table 4‒4: Activity types

Name

Explanation

Receive

Receives a request message that was sent by a service requester.

Reply

Responds to the service requester with process execution results during synchronous reception.

Invoke service

Sends a request message to a service module.

Assign

Assigns variables.

Scope

Determines the valid range of the activity.

The global scope name is @GLOBAL.

SEQUENCE

Executes activities in the order defined.

A sequence activity is completed when the last retained activity is completed.

Flow process

Concurrently executes the defined activities.

The flow starting activity and flow ending activity during business process development are displayed as flow activities. A flow activity is completed when all of the retained activities are completed.

SWITCH

Selects an activity to be executed by the selection condition that has been defined.

The switch starting activity and switch ending activity during business process development are displayed as switch activities. A switch activity is completed when all of the activities selected by the branch condition are completed.

While

Repeats execution of the activity as long as the defined repetition condition is true.

INVOKE JAVA

Calls a Java program according to the defined interface.

Empty

Indicates no action.

Throw

Reports a user-defined fault to the upper scope activity.

Standby

Process execution stands until there is a specified regular interval or a period.

State

Displays the following activity status when the Activity Info. button is clicked:

Table 4‒5: Activity status

Name

Explanation

unexecuted

The activity instance has not been executed, but it will probably be executed in the future.

unomitted

The activity instance has not been executed, and its execution will probably be omitted in the future.

executing

The activity instance is executing.

waiting

The receive activity instance is ready to be accepted.

faulting

A fault occurred in the scope activity instance, and the detected activity is executing.

completed

The activity instance was successfully executed and terminated.

cancelled

A fault occurred, and execution of the activity instance was cancelled.

terminated with fault

The activity instance was terminated due to a fault that occurred during execution.

execution omitted

The activity instance was terminated because its execution was omitted.

error

The activity instance was terminated due to an error that occurred during the execution.

Start Time

When the Activity Info. button is clicked, this column displays the activity start date/time in the same format as in the search condition field.

End Time

When the Activity Info. button is clicked, this column displays the activity end date/time in the same format as in the search condition field.

Correlation Set Info. button

Displays detailed information about the correlation set for the process instance that was selected from the list of search results. The correlation set information is sorted in ascending order by correlation set definition names.

Variable Info. button

Displays detailed information about the variables for the process instance that was selected from the list of search results. The variable information is sorted in ascending order by variable definition names.

Activity Info. button

Displays detailed information about the activities for the process instance that was selected from the list of search results. The activity information is sorted in chronological order by start date/time. An item whose start date/time field is empty (unexecuted) is placed at the end of the list.

Variable Value button

Displays a new window containing the variable value details when the data type of the variable information displayed in the Detailed Information field is String or Message.

5 Commands (Operating and Execution Environments)

This chapter describes the syntax for the commands used in the operating and execution environments of a service platform.

5.1 Types of commands

Three types of commands are used in the operating and execution environments of a service platform. Each type is stored in a separate directory.

Types of command

Executed in:

Function

Commands whose name begins with csc

Operating environment

These commands set up an HCSC server, perform basic operations, and manage repositories and users.

Some of these commands communicate with Management Server to manage the HCSC server. Therefore, even if a command is terminated forcibly, the processing might continue.

If command names and Java VM start options are specified in the HCSC-Manager command definition file for Java VM start options, the settings will be applied when a command is executed.

Commands whose name begins with csm#

Execution environment

These commands manage various accounts and display the transmission log.

Commands whose name begins with csa

#

When the database to be used is HiRDB and the JDBC driver is HiRDB Type4 JDBC Driver, specify the path of HiRDB Type4 JDBC Driver in the HCSC-Messaging command definition file.

When the database to be used is Oracle, specify the path of Oracle JDBC Thin Driver in the HCSC-Messaging command definition file.

Important note

A user who has administrator permissions executes the commands used in the operating and execution environments of a service platform. For details about how to change the Service Coordinator administrator in UNIX, see Appendix A. Changing the Service Coordinator administrator (in UNIX) in the Service Platform Setup and Operation Guide.

5.1.1 List of commands

The following tables list and describe the commands used in the operating environment and those used in the execution environment.

(1) List of commands used in the operating environment

The commands used in the operating environment are stored in the following location:

service-platform-installation-directory\CSC\bin

The following table lists and describes the commands used in the operating environment.

Table 5‒1: List of commands used in the operating environment of a service platform

Classification of function

Command

Description

Classification of processing

Major classification

Minor classification

Management

User management

cscpasswd

Changes the user information according to specified conditions.

A

Repository management

cscrepls

Outputs the repository information to the standard output.

C

cscrepdiff

Displays the difference between the current repository information and exported repository information in the standard output.

C

cscrepcheck

Verifies whether a repository can be imported.

A

cscrepctl

Outputs the information from the repository to a ZIP file, and expands the information stored in the ZIP format to the repository.

A

cscrepupdate

Updates the operating environment repositories.

A

Service management

cscsvcls

Outputs the service information to the standard output. This command also examines the values to be specified in the arguments of the cscsvcctl command.

C

cscsvcctl

Outputs or inputs the service-information change definition file. This command also changes the service information related to service adapters.

A

Environment management

cscenvbackup

Backs up the files required to restore the HCSC-Manager environment.

C

cscenvrestore

Restores the environment by using the backup files of the HCSC-Manager environment.

A

Setup

Server setup

cscsvsetup

Sets up an HCSC server.

A

cscsvunsetup

Unsets up an HCSC server.

A

HCSC component setup

csccompodeploy

Allocates HCSC components.

A

csccompoundeploy

Deletes the allocated HCSC components.

A

Set and obtain server definition

cscsvconfig

(Specifying set in the -operation option)

Updates the definition information for HCSC servers.

B

cscsvconfig

(Specifying get in the -operation option)

Obtains the definition information for HCSC servers.

C

Obtain, set, and delete a definition file

csccmctl (Specifying get in the -operation option)

Obtains the definition files set up in the development environment.

D

csccmctl (Specifying set in the -operation option)

Sets up the definition files in the operating environment.

A

csccmctl (Specifying reset in the -operation option)

Deletes the definition files set up in the operating environment.

A

Set and obtain an HCSC component definition

csccompoconfig

(Specifying set in the -operation option)

Updates the definition information of a user-defined reception.

B

csccompoconfig

(Specifying get in the -operation option)

Obtains the definition information of a user-defined reception.

C

Easy setup

cscsetup

Easily sets up a system that can be applied to the production environment.

A

Operation

Server operations

cscsvstart

Starts an HCSC server.

B

cscsvstop

Stops an HCSC server.

B

HCSC component operations

csccompostart

Starts HCSC components.

B

csccompostop

Stops HCSC components.

B

cscprecache

Pre-caches the format and data transformation definitions.

C

Standard and user-defined reception

cscrcptnstart

Starts the standard and user-defined receptions.

B

cscrcptnstop

Stops the standard and user-defined receptions.

B

Status check

cscstatus

Displays the status for HCSC servers, standard receptions, and HCSC components.

C

Operation check

cscresinfo

Displays the operation information for the HCSC server resources.

C

General purpose

cscutil

Executes the following operations:

Starts and stops HCSC servers

Starts and stops HCSC components, and obtains information

Starts and stops standard receptions

Obtains the HCSC server setup information and HCSC server information

Obtains user-defined reception information

D

cscpiselect

Searches the business process information according to specified conditions and outputs the result in a CSV or TSV format.

C

cscpidelete

Deletes the business process execution logs according to specified conditions.

C

cscpireexec

Re-executes a running business process according to specified conditions.

C

cscapputil

Operates the applications that are managed by an HCSC server.

C

File integration

Folder operations

cscfscls

References the files in the common folder.

C

cscfscrm

Deletes the files from the common folder.

B

cscfswls

References the work folder.

C

cscfswrm

Deletes the work folder.

B

Tools

Version upgrade

cscenvupdate

Upgrades the version of a specified HCSC server in the execution environment.

A

Message tracking

cscmsgtk

Starts message tracking and displays the message tracking prompt.

E

Legend:

A: Repository update commands (the commands that update the repository, when executed).

B: Server update commands (the commands that update the information or the status of HCSC servers, when executed).

C: Reference commands (the commands that only reference the information, when executed). The HCSC server and the repository are not updated.

D: The server update commands or reference commands are executed depending on the options.

E: The commands that are not applicable to the repository update, server update, and reference commands.

(2) List of commands used in the execution environment

The commands used in the execution environment are stored in the following locations:

Commands beginning with csaftp

service-platform-installation-directory\CSC\custom-adapter\FTP\bin

Other commands

service-platform-installation-directory\CSC\bin

The following table lists and describes the commands used in the execution environment.

Table 5‒2: List of commands used in the execution environment of a service platform

Classification of function

Command

Description

Classification of processing

Major classification

Minor classification

FTP integration

Register, update, and obtain users

csaftpuseradd

Registers a new user in an FTP adapter.

B

csaftpuserdel

Deletes a user registered in the FTP adapter.

B

csaftpuserls

Displays the users registered in the FTP adapter.

C

csmftpaddusr

Registers a new user in an FTP inbound adapter.

B

csmftpdelusr

Deletes a user registered in the FTP inbound adapter.

B

csmftplsusr

Displays the users registered in FTP inbound adapter.

C

Transmission log

csmftplshistory

Displays the transmission log of the FTP inbound adapter.

C

Mail integration

Register, update, and obtain users

csmmailaddusr

Registers and updates user information in the mail adapter account definition file.

B

csmmaildelusr

Deletes the user information registered in the mail adapter account definition file.

B

csmmaillsusr

Displays the user information registered in the mail adapter account definition file.

C

Public key authentication

Register, update, and obtain private key information

csakeyadd

Registers (or updates) private key information in the public key authentication information.

B

csakeydel

Deletes the private key information registered in the public key authentication information.

B

csakeyls

Displays the private key information registered in the public key authentication information.

C

Password authentication

Register, update, and obtain users

csauseradd

Registers (or updates) a user and password in the password authentication information.

B

csauserdel

Deletes a user and password registered in the password authentication information.

B

csauserls

Displays the users and passwords registered in authentication information.

C

Legend:

B: Server update commands (the commands that update the information or the status of HCSC servers, when executed).

C: Reference commands (the commands that only reference the information, when executed). The HCSC server and the repository are not updated.

5.1.2 Concurrent execution of commands

If other operations are running when you execute a command, you might not be able to execute the command. The following table describes whether you can execute a command when other operations are running.

Table 5‒3: Executability of a command when other operations are running

Command to be executed

Currently running operation or current status

Repository update commands are being executed

Server update commands are being executed

Reference commands are being executed

User is logged in to the window

Window operation is running (Update)

Repository update commands

N

N

N

N

N

Server update commands

N

N

Y

Y

N

Reference commands

N

Y

Y

Y

Y

Legend:

Y: Command can be executed.

N: Command cannot be executed. If these commands are executed concurrently with the repository update commands and commands including repository operations (reference and update), an exclusion error occurs with the return code 3.

Note

The cscutil command includes the server update command functions (such as starting and stopping HCSC servers), and the reference command functions (such as obtaining the HCSC server information).

If you execute the cscutil command when other operations are running, the executability of this command will differ depending on the functions to be executed (which option is specified).

5.1.3 Command timeout functionality

The timeout functionality is used when there is no response from the executed command. The following table describes the timeout functionality provided by HCSC server. For details on definition files, see 6.5 Files used for HCSC server operations.

Table 5‒4: Timeout functionality provided by HCSC server

Definition file

Property

Type of timeout functionality

HCSC-Manager definition file

cscmng.manager.identifier-name-of-manager.timeout

Communication timeout

cscmng.server.HCSC-server-name.hws.svstop.timeout

Monitoring time

HCSC server runtime definition file

csc-command-timeout

Communication timeout

csc-precache-timeout

Communication timeout

startcsc-timeout

Monitoring time

stopcsc-timeout

Monitoring time

j2ee-stopapp-timeout

Monitoring time

receptionstop-monitor-timer

Communication timeout,

monitoring time

csc-receptionstop-timeout

Communication timeout

Legend:

Communication timeout:

Detects a communication error.

Monitoring time:

Stands by until a particular target reaches the expected status with the extension of a command execution.

The timeout values of the properties classified as monitoring time must be tuned according to the extension of the system (increase in HCSC components).

Important note

The command timeout functionality does not guarantee that the control returns to the command client when the timeout value is exceeded.

The rewinding process might be executed when an error occurs depending on the command, so the processing from when the specified time is exceeded until the result is reported to the client might take longer than the set value.

5.1.4 Command cancellation functionality

The cancellation functionality releases the resources by a certain time. By specifying a cancellation condition (which is time), you can cancel the processing while a command is being executed. A command, whose execution is cancelled using the cancellation functionality, outputs a warning message and returns the exit code 10.

HCSC server provides the following cancellation functionality:

cscpidelete command (-canceltimer option)

cscpiselect command (-canceltimer option)

5.2 Command input format

The input format of the commands is as follows:

Command-name [argument ...]

The following is a description of each of these items. Note that $ indicates a command prompt and cmd indicates a command name.

Command-name

Specifies the file name of the command to be executed.

To execute a command by specifying a path containing spaces, the entire path must be enclosed within double quotation marks (" ").

Example of incorrect specification: $ C:\Program Files\Hitachi\Cosminexus\CC\server\bin\cmd

Example of correct specification: $ "C:\Program Files\Hitachi\Cosminexus\CC\server\bin\cmd"

Arguments

An argument also includes options. The input format and the rules for specifying the options are as follows:

Input format for options

An option is a string beginning with a hyphen (-). The option input formats include a format where no option argument is specified and a format where one option argument is specified.

Format without an option argument

$ cmd -option-flag

Format with one option argument

$ cmd -option-flag option-argument

Legend:

option-flag

This represents a case-sensitive, single-byte alphanumeric character.

option-argument

This represents an argument corresponding to the option flag.

Rules for specifying options

Multiple option flags cannot be combined with a single hyphen (-).

Example of incorrect specification: $ cmd -abc

Example of correct specification: $ cmd -a -b -c

The option argument of an option flag that requires an option argument cannot be omitted.

A space or a tab must be specified between an option flag and an option argument.

Example of incorrect specification: $ cmd -afile

Example of correct specification: $ cmd -a file

The same option flag cannot be specified more than once.

Example of incorrect specification: $ cmd -a 1 -a 2

To include spaces in an option argument, the entire option argument must be enclosed within double quotation marks (" ").

Example of incorrect specification: $ cmd -a file 1

Example of correct specification: $ cmd -a "file 1"

To include a special character (escape character) in an option argument, the special character must be enclosed within double quotation marks (" ").

Example of incorrect specification: $ cmd -a xyz;12

Example of correct specification: $ cmd -a "xyz;12"

Priority of options

A few options of each command can be omitted if they are coded in the HCSC-Manager command definition file. The following priority applies to the HCSC-Manager command definition file and to the command arguments:

- When an option is specified in both the HCSC-Manager command definition file and the command argument:

The option specified in the command argument is valid.

- When an option is not specified in both the HCSC-Manager command definition file and the command argument:

The command terminates abnormally.

For details about the HCSC-Manager command definition file, see 6.5.2 HCSC-Manager command definition file.

There are no rules for the order of the options. The following examples 1 and 2 are treated as the same command:

Example 1: $ cmd -a file -b option

Example 2: $ cmd -b option -a file

5.3 Format for describing command syntax

In this chapter, command syntax is described in the following format. Note that the commands are listed and explained in alphabetical order.

Format

Describes the command input format.

Function

Describes the functionality of commands.

Argument

Describes the arguments and the options of commands.

Output format

Describes the command output format.

Example of input

Gives an example of command input.

Display format

Describes the command output format.

Example of display

Gives an example of command display.

Return value

Describes the return value of commands.

Notes

Provides general notes on executing commands.

Note

All the above-mentioned items are not provided for each command. In addition to the above-mentioned items, the information specific to individual commands might be provided.

The following table lists the symbols used in syntax explanations in this chapter.

Symbol

Meaning

|

In syntax explanations, a vertical bar separates multiple items, and has the meaning of OR.

For example: A|B means A or B.

{ }

In syntax explanations, curly brackets indicate that only one of the enclosed items is to be selected. If the items are arranged horizontally and separated by a vertical bar (|), select one of the items.

For example: {A|B|C} means only one of A, or B, or C.

[ ]

In syntax explanations, square brackets indicate that the enclosed item or items are optional.

For example: [A] means that you can specify A or nothing.

Italics

In syntax explanations, italics indicate that the corresponding element must be specified.

For example: property means that you must specify a property.

...

In coding, an ellipsis (...) indicates that one or more lines of coding have been omitted.

For example: ABC... means that the coding after ABC has been omitted.

~

In syntax explanations, a swung dash (~) indicates that the items preceding the swung dash comply with the rules mentioned in < >, (( )), and << >> following the swung dash.

< >

In syntax explanations, angle brackets indicate the syntax elements that must be complied with when items are coded. For details on syntax elements, see the following table.

(( ))

In syntax explanations, double-parentheses indicate the range of values that you can specify for an item.

<< >>

In syntax explanations, double-angle brackets indicate the default value that the system assumes when an item is omitted.

The following table lists the types and definitions of the syntax elements used in this chapter.

Type

Definition

Alphabetic characters

A to Z, a to z

Lowercase alphabetic characters

a to z

Uppercase alphabetic characters

A to Z

Numeric characters

0 to 9

Alphanumeric characters

A to Z, a to z, 0 to 9

Symbols

_, ., -

Character string

An array of strings

5.4 Commands used in the operating environment and execution environment of a service platform

csaftpuseradd (Registering and updating FTP adapter users)

Format

csaftpuseradd [-h]
 -user login-user-ID
 -pass login-password
 [-account billing-information]
 [-r]
 { -f path-of-FTP-adapter-account-definition-file| -name service-ID }

Function

Registers a user in the FTP adapter account definition file. If a user is already registered, this command updates the password and the billing information.

For details on how to use this command, see 5.4.14 Checking and changing the user information of the FTP adapter in the Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and one-byte symbols> ((1 to 80 characters))

Specifies the user ID to be registered or updated.

You can specify one-byte alphanumeric characters, one-byte symbols (0x21 to 0x7E in ASCII encoding), and one-byte spaces (0x20 in ASCII encoding). The characters are case sensitive. The available one-byte symbols are as follows:

Exclamation mark (!)

Double quotation mark (")

Hash mark (#)

Dollar sign ($)

Percent sign (%)

Ampersand (&)

Apostrophe mark (')

Left parenthesis (()

Right parenthesis ())

Asterisk (*)

Plus sign (+)

Comma (,)

Hyphen (-)

Period (.)

Forward slash (/)

Colon (:)

Semicolon (;)

Left angle bracket (<)

Right angle bracket (>)

Equal sign (=)

Question mark (?)

At mark (@)

Left square bracket ([)

Right square bracket (])

Yen sign (\)

Caret (^)

Underscore (_)

Grave accent mark (`)

Left curly bracket ({)

Right curly bracket (})

Vertical bar (|)

Swung dash (~)

-pass login-password ~ <one-byte alphanumeric characters and one-byte symbols> ((1 to 80 characters))

Specifies a password for the user ID to be registered or updated. You can specify one-byte alphanumeric characters, one-byte symbols (0x21 to 0x7E in ASCII encoding), and one-byte spaces (0x20 in ASCII encoding). The characters are case sensitive. The available one-byte symbols are the same as those for the -user option.

To change the password (when the -r option is specified), specify the new password.

-account billing-information ~ <one-byte alphanumeric characters and one-byte symbols> ((at least 1 character))

Specifies the billing information (which is a string indicating the account) for the user that is to be registered or updated. You can specify one-byte alphanumeric characters, one-byte symbols (0x21 to 0x7E in ASCII encoding), and one-byte spaces (0x20 in ASCII encoding). The characters are case sensitive. The available one-byte symbols are the same as those for the -user option.

If this option is omitted, or if null is specified in billing-information, the billing information is not set up.

Note that you must specify this option to change the password for a user for whom the billing information is set up.

-r

Specify this option to change the password of the user ID that is already registered.

-f path-of-FTP-adapter-account-definition-file

Specifies the relative or absolute path of the FTP adapter account definition file. To include spaces, enclose the entire option argument in double quotation marks (").

If the file does not exist already, an FTP adapter account definition file is created. However, an error occurs if the directory does not exist. To add an account to an existing FTP adapter account definition file, specify the existing FTP adapter account definition file.

-name service-ID ~ <halfwidth alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the service ID of the FTP adapter when users are managed on an FTP adapter basis by using a product-specific path.

If no file exists in the product-specific path, an FTP adapter account definition file is created. However, an error occurs if the directory does not exist. For details about the product-specific path, see 6.8.1 FTP adapter account definition file.

Examples of input

Registering user information in any unit by using the account definition file in any path

(1) To register a user for whom the billing information will be set up

csaftpuseradd -user user1 -pass password1 -account account1 -f account.properties

(2) To register a user for whom the billing information will not be set up

csaftpuseradd -user user2 -pass password2 -f account.properties

(3) To update the password and the billing information of a user

csaftpuseradd -user user1 -pass passwordnew -account accountnew -r -f account.properties

(4) To update the password of a user for whom the billing information is not specified

csaftpuseradd -user user2 -pass passwordnew -r -f account.properties

(5) To add the billing information for a registered user

csaftpuseradd -user user2 -pass password2 -account account2 -r -f account.properties

(6) To delete the billing information for a registered user

csaftpuseradd -user user1 -pass password1 -r -f account.properties

Registering user information on an FTP adapter basis by using the account definition file in a product-specific path

(1) To register a user for whom the billing information will be set up

csaftpuseradd -user user1 -pass password1 -account account1 -name adp1

(2) To register a user for whom the billing information will not be set up

csaftpuseradd -user user2 -pass password2 -name adp1

(3) To update the password and the billing information of a user

csaftpuseradd -user user1 -pass passwordnew -account accountnew -r -name adp1

(4) To update the password of a user for whom the billing information is not specified

csaftpuseradd -user user2 -pass passwordnew -r -name adp1

(5) To add the billing information for a registered user

csaftpuseradd -user user2 -pass password2 -account account2 -r -name adp1

(6) To delete the billing information for a registered user

csaftpuseradd -user user1 -pass password1 -r -name adp1

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

9

An error occurred when checking the execution permission.

Notes

You can register any number of users.

You cannot edit the FTP adapter account definition file.

Specify access permissions so that only the administrator who executes the operation commands can update and reference the FTP adapter account definition file.

The content executed by the command (registering and updating a user) takes effect after the FTP adapter starts. Also, if you execute the command when the FTP adapter is running, the content executed by the command (registering and updating a user) takes effect after the FTP adapter starts the next time.

The FTP adapter account definition file might be corrupted due to a file I/O error (for example, a disk is full) during command execution. Back up the file on a regular basis.

Do not specify service-platform-installation-directory\CSC\config\common\account.properties in the -f option.

csaftpuserdel (Deleting FTP adapter users)

Format

csaftpuserdel [-h]
 -user login-user-ID
 { -f path-of-FTP-adapter-account-definition-file | -name service-ID }

Function

Deletes a user registered in the FTP adapter account definition file.

For details on how to use this command, see 5.4.14 Checking and changing the user information of the FTP adapter in the Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and one-byte symbols> ((1 to 80 characters))

Specifies the user ID to be deleted. You can specify one-byte alphanumeric characters, one-byte symbols (0x21 to 0x7E in ASCII encoding), and one-byte spaces (0x20 in ASCII encoding). The characters are case sensitive. The available one-byte symbols are as follows:

Exclamation mark (!)

Double quotation mark (")

Hash mark (#)

Dollar sign ($)

Percent sign (%)

Ampersand (&)

Apostrophe mark (')

Left parenthesis (()

Right parenthesis ())

Asterisk (*)

Plus sign (+)

Comma (,)

Hyphen (-)

Period (.)

Forward slash (/)

Colon (:)

Semicolon (;)

Left angle bracket (<)

Right angle bracket (>)

Equal sign (=)

Question mark (?)

At mark (@)

Left square bracket ([)

Right square bracket (])

Yen sign (\)

Caret (^)

Underscore (_)

Grave accent mark (`)

Left curly bracket ({)

Right curly bracket (})

Vertical bar (|)

Swung dash (~)

-f path-of-FTP-adapter-account-definition-file

Specifies the relative or absolute path of the FTP adapter account definition file. To include spaces, enclose the entire option argument in double quotation marks (").

-name service-ID ~ <halfwidth alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the service ID of the FTP adapter. If the -name option was not specified when the user was registered, specify the -f option rather than this option.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

9

An error occurred when checking the execution permission.

Notes

You cannot edit the FTP adapter account definition file.

The FTP adapter account definition file is not deleted even if there is no user authentication information in the FTP adapter account definition file.

Before you execute the command, specify access permissions so that only the Administrator executing the operation commands can update and reference the FTP adapter account definition file.

The content executed by the command (deleting a user) takes effect after the FTP adapter starts. Also, if you execute the command when the FTP adapter is running, the content executed by the command (deleting a user) takes effect after the FTP adapter starts the next time.

The FTP adapter account definition file might be corrupted due to a file I/O error (for example, a disk is full) during command execution. Back up the file on a regular basis.

Do not specify service-platform-installation-directory\CSC\config\common\account.properties in the -f option.

csaftpuserls (Displaying FTP adapter users)

Format

csaftpuserls [-h]
 { -f path-of-FTP-adapter-account-definition-file | -name service-ID }

Function

Displays the users that are registered in the FTP adapter account definition file. The display results are output to the standard output.

For details on how to use this command, see 5.4.14 Checking and changing the user information of the FTP adapter in the Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-f path-of-FTP-adapter-account-definition-file

Specifies the relative or absolute path of the FTP adapter account definition file. To include spaces, enclose the entire option argument in double quotation marks (").

-name service-ID ~ <halfwidth alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the service ID of the FTP adapter in which the users to be displayed are registered.

Display format

(1) When the user authentication information is registered (without -name specified)

1: User ID 1= billing-information

2: User ID 2

...

The user authentication information registered without specifying the -name option is displayed. Each line contains information for one user. If the billing information is specified for a user ID, the billing information is displayed.

(2) When the user authentication information is not registered (without -name specified)

none

(3) When the user authentication information is registered (with -name specified)

1: User ID 1= billing-information

2: User ID 2

...

The user authentication information registered with the -name option specified is displayed. Each line contains information for one user. If the billing information is specified for a user ID, the billing information is displayed.

(4) When the user authentication information is not registered (with -name specified)

none

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

9

An error occurred when checking the execution permission.

Notes

You cannot edit the FTP adapter account definition file.

Before you execute the command, specify access permissions so that only the Administrator executing the operation commands can update and reference the FTP adapter account definition file.

Do not specify service-platform-installation-directory\CSC\config\common\account.properties in the -f option.

csakeyadd (Registering and updating private key information for public key authentication)

Format

csakeyadd [-h]
           -keyfile file-path-of-private-key
          [-pass passphrase-for-private-key]
           -keyid key-ID
          [-r]
           -f public-key-authentication-information-definition-file

Function

Registers or updates private key information required for public key authentication included in user authentication. You can register any number of public key authentication information items.

The registered or updated public key authentication information takes effect when the service adapter that uses the public key authentication information issues the first request. If you execute this command after the first request, the registered or updated public key authentication information takes effect after the service adapter starts the next time.

Note the following when you execute the command:

Specify access permissions so that only the administrator who executes the command can update and reference the public key authentication information definition file and private key file.

When updating the public key authentication information definition file, we recommend that you create a backup file.

Arguments

-h

Displays the usage of the command. When you specify this option, all other options are ignored even if specified.

-keyfile file-path-of-private-key

Specifies the path of the private key file as a relative or absolute path. To include spaces in the path, enclose the entire option argument in double quotation marks (").

If the specified file does not exist, an error occurs.

-pass passphrase-for-private-key

Specifies the passphrase, if any, that has been set for the target private key.

-keyid key-ID ~ <halfwidth alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the ID that uniquely identifies the private key.

To register public key authentication information:

Specify an ID that is unique in the public key authentication information definition file.

To update public key authentication information (with the -r argument specified):

Specify an ID registered in the public key authentication information definition file.

-r

Specify this option to update the public key authentication information that is already registered.

-f public-key-authentication-information-definition-file

Specifies the path of the public key authentication information definition file as a relative or absolute path. To include spaces in the path, enclose the entire option argument in double quotation marks (").

If the specified file does not exist, one of the following operations is performed:

When the public key authentication information is registered:

If the specified file does not exist, a public key authentication information definition file with the specified name is created. However, an error occurs if the specified directory does not exist.

When the public key authentication information is updated (with the -r argument specified):

If the specified file does not exist, an error occurs.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

9

An error occurred when checking the execution permission.

Notes

Do not directly edit the public key authentication information definition file.

After executing the command, do not edit or move the private key file.

csakeydel (Deleting private key information for public key authentication)

Format

csakeydel [-h]
          -keyid key-ID
          -f public-key-authentication-information-definition-file

Function

Deletes the private key information registered in the public key authentication information definition file.

The deleted private key information is applied after the service adapter that uses the authentication information starts. If you execute the command when the service adapter is running, the deleted private key information will be applied after the service adapter starts the next time.

Note that the private key file is not deleted by deleting the private key information. The public key authentication information definition file is not deleted even if there is no more public key authentication information in the file.

Note the following when you execute the command:

Specify access permissions so that only the administrator who executes the command can update and reference the public key authentication information definition file.

We recommend that you create a backup file of the public key authentication information definition file.

Arguments

-h

Displays the usage of the command. When you specify this option, all other options are ignored even if specified.

-keyid key-ID ~ <halfwidth alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the ID of the private key information to be deleted from the public key authentication information.

-f public-key-authentication-information-definition-file

Specifies the path of the public key authentication information definition file as a relative or absolute path. To include spaces in the path, enclose the entire option argument in double quotation marks (").

If the specified file does not exist, an error occurs.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

9

An error occurred when checking the execution permission.

Notes

Do not directly edit the public key authentication information definition file.

csakeyls (Displaying private key information for public key authentication)

Format

csakeyls [-h]
         -f public-key-authentication-information-definition-file

Function

Displays the private key information registered in the public key authentication information definition file by using the following format:

--- (Variable-length dashed line header)
public-key-authentication-information
--- (Variable-length dashed line footer)

Note the following when you execute the command:

Specify access permissions so that only the administrator who executes the command can update and reference the public key authentication information definition file.

Arguments

-h

Displays the usage of the command. When you specify this option, all other options are ignored even if specified.

-f public-key-authentication-information-definition-file

Specifies the path of the public key authentication information definition file as a relative or absolute path. To include spaces in the path, enclose the entire option argument in double quotation marks (").

If the specified file does not exist, an error occurs.

Display format

(1) When the public key authentication information definition file contains registered information

Public key authentication information is displayed on each line.

-------------------------------------------------------------
key-ID passphrase# file-path-for-private-key
 ...
 ...
-------------------------------------------------------------

#

If a passphrase has been set, four asterisks (****) are displayed. If no passphrase has been set, four halfwidth spaces (Δ Δ Δ Δ) are displayed.

(2) When the public key authentication information definition file does not contain registered information

----
none
----

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

9

An error occurred when checking the execution permission.

Note

Do not directly edit the public key authentication information definition file.

csauseradd (Registering and updating user information for password authentication)

Format

csauseradd [-h]
           -user user-name
           -pass password
           [-r]
           -f password-authentication-information-definition-file

Function

Registers or updates the user information (user name and password) required for password authentication included in user authentication. You can register any number of users.

The registered or updated password authentication information takes effect after the service adapter that uses the password authentication information starts. If you execute the command when the service adapter is running, the registered or updated password authentication information takes effect after the service adapter starts the next time.

Note the following when you execute the command:

Specify access permissions so that only the administrator who executes the command can update and reference the password authentication information definition file.

When updating the password authentication information definition file, we recommend that you create a backup file.

Arguments

-h

Displays the usage of the command. When you specify this option, all other options are ignored even if specified.

-user user-name ~ <halfwidth alphanumeric characters and halfwidth symbols> ((1 to 80 characters))

Specifies the user name to be registered or updated.

You can specify halfwidth alphanumeric characters, halfwidth symbols (0x21 to 0x7E in ASCII encoding), and halfwidth spaces (0x20 in ASCII encoding). The characters are case sensitive. You can use the following halfwidth symbols:

Exclamation mark (!)

Double quotation mark (")

Hash mark (#)

Dollar sign ($)

Percent sign (%)

Ampersand (&)

Apostrophe mark (')

Left parenthesis (()

Right parenthesis ())

Asterisk (*)

Plus sign (+)

Comma (,)

Hyphen (-)

Period (.)

Forward slash (/)

Colon (:)

Semicolon (;)

Left angle bracket (<)

Right angle bracket (>)

Equal sign (=)

Question mark (?)

At mark (@)

Left square bracket ([)

Right square bracket (])

Yen sign (\)

Caret (^)

Underscore (_)

Grave accent mark (`)

Left curly bracket ({)

Right curly bracket (})

Vertical bar (|)

Swung dash (~)

-pass password ~ <halfwidth alphanumeric characters and halfwidth symbols> ((1 to 80 characters))

Specifies the password for the user name to be registered or updated.

You can specify halfwidth alphanumeric characters, halfwidth symbols (0x21 to 0x7E in ASCII encoding), and halfwidth spaces (0x20 in ASCII encoding). The characters are case sensitive. You can use the following halfwidth symbols.

Exclamation mark (!)

Double quotation mark (")

Hash mark (#)

Dollar sign ($)

Percent sign (%)

Ampersand (&)

Apostrophe mark (')

Left parenthesis (()

Right parenthesis ())

Asterisk (*)

Plus sign (+)

Comma (,)

Hyphen (-)

Period (.)

Forward slash (/)

Colon (:)

Semicolon (;)

Left angle bracket (<)

Right angle bracket (>)

Equal sign (=)

Question mark (?)

At mark (@)

Left square bracket ([)

Right square bracket (])

Yen sign (\)

Caret (^)

Underscore (_)

Grave accent mark (`)

Left curly bracket ({)

Right curly bracket (})

Vertical bar (|)

Swung dash (~)

-r

Specify this option to change the password of the user that is already registered.

-f password-authentication-information-definition-file

Specifies the path of the password authentication information definition file as a relative or absolute path. To include spaces in the path, enclose the entire option argument in double quotation marks (").

If the specified file does not exist, one of the following operations is performed:

When the password authentication information is registered

If the specified file does not exist, a password authentication information definition file with the specified name is created. However, an error occurs if the specified directory does not exist.

When the password authentication information is updated (with the -r argument specified)

If the specified file does not exist, an error occurs.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

9

An error occurred when checking the execution permission.

Note

Do not directly edit the password authentication information definition file.

csauserdel (Deleting user information for password authentication)

Format

csauserdel [-h]
           -user user-name
           -f password-authentication-information-definition-file

Function

Deletes the user information registered in the password authentication information definition file.

The deleted user information is applied after the service adapter that uses the authentication information starts. If you execute the command when the service adapter is running, the deleted user information is applied after the service adapter starts the next time.

Note that the password authentication information definition file is not deleted even if there is no more user information in the file.

Note the following when you execute the command:

Specify access permissions so that only the administrator who executes the command can update and reference the password authentication information definition file.

We recommend that you create a backup file of the password authentication information definition file.

Arguments

-h

Displays the usage of the command. When you specify this option, all other options are ignored even if specified.

-user user-name ~ <halfwidth alphanumeric characters and halfwidth symbols> ((1 to 80 characters))

Specifies the user name to be deleted. The characters are case sensitive.

-f password-authentication-information-definition-file

Specifies the path of the password authentication information definition file as a relative or absolute path. To include spaces in the path, enclose the entire option argument in double quotation marks (").

If the specified file does not exist, an error occurs.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

9

An error occurred when checking the execution permission.

Note

Do not directly edit the password authentication information definition file.

csauserls (Displaying user information for password authentication)

Format

csauserls [-h]
          -f password-authentication-information-definition-file

Function

Displays the user information registered in the password authentication information definition file by using the following format.

--- (Variable-length dashed line header)
user-name
--- (Variable-length dashed line footer)

Note the following when you execute the command:

Specify access permissions so that only the administrator who executes the command can update and reference the password authentication information definition file.

Arguments

-h

Displays the usage of the command. When you specify this option, all other options are ignored even if specified.

-f password-authentication-information-definition-file

Specifies the path of the password authentication information definition file as a relative or absolute path. To include spaces in the path, enclose the specified value in double quotation marks (").

If the specified file does not exist, an error occurs.

Display format

(1) When the password authentication information definition file contains registered information

-------------------------------------------------------------
user-name
 ...
 ...
-------------------------------------------------------------

(2) When the password authentication information definition file does not contain registered information

----
none
----

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

9

An error occurred when checking the execution permission.

Note

Do not directly edit the password authentication information definition file.

cscapputil (Operating an application)

Format

cscapputil [-h]
 -user login-user-ID
 -pass login-password
 {-mng Manager-name
 |-host IP-address:port-number
 -mnguser Management-user-ID [-mngpass Management-user-password]}
 {-operation { start|stop|delete }
 -j2ee J2EE-server-name -app application-name
 |-operation list -j2ee J2EE-server-name}

Function

This command operates the applications managed by an HCSC server.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see the following locations in the uCosminexus Service Platform Setup and Operation Guide according to the purpose of use:

7.5.3 How to recover when executing HCSC server setup and unsetup

7.5.4 How to recover when deploying and deleting HCSC Components

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-mng Manager-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the name (Manager name) for identifying Management Server. Specify the name of the Manager existing in the repository.

-host host-name-or-IP-address: port-number ~ <host name or IP address: character string, port number: numeric string> ((character string: at least 1 character, port number: 1 - 65535))

Specifies the host name (or IP address) and the port number of the Manager remote management function connected with a colon (:). You cannot omit the IP address and the port number together.

You can specify the -host option even if the repository does not exist. When you specify the -host option, specify the options -mnguser and -mngpass.

-mnguser Management-user-ID ~ ((at least 1 character))

Specifies the management user ID of Management Server

-mngpass Management-user-password ~ ((at least 1 character))

Specifies the management user password of Management Server. Do not specify this option if there is no password.

-operation { start|stop|delete }

Specifies an operation of the specified application.

start

Starts the application.

stop

Stops the application.

delete

Deletes the application.

list

Displays the application.

-j2ee J2EE-server-name ~ ((at least 1 character))

Specifies the logical name of the J2EE server.

-app application-name ~ ((at least 1 character))

Specifies the application name.

You can omit this option if list is specified in the -operation option. If you specify a value for this option, the value is ignored.

Examples of input

(1) To start the application HCSCMessaging existing on the J2EE server J2EEServer

cscapputil -user admin -pass admin -host localhost:28099 -mnguser admin -j2ee J2EEServer -app HCSCMessaging -operation start

(2) To stop the application HCSCMessaging existing on the J2EE server J2EEServer

cscapputil -user admin -pass admin -host localhost:28099 -mnguser admin -j2ee J2EEServer -app HCSCMessaging -operation stop

(3) To delete the application HCSCMessaging existing on the J2EE server J2EEServer

cscapputil -user admin -pass admin -host localhost:28099 -mnguser admin -j2ee J2EEServer -app HCSCMessaging -operation delete

(4) To display the applications existing on the J2EE server J2EEServer

cscapputil -user admin -pass admin -host localhost:28099 -mnguser admin -j2ee J2EEServer -operation list

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

If you use this command to delete an application, the HCSC system might not operate normally. Therefore, carefully execute the operations.

csccmctl (Managing definition files)

Format

csccmctl [-h]
 -user login-user-ID
 -pass login-password
 -cluster cluster-name
 -name service-ID-of-service-adapter|reception-ID
 -targetfilename name-of-definition-file
 [-basedir current-directory]
 -operation {get|set|reset}

Function

You can use the following functions for the definition files set up in the development environment:

Obtaining the definition files set up in the development environment (-operation get)

Setting up the definition files in the operating environment (-operation set)

Deleting the definition files set up in the operating environment (-operation reset)

Use this command when different values are set up in the development and operating environments. The definition files set up with this command are only valid in the operating environment.

This command can only delete the definition files set up in the operating environment. You cannot delete the definition files set up in the development environment with this command. To delete the definition files set up in the development environment, delete the definition files when in the development environment.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see the following locations in the Service Platform Setup and Operation Guide according to the purpose of use:

Usage when get is specified in the -operation option

3.1.9 Importing the HCSC component definition files into the operating environment

Usage when set is specified in the -operation option

3.1.10 Setting and updating the HCSC component definition files in the operating environment

Usage when reset is specified in the -operation option

3.1.11 Deleting the HCSC component definition files from the operating environment

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the cluster that has a service adapter whose service information you intend to change. If the repository has one cluster, you can omit the -cluster option from this command by specifying that cluster in the HCSC-Manager command definition file.

-name service-ID-of-service-adapter|reception-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies one of the following:

To set up the service adapter definition file: Service ID

To set up a user-defined reception definition file: Reception ID

-targetfilename name-of-definition-file ~ ((at least 1 character))

Specifies the name of the definition file you want to obtain, set, update, and delete. You can only specify the file name as a value.

An error occurs if you specify the name of a non-existent file during obtain, set, and update operations; however, no error occurs if such a name is specified during the deletion operation. The processing continues.

The length of the directory and the file path is restricted depending on the OS. Set the length of the path coupled with the current directory specified in the -basedir option so that the length does not exceed the length restricted by the OS.

-basedir current-directory ~ ((at least 1 character))

Specify the relative or absolute directory path for the definition file you want to obtain, set, and update. The specified value must be a directory. Make sure that you specify an existing directory.

If this option is not specified, the path used for executing the command is considered as the current directory.

The length of the directory and the file path is restricted depending on the OS. Set the length of the path coupled with the definition file name specified in the -targetfilename option so that the length does not exceed the length restricted by the OS.

Note that this option is ignored when the -operation reset option is specified.

-operation {get|set|reset}

Obtains, sets, or deletes a definition file that is set up in the development environment, in the operating environment. Use this option to specify settings that are different from those in the development environment.

get

A definition file specified in the -targetfilename option is allocated to the directory specified in the -basedir option.

If the same file name exists, the file is overwritten.

set

The file specified in the -targetfilename option and present in the directory specified in the -basedir option is set up in the operating environment repository. If a definition file with the same name already exists, the contents are updated.

reset

If the file name specified in the -targetfilename option matches with the file name of the operating environment repository specified in the -operation set option, the definition file is deleted.

Examples of input

To set up the service adapter definition file

(1) To obtain the definition file adptp1_config.xml in the operating environment

csccmctl -cluster CLS1 -name ADP1 -targetfilename adptp1_config.xml -basedir C:\tmp -operation get

(2) To set up or update the definition file adptp1_config.xml in the operating environment

csccmctl -cluster CLS1 -name ADP1 -targetfilename adptp1_config.xml -basedir C:\tmp -operation set

(3) To delete the settings for the definition file adptp1_config.xml from the operating environment

csccmctl -cluster CLS1 -name ADP1 -targetfilename adptp1_config.xml -operation reset

To set up the TP1/ RPC reception definition file

(1) To obtain the definition file cscurecptp1rpc.properties in the operating environment

csccmctl -cluster CLS1 -name RCP1 -targetfilename cscurecptp1rpc.properties -basedir C:\tmp -operation get

(2) To set up or update the definition file cscurecptp1rpc.properties in the operating environment

csccmctl -cluster CLS1 -name RCP1 -targetfilename cscurecptp1rpc.properties -basedir C:\tmp -operation set

(3) To delete the settings for the definition file cscurecptp1rpc.properties from the operating environment

csccmctl -cluster CLS1 -name RCP1 -targetfilename cscurecptp1rpc.properties -operation reset

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

Execute the options -operation set or -operation reset before you deploy the components.

csccompoconfig (Defining HCSC components)

Format

csccompoconfig [-h]
 -user login-user-ID
 -pass login-password
 {-operation get -csc HCSC-server-name
 [-outputfile file-name-with-output-destination-path]
 |-operation set -propfile
 name-of-user-defined-reception-runtime-definition-file
 |name-of-HITACHI-Application-Integrated-Property-File
 {-csc HCSC-server-name|-cluster cluster-name}}
 -name reception-ID

Function

Obtains and changes the definition information of a user-defined reception.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see the following locations in the uCosminexus Service Platform Setup and Operation Guide according to the purpose of use:

Usage when set is specified in the -operation option

3.1.15 Setting the definition information for user-defined receptions

Usage when get is specified in the -operation option

3.1.16 Checking the definition information of the user-defined receptions

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-operation {get|set}

Specifies the operations of this command.

get

Outputs the definitions set up in the specified user-defined reception to the standard output.

set

Applies the contents of the file specified in the -propfile option to the specified user-defined reception.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the HCSC server name.

-outputfile file-name-with-output-destination-path ~ ((1 to 200 bytes))

Specifies the file name and the path to output the defined contents when the -operation get option is specified. Specify a relative or absolute path.

-propfile name-of-user-defined-reception-runtime-definition-file| name-of-HITACHI-Application-Integrated-Property-File ~ ((1 to 200 bytes))

Specifies the file name containing the list of definitions to be defined in one of the following receptions. Specify the name with a relative or absolute path. This option is enabled when the -operation set option is specified.

SOAP reception: Sets up the user-defined reception runtime definition file.

Custom reception: Sets up the HITACHI Application Integrated Property File.

-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters)) <<server name specified in the -csc option>>

Specifies the cluster name. This option is enabled when the -operation set option is specified. Also, an error occurs if you specify the -cluster option when the cluster type is HA.

-name reception-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the reception ID of the user-defined reception.

Output format

The output format when you specify the -operation get option is as follows:

SOAP reception

user-defined-reception-soap.threads.maximum=20
user-defined-reception-soap.queue-size=1000
user-defined-reception-soap.exclusive.threads=2

Custom reception

The output format complies with that of the HITACHI Application Integrated Property File.

If you specify the file name with an output destination path in the -outputfile option when the -operation get option is specified, the standard output information is output to the specified file.

Examples of input

(1) To obtain the definition of the SOAP user-defined reception ID URECP1 deployed on the server CSCSrv1

csccompoconfig -user admin -pass admin -csc CSCSrv1 -name URECP1 -operation get

(2) To output the definition of the SOAP user-defined reception ID URECP1 deployed on the server CSCSrv1, to a file

csccompoconfig -user admin -pass admin -csc CSCSrv1 -name URECP1 -operation get -outputfile runtime_recp1.properties

(3) To obtain the definition of the custom reception ID CRECP1 deployed on the server CSCSrv1

csccompoconfig -user admin -pass admin -csc CSCSrv1 -name CRECP1 -operation get

(4) To output the definition of the custom reception ID CRECP1 deployed on the server CSCSrv1, to a file

csccompoconfig -user admin -pass admin -csc CSCSrv1 -name CRECP1 -operation get -outputfile userdef_crecp1.xml

(5) To set up the definitions of all the SOAP user-defined reception IDs URECP1 deployed in the cluster CLS1

csccompoconfig -user admin -pass admin -cluster CLS1 -name URECP1 -operation set -propfile cscurcptnconfig.properties

(6) To set up the definitions of all the custom reception IDs CRECP1 deployed in the cluster CLS1

csccompoconfig -user admin -pass admin -cluster CLS1 -name CRECP1 -operation set -propfile userdef_crecp1.xml

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

2

A communication timeout occurred.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

For a SOAP reception, execute this command after deploying the components.

For a custom reception, execute this command after deploying the components and stopping the service.

An error occurs if you execute this command for components that are not deployed.

Only the values that are changed from the default values are output.

When you delete a component, the values specified for that component become invalid.

csccompodeploy (Deploying HCSC components)

Format

csccompodeploy [-h]
 -user login-user-ID
 -pass login-password
 {-csc HCSC-server-name|-cluster cluster-name}
 {-name service-ID|reception-ID
 |-all [-errskip]
 |-namelist file-name-specifying-HCSC-components [-errskip]}

Function

Deploys HCSC components on the HCSC server that is already set up.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

If an error occurs in one of the execution-target HCSC components (including errors generated during invocation of HCSC components, such as communication failure), you can use the error skip function to skip that HCSC component and continue processing. You cannot use the error skip function from the operating window in the operating environment or from the batch execution function (for example, starting HCSC components deployed on the server) in the development environment.

For details on how to use this command, see the following locations in the Service Platform Setup and Operation Guide according to the purpose of use:

3.1.8 Deploying a service adapter

3.1.13 Deploying a business process

3.1.14 Deploying a user-defined reception

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the HCSC server on which the HCSC components are to be deployed.

-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the cluster name where the HCSC components are to be deployed in a batch. Note that an error occurs if you specify the -cluster option when the cluster type is HA.

-name service-ID|reception-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the service ID or reception ID of the HCSC components to be deployed.

-all

Deploys all the undeployed HCSC components. When you specify this option along with -csc, all the undeployed HCSC components within the HCSC server will be deployed. When you specify this option along with -cluster, all the undeployed HCSC components within that cluster will be deployed.

The following table lists the order in which the HCSC components are deployed when you specify this option. When -errskip is not specified along with this option, if an error occurs during processing, the deployment processing will stop even if all the HCSC components are not deployed.

Deployment order

Type of HCSC components

Deployment order within HCSC components

1

Service adapters

Ascending order of service IDs

2

Business processes

Ascending order of business process names

3

User-defined receptions

The following priority applies:

Ascending order of reception IDs of user-defined receptions (invocation target selected)

Ascending order of business process names and ascending order of reception IDs of user-defined receptions (invocation target fixed)

-errskip

Continues processing even if some of the specified HCSC components cannot be deployed (error skip function). Specify this option along with -all or -namelist.

With the error skip function enabled, if errors occur in HCSC components, messages are output to the HCSC-Manager log and console according to the following procedure:

When an error occurs in an HCSC component, the relevant error message is output and the processing continues.

After processing of all the HCSC components terminates, a warning message indicating the number of HCSC components that caused errors is output.

You can omit the specification of this option in this command by defining this option in the HCSC-Manager command definition file (csccmd.properties) to always enable the error skip function. For details about how to define the HCSC-Manager command definition file, see 6.5.2 HCSC-Manager command definition file.

-namelist file-name-specifying-HCSC-components ~ ((1 to 200 bytes))

Uses the HCSC component-specification file to specify the HCSC components to be deployed. Specify this file with an absolute or relative path. If the file does not exist, the command ends abnormally. For details on the HCSC component-specification file, see 6.5.5 HCSC component-specification file.

Note that the deployment order of the specified HCSC components and the processing in the event of an error are the same as those for the -all option.

Example of input

(1) To deploy all the service adapters on a single HCSC server

csccompodeploy -user login-user-ID -pass login-password -csc HCSC-server-name -all

(2) To deploy the specified service adapter on a single HCSC server

csccompodeploy -user login-user-ID -pass login-password -csc HCSC-server-name -name service-ID-of-service-adapter

(3) To deploy all the HCSC components on the HCSC server CSCSrv1, and continue processing even if some HCSC components cannot be deployed

csccompodeploy -csc CSCSrv1 -all -errskip

(4) To deploy the HCSC components specified in the HCSC component-specification file hcsccomponent.txt on HCSC server CSCSrv1, and continue processing even if some HCSC components cannot be deployed:

csccompodeploy -csc CSCSrv1 -namelist hcsccomponent.txt -errskip

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

2

A communication timeout occurred.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

If -errskip is specified, the return value is 0 because processing continues even if an error occurs during processing of an HCSC component. However, if an error such as an invalid combination of options occurs other than during invocation of an HCSC component, the return value might be other than 0.

Notes

If multiple clients simultaneously execute this command for one HCSC server, a processing error (exclusion error, or abnormal end due to repeated operations for a component) might occur. If an error occurs, re-execute the command using one of the following methods:

Specify the -all option to redeploy HCSC components

Specify the -name option to deploy HCSC components individually

csccompostart (Starting HCSC components)

Format

csccompostart [-h]
 -user login-user-ID
 -pass login-password
 {-csc HCSC-server-name|-cluster cluster-name}
 {-name service-ID|reception-ID
 |-all [-errskip]
 |-namelist file-name-specifying-HCSC-components [-errskip]}
 [-nogc]

Function

Starts HCSC components.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

If an error occurs in one of the execution-target HCSC components (including errors generated during invocation of HCSC components, such as communication failure), you can use the error skip function to skip that HCSC component and continue processing. You cannot use the error skip function from the operating window in the operating environment or from the batch execution function (for example, starting HCSC components deployed on the server) in the development environment.

For details on how to use this command, see the following locations in the Service Platform Setup and Operation Guide according to the purpose of use:

5.3.6 Starting Service Adapters

5.3.7 Starting Business Processes

5.3.8 Starting user-defined receptions

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the HCSC server name of the HCSC components to be started.

-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the cluster where the HCSC components will be started in a batch. An error occurs if you specify the -cluster option when the cluster type is HA.

-name service-ID|reception-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the service ID or reception ID of the HCSC components to be started. When you specify this option along with the -cluster option, all the HCSC components with the same service ID within the cluster will start.

-all

Starts all the stopped HCSC components within the specified range. When you specify this option along with the -csc option, all the stopped HCSC components within the specified HCSC server will start. When you specify this option along with the -cluster option, all the stopped HCSC components within the specified cluster will start.

The following table lists the order in which the HCSC components are started when you specify this option. When -errskip is not specified along with this option, if an error occurs during processing, the start processing will stop even if all the HCSC components have not started.

Starting order

Types of HCSC components

Starting order within HCSC components

1

Service adapters

Ascending order of service IDs

2

Business processes

Ascending order of business process names

3

User-defined receptions

The following priority applies:

Ascending order of reception IDs of user-defined receptions (invocation target selected)

Ascending order of business process names and ascending order of reception IDs of user-defined receptions (invocation target fixed)

-errskip

Continues processing even if some of the specified HCSC components cannot start (error skip function). Specify this option along with -all or -namelist.

With the error skip function enabled, if errors occur in HCSC components, messages are output to the HCSC-Manager log and console according to the following procedure:

When an error occurs in an HCSC component, the relevant error message is output and the processing continues.

After processing of all the HCSC components terminates, a warning message indicating the number of HCSC components that caused errors is output.

You can omit the specification of this option in this command by defining this option in the HCSC-Manager command definition file (csccmd.properties) to always enable the error skip function. For details about how to define the HCSC-Manager command definition file, see 6.5.2 HCSC-Manager command definition file.

-namelist file-name-specifying-HCSC-components ~ ((1 to 200 bytes))

Uses the HCSC component-specification file to specify the HCSC components to be started. Specify this file with an absolute or relative path. If the file does not exist, the command ends abnormally. For details on the HCSC component-specification file, see 6.5.5 HCSC component-specification file.

Note that the starting order of the specified HCSC components and the processing in the event of an error are the same as those for the -all option.

-nogc

Starts the components without generating Full GC. However, the specification of this option does not control Full GC generated automatically by Java VM or Full GC issued by an abnormal J2EE server processing.

Execute the javagc command to explicitly generate Full GC when an HCSC component starts. For details on the javagc command, see javagc (forcibly perform GC) in the manual uCosminexus Application Server Command Reference Guide.

Examples of input

(1) To start BP1 existing on the HCSC server HCSC

csccompostart -user admin -pass admin -csc HCSC -name BP1

(2) To start all the HCSC components existing on the HCSC server HCSC in a batch

csccompostart -user admin -pass admin -csc HCSC -all

(3) To start BP1 on each HCSC server in the cluster Cluster in a batch

csccompostart -user admin -pass admin -cluster Cluster -name BP1

(4) To start all the HCSC components existing in the cluster Cluster in a batch

csccompostart -user admin -pass admin -cluster Cluster -all

(5) To start BP1 existing on the HCSC server CSCSrv1 in a batch and without generating Full GC

csccompostart -user admin -pass admin -csc CSCSrv1 -name BP1 -nogc

(6) To start the HCSC components specified in the HCSC component-specification file hcsccomponent.txt, from among the HCSC components on the HCSC server CSCSrv1, in a batch

csccompostart -user admin -pass admin -csc CSCSrv1 -namelist hcsccomponent.txt

(7) To start all HCSC components existing on the HCSC server CSCSrv1, and continue processing even if some HCSC components cannot start

csccompostart -csc CSCSrv1 -all -errskip

(8) To start the HCSC components specified in the HCSC component-specification file hcsccomponent.txt, from among the HCSC components on the HCSC server CSCSrv1, and continue processing even if some HCSC components cannot start

csccompostart -csc CSCSrv1 -namelist hcsccomponent.txt -errskip

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

2

A communication timeout occurred.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

If -errskip is specified, the return value is 0 because processing continues even if an error occurs during processing of an HCSC component. However, if an error such as an invalid combination of options occurs other than during invocation of an HCSC component, the return value might be other than 0.

Notes

Execute this command for the stopped HCSC components. If multiple HCSC components are specified, the command is executed only for the running HCSC components. The processing will be skipped for HCSC components that are not running.

The HCSC server must be running when you execute the command.

If an error occurs when you specify the options -cluster or -all, check the results with the cscstatus command, eliminate the cause of the error, and then re-execute the command.

If multiple clients simultaneously execute this command for one HCSC server, a processing error (exclusion error, or abnormal end due to repeated operations for a component) might occur. If an error occurs, re-execute the command using one of the following methods:

Specify the -all option to start HCSC components

Specify the -name option to start HCSC components individually

csccompostop (Stopping HCSC components)

Format

csccompostop [-h]
 -user login-user-ID
 -pass login-password
 {-csc HCSC-server-name|-cluster cluster-name}
 {-name service-ID|reception-ID|-all
 |-namelist file-name-specifying-HCSC-components}
 [-nogc]

Function

Stops HCSC components.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see the following locations in the Service Platform Setup and Operation Guide according to the purpose of use:

5.3.34 Stopping the user -defined reception

5.3.35 Terminating the Service Adapter

5.3.36 Terminating the Business Process

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the HCSC server name of the HCSC components to be stopped.

-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the cluster where the HCSC components will be stopped in a batch. An error occurs if you specify the -cluster option when the cluster type is HA.

-name service-ID|reception-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the service ID or reception ID of the HCSC components to be stopped. When you specify this option along with the -cluster option, all the HCSC components with the same service ID within the cluster will stop.

-all

Stops all the running HCSC components within the specified range. When you specify this option along with the -csc option, all the running HCSC components within that HCSC server will start. When you specify this option along with the -cluster option, all the running HCSC components within that cluster will stop.

The following table lists the order in which the HCSC components are stopped when you specify this option. If an error occurs during processing, the stop processing will end even if all the HCSC components are not stopped.

Stopping order

Types of HCSC components

Stopping order within HCSC components

1

User-defined reception

The following priority applies:

Ascending order of reception IDs of user-defined receptions (invocation target selected)

Ascending order of business process names and ascending order of reception IDs of user-defined receptions (invocation target fixed)

2

Business process

Ascending order of business process names

3

Service adapter

Ascending order of service IDs

-namelist file-name-specifying-HCSC-components ~ ((1 to 200 bytes))

Uses the HCSC component-specification file to specify the HCSC components to be stopped. Specify this file with an absolute or relative path. If the file does not exist, the command ends abnormally. For details on the HCSC component-specification file, see 6.5.5 HCSC component-specification file.

Note that the HCSC components are stopped in the same order as that described for the -all option.

-nogc

Stops the components without generating Full GC. However, the specification of this option does not control Full GC generated automatically by Java VM.

Examples of input

(1) To stop BP1 existing on the HCSC server HCSC

csccompostop -user admin -pass admin -csc HCSC -name BP1

(2) To stop all the HCSC components existing on the HCSC server HCSC in a batch

csccompostop -user admin -pass admin -csc HCSC -all

(3) To stop BP1 on each HCSC server in the cluster Cluster in a batch

csccompostop -user admin -pass admin -cluster Cluster -name BP1

(4) To stop all the HCSC components existing in the cluster Cluster in a batch

csccompostop -user admin -pass admin -cluster Cluster -all

(5) To stop BP1 existing on the HCSC server CSCSrv1 in a batch and without generating Full GC

csccompostop -user admin -pass admin -csc CSCSrv1 -name BP1 -nogc

(6) To stop the HCSC components specified in the HCSC component-specification file hcsccomponent.txt, from among the HCSC components on the HCSC server CSCSrv1, in a batch

csccompostop -user admin -pass admin -csc CSCSrv1 -namelist hcsccomponent.txt

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

2

A communication timeout occurred.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

Execute this command to stop running HCSC components. If multiple HCSC components are specified, the command is executed only for the running HCSC components. The processing will be skipped for HCSC components that are not running.

The HCSC server must be running when you execute the command.

If an error occurs when you specify the options -cluster or -all, check the results with the cscstatus command, eliminate the cause of the error, and then re-execute the command.

If multiple clients simultaneously execute this command for one HCSC server, a processing error (exclusion error, or abnormal end due to repeated operations for a component) might occur. If an error occurs, re-execute the command using one of the following methods:

Specify the -all option to stop HCSC components

Specify the -name option to stop HCSC components individually

csccompoundeploy (Deleting the deployed HCSC components)

Format

csccompoundeploy [-h]
 -user login-user-ID
 -pass login-password
 {-csc HCSC-server-name|-cluster cluster-name}
 {-name service-ID|reception-ID|-all
 |-namelist file-name-specifying-HCSC-components}
 [-force]
 [-ignore]
 [-nogc]

Function

Deletes the HCSC components deployed in the execution environment.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see the following locations in the Service Platform Setup and Operation Guide according to the purpose of use:

3.3.1 Deleting a service adapter

3.3.2 Deleting a business process

3.3.3 Deleting a user-defined reception

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the HCSC server to which the HCSC components to be deleted from the execution environment, belong.

-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the cluster from where the HCSC components are to be deleted in a batch. Note that an error occurs if you specify the -cluster option when the cluster type is HA.

-name service-ID|reception-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the service ID or reception ID of the HCSC components to be deleted from the execution environment.

-all

Deletes all the deployed HCSC components. When you specify this option along with the -csc option, all the HCSC components deployed within that HCSC server will be deleted. When you specify this option along with the -cluster option, all the HCSC components deployed within that cluster will be deleted.

The following table lists the order in which the HCSC components are deleted when you specify this option. If an error occurs during processing, the deletion processing will stop even if all the HCSC components are not deleted.

Deletion order

Types of HCSC components

Deletion order within HCSC components

1

User-defined receptions

The following priority applies:

Ascending order of reception IDs of user-defined receptions (invocation target selected)

Ascending order of business process names and ascending order of reception IDs of user-defined receptions (invocation target fixed)

2

Business processes

Ascending order of business process names

3

Service adapters

Ascending order of service IDs

-namelist file-name-specifying-HCSC-components ~ ((1 to 200 bytes))

Uses the HCSC component-specification file to specify the HCSC components to be deleted. Specify this file with an absolute or relative path. If the file does not exist, the command ends abnormally. For details on the HCSC component-specification file, see 6.5.5 HCSC component-specification file.

Note that the HCSC components are deleted in the same order as that described for the -all option.

-force

Forcefully deletes the deployed service adapters. This option is enabled for service adapters. Even if you specify this option for a business process and a user-defined reception, the business process and the user-defined reception are not deleted. Note that if the service adapter to be deleted is asynchronous (MDB (WS-R)), the service adapter will be deleted even if there are messages in the transfer queue.

-ignore

This option is specified to update the repository information even when the HCSC components deployed in the execution environment cannot be deleted. This option is used to achieve integrity between the execution and repository environments in the event of a hard disk failure or a communication error during unsetup.

-nogc

Deletes the components without generating Full GC. However, the specification of this option does not control Full GC generated automatically by Java VM.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

2

A communication timeout occurred.

3

An exclusion error occurred.

4

The service adapter could not be deleted because message processing was underway.

9

An error occurred when checking the execution permission.

Notes

If multiple clients simultaneously execute this command for one HCSC server, a processing error (exclusion error, or abnormal end due to repeated operations for a component) might occur. If an error occurs, re-execute the command using one of the following methods:

Specify the -all option to delete HCSC components

Specify the -name option to delete HCSC components individually

cscenvbackup (Backing up the HCSC-Manager environment)

Format

cscenvbackup [-h]
 -user login-user-ID
 -pass login-password
 [-backupdir backup-file-output-destination-directory]

Function

Backs up the files required for restoring the HCSC-Manager environment to recover an error that occurs in the HCSC-Manager environment, and for executing environment migration operations, such as scale up. The backup file name is assigned in the following format:

For IPv4: cscmngBKaaabbbcccddd_YYYYMMDDhhmmss.zip

For IPv6: cscmngBKaaaabbbbccccddddeeeeffffgggghhhh_YYYYMMDDhhmmss.zip

cscmngBK:

Indicates that the file is a backup file of the HCSC-Manager environment.

aaabbbcccddd:

Indicates the IPv4 address of the computer that executed the command. However, if an attempt to acquire the IP address failed, no IP address is included in the file name.

aaaabbbbccccddddeeeeffffgggghhhh:

Indicates the IPv6 address of the computer that executed the command. However, if an attempt to acquire the IP address failed, no IP address is included in the file name.

YYYYMMDDhhmmss:

Indicates the time of the backup.

YYYY: year, MM: month, DD: day, hh: hours, mm: minutes, ss: seconds

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see 7.9.3 Backup and recovery of operating environment in the Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-backupdir backup-file-output-destination-directory ((1 to 100 bytes))

Specifies the directory to output the backup files for the HCSC-Manager environment. If this option is omitted, the output destination specified in the HCSC-Manager definition file is assumed.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

The system configuration information cannot be compared with the current information by the cscrepdiff command.

cscenvrestore (Restoring the HCSC-Manager environment)

Format

cscenvrestore [-h]
 -user login-user-ID
 -pass login-password
 -restorefile backup-file-name-of-HCSC-Manager-operating-environment

Function

This command restores the environment by using the following backup files of the HCSC-Manager environment:

Backup files obtained automatically when the repository is successfully imported

Backup files obtained with the cscenvbackup command

The environment cannot be restored by using any other files.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see 7.9.3 Backup and recovery of operating environment in the Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-restorefile backup-file-name-of-HCSC-Manager-operating-environment ~ ((1 to 200 bytes))

Specifies the name of the backup file for restoring the HCSC-Manager operating environment as an absolute or relative path. By default, this option specifies the backup file that is obtained automatically when the repository is successfully imported.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

Restore the environment with the HCSC-Manager environment backup files appropriate for the HCSC server environment.

cscenvupdate (Upgrading the execution environment)

Format

cscenvupdate [-h]
 -csc HCSC-server-name
 [-force]

Function

Updates the execution environment or the database for the specified HCSC server. The repository is also updated simultaneously if the version of the operating environment repository is an earlier version.

By setting up the default HCSC server name in the HCSC-Manager command definition file, you can omit the specification of the server name in this command.

For details on how to use this command, see the following locations in the Service Platform Setup and Operation Guide according to the purpose of use:

To upgrade the repository in the development environment

Appendix G. Migration from an Old Version

To upgrade the repository in the operating environment

Appendix H. Performing Repository Migration from an Old Version in the Operating Environment

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the HCSC server to be upgraded.

-force

Executes the in-process upgrade operation when an error occurs even when the cscenvupdate command is not being executed.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

An error might occur if you perform a rolling update when the database is HiRDB. For details, see Appendix G.4 Migration procedure for a rolling update in the Service Platform Setup and Operation Guide.

If the command ends with an error, eliminate the error and then re-execute the command.

If a file I/O error occurs while the repository is being updated, the message KEOS50133-E might be output when you re-execute the command. In such cases, see 7.6.2 How to perform recovery when file input and output has failed in the Service Platform Setup and Operation Guide, to manually restore the environment.

If the version of the operating environment repository is an earlier version, make sure that a drive on the following directories has free space of at least 3-times the disk usage for the repository:

Installation directory of the service platform

Directory specified in the CSCMNG_HOME environment variable

cscfscls (Referencing a common folder)

Format

cscfscls [-h]
 -user login-user-ID
 -pass login-password
 {-csc HCSC-server-name|-cluster cluster-name}
 {-folder common-folder-definition-name|-all}
 [-t start-date-and-time|-d number-of-days]
 [-recursive]

Function

References the files in common folders.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

If there are user-created files and directories in the common folder, you can recursively reference the directories and files in those directories.

For details on how to use this command, see 5.4.21 Referencing the information of the common folder in the Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager. The characters are case sensitive.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager. The characters are case sensitive.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the HCSC server name. The characters are case sensitive.

-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the cluster name. The characters are case sensitive.

-folder common-folder-definition-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 64 characters))

Specifies the common folder definition name. The characters are case sensitive.

-all

References the files in all common folders.

-t start-date-and-time

References the files in the common folders older than the specified date and time. If the -recursive option is specified and there are no files in the subfolders in the common folders, the command references the subfolders older than the specified date and time. Note that you can specify the date and time in the following format. You must specify an existing date and time in 14 digits.

Start date and time: Specify the date and time in the YYYYMMDDhhmmss format.

YYYY: Year (1970 YYYY)

MM: Month (01 MM 12)

DD: Date (01 DD 31)

hh: Hours (00 hh 23)

mm: Minutes (00 mm 59)

ss: Seconds (00 ss 59)

-d number-of-days ~ <Integer> ((0 to 365))

References the files older than the specified number of days, in the common folder. If the -recursive option is specified and there are no files in the subfolders in the common folder, the command references the subfolders older than the specified number of days. Specify the number of days in days. If you specify 0, all the files in the common folder will be referenced.

-recursive

Recursively references files in the subfolders. The files in the subfolders are displayed for FileName by using the relative paths from the common folder root. For a subfolder that contains no files, the folder name suffixed with / is displayed for FileName.

Output format

When the command does not recursively reference the files in the subfolders

HCSCServerName CommonFolderName FileSize LastModifiedTime FileName
HCSC-server-name common-folder-definition-name file-size last-update-time-of-file file-name
 ...
HCSC-server-name common-folder-definition-name file-size last-update-time-of-file file-name

When the command recursively references the files in the subfolders

HCSCServerName CommonFolderName FileSize LastModifiedTime FileName
HCSC-server-name common-folder-definition-name file-size last-update-time-of-file-or-folder file-name-or-folder-name
 ...
HCSC-server-name common-folder-definition-name file-size last-update-time-of-file-or-folder file-name-or-folder-name

Description

Display item

Description

HCSCServerName

Indicates the HCSC server name.

CommonFolderName

Indicates the common folder definition name.

FileSize

Indicates the file size in bytes. When a folder is displayed, 0 (bytes) is displayed.

LastModifiedTime

Indicates the last update time of a file or folder in the YYYY/MM/DD hh:mm:ss format.

FileName

Indicates file name or folder name. If the file name exceeds 200 bytes, the first 200 bytes are displayed.

An example of output is as follows:

When the command does not recursively reference the files in the subfolders

HCSCServerName CommonFolderName FileSize LastModifiedTime FileName
HCSC FOLDER1 1024 2010/04/26 14:26:39 ftpcommon.txt2010_04_26_14_26_39_111
HCSC FOLDER2 1050 2010/04/26 14:26:40 ftp.txt2010_04_26_14_26_39_222
HCSC FOLDER3 1020 2010/04/26 14:26:50 ftp.txt2010_04_26_14_26_39_333

When the command recursively references the files in the subfolders

HCSCServerName CommonFolderName FileSize LastModifiedTime    FileName
HCSC           FOLDER1          156      2015/04/22 10:01:20 ftpcommon.txt
HCSC           FOLDER1          297      2015/04/22 10:01:20 sub1/ftp.txt
HCSC           FOLDER1          1089     2015/04/22 10:01:20 sub1/sub2/ftp.txt
HCSC           FOLDER1          0        2015/04/22 10:01:20 sub3/
HCSC           FOLDER1          0        2015/04/22 10:01:21 sub4/sub5/

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

2

A communication timeout occurred.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

cscfscrm (Deleting a common folder)

Format

cscfscrm [-h]
 -user login-user-ID
 -pass login-password
 {-csc HCSC-server-name|-cluster cluster-name}
 {-folder common-folder-definition-name
 [-targetfilename file-name-or-folder-name|-t deletion-start-date-and-time|-d number-of-days]
 |-all [-t deletion-start-date-and-time|-d number-of-days]}
 [-retrycount retry-count]
 [-retryinterval retry-interval-(seconds)]
 [-recursive]

Function

Deletes the files in a common folder and files under subfolders. This command does not delete the common folder and the folders in the common folder. If the common folder contains a subfolder, you can recursively delete the files in the subfolder.

The retry count and the retry interval are used to obtain a lock. If you specify multiple files, the retry count and the retry interval are enabled for each file.

The processing will be cancelled after an error occurs when you delete multiple files.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see 5.4.22 Deleting files in the common folder in the uCosminexus Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager. The characters are case sensitive.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager. The characters are case sensitive.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the HCSC server name. The characters are case sensitive.

-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the cluster name. The characters are case sensitive.

-folder common-folder-definition-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 64 characters))

Specifies the common folder definition name. The characters are case sensitive.

-targetfilename file-name-or-folder-name ~ ((1 to 200 bytes))

Specifies the name of the file or subfolder to be deleted. If you specify a subfolder, the command deletes the files directly under the subfolder. To recursively delete the files under the subfolder, you must also specify the -recursive option. To specify a file or folder in a subfolder, specify the relative path from the common folder root.

Specify the files existing in the common folder. To reference the files in a common folder, execute the cscfscls command.

-t deletion-start-date-and-time

Deletes the files in the common folders older than the specified date and time. If the -recursive option is specified, the command also deletes the files in the subfolders older than the specified date and time. Note that you can specify the date and time in the following format. You must specify an existing date and time in 14 digits.

YYYYMMDDhhmmss

YYYY: Year (1970 YYYY)

MM: Month (01 MM 12)

DD: Date (01 DD 31)

hh: Hours (00 hh 23)

mm: Minutes (00 mm 59)

ss: Seconds (00 ss 59)

-d number-of-days ~ <Integer> ((0 to 365))

Deletes the files older than the specified number of days, in the common folder. If the -recursive option is specified, the command also deletes the files in the subfolders older than the specified number of days. Specify the number of days in days. If you specify 0, all the files in the common folder will be deleted.

-all

Deletes the files from all common folders.

-retrycount retry-count ~ <Integer> ((0 to 10000))

Specifies the retry count. The default value is 0.

If 0 is specified, the operation is not retried.

-retryinterval retry-interval-(seconds) ~ <Integer> ((0 to 86400))

Specifies the retry interval in seconds. The default value is 1.

If 0 is specified, the operation is retried without an interval.

-recursive

Recursively deletes files in the subfolders.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

2

A communication timeout occurred.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

Files in common folders are not automatically deleted. We recommend that you determine the retention period of files in advance and periodically delete old files.

Before you execute this command, make sure that the required files do not exist in the common folder.

Make sure that no business process is accessing the files to be deleted.

When executing this command during execution of a business process, you must consider the possibility that you might not be able to obtain a file lock due to conflict with other processes. Set the appropriate lock retry count and lock retry interval for this command and for each function that accesses common folders.

cscfswls (Referencing a work folder)

Format

cscfswls [-h]
 -user login-user-ID
 -pass login-password
 {-csc HCSC-server-name|-cluster cluster-name}
 {-name reception-ID|-all}
 [-t start-date-and-time|-d number-of-days]

Function

References work folders on a reception basis.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

If there are user-created files and directories in the work folder, only the directories are displayed.

For details on how to use this command, see 5.4.19 Referencing the work folder in the Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager. The characters are case sensitive.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager. The characters are case sensitive.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the HCSC server name. The characters are case sensitive.

-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the cluster name. The characters are case sensitive.

-name reception-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the reception ID. The characters are case sensitive.

-all

References all work folders.

-t start-date-and-time

References the work folders older than the specified date and time. Note that you can specify the date and time in the following format. You must specify an existing date and time in 14 digits.

YYYYMMDDhhmmss

YYYY: Year (1970 YYYY)

MM: Month (01 MM 12)

DD: Date (01 DD 31)

hh: Hours (00 hh 23)

mm: Minutes (00 mm 59)

ss: Seconds (00 ss 59)

-d number-of-days ~<Integer> ((0 to 365))

References the work folders older than the specified number of days. Specify the number of days in days. If 0 is specified, all the work folders will be referenced.

Output format

HCSCServerName ReceptionID FolderSize LastModifiedTime FolderName
HCSC-server-name reception-ID total-size-of-files-in-folder last-update-time-of-folder folder-name
 ...
HCSC-server-name reception-ID total-size-of-files-in-folder last-update-time-of-folder folder-name

Description

Display item

Description

HCSCServerName

Indicates the HCSC server name.

ReceptionID

Indicates the reception ID.

FolderSize

Indicates the total size of the files in the folder in bytes. This does not include the size of the folder itself.

LastModifiedTime

Indicates the last update time of the folder as YYYY/MM/DD hh:mm:ss.

If there are files in the folder, the last update time of the file with the most recent last update time will be output from among the existing files.

FolderName

Indicates the folder name.

An example of output is as follows:

HCSCServerName ReceptionID FolderSize LastModifiedTime FolderName
HCSC rcp1 1020 2010/04/26 14:26:39 01111101111120100426142639111000
HCSC rcp2 1030 2010/04/26 14:26:40 01111101111120100426142640111000
HCSC rcp3 1004 2010/04/26 14:26:50 01111101111120100426142650111000

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

2

A communication timeout occurred.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

cscfswrm (Deleting a work folder)

Format

cscfswrm [-h]
 -user login-user-ID
 -pass login-password
 {-csc HCSC-server-name|-cluster cluster-name}
 {-name reception-ID|-all }
 [ -t deletion-start-date-and-time|-d number-of-days]

Function

Deletes folders on a reception basis.

The processing stops after an error occurs when you delete multiple files.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see 5.4.20 Deleting the work folder in the Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager. The characters are case sensitive.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager. The characters are case sensitive.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the HCSC server name. The characters are case sensitive.

-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the cluster name. The characters are case sensitive.

-name reception-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the reception ID. The characters are case sensitive.

-all

Deletes all work folders.

-t deletion-start-date-and-time

Deletes the work folders (including the files and folders in the work folders) older than the specified date and time. Note that you can specify the date and time in the following format. You must specify an existing date and time in 14 digits.

YYYYMMDDhhmmss

YYYY: Year (1970 YYYY)

MM: Month (01 MM 12)

DD: Date (01 DD 31)

hh: Hours (00 hh 23)

mm: Minutes (00 mm 59)

ss: Seconds (00 ss 59)

-d number-of-days ~<Integer> ((0 to 365))

Deletes the files in the work folder older than the specified number of days. Specify the number of days in days. If 0 is specified, all the work folders will be deleted.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

2

A communication timeout occurred.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

If work folders remain undeleted, the number of subdirectories might reach the upper limit for the file system of the OS, and a request can no longer be executed. Therefore, periodically delete work folders. When you delete work folders, determine the deletion start date and time and the number days, considering the execution period of business processes.

Before you execute the command, stop the reception that manages work folders and the business processes which are invoked by that reception.

Specify the date and time for the execution environment in the deletion start date and time.

Before you execute this command, make sure that required directories and files do not exist in the work folder.

cscmsgtk (Invoking the message tracking function)

Format

cscmsgtk [-h]
 -prf trace-based-performance-analysis -file-name
 [-date [read-start-date-and-time],[read-end-date-and-time]]

Function

Reads the trace based performance analysis for the specified condition and invokes the message tracking function. When the message tracking function starts, an interactive prompt exclusively used for message tracking appears. This prompt waits for you to enter a command (commands for the message tracking prompt) used in the message tracking function.

By setting up the default trace based performance analysis file name in the HCSC-Manager command definition file, you can omit the specification of the file name in this command.

For details on how to use this command, see 7.10 Error analysis using message tracking in the Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-prf trace based-performance-analysis-file-name ~ ((1 to 200 bytes))

Specifies the name of the trace based performance analysis file (CSV format), which is read when the message tracking function is invoked, as an absolute or relative path. If the specified file does not exist, the command ends abnormally.

-date [read-start-date-and-time],[read-end-date-and-time] ~ <one-byte numeric characters>

Specifies the range of trace based performance analysis read when the message tracking function is invoked. Specify the read start date and time and read end date and time in one of the following formats. Also, make sure you specify an existing date and time.

Format 1: hhmmssMMddyyyy

Format 2: hhmmssMMdd

Format 3: hhmmss

hh: Hours (00 hh 23)

mm: Minutes (00 mm 59)

ss: Seconds (00 ss 59)

MM: Month (01 MM 12)

dd: Date (01 dd 31)

yyyy: Year (1970 yyyy)

If only the Year is omitted (format 2), the year of command execution will be set up. If the Year, Month, and Date are omitted (format 3), the year, month, and date of command execution will be set up. If the read start date and time is omitted, the trace based performance analysis will be read from the oldest trace. If the read end date and time is omitted, the trace based performance analysis will be read until the most recent trace.

Commands used at the message tracking prompt

Error analysis command

Format

prf IP-address-of-root-application-information/ process-ID-of-root-application-information/ communication-number-of-root-application-information
[Communication-number]

Description

Outputs the information about the trace based performance analysis that matches the specified root application information.

IP-address-of-root-application-information/ process-ID-of-root-application-information/ communication-number-of-root-application-information

Outputs a set of trace contents for the specified root application information.

Communication-number

Outputs detailed information for the specified trace based performance analysis.

List display command

Format

ls [-e] [-t] [number-of-displayed-items]

Description

Outputs the root application information in a list. The list is output in an ascending order of the output start date and time.

-e

Outputs the root application information that contains an error. Only the root application information containing trace with a return code other than 0 is output.

-t

Outputs the root application information with the longest elapsed time from the trace output first up to the trace output last, in the series of trace based performance analysis indicated by the root application information. The root application information will be output in an ascending order of the elapsed time.

number-of-displayed-items

Outputs the root application information for the specified number of items. A specified number of items are output from the items with the latest output start date and time of the trace based performance analysis.

Reference note

You can also specify the options in continuation such as -et.

(Example) If the number of items to be displayed is 3:

ls -et 3

Focus analysis command

Format

focus [focus-date-and-time]

Description

This command narrows down only the trace for the processing executed within the specified focus date and time for analysis.

focus-date-and-time

Specify the focus date and time of the trace based performance analysis in one of the following formats. Also, make sure that you specify an existing date and time.

Format 1: hhmmssMMddyyyy

Format 2: hhmmssMMdd

Format 3: hhmmss

hh: Hours (00 hh 23)

mm: Minutes (00 mm 59)

ss: Seconds (00 ss 59)

MM: Month (01 MM 12)

dd: Date (01 dd 31)

yyyy: Year (1970 yyyy)

If only the Year is omitted (format 2), the year of command execution will be set up. If the Year, Month, and Date are omitted (format 3), the Year, Month, and Date of command execution will be set up.

If you want to return the trace to be analyzed to the range used when the message tracking function was invoked, execute the focus command without specifying the focus date and time.

Output mode switching command

Format

mode {normal|detail}

Description

Switches the output mode of the trace based performance analysis.

normal

The trace based performance analysis will be output in the standard output mode. Only the trace based performance analysis collected at the trace points for the service platform is output.

detail

The trace based performance analysis will be output in the detailed output mode. The entire trace based performance analysis is output.

Command for displaying trace collection points

Format

id {event-ID|list}

Description

Displays the collection points for the trace based performance analysis.

event-ID

Displays the trace collection points for the specified event ID.

list

Displays all the trace collection points for the service platform.

Quit command

Format

quit

Description

Stops the message tracking prompt.

Help command

Format

help|?

Description

Displays help information.

Examples of input

(1) To read the entire trace

cscmsgtk -prf prf_trace.csv

(2) To read the trace collected from 8hrs 45 mins 00 secs to 17 hrs 15 mins 00 secs on the command execution date

cscmsgtk -prf prf_trace.csv -date 084500,171500

(3) To read the trace collected from March 23, 8 hrs 45 mins 00 secs to March 24, 17 hrs 15 mins 00 secs in the command execution year

cscmsgtk -prf prf_trace.csv -date 0845000323,1715000324

(4) To read the trace collected from March 23, 2008, 8 hrs 45 mins 00 secs to March 24, 2008, 17 hrs 15 mins 00 secs

cscmsgtk -prf prf_trace.csv -date 08450003232008,17150003242008

(5) To read the entire trace collected before 17 hrs 15 mins 00 secs on the command execution date

cscmsgtk -prf prf_trace.csv -date ,171500

(6) To read the entire trace collected after 8 hrs 45 mins 00 secs on the command execution date

cscmsgtk -prf prf_trace.csv -date 084500,

Notes

An error occurs in the following cases:

When the syntax of the command argument is invalid

When an attempt to access the trace based performance analysis file fails

When the specified read start date and time or read end date and time is incorrect

The messages displayed when the cscmsgtk command is being executed or when the message tracking function is being invoked are not output to the log file.

During the execution of other commands, if the message tracking function is invoked by reading a trace based performance analysis file with a large file size, the throughput of the other commands might decrease.

cscpasswd (Managing users)

Format

cscpasswd [-h]
 -user login-user-ID
 -pass login-password
 {-print
 |-cscmnguser new-user-ID
 -cscmngpass new-password
 |-mng Manager-name
 -mnguser new-user-ID
 [-mngpass new-password]
 |-csc HCSC-server-name
 -cscuser new-user-ID
 -cscpass new-password}

Function

Changes the user information according to specified conditions. After the command terminates normally, the changed information takes effect the next time you log in to the window or the next time the command is invoked.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details about how to use this command, see 2.4.2 Setting user information in the uCosminexus Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-print

Displays the HCSC-Manager user IDs managed by HCSC-Manager, the user IDs that will access Manager, and the user IDs that will access the database used by the HCSC server.

-cscmnguser new-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the new user ID for HCSC-Manager.

-cscmngpass new-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password for the new HCSC-Manager user ID.

-mng Manager-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the Manager name that was entered during the Manager setup. Specify this option to change the user information to log in to Manager. Specify the Manager name that is specified in the HCSC server configuration definition file.

-mnguser new-user-ID ~ ((at least 1 character))

Specifies the new user ID for Manager.

-mngpass new-password ~ ((at least 1 character))

Specifies the password for the new Manager user ID. Specify this option only if a password has been set for the Manager user ID to be changed.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the HCSC server name that was entered when the HCSC server is set up. Specify this option to change the user information used to log in to the HCSC server.

-cscuser user-ID-to-be-changed ~ ((at least 1 character))

Specifies the user ID for the database that the HCSC server uses.

-cscpass password-to-be-changed ~ ((at least 1 character))

Specifies a password for the user ID of the database used by the HCSC server to be changed.

Examples of input

(1) To change the HCSC-Manager user ID to user1 and the password to password

cscpasswd -user admin -pass admin -cscmnguser user1 -cscmngpass password

(2) To change the user ID of the Manager named Manager to admin and the password to admin

cscpasswd -user admin -pass admin -mng Manager -mnguser admin -mngpass admin

(3) To change the user ID of the database accessed by the HCSC server HCSC to server1 and the password to password

cscpasswd -user admin -pass admin -csc HCSC -cscuser server1 -cscpass password

(4) To change the user ID of the database accessed by the HCSC server HCSC to "user1" and the password to "pass"

cscpasswd -user admin -pass admin -csc HCSC -cscuser \"user1\" -cscpass \"pass\"

(5) To display the HCSC-Manager user information

cscpasswd -user admin -pass admin -print

Display format

To display the user information (when -print is specified)

HCSC-Manager:HCSC-Manager-user-ID
 + Manager-name:User-ID-corresponding-to-the-Manager-name
 HCSC-server-name:User-ID-corresponding-to-the-HCSC-server-name
 HCSC-server-name:User-ID-corresponding-to-the-HCSC-server-name
 ...
 + Manager-name:User-ID-corresponding-to-the-Manager-name
 HCSC-server-name:User-ID-corresponding-to-the-HCSC-server-name
 ...

Note

If a user ID is not set for the database, the user ID corresponding to the HCSC server name is not displayed.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

cscpidelete (Deleting the process instance execution log)

Format

cscpidelete [-h]
 -user login-user-ID
 -pass login-password
 -csc HCSC-server-name
 {-where where-clause
 |-idlist name-of- file-containing-list-of-process-instance-identifiers
 |-wherefile name-of-file-containing-where-clause
 |[-processname business-process-definition-name]
 [-date [inquiry-start-date-and-time],inquiry-end-date-and-time]
 [-status {executing|completed|faulted|error|all}]
 |-force}
 [-encoding encoding-name]
 [-canceltimer cancellation-time]

Function

For an HCSC server that is already set up, this command deletes the process instance execution logs according to specified conditions.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see 6.1.4 Deleting process instance execution logs in the Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the HCSC server that executes SQL statements.

-where where-clause ~ ((at least 1 character))

Specifies the where clause to search for the process summary information for the process instance to be deleted. For details on the information that can be specified in the where clause, see the SQL reference documentation for the database in use.

Note that you cannot specify a table name and add a comment line in the where clause. The following are the examples of correct and incorrect settings for the where clause:

Examples of settings 1

 Example of incorrect settings: Table name is specified
 P.Status='Completed'
 Example of correct settings: Table name is not specified
 Status='Completed'

Examples of settings 2

 Example of incorrect settings: Comment line is added
 Status='Completed' AND
 # ProcessDefinitionName like 'BP%'
 Example of correct settings: Comment line is not added
 Status='Completed' AND
 ProcessDefinitionName like 'BP%'

-idlist name-of-file-containing-list-of-process-instance-identifiers ~ ((1 to 200 bytes))

Specifies the name of the file that contains the list of process instance identifiers. Specify the list of process instance identifiers using a linefeed as a delimiter (\r\n or \n). Specify the file path as an absolute or relative path. The leading and trailing spaces on each new line are deleted. The example of settings is as follows.

Example of settings

To delete the business processes with Process IDs 11111, 44444, and 77777 (\n indicates the linefeed code)

11111\n
44444\n
77777\n

-wherefile name-of-file-containing-where-clause ~ ((1 to 200 bytes))

Specifies the name of the file containing the where clause using an absolute or relative path. The linefeed code in the specified file is replaced with spaces to search for the process summary information, and then the corresponding process instance execution log is deleted.

-processname business-process-definition-name ~ ((at least 1 character))

Deletes the process instance of the specified business process definition name.

-date [inquiry-start-date-and-time],inquiry-end-date-and-time ~ <one-byte numeric characters>

Deletes the process instances started from the specified inquiry start date and time to the inquiry end date and time. If the inquiry start date and time is omitted, the process instances started before the inquiry end date and time will be deleted. Do not place a space before or after the commas (,) separating the inquiry start date and time and the inquiry end date and time. Specify the inquiry start date and time and the inquiry end date and time in the format shown below. Make sure that you use the default time zone to specify the dates and times.

Inquiry start date and time: Specify the value in the YYYYMMDDhhmmss format.

Inquiry end date and time: Specify the value in the YYYYMMDDhhmmss format.

YYYY: Year (1970 YYYY)

MM: Month (01 MM 12)

DD: Date (01 DD 31)

hh: Hours (00 hh 23)

mm: Minutes (00 mm 59)

ss: Seconds (00 ss 59)

-status {executing|completed|faulted|error|all} ~ <<completed>>

Deletes the process instances with the specified status. If the options -where, -idlist, -wherefile, -status, and -force are all omitted, completed is enabled in this option.

executing

The log information for the process instances with the executing status will be deleted.

completed

The log information for the process instances with the completed status will be deleted.

faulted

The log information for the process instances with the faulted status will be deleted.

error

The log information for the process instances with the error status will be deleted.

all

The log information for the process instances with all the above statuses will be deleted.

-force

Deletes the information about all the process instances from the database.

-encoding encoding-name ~ ((at least 1 character)) <<Default Java VM encoding>>

Specifies the encoding used in the input file specified in the options -wherefile or -idlist. You can specify the following encoding names:

UTF-8

US-ASCII

ISO-8859-1

Encoding names supported by Java VM

-canceltimer cancellation-time ~ ((0 to 86400)) <<0>>

This option enables you to cancel the processing if the processing does not end even after the lapse of a specified time. Specify the time until the cancellation of processing in seconds.

If a value other than 0 is specified

After the lapse of the specified time, the processing will be cancelled and the resources will be released even if records matching the conditions are left behind. The command ends normally with the return value 10. In this case, a warning message is output to the message log and the console.

If 0 is specified

The processing is not cancelled until all the records matching the conditions are processed.

Examples of input

(1) To delete the entire information

cscpidelete -user admin -pass admin -csc HCSC -force

(2) To delete all the processes with the Completed status

cscpidelete -user admin -pass admin -where "State='Completed'"

(3) To delete the processes with Process IDs 11111, 22222, and 33333

When the process IDs are specified in a file containing the where clause

cscpidelete -user admin -pass admin -wherefile delete_where.txt -csc HCSC

Contents of delete_where.txt

ProcessID='11111' OR ProcessID='22222' OR ProcessID='33333'

When the process IDs are specified in a file containing a list of process instance identifiers separated by linefeeds

cscpidelete -user admin -pass admin -idlist idlist.txt -csc HCSC

Contents of idlist.txt

11111

22222

33333

(4) To delete all the processes with the Completed status; however, cancel the deletion of the remaining processes if the deletion processing does not end even after the lapse of 300 seconds.

cscpiselect -user admin -pass admin -where "State = 'Completed'" -canceltimer 300

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

2

A communication timeout occurred.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

10

Processing will be cancelled because the specified cancellation time elapsed.

Notes

The where clause of an SQL statement is specified in the option for this command. Therefore, change the user ID and the password periodically to avoid unauthorized use of the command by a third party.

If you specify 100 or more process instances for deletion and an exception occurs during the deletion of the 101st and later process instances, the status of the previous 100 target process instances changes to Deleted. In such cases, the deletion information for those 100 process instances is displayed in the error message details.

You can use this command only when you use a database.

cscpireexec (Re-executing process instances)

Format

cscpireexec [-h]
 -user login-user-ID
 -pass login-password
 -csc HCSC-server-name
 {-processname business-process-definition-name
 |-processnamefile business-process-definition-file-name
 |-all}
 [{-processid process-instance-identifier
 |-processidfile name-of- file-containing-process-instance-identifiers
 |-targetcsc name-of-HCSC-server-to-be-re-executed
 [-status activity-status-that-forms-re-execution-condition]}]
 [-encoding encoding-name]
 [-summary]

Function

Re-executes a cancelled process instance according to specified conditions.

This command can also re-execute only the process instances executed on a specified HCSC server. In such cases, the process instances to be re-executed can be specified in accordance with the activity status.

The process instances to be re-executed are as follows:

Process instances where the invoke service activity status is Executing or Error

Process instances where the standby activity status is Executing

Process instances where the scope activity status is Executingwait, Error, or Completedwait

Process instances where the response activity status is Completedwait

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see 6.1.5 Re-executing process instances in the Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the HCSC server to be re-executed.

-processname business-process-definition-name ~ <character string of NCName type in the XML schema> ((64 or fewer bytes in the database character encoding))

Specifies the business process definition name for the process to be re-executed.

-processnamefile business-process-definition-file-name ~ ((1 to 200 bytes))

Specifies the absolute or relative path of the business process definition file for the process to be re-executed. Specify only the business process definition names in the file. The contents of the business process definition file are read, and the leading and trailing spaces, tabs, and linefeeds are removed to obtain the identifiers of the process instances to be re-executed.

-all

Re-executes all the target process instances in a batch.

-processid process-instance-identifier ~ ((1 to 240 bytes or less))

Specifies the process instance identifier of the process to be re-executed. If the -processidfile option is not specified with this option, all the cancelled processes with the business process definition names specified in the options -processname or -processnamefile are re-executed.

A process instance identifier might be a long character string (which is a maximum of 240 characters). Note that if you set up a deep directory hierarchy for the response message output directory, the system might not be able to create a file. If a response message file is not created even after the process is re-executed, a message is displayed.

-processidfile name-of- file-containing-process-instance-identifiers ~ ((1 to 200 bytes))

Specifies the absolute or relative path of the file that contains the process instance identifier of the process to be re-executed. In the file containing process instance identifiers, specify the process instance identifiers only. During command execution, the contents of this file are read and the leading and trailing spaces, tabs, and linefeeds are removed to obtain the identifiers of the process instances you intend to re-execute. If the -processid option is not specified with this option, all the processes that have the business process definition names specified in the options -processname or -processnamefile and which were cancelled during execution are re-executed.

-targetcsc name-of-HCSC-server-to-be-re-executed ~ ((1 to 8 characters))

Specifies the name of the HCSC server to be re-executed. The process instances executed on the specified HCSC server will be re-executed. However, the process instances executed in 08-70 or earlier will not be re-executed.

If this option is omitted, the process instances executed on all HCSC servers are subject to re-execution.

-status activity-status-that-forms-re-execution-condition

Specifies the activity status that forms the condition for re-execution. You can specify the following statuses. You can also specify multiple statuses separated by commas (,).

executing

The process instances that have an invoke service activity or standby activity with the Executing status, are subject to re-execution.

error

The process instances that have an invoke service activity or scope activity with the Error status are subject to re-execution.

executingwait

The process instances that have a scope activity with the executingwait status are subject to re-execution.

completedwait

The process instances that have a scope activity or response activity with the completedwait status are subject to re-execution.

If this option is omitted, all the above statuses are subject to re-execution, and process instances that have any of the following activities are subject to re-execution:

Invoke service activity or standby activity with the Executing status

Invoke service activity or scope activity with the Error status

Scope activity with the executingwait status

Scope activity or response activity with the completedwait status

-encoding encoding-name ~ <<Default Java VM encoding>> ((at least 1 character))

Specifies the name of the encoding used in the input file specified in the options processidfile or processnamefile. You can specify the following encoding names:

UTF-8

US-ASCII

ISO-8859-1

Encoding supported by Java VM

-summary

Specify this option to display the re-execution results for successful and failed cases.

Examples of input

(1) To re-execute a process instance with a process instance identifier 11111 and the business process definition name PC Lease

cscpireexec -user admin -pass admin -processidfile process_id.txt -csc HCSC -processnamefile processname.txt

Contents of process_id.txt: 11111

Contents of processname.txt: PC Lease

(2) To re-execute the service components with the business process definition name PC Lease in a batch

cscpireexec -user admin -pass admin -csc HCSC -processname "PC Lease"

(3) To re-execute all the target process instances in a batch

cscpireexec -user admin -pass admin -csc HCSC -all

(4) To re-execute the process instances executed on HCSC server CSCSrv2 and in the Executing status, in a batch

cscpireexec -user admin -pass admin -csc CSCSrv1 -all -targetcsc CSCSrv2 -status executing

(5) To re-execute the process instances executed on HCSC server CSCSrv2 and in the statuses Executing, executingwait, and completedwait, in a batch

cscpireexec -user user1 -pass password -csc CSCSrv1 -all -targetcsc CSCSrv2 -status executing,executingwait,completedwait

Display format

(1) When -summary is not specified

ProcessID,ProcessDefinitionName,Result,ErrorMessage
PI-identifier,business-process-definition-name,invocation-result,error-information
PI-identifier,business-process-definition-name,invocation-result,error-information
 ...

Description

Display item

Content

Description

ProcessID

PI identifier

Indicates the process instance identifier.

ProcessDefinitionName

Business process definition name

Indicates the business process definition name.

Result

Invocation result

Indicates the invocation result. One of the following values is displayed:

Success: Invocation ended normally

Failure: Invocation failed

ErrorMessage

Error information

Indicates the error information, which is displayed as follows, depending on the contents of the Result column (invocation result):

Success: ""

Failure: error-information

These display items represent the information for one record in the CSCBP_cluster-name_PROCESS table. For details, see Appendix C.1 Table information about process instance execution log management in the uCosminexus Service Platform Setup and Operation Guide.

(2) When -summary is specified

The KEOS52290-I message, indicating the successful re-execution cases and failed re-execution cases, is displayed. For details, see 2.22 Messages from KEOS50000 to KEOS59999 in the uCosminexus Service Platform Messages.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

2

A communication timeout occurred.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

You can use this command only when you use a database.

If many process instances are to be re-executed, the re-execution process might take some time to finish.

If no process instances are to be re-executed, the command ends abnormally.

cscpiselect (Finding process instances)

Format

cscpiselect [-h]
 -user login-user-ID
 -pass login-password
 -csc HCSC-server-name
 -table
 {process|activity|link|set|string|numeric|boolean
 |message|relation|process_set}
 [-detail]
 [-separator {comma|tab}]
 [{-count|-orderby sort-condition}]
 [{-where where-clause
 |-wherefile name-of-file-containing-where-clause
 |[-processname business-process-definition-name]
 [-date [inquiry-start-date-and-time],inquiry-end-date-and-time]
 [-status {executing|completed|faulted|error
 |executingwait|completedwait|all}]
 [-targetcsc HCSC-server-name-to-be-searched]}]
 [-encoding encoding-name]
 [-canceltimer cancellation-time]

Function

Searches the business process information for the set up HCSC server according to specified conditions, and outputs the information in the CSV or TSV format.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see the following locations in the uCosminexus Service Platform Setup and Operation Guide according to the purpose of use:

6.1.2 Searching the execution log of a process instance

6.1.3 Acquiring detailed information from the process instance execution logs

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the HCSC server executing SQL statements.

-table {process|activity|link|set|string|numeric|boolean|message|relation|process_set}

Specifies the table to be searched.

When process_set is specified in this option, the process summary information and correlation set information are linked internally to perform the search. Therefore, to specify a process information column or a correlation set information column in the search condition, add P or C in the where clause respectively.

If a value other than process_set is specified in this option, the table name need not be specified in the where clause. For the information that can be specified in the where clause, see the SQL reference documentation for the database in use.

process

Displays the process summary information corresponding to the specified search condition.

Note that you cannot specify a table name and add a comment line in the where clause. The following are examples of correct and incorrect settings for the where clause:

Examples of settings 1

 Example of incorrect settings: Table name is specified
 P.Status='Completed'
 Example of correct settings: Table name is not specified
 Status='Completed'

Examples of settings 2

 Example of incorrect settings: Comment line is added
 Status='Completed' AND
 # ProcessDefinitionName like 'BP%'
 Example of correct settings: Comment line is not added
 Status='Completed' AND
 ProcessDefinitionName like 'BP%'

activity

Displays the activity information corresponding to search conditions.

link

Displays the link information corresponding to search conditions.

set

Displays the correlation set information corresponding to search conditions.

string

Displays the string variable information corresponding to search conditions.

numeric

Displays the numeric variable information corresponding to search conditions.

boolean

Displays the boolean variable information corresponding to search conditions.

message

Displays the message variable information corresponding to search conditions.

relation

Displays the message-related information corresponding to search conditions.

process_set

Searches the correlation set information for the process summary information corresponding to search conditions and then displays the information. Specify the table name in the where clause. The following are examples of correct and incorrect settings for the where clause:

Examples of settings

 Example of incorrect settings: Table name is not specified
 State='Completed'
 Example of correct settings1: Table name is specified
 P.State='Completed'
 Example of correct settings2: Table name is specified
 P.State='Completed' AND
 C.ProcessDefinitionName like 'BP%'

-detail

Specify this option to output all the table information.

-separator {comma|tab} ~<<comma>>

Specifies the separator for demarcating the information.

-count

Specifies that only the number of search result rows is output. Use this option to obtain only the number of searched items when the search result contains large amount of data (this corresponds to count(*) in SQL statements).

-orderby sort-condition ~ ((at least 1 character))

Specifies the data sorting condition. This corresponds to the order by clause in SQL statements. The options -orderby and -count cannot be simultaneously specified. For the information that can be specified in the order by clause, see the SQL reference documentation for the database in use. If the -orderby option is not specified, the command assumes that the order by clause is not specified.

-where where-clause ~ ((at least 1 character))

Specifies the where clause. For the information that can be specified in the where clause, see the SQL reference documentation for the database in use.

If the SplitKey string is used for search, the information about the SplitKey string is not output. Also, depending on the value specified in the -table option, you must add the SplitKey string in the view table described in the following table. For details about the view table configuration, see the explanation of the view table information in C.1 Table information about process instance execution log managemen in the uCosminexus Service Platform Setup and Operation Guide.

Table 5‒5: View table that requires the addition of the SplitKey string

Value set in the -table option

View table that requires the addition of the SplitKey string in advance

process

None

activity

CSCBP_cluster-name_V_ACTIVITY

link

CSCBP_cluster-name_V_LINK

set

None

string

CSCBP_cluster-name_V_STR_VARIABLE

numeric

CSCBP_cluster-name_V_NUM_VARIABLE

boolean

CSCBP_cluster-name_V_BOOL_VARIABLE

message

CSCBP_cluster-name_V_MSG_VARIABLE

relation

None

process_set

None

-wherefile name-of-file-containing-where-clause ~ ((1 to 200 bytes))

Specifies the name of the file containing the where clause using an absolute or relative path. The linefeed code in the specified file is replaced with spaces, and then the SQL statement is executed. For the information that can be specified, see the SQL reference documentation for the database in use.

Note that the precautions for using the SplitKey string for a search are the same as those for the -where option.

-processname business-process-definition-name ~ ((at least 1 character))

Specify this option to perform a search using the business process definition name. You can specify this option only when a value other than relation or process_set is specified in the -table option.

-date [inquiry-start-date-and-time],inquiry-end-date-and-time ~ <one-byte numeric characters>

Specify this option to search by the start date and time of a process instance. This option searches the process instances that started from the specified inquiry start date and time to the inquiry end date and time. You can specify this option only when process or activity is specified in the -table option. If the inquiry start date and time is omitted, the search is performed from the process instances that started before the inquiry end date and time. Do not place a space before or after the comma (,) separating the inquiry start date and time from the inquiry end date and time. Specify the inquiry start date and time and the inquiry end date and time in the format shown below. Make sure that you use the default time zone to specify the dates and times.

Inquiry start date and time: Specify the date and time in the YYYYMMDDhhmmss format.

Inquiry end date and time: Specify the date and time in the YYYYMMDDhhmmss format.

YYYY: Year (1970 YYYY)

MM: Month (01 MM 12)

DD: Date (01 DD 31)

hh: Hours (00 hh 23)

mm: Minutes (00 mm 59)

ss: Seconds (00 ss 59)

-status {executing|completed|faulted|error|executingwait|completedwait|all} ~ <<all>>

Specify this option to perform a search using the status of the process instance and activity instance.

You can only specify the arguments executing, completed, faulted, and error when process or activity is specified in the -table option. Also, you can only specify the arguments executingwait and completedwait when activity is specified in the -table option.

executing

The process summary information or activity information of process instances with the Executing status will be searched.

completed

The process summary information or activity information of process instances with the completed status will be searched.

faulted

The process summary information or activity information of process instances with the faulted status will be searched.

error

The process summary information or activity information of process instances with the error status will be searched.

executingwait

The activity information with the executingwait status will be searched.

completedwait

The activity information with the completedwait status will be searched.

all

The process summary information or activity information with all the above statuses will be searched.

The following are examples of incorrect and correct settings for the -table option with an example of specifying the executingwait argument in the -status option:

Examples of settings

Example of incorrect settings: activity is not specified in the -table option
 -table process -status executingwait
Example of correct settings: activity is specified in the -table option
 -table activity -status executingwait

-targetcsc HCSC-server-name-to-be-searched ~ ((1 to 8 characters))

Specifies the name of the HCSC server to be searched. The process instances executed on the specified HCSC server will be searched. Note that the process instances executed in 08-70 or earlier will not be searched.

If this option is omitted, the process instances executed on all the HCSC servers will be searched.

-encoding encoding-name ~ <<Default Java VM encoding>> ((at least 1 character))

Specifies the name of the encoding used in the input file specified in the -wherefile option. You can specify the following encoding names:

UTF-8

US-ASCII

ISO-8859-1

Encoding supported by Java VM

-canceltimer cancellation-time ~ ((0 to 86400)) <<0>>

This option enables you to cancel the processing if the processing does not end even after the specified time has lapsed. Specify the time until the cancellation of processing in seconds. If the -count option is specified, this option is ignored even if specified.

If a value other than 0 is specified

After the lapse of the specified time, the processing will be cancelled and the resources will be released even if records matching the conditions are left behind. The command ends normally with the return value 10. In this case, a warning message is output to the message log and the console.

If 0 is specified

The processing is not cancelled until all the records matching the conditions are processed.

Examples of input

(1) To display the entire process summary information

cscpiselect -user admin -pass admin -csc HCSC -table process

(2) To display the entire summary information for the process whose correlation set definition name is rentalNumber and whose correlation set value is 100

cscpiselect -user admin -pass admin -wherefile sql_where.txt -csc HCSC -table process_set

Contents of sql_where.txt

C.CorrelationSetName = 'rentalNumber' AND C.CorrelationSetValue = '100'

(3) To display the number of rows of character strings whose business process definition name begins with BP, from the activity information

cscpiselect -user admin -pass admin -count -wherefile sql_where.txt -csc HCSC -table activity

Contents of sql_where.txt

ProcessDefinitionName like 'BP%'

(4) To search all the link information items

cscpiselect -user admin -pass admin -csc HCSC -table link

(5) To search all the correlation set information items

cscpiselect -user admin -pass admin -csc HCSC -table set

(6) To search the string variable information with the condition ProcessID = '11111'

cscpiselect -user admin -pass admin -wherefile sql_where.txt -csc HCSC -table string

Contents of sql_where.txt

ProcessID = '11111'

(7) To search the numeric variable information with the conditions ProcessID = '11111', and a business process definition name beginning with BP

cscpiselect -user admin -pass admin -wherefile sql_where.txt -csc HCSC -table numeric

Contents of sql_where.txt

ProcessID = '11111' AND ProcessDefinitionName like 'BP%'

(8) To search the boolean variable information with the conditions ProcessID = '11111', and a definition value of 0

cscpiselect -user admin -pass admin -where "ProcessID = '11111' AND VariableValue = 0" -csc HCSC -table boolean

(9) To search the message variable information with the conditions ProcessID = '11111' and the variable definition name containing ABC, and sorting the search results in the descending order of ProcessID

cscpiselect -user admin -pass admin -wherefile sql_where.txt -orderby "ProcessID DESC"-csc HCSC -table message

Contents of sql_where.txt

ProcessID = '11111' AND VariableName like '%ABC%'

(10) To search the process summary information by specifying the last executed HCSC server , and then displaying the information

cscpiselect -user admin -pass admin -csc CSCSrv1 -table process -targetcsc CSCsrv2

(11) To search the execution log generated until March 31, 2012 (however, the processing stops and the resources are released if the search takes 300 seconds or more)

cscpiselect -user admin -pass admin -csc CSCSrv1 -table process -date ,20120331235959 -canceltimer 300

Display format

(1) Process summary information (when process or process_set is specified)

If -detail is omitted

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,State,StartTime,EndTime,CSCServerName
PI-identifier,business-process-definition-name,business-process-definition-version,PI-status,PI-start-time,PI-end-time,HCSC-server-name
PI-identifier,business-process-definition-name,business-process-definition-version,PI-status,PI-start-time,PI-end-time,HCSC-server-name
 ...

Note

There is no linefeed from ProcessID (PI-identifier) to EndTime (PI-end-time).

If -detail is specified

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,State,StartTime,EndTime,ChangeCount,CSCServerName
PI-identifier,business-process-definition-name,business-process-definition-version,PI-status,PI-start-time,PI-end-time,update-count,HCSC-server-name
PI-identifier,business-process-definition-name,business-process-definition-version,PI-status,PI-start-time,PI-end-time,update-count,HCSC-server-name
 ...

Note

There is no linefeed from ProcessID (PI-identifier) to ChangeCount (update-count).

Description

The following table describes the information for one record in the CSCBP_cluster-name_PROCESS table. For details, see Appendix C. Database Table Information in the uCosminexus Service Platform Setup and Operation Guide.

Display item

Content

Description

ProcessID

PI identifier

Indicates the process instance identifier.

ProcessDefinitionName

Business process definition name

Indicates the business process definition name.

ProcessDefinitionVersion

Business process definition version

Indicates the business process definition version.

State

PI status

Indicates the status of the process instance.

StartTime

PI start time

Indicates the process instance start time (GMT).

The start time is output in the format YYYY/MM/DD hh:mm:ss that is defined as java.text.SimpleDateFormat:

YYYY: Year

MM: Month

DD: Date

hh: Hour

mm: Minutes

ss: Seconds

EndTime

PI end time

Indicates the process instance end time (GMT).

The end time is output in the format YYYY/MM/DD hh:mm:ss that is defined as java.text.SimpleDateFormat:

YYYY: Year

MM: Month

DD: Date

hh: Hour

mm: Minutes

ss: Seconds

ChangeCount

Update count

Indicates the data update count.

CSCServerName#

HCSC server name

Indicates the name of the last executed HCSC server.

#

If no values exist in the process instance log, nothing is displayed.

(2) Activity information (when activity is specified)

If -detail is omitted

ProcessID,ActivityNumber,ActivityDefinitionName,ActivityKind,State,StartTime,EndTime,WaitTime
PI-identifier,ACI-identifier,AC-definition-name,AC-type,ACI-status,AC-start-time,AC-end-time,AC-wait-time
PI-identifier,ACI-identifier,AC-definition-name,AC-type,ACI-status,AC-start-time,AC-end-time,AC-wait-time
 ...

Note

There is no linefeed from ProcessID (PI-identifier) to WaitTime (AC-wait-time).

If -detail is specified

ProcessID,ActivityNumber,ProcessDefinitionName,
ProcessDefinitionVersion,ActivityDefinitionName,ActivityKind,
ParentNumber,ScopeNumber,RepeatNumber,State,
FirstChildNumber,LastChildNumber,StartTime,EndTime,WaitTime,CSCServerName
PI-identifier,ACI-identifier,business-process-definition-name,
business-process-definition-version,AC-definition-name,AC-type
Parent-ACI-identification-number,Subordinate-SCI-identification-number,Subordinate-RP-identification-number,ACI-status,
First-child-ACI-identification-number,Last-child-ACI-identification-number,AC-start-time,AC-end-time,AC-wait-time,HCSC-server-name
 ...

Note

There is no linefeed from ProcessID (PI-identifier) to CSCServerName (HCSC-server-name).

Description

The following table describes the information for one record in the CSCBP_cluster-name_ACTIVITY table. For details, see Appendix C. Database Table Information in the uCosminexus Service Platform Setup and Operation Guide.

Display item

Content

Description

ProcessID

PI identifier

Indicates the process instance identifier.

ActivityNumber

ACI identifier

Indicates the activity instance identification number.

This is a unique value in process instances.

ProcessDefinitionName

Business process definition name

Indicates the business process definition name.

ProcessDefinitionVersion

Business process definition version

Indicates the business process definition version.

ActivityDefinitionName

AC definition name

Indicates the activity definition name.

ActivityKind

AC type

Indicates the activity type.

ParentNumber

Parent ACI identification number

Indicates the identification number of the parent activity instance.

ScopeNumber

Subordinate SCI identification number

Indicates the identification number of the subordinate scope instance.

RepeatNumber

Subordinate RP identification number

Indicates the identification number of the subordinate iteration processing.

State

ACI status

Indicates the status of the activity instance.

FirstChildNumber

First child ACI identification number

Indicates the identification number of the first child activity instance.

LastChildNumber

Last child ACI identification number

Indicates the identification number of the last child activity instance.

StartTime#

AC start time

Indicates the activity start time (GMT). The start time is output in the format YYYY/MM/DD hh:mm:ss that is defined as java.text.SimpleDateFormat:

YYYY: Year

MM: Month

DD: Date

hh: Hour

mm: Minutes

ss: Seconds

EndTime#

AC end time

Indicates the activity end time (GMT). The end time is output in the format YYYY/MM/DD hh:mm:ss that is defined as java.text.SimpleDateFormat:

YYYY: Year

MM: Month

DD: Date

hh: Hour

mm: Minutes

ss: Seconds

WaitTime#

AC wait time

Indicates the activity wait time (GMT). The wait time is output in the format YYYY/MM/DD hh:mm:ss that is defined as java.text.SimpleDateFormat:

YYYY: Year

MM: Month

DD: Date

hh: Hour

mm: Minutes

ss: Seconds

CSCServerName#

HCSC server name

Indicates the name of the last executed HCSC server.

#

If no values exist in the process instance log, nothing is displayed.

(3) Link information (when link is specified)

If -detail is omitted

ProcessID,LinkDefinitionName,State
PI-identifier,link-definition-name,link-status
PI-identifier,link-definition-name,link-status
 ...

If -detail is specified

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,
LinkDefinitionName,RepeatNumber,State
PI-identifier,business-process-definition-name,business-process-definition-version,
link-definition-name,Subordinate-RP-identification-number,link-status
 ...

Note

There is no linefeed from ProcessID (PI-identifier) to State (link-status).

Description

The following table describes the information for one record in the CSCBP_cluster-name_LINK table. For details, see Appendix C. Database Table Information in the uCosminexus Service Platform Setup and Operation Guide.

Display item

Content

Description

ProcessID

PI identifier

Indicates the process instance identifier.

ProcessDefinitionName

Business process definition name

Indicates the business process definition name.

ProcessDefinitionVersion

Business process definition version

Indicates the business process definition version.

LinkDefinitionName

Link definition name

Indicates the link definition name.

RepeatNumber

Subordinate RP identification number

Indicates the identification number of a subordinate iteration processing.

State

Link status

Indicates the status of the link (true value).

(4) Correlation set information (when set is specified)

If -detail is omitted

ProcessID,CorrelationSetName,CorrelationSetValue
PI-identifier,correlation-set-definition-name,correlation-set-value
PI-identifier,correlation-set-definition-name,correlation-set-value
 ...

If -detail is specified

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,ScopeDefinitionName,
ScopeNumber,CorrelationSetName,CorrelationSetValue,State
PI-identifier,business-process-definition-name,business-process-definition-version,SC-definition-name,
SCI-identification-number,correlation-set-definition-name,correlation-set-value,validity-of-correlation-set
PI-identifier,business-process-definition-name,business-process-definition-version, SC-definition-name,
SCI-identification-number,correlation-set-definition-name,correlation-set-value, validity-of-correlation-set
 ...

Note

There is no linefeed from ProcessID (PI-identifier) to State (validity-of-correlation-set).

Description

The following table describes the information for one record in the CSCBP_cluster-name_CORRELATIONSET table. For details, see Appendix C. Database Table Information in the uCosminexus Service Platform Setup and Operation Guide.

Display item

Content

Description

ProcessID

PI identifier

Indicates the process instance identifier.

ProcessDefinitionName

Business process definition name

Indicates the business process definition name.

ProcessDefinitionVersion

Business process definition version

Indicates the business process definition version.

ScopeDefinitionName

SC definition name

Indicates the scope definition name.

ScopeNumber

SCI identification number

Indicates the identification number of the scope instance.

CorrelationSetName

Correlation set definition name

Indicates the correlation set definition name.

CorrelationSetValue

Correlation set value

Indicates the correlation set value. This value is converted to a character string, linked, and then stored.

State

Validity of correlation set

Indicates the validity of a correlation set (true value).

(5) String variable information (when string is specified)

If -detail is omitted

ProcessID,VariableName,VariableValue
PI-identifier,variable-definition-name,variable-value
PI-identifier,variable-definition-name,variable-value
 ...

If -detail is specified

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,
ScopeDefinitionName,ScopeNumber,VariableName,VariableValue
PI-identifier,business-process-definition-name,business-process-definition-version,
SC-definition-name,SCI-identification-number,variable-definition-name,variable-value
PI-identifier,business-process-definition-name,business-process-definition-version,
SC-definition-name, SCI-identification-number,variable-definition-name,variable-value
 ...

Note

There is no linefeed from ProcessID (PI-identifier) to VariableValue (variable-value).

Description

The following table describes the information for one record in the CSCBP_cluster-name_STR_VARIABLE table. For details, see Appendix C. Database Table Information in the Service Platform Setup and Operation Guide.

Display item

Content

Description

ProcessID

PI identifier

Indicates the process instance identifier.

ProcessDefinitionName

Business process definition name

Indicates the business process definition name.

ProcessDefinitionVersion

Business process definition version

Indicates the business process definition version.

ScopeDefinitionName

SC definition name

Indicates the scope definition name.

ScopeNumber

SCI identification number

Indicates the identification number of the scope instance.

VariableName

Variable definition name

Indicates the variable definition name.

VariableValue

Variable value

Indicates the variable value.

(6) Numeric variable information (when numeric is specified)

If -detail is omitted

ProcessID,VariableName,VariableValue
PI-identifier,variable-definition-name,variable-value
PI-identifier,variable-definition-name,variable-value
 ...

If -detail is specified

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,
ScopeDefinitionName,ScopeNumber,VariableName,VariableValue
PI-identifier,business-process-definition-name,business-process-definition-version,
SC-definition-name,SCI-identification-number,variable-definition-name,variable-value
PI-identifier,business-process-definition-name,business-process-definition-version,
SC-definition-name, SCI-identification-number,variable-definition-name,variable-value
 ...

Note

There is no linefeed from ProcessID (PI-identifier) to VariableValue (variable-value).

Description

The following table describes the information for one record in the CSCBP_cluster-name_NUM_VARIABLE table. For details, see Appendix C. Database Table Information in the uCosminexus Service Platform Setup and Operation Guide.

Display item

Content

Description

ProcessID

PI identifier

Indicates the process instance identifier.

ProcessDefinitionName

Business process definition name

Indicates the business process definition name.

ProcessDefinitionVersion

Business process definition version

Indicates the business process definition version.

ScopeDefinitionName

SC definition name

Indicates the scope definition name.

ScopeNumber

SCI identification number

Indicates the identification number of the scope instance.

VariableName

Variable definition name

Indicates the variable definition name.

VariableValue

Variable value

Indicates the variable value.

(7) Boolean variable information (when boolean is specified)

If -detail is omitted

ProcessID,VariableName,VariableValue
PI-identifier,variable-definition-name,variable-value
PI-identifier,variable-definition-name,variable-value
 ...

If -detail is specified

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,
ScopeDefinitionName,ScopeNumber,VariableName,VariableValue
PI-identifier,business-process-definition-name,business-process-definition-version,
SC-definition-name,SCI-identification-number,variable-definition-name,variable-value
PI-identifier,business-process-definition-name,business-process-definition-version,
SC-definition-name,SCI-identification-number,variable-definition-name,variable-value
 ...

Note

There is no linefeed from ProcessID (PI-identifier) to VariableValue (variable-value).

Description

The following table describes the information for one record in the CSCBP_cluster-name_BOOL_VARIABLE table. For details, see Appendix C. Database Table Information in the Service Platform Setup and Operation Guide.

Display item

Content

Description

ProcessID

PI identifier

Indicates the process instance identifier.

ProcessDefinitionName

Business process definition name

Indicates the business process definition name.

ProcessDefinitionVersion

Business process definition version

Indicates the business process definition version.

ScopeDefinitionName

SC definition name

Indicates the scope definition name.

ScopeNumber

SCI identification number

Indicates the identification number of the scope instance.

VariableName

Variable definition name

Indicates the variable definition name.

VariableValue

Variable value

Indicates the variable value.

(8) Message variable information (when message is specified)

If -detail is omitted

ProcessID,VariableName,
VariableValue
PI-identifier,variable-definition-name,
variable-value
PI-identifier,variable-definition-name,
variable-value
 ...

Note

There is no linefeed from ProcessID (PI-identifier) to VariableName (variable-definition-name), and VariableValue (variable-value) is displayed on the next line.

If -detail is specified

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,
ScopeDefinitionName,ScopeNumber,VariableName,
VariableValue
PI-identifier,business-process-definition-name,business-process-definition-version,
SC-definition-name,SCI-identification-number,variable-definition-name,
variable-value
PI-identifier,business-process-definition-name,business-process-definition-version,
SC-definition-name,SCI-identification-number,variable-definition-name,
variable-value
 ...

Note

There is no linefeed from ProcessID (PI-identifier) to VariableName (variable-definition-name), and VariableValue (variable-value) is displayed on the next line.

Description

The following table describes the information for one record in the CSCBP_cluster-name_MSG_VARIABLE table. For details, see Appendix C. Database Table Information in the Service Platform Setup and Operation Guide.

Display item

Content

Description

ProcessID

PI identifier

Indicates the process instance identifier.

ProcessDefinitionName

Business process definition name

Indicates the business process definition name.

ProcessDefinitionVersion

Business process definition version

Indicates the business process definition version.

ScopeDefinitionName

SC definition name

Indicates the scope definition name.

ScopeNumber

SCI identification number

Indicates the identification number of the scope instance.

VariableName

Variable definition name

Indicates the variable definition name.

VariableValue

Variable value

Indicates the variable value.

(9) Message-related information (when relation is specified)

If -detail is omitted

MessageID,ProcessID,ActivityNumber,SendOrReceive
MSG-identifier,PI-identifier,ACI-identification-number,send-and-receive-flag
MSG-identifier,PI-identifier,ACI-identification-number,send-and-receive-flag
 ...

If -detail is specified

MessageID,ProcessID,ActivityNumber,SendOrReceive,AsynchronousMessagingID
MSG-identifier,PI-identifier,ACI-identification-number,send-and-receive-flag,ID
MSG-identifier,PI-identifier,ACI-identification-number,send-and-receive-flag,ID
 ...

Note

There is no linefeed from MessageID (MSG-identifier) to AsynchronousMessagingID (ID).

Description

The following table describes the information for one record in the CSCBP_cluster-name_MSG_RELATION table. For details, see Appendix C. Database Table Information in the Service Platform Setup and Operation Guide.

Display item

Content

Description

MessageID

MSG identifier

Indicates the message identifier.

ProcessID

PI identifier

Indicates the process instance identifier.

ActivityNumber

ACI identification number

Indicates the identification number of the activity instance.

SendOrReceive

Send and receive flag

Indicates the send and receive flag for the message.

AsynchronousMessagingID

ID

Indicates the ID of an asynchronous message that uses Reliable Messaging.

(10) Count display

KEOS52029-I: row count is number-of-rows

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

2

A communication timeout occurred.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

10

Processing will be cancelled because the specified cancellation time elapsed.

Notes

Do not specify any comment line.

The where clause of an SQL statement is specified in the option for this command. Therefore, change the user ID and the password periodically to avoid unauthorized use of the command by a third party.

You can use this command only when you use a database.

If all the following options are not specified, the command assumes that the where clause is not specified:

-where option

-wherefile option

-processname option

-date option

-status option

cscprecache (Pre-caching format definitions and data transformation definitions)

Format

cscprecache [-h]
 -user login-user-ID
 -pass login-password
 -csc HCSC-server-name
 [-name service-ID]

Function

Parses all the format definitions and data transformation definitions defined in a component and caches the definitions on an HCSC server before the real operations start. This improves the request processing performance.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command. You can set the maximum number of threads to be used for sending the parsing requests to multiple components by defining the value in a property of the HCSC-Manager definition file (cscmng.properties). You can also set the timeout value for the pre-cache processing in each component by defining the value in a property of the HCSC server runtime definition file (cscsvconfig.properties).

For details on how to use this command, see 5.3.20 Performing cache of the definition information of the business process in the Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the HCSC server that sends the parsing request.

-name service-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the service that sends the parsing request.

Examples of input

(1) To parse all the components in an HCSC server

cscprecache -csc HCSC-server-name

(2) To parse only a specific component

cscprecache -csc HCSC-server-name -name service-ID

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

An error occurs if you execute this command for a service adapter or a user-defined reception.

Before you execute the command, make sure that the upper cache limit for the properties formatdef-maxcache-num and transformdef-maxcache-num in the HCSC server runtime definition file is greater than the number of format definitions and data transformation definitions that are set up. If the upper cache limit is smaller than the number of format definitions and data transformation definitions that are set up, the cache is deleted, so the performance might not improve.

cscrcptnstart (Starting standard receptions and user-defined receptions)

Format

cscrcptnstart [-h]
 -user login-user-ID
 -pass login-password
 {-csc HCSC-server-name|-cluster cluster-name}
 [{-standard|-userdef}]
 [-nogc]

Function

Starts a reception (standard reception and user-defined reception).

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see the following locations in the Service Platform Setup and Operation Guide according to the purpose of use:

5.3.8 Starting user-defined receptions

5.3.9 Starting standard receptions

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the HCSC server for starting the reception.

-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the cluster for starting the receptions in a batch. An error occurs if you specify the -cluster option when the cluster type is HA.

-standard

Invokes only the standard receptions. If both -standard and -userdef are not specified, all the receptions will be invoked.

-userdef

Invokes all the user-defined receptions. Use the csccompostart command to start the user-defined receptions individually. If both -standard and -userdef are not specified, all the receptions will be invoked.

-nogc

Invokes the receptions without generating Full GC. However, the specification of this option does not control Full GC generated automatically by Java VM or Full GC issued by abnormal J2EE server processing.

Execute the javagc command to explicitly generate Full GC when an HCSC component starts. For details on the javagc command, see javagc (forcibly perform GC) in the manual Application Server Command Reference Guide.

Examples of input

(1) To start the receptions for the HCSC server HCSC

cscrcptnstart -user admin -pass admin -csc HCSC

(2) To start the standard receptions for each HCSC server in the cluster Cluster in a batch

cscrcptnstart -user admin -pass admin -cluster Cluster -standard

(3) To start the receptions under the HCSC server CSCSrv1 in a batch, and without generating Full GC

cscrcptnstart -user admin -pass admin -csc CSCSrv1 -nogc

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

2

A communication timeout occurred.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

Execute this command for the stopped receptions.

The HCSC server must be running when you execute the command.

If an error occurs when you specify the -cluster option, check the results with the cscstatus command, eliminate the cause of the error, and then re-execute the command.

If multiple clients simultaneously execute this command for one HCSC server, a processing error (exclusion error, or abnormal end due to repeated operations for a component) might occur. If an error occurs, re-execute the command.

cscrcptnstop (Stopping standard receptions and user-defined receptions)

Format

cscrcptnstop [-h]
 -user login-user-ID
 -pass login-password
 {-csc HCSC-server-name|-cluster cluster-name}
 [{-standard|-userdef}]
 [-stopfg {normal|wait|force}]
 [-nogc]

Function

Stops a reception (standard receptions and user-defined receptions).

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see the following locations in the Service Platform Setup and Operation Guide according to the purpose of use:

5.3.33 Terminating the Standard Reception

5.3.34 Stopping the user -defined reception

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the HCSC server for stopping the reception.

-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the cluster for stopping the receptions in a batch. An error occurs if you specify the -cluster option when the cluster type is HA.

-standard

Stops only the standard receptions. If both -standard and -userdef are not specified, all the receptions will be stopped.

-userdef

Stops all the user-defined receptions. Use the csccompostop command to stop the user-defined receptions individually. If both -standard and -userdef are not specified, all the receptions will be stopped.

-stopfg {normal|wait|force}

Specifies the stop option for the standard receptions. This definition is ignored if the -userdef option is specified. The default value is normal.

normal

Specify this option to normally stop a standard reception.

wait

Specify this option to stop a standard reception in a planned manner.

force

Specify this option to forcefully stop a standard reception.

-nogc

Stops the receptions without generating Full GC. However, the specification of this option does not control Full GC generated automatically by Java VM.

Examples of input

(1) To stop the receptions for the HCSC server HCSC

cscrcptnstop -user admin -pass admin -csc HCSC

(2) To stop the receptions for each HCSC server in the cluster Cluster in a batch

cscrcptnstop -user admin -pass admin -cluster Cluster

(3) To stop the receptions under the HCSC server CSCSrv1 in a batch, and without generating Full GC

cscrcptnstop -user admin -pass admin -csc CSCSrv1 -nogc

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

2

A communication timeout occurred.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

Execute this command for the running receptions.

The HCSC server must be running when you execute the command.

If an error occurs when you specify the -cluster option, check the results with the cscstatus command, eliminate the cause of the error, and then re-execute the command.

If multiple clients simultaneously execute this command for one HCSC server, a processing error (exclusion error, or abnormal end due to repeated operations for a component) might occur. If an error occurs, re-execute the command.

cscrepcheck (Verifying importability)

Format

cscrepcheck [-h]
 -user login-user-ID
 -pass login-password
 -repfile repository-ZIP-file-name
 [-compo [-name {service-ID|reception-ID-of-user-defined-reception-(invocation-target-selected)}]]

Function

Checks whether the specified repository ZIP file can be imported. If the file cannot be imported, this command displays the cause in an error message.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see 4.6 Adding, updating, and deleting a repository using component as a unit in the uCosminexus Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-repfile repository-ZIP-file-name ~ ((1 to 200 bytes))

Specifies the absolute or relative path of the repository ZIP file whose importability is to be verified.

-compo

Specify this option to check whether the components of the repository can be imported.

If this option is omitted, the command checks the importability of the entire repository ZIP file.

-name {service-ID|reception-ID-of-user-defined-reception-(invocation-target-selected)} ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies one of the following for the HCSC component whose importability is to be verified:

service-ID

Specify the service ID of the business process or service adapter.

reception-ID-of-user-defined-reception-(invocation-target-selected)

Specify the reception ID of the user-defined reception (invocation target selected).

If this option is omitted, all the HCSC components of the repository ZIP file are verified.

Examples of input

(1) To verify the importability of the repository ZIP file repository.zip

cscrepcheck -user admin -pass admin -repfile repository.zip

(2) To verify the importability of the components of the repository ZIP file repository.zip

cscrepcheck -user admin -pass admin -repfile repository.zip -compo

(3) To verify the importability of a HCSC component with the service ID 1 in the repository ZIP file repository.zip

cscrepcheck -user admin -pass admin -repfile repository.zip -compo -name 1

(4) To verify the importability of an HCSC component with the reception ID 2 in the repository ZIP file repository.zip

cscrepcheck -user admin -pass admin -repfile repository.zip -compo -name 2

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

An error might occur during the import process if the settings for using a database and Reliable Messaging differ in the repository information for the current operating environment and the repository information to be imported.

An error might occur during the import process if the SOAP mode of the repository information for the current operating environment differs from that of the repository information to be imported.

An error occurs if the repository contains multiple cluster environments.

cscrepctl (Importing/Exporting)

Format

cscrepctl [-h]
 -user login-user-ID
 -pass login-password
 {-import file-name [-overwrite]
 [{-check|-compo
     [{-name {service-ID|reception-ID-of-user-defined-reception-(invocation-target-selected)}
      |-namelist file-name-specifying-HCSC-components}] [-nouoc]}]
 |-export file-name
 |-autoexport
 |-delete {-name {service-ID|reception-ID-of-user-defined-reception-(invocation-target-selected)}
 |-namelist file-name-specifying-HCSC-components}}

Function

Outputs the information from the repository to a ZIP file, and expands the information stored in the ZIP format to the repository. This command also enables you to delete the repository components.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see the following locations in the Service Platform Setup and Operation Guide according to the purpose of use:

4.2 Exporting Repository Information

4.3 Importing a repository

4.6 Adding, updating, and deleting a repository using component as a unit

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-import file-name ~ ((1 to 200 bytes))

Specifies the absolute or relative path for the ZIP file to be expanded.

-overwrite

Expands the HCSC components imported and stored in the ZIP format to the operating environment repository. This option is enabled when the -import option is specified.

When you specify the -overwrite option, all the HCSC components stored in a ZIP file, including those HCSC components that have not been changed, will be expanded to the operating environment repository.

If you omit the -overwrite option, only the changed HCSC components stored in the ZIP file will be expanded to the operating environment repository. At this time, the HCSC components existing in the current operating environment are used as the HCSC components that have not been changed.

-check

Checks whether the HCSC server configuration information is the same in the repository information for the current operating environment and the repository information to be imported. An error occurs if the HCSC server configuration information is different. This option is enabled when the -import option is specified. Do not specify this option for a standard import.

-compo

Imports the information for components.

-name {service-ID|reception-ID-of-user-defined-reception-(invocation-target-selected)} ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies one of the following for the HCSC component to be imported or deleted:

service-ID

Specify the service ID of the business process or service adapter.

reception-ID-of-user-defined-reception-(invocation-target-selected)

Specify the reception ID of the user-defined reception (invocation target selected).

If you omit this option when the -compo option is specified, all the HCSC components will be imported.

-namelist file-name-specifying-HCSC-components ~ ((1 to 200 bytes))

Specifies the HCSC components you intend to import or delete in the HCSC component-specification file.

Specifies the file in an absolute or relative path. If the file does not exist, the command terminates abnormally. For details on the HCSC component-specification file, see 6.5.5 HCSC component-specification file.

Note that the order of executing the specified HCSC components is not fixed.

-nouoc

Specify this option if you do not want to update UOC when each component is imported. UOC is the source, class, and library created independently by the user as a part of the HCSCTE project in the development environment.

You can specify this option only when you specify the -compo option.

-export file-name ~ ((1 to 200 bytes))

Specifies the name of the ZIP file to be output, expressed as an absolute or relative path. If the directory up to the specified file does not exist, the command terminates abnormally. If the specified file already exists, the file is overwritten. If the extension of the specified file is not .zip, then .zip is added.

-autoexport

Specify this option to output the ZIP file with the default file name. This option assigns the default file name in the following format:

For IPv4: aaabbbcccddd_YYYYMMDDhhmmss.zip

For IPv6: aaaabbbbccccddddeeeeffffgggghhhh_YYYYMMDDhhmmss.zip

aaabbbcccddd:

Indicates the IPv4 address of the machine that executed the command.

aaaabbbbccccddddeeeeffffgggghhhh:

Indicates the IPv6 address of the machine that executed the command.

YYYYMMDDhhmmss:

Indicates the time of backup.

YYYY: Year, MM: Month, DD: Date, hh: Hour, mm: Minutes, ss: Seconds

You can specify the output destination in cscmng.properties (HCSC-Manager definition file). If the output destination is not specified, the ZIP file is output to the current directory.

-delete

Deletes the components with the specified service ID from the operating environment repository. After this option, specify the service ID you intend to delete in the options -name or -namelist.

If you delete a service by specifying this option, the services invoked from the other business processes are also deleted. Therefore, carefully select the service you intend to delete.

Examples of input

(1) To expand the contents of repository.zip to a repository

cscrepctl -user admin -pass admin -import repository.zip

(2) To output repository.zip containing the repository information to the current directory

cscrepctl -user admin -pass admin -export repository.zip

(3) To output with the default file name

cscrepctl -user admin -pass admin -autoexport

(4) To import the contents of repository.zip for each component

cscrepctl -user admin -pass admin -import repository.zip -compo

(5) To import the HCSC component for which the service ID or the reception ID of the user-defined reception (invocation target selected) is 1

cscrepctl -user admin -pass admin -import repository.zip -compo -name 1

(6) To import all the HCSC components specified in the HCSC component-specification file hcsccomponent.txt, from among the repository.zip contents

cscrepctl -user admin -pass admin -import repository.zip -compo -namelist hcsccomponent.txt

(7) To delete the HCSC component for which the service ID or the reception ID of the user-defined reception (invocation target selected) is 1

cscrepctl -user admin -pass admin -delete -name 1

(8) To delete all the HCSC components specified in the HCSC component-specification file hcsccomponent.txt

cscrepctl -user admin -pass admin -delete -namelist hcsccomponent.txt

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

This command cannot be executed while the user is logged in to the operating environment.

When you import the repository information, make sure that no directory or file under the directory that has been set as a repository is referenced, and then execute the cscrepctl command.

An error might occur during the import process if the settings for the usage of the database and Reliable Messaging differ in the repository information for the current operating environment and the repository information to be imported.

An error might occur during the import process if the SOAP mode of the repository information for the current operating environment differs from that of the repository information to be imported.

cscrepdiff (Displaying the differences in the repository information)

Format

cscrepdiff [-h]
 -user login-user-ID
 -pass login-password
 -repfile exported-repository-ZIP-file-name
 [-allinfo]
 [{-check
  |-compo [-name {service-ID|reception-ID-of-user-defined-reception-(invocation-target-selected)} ] }]
 [-listfile name-of-HCSC-component-specification-file-at-output-destination]

Function

Outputs the differences between the HCSC components in the repository information of the current operating environment and those in the specified repository information. If the following items in the repository information are same, this command displays the difference considering the component as the same HCSC component.

Service ID of a service adapter

Service ID of a business process

Reception ID of a user-defined reception

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see 4.5 Referencing difference information of repositories in the Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-repfile exported-repository-ZIP-file-name ~ ((1 to 200 bytes))

Specifies the name of the exported ZIP file whose differences are to be displayed as an absolute or relative path.

-allinfo

Displays the changes for all the HCSC components. All the imported HCSC components are displayed, so a large amount of information might be displayed if there are many HCSC components in the repository.

If this option is omitted, only the HCSC components with differences are displayed.

-check

Checks whether the HCSC server configuration information is the same in the repository information for the current operating environment and the repository information to be compared. An error occurs if the HCSC server configuration information is different. Do not specify this option for a standard import.

-compo

Displays the differences in HCSC components when the information is imported for each component.

-name {service-ID|reception-ID-of-user-defined-reception-(invocation-target-selected)} ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies one of the following for the type of HCSC components in the ZIP file when the information is imported for each component.

service-ID

Specify the service ID of the business process or service adapter.

reception-ID-of-user-defined-reception-(invocation-target-selected)

Specify the reception ID of the user-defined reception (invocation target selected).

You can specify this option when you specify the -compo option.

If this option is omitted, all the HCSC components in the ZIP file will be imported for each component.

-listfile name-of-HCSC-component-specification-file-at-output-destination ~ ((1 to 200 bytes))

Outputs the differences and the types of changes of the HCSC components to the specified file. Specifies the file in an absolute or relative path. If the path does not exist, the command terminates abnormally.

The output format is the same as that of the HCSC component-specification file. For details on the format for describing the HCSC component-specification file, see 6.5.5 HCSC component-specification file.

Output format

The following is the output format of the HCSC component-specification file when the -listfile option is specified.

(1) To output a repository, wherein there are changes in all the items, to a file (when the -listfile option is specified)

(2) To output a repository, wherein there are changes in all the items, component-wise to a file (when the options -compo and -listfile are specified)

(3) To output a repository with some changed and some unchanged items to a file (when the options -allinfo and -listfile are specified)

Display format

The meanings of symbols in the display format are as follows:

<: HCSC components existing in the current repository information

>: HCSC components existing in the repository information of the specified ZIP file

(1) When there are changes in all the items

(2) When there are changes only in the user-defined receptions (invocation target selected)

(3) When there are changes only in the business processes

(4) When there is no change (when the -allinfo option is omitted)

(5) When there are changes in all the items, but the items contain unchanged components (when the -allinfo option is specified)

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

An error might occur during command execution if the settings to use the database and Reliable Messaging differ in the repository information for the current operating environment and the repository information to be compared.

An error might occur during command execution if the SOAP mode of the repository information for the current operating environment differs from that of the repository information to be compared.

cscrepls (Displaying the repository information)

Format

cscrepls [-h]
 -user login-user-ID
 -pass login-password
 [{-repfile exported-repository-ZIP-file-name
 |-envbackfile name-of-HCSC-Manager-environment-backup-file}]
 [{-csc HCSC-server-name|-oldtype|-private}]
 [-listfile name-of-HCSC-component-specification-file-at-output-destination]

Function

Outputs the repository information to the standard output. You can also use this command to check the values specified for the arguments of the cscutil command. This command also outputs the list of all the HCSC components included in the repository, to a file.

The following shows the order in which the repository information for HCSC components is output. Information for non-existent HCSC components is not output.

User-defined reception (invocation target selected)

Business process or user-defined reception (invocation target fixed)

Service adapter

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see 4.4 Referencing the repository information in the Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-repfile exported-repository-ZIP-file-name ~ ((1 to 200 bytes))

Specifies the name of the exported repository ZIP file using an absolute or relative path. This option references the contents of the exported repository file and displays the configuration information. You cannot specify this option along with the -envbackfile.

-envbackfile name-of-HCSC-Manager-environment-backup-file ~ ((1 to 200 bytes))

Specifies the name of the HCSC-Manager environment backup file using an absolute or relative path. This option references the contents of the exported repository file and displays the configuration information. You cannot specify this option along with the -repfile.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Outputs the specified HCSC server information only.

-oldtype

Outputs the information for version 07-20 or earlier.

-private

Specify this option to display the information containing private components, existing in the repository or the repository file.

-listfile name-of-HCSC-component-specification-file-at-output-destination ~ ((1 to 200 bytes))

Outputs the list of all the HCSC components included in a repository, to the specified file. Specifies the file name using an absolute or relative path. If the path does not exist, the command terminates abnormally.

The output format is the same as that of the HCSC component-specification file, but the type of changes is not output. For details on the format for describing the HCSC component-specification file, see 6.5.5 HCSC component-specification file.

Output format

The following is the output format of the HCSC component-specification file when the -listfile option is specified:

#Command Edit Time:command-issuing-time

#Cluster Name:cluster-name
#HCSC-Server Name:HCSC-server-name
#UserDefinedReception
reception-ID-of-user-defined-reception-(invocation-target-selected)
#BusinessProcess
service-ID-of-business-process
#UserDefinedReception
reception-ID-of-user-defined-reception-(invocation-target-fixed)
#BusinessProcess
service-ID-of-business-process
#UserDefinedReception
reception-ID-of-user-defined-reception-(invocation-target-fixed)
#ServiceAdapter
service-ID-of-service-adapter

#HCSC-Server Name:HCSC-server-name
#UserDefinedReception
reception-ID-of-user-defined-reception-(invocation-target-selected)
#BusinessProcess
service-ID-of-business-process
#UserDefinedReception
reception-ID-of-user-defined-reception-(invocation-target-fixed)
#BusinessProcess
service-ID-of-business-process
#UserDefinedReception
reception-ID-of-user-defined-reception-(invocation-target-fixed)
#ServiceAdapter
service-ID-of-service-adapter

#Cluster Name:cluster-name
#HCSC-Server Name:HCSC-server-name
#BusinessProcess
service-ID-of-business-process
#UserDefinedReception
reception-ID-of-user-defined-reception-(invocation-target-fixed)
#BusinessProcess
service-ID-of-business-process
#UserDefinedReception
reception-ID-of-user-defined-reception-(invocation-target-fixed)
#ServiceAdapter
service-ID-of-service-adapter

Description

Display item

Description

#Command Edit Time

Indicates the time when the command was issued.

The time is output in the format YYYY/MM/DD hh:mm:ss.SSS defined with java.text.SimpleDateFormat.

YYYY: Year

MM: Month

DD: Date

hh: Hour

mm: Minutes

ss: Seconds

SSS: Milliseconds

#Cluster Name

Indicates the cluster name.

#HCSC-Server Name

Indicates the name of the HCSC server.

#UserDefinedReception

Indicates the reception ID of the user-defined reception (invocation target selected) or user-defined reception (invocation target fixed).

#BusinessProcess

Indicates the business process service ID.

#ServiceAdapter

Indicates the service ID of a service adapter.

Display format

(1) When the HCSC server is not specified in the -csc option

Command Edit Time:command-issuing-time
Domain(name:domain-name)
- Cluster(name:cluster-name)
    cluster-display-name:cluster-display-name
    cluster-type:cluster-type
    db-use:database-usage
    rm-use:usage-of-Reliable-Messaging
    SOAP-mode:used-SOAP-mode
  - HCSC-Server(CSCSrvName:HCSC-server-name)
      display-name:display-name-of-HCSC-server
      J2EESrvName:J2EE-server-name
      RMSystemName:RM-system-name
      Cosminexus Manager(Manager-name, host-IP-address-of-Manager:port-number-of-Manager)
    - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-selected))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-reception-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-selected)-update
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        deployed:status-of-business-process-deployment
        modified-time:time-of-business-process-update
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-reception-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-fixed)-update
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        deployed:status-of-business-process-deployment
        modified-time:time-of-business-process-update
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-reception-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-fixed)-update
    - ServiceAdapter(ServiceID:service-ID-of-service-adapter)
        ServiceName:display-name-of-adapter
        deployed:status-of-adapter-deployment
        modified-time:time-of-service-adapter-update
  - HCSC-Server(CSCSrvName:HCSC-server-name)
      display-name:display-name-of-HCSC-server
      J2EESrvName:J2EE-server-name
      RMSystemName:RM-system-name
      Cosminexus Manager(Manager-name, host-IP-address-of-Manager:port-number-of-Manager)
    - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-selected))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-reception-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-selected)-update
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        deployed:status-of-business-process-deployment
        modified-time:time-of-business-process-update
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-reception-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-fixed)-update
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        deployed:status-of-business-process-deployment
        modified-time:time-of-business-process-update
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-reception-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-fixed)-update
    - ServiceAdapter(ServiceID:service-adapter-name)
        ServiceName:display-name-of-adapter
        Type:adapter-type
        deployed:status-of-adapter-deployment
        modified-time:time-of-service-adapter-update
- Cluster(name:cluster-name)
    cluster-display-name:cluster-display-name
    cluster-type:cluster-type
    db-use:database-usage
    rm-use:usage-of-Reliable-Messaging
    SOAP-mode:used-SOAP-mode
  - HCSC-Server(CSCSrvName:HCSC-server-name)
      display-name:display-name-of-HCSC-server
      J2EESrvName:J2EE-server-name
      RMSystemName:RM-system-name
      Cosminexus Manager(Manager-name, host-IP-address-of-Manager:port-number-of-Manager)
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        deployed:status-of-business-process-deployment
        modified-time:time-of-business-process-update
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-reception-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-fixed)-update
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        deployed:status-of-business-process-deployment
        modified-time:time-of-business-process-update
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-reception-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-fixed)-update
    - ServiceAdapter(ServiceID:service-ID-of-service-adapter)
        ServiceName:display-name-of-adapter
        Type:adapter-type
        deployed:status-of-adapter-deployment
        modified-time:time-of-service-adapter-update

(2) When the HCSC server is specified in the -csc option

Command Edit Time:command-issuing-time
Domain(name:domain-name)
- Cluster(name:cluster-name)
    cluster-display-name:cluster-display-name
    cluster-type:cluster-type
    db-use:database-usage
    rm-use:usage-of-Reliable-Messaging
    SOAP-mode:used-SOAP-mode
  - HCSC-Server(CSCSrvName:HCSC-server-name)
      display-name:display-name-of-HCSC-server
      J2EESrvName:J2EE-server-name
      RMSystemName:RM-system-name
      Cosminexus Manager(Manager-name, host-IP-address-of-Manager:port-number-of-Manager)
    - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-selected))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-reception-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-selected)-update
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        deployed:status-of-business-process-deployment
        modified-time:time-of-business-process-update
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-reception-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-fixed)-update
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        deployed:status-of-business-process-deployment
        modified-time:time-of-business-process-update
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-reception-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-fixed)-update
    - ServiceAdapter(ServiceID:service-ID-of-service-adapter)
        ServiceName:display-name-of-adapter
        Type:adapter-type
        deployed:status-of-adapter-deployment
        modified-time:time-of-service-adapter-update

(3) When the -oldtype option is specified

Command Edit Time:command-issuing-time
Domain(name:domain-name)
- Cosminexus Manager(name:Manager-name)
    display-name:display-name-of-Manager
    management-ip:host-IP-address-of-Manager
    port:port-number-of-Manager
  - HCSC-Server(CSCSrvName:HCSC-server-name)
      display-name:display-name-of-HCSC-server
      cluster-name:cluster-name
      cluster-display-name:cluster-display-name
      cluster-type:cluster-type
      J2EESrvName:J2EE-server-name
    - SessionBean
        Url:URL-used-for-invoking-synchronous-service-(SessionBean)
        LookupName:lookup-name-used-for-invoking-synchronous-service-(SessionBean)
    - WebService(SOAP1.1)
        Url:URL-used-for-invoking-synchronous-service-(Web-Services/SOAP1.1)
    - WebService(SOAP1.2)
        Url:URL-used-for-invoking-synchronous-service-(Web-Services/SOAP1.2)
    - MDB(WS-R)
        Url:URL-used-for-invoking-asynchronous-service-(MDB(WS-R))
    - MDB(DBQueue)
        Name:database-queue-name
    - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-selected))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-reception-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-selected)-update
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        deployed:status-of-business-process-deployment
        modified-time:time-of-business-process-update
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-reception-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-fixed)-update
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        deployed:status-of-business-process-deployment
        modified-time:time-of-business-process-update
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-reception-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-fixed)-update
    - ServiceAdapter(ServiceID:service-ID-of-service-adapter)
        ServiceName:display-name-of-adapter
        Type:adapter-type
        deployed:status-of-adapter-deployment
        modified-time:time-of-service-adapter-update
  - HCSC-Server(CSCSrvName:HCSC-server-name)
      display-name:display-name-of-HCSC-server
      cluster-name:cluster-name
      cluster-display-name:cluster-display-name
      cluster-type:cluster-type
      J2EESrvName:J2EE-server-name
    - SessionBean
        Url:URL-used-for-invoking-synchronous-service-(SessionBean)
        LookupName:lookup-name-used-for-invoking-synchronous-service-(SessionBean)
    - WebService(SOAP1.1)
        Url:URL-used-for-invoking-synchronous-service-(Web-Services/SOAP1.1)
    - WebService(SOAP1.2)
        Url:URL-used-for-invoking-synchronous-service-(Web-Services/SOAP1.2)
    - MDB(WS-R)
        Url:URL-used-for-invoking-asynchronous-service-(MDB(WS-R))
    - MDB(DBQueue)
        Name:database-queue-name
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        deployed:status-of-business-process-deployment
        modified-time:time-of-business-process-update
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-reception-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-fixed)-update
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        deployed:status-of-business-process-deployment
        modified-time:time-of-business-process-update
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-reception-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-fixed)-update
- Cosminexus Manager(name:Manager-name)
    display-name:display-name-of-Manager
    management-ip:host-IP-address-of-Manager
    port:port-number-of-Manager
  - HCSC-Server(CSCSrvName:HCSC-server-name)
      display-name:display-name-of-HCSC-server
      cluster-name:cluster-name
      cluster-display-name:cluster-display-name
      cluster-type:cluster-type
      J2EESrvName:J2EE-server-name
    - SessionBean
        Url:URL-used-for-invoking-synchronous-service-(SessionBean)
        LookupName:lookup-name-used-for-invoking-synchronous-service-(SessionBean)
    - WebService(SOAP1.1)
        Url:URL-used-for-invoking-synchronous-service-(Web-Services/SOAP1.1)
    - WebService(SOAP1.2)
        Url:URL-used-for-invoking-synchronous-service-(Web-Services/SOAP1.2)
    - MDB(WS-R)
        Url:URL-used-for-invoking-asynchronous-service-(MDB(WS-R))
    - MDB(DBQueue)
        Name:database-queue-name
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        deployed:status-of-business-process-deployment
        modified-time:time-of-business-process-update
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-reception-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-fixed)-update
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        deployed:status-of-business-process-deployment
        modified-time:time-of-business-process-update
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-reception-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-fixed)-update
  - HCSC-Server(CSCSrvName:HCSC-server-name)
      display-name:display-name-of-HCSC-server
      cluster-name:cluster-name
      cluster-display-name:cluster-display-name
      cluster-type:cluster-type
      J2EESrvName:J2EE-server-name
    - SessionBean
        Url:URL-used-for-invoking-synchronous-service-(SessionBean)
        LookupName:lookup-name-used-for-invoking-synchronous-service-(SessionBean)
    - WebService(SOAP1.1)
        Url:URL-used-for-invoking-synchronous-service-(Web-Services/SOAP1.1)
    - WebService(SOAP1.2)
        Url:URL-used-for-invoking-synchronous-service-(Web-Services/SOAP1.2)
    - MDB(WS-R)
        Url:URL-used-for-invoking-asynchronous-service-(MDB(WS-R))
    - MDB(DBQueue)
        Name:database-queue-name
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        deployed:status-of-business-process-deployment
        modified-time:time-of-business-process-update
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        deployed:status-of-business-process-deployment
        modified-time:time-of-business-process-update
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-reception-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-fixed)-update

(4) When the -private option is specified (underlined portions indicate the information for private components)

Command Edit Time:command-issuing-time
Domain(name:domain-name)
- Cluster(name:cluster-name)
    cluster-display-name:cluster-display-name
    cluster-type:cluster-type
    db-use:database-usage
    rm-use:usage-of-Reliable-Messaging
    SOAP-mode:used-SOAP-mode
  - HCSC-Server(CSCSrvName:HCSC-server-name)
      display-name:display-name-of-HCSC-server
      J2EESrvName:J2EE-server-name
      RMSystemName:RM-system-name
      Cosminexus Manager(Manager-name, host-IP-address-of-Manager:port-number-of-Manager)
    - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-selected))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-reception-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-selected)-update
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        modified-time:time-of-business-process-update
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          modified-time:time-of-user-defined-reception-(invocation-target-fixed)-update
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        modified-time:time-of-business-process-update
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          modified-time:time-of-user-defined-reception-(invocation-target-fixed)-update
    - ServiceAdapter(ServiceID:service-ID-of-service-adapter)
        ServiceName:display-name-of-adapter
        Type:adapter-type
        modified-time:time-of-service-adapter-update
  - HCSC-Server(CSCSrvName:HCSC-server-name)
      display-name:display-name-of-HCSC-server
      J2EESrvName:J2EE-server-name
      RMSystemName:RM-system-name
      Cosminexus Manager(Manager-name, host-IP-address-of-Manager:port-number-of-Manager)
    - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-selected))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-reception-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-selected)-update
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        modified-time:time-of-business-process-update
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          modified-time:time-of-user-defined-reception-(invocation-target-fixed)-update
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        modified-time:time-of-business-process-update
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          modified-time:time-of-user-defined-reception-(invocation-target-fixed)-update
    - ServiceAdapter(ServiceID:service-ID-of-service-adapter)
        ServiceName:display-name-of-adapter
        Type:adapter-type
        deployed:status-of-adapter-deployment
        modified-time:time-of-service-adapter-update
- Cluster(name:cluster-name)
    cluster-display-name:cluster-display-name
    cluster-type:cluster-type
    db-use:database-usage
    rm-use:usage-of-Reliable-Messaging
    SOAP-mode:used-SOAP-mode
  - HCSC-Server(CSCSrvName:HCSC-server-name)
      display-name:display-name-of-HCSC-server
      J2EESrvName:J2EE-server-name
      RMSystemName:RM-system-name
      Cosminexus Manager(Manager-name, host-IP-address-of-Manager:port-number-of-Manager)
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        deployed:status-of-adapter-deployment
        modified-time:time-of-business-process-update
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-adapter-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-fixed)-update
    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
        deployed:status-of-adapter-deployment
        modified-time:time-of-business-process-update
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
          deployed:status-of-adapter-deployment
          modified-time:time-of-user-defined-reception-(invocation-target-fixed)-update
    - ServiceAdapter(ServiceID:service-ID-of-service-adapter)
        ServiceName:display-name-of-adapter
        Type:adapter-type
        deployed:status-of-adapter-deployment
        modified-time:time-of-service-adapter-update
- PrivateComponents
    - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-selected))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root

    - BusinessProcess(ServiceID:service-ID-of-business-process)
        ServiceName:business-process-display-name
      - UserDefinedReception(ReceptionID:reception-ID-of-user-defined-reception-(invocation-target-fixed))
          ReceptionName:reception-name
          Type:reception-type
          ContextRoot:context-root
    - ServiceAdapter(ServiceID:service-ID-of-service-adapter)
        ServiceName:display-name-of-adapter
        Type:adapter-type

Description ((1) When the HCSC server is not specified in the -csc option, and (2) When the HCSC server is specified in the -csc option)

Display item

Description

Command Edit Time

Indicates the time when the command was issued.

The time is output in the format YYYY/MM/DD hh:mm:ss.SSS defined with java.text.SimpleDateFormat.

YYYY: Year

MM: Month

DD: Date

hh: Hour

mm: Minutes

ss: Seconds

SSS: Milliseconds

Domain (name)

Indicates the domain name.

Cluster (name)

Indicates the cluster name.

cluster-display-name

Indicates the cluster display name.#¹

cluster-type

Indicates the cluster type. One of the following values is displayed:

LB: Load-balancing cluster

HA: HA cluster

db-use

Indicates whether a database is being used. One of the following values is displayed:

ON: A database is being used.

OFF: No database is being used.

rm-use

Indicates whether Reliable Messaging is being used. One of the following values is displayed:

ON: Reliable Messaging is being used.

OFF: Reliable Messaging is not being used.

SOAP-mode

Indicates the SOAP mode used. One of the following values is displayed:

1.1: Indicates the SOAP 1.1 mode.

1.1/1.2: Indicates the combined SOAP 1.1/ 1.2 mode.

HCSC-Server (CSCSrvName)

Indicates the name of the HCSC server.

display-name

Indicates the display name of the HCSC server.#¹

J2EESrvName

Indicates the J2EE server name.

RMSystemName

Indicates the RM system name.

Cosminexus Manager (name, ip: port)

The following information is displayed:

Manager name

Host IP address of Manager

Port number of Manager

BusinessProcess (ServiceID)

Indicates the business process service ID.

ServiceAdapter (ServiceID)

Indicates the service ID of a service adapter.

ServiceName

Indicates the display name of the business process or the service adapter.

UserDefinedReception (ReceptionID)#2

Indicates the reception ID of a user-defined reception.

ReceptionName#2

Indicates the reception name of the user-defined reception.

Type#2

The following information is displayed for the adapter types:

WebService: SOAP adapter

SessionBean: SessionBean adapter

MDB_WSR: MDB (WS-R) adapter

MDB_DBQ: MDB (DB queue) adapter

Custom: The service adapters other than the ones mentioned above (blank spaces are displayed for the repository information earlier than 07-50)

The following information is displayed for the reception types:

WebService: SOAP reception

Custom: User-defined reception other than SOAP reception

ContextRoot#2

Indicates the context root. If there is no information, a blank space is displayed.

deployed#2

Indicates whether a business process, a service adapter, or a user-defined reception is deployed. One of the following values is displayed:

true: Deployed.

false: Not deployed.

modified-time#2

Indicates the time at which a business process, a service adapter, or a user-defined reception was updated.

The time is output in the format YYYY/MM/DD hh:mm:ss.SSS defined with java.text.SimpleDateFormat.

YYYY: Year

MM: Month

DD: Date

hh: Hour

mm: Minutes

ss: Seconds

Note that the update time is the packaging time in the development environment.

#1

Garbled characters might be generated if the following conditions are both satisfied:

When the following characters are used in the HCSC server display name, cluster display name, or user messages:

- Characters other than Basic Multilingual Plane (BMP)

- Characters in the range of Unicode code point U+10000 to U+10FFFF

- Characters represented by a surrogate pair of UTF-16 encoding

This command is used in Windows.

#2

The items for a user-defined reception (invocation target selected) and the items for a user-defined reception (invocation target fixed) are output to different locations.

The items for a user-defined reception (invocation target selected) are output before BusinessProcess.

The items for a user-defined reception (invocation target fixed) are output as subordinate items of BusinessProcess.

Description ((3) When the -oldtype option is specified, and (4) When the -private option is specified)

Display item

Description

Command Edit Time

Indicates the time when the command was issued.

The time is output in the format YYYY/MM/DD hh:mm:ss.SSS defined with java.text.SimpleDateFormat.

YYYY: Year

MM: Month

DD: Date

hh: Hour

mm: Minutes

ss: Seconds

SSS: Milliseconds

Domain (name)

Indicates the domain name.

Cosminexus Manager (name)

Indicates the Manager name.

display-name

One of the following is displayed:

Display name of Manager#¹

Display name of HCSC server#¹

Display name of the business process

Display name of the service adapter

management-ip

Indicates the host IP address of Manager.

Port

Indicates the port number of Manager.

HCSC-Server (CSCSrvName)

Indicates the name of the HCSC server.

cluster-name

Indicates the cluster name.

cluster-display-name

Indicates the cluster display name.

cluster-type

Indicates the cluster type. One of the following values is displayed:

LB: Load-balancing cluster

HA: HA cluster

J2EESrvName

Indicates the J2EE server name.

RMSystemName

Indicates the RM system name.

Url

One of the following is displayed:

For SessionBean: URL used for invoking a synchronous service (SessionBean)

For WebService (SOAP 1.1): URL used for invoking a synchronous service (Web service/ SOAP 1.1)

For WebService (SOAP 1.2): URL used for invoking a synchronous service (Web service/ SOAP 1.2)

For MDB (WS-R): URL used for invoking an asynchronous service (MDB (WS-R))

LookupName

Indicates the lookup name used for invoking a synchronous service (SessionBean).

Name

Indicates the database queue name.

BusinessProcess (ServiceID)

Indicates the business process service ID.

UserDefinedReception(ReceptionID)#2

Indicates the reception ID of the user-defined reception.

ReceptionName#2

Indicates the reception name of the user-defined reception.

Type#2

The following information is displayed for adapter types. Blank spaces are displayed for the repository information earlier than 07-50.

WebService: SOAP adapter

SessionBean: SessionBean adapter

MDB_WSR: MDB (WS-R) adapter

MDB_DBQ: MDB (DB queue) adapter

Custom: Service adapters other than the above

The following information is displayed for reception types:

WebService: SOAP reception

Custom: User-defined reception other than SOAP reception

ContextRoot#2

Indicates the context root. If there is no information, a blank space is displayed.

deployed#2

Indicates whether a business process or a service adapter is deployed. One of the following values is displayed:

true: Deployed.

false: Not deployed.

modified-time#2

Indicates the time at which a business process or a service adapter was updated.

The time is output in the format YYYY/MM/DD hh:mm:ss.SSS defined with java.text.SimpleDateFormat.

YYYY: Year

MM: Month

DD: Date

hh: Hour

mm: Minutes

ss: Seconds

Note that the update time is the packaging time in the development environment.

ServiceAdapter (ServiceID)

Indicates the service ID of a service adapter.

#1

Garbled characters might be generated if both the following conditions are satisfied:

When the following characters are used in the HCSC server display name, cluster display name, or user messages:

- Characters other than Basic Multilingual Plane (BMP)

- Characters in the range of Unicode code point U+10000 to U+10FFFF

- Characters represented by a surrogate pair of UTF-16 encoding

This command is used in Windows.

#2

The items for a user-defined reception (invocation target selected) and the items for a user-defined reception (invocation target fixed) are output to different locations.

The items for a user-defined reception (invocation target selected) are output before BusinessProcess.

The items of a user-defined reception (invocation target fixed) are output as subordinate items of BusinessProcess.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

When the -repfile option is specified, the following information is not output:

The deployment status of business processes and service adapters

URLs used for invoking the following services:#

Synchronous service (SessionBean)

Synchronous service (Web service (SOAP1.1))

Synchronous service (Web service (SOAP1.2))

Asynchronous service (MDB (WS-R))

Database queue name#

Cluster type

#

The URLs used for invoking service components and the database queue name are output when you specify the -oldtype option.

cscrepupdate (Updating a repository)

Format

cscrepupdate [-h]
 -user login-user-ID
 -pass login-password
 -inputfile name-of-ZIP-file-before-update
 -outputfile name-of-ZIP-file-after-update

Function

Updates a repository created in an earlier version to a repository available in the installed version. If the repository need not be updated, nothing is output.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see the description related to updating a repository in Appendix H.2 Repository migration procedure in the operating environment during a new installation in the uCosminexus Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-inputfile name-of-ZIP-file-before-update ~ ((1 to 200 bytes))

Specifies the old repository ZIP file before update as an absolute or relative path.

An error occurs if the specified file does not exist.

-outputfile name-of-ZIP-file-after-update ~ ((1 to 200 bytes))

Specifies the output destination of the updated repository ZIP file with a new version as an absolute or relative path. If the extension of the specified file is not .zip, then .zip is added. You cannot specify the same ZIP file as that specified in the -inputfile option.

If the specified file already exists, the file is overwritten. Also, an error occurs in the following cases:

If no directory exists for the specified file

If a value other than a file name is specified

Example of input

To update the contents of repository_old.zip and to output the file to the current directory as repozitory_new.zip

cscrepupdate -user admin -pass admin -inputfile repository_old.zip -outputfile repozitory_new.zip

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

You can update 08-00 and later repositories with this command. To update the 07-60 or earlier repositories, import and then update the repository in the development environment.

Before you execute the command, make sure that the drives with the following directories have free space that is at least twice the disk space used by the repository:

Service platform installation directory

Directory specified in the CSCMNG_HOME environment variable

cscresinfo (Displaying the resource information)

Format

cscresinfo [-h]
 -user login-user-ID
 -pass login-password
 -csc HCSC-server-name

Function

Displays the resource information for the HCSC server. This command displays only the information for the running resource adapters, standard receptions, and HCSC components. If the HCSC server is not running, no information is displayed.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see 5.3.16 Checking Resource Operation Information of the HCSC Server in the uCosminexus Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the HCSC server whose information you intend to display.

Output format

(1) When the HCSC server, standard reception, and HCSC components are all running

Information Get Time: information-collection-time
[HCSC-Server]
cluster-name.HCSC-server-name:active
 Java VM Heap Size(MB) maximum-Java-VM-heap-size/ upper-limit-for-Java-VM-heap-size

[DBConnector]
 resource-adapter-name maximum-number-of-DB-connections/ upper-limit-for-DB-connections

[StandardReception]
reception-type
 queue maximum-queue-retention-count/ upper-limit-of-queue-retention-count
 instance maximum-number-of-executions/ upper-limit-for-executions

[UserDefinedReception]
reception-ID-of-user-defined-reception
 queue maximum-queue-retention-count/ upper-limit-of-queue-retention-count
 instance maximum-number-of-executions/ upper-limit-for-executions

[BusinessProcess]
business-process-service-ID maximum-number-of-executions/ upper-limit-for-executions

[ServiceAdapter]
service-ID-of-service-adapter maximum-number-of-executions/ upper-limit-for-executions

(2) When the HCSC server is running and the standard reception and HCSC components are not running

Information Get Time: information-collection-time
[HCSC-Server]
cluster-name.HCSC-server-name:active
 Java VM Heap Size(MB) maximum-Java-VM-heap-size / upper-limit-for-Java-VM-heap-size

[DBConnector]
 resource-adapter-name maximum-number-of-DB-connections/ upper-limit-for-DB-connections

[StandardReception]#

[UserDefinedReception]#

[BusinessProcess]#

[ServiceAdapter]#

#

Only the heading is displayed.

(3) When the HCSC server is not running

[HCSC-Server]
cluster-name.HCSC-server-name:HCSC-server-status#

#

A status other than active is displayed.

Description

Display item

Description

Information collection time

Indicates the time when the information was collected. The time is output in the format YYYY/MM/DD hh:mm:ss.SSS defined with java.text.SimpleDateFormat.

YYYY: Year

MM: Month

DD: Date

hh: Hour

mm: Minutes

ss: Seconds

Cluster name

Indicates the cluster name.

HCSC server name

Indicates the name of the HCSC server.

Maximum Java VM heap size#1

Indicates the maximum Java VM heap size in megabytes. If an attempt to obtain the information fails or if the information is not obtained#2, - is displayed.

Upper limit for the Java VM heap size

Indicates the upper limit for the Java VM heap size in megabytes. If an attempt to obtain the information fails or if the information is not obtained#2, - is displayed.

Resource adapter name

Indicates the resource adapter name.

Maximum number of DB connections#1

Indicates the maximum number of DB connections. Also, in the following cases, NA/NA (invalid value) is displayed along with the upper limit for DB connections:

The relevant resource adapter is a root resource adapter or the DB connector for integration with Reliable Messaging

When the upper limit for the connection pool is set at 0

Upper limit for DB connections

Indicates the upper limit for DB connections. When only the upper limit for DB connections is displayed as NA, it indicates unlimited. For details on the display of NA/NA along with the maximum number of DB connections, see the description for Maximum number of DB connections.

Reception type

Indicates the reception type of the standard reception. One of the following values is displayed:

WebService (SOAP 1.1)

WebService (SOAP 1.2)

Maximum queue retention count#1

Indicates the maximum queue retention count. If an attempt to obtain the information fails or if the information is not obtained#3, - is displayed.

Upper limit of the queue retention count

Indicates the upper limit of the queue retention count. If an attempt to obtain the information fails, if the information is not obtained#3, or in the case of a user-defined reception (other than SOAP reception), - is displayed.

Maximum number of executions#1

Indicates the maximum number of executions. If an attempt to obtain the information fails or if the information is not obtained#3, - is output to the standard output.

Upper limit for executions

Indicates the upper limit for executions. When NA or 0 is displayed, it indicates unlimited. If an attempt to obtain the information fails or if the information is not obtained#3, - is displayed.

Reception ID of a user-defined reception

Indicates the reception ID of a user-defined reception.

Business process service ID

Indicates the business process service ID.

Service ID of a service adapter

Indicates the service ID of a service adapter.

HCSC server status

Indicates the HCSC server status. One of the following is displayed:

active: Running status

inactive: Stopped status

startfailed: Start failed

stopfailed: Stop failed

starting: Starting

stopping: Stopping

unknown: Collection failed

#1

The maximum value indicates the maximum value in the data collected during a period of 60 seconds.

#2

If the command is executed in the time period from the start of the HCSC server until the information is collected (60 seconds by default), the information is not obtained.

#3

If the command is executed in the time period from the start of target receptions or HCSC components until the information is collected (60 seconds by default), the information is not obtained.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

9

An error occurred when checking the execution permission.

cscstatus (Displaying the status)

Format

cscstatus [-h]
 -user login-user-ID
 -pass login-password
 [-csc HCSC-server-name
 -type {system|reception|compo}]

Function

Displays the status for the HCSC servers, standard receptions, and HCSC components.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see the following locations in the uCosminexus Service Platform Setup and Operation Guide according to the purpose of use:

5.3.11 Checking the PRF Status

5.3.12 Checking the HTTP Server Status

5.3.15 Checking the HCSC server information

5.3.17 Checking the service adapter information

5.3.18 Checking the business process information

5.3.19 Checking the information of user-defined reception

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the HCSC server for which you intend to display the status of standard receptions or HCSC components. If you specify this option, make sure that you also specify the -type option. If this option is omitted, the command displays the status of all the HCSC servers.

-type {system|reception|compo}

Specifies the type of a standard reception or an HCSC component whose status you want to display.

system

Specify this option to display the status of the HCSC server and the logical servers managed by the HCSC server (PRF status).

reception

Specify this option to display the status of standard receptions and user-defined receptions.

compo

Specify this option to display the status of HCSC components.

Display format

(1) HCSC server status

Command Edit Time: command-issuing-time
HCSC-server-status HCSC-server-name

Description

Display item

Description

HCSC server status

Indicates the HCSC server status. One of the following is displayed:

active: Running status

inactive: Stopped status#

starting: Starting

startfailed: Start failed status

stopping: Stopping

stopfailed: Stop failed status

unknown: Collection failed

HCSC server name

Indicates the name of the HCSC server. The name is displayed in the following format:

cluster-name.HCSC-server-name

#

The status is displayed as inactive even if the time required for obtaining the status of the HCSC server is more than the command timeout value specified in csc-command-timeout in the HCSC server runtime definition file.

(2) Status of the logical servers managed by the HCSC server (when -csc is specified)

When -type system is specified

Command Edit Time: command-issuing-time
HCSC-server-status HCSC-server-name
logical-server-status logical-server-name

Description

Display item

Description

HCSC server status

Indicates the status of the HCSC server. One of the following is displayed:

active: Running status

inactive: Stopped status#

starting: Starting

startfailed: Start failed status

stopping: Stopping

stopfailed: Stop failed status

unknown: Collection failed

Logical server status

Indicates the status of the logical server. One of the following is displayed:

active: Running status

inactive: Stopped status

starting: Starting

stopping: Stopping

abnormal ended: Abnormal termination

recovering: Recovering

communication error: Communication error

auto stopping: Auto-stopping

auto restarting: Auto-restarting

force stopping: Forced stopping

planned stopping: Planned stopping

#

The status is displayed as inactive even if the time required for obtaining the status of the HCSC server is more than the command timeout value specified in csc-command-timeout in the HCSC server runtime definition file.

(3) Status of standard receptions and user-defined receptions (when -csc is specified)

When -type reception is specified

Command Edit Time: command-issuing-time
 standard-reception-status reception

 user-defined-reception-status

Description

Display item

Description

Standard reception status

Indicates the status of the standard reception. One of the following is displayed:

active: Running status

inactive: Stopped status#

starting: Starting

startfailed: Start failed status

stopping: Stopping

stopfailed: Stop failed status

unknown: Collection failed

User-defined reception status

Indicates the status of the user-defined reception. One of the following is displayed:

active: Running status

inactive: Stopped status

starting: Starting

startfailed: Start failed status

stopping: Stopping

stopfailed: Stop failed status

deleting: Deleting

undeployed: Undeployed

unknown: Collection failed

#

The status is displayed as inactive even if the time required for obtaining the status of the HCSC server is more than the command timeout value specified in csc-command-timeout in the HCSC server runtime definition file.

Also, when the status of the HCSC server is inactive, even the status of the standard reception is displayed as inactive.

(4) Status of HCSC components (When -csc is specified)

When -type compo is specified

Command Edit Time: command-issuing-time
 business-process-status business-process-service-ID update-time#

 service-adapter- status service-ID-of-service-adapter update-time#

 user-defined-reception-status reception-ID-of-user-defined-reception update-time#

#

Indicates the time at which the HCSC components are packaged in the development environment. Therefore, this value depends on the time of the machine in the development environment.

Description

Display item

Description

Business process status

Service adapter status

User-defined reception status

Indicates the status of business processes, service adapters, and user-defined receptions. One of the following is displayed:

active: Running status

inactive: Stopped status

starting: Starting

startfailed: Start failed status

stopping: Stopping

stopfailed: Stop failed status

deleting: Deleting

undeployed: Undeployed

unknown: Collection failed

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

cscsetup (Easy setup of the production environment)

Format

cscsetup [-h]
 {-setup definition-file-storage-directory
 |-unsetup [-force]
 |-change definition-file-storage-directory}
 [-yes]

Function

Sets up and removes the setup of the systems that can be applied to the production environment. Furthermore, this command easily changes the information set up with easy setup.

For details on how to use this command, see 3.5.3 Executing the Easy Setup functionality for the HCSC production environment in the uCosminexus Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-setup definition-file-storage-directory ~ ((1 to 100 bytes))

Specify the absolute path of the definition file storage directory. This command references the definition file of the specified directory and sets up the production environment.

For SOA.xml in the directory specified here, you need to set up a JAR file for the container extension library appropriate for the SOAP mode (SOAP1.1 mode or SOAP1.1/1.2 combined mode). If you do not set up the JAR file, operations are not guaranteed.

-unsetup

Removes the set up production environment.

-force

If an error occurs during unsetup, the unsetup operation continues forcefully. Use this option when the setup operation specifying the -setup option and the unsetup operation specifying the -unsetup option fail and the processing cannot continue. For a normal unsetup, we recommend that you specify the -unsetup option to remove the setup instead of the -force option.

-change definition-file-storage-directory ~ ((1 to 100 bytes))

Specify the absolute path of the definition file storage directory. This command references the definition file of the specified directory and changes the information for the production environment.

Note that if you change the SOAP mode for an environment that has been set up, operations are not guaranteed.

-yes

The confirmation message is not displayed.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

9

An error occurred when checking the execution permission.

Notes

In UNIX, if the cscsetup command definition file (cscsetup.properties) does not exist in the definition file storage directory, the processing is executed by the superuser. Therefore, if you want to change Component Container Administrator and execute operations, specify the owner name and group name in the cscsetup command definition file (cscsetup.properties). For details on the cscsetup command definition file, see 6.4.1 cscsetup command definition file.

cscsvcctl (Managing the service information)

Format

cscsvcctl [-h]
 -user login-user-ID
 -pass login-password
 {-getfile name-of-service-information-change-definition-file
 |-setfile name-of-service-information-change-definition-file
 |-cluster cluster-name
 -name service-ID-of-service-adapter
 -props property}

Function

The cscsvcctl command has the following functions:

A function to output the service-information change definition file (using the -getfile option)

A function to enter the service-information change definition file and to set up the changes in the service information in a batch (using the -setfile option)

A function to set up the changes in the service information individually, without using the service-information change definition file (using the options -cluster, -name, and -props)

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see 3.1.6 Changing the service information in the uCosminexus Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-getfile name-of-service-information-change-definition-file ((1 to 200 bytes))

Specifies the name of the service-information change definition file to be output as an absolute or relative path. If there is no directory for the specified file, the command terminates abnormally. If the specified file already exists, the file is overwritten. If a directory with the same name as the specified file name exists, the command will terminate abnormally.

Note that the values set for the proxy server user ID and password and the basic authentication user ID and password are displayed as follows in the output service-information change definition file:

If a value is set: The value has already been set.

If no value is set: Space

-setfile name-of-service-information-change-definition-file ((1 to 200 bytes))

Specifies the name of the service-information change definition file to be entered as an absolute or relative path. If the specified file does not exist, the command terminates abnormally.

Note that when you set the service-information change definition file, specify the value obtained with the -getfile option as is if you do not want to change the proxy server user ID and password and the basic authentication user ID and password.

-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the cluster that contains the service adapter for changing the service information.

-name service-ID-of-service-adapter ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the service ID of the service adapter for changing the service information.

-props property ~ ((at least 1 character))

Specifies the information passed on to the operation target in the format key=value. In key, use the key name displayed with the service information display command (cscsvcls). Enclose the specified value within double quotation marks ("). Also, you can specify multiple items of the service information related to the service adapter specified in the -name option. To specify multiple items, demarcate the specified values with commas (,) (example: -props "a=b,c=d"). Note that if the LocalCall value checked with the service information display command (cscsvcls) is false, do not change the value to true.

Examples of input

(1) To output the service-information change definition file

cscsvcctl -getfile service_info.txt

(2) To enter the service-information change definition file and set up the changes in the service information in a batch

cscsvcctl -setfile service_info.txt

(3) To set up the changes in the service information individually, without using the service-information change definition file

cscsvcctl -cluster Cluster -name adapter1 -props "Url=aaa,ReadTimeout=60"

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

When the options -setfile or -name are specified, and if the service adapter whose service information is to be changed, is being deployed (the service adapter is being deployed on one of the HCSC servers in the cluster in an HCSC server cluster configuration), the cscsvcctl command results in an error.

cscsvcls (Displaying the service information)

Format

cscsvcls [-h]
 -user login-user-ID
 -pass login-password
 [-detail]

Function

Outputs the service information to the standard output. You can check the output service information as the property information to be specified in the -props option of the cscsvcctl command (for managing the service information).

The service information can be output for the following adapter types:

SessionBean

WebService

MDB_WSR

MDB_DBQ

For any other cases (user-defined receptions or the service adapter type Custom), the definition file name specified in the development environment or operating environment and the status of that definition file (whether the status has changed in the operating environment) are output.

Note that you can obtain and set up definition files by using the csccmctl command (for managing definition files).

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see the following locations in the uCosminexus Service Platform Setup and Operation Guide according to the purpose of use:

3.1.7 Checking the service information

3.1.12 Checking the status of the operating environment definition file

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-detail

Specify this option to display the values set during development.

Output format

When -detail is not specified:

Command Edit Time: command-issuing-time
Cluster(name: cluster-name)
- ServiceAdapter(ServiceID: service-ID-of-service-adapter, ServiceType: adapter-type)
 Attribute name: value
- ServiceAdapter(ServiceID: service-ID-of-service-adapter, ServiceType: adapter-type)
 Attribute name: value
- ServiceAdapter(ServiceID: service-ID-of-service-adapter, ServiceType: Custom)
 Definition file name: status
-UserDefinedReception(ReceptionID: reception-ID, ReceptionType: reception-type)
 Definition file name: status

When -detail is specified:

Command Edit Time: command-issuing-time
Cluster(name: cluster-name)
- ServiceAdapter(ServiceID: service-ID-of-service-adapter, ServiceType: service-adapter-type)
 Attribute name (def): value-specified-during-development
 Attribute name (set): value
- ServiceAdapter(ServiceID: service-ID-of-service-adapter, ServiceType: service-adapter-type)
 Attribute name (def): value-specified-during-development
 Attribute name (set): value
- ServiceAdapter(ServiceID: service-ID-of-service-adapter, ServiceType: Custom)
 Definition file name: status
 Property key name: property-value
-UserDefinedReception(ReceptionID: reception-ID, ReceptionType: reception-type)
 Definition file name: status
 Property key name=: property-value

Description

Display item

Description

Command Edit Time

Indicates the time when the command was issued.

The time is output in the format YYYY/MM/DD hh:mm:ss.SSS defined with java.text.SimpleDateFormat.

YYYY: Year

MM: Month

DD: Date

hh: Hour

mm: Minutes

ss: Seconds

SSS: Milliseconds

Cluster (name)

Indicates the cluster name.

ServiceAdapter (ServiceID)

Indicates the service ID of a service adapter.

ServiceType

Indicates the service adapter type. One of the following is output:

SessionBean: Synchronous (SessionBean)

WebService: Synchronous (Web service)

MDB_WSR: Asynchronous (MDB (WS-R))

MDB_DBQ: Asynchronous (MDB (DB queue))

Custom: Service adapters other than the above

Attribute name

Outputs the service information that is currently valid.

Attribute name (def)

Outputs the service information set up during development.

Attribute name (set)

Outputs the service information specified in the service-information change definition.

Reception ID

Indicates the reception ID.

Reception type

Indicates the reception type. One of the following is output:

WebService: SOAP reception

Custom: User-defined reception other than SOAP reception

Definition file name#1

Indicates the definition file name.

Status

Indicates the definition file status. One of the following is output:

noChange: Status in which the self-defined file is not set in the operating environment

add: Status in which the self-defined file is added to the operating environment

changed: Status in which the definitions added to the operating environment are changed

Property key name#2

If the extension of the definition file is *.properties, the property key name is output.

Property value#2

If the extension of the definition file is *.properties, the property value is output.

#1

The name of HITACHI Application Integrated Property File might be displayed for a service adapter.

#2

This item is only displayed when the extension is *.properties.

The following table describes the output format for the service information. Note that the SOAP mode in the table represents the SOAP 1.1 mode and SOAP 1.1/ 1.2 combined mode.

Table 5‒6: Output format of the service information

Service adapter type

SOAP mode

Output format (order of output)

Corresponding attributes in the service-information change definition file

1.1

1.1/ 1.2 combined

WebService

Y

Y

BasicAuthenticationId

basic_authentication_id#1#2

Y

Y

BasicAuthenticationPass

basic_authentication_pass#1#2

Y

Y

BasicAuthenticationUse

basic_authentication_use#1

Y

SessionMaintain

c4web.application.app_maintainsession#1

Y

NonProxyHosts

c4web.application.non_proxy_hosts#1

Y

ProxyHost

c4web.application.proxy_host#1

Y

ProxyPassword

c4web.application.proxy_password#1#2

Y

ProxyPort

c4web.application.proxy_port#1

Y

ProxyUser

c4web.application.proxy_user#1#2

Y

AutoDeleteIncompleteFile

com.cosminexus.csc.auto-delete-incomplete-file#1

Y

ConnectTimeout

c4web.application.socket_connect_timeout#1

Y

com.cosminexus.csc.connect.timeout#1

Y

FileReadLockRetryCount

com.cosminexus.csc.file.read-lock.retry.count#1

Y

FileReadLockRetryInterval

com.cosminexus.csc.file.read-lock.retry.interval#1

Y

ReadTimeout

c4web.application.socket_read_timeout#1

Y

com.cosminexus.csc.request.timeout#1

Y

WriteTimeout

c4web.application.socket_write_timeout#1

Y

PrfTraceLevel

c4web.common.prf_trace_level#1

Y

ReceiveMaxSoapEnvelopeSize

c4web.common.receive_max_soap_envelope_size#1

Y

SendMaxSoapEnvelopeSize

c4web.common.send_max_soap_envelope_size#1

Y

SessionMaintain

com.cosminexus.csc.session.maintain#1

Y

Y

Url

url

SessionBean

Y

Timeout

c4web.application.ejb_timeout#1

Y

PrfTraceLevel

c4web.common.prf_trace_level#1

Y

LookupName

lookupName

Y

Url

url

MDB_WSR

Y

LocalCall

local_call

Y

QueueName

queue_name

Y

Url

url

Y

MaxMessageNum

max_message_num

Y

QosInOrder

qos_in_order

Y

RdAreaName

rdarea_name

MDB_DBQ

Y

Y

QueueName

queue_name

Legend:

Y: Indicates that the mode supports the output of the service information.

Blank column: Indicates that the mode does not support the output of the service information.

#1

If not specified, a space is displayed.

#2

If specified, the The value has already been set. text is displayed.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

cscsvconfig (HCSC server runtime definitions)

Format

cscsvconfig [-h]
 -user login-user-ID
 -pass login-password
 {-operation get -csc HCSC-server-name
 |-operation set -propfile name-of-HCSC-server-runtime-definition-file
 {-csc HCSC-server-name|-cluster cluster-name}}

Function

Obtains and changes the definition information for an HCSC server after the server is set up.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see the following locations in the uCosminexus Service Platform Setup and Operation Guide according to the purpose of use:

Usage when set is specified in the -operation option

3.1.4 Setting up the HCSC server definition information

Usage when get is specified in the -operation option

3.1.5 Checking the contents defined in the HCSC server

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-operation {get|set}

Specifies the operations of these commands.

get

Outputs the definitions set for the specified HCSC server to the standard output.

set

Applies the contents of the file specified in the -propfile option to the specified HCSC server.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the HCSC server whose definition information you want to obtain or change.

-propfile name-of-HCSC-server-runtime-definition-file ~ ((1 to 200 bytes))

Specifies the name of the file that contains the list of definitions to be defined on the HCSC server as a relative or absolute path. This option is enabled if set is specified in the -operation option.

-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the cluster wherein the HCSC server definitions are to be updated in a batch. This option is enabled if set is specified in the -operation option. However, an error occurs if you specify this option when the cluster type is HA.

Examples of input

(1) To obtain the definitions for the HCSC server HCSC

cscsvconfig -user admin -pass admin -csc HCSC -operation get

(2) To set up the definitions for the HCSC server HCSC

cscsvconfig -user admin -pass admin -csc HCSC -operation set -propfile config.properties

(3) To change the definitions for all the HCSC servers in the cluster Cluster

cscsvconfig -user admin -pass admin -cluster Cluster -operation set -propfile config.properties

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

2

A communication timeout occurred.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

cscsvsetup (Setting up an HCSC server)

Format

cscsvsetup [-h]
 -user login-user-ID
 -pass login-password
 [-csc HCSC-server-name]
 [-cluster cluster-name]
 -propfile name-of-HCSC-server-configuration-definition-file

Function

Sets up an HCSC server.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see 3.1.3 Setting up an HCSC server in the uCosminexus Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the HCSC server to be set up. Do not use an HCSC server name that is identical and only differs in upper or lower case, from the name of an HCSC server that is already set up. If such a name is used, the database table name and queue name might be duplicated, resulting in a setup error. If you omit this option, the HCSC server name specified in the HCSC server configuration definition file is assumed.

-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters)) <<server name specified in the -csc option>>

Specifies the name of the cluster to which the HCSC server to be set up belongs. This cluster name must be unique amongst the different clusters. Do not use a cluster name that is identical and only differs in upper or lower case, from the name of a cluster that is already set up. If such a name is used, the database table name and queue name might be duplicated, resulting in a setup error. If you omit this option, the cluster name specified in the HCSC server configuration definition file is assumed.

-propfile name-of-HCSC-server-configuration-definition-file ~ ((1 to 200 bytes))

Specifies the name of the HCSC server configuration definition file as a relative or absolute path.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

2

A communication timeout occurred.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

To perform an additional setup, execute the command after the termination of the HCSC server, each business process, and each service adapter. If the command is executed while any of the above are still running, an error occurs.

The settings for using the database and Reliable Messaging in one cluster must be the same.

The SOAP modes of all the HCSC servers in one repository must be the same.

cscsvstart (Starting an HCSC server)

Format

cscsvstart [-h]
 -user login-user-ID
 -pass login-password
 {-csc HCSC-server-name|-cluster cluster-name}
 [{-logical logical-server-name|-system }]

Function

Starts the HCSC server or logical server.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see the following locations in the uCosminexus Service Platform Setup and Operation Guide according to the purpose of use:

5.3.3 Starting PRF

5.3.4 Starting HCSC server

5.3.5 Starting HTTP Server

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the HCSC server to be started.

-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the cluster wherein the HCSC servers are to be started in a batch. An error occurs if you specify the -cluster option when the cluster type is HA.

-logical logical-server-name ~ <one-byte alphanumeric characters, underscores (_), and hyphens (-)> ((1 to 128 characters))

Specifies the name of the logical server to be started. The following table describes the types of logical servers set up with this option and their operations. Note that when you specify this option, the HCSC servers will not start.

Table 5‒7: Types of logical servers specified in the -logical option and their operations (for starting)

No.

Type of the specified logical server

Operation

1

PRF

Starts PRF.

2

Smart Agent

Starts Smart Agent.

3

CTM Domain Manager

Starts CTM Domain Manager.

4

CTM daemon

Starts the CTM daemon.

5

J2EE server

Starts a J2EE server without starting J2EE applications.#

6

Web server

Starts a Web server.

#

Execute the command when the HCSC server is not running.

-system

Simultaneously starts the logical server defined in cscmng.server.HCSC-server-name.system in the HCSC-Manager definition file and the HCSC server.

Examples of input

(1) To start the HCSC server HCSC

cscsvstart -user admin -pass admin -csc HCSC

(2) To start all the HCSC servers in the cluster Cluster in a batch

cscsvstart -user admin -pass admin -cluster Cluster

(3) To simultaneously start the HCSC servers in the cluster Cluster and logical servers, in a batch

cscsvstart -user admin -pass admin -cluster Cluster -system

(4) To start the logical server PRF in the cluster Cluster, in a batch

cscsvstart -user admin -pass admin -cluster Cluster -logical PRF

(5) To start the J2EE server J2EEServer existing on the HCSC server HCSC without starting J2EE applications

cscsvstart -user admin -pass admin -csc HCSC -logical J2EEServer

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

2

A communication timeout occurred.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

Execute this command for an HCSC server that is already set up and stopped.

If you execute this command for a running HCSC server, an error does not occur.

If an error occurs when you specify the -cluster option, check the results with the cscstatus command, eliminate the cause of the error, and then re-execute the command.

If a service adapter or business process cannot start when the HCSC server starts, the service adapter, business process, or reception might be stopped, but startup of the HCSC server terminates normally.

cscsvstop (Stopping an HCSC server)

Format

cscsvstop [-h]
 -user login-user-ID
 -pass login-password
 {-csc HCSC-server-name|-cluster cluster-name}
 [{-logical logical-server-name|-system}]
 [-force]

Function

Stops the HCSC server.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see the following locations in the Service Platform Setup and Operation Guide according to the purpose of use:

5.3.37 Terminating the HTTP Server

5.3.38 Terminating the HCSC Server

5.3.39 Terminating PRF

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the HCSC server to be stopped.

-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the cluster wherein the HCSC servers are to be stopped in a batch. An error occurs if you specify the -cluster option when the cluster type is HA.

-logical logical-server-name ~ <one-byte alphanumeric characters, underscores (_), and hyphens (-)> ((1 to 128 characters))

Specifies the name of the logical server to be stopped. The following table describes the types of logical servers set up with this option and their operations. Note that when you specify this option, the HCSC servers will not stop and the -force option is disabled.

Table 5‒8: Types of logical servers specified in the -logical option and their operations (for stopping)

No.

Type of specified logical server

Operation

1

PRF

Stops PRF.

2

Smart Agent

Stops Smart Agent.

3

CTM Domain Manager

Stops CTM Domain Manager.

4

CTM daemon

Stops the CTM daemon.

5

J2EE server

Stops a J2EE server.#

6

Web server

Stops a Web server.

#

Execute the command when the HCSC server is not running.

-system

Simultaneously stops the logical server defined in cscmng.server.HCSC-server-name.system in the HCSC-Manager definition file and the HCSC server.

-force

Forcibly stops an HCSC server even if the standard reception or user-defined reception is running. The logical J2EE server on which the HCSC server runs will stop normally.

Examples of input

(1) To stop the HCSC server HCSC

cscsvstop -user admin -pass admin -csc HCSC

(2) To forcefully stop all the HCSC servers in the cluster Cluster in a batch

cscsvstop -user admin -pass admin -cluster Cluster -force

(3) To simultaneously stop the HCSC servers in the cluster Cluster and logical servers, in a batch

cscsvstop -user admin -pass admin -cluster Cluster -system

(4) To stop the logical server PRF in the cluster Cluster, in a batch

cscsvstop -user admin -pass admin -cluster Cluster -logical PRF

(5) To stop the J2EE server J2EEServer on the HCSC server HCSC

cscsvstop -user admin -pass admin -csc HCSC -logical J2EEServer

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

2

A communication timeout occurred.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

Execute this command for a running HCSC server.

If an error occurs when you specify the -cluster option, check the results with the cscstatus command, eliminate the cause of the error, and then re-execute the command.

cscsvunsetup (Removing the setup of the HCSC server)

Format

cscsvunsetup [-h]
 -user login-user-ID
 -pass login-password
 -csc HCSC-server-name
 [-ignore]

Function

Removes the setup of the HCSC server.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see 3.3.5 Unsetting up an HCSC server in the uCosminexus Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the HCSC server for which the setup is to be removed.

-ignore

Specify this option to update the repository information even if the setup of the HCSC server cannot be removed from the execution environment. This option is used to achieve integrity between the execution and repository environments in the event of a hard disk failure or a communication error during unsetup. If HCSC components are deployed, the repository information is not updated. To delete the information about HCSC components, specify the -ignore option with the csccompoundeploy command.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

2

A communication timeout occurred.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

Execute this command after stopping the HCSC server and undeploying or removing the setup of each HCSC component. An error occurs if the HCSC server is running, or the HCSC components are deployed or set up.

cscutil (Various operations)

Format

cscutil [-h]
 -user login-user-ID
 -pass login-password
 {-mng Manager-name
 |-host IP-address:port-number -mnguser Management-user-ID
 [-mngpass Management-user-password]}
 -target {server|compo|compo_urecp|request_service}
 -operation {start|stop|get_setup_info|get_info
 |get_bp_info|get_adapter_info}
 {-props property|-propfile property-file-name}
 [-binary file-name]

Function

This command enables you to perform the following operations:

Start and stop HCSC servers

Obtain the HCSC server setup information and HCSC server information

Start and stop business processes and service adapters, and obtain information

Start and stop standard receptions

Obtain user-defined reception information

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

The following table describes the values to be specified in the -target and -operation options for each operation.

Table 5‒9: Operations that can be performed according to the values in the -target and -operation options

Operations

-target option

-operation option

Starting HCSC servers

server

start

Starting business processes

compo

start

Starting service adapters

compo

start

Starting standard receptions

request_service

start

Stopping standard receptions

request_service

stop

Stopping service adapters

compo

stop

Stopping business processes

compo

stop

Stopping HCSC servers

server

stop

Obtaining the HCSC server setup information

server

get_setup_info

Obtaining the HCSC server information

server

get_info

Obtaining the business process information

compo

get_bp_info

Obtaining the service adapter information

compo

get_adapter_info

Obtaining the user-defined reception information

compo_urecp

get_info

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-mng Manager-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the identifier name for Manager. Specify the name of Manager existing in the repository.

-host host-name-or-IP-address: port-number ~ <Host name or IP address: character string, port number: numeric string> ((character string: at least 1 character, port number: 1 to 65535))

Specifies the host name (or IP address) and the port number of the Manager remote management function concatenated with colons (:). The IP address and the port number cannot be simultaneously omitted.

You can specify the -host option even if the repository does not exist. When you specify the -host option, specify the options -mnguser and -mngpass.

-mnguser Management-user-ID ~ ((at least 1 character))

Specifies the management user ID of Manager.

-mngpass Management-user-password ~ ((at least 1 character))

Specifies the password for the management user ID of Manager. You can specify this option only when a password has been set for the Manager user ID you intend to change.

-target {server|compo|compo_urecp|request_service}

Specifies the target of the operations to be executed.

server

Specifies an HCSC server as the target of the operations to be executed.

compo

Specifies a business process or a service adapter as the target of the operations to be executed.

compo_urecp

Specifies a user-defined reception as the target of the operations to be executed.

request_service

Specifies a standard reception as the target of the operations to be executed.

-operation {start|stop|get_setup_info|get_info|get_bp_info|get_adapter_info}

Specifies the operations to be executed.

start

Specify this option to start the specified operation target.

stop

Specify this option to stop the specified operation target.

get_setup_info

Specify this option to obtain the setup information for the specified HCSC server.

get_info

Specify this option to obtain the information for the specified HCSC server.

get_bp_info

Specify this option to obtain the information for the specified business process.

get_adapter_info

Specify this option to obtain the information for the specified service adapter.

-props property ~ ((0 or more characters))

Specifies the properties for the specified -target (operation target) and -operation (operations) options in the key-value=specified-value format. Enclose the specified value within double quotation marks (").

However, do not specify the following characters in the key values and specified values. If such characters are specified, the operations become uncertain.

Double quotation mark (")

Equal sign (=)

Comma (,)

Also, to specify multiple arguments, demarcate the arguments with commas (,).

(Example) -props "J2EESrvName=name-of-J2EE-server-on-which-HCSC-server-is-set-up, CSCSrvName=name-of-HCSC-server-to-be-started"

The following table describes the specifications in the -target, -operation, and -props options appropriate for the operations.

Table 5‒10: Specifications in the -target (operation target), -operation (operations), and -props options appropriate for the operations

Operation

-target

-operation

Property specified with -props

Starting HCSC servers

server

start

J2EESrvName = Name of the J2EE server on which the HCSC server is set up

CSCSrvName = Name of the HCSC server to be started

Starting business processes

compo

start

AdapterName = Service ID of the business process to be started

ServiceKind = Adapter type

bp: Business process

J2EESrvName = Name of the J2EE server on which the adapter will be started

CSCSrvName = Name of the HCSC server on which the adapter will be started

Starting service adapters

compo

start

AdapterName = Service ID of the service adapter to be started

ServiceKind = Adapter type

serviceAdapter: Service adapter

J2EESrvName = Name of the J2EE server on which the adapter will be started

CSCSrvName = Name of the HCSC server on which the adapter will be started

Starting standard receptions

request_service

start

J2EESrvName = Name of the J2EE server on which the HCSC server is running

CSCSrvName = Name of the HCSC server that can receive requests

Stopping standard receptions

request_service

stop

J2EESrvName = Name of the J2EE server to be imported

CSCSrvName = Name of the HCSC server for which requests will be controlled

ForceFlag = Forced termination flag

NORMAL_OPTION: Normal termination

WAIT_OPTION: Planned termination

FORCE_OPTION: Forced termination

Stopping service adapters

compo

stop

J2EESrvName = Name of the J2EE server for which the adapter will be stopped

CSCSrvName = Name of the HCSC server for which the adapter will be stopped

AdapterName = Service ID of the service adapter to be stopped

Stopping business processes

compo

stop

J2EESrvName = Name of the J2EE server for which the adapter will be stopped

CSCSrvName = Name of the HCSC server for which the adapter will be stopped

AdapterName = Service ID of the business process to be stopped

Stopping HCSC servers

server

stop

J2EESrvName = Name of the J2EE server on which the HCSC server is set up

CSCSrvName = Name of the HCSC server to be stopped

ForceFlag = Forced termination flag

false: Normal termination

true: Forced termination

Obtaining the HCSC server setup information

server

get_setup_info

CSCSrvName = Name of the HCSC server

Obtaining the HCSC server information

server

get_info

CSCSrvName = Name of the HCSC server for which the status is to be displayed

Obtaining the business process information

compo

get_bp_info

CSCSrvName = Name of the HCSC server

AdapterName = Service ID of the business process

Obtaining the service adapter information

compo

get_adapter_info

CSCSrvName = Name of the HCSC server

AdapterName = Service ID of the service adapter

Obtaining the user-defined reception information

compo_urecp

get_info

CSCSrvName = Name of the HCSC server for which the user-defined reception information is to be obtained

-propfile property-file-name ~ ((1 to 200 bytes))

Specifies the name of the property file containing arguments, expressed as an absolute or relative path. Specify the property file name in the J2SE property file format.

-binary file-name ~ ((1 to 200 bytes))

Specifies the name of the binary file, expressed as an absolute or relative path. This option is defined for further use.

Examples of input

(1) To start the HCSC server HCSC

cscutil -user admin -pass admin -mng Manager -target server -operation start -props "CSCSrvName=HCSC, J2EESrvName=J2EEServer"

(2) To start the HCSC server HCSC by using the property file cscutil.properties

cscutil -user admin -pass admin -host 10.209.13.165:9001 -mnguser admin -mngpass admin -target server -operation start -propfile cscutil.properties

Contents of cscutil.properties

 CSCSrvName=HCSC
 J2EESrvName=J2EEServer

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

2

A communication timeout occurred.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

When you execute the cscutil command, you can concurrently execute multiple referencing functions (such as referencing the HCSC server information).

Only one operating function (such as starting an HCSC server or stopping a service adapter) can be executed at a time.

csmftpaddusr (Registering and updating FTP inbound adapter users)

Format

csmftpaddusr -usr user-name
 -pass password
 [-r]

Function

Registers a user in an FTP inbound adapter. If a user is already registered, this command updates the password.

For details on how to use this command, see 5.4.12 Checking and confirming the user information of the FTP inbound adapter in the uCosminexus Service Platform Setup and Operation Guide.

Arguments

-usr user-name ~ <one-byte alphanumeric characters and one-byte symbols> ((1 to 80 characters))

Specifies the name of the user to be registered or updated. You cannot register a user whose user name is not specified (anonymous user).

You can specify one-byte alphanumeric characters, one-byte symbols (0x21 to 0x7E in ASCII encoding), and one-byte spaces (0x20 in ASCII encoding). The characters are case sensitive. The available one-byte symbols are as follows:

Exclamation mark (!)

Double quotation mark (")

Hash mark (#)

Dollar sign ($)

Percent sign (%)

Ampersand (&)

Apostrophe mark (')

Left parenthesis (()

Right parenthesis ())

Plus sign (+)

Hyphen (-)

Period (.)

Forward slash (/)

Colon (:)

Semicolon (;)

Left angle bracket (<)

Right angle bracket (>)

Equal sign (=)

Question mark (?)

At mark (@)

Left square bracket ([)

Right square bracket (])

Yen sign (\)

Caret (^)

Underscore (_)

Grave accent mark (`)

Left curly bracket ({)

Right curly bracket (})

Vertical bar (|)

Swung dash (~)

-pass password ~ <one-byte alphanumeric characters and one-byte symbols> ((1 to 80 characters))

Specifies the password for the user name to be registered or updated. You can specify one-byte alphanumeric characters, one-byte symbols (0x21 to 0x7E in ASCII encoding), and one-byte spaces (0x20 in ASCII encoding). The alphabetic characters are case sensitive. The available one-byte symbols are the same as those for the -usr option.

To change the password (when the -r option is specified), specify the new password.

-r

Specify this option to change the password of the user ID that is already registered.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

You can register a maximum of 2,048 users.

Execute the command when the FTP inbound adapter is not running.

You can execute the command irrespective of the status of the HCSC server.

The content executed by the command (registering and updating a user) takes effect after the FTP inbound adapter starts. Also, if you execute the command when the FTP inbound adapter is running, the content executed by the command (registering and updating a user) takes effect after the FTP inbound adapter starts the next time.

An error occurs in the following cases:

When a user is being registered, updated, deleted, and displayed

When a user other than the System Administrator attempts to execute the command

csmftpdelusr (Deleting FTP inbound adapter users)

Format

csmftpdelusr -usr user-name

Function

Deletes a user registered in the FTP inbound adapter.

For details on how to use this command, see 5.4.12 Checking and confirming the user information of the FTP inbound adapter in the uCosminexus Service Platform Setup and Operation Guide.

Arguments

-usr user-name ~ <one-byte alphanumeric characters and one-byte symbols> ((1 to 80 characters))

Specifies the name of the user to be deleted. You can specify one-byte alphanumeric characters, one-byte symbols (0x21 to 0x7E in ASCII encoding), and one-byte spaces (0x20 in ASCII encoding). The alphabetic characters are case sensitive. The available one-byte symbols are as follows:

Exclamation mark (!)

Double quotation mark (")

Hash mark (#)

Dollar sign ($)

Percent sign (%)

Ampersand (&)

Apostrophe mark (')

Left parenthesis (()

Right parenthesis ())

Plus sign (+)

Hyphen (-)

Period (.)

Forward slash (/)

Colon (:)

Semicolon (;)

Left angle bracket (<)

Right angle bracket (>)

Equal sign (=)

Question mark (?)

At mark (@)

Left square bracket ([)

Right square bracket (])

Yen sign (\)

Caret (^)

Underscore (_)

Grave accent mark (`)

Left curly bracket ({)

Right curly bracket (})

Vertical bar (|)

Swung dash (~)

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

Execute the command when the FTP inbound adapter is not running.

You can execute the command irrespective of the status of the HCSC server.

The content executed by the command (deleting a user) takes effect after the FTP inbound adapter starts. Also, if you execute the command when the FTP inbound adapter is running, the content executed by the command (deleting a user) takes effect after the FTP inbound adapter starts the next time.

An error occurs in the following cases:

When a user is being registered, updated, deleted, and displayed

When a user other than the System Administrator attempts to execute the command

csmftplsusr (Displaying the FTP inbound adapter users)

Format

csmftplsusr

Function

Displays the users registered in the FTP inbound adapter. The display results are output to the standard output.

For details on how to use this command, see 5.4.12 Checking and confirming the user information of the FTP inbound adapter in the uCosminexus Service Platform Setup and Operation Guide.

Display format

1: User ID 1

2: User ID 2

3: User ID 3

...

This command displays one user name on one line.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

Execute the command when the FTP inbound adapter is not running.

You can execute the command irrespective of the status of the HCSC server.

An error occurs in the following cases:

When a user is being registered, updated, deleted, and displayed

When a user other than the System Administrator attempts to execute the command

csmftplshistory (Displaying the transmission log)

Format

csmftplshistory J2EE-server-name
 [-csv output-file-path]
 [-date display-start-date-and-time,display-end-date-and-time]

Function

Displays the transmission log.

For details on how to use this command, see 5.4.18 Acquiring the transfer history in the uCosminexus Service Platform Setup and Operation Guide.

Arguments

J2EE-server-name

Specifies the name of the J2EE server specified when HCSC starts.

If you specify the name of a J2EE server, for which the setup has been removed, the transmission log that is already collected by this J2EE server is displayed.

-csv output-file-path

Outputs the transmission log to a CSV file. Specify the output file path as an absolute or relative path. However, in Windows, you cannot specify a relative path with a drive letter (example: C:temp\history.csv). If this option is omitted, the transmission log is output to the standard output.

-date display-start-date-and-time,display-end-date-and-time

Specify this option when the transmission command start date and time outputs only the transmission log from the display start date and time to the display end date and time.

Specify the display start date and time and the display end date and time in the following format:

Display start date and time: Specify the date and time in the YYYYMMDDhhmmss format.

Display end date and time: Specify the date and time in the YYYYMMDDhhmmss format.

YYYY: Year (1970 YYYY)

MM: Month (01 MM 12)

DD: Date (01 DD 31)

hh: Hours (00 hh 23)

mm: Minutes (00 mm 59)

ss: Seconds (00 ss 59)

In the display end date and time, if you specify a value that is older than the display start date and time, nothing is displayed. Also, if the transmission command start date and time is not stored in the transmission log due to reasons such as the abnormal termination of the transmission processing, that transmission log is not displayed.

Output format

Example of output in the CSV format

The name of the output item is output in the first line and the transmission log for one time is output on one line.

TransferID UserName ServerFileName...ClientPort
10.209.12.111/2200/0x00000000000000c7 admin /service1/file1...1071
10.209.12.111/2200/0x00000000000000c8 admin /service1/file2...1072
 ...

Example of output to the standard output

TransferID :10.209.12.111/2200/0x00000000000000c7
UserName :admin
ServerFileName :/service1/file1
TransferType :RETR
TransferMode :ASCII
CompressionMode :uncompress
Status :SUCCESS
TransferCmdStartTime :2010/07/22 19:00:00.000
TransferCmdEndTime :2010/07/22 19:00:02.000
TransferCmdTime :2.000
TransferStartTime :2010/07/22 19:00:01.000
TransferEndTime :2010/07/22 19:00:02.000
TransferTime :1.000
TransferSize :1024
ClientIP :10.209.12.110
ClientPort :1071
 ...

Description

Display item

Description

TransferID

Indicates a unique number for each transmission. This forms the PRF root application information.

The ID is displayed in the format xxx.xxx.xxx.xxx/aaa/bbb.

xxx.xxx.xxx.xxx: IP address of the root application

aaa: Process ID of the root application

bbb: Root communication number

UserName

Indicates the name of an authenticated user.

ServerFileName

Indicates the server file name for which a transmission has been requested from the client.

The name is displayed in the format /assigned-identifier/file-name.

TransferType

Indicates the transfer type. One of the following is displayed:

RETR: Transmission of files from the server to the client

STOR: Transmission of files from the client to the server

APPE: Transmission of files from the client to the server (additional writing to a file on the server)

TransferMode

Indicates the transmission mode specified for the transmission request.

ASCII: ASCII mode

BINARY: BINARY mode

CompressionMode

Indicates the compression mode specified for the transmission request.

compress: Compress

uncompress: Uncompress

unknown: Data connection failed to open

Status

Indicates the end status of file transmission.

SUCCESS: File transmission is successful

FAILURE: File transmission failed

TransferCmdStartTime

Indicates the time at which the transmission command was received and the transmission command processing started.

The time is displayed in the format YYYY/MM/DD HH:MM:SS.mmm.

YYYY: Year

MM: Month

DD: Date

HH: Hours

MM: Minutes

SS: Seconds

mmm: Milliseconds

*****: An error occurred before the processing of the transmission command started

TransferCmdEndTime

Indicates the time at which the processing of the transmission command ended.

The time is displayed in the format YYYY/MM/DD HH:MM:SS.mmm.

YYYY: Year

MM: Month

DD: Date

HH: Hours

MM: Minutes

SS: Seconds

mmm: Milliseconds

TransferCmdTime

Indicates the total time required for the processing of the transmission command.

The time is displayed in the format ss.SSS.

ss: Seconds

SSS: Milliseconds

*****: An error occurred before the processing of the transmission command started

TransferStartTime

Indicates the time at which the file transmission started.

The time is displayed in the format YYYY/MM/DD HH:MM:SS.mmm.

YYYY: Year

MM: Month

DD: Date

HH: Hours

MM: Minutes

SS: Seconds

mmm: Milliseconds

*****: An error occurred before the transmission started

TransferEndTime

Indicates the time at which the file transmission ended.

The time is displayed in the format YYYY/MM/DD HH:MM:SS.mmm.

YYYY: Year

MM: Month

DD: Date

HH: Hours

MM: Minutes

SS: Seconds

mmm: Milliseconds

*****: Transmission failed

TransferTime

Indicates the total time required for the file transmission.

The time is displayed in the format ss.SSS.

ss: Seconds

SSS: Milliseconds

*****: Transmission failed

TransferSize

Indicates the data size of the transmitted file in bytes.

If the transmission fails, -1 is displayed.

ClientIP

Indicates the IP address of the client that requested the transmission.

ClientPort

Indicates the port number of the client that requested the transmission.

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

3

An exclusion error occurred.

9

An error occurred when checking the execution permission.

Notes

You can execute the command irrespective of the status of the HCSC server.

You can execute the command irrespective of the status of the FTP inbound adapter.

An error occurs when a user other than the System Administrator attempts to execute the command.

csmmailaddusr (Registering and updating the mail adapter user information)

Format

csmmailaddusr [-h]
 -user login-user-name
 -pass login-password
 [-r]
 -f path-of-mail-adapter-account-definition-file

Function

Registers a user in the mail adapter account definition file. If a user is already registered, this command updates the password.

For details on how to use this command, see 5.5.1 Managing the user information in the uCosminexus Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-name ~ <one-byte alphanumeric characters and one-byte symbols>

Specifies the name of the user to be registered or updated.

You can specify one-byte alphanumeric characters, one-byte symbols (0x21 to 0x7E in ASCII encoding), and one-byte spaces (0x20 in ASCII encoding). The characters are case sensitive. The available one-byte symbols are as follows:

Exclamation mark (!)

Double quotation mark (")

Hash mark (#)

Dollar sign ($)

Percent sign (%)

Ampersand (&)

Apostrophe mark (')

Left parenthesis (()

Right parenthesis ())

Asterisk (*)

Plus sign (+)

Comma (,)

Hyphen (-)

Period (.)

Forward slash (/)

Colon (:)

Semicolon (;)

Left angle bracket (<)

Right angle bracket (>)

Equal sign (=)

Question mark (?)

At mark (@)

Left square bracket ([)

Right square bracket (])

Yen sign (\)

Caret (^)

Underscore (_)

Grave accent mark (`)

Left curly bracket ({)

Right curly bracket (})

Vertical bar (|)

Swung dash (~)

-pass login-password ~ <one-byte alphanumeric characters and one-byte symbols>

Specifies the password for the user name to be registered or updated. You can specify one-byte alphanumeric characters, one-byte symbols (0x21 to 0x7E in ASCII encoding), and one-byte spaces (0x20 in ASCII encoding). The characters are case sensitive. The available one-byte symbols are the same as those for the -user option.

To change the password (when the -r option is specified), specify the new password.

-r

Specify this option to change the password of an already registered user.

-f path-of-mail-adapter-account-definition-file

Specifies the relative or absolute path of the mail adapter account definition file. To include spaces, enclose the entire option argument in double quotation marks (").

A mail adapter account definition file is created if the file does not exist already. However, if the directory does not exist, an error occurs. To add the user information to an existing mail adapter account definition file, specify the existing mail adapter account definition file.

Examples of input

(1) To register the user name user2 and the password password2 in the mail adapter account definition file account.properties

csmmailaddusr -user user2 -pass password2 -f account.properties

(2) To update the password for the user name user2 registered in the mail adapter account definition file account.properties to passwordnew

csmmailaddusr -user user2 -pass passwordnew -r -f account.properties

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

9

An error occurred when checking the execution permission.

Notes

You can register any number of users.

You cannot edit the mail adapter account definition file.

Before you execute the command, specify Access Permission so that only the Administrator executing the command can update and reference the mail adapter account definition file.

csmmaildelusr (Deleting the mail adapter user information)

Format

csmmaildelusr [-h]
 -user login-user-name
 -f path-of-mail-adapter-account-definition-file

Function

Deletes the user information registered in the mail adapter account definition file.

For details on how to use this command, see 5.5.1 Managing the user information in the uCosminexus Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-name ~ <one-byte alphanumeric characters and one-byte symbols>

Specifies the name of the user to be deleted. You can specify one-byte alphanumeric characters, one-byte symbols (0x21 to 0x7E in ASCII encoding), and one-byte spaces (0x20 in ASCII encoding). The characters are case sensitive. The available one-byte symbols are as follows:

Exclamation mark (!)

Double quotation mark (")

Hash mark (#)

Dollar sign ($)

Percent sign (%)

Ampersand (&)

Apostrophe mark (')

Left parenthesis (()

Right parenthesis ())

Asterisk (*)

Plus sign (+)

Comma (,)

Hyphen (-)

Period (.)

Forward slash (/)

Colon (:)

Semicolon (;)

Left angle bracket (<)

Right angle bracket (>)

Equal sign (=)

Question mark (?)

At mark (@)

Left square bracket ([)

Right square bracket (])

Yen sign (\)

Caret (^)

Underscore (_)

Grave accent mark (`)

Left curly bracket ({)

Right curly bracket (})

Vertical bar (|)

Swung dash (~)

-f path-of-mail-adapter-account-definition-file

Specifies the relative or absolute path of the mail adapter account definition file. To include spaces, enclose the entire option argument in double quotation marks (").

Example of input

To delete the user information for the user name user2 registered in the mail adapter account definition file account.properties:

csmmaildelusr -user user2 -f account.properties

The content of the mail adapter account definition file changes as follows depending on the execution of the command for deleting the user information:

[Before executing the command]

1: user1
2: user2
 ...
 ...

[After executing the command]

1: user1
 ...
 ...

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

9

An error occurred when checking the execution permission.

Notes

You cannot edit the mail adapter account definition file.

The mail adapter account definition file is not deleted even if there is no user information in the mail adapter account definition file.

Before you execute the command, specify Access Permission so that only the Administrator executing the command can update and reference the mail adapter account definition file.

csmmaillsusr (Displaying the mail adapter user information)

Format

csmmaillsusr [-h]
 -f path-of-mail-adapter-account-definition-file

Function

Displays the users registered in the mail adapter account definition file. The display results are output in the standard output format.

For details on how to use this command, see 5.5.1 Managing the user information in the uCosminexus Service Platform Setup and Operation Guide.

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-f path-of-mail-adapter-account-definition-file

Specifies the relative or absolute path of the mail adapter account definition file. To include spaces, enclose the entire option argument in double quotation marks (").

Display format

(1) When the user information is registered

1: User ID1
2: User ID2
 ...

One user name is displayed on each line in alphabetic order.

(2) When the user information is not registered

none

Return values

Return value

Meaning

0

The command terminated normally.

1

The command terminated abnormally.

9

An error occurred when checking the execution permission.

Notes

You cannot edit the mail adapter account definition file.

Before you execute the command, specify Access Permission so that only the Administrator executing the command can update and reference the mail adapter account definition file.

6 Definition Files (Operating and Execution Environments)

This chapter describes the syntax of the definition files that are used in the operating and execution environments of a service platform.

6.1 Types of definition files

The following table lists and describes the types of definition files for the operating and execution environments.

Table 6‒1: List of definition files (operating and execution environments)

Classification

File name

Overview

Files used for setting up HCSC servers

cscsetup command definition file

Specifies the information required for executing the cscsetup command.

HCSC server configuration definition file

Specifies the configuration definition for HCSC servers.

HCSC server setup definition file

Sets up the information that can be specified for setting up HCSC servers.

Files used for HCSC server operations

HCSC-Manager command definition file for Java VM start options

Specifies the Java VM start options that are applied when executing a command. This file is applicable to commands beginning with csc.

HCSC-Manager command definition file

Defines the default values of options for each command.

HCSC-Manager definition file

Specifies the information required for operating HCSC-Manager.

HCSC-Messaging command definition file

Specifies the information required for executing HCSC-Messaging commands.

HCSC component-specification file

Specifies HCSC components and the processing information.

HCSC server runtime definition file

Specifies the definition information for a set up HCSC server from HCSC-Manager.

Definition file for emulated configuration information

Specifies the configuration information for the service emulation function in XML format.

Component-ID configuration file

Specifies whether to output user message traces based on HCSC component IDs.

Component-type configuration file

Specifies the types of HCSC components for which user message traces are output.

Service-information change definition file

Specifies the changes in the service information of a service adapter.

Files used for SOAP integration

SOAP fault operation definition file

Sets up the targetNamespace URI.

User-defined reception runtime definition file

Specifies the information for SOAP receptions.

Files used for TP1 integration

TP1-adapter runtime-environment property file

Sets up the TP1/Client/J environment definition file used to operate the TP1 adapter in the execution environment.

Files used for FTP integration

FTP adapter account definition file

Manages the user account information in a batch. Manages the FTP adapter account definition file with operation commands.

FTP adapter command definition file

Specifies the configuration information for the message log of the commands used with FTP adapters.

FTP-adapter runtime-environment property file

Specifies the configuration information for each FTP adapter.

FTP reception configuration file

Specifies the information for the settings that are changed frequently after an FTP reception is set up.

FTP command authorization list definition file

Specifies the FTP commands that can be executed before and after the transmission and before and after the execution of list commands.

FTP execution authorization list definition file

Specifies the users who are allowed and the users who are not allowed to execute the FTP reception-related business processes.

File operations adapter runtime-environment property file

Specifies information such as the output levels of the message and trace logs when the file operations adapter is operated in the execution environment.

List command options definition file

Sets up the option strings that can be specified in the arguments of the list commands executed by an FTP client.

Files used for file event linkage

File-event-reception configuration file

Specifies the configuration information for a specific file event reception.

File-event-reception common configuration file

Specifies the configuration information that is common to all file event receptions.

Files used with the file adapter

File adapter runtime-environment property file

Specifies information such as the output levels of the message and trace logs when the file adapter is operated in the execution environment.

Files used with the Object Access adapter

Object Access adapter runtime-environment property file

Specifies information such as the log and trace output levels when the Object Access adapter is operated in the execution environment.

Files used with the Message Queue adapter

Message Queue adapter runtime-environment property file

Specifies information such as the log and trace output levels when the Message Queue adapter is operated in the execution environment.

Files used with the mail adapter

Mail adapter account definition file

Manages the user account information in a batch. Manages the mail adapter account definition file with operation commands.

Mail adapter command definition file

Specifies the output information for the message log of the commands used with mail adapters.

Mail adapter runtime environment property file

Specifies the configuration information for each mail adapter.

Mail header definition file

Specifies options for any user-defined mail headers.

Files used with the HTTP adapter

HTTP-adapter runtime-environment property file

Specifies the configuration information for each HTTP adapter.

HTTP-adapter runtime-environment common property file

Specifies the configuration information that is common to all HTTP adapters.

Files used with command adapters

Command-execution permission definition file

Specifies the external commands that can be executed by command adapters.

Process environment-variable definition file

Specifies the environment variables that are valid only in external command processes.

Command-adapter runtime-environment properties file

Specifies the configuration information for each command adapter.

Command-adapter runtime-environment common properties file

Specifies the configuration information that is common to all command adapters.

Files used with SFTP adapters

SFTP-adapter runtime-environment properties file

Specifies the configuration information for each SFTP adapter.

SFTP-adapter runtime-environment common properties file

Specifies the configuration information that is common to all SFTP adapters.

6.2 Input format of definition files

Create or edit the definition files listed in Table 6-1 List of definition files (operating and execution environments) in the following input formats:

Input format of the HCSC server configuration definition file

The HCSC server configuration definition file is in the XML format. Create or edit this file according to the XML specifications.

Input format of the HCSC-Manager command definition file for Java VM start options

The HCSC-Manager command definition file for Java VM start options can be created and edited according to the following file format:

In Windows: Win32 batch file format

In UNIX: Shell-script file format

Input format of the SOAP fault operation definition file

The SOAP fault operation definition file has a unique format. Create of edit this file according to the specifications of the SOAP fault operation definition file.

Input format of the list command options definition file

The list command options definition file has a unique format. Create or edit this file according to the specifications in the list command options definition file.

Input format of other definition files

Definition files other than the above can be created or edited in the following Java property file format.

Format

The input format of definition files is as follows:

key-name = value

#comment

The following is the description of each of these items.

Key name

Specifies the key name to be defined.

If the same key is specified multiple times in a definition file, the value of the key specified at the end is applied based on the specifications for the java.util.Properties class.

When you omit the specified value, make sure that you omit the key name as well. You cannot code only the key name.

Delimiter

Specify an equal sign (=) as the delimiter. A space or a tab can also be used instead of an equal sign.

Value

Specified when the value to be defined exists. The string up to the linefeed is considered as a value, so you cannot specify strings such as spaces or comments after the value.

Comment

A line that starts with a hash mark (#) or an exclamation mark (!) is treated as a comment.

Use the ISO-8859-1 character encoding for each of these items. If you code characters that cannot be directly expressed with the ISO-8859-1 character encoding, convert the characters to Unicode by using the following hjdk.native2ascii.jar tool.

service-platform-installation-directory\jdk\bin\java -jar service-platform-installation-directory\jdk\lib\hcompatlib\hjdk.native2ascii.jar input-file-path output-file-path

For details about the hjdk.native2ascii.jar tool, see the JDK documentation.

6.3 Format for describing the definition file syntax

This chapter describes the syntax of definition files coded hereafter in the following format. Note that not all the files are coded in the following format. In addition to the following items, the information specific to individual files might also be provided.

Format

Indicates the format for describing a file.

Function

Describes the functionality of a file.

DTD

Describes Document Type Definition (DTD) of a file.

File storage location

Indicates the location where a file is stored.

Specifiable elements

Describes the XML elements that can be specified in a file.

Specifiable parameters

Describes the parameters that can be specified in a file.

Specifiable properties

Describes the properties that can be specified in a file. Italic characters in a property name indicate variables.

Example of coding

Indicates a coding example for the file contents.

Usage

Describes how to use a file.

Notes

Provides notes on setting up and using a file.

The following table lists and describes the symbols used for syntax explanations in this chapter:

Symbol

Meaning

|

In syntax explanations, a vertical bar separates multiple items, and has the meaning of OR.

For example: A|B means A or B.

{ }

In syntax explanations, curly brackets indicate that only one of the enclosed items is to be selected. If the items are arranged horizontally and separated by a vertical bar (|), select one of the items.

For example: {A|B|C} means only one of A, or B, or C.

[ ]

In syntax explanations, square brackets indicate that the enclosed item or items are optional.

For example: [A] means that you can specify A or nothing.

...

In coding, an ellipsis (...) indicates that one or more lines of coding have been omitted.

For example: ABC... means that the coding after ABC has been omitted.

~

In syntax explanations, a swung dash ( ~) indicates that the items preceding the swung dash comply with the rules mentioned in < >, (()), and << >> following the swung dash.

< >

In syntax explanations, angle brackets indicate the syntax elements that must be complied with when the items are coded. For details on syntax elements, see the following table.

(())

In syntax explanations, double parentheses indicate the range of values that you can specify for an item.

<< >>

In syntax explanations, double angle brackets indicate the default value that the system assumes when an item is omitted.

The following table lists the types and definitions of the syntax elements used in this chapter:

Type

Definition

Alphabetic characters

A to Z, a to z

Lowercase alphabetic characters

a to z

Uppercase alphabetic characters

A to Z

Numeric characters

0 to 9

Alphanumeric characters

A to Z, a to z, 0 to 9

Symbols

_, ., -

Character string

An array of strings

6.4 Files used for configuring HCSC servers

6.4.1 cscsetup command definition file

(1) Format

owner=Owner-set-by-Component-Container-Administrator
group=Group-set-by-Component-Container-Administrator

(2) Function

Specifies the information required for operating the cscsetup command. This definition file is used for easy setup of the HCSC production environment. This definition file is valid only for UNIX.

(3) File storage location

Template file (SOAP1.1 mode)

service-platform-installation-directory\CSC\config\manager\templates\hsetup\esb\cscsetup.properties

Template file (SOAP1.1/1.2 combined mode)

service-platform-installation-directory\CSC\config\manager\templates\hsetup\esb_1.1_1.2mode\cscsetup.properties

Important note

The stored file becomes the template file. After copying the template file to any directory, edit the template file and then create the definition file.

(4) Specifiable parameters

owner=owner-set-by-Component-Container-Administrator ~ <<superuser>>

Specifies the owner set by Component Container Administrator.

group=group-set-by-Component-Container-Administrator ~ <<superuser>>

Specifies the primary GID set by Component Container Administrator.

(5) Notes

If you do not specify the values for the owner and the group, the following values become the default values. To perform operations by changing to any Component Container Administrator, specify the owner and the group in this definition file.

In Linux(R)

Owner: root, Group: root

In AIX

Owner: root, Group: system

6.4.2 HCSC server configuration definition file

(1) Format

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE csc-setup-definition SYSTEM "cscsvsetup_1_3.dtd">
<!-- All Rights Reserved. Copyright (C) 2006, 2008, Hitachi, Ltd. -->
<csc-setup-definition>
 <cluster>
 <name>cluster-name</name>
 <type>cluster-type</type>
 </cluster>
 <cosminexus-manager>
 <!-- Cosminexus Manager Definition -->
 <name>Manager-name</name>
 <ip-address>IP-address-or-host-name-of-Manager</ip-address>
 <port>Port-number-of-Manager</port>
 <id>Management-Server-management-user-ID</id>
 <password>Management-Server-management-user-password</password>
 <csc-server>
 <!-- HCSC-Server Definition -->
 <name>HCSC-server-name</name>
 <id>user-ID-of-database-used-by-HCSC-server</id>
 <password>password-of-database-used-by-HCSC-server</password>
 <j2ee-server-name>name-of-J2EE-server-used-by-HCSC-server</j2ee-server-name>
 <setup-properties>HCSC-server-setup-definition-file-name</setup-properties>
 </csc-server>
 </cosminexus-manager>
 <reception>
 <soap-reception>
 <!-- WebServer Definition -->
 <ip-address>IP-address-or-host-name-of-Web-server</ip-address>
 <port>port-number-of-Web-server</port>
 <protocol>protocol-type</protocol>
 </soap-reception>
 <jms-reception>
 <!-- WebServer Definition-->
 <ip-address>IP-address-or-host-name-of-Web-server</ip-address>
 <port>port-number-of-Web-server</port>
 <protocol>protocol-type-(http-or-https)</protocol>
 <rm-service-context-root>service-context-root-for-RM</rm-service-context-root>RM-service-name
 </jms-reception>
 <jms-physical-reception>
 <!-- WebServer Definition-->
 <ip-address>IP-address-or-host-name-of-Web-server</ip-address>
 <port>port-number-of-Web-server</port>
 <protocol>protocol-type</protocol>
 <rm-service-context-root>service-context-root-for-RM</rm-service-context-root>
 </jms-physical-reception>
 <ejb-reception>
 <!-- NameServer Definition-->
 <ip-address>IP-address-or-host-name-of-NameServer</ip-address>
 <port>port-number-of-NameServer</port>
 </ejb-reception>
 </reception>
</csc-setup-definition>

(2) Function

Specifies the configuration information for HCSC servers.

(3) DTD

<!ELEMENT csc-setup-definition (cluster?,cosminexus-manager,reception?)>
<!ELEMENT cluster (name?,display-name?,type?)>
<!ELEMENT name (#PCDATA)>
<!ELEMENT display-name (#PCDATA)>
<!ELEMENT type (#PCDATA)>
<!ELEMENT cosminexus-manager (name,display-name?,ip-address,port,id,password?,csc-server)>
<!ELEMENT ip-address (#PCDATA)>
<!ELEMENT port (#PCDATA)>
<!ELEMENT id (#PCDATA)>
<!ELEMENT password (#PCDATA)>
<!ELEMENT csc-server (name?,display-name?,id?,password?,j2ee-server-name,setup-properties)>
<!ELEMENT j2ee-server-name (#PCDATA)>
<!ELEMENT setup-properties (#PCDATA)>
<!ELEMENT reception (soap-reception?,jms-reception?,jms-physical-reception?,ejb-reception?)>
<!ELEMENT soap-reception (ip-address?,port,protocol)>
<!ELEMENT protocol (#PCDATA)>
<!ELEMENT jms-reception (ip-address?,port,protocol,rm-service-context-root?)>
<!ELEMENT rm-service-context-root (#PCDATA)>
<!ELEMENT jms-physical-reception (ip-address?,port,protocol,rm-service-context-root?)>
<!ELEMENT ejb-reception (ip-address?,port)>

(4) File storage location

service-platform-installation-directory\CSC\config\manager\templates\cscsvsetup.xml

(5) Specifiable elements

(a) Definition of cluster

You can omit the cluster tag.

name cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the cluster name. By setting up this tag, you can omit the -cluster option of the cscsvsetup command.

type cluster-type ~ <<LB>>

Specifies one of the following as the cluster type. You can omit this value in a load-balancing cluster configuration. Make sure that the value is specified in uppercase.

LB

Specify this value in a load-balancing cluster configuration.

HA

Specify this value in an HA cluster configuration.

(b) Definition of cosminexus-manager

name Manager-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies a unique identifier name for HCSC-Manager so that HCSC-Manager recognizes Manager. Specify a unique identifier name for each Manager (host) in HCSC-Manager.

ip-address IP-address-or-host-name-of-Manager ~ ((at least 1 character))

Specifies the IP address or the host name on which Management Server is running. From the second time onwards, the value gets overwritten if you change the settings and perform a re-setup.

port Port-number-of-Manager ~ ((1 to 65535))

Specifies the port number for connecting to the remote management function of Management Server.

Specifies the value of com.cosminexus.mngsvr.management.port. If no value is specified, specify 28099. From the second time onwards, the value gets overwritten if you change the settings and perform a re-setup.

id Management-Server-management-user-ID ~ ((at least 1 character))

Specifies the management user ID for Management Server.

password Management-Server-management-user-password ~ ((at least 1 character))

Specifies the management user password for Management Server. You can omit this tag. If the tag is omitted, the system assumes that no password is specified.

(c) Definition of csc-server

name HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the HCSC server. By setting up this tag, you can omit the -csc option of the cscsvsetup command.

id user-ID-of-database-used-by-HCSC-server ~ ((at least 1 character))

Specifies the user ID of the database used by the HCSC server. The maximum string value and the specifiable characters depend on the database to be used. Make sure that you set up this element when you use a database. If no database is used, you can omit this element.

password password-of-database-used-by-HCSC-server

Specifies the password of the database used by the HCSC server. The maximum string value and the specifiable characters depend on the database to be used. Make sure that you set up this element when you use a database. If no database is used, you can omit this element.

j2ee-server-name name-of-J2EE-server-used-by-HCSC-server ~ ((at least 1 character))

Specifies the J2EE server name used to set up the HCSC server. We recommend that you use a server name that is 110 bytes or shorter. In an environment in which the local machine has an IPv6 address, if you specify a J2EE server name that contains 111 bytes or more, an error might occur during generation of process instances. In an environment in which this error can occur, specify ON for the short-processid property in the HCSC server runtime definition.

setup-properties HCSC-server-setup-definition-file-name

Specifies the name of the HCSC server setup definition file with a relative or an absolute path.

(d) Definition of soap-reception

Specify this element to invoke synchronous services (Web Services). Omit the soap-reception tag if you do not want to invoke synchronous services (Web Services).

ip-address IP-address-or-host-name-of-Web-server ~ <<the same IP address or host name as Manager>>

Specifies the IP address or the host name on which the Web server is running. You can omit this value if the IP address (or the host name) of the reception and Management Server is the same. From the second time onwards, the value gets overwritten if you change the settings and perform a re-setup.

port port-number-of-Web-server ~ ((1 to 65535))

Specifies the reception port number for the Web server. From the second time onwards, the value gets overwritten if you change the settings and perform a re-setup.

protocol protocol-type

Specifies one of the following as the Web server reception protocols. From the second time onwards, the value gets overwritten if you change the settings and perform a re-setup.

http

Received with HTTP.

https

Received with HTTPS.

(e) Definition of jms-reception

Specify this element when the cluster type is the HA cluster and an asynchronous service (MDB(WS-R)) is to be invoked. You can omit the jms-reception tag if no asynchronous service (MDB(WS-R)) is to be invoked. If the cluster type is a load-balancing cluster, the value is ignored even if specified.

ip-address IP-address-or-host-name-of-Web-server ~ <<the same IP address or host name as Manager>>

Specifies the IP address or the host name on which the Web server is running. You can omit this value if the IP address (or the host name) of the reception and Management Server is the same. From the second time onwards, the value gets overwritten if you change the settings and perform a re-setup.

port port-number-of-Web-server ~ ((1 to 65535))

Specifies the reception port number for the Web server. From the second time onwards, the value gets overwritten if you change the settings and perform a re-setup.

protocol protocol-type

Specifies one of the following as the Web server reception protocols. From the second time onwards, the value gets overwritten if you change the settings and perform a re-setup.

http

Received with HTTP.

https

Received with HTTPS.

rm-service-context-root service-context-root-for-RM ~ ((at least 1 character))

Specifies the service context root name for Reliable Messaging. From the second time onwards, the value gets overwritten if you change the settings and perform a re-setup.

(f) Definition of jms-physical-reception

Specify this element when the cluster type is a load-balancing cluster and an asynchronous service (MDB(WS-R)) is to be invoked. If you do not invoke an asynchronous service (MDB(WS-R)) or do not use Reliable Messaging, you must omit the jms-physical-reception tag. If the cluster type is the HA cluster, the value is ignored even if specified.

ip-address IP-address-or-host-name-of-Web-server ~ <<the same IP address or host name as Manager>>

Specifies the IP address or the host name on which the Web server is running. You can omit this value if the IP address (or the host name) of the reception and Management Server is the same. From the second time onwards, the value gets overwritten if you change the settings and perform a re-setup.

port port-number-of-Web-server ~ ((1 to 65535))

Specifies the reception port number for the Web server. From the second time onwards, the value gets overwritten if you change the settings and perform a re-setup.

protocol protocol-type

Specifies one of the following as the Web server reception protocols. From the second time onwards, the value gets overwritten if you change the settings and perform a re-setup.

http

Received with HTTP.

https

Received with HTTPS.

rm-service-context-root service-context-root-for-RM ~ ((at least 1 character))

Specifies the service context root name for Reliable Messaging. From the second time onwards, the value gets overwritten if you change the settings and perform a re-setup.

(g) Definition of ejb-reception

Specify this element to invoke a SessionBean. If you do not want to invoke a SessionBean, omit the ejb-reception tag.

ip-address IP-address-or-host-name-of-NameServer ~ ((at least 1 character)) <<the same IP address or host name as Manager>>

Specifies the IP address or the host name on which the name server is running. You can omit this value if the IP address (or the host name) of the reception and Management Server is the same. From the second time onwards, the value gets overwritten if you change the settings and perform a re-setup.

port port-number-of-NameServer ~ ((1 to 65535))

Specifies the reception port number for the name server. From the second time onwards, the value gets overwritten if you change the settings and peform a re-setup.

(6) Example of coding

An example of coding of the HCSC server configuration definition file is as follows:

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE csc-setup-definition SYSTEM "cscsvsetup_1_2.dtd">
<!-- All Rights Reserved. Copyright (C) 2006, Hitachi, Ltd. -->
<csc-setup-definition>
 <cluster>
 <name>LB cluster </name>
 <type>LB</type>
 </cluster>
 <cosminexus-manager>
 <!-- Cosminexus Manager Definition -->
 <name>MNG1</name>
 <ip-address>10.209.114.162</ip-address>
 <port>28099</port>
 <id>admin</id>
 <password>admin</password>
 <csc-server>
 <!-- HCSC-Server Definition -->
 <id>admin</id>
 <password>admin</password>
 <j2ee-server-name>LBServer</j2ee-server-name>
 <setup-properties>cscsvsetup.properties</setup-properties>
 </csc-server>
 </cosminexus-manager>
 <reception>
 <soap-reception>
 <!-- WebServer Definition -->
 <ip-address>10.209.15.197</ip-address>
 <port>80</port>
 <protocol>http</protocol>
 </soap-reception>
 <jms-physical-reception>
 <!-- WebServer Definition-->
 <ip-address>10.209.114.162</ip-address>
 <port>80</port>
 <protocol>http</protocol>
 <rm-service-context-root>uCosminexusRM</rm-service-context-root>
 </jms-physical-reception>
 <ejb-reception>
 <!-- NameServer Definition-->
 <ip-address>10.209.114.9</ip-address>
 <port>900</port>
 </ejb-reception>
 </reception>
</csc-setup-definition>

(7) Usage

Specify the HCSC server configuration definition file in an argument of the -propfile option of the cscsvsetup command. For details on how to do this, see 3.1.3 Setting up an HCSC server in the uCosminexus Service Platform Setup and Operation Guide.

6.4.3 HCSC server setup definition file

(1) Format

[db-use={ON|OFF}]
[rm-use={ON|OFF}]
[hcscserver-data-filepath=output-destination-path-storing-System-Administrator-information-for-HCSC-server]

 request-ejb={ON|OFF}
 request-soap={ON|OFF}
 request-jms={ON|OFF}
[request-jms.maxmessage=maximum-number-of-messages-in-standard-asynchronous-reception (MDB(WS-R))-queue]
 request-dbq={ON|OFF}
[request-dbq.maxmessage=maximum-number-of-messages-in-standard-asynchronous-reception (MDB(DBqueue))-queue]
[request-jms-rdarea=RD-area-name-of-standard-asynchronous-reception (MDB(WS-R))]
[request-dbq-rdarea=RD-area-name-of-standard-asynchronous-reception (MDB(DBQueue))]
[request-dbq-maxlen=maximum-length-of-messages-in-standard-asynchronous-reception (MDB(DBQueue))]

[request-userdef-soap={ON|OFF}]

[naming-service-hostname=host-name-of-Naming-Service]
[naming-service-port=port-number-of-Naming-Service]

[rm-systemname=system-name-of-Reliable-Messaging]
[rm-displayname=display-name-of-Reliable-Messaging]

[dbcon-xadisplayname=display-name-of-DB-Connector-for-XATransaction-or-LocalTransaction]
[dbcon-nodisplayname=display-name-of-DB-Connector-for-NoTransaction]

[dbtype={HIRDB|ORACLE11G}]
[jdbc-type={DBPSV|HIRDB-TYPE4|ORACLE-THIN}]
[jdbc-url=database-URL-for-JDBC]
[jdbc-dbhostname=host-name-of-database]
[jdbc-dbconnectinfo=connection-information-of-database]
[db-character-sets={ASCII|Shift_JIS|UTF-8|EUC-JP}]
[db-tbl-split-key={NONE|MONTH}]
[db-tbl-split-corcheck-use={ON|OFF}]

[bp-status-compatible={ON|OFF}]

[bp-invoke-status-compatible={ON|OFF}]

[cscserverinfo-tbl-area=table-area-for-basic-HCSC-information]
[server-trans-tbl-area=table-area-for-HCSC-linkage]
[location-tbl-area=table-area-for-locations]
[routing-tbl-area=table-area-for-routing]
[cv-tbl-area=table-area-for-data-transformation]

[exehistory-tbl-area=table-area-for-execution-log-information]
[exehistory-idx-area=area-for-storing-execution-log-information-table-index]
[process-tbl-area=area-for-storing-PROCESS-table-for-business-process-infrastructure]
[process-idx-area=area-for-storing-index-of-PROCESS-table-for-business-process-infrastructure]
[activity-tbl-area=area-for-storing-ACTIVITY-table-for-business-process-infrastructure]
[activity-idx-area=area-for-storing-index-of-ACTIVITY-table-for-business-process-infrastructure]
[link-tbl-area=area-for-storing-LINK-table-for-business-process-infrastructure]
[link-idx-area=area-for-storing-index-of-LINK-table-for-business-process-infrastructure]
[correlationset-tbl-area=area-for-storing-CORRELATIONSET-table-for-business-process-infrastructure]
[correlationset-idx-area=area-for-storing-index-of-CORRELATIONSET-table-for-business-process-infrastructure]
[string-variable-tbl-area=area-for-storing-STRING-VARIABLE-table-for-business-process-infrastructure]
[string-variable-idx-area=area-for-storing-index-of-STRING-VARIABLE-table-for-business-process-infrastructure]
[numeric-variable-tbl-area=area-for-storing-NUMERIC-VARIABLE-table-for-business-process-infrastructure]
[numeric-variable-idx-area=area-for-storing-index-of-NUMERIC-VARIABLE-table-for-business-process-infrastructure]
[boolean-variable-tbl-area=area-for-storing-BOOLEAN-VARIABLE-table-for-business-process-infrastructure]
[boolean-variable-idx-area=area-for-storing-index-of-BOOLEAN-VARIABLE-table-for-business-process-infrastructure]
[message-variable-tbl-area=area-for-storing-MESSAGE-VARIABLE-table-for-business-process-infrastructure]
[message-variable-idx-area=area-for-storing-index-of-MESSAGE-VARIABLE-table-for-business-process-infrastructure]
[message-variable-val-area=area-for-storing-VariableValue-string-of-MESSAGE-VARIABLE-table-for-business-process-infrastructure]
[message-relation-tbl-area=area-for-storing-MESSAGE-RELATION-table-for-business-process-infrastructure]
[message-relation-idx-area=area-for-storing-index-of-MESSAGE-RELATION-table-for-business-process-infrastructure]
[clusterinfo-tbl-area=area-for-storing-cluster-information]
[haasyncadp-tbl-area=area-for-storing-service-IDs-of-asynchronous-adapters-allocated-in-cluster]
[sql-scriptfilename=path-of-SQL-script-file]
[activitynumber-maximum-compatible={ON|OFF}]

[xmlanalyze-mode={standard|advanced}]

(2) Function

Specifies the information that can be set up when an HCSC server is set up.

(3) File storage location

service-platform-installation-directory\CSC\config\manager\templates\cscsvsetup.properties

(4) Specifiable properties

(a) Associated with setup configuration

db-use={ON|OFF} ~ <<ON>>

Specifies whether a database will be used with the HCSC server.

ON

A database will be used.

OFF

A database will not be used.

rm-use={ON|OFF} ~ <<ON>>

Specifies whether Reliable Messaging will be used with the HCSC server. An error occurs if OFF is specified for the db-use property, and you specify ON for this property.

ON

Reliable Messaging will be used.

OFF

Reliable Messaging will not be used.

hcscserver-data-filepath=output-destination-path-storing-System-Administrator-information-for-HCSC-server ~ <String of maximum 100 bytes> <<service-platform-installation-directory\CSC\spool\msg>>

Specifies an absolute path for the output destination to store the System Administrator information for the HCSC server. Use the characters / or \\ as directory delimiters. An error occurs if you specify a non-existent directory, and if the specified string exceeds 100 bytes. Therefore, explicitly specify this property when service-platform-installation-directory exceeds 84 bytes. Note that the byte length that can be specified is the length obtained after decoding the string with ISO-8859-1.

(b) Associated with standard receptions

request-ejb={ON|OFF}

Specifies whether a standard synchronous reception (SessionBean) will be used.

ON

A standard synchronous reception (SessionBean) will be used.

OFF

A standard synchronous reception (SessionBean) will not be used.

Specify ON in the following cases:

To invoke service components from a service requester by using a SessionBean

To re-execute process instances on the operating environment window

To re-execute process instances by using the cscpireexec command

request-soap={ON|OFF}

Specifies whether a standard synchronous reception (Web Service) will be used.

ON

A standard synchronous reception (Web Service) will be used.

OFF

A standard synchronous reception (Web Service) will not be used.

Specify ON to invoke service components from a service requester by using Web Service.

request-jms={ON|OFF}

Specifies whether a standard asynchronous reception (MDB(WS-R)) will be used. An error occurs if OFF is specified for the rm-use property and you specify ON for this property.

ON

A standard asynchronous reception (MDB(WS-R)) will be used.

OFF

A standard asynchronous reception (MDB(WS-R)) will not be used.

Specify ON in the following cases:

To invoke service components from a service requester by using MDB(WS-R)

After executing reply activities with the deployed business processes, when a business process is defined for executing basic activities (receive , invoke service, invoke Java, data transformation, assign, empty, throw, and standby)

request-jms.maxmessage=maximum-number-of-messages-in-standard-asynchronous-reception-(MDB(WS-R))-queue ~ <Numeric character> ((1 to 65535)) <<1024>>

Specifies the maximum number of messages set when the reception queue is created for a standard asynchronous reception (MDB(WS-R)). This value depends on the value set in Reliable Messaging. This property is valid only when you specify ON in the request-jms property.

request-dbq={ON|OFF}

Specifies whether a standard asynchronous reception (MDB(DBQueue)) will be used. An error occurs if OFF is specified for the rm-use property, and you specify ON for this property.

ON

A standard asynchronous reception (MDB(DBQueue)) will be used.

Note that you cannot specify ON in Oracle.

OFF

A standard asynchronous reception (MDB(DBQueue)) will not be used.

Specify ON to invoke service components from a service requester by using (MDB(DBQueue)).

request-dbq.maxmessage=maximum-number-of-messages-in-standard-asynchronous-reception-(MDB (DB queue))-queue ~ <Numeric character> ((1 to 65535)) <<1024>>

Specifies the maximum number of messages set when the reception queue is created for a standard asynchronous reception (MDB(DBQueue)). This value depends on the value set in Reliable Messaging. This property is valid only when you specify ON in the request-dbq property.

request-jms-rdarea=RD-area-name-of-standard-asynchronous-reception (MDB(WS-R)) ~ <Alphanumeric characters beginning with alphabetic characters, spaces, and underscores (_)> ((1 to 30 characters))

Specifies the RD area name of a standard asynchronous reception (MDB(WS-R)). This property is invalid when Oracle is used as the database. Because this value depends on the value specified for Reliable Messaging, you can specify this property only when using Reliable Messaging.

request-dbq-rdarea=RD-area-name-of-standard-asynchronous-reception (MDB(DBQueue)) ~ <Alphanumeric characters beginning with alphabetic characters, spaces, and underscores (_)> ((1 to 30 characters))

Specifies the RD area name of a standard asynchronous reception (MDB(DBQueue)). This property is invalid when Oracle is used as the database. Because this value depends on the value specified for Reliable Messaging, you can specify this property only when using Reliable Messaging.

request-dbq-maxlen=maximum-length-of-messages-in-standard-asynchronous-reception-(MDB(DBQueue)) ~ <Numeric character> ((1000 to 1048576)) <<33000>>

Specifies the maximum length of messages in a standard asynchronous reception (MDB(DBQueue)) in bytes. This value depends on the value set in Reliable Messaging.

(c) Associated with user-defined receptions

request-userdef-soap={ON|OFF} ~ <<OFF>>

Specifies whether a SOAP reception will be used.

ON

A SOAP reception will be used.

OFF

A SOAP reception will not be used.

Important note

You can deploy or execute user-defined receptions even if OFF is specified. However, note that when OFF is specified and user-defined receptions are defined in the development environment, the address of the request destination Web Service from the service requester is not displayed.

(d) Associated with J2EE

naming-service-hostname=host-name-of-Naming-Service ~ <Character string>

Specifies the host name for Naming Service. The host name depends on the name specified in the service platform. If you omit this property, the host name that has been set for Management Server is specified.

naming-service-port=port-number-of-Naming-Service ~ <Numeric character> ((1 to 65535))

Specifies the port number for the naming service. The port number depends on the value set in the service platform. If you omit this property, the port number for the in-process naming service of the logical J2EE server managed by Management Server is specified.

(e) Associated with Reliable Messaging

rm-systemname=system-name-of-Reliable-Messaging ~ <Uppercase alphabetic characters or numbers beginning with alphabetic characters> ((1 to 3 characters))

Specifies the RM system name of Reliable Messaging used by the HCSC server. You can specify this property only when using Reliable Messaging.

The system name depends on the name specified in the service platform. Make sure that you specify this property when ON is specified for the rm-use property. An error occurs if you specify this property when OFF is specified for the rm-use property.

rm-displayname=display-name-of-Reliable-Messaging ~ <Alphanumeric characters and underscores (_)>

Specifies the value obtained by sanitizing (changing characters other than one-byte alphanumeric characters to underscores (_)) the display name of Reliable Messaging (resource adapter) used by the HCSC server. You can specify this property only when using Reliable Messaging.

The display name depends on the name specified in the service platform. Make sure that you specify this property when ON is specified for the rm-use property. An error occurs if you specify this property when OFF is specified for the rm-use property.

(f) Associated with DB Connector

dbcon-xadisplayname=display-name-of-DB-Connector-for-XATransaction-or-LocalTransaction ~ <Alphanumeric characters and underscores (_)>

Specifies the value obtained by sanitizing (changing characters other than one-byte alphanumeric characters to underscores (_)) the display name of DB Connectors for XATransaction or LocalTransaction, which is used by the HCSC server. The display name depends on the name specified in the service platform. Make sure that you specify this property when ON is specified for the db-use property. An error occurs if you specify this property when OFF is specified for the db-use property.

dbcon-nodisplayname=display-name-of-DB-Connector-for-NoTransaction

Specifies the value obtained by sanitizing (changing characters other than one-byte alphanumeric characters to underscores (_)) the display name of DB Connector for NoTransaction, which is used by the HCSC server. The display name depends on the name specified in the service platform. Make sure that you specify this property when ON is specified for the db-use property. An error occurs if you specify this property when OFF is specified for the db-use property.

(g) Associated with databases

dbtype={HIRDB|ORACLE11G}

Specifies the type of the database to be used by the HCSC server. Make sure that you specify this property when ON is specified for the db-use property. An error occurs if you specify this property when OFF is specified for the db-use property.

HIRDB

HiRDB will be used as the database.

ORACLE11G

Oracle will be used as the database.

jdbc-type={DBPSV|HIRDB-TYPE4|ORACLE-THIN}

Specifies the type of the JDBC driver to be used when the HCSC server is offline. Make sure that you specify this property when ON is specified for the db-use property. An error occurs if you specify this property when OFF is specified for the db-use property.

DBPSV

JdbcDbpsvDriver of DABroker Library will be used. Make sure that you specify the properties jdbc-dbhostname and jdbc-dbconnectinfo when DBPSV is specified. You cannot access Oracle databases by using DABroker Library.

HIRDB-TYPE4

HiRDB Type4 JDBC Driver will be used. When HIRDB-TYPE4 is specified, make sure that you specify the properties jdbc-dbhostname and jdbc-dbconnectinfo.

ORACLE-THIN

Oracle JDBC Thin Driver will be used. Make sure that you specify this value in the dbtype property when ORACLE11G is specified as the database type to be used. Also, make sure that you specify the jdbc-url property when ORACLE-THIN is specified.

jdbc-url=database-URL-for-JDBC ~ <Character string>

Specifies the destination database URL specified for establishing a connection with the Driver.connect method, as the connection settings supporting each JDBC driver to be used when the HCSC server is offline. Make sure that you specify this property when ORACLE-THIN is specified as the JDBC driver type in the jdbc-type property.

When DBPSV is specified in the jdbc-type property

The specification of the jdbc-url property is disabled.

When HIRDB-TYPE4 is specified in the jdbc-type property

The specification of the jdbc-url property is disabled.

When ORACLE-THIN is specified in the jdbc-type property

Specifies the URL to be used for connecting Oracle JDBC Thin Driver to the database. Specifies the string after jdbc:oracle:thin:@. For details on the URL format, see the Oracle documentation. Do not specify a URL containing the user name and the password to be used for connecting to the database. Specify the user name and the password to be used for connecting to the database in the HCSC server configuration definition file.

jdbc-dbhostname=host-name-of-a- database ~ <Character string> ((maximum 2086 characters))

Specifies the host name or the IP address of HiRDB to be used by the HCSC server when the HCSC server is offline. Make sure that you specify this property when DBPSV and HIRDB-TYPE4 are specified as the JDBC driver types in the jdbc-type property. When ORACLE-THIN is specified in the jdbc-type property, the specification of the jdbc-dbhostname property is disabled.

jdbc-dbconnectinfo=database-connection-information ~ <Alphanumeric characters>

Specifies the connection information (the port number or the name of the environment variable group) to be used when the HCSC server is offline. Use the characters / or \\ as directory delimiters. This value depends on the value set in DABroker or HiRDB. Make sure that you specify this property when DBPSV and HIRDB-TYPE4 are specified as the JDBC driver types in the jdbc-type property.

When DBPSV is specified in the jdbc-type property

Specifies the port number of the HiRDB system, or the name of the environment variable group of the HiRDB client. When you specify the name of the environment variable group, make sure that you include @DABENVGRP at the beginning.

When HIRDB-TYPE4 is specified in the jdbc-type property

Specifies the port number of the HiRDB system, or the file name of the environment variable group of the HiRDB client. When you specify the file name of the environment variable group, make sure that you specify @HIRDBENVGRP= at the beginning followed by the file name of the environment variable group as an absolute path.

When ORACLE-THIN is specified in the jdbc-type property

The specification of the jdbc-dbconnectinfo property is disabled.

db-character-sets={ASCII|Shift_JIS|UTF-8|EUC-JP}

Specifies the type of the character encoding specified in the database to be used.

This property is used to convert the length (number of bytes of a string that can be entered in the database) of NCName of XML schema definition to the specified character encoding and perform a check during the input check for a command reception (MBean) and standard reception.

Make sure that you specify this property when ON is specified in the db-use property. You can omit this property if no database is to be used. If you do not specify this property when OFF is specified for the db-use property, check by converting the characters to UTF-8. If a type other than UTF-8 is specified, check with the specified character encoding.

ASCII

Specify ASCII when the character encoding type specified in the database to be used is ASCII.

Shift_JIS

Specify Shift_JIS when the character encoding type specified in the database to be used is Shift_JIS.

UTF-8

Specify UTF-8 when the character encoding type specified in the database to be used is UTF-8.

EUC-JP

Specify EUC-JP when the character encoding type specified in the database to be used is EUC-JP.

db-tbl-split-key={NONE|MONTH} ~ <<NONE>>

Specifies whether the range segmentation function of tables will be used based on the date data.

NONE

The range segmentation function will not be used.

MONTH

The range segmentation function will be used. The month (GMT) in which process instances started is used as the split key and registered to the table.

Define the segmentation method used for the range segmentation function of tables in the SQL script file specified in the sql-scriptfilename property. For details on the configuration of tables, see Appendix C. Database Table Information in the uCosminexus Service Platform Setup and Operation Guide.

db-tbl-split-corcheck-use={ON|OFF} ~ <<OFF>>

Specifies whether the check for duplicates in correlation sets, will be strengthened. Specify ON when using the segmentation functions of the execution log information table in HiRDB.

ON

The check for duplicates in correlation sets is strengthened.

OFF

The check for duplicates in correlation sets is not strengthened.

To use the table segmentation function, define the segmentation method in the SQL script file specified in sql-scriptfilename. For details on the configuration of tables, see Appendix C. Database Table Information in the Service Platform Setup and Operation Guide.

(h) Compatibility of business process statuses

bp-status-compatible={ON|OFF}

Specifies the following information. This property is valid when you use persistent business processes.

Whether to set the process instance and the activity to the Error status when an exception (error) occurs while the invoke service activity of a business process is running

Whether to end or to start a transaction for operations other than the execution of the invoke service activity with a synchronous communication model

The transaction and the status transition of the invoke service activity differ depending on the combination of the properties bp-status-compatible and bp-invoke-status-compatible. For details, see 3.4.4 Transactions of the invoke service activity in the manual Service Platform Overview

The default value for a new installation of 08-10 or later is OFF. Also, the default value is ON when migrated from the version 08-00 or earlier.

(i) Compatibility of invoke service activity statuses

bp-invoke-status-compatible={ON|OFF}

Specifies whether to end or to start a transaction when the execution of the invoke service activity of a business process is successfully completed.

This property is valid when you specify OFF in the bp-status-compatible property. Also, this property is valid when you use persistent business processes.

The transaction and the status transition of the invoke service activity differ depending on the combination of the properties bp-status-compatible and bp-invoke-status-compatible. For details, see 3.4.4 Transactions of the invoke service activity in the manual Service Platform Overview.

The default value for a new installation is OFF. Also, the default value is ON when migrated from the version 08-70 or earlier.

(j) RD area (table area) information for databases

cscserverinfo-tbl-area=table-area-for-basic-HCSC-information ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the table area that creates the basic HCSC information table. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the table area is determined based on the database to be used.

server-trans-tbl-area=table-area-for-HCSC-linkage ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the table area that creates the HCSC linkage directory. The value to be specified depends on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the table area is determined based on the database to be used.

location-tbl-area=table-area-for-locations ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the table area that creates the location directory. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the table area is determined based on the database to be used.

routing-tbl-area=table-area-for-routing ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the table area that creates the routing directory. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the table area is determined based on the database to be used.

cv-tbl-area=table-area-for-data-transformation ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the table area that creates the data transformation directory. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the table area is determined based on the database to be used.

exehistory-tbl-area=table-area-for-execution-log-information ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the table area that creates the execution log information table. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the table area is determined based on the database to be used.

exehistory-idx-area=area-for-storing-execution-log-information-table-index ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the index of the execution log information table. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the index area is determined based on the database to be used.

process-tbl-area=area-for-storing-PROCESS-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the PROCESS table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the table area is determined based on the database to be used.

process-idx-area=area-for-storing-index-of-PROCESS-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the index of the PROCESS table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the index area is determined based on the database to be used.

activity-tbl-area=area-for-storing-ACTIVITY-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the ACTIVITY table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the table area is determined based on the database to be used.

activity-idx-area=area-for-storing-index-of-ACTIVITY-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the index of the ACTIVITY table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the index area is determined based on the database to be used.

link-tbl-area=area-for-storing-LINK-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the LINK table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the table area is determined based on the database to be used.

link-idx-area=area-for-storing-index-of-LINK-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the index of the LINK table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the index area is determined based on the database to be used.

correlationset-tbl-area=area-for-storing-CORRELATIONSET-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the CORRELATIONSET table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the table area is determined based on the database to be used.

correlationset-idx-area=area-for-storing-index-of-CORRELATIONSET-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the index of the CORRELATIONSET table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the index area is determined based on the database to be used.

string-variable-tbl-area=area-for-storing-STRING-VARIABLE-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the STRING-VARIABLE table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the table area is determined based on the database to be used.

string-variable-idx-area=area-for-storing-index-of-STRING-VARIABLE-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the index of the STRING-VARIABLE table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the index area is determined based on the database to be used.

numeric-variable-tbl-area=area-for-storing-NUMERIC-VARIABLE-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the NUMERIC-VARIABLE table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the table area is determined based on the database to be used.

numeric-variable-idx-area=area-for-storing-index-of-NUMERIC-VARIABLE-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the index of the NUMERIC-VARIABLE table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the index area is determined based on the database to be used.

boolean-variable-tbl-area=area-for-storing-BOOLEAN-VARIABLE-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the BOOLEAN-VARIABLE table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the table area is determined based on the database to be used.

boolean-variable-idx-area=area-for-storing-index-of-BOOLEAN-VARIABLE-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the index of the BOOLEAN-VARIABLE table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the index area is determined based on the database to be used.

message-variable-tbl-area=area-for-storing-MESSAGE-VARIABLE-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the MESSAGE-VARIABLE table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the table area is determined based on the database to be used.

message-variable-idx-area=area-for-storing-index-of-MESSAGE-VARIABLE-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the index of the MESSAGE-VARIABLE table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the index area is determined based on the database to be used.

message-variable-val-area=area-for-storing-VariableValue-string-of-MESSAGE-VARIABLE-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the VariableValue string of the MESSAGE-VARIABLE table for the business process infrastructure.

In HiRDB

No value needs to be specified. This property is disabled even if specified.

In Oracle

The table area will be specified.

If you omit this property, the table area is determined based on the database to be used.

message-relation-tbl-area=area-for-storing-MESSAGE-RELATION-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the MESSAGE-RELATION table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the table area is determined based on the database to be used.

message-relation-idx-area=area-for-storing-index-of-MESSAGE-RELATION-table-for-business-process-infrastructure ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the index of the MESSAGE-RELATION table for the business process infrastructure. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the index area is determined based on the database to be used.

clusterinfo-tbl-area=area-for-storing-cluster-information ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the table to store the cluster information that is set up in a cluster. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the table area is determined based on the database to be used.

haasyncadp-tbl-area=area-for-storing-service-IDs-of-asynchronous-adapters-deployed-within-a-cluster ~ <For a string and an RD area name: Alphanumeric characters beginning with alphabetic characters, and spaces> ((For an RD area name: 1 to 30 characters))

Specifies the area that creates the table to store the asynchronous-adapters service IDs deployed within a cluster. The value to be specified differs depending on the type of the database to be used.

In HiRDB

The RD area name will be specified.

In Oracle

The table area will be specified.

If you omit this property, the table area is determined based on the database to be used.

sql-scriptfilename=path-for-SQL-script-file ~ <Character string>

Specifies an absolute path for the SQL script file used to create the database. Use the characters / or \\ as directory delimiters.

This property is an optional function. When you specify a user SQL file in this property, make sure that the TABLE name, INDEX name, and VIEW name of the SQL file are correct. The operations might not function properly if you specify incorrect names. Also, when you remove the HCSC server setup, the tables used by the HCSC server are deleted irrespective of the SQL file contents. However, the tables that can be shared within the HA cluster are deleted only when the setup of the last HCSC server in the cluster is removed. For details on the set of tables used by the HCSC server, see 7.5.3 How to recover when executing HCSC server setup and unsetup in the uCosminexus Service Platform Setup and Operation Guide.

Also, for details on the SQL script file, see Appendix D. Setting up the SQL Script File in the uCosminexus Service Platform Setup and Operation Guide.

Note that the following properties will be disabled when you specify this property:

cscserverinfo-tbl-area

server-trans-tbl-area

location-tbl-area

routing-tbl-area

cv-tbl-area

exehistory-tbl-area

exehistory-idx-area

process-tbl-area

process-idx-area

activity-tbl-area

activity-idx-area

link-tbl-area

link-idx-area

correlationset-tbl-area

correlationset-idx-area

string-variable-tbl-area

string-variable-idx-area

numeric-variable-tbl-area

numeric-variable-idx-area

boolean-variable-tbl-area

boolean-variable-idx-area

message-variable-tbl-area

message-variable-idx-area

message-variable-val-area

message-relation-tbl-area

message-relation-idx-area

clusterinfo-tbl-area

haasyncadp-tbl-area

(k) Compatibility of the maximum number of activity instances

activitynumber-maximum-compatible={ON|OFF} ~ <<OFF>>

Specifies the upper limit for the activity instance ID numbers that can be generated with one process instance.

ON

A maximum of 32,768 activity instance ID numbers can be generated.

OFF

A maximum of 2,147,483,648 activity instance ID numbers can be generated.

The default values are as follows:

For new installations of 08-50 or later

The default value is OFF.

For migration from the version 08-10 or earlier

In an environment where no database is used, the default value is OFF, and in an environment where a database is used, the default value is ON.

(l) XML parsing

xmlanalyze-mode={standard|advanced} ~ <<standard>>

Selects the XML parsing mode from the following. Specify standard if you want to emphasize the compatibility with 09-00 or earlier in the process of XML parsing or to use the SOAP attachment function.

standard

The entire XML document will be parsed.

advanced

The memory usage and the processing performance will improve when you execute the following processing:

When you use SOAP receptions in the SOAP 1.1/ 1.2 combined mode

When you use SOAP adapters in the SOAP 1.1/ 1.2 combined mode

When you use DB adapters

When you execute data transformation

The notes on specifying advanced are as follows:

As the entire XML document is not parsed, an error might not occur even if the XML data is invalid.

The SOAP attachment function cannot be used.

The following components use StAX to parse XML messages:

SOAP receptions (in the SOAP 1.1/ 1.2 combined mode)

SOAP adapters (in the SOAP 1.1/ 1.2 combined mode)

DB adapters

Business processes (header allocation processing)

Therefore, create requesters and services keeping the following points in mind:

An exception occurs when you specify messages of XML version 1.1.

An exception occurs when you use the ISO-10646-UCS-4 encoding.

An exception does not occur when an XML document contains an element name beginning with a colon (:).

An exception does not occur when the character data in an XML document contains an independent CDATA section end delimiter ("]]>").

An empty element tag is output with the start and end tags as follows:

(Example) <sample></sample>

For the notes on using StAX, see 6.4 Notes on StAX in the uCosminexus Application Server XML Processor User Guide.

(5) Example of coding

The following is an example of coding when HiRDB is used:

db-use=ON
rm-use=ON
request-ejb=ON
request-soap=ON
request-jms=ON
request-dbq=OFF
rm-systemname=RM
rm-displayname=Cosminexus_Reliable_Messaging
dbcon-xadisplayname=DB_Connector_for_HiRDB_Type4_Cosminexus_RM
dbcon-nodisplayname=DB_Connector_for_HiRDB_Type4
dbtype=HIRDB
jdbc-type=HIRDB-TYPE4
jdbc-dbhostname=localhost
jdbc-dbconnectinfo=22200
db-character-sets=Shift_JIS
cscserverinfo-tbl-area=RDDATA1
location-tbl-area=RDDATA1
routing-tbl-area=RDDATA1
cv-tbl-area=RDDATA1
exehistory-tbl-area=RDDATA2
exehistory-idx-area=RDINDX2
process-tbl-area=RDDATA1
process-idx-area=RDINDX1
activity-tbl-area=RDDATA1
activity-idx-area=RDINDX1
link-tbl-area=RDDATA1
link-idx-area=RDINDX1
correlationset-tbl-area=RDDATA1
correlationset-idx-area=RDINDX1
string-variable-tbl-area=RDDATA3
string-variable-idx-area=RDINDX3
numeric-variable-tbl-area=RDDATA3
numeric-variable-idx-area=RDINDX3
boolean-variable-tbl-area=RDDATA3
boolean-variable-idx-area=RDINDX3
message-variable-tbl-area=RDDATA3
message-variable-idx-area=RDINDX3
message-relation-tbl-area=RDDATA4
message-relation-idx-area=RDINDX4

(6) Usage

Specify the HCSC server setup definition file in the setup-properties element of the HCSC server configuration definition file.

(7) Notes

The operations might not function properly if the same property is specified multiple times.

Even if you do not use the standard reception, specify ON for one of the following properties. Also specify the <reception> tag in the HCSC server configuration definition file associated with the property for which ON is specified. If you do not specify the appropriate tag, the KDEC10073-E message will be output during setup of the HCSC server.

request-ejb

request-soap

request-jms

request-dbq

Note the following when you specify the path:

Do not specify a path that contains characters expressing a relative path or a parent directory (..\ or ../), or characters expressing a current directory (.\ or ./).

Do not specify a path containing a symbolic link.

In Windows, do not specify a path containing a UNC format, an NTFS stream name, or a reserved device name. The path characters are not case sensitive.

6.5 Files used for HCSC server operations

6.5.1 HCSC-Manager command definition file for Java VM start options

(1) Format

In Windows

Specify the file in the Win32 batch file format. Δ indicates a halfwidth space.

setΔ cscjvmopt_command-name=Java-VM-start-option-1[ΔJava-VM-start-option-2][Δ...]

In UNIX

Specify the file in the shell script file format. Δ indicates a halfwidth space.

cscjvmopt_command-name="Java-VM-start-option-1[ΔJava-VM-start-option-2[Δ...]"

(2) Function

Specifies the Java VM start options that are applied to each command. You can use this file for the commands whose name begins with csc and which are used in the operating environment or execution environment. For details about the commands used in the operating environment or execution environment, see 5. Commands (Operating and Execution Environments).

The specified Java VM start options are used as the values of environment variables (or variables in UNIX) of the command. Therefore, when you set up or change the file, the settings in the file will be applied when the command is executed the next time.

Note the following when creating the file:

In UNIX, enclose the entire option in double quotation marks (").

Do not enter a space before or after =.

If an invalid value such as a spelling error is specified for a Java VM start option, the system behavior depends on Java VM.

Note that when the Java VM start options are specified, the operation follows the Java VM specification. If an unexpected operation occurs, such as a Java VM error during execution of a command, modify the file and then re-execute the command.

If you specify the following for an argument of a Java VM start option, operations are not guaranteed:

A file path containing spaces

A file path enclosed in double quotation marks (") or single quotation marks (')

Example of invalid specification (in UNIX)

cscjvmopt_cscpiselect=-XX:HitachiJavaLog:"/opt/ProgramΔFiles"

(3) File storage location

In Windows

Template file:

service-platform-installation-directory\CSC\config\manager\templates\cscjvmopt.bat

Storage location of the created file and the file name:

service-platform-installation-directory\CSC\config\manager\cscjvmopt.bat

In UNIX

Template file:

/opt/Cosminexus/CSC/config/manager/templates/cscjvmopt

Storage location of the created file and the file name:

/opt/Cosminexus/CSC/config/manager/cscjvmopt

(4) Specifiable Java VM start options

For details such as the range of arguments that can be specified for Java VM start options, see 14. Options for Invoking Java VM in the Application Server Definition Reference Guide. If you specify a Java VM start option that is not described here, operations cannot be guaranteed.

-Xms

Specifies the initial value of the heap area (New area + Old area).

-Xmx

Specifies the maximum value of the heap area (New area + Old area).

-Xss

Specifies the stack size of the thread.

-XX:MetaspaceSize

Specifies the initial value of the Metaspace area.

-XX:MaxMetaspaceSize

Specifies the maximum value of the Metaspace area.

-XX:HitachiJavaLog

Specifies the prefix of the Java VM log file and the directory to output the log files.

Specification of the log file output destination when multiple HCSC-Manager environments are set up

If you set up multiple HCSC-Manager environments on a single machine by specifying multiple CSCMNG_HOME environment variables, make sure that duplicate destinations are not specified for log file output. If duplicate destinations are specified, operations cannot be guaranteed. For details about the CSCMNG_HOME environment variable, see 2.9.2 Procedure for configuring multiple environments on one machine in the Service Platform Setup and Operation Guide.

To switch the log file output destination for each HCSC-Manager environment, we recommend that you have the CSCMNG_HOME environment variable included in the argument (example: XX:HitachiJavaLog:%CSCMNG_HOME%\log).

In this case, the log file output destination changes for each HCSC-Manager environment as follows:

Setting of the CSCMNG_HOME environment variable (HCSC-Manager environment 1)

set CSCMNG_HOME=C:\WorkPri

This sets the following log file output destination:

C:\WorkPri\log\javalog01.log

Setting of the CSCMNG_HOME environment variable (HCSC-Manager environment 2)

set CSCMNG_HOME=C:\WorkSec

This sets the following log file output destination:

C:\WorkSec\log\javalog01.log

Important note

If the path specified in the CSCMNG_HOME environment variable contains spaces, you cannot use the CSCMNG_HOME environment variable to specify the path of the log output destination. In this case, switch the output destination by using the CSCMNG_HOME environment variable and another environment variable that specifies a path not containing a space.

-XX:HitachiJavaLogFileSize

Specifies the upper limit of the size of one Java VM log file.

-XX:HitachiJavaLogNumberOfFile

Specifies the maximum number of Java VM log files that can be created.

-XX:[+|-]HitachiVerboseGC

Specifies whether to output extended verbosegc information if a GC occurs.

(5) Example of coding

The following shows examples of coding to specify Java VM start options for the cscpiselect command.

In Windows

set cscjvmopt_cscpiselect=-Xmx512m -Xms512m

In UNIX

cscjvmopt_cscpiselect="-Xmx512m -Xms512m"

6.5.2 HCSC-Manager command definition file

(1) Format

This definition file uses the J2SE property file format.

csc.all.command-argument-name=Value
csc.command-identifier.command-argument-name=Value

(2) Function

Sets up default values for the options of each command. After the configuration file is changed, the updated information is applied when the command is issued the next time. If the option value is specified in both, the definition file and the command, the value specified in the command will be valid.

This definition file contains information, such as the user ID and the password, so set up the file permissions appropriately.

(3) File storage location

Service-platform-installation-directory\CSC\config\manager\csccmd.properties

(4) Specifiable parameters

csc.all.command-argument-name=Value

Specifies default values for the arguments common to all the commands. Specify the value for the command argument name by removing the hyphen (-). If no value exists, you need not specify the value.

(Example of specification 1)

If you assume the value admin for the -user option of all the commands:

csc.all.user=admin

(Example of specification 2)

If you assume that the -all option is specified for all the commands:

csc.all.all=

csc.command-identifier.command-argument-name=Value

Defines default arguments for the command corresponding to the command identifier. For the command identifier, specify the value by removing csc from the command name. For the command argument name, specify the value by removing the hyphen (-). If no value exists, you need not specify the value.

(Example of specification 1)

If you assume the value HCSC for the -csc option of the cscpiselect commands:

csc.piselect.csc=HCSC

(Example of specification 2)

If you assume that the -system option is specified for the cscsvstart commands:

csc.svstart.system=

(5) Notes

As described in the following example, in the case of a discrepancy in the specified contents of the HCSC-Manager command definition file and the specification of command arguments, the command arguments become invalid.

Contents of the HCSC-Manager command definition file

csc.all.user=AAA
csc.all.pass=BBB
csc.repctl.autoexport=

Example of command input

> cscrepctl -import repository.zip

In this example, both the options -import and -autoexport are specified for the cscrepctl command. Therefore, this will result in an error due to an invalid command argument.

6.5.3 HCSC-Manager definition file

(1) Format

cscmng.repository.root=root-directory-path-of-repository

cscmng.log.dir=path-of-directory-to-output-log
cscmng.log.channel-name.filesize=log-file-size
cscmng.log.channel-name.filenum=number-of-log-files

cscmng.manager.identifier-name-of-Manager.timeout=read-timeout-value

cscmng.pireexec.response.dir=path-of-directory-for-storing-response-messages
cscmng.pireexec.response.encoding=character-encoding-for-stored-response-messages

cscmng.server.HCSC-server-name.system=logical-server-name

cscmng.repctl.export.dir=path-of-directory-to-output-export-file

cscmng.envbackup.dir=path-of-directory-to-output-environment-backup
cscmng.envbackup.dir.envrestore=path-of-directory-to-output-environment-backup-before-restoration
cscmng.envbackup.dir.import=path-of-directory-to-output-environment-backup-before-import
cscmng.envbackup.autoget={ON|OFF}
cscmng.envbackup.autoget.off={envrestore|import|envrestore,import}

cscmng.precache.thread.maximum=maximum-number-of-threads-processed-in-parallel-with-cscprecache-command

cscmng.server.HCSC-server-name.hws.svstop={normal|wait}
cscmng.server.HCSC-server-name.hws.svstop.timeout=timeout-value-for-planned-stop-of-HTTP-Server

(2) Function

Sets up the information required for operating HCSC-Manager.

(3) File storage location

Service-platform-installation-directory\CSC\config\manager\cscmng.properties

(4) Specifiable parameters

(a) Repository settings

cscmng.repository.root=root-directory-path-of-repository ~ <String of maximum 100 bytes> <<service-platform-installation-directory\CSC\repository>>

Specifies an absolute path for the root directory of the repository. Use the characters / or \\ as directory delimiters.

An error might occur if a relative path is specified. An error also occurs if a non-existent directory is specified, and if the specified string exceeds 100 bytes. Therefore, if the service platform installation directory exceeds 84 bytes, explicitly specify this property.

Note that when multiple operating and execution environments are set up (the CSCMNG_HOME environment variable is set up) on one machine, the default value is as follows:

%CSCMNG_HOME%\repository

(b) Log settings

cscmng.log.dir=path-of-directory-to-output-log ~ <String of maximum 100 bytes> <<service-platform-installation-directory\CSC\log\manager>>

Specifies an absolute path for the directory to output the log. Use the characters / or \\ as directory delimiters. An error might occur if a relative path is specified. An error also occurs if a non-existent directory is specified, and if the specified string exceeds 100 bytes. Therefore, if the service platform installation directory exceeds 84 bytes, explicitly specify this property.

Note that when multiple operating and execution environments are set up (the CSCMNG_HOME environment variable is set up) on one machine, the default value is as follows:

%CSCMNG_HOME%\log\manager

cscmng.log.channel-name.filesize=log-file-size ~ <Numeric character> ((4096 to 16777216)) <<1048576>> When the channel is maintenance <numeric character> ((4096 to 16777216)) <<4194304>>

Specifies the maximum size per log file in bytes. If you specify an invalid value, the default value is specified. Specify any one of the following in the channel name:

message: Message log

exception: Exception log

maintenance: Maintenance log

cscmng.log.channel-name.filenum=number-of-log-files ~ <Numeric character> ((1 to 16)) <<2>>

Specifies the number of log files. If you specify an invalid value, the default value is specified. Specify any one of the following in the channel name:

message: Message log

exception: Exception log

maintenance: Maintenance log

(c) Manager settings

cscmng.manager.identifier-name-of-Manager.timeout=read-timeout-value ~ <Numeric character> ((0 to 86400)) <<0>>

Specifies the read timeout in the connection with Manager in seconds. A timeout does not occur if you specify 0. If you specify an invalid value, the default value is specified. Set up the Manager name specified in the HCSC server configuration definition file as the identifier name for Manager.

(d) Settings for re-executing process instances

cscmng.pireexec.response.dir=path-of-directory-for-storing-response-messages ((1 to 100 bytes))

Specifies an absolute path for the response message storage directory that is used when response messages are received during the re-execution of process instances. Use the characters / or \\ as directory delimiters. An error might occur if a relative path is specified. If no path is specified, the response messages are not stored. An error occurs if you specify a non-existent path. Also, the file cannot be created if the length of the file that includes the path exceeds MAX_PATH for the OS.

cscmng.pireexec.response.encoding=character-encoding-for-stored-response-messages ~ <<UTF-8>>

Specifies the JavaVM-supported encoding for the character encoding that is output when response messages are stored. If you specify a non-existent character encoding, the default value is specified.

(e) Settings for HCSC server operations

cscmng.server.HCSC-server-name.system=logical-server-name

Specifies the logical servers to be managed by the HCSC system. When the HCSC system manages the logical servers, this enables you to perform various logical server operations (starting and stopping logical servers with an HCSC server and referencing the statuses).

Specify logical server names by using commas (,) as delimiters, as follows: logical-server-name,logical-server-name, .... The one-byte spaces and tab characters before and after the commas are ignored. The logical servers are started and stopped in the order specified in Manager. If the HCSC servers are also to be simultaneously started, the order for starting the J2EE servers is followed.

(Example of specification )

To simultaneously start and stop the logical performance tracer (PRF) and the logical Web server (WebServer) on the HCSC server (HCSC):

cscmng.server.HCSC.system=PRF,WebServer

(f) Exporting the repository

cscmng.repctl.export.dir=path-of-directory-to-output-export-file ~ ((1 to 100 bytes))

Specifies the directory to output the export file when the cscrepctl command is used to export the repository.

(g) Backing up the environment

cscmng.envbackup.dir=path-of-directory-to-output-environment-backup ~ ((1 to 100 bytes)) <<current directory>>

Specifies the directory to output the environment backup file when the environment is backed up with the cscenvbackup command.

cscmng.envbackup.dir.envrestore=path-of-directory-to-output-environment-backup-before-restoration ~ ((1 to 100 bytes))

Specifies the directory to output the pre-restoration environment backup file when the environment is restored with the cscenvrestore command. The specification of this parameter has higher priority than the specification of the cscmng.envbackup.dir parameter. If you omit this parameter, the pre-restoration environment backup file is output to the directory specified with the cscmng.envbackup.dir parameter. If the cscmng.envbackup.dir parameter is also omitted, the file is output to the following directory:

Service-platform-installation-directory\CSC\spool\manager\

Note that when multiple operating and execution environments are set up (the CSCMNG_HOME environment variable is set up) on one machine, the default value is as follows:

%CSCMNG_HOME%\spool\manager

cscmng.envbackup.dir.import=path-of-directory-to-output-environment-backup-before-import ~ ((1 to 100 bytes))

Specifies the directory to output the pre-import environment backup file when a repository is imported by specifying the -import option with the cscrepctl command. The specification of this parameter has higher priority than the specification of the cscmng.envbackup.dir parameter. If you omit this parameter, the pre-import environment backup file is output to the directory specified with the cscmng.envbackup.dir parameter. If the cscmng.envbackup.dir parameter is also omitted, the file is output to the following directory:

Service-platform-installation-directory\CSC\spool\manager

Note that when multiple operating and execution environments are set up (the CSCMNG_HOME environment variable is set up) on one machine, the default value is as follows:

%CSCMNG_HOME%\spool\manager

cscmng.envbackup.autoget={ON|OFF} ~ <<ON>>

Specifies whether an automatic backup will be taken.

ON

An automatic backup will be taken.

OFF

An automatic backup will not be taken.

cscmng.envbackup.autoget.off={envrestore|import|envrestore,import}

Specify this parameter if you do not want to take an automatic backup when an environment is being restored or when a repository is being imported. If you do not want an automatic backup when the environment is restored and when the repository is imported, specify envrestore and import by using commas (,) as delimiters. The space characters before and after the commas are ignored.

envrestore

No automatic backup is taken when the environment is restored by executing the cscenvrestore command.

import

No automatic backup is taken when the repository is imported by specifying the -import option with the cscrepctl command.

(Examples of specifications)

If you do not want to take an automatic backup when an environment is restored

cscmng.envbackup.autoget.off=envrestore

If you do not want to take an automatic backup when a repository is imported

cscmng.envbackup.autoget.off=import

If you do not want to take an automatic backup when an environment is restored and when a repository is imported

cscmng.envbackup.autoget.off=envrestore,import

Tip

Whether an automatic backup will be taken when an environment is being restored or when a repository is being imported differs depending on the specified combination of the parameters cscmng.envbackup.autoget and cscmng.envbackup.autoget.off. The following table describes the relationship between the parameters cscmng.envbackup.autoget and cscmng.envbackup.autoget.off.

Table 6‒2: Relationship between the parameters cscmng.envbackup.autoget and cscmng.envbackup.autoget.off

Specification of the cscmng.envbackup.autoget parameter

Specification of the cscmng.envbackup.autoget.off parameter

When an environment is restored

When a repository is imported

No

No

Y

Y

No

Envrestore

N

Y

No

Import

Y

N

No

envrestore,import

N

N

ON

No

Y

Y

ON

Envrestore

N

Y

ON

Import

Y

N

ON

envrestore,import

N

N

OFF

No

N

N

OFF

Envrestore

N

N

OFF

Import

N

N

OFF

envrestore,import

N

N

Legend:

Y: Automatic backup will be taken.

N: Automatic backup will not be taken.

(h) Thread settings for commands

cscmng.precache.thread.maximum=maximum-number-of-threads-processed-parallely-with-cscprecache-command ~ <Numeric character> ((1 to 1024)) <<16>>

Specifies the maximum number of threads for sending parallel pre-parse requests with the cscprecache command. An error occurs if no value is specified or if an invalid value is specified.

If there is no target or only 1 target for sending the parsing request, the threads are not generated, and hence the value of this property is ignored.

(i) Settings for HTTP Server operations

cscmng.server.HCSC-server-name.hws.svstop={normal|wait} ~ <<wait>>

Specifies the operations for stopping the HTTP Server. If you specify an invalid value, the default value is specified. This parameter is valid when you want to stop logical servers in a batch, to stop logical servers of the HTTP Server, and to stop an HCSC server from an operating environment window.

normal

The HTTP Server will stop normally.

wait

The HTTP Server will stop in a planned manner.

cscmng.server.HCSC-server-name.hws.svstop.timeout=timeout-value-for-planned-termination-of-HTTP-Server ~ <Numeric character> ((0 or less, or 60 to 1800)) <<300>>

Specifies the timeout value for stopping the HTTP Server in a planned manner, in seconds. If you specify an invalid value, the default value is specified.

If you specify 0 or a lesser value, the stop monitoring time set up in Management Server is specified. If the specified stop monitoring time is 0, the timeout does not occur. For details on the stop monitoring time, see 11.11.1 Start and stop settings for Web servers in the uCosminexus Application Server Management Portal User Guide.

This parameter is valid when you want to stop logical servers in a batch, to stop logical servers of the HTTP Server, and to stop an HCSC server from an operating environment window.

Note that if a value other than 0 is specified in the HWSGracefulStopTimeout directive, the timeout will also be monitored by the value specified in the HWSGracefulStopTimeout directive. For details on the HWSGracefulStopTimeout directive, see 6.2.4 Directives that start with E, F, G, H, and I in the uCosminexus Application Server HTTP Server User Guide.

(5) Example of coding

cscmng.repository.root=C:/Program Files/Hitachi/Cosminexus/CSC/repository

cscmng.log.dir=C:/Program Files/Hitachi/Cosminexus/CSC/log/manager
cscmng.log.message.filesize=1048576
cscmng.log.message.filenum=2
cscmng.log.exception.filesize=1048576
cscmng.log.exception.filenum=2
cscmng.log.maintenance.filesize=4194304
cscmng.log.maintenance.filenum=2

cscmng.manager.node1.timeout=180
cscmng.manager.node2.timeout=180

cscmng.pireexec.response.dir=C:/TMP
cscmng.pireexec.response.encoding=UTF-8

cscmng.server.HCSC.system=PRF, WebServer

cscmng.repctl.export.dir=C:/TMP/autoexport

cscmng.envbackup.dir=C:/TMP/enbbackup
cscmng.envbackup.dir.envrestore=C:/TMP/envrestore
cscmng.envbackup.dir.import=C:/TMP/import
cscmng.envbackup.autoget=ON
cscmng.envbackup.autoget.off=envrestore

cscmng.precache.thread.maximum=16

cscmng.server.HCSC.hws.svstop=wait
cscmng.server.HCSC.hws.svstop.timeout=300

(6) Notes

The HCSC-Manager definition file is read only once when the window and command processes are invoked. Therefore, if you change the HCSC-Manager definition file, the changes are applied when you start the process next time. However, to enable the changes in the file size and the number of files, you need to save or delete the file. For details, see 7.3.1(3) Notes on acquisition of log and trace data: General notes in the Service Platform Setup and Operation Guide.

After you set up the HCSC server, do not change the value of the cscmng.repository.root parameter until you remove the setup of the HCSC server. If the value is changed, you might not be able to perform operations for the set up HCSC server.

The HWSGracefulStopTimeout directive is automatically set up by HCSC-Manager. For an environment set up with the setup wizard, you cannot change the settings for the HWSGracefulStopTimeout directive from the management portal. Even if you directly rewrite the settings for the HWSGracefulStopTimeout directive in the HTTP Server definition file (httpsd.conf), note that the settings are restored when the set information is distributed.

Note the following when you specify the path:

Do not specify a path that contains characters expressing a relative path or a parent directory (..\ or ../) or characters expressing a current directory (.\ or ./).

Do not specify a path containing a symbolic link.

In Windows, do not specify a path containing a UNC format, an NTFS stream name, or a reserved device name. The path characters are not case sensitive.

6.5.4 HCSC-Messaging command definition file

(1) Format

In Windows

@echo off
set HCSC_ADDCLASSPATH=Path-of-HiRDB-Type4-JDBC-Driver-or-Oracle-JDBC-Thin-Driver

In UNIX

#!/bin/sh
HCSC_ADDCLASSPATH=Path-of-HiRDB-Type4-JDBC-Driver-or-Oracle-JDBC-Thin-Driver

(2) Function

Specifies the information required for operating HCSC-Messaging commands (commands beginning with csm).

(3) File storage location

In Windows

Service-platform-installation-directory\CSC\config\msg\cmdconf.bat

In UNIX

/opt/Cosminexus/CSC/config/msg/cmdconf

(4) Specifiable parameters

HCSC_ADDCLASSPATH

Specifies the file name of each database driver with an absolute path.

In HiRDB

If HiRDB Type4 JDBC Driver is used, this parameter specifies the file name of HiRDB Type4 JDBC Driver (pdjdbc2.jar) with an absolute path.

In Oracle

If Oracle JDBC Thin Driver is used, this parameter specifies the file name of Oracle JDBC Thin Driver with an absolute path.

In cases other than the above, define only the environment variable and do not specify the value.

Important note

Do not set any value other than HCSC_ADDCLASSPATH as the environment variable.

(5) Example of coding

The following are the examples of coding of the HCSC-Messaging command definition file:

In Windows

@echo off
set HCSC_ADDCLASSPATH=C:\win32app\hitachi\hirdb_s\CLIENT\UTL\pdjdbc2.jar

In UNIX

#!/bin/sh
HCSC_ADDCLASSPATH=/opt/HiRDB_S/client/lib/pdjdbc2.jar

6.5.5 HCSC component-specification file

(1) Format

[change-type.]{service-ID|reception-ID}
 ...
[change-type.]{service-ID|reception-ID}

(2) Function

Specifies the add, change, and delete operations of HCSC components in a text file format. To specify multiple HCSC components, specify one component on each line. By specifying the created HCSC component-specification file in a command, you can process multiple HCSC components in a batch.

You can enter the HCSC component-specification file in a text file format as well, but with the following commands you can also output to a file and create the information for HCSC components:

The -listfile option of the cscrepdiff command (outputs the differences in HCSC components)

The -listfile option of the cscrepls command (outputs the list of HCSC components)

(3) File storage location

You can store the HCSC component-specification file at any location and assign any name to the file.

(4) Specifiable parameters

[change-type.]{service-ID|reception-ID}

Specifies the service ID or reception ID for the HCSC component to be added, changed, or deleted.

Specify one of the following as the change type of HCSC components:

add

Adds the specified HCSC component to the processing target.

change

Re-deploys the HCSC component when there is a change in the deployed HCSC component.

delete

Deletes the deployed HCSC component from the processing target.

No specification

The specified HCSC components are subject to processing by all the commands irrespective of the deployment status.

The following table lists the combination of commands for which you can specify the HCSC component-specification file in the -namelist option, and the specifiable change types:

Command name

Change type

add

change

delete

No specification

csccompostart

Y

Y

N

Y

csccompostop

N

Y

Y

Y

csccompodeploy

Y

Y

N

Y

csccompoundeploy

N

Y

Y

Y

cscrepctl -import -compo

Y

Y

N

Y

cscrepctl -delete

N

N

Y

Y

Legend:

Y: Valid.

N: Invalid.

(5) Example of coding

The following is an example of coding of the HCSC component-specification file:

#[BusinessProcess]
change.BP2
delete.BP3
add.BP4

#[ServiceAdapter]
change.adp2
delete.adp3
add.adp4

#[UserDefinedReception]
change.rcp2
delete.rcp3
add.rcp4

(6) Usage

Specify the created HCSC component-specification file in the argument of the -namelist option of the following commands. For details on how to execute the commands, see the description for each command in 5. Commands (Operating and Execution Environments).

csccompostart command

csccompostop command

csccompodeploy command

csccompoundeploy command

cscrepctl -import -compo command

cscrepctl -delete command

(7) Notes

If you specify multiple HCSC components, the order of executing the HCSC components differs depending on the commands. For details on the execution order, see the description for each command.

If the service ID or reception ID is repeated, an error occurs even if the change types are different.

The HCSC components that are not subject to processing are skipped in the cases such as when the HCSC components you want to deploy are already deployed.

A line beginning with a hash mark (#) is a comment.

The one-byte spaces at the beginning and at the end of each line are trimmed.

A blank line is skipped and is not referenced.

6.5.6 HCSC server runtime definition file

(1) Format

[methodtrace-filepath= Path-to-output-method-trace-and-exception-log]
[requesttrace-filepath=Path-to-output-request-trace]
[telegramtrace-filepath=Path-to-output-user-message-trace]
[methodtrace-filenum=number-of-method-trace-files]
[requesttrace-filenum=number-of-request-trace-files]
[telegramtrace-filenum=number-of-user-message-trace-files]
[bpacttrace-filenum=number-of-activity-trace-files-for-business-processes]
[methodtrace-filesize=size-of-method-trace-files]
[requesttrace-filesize=size-of-request-trace-files]
[telegramtrace-filesize=size-of-user-message-trace-files]
[bpacttrace-filesize=size-of-an-activity-trace-file-for-business-processes]
[bpacttrace-extend-item={NONE|PROCESSINSTANCEID}]
[telegramtrace-trigger={NORMAL|SYSERR|FAULT|DTERR}]
[telegramtrace-component-type-filepath=path-of-component-type-configuration-file-for-user-message-traces]
[telegramtrace-component-id-filepath=path-of-component-ID-configuration-file-for-user-message-traces]

[methodtrace-level={1|2|3|4|5}]
[requesttrace={ON|OFF}]
[telegramtrace={ON|OFF}]
[bpacttrace={ON|OFF}]
[bptrace-level={0|10|20|30}]
[bptrace-filenum=number-of-BP-trace-files]
[bptrace-filesize=BP-trace-size]
[bpexptrace-filenum=number-of-exception-log-files-for-business-process-infrastructure]
[bpexptrace-filesize=size-of-exception-log-files-for-business-process-infrastructure]
[cscexptrace-filenum=number-of-exception-log-files-for-messaging-infrastructure]
[cscexptrace-filesize=size-of-exception-log-files-for-messaging-infrastructure]

[request-ejb.instance.minimum=minimum-number-of-standard-synchronous-reception-(SessionBean)-instances]
[request-ejb.instance.maximum=maximum-number-of-standard-synchronous-reception-(SessionBean)-instances]
[request-ejb.ctm={true|false}]
[request-ejb.parallel.count=number-of-threads-prepared-to-invoke-applications-by-CTM]
[request-ejb.optional.name=optional-name-of-standard-synchronous-reception-(SessionBean)]
[request-soap.instance.minimum=minimum-number-of-concurrent-executions-of-standard-synchronous-reception-(Web Service/ SOAP 1.1)]
[request-soap.instance.maximum=maximum-number-of-concurrent-executions-of-standard-synchronous-reception-(Web Service/ SOAP 1.1)]
[request-soap.exclusive.threads=number-of-dedicated-threads-for-standard-synchronous-reception-(Web Service/ SOAP 1.1)]
[request-soap.queue-size=size-of-pending-queue-for-standard-synchronous-reception-(Web Service/ SOAP 1.1)]
[request-soap1_2.instance.minimum=minimum-number-of-concurrent-executions-of-standard-synchronous-reception-(Web Service/ SOAP 1.2)]
[request-soap1_2.instance.maximum=maximum-number-of-concurrent-executions-of-standard-synchronous-reception-(Web Service/ SOAP 1.2)]
[request-soap1_2.exclusive.threads=number-of-dedicated-threads-for-standard-synchronous-reception-(Web Service/ SOAP 1.2)]
[request-soap1_2.queue-size=size-of-pending-queue-for-standard-synchronous-reception-(Web Service/ SOAP 1.2)]
[request-jms.instance.maximum=maximum-number-of-standard-asynchronous-reception-(MDB(WS-R))-instances]
[request-jms.rollback-count=rollback-warning-message-output-count-for-standard-asynchronous-reception-(MDB(WS-R))]
[receptionstop-monitor-timer=timeout-value-for-monitoring-reception-queue]
[csc-receptionstop-timeout=communication-timeout-value-to-wait-for-reception-termination]

[soapfault-targetnamespace-filepath=absolute-path-of-SOAP-fault-operation-definition-file]
[soapfault-handling-mode={DETAIL|FAULTCODE}]
[oa-adapter-character-code={SJIS|MS932}]

[formatdef-maxcache-num=number-of-cacheable-format-definitions]
[transformdef-maxcache-num=number-of-cacheable-data-transformation-definitions-for-servers]
[xmltelegram-maxcache-num=number-of-cacheable-XML-messages]
[telegram-validation={ON|OFF}]
[xmltelegram-namespace-complement={ON|OFF}]
[telegram-undefined-character-code={ERROR|REPLACE}]
[telegram-notfound-soapheader={ERROR|IGNORE}]
[validation-activity={ON|OFF}]
[transform-binary-error-check={ON|OFF}]
[code-table-root-path=absolute-path-of-root-path-of-code-conversion-table-storage-path]

[syserr-to-fault-convert={ON|OFF}]
[validate-fault-compatible={ON|OFF}]
[bp-reply-after-min-thread-pool-size=minimum-number-of-threads-used-for-executing-activities-after-response-activity]
[bp-reply-after-max-thread-pool-size=maximum-number-of-threads-used-for-executing-activities-after-response-activity]
[bp-reply-after-thread-pool-keep-alive=retention-time-of-threads-used-for-executing-activities-after-response-activity]
[service-emulate.enable={true|false}]
[service-emulate-def-filepath=absolute-path-of-definition-file-for-emulated-configuration-information]

[j2ee-stopapp-timeout=stop-monitoring-time-of-J2EE-applications]
[startcsc-timeout=start-monitoring-time-of-J2EE-servers]
[stopcsc-timeout=stop-monitoring-time-of-J2EE-servers]

[csc-command-timeout=command-timeout-value]
[csc-precache-timeout=timeout-value-for-EJB-communication-with-business-process-for-precache-processing]

[cookie-parsing={ON|OFF}]

[work-folder=absolute-path-of-work-folder]
[common-folder-common-folder-definition-name=absolute-path-of-common-folder]

[dba-separate-transaction={true|false}]

[common-uoc-prop-path=folder-for-storing-component-common-UOC-property-file]

[short-processid-servername=HCSC-server-name-identifier-to-be-used-with-process-instance-identifier]
[short-processid={ON|OFF}]

[xml-pooled-instance-minimum=minimum-number-of-pooled-instances-of-classes-used-in-XML-processing]
[xml-pooled-instance-maximum=maximum-number-of-pooled-instances-of-classes-used-in-XML-processing]

[request-id-separate-key={slash|atsign|period}]
[fileevent-reception.monitored-file.enabled={true|false}]
[fileevent-reception.monitored-folder=path-of-monitored-folder]
[fileevent-reception.monitor-interval=file-monitoring-interval]
[fileevent-reception.monitor-starting.delay=time-to-wait-before-file-monitoring-starts]

(2) Function

Specifies the definition information for a set up HCSC server from HCSC-Manager.

(3) File storage location

Service-platform-installation-directory\CSC\config\manager\templates\cscsvconfig.properties

(4) Specifiable properties

(a) Log trace

methodtrace-filepath=Path-to-output-method-trace-and-exception-log ~ <Character strings (including two-byte characters) and spaces> <<Directory-to-output-J2EE-server-log\csc\maintenance>>

Specifies an absolute path to output the method trace and the exception log of the messaging infrastructure and business process infrastructure.

Use the characters / or \\ as directory delimiters. If you specify a non-existent directory, the default value is used. The default value depends on the value set in the service platform.

requesttrace-filepath=Path-to-output-request-trace ~ <Character strings (including two-byte characters) and spaces> <<Directory-to-output-J2EE-server-log\csc>>

Specifies an absolute path to output the request trace. This property is valid only when you specify ON in the requesttrace property.

Use the characters / or \\ as directory delimiters. If you specify a non-existent directory, the default value is used. The default value depends on the value set in the service platform.

telegramtrace-filepath=Path-to-output-user-message-trace ~ <Character strings (including two-byte characters) and spaces> <<Directory-to-output-J2EE-server-log\csc>>

Specifies an absolute path to output the user message trace. This property is valid only when you specify ON in the telegramtrace property.

Use the characters / or \\ as directory delimiters. If you specify a non-existent directory, the default value is used. The default value depends on the value set in the service platform.

methodtrace-filenum=number-of-method-trace-files ~ <Numeric character> ((1 to 16)) <<8>>

Specifies the maximum number of method trace files.

requesttrace-filenum=number-of-request-trace-files ~ <Numeric character> ((1 to 16)) <<4>>

Specifies the maximum number of request trace files. This property is valid only when you specify ON in the requesttrace property.

telegramtrace-filenum=number-of-user-message-trace-files ~ <Numeric character> ((1 to 16)) <<4>>

Specifies the maximum number of user message trace files. This property is valid only when you specify ON in the telegramtrace property.

bpacttrace-filenum=number-of-activity-trace-files-for-business-processes ~ <Numeric character> ((1 to 16)) <<4>>

Specifies the maximum number of activity trace files for business processes. This property is valid only when you specify ON in the bpacttrace property.

methodtrace-filesize=size-of-method-trace-files ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the maximum size of one method trace file in bytes.

requesttrace-filesize=size-of-request-trace-files ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the maximum size of one request trace file in bytes. This property is valid only when you specify ON in the requesttrace property.

telegramtrace-filesize=size-of-user-message-trace-files ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the maximum size of one user message trace file in bytes. This property is valid only when you specify ON in the telegramtrace property.

bpacttrace-filesize=size-of-an-activity-trace-file-for-business-processes ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the maximum size of one activity trace file for business processes in bytes. This property is valid only when you specify ON in the bpacttrace property.

bpacttrace-extend-item={NONE|PROCESSINSTANCEID} ~ <<NONE>>

Specifies whether to add output items to the activity trace for business processes. This property is valid only when you specify ON in the bpacttrace property.

NONE

No additional items are output to the activity trace.

PROCESSINSTANCEID

Process instance identifiers are output to the activity trace.

When activities are executed after a reply activity, the thread ID differs before and after the reply activity. In such cases, you can identify a request by outputting the process instance identifier.

telegramtrace-trigger={NORMAL|SYSERR|FAULT|DTERR} ~ <<NORMAL>>

Specifies the trigger that will output the user message trace. This property is valid only when you specify ON in the telegramtrace property.

NORMAL

Trace is output for a normal processing. Specify NORMAL in the test and debug environments by considering the effect on the processing performance of the HCSC server.

SYSERR

Trace is output when a system exception is detected.

FAULT

Trace is output when a fault is detected.

DTERR

Debug information is output when an error occurs during conversion processing of binary data.

The following table lists the combinations of output triggers for NORMAL, SYSERR, and FAULT and the messages that are output:

Output trigger

Timing

Message type

Request message

Response message

Fault message

NORMAL

For a normal processing

Y

Y

N

When a system exception is detected

N

N

N

When a fault is detected (not caught)

N

N

N

When a fault is detected (caught)

N

N

N

SYSERR

For a normal processing

N

N

N

When a system exception is detected

Y

N

N

When a fault is detected (not caught)

Y

N

N

When a fault is detected (caught)

N

N

N

FAULT

For a normal processing

N

N

N

When a system exception is detected

N

N

N

When a fault is detected (not caught)

Y

N

Y

When a fault is detected (caught)

Y

N

Y

Legend:

Y: Message is output.

N: Message is not output.

The following table lists the combinations of output trigger for DTERR and the information that is output:

Output trigger

Timing

Output information

DTERR

When binary data is read (transformation from binary to DOM)

Information about the message (binary or DOM) that was processed before an error occurred

When binary data is generated (transformation from DOM to binary)

Information about the message (DOM) that was processed before an error occurred

You can specify multiple values by using commas as delimiters. Even if you specify multiple triggers, the same information is not output repeatedly. For example, if a request message is already output for a normal processing, the message is not output when a system exception or a fault is detected.

telegramtrace-component-type-filepath=path-of-component-type-configuration-file-for-user-message-traces ~ <Character strings (including two-byte characters) and spaces>

If you want to output information for only the specific component types for the user message trace, specify the absolute path for the component-type configuration file in which the component types are specified. Use a forward slash (/) or two backslashes (\\) as a directory separator. An error occurs if you specify a non-existent file.

This property is valid only when you specify ON in the telegramtrace property and specify NORMAL in the telegramtrace-trigger property.

For details about how to define the component-type configuration file, see 6.5.9 Component-type configuration file.

There are the following two ways to specify the HCSC components for which the user message trace for normal processing is output. If you specify the same HCSC component in both the component-ID configuration file and the component-type configuration file, the setting of the component-ID configuration file will be applied.

Specify the component type (telegramtrace-component-type-filepath property).

Specify the HCSC component ID (telegramtrace-component-id-filepath property).

For details about the contents of the user message trace to be output with HCSC components specified, see 7.4.4 User message trace in the Service Platform Setup and Operation Guide.

telegramtrace-component-id-filepath=path-of-component-ID-configuration-file-for-user-message-traces ~ <Character strings (including two-byte characters) and spaces>

If you want to output information for only the specific HCSC components for the user message trace, specify the absolute path to the component-ID configuration file in which the HCSC component IDs and whether to output information are specified. Use a forward slash (/) or two backslashes (\\) as a directory separator. If you specify a non-existent file, an error occurs.

This property is valid only when you specify ON in the telegramtrace property and specify NORMAL in the telegramtrace-trigger property.

For details about how to define the component-ID configuration file, see 6.5.8 Component-ID configuration file.

There are the following two ways to specify the HCSC components for which the user message trace for normal processing is output. If you specify the same HCSC component in both the component-ID configuration file and the component-type configuration file, the setting of the component-ID configuration file will be applied.

Specify the component type (telegramtrace-component-type-filepath property)

Specify the HCSC component ID (telegramtrace-component-id-filepath property)

For details about the contents of the user message trace to be output with HCSC components specified, see 7.4.4 User message trace in the Service Platform Setup and Operation Guide.

methodtrace-level={1|2|3|4|5} ~ <<3>>

Specifies the output level for the method trace. The following table lists the output information and the output levels:

Output information

Output level

1

2

3

4

5

Information about the input file and output file (file path, file format, file size, and number of records)#1

Y#1

Y#1

Y#1

Y#1

Y#1

Entrance and exit information for the standard reception method (class name, method name, argument, return value)#2

N#2

Y#2

Y#2

Y#2

Y#2

Entrance and exit information for the external (such as BP) interfaces (class name, method name, argument, return value)

N

N

Y

Y

Y

Entrance and exit information for the interfaces within the components (class name, method name, argument, return value)

N

N

N

Y

Y

Debug information (information such as the branching of processing)

N

N

N

N

Y

Legend:

Y: Information is output.

N: Information is not output.

#1

Output only for file transformation operations.

#2

Not applicable to DB adapters.

requesttrace={ON|OFF} ~ <<ON>>

Specifies whether the request trace will be collected.

ON

The request trace will be collected.

OFF

The request trace will not be collected.

telegramtrace={ON|OFF} ~ <<OFF>>

Specifies whether the user message trace will be collected. Specify ON to output debug information.

ON

The user message trace will be collected.

OFF

The user message trace will not be collected.

bpacttrace={ON|OFF} ~ <<OFF>>

Specifies whether to collect activity traces for business processes. For details about activity traces, see 7.4.5 Activity trace in the Service Platform Setup and Operation Guide.

ON

Activity traces will be collected.

OFF

Activity traces will not be collected.

bptrace-level={0|10|20|30} ~ <<10>>

Specifies the output level of the method trace for the business process infrastructure. The following table lists the output information and the output levels:

Output level

Output content

0

Error information

10

Error information, I/O and data of other programs#

I/O and data of main functions

Start and stop of communication executed by the business process debugging functions, Start and stop of debug processing

20

Error information, I/O and data of other programs#

I/O and data of functions

30

Error information, I/O information of other programs#

I/O and data of functions

Point information for main locations

#

Also includes the messaging and data transformation infrastructures.

bptrace-filenum=number-of-BP-trace-files ~ <Numeric character> ((1 to 16)) <<16>>

Specifies the number of method trace files for the business process infrastructure.

bptrace-filesize=BP-trace-size ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the method trace size for the business process infrastructure in bytes.

bpexptrace-filenum=number-of-exception-log-files-for-business-process-infrastructure ~ <Numeric character> ((1 to 16)) <<16>>

Specifies the maximum number of exception log files for the business process infrastructure.

bpexptrace-filesize=size-of-exception-log-files-for-business-process-infrastructure ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the maximum size of one exception log file for the business process infrastructure in bytes.

cscexptrace-filenum=number-of-exception-log-files-for-messaging-infrastructure ~ <Numeric character> ((1 to 16)) <<16>>

Specifies the maximum number of exception log files for the messaging infrastructure.

cscexptrace-filesize=size-of-exception-log-files-for-messaging-infrastructure ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the maximum size of one exception log file for the messaging infrastructure in bytes.

(b) Associated with standard receptions

request-ejb.instance.minimum=minimum-number-of-standard-synchronous-reception-(SessionBean)-instances ~ <Numeric character> ((0, or 1 to value set in the request-ejb.instance.maximum property)) <<value set in the request-ejb.instance.maximum property >>

Specifies the minimum number of standard synchronous reception (SessionBean) instances in a pool. This property is valid only when you specify ON in the request-ejb property of the HCSC server setup definition file.

request-ejb.instance.maximum=maximum-number-of-standard-synchronous-reception-(SessionBean)-instances ~ <Numeric character> ((1 to 1024)) <<10>>

Specifies the maximum number of standard synchronous reception (SessionBean) instances in a pool. This property is valid only when you specify ON in the request-ejb property of the HCSC server setup definition file.

Specify at least 127 instances when you are using CTM and when you want to dynamically change the number of concurrent executions of CTM.

request-ejb.ctm={true|false} ~ <<false>>

Specifies whether the system will be integrated with CTM. This property is valid only when you specify ON in the request-ejb property of the HCSC server setup definition file.

true

The system will be integrated with CTM.

false

The system will not be integrated with CTM.

request-ejb.parallel.count=number-of-threads-prepared-to-invoke-applications-by-CTM ~ <Numeric character> ((1 to 127)) <<1>>

Specifies the number of threads prepared to invoke applications by CTM. This property is valid only when you specify true in the request-ejb.ctm property. Specify a value that is equal to or less than the value specified in the request-ejb.instance.maximum property.

request-ejb.optional.name=optional-name-of-standard-synchronous-reception-(SessionBean) ~ <Alphanumeric characters, underscores (_), periods (.), and forward slashes (/)> ((1 string length 255))

Specifies the optional name of the standard synchronous reception (SessionBean). Specify the same optional name with all the HCSC servers when you use a standard reception.

This property is valid only when the JavaVM system property ejbserver.cui.optionalname.enabled is set to true. For details on ejbserver.cui.optionalname.enabled, see 5.2.3 usrconf.properties (System property file for server management commands) in the Application Server Definition Reference Guide.

Note that a request reception cannot be invoked if the following names are specified:

Names duplicated with the following values (with the running status):

Service ID of a service adapter

Service ID of a business process

Reception ID of a user-defined reception

Other names, such as the value specified for optional-name of J2EE applications

Names beginning with HITACHI_EJB

Names with forward slashes (/) or periods (.) at the beginning or end

Names containing only forward slashes (/) or only periods (.)

Names containing a series of forward slashes (/)

Names containing a series of forward slashes (/) and periods (.)

Also, any spaces or linefeeds before and after a string are removed. An error occurs if a string contains a space or a linefeed character.

request-soap.instance.minimum=minimum-number-of-concurrent-executions-of-standard-synchronous-reception-(Web Service/ SOAP 1.1) ~ <Numeric character> ((0, or 1 to value set in the request-soap.instance.maximum property)) << value set in the request-soap.instance.maximum property>>

Specifies the minimum number of concurrent executions of a standard synchronous reception (Web Service/ SOAP 1.1) in a pool. This property is valid only when you specify ON in the request-soap property of the HCSC server setup definition file.

request-soap.instance.maximum=maximum-number-of-concurrent-executions-of-standard-synchronous-reception-(Web Service/ SOAP 1.1) ~ <Numeric character> ((1 to 1024)) <<10>>

Specifies the maximum number of concurrent executions of a standard synchronous reception (Web Service/ SOAP 1.1) in a pool. This property is valid only when you specify ON in the request-soap property of the HCSC server setup definition file.

request-soap.exclusive.threads=number-of-dedicated-threads-for-standard-synchronous-reception-(Web Service/ SOAP 1.1) ~ <Numeric character> ((0 to 1024)) <<0>>

Specifies the number of dedicated threads for a standard synchronous reception (Web Service/ SOAP 1.1) in a pool. Specify a value that does not exceed the maximum number of concurrent executions (request-soap.instance.maximum). If you specify 0, no threads are dedicated.

Note that this value is set up for the WAR attribute thread-control-exclusive-threads. Therefore, you must specify this value after considering the maximum threads and the maximum number of connections for the entire Web container.

request-soap.queue-size=size-of-pending-queue-for-standard-synchronous-reception-(Web Service/ SOAP 1.1) ~ <Numeric character> ((0 to 2147483647)) <<8192>>

Specifies the size of the pending queue for a standard synchronous reception (Web Service/ SOAP 1.1) in a pool.

request-soap1_2.instance.minimum=minimum-number-of-concurrent-executions-of-standard-synchronous-reception-(Web Service/ SOAP 1.2) ~ <Numeric character> ((0, or 1 to value set in the request-soap1_2.instance.maximum property)) <<value set in the request-soap1_2.instance.maximum property>>

Specifies the minimum number of concurrent executions of a standard synchronous reception (Web Service/ SOAP 1.2) in a pool. This property is valid only when you specify ON in the request-soap property of the HCSC server setup definition file.

request-soap1_2.instance.maximum=maximum-number-of-concurrent-executions-of-standard-synchronous-reception-(Web Service/ SOAP 1.2) ~ <Numeric character> ((1 to 1024)) <<10>>

Specifies the maximum number of concurrent executions of a standard synchronous reception (Web Service/ SOAP 1.2) in a pool. This property is valid only when you specify ON in the request-soap property of the HCSC server setup definition file.

request-soap1_2.exclusive.threads=number-of-dedicated-threads-for-standard-synchronous-reception-(Web Service/ SOAP 1.2) ~ <Numeric character> ((0 to 1024)) <<0>>

Specifies the number of dedicated threads for a standard synchronous reception (Web Service/ SOAP 1.2) in a pool. Specify a value that does not exceed the maximum number of concurrent executions (request-soap1_2.instance.maximum). If you specify 0, no threads are dedicated.

Note that this value is set up for the WAR attribute thread-control-exclusive-threads. Therefore, you must specify this value considering the maximum threads and the maximum number of connections for the entire Web container.

request-soap1_2.queue-size=size-of-pending-queue-for-standard-synchronous-reception-(Web Service/ SOAP 1.2) ~ <Numeric character> ((0 to 2147483647)) <<8192>>

Specifies the size of the pending queue for a standard synchronous reception (Web Service/ SOAP 1.2) in a pool.

request-jms.instance.maximum=maximum-number-of-standard-asynchronous-reception-(MDB(WS-R))-instances ~ <Numeric character> ((1 to 1024)) <<10>>

Specifies the maximum number of standard asynchronous reception (MDB(WS-R)) instances in a pool. This property is valid only when you specify ON in the request-jms property of the HCSC server setup definition file.

request-jms.rollback-count=rollback-warning-message-output-count-for-standard-asynchronous-reception-(MDB(WS-R)) ~ <Numeric character> ((1 to 2147483647)) <<0>>

Outputs a warning message (KDEC00049-W) for a MDB (WS-R) reception when the extraction and the rollback of the same message from the queue are executed more than the specified number of times. If you specify 0, no warning message is output.

receptionstop-monitor-timer=timeout-value-for-monitoring-reception-queue ~ <Numeric character> ((0 to 600)) <<0>>

Specifies the timeout value for the processing of messages of an asynchronous standard reception (MDB (WS-R) and MDB (DB queue)) in seconds.

From the maximum number of messages in the queue and the processing time per message, calculate the maximum time for which the in-process messages remain in the queue, and then specify a value in seconds that is greater than this value. To specify a value other than 0, you must also specify a value in the csc-receptionstop-timeout property.

Note that you can specify the default value (no timeout) if any of the following cases are applicable:

If an asynchronous standard reception (MDB (WS-R) and MDB (DB queue)) is not used

If a planned termination is not executed

A timeout does not occur if you specify 0. Note that if a dead message queue is not set in Reliable Messaging, an infinite loop might occur due to the rollback operation. Therefore, do not specify 0.

csc-receptionstop-timeout=communication-timeout-value-to-wait-for-reception-termination ~ <Numeric character> ((0 to 86400)) <<value set in the csc-command-timeout property>>

Specifies the timeout value for the communication processing of an asynchronous standard reception (MDB (WS-R) and MDB (DB queue)) in seconds. Specify a timeout value that is longer than the value set in the receptionstop-monitor-timer property.

Note that you can specify the default value (value set in the csc-command-timeout property) if any of the following cases are applicable:

If an asynchronous standard reception (MDB (WS-R) and MDB (DB queue)) is not used

If a planned termination is not executed

A timeout does not occur if you specify 0.

(c) Associated with service adapters

soapfault-targetnamespace-filepath=absolute-path-of-SOAP-fault-operation-definition-file ~ <Character string>

Specifies an absolute path for the SOAP fault operation definition file. Use the characters / or \\ as directory delimiters. Specify this property when you want the SOAP adapter to handle all the SOAP Faults from Web Services as faults.

For details about the SOAP fault operation definition file, see 6.6.1 SOAP fault operation definition file.

soapfault-handling-mode={DETAIL|FAULTCODE} ~ <<FAULTCODE>>

Specifies the operation mode in which the SOAP adapter determines whether to handle SOAP Faults from Web Services as faults. We recommend that you specify DETAIL in this property. If you want to emphasize the compatibility with 09-70 or earlier, specify FAULTCODE.

DETAIL

Whether to handle SOAP Faults as faults is determined based on the child element directly under the detail element of the SOAP Fault in SOAP1.1 (or under the Detail element of the SOAP Fault in SOAP1.2).

FAULTCODE

Whether to handle SOAP Faults as faults is determined based on the value of the faultcode element of the SOAP Fault in SOAP1.1. In SOAP1.2, SOAP Faults are not handled as faults.

oa-adapter-character-code={SJIS|MS932} ~ <<SJIS>>

Specifies the character code of messages that the Object Access adapters send to and receive from service components.

The specified character code is used by all Object Access adapters.

(d) Associated with data transformation

formatdef-maxcache-num=number-of-cacheable-format-definitions ~ <Numeric character> ((1 to 2147483647)) <<2147483647>>

Specifies the number of cacheable format definitions. The number of format definitions used in an HCSC server is the sum total of the following:

Even if you specify a value greater than the sum total, memory space exceeding the required size will not be used. If you want to cache all the format definitions in the repository, specify a large value.

Number of all message type variables defined in each business process

Number of all request message formats defined in each user-defined reception

Number of all response message formats defined in each user-defined reception

Number of all request message formats defined in each service adapter

Number of all response message formats defined in each service adapter

transformdef-maxcache-num=number-of-cacheable-data-transformation-definitions-for-servers ~ <Numeric character> ((1 to 2147483647)) <<2147483647>>

Specifies the number of cacheable data transformation definitions. To reuse the data transformation definitions, specify a value that is equal to or greater than the number of defined data transformations.

Even if you specify a value greater than the number of defined data transformations, memory space exceeding the required size will not be used. If you want to cache all the data transformation definitions in the repository, specify a large value.

xmltelegram-maxcache-num=number-of-cacheable-XML-messages ~ <Numeric character> ((0 to 2147483647)) <<0>>

Specifies the number of cacheable XML message objects. By reusing the cached XML message objects, you can reduce the time for processing the XML messages of the same format. To reuse the XML messages, specify a value that is equal to or greater than the following value:

(The-number-specified-for-the-service-adapter-or-business-process-data-transformation) + (The-number-specified-for-the-business-process-path-operations)

If you specify 0, the XML message objects are not cached.

Note that the processing time might be more for XML messages with less number of elements.

telegram-validation={ON|OFF} ~ <<OFF>>

Validates whether the message to be sent or received is appropriate for the specified message format (data validation function).

ON

The message format will be validated.

OFF

The message format will not be validated.

For details on the data validation function, see 6.2 Data validation function in the manual Service Platform Overview.

xmltelegram-namespace-complement={ON|OFF} ~ <<OFF>>

Specifies whether the namespace declaration corresponding to the namespace prefix that is specified in the attribute value existing in an XML message, for the XML messages that flow within an HCSC server, will be complemented.

ON

The namespace declaration corresponding to the namespace prefix will be complemented.

OFF

The namespace declaration corresponding to the namespace prefix will not be complemented.

Specify ON to use the QName type as the type of XML schema attribute values, for the user messages flowing within an HCSC server. However, note that if you specify ON, the message size becomes larger than when OFF is specified.

For details, see 4.5 Complementing the namespace prefixes specified for the attribute values in XML messages in the manual Service Platform Overview.

telegram-undefined-character-code={ERROR | REPLACE} ~ <<ERROR>>

Specifies the operations to be performed when an undefined character encoding is detected during the conversion of character encoding for binary data.

ERROR

An error occurs during the detection process and the processing ends.

REPLACE

The undefined part of the character code is replaced with a blank character code or a user-specified character code, and processing continues.

You can replace all the spaces with two-byte characters and also with two-byte or one-byte characters according to the shift or escape status. For details on how to specify the settings, see 1.3.1 Format dialog.

telegram-notfound-soapheader={ERROR|IGNORE} ~ <<IGNORE>>

Specifies whether the processing continues if the headers, specified for the messages to be sent and received, do not exist for the reception definition file, service adapter definition file, or business process definition file.

ERROR

If the headers specified in the definition file do not exist, an error message is displayed and the processing is canceled.

IGNORE

If the headers specified in the definition file do not exist, the specification is ignored and processing continues.

validation-activity={ON|OFF} ~ <<ON>>

Defines whether the message type variables (XML) will be validated with the validation activity. The validation activities of all the business processes in an HCSC server are targets for validation.

ON

The message type variables (XML) specified in the validation activity will be validated.

OFF

The message type variables (XML) specified in the validation activity will not be validated.

transform-binary-error-check={ON|OFF} ~ <<ON>>

Defines whether an error check will be implemented during binary data transformation. You can check whether the binary data generated due to the extension of the data transformation activity is in accordance with the binary format definition.

ON

An error check will be performed to check if the binary data is in accordance with the binary format definition. Specify ON to convert the data to binary data during data transformation.

OFF

An error check will not be performed to check if the binary data is in accordance with the binary format definition.

code-table-root-path=absolute-path-of-root-path-of-code-conversion-table-storage-path ~ <Character strings (including two-byte characters) and spaces> <<service-platform-installation-directory\\CSC\\userlib\\codetables>>

Specifies, as an absolute path, the root path of the code conversion table storage path. Use a forward slash (/) or two backslashes (\\) as a directory separator. If you specify a non-existent directory, the HCSC server fails to start.

(e) Associated with business processes

syserr-to-fault-convert={ON|OFF} ~ <<OFF>>

Defines whether a general fault will be generated when a system exception occurs in the data transformation activity, assign activity, or switch activity.

ON

A system exception will be caught and a general fault will be generated.

OFF

A general fault will not be generated when a system exception occurs.

validate-fault-compatible={ON|OFF} ~ <<ON>>

Defines whether the format of the fault message sent due to the validate fault will be the format used until 09-00 or earlier.

ON

The fault message will be sent in the format used in 09-00 or an earlier format.

OFF

The fault message will be sent in the new format that includes the process instance identifier and the activity name.

bp-reply-after-min-thread-pool-size=minimum-number-of-threads-used-for-executing-activities-after-response-activity ~ <Numeric character> ((1-2147483647)) <<16>>

Defines the minimum number of unused threads that are saved in a thread pool and that will be used for executing activities after a response activity.

The defined information takes effect for each HCSC server. Therefore, specify a value with consideration of the number of concurrent executions of a business process that has defined activities after a response was made within the HCSC server.

If you specify a value greater than the value of the bp-reply-after-max-thread-pool-size property, an error occurs during execution of the cscsvconfig command.

bp-reply-after-max-thread-pool-size=maximum-number-of-threads-used-for-executing-activities-after-response-activity ~ <Numeric character> ((1-2147483647)) <<32>>

Defines the maximum number of threads that can be created in a thread pool and that will be used for executing activities after a response activity.

The defined information takes effect for each HCSC server. Therefore, specify a value with consideration of the number of concurrent executions of a business process that has defined activities after a response was made within the HCSC server.

bp-reply-after-thread-pool-keep-alive=retention-time-of-threads-used-for-executing-activities-after-response-activity ~ <Numeric character> ((1-2147483647)) <<60>>

Defines the time, in seconds, to retain a thread by its end if the number of threads that have not been used for executing activities after a response activity exceeds the value specified for bp-reply-after-min-thread-pool-size.

The defined information takes effect for each HCSC server. Therefore, specify a value with consideration of the number of concurrent executions of a business process that has defined activities after a response was made within the HCSC server.

service-emulate.enable={true|false} ~ <<false>>

Specifies whether to enable the service emulation function.

true

The service emulation function is enabled.

false

The service emulation function is not enabled.

service-emulate-def-filepath=absolute-path-of-definition-file-for-emulated-configuration-information ~ <Character strings (including two-byte characters) and spaces>

Specifies the absolute path to the definition file for emulated configuration information when the service emulation function is enabled (service-emulate.enable=true is specified) in the execution environment. You can use a forward slash (/) or two backslashes (\\) as a directory separator.

If you omit this property when service-emulate.enable=true is specified, an error occurs during execution of the cscsvconfig command.

For details about how to configure the definition file for emulated configuration information, see 6.5.7 Definition file for emulated configuration information.

(f) Associated with J2EE

j2ee-stopapp-timeout=stop-monitoring-time-of-J2EE-applications ~ <Numeric character> ((0 to 2147483647)) <<60>>

Specifies the monitoring time for stopping the J2EE applications, issued by the commands for stopping request receptions and business processes or service adapters, in seconds. If a request is being processed, the system stands by for the specified time only.

After the timeout occurs, the request receptions, business processes, and service adapters will be forcefully stopped.

startcsc-timeout=start-monitoring-time-of-J2EE-servers ~ <Numeric character> ((1 to 2147483647)) <<180>>

Specifies the monitoring time to monitor the starting of J2EE servers with the HCSC server start command, in seconds. Even if the HCSC server start command times out, the J2EE server start processing continues.

Note that you need not specify this property because this property is disabled even if you specify it in 09-50 and later.

stopcsc-timeout=stop-monitoring-time-of-J2EE-servers ~ <Numeric character> ((1 to 2147483647)) <<180>>

Specifies the monitoring time to monitor the stopping of J2EE servers with the HCSC server stop command, in seconds. Even if the HCSC server stop command times out, the J2EE server stop processing continues.

Note that you need not specify this property because this property is disabled even if you specify it in 09-50 and later.

(g) Monitoring the communication timeout value for commands

csc-command-timeout=command-timeout-value ~ <Numeric character> ((0 to 86400)) <<300>>

Specifies the timeout value in seconds for reporting to the client when a J2EE server slows down or when there is a communication error between a J2EE server and the database with the following functions:

Commands beginning with csc

Management GUI (Eclipse)

Development window GUI (Eclipse)

A timeout does not occur if you specify 0.

csc-precache-timeout=timeout-value-for-EJB-communication-with-business-process-for-pre-cache-processing ~ <Numeric character> ((0 to 86400)) <<0>>

Specifies the timeout value for the pre-cache processing in business processes in seconds.

A timeout does not occur if you specify 0.

(h) Inheriting the Cookie information

cookie-parsing={ON|OFF} ~ <<OFF>>

Specifies whether the Cookie information will be inherited.

ON

The Cookie information will be implicitly inherited.

OFF

The Cookie information will not be implicitly inherited.

(i) Associated with folders

work-folder=absolute-path-of-work-folder ~ <Character strings (including two-byte characters) and spaces> <<service-platform-installation-directory\\CSC\\spool\\ftp\\work>>

Specifies an absolute path for the work folder root. Use the characters / or \\ as directory delimiters. The HCSC server fails to start if you specify a non-existent directory.

A path of 153 bytes is required for the product under the specified work folder. When you specify any work folder root, make sure that the path does not exceed the maximum path length of the OS.

common-folder-common-folder-definition-name=absolute-path-of-common-folder ~ <Character strings (including two-byte characters) and spaces> ((1 string length 64)) <<service-platform-installation-directory\\CSC\\spool\\ftp\\com>>

Specifies an absolute path of the common folder. You can specify the same directory by specifying different common folder definition names.

common-folder-definition-name

You can specify alphanumeric characters and underscores (_) for the common folder definition name.

If you omit the specification, the common folder definition name will be default.

Absolute path of the common folder

Use a forward slash (/) or two backslashes (\\) as a directory separator. If you specify a non-existent directory, the HCSC server fails to start.

When the common folder is used, a path of the following length is created under the common folder. Considering this path, specify the common folder so that the total path length does not exceed the maximum path length of the OS.

Length of the user-specified file name + 106 bytes

For HTTP adapters and mail adapters, the path length to be used differs depending on the function. The following table lists the path length required for each function:

Service adapter type

Function

Total path length#1

HTTP adapter

Sending files for an HTTP request

Total sum of the following in bytes:

Number of bytes in the path of the common folder root

Number of bytes in the path under the common folder (106 bytes#2)

Number of bytes in the file name to be used

Downloading files for an HTTP response

Total sum of the following in bytes:

Number of bytes in the path of the common folder root

Number of bytes in the path under the common folder (156 bytes#2)

Mail adapter

Sending a file used as the mail body

Total sum of the following in bytes:

Path of the common folder root

Number of bytes in the path under the common folder (106 bytes#2)

Number of bytes in the file name to be used

Sending email attachments

#1

When a subfolder is used, the length of the relative path of the subfolder is also added.

#2

When a subfolder is used, 1 byte is added to the path length.

(j) Associated with DB adapters

dba-separate-transaction={true|false} ~ <<false>>

Specifies whether to start DB adapter transactions separately from the business processes.

To start a DB adapter transaction separately from a business process, either specify true, or specify Y in the dba_separate_transaction attribute of the SQL operation definition file, and then change the value specified for the trans-attribute element of the HITACHI Application Integrated Property File for DB adapters from Required to RequiresNew.

true

A DB adapter transaction will be started separately from a business process.

false

The same transaction as a business process will also be used in the DB adapter as well.

(k) Associated with component-common UOC

common-uoc-prop-path=folder-for-storing-component-common-UOC-property-file ~ <String (including two-byte characters)>

Specifies an absolute path for the storage folder of the component-common UOC property file. Use the characters / or \\ as folder delimiters. Note that an exception occurs while the HCSC server runtime definition file is being read if you do not specify a storage folder and only specify the property name.

If you specify the component-common UOC property file, the component-common UOC function is used and the trace based performance analysis is output before and after a UOC class is invoked.

For details on how to specify the component-common UOC property file, see Appendix G. Component-common UOC in the Service Platform Basic Development Guide. Also, for details on the trace based performance analysis output with the component-common UOC function, see 7.4.3 Performance Analysis Trace in the uCosminexus Service Platform Setup and Operation Guide.

(l) Associated with HCSC servers

short-processid-servername=HCSC-server-name-identifier-to-be-used-with-process-instance-identifier ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters)) <HCSC-server-name>

Specifies the HCSC server name identifier to be used with the process instance identifier. Specify an identifier that is unique in the cluster. The operations might not function properly if you do not specify a unique value.

This property is valid only when you specify ON in the short-processid property.

short-processid={ON|OFF} ~ <<OFF>>

Specifies whether the process instance identifier will be shortened. If the local machine has an IPv6 address and the J2EE server name contains 111 bytes or more, an error might occur during generation of process instances. If such errors occur, specify ON.

ON

The process instance identifier will be shortened.

OFF

The process instance identifier will not be shortened.

(m) Instance pool

xml-pooled-instance-minimum=minimum-number-of-pooled-instances-of-classes-used-in-XML-processing ~ <Numeric character> ((0 to 2147483647)) <<0>>

Specifies the minimum number of instances to be cached for the classes to be used for processing requests and response messages. Specify a value that is equal to or less than the value specified for the xml-pooled-instance-maximum property. If you specify a value that is greater than the xml-pooled-instance-maximum property, an error occurs during the execution of the cscsvconfig command.

When an HCSC server starts, the number of instances specified in this property are generated and set up in a pool. If you specify 0, the instances are not cached when the HCSC server starts.

If the csc.dt.pool.DocumentBuilder.initialSize property is set in usrconf.properties (user property file for J2EE servers), specify the same value as that property.

xml-pooled-instance-maximum=maximum-number-of-pooled-instances-of-classes-used-in-XML-processing ~ <Numeric character> ((0 to 2147483647)) <<64>>

Specifies the maximum number of instances to be cached for the classes to be used for processing requests and response messages.

If the csc.dt.pool.DocumentBuilder.maxSize property of usrconf.properties (user property file for J2EE servers) is set, specify the same value as that property. If the csc.dt.pool.DocumentBuilder.maxSize property is not set up, specify a value that is equal to or greater than the total of the maximum number of executions of all the request receptions in an HCSC server.

If you specify 0, the instances are not cached.

If the received requests exceed the maximum specified number, you might have to wait for the requests to be processed.

(n) Associated with custom reception

request-id-separate-key={slash|atsign|period} ~ <<slash>>

Specifies a separate key of the request ID generated by an FTP reception or HTTP reception.

slash

A halfwidth forward slash (/) will be used as a separate key of the request ID.

atsign

A halfwidth at mark (@) will be used as a separate key of the request ID.

period

A halfwidth period (.) will be used as a separate key of the request ID.

Important note

When changing the separate key of the request ID, make sure that there is no process instance in the Error or Executing status.

This modification applies to Service Coordinator 09-51-01 or later.

fileevent-reception.monitored-file.enabled={true|false} ~ <<false>>

Specifies whether to allow file monitoring.

true

The file monitoring function is enabled. When you use the file event reception, specify true.

false

The file monitoring function is disabled.

fileevent-reception.monitored-folder=absolute-path-of-monitored-folder ~ <Character strings (including two-byte characters) and spaces> <<service-platform-installation-directory\\CSC\\spool\\fileevent>>

Specifies the absolute path to the monitored folder. Use a forward slash (/) or two backslashes (\\) as a directory separator. Do not specify the same directory as the common folder.

If you do not specify the absolute path or specify a non-existent directory, the HCSC server fails to start.

When you monitor the files to be acquired, there is no need to specify this property. This property is disabled even if specified.

fileevent-reception.monitor-interval=file-monitoring-interval ~ <Numeric character> ((1 to 44640)) <<10>>

Specifies the file monitoring intervals in minutes.

fileevent-reception.monitor-starting.delay=time-to-wait-before-file-monitoring-starts ~ <Numeric character> ((1 to 44640)) <<10>>

Specifies the number of minutes that can elapse before the file monitoring starts after startup of the HCSC server.

The file monitoring will start when the time specified here elapses after the HCSC server startup command is executed.

(5) Example of coding

A sample file is as follows:

methodtrace-filepath=c:\\TMP
requesttrace-filepath=c:\\TMP
telegramtrace-filepath=c:\\TMP
methodtrace-filenum=8
requesttrace-filenum=4
telegramtrace-filenum=4
methodtrace-filesize=2097152
requesttrace-filesize=2097152
telegramtrace-filesize=2097152
telegramtrace-trigger=NORMAL
methodtrace-level=3
requesttrace=ON
telegramtrace=ON
bptrace-level=10
bptrace-filenum=16
bptrace-filesize=2097152
request-ejb.instance.minimum=10
request-ejb.instance.maximum=10
request-ejb.ctm=false
request-ejb.parallel.count=1
request-soap.instance.minimum=10
request-soap.instance.maximum=10
request-jms.instance.maximum=10
receptionstop-monitor-timer=0

(6) Usage

Specify the HCSC server runtime definition file in the argument of the -propfile option of the cscsvconfig command. For details on how to do this, see 3.1.4 Setting up the HCSC server definition information in the uCosminexus Service Platform Setup and Operation Guide.

(7) Notes

Note the following when you specify the path:

Do not specify a path that contains characters expressing a relative path or a parent directory (..\ or ../) or characters expressing a current directory (.\ or ./).

Do not specify a path containing a symbolic link.

In Windows, do not specify a path containing a UNC format, an NTFS stream name, or a reserved device name. The path characters are not case sensitive.

6.5.7 Definition file for emulated configuration information

(1) Format

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE HCSCAutoEmulate SYSTEM "debug_auto_emulate_list_file_1_0.dtd">
<HCSCAutoEmulate>
<viewState>
<emulate condition="(conditional-expression)" operation="(operation-name)" service="(service-name)" type="(response-type)" valid="(whether-to-perform-emulation)" xmlfile="(path-of-response-message-file)"/>
<emulate condition="(conditional-expression)" operation="(operation-name)" service="(service-name)" type="(response-type)" valid="(whether-to-perform-emulation)" xmlfile="(path-of-response-message-file)"/>
 ...
</viewState>
</HCSCAutoEmulate>

(2) Function

Specifies the configuration information for the emulation function in XML format. For details about the service emulation function, see the manual Service Platform Overview.

The definition file for emulated configuration information is read and parsed for each request at the following timing:

At the execution of the invoke service activity that is first defined in the business process

At the execution of the invoke service activity that is first defined after a reply activity

At the execution of the invoke service activity that is first defined after a standby activity

When a process instance is re-executed, this file is read and parsed at the execution of the invoke service activity that is first defined in the re-execution range.

A response message file specified in the xmlfile attribute is also read for each request. Therefore, any changes in the definition file for emulated configuration information or the response message file will be applied at the next request. Note that operations are not guaranteed if the contents of these files are changed during processing of a request.

Important note

If you emulate a response message by using the business process debug function in the development environment, the settings of the definition file for emulated configuration information are not enabled for the relevant invoke service activity.

During emulation, a service adapter is not invoked. Therefore, the functions specific to service adapters and used by service adapters, and some functions of the invoke service activity of a business process cannot be used.

Use the following procedure to create a definition file for emulated configuration information and apply it to the execution environment.

Copy the following template file to any directory.

service-platform-installation-directory\CSC\config\msg\templates\service_emulate_info.aels

You must define the file based on the template file. Operations are not guaranteed if the file is created in any other way.

Edit the element descriptions, and then save the file with any file name with the extension .aels.

If the extension is not .aels, an error occurs when you execute the cscsvconfig command (HCSC server runtime definitions).

(3) Specifiable elements

<?xml version="1.0" encoding="UTF-8"?>

An XML declaration indicating that this file is an XML file

<!DOCTYPE HCSCAutoEmulate SYSTEM "debug_auto_emulate_list_file_1_0.dtd">

An element-type declaration indicating a DTD subset

<HCSCAutoEmulate>

A root element for emulated configuration information

<viewState>

A root element for emulated configuration information

<emulate condition="(conditional-expression)" operation="(operation-name)" service="(service-name)" type="(response-type)" valid="(whether-to-perform-emulation)" xmlfile="(path-of-response-message-file)"/>

An element that defines emulated configuration information. You can define multiple emulate elements.

If multiple emulate elements that meet the following conditions are defined, the emulate elements are enabled in the order they appear.

The evaluation result of the conditional expression specified in the condition attribute is true.

The service attribute and the operation attribute have the same value.

The valid attribute is set to true.

For details about the priority of emulate elements, see (4) Priority of definitions used for emulation.

The following describes the contents to be specified in the emulate element.

condition="(conditional-expression)"

Enter the conditional expression for emulating the service, by using a string-type XPath.

You can specify the conditional expression only when the variable type of the request message is XML or non-XML. Operations are not guaranteed if the variable type is any.

The conditional expression is evaluated when valid=true (emulation function enabled) is set.

Note the following when you specify the conditional expression:

Specify an empty string if you do not use a conditional expression. If no conditional expression is used, true is assumed as the evaluation result of the conditional expression.

When you specify an XPath in a conditional expression, do not acquire information by using an extension function (for example, bpws:getVariableProperty) or by directly specifying a variable name. If you use such methods to specify an XPath, operations are not guaranteed.

To include an escape character (<, >, &, ", ') in the conditional expression, specify an entity reference.

operation="(operation-name)"

Specify the operation name of the service adapter in the string type.

service="(service-name)"

Specify the service name of the service adapter in the string type.

type="(response-type)"

Specify one of the following response types.

RESPONSE_NORMAL

This option specifies the normal response.

The contents of the response message file will be returned as a response message.

RESPONSE_FAULT

This option specifies the fault response.

The contents of the response message file will be returned as a fault message.

valid="(whether-to-perform-emulation)" ~ <<false>>

Select one of the following to specify whether to perform emulation.

true

Emulation is performed.

false

The service adapter is invoked without performing emulation.

xmlfile="(path-of-response-message-file)"

Specify the path of the response message file that contains the messages to be emulated, by using a string-type absolute path.

For a path separator, specify a forward slash (/) for the HCSC server in Windows and specify a backslash (\) for the HCSC server in UNIX.

To include an escape character (<, >, &, ", ') in the file path, specify an entity reference.

To specify XML format data for the response message, make sure that the XML character code is UTF-8.

Note that if you specify an XSLT style sheet (file extension: .xsl) for a response message, a message transformed from a request message by using the XSLT style sheet can be emulated as the response message. Note the following when you perform this emulation:

You can perform the emulation when the variable type is XML for both the request message and the response message. If the variable type of both messages is not XML, operations are not guaranteed.

You can specify only one transformation source (request message).

For the XSLT style sheet, you must specify a data transformation definition file generated by the mapping definition editor. In addition, the file extension must be .xsl. If any other file is specified, operations are not guaranteed.

(4) Priority of definitions used for emulation

The priority of definitions used for emulation is given in the order in which the emulate elements appear in the definition file for emulated configuration information.

The priority is applied to the emulate elements that meet the following conditions in the definition file for emulated configuration information:

The same value is set for the service attribute and operation attribute.

The valid attribute is set to true.

In the following example, false is set for the valid attribute of the first emulate element. Therefore, the emulation will be performed for the configuration information for the second emulate element.

                   :
<viewState>
<emulate condition="/root/elm1 = &quot;exec1&quot;" operation="exec" service="TP1Adapter" type="RESPONSE_NORMAL" valid="false" xmlfile="/data/telegram/exec1"/>
<emulate condition="/root/elm1 = &quot;exec2&quot;" operation="exec" service="TP1Adapter" type="RESPONSE_NORMAL" valid="true" xmlfile="/data/telegram/exec3"/>
<emulate condition="" operation="exec" service="TP1Adapter" type="RESPONSE_NORMAL" valid="true" xmlfile="/data/telegram/exec3"/>
</viewState>
                   :

Note that this priority does not apply to the emulate elements for which the evaluation result of the conditional expression specified in the condition attribute is false. Therefore, the response message to be emulated can be changed according to the evaluation result of the conditional expression.

The following example shows that conditional expressions are specified in the condition attributes of some emulate elements. The conditional expressions define that the response message to be emulated changes according to the value set for the elm1 element of the request message.

Figure 6‒1: Definition example when conditional expressions are specified in the definition file for emulated configuration information

To define a conditional expression (XPath), you must specify the path of an element of the request message to be evaluated. You can obtain the path by selecting the relevant variable from the variable list in the Business Process Definition window and then clicking the Display button.

In the figure, the three emulate elements have the same values of the service and operation attribute, and the valid attribute is set to true. Therefore, the emulate element that becomes valid changes as follows according to the evaluation result of the conditional expression specified in the condition attribute.

When the value of the request message is exec1

The first emulate element is valid.

When the value of the request message is exec2

Because the evaluation result of the conditional expression of the first emulate element is false, the conditional expression of the second emulate element is evaluated.

Because the evaluation result of the conditional expression of the second emulate element is true, the second emulate element becomes valid.

When the value of the request message is exec3

Because the evaluation result of the conditional expressions of the first and second emulate elements are false, the third emulate element becomes valid.

(5) Example of coding

The following is an example of coding of the definition file for emulated configuration information. This example indicates that the exec operation of the TP1 adapter is emulated.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE HCSCAutoEmulate SYSTEM "debug_auto_emulate_list_file_1_0.dtd">
<HCSCAutoEmulate>
<viewState>
<emulate condition="" operation="exec" service="TP1Adapter" type="RESPONSE_NORMAL" valid="true" xmlfile="/data/telegram/exec1"/>
</viewState>
</HCSCAutoEmulate>

The following values are set in this example:

Attribute name

Set value

condition

An empty string ("") is set to indicate that no conditions are to be defined.

operation

exec selected for the operation name of the invoke service activity is set.

service

TP1Adapter selected for the service name of invoke service activity is set.

type

RESPONSE_NORMAL is set.

valid

true is set to perform the emulation.

xmlfile

The response message file /data/telegram/exec1 is set.

The contents of this file will be set in the out body allocated variable for the response message of the invoke service activity.

6.5.8 Component-ID configuration file

(1) Format

[HCSC-component-ID={ON|OFF}]
 ...
[HCSC-component-ID={ON|OFF}]

(2) Function

Specifies whether to output HCSC component information for the user message trace based on HCSC component IDs (reception IDs or service IDs). Specify one HCSC component in one file in the J2SE property file format.

Reference note

To specify whether to output the user message traces based on HCSC component types, set up the component-type configuration file.

You can set up both the component-ID configuration file and the component-type configuration file. If you specify the same HCSC component in both of these files, the setting of the component-ID configuration file will be applied.

(3) File storage location

There is no template file for a component-ID configuration file.

You can store the created component-ID configuration file with any name and in any location.

To enable the created component-ID configuration file, specify the path in the telegramtrace-component-id-filepath property of the HCSC server runtime definition file.

(4) Specifiable parameters

HCSC-component-ID={ON|OFF}

Specifies whether to output HCSC component information for the user message trace.

HCSC-component-ID

Specify the service ID or reception ID.

{ON|OFF}

Specifies whether to output the specified HCSC component information for the user message trace.

ON: Information is output for the user message trace.

OFF: Information is not output for the user message trace.

The setting (ON or OFF) is determined based on exact match. If you specify any other value or empty characters, the operation is the same as when no component ID is specified.

Note that you can also use the component-type configuration file (containing the HCSC component types) to specify whether to output HCSC component information for the user message trace. If you specify the same HCSC component in the component-ID configuration file and the component-type configuration file, the setting of the component-ID configuration file will be applied.

(5) Example of coding

The following shows an example when the following information is output for the user message trace:

Information for HCSC component ID RCP1 is output.

Information for HCSC component ID ADP1 is not output.

In this case, specify as follows in the component-ID configuration file.

RCP1=ON
ADP1=OFF

To output information for all FTP receptions and FTP adapters except for HCSC component IDs FTP_RCP1, FTP_ADP1, and FTP_ADP3 for the user message trace, specify as follows in the component-type configuration file and the component-ID configuration file.

Contents of the component-type configuration file (output of FTP receptions and FTP adapters) are as follows:

reception.urecp.ftp
adapter.ftp

Contents of the component-ID configuration file (excluding HCSC component IDs FTP_RCP1, FTP_ADP1, and FTP_ADP3 from the output target) are as follows:

FTP_RCP1=OFF
FTP_ADP1=OFF
FTP_ADP3=OFF

6.5.9 Component-type configuration file

(1) Format

[HCSC-component-type]
 ...
[HCSC-component-type]

(2) Function

Specifies the types of HCSC components to output information for the user message. You can specify one HCSC component type in one line. Specify this file in the J2SE property file format.

Reference note

To specify whether to output the user message traces based on HCSC component IDs, set up the component-ID configuration file.

You can set up both the component-ID configuration file and the component-type configuration file. If you specify the same HCSC component in both of these files, the setting of the component-ID configuration file will be applied.

(3) File storage location

The template file is stored in the following location:

service-platform-installation-directory\CSC\config\msg\templates\csctelegram_component_type.properties

You can store the created component-type configuration file with any name and in any location.

To enable the created component-type configuration file, specify the path in the telegramtrace-component-type-filepath property of the HCSC server runtime definition file.

(4) Specifiable parameters

HCSC-component-type

Specify the type of the HCSC component for which information is output for the user message trace. You can specify the types of HCSC components in the following table.

Table 6‒3: Types of HCSC components

Type

Specified value

Reception

Standard reception

Standard reception (Web Services)

reception.standard.soap

Standard reception (SessionBean)

reception.standard.ejb

Standard reception (MDB (WS-R))

reception.standard.wsr

Standard reception (MDB (database queue))

reception.standard.dbq

User-defined reception

SOAP reception

reception.urecp.soap

TP1/RPC reception

reception.urecp.tp1

FTP reception

reception.urecp.ftp

HTTP reception

reception.urecp.http

Message Queue reception

reception.urecp.mq

File event reception

reception.urecp.fileevent

Custom reception

reception.urecp.rcpfw

Service adapter

SOAP adapter

adapter.soap

SessionBean adapter

adapter.ejb

MDB (WS-R) adapter

adapter.wsr

MDB (database queue) adapter

adapter.dbq

DB adapter

adapter.db

TP1 adapter

adapter.tp1

File adapter

adapter.ff

Object Access adapter

adapter.oa

Message Queue adapter

adapter.mq

FTP adapter

adapter.ftp

File operations adapter

adapter.fop

Mail adapter

adapter.mail

HTTP adapter

adapter.http

Command adapter

adapter.cmd

SFTP adapter

adapter.sftp

Custom adapter

adapter.custom

(5) Example of coding

The following shows an example of coding when information for only FTP receptions and FTP adapters is output for the user message trace.

reception.urecp.ftp
adapter.ftp

6.5.10 Service-information change definition file

(1) Format

Outputs the information corresponding to each service in an ascending order of the key.

(a) Service information for SOAP adapters (SOAP 1.1 mode)

cluster-name.service-ID.WebService.url=URL-used-for-invoking-service-components
cluster-name.service-ID.WebService.c4web.application.socket_read_timeout=read-timeout-value
cluster-name.service-ID.WebService.c4web.application.socket_connect_timeout=connection-timeout-value
cluster-name.service-ID.WebService.c4web.application.socket_write_timeout=write-timeout-value
cluster-name.service-ID.WebService.c4web.application.proxy_host=host-name-of-proxy-server
cluster-name.service-ID.WebService.c4web.application.non_proxy_hosts=host-name-when-proxy-server-is-not-used
cluster-name.service-ID.WebService.c4web.application.proxy_port=port-number-of-proxy-server
cluster-name.service-ID.WebService.c4web.application.proxy_user=proxy-server-user
cluster-name.service-ID.WebService.c4web.application.proxy_password=proxy-server-password
cluster-name.service-ID.WebService.c4web.common.prf_trace_level=option-to-output-trace-based-performance-analysis
cluster-name.service-ID.WebService.c4web.common.receive_max_soap_envelope_size=maximum-number-of-bytes-of-receiving-SOAPEnvelope
cluster-name.service-ID.WebService.c4web.common.send_max_soap_envelope_size=maximum-number-of-bytes-of-sending-SOAPEnvelope
cluster-name.service-ID.WebService.basic_authentication_use={true|false}
cluster-name.service-ID.WebService.basic_authentication_id=basic-authentication-user
cluster-name.service-ID.WebService.basic_authentication_pass=basic-authentication-password
cluster-name.service-ID.WebService.c4web.application.app_maintainsession={true|false}

(b) Service information for SOAP adapters (SOAP 1.1/ 1.2 combined mode)

cluster-name.service-ID.WebService.url=URL-used-for-invoking-service-components
cluster-name.service-ID.WebService.com.cosminexus.csc.request.timeout=read-timeout-value
cluster-name.service-ID.WebService.com.cosminexus.csc.connect.timeout=connection-timeout-value
cluster-name.service-ID.WebService.com.cosminexus.csc.session.maintain={true | false}
cluster-name.service-ID.WebService.com.cosminexus.csc.auto-delete-incomplete-file={true | false}
cluster-name.service-ID.WebService.com.cosminexus.csc.file.read-lock.retry.count=lock-retry-count
cluster-name.service-ID.WebService.com.cosminexus.csc.file.read-lock.retry.interval=lock-retry-interval
cluster-name.service-ID.WebService.basic_authentication_use={true|false}
cluster-name.service-ID.WebService.basic_authentication_id=basic-authentication-user
cluster-name.service-ID.WebService.basic_authentication_pass=basic-authentication-password

(c) Service information for SessionBean adapters

cluster-name.service-ID.SessionBean.url=URL-used-for-invoking-service-components
cluster-name.service-ID.SessionBean.lookup_name=lookup-name
cluster-name.service-ID.SessionBean.c4web.application.ejb_timeout=invocation-timeout-value
cluster-name.service-ID.SessionBean.c4web.common.prf_trace_level=option-to-output-trace-based-performance-analysis

(d) Service information for MDB (WS-R) adapters

cluster-name.service-ID.MDB_WSR.queue_name=name-of-queue-to-which-service-adapter-sends-messages
cluster-name.service-ID.MDB_WSR.local_call={true|false}
cluster-name.service-ID.MDB_WSR.url=Web-application-URL-for-transmission-between-transmit-destination-queues
cluster-name.service-ID.MDB_WSR.max_message_num=maximum-number-of-messages-that-can-be-stored-in-transmit-queue
cluster-name.service-ID.MDB_WSR.qos_in_order={true|false}
cluster-name.service-ID.MDB_WSR.rdarea_name=name-of-RD-area-where-transmit-queue-will-be-created

(e) Service information for MDB (DB queue) adapters

cluster-name.service-ID.MDB_DBQ.queue_name=queue-name-related-to-service-components

(2) Function

Specifies the changes in the service information of a service adapter.

(3) File storage location

The file is stored in the path specified in the -getfile option of the cscsvcctl command.

(4) Specifiable parameters

(a) Service information for SOAP adapters (SOAP 1.1 mode)

cluster-name.service-ID.WebService.url=URL-used-for-invoking-service-components

Specifies the URL to be used for invoking service components.

cluster-name.service-ID.WebService.c4web.application.socket_read_timeout=read-timeout-value

Specifies a read timeout value for the service adapter socket in seconds. For details on the values to be specified, see the description for c4web.application.socket_read_timeout in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.

cluster-name.service-ID.WebService.c4web.application.socket_connect_timeout=connection-timeout-value

Specifies a connection timeout value for the service adapter socket in seconds. For details on the values to be specified, see the description for c4web.application.socket_connect_timeout in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.

cluster-name.service-ID.WebService.c4web.application.socket_write_timeout=write-timeout-value

Specifies a write timeout value for the service adapter socket in seconds. For details on the values to be specified, see the description for c4web.application.socket_write_timeout in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.

cluster-name.service-ID.WebService.c4web.application.proxy_host=host-name-of-proxy-server

Specifies the host name or the IP address of the proxy server. For details on the values to be specified, see the description for c4web.application.proxy_host in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.

cluster-name.service-ID.WebService.c4web.application.non_proxy_hosts=host-name-when-proxy-server-is-not-used

Specifies the host name or the IP address to be used when the proxy server is not used. For details on the values to be specified, see the description for c4web.application.non_proxy_hosts in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.

cluster-name.service-ID.WebService.c4web.application.proxy_port=port-number-of-proxy-server

Specifies the port number of the proxy server. For details on the values to be specified, see the description for c4web.application.proxy_port in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.

cluster-name.service-ID.WebService.c4web.application.proxy_user=proxy-server-user

Specifies the authentication user ID of the proxy server. For details on the values to be specified, see the description for c4web.application.proxy_user in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.

cluster-name.service-ID.WebService.c4web.application.proxy_password=proxy-server-password

Specifies the password corresponding to the authentication user ID of the proxy server. For details on the values to be specified, see the description for c4web.application.proxy_password in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.

cluster-name.service-ID.WebService.c4web.common.prf_trace_level=option-to-output-trace-based-performance-analysis

Specifies the output options for the trace based performance analysis. For details on the values to be specified, see the description for c4web.common.prf_trace_level in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.

cluster-name.service-ID.WebService.c4web.common.receive_max_soap_envelope_size=maximum-number-of-bytes-of-receiving-SOAPEnvelope

Specifies the maximum number of SOAP envelope bytes that can be received. For details on the values to be specified, see the description for c4web.common.receive_max_soap_envelope_size in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.

cluster-name.service-ID.WebService.c4web.common.send_max_soap_envelope_size=maximum-number-of-bytes-of-sending-SOAPEnvelope

Specifies the maximum number of SOAP envelope bytes that can be sent. For details on the values to be specified, see the description for c4web.common.send_max_soap_envelope_size in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.

cluster-name.service-ID.WebService.basic_authentication_use={true|false}

Specifies whether the service adapter will use basic authentication. When you set up basic authentication, make sure that you specify this parameter regardless of whether basic authentication is used.

true

Basic authentication will be used.

false

Basic authentication will not be used.

cluster-name.service-ID.WebService.basic_authentication_id=basic-authentication-user ~ <one-byte alphanumeric characters, one-byte symbols (0x21 to 0x7E# in ASCII encoding), and one-byte spaces (0x20 in ASCII encoding)> ((at least 1 character))

Specifies the user ID for basic authentication. When you set up basic authentication, make sure that you specify this parameter regardless of whether basic authentication is used.

To specify one-byte spaces (0x20 in ASCII encoding) at the beginning of the value, specify \ before the one-byte space. Also, to specify \ in the value, specify \\.

#

You cannot use a hash mark (#), colon (:), question mark (?), at mark (@), or forward slash (/).

cluster-name.service-ID.WebService.basic_authentication_pass=basic-authentication-password ~ <one-byte alphanumeric characters, one-byte symbols (0x21 to 0x7E# in ASCII encoding), and one-byte spaces (0x20 in ASCII encoding)> ((1 to 40 characters))

Specifies the password for basic authentication. When you set up basic authentication, make sure that you specify this parameter regardless of whether basic authentication is used.

To specify one-byte spaces (0x20 in ASCII encoding) at the beginning of the value, specify \ before the one-byte space. Also, to specify \ in the value, specify \\.

#

You cannot use a hash mark (#), colon (:), question mark (?), at mark (@), or forward slash (/).

cluster-name.service-ID.WebService.c4web.application.app_maintainsession={true|false}

Specifies whether an HTTP session will be maintained. For details on the values to be specified, see the description for c4web.application.app_maintainsession in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.

(b) Service information for SOAP adapters (SOAP 1.1/ 1.2 combined mode)

cluster-name.service-ID.WebService.url=URL-used-for-invoking-service-components

Specifies the URL to be used for invoking service components.

cluster-name.service-ID.WebService.com.cosminexus.csc.request.timeout=read-timeout-value

Specifies a read timeout value for the service adapter socket in seconds. For details on the values to be specified, see the description for com.cosminexus.csc.request.timeout in the items set in 3.6.2 Client definition file.

cluster-name.service-ID.WebService.com.cosminexus.csc.connect.timeout=connection-timeout-value

Specifies a connection timeout value for the service adapter socket in seconds. For details on the values to be specified, see the description for com.cosminexus.csc.connect.timeout in the items set in 3.6.2 Client definition file.

cluster-name.service-ID.WebService.com.cosminexus.csc.session.maintain={true | false}

Specifies whether an HTTP session will be maintained. set in 3.6.2 Client definition file.

cluster-name.service-ID.WebService.com.cosminexus.csc.auto-delete-incomplete-file={true | false}

Specifies whether to automatically delete the incomplete files generated due to an error during output of files to a work folder or common folder after the SOAP adapter has received attachments from a service component. For details about the values you can specify, see the description for com.cosminexus.csc.auto-delete-incomplete-file in the items set in 3.6.2 Client definition file.

cluster-name.service-ID.WebService.com.cosminexus.csc.file.read-lock.retry.count=lock-retry-count

Specifies the lock retry count when an attempt to acquire a shared lock for files in the common folder fails. For details about the values you can specify, see the description for com.cosminexus.csc.file.read-lock.retry.count in the items set in 3.6.2 Client definition file.

cluster-name.service-ID.WebService.com.cosminexus.csc.file.read-lock.retry.interval=lock-retry-interval

Specifies, in seconds, the retry interval when an attempt to acquire a shared lock for files in the common folder fails. For details about the values you can specify, see the description for com.cosminexus.csc.file.read-lock.retry.interval in the items set in 3.6.2 Client definition file.

cluster-name.service-ID.WebService.basic_authentication_use={true|false}

Checks the usability of basic authentication in a service adapter definition.

true

Basic authentication will be used.

false

Basic authentication will not be used.

cluster-name.service-ID.WebService.basic_authentication_id=basic-authentication-user ~ <Halfwidth alphanumeric characters, halfwidth symbols (0x21 to 0x7E in ASCII encoding#), and halfwidth spaces (0x20 in ASCII encoding)> ((at least 1 character))

Specifies the user name for basic authentication in a service adapter definition.

#

You cannot use a colon (:) or forward slash (/).

cluster-name.service-ID.WebService.basic_authentication_pass=basic-authentication-password ~ <Halfwidth alphanumeric characters, halfwidth symbols (0x21 to 0x7E in ASCII encoding#), and halfwidth spaces (0x20 in ASCII encoding)> ((1 to 40 characters))

Specifies the password for basic authentication in a service adapter definition.

#

You cannot use a colon (:) or forward slash (/).

(c) Service information for SessionBean adapters

cluster-name.service-ID.SessionBean.url=URL-used-for-invoking-service-components

Specifies the URL to be used for invoking service components.

cluster-name.service-ID.SessionBean.lookup_name=lookup-name

Specifies the lookup names to be used for invoking service components.

cluster-name.service-ID.SessionBean.c4web.application.ejb_timeout=invocation-timeout-value

Specifies a timeout value for invoking service components in seconds. Specify a value from 0 to 86400. A timeout does not occur if you specify 0.

cluster-name.service-ID.SessionBean.c4web.common.prf_trace_level=option-to-output-trace-based-performance-analysis

Specifies the output options for the trace based performance analysis. For details on the values to be specified, see the description for c4web.common.prf_trace_level in 10.3 Setting up the client definition file in the uCosminexus Application Server SOAP Application Development Guide.

(d) Service information for MDB (WS-R) adapters

cluster-name.service-ID.MDB_WSR.queue_name=name-of-queue-to-which-service-adapter-sends-messages

Specifies the name of the queue to which the service adapter will send messages.

cluster-name.service-ID.MDB_WSR.local_call={true|false}

Specifies the service components of the local host or remote host with which the service adapter will connect.

true

The service adapter will connect to the service components of the local host.

false

The service adapter will connect to the service components of the remote host.

You can change the local_call value from true to false only when all the correct values are specified in the parameters specified in the service-information change definition file. Do not change the local_call value from false to true.

cluster-name.service-ID.MDB_WSR.url=Web-application-URL-for-transmission-between-transmit-destination-queues

Specifies the message transmission destination for the transmit queue used by the service adapter. Specify the Web application URL for transmission between transmit destination queues as the message transmission destination. This parameter is valid only when the local_call parameter is false.

cluster-name.service-ID.MDB_WSR.max_message_num=maximum-number-of-messages-that-can-be-stored-in-transmit-queue ~ <Numeric character> ((1 to 65535))

Specifies the maximum number of messages that can be stored in the transmit queue used by the service adapter. This parameter is valid only when the local_call parameter is false.

cluster-name.service-ID.MDB_WSR.qos_in_order={true|false}

Specifies whether the correct order will be guaranteed when the transmit queue used by the service adapter transmits messages. This parameter is valid only when the local_call parameter is false.

true

The order will be guaranteed.

false

The order will not be guaranteed.

cluster-name.service-ID.MDB_WSR.rdarea_name=name-of-RD-area-where-transmit-queue-will-be-created~ <one-byte alphanumeric characters, underscores (_), and one-byte spaces ( )> ((30 bytes or less))

Specifies the name of the RD area to create the transmit queue used by the service adapter. This parameter is valid only when the local_call parameter is false. Do not specify ALL.

(e) Service information for MDB (DB queue) adapters

cluster-name.service-ID.MDB_DBQ.queue_name=queue-name-related-to-service-components

Specifies the queue name associated with service components.

(5) Usage

Obtain the service-information change definition file by specifying the file name in the -getfile option of the cscsvcctl command. Define the changed information in the obtained file, specify the file name in the -setfile option of the cscsvcctl command, and then perform the settings.

For the service information that is not changed in the operating environment, a hash mark (#) indicating a comment is added at the beginning of the parameters. To change the service information, delete the hash mark (#) added to the corresponding parameter.

To disable the changes made in the operating environment (to enable the development environment settings), add a hash mark (#) indicating a comment at the beginning of the parameters.

(6) Notes

To specify one-byte spaces (0x20 in ASCII encoding) at the beginning of the value, specify \ before the one-byte space. Also, to specify \ in the value, specify \\.

To set up or to change a value, edit the value in the Java property file format.

If the service information obtained with the -getfile option of the cscsvcctl command includes the following characters, the characters are output by adding \ to them.

One-byte exclamation mark (!)

One-byte hash mark (#)

One-byte colon (:)

One-byte equal sign (=)

6.6 Files used for SOAP integration

6.6.1 SOAP fault operation definition file

(1) Format

[targetNamespace-URI]
[targetNamespace-URI]
 ...

(2) Function

Specifies the targetNamespace URI. The targetNamespace URI is used to decide whether the SOAP Fault received from Web Service by a service adapter will be handled as a Fault. The specified contents take effect after the HCSC server starts.

(3) Specification method

Demarcate the targetNamespace URIs with linefeeds. Specify the coding for targetNamespace of the WSDL that you will use to create a service adapter as is.

You can use the following characters specified in the ISO-8859-1 character encoding in targetNamespace:

Alphanumeric characters

Exclamation mark (!)

Double quotation mark (")

Hash mark (#)

Dollar sign ($)

Percent sign (%)

Ampersand (&)

Apostrophe mark (')

Left parenthesis (()

Right parenthesis ())

Plus sign (+)

Comma (,)

Hyphen (-)

Period (.)

Forward slash (/)

Colon (:)

Semicolon (;)

Left angle bracket (<)

Right angle bracket (>)

Equal sign (=)

Question mark (?)

At mark (@)

Left square bracket ([)

Right square bracket (])

Yen sign (\)

Caret (^)

Underscore (_)

Grave accent mark (`)

Left curly bracket ({)

Right curly bracket (})

Vertical bar (|)

Swung dash (~)

A line beginning with a hash mark (#) is a comment.

A blank line is ignored. Also, the one-byte spaces and tabs at the beginning and at the end of a line are ignored.

If the value of the targetNamespace attribute, declared in the WSDL, is null (no value) or if the targetNamespace attribute is not defined, code "" (two double quotation marks).

(4) Operations for invalid definitions

The HCSC server fails to start if there are definitions that do not match the rules described in Specification method (this, however, excludes the cases where a definition does not match with the conditions of the ISO-8859-1 character encoding).

Note that in the following cases the operation might not be normal if a SOAP Fault is returned by a service component:

When you specify an invalid targetNamespace#

When you specify characters that cannot be used as targetNamespace of the WSDL

When you use character encoding other than the specified character encoding

#

Use the coding for targetNamespace of the WSDL that you will use to create a service adapter as is. Although http://www.xxx.com/ and http://w%77w.xxx.com/ are synonymous as URIs, they are recognized as separate URIs.

(5) Example of coding

http://dictionary.com
urn:sample.co.jp:xmlns:wsdl:2007-06

6.6.2 User-defined reception runtime definition file

(1) Format

user-defined-reception-soap.threads.maximum=Maximum-number-of-concurrent-executions
user-defined-reception-soap.exclusive.threads=Number-of-dedicated-threads
user-defined-reception-soap.queue-size=Pending-queue-size

(2) Function

Specifies the information for SOAP receptions.

(3) File storage location

Service-platform-installation-directory\CSC\config\manager\templates\cscurcptnconfig.properties

(4) Specifiable parameters

user-defined-reception-soap.threads.maximum=Maximum-number-of-concurrent-executions ~ <Numeric character> ((1 to 1024)) <<10>>

Specifies the maximum number of concurrently executing SOAP receptions. You must specify a value that is equal to or more than the number of dedicated threads.

user-defined-reception-soap.exclusive.threads=Number-of-dedicated-threads ~ <Numeric character> ((0 to 1024)) <<0>>

Specifies the number of dedicated threads of a SOAP reception. You must specify a value that does not exceed the maximum number of executions. If you specify 0, no threads are dedicated.

Note that this value is set up for the WAR attribute thread-control-exclusive-threads. Therefore, you must specify this value after considering the maximum threads and the maximum number of connections for the entire Web container.

user-defined-reception-soap.queue-size=Pending-queue-size ~ <Numeric character> ((0 to 2147483647)) <<8192>>

Specifies the size of the pending queue for a SOAP reception.

(5) Usage

Specify the user-defined reception runtime definition file in the argument of the -propfile option of the csccompoconfig command. For details on how to do this, see 3.1.15 Setting the definition information for user-defined receptions in the uCosminexus Service Platform Setup and Operation Guide.

6.7 Files used for TP1 integration

6.7.1 TP1-adapter runtime-environment property file

(1) Format

tp1client.config=path-of-TP1/Client/J-environment-definition-file
[buffer.keep={true|false}]
[message.level={0|10|20}]
[trace.level={0|10|20}]
[trace.filesize=size-of-output-trace-log]
[trace.filenum=number-of-trace-log-files-output]

(2) Function

The TP1-adapter runtime-environment property file defines the TP1/Client/J environment definition file that is used when the TP1 adapter is operated in the execution environment. Use the sample file to create this file.

The sample file is stored at the following location:

service-platform-installation-directory\CSC\custom-adapter\TP1\config\templates\adptp1.properties

To create the TP1-adapter runtime-environment property file:

Copy and store the sample file in the following directory:

Service-platform-installation-directory\CSC\custom-adapter\TP1\config

Rename the sample file as service-ID.properties.

Edit and save the defined information.

The TP1-adapter runtime-environment property file is applied in the execution environment when you start the TP1 adapter. To change the contents of the TP1-adapter runtime-environment property file, stop the TP1 adapter and then perform the operation. When you restart the TP1 adapter, the changes are applied in the execution environment.

(3) Specifiable properties

tp1client.config=path-of-TP1/Client/J-environment-definition-file ~ <Character string>

Codes the path of the TP1/Client/J environment definition file. Use \\ instead of \ as directory delimiters in the path.

buffer.keep={true|false} ~ <<true>>

Specifies the options for generating the sending and receiving buffer.

true

A sending and receiving buffer will be generated and stored when the TP1 adapter starts.

false

A sending and receiving buffer will be generated or released when the RPC communication starts.

If you specify any other value, a warning message (KDEE12021-W) is displayed and the operation similar to when true is specified is performed. Furthermore, if the buffer.keep property itself is not coded, the operation similar to when true is specified is performed without displaying a warning message.

message.level={0|10|20} ~ <<10>>

Specifies the output level of the message log.

0: A message with the message type E (Error) will be output.

10: A message with the message type E (Error) or W (Warning) will be output.

20: All the messages will be output.

trace.level={0|10|20} ~ <<10>>

Specifies the output level of the trace log.

0: The method trace information will not be collected.

10: The method trace information will be collected.

20: The method trace or data trace information will be collected.

trace.filesize=size-of-output-trace-log ~ <unsigned integer> ((4096 to 2147483647)) <<2097152>>

Specifies the size of files output for the trace information collected by the TP1 adapter in bytes.

trace.filenum=number-of-trace-log-files-output ~ <unsigned integer> ((1 to 16)) <<8>>

Specifies the number of files output for the trace information collected by the TP1 adapter.

(4) Notes

Note the following when you specify the path:

Do not specify a path that contains characters expressing a relative path or a parent directory (..\ or ../), and characters expressing a current directory (.\ or ./).

Do not specify a path containing a symbolic link.

In Windows, do not specify a path containing a UNC format, an NTFS stream name, and a reserved device name. Also, the path characters are not case sensitive.

6.8 Files used for FTP integration

6.8.1 FTP adapter account definition file

(1) Function

Manages user authentication information in a batch for FTP servers that are connected by using the FTP adapter.

Because the FTP adapter account definition file is managed with operation commands, the user need not edit the FTP adapter account definition file.

(2) File storage location

service-platform-installation-directory\CSC\custom-adapter\FTP\config\templates\account.properties

You can store the FTP adapter account definition file with any name at any location. However, you must specify the absolute path of the FTP adapter account definition file in the ftpadp.account-inf-filepath property of the FTP-adapter runtime-environment property file.

If you do not specify the ftpadp.account-inf-filepath property of the FTP-adapter runtime-environment property file, the FTP adapter account definition file stored in the following directory is used.

service-platform-installation-directory\CSC\config\common\account.properties

In addition, when the csaftpuseradd command is executed with the -name option specified, an FTP adapter account definition file is automatically generated in the preceding path. If no FTP adapter account definition file is stored in this path, an error occurs when the FTP adapter starts.

6.8.2 FTP adapter command definition file

(1) Format

[ftpadp.command.messagelog.filepath=absolute-path-of-directory-to-output-message-log-files-of-FTP-adapter-commands]
[ftpadp.command.messagelog.filenum=number-of-message-log-files-of-FTP-adapter-commands]
[ftpadp.command.messagelog.filesize=maximum-size-of-one-message-log-file-of-FTP-adapter-commands]

(2) Function

This file defines the configuration information of the message log for FTP adapter commands.

(3) File storage location

Service-platform-installation-directory\CSC\custom-adapter\FTP\config\adpftpcommand.properties

(4) Specifiable parameters

ftpadp.command.messagelog.filepath=absolute-path-of-directory-to-output-message-log-files-of-FTP-adapter-commands ~ <Character strings (including two-byte characters) and spaces> <<service-platform-installation-directory\CSC\custom-adapter\FTP\log>>

Specifies an absolute path for the directory to output the message log files for the FTP adapter related commands. If you specify a non-existent directory, the default value is used.

Note that the message log is created with the name messagenumber-of-files.log.

ftpadp.command.messagelog.filenum=number-of-message-log-files-of-FTP-adapter-commands ~ <Numeric character> ((1 to 64)) <<2>>

Specifies the number of message log files of the FTP adapter related commands.

ftpadp.command.messagelog.filesize=maximum-size-of-one-message-log-file-of-FTP-adapter-commands ~ <Numeric character> ((4096 to 16777216)) <<1048576>>

Specifies the maximum size of one message log file of the FTP adapter related commands in bytes.

(5) Notes

Note the following when you specify the path:

Do not specify a path that contains characters expressing a relative path or a parent directory (..\ or ../) or characters expressing a current directory (.\ or ./).

Do not specify a path that contains a symbolic link.

In Windows, do not specify a path containing a UNC format, an NTFS stream name, or a reserved device name. The path characters are not case sensitive.

6.8.3 FTP-adapter runtime-environment property file

(1) Format

[ftpadp.host-ipaddr=IP-address-or-host-name-of-FTP-server-to-be-connected-to-to]
[ftpadp.host-con-port=port-number-for-control-connection-of-FTP-server-to-be-connected-to]
[ftpadp.file-name.charset={UTF-8|MS932}]

[ftpadp.ftps.enable={TRUE|FALSE}]
[ftpadp.ftps.protocol-name={TLS|SSL}]
[ftpadp.ftps.implicit-mode={TRUE|FALSE}]
[ftpadp.ftps.data-con-secure={TRUE|FALSE}]
[ftpadp.ftps.server-authentication={TRUE|FALSE}]

[ftpadp.client-ipaddr=IP-address-of-HCSC-server]
[ftpadp.client-con-port.min=minimum-value-for-the-range-of-control-connection-port-numbers-of-FTP-adapter]
[ftpadp.client-con-port.max=maximum-value-for-the-range-of-control-connection-port-numbers-of-FTP-adapter]
[ftpadp.client-pasv-port.min=minimum-value-for-the-range-of-port-numbers-where-FTP-adapter-establishes-data-connection-when-data-connection-mode-is-PASV]
[ftpadp.client-pasv-port.max=maximum-value-for-the-range-of-port-numbers-where-FTP-adapter-establishes-data-connection-when-data-connection-mode-is-PASV]
[ftpadp.listen-port.min=minimum-value-for-the-range-of-port-numbers-where-FTP-adapter-waits-for-data-connection-when-data-connection-mode-is-PORT]
[ftpadp.listen-port.max=maximum-value-for-the-range-of-port-numbers-where-FTP-adapter-waits-for-data-connection-when-data-connection-mode-is-PORT]

[ftpadp.ftp-user=login-user-name-of-FTP-server-to-be-connected-to]
[ftpadp.ftp-type={A|a|I|i}]
[ftpadp.ftp-mode={S|s|C|c}]
[ftpadp.pasvport={PASV|pasv|PORT|port}]

[ftpadp.file-size-check={TRUE|FALSE}]

[ftpadp.methodtrace.level={1|2|3|4|5}]
[ftpadp.methodtrace.filepath=absolute-path-of-directory-to-output-maintenance-log]
[ftpadp.methodtrace.filenum=number-of-maintenance-log-files]
[ftpadp.methodtrace.filesize=maximum-size-of-one-maintenance-log-file]

[ftpadp.ftpprotocoltrace.filenum=number-of-protocol-trace-files]
[ftpadp.ftpprotocoltrace.filesize=maximum-size-of-one-protocol-trace-file]

[ftpadp.messagelog.level={0|10|20}]

[ftpadp.account-inf-filepath=absolute-path-of-FTP-adapter-account-definition-file]
[ftpadp.cscthrough-filepath=absolute-path-of-FTP-command-authorization-list-definition-file]

[ftpadp.control-con.retry.count=retry-count-when-control-connection-cannot-be-established]
[ftpadp.control-con.retry.interval=retry-interval-when-control-connection-cannot-be-established]
[ftpadp.control-con.connect.timeout=connection-timeout-for-control-connection]

[ftpadp.data-con.retry.count=retry-count-when-data-connection-cannot-be-established-in-PASV-mode]
[ftpadp.data-con.retry.interval=retry-interval-when-data-connection-cannot-be-established-in-PASV-mode]
[ftpadp.data-con.connect.timeout=connection-timeout-for-data-connection]

[ftpadp.read-lock.retry.count=retry-count-when-shared-lock-of-common-folder-files-fails]
[ftpadp.read-lock.retry.interval=retry-interval-when-shared-lock-of-common-folder-files-fails]
[ftpadp.write-lock.retry.count=retry-count-when-dedicated-lock-of-common-folder-files-fails]
[ftpadp.write-lock.retry.interval=retry-interval-when-dedicated-lock-of-common-folder-files-fails]

[ftpadp.data-con-put.timeout=timeout-value-for-data-transmission]
[ftpadp.data-con-get.timeout=timeout-value-for-data-acquisition]

[ftpadp.ftp-command-reply.timeout=reply-timeout-value]

[ftpadp.listen.timeout=Listen-timeout-value]
[ftpadp.data-con.read.timeout=receive-buffer-read-timeout-value-for-data-connection-in-passive-mode]

[ftpadp.put-client-buffer.size=client-buffer-size-for-file-transmission-(sending)]
[ftpadp.get-client-buffer.size=client-buffer-size-for-file-transmission-(receiving)]
[ftpadp.exptrace.filenum=number-of-exception-log-files]
[ftpadp.exptrace.filesize=maximum-size-of-one-exception-log-file]

[ftpadp.listen-port.reuse={TRUE|FALSE}]

(2) Function

Specifies the parameters that depend on the execution environment of FTP adapters.

There are two types of FTP-adapter runtime-environment property files: the individual definition file specified for each FTP adapter, and the common definition file that is applied to all FTP adapters. An FTP-adapter runtime-environment property file that is applied to all FTP adapters is referred to as an FTP-adapter runtime-environment common properties file.

If both the individual FTP-adapter runtime-environment property file and the FTP-adapter runtime-environment common properties file are specified, the definitions in the two files are merged. If the same properties are specified in these files, the contents of the individual FTP-adapter runtime-environment property file become valid.

You can create an FTP-adapter runtime-environment property file and an FTP-adapter runtime-environment common properties files based on the template file.

How to create an FTP-adapter runtime-environment property file

To create an FTP-adapter runtime-environment property file:

Define the FTP-adapter runtime-environment property file based on the following template file:

service-platform-installation-directory\CSC\custom-adapter\FTP\config\templates\adpftp.properties

Rename the edited FTP-adapter runtime-environment property file as service-ID.properties, and then store the file in the following directory:

service-platform-installation-directory\CSC\custom-adapter\FTP\config

How to create an FTP-adapter runtime-environment common properties file

To create an FTP-adapter runtime-environment common properties file:

Define the FTP-adapter runtime-environment common properties file based on the following template file:

service-platform-installation-directory\CSC\custom-adapter\FTP\config\templates\adpftp.properties

Store the edited FTP-adapter runtime-environment common properties file in the following directory:

service-platform-installation-directory\CSC\custom-adapter\FTP\config\common

Do not change the file name.

(3) Specifiable properties

(a) Properties that must be specified in a request message or the FTP-adapter runtime-environment property file

You must specify the following properties in a request message or the FTP-adapter runtime-environment property file. If you specify the parameters in both the request message and the FTP-adapter runtime-environment property file, the values in the request message become valid.

ftpadp.host-ipaddr=IP-address-or-host-name-of-FTP-server-to-be-connected-to
ftpadp.ftp-user=login-user-name-of-FTP-server-to-be-connected-to

Associated with server information

ftpadp.host-ipaddr=IP-address-or-host-name-of-FTP-server-to-be-connected-to

Specifies the IP address or the host name of the FTP server to be connected to.

You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.

Important note

To use Windows, specify the real IP address or host name. If you specify a loopback IP address (127.0.0.1 or localhost), an FTP connection might fail.

Associated with FTP settings

ftpadp.ftp-user=login-user-name-of-FTP-server-to-be-connected-to ~ <Character string> ((1 to 80 characters))

Specifies the login user name of the FTP server to be connected to the FTP adapter. The available user names are specified in the FTP adapter account definition file.

You can use halfwidth alphanumeric characters, halfwidth symbols (0x21 to 0x7E in ASCII encoding), and halfwidth spaces (0x20 in ASCII encoding). The characters are case sensitive. You can use the following halfwidth symbols:

Exclamation mark (!)

Double quotation mark (")

Hash mark (#)

Dollar sign ($)

Percent sign (%)

Ampersand (&)

Apostrophe mark (')

Left parenthesis (()

Right parenthesis ())

Asterisk (*)

Plus sign (+)

Comma (,)

Hyphen (-)

Period (.)

Forward slash (/)

Colon (:)

Semicolon (;)

Left angle bracket (<)

Right angle bracket (>)

Equal sign (=)

Question mark (?)

At mark (@)

Left square bracket ([)

Right square bracket (])

Yen sign (\)

Caret (^)

Underscore (_)

Grave accent mark (`)

Left curly bracket ({)

Right curly bracket (})

Vertical bar (|)

Swung dash (~)

The login user name to be specified must have the permissions to execute file operations. The value specified here is used as an argument of the USER command.

You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.

If you omit this property, you need to specify the login user name in the FTP adapter's request message. If you do not specify the login user name, a system exception occurs when the FTP adapter is invoked.

(b) Specifiable properties in a request message and FTP-adapter runtime-environment property file

If necessary, you can specify the following properties in a request message or the FTP-adapter runtime-environment property file. If you specify the properties in both the request message and the FTP-adapter runtime-environment property file, the values in the request message become valid. You can use the FTP-adapter runtime-environment common properties file to reduce the number of definition files managed during operation. In this case, if you want to specify different values for some properties for each request, specify the information in a request message.

ftpadp.host-con-port=port-number-for-control-connection-of-FTP-server-to-be-connected-to
ftpadp.file-name.charset={UTF-8|MS932}

ftpadp.ftp-type={A|a|I|i}
ftpadp.ftp-mode={S|s|C|c}
ftpadp.pasvport={PASV|pasv|PORT|port}

ftpadp.file-size-check={TRUE|FALSE}

ftpadp.ftps.enable={TRUE|FALSE}
ftpadp.ftps.protocol-name={TLS|SSL}
ftpadp.ftps.implicit-mode={TRUE|FALSE}
ftpadp.ftps.data-con-secure={TRUE|FALSE}
ftpadp.ftps.server-authentication={TRUE|FALSE}

Associated with server information

ftpadp.host-con-port=port-number-for-control-connection-of-FTP-server-to-be-connected-to ~ <Numeric character> ((1 to 65535)) <<21>>

Specifies the control connection port number for the FTP server to be connected to.

You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.

ftpadp.file-name.charset={UTF-8|MS932} ~ <<UTF-8>>

Specifies the name of the character set to be used when the following information is sent and received between FTP servers:

Information (such as the file name) to be sent and received with a control connection

Information (file list information) received from the FTP server via a data connection, during the execution of the commands LIST or NLST

You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.

You can specify the following values. The characters are not case sensitive.

UTF-8

UTF-8 will be used as the character set.

MS932

MS932 will be used as the character set.

Associated with FTP settings

ftpadp.ftp-type={A|a|I|i}

Specifies one of the following values as the type of data to be transmitted. The value specified here is used as an argument of the TYPE command.

A or a

Data will be transmitted in the ASCII format.

I or i

Data will be transmitted in the image (BINARY) format.

You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.

If you omit this property, data is transmitted in the ASCII format in accordance with the FTP protocol specifications (RFC959).

ftpadp.ftp-mode={S|s|C|c} ~ <<S>>

Specifies whether to compress the data to be transmitted. The value specified here is used as an argument of the MODE command.

S or s

The file will be transmitted without being compressed.

C or c

The file will be compressed and transmitted.

You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.

ftpadp.pasvport={PASV|pasv|PORT|port} ~ <<PASV>>

Specifies one of the following as the data connection mode.

PASV or pasv

The data connection will be set up in the PASV mode.

PORT or port

The data connection will be set up in the PORT mode.

Associated with checking of the file size

ftpadp.file-size-check={TRUE|FALSE} ~ <<FALSE>>

Specifies whether to use the function that checks whether the size of the file being sent and being received is correct.

TRUE

The file size will be checked.

FALSE

The file size will not be checked.

Associated with FTPS

ftpadp.ftps.enable={TRUE|FALSE} ~ <<FALSE>>

Specifies whether FTPS will be used for connecting to the FTP server.

You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.

TRUE

FTPS will be used for connecting to the FTP server.

If you select TRUE, the communication for control and data connections is encrypted (not encrypted if you specify settings to control the encryption of the communication for a data connection). However, the destination FTP server must support the FTPS-based connection.

FALSE

Normal FTP will be used for connecting to the FTP server.

If you select FALSE, the communication for control and data connections is not encrypted.

If you specify FALSE when the destination FTP server is operating in the Implicit mode of FTPS, the system might wait after connecting to the FTP server and until a timeout occurs. The shorter time period from among the following timeout values is applied as the timeout value:

Value specified in the ftpadp.control-con.connect.timeout property (connection timeout value for control connection)

If a timeout occurs at this value, the connection is retried for the number of times specified in the ftpadp.control-con.retry.count property, and then the message KDEK30407-E will be displayed.

Timeout value specified in the destination FTP server

If a timeout occurs at this value, the message KDEK30428-E will be displayed.

ftpadp.ftps.protocol-name={TLS|SSL} ~ <<TLS>>

Specifies the security communication protocol to be prepared for using FTPS for connecting to the FTP server. This specification is valid only when FTPS is used for connecting to the FTP server.

You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.

TLS

TLS will be used in the security communication protocol.

SSL

SSL will be used in the security communication protocol.

ftpadp.ftps.implicit-mode={TRUE|FALSE} ~ <<FALSE>>

Specifies whether the Implicit mode of FTPS will be used when FTPS is used for connecting to the FTP server. This specification is valid only when FTPS is used for connecting to the FTP server.

You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.

TRUE

The Implicit mode (mode in which an implicitly encrypted communication is started immediately after connecting to the FTP server) will be used. The mode in which an implicitly encrypted communication is started immediately after connecting to the FTP server will be used.

FALSE

The Explicit mode (mode in which an explicitly encrypted communication is started by executing the AUTH command from the FTP client, after connecting to the FTP server) will be used. The mode in which an explicitly encrypted communication is started by executing the AUTH command from the FTP client, after connecting to the FTP server, will be used.

If you specify FALSE when the destination FTP server is operating in the Implicit mode of FTPS, the system might wait after connecting to the FTP server and until a timeout occurs. The shorter time period from among the following timeout values is applied as the timeout value:

Value specified in the ftpadp.control-con.connect.timeout property (connection timeout value for control connection)

If a timeout occurs at this value, the connection is retried for the number of times specified in the ftpadp.control-con.retry.count property, and then the message KDEK30407-E will be displayed.

Timeout value specified in the destination FTP server

If a timeout occurs at this value, the message KDEK30428-E will be displayed.

ftpadp.ftps.data-con-secure={TRUE|FALSE} ~ <<TRUE>>

Specifies whether the communication for data connection when FTPS is used for connecting to the FTP server, will be encrypted. This specification is valid only when FTPS is used for connecting to the FTP server.

You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.

TRUE

The communication for data connection will be encrypted.

FALSE

The communication for data connection will not be encrypted.

ftpadp.ftps.server-authentication={TRUE|FALSE} ~ <<FALSE>>

Specifies whether the FTP server when FTPS is used for connecting to the FTP server, will be authenticated. This specification is valid only when FTPS is used for connecting to the FTP server.

You can also specify the information in a request message of the FTP adapter. If the information is duplicated, the value in the request message becomes valid.

TRUE

The server will be authenticated (the certificate will be checked).

Whether the public key certificate of the FTP server, which is the FTPS destination, is reliable will be checked, and the processing will be executed only if the certificate is reliable.

To specify TRUE, the trust store-related settings are required. For details on the trust store-related settings, see Appendix H.2 Encryption and authentication using a secure protocol (FTP inbound adapter) in the uCosminexus Service Platform Reception and Adapter Definition Guide.

FALSE

The certificate will not be checked.

The processing continues without checking whether the public key certificate of the FTP server, which is the FTPS destination, is reliable.

(c) Properties that can be specified only in the FTP-adapter runtime-environment property file

The following properties can be specified in the FTP-adapter runtime-environment property file. If you want to reduce the number of definition files managed during operation, use the FTP-adapter runtime-environment common properties file.

ftpadp.client-ipaddr=IP-address-of-HCSC-server
ftpadp.client-con-port.min=minimum-value-for-the-range-of-control-connection-port-numbers-of-FTP-adapter
ftpadp.client-con-port.max=maximum-value-for-the-range-of-control-connection-port-numbers-of-FTP-adapter
ftpadp.control-con.retry.count=retry-count-when-control-connection-cannot-be-established
ftpadp.control-con.retry.interval=retry-interval-when-control-connection-cannot-be-established
ftpadp.control-con.connect.timeout=connection-timeout-for-control-connection

ftpadp.client-pasv-port.min=minimum-value-for-the-range-of-port-numbers-where-FTP-adapter-establishes-data-connection-when-data-connection-mode-is-PASV
ftpadp.client-pasv-port.max=maximum-value-for-the-range-of-port-numbers-where-FTP-adapter-establishes-data-connection-when-data-connection-mode-is-PASV
ftpadp.data-con.retry.count=retry-count-when-data-connection-cannot-be-established-in-PASV-mode
ftpadp.data-con.retry.interval=retry-interval-when-data-connection-cannot-be-established-in-PASV-mode
ftpadp.data-con.connect.timeout=connection-timeout-for-data-connection

ftpadp.listen-port.min=minimum-value-for-the-range-of-port-numbers-where-FTP-adapter-waits-for-data-connection-when-data-connection-mode-is-PORT
ftpadp.listen-port.max=maximum-value-for-the-range-of-port-numbers-where-FTP-adapter-waits-for-data-connection-when-data-connection-mode-is-PORT
ftpadp.listen-port.reuse={TRUE|FALSE}
ftpadp.listen.timeout=Listen-timeout-value
ftpadp.data-con.read.timeout=receive-buffer-read-timeout-value-for-data-connection-in-passive-mode

ftpadp.exptrace.filenum=number-of-exception-log-files
ftpadp.exptrace.filesize=maximum-size-of-one-exception-log-file
ftpadp.ftpprotocoltrace.filenum=number-of-protocol-trace-files
ftpadp.ftpprotocoltrace.filesize=maximum-size-of-one-protocol-trace-file
ftpadp.methodtrace.level={1|2|3|4|5}
ftpadp.methodtrace.filepath=absolute-path-of-directory-to-output-maintenance-log
ftpadp.methodtrace.filenum=number-of-maintenance-log-files
ftpadp.methodtrace.filesize=maximum-size-of-one-maintenance-log-file
ftpadp.messagelog.level={0|10|20}

ftpadp.account-inf-filepath=absolute-path-of-FTP-adapter-account-definition-file
ftpadp.cscthrough-filepath=absolute-path-of-FTP-command-authorization-list-definition-file

ftpadp.read-lock.retry.count=retry-count-when-shared-lock-of-common-folder-files-fails
ftpadp.read-lock.retry.interval=retry-interval-when-shared-lock-of-common-folder-files-fails
ftpadp.write-lock.retry.count=retry-count-when-dedicated-lock-of-common-folder-files-fails
ftpadp.write-lock.retry.interval=retry-interval-when-dedicated-lock-of-common-folder-files-fails

ftpadp.data-con-put.timeout=timeout-value-for-data-transmission
ftpadp.data-con-get.timeout=timeout-value-for-data-acquisition

ftpadp.ftp-command-reply.timeout=reply-timeout-value

ftpadp.put-client-buffer.size=client-buffer-size-for-file-transmission-(sending)
ftpadp.get-client-buffer.size=client-buffer-size-for-file-transmission-(receiving)

Associated with client information (basic settings)

ftpadp.client-ipaddr=IP-address-of-HCSC-server

Specifies the IP address of the HCSC server. The IP address specified here is used for control connections and data connections.

If you omit this property, the system automatically assigns any IP address. Among the batch of IP addresses acquired by using the java.net.NetworkInterface class, the first real IP address found is allocated. If a real IP does not exist, a loopback IP address is allocated.

Important note

To use Windows, specify a real IP address. If you specify a loopback IP address, an FTP connection might fail.

ftpadp.client-con-port.min=minimum-value-for-the-range-of-control-connection-port-numbers-of-FTP-adapter ~ <Numeric character> ((1024 to 65535))

Specifies the minimum value for the range of control connection port numbers of the FTP-adapter.

You can specify the following values:

Values that are equal to or less than the value of the ftpadp.client-con-port.max property (maximum value for the range of control connection port numbers of the FTP adapter)

Values that do not overlap with the range specified by the ftpadp.client-pasv-port.min property (minimum value for the range of port numbers where the FTP adapter establishes a data connection when the data connection mode is PASV) and the ftpadp.client-pasv-port.max property (maximum value for the range of port numbers where the FTP adapter establishes a data connection when the data connection mode is PASV)

Values that do not overlap with the range specified by the ftpadp.listen-port.min property (minimum value for the range of port numbers where the FTP adapter waits for a data connection when the data connection mode is PORT) and the ftpadp.listen-port.max property (maximum value for the range of port numbers where the FTP adapter waits for a data connection when the data connection mode is PORT)

If you specify any other value, an error occurs when the FTP adapter starts or during processing of a request in which the data connection mode is changed by <pasvport> in a request message of the FTP adapter.

Important note

Do not specify this property if you omit the ftpadp.client-con-port.max property (maximum value for the range of control connection port numbers of the FTP adapter). If you specify this property, an error occurs when the FTP adapter starts.

If you omit this property, the system automatically sets up any port number.

ftpadp.client-con-port.max=maximum-value-for-the-range-of-control-connection-port-numbers-of-FTP-adapter ~ <Numeric character> ((1024 to 65535))

Specifies the maximum value for the range of control connection port numbers of the FTP adapter.

You can specify the following values:

Values that are equal to or more than the value specified for the ftpadp.client-con-port.min property (minimum value for the range of control connection port numbers of the FTP adapter)

Values that do not overlap with the range specified by the ftpadp.client-pasv-port.min property (minimum value for the range of port numbers where the FTP adapter establishes a data connection when the data connection mode is PASV) and the ftpadp.client-pasv-port.max property (maximum value for the range of port numbers where the FTP adapter establishes a data connection when the data connection mode is PASV)

Values that do not overlap with the range specified by the ftpadp.listen-port.min property (minimum value for the range of port numbers where the FTP adapter waits for a data connection when the data connection mode is PORT) and the ftpadp.listen-port.max property (maximum value for the range of port numbers where the FTP adapter waits for a data connection when the data connection mode is PORT)

If you specify any other value, an error occurs when the FTP adapter starts or during processing of a request in which the data connection mode is changed by <pasvport> in a request message of the FTP adapter.

Important note

Do not specify this property if you omit the ftpadp.client-con-port.min property (minimum value for the range of control connection port numbers of the FTP adapter). If you specify this property, an error occurs when the FTP adapter starts.

If you omit this property, the system automatically sets up any port number.

Associated with control connection timeout

ftpadp.control-con.retry.count=retry-count-when-control-connection-cannot-be-established ~ <Numeric character> ((0 to 10000)) <<5>>

Specifies the retry count when a control connection cannot be established. If you specify 0, the connection will not be retried.

ftpadp.control-con.retry.interval=retry-interval-when-control-connection-cannot-be-established ~ <Numeric character> ((0 to 86400)) <<2>>

Specifies, in seconds, the retry interval when a control connection cannot be established. If you specify 0, the connection will be retried without an interval.

ftpadp.control-con.connect.timeout=connection-timeout-for-control-connection ~ <Numeric character> ((1 to 3600)) <<10>>

Specifies, in seconds, the connection timeout value for a control connection.

Associated with client information (when the data connection mode is PASV)

ftpadp.client-pasv-port.min=minimum-value-for-the-range-of-port-numbers-where-FTP-adapter-establishes-data-connection-when-data-connection-mode-is-PASV ~ <Numeric character> ((1024 to 65535))

Specifies the minimum value for the range of port numbers where the FTP adapter establishes a data connection, when the data connection mode is PASV. This property is valid only when the data connection mode is PASV.

You can specify the following values:

Values that are equal to or less than the ftpadp.client-pasv-port.max property (maximum value for the range of port numbers where the FTP adapter establishes a data connection when the data connection mode is PASV)

Values that do not overlap with the range specified by the ftpadp.client-con-port.min property (minimum value for the range of control connection port numbers of the FTP adapter) and the ftpadp.client-con-port.max property (maximum value for the range of control connection port numbers of the FTP adapter)

If you specify any other value, an error occurs when the FTP adapter starts or during processing of a request in which the data connection mode is changed by <pasvport> in a request message of the FTP adapter.

Important note

Do not specify this property if you omit the ftpadp.client-pasv-port.max property (maximum value for the range of port numbers where the FTP adapter establishes a data connection when the data connection mode is PASV). If you specify this property, an error occurs when the FTP adapter starts.

If you omit this property, the system automatically sets up any port number.

For the port number, specify a value in the range from the value of this property to the value of the ftpadp.client-pasv-port.max property.

If the specified value cannot be used as the port number, specify another value in the preceding range and then retry the connection.

When the connection is retried, the KDEK30410-W message is output.

If an attempt to establish a data connection without specifying this property failed or if all of the values in the range cannot be used for the data connection port number, the KDEK30409-E message is output.

ftpadp.client-pasv-port.max=maximum-value-for-the-range-of-port-numbers-where-FTP-adapter-establishes-data-connection-when-data-connection-mode-is-PASV ~ <Numeric character> ((1024 to 65535))

Specifies the maximum value for the range of port numbers where the FTP adapter establishes a data connection, when the data connection mode is PASV. This property is valid only when the data connection mode is PASV.

You can specify the following values:

Values that are equal to or more than the ftpadp.client-pasv-port.min property (minimum value for the range of port numbers where the FTP adapter establishes a data connection when the data connection mode is PASV)

Values that do not overlap with the range specified by the ftpadp.client-con-port.min property (minimum value for the range of control connection port numbers of the FTP adapter) and the ftpadp.client-con-port.max property (maximum value for the range of control connection port numbers of the FTP adapter)

If you specify any other value, an error occurs when the FTP adapter starts.

Omit this property in the following case. If you specify this property, an error occurs when the FTP adapter starts or during processing of a request in which the data connection mode is changed by <pasvport> in a request message of the FTP adapter.

Important note

If you omit the ftpadp.client-pasv-port.min property (minimum value for the range of port numbers where the FTP adapter establishes a data connection when the data connection mode is PASV), omit this property as well. If you specify this property, an error occurs when the FTP adapter starts.

If you omit this property, the system automatically sets up any port number.

For the port number, specify a value in the range from the value of this property to the value of the ftpadp.client-pasv-port.min property.

If the specified value cannot be used as the port number, specify another value in the preceding range and then retry the connection.

When the connection is retried, the KDEK30410-W message is output.

If an attempt to establish a data connection without specifying this property failed or if all of the values in the range cannot be used for the data connection port number, the KDEK30409-E message is output.

Associated with data connection timeout

ftpadp.data-con.retry.count=retry-count-when-data-connection-cannot-be-established-in-PASV-mode ~ <Numeric character> ((0 to 10000)) <<5>>

Specifies the retry count when a data connection cannot be established in the PASV mode. If you specify 0, the connection will not be retried.

When the connection is retried, the KDEK30410-W message is output. If the retry count exceeds the value of this property, the KDEK30409-E message is output.

ftpadp.data-con.retry.interval=retry-interval-when-data-connection-cannot-be-established-in-PASV-mode ~ <Numeric character> ((0 to 86400)) <<2>>

Specifies, in seconds, the retry interval when a data connection cannot be established in the PASV mode. If you specify 0, the connection will be retried without an interval.

ftpadp.data-con.connect.timeout=connection-timeout-for-data-connection ~ <Numeric character> ((1 to 3600)) <<10>>

Specifies, in seconds, the connection timeout value for a data connection in the PASV mode.

Associated with client information (when the data connection mode is PORT)

ftpadp.listen-port.min=minimum-value-for-the-range-of-port-numbers-where-FTP-adapter-waits-for-data-connection-when-data-connection-mode-is-PORT ~ <Numeric character> ((1024 to 65535)) <<49152>>

Specifies the minimum value for the range of port numbers where the FTP adapter waits for a data connection when the data connection mode is PORT.

This property is valid only when the data connection mode is PORT.

You can specify the following values:

Values that are equal to or less than the ftpadp.listen-port.max property (maximum value for the range of port numbers where the FTP adapter waits for a data connection when the data connection mode is PORT)

Values that do not overlap with the range specified by the ftpadp.client-con-port.min property (minimum value for the range of control connection port numbers of the FTP adapter) and the ftpadp.client-con-port.max property (maximum value for the range of control connection port numbers of the FTP adapter)

If you specify any other value, an error occurs when the FTP adapter starts or during processing of a request in which the data connection mode is changed by <pasvport> in a request message of the FTP adapter.

For the port number used to wait for a data connection, specify a value in the range from the value of this property to the value of the ftpadp.listen-port.max property.

If the specified value cannot be used as the port number, specify another value in the preceding range and then retry the connection.

When the connection is retried, the KDEK30410-W message is output.

If all the values in the range cannot be used for the wait port number, the KDEK30409-E message is output.

ftpadp.listen-port.max=maximum-value-for-the-range-of-port-numbers-where-FTP-adapter-waits-for-data-connection-when-data-connection-mode-is-PORT ~ <Numeric character> ((1024 to 65535)) <<65535>>

Specifies the maximum value for the range of port numbers where the FTP adapter waits for a data connection when the data connection mode is PORT.

This property is valid only when the data connection mode is PORT.

You can specify the following values:

Values that are equal to or more than the ftpadp.listen-port.min property (minimum value for the range of port numbers where the FTP adapter waits for a data connection when the data connection mode is PORT)

Values that do not overlap with the range specified by the ftpadp.client-con-port.min property (minimum value for the range of control connection port numbers of the FTP adapter) and the ftpadp.client-con-port.max property (maximum value for the range of control connection port numbers of the FTP adapter)

If you specify any other value, an error occurs when the FTP adapter starts or during processing of a request in which the data connection mode is changed by <pasvport> in a request message of the FTP adapter.

For the port number used to wait for a data connection, specify a value in the range from the value of this property to the value specified for the ftpadp.listen-port.min property.

If the specified value cannot be used as the port number, specify another value in the preceding range and then retry the connection.

When the connection is retried, the KDEK30410-W message is output.

If all of the values in the range cannot be used for the wait port number, the KDEK30409-E message is output.

Associated with the reuse of ports

ftpadp.listen-port.reuse={TRUE|FALSE} ~ <<TRUE>>

Specifies whether to reuse ports in the TIME_WAIT status when the OS is Linux or AIX and the data connection mode is the PORT mode. If the data connection mode is other than the PORT mode, the value specified in this property is ignored.

You can reuse the ports having port numbers in the range from the value specified for ftpadp.listen-port.min to the value specified for ftpadp.listen-port.max.

TRUE

Ports in the TIME_WAIT status will be reused.

In addition, SO_REUSEADDR is enabled.

TRUE is also assumed when you omit this property or if you specify only the property name.

Important note

Depending on whether port numbers used in the PASV mode (in the range from the value of ftpadp.client-pasv-port.min to the value of ftpadp.client-pasv-port.max) are specified, make sure that the port numbers are not duplicated as follows. If port numbers are duplicated, operations are not guaranteed.

If port numbers for use in the PASV mode are specified

Make sure that the port numbers are not in the range of the port numbers used in the PORT mode (the range from the value specified for ftpadp.listen-port.min to the value specified for ftpadp.listen-port.max).

If port numbers for use in the PASV mode are not specified

Make sure that the available range of OS dynamic ports do not overlap with the range of port numbers used in the PORT mode (the range from the value specified for ftpadp.listen-port.min to the value specified for ftpadp.listen-port.max).

FALSE

Ports in the TIME_WAIT status will not be reused.

In addition, SO_REUSEADDR is disabled.

If you specify this property in Windows, an error occurs when an FTP adapter starts.

Important note

When you specify this property in Linux or AIX, specify the same value for all FTP adapters in the PORT mode on the HCSC server. If you do not specify the same value, operations are not guaranteed.

Associated with Listen timeout

ftpadp.listen.timeout=Listen-timeout-value ~ <Numeric character> ((1 to 3600)) <<60>>

Specifies, in seconds, the monitoring time for the Listen status after a reply is received from the PORT command in the PORT mode. If there is no data connection request from the server when the specified time has elapsed, an exception (error) occurs.

Associated with data read timeout

ftpadp.data-con.read.timeout=receive-buffer-read-timeout-value-for-data-connection-in-passive-mode ~ <Numeric character> ((0 to 3600)) <<0>>

Specifies, in seconds, the timeout value for reading data from the receive buffer for a data connection in passive mode.

If you specify 0, timeouts do not occur.

Associated with exception logs

ftpadp.exptrace.filenum=number-of-exception-log-files ~ <Numeric character> ((1 to 16)) <<8>>

Specifies the number of exception log files.

ftpadp.exptrace.filesize=maximum-size-of-one-exception-log-file ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the maximum size of one exception log file in bytes.

Associated with FTP protocol trace

ftpadp.ftpprotocoltrace.filenum=number-of-protocol-trace-files ~ <Numeric character> ((1 to 16)) <<8>>

Specifies the number of protocol trace files.

ftpadp.ftpprotocoltrace.filesize=maximum-size-of-one-protocol-trace-file ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the maximum size of one protocol trace file in bytes.

Associated with maintenance logs

ftpadp.methodtrace.level={1|2|3|4|5} ~ <<3>>

Specifies the output level for the maintenance log. The following table lists the output information and output levels.

Output information

Output level

1

2

3

4

5

Error information (cause of an exception)

Y

Y

Y

Y

Y

Entrance and exit information for the requestor service method (class name, method name, argument, return value)

N

Y

Y

Y

Y

Entrance and exit information for the external (such as BP) interfaces (class name, method name, argument, return value)

N

N

Y

Y

Y

Entrance and exit information for the interfaces within a component (class name, method name, argument, return value)

N

N

N

Y

Y

Debug information (such as information of branching of processing)

N

N

N

N

Y

Legend:

Y: Information is output.

N: Information is not output.

ftpadp.methodtrace.filepath=absolute-path-of-directory-to-output-maintenance-log ~ <Character strings (including two-byte characters) and spaces> <<directory-to-output-J2EE-server-log\CSCADP\FTPADP\maintenance\service-ID>>

Specifies the absolute path to the directory to output the maintenance log.

directory-to-output-J2EE-server-log is specified in ejb.server.log.directory of usrconf.cfg (option definition file for the J2EE server).

A directory having the specified service ID is created directly under the specified path, and then the maintenance log is created in this directory.

Note that a maintenance log is created with the name cscftpadpmtd_HCSC-server-name_number-of-files.log.

If you specify a non-existent directory or if the directory having the service ID cannot be created, the KDEK20903-W message is output and the maintenance log is output to the default output destination directory.

ftpadp.methodtrace.filenum=number-of-maintenance-log-files ~ <Numeric character> ((1 to 16)) <<8>>

Specifies the number of maintenance log files.

ftpadp.methodtrace.filesize=maximum-size-of-one-maintenance-log-file ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the maximum size of one maintenance log file in bytes.

Associated with message logs

ftpadp.messagelog.level={0|10|20} ~ <<10>>

Specifies the output level for the message log. The following table lists the output information and output levels:

Output information

Output level

0

10

20

Error information

Cause of an exception or an error

Y

Y

Y

Warning information

Information such as a problem that occurred

N

Y

Y

Information

Contents of messages and arguments

Change in the HCSC-Messaging status (when starting or stopping)

Command reception and completion of execution

Event notification

N

N

Y

Legend:

Y: Information is output.

N: Information is not output.

Associated with paths

ftpadp.account-inf-filepath=absolute-path-of-FTP-adapter-account-definition-file ~ <Character strings (including two-byte characters) and spaces>

Specifies the absolute path to the FTP adapter account definition file.

ftpadp.cscthrough-filepath=absolute-path-of-FTP-command-authorization-list-definition-file-(for-FTP-adapters) ~ <Character strings (including two-byte characters) and spaces>

Specifies the absolute path to the FTP command authorization list definition file (for FTP adapters). If you omit this property, the user-specified FTP commands cannot be executed before and after the transmission and before and after the execution of list commands.

Associated with lock acquisition timeout

ftpadp.read-lock.retry.count=retry-count-when-shared-lock-of-common-folder-files-fails ~ <Numeric character> ((0 to 1024)) <<0>>

Specifies the retry count when a shared lock of the files in the common folder fails.

ftpadp.read-lock.retry.interval=retry-interval-when-shared-lock-of-common-folder-files-fails ~ <Numeric character> ((1 to 1024)) <<1>>

Specifies, in seconds, the retry interval when a shared lock of the files in the common folder fails.

ftpadp.write-lock.retry.count=retry-count-when-dedicated-lock-of-common-folder-files-fails ~ <Numeric character> ((0 to 1024)) <<0>>

Specifies the retry count when a dedicated lock of the files in the common folder fails.

ftpadp.write-lock.retry.interval=retry-interval-when-dedicated-lock-of-common-folder-files-fails ~ <Numeric character> ((1 to 1024)) <<1>>

Specifies, in seconds, the retry interval when a dedicated lock of the files in the common folder fails.

Associated with data transmission or acquisition timeout

ftpadp.data-con-put.timeout=timeout-value-for-data-transmission ~ <Numeric character> ((1 to 86400)) <<60>>

Specifies, in seconds, the monitoring time until the transmission of the entire file is completed when sending data. If the sending process is not completed even after the specified time has elapsed, an exception (error) occurs.

ftpadp.data-con-get.timeout=timeout-value-for-data-acquisition ~ <Numeric character> ((1 to 86400)) <<60>>

Specifies, in seconds, the monitoring time until the reception of the entire file is completed when receiving data. If the receiving process is not completed even after the specified time has elapsed, an exception (error) occurs.

Associated with FTP command reply timeout

ftpadp.ftp-command-reply.timeout=reply-timeout-value ~ <Numeric character> ((1 to 3600)) <<60>>

Specifies, in seconds, the monitoring time until a reply is received after an FTP command is issued. If there is no reply for the command even after the specified time has elapsed, an exception (error) occurs.

Associated with the buffer size

ftpadp.put-client-buffer.size=client-buffer-size-for-file-transmission-(sending) ~ <Numeric character> ((512 to 262144)) <<40960>>

Specifies the size of client buffer memory in bytes for file transmission (sending).

Change this value when the memory is limited or if you want to improve the transmission efficiency. Note that the transmission efficiency varies depending on the line speed, line usage, and CPU performance.

ftpadp.get-client-buffer.size=client-buffer-size-for-file-transmission-(receiving) ~ <Numeric character> ((512 to 262144)) <<40960>>

Specifies the size of client buffer memory in bytes for file transmission (receiving).

Change this value when the memory is limited or if you want to improve the transmission efficiency. Note that the transmission efficiency varies depending on the line speed, line usage, and CPU performance.

(4) Notes

We recommend that you specify the following property in the FTP-adapter runtime-environment common properties file because you must specify the same value for this property for all FTP adapters in the PORT mode. If different values are specified for FTP adapters, operations are not guaranteed.

ftpadp.listen-port.reuse

Note the following when you specify the path:

Do not specify a path that contains characters expressing a relative path or a parent directory (..\ or ../) or characters expressing a current directory (.\ or ./).

Do not specify a path containing a symbolic link.

In Windows, do not specify a path containing a UNC format, an NTFS stream name, or a reserved device name. The path characters are not case sensitive.

6.8.4 FTP reception configuration file

(1) Format

[urecp-ftp.permission-def.filepath=Path-of-FTP-execution-authorization-list-definition-file]
[urecp-ftp.ftp-command-allow.filepath=Path-of-FTP-command-authorization-list-definition-file]
[urecp-ftp.request-timeout=processing-time-of-business-process-after-FTP-reception]
[urecp-ftp.resident-thread.count=number-of-resident-threads-used-for-monitoring-the-processing-time-after-FTP-reception]
[urecp-ftp.timer-thread.maximum=maximum-number-of-threads-used-for-monitoring-the-processing-time-after-FTP-reception]
[urecp-ftp.list-command-option.filepath=Path-of-list-command-options-definition-file]
[urecp-ftp.read-lock.retry.count=retry-count-when-shared-lock-of-common-folder-files-fails]
[urecp-ftp.read-lock.retry.interval=retry-interval-when-shared-lock-of-common-folder-files-fails]
[urecp-ftp.write-lock.retry.count=retry-count-when-dedicated-lock-of-common-folder-files-fails]
[urecp-ftp.write-lock.retry.interval=retry-interval-when-dedicated-lock-of-common-folder-files-fails]

(2) Function

Specifies the information for the settings that are changed frequently after an FTP reception is set up. The contents specified in the FTP reception configuration file become valid when an FTP reception starts.

This file specifies the parameters that depend on the execution environment of FTP receptions.

There are two types of FTP reception configuration files: the individual definition file specified for each FTP reception, and the common definition file that is applied to all FTP receptions. A common definition file that is applied to all FTP receptions is referred to as an FTP reception common configuration file.

If both an FTP reception configuration file and an FTP reception common configuration file are specified, the definitions of the two files are merged. If the same properties are specified in these files, the contents of the FTP reception configuration file become valid.

You can create an FTP reception configuration file and an FTP reception common configuration file based on the template file.

How to create an FTP reception configuration file

To create an FTP reception configuration file:

Define the FTP reception configuration file based on the following template file:

service-platform-installation-directory\CSC\config\ftprecp\templates\ftprecp_config.properties

Rename the edited FTP reception configuration file as reception-ID.properties, and then store the file in the following directory:

service-platform-installation-directory\CSC\config\ftprecp

How to create an FTP reception common configuration file

To create an FTP reception common configuration file:

Define the FTP reception common configuration file based on the following template file:

service-platform-installation-directory\CSC\config\ftprecp\templates\ftprecp_config.properties

Store the edited FTP reception common configuration file in the following directory:

service-platform-installation-directory\CSC\config\ftprecp\common

Do not change the file name.

(3) Specifiable properties

urecp-ftp.permission-def.filepath=Path-of-FTP-execution-authorization-list-definition-file ~ <Character strings (including two-byte characters) and spaces>

Specifies an absolute path for the FTP execution authorization list definition file.

If you omit this property in both the individual definition file and the common definition file, all users are permitted to execute business processes related to FTP receptions.

urecp-ftp.ftp-command-allow.filepath=Path-of-FTP-command-authorization-list-definition-file ~ <Character strings (including two-byte characters) and spaces>

Specifies an absolute path for the FTP command authorization list definition file (for FTP receptions).

If you omit this property in both the individual definition file and the common definition file, the execution of user-specified FTP commands is not permitted before and after transmission and before and after execution of list commands.

urecp-ftp.request-timeout=processing-time-of-business-process-after-FTP-reception ~ <Numeric character> ((0 to 2147483647)) <<0>>

Specifies the processing time from the passing of a request message to a business process after an FTP reception and until the return of a response message, in seconds.

If you specify 0 or if you omit the key or the value, the processing time is not monitored.

If you specify a value of 1 or more, resident threads will be created to monitor the processing time. Specify the number of resident threads in the urecp-ftp.resident-thread.count property.

If you specify a non-numeric value or a value outside the range, an error occurs when the command is executed.

urecp-ftp.resident-thread.count=number-of-resident-threads-used-for-monitoring-the-processing-time-after-FTP-reception ~ <Numeric character> ((0 to 2147483647)) <<0>>

Specifies the number of resident threads created for monitoring the processing time in business processes after an FTP reception. A resident thread is generated when an FTP reception starts.

Also, no threads are generated if the monitoring process is not executed. Therefore, the value specified in this property is ignored.

If you specify a non-numeric value or a value outside the range, an error occurs when the command is executed. Also, if you specify a value that is greater than the value specified in the urecp-ftp.timer-thread.maximum property, an error occurs when the command is executed.

urecp-ftp.timer-thread.maximum=maximum-number-of-threads-used-for-monitoring-the-processing-time-after-FTP-reception ~ <Numeric character> ((0 to 2147483647)) <<value specified for urecp-ftp.pooled-instance.maximum in the FTP reception definition file>>

Specifies the maximum number of threads used for monitoring the processing time after an FTP reception. No threads are generated if the processing time is not monitored. Therefore, the value specified in this property is ignored.

If you omit the key or the value, the value specified in the urecp-ftp.pooled-instance.maximum property (maximum number of instances pooled for the reception processing and the custom reception framework) of the FTP reception definition file is applied as the default value. The changes made with the csccompoconfig command are not applied.

The maximum number of threads is one amongst the following cases:

When you specify 0

When the default value is applied and the value specified for urecp-ftp.pooled-instance.maximum in the FTP reception definition file is 0

urecp-ftp.list-command-option.filepath=Path-of-list-command-options-definition-file ~ <Character strings (including two-byte characters) and spaces>

Specifies an absolute path for the list command options definition file.

If you omit this property in both the individual definition file and the common definition file, all information specified in the list command arguments is interpreted as the path information.

urecp-ftp.read-lock.retry.count=retry-count-when-shared-lock-of-common-folder-files-fails ~ <Numeric character> ((0 to 1024)) <<0>>

Specifies the retry count when a shared lock of the files in the common folder fails. If you do not use the common folder, the value specified for this property is ignored because the files are not locked with a shared lock.

If you omit the key or the value, the default value is used for operation.

If you specify a non-numeric value or a value outside the range, an error occurs when the command is executed.

urecp-ftp.read-lock.retry.interval=retry-interval-when-shared-lock-of-common-folder-files-fails ~ <Numeric character> ((1 to 1024)) <<1>>

Specifies, in seconds, the retry interval when a shared lock of the files in the common folder fails. If you do not use the common folder, the value specified for this property is ignored because the files are not locked with a shared lock.

If you omit the key or the value, the default value is used for operation.

If you specify a non-numeric value or a value outside the range, an error occurs when the command is executed.

urecp-ftp.write-lock.retry.count=retry-count-when-dedicated-lock-of-common-folder-files-fails ~ <Numeric character> ((0 to 1024)) <<0>>

Specifies the retry count when a dedicated lock of the files in the common folder fails. If you do not delete the files in the common folder, the value specified for this property is ignored because the files are not locked with a dedicated lock.

If you omit the key or the value, the default value is used for operation.

If you specify a non-numeric value or a value outside the range, an error occurs when the command is executed.

urecp-ftp.write-lock.retry.interval=retry-interval-when-dedicated-lock-of-common-folder-files-fails ~ <Numeric character> ((1 to 1024)) <<1>>

Specifies, in seconds, the retry interval when a dedicated lock of the files in the common folder fails. If you do not delete the files in the common folder, the value specified for this property is ignored because the files are not locked with a dedicated lock.

If you omit the key or the value, the default value is used for operation.

If you specify a non-numeric value or a value outside the range, an error occurs when the command is executed.

(4) Example of coding

The examples of coding are as follows:

In Windows

urecp-ftp.permission-def.filepath=C:\\my_config\\permission_A.properties
urecp-ftp.ftp-command-allow.filepath=C:\\my_config\\command_allow_X.properties
urecp-ftp.list-command-option.filepath=C:\\my_config\\list_command_option.txt

In UNIX

urecp-ftp.permission-def.filepath=/my_config/permission_A.properties
urecp-ftp.ftp-command-allow.filepath=/my_config/command_allow_X.properties
urecp-ftp.list-command-option.filepath=/my_config/list_command_option.txt

(5) Notes

Note the following when you specify the path:

Do not specify a path that contains characters expressing a relative path or a parent directory (..\ or ../) or characters expressing a current directory (.\ or ./).

Do not specify a path containing a symbolic link.

In Windows, do not specify a path containing a UNC format, an NTFS stream name, or a reserved device name. The path characters are not case sensitive.

6.8.5 FTP command authorization list definition file

(1) Format

[ftp-command.allow=FTP-command-that-can-be-executed]
[ftp-command.site.allow=Commands-that-can-be-executed-with-SITE-command]

(2) Function

Specifies the FTP commands that can be executed before and after the transmission and before and after the execution of list commands.

The FTP command authorization list definition file includes two types of files, the file for FTP adapters and the file for FTP receptions.

The contents specified in the FTP command authorization list definition file become valid when an FTP reception or FTP adapter starts.

You can create an FTP command authorization list definition file based on the template file.

How to create an FTP command authorization list definition file (for FTP reception)

To create an FTP command authorization list definition file (for FTP reception):

Define the FTP command authorization list definition file (for FTP reception) based on the following template file:

service-platform-installation-directory\CSC\config\ftprecp\templates\ftp_command_allow.properties

Store the edited FTP command authorization list definition file (for FTP reception) in the following directory:

service-platform-installation-directory\CSC\config\ftprecp\common

Do not change the file name.

Reference note

If you specify the following property, you can store the FTP command authorization list definition file (for FTP receptions) in any path and with any file name:

urecp-ftp.ftp-command-allow.filepath property of the FTP reception configuration file

If you omit this property, the FTP command authorization list definition file stored in the directory indicated in step 2 is used. If this directory does not contain the FTP command authorization list definition file, the execution of all the FTP commands is not permitted.

How to create an FTP command authorization list definition file (for FTP adapters)

To create an FTP command authorization list definition file (for FTP adapters):

Define the FTP command authorization list definition file (for FTP adapters) based on the following template file:

service-platform-installation-directory\CSC\custom-adapter\FTP\config\templates\cscthrough.properties

Store the edited FTP command authorization list definition file (for FTP adapters) in the following directory:

service-platform-installation-directory\CSC\custom-adapter\FTP\config\common

Do not change the file name.

Reference note

If you specify the following property, you can store the FTP command authorization list definition file (for FTP adapters) with any file name and in any path:

ftpadp.cscthrough-filepath property of the FTP-adapter runtime-environment property file

If you omit this property, the FTP command authorization list definition file stored in the directory indicated in step 2 is used. If this directory does not contain the FTP command authorization list definition file, the execution of all the FTP commands is not permitted.

(3) Specifiable properties

ftp-command.allow=FTP-command-that-can-be-executed ~ <Character strings or one-byte asterisks (*)>

Specifies the FTP commands that can be executed for the business processes before or after the transmission. The characters are not case sensitive.

If you omit this property, the execution of all the FTP commands, except the SITE command, will not be permitted.

Important note

The settings for this property are applied only to the FTP reception or the FTP adapter in which the path of this definition file is specified in the FTP reception configuration file or FTP-adapter runtime-environment property file.

The ftp-command.site.allow property specifies whether the commands set as arguments of the SITE command can be executed. Therefore, you need not specify the SITE command in this property.

To specify multiple commands, specify command, command, ..., by using commas (,) as delimiters. The one-byte spaces and tab characters before and after the commas are ignored.

If you specify one-byte asterisks (*) only, all the FTP commands, except the SITE command supported by the service platform, can be executed.

The commands STOR, APPE, STOU, RETR, LIST, and NLST are not supported by the service platform. Therefore, even if you specify these commands, they cannot be executed. Similarly, even if you specify one-byte asterisks (*), the commands cannot be executed.

ftp-command.site.allow=Commands-that-can-be-executed-with-SITE-command ~ <Character strings or one-byte asterisks (*)>

Specifies the commands that are uniquely supported by the FTP server and that can be executed for the business processes before or after the transmission. The command specified as the first argument of the SITE command becomes the target of this property. The characters are not case sensitive.

If you omit this property, none of the SITE commands can be executed.

Important note

The settings for this property are applied only to the FTP reception or the FTP adapter in which the path of this definition file is specified in the FTP reception configuration file or FTP-adapter runtime-environment property file.

The SITE FSIZE command is processed with the FTP inbound adapter. Therefore, even if you specify FSIZE in the value of this property, the value is ignored.

To specify multiple commands, specify command, command, ..., by using commas (,) as delimiters. The one-byte spaces and tab characters before and after the commas are ignored.

If you specify one-byte asterisks (*) only, all the SITE commands, except FSIZE, can be executed.

(4) Example of coding

An example of coding is as follows:

ftp-command.allow=STAT, RNFR, RNTO, DELE, RMD
ftp-command.site.allow=CHMOD, UMASK

The details for the example of coding are as follows:

Permitted FTP commands (except the SITE command): Commands STAT, RNFR, RNTO, DELE, and RMD

Permitted SITE commands: Commands CHMOD and UMASK

6.8.6 FTP execution authorization list definition file

(1) Format

[urecp-ftp.permission.allow=user-name-with-execution-permission]
[urecp-ftp.permission.deny=user-name-without-execution-permission]

(2) Function

Specifies the users who will be allowed or not allowed to execute the business processes associated with an FTP reception.

You can create an FTP execution authorization list definition file based on the template file.

To create an FTP execution authorization list definition file:

Define the FTP execution authorization list definition file based on the following template file:

service-platform-installation-directory\CSC\config\ftprecp\templates\ftp_permission_allow.properties

Store the edited FTP execution authorization list definition file in the following directory:

service-platform-installation-directory\CSC\config\ftprecp\common

Do not change the file name.

Reference note

If you specify the following property, you can store the FTP execution authorization list definition file in any path and with any file name:

urecp-ftp.permission-def.filepath property of the FTP reception configuration file

If you omit this property, the FTP execution authorization list definition file stored in the directory indicated in step 2 is used. If this directory does not contain the FTP execution authorization list definition file, the execution of all the FTP commands is not permitted.

(3) Specifiable properties

urecp-ftp.permission.allow=user-name-with-execution-permission ~ <Character strings or one-byte asterisks (*)> <<*>>

Specifies the name of the user who will be allowed to execute the business processes associated with an FTP reception.

To specify multiple users, specify user-name, user-name, ..., by using one-byte commas (,) as delimiters. The one-byte spaces and tab characters before and after the one-byte commas are ignored.

The empty user names (user names with length 0) are also ignored. If you specify the user names as follows, null will be ignored and the FTP reception will start successfully:

urecp-ftp.permission.allow = user-name-1,
urecp-ftp.permission.allow = user-name-1, Δ
urecp-ftp.permission.allow = user-name-1, Δ,user-name-2
urecp-ftp.permission.allow = user-name-1,,,,,,,,,,user-name-2
urecp-ftp.permission.allow = ,tab-character user-name-1 tab-character,tab-character tab-character

Legend:

Δ: Indicates a one-byte space.

If you specify one-byte asterisks (*) only, all the users are allowed to execute the business processes. Note that to specify a user name in the following format, enclose the user name within tab characters:

User names containing one-byte commas (,)

User names with one-byte spaces at the beginning or at the end

User names containing one one-byte asterisks (*)

If you omit this property, a one-byte asterisk (*) is specified.

Important note

The users specified in the urecp-ftp.permission.deny property (name of the user who does not have the execution permission) are not allowed to execute the business processes associated with an FTP reception.

urecp-ftp.permission.deny= user-name-without-execution-permission <Character strings or one-byte asterisks (*)>

Specifies the name of the user who will not be allowed to execute the business processes associated with an FTP reception.

To specify multiple users, specify user-name, user-name, ..., by using one-byte commas (,) as delimiters. The one-byte spaces and tab characters before and after the one-byte commas are ignored.

The empty user names (user names with length 0) are also ignored. If you specify the user names as follows, null will be ignored and the FTP reception will start successfully:

urecp-ftp.permission.deny = user-name-1,
urecp-ftp.permission.deny = user-name-1, Δ
urecp-ftp.permission.deny = user-name-1, Δ,user-name-2
urecp-ftp.permission.deny = user-name-1,,,,,,,,,,user-name-2
urecp-ftp.permission.deny = ,tab-character user-name-1 tab-character,tab-character tab-character

Legend:

Δ: Indicates a one-byte space.

Note that to specify a user name in the following format, enclose the user name within tab characters:

User names containing one-byte commas (,)

User names with one-byte spaces at the beginning or at the end

Important note

The users specified in this property are not allowed to execute the business processes associated with an FTP reception even if the user name or a one-byte asterisk (*) is specified in the urecp-ftp.permission.allow property (name of the user who has the execution permission).

(4) Example of coding

An example of coding is as follows:

To allow all the users (default )

urecp-ftp.permission.allow=*

Note that all the users are allowed even if the urecp-ftp.permission-def.filepath property (path of the FTP execution authorization list definition file) is not specified in the FTP reception configuration file.

To allow the user names root and admin only

urecp-ftp.permission.allow=root,admin

To allow the users other than the user names guest1 and guest2

If the urecp-ftp.permission.allow property (name of the user who has the execution permission) is specified

urecp-ftp.permission.allow=*
urecp-ftp.permission.deny=guest1,guest2

If the urecp-ftp.permission.allow property is omitted

urecp-ftp.permission.deny=guest1,guest2

6.8.7 File operations adapter runtime-environment property file

(1) Format

[messagelog-level={0|10|20}]

[methodtrace-level={1|2|3|4|5}]
[methodtrace-filenum=number-of-maintenance-log-files]
[methodtrace-filesize=maximum-size-of-one-maintenance-log-file]

[exptrace-filenum=number-of-exception-log-files]
[exptrace-filesize=maximum-size-of-one-exception-log-file]

[readLock.retry.count=lock-retry-count-when-shared-lock-cannot-be-obtained]
[readLock.retry.interval=lock-retry-interval-when-shared-lock-cannot-be-obtained]
[writeLock.retry.count=lock-retry-count-when-dedicated-lock-cannot-be-obtained]
[writeLock.retry.interval=lock-retry-interval-when-dedicated-lock-cannot-be-obtained]

[transform.limitsize=input-file-size-for-stopping-file-transformation]
[transform.timeout=timeout-value-for-stopping-file-transformation]
[compress.inputfile.limitsize=input-file-size-for-stopping-file-compression]
[compress.outputfile.limitsize=output-file-size-for-stopping-file-compression]
[compress.timeout=timeout-value-for-stopping-file-compression]
[extract.inputfile.limitsize=input-file-size-for-stopping-file-extraction]
[extract.outputfile.limitsize=output-file-size-for-stopping-file-extraction]
[extract.timeout=timeout-value-for-stopping-file-extraction]
[writeList.outputfile.limitsize=output-file-size-for-stopping-file-list-write]

(2) Function

Specifies information such as the output levels of the message and trace logs for the operations of the file operations adapter in the execution environment.

(3) File storage location

Service-platform-installation-directory\CSC\config\adpfop\service-ID.properties

(4) Specifiable properties

(a) Message log

messagelog-level={0|10|20} ~ <<10>>

Specifies the output levels for the message log. The following table lists the output information and the output levels:

Output information

Output level

0

10

20

Error information

Cause of an exception or an error

Y

Y

Y

Warning information

Information such as the problem that occurred

O

Y

Y

Information

Content of the messages and arguments

Change in the HCSC-Messaging status (when starting or stopping)

During command reception and completion of execution

Event notification

O

O

O

Legend:

Y: Information is output.

O: Only important log messages are output.

(b) Maintenance log

methodtrace-level={1|2|3|4|5} ~ <<3>>

Specifies the output levels for the maintenance log. The following table lists the output information and the output levels:

Output information

Output level

1

2

3

4

5

Entrance and exit information for the requester service method (class name, method name, argument, return value)

N

Y

Y

Y

Y

Entrance and exit information for the external (such as BP) interfaces (class name, method name, argument, return value)

N

N

Y

Y

Y

Entrance and exit information for the interfaces within the components (class name, method name, argument, return value)

N

N

N

Y

Y

Debug information (information such as the branching of processing)

N

N

N

N

Y

Legend:

Y: Information is output.

N: Information is not output.

methodtrace-filenum=number-of-maintenance-log-files ~ <Numeric character> ((1 to 16)) <<8>>

Specifies the number of maintenance log files.

methodtrace-filesize=maximum-size-of-one-maintenance-log-file ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the maximum size of one maintenance log file in bytes.

(c) Exception log

exptrace-filenum=number-of-exception-log-files ~ <Numeric character> ((1 to 16)) <<8>>

Specifies the number of exception log files.

exptrace-filesize=maximum-size-of-one-exception-log-file ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the maximum size of one exception log file in bytes.

(d) Acquiring a lock

readLock.retry.count=lock-retry-count-when-shared-lock-cannot-be-obtained ~ <Numeric character> ((0 to 1024)) <<0>>

Specifies the lock retry count when a shared lock cannot be obtained.

readLock.retry.interval=lock-retry-interval-when-shared-lock-cannot-be-obtained ~ <Numeric character> ((1 to 1024)) <<1>>

Specifies the lock retry interval when a shared lock cannot be obtained, in seconds.

writeLock.retry.count=lock-retry-count-when-dedicated-lock-cannot-be-obtained ~ <Numeric character> ((0 to 1024)) <<0>>

Specifies the lock retry count when a dedicated lock cannot be obtained.

writeLock.retry.interval=lock-retry-interval-when-dedicated-lock-cannot-be-obtained ~ <Numeric character> ((1 to 1024)) <<1>>

Specifies the lock retry interval when a dedicated lock cannot be obtained, in seconds.

(e) Other

transform.limitsize=input-file-size-for-stopping-file-transformation ~ <Numeric character> ((0 to 2147483647)) <<62914560>>

Specifies the maximum size of the input file that is to be transformed with the file transformation operation, in bytes. If the input file exceeds the maximum size, an error message (KDEC80051-E) is displayed and the processing ends. If you specify 0, the file size becomes unlimited.

transform.timeout=timeout-value-for-stopping-file-transformation ~ <Numeric character> ((0 to 86400)) <<60>>

Specifies the timeout value for the segmented processing method in the file transformation operation, in seconds. If the time that has elapsed from the start of the file transformation operation to the completion of the processing of all the separated records exceeds the specified timeout value, an error message (KDEC80052-E) is displayed and the processing ends.

Note that this property is ignored even if specified for the batch processing method.

A timeout does not occur if you specify 0.

compress.inputfile.limitsize=input-file-size-for-stopping-file-compression ~ <Numeric character> ((1-9223372036854775807)) <<4294967296>>

Specifies the maximum size (in bytes) of the input file to be compressed with the file compression operation. The specification of the maximum value is treated as unlimited. If the input file exceeds the maximum size, an error message (KDEC80105-E) is displayed and the processing ends.

compress.outputfile.limitsize=output-file-size-for-stopping-file-compression ~ <Numeric character> ((1-9223372036854775807)) <<4294967296>>

Specifies the maximum size (in bytes) of the output file to be compressed with the file compression operation. The specification of the maximum value is treated as unlimited. If the output file exceeds the maximum size, an error message (KDEC80106-E) is displayed and the processing ends.

compress.timeout=timeout-time-for-stopping-file-compression ~ <Numeric character> ((0-86400)) <<60>>

Specifies the timeout value (in seconds) for conversion in the file conversion operation. If the time that has elapsed from the start of the file conversion operation until the file is compressed exceeds the specified timeout value, an error message (KDEC80107-E) is displayed and the processing ends.

A timeout does not occur if you specify 0.

extract.inputfile.limitsize=input-file-size-for-stopping-file-extraction ~ <Numeric character> ((1-9223372036854775807)) <<4294967296>>

Specifies the maximum size (in bytes) of the input file to be extracted with the file extraction operation. The specification of the maximum value is treated as unlimited. If the input file exceeds the maximum size, an error message (KDEC80126-E) is displayed and the processing ends.

extract.outputfile.limitsize=output-file-size-for-stopping-file-extraction ~ <Numeric character> ((1-9223372036854775807)) <<4294967296>>

Specifies the maximum size (in bytes) of the output file to be extracted with the file extraction operation. The specification of the maximum value is treated as unlimited. If the output file exceeds the maximum size, an error message (KDEC80127-E) is displayed and the processing ends.

extract.timeout=timeout-time-for-stopping-file-extraction ~ <Numeric character> ((0-86400)) <<60>>

Specifies the timeout value (in seconds) for extraction in the file extraction operation. If the time that has elapsed from the start of the file extraction operation until the file is extracted exceeds the specified timeout value, an error message (KDEC80128-E) is displayed and the processing ends.

A timeout does not occur if you specify 0.

writeList.outputfile.limitsize=output-file-size-for-stopping-file-list-write ~ <Numeric character> ((0 to 214743647)) <<62914560>>

Specifies the maximum size (in bytes) of the output file to which file list information is to be output with the file list write operation. If the output file exceeds the maximum size, an error message (KDEC80106-E) is displayed and the processing ends. If you specify 0, the file size is unlimited.

(5) Example of coding

An example of coding is as follows:

messagelog-level=10
methodtrace-level=3
methodtrace-filenum=8
methodtrace-filesize=2097152
 ...

6.8.8 List command options definition file

(1) Format

[option-string-1]
[option-string-2]
 ...
[option-string-n]

(2) Function

Specifies the option strings, which form the arguments of the list commands (LIST and NLST commands) executed by the FTP client, on each line. You can specify multiple option strings, however, only one option string is applied to each command.

The following are the differences in the execution format of the list commands when the list command options definition file is not defined and when the file is defined. Δ indicates a single one-byte space.

When the list command options definition file is not defined

The execution format of the list commands is as follows:

LIST[Δpath]
NLST[Δpath]

In such cases, all the information specified in the list command arguments is interpreted as the path information.

When the list command options definition file is defined

If you define option-string as list command options in advance, you can execute the list commands in the following execution format.

LIST[Δoption-string][ Δpath]
NLST[Δoption-string][ Δpath]

The FTP reception separates the information specified in the list command arguments into option-string and path, as defined in the list command options definition file, and executes the information.

(3) File storage location

Because there is no template file for the list command options definition file, you need to create a new file.

The path where the list command options definition file is stored and the file name are optional.

However, the storage location of the list command options definition file must be specified with the absolute path in the urecp-ftp.list-command-option.filepath property of the FTP reception configuration file. If you omit the urecp-ftp.list-command-option.filepath property, the list command options definition file (ftp_command_option.txt) stored in the following directory is used. If the list command options definition file is not stored in this directory, all information specified in the list command arguments is interpreted as the path information.

service-platform-installation-directory\CSC\custom-adapter\FTP\config\common

(4) Specifiable properties

option-string ~ <Character string>

Specifies the option strings that can be specified in the list command arguments.

You can specify one-byte alphanumeric characters, one-byte symbols (0x21 to 0x7E in ASCII encoding), and one-byte spaces (0x20 in ASCII encoding). The characters are case sensitive. You cannot specify one-byte spaces and tab characters at the beginning and at the end.

The available one-byte symbols are as follows:

Exclamation mark (!)

Double quotation mark (")

Hash mark (#)

Dollar sign ($)

Percent sign (%)

Ampersand (&)

Apostrophe mark (')

Left parenthesis (()

Right parenthesis ())

Asterisk (*)

Plus sign (+)

Comma (,)

Hyphen (-)

Period (.)

Forward slash (/)

Colon (:)

Semicolon (;)

Left angle bracket (<)

Right angle bracket (>)

Equal sign (=)

Question mark (?)

At mark (@)

Left square bracket ([)

Right square bracket (])

Yen sign (\)

Caret (^)

Underscore (_)

Grave accent mark (`)

Left curly bracket ({)

Right curly bracket (})

Vertical bar (|)

Swung dash (~)

(5) Example of coding

To be able to specify both the options, -al and -la, specify the option strings in both the formats, as follows:

-al
-la

To be able to specify both the options, -l and -L, specify the option strings in both the formats, as follows:

-l
-L

(6) Notes

If you change the information specified in the list command options definition file and you want to enable the specified values, restart the FTP reception that is using that list command options definition file.

You cannot specify one-byte spaces at the beginning and at the end of the option string.

If the beginning of the specified option string is \, \ is interpreted as an escape character, and the rest of the string is considered as the option string.

Note that \ specified within an option string is treated as a normal character string \ and not as an escape character.

To define an option string beginning with # or \, add an escape character \ before the option string.

You cannot specify one-byte spaces or tab characters immediately after the escape character \, or define a line containing escape characters \ only. If you specify such characters, an error occurs.

The string up to the linefeed is a value. However, the one-byte spaces and tab characters at the beginning and at the end of the string are ignored.

If the non-null character (characters that are neither one-byte spaces nor tab characters) at the beginning of the specified string is #, that line is considered as a comment.

6.9 Files used for file event linkage

6.9.1 File-event-reception configuration file

(1) Format

[urecp-fileevent.trace.filenum=number-of-file-event-trace-files]
[urecp-fileevent.trace.filesize=maximum-size-of-one-file-event-trace-file]

(2) Function

Specifies the configuration information for a specific file event reception to be changed after a file event reception is set up. This file is also used to specify the information that is frequently changed.

You can create this file by editing the template file.

Location of the template file:

service-platform-installation-directory\CSC\custom-reception\fileevent\config\templates\fileeventrecp_config.properties

Location to store the file-event-reception configuration file:

service-platform-installation-directory\CSC\custom-reception\fileevent\config\

Store the file with the file name reception-ID.properties.

When the file event reception starts, the file you created is read and the settings become valid.

(3) Specifiable properties

urecp-fileevent.trace.filenum=number-of-file-event-trace-files ~ <Numeric character> ((1 to 16)) <<8>>

Specifies the number of file event trace files.

If you omit either the property name or the value, the default value is used for operation. If you specify a non-numeric value or a value outside the range, an error occurs.

urecp-fileevent.trace.filesize=maximum-size-of-one-file-event-trace-file ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the maximum size of one file event trace file in bytes.

If you omit either the property name or the value, the default value is used for operation. If you specify a non-numeric value or a value outside the range, an error occurs.

(4) Example of coding

The following is an example of coding of the file-event-reception configuration file.

urecp-fileevent.trace.filenum=8
urecp-fileevent.trace.filesize=2097152

6.9.2 File-event-reception common configuration file

(1) Format

The format for describing the file is the same as for the file-event-reception configuration file. For details about the format, see 6.9.1 File-event-reception configuration file.

(2) Function

Specifies the configuration information that is common to all file event receptions. You can create this file by editing the template file.

Location of the template file:

service-platform-installation-directory\CSC\custom-reception\fileevent\config\templates\fileeventrecp_config.properties

Location to store the file-event-reception common configuration file:

service-platform-installation-directory\CSC\custom-reception\fileevent\config\common\

Store the file with the file name fileeventrecp_config.properties.

(3) Specifiable properties

The specifiable properties are the same as those for the file-event-reception configuration file. For details about the format, see 6.9.1 File-event-reception configuration file.

(4) Example of coding

The example of coding is the same as that for the file-event-reception configuration file. For details about the format, see 6.9.1 File-event-reception configuration file.

6.10 Files used with the file adapter

6.10.1 File adapter runtime-environment property file

(1) Format

[message.level={0|10|20}]
[methodtrace.level={0|10|20|30}]
[methodtracefile.size=method-trace-output-size]
[methodtracefile.num=number-of-method-trace-files-output]
 fileaccess.path1=I/O-permitted-file-path-1
[fileaccess.path2=I/O-permitted-file-path-2]
[fileaccess.path3=I/O-permitted-file-path-3]
[fileaccess.path4=I/O-permitted-file-path-4]
[fileaccess.path5=I/O-permitted-file-path-5]
[fileaccess.maxsize=maximum-size-of-input-file]
 character.code={MS932|UTF8|UTF16_BIG|UTF16_LITTLE|JIS|KEIS+EBCDIC|KEIS+EBCDIK}
[codetable.path=transformation-table-storage-path]

(2) Function

The file adapter runtime-environment property file defines information such as the output levels of the message and trace logs for the operations of the file adapter in the execution environment.

The sample file is stored at the following location:

Service-platform-installation-directory-in-execution-environment\CSC\custom-adapter\File\config\templates\adpff_exe.properties

To create the file adapter runtime-environment property file:

Copy and store the sample file in the following directory:

Service-platform-installation-directory-in-execution-environment\CSC\custom-adapter\File\config

Rename the sample file as service-ID.properties.

Edit and save the defined information.

The file adapter runtime-environment property file is applied in the execution environment when you start the file adapter. To change the contents of the file adapter runtime-environment property file, stop the file adapter and then perform the operation. When you restart the file adapter, the changes are applied to the execution environment.

(3) Specifiable properties

message.level={0|10|20} ~ <<10>>

Specifies the output levels for the message log. The following table lists the output information and the output levels:

Information type

Output level

0

10

20

Error information

Y

Y

Y

Warning information

O

Y

Y

Information

O

O

Y

Legend:

Y: All the information is output.

O: Only important message logs are output.

methodtrace.level={0|10|20|30} ~ <<10>>

Specifies the output levels for the method trace. The following table lists the output information and the output levels:

Information type

Output level

0

10

20

30

Errors in the methods

Y

Y

Y

Y

Information for the methods invoked externally and start or stop information for the file I/O methods

N

Y

Y

Y

Start or stop information for the public methods that are referenced from other HCSC components

N

N

Y

Y

Start and stop information for the internal methods (non-public methods) that are not referenced from other components

N

N

N

Y

Legend:

Y: Information is output.

N: Information is not output.

methodtracefile.size=method-trace-output-size ~ <Numeric character> ((4096 to 2147483647)) <<4194304>>

Specifies the size of the files output for the method trace information collected by the file adapter, in bytes.

methodtracefile.num=number-of-method-trace-files-output ~ <Numeric character> ((1 to 16)) <<4>>

Specifies the number of files output for the method trace information collected by the file adapter. We recommend that you specify at least two files.

fileaccess.path ((1 to 5))=I/O-permitted-file-path

Specifies an absolute path for the directory in which file I/O is permitted. Thefile I/O can be done under the directories specified in these keys. You can also create sub-directories.

You can specify five absolute paths for the directories in which file I/O is permitted.

fileaccess.maxsize=maximum-size-of-input-file ~ <Numeric character> ((1 to 67108864)) <<4194304>>

Specifies the maximum size of the file to be read.

character.code={MS932|UTF8|UTF16_BIG|UTF16_LITTLE|JIS|KEIS+EBCDIC| KEIS+EBCDIK}

Specifies the character encoding of the binary data. When you specify this property, make sure that you specify the codetable.path property as well. Specify this property to execute the write mode functions in the fixed length, length tag, or separator file formats.

codetable.path=transformation-table-storage-path

Specifies the path for storing the conversion table (user mapping file) for the code conversion function. You can specify one of the following paths depending on whether the user mapping file is customized. Note that when you specify the path, use \\ as directory delimiters.

When the user mapping file is used with default values and is not customized

service-platform-installation-directory\CSC\lib\external\table

When the user mapping file customized by using Code Converter is used

path-for-storing-the-conversion-table-(user-mapping-file)-for-Code-Converter

When you specify this property, make sure that you specify the character.code property. Specify this property to execute the write mode functions in the fixed length, length tag, or separator file formats.

(4) Notes

Note the following when you specify the path:

Do not specify a path that contains characters expressing a relative path or a parent directory (..\ or ../), and characters expressing a current directory (.\ or ./).

Do not specify a path containing a symbolic link.

In Windows, you cannot specify a path containing a UNC format, an NTFS stream name, and a reserved device name. Also, the path characters are not case sensitive. Use \\ as directory delimiters in the path.

You can specify the path length from 1 to 198 bytes, when UTF-8 is used for conversion.

6.11 Files used with the Object Access adapter

6.11.1 Object Access adapter runtime-environment property file

(1) Format

[message.level={0|10|20}]
[trace.level={0|10|20|30}]
[methodtracefile.size=method-trace-output-size]
[methodtracefile.num=number-of-method-trace-files-output]
[datatracefile.size=data-trace-output-size]
[datatracefile.num=number-of-data-trace-files-output]
[exptracefile.size=output-size-of-exception-log]
[exptracefile.num=number-of-exception-log-files-output]

(2) Function

Defines the log and trace information that is output when you operate the Object Access adapter in the execution environment.

To create the Object Access adapter runtime-environment property file:

Define the Object Access adapter runtime-environment property file based on the following template file:

Service-platform-installation-directory\CSC\custom-adapter\OA\config\templates\adpoa.properties

Store the edited Object Access adapter runtime-environment property file with the following file name:

service-platform-installation-directory\CSC\custom-adapter\OA\config\service-ID.properties

The Object Access adapter runtime-environment property file is applied in the execution environment when the Object Access adapter starts.

To change the contents of the Object Access adapter runtime-environment property file, stop the Object Access adapter and then change the contents. After making the changes, restart the Object Access adapter so that the changes are applied in the execution environment.

(3) Specifiable properties

message.level={0|10|20} ~ <<10>>

Specifies the output levels for the message log.

The following table lists and describes the specifiable output levels and the output information corresponding to the output levels:

Information type

Output level

0

10

20

Error information

Y

Y

Y

Warning information

O

Y

Y

Information

O

O

Y

Legend:

Y: All the information is output.

O: Only important log messages are output.

trace.level={0|10|20|30} ~ <<10>>

Specifies the output levels for the method and data traces.

The following table lists and describes the specifiable output levels and the output information corresponding to the output levels:

Information type

Output level

0

10

20

30

Information for the methods invoked externally

N

Y

Y

Y

Information for invoking the methods with arguments, or communication methods, from amongst the external methods

N

Y

Y

Y

Information for the methods invoked externally, and start and stop information for the public methods that are referenced from other components

N

N

Y

Y

Start and stop information for the internal methods (non-public methods) that are not referenced from other components

N

N

N

Y

Errors in the methods

Y

Y

Y

Y

Legend:

Y: Information is output.

N: Information is not output.

methodtracefile.size=method-trace-output-size ~ <unsigned number> ((4096 to 2147483647)) <<4194304>>

Specifies the size of the files output for the method trace information collected by the Object Access adapter, in bytes.

methodtracefile.num=number-of-method-trace-files-output ~ <unsigned number> ((1 to 16)) <<4>>

Specifies the number of files output for the method trace information collected by the Object Access adapter. We recommend that you specify at least two files.

datatracefile.size=data-trace-output-size ~ <unsigned number> ((4096 to 2147483647)) <<1048576>>

Specifies the size of the files output for the data trace information collected by the Object Access adapter, in bytes.

datatracefile.num=number-of-data-trace-files-output ~ <unsigned number> ((1 to 16)) <<4>>

Specifies the number of files output for the data trace information collected by the Object Access adapter. We recommend that you specify at least two files.

exptracefile.size=output-size-of-exception-log ~ <unsigned number> ((4096 to 2147483647)) <<4194304>>

Specifies the size of the files output for the exception trace information collected by the Object Access adapter, in bytes.

exptracefile.num=number-of-exception-log-files-output ~ <unsigned number> ((1 to 16)) <<4>>

Specifies the number of files output for the exception trace information collected by the Object Access adapter.

(4) Example of coding

To omit the specified value, omit the value including the key name. You cannot code only the key name and omit the value. An example of coding when trace.level is omitted is as follows:

Correct coding method

 ...
message.level=20
methodtracefile.size=4194304
 ...

Incorrect coding method (value of trace.level is not specified)

 ...
message.level=20
trace.level=
methodtracefile.size=4194304
 ...

6.12 Files used with the Message Queue adapter

6.12.1 Message Queue adapter runtime-environment property file

(1) Format

[message.level={0|10|20}]
[trace.level={0|10|20|30}]
[methodtracefile.size=method-trace-output-size]
[methodtracefile.num=number-of-method-trace-files-output]
[datatracefile.size=data-trace-output-size]
[datatracefile.num=number-of-data-trace-files-output]
 codetable.path=transformation-table-storage-path
[exptracefile.size=output-size-of-exception-log]
[exptracefile.num=number-of-exception-log-files-output]
[transaction.local={true|false}]

(2) Function

Defines the log and trace information that is output when you operate the Message Queue adapter in the execution environment.

To create the Message Queue adapter runtime-environment property file:

Define the Message Queue adapter runtime-environment property file based on the following template file:

Service-platform-installation-directory\CSC\custom-adapter\MQ\config\templates\adpmq.properties

Store the edited Message Queue adapter runtime-environment property file with the following file name:

service-platform-installation-directory\CSC\custom-adapter\MQ\config\service-ID.properties

The Message Queue adapter runtime-environment property file is applied to the execution environment when the Message Queue adapter starts.

To change the contents of the Message Queue adapter runtime-environment property file, stop the Message Queue adapter and then change the contents. After making the changes, restart the Message Queue adapter so that the changes are applied in the execution environment.

(3) Specifiable properties

message.level={0|10|20} ~ <<10>>

Specifies the output levels for the message log. The following table lists the output levels for the message log.

Table 6‒4: Mapping of the output levels and the output information

Information type

Output level

0

10

20

Error information

Y

Y

Y

Warning information

O

Y

Y

Information

O

O

Y

Legend:

Y: All the information is output.

O: Only important log messages are output.

trace.level={0|10|20|30} ~ <<10>>

Specifies the output levels for the method and data traces.

The following table describes the output levels for the method trace:

Information type

Output level

0

10

20

30

Information for the methods invoked externally and start and stop information for the I/O methods that send and receive messages

N

Y

Y

Y

Start and stop information for the public methods that are referenced from other components

N

N

Y

Y

Start and stop information for the internal methods (non-public methods) that are not referenced from other components

N

N

N

Y

Errors in the methods

Y

Y

Y

Y

Legend:

Y: Information is output.

N: Information is not output.

The following table describes the output levels for the data trace:

Information type

Output level

0

10

20

30

Request data information for sent and received messages

N

N

N

Y

Response data information for sent and received messages

N

N

Y

Y

Detail information for Fault information

Y

Y

Y

Y

Failure in sending a message and failure in XML conversion of a received message

Y

Y

Y

Y

Legend:

Y: Information is output.

N: Information is not output.

The following table describes the merits and the demerits of specifying 20 or more data trace output levels. Specify the output level after considering the merits and the demerits.

Table 6‒5: Merits and demerits of the data trace output levels

Merits/ demerits

Output level

10

20 or more

Merits

The data trace is output only when an error occurs. Therefore, when compared to 20 or more output levels, the processing performance improves greatly.

The disk size for the output of the data trace is equal to the number of times a request error occurs. Therefore, only a small disk size is sufficient.

If the receiving of messages or a message sending and receiving request fails, the user data might be lost.

In such cases, the user data can be restored from the data trace.

Demerits

If the receiving of messages or a message sending and receiving request fails, the user data might be lost.

In such cases, the lost user data cannot be recovered.

The user data is output to the data trace. Therefore, when compared to the output level 10, the processing performance greatly deteriorates.

The disk size required to output the data trace depends on the amount of messages that are sent and received.

methodtracefile.size=method-trace-output-size ~ <unsigned number> ((4096 to 2147483647)) <<4194304>>

Specifies the size of the files output for the method trace information collected by the Message Queue adapter, in bytes.

methodtracefile.num=number-of-method-trace-files-output ~ <unsigned number> ((1 to 16)) <<4>>

Specifies the number of files output for the method trace information collected by the Message Queue adapter.

datatracefile.size=data-trace-output-size ~ <unsigned number> ((4096 to 2147483647)) <<1048576>>

Specifies the size of the files output for the data trace information collected by the Message Queue adapter, in bytes.

datatracefile.num=number-of-data-trace-files-output ~ <unsigned number> ((1 to 16)) <<4>>

Specifies the number of files output for the data trace information collected by the Message Queue adapter.

codetable.path=conversion-table-storage-path ~ <path for storing the conversion table (user mapping file) for the code conversion function>

Specifies the path for storing the conversion table (user mapping file) for the code conversion function. In Windows, use \\ instead of \ as directory delimiters in the path.

Make sure that you specify this property when you want to specify the sending queue-specific information or receiving queue-specific information for a request message, when sending binary messages.

Specify the following paths depending on whether the user mapping file is customized:

When the user mapping file is used with default values and is not customized

Service-platform-installation-directory\CSC\lib\external\table

When the user mapping file customized by using the code conversion function is used

path-for-storing-the-conversion-table-(user-mapping-file)-for-code-conversion-function

Note the following when you specify the path:

Do not specify a path that contains characters expressing a relative path or a parent directory (..\ or ../), characters expressing a current directory (.\ or ./), and a symbolic link.

In Windows, do not specify a path containing a UNC format, an NTFS stream name, and a reserved device name. Also, the path characters are not case sensitive.

Specify the path length so that when converted to UTF-8, the length is 1 to 198 bytes.

exptracefile.size=output-size-of-exception-log ~ <Numeric character> ((4096 to 2147483647)) <<4194304>>

Specifies the size of the files output for the exception information (stack trace) collected by the Message Queue adapter, in bytes.

exptracefile.num=number-of-exception-log-files-output ~ <Numeric character> ((1 to 16)) <<4>>

Specifies the number of files output for the exception information (stack trace) collected by the Message Queue adapter.

transaction.local={true|false} ~ <<true>>

Specifies whether the Message Queue adapter will perform a transaction conclusion process. Specify false if you want to specify XATransaction for the transaction support level for the resource adapter.

If you specify false and specify LocalTransaction for the transaction support level for the resource adapter, a transaction is concluded when the transaction of a business process is committed.

6.13 Files used with the mail adapter

6.13.1 Mail adapter account definition file

The mail adapter account definition file manages the user name and the password required for authentication when a mail adapter connects to a mail server.

The mail adapter account definition file is created with the specified file name on the path specified in the csmmailaddusr command. For details on the csmmailaddusr command (registering and updating the mail adapter user information), see csmmailaddusr (Registering and updating the mail adapter user information) in 5. Commands (Operating and Execution Environments).

To enable the mail adapter account definition file, you must specify the absolute path of the mail adapter account definition file in the mailadp.account.file.path key of the mail adapter runtime environment property file.

Note that the mail adapter account definition file cannot be edited because the file is managed with operation commands.

6.13.2 Mail adapter command definition file

(1) Format

[mailadp.command.messagelog.filepath=directory-to-output-command-message-log]
[mailadp.command.messagelog.filenum=number-of-command-message-log-files]
[mailadp.command.messagelog.filesize=maximum-size-of-one-command-message-log-file]
[mailadp.command.messagelog.level={10|20|30}]

(2) Function

This file is used to specify information such as the output destination and the output levels of the message log for the commands used with the mail adapter.

Create the mail adapter command definition file with the name adpmailcommand.properties.

(3) File storage location

The template file is stored at the following location:

Service-platform-installation-directory\CSC\config\mail\templates\adpmailcommand.properties

The mail adapter command definition file is stored at the following location:

Service-platform-installation-directory\CSC\config\mail

(4) Specifiable properties

mailadp.command.messagelog.filepath=directory-to-output-command-message-log~ <Character strings (including two-byte characters) and spaces>

Specifies an absolute path for the directory to output the command message log.

Use the characters / or \\ as directory delimiters. If the directory is not specified, or if the specified folder does not exist, the log is output to service-platform-installation-directory\csc\log\adapter\command.

mailadp.command.messagelog.filenum=number-of-command-message-log-files ~ <Numeric character> ((1 to 64)) <<2>>

Specifies the number of command message log files.

mailadp.command.messagelog.filesize=maximum-size-of-one-command-message-log-file ~ <Numeric character> ((4096 to 16777216)) <<1048576>>

Specifies the maximum size of one command message log file in bytes.

mailadp.command.messagelog.level={10|20|30} ~ <<20>>

Specifies the output levels for the command message log. The following table lists the output information and the output levels:

Output information

Description

Output level

10

20

30

Error information

Cause of an exception or an error

Y

Y

Y

Warning information

Information such as the problem that occurred

Information

Content of arguments

During command reception and completion of execution

Event notification

Stack trace information

Stack trace for error

N

Y

Y

Debug information

Debug information for error

N

N

Y

Legend:

Y: Information is output.

N: Information is not output.

(5) Example of coding

An example of coding of the mail adapter command definition file is as follows:

mailadp.command.messagelog.filepath=C:\\Program Files\\Hitachi\\Cosminexus\\csc\\log\\adapter\\command
mailadp.command.messagelog.filenum=2
mailadp.command.messagelog.filesize=1048576
mailadp.command.messagelog.level=20

(6) Notes

Two-byte characters are interpreted as invalid strings. Therefore, you must convert such characters by using the following hjdk.native2ascii.jar tool.

service-platform-installation-directory\jdk\bin\java -jar service-platform-installation-directory\jdk\lib\hcompatlib\hjdk.native2ascii.jar input-file-path output-file-path

For details about the hjdk.native2ascii.jar tool, see the JDK documentation.

Note the following when you specify the path:

Do not specify a path that contains characters expressing a relative path or a parent directory (..\ or ../) or characters expressing a current directory (.\ or ./).

Do not specify a path containing a symbolic link.

In Windows, do not specify a path containing a UNC format, an NTFS stream name, or a reserved device name. The path characters are not case sensitive.

6.13.3 Mail adapter runtime environment property file

(1) Format

 mailadp.smtp.host.name=IP-address-or-host-name-of-mail-server-to-be-connected-to
[mailadp.smtp.port=port-number-of-mail-server-to-be-connected-to]

[mailadp.user=login-user-name-of-mail-server-to-be-connected-to]
 mailadp.addr.from=address-set-in-FROM-field-of-mail
[mailadp.addr.to=address-set-in-TO-field-of-mail]
[mailadp.addr.cc=address-set-in-CC-field-of-mail]
[mailadp.addr.bcc=address-set-in-BCC-field-of-mail]
[mailadp.addr.count.max=maximum-number-of-addresses-that-can-be-set-up]
[mailadp.mail.body.size=mail-body-size]
[mailadp.attach.path.n=absolute-path-of-attachment]
[mailadp.attach.file.size=maximum-size-of-mail-attachment]
[mailadp.max.attach.count.per.mail=maximum-number-of-attachments]
[mailadp.mail.format={text/plain|text/html|text/xml}]
[mailadp.mail.body-text=text-inserted-in-mail-body]
[mailadp.mail.body-filepath=file-path-of-text-inserted-in-mail-body]
[mailadp.mail.body-filecharset={UTF-8|MS932}]
[mailadp.subject.size=mail-subject-size]
[mailadp.subject.text=text-inserted-in-mail-subject]
[mailadp.smtp.encoding=mail-encoding]
[mailadp.smtp.auth={LOGIN|PLAIN}]
[mailadp.user.header.path=absolute-path-of-mail-header-definition-file]
[mailadp.account.file.path=absolute-path-of-mail-adapter-account-definition-file]

[mailadp.methodtrace.level={1|2|3|4|5}]
[mailadp.methodtrace.filepath=directory-to-output-maintenance-log]
[mailadp.methodtrace.filenum=number-of-maintenance-log-files]
[mailadp.methodtrace.filesize=maximum-size-of-one-maintenance-log-file]

[mailadp.messagelog.level={0|10|20}]

[mailadp.smtp.timeout=timeout-value-for-sending-mail]
[mailadp.smtp.connectiontimeout=timeout-value-for-connecting-to-mail-server]

[mailadp.read-lock.retry.count=retry-count-when-shared-lock-of-common-folder-files-fails]
[mailadp.read-lock.retry.interval=retry-interval-when-shared-lock-of-common-folder-files-fails]

[mailadp.exptrace.filenum=maximum-number-of-exception-log-files-output]
[mailadp.exptrace.filesize=maximum-size-of-exception-log-files-output]

[mailadp.smtps.enable={TRUE|FALSE}]
[mailadp.smtps.starttls.enable={TRUE|FALSE}]
[mailadp.smtps.starttls.required={TRUE|FALSE}]

(2) Function

Specifies the configuration information of the mail adapter.

Create the mail adapter runtime environment property file with the name service-ID.properties.

(3) File storage location

The template file is stored at the following location:

Service-platform-installation-directory\CSC\config\mail\templates\adpmail.properties

The file service-ID.properties is stored at the following location:

Service-platform-installation-directory\CSC\config\mail

(4) Specifiable properties

(a) Associated with server information

mailadp.smtp.host.name=IP-address-or-host-name-of-mail-server-to-be-connected-to

Specifies the IP address or the host name of the mail server to be connected to. You cannot omit this property.

You can also specify the information in the request message format of the mail adapter. If the information is duplicated, the value in the request message format becomes valid.

mailadp.smtp.port=port-number-of-mail-server-to-be-connected-to~ <Numeric character> ((1 to 65535)) <<25>>

Specifies the port number of the mail server to be connected to.

You can also specify the information in the request message format of the mail adapter. If the information is duplicated, the value in the request message format becomes valid.

(b) Associated with mail settings

mailadp.user=login-user-name-of-mail-server-to-be-connected-to

Specifies the login user name of the mail server to be connected to. You can specify one-byte alphanumeric characters, one-byte symbols (0x21 to 0x7E in ASCII encoding), and one-byte spaces (0x20 in ASCII encoding). The characters are case sensitive.

The available one-byte symbols are as follows:

Exclamation mark (!)

Double quotation mark (")

Hash mark (#)

Dollar sign ($)

Percent sign (%)

Ampersand (&)

Apostrophe mark (')

Left parenthesis (()

Right parenthesis ())

Asterisk (*)

Plus sign (+)

Comma (,)

Hyphen (-)

Period (.)

Forward slash (/)

Colon (:)

Semicolon (;)

Left angle bracket (<)

Right angle bracket (>)

Equal sign (=)

Question mark (?)

At mark (@)

Left square bracket ([)

Right square bracket (])

Yen sign (\)

Caret (^)

Underscore (_)

Grave accent mark (`)

Left curly bracket ({)

Right curly bracket (})

Vertical bar (|)

Swung dash (~)

You can also specify the information in the request message format of the mail adapter. If the information is duplicated, the value in the request message format becomes valid.

Make sure that you specify this property when the SMTP authentication type is LOGIN. You need not specify this property, if the SMTP authentication type is PLAIN.

mailadp.addr.from=address-set-in-FROM-field-of-mail

Specifies a valid address that will be set in the FROM field of the mail to be sent. You cannot omit this property.

You can also specify the information in the request message format of the mail adapter. If the information is duplicated, the value in the request message format becomes valid.

mailadp.addr.to=address-set-in-TO-field-of-mail

Specifies a valid address that will be set in the TO field of the mail to be sent. To specify multiple addresses, insert commas (,) as delimiters.

You can also specify the information in the request message format of the mail adapter. If the information is duplicated, the value in the request message format becomes valid.

mailadp.addr.cc=address-set-in-CC-field-of-mail

Specifies a valid address that will be set in the CC field of the mail to be sent. To specify multiple addresses, insert commas (,) as delimiters.

You can also specify the information in the request message format of the mail adapter. If the information is duplicated, the value in the request message format becomes valid.

mailadp.addr.bcc=address-set-in-BCC-field-of-mail

Specifies a valid address that will be set in the BCC field of the mail to be sent. To specify multiple addresses, insert commas (,) as delimiters.

You can also specify the information in the request message format of the mail adapter. If the information is duplicated, the value in the request message format is becomes valid.

mailadp.addr.count.max=maximum-number-of-addresses-that-can-be-set-up ~ <Numeric character> ((1 to 768)) <<768>>

Specifies the maximum number of addresses that can be set up in the address field.

The maximum number of addresses includes the total number of addresses set in TO, CC, and BCC fields. If a same address is set multiple times, each address is counted as one.

mailadp.mail.body.size=mail-body-size ~ <Numeric character> ((1 to 2048000)) <<1024000>>

Specifies the size of the mail body in bytes.

mailadp.attach.path.n=absolute-path-of-attachment

Specifies an absolute path for the attachment. In n, specify a natural number from 1 to 100 depending on the number of attachments. An example of specification is as follows:

For one attachment

mailadp.attach.path.1=C:\\temp\\attach1.txt

For multiple attachments

mailadp.attach.path.1= C:\\temp\\attach1.txt
mailadp.attach.path.2= C:\\temp\\attach2.txt
...

Use the characters / or \\ as directory delimiters. When you specify multiple attachments, if you specify the same file twice, the same file is attached twice.

You can also specify the information in the request message format of the mail adapter. If the information is duplicated, the value in the request message format becomes valid.

mailadp.attach.file.size=maximum-size-of-mail-attachment ~ <Numeric character> ((0 to 5242880)) <<5242880>>

Specifies the maximum size of one mail attachment in bytes.

mailadp.max.attach.count.per.mail=maximum-number-of-attachments ~ <Numeric character> ((0 to 100)) <<10>>

Specifies the maximum number of files that can be attached to one email.

mailadp.mail.format={text/plain|text/html|text/xml} ~ <<text/plain>>

Specifies text/plain, text/html, or text/xml# as the mail formats.

You can also specify the information in the request message format of the mail adapter. If the information is duplicated, the value in the request message format becomes valid.

#

If text/xml is specified, the mail adapter displays the data in the plain text format.

mailadp.mail.body-text=text-inserted-in-mail-body

Specifies the text to be inserted in the mail body.

You can also specify the information in the request message format of the mail adapter. If the information is duplicated, the value in the request message format becomes valid.

mailadp.mail.body-filepath=file-path-of-text-inserted-in-mail-body

Specifies any file path. The text of the file specified here is read in the mail body. Use the characters / or \\ as directory delimiters.

You can also specify the information in the request message format of the mail adapter. If the information is duplicated, the value in the request message format becomes valid.

mailadp.mail.body-filecharset={UTF-8|MS932} ~ <<UTF-8>>

Specifies the character set of the file specified with the mailadp.mail.body-filepath key. The characters are not case sensitive.

You can also specify the information in the request message format of the mail adapter. If the information is duplicated, the value in the request message format becomes valid.

mailadp.subject.size=mail-subject-size ~ <Numeric character> ((0 to 80)) <<80>>

Specifies the size of the mail subject. If the number of characters in the subject exceeds the specified size, the exceeded characters are trimmed.

mailadp.subject.text=text-inserted-in-mail-subject

Specifies the text to be inserted in the mail subject. If no value is specified, the mail is sent without a subject.

You can also specify the information in the request message format of the mail adapter. If the information is duplicated, the value in the request message format becomes valid.

mailadp.smtp.encoding=mail-encoding ~ <<ISO-2022-JP>>

Specifies the mail encoding. The specified encoding is used while the mail is being sent.

You can also specify the information in the request message format of the mail adapter. If the information is duplicated, the value in the request message format becomes valid.

mailadp.smtp.auth={LOGIN|PLAIN} ~ <<PLAIN>>

Specifies the authentication type for the mail server. The characters are not case sensitive.

You can also specify the information in the request message format of the mail adapter. If the information is duplicated, the value in the request message format becomes valid.

mailadp.user.header.path=absolute-path-of-mail-header-definition-file

Specifies an absolute path for the mail header definition file. Use the characters / or \\ as directory delimiters.

You can also specify the information in the request message format of the mail adapter. If the information is duplicated, the value in the request message format becomes valid.

mailadp.account.file.path=absolute-path-of-mail-adapter-account-definition-file

Specifies an absolute path for the mail adapter account definition file. Use the characters / or \\ as directory delimiters.

(c) Associated with maintenance log

mailadp.methodtrace.level={1|2|3|4|5} ~ <<3>>

Specifies the output levels for the maintenance log. The following table lists the output information and the output levels:

Output information

Output level#

1

2

3

4

5

Error information (cause of exception)

Y

Y

Y

Y

Y

Entrance and exit information for the requester service method (class name, method name, argument, return value)

N

Y

Y

Y

Y

Entrance and exit information for the external (such as BP) interfaces (class name, method name, argument, return value)

N

N

Y

Y

Y

Entrance and exit information for the interfaces within the components (class name, method name, argument, return value)

N

N

N

Y

Y

Mail sending information (mail server connection, mail details, message trace)

N

N

N

Y

Y

Debug information (information such as the branching of processing)

N

N

N

N

Y

Legend:

Y: Information is output.

N: Information is not output.

#

If you specify 4 or 5 as the maintenance log output level, the mail address used for sending the mail is output.

mailadp.methodtrace.filepath=directory-to-output-maintenance-log

Specifies an absolute path for the directory to output the maintenance log. Use the characters / or \\ as directory delimiters.

If the specified folder does not exist, the log is output to work-directory-of-J2EE-server\ejb\J2EE-server-name\logs\CSCADP\MAILADP\maintenance\service-ID.

You can change work-directory-of-J2EE-server\ejb\J2EE-server-name\logs with the ejb.server.log.directory in the usrconf.cfg key (option definition file for J2EE servers). For details on usrconf.cfg, see 2.2.2 usrconf.cfg (Option definition file for J2EE servers) in the uCosminexus Application Server Definition Reference Guide.

mailadp.methodtrace.filenum=number-of-maintenance-log-files ~ <Numeric character> ((1 to 16)) <<8>>

Specifies the number of maintenance log files.

mailadp.methodtrace.filesize=maximum-size-of-one-maintenance-log-file ~ <Numeric character> ((4096 to 147483647)) <<2097152>>

Specifies the maximum size of one maintenance log file in bytes.

(d) Associated with message log

mailadp.messagelog.level={0|10|20} ~ <<10>>

Specifies the output levels for the message log. The following table lists the output information and the output levels:

Output information

Description

Output level

0

10

20

Error information

Cause of an exception or an error

Y

Y

Y

Warning information

Information such as the problem that occurred

N

Y

Y

Information

Content of the messages and arguments

Change in the HCSC-Messaging status (when starting or stopping)

During command reception and completion of execution

Event notification

N

N

Y

Legend:

Y: Information is output.

N: Information is not output.

(e) Associated with re-connection

mailadp.smtp.timeout=timeout-value-for-sending-mail ~ <Numeric character> ((0 to 3600)) <<180>>

Specifies the timeout value for sending a mail, in seconds. A timeout does not occur if you specify 0.

The value of this property will be set for the mail.smtp.timeout property, which is a JavaMail session property used for sending emails to the SMTP server.

mailadp.smtp.connectiontimeout=timeout-value-for-connecting-to-mail-server ~ <Numeric character> ((0 to 86400)) <<180>>

Specifies the timeout value for connecting to a mail server, in seconds. A timeout does not occur if you specify 0.

The value of this property will be set for the mail.smtp.connectiontimeout property, which is a JavaMail session property used for sending emails to the SMTP server.

(f) Associated with lock acquisition timeout

mailadp.read-lock.retry.count=retry-count-when-shared-lock-of-common-folder-files-fails ~ <Numeric character> ((0 to 1024)) <<0>>

Specifies the retry count when a shared lock of the files in the common folder fails.

mailadp.read-lock.retry.interval=retry-interval-when-shared-lock-of-common-folder-files-fails ~ <Numeric character> ((1 to 1024)) <<1>>

Specifies the retry interval when a shared lock of the files in the common folder fails, in seconds.

(g) Associated with exception log

mailadp.exptrace.filenum=maximum-number-of-exception-log-files-output ~ <Numeric character> ((1 to 16)) <<8>>

Specifies the maximum number of exception log files that will be output.

mailadp.exptrace.filesize=maximum-size-of-exception-log-files-output ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the maximum size (in bytes) of exception log files that will be output.

(h) Associated with TLS

mailadp.smtps.enable={TRUE|FALSE} ~ <<FALSE>>

Specifies whether to use TLS to connect to the SMTP server. The characters are not case sensitive.

TRUE

TLS is used to connect to the SMTP server.

FALSE

TLS is not used. SMTP is used to connect to the SMTP server.

mailadp.smtps.starttls.enable={TRUE|FALSE} ~ <<TRUE>>

Specifies whether to use STARTTLS when TLS is used for connection with the SMTP server. This property is valid only when you specify TRUE for the mailadp.smtps.enable property. The characters are not case sensitive.

TRUE

STARTTLS is used. Communication starts with normal SMTP. Then, when it is confirmed that both parties support TLS by using STARTTLS, the connection is re-established via TLS.

FALSE

STARTTLS is not used. All SMTP communications are encrypted by TLS.

mailadp.smtps.starttls.required={TRUE|FALSE} ~ <<FALSE>>

When the mail adapter uses STARTTLS, this property specifies whether the mail adapter will generate an error when one of the following conditions is met on the SMTP server to connect to.

The SMTP server to connect to does not support STARTTLS.

An error occurs during processing of STARTTLS on the SMTP server to connect to.

This property is valid only when you specify TRUE for both the mailadp.smtps.enable and mailadp.smtps.starttls.enable properties. The characters are not case sensitive.

TRUE

The mail adapter will generate an error.

FALSE

SMTP is used to connect to the SMTP server.

(5) Example of coding

An example of coding of the mail adapter runtime environment property file is as follows:

mailadp.smtp.host.name=domainName.com
mailadp.smtp.port=25
mailadp.user=john
mailadp.addr.from=sampleuser@XXXXXX.com

(6) Notes

An error occurs if any one of the following properties is not specified:

mailadp.addr.to

mailadp.addr.cc

mailadp.addr.bcc

Two-byte characters are interpreted as invalid strings. Therefore, you must convert such characters by using the following hjdk.native2ascii.jar tool.

service-platform-installation-directory\jdk\bin\java -jar service-platform-installation-directory\jdk\lib\hcompatlib\hjdk.native2ascii.jar input-file-path output-file-path

For details about the hjdk.native2ascii.jar tool, see the JDK documentation.

Note the following when you specify the path:

Do not specify a path that contains characters expressing a relative path or a parent directory (..\ or ../) or characters expressing a current directory (.\ or ./).

Do not specify a path containing a symbolic link.

In Windows, do not specify a path containing a UNC format, an NTFS stream name, or a reserved device name. The path characters are not case sensitive.

6.13.4 Mail header definition file

(1) Format

[key-name=value]

(2) Function

This file is used to specify any user-defined mail header options, such as the importance of the mail or the presence or absence of reply requests.

You can store the mail header definition file on any path with any file name. However, the absolute path of the mail header definition file must be specified in the mailadp.user.header.path key of the mail adapter runtime environment property file.

(3) File storage location

The template file is stored at the following location:

Service-platform-installation-directory\CSC\config\mail\templates\mail-header.properties

(4) Example of coding

An example of coding of the mail header definition file is as follows:

Importance=High
Sensitivity=Private

(5) Notes

The operations might not function properly if the key name and the values are duplicated.

The operations might not function properly if the same header is defined multiple times.

You cannot specify an empty value for a key name. An error occurs if such a value is specified.

If nothing is defined in the mail header definition file, the mail is sent without the user-defined mail header.

The operations of the mail header definition file depend on the mail server and the clients who will receive the mails.

We recommend that a different mail header be defined in the mail header definition file than the mail header defined in the mail adapter runtime environment property file or the request message. If you specify the same mail header in the mail adapter runtime environment property file and mail header definition file, the operation will depend on the mail server.

Two-byte characters are interpreted as invalid strings. Therefore, you must convert such characters by using the following hjdk.native2ascii.jar tool.

service-platform-installation-directory\jdk\bin\java -jar service-platform-installation-directory\jdk\lib\hcompatlib\hjdk.native2ascii.jar input-file-path output-file-path

For details about the hjdk.native2ascii.jar tool, see the JDK documentation.

6.14 Files used with the HTTP adapter

6.14.1 HTTP-adapter runtime-environment property file

(1) Format

[adphttp.request.method={GET|HEAD|POST|OPTIONS|PUT|DELETE}]
[adphttp.request.uri-scheme-authority=URI-scheme-and-authority]
[adphttp.request.uri-path=URI-path]
[adphttp.request.uri-query.serial-number=URI-query]

[adphttp.request.header.authorization.type={none|raw}]
[adphttp.request.header.authorization=authentication-information]

[adphttp.request.header.content-type.charset=character-encoding-of-Content-Type-header]
[adphttp.request.header.content-type=media-type-of-Content-Type-header]

[adphttp.request.header.userdef.serial-number=request-header]

[adphttp.request.part.message.binding={none|raw|form-data}]

[adphttp.request.part.file.serial-number.input-folder-name=common-folder-definition-name]
[adphttp.request.part.file.serial-number.local-file-name=name-of-file-to-be-read]

[adphttp.request.output-folder-name=common-folder-definition-name]
[adphttp.request.output-sub-folder=name-of-file-output-destination-subfolder]

[adphttp.config.trace.path=directory-to-output-log]
[adphttp.config.messagelog.level={0|10|20}]
[adphttp.config.methodtrace.level={1|2|3|4|5}]
[adphttp.config.methodtrace.filenum=number-of-method-trace-files]
[adphttp.config.methodtrace.filesize=size-of-method-trace-files]
[adphttp.config.exptrace.filenum=number-of-exception-log-files]
[adphttp.config.exptrace.filesize=size-of-exception-log-files]

[adphttp.config.password-auth-inf-filepath=path-of-password-authentication-information-definition-file]

[adphttp.config.publickey-auth-inf-filepath=path-of-public-key-authentication-information-definition-file]

(2) Function

Specifies the configuration information for each HTTP adapter.

For details on the priority order when the same elements are specified in the request message (header), the HTTP-adapter runtime-environment property file, and HTTP-adapter runtime-environment common property file, see 2.14.12 Mapping of parameters in the request message (header) and the HTTP-adapter runtime-environment (common) property file in the manual Service Platform Overview.

To create the HTTP-adapter runtime-environment property file:

Define the HTTP-adapter runtime-environment property file based on the following template file:

Service-platform-installation-directory\CSC\custom-adapter\HTTP\config\templates\serviceid.properties

Rename the edited HTTP-adapter runtime-environment property file as service-ID.properties, and store the file in the following directory:

Service-platform-installation-directory\CSC\custom-adapter\HTTP\config

(3) Specifiable properties

(a) Request line

adphttp.request.method={GET|HEAD|POST|OPTIONS|PUT|DELETE}

Specifies the name of the HTTP method for the request.

If you specify a method name other than GET, HEAD, POST, OPTIONS, PUT, and DELETE, the operations are not guaranteed.

adphttp.request.uri-scheme-authority=URI-scheme-and-authority

Specifies the URI scheme and the authority in the format scheme://authority.

adphttp.request.uri-path=URI-path

Specifies a portion of the URI path. If the URI path is the root path ("/"), you can omit the path.

adphttp.request.uri-query.serial-number=URI-query

Specifies URI queries one by one, in the format key=value.

You can specify a number from 1 to 1024 in serial-number.

(b) WWW authentication

adphttp.request.header.authorization.type={none|raw} ~ <<none>>

Specifies the WWW authentication type. The characters are not case sensitive.

none

The authentication information is not sent.

raw

The authentication information is set in Authorization of the HTTP request header and sent.

When you specify this property, make sure that you specify the authentication information in the adphttp.request.header.authorization property.

adphttp.request.header.authorization=authentication-information

Specifies the WWW authentication information as follows:

If none is specified in the property adphttp.request.header.authorization.type

Remove the comments (specify an empty string).

If raw is specified in the property adphttp.request.header.authorization.type

Specify any authentication information.

(c) Content-Type header of HTTP headers

adphttp.request.header.content-type.charset=character-encoding-of-Content-Type-header

Specifies the character encoding of the Content-Type header for the HTTP request header.

If form-data is specified in the binding method of the request message (body), an HTTP request is sent after transforming the form data to the character encoding specified in this property. You can specify only the character encoding that can be used in JavaVM.

If raw is specified in the binding method of the request message (body), specify a character encoding suitable to the character encoding in the request message (body).

If the adphttp.request.header.content-type property is not specified, this property is ignored. An error occurs if you specify only the key and not the value.

adphttp.request.header.content-type=media-type-of-Content-Type-header

Specifies the media type of the Content-Type header for the HTTP request header in the format */*. An error occurs if you specify only the key and not the value.

(d) Optional specifications of the HTTP header

adphttp.request.header.userdef.serial-number=request-header

Specifies any request-header (one header) in the format field-name:field-value. You can specify a number from 1 to 1024 in serial-number.

We recommend extended header settings for this property. The operations might not function normally if you define a standard header. Also, a special HTTP header is ignored even if specified. For details, see the description about the HTTP request header in 2.14.3 Relation between HTTP requests and request messages in the manual Service Platform Overview.

The specified value is divided into field-name and field-value considering the first colon (:) as a delimiter and then set in the HTTP header. Even if field-name and field-value contain extra null characters, the characters are not removed.

Do not specify linefeed characters in field-name and field-value. An error occurs if linefeed characters are included.

(e) Request message (body)

adphttp.request.part.message.binding={none|raw|form-data} ~ <<none>>

Specifies the binding method of the request message (body) to the HTTP request body. The characters are not case sensitive.

none

The HTTP request body will not be sent.

raw

The pass-through mode is used, and the data specified in the request message (body) is set in the HTTP request body as is.

form-data

The normal mode is used, and the form data in the request message (body) is set in the HTTP request body in the format Content-Type: application/x-www-form-urlencoded.

When using an authentication flow supported by OAuth 2.0, specify form-data to send authentication information as the form data.

(f) Input file

adphttp.request.part.file.serial-number.input-folder-name=common-folder-definition-name

Specifies the definition name of the common folder where the file to be read is stored. You can specify only 1 in serial-number.

If the specified common folder definition name is invalid, an error occurs. An error also occurs if you specify only the key and not the value. You can omit this property if you do not use the common folder.

When you specify this property, make sure that you specify the name of the file to be read in the adphttp.request.part.file.serial-number.local-file-name property.

adphttp.request.part.file.serial-number.local-file-name=name-of-file-to-be-read

Specifies the name of the file to be read. You can specify only 1 in serial-number.

If you specify a hierarchical structure or a higher path, an error occurs. If you use a subfolder, specify the relative path from the common folder root to the file name. An error also occurs if you specify only the key and not the value.

When you specify this property, make sure that you specify the common folder definition name in the adphttp.request.part.file.serial-number.input-folder-name property.

Specify a file other than a symbolic link.

(g) Output files

adphttp.request.output-folder-name=common-folder-definition-name

Specifies the definition name of the common folder where the file to be written to is stored.

If the specified common folder definition name is invalid, an error occurs. An error also occurs if you specify only the key and not the value.

You can omit this property if you do not use the common folder.

adphttp.request.output-sub-folder=name-of-file-output-destination-subfolder

Specifies the subfolder to which download files are output during HTTP response.

If you specify the common folder for the adphttp.request.output-folder-name property and use a subfolder, specify the subfolder to which write-target files are to be output.

Specify the relative path from the common folder root to the subfolder. You can omit the file separator (/) at the beginning or end of a relative path.

If the specified subfolder does not exist, a folder is created when the command is executed.

If you specify a path higher than the common folder root, an error occurs.

If a common folder definition name is not defined for the adphttp.request.output-folder-name property, the value specified in this property is ignored.

(h) Logging

adphttp.config.trace.path=directory-to-output-log~ <<log-output-directory-specified-in-the-key-ejb.server.log.directory-of-the-option-definition-file-for-J2EE-servers- (usrconf.properties)\CSCADP\ADPHTTP\maintenance\service-ID>>

Specifies an absolute path for the directory to output the maintenance and exception logs. If the specified folder does not exist, a folder is created when the HTTP adapter starts.

adphttp.config.messagelog.level={0|10|20} ~ <<10>>

Specifies the output levels for the message log. The following table lists the output information and the output levels:

Output information

Description

Output level

0

10

20

Error information

Cause of an exception or an error

Y

Y

Y

Warning information

Information such as the problem that occurred

O

Y

Y

Information

Content of the messages and arguments

Changes in the HTTP adapter status (starting and stopping)

Event notification

O

O

Y

Legend:

Y: Information is output.

O: Only important log messages are output.

adphttp.config.methodtrace.level={1|2|3|4|5} ~ <<3>>

Specifies the output levels for the maintenance log. The following table lists the output information and the output levels:

Output information

Output level

1

2

3

4

5

Error information (cause of exception)

Y

Y

Y

Y

Y

Entrance and exit information for the interfaces of the main external modules (class name, method name, argument, return value)

N

Y

Y

Y

Y

Entrance and exit information for the interfaces of the external modules (class name, method name, argument, return value)

N

N

Y

Y

Y

Entrance and exit information for the interfaces within the main components (class name, method name, argument, return value)

N

N

N

Y

Y

Entrance and exit information for the interfaces within the components (class name, method name, argument, return value), and debug information (information such as the branching of processing)

N

N

N

N

Y

Legend:

Y: Information is output.

N: Information is not output.

adphttp.config.methodtrace.filenum=number-of-method-trace-files ~ <Numeric character> ((1 to 16)) <<8>>

Specifies the number of maintenance log files.

adphttp.config.methodtrace.filesize=size-of-method-trace-files ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the maximum size of one maintenance log file in bytes.

adphttp.config.exptrace.filenum=number-of-exception-log-files ~ <Numeric character> ((1 to 16)) <<8>>

Specifies the number of exception log files.

adphttp.config.exptrace.filesize=size-of-exception-log-files ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the maximum size of one exception log file in bytes.

(i) Password authentication information definition file

adphttp.config.password-auth-inf-filepath=path-of-password-authentication-information-definition-file

Specifies the name of the password authentication information definition file as an absolute path if the user information for password authentication has been registered by using the csauseradd command. Specify the path of the password authentication information definition file that was specified for the -f option when the csauseradd command was executed.

The file to be specified requires access permissions of the administrator of the HCSC server.

If the specified file does not exist, an error occurs when the service adapter starts.

(j) Public key authentication information definition file

adphttp.config.publickey-auth-inf-filepath=path-of-public-key-authentication-information-definition-file

Specifies the name of the public key authentication information definition file as an absolute path if private key information for public key authentication has been registered by using the csakeyadd command. Specify the path of the public key authentication information definition file that was specified for the -f option when the csakeyadd command was executed.

The file to be specified requires access permissions of the administrator of the HCSC server.

If the specified file does not exist, an error occurs when the service adapter starts.

(4) Example of coding

An example of coding is as follows:

adphttp.request.method=GET
adphttp.request.uri-scheme-authority=http://localhost:80
adphttp.request.uri-path=trans/EN2JP/something
adphttp.request.uri-query.1=name=id
adphttp.request.header.authorization.type=none
adphttp.request.header.authorization=
adphttp.request.header.content-type.charset=utf-8
adphttp.request.header.content-type=application/msword
adphttp.request.header.userdef.1=cache-control:no-cache
adphttp.request.part.message.binding=none
adphttp.config.messagelog.level=10
adphttp.config.methodtrace.level=3
adphttp.config.methodtrace.filenum=8
adphttp.config.methodtrace.filesize=2097152
adphttp.config.exptrace.filenum=8
adphttp.config.exptrace.filesize=2097152

(5) Notes

Set the character encoding of the property file to UTF-8 and then store the file. If you use a character encoding other than UTF-8, the set value might not be interpreted correctly.

Note the following when you specify the path:

Do not specify a path that contains characters expressing a relative path or a parent directory (..\ or ../) or characters expressing a current directory (.\ or ./).

Do not specify a path containing a symbolic link.

In Windows, do not specify a path containing a UNC format, an NTFS stream name, or a reserved device name. The path characters are not case sensitive.

6.14.2 HTTP-adapter runtime-environment common property file

(1) Format

The file coding format is the same as that of the HTTP-adapter runtime-environment property file. For details about the file coding format, see 6.14.1 HTTP-adapter runtime-environment property file.

(2) Function

Specifies the configuration information that is common to all the HTTP adapters.

For details on the priority order when the same elements are specified in the request message (header), the HTTP-adapter runtime-environment property file, and HTTP-adapter runtime-environment common property file, see 2.14.12 Mapping of parameters in the request message (header) and the HTTP-adapter runtime-environment (common) property file in the manual Service Platform Overview.

To create the HTTP-adapter runtime-environment common property file:

Define the HTTP-adapter runtime-environment common property file based on the following template file:

Service-platform-installation-directory\CSC\custom-adapter\HTTP\config\templates\adphttpcom.properties

Store the edited HTTP-adapter runtime-environment common property file in the following directory:

Service-platform-installation-directory\CSC\custom-adapter\HTTP\config\common

Do not change the file name.

(3) Specifiable properties

The properties that you can specify in this file are the same as those in the HTTP-adapter runtime-environment property file. For details on the specifiable properties, see 6.14.1 HTTP-adapter runtime-environment property file.

(4) Notes

Set the character encoding of the property file to UTF-8 and then store the file. If you use a character encoding other than UTF-8, the set value might not be interpreted correctly.

6.15 Files used with command adapters

6.15.1 Command-execution permission definition file

(1) Format

Specify regular expressions that accept strings to be checked, using a linefeed as a delimiter.

The available character code is UTF-8 only.

Empty string lines are ignored.

The coding format of regular expressions complies with the java.util.regex.Pattern class specification.

(2) Function

Specifies, in regular expressions, the combination of an external command and command line arguments that can be executed by a command adapter.

When a request is sent to a command adapter, the command adapter checks the strings specified in the request message based on the regular expressions specified in the command-execution permission definition file. Each string consists of an external command and command line arguments concatenated with halfwidth spaces.

To create a command-execution permission definition file:

Confirm the file path to the commands that the command adapter is permitted to execute, and the specification of command line arguments that can be specified.

Create regular expressions that accept the strings to be checked, and then code the regular expressions in the file.

Store the created command-execution permission definition file in any location and with any file name.

Important note

To enable the command-execution permission definition file, specify the path of this file for the adpcmd.config.command.allow-file-path property of the command-adapter runtime-environment properties file.

(3) Example of coding

The following is an example of coding of the command-execution permission definition file.

/bin/ls(?: -l)?
/usr/share/product/bin/[^ /]+.sh[^&|<>]*

(4) Note

Appropriately specify the regular expressions that accept strings corresponding to external commands and command line arguments. Especially, if the following prerequisites must be satisfied when the system is designed, you can prevent security risks by suppressing the startup of processes not intended by system administrators:

Adapters can be directly invoked without using a business process (when the standard reception is active).

Values from an end user's requester are directly mapped to a request message of a command adapter in a business process.

Reference note

The following are examples of inappropriate regular expressions.

Expressions that accept any character string (for example, .+ and .*).

Startup of unintended processes cannot be prevented.

Special characters that have meaning of execution control in shells or command prompts (for example, &, |, >, and <)

Startup of an unintended process specified in a command line argument cannot be prevented.

6.15.2 Process environment-variable definition file

(1) Format

This file has the Java property file format.

Specify one environment variable in one line.

environment-variable-name-1=variable-1
environment-variable-name-2=variable-2
 ...
environment-variable-name-n=variable-n

Important note

When using non-ASCII characters, take one of the following actions:

Save the file in UTF-8.

Specify the information by using Unicode escapes stipulated in the Java java.util.Properties class.

(2) Function

The process environment-variable definition file specifies the environment variables that are valid only in external command processes.

To create this file:

Confirm the environment variable specifications (environment variable names and variable values) used in external command processes.

Specify the environment variable names and variable values in the file according to the Java property file format.

Store the created process environment-variable definition file in any location and with any name.

Important note

To enable the process environment-variable definition file, specify the path of this file for the adpcmd.config.process-environment.variable-file-path property of the command-adapter runtime-environment properties file.

(3) Example of coding

The following is an example of coding of the process environment-variable definition file.

SIZE_OF_LIST=20000
OPTION_STATUS=1

(4) Notes

Whether the environment variable names are case sensitive depends on the specification of the operating system.

Because this file has the Java property format, there might be a case in which environment variable names and variable values must be escaped.

You cannot specify a value that references other variable values or its own original value.

If you specify the same key multiple times, it is not certain which one becomes valid.

6.15.3 Command-adapter runtime-environment properties file

(1) Format

adpcmd.config.command.allow-file-path=path-of-command-execution-permission-definition-file

[adpcmd.config.process-environment.variable-file-path=path-of-process-environment-variable-definition-file]
[adpcmd.config.process-environment.working-dir-path=work-directory-path-for-external-command-processes]

[adpcmd.config.timeout.value=timeout-value-of-external-command-process]
[adpcmd.config.timeout.enable-kill-process={true|false}]

[adpcmd.config.stdout.size=maximum-size-of-standard-output-acquired-by-response-message]

[adpcmd.log.messagelog.level={0|10|20}]
[adpcmd.log.methodtrace.level={1|2|3|4|5}]
[adpcmd.log.methodtrace.filenum=number-of-maintenance-log-files]
[adpcmd.log.methodtrace.filesize=size-of-maintenance-log-file]
[adpcmd.log.exptrace.filenum=number-of-exception-log-files]
[adpcmd.log.exptrace.filesize=size-of-exception-log-file]
[adpcmd.log.stderr.enable={true|false}]
[adpcmd.log.stderr.charset={UTF-8|MS932|EUC-JP}]
[adpcmd.log.stderr.filenum=number-of-standard-error-output-log-files]
[adpcmd.log.stderr.filesize=size-of-standard-error-output-log-file]

(2) Function

Specifies the configuration information for each command adapter.

To create a command-adapter runtime-environment properties file:

Define the command-adapter runtime-environment properties file based on the following template file:

service-platform-installation-directory\CSC\custom-adapter\Command\config\templates\serviceid.properties

Rename the edited command-adapter runtime-environment properties file as service-ID.properties, and then store the file in the following directory:

service-platform-installation-directory\CSC\custom-adapter\Command\config

(3) Specifiable properties

(a) Path of the command-execution permission definition file

adpcmd.config.command.allow-file-path=path-of-command-execution-permission-definition-file

Specifies the path of the command-execution permission definition file as an absolute or relative path. When you specify a relative path, the base directory is as follows:

service-platform-installation-directory\CSC\custom-adapter\Command\config

Reference note

Assume that C:\Example is specified for service-platform-installation-directory and a command-execution permission definition file named acc.txt is created in C:\Example\CSC\custom-adapter\Command\config. In this case, the operation is the same no matter which of the following two examples you use:

Example of an absolute path specification

adpcmd.config.command.allow-file-path=C:\\Example\\CSC\\custom-adapter\\Command\\config\\acc.txt

Example of a relative path specification

adpcmd.config.command.allow-file-path=acc.txt

(b) Environment settings for external command processes

adpcmd.config.process-environment.variable-file-path=path-of-process-environment-variable-definition-file

Specifies the path of the process environment-variable definition file as an absolute or relative path. When you specify a relative path, the base directory is as follows:

service-platform-installation-directory\CSC\custom-adapter\Command\config

adpcmd.config.process-environment.working-dir-path=work-directory-path-for-external-command-processes ~ <<service-platform-installation-directory\CSC\spool\Command>>

Specifies the absolute path to the work directory for external command processes.

(c) Timeout

adpcmd.config.timeout.value=timeout-value-of-external-command-process ~ <Numeric character> ((0 to 86400)) <<60>>

Specifies the timeout value (in seconds) for external command processes.

If you specify 0, a timeout does not occur for processes, and the system waits until the external command processes end.

Important note

A service platform does not provide a method for stopping external command processes from the operating environment. Therefore, you must specify an external command that definitely terminates processes or create an external command that allows you to check the status.

adpcmd.config.timeout.enable-kill-process=whether-to-kill-external-command-process-when-timeout-occurs ~ {true|false} <<true>>

Specifies whether to attempt to forcibly terminate the external command process when a timeout occurs.

true

Forced termination will be attempted.

false

Forced termination will not be performed.

Even if true is specified, the forced termination might fail depending on the status of the external command process. See the message log to check whether the forced termination is successful.

If false is specified, the running external command process continues processing irrespective of the status of the command adapter and HCSC server.

Important note

A service platform does not provide a method for stopping external command processes from the operating environment. Therefore, you must specify an external command that definitely terminates processes or create an external command that allows you to check the status.

(d) Maximum size of standard output that can be acquired by a response message

adpcmd.config.stdout.size=maximum-size-of-standard-output-acquired-by-response-message ~ <Numeric character> ((0 to 104857600)) <<2097152>>

Specifies the maximum size of the standard output (in bytes) that can be acquired by using a response message.

If you specify 0, the standard output cannot be acquired by using a response message.

If the size of data output to the standard output by an external command process exceeds the value specified for this property, a warning message is output to the message log. However, if you specify 0, no warning message is output.

(e) Logging

adpcmd.log.messagelog.level={0|10|20} ~ <<10>>

Specifies the output level for the message log.

The following table lists the output information and the output levels:

Output information

Description

Output level

0

10

20

Error information

Cause of an exception or an error

A

A

A

Warning information

Status that must be checked during system operation

B

A

A

Information

Changes in the command adapter status (starting or stopping)

Event notification (starting or ending of an external command)

B

B

A

Legend:

A: All the information is output.

B: Only the important log messages are output.

adpcmd.log.methodtrace.level={1|2|3|4|5} ~ <<3>>

Specifies the output level for the maintenance log.

The following table lists the output information and the output levels:

Output information

Output level

1

2

3

4

5

Error information (cause of an exception)

Y

Y

Y

Y

Y

Interface information for the main external modules (information related to the custom adapter framework)

N

Y

Y

Y

Y

Interface information for the external modules (information related to external command processes)

N

N

Y

Y

Y

Information for the interfaces within the main components

N

N

N

Y

Y

Debug information

N

N

N

N

Y

Legend:

Y: Information is output.

N: Information is not output.

adpcmd.log.methodtrace.filenum=number-of-maintenance-log-files ~ <Numeric character> ((1 to 16)) <<8>>

Specifies the number of maintenance log files.

adpcmd.log.methodtrace.filesize=size-of-maintenance-log-file ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the maximum size of one maintenance log file in bytes.

adpcmd.log.exptrace.filenum=number-of-exception-log-files ~ <Numeric character> ((1 to 16)) <<8>>

Specifies the number of exception log files.

adpcmd.log.exptrace.filesize=size-of-exception-log-file ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the maximum size of one exception log file in bytes.

adpcmd.log.stderr.enable={true|false} ~ <<true>>

Specifies whether the contents of the standard error output for external command processes will be written to a log file.

true

The standard error output log is enabled.

false

The standard error output log is disabled.

adpcmd.log.stderr.charset={UTF-8|MS932|EUC-JP} ~ <<UTF-8>>

Specifies the character code used when an external command process outputs data to the standard error output.

If the external command process outputs ASCII characters only, you can omit this property to use the default setting.

adpcmd.log.stderr.filenum=number-of-standard-error-output-log-files ~ <Numeric character> ((1 to 16)) <<8>>

Specifies the number of standard error output log files.

adpcmd.log.stderr.filesize=size-of-standard-error-output-log-file ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the maximum size of one standard error output log file in bytes.

6.15.4 Command-adapter runtime-environment common properties file

(1) Format

The format for describing the file is the same as for the command-adapter runtime-environment properties file. For details about the format, see 6.15.3 Command-adapter runtime-environment properties file.

(2) Function

Specifies the configuration information that is common to all command adapters.

To create a command-adapter runtime-environment common properties file:

Define the command-adapter runtime-environment common properties file based on the following template file:

service-platform-installation-directory\CSC\custom-adapter\Command\config\templates\serviceid.properties

Rename the edited command-adapter runtime-environment common properties file as adpcmdcom.properties, and then store the file in the following directory:

service-platform-installation-directory\CSC\custom-adapter\Command\config\common

(3) Specifiable properties

The specifiable properties are the same as those for the command-adapter runtime-environment properties file. For details, see 6.15.3 Command-adapter runtime-environment properties file.

Important note

If you specify a relative path for any of the following properties, the base directory is the directory in which the command-adapter runtime-environment common properties file is stored (service-platform-installation-directory\CSC\custom-adapter\Command\config\common):

adpcmd.config.command.allow-file-path

adpcmd.config.process-environment.variable-file-path

Assume that C:\Example is specified for service-platform-installation-directory and a command-execution permission definition file named acc.txt is created in C:\Example\CSC\custom-adapter\Command\config. In this case, the operation is the same no matter which of the following two examples you use:

Example of an absolute path specification

adpcmd.config.command.allow-file-path=C:\\Example\\CSC\\custom-adapter\\Command\\config\\acc.txt

Example of a relative path specification

adpcmd.config.command.allow-file-path=acc.txt

6.16 Files used with SFTP adapters

6.16.1 SFTP-adapter runtime-environment properties file

(1) Format

[sftpadp.host-ipaddr=IP-address-or-host-name-of-SFTP-server-to-be-connected-to]
[sftpadp.host-con-port=port-number-of-SFTP-server-to-be-connected-to]
[sftpadp.user=login-user-name-of-SFTP-server-to-be-connected-to]

[sftpadp.client-ipaddr=IP-address-of-HCSC-server]
[sftpadp.client-port.min=minimum-value-for-the-range-of-port-numbers-to-establish-sesssion]
[sftpadp.client-port.max=maximum-value-for-the-range-of-port-numbers-to-establish-sesssion]

[sftpadp.data-compression={true|false}]
[sftpadp.strict-hostkey-checking={true|false}]
[sftpadp.host-auth-inf-filepath=absolute-path-for-host-public-key-file]
[sftpadp.user-auth-type={password|publickey}]
[sftpadp.password-auth-info=user-name-for-password-authentication]
[sftpadp.password-auth-inf-filepath=absolute-path-of-password-authentication-information-definition-file]
[sftpadp.publickey-auth-info=authentication-information-ID-used-for-public-key-authentication]
[sftpadp.publickey-auth-inf-filepath=absolute-path-of-public-key-authentication-information-definition-file]
[sftpadp.kex-exchange.algorithm=priority-of-key-exchange-method-used-for-encrypted-communication]
[sftpadp.common-key.cryptosystem.c2s=priority-of-common-key-cryptography-method-(client-to-server-communication)]
[sftpadp.common-key.cryptosystem.s2c=priority-of-common-key-cryptography-method-(server-to-client-communication)]
[sftpadp.message-authentication-code.c2s=priority-of-message-authentication-encoding-method-(client-to-server-communication)]
[sftpadp.message-authentication-code.s2c=priority-of-message-authentication-encoding-method-(server-to-client-communication)]
[sftpadp.host-key.algorithm=priority-of-host-authentication-method]
[sftpadp.data-compression.algorithm.c2s=priority-of-data-compression-algorithm-(client-to-server-communication)]
[sftpadp.data-compression.algorithm.s2c=priority-of-data-compression-algorithm-(server-to-client-communication)]

[sftpadp.session.timeout=timeout-value-for-session-connection-processing]
[sftpadp.session-con.retry.count=retry-count-when-session-cannot-be-established]
[sftpadp.session-con.retry.interval=retry-interval-when-session-cannot-be-established]

[sftpadp.read-lock.retry.count=retry-count-when-shared-lock-of-common-folder-fails]
[sftpadp.read-lock.retry.interval=retry-interval-when-shared-lock-of-common-folder-fails]
[sftpadp.write-lock.retry.count=retry-count-when-dedicated-lock-of-common-folder-fails]
[sftpadp.write-lock.retry.interval=retry-interval-when-dedicated-lock-of-common-folder-fails]

[sftpadp.data-read.timeout=time-for-monitoring-response-from-SFTP-server]

[sftpadp.methodtrace.level={1|2|3|4|5}]
[sftpadp.methodtrace.filenum=number-of-maintenance-log-files]
[sftpadp.methodtrace.filesize=maximum-size-of-one-maintenance-log-file]

[sftpadp.exptrace.filenum=number-of-exception-log-files]
[sftpadp.exptrace.filesize=maximum-size-of-one-exception-log-file]

[sftpadp.sftpprotocoltrace.filenum=number-of-SFTP-protocol-trace-files]
[sftpadp.sftpprotocoltrace.filesize=maximum-size-of-one-SFTP-protocol-trace-file]

(2) Function

Specifies the configuration information for each SFTP adapter.

There are two types of SFTP-adapter runtime-environment properties files: the individual definition file specified for each SFTP adapter, and the common definition file that is applied to all SFTP adapters. An SFTP-adapter runtime-environment properties file that is applied to all SFTP adapters is referred to as an SFTP-adapter runtime-environment common properties file.

If both the SFTP-adapter runtime-environment properties file and the SFTP-adapter runtime-environment common properties file are specified, the definitions in the two files are merged. If the same properties are specified in these files, the contents of the individual SFTP-adapter runtime-environment properties file become valid.

To create an SFTP-adapter runtime-environment properties file:

Define the SFTP-adapter runtime-environment properties file based on the following template file:

service-platform-installation-directory\CSC\custom-adapter\SFTP\config\templates\adpsftp.properties

Store the edited SFTP-adapter runtime-environment properties file with the following file name:

service-platform-installation-directory\CSC\custom-adapter\SFTP\config\service-ID.properties

(3) Specifiable properties

(a) Server information

sftpadp.host-ipaddr=IP-address-or-host-name-of-SFTP-server-to-be-connected-to

Specifies the IP address or host name of the SFTP server to be connected. You can specify the IP address by using the IPv4 dot notation or the IPv6 colon notation.

If both the host-ipaddr element of a request message and this property are specified, the value specified for the host-ipaddr element takes priority. If neither of them is specified, the request processing causes an error. For details about the host-ipaddr element, see the manual Service Platform Reception and Adapter Definition Guide.

sftpadp.host-con-port=port-number-of-SFTP-server-to-be-connected-to ~ <Numeric character> ((1 to 65535))

Specifies the port number of the SFTP server to be connected.

If both the host-con-port element of a request message and this property are specified, the value specified for the host-con-port element takes priority. If neither of them is specified, the request processing causes an error. For details about the host-con-port element, see the manual Service Platform Reception and Adapter Definition Guide.

sftpadp.user=login-user-name-of-SFTP-server-to-be-connected-to ~ <Character string> ((1 to 80 characters))

Specifies the login user name of the SFTP server to be connected.

You can specify halfwidth alphanumeric characters, halfwidth symbols (0x21 to 0x7E in ASCII encoding), and halfwidth spaces (0x20 in ASCII encoding). The characters are case sensitive. You can use the following halfwidth symbols:

Exclamation mark (!)

Double quotation mark (")

Hash mark (#)

Dollar sign ($)

Percent sign (%)

Ampersand (&)

Apostrophe mark (')

Left parenthesis (()

Right parenthesis ())

Asterisk (*)

Plus sign (+)

Comma (,)

Hyphen (-)

Period (.)

Forward slash (/)

Colon (:)

Semicolon (;)

Left angle bracket (<)

Right angle bracket (>)

Equal sign (=)

Question mark (?)

At mark (@)

Left square bracket ([)

Right square bracket (])

Yen sign (\)

Caret (^)

Underscore (_)

Grave accent mark (`)

Left curly bracket ({)

Right curly bracket (})

Vertical bar (|)

Swung dash (~)

The login user to be specified must have the permissions to execute file operations.

If both the sftp-user element of a request message and this property are specified, the value specified for the sftp-user element takes priority. If neither of them is specified, the request processing causes an error. For details about the sftp-user element, see the manual Service Platform Reception and Adapter Definition Guide.

(b) Associated with client information

sftpadp.client-ipaddr=IP-address-of-HCSC-server

Specifies the IP address of the HCSC server. You can specify the IP address by using the IPv4 dot notation or the IPv6 colon notation.

If the specified IP address is invalid, a system exception occurs. If you omit this property, the system automatically assigns any IP address.

sftpadp.client-port.min=minimum-value-for-the-range-of-port-numbers-to-establish-sesssion ~ <Numeric character> ((1024 to 65535))

Specifies the minimum value for the range of port numbers where the SFTP adapter establishes a session. This property must be specified in pair with the sftpadp.client-port.max property that specifies the maximum value of the preceding range. If you omit both of these properties, the system automatically assigns any port number.

In the following cases, an error occurs when the SFTP adapter starts:

A value greater than the maximum value of the range of port numbers (specified for the sftpadp.client-port.max property) is specified.

Either the sftpadp.client-port.min property or the sftpadp.client-port.max property is specified.

sftpadp.client-port.max=maximum-value-for-the-range-of-port-numbers-to-establish-sesssion ~ <Numeric character> ((1024 to 65535))

Specifies the maximum value for the range of port numbers where the SFTP adapter establishes a session. This property must be specified in pair with the sftpadp.client-port.min property that specifies the minimum value of the preceding range. If you omit both of these properties, the system automatically assigns any port number.

In the following cases, an error occurs when the SFTP adapter starts:

A value smaller than the minimum value of the range of port numbers (specified for the sftpadp.client-port.min property) is specified.

Either the sftpadp.client-port.min property or the sftpadp.client-port.max property is specified.

(c) SFTP settings

sftpadp.data-compression={true|false} ~ <<false>>

Specifies whether to compress the data to be transmitted.

true

The data to be transmitted will be compressed.

false

The data to be transmitted will not be compressed.

If both the data-compression element of a request message and this property are specified, the value specified for the data-compression element takes priority. If neither of them is specified, the default value is applied. For details about the data-compression element, see the manual Service Platform Reception and Adapter Definition Guide.

sftpadp.strict-hostkey-checking={true|false} ~ <<false>>

Specifies whether to perform the strict host key check during host authentication.

true

The strict host key check will be performed.

The host key received from the SFTP server is compared with the host key specified for the sftpadp.host-auth-inf-filepath property to verify that the target server is to be connected to. If the host key does not exist or is changed, an error occurs.

Because host authentication uses the host public key file, you must specify the absolute path of the host public key file for the sftpadp.host-auth-inf-filepath property.

false

The strict host key check will not be performed.

If both the strict-hostkey-checking element of a request message and this property are specified, the value specified for the strict-hostkey-checking element takes priority. If neither of them is specified, the default value is applied. For details about the strict-hostkey-checking element, see the manual Service Platform Reception and Adapter Definition Guide.

sftpadp.host-auth-inf-filepath=absolute-path-for-host-public-key-file

Specifies the absolute path to the host public key file. You must create the host public key file in advance and assign access permissions of the administrator of the HCSC server.

If the specified host public key file does not exist, an error occurs when the SFTP adapter starts. In addition, if this property is not specified when the strict host key check is performed (sftpadp.strict-hostkey-checking=true is specified), an error occurs during request processing.

sftpadp.user-auth-type={password|publickey}

Specifies the user authentication method.

password

Password authentication will be performed.

publickey

Public key authentication will be performed.

If both the user-auth-type element of a request message and this property are specified, the value specified for the user-auth-type element takes priority. If neither of them is specified, the request processing causes an error. For details about the user-auth-type element, see the manual Service Platform Reception and Adapter Definition Guide.

sftpadp.password-auth-info=user-name-for-password-authentication ~ <Character string> ((1 to 80 characters))

Specifies the user name used for password authentication if password authentication will be performed.

Specify the user name registered by using the csauseradd command. You can use halfwidth alphanumeric characters, halfwidth symbols (0x21 to 0x7E in ASCII encoding), and halfwidth spaces (0x20 in ASCII encoding). The characters are case sensitive. You can use the following halfwidth symbols:

Exclamation mark (!)

Double quotation mark (")

Hash mark (#)

Dollar sign ($)

Percent sign (%)

Ampersand (&)

Apostrophe mark (')

Left parenthesis (()

Right parenthesis ())

Asterisk (*)

Plus sign (+)

Comma (,)

Hyphen (-)

Period (.)

Forward slash (/)

Colon (:)

Semicolon (;)

Left angle bracket (<)

Right angle bracket (>)

Equal sign (=)

Question mark (?)

At mark (@)

Left square bracket ([)

Right square bracket (])

Yen sign (\)

Caret (^)

Underscore (_)

Grave accent mark (`)

Left curly bracket ({)

Right curly bracket (})

Vertical bar (|)

Swung dash (~)

If both the user-auth-info element of a request message and this property are specified, the value specified for the user-auth-info element takes priority. If the user-auth-info element, this property, or the sftpadp.publickey-auth-info property is not specified, the request processing causes an error. For details about the user-auth-info element, see the manual Service Platform Reception and Adapter Definition Guide.

sftpadp.password-auth-inf-filepath=absolute-path-of-password-authentication-information-definition-file

Specifies the absolute path of the password authentication information definition file if password authentication will be performed. Specify a password authentication information definition file created by using the csauseradd command.

The password authentication information definition file to be specified requires access permissions of the administrator of the HCSC server.

If the specified password authentication information definition file does not exist, an error occurs when the SFTP adapter starts. If this property is not specified when password authentication will be performed, an error occurs during request processing.

Important note

User authentication is always performed. Therefore, you must specify this property or the sftpadp.publickey-auth-inf-filepath property. If you omit both, an error occurs during request processing.

sftpadp.publickey-auth-info=authentication-information-ID-used-for-public-key-authentication ~ <Halfwidth alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the ID of the authentication information used for public key authentication if public key authentication will be performed. Specify a key ID registered by using the csakeyadd command.

If both the user-auth-info element of a request message and this property are specified, the value specified for the user-auth-info element takes priority. If the user-auth-info element, this property, or the sftpadp.password-auth-info property is not specified, the request processing causes an error. For details about the user-auth-info element, see the manual Service Platform Reception and Adapter Definition Guide.

sftpadp.publickey-auth-inf-filepath=absolute-path-of-public-key-authentication-information-definition-file

Specifies the absolute path of the public key authentication information definition file if public key authentication will be performed. Specify a public key authentication information definition file created by using the csakeyadd command.

The public key authentication information definition file to be specified requires access permissions of the administrator of the HCSC server.

If the specified public key authentication information definition file does not exist, an error occurs when the SFTP adapter starts. If this property is not specified when public key authentication will be performed, an error occurs during request processing.

Important note

User authentication is always performed. Therefore, you must specify this property or the sftpadp.password-auth-inf-filepath property. If you omit both, an error occurs during request processing.

sftpadp.kex-exchange.algorithm=priority-of-key-exchange-method-used-for-encrypted-communication

Specifies the priority of the key exchange methods used to establish encrypted communication.

The following table lists the specifiable key exchange methods and the default priority. Specify these key exchange methods in the order of priority, using the comma separated format (for example, sftpadp.kex-exchange.algorithm=key-exchange-method,key-exchange-method,key-exchange-method). If you specify a key exchange method not shown in this table, an error occurs when the SFTP adapter starts.

Default priority

Key exchange method

High

ecdh-sha2-nistp256

↑

ecdh-sha2-nistp384

|

ecdh-sha2-nistp521

|

diffie-hellman-group14-sha1

|

diffie-hellman-group-exchange-sha256

↓

diffie-hellman-group-exchange-sha1

Low

diffie-hellman-group1-sha1

sftpadp.common-key.cryptosystem.c2s=priority-of-common-key-cryptography-method-(client-to-server-communication)

Specifies the priority of the common key cryptography methods used to establish encrypted communication from a client to a server.

The following table lists the specifiable common key cryptography methods and the default priority. Specify these common key cryptography methods in the order of priority, using the comma separated format (for example, sftpadp.common-key.cryptosystem.c2s=common-key-cryptography-method,common-key-cryptography-method,common-key-cryptography-method). If you specify a common key cryptography method not shown in this table, an error occurs when the SFTP adapter starts.

Default priority

Common key cryptography method

High

aes128-ctr

↑

aes128-cbc

|

3des-cbc

|

blowfish-cbc

|

aes192-ctr

|

aes192-cbc

↓

aes256-ctr

Low

aes256-cbc

sftpadp.common-key.cryptosystem.s2c=priority-of-common-key-cryptography-method-(server-to-client-communication)

Specifies the priority of the common key cryptography methods used to establish encrypted communication from a server to a client.

The following table lists the specifiable common key cryptography methods and the default priority. Specify these common key cryptography methods in the order of priority, using the comma separated format (for example, sftpadp.common-key.cryptosystem.s2c=common-key-cryptography-method,common-key-cryptography-method,common-key-cryptography-method). If you specify a common key cryptography method not shown in this table, an error occurs when the SFTP adapter starts.

Default priority

Common key cryptography method

High

aes128-ctr

↑

aes128-cbc

|

3des-cbc

|

blowfish-cbc

|

aes192-ctr

|

aes192-cbc

↓

aes256-ctr

Low

aes256-cbc

sftpadp.message-authentication-code.c2s=priority-of-message-authentication-encoding-method-(client-to-server-communication)

Specifies the priority of the message authentication encoding methods (mechanisms that prevent alteration of data) used for communication from a client to a server.

The following table lists the specifiable message authentication encoding methods and the default priority. Specify these message authentication encoding methods in the order of priority, using the comma separated format (for example, sftpadp.message-authentication-code.c2s=encoding-method,encoding-method,encoding-method). If you specify a message authentication encoding method not shown in this table, an error occurs when the SFTP adapter starts.

Default priority

Message authentication encoding method

High

hmac-md5

↑

hmac-sha1

|

hmac-sha2-256

↓

hmac-sha1-96

Low

hmac-md5-96

sftpadp.message-authentication-code.s2c=priority-of-message-authentication-encoding-method-(server-to-client-communication)

Specifies the priority of the message authentication encoding methods (mechanisms that prevent alteration of data) used for communication from a server to a client.

The following table lists the specifiable message authentication encoding methods and the default priority. Specify message authentication encoding methods in the order of priority, using the comma separated format (for example, sftpadp.message-authentication-code.s2c=encoding-method,encoding-method,encoding-method). If you specify a message authentication encoding method not shown in this table, an error occurs when the SFTP adapter starts.

Default priority

Message authentication encoding method

High

hmac-md5

↑

hmac-sha1

|

hmac-sha2-256

↓

hmac-sha1-96

Low

hmac-md5-96

sftpadp.host-key.algorithm=priority-of-host-authentication-method

Specifies the priority of host authentication methods.

The following table lists the specifiable host authentication methods and the default priority. Specify these host authentication methods in the order of priority, using the comma separated format (for example, sftpadp.host-key.algorithm=host-authentication-method,host-authentication-method,host-authentication-method). If you specify a host authentication method not shown in this table, an error occurs when the SFTP adapter starts.

Default priority

Host authentication method

High

ssh-rsa

↓

ssh-dss

Low

ecdsa-sha2-nistp256

sftpadp.data-compression.algorithm.c2s=priority-of-data-compression-algorithm-(client-to-server-communication)

Specifies the priority of the data compression algorithms used for communication from a client to a server.

The following table lists the specifiable data compression algorithms and the default priority. Specify these data compression algorithms in the order of priority, using the comma separated format (for example, sftpadp.data-compression.algorithm.c2s=data-compression-algorithm,data-compression-algorithm,data-compression-algorithm). If you specify a data compression algorithm not shown in this table, an error occurs when the SFTP adapter starts.

Default priority

Data compression algorithm

High

zlib@openssh.com

Low

zlib

sftpadp.data-compression.algorithm.s2c=priority-of-data-compression-algorithm-(server-to-client-communication)

Specifies the priority of the data compression algorithms used for communication from a server to a client.

The following table lists the specifiable data compression algorithms and the default priority. Specify these data compression algorithms in the order of priority, using the comma separated format (for example, sftpadp.data-compression.algorithm.s2c=data-compression-algorithm,data-compression-algorithm,data-compression-algorithm). If you specify a data compression algorithm not shown in this table, an error occurs when the SFTP adapter starts.

Default priority

Data compression algorithm

High

zlib@openssh.com

Low

zlib

(d) Session connection timeout

sftpadp.session.timeout=timeout-value-for-session-connection-processing ~ <Numeric character> ((1 to 3600)) <<10>>

Specifies the wait time (in seconds) until the session connection processing times out.

sftpadp.session-con.retry.count=retry-count-when-session-cannot-be-established ~ <Numeric character> ((0 to 10000)) <<5>>

Specifies the number of times to retry a connection when a session cannot be established because, for example, the target system is busy. If you specify 0, the connection will not be retried.

sftpadp.session-con.retry.interval=retry-interval-when-session-cannot-be-established ~ <Numeric character> ((0 to 86400)) <<2>>

Specifies the interval (in seconds) at which a connection is retried when a session cannot be established because, for example, the target system is busy. If you specify 0, the connection will be retried without an interval.

(e) Lock acquisition timeout

sftpadp.read-lock.retry.count=retry-count-when-shared-lock-of-common-folder-fails ~ <Numeric character> ((0 to 1024)) <<0>>

Specifies the retry count when a shared lock of the files in the common folder fails.

sftpadp.read-lock.retry.interval=retry-interval-when-shared-lock-of-common-folder-fails ~ <Numeric character> ((1 to 1024)) <<1>>

Specifies, in seconds, the retry interval when a shared lock of the files in the common folder fails.

sftpadp.write-lock.retry.count=retry-count-when-dedicated-lock-of-common-folder-fails ~ <Numeric character> ((0 to 1024)) <<0>>

Specifies the retry count when a dedicated lock of the files in the common folder fails.

sftpadp.write-lock.retry.interval=retry-interval-when-dedicated-lock-of-common-folder-fails ~ <Numeric character> ((1 to 1024)) <<1>>

Specifies, in seconds, the retry interval when a dedicated lock of the files in the common folder fails.

(f) Data read timeout

sftpadp.data-read.timeout=time-for-monitoring-response-from-SFTP-server ~ <Numeric character> ((1 to 3600)) <<60>>

Specifies the time (in seconds) for monitoring a response from the SFTP server when, for example, file data is acquired at runtime of the GET operation or the result of algorithm negotiation is acquired.

If the receiving process is not completed even after the specified time has elapsed, an exception (error) occurs.

(g) Maintenance log

sftpadp.methodtrace.level={1|2|3|4|5} ~ <<3>>

Specifies the output level for the maintenance log. The following table lists the output information and output levels:

Output information

Output level

1

2

3

4

5

Entrance and exit information for the requestor service method (class name, method name, argument, return value)

N

Y

Y

Y

Y

Entrance and exit information for the external (such as BP) interfaces (class name, method name, argument, return value)

N

N

Y

Y

Y

Entrance and exit information for the interfaces within a component (class name, method name, argument, return value)

N

N

N

Y

Y

Debug information (such as information of branching of processing)

N

N

N

N

Y

Legend:

Y: Information is output.

N: Information is not output.

sftpadp.methodtrace.filenum=number-of-maintenance-log-files ~ <Numeric character> ((1 to 16)) <<8>>

Specifies the number of maintenance log files.

sftpadp.methodtrace.filesize=maximum-size-of-one-maintenance-log-file ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the maximum size of one maintenance log file in bytes.

(h) Exception log

sftpadp.exptrace.filenum=number-of-exception-log-files ~ <Numeric character> ((1 to 16)) <<8>>

Specifies the number of exception log files.

sftpadp.exptrace.filesize=maximum-size-of-one-exception-log-file ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the maximum size of one exception log file in bytes.

(i) SFTP protocol trace

sftpadp.sftpprotocoltrace.filenum=number-of-SFTP-protocol-trace-files ~ <Numeric character> ((1 to 16)) <<8>>

Specifies the number of protocol trace files.

sftpadp.sftpprotocoltrace.filesize=maximum-size-of-one-SFTP-protocol-trace-file ~ <Numeric character> ((4096 to 2147483647)) <<2097152>>

Specifies the maximum size of one protocol trace file in bytes.

6.16.2 SFTP-adapter runtime-environment common properties file

(1) Format

The format for describing the file is the same as for the SFTP-adapter runtime-environment properties file. For details about the format, see 6.16.1 SFTP-adapter runtime-environment properties file.

This file specifies the configuration information that is common to all SFTP adapters.

To create an SFTP-adapter runtime-environment common properties file:

Define the SFTP-adapter runtime-environment common properties file based on the following template file:

service-platform-installation-directory\CSC\custom-adapter\SFTP\config\templates\adpsftp.properties

Store the edited SFTP-adapter runtime-environment common properties file in the following directory:

service-platform-installation-directory\CSC\custom-adapter\SFTP\config\common

Do not change the file name.

(2) Specifiable properties

The specifiable properties are the same as those for the SFTP-adapter runtime-environment properties file. For details, see 6.16.1 SFTP-adapter runtime-environment properties file.

6.17 File used for user authentication

6.17.1 Definition file for user-authentication information management commands

(1) Format

[authinfo.command.messagelog.filepath=absolute-path-of-directory-to-output-message-log-files]
[authinfo.command.messagelog.filenum=number-of-message-log-files]
[authinfo.command.messagelog.filesize=maximum-size-of-one-message-log-file]

(2) Function

Specifies the configuration when the following user-authentication information management commands are executed:

csakeyadd command (adds or updates the private key information for public key authentication)

csakeydel command (deletes the private key information for public key authentication)

csakeyls command (displays the private key information for public key authentication)

csauseradd command (adds or updates the user information for password authentication)

csauserdel command (deletes the user information for password authentication)

csauserls command (displays the user information for password authentication)

To create a definition file for user-authentication information management commands:

Configure the definition file for user-authentication information management commands based on the following template file:

service-platform-installation-directory\CSC\config\msg\templates\authinfocommand.properties

Store the edited definition file for user-authentication information management commands in the following directory:

service-platform-installation-directory\CSC\config\msg

Do not change the file name.

(3) Specifiable properties

authinfo.command.messagelog.filepath=absolute-path-of-directory-to-output-message-log-files ~ <Character strings (including two-byte characters) and spaces> <<service-platform-installation-directory\CSC\log\msg\command>>

Specifies the absolute path to the directory to output message log files for user-authentication information management commands.

authinfo.command.messagelog.filenum=number-of-message-log-files ~ <Numeric character> ((1 to 64)) <<2>>

Specifies the number of message log files for the user authentication information management commands.

authinfo.command.messagelog.filesize=maximum-size-of-one-message-log-file ~ <Numeric character> ((4096 to 16777216)) <<1048576>>

Specifies, in bytes, the maximum size of one message log file for the user authentication information management commands.

(4) Note

Do not specify the same property multiple times. If you specify the same property multiple times, it is not certain which value becomes valid.

Appendixes

A. Character Code Mapping

This appendix describes the mapping of character codes for conversion in Code Converter.

To create a user mapping for Code Converter or to use the Code Converter API within the character code conversion UOC, use the following version of Code Converter.

In Windows

Execution environment

Code Converter - Server Runtime for Java 04-02 or later

Development environment

Code Converter - Development Kit for Java 04-02 or later

In Linux

Execution environment

Code Converter - Runtime for Java 04-02 or later

A.1 Mapping one-byte codes

The following table describes the mapping for conversion of halfwidth codes for Code Converter.

Figure A‒1: Mapping for one-byte code conversion

Legend:

--: No applicable characters

Note 1

Codes EBCDIC and EBCDIK (KEIS version) support the standard version.

In the standard version, (5D)₁₆ becomes (4F)₁₆ and (21)₁₆ becomes (5A)₁₆.

Note 2

With EBCDIC and EBCDIK (KEIS version), (0A)₁₆ is treated as a code for switching between one- and two-byte codes.

Note 3

With EBCDIC (IBM version), (0E)₁₆ and (0F)₁₆ are treated as codes for switching between two-byte and one-byte codes.

Note 4

With EBCDIC (JEF version) and EBCDIK (JEF version), (28)₁₆, (29)₁₆, and (38)₁₆ are treated as codes for switching between one- and two-byte codes.

For output, only (28)₁₆ and (29)₁₆ are treated as codes for switching between one- and two-byte codes.

A.2 Code mapping for special characters

The following table describes the mapping for conversion of special characters for Code Converter.

Code Converter supports three types of special characters provided by vendors: Windows special characters, IBM selected characters, and NEC-selected IBM extended characters. To use the IBM selected characters and NEC-selected IBM extended characters, you must define the user mapping.

Table A‒1: List of conversion details for the code mapping of special characters provided by vendors

Conversion details

Location of description

Windows special characters

SJIS and Unicode (UCS-2)

Appendix A.2(1)(a)

From Unicode (UCS-2) to SJIS

Appendix A.2(1)(b)

IBM selected characters

Appendix A.2(2)

NEC-selected IBM extended characters

Appendix A.2(3)

(1) Conversion mapping of Windows special characters

(a) Mapping Windows special characters (SJIS and Unicode (UCS-2))

Note 1

The numeric characters in the H/L column of the table are SJIS. The numeric characters in the column where the fonts are described are Unicode (UCS-2).

Note 2

The parts with thick borders only indicate the conversion from SJIS to Unicode (UCS-2). The conversion from Unicode (UCS-2) to SJIS is as described in (b) Mapping Windows special characters (from Unicode (UCS-2) to SJIS).

(b) Mapping Windows special characters (from Unicode (UCS-2) to SJIS)

(2) Mapping IBM selected characters

(a) Mapping IBM selected characters (SJIS and Unicode (UCS-2))

Note 1

The numeric characters in the H/L column of the table are SJIS. The numeric characters in the column where the fonts are described are Unicode (UCS-2).

Note 2

The parts with thick borders only indicate the conversion from SJIS to Unicode (UCS-2). The conversion from Unicode (UCS-2) to SJIS is as described in (b) Mapping IBM selected characters (from Unicode (UCS-2) to SJIS).

(b) Mapping IBM selected characters (from Unicode (UCS-2) to SJIS)

(c) Mapping IBM selected characters (IBM code and Unicode (UCS-2))

(3) Mapping NEC-selected IBM extended characters

(a) Mapping NEC-selected IBM extended characters (SJIS and Unicode (UCS-2))

(b) Mapping NEC-selected IBM extended characters (from Unicode (UCS-2) to SJIS)

B. Glossary

Terminology used in this manual

For the terms used in the manual, see the uCosminexus Application Server and BPM/ESB Platform Terminology Guide.

Index

A

acquire node count dialog[1]

acquire node name dialog[1]

Acquire String Length dialog[1]

Acquire Substring dialog[1]

activity auto align function[1]

activity auto connect function[1]

activity snapping function[1]

Add/Edit Condition dialog[1]

Add/Edit Sort Condition dialog[1]

add multiple services dialog[1]

Add or Change Separator dialog[1]

Allocating Correlation Set Group Dialog[1]

Assign Activity dialog[1]

Assign Activity sub dialog[1]

attribute[1]

auto align function[1]

auto connect function[1]

B

backing up HCSC-Manager environment[1]

base conversion dialog[1]

basic activity[1]

binary format definition

dialogs related to[1]

Binary Format Definition Editor[1]

redoing operations[1]

undoing operations[1]

Binary Format Definition window[1]

operations in[1]

binary-message-generation command properties file[1]

binary-message-generation definition file[1]

binary-parse command properties file[1]

break point view[1]

business process

dialogs related to[1]

Business Process Definition window[1]

operations in[1]

Business Process Definition window

redoing operations[1]

undoing operations[1]

business process editor[1]

C

canvas[1]

restoring default display size[1]

zooming in contents[1]

zooming out contents[1]

character code mapping[1]

check node dialog[1]

check string dialog[1]

choose node dialog[1]

client definition file[1]

closing open tabs[1]

code mapping for special characters[1]

command

input format (development environment)[1]

syntax and description format (development environment)[1]

command-adapter runtime-environment common properties file[1]

command-adapter runtime-environment properties file[1]

command-execution permission definition file[1]

command for displaying trace collection points[1]

command input format (operating and execution environments)[1]

commands used at message tracking prompt[1]

commands used in development environment of service platform[1]

commands used in operating environment and execution environment of service platform[1]

comment

minimizing[1]

restoring size[1]

complex content[1]

Complex Content Element dialog[1]

component-common UOC function[1]

component dialog[1]

component-ID configuration file[1]

component-type configuration file[1]

Concatenate dialog[1]

concurrent execution of commands[1]

condition setting dialog[1]

Condition Setting dialog

flow activity[1]

switch activity[1]

Condition Settings dialog (Set Node Condition)[1]

Condition Value Setting dialog[1]

configuration of Debug Business Process screen[1]

configuration of window for creating binary format definition files[1]

Console view[1]

when defining binary format[1]

Console view (when creating HSCS components and data transformation definitions)[1]

conversion dialog from COBOL library text[1]

conversion type[1]

convert number format dialog[1]

creating XML format definition files from binary format definition files[1]

csaftpuseradd[1]

csaftpuserdel[1]

csaftpuserls[1]

csakeyadd[1]

csakeydel[1]

csakeyls[1]

csamkxmls[1]

csauseradd[1]

csauserdel[1]

csauserls[1]

cscapputil[1]

cscbinaryparse[1]

csccmctl[1]

csccompoconfig[1]

csccompodeploy[1]

csccompostart[1]

csccompostop[1]

csccompoundeploy[1]

cscenvbackup[1]

cscenvrestore[1]

cscenvupdate[1]

cscfdx2xsd[1]

cscfscls[1]

cscfscrm[1]

cscfswls[1]

cscfswrm[1]

cscgenbinary[1]

cscjson2xsd[1]

cscjsonxmlconv[1]

cscmsgtk[1]

cscpasswd[1]

cscpidelete[1]

cscpireexec[1]

cscpiselect[1]

cscprecache[1]

cscrcptnstart[1]

cscrcptnstop[1]

cscrepcheck[1]

cscrepctl[1]

cscrepdiff[1]

cscrepls[1]

cscrepupdate[1]

cscresinfo[1]

cscsetup[1]

cscsetup command definition file[1]

cscsoapmode[1]

cscstatus[1]

cscsvcctl[1]

cscsvcls[1]

cscsvconfig[1]

cscsvsetup[1]

cscsvstart[1]

cscsvstop[1]

cscsvunsetup[1]

csctransform[1]

cscutil[1]

csmftpaddusr[1]

csmftpdelusr[1]

csmftplshistory[1]

csmftplsusr[1]

csmmailaddusr[1]

csmmaildelusr[1]

csmmaillsusr[1]

Custom Adapter Basic window[1]

Custom Adapter Details window[1]

custom dialog[1]

D

database adapters

creating XML format definition file for[1]

data transformation, configuration of window for defining[1]

Data Transformation (Mapping) Definition window

redoing operations[1]

undoing operations[1]

Data Transformation Activity dialog[1]

data-transformation command properties file[1]

data transformation definition

saving[1]

data transformation definition window

operations in[1]

Data Transformation Definition window[1]

DB adapter mapping settings dialog[1]

debug configuration dialog[1]

debug view[1]

defining HCSC components[1]

Definition area[1]

definition file (development environment)[1]

definition file for emulated configuration information[1]

definition file for user-authentication information management commands[1]

definition files (operating and execution environments)[1]

Definition information page[1]

definition windows and information display windows[1]

delete multiple services dialog[1]

Delete User Defined Reception dialog[1]

deleting common folder[1]

deleting deployed HCSC components[1]

deleting FTP adapter users[1]

deleting FTP inbound adapter users[1]

deleting mail adapter user information[1]

deleting private key information for public key authentication[1]

deleting process instance execution log[1]

deleting user information for password authentication[1]

deleting work folder[1]

deploying HCSC components[1]

description format of definition file syntax (development environment)[1]

dialog boxes for operating multiple services[1]

dialog boxes related to validation and packaging[1]

dialogs related to data transformation (mapping)[1]

dialogs related to debugging of business processes[1]

displaying differences in repository information[1]

displaying FTP adapter users[1]

displaying FTP inbound adapter users[1]

displaying mail adapter user information[1]

displaying private key information for public key authentication[1]

displaying repository information[1]

displaying resource information[1]

displaying service information[1]

displaying status[1]

displaying transmission log[1]

displaying user information for password authentication[1]

E

easy setup of production environment[1]

editor area[1]

element

copying[1]

deleting[1]

moving[1]

pasting[1]

element path, copying from schema tree viewer[1]

Empty Activity dialog[1]

enabling and disabling activity list display[1]

enabling and disabling variable list display[1]

error analysis command[1]

exporting[1]

Export Mapping Definition dialog box[1]

F

Fault Handler dialog[1]

file adapter runtime-environment property file[1]

file-event-reception common configuration file[1]

file-event-reception configuration file[1]

file-event-reception definition file[1]

file operations adapter definition file[1]

file operations adapter runtime-environment property file[1]

files used for configuring HCSC servers[1]

files used for data-transformation unit test commands (operating and execution environments)[1]

files used for file event linkage[1]

files used for FTP integration (operating and execution environments)[1]

files used for HCSC server operations[1]

files used for SOAP integration (operating and execution environments)[1]

files used for TP1 integration (operating and execution environments)[1]

files used for transformation between JSON format data and XML format data (operating and execution environments)[1]

files used with command adapters (operating and execution environments)[1]

files used with file adapter (operating and execution environments)[1]

files used with HTTP adapter (operating and execution environments)[1]

files used with mail adapter (operating and execution environments)[1]

files used with Message Queue adapter (operating and execution environments)[1]

files used with Object Access adapter (operating and execution environments)[1]

files used with SFTP adapters (operating and execution environments)[1]

file to be used in FTP linkage (development environment)[1]

file to be used in message queue adapter (development environment)[1]

file to be used in message queue reception[1]

File to be used in Object Access adapter (development environment) [1]

file to be used in soap linkage (development environment)[1]

file to be used in tp1 linkage (development environment)[1]

file used for file event linkage (development environment)[1]

file used for HTTP adapter (development environment)[1]

file used for HTTP reception (development environment)[1]

file used for user authentication[1]

filter function settings of outline view[1]

finding process instance[1]

Flow Activity dialog[1]

focus analysis command[1]

format dialog[1]

format for describing command syntax (operating and execution environments)[1]

format for describing definition file syntax (operating and execution environments)[1]

FTP adapter account definition file[1]

FTP adapter command definition file[1]

FTP-adapter runtime-environment property file[1]

FTP command authorization list definition file[1]

FTP execution authorization list definition file[1]

FTP reception configuration file[1]

FTP reception definition file[1]

H

HCSC automatic emulation view[1]

HCSC Component Information Display window[1]

HCSC components, configuration of window for creating[1]

HCSC component-specification file[1]

HCSC emulation view[1]

HCSC-Manager command definition file[1]

HCSC-Manager command definition file for Java VM start options[1]

HCSC-Manager definition file[1]

HCSC-Messaging command definition file[1]

HCSC server configuration definition file[1]

HCSC server runtime definition file[1]

HCSC server runtime definitions[1]

HCSC server setup definition file[1]

HCSCTE result view[1]

HCSC XPath evaluation view[1]

header allocated variable dialog[1]

help command[1]

HTTP adapter definition file[1]

HTTP-adapter runtime-environment common property file[1]

HTTP-adapter runtime-environment property file[1]

HTTP reception definition file[1]

HTTP-reception service-selection definition file[1]

HTTP response header definition file[1]

I

importing[1]

import mapping definition dialog[1]

Information page[1]

input format of definition file (development environment)[1]

input format of definition files (operating and execution environments)[1]

Invoke Java Activity dialog[1]

Invoke Service Activity dialog[1]

invoking message tracking function[1]

J

JSON-XML transformation definition file[1]

L

Link dialog[1]

list command options definition file[1]

list display command[1]

List Of Variables And Correlation Sets dialog[1]

logical operation dialog[1]

loop node dialog[1]

Loop Settings dialog[1]

M

mail adapter account definition file[1]

mail adapter command definition file[1]

mail adapter runtime environment property file[1]

mail header definition file[1]

managing definition files[1]

managing service information[1]

managing users[1]

mapping IBM selected characters (from Unicode (UCS-2) to SJIS)[1]

mapping IBM selected characters (IBM code and Unicode (UCS-2))[1]

mapping IBM selected characters (SJIS and Unicode (UCS-2))[1]

mapping lines

changing color of[1]

mapping NEC-selected IBM extended characters (from Unicode (UCS-2) to SJIS)[1]

mapping NEC-selected IBM extended characters (SJIS and Unicode (UCS-2))[1]

mapping one-byte codes[1]

mapping viewer[1]

mapping Windows special characters (from Unicode (UCS-2) to SJIS)[1]

mapping Windows special characters (SJIS and Unicode (UCS-2))[1]

MDB/WS-R Detail Editor (Service adapter definition window)[1]

menu bar[1]

Message Queue adapter communication-configuration definition file[1]

Message Queue adapter environment-definition file[1]

Message Queue adapter runtime-environment property file[1]

Message Queue reception definition file[1]

minimizing

comments[1]

multiple packaging dialog[1]

mutually transforming DOM and binary data[1]

mutually transforming JSON format data and XML format data[1]

N

not operation dialog[1]

O

Object Access adapter runtime-environment property file[1]

objects

aligning[1]

copying[1]

cutting[1]

deleting[1]

opening higher-order tabs[1]

operating application[1]

Operations Page[1]

outline view[1], [2]

outline view (Define Business Process window)[1]

output mode switching command[1]

output of namespace prefix to XML[data transformation definition screen][1]

P

Package Explorer[1]

palette

Business Process Definition window[1]

Data Transformation Definition window[1]

display settings, specifying[1]

Palette Settings dialog[1]

pasting objects[1]

perform node operation dialog[1]

pre-caching format definitions and data transformation definitions[1]

Preferences dialog box (data transformation settings)[1]

Preferences dialog box (validation and packaging operation settings)[1]

Problems view (when creating HSCS components and data transformation definitions)[1]

Problems view (when defining binary format)[1]

process environment-variable definition file[1]

Properties view[1]

when defining binary format[1]

Q

quit command[1]

R

Receive Activity dialog[1]

re-executing process instances[1]

referencing common folder[1]

referencing work folder[1]

registering and updating FTP adapter users[1]

registering and updating FTP inbound adapter users[1]

registering and updating mail adapter user information[1]

registering and updating private key information for public key authentication[1]

registering and updating user information for password authentication[1]

register mapping definitions dialog[1]

remove input value dialog[1]

removing setup of HCSC server[1]

repeat condition setting dialog[1]

repeat list setting dialog[1]

replace value dialog[1]

Reply Activity dialog[1]

Resource Information page[1]

restoring

comment size[1]

restoring HCSC-Manager environment[1]

round node dialog[1]

S

schema logical name[1]

Scope Activity dialog[1]

search element name dialog[1]

select automatic mapping options dialog[1]

Select Element dialog[1]

select function dialog[1]

Select Node dialog

binary format definition[1]

data transformation[1]

Select Root Element dialog[1]

Select Separator dialog[1]

select transformation function dialog[1]

Service adapter definition window[1]

NonCustom Standard Editor (MDB/DB Queue)[1]

NonCustom Standard Editor (MDB/WS-R)[1]

NonCustom Standard Editor (SessionBean)[1]

NonCustom Standard Editor (Web Service)[1]

service-information change definition file[1]

SessionBean Detail Editor (Service adapter definition window)[1]

set constant dialog[1]

Set Node Condition dialog[1]

setting dialog (setting up WSDL custom binding file)[1]

settings for automatic mapping source dialog[1]

settings for duplicate mapping range dialog[1]

settings for duplicate mapping source dialog[1]

Settings for Mapping Source dialog[1]

Settings for Source and Target Schema File dialog box[1]

Settings for Source Schema File dialog box[1]

setting up HCSC server[1]

setting up SOAP mode[1]

SFTP-adapter runtime-environment common properties file[1]

SFTP-adapter runtime-environment properties file[1]

shift operation dialog[1]

Showing Variable dialog[1]

simple content[1]

simple content element dialog[1]

snapping function[1]

SOAP fault operation definition file[1]

SOAP reception definition file[1]

source schema tree viewer[1]

standby activity dialog[1]

starting HCSC components[1]

starting HCSC server[1]

starting standard receptions and user-defined receptions[1]

stopping HCSC components[1]

stopping HCSC server[1]

stopping standard receptions and user-defined receptions[1]

structure activity[1]

sum up nodes dialog[1]

Switch Activity dialog[1]

system properties file for data transformation[1]

T

tab[1]

Business Process Definition window[1]

Take In Message Format dialog[1]

target schema tree viewer[1]

testing data transformation[1]

Throw Activity dialog[1]

TP1-adapter runtime-environment property file[1]

Tracking page[1]

transforming JSON format data to XSD files[1]

Tree view[1], [2]

trim node dialog[1]

types of commands (development environment)[1]

types of commands (operating and execution environments)[1]

types of definition files (development environment)[1]

types of definition files (operating and execution environments)[1]

U

updating repository[1]

upgrading execution environment[1]

user-defined reception

dialog[1]

User-Defined Reception Definition window[1]

User-Defined Reception Information Display window[1]

user-defined reception runtime definition file[1]

V

validation activity dialog[1]

value setting dialog[1]

variable view[1]

various operations[1]

verifying importability[1]

W

Web Services Detail Editor (Service adapter definition window)[1]

While Activity dialog[1]

window configuration (development environment)[1]

windows (development environment)[1]

window structure (Operating environment)[1]

WSDL custom binding file related dialog[1]

X

XML format definition file

creating for database adapter[1]

XPath dialog box[1]