Cosminexus V11 BPM/ESB基盤 サービスプラットフォーム リファレンス

文法・操作書

3021-3-J46-60

前書き

対象製品

マニュアル「アプリケーションサーバ & BPM/ESB基盤 概説」の前書きの対象製品の説明を参照してください。

輸出時の注意

本製品を輸出される場合には、外国為替及び外国貿易法の規制並びに米国輸出管理規則など外国の輸出関連法規をご確認の上、必要な手続きをお取りください。

なお、不明な場合は、弊社担当営業にお問い合わせください。

商標類

HITACHI，Cosminexus，HiRDB，OpenTP1，uCosminexusは，株式会社 日立製作所の商標または登録商標です。

AIXは，世界の多くの国で登録されたInternational Business Machines Corporationの商標です。

Apache(R)，Apache Kafka(R)，およびKafka(R)は，Apache Software Foundationの米国およびその他の国における登録商標または商標です。

Eclipseは，Eclipse Foundation, Inc.の商標です。

IBMは，世界の多くの国で登録されたInternational Business Machines Corporationの商標です。

Linuxは，Linus Torvalds氏の米国およびその他の国における登録商標です。

Microsoft，Excel，Windows，Windows Serverは，マイクロソフト 企業グループの商標です。

Oracle(R)，Java，MySQL及びNetSuiteは，Oracle，その子会社及び関連会社の米国及びその他の国における登録商標です。

UNIXは，The Open Groupの登録商標です。

その他記載の会社名，製品名などは，それぞれの会社の商標もしくは登録商標です。

Eclipseは，開発ツールプロバイダのオープンコミュニティであるEclipse Foundation, Inc.により構築された開発ツール統合のためのオープンプラットフォームです。

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

本ソフトウェアに含まれる第三者ソフトウェアに関する情報を次に示します。

第三者ソフトウェア：Trang

著作権者：Thai Open Source Software Center Ltd

当該ソフトウェアのライセンス条文：以下の通り。

Copyright (c) 2002, 2003, 2008 Thai Open Source Software Center Ltd

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of the Thai Open Source Software Center Ltd nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

ランゲージパックの使用について

このマニュアルでは，Eclipse Babel Projectが提供するBABEL日本語ランゲージパックを適用したEclipseメニュー表記を使用しています。使用するランゲージパックのバージョンによっては，マニュアル内の表記と異なる場合があります。

発行

2024年 9月 3021-3-J46-60

著作権

All Rights Reserved. Copyright (C) 2020, 2024, Hitachi, Ltd.

変更内容

変更内容(3021-3-J46-60) uCosminexus Service Architect 11-50，uCosminexus Service Platform 11-50

追加・変更内容

変更個所

Service Platformの適用OSにAmazon Linux 2023を追加した。

−

［受付アクティビティ］ダイアログと［応答アクティビティ］ダイアログのオペレーション名を別のダイアログで指定できるようにした。

1.4.7，1.4.8，1.4.9，1.4.10

HTTP受付にルーティング機能を追加し，HTTP受付をホスト名，URLパターン，およびHTTPメソッド単位で実行できるようにした。

3.1，3.11.3(1)，3.11.3(4)，3.11.4

HTTPアダプタにリダイレクト機能を追加し，HTTPアダプタが一時的にサービスを呼び出せない場合に代わりのサービスを呼び出せるようにした。

3.10.1(1)，3.10.1(4)

HTTPアダプタのリクエスト処理時に，署名付きAWS APIリクエストに必要な署名情報をリクエストヘッダに付与できるようにした。

5.4 csahttpuseradd，5.4 csahttpuserdel，5.4 csahttpuserls，6.14.1，6.14.2(1)，6.14.2(3)，6.21.1(1)，6.21.1(2)，6.21.1(4)

HCSC本番環境簡易セットアップ機能で，複数のサーバを構築できるようにした。

5.4 cscsetup，6.4.1(3)

FTPインバウンドアダプタの転送履歴の表示対象となるディレクトリを指定できるようにした。

5.4 csmftplshistory

SFTPアダプタで使用するOSSを変更した。

6.16.1(1)，6.16.1(3)

単なる誤字・脱字などはお断りなく訂正しました。

はじめに

このマニュアルをお読みになる際の前提情報については，マニュアル「アプリケーションサーバ & BPM/ESB基盤 概説」のはじめにの説明を参照してください。

第1編　開発環境のリファレンス

1　画面（開発環境）

この章では，サービスプラットフォームの開発環境で使用する画面について説明します。

1.1　画面構成（開発環境）

開発環境で使用する画面の構成について説明します。

1.1.1　バイナリフォーマット定義ファイルを定義する画面の構成

次の画面は，ウィザードで作成したバイナリフォーマット定義ファイルに対し，要素などを定義する画面です。画面の構成を説明します。

図1‒1　バイナリフォーマット定義ファイルを定義する画面の構成

パッケージ・エクスプローラー

バイナリフォーマット定義ファイルの一覧が表示されます。

バイナリフォーマット定義画面

バイナリフォーマット定義ファイルの内容を定義する画面です。バイナリフォーマット定義エディタおよびアウトラインビューから構成されます。

バイナリフォーマット定義画面の詳細については，「1.2.1　バイナリフォーマット定義画面」を参照してください。

プロパティービュー

バイナリフォーマット定義画面で定義したバイナリフォーマット定義ファイルの情報や各要素の情報が表示されます。

問題ビュー

バイナリフォーマット定義ファイルを検証した結果，問題があった場合に，問題点の一覧が表示されます。

コンソールビュー

バイナリフォーマット定義ファイルの検証結果が表示されます。

参考

Eclipseのパースペクティブによっては，初期状態で表示されないビューがあります。この場合，Eclipseのメニューから［ウィンドウ］−［ビューの表示］を選択して，必要なビューを開いてください。

1.1.2　HCSCコンポーネントを作成またはデータ変換を定義する画面の構成

次の画面は，HCSCコンポーネントの作成や，データ変換の定義で使用する画面です。画面の構成を説明します。

図1‒2　HCSCコンポーネントを作成またはデータ変換を定義する画面の構成

ツリービュー

サービス定義一覧，公開サービス一覧，およびシステム構成定義一覧が表示されます。

ツリービューの表示項目は，ツリービューの上部にあるテキストボックスに表示項目の名称を入力することでフィルタリングできます。

定義領域

操作に応じて次に示す定義画面または情報表示画面が表示されます。

サービスアダプタ定義画面

ビジネスプロセス定義画面

データ変換定義画面

ユーザ定義受付定義画面

HCSCコンポーネント情報表示画面

ユーザ定義受付情報表示画面

それぞれの画面の詳細については，「1.2　定義画面および情報表示画面」を参照してください。

プロパティービュー

定義領域で定義したHCSCコンポーネントの情報などが表示されます。

問題ビュー

HCSCコンポーネントおよびデータ変換定義を検証した結果，問題があった場合に，問題点の一覧が表示されます。

コンソールビュー

次に示す情報が表示されます。

出力時刻（出力形式：[yyyy/MM/dd HH:mm:ss]）

エラー情報

検証結果

HCSCTE結果ビュー

検証，パッケージング，公開化，非公開化が発生する処理の結果として，次に示す情報が表示されます。

サービス名

サービス種別

メッセージ

1.1.3　ビジネスプロセスのデバッグ画面の構成

ビジネスプロセスのデバッグで使用する画面の構成を次の図に示します。

図1‒3　ビジネスプロセスのデバッグ画面の構成

(1)　デバッグビュー

デバッグ中のビジネスプロセスの名称，および中断しているアクティビティの名称が表示されます。また，ステップ実行，再開，および終了の操作を実行します。

図1‒4　デバッグビュー

デバッグビューに表示されるアイコンを次に示します。

表1‒1　デバッグビューのアイコン

アイコン

名称

説明

デバッグ構成

「「［デバッグ構成］ダイアログで指定した名称」［HCSC-BP］」が表示されます。

ビジネスプロセス

デバッグ中のビジネスプロセスの名称が表示されます。

プロセスインスタンス※

プロセスインスタンス名が表示されます。

アクティビティ

中断しているアクティビティの名称が表示されます。

HCSCサーバ

常に「HCSCサーバ」が表示されます。

ステップイン

中断しているアクティビティがステップ実行，および再開されます。

ステップイン，ステップオーバー，ステップリターン，および再開したときの処理の詳細については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「10.　ビジネスプロセスのデバッグ」を参照してください。

ステップオーバー

ステップリターン

再開

終了

ビジネスプロセスのデバッグが終了されます。

注※

プロセスインスタンスの処理が中断している場合，アイコンは[図データ]で表示されます。プロセスインスタンスが処理中の場合は[図データ]になります。

(2)　変数ビュー

ビジネスプロセスで現在使用している変数，および相関セットを確認したり，変数の値を更新したりするときに使用します。

図1‒5　変数ビュー

［名前］

変数（[図データ]）および相関セット（[図データ]）の名称が表示されます。

［値］

変数および相関セットの値が表示されます。ビジネスプロセスの実行によって変数の値が変わった場合や，変数の値を更新した場合，値が変わった変数の［名前］および［値］のセルが黄色で表示されます。変数が初期化されていない場合は，<uninitialized>が表示されます。なお，実行中のスコープと上位のスコープに同じ名前の変数や相関セットがある場合，変数ビューには実行中のスコープの変数や相関セットが表示されます。

(3)　ブレークポイントビュー

ブレークポイントの設定を有効，または無効にする場合に使用します。

図1‒6　ブレークポイントビュー

アクティビティに設定したブレークポイントが「ビジネスプロセス名［アクティビティ名］」の形式で表示されます。ブレークポイントに条件式を指定している場合は，「ビジネスプロセス名［アクティビティ名］：条件式」の形式で表示されます。

設定したブレークポイントを有効にする場合は，チェックボックスをチェックします。設定したブレークポイントを無効にする場合は，チェックボックスのチェックを解除します。

なお，ビジネスプロセスのデバッグでは，すべてのブレークポイントをスキップする機能（[図データ]）は使用できません。

(4)　ビジネスプロセスエディタ

デバッグ中のビジネスプロセスが表示されます。

図1‒7　ビジネスプロセスエディタ

プロセスインスタンスの処理が中断しているときは，中断しているアクティビティが緑色で表示されます。

なお，ブレークポイントが設定されたアクティビティには，ブレークポイントを表すマークが付きます。ブレークポイントが有効の場合は，次の図のようにマークがチェックされた状態になります。ブレークポイントが無効の場合は，マークのチェックが外れた状態になります。

図1‒8　ブレークポイントが設定されたアクティビティ

(5)　HCSC 自動エミュレートビュー

サービスの自動エミュレーションを設定するときに使用します。

図1‒9　HCSC 自動エミュレートビュー

［有効］

サービスの自動エミュレーションの設定を有効にする場合にチェックボックスをチェックします。

［優先順位］

先頭の行から順番に1，2，3，…が表示されます。

［サービス名］

セルを選択すると，選択できるサービスの一覧がドロップダウンリストで表示されます。

［オペレーション名］

セルを選択すると，［サービス名］で選択したサービスが持つオペレーションの一覧がドロップダウンリストで表示されます。

［応答種別］

セルを選択すると，通常応答またはフォルト応答をドロップダウンリストから選択できます。

［応答電文］

セルを選択すると，［...］ボタンが表示されます。［...］ボタンをクリックすると，応答電文を設定するダイアログが表示されます。すでに応答電文を設定している場合は，応答電文のファイル名が表示されます。

［条件］

サービスをエミュレーションする条件式をXPathで入力します。条件式を入力するときは，次の点に注意してください。

サービスの要求電文に対して条件を設定するため，変数名の指定は不要です。

空文字（0x00）およびcsc:getVariableDataなどの拡張関数は使用できません。

条件式を指定しなかった場合は，常に真として評価されます。

［追加］ボタン

テーブルに行が追加されます。

［削除］ボタン

セルを選択して［削除］ボタンをクリックすると，選択したセルを含む行が削除されます。

［上へ］ボタン

選択した行の優先順位を上げます。

［下へ］ボタン

選択した行の優先順位を下げます。

［保存］ボタン

HCSC 自動エミュレートビューで設定した情報を保存するダイアログが表示されます。

［読み込み］ボタン

HCSC 自動エミュレートビューで設定した情報を取得するダイアログが表示されます。

(6)　HCSC エミュレートビュー

サービスの手動エミュレーションを設定，および実行するときに使用します。

図1‒10　HCSC エミュレートビュー

［応答種別］

セルを選択すると，ドロップダウンリストが表示され，通常応答またはフォルト応答を選択できます。

［応答電文］

セルを選択すると，［...］ボタンが表示されます。［...］ボタンをクリックすると，応答電文を設定するダイアログが表示されます。すでに応答電文を設定している場合は，応答電文のファイル名が表示されます。

［追加］ボタン

テーブルに行が追加されます。

［削除］ボタン

セルを選択して［削除］ボタンをクリックすると，選択したセルを含む行が削除されます。

［再開］ボタン

サービスがエミュレーションされ，ビジネスプロセスのデバッグが再開されます。

［ステップ実行］ボタン

サービスがエミュレーションされ，ビジネスプロセスのデバッグがステップオーバーされます。

［保存］ボタン

HCSC エミュレートビューで設定した情報を保存するダイアログが表示されます。

［読み込み］ボタン

HCSC エミュレートビューで設定した情報を取得するダイアログが表示されます。

(7)　HCSC XPath 評価ビュー

分岐開始アクティビティや代入アクティビティの条件式を評価するときに使用します。

図1‒11　HCSC XPath 評価ビュー

［XPath式］

条件式をXPathで入力します。条件式を入力するときは，次の点に注意してください。

空文字（0x00）は使用できません。

改行が含まれる値の同値判定はできません。

例えば，変数xの要素/y/zを次に示すような値とします。

"a
b"

このとき，次のXPath式でXPath評価を実行しても評価結果は真（true）になりません。

$x/y/z="a
b"

改行文字やスペースを取り除くXPathの関数normalize-space()を使用することで回避できます。

［評価］ボタン

［XPath式］に入力した条件式が評価されます。

［評価結果］

［XPath式］に入力した条件式の評価結果が表示されます。

(8)　アウトラインビュー

デバッグ中のビジネスプロセスで定義した変数の名称，およびアクティビティの名称が表示されます。

図1‒12　アウトラインビュー

1.2　定義画面および情報表示画面

この節では，開発環境で使用する画面を定義内容ごとに項目を分けて説明します。画面の種類と，各画面の説明個所を次の表に示します。

表1‒2　開発環境で使用する画面の一覧

画面名

画面と構成要素（タブなど）の説明

説明個所

バイナリフォーマット定義画面

バイナリフォーマット定義ファイルを定義します。

バイナリフォーマット定義エディタ

バイナリフォーマット定義ファイルの内容を定義します。

アウトラインビュー

バイナリフォーマット定義エディタで定義した各要素の関係が表示されます。

1.2.1

サービスアダプタ定義画面

（Webサービスの場合）

SOAPアダプタの定義内容を表示または編集します。

「基本」タブに基本項目，「詳細」タブに詳細項目を表示します。

1.2.2(1)

サービスアダプタ定義画面

（SessionBeanの場合）

SessionBeanアダプタの定義内容を表示または編集します。

「基本」タブに基本項目，「詳細」タブに詳細項目を表示します。

1.2.2(2)

サービスアダプタ定義画面

（MDB（WS-R）の場合）

MDB（WS-R）アダプタの定義内容を表示または編集します。

「基本」タブに基本項目，「詳細」タブに詳細項目を表示します。

1.2.2(3)

サービスアダプタ定義画面

（MDB（DBキュー）の場合）

MDB（DBキュー）アダプタの定義内容を表示または編集します。

「基本」タブに基本項目を表示します。

1.2.2(4)

サービスアダプタ定義画面

（gRPCアダプタの場合）

gRPCアダプタの定義内容を表示または編集します。

「基本」タブに基本項目，「詳細」タブに詳細項目を表示します。

1.2.2(5)

サービスアダプタ定義画面（汎用カスタムアダプタの場合）

汎用カスタムアダプタの定義内容を表示または編集します。

「基本」タブに基本項目，「詳細」タブに詳細項目を表示します。

1.2.2(6)

サービスアダプタ定義画面

（その他のアダプタの場合）

次に示すアダプタの定義内容を表示または編集します。

DBアダプタ

TP1アダプタ

ファイルアダプタ

Object Accessアダプタ

Message Queueアダプタ

FTPアダプタ

ファイル操作アダプタ

メールアダプタ

コマンドアダプタ

HTTPアダプタ

SFTPアダプタ

Kafkaアダプタ

「基本」タブに基本項目，「詳細」タブに詳細項目を表示します。

1.2.2(7)

ビジネスプロセス定義画面

ビジネスプロセスをビジネスプロセスエディタで定義します。

1.2.3

データ変換定義画面

データ変換をマッピング定義エディタで定義します。

1.2.4

ユーザ定義受付定義画面

ユーザ定義受付の定義内容を表示または編集します。

「基本」タブに基本項目，「詳細」タブに詳細項目を表示します。

1.2.5

HCSCコンポーネント情報表示画面

HCSCサーバの構成およびHCSCコンポーネントの情報が表示されます。

1.2.6

ユーザ定義受付情報表示画面

ユーザ定義受付の情報が表示されます。

1.2.7

この章の画面や操作の説明で使用している記号を次に示します。

記号

意味

<　　>

<　>内の名称がユーザの環境によって異なることを表します。

「　　」

入力値，可変値，またはメッセージなどのユーザが入力する内容を表します。

注意事項

HCSCTEでは，複数のウィンドウからの同時操作はサポートされていません。Eclipseのメニューから［ウィンドウ］−［新規ウィンドウ］を選択して，新しいウィンドウを開かないでください。

ビジネスプロセス定義画面やサービスアダプタ定義画面などのオープンに失敗した場合，不正なエディタが開くことがあります。誤動作を避けるため，このエディタはすぐに閉じてください。

1.2.1　バイナリフォーマット定義画面

バイナリフォーマット定義ファイルの定義で使用する，バイナリフォーマット定義画面について説明します。

バイナリフォーマット定義ファイルの作成方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4.4　電文フォーマット（バイナリフォーマット定義ファイル）の作成方法」を参照してください。

図1‒13　バイナリフォーマット定義画面

バイナリフォーマット定義画面は，バイナリフォーマット定義エディタとアウトラインビューから構成されます。

それぞれの表示内容について，次に説明します。

(1)　バイナリフォーマット定義エディタ

要素を設定してバイナリフォーマット定義ファイルの内容を定義します。定義した内容はツリー形式で表示されます。

バイナリフォーマット定義エディタの表示内容について説明します。

図1‒14　バイナリフォーマット定義エディタ

バイナリフォーマット定義ファイル名

バイナリフォーマット定義ファイルの名称です。

バイナリフォーマット定義エディタは，複数のバイナリフォーマット定義ファイルを開いて編集できます。編集するバイナリフォーマット定義ファイルの名称をクリックすると，編集の対象がアクティブになります。また，アウトラインビューの表示も切り替わります。

フォーマット（[図データ]）

バイナリフォーマット定義ファイルのフォーマット名です。

ノード

バイナリフォーマット定義ファイル内に定義されている要素です。

フォーマットを基準に1つ目の階層はグローバル定義の要素です。2つ目の階層は複合内容要素の構成要素です。各ノードには，アイコンと要素名が表示されます。

なお，バイナリフォーマット定義エディタでノードを選択すると，アウトラインビューでも同じノードが選択状態になります。

各ノードの表示内容を次の表に示します。

表1‒3　バイナリフォーマット定義エディタに表示されるノード

区分

アイコン

説明

グローバル定義の要素

単純内容要素です。

逐次構成の複合内容要素です。

ルート要素に設定されている逐次構成の複合内容要素です。

選択構成の複合内容要素です。

ルート要素に設定されている選択構成の複合内容要素です。

複合内容要素の構成要素

構成要素として設定されている単純内容要素です。

構成要素として設定されている逐次構成の複合内容要素です。

構成要素として設定されている選択構成の複合内容要素です。

ローカル定義の単純内容要素です。

検証の結果として，警告またはエラーが発生しているノードには，上で示すアイコンに警告またはエラーの発生を示すアイコン（警告：[図データ]，エラー：[図データ]）が付与されて表示されます。

出現回数

ノードに出現回数が設定されている場合に，次の形式で表示されます。

[最小出現回数:最大出現回数]

構成要素を設定したときに，出現回数をどのように設定したかによって，出現回数の表示は異なります。出現回数の表示と設定内容の関係を次の表に示します。

表1‒4　出現回数の表示と設定内容の関係

表示形式

出現回数の指定方法

説明

[n:n]

固定

nは固定の出現回数です。

最小出現回数と最大出現回数に同じ値が表示されます。例えば，出現回数が3回で固定の場合，[3:3]と表示されます。

[n:*]

データの終端まで

データを省略できる場合

最小出現回数nが0になり，[0:*]と表示されます。

データを省略できない場合

最小出現回数nが1になり，[1:*]と表示されます。

[0:*]->

ノード指定

最小出現回数は0，最大出現回数は*で表示されます。また，ほかのノードを参照するノードであることを示す「->」が表示されます。

[n:m]

範囲指定

出現回数がn〜mの範囲であることを示しています。

依存関係

ほかのノードを参照しているノード（依存ノード）の場合，「->」が表示されます。ただし，参照されているノード（ターゲットノード）には何も表示されません。

なお，依存関係の詳細情報（パスなど）は，プロパティービューに表示されます。

(2)　アウトラインビュー

バイナリフォーマット定義エディタで定義した各要素の関係を確認できます。各要素の関係は，ルート要素を起点としたツリー形式で表現されます。

アウトラインビューの表示は，バイナリフォーマット定義エディタで要素を定義すると，自動的に更新されます。アウトラインビューでは要素を定義できません。

なお，アウトラインビューに表示されているノード（ルート要素および構成要素）を選択すると，バイナリフォーマット定義エディタでも同じノードが選択状態になります。

アウトラインビューの表示内容について説明します。

図1‒15　アウトラインビュー

ノード

バイナリフォーマット定義ファイル内に定義されている要素です。

各ノードの表示内容を次の表に示します。

表1‒5　アウトラインビューに表示されるノード

区分

アイコン

説明

ルート要素

ルート要素に設定されている逐次構成の複合内容要素です。

ルート要素に設定されている選択構成の複合内容要素です。

構成要素

構成要素として設定されている単純内容要素です。

構成要素として設定されている逐次構成の複合内容要素です。

構成要素として設定されている選択構成の複合内容要素です。

ローカル定義の単純内容要素です。

検証の結果として，警告またはエラーが発生しているノードには，上で示すアイコンに警告またはエラーの発生を示すアイコン（警告：[図データ]，エラー：[図データ]）が付与されて表示されます。

1.2.2　サービスアダプタ定義画面

サービスアダプタ定義画面でのサービスアダプタの定義について，サービス種別ごとに説明します。

画面の表示方法，および各サービスアダプタの定義方法については，マニュアル「サービスプラットフォーム 開発ガイド 受付・アダプタ定義編」の「3.3　サービスアダプタの内容の定義」を参照してください。

注意事項

サービスアダプタ定義画面では，入力項目の前後に半角スペースや全角スペースを指定できません。ただし，MDB（WS-R）アダプタの詳細画面の［転送キュー作成先RDエリア名］には，末尾に半角スペースを指定できます。

サービスアダプタ定義画面で［表示］ボタンをクリックして電文フォーマットを表示する際，サービスアダプタ定義画面の［電文フォーマット］に表示されているファイル名と異なるファイル名がテキストエディタ上部のタブに表示されることがあります。

(1)　サービス種別「Webサービス」の場合

サービス種別「Webサービス」で指定する，SOAPアダプタを定義する場合の画面について説明します。

(a)　Webサービスの基本画面

Webサービスの基本画面の項目について説明します。

図1‒16　サービスアダプタ定義画面（Webサービスの基本画面）

(i)［サービス部品制御情報］

サービスアダプタ新規作成時に指定したサービス部品についての情報が表示されます。

［サービス名］

HCSCコンポーネントの名称が表示されます。

［サービスID］

HCSCコンポーネントのIDが表示されます。サービスIDは，8バイト以内の英数字およびアンダーバー（_）で指定します。

［サービス種別］

サービス部品の種別として「Web サービス」が表示されます。

［アドレス］

サービス部品のあるURLが表示されます。

［最大インスタンス数］

サービス部品の最大インスタンス数が表示されます。

［サービスクラス名］

サービス部品のクラス名が表示されます。

［オペレーション］

オペレーション名が表示されます。サービス部品が持つオペレーション名をドロップダウンリストから選択できます。

［システム例外をフォルトに変換する］チェックボックス

サービス部品で発生した例外をフォルトに変換する場合にチェックします。

なお，サービスアダプタ内で発生した例外はフォルトに変換されません。

詳細については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「7.11　サービスアダプタでの例外発生時の運用」を参照してください。

(ii)［オペレーション情報］

サービス部品のオペレーションについての情報が表示されます。

［オペレーション名］

サービス部品制御情報のオペレーション欄で選択したオペレーションの名称が表示されます。

［通信モデル］

サービス部品制御情報のオペレーション欄で選択したオペレーションの通信モデルとして「同期」が表示されます。

(iii)［要求電文］

サービスリクエスタから送信される要求電文の情報が表示されます。

［ボディ］タブ

・［標準］

［使う］チェックボックス

サービスリクエスタから受け付けた標準電文の内容を確認したり，標準電文をサービス部品電文のフォーマットにデータ変換したりする場合にチェックします。

［電文フォーマット］

サービスリクエスタから受け付けた標準電文のフォーマット名が表示されます。電文フォーマットは変更できます。

［参照］ボタン

標準電文フォーマットを設定するダイアログが表示されます。

［表示］ボタン

標準電文のフォーマットが表示されます。

［出力］ボタン

標準電文フォーマットの出力先を指定するダイアログが表示されます。

・［サービス部品］

［電文フォーマット］

サービス部品の電文フォーマット名が表示されます。電文フォーマットは，サービス部品電文のオペレーションの要求電文に該当するWSDLから自動生成されます。変更はできません。

［参照］ボタン

このボタンは使用しません。

［表示］ボタン

サービス部品の電文フォーマットが表示されます。

［出力］ボタン

サービス部品の電文フォーマットの出力先を指定するダイアログが表示されます。

・データ変換

［データ変換定義］

標準電文からサービス部品電文へデータ変換するための定義ファイル名を入力します。

［編集］ボタン

データ変換定義画面が表示されます。データ変換定義欄で設定した定義ファイルの内容を編集できます。初めて定義する場合は，［ルート要素選択］ダイアログが表示されます。電文フォーマットを変更した場合は，電文フォーマットの変更を反映するかを確認するダイアログが表示されます。

［削除］ボタン

［編集］ボタンで設定したデータ変換定義を削除します。

［ヘッダ］タブ

・［ルート要素］

ルート要素が表示されます。ドロップダウンリストに表示されるルート要素の一覧は，ボタンで追加・削除できます。

［追加］ボタン

電文フォーマットを設定するダイアログが表示されます。電文フォーマットを設定したあと，その電文フォーマットに含まれるルート要素を追加できます。

［削除］ボタン

［ルート要素］に表示されているルート要素を削除します。削除するルート要素はドロップダウンリストから選択できます。

・［名前空間］

［ルート要素］に表示されているルート要素の名前空間が表示されます。

・［電文フォーマット］

［ルート要素］に表示されているルート要素を含んだ電文フォーマット名が表示されます。

［表示］ボタン

ルート要素を含んだ電文のフォーマットが表示されます。

［出力］ボタン

電文フォーマットの出力先を指定するダイアログが表示されます。

(iv)［応答電文］

サービス部品から送信される応答電文の情報が表示されます。

［ボディ］タブ

・［標準］

［使う］チェックボックス

サービス部品から受け付けたサービス部品電文の内容を確認したり，サービス部品電文を標準電文のフォーマットにデータ変換したりする場合にチェックします。

［電文フォーマット］

サービス部品から受け付けた標準電文のフォーマット名が表示されます。電文フォーマットは変更できます。

［参照］ボタン

標準電文フォーマットを設定するダイアログが表示されます。

［表示］ボタン

標準電文のフォーマットが表示されます。

［出力］ボタン

標準電文フォーマットの出力先を指定するダイアログが表示されます。

・［サービス部品］

［電文フォーマット］

サービス部品の電文フォーマット名が表示されます。電文フォーマットは，サービス部品電文のオペレーションの応答電文に該当するWSDLから自動生成されます。変更はできません。

［参照］ボタン

このボタンは使用しません。

［表示］ボタン

サービス部品電文のフォーマットが表示されます。

［出力］ボタン

サービス部品の電文フォーマットの出力先を指定するダイアログが表示されます。

・データ変換

［データ変換定義］

サービス部品電文から標準電文へデータ変換するための定義ファイル名を入力します。

［編集］ボタン

データ変換定義画面が表示されます。データ変換定義欄で設定した定義ファイルの内容を編集できます。初めて定義する場合は，［ルート要素選択］ダイアログが表示されます。電文フォーマットを変更した場合は，電文フォーマットの変更を反映するかを確認するダイアログが表示されます。

［削除］ボタン

［編集］ボタンで指定したデータ変換定義を削除します。

［ヘッダ］タブ

・［ルート要素］

ルート要素が表示されます。ドロップダウンリストに表示されるルート要素の一覧は，ボタンで追加・削除できます。

［追加］ボタン

電文フォーマットを設定するダイアログが表示されます。電文フォーマットを設定したあと，その電文フォーマットに含まれるルート要素を追加できます。

［削除］ボタン

［ルート要素］に表示されているルート要素を削除します。削除するルート要素はドロップダウンリストから選択できます。

・［名前空間］

［ルート要素］に表示されているルート要素の名前空間が表示されます。

・［電文フォーマット］

［ルート要素］に表示されているルート要素を含んだ電文フォーマット名が表示されます。

［表示］ボタン

ルート要素を含んだフォーマットが表示されます。

［出力］ボタン

電文フォーマットの出力先を指定するダイアログが表示されます。

(v)［フォルト電文］

サービス部品のフォルト電文についての情報が表示されます。

［フォルト名］

サービス部品のフォルトの名称が表示されます。

［電文フォーマット］

サービス部品のフォルト電文のフォーマット名が表示されます。

［参照］ボタン

このボタンは使用しません。

［表示］ボタン

フォルト電文のフォーマットが表示されます。

［出力］ボタン

フォルト電文のフォーマットの出力先を指定するダイアログが表示されます。

(b)　Webサービスの詳細画面

Webサービスの詳細画面の項目について説明します。

図1‒17　サービスアダプタ定義画面（Webサービスの詳細画面）

(i)［Webサービス制御情報］

サービスアダプタ新規作成時に指定したサービス部品について，サービス種別ごとの情報が表示されます。

・クライアント定義ファイル

［クライアント定義ファイル］

［参照］ボタンで設定したクライアント定義ファイル名が表示されます。

［参照］ボタン

クライアント定義ファイルを設定するダイアログが表示されます。

［編集］ボタン

クライアント定義ファイルを編集するためのエディタが起動します。エディタ上でクライアント定義ファイルを保存したあと，サービスアダプタを保存することで，編集した内容がリポジトリに反映されます。

クライアント定義ファイルの編集中にサービスアダプタを保存しようとすると，クライアント定義ファイルを保存してよいか確認するダイアログが表示されます。

［出力］ボタン

クライアント定義ファイルの出力先を指定するダイアログが表示されます。

・ベーシック認証

［ベーシック認証］

［使う］チェックボックス

サービス部品で，ベーシック認証を使用している場合にチェックします。

［ユーザ名］

半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」※），および半角スペース（ASCIIコードの「0x20」）を入力します。バイト長の制限はありません。

注※

SOAP1.1モードの場合，#（ハッシュマーク），:（コロン），?（クエスチョン），@（アットマーク），/（スラッシュ）は使用できません。SOAP1.1/1.2併用モードの場合，:（コロン），/（スラッシュ）は使用できません。

［パスワード］

40バイト以内の半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」※），および半角スペース（ASCIIコードの「0x20」）を入力します。

注※

SOAP1.1モードの場合，#（ハッシュマーク），:（コロン），?（クエスチョン），@（アットマーク），/（スラッシュ）は使用できません。SOAP1.1/1.2併用モードの場合，:（コロン），/（スラッシュ）は使用できません。

［パスワード（確認）］

パスワード欄で入力したパスワードを再度入力します。

(2)　サービス種別「SessionBean」の場合

サービス種別「SessionBean」に対応するサービスアダプタを定義する場合の画面について説明します。

(a)　SessionBeanの基本画面

SessionBeanの基本画面の項目について説明します。

図1‒18　サービスアダプタ定義画面（SessionBeanの基本画面）

(i)［サービス部品制御情報］

サービスアダプタ新規作成時に指定したサービス部品についての情報が表示されます。

［サービス種別］

サービス部品の種別として「SessionBean」が表示されます。

［アドレス］

JNDI名前空間に登録されている，呼び出すサービス部品の名称を入力します。

リモート呼び出しとなるようにアドレスを指定します（ローカル呼び出しはできません）。

SessionBeanの場合は，フォルト電文の情報は表示されません。

上記以外の各項目は，Webサービスの基本画面と同様です。Webサービスの基本画面の項目については，「1.2.2(1)(a)　Webサービスの基本画面」を参照してください。

(b)　SessionBeanの詳細画面

SessionBeanの詳細画面の項目について説明します。

図1‒19　サービスアダプタ定義画面（SessionBeanの詳細画面）

(i)［SessionBean制御情報］

サービスアダプタ新規作成時に指定したサービス部品について，サービス種別ごとの情報が表示されます。

・クライアント定義ファイル

［クライアント定義ファイル］

クライアント定義ファイル名が表示されます。

［参照］ボタン

クライアント定義ファイルを設定するダイアログが表示されます。

［編集］ボタン

クライアント定義ファイルを編集するためのエディタが起動します。エディタ上でクライアント定義ファイルを保存したあと，サービスアダプタを保存することで，編集した内容がリポジトリに反映されます。

クライアント定義ファイルの編集中にサービスアダプタを保存しようとすると，クライアント定義ファイルを保存してよいか確認するダイアログが表示されます。

［出力］ボタン

クライアント定義ファイルの出力先を指定するダイアログが表示されます。

・ユーザ定義クラス

［ユーザ定義クラス（JARファイル）］

［追加］ボタンで設定したユーザ定義クラス（JARファイル）名が表示されます。

［追加］ボタン

ユーザ定義クラス（JARファイル）を設定するダイアログが表示されます。選択するJARファイルの拡張子は，すべて小文字の「jar」としてください。

［出力］ボタン

ユーザ定義クラス（JARファイル）の出力先を指定するダイアログが表示されます。

［削除］ボタン

ユーザ定義クラス欄で選択したJARファイルを削除します。

(3)　サービス種別「MDB（WS-R）」の場合

サービス種別「MDB（WS-R）」に対応するサービスアダプタを定義する場合の画面について説明します。

(a)　MDB（WS-R）の基本画面

MDB（WS-R）の基本画面の項目について説明します。

図1‒20　サービスアダプタ定義画面（MDB（WS-R）の基本画面）

(i)［サービス部品制御情報］

サービスアダプタ新規作成時に指定したサービス部品についての情報が表示されます。

［サービス種別］

サービス部品の種別として「MDB/WS-R」が表示されます。

［アドレス］

サービス部品に関連づけられているキュー名を入力します。

［サービスクラス名］

この項目は使用しません。

(ii)［オペレーション情報］

サービス部品のオペレーションについての情報が表示されます。

［通信モデル］

サービス部品制御情報のオペレーション欄で選択したオペレーションの通信モデルとして「非同期」が表示されます。

(iii)［要求電文］

・［サービス部品］

［電文フォーマット］

サービス部品電文のフォーマット名を入力します。電文フォーマットは変更できます。

［参照］ボタン

サービス部品電文フォーマットを設定するダイアログが表示されます。

MDB（WS-R）の場合は，応答電文，およびフォルト電文の情報は表示されません。

上記以外の項目は，Webサービスの基本画面と同様です。Webサービスの基本画面の項目については，「1.2.2(1)(a)　Webサービスの基本画面」を参照してください。

(b)　MDB（WS-R）の詳細画面

MDB（WS-R）の詳細画面の項目について説明します。

図1‒21　サービスアダプタ定義画面（MDB（WS-R）の詳細画面）

(i)［MDB制御情報］

サービスアダプタ新規作成時に指定したサービス部品について，サービス種別ごとの情報が表示されます。

［JMSメッセージ種別］

サービス部品のJMSメッセージ種別が表示されます。次に示すメッセージ種別をドロップダウンリストから選択します。

テキスト

バイト

オブジェクト

・［呼出し設定］

［リモート呼出し］ラジオボタン

サービス部品をリモート呼出しする場合に選択します。選択すると，リモート呼出し設定の各項目が活性化し，入力できる状態になります。

［ローカル呼出し］ラジオボタン

サービス部品をローカル呼出しする場合に選択します。選択すると，リモート呼出し設定の各項目が非活性化し，入力できない状態になります。

・［リモート呼出し設定］

［最大メッセージ数］

サービス部品が送信できる電文の最大数を設定します。設定できる値は1〜65535です。

［宛先URL］

非同期時の応答結果の受信先URLを設定します。

・［ベーシック認証］

［使う］チェックボックス

サービス部品で，ベーシック認証を使用している場合にチェックします。

［ユーザ名］

英数字および記号を半角で入力します。バイト長の制限はありません。

［パスワード］

40バイト以内の英数字および記号を半角で入力します。

［パスワード（確認）］

パスワード欄で入力したパスワードを再度入力します。

［転送キュー作成先RDエリア名］

転送キューの作成先RDエリア名を指定します。なお，この項目の末尾には半角スペースを指定できます。

［順序保証］チェックボックス

Reliable Messagingで転送の順序を保証する場合にチェックします。

(4)　サービス種別「MDB（DBキュー）」の場合

サービス種別「MDB（DBキュー）」に対応するサービスアダプタを定義する場合の画面について説明します。

(a)　MDB（DBキュー）の基本画面

MDB（DBキュー）の基本画面の項目について説明します。

図1‒22　サービスアダプタ定義画面（MDB（DBキュー）の基本画面）

(i)［サービス部品制御情報］

サービスアダプタ新規作成時に指定したサービス部品についての情報が表示されます。

［サービス種別］

サービス部品の種別として「MDB/DB キュー」が表示されます。

上記以外の項目は，MDB（WS-R）の基本画面と同様です。MDB（WS-R）の基本画面の項目については，「1.2.2(3)(a)　MDB（WS-R）の基本画面」を参照してください。

なお，MDB（DBキュー）には，詳細画面はありません。

(5)　サービス種別「gRPCアダプタ」の場合

サービス種別「gRPCアダプタ」に対応するサービスアダプタを定義する場合の画面について説明します。

(a)　gRPCアダプタの基本画面

gRPCアダプタの基本画面の項目について説明します。

図1‒23　サービスアダプタ定義画面（gRPCアダプタの基本画面）

(i)［サービス部品制御情報］

サービスアダプタ新規作成時に指定したサービス部品についての情報が表示されます。

［サービス名］

HCSCコンポーネントの名称が表示されます。変更することもできます。

［サービスID］

HCSCコンポーネントのIDが表示されます。

変更する場合は，8バイト以内の英数字およびアンダーバー（_）で指定します。

［サービス種別］

サービス部品の種別として「gRPCアダプタ」が表示されます。

［最大インスタンス数］

サービス部品の最大インスタンス数が表示されます。変更することもできます。

［gRPC Service名］

gRPC Service名が表示されます。

［オペレーション（RPCメソッド）］

オペレーション（RPCメソッド）が表示されます。

［システム例外をフォルトに変換する］チェックボックス

サービス部品で発生した例外をフォルトに変換する場合にチェックします。

なお，サービスアダプタ内で発生した例外はフォルトに変換されません。

詳細については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「7.11　サービスアダプタでの例外発生時の運用」を参照してください。

(ii)［オペレーション情報］

サービス部品のオペレーションについての情報が表示されます。

［オペレーション名（RPCメソッド名）］

オペレーション名（RPCメソッド名）が表示されます。

［通信モデル］

オペレーションの通信モデルとして「同期」が表示されます。

(iii)［要求電文］

サービスリクエスタから送信される要求電文の情報が表示されます。

［電文フォーマット］

電文フォーマット名が表示されます。

［表示］ボタン

電文フォーマットが表示されます。

［出力］ボタン

電文フォーマットの出力先を指定するダイアログが表示されます。

(iv)［応答電文］

サービス部品から送信される応答電文の情報が表示されます。

［電文フォーマット］

電文フォーマット名が表示されます。

［表示］ボタン

電文フォーマットが表示されます。

［出力］ボタン

電文フォーマットの出力先を指定するダイアログが表示されます。

(v)［フォルト電文］

サービス部品のフォルト電文についての情報が表示されます。

［フォルト名］

サービス部品のフォルトの名称が表示されます。

［電文フォーマット］

サービス部品のフォルト電文のフォーマット名が表示されます。

［参照］ボタン

フォルト電文フォーマットのファイルを設定するダイアログが表示されます。フォルト電文フォーマットの内容を修正して再登録する際に使用します。それ以外のファイルを指定した場合は動作を保証しません。

［表示］ボタン

フォルト電文のフォーマットが表示されます。

［出力］ボタン

フォルト電文のフォーマットの出力先を指定するダイアログが表示されます。

(b)　gRPCアダプタの詳細画面

gRPCアダプタの詳細画面の項目について説明します。

図1‒24　サービスアダプタ定義画面（gRPCアダプタ詳細画面）

(i)［サービスアダプタ制御情報］

サービスアダプタ新規作成時に指定したサービス部品について，サービス種別ごとの情報が表示されます。

・独自定義ファイル

［独自定義ファイル］

［追加］ボタンで設定した独自定義ファイル（gRPCアダプタ独自定義ファイル）のファイル名が表示されます。

［追加］ボタン

独自定義ファイル（gRPCアダプタ独自定義ファイル）を追加するダイアログが表示されます。

［編集］ボタン

選択した独自定義ファイルを編集するためのエディタが起動します。

独自定義ファイルを複数選択してクリックした場合は，選択されたすべての独自定義ファイルに対してエディタが起動します。

エディタ上で独自定義ファイルを保存したあと，サービスアダプタを保存することで，編集した内容がリポジトリに反映されます。独自定義ファイルの編集中にサービスアダプタを保存しようとすると，独自定義ファイルを保存してよいか確認するダイアログが表示されます。

［出力］ボタン

独自定義ファイル（gRPCアダプタ独自定義ファイル）の出力先を指定するダイアログが表示されます。

［削除］ボタン

選択したファイルを削除します。

・protoファイル

［protoファイル］

protoファイルをZIP形式で圧縮したファイルの名称「proto.zip」が表示されます。

［出力］ボタン

ファイル「proto.zip」の出力先を指定するダイアログが表示されます。

proto.zipの内容については，マニュアル「サービスプラットフォーム 解説」の「2.13.1　gRPCプロトコルを利用したシステム」を参照してください。

(6)　サービス種別「汎用カスタムアダプタ」の場合

汎用カスタムアダプタを定義する場合の画面について説明します。

(a)　汎用カスタムアダプタの基本画面

汎用カスタムアダプタの基本画面の項目について説明します。

図1‒25　サービスアダプタ定義画面（汎用カスタムアダプタの基本画面）

(i)［サービス部品制御情報］

汎用カスタムアダプタの新規作成時に指定したサービス部品についての情報が表示されます。

［サービス名］

HCSCコンポーネントの名称が表示されます。

［サービスID］

HCSCコンポーネントのIDが表示されます。サービスIDは，8バイト以内の英数字およびアンダーバー（_）で指定します。

［サービス種別］

サービス部品の種別として「汎用カスタムアダプタ」が表示されます。

［アドレス］

この項目は使用しません。

［最大インスタンス数］

サービス部品の最大インスタンス数が表示されます。

［サービスクラス名］

この項目は使用しません。

［オペレーション］

オペレーション名が表示されます。サービス部品が持つオペレーション名をドロップダウンリストから選択できます。

［追加］ボタン

オペレーションを追加するダイアログが表示されます。

［削除］ボタン

オペレーション欄で選択したオペレーションを削除します。

［システム例外をフォルトに変換する］チェックボックス

サービス部品で発生した例外をフォルトに変換する場合にチェックします。

なお，サービスアダプタ内で発生した例外はフォルトに変換されません。

詳細については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「7.11　サービスアダプタでの例外発生時の運用」を参照してください。

(ii)［オペレーション情報］

サービス部品のオペレーションについての情報が表示されます。

［オペレーション名］

サービス部品制御情報のオペレーション欄で選択したオペレーションの名称が表示されます。

［通信モデル］

サービス部品制御情報のオペレーション欄で選択したオペレーションの通信モデルが表示されます。同期または非同期をドロップダウンリストから選択できます。選択内容によって，次のように表示が変わります。

同期を選択した場合：応答電文とフォルト電文の情報が表示されます。

非同期を選択した場合：応答電文とフォルト電文の情報は表示されません。非同期のままサービスアダプタの定義を保存すると，応答電文とフォルト電文の全項目は消えます。

(iii)［要求電文］

サービスリクエスタから送信される要求電文の情報が表示されます。

［any型を使う］チェックボックス

データの型を指定しないでサービスアダプタを作成する場合にチェックします。

・［標準］

［使う］チェックボックス

サービスリクエスタから受け付けた標準電文の内容を確認したり，標準電文を汎用カスタムアダプタ電文のフォーマットにデータ変換したりする場合にチェックします。

［電文フォーマット］

サービスリクエスタから受け付けた標準電文のフォーマット名が表示されます。電文フォーマットは変更できます。

［参照］ボタン

標準電文フォーマットを設定するダイアログが表示されます。

［表示］ボタン

標準電文のフォーマットが表示されます。

［出力］ボタン

標準電文フォーマットの出力先を指定するダイアログが表示されます。

・［サービス部品］

［電文フォーマット］

汎用カスタムアダプタ電文のフォーマット名を入力します。電文フォーマットは変更できます。

［参照］ボタン

汎用カスタムアダプタ電文のフォーマットファイルを設定するダイアログが表示されます。

［表示］ボタン

汎用カスタムアダプタ電文のフォーマットが表示されます。

［出力］ボタン

汎用カスタムアダプタ電文のフォーマットの出力先を指定するダイアログが表示されます。

・データ変換

［データ変換定義］

標準電文から汎用カスタムアダプタ電文へデータ変換するための定義ファイル名を入力します。

［編集］ボタン

データ変換定義画面が表示されます。データ変換定義欄で設定した定義ファイルの内容を編集できます。初めて定義する場合は，［ルート要素選択］ダイアログが表示されます。電文フォーマットを変更した場合は，電文フォーマットの変更を反映するかを確認するダイアログが表示されます。

［削除］ボタン

［編集］ボタンで設定したデータ変換定義を削除します。

(iv)［応答電文］

サービス部品から送信される応答電文の情報が表示されます。

オペレーション情報の通信モデル欄で「同期」を選択した場合だけ，設定できます。

［any型を使う］チェックボックス

データの型を指定しないでサービスアダプタを作成する場合にチェックします。

・［標準］

［使う］チェックボックス

サービス部品から受け付けた汎用カスタムアダプタ電文の内容を確認したり，汎用カスタムアダプタ電文を標準電文のフォーマットにデータ変換したりする場合にチェックします。

［電文フォーマット］

サービス部品から受け付けた標準電文のフォーマット名が表示されます。電文フォーマットは変更できます。

［参照］ボタン

標準電文フォーマットを設定するダイアログが表示されます。

［表示］ボタン

標準電文フォーマットが表示されます。

［出力］ボタン

標準電文フォーマットの出力先を指定するダイアログが表示されます。

・［サービス部品］

［電文フォーマット］

サービス部品の電文フォーマット名が表示されます。電文フォーマットは変更できます。

［参照］ボタン

汎用カスタムアダプタ電文のフォーマットファイルを設定するダイアログが表示されます。

［表示］ボタン

汎用カスタムアダプタのフォーマットが表示されます。

［出力］ボタン

汎用カスタムアダプタのフォーマットの出力先を指定するダイアログが表示されます。

・データ変換

［データ変換定義］

汎用カスタムアダプタ電文から標準電文へデータ変換するための定義ファイル名を入力します。

［編集］ボタン

データ変換定義画面が表示されます。データ変換定義欄で設定した定義ファイルの内容を編集できます。初めて定義する場合は，［ルート要素選択］ダイアログが表示されます。電文フォーマットを変更した場合は，電文フォーマットの変更を反映するかを確認するダイアログが表示されます。

［削除］ボタン

［編集］ボタンで指定したデータ変換定義を削除します。

(v)［フォルト電文］

サービス部品のフォルト電文についての情報が表示されます。

［追加］ボタン

フォルト名を追加するダイアログが表示されます。汎用カスタムアダプタの定義では，このボタンは使用しません。

［削除］ボタン

フォルト名欄で選択したフォルト名を削除します。汎用カスタムアダプタの定義では，このボタンは使用しません。

［フォルト名］

サービス部品のフォルトの名称が表示されます。汎用カスタムアダプタの定義では，この欄は使用しません。

［電文フォーマット］

サービス部品のフォルト電文のフォーマット名が表示されます。汎用カスタムアダプタの定義では，この欄は使用しません。

［参照］ボタン

フォルト電文のフォーマットを設定するダイアログが表示されます。汎用カスタムアダプタの定義では，このボタンは使用しません。

［表示］ボタン

フォルト電文のフォーマットが表示されます。汎用カスタムアダプタの定義では，このボタンは使用しません。

［出力］ボタン

フォルト電文のフォーマットの出力先を指定するダイアログが表示されます。

(b)　汎用カスタムアダプタの詳細画面

汎用カスタムアダプタの詳細画面の項目について説明します。

図1‒26　サービスアダプタ定義画面（汎用カスタムアダプタの詳細画面）

(i)［サービスアダプタ制御情報］

汎用カスタムアダプタの新規作成時に指定したサービス部品についての情報が表示されます。

・サービスアダプタ

［サービスアダプタ（EJB-JARファイル）］

［参照］ボタンで設定した汎用カスタムアダプタのEJB-JARファイルの名称が表示されます。

［参照］ボタン

汎用カスタムアダプタのEARファイル名を設定するダイアログが表示されます。

・ユーティリティクラス

［ユーティリティクラス（JARファイル）］

［追加］ボタンで設定したユーティリティクラスが表示されます。汎用カスタムアダプタの定義では，この欄は使用しません。

［追加］ボタン

ユーティリティクラスを追加するダイアログが表示されます。汎用カスタムアダプタの定義では，このボタンは使用しません。

［出力］ボタン

ユーティリティクラスの出力先を指定するダイアログが表示されます。汎用カスタムアダプタの定義では，このボタンは使用しません。

［削除］ボタン

ユーティリティクラス欄で選択したファイルを削除します。汎用カスタムアダプタの定義では，このボタンは使用しません。

・独自定義ファイル

［独自定義ファイル］

［追加］ボタンで設定したSQLオペレーション定義ファイル，およびアプリケーション統合属性ファイルが表示されます。

［追加］ボタン

独自定義ファイル（SQLオペレーション定義ファイルおよびアプリケーション統合属性ファイル）を追加するダイアログが表示されます。

［編集］ボタン

選択した独自定義ファイルを編集するためのエディタが起動します。

独自定義ファイルを複数選択してクリックした場合は，選択されたすべての独自定義ファイルに対してエディタが起動します。

エディタ上で独自定義ファイルを保存したあと，サービスアダプタを保存することで，編集した内容がリポジトリに反映されます。独自定義ファイルの編集中にサービスアダプタを保存しようとすると，独自定義ファイルを保存してよいか確認するダイアログが表示されます。

［出力］ボタン

独自定義ファイル（SQLオペレーション定義ファイルおよびアプリケーション統合属性ファイル）の出力先を指定するダイアログが表示されます。

［削除］ボタン

選択したファイルを削除します。

(7)　その他のサービスアダプタの場合

次に示すサービスアダプタを定義する場合の画面について説明します。

DBアダプタ

TP1アダプタ

ファイルアダプタ

Object Accessアダプタ

Message Queueアダプタ

FTPアダプタ

ファイル操作アダプタ

メールアダプタ

HTTPアダプタ

コマンドアダプタ

SFTPアダプタ

Kafkaアダプタ

(a)　その他のサービスアダプタの基本画面

基本画面は汎用カスタムアダプタの基本画面と同じですが，画面項目の表示内容が一部異なります。汎用カスタムアダプタの基本画面の項目については，「1.2.2(6)(a)　汎用カスタムアダプタの基本画面」を参照してください。

汎用カスタムアダプタの基本画面と差異がある項目について，次に説明します。

(i)［サービス部品制御情報］

［サービス種別］

サービス部品の種別として，次の中から該当するサービス種別が表示されます。

DBアダプタ

TP1アダプタ

ファイルアダプタ

Object Accessアダプタ

Message Queueアダプタ

FTPアダプタ

ファイル操作アダプタ

メールアダプタ

HTTPアダプタ

コマンドアダプタ

SFTPアダプタ

Kafkaアダプタ

(b)　その他のサービスアダプタの詳細画面

詳細画面の各項目は，汎用カスタムアダプタの詳細画面と同様です。汎用カスタムアダプタの詳細画面の項目については，「1.2.2(6)(b)　汎用カスタムアダプタの詳細画面」を参照してください。

1.2.3　ビジネスプロセス定義画面

ビジネスプロセスの定義に使用するビジネスプロセス定義画面について説明します。

操作方法については，「1.12　ビジネスプロセス定義画面の操作」を参照してください。

図1‒27　ビジネスプロセス定義画面

(1)　パレット

キャンバスに配置するアクティビティ，コネクションまたはコメントをパレットのツールから選択します。

パレットの各項目について説明します。

図1‒28　パレット（ビジネスプロセス定義画面）

グループ

コネクションまたは同じ種類のアクティビティをまとめたグループです。先頭に[図データ]が付いています。

ツール

グループの下位にあるアクティビティ，コネクションおよびコメントです。

選択したアクティビティは，キャンバスを任意の個所でクリックすると配置されます。ドラッグ＆ドロップでキャンバスに配置することもできます。

また，コネクションを選択し，キャンバスに配置したアクティビティを二つ選択すると，アクティビティ同士を連結できます。

パレットのグループおよびツールの一覧を次の表に示します。

表1‒6　パレットのグループおよびツール（ビジネスプロセス定義画面）

アイコン

表示名

説明

選択

キャンバス上のアクティビティおよびコネクションを選択します。

コネクション

通常のコネクション，リンクコネクション，およびフォルトコネクションをまとめたグループです。

コネクション

通常のアクティビティを連結するコネクションです。

リンク

リンクコネクションです。リンクを定義する場合にアクティビティを連結します。

フォルト

フォルトコネクションです。フォルト処理を定義する場合にアクティビティを連結します。

補償

補償コネクションです。補償処理を定義する場合にアクティビティを連結します。

基本アクティビティ

ビジネスプロセスで基本的な定義（受付処理，応答処理，サービス部品の呼び出しなど）をするアクティビティをまとめたグループです。

受付

受付アクティビティです。

応答

応答アクティビティです。

サービス呼出

サービス呼出アクティビティです。

Java呼出

Java呼出アクティビティです。

データ変換

データ変換アクティビティです。

代入

代入アクティビティです。

無操作

無操作アクティビティです。

フォルト送出

フォルト送出アクティビティです。

補償

補償アクティビティです。

待機

待機アクティビティです。

検証

検証アクティビティです。

ログ出力

ログ出力アクティビティです。

途中終了

途中終了アクティビティです。

構造アクティビティ

ビジネスプロセスで分岐処理，並列処理，繰り返し処理などを使って構造的な定義をするアクティビティをまとめたグループです。

スコープ

スコープアクティビティです。

繰り返し

繰り返しアクティビティです。

分岐開始

分岐開始アクティビティです。

分岐終了

分岐終了アクティビティです。

並列処理開始

並列処理開始アクティビティです。

並列処理終了

並列処理終了アクティビティです。

ユーティリティ

ユーティリティのグループです。

コメント

コメントを作成します。

(2)　キャンバス

キャンバスには，パレットで選択したアクティビティを配置します。また，配置したアクティビティをコネクションで連結します。

参考

オートコネクト機能が有効の場合，キャンバス上で配置または移動しようとするアクティビティがほかのアクティビティに近づくと，アクティビティとのコネクションがプレビュー表示されます。その状態でアクティビティを配置すると，コネクションが確定し，アクティビティ同士が連結されます。オートコネクト機能については，「1.12.16　アクティビティのオートコネクト機能の有効・無効を設定する」を参照してください。

図1‒29　キャンバス

キャンバスには，変数・相関セット，ビジネスプロセスの開始を示す開始アクティビティ，およびビジネスプロセスの終了を示す終了アクティビティがすでに配置されています。

変数・相関セット（[図データ]）

変数・相関セットを定義する場合に使用します。クリックすると，［変数・相関セット一覧］ダイアログが表示されます。

開始（[図データ]）

開始アクティビティです。このアクティビティは削除できません。

終了（[図データ]）

終了アクティビティです。このアクティビティは削除できません。

(3)　タブ

次に示すアクティビティのタブでは，開いているタブを閉じたり，上位階層のタブを開いたりといった操作ができます。

スコープアクティビティ

繰り返しアクティビティ

データ変換アクティビティ

(a)　開いているタブを閉じる

開いているタブを閉じる方法には，次の3とおりがあります。

スコープアクティビティ，繰り返しアクティビティの場合，キャンバスで項目が選択されていない状態で右クリックし，コンテキストメニューで［タブを閉じる］を選択する

閉じる対象のタブを右クリックし，コンテキストメニューで［タブを閉じる］を選択する

閉じる対象のタブを中クリックする

なお，データ変換アクティビティで編集中のタブを閉じようとすると，変更内容を破棄してよいかを問い合わせるメッセージが表示されます。変更内容を破棄してよい場合は［はい］ボタンを選択してください。

(b)　上位階層のタブを開く

アクティビティの上位階層のタブを開く方法には，次の2とおりがあります。

スコープアクティビティ，繰り返しアクティビティの場合，キャンバスで項目が選択されていない状態で右クリックし，コンテキストメニューで［定義キャンバスのタブを開く］を選択する

閉じる対象のタブを右クリックし，コンテキストメニューで［定義キャンバスのタブを開く］を選択する

操作後は，開いたタブがアクティブになります。

(4)　アウトラインビュー

ビジネスプロセスで定義した変数，アクティビティの一覧が表示されます。アウトラインビューの表示は，ビジネスプロセスを定義すると，自動的に更新されます。

アウトラインビューに表示されている変数をダブルクリックすると，［変数・相関セット一覧］ダイアログが表示され，［変数・相関セット一覧］ダイアログでも同じ項目が選択状態になります。また，アウトラインビューに表示されているアクティビティを選択すると，ビジネスプロセス定義画面でも同じ項目が選択状態になります。

アウトラインビューの表示項目は，アウトラインビューの上部にあるテキストボックスに表示項目の名称を入力することでフィルタリングできます。また，フィルタ機能として変数一覧フィルタ，アクティビティ一覧フィルタがあります。変数一覧フィルタ，アクティビティ一覧フィルタについては，「1.14　アウトラインビューのフィルタ機能の設定」を参照してください。

アウトラインビューの表示内容について説明します。

図1‒30　アウトラインビュー（ビジネスプロセス定義画面）

グループ

変数またはアクティビティをまとめたグループです。

変数・アクティビティ

ビジネスプロセスで定義した変数，アクティビティです。

アウトラインビューに表示されるグループおよび変数・アクティビティの一覧を次の表に示します。

表1‒7　アウトラインビューのグループおよび変数・アクティビティ（ビジネスプロセス定義画面）

アイコン

表示名

説明

変数一覧

変数をまとめたグループです。

<変数の名称>

変数です。

アクティビティ一覧

アクティビティをまとめたグループです。

<受付アクティビティの名称>

受付アクティビティです。

<応答アクティビティの名称>

応答アクティビティです。

<サービス呼出アクティビティの名称>

サービス呼出アクティビティです。

<Java呼出アクティビティの名称>

Java呼出アクティビティです。

<データ変換アクティビティの名称>

データ変換アクティビティです。

<代入アクティビティの名称>

代入アクティビティです。

<無操作アクティビティの名称>

無操作アクティビティです。

<フォルト送出アクティビティの名称>

フォルト送出アクティビティです。

<補償アクティビティの名称>

補償アクティビティです。

<待機アクティビティの名称>

待機アクティビティです。

<検証アクティビティの名称>

検証アクティビティです。

<ログ出力アクティビティの名称>

ログ出力アクティビティです。

<途中終了アクティビティの名称>

途中終了アクティビティです。

<スコープアクティビティの名称>

スコープアクティビティです。スコープアクティビティ内で定義した変数，アクティビティはスコープアクティビティを起点としたツリー形式で表示されます。

<繰り返しアクティビティの名称>

繰り返しアクティビティです。繰り返しアクティビティ内で定義したアクティビティは繰り返しアクティビティを起点としたツリー形式で表示されます。

<分岐開始アクティビティの名称>

分岐開始アクティビティです。

<分岐終了アクティビティの名称>

分岐終了アクティビティです。

<並列処理開始アクティビティの名称>

並列処理開始アクティビティです。

<並列処理終アクティビティの名称>

並列処理終了アクティビティです。

<コメントの1行目の内容>

コメントです。

1.2.4　データ変換定義画面

マッピング定義エディタではデータ変換を定義します。

操作方法については，「1.13　データ変換定義画面の操作」を参照してください。

図1‒31　データ変換定義画面

(1)　変換元スキーマツリービューア，マッピングビューア，および変換先スキーマツリービューア

変換元スキーマツリービューアのノードから変換先スキーマツリービューアのノードへマッピングします。マッピングビューアでは，パレットから選択したファンクションを配置したり，ノードアダプタやファンクションをマッピング線で接続したりします。

変換元スキーマツリービューア，マッピングビューア，および変換先スキーマツリービューアの各項目について説明します。

図1‒32　変換元スキーマツリービューア，マッピングビューア，および変換先スキーマツリービューア

ノード

XMLスキーマのスキーマ論理名，要素，および属性です。

ノードに表示されるアイコンおよびアイコンの意味を次に示します。

スキーマ論理名（[図データ]）

XMLスキーマファイルを識別する論理名を表します。

複合内容（[図データ]）

複合内容を持つ複合型の要素を表します。

単純内容（[図データ]）

単純型の要素，および単純内容を持つ複合型の要素を表します。

属性（[図データ]）

要素の属性を表します。

ノードの最後に表示される角括弧（[　]）の値は，ノードの出現回数を示します。出現回数は次の形式で表示されます。

[最小出現回数：最大出現回数]

最大出現回数に上限がない場合，アスタリスク（*）が表示されます。

最小出現回数，最大出現回数がともに1回の場合，出現回数は表示されません。

コピーしたい要素を選択して右クリックし，コンテキストメニューで［要素パスのコピー］を選択すると，パスがクリップボードへコピーできます。N対1変換時は，「$<スキーマの論理名（ビジネスプロセスの変数名）>」を含むパスがコピーされます。

ノード対応線

ノードとノードアダプタの対応を示す線です。

ノードアダプタ

ノードアダプタはすべてのノードに対して表示されます。変換元のノードアダプタと変換先のノードアダプタをマッピング線で接続して，マッピングします。ノードアダプタには，マッピング対象のノードアダプタ（[図データ]）とマッピング対象外のノードアダプタ（[図データ]）の2種類があります。マッピング対象およびマッピング対象外については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.11　マッピングの条件」を参照してください。

なお，ノードアダプタは，マッピングビューアに表示されるスクロールバーではスクロールできません。変換先スキーマツリービューアに表示されるスクロールバーを動かすことでスクロールできます。

(2)　パレット

マッピングビューアに配置するファンクションをパレットのツールから選択します。また，マッピング線を選択して，ノードアダプタやファンクションを接続します。

パレットの各項目について説明します。

図1‒33　パレット（データ変換定義画面）

グループ

同じ種類のファンクションをまとめたグループです。先頭に[図データ]が付いています。クリックすると，グループ下のツール一覧が非表示になります。ツール一覧が非表示の場合は，ツールの一覧が表示されます。

ツール

ファンクションやマッピング線などです。選択したファンクションをマッピングビューアに配置したり，ノードアダプタやファンクションをマッピング線で接続したりします。

パレットのグループおよびツールの一覧を次の表に示します。

表1‒8　パレットのグループおよびツール（データ変換定義画面）

アイコン

表示名

説明

選択

マッピングビューア上のファンクションおよびマッピング線を選択します。

囲み枠

四角で囲んだ範囲に含まれるファンクションおよびマッピング線を選択します。

マッピング

ノードやファンクションを接続するマッピング線です。

文字列

文字列に関するファンクションをまとめたグループです。

concat

文字列連結ファンクションです。

substr

部分文字列取得ファンクションです。

length

文字数取得ファンクションです。

contain

文字列調査ファンクションです。

trim

空白除去ファンクションです。

数値

数値に関するファンクションをまとめたグループです。

format

数値フォーマット変換ファンクションです。

calc

数値演算ファンクションです。

round

端数処理ファンクションです。

sum

総和ファンクションです。

ビット

ビット演算に関するファンクションをまとめたグループです。

not

否定演算ファンクションです。

bitop

論理演算ファンクションです。

shift

シフト演算ファンクションです。

ノード

ノードに関するファンクションをまとめたグループです。

name

ノード名取得ファンクションです。

count

ノード数取得ファンクションです。

exist

ノード調査ファンクションです。

制御

マッピングを制御するファンクションをまとめたグループです。

loop

くり返しファンクションです。

choose

選択ファンクションです。

その他

どのグループにも当てはまらないファンクションをまとめたグループです。

replace

値置換えファンクションです。

radix

基数変換ファンクションです。

custom

カスタムファンクションです。

const

定数ファンクションです。

xpath

XPathファンクションです。

1.2.5　ユーザ定義受付定義画面

ユーザ定義受付定義画面での受付の定義について，受付種別ごとに説明します。

画面の表示方法，および各受付の定義方法については，マニュアル「サービスプラットフォーム 開発ガイド 受付・アダプタ定義編」の「2.　ユーザ定義受付の定義」を参照してください。

(1)　受付種別「SOAP受付」の場合

ユーザ定義受付定義画面の，SOAP受付の定義情報の表示について説明します。

(a)　SOAP受付の基本画面

SOAP受付の基本画面の項目について説明します。

図1‒34　ユーザ定義受付定義画面（SOAP受付の基本画面）

［ユーザ定義受付情報］

［受付名］

ユーザ定義受付を追加したときにユーザ定義受付追加ウィザードに指定した受付名が表示されます。受付名は，XMLSchemaのNCName定義文字で，40バイト以内で指定します。また，受付名は，ビジネスプロセス内で一意になるように指定します。

［受付ID］

ユーザ定義受付を追加したときに付与されるIDが表示されます。受付IDは，8バイト以内の英数字およびアンダーバー（_）で指定します。また，受付IDは，リポジトリ内で一意になるように指定します。

［受付種別］

受付の種別として「SOAP受付」が表示されます。受付種別は変更できません。

［ポート名］

ユーザ定義受付を追加するウィザードの［Portの指定］で選択したポート名が表示されます。

［コンテキストルート］

コンテキストルート名が表示されます。コンテキストルート名は，次の点に注意して指定します。

半角英数字および次に示す記号で指定してください。

/　@　+　-　$　_　.　!　'　(　)　%　~　

リポジトリ内で一意になるように指定してください。

アプリケーションサーバの仕様に準拠した指定をしてください。次の値を指定すると，デプロイ時にエラーとなります。

先頭，または末尾に区切り文字（/）が指定されている。

（例）/rcp, rcp/sub/

区切り文字（/）が多重指定されている。

（例）rcp//sub

相対パスが指定されている。

（例）rcp/./sub/..

パーセントエンコーディング以外の目的でパーセント（%）が指定されている。

（例）rcp%

HCSCサーバ名，HCSCサーバに配備されたSOAPアダプタ（サービス種別「Webサービス」で指定）のサービスID，およびReliable Messagingで使用するコンテキストルートの値は指定しないでください。

［オペレーション名］

オペレーション名が表示されます。ユーザ定義受付に定義されているオペレーション名をドロップダウンリストから選択できます。

［要求電文］

・［ボディ］タブ

［電文フォーマット］

要求電文の電文フォーマット名が表示されます。電文フォーマットは，WSDLから自動生成されます。

［表示］ボタン

要求電文の電文フォーマットが表示されます。

［出力］ボタン

要求電文の電文フォーマットの出力先を指定するダイアログが表示されます。

・［ヘッダ］タブ

［ルート要素］

ルート要素が表示されます。要求電文にヘッダ情報が含まれていない場合，この項目には何も表示されません。ドロップダウンリストに表示されるルート要素の一覧は，ボタンで追加・削除できます。

［追加］ボタン

電文フォーマットを設定するダイアログが表示されます。電文フォーマットを設定したあと，その電文フォーマットに含まれるルート要素を追加できます。

［削除］ボタン

［ルート要素］に表示されているルート要素を削除します。

［名前空間］

［ルート要素］に表示されているルート要素の名前空間が表示されます。要求電文にヘッダ情報が含まれていない場合，この項目には何も表示されません。

［電文フォーマット］

［ルート要素］に表示されているルート要素を含んだ電文フォーマット名が表示されます。要求電文にヘッダ情報が含まれていない場合，この項目には何も表示されません。

［表示］ボタン

要求電文のヘッダ情報が表示されます。

［出力］ボタン

要求電文のヘッダ情報の出力先を指定するダイアログが表示されます。

［応答電文］

・［ボディ］タブ

［電文フォーマット］

応答電文の電文フォーマット名が表示されます。電文フォーマットは，WSDLから自動生成されます。

［表示］ボタン

応答電文の電文フォーマットが表示されます。

［出力］ボタン

応答電文の電文フォーマットの出力先を指定するダイアログが表示されます。

・［ヘッダ］タブ

［ルート要素］

ルート要素が表示されます。応答電文にヘッダ情報が含まれていない場合，この項目には何も表示されません。ドロップダウンリストに表示されるルート要素の一覧は，ボタンで追加・削除できます。

［追加］ボタン

電文フォーマットを設定するダイアログが表示されます。電文フォーマットを設定したあと，その電文フォーマットに含まれるルート要素を追加できます。

［削除］ボタン

［ルート要素］に表示されているルート要素を削除します。

［名前空間］

［ルート要素］に表示されているルート要素の名前空間が表示されます。応答電文にヘッダ情報が含まれていない場合，この項目には何も表示されません。

［電文フォーマット］

［ルート要素］に表示されているルート要素を含んだ電文フォーマット名が表示されます。応答電文にヘッダ情報が含まれていない場合，この項目には何も表示されません。

［表示］ボタン

応答電文のヘッダ情報が表示されます。

［出力］ボタン

応答電文のヘッダ情報の出力先を指定するダイアログが表示されます。

［フォルト電文］

［フォルト名］

ユーザ定義受付のフォルトの名称が表示されます。

［電文フォーマット］

フォルト電文のフォーマット名が表示されます。電文フォーマットは，WSDLから自動生成されます。

［表示］ボタン

フォルト電文のフォーマットが表示されます。

［出力］ボタン

フォルト電文のフォーマットの出力先を指定するダイアログが表示されます。

(b)　SOAP受付の詳細画面

SOAP受付の詳細画面の項目について説明します。この画面は，SOAP1.1/1.2併用モードでだけ使用されます。

図1‒35　ユーザ定義受付定義画面（SOAP受付の詳細画面）

［ユーザ定義受付制御情報］

独自定義ファイルの名称が表示されます。

［独自定義ファイル］

独自定義ファイルが表示されます。

独自定義ファイルは次のボタンで追加・編集・削除・出力先指定ができます。

［追加］ボタン

独自定義ファイルを追加するダイアログが表示されます。

［編集］ボタン

選択した独自定義ファイルを編集するためのエディタが起動します。

独自定義ファイルを複数選択してクリックした場合は，選択されたすべての独自定義ファイルに対してエディタが起動します。エディタ上で独自定義ファイルを保存したあと，ユーザ定義受付を保存することで，編集した内容がリポジトリに反映されます。独自定義ファイルの編集中にユーザ定義受付を保存しようとすると，独自定義ファイルを保存してよいか確認するダイアログが表示されます。

［出力］ボタン

独自定義ファイルの出力先を指定するダイアログが表示されます。

［削除］ボタン

選択したファイルを削除します。

(2)　受付種別「gRPC受付」の場合

ユーザ定義受付定義画面の，gRPC受付の定義情報の表示について説明します。

(a)　gRPC受付の基本画面

gRPC受付の基本画面の項目について説明します。

図1‒36　ユーザ定義受付定義画面（gRPC受付の基本画面）

［ユーザ定義受付情報］

［受付名］

ユーザ定義受付を追加したときにユーザ定義受付追加ウィザードに指定した受付名が表示されます。受付名は，XMLSchemaのNCName定義文字で，40バイト以内で指定します。また，受付名は，ビジネスプロセス内で一意になるように指定します。

［受付ID］

受付のIDが表示されます。受付IDは，8バイト以内の英数字およびアンダーバー（_）で指定します。

［受付種別］

受付の種別として「gRPC受付」が表示されます。受付種別は変更できません。

［gRPC Service名］

gRPC Service名が表示されます。

［オペレーション名（RPCメソッド名）］

オペレーション名（RPCメソッド名）が表示されます。

［要求電文］

［電文フォーマット］

要求電文の電文フォーマット名が表示されます。

［表示］ボタン

要求電文の電文フォーマットが表示されます。

［出力］ボタン

要求電文の電文フォーマットの出力先を指定するダイアログが表示されます。

［応答電文］

［電文フォーマット］

応答電文の電文フォーマット名が表示されます。

［表示］ボタン

応答電文の電文フォーマットが表示されます。

［出力］ボタン

応答電文の電文フォーマットの出力先を指定するダイアログが表示されます。

［フォルト電文］

［フォルト名］

ユーザ定義受付のフォルトの名称が表示されます。

［電文フォーマット］

フォルト電文のフォーマット名が表示されます。

［参照］ボタン

フォルト電文フォーマットのファイルを設定するダイアログが表示されます。フォルト電文フォーマットの内容を修正して再登録する際に使用します。それ以外のファイルを指定した場合は動作を保証しません。

［表示］ボタン

フォルト電文のフォーマットが表示されます。

［出力］ボタン

フォルト電文のフォーマットの出力先を指定するダイアログが表示されます。

(b)　gRPC受付の詳細画面

gRPC受付の詳細画面の項目について説明します。

図1‒37　ユーザ定義受付定義画面（gRPC受付の詳細画面）

［ユーザ定義受付制御情報］

［独自定義ファイル］

gRPC受付定義ファイルのファイル名「cscurecpgrpc.properties」が表示されます。

独自定義ファイルは次のボタンで追加・編集・削除・出力先指定ができます。

［追加］ボタン

独自定義ファイルを追加するダイアログが表示されます。

［編集］ボタン

選択した独自定義ファイルを編集するためのエディタが起動します。

独自定義ファイルを複数選択してクリックした場合は，選択されたすべての独自定義ファイルに対してエディタが起動します。エディタ上で独自定義ファイルを保存したあと，ユーザ定義受付を保存することで，編集した内容がリポジトリに反映されます。独自定義ファイルの編集中にユーザ定義受付を保存しようとすると，独自定義ファイルを保存してよいか確認するダイアログが表示されます。

［出力］ボタン

独自定義ファイルの出力先を指定するダイアログが表示されます。

［削除］ボタン

選択したファイルを削除します。

［protoファイル］

protoファイルをZIP形式で圧縮したファイルの名称「proto.zip」が表示されます。

［出力］ボタン

ファイル「proto.zip」の出力先を指定するダイアログが表示されます。

proto.zipの内容については，マニュアル「サービスプラットフォーム 解説」の「2.13.1　gRPCプロトコルを利用したシステム」を参照してください。

(3)　受付種別「TP1/RPC受付」，「FTP受付」，「HTTP受付」，「Message Queue受付」，「ファイルイベント受付」，「Kafka受付」，「スケジュール駆動受付」，「カスタム受付」の場合

次に示す受付種別の画面項目について説明します。

TP1/RPC受付

FTP受付

HTTP受付

Message Queue受付

ファイルイベント受付

Kafka受付

スケジュール駆動受付

カスタム受付

(a)　TP1/RPC受付，FTP受付，HTTP受付，Message Queue受付，ファイルイベント受付，Kafka受付，スケジュール駆動受付，カスタム受付の基本画面

TP1/RPC受付，FTP受付，HTTP受付，Message Queue受付，ファイルイベント受付，Kafka受付，スケジュール駆動受付，カスタム受付の基本画面の項目について説明します。

図1‒38　ユーザ定義受付定義画面（TP1/RPC受付，FTP受付，HTTP受付，Message Queue受付，ファイルイベント受付，Kafka受付，スケジュール駆動受付，カスタム受付の基本画面）

［ユーザ定義受付情報］

［受付名］

受付の名称が表示されます。受付の名称は40バイト以内で指定します。受付名は，ユーザ定義受付（呼出先選択）の場合はリポジトリ内で，それ以外の受付の場合はビジネスプロセス内で一意になるように指定します。

［受付ID］

受付のIDが表示されます。受付IDは，8バイト以内の英数字およびアンダーバー（_）で指定します。

［受付種別］

受付の種別として次のどれかが表示されます。受付種別は変更できません。

TP1/RPC受付

FTP受付

HTTP受付

Message Queue受付

ファイルイベント受付

Kafka受付

スケジュール駆動受付

カスタム受付

［デフォルトオペレーション名］

デフォルトで呼び出すオペレーション名が表示されます。デフォルトで呼び出すオペレーション名をドロップダウンリストから選択できます。

［オペレーション］

オペレーション名が表示されます。受付で定義されているオペレーション名をドロップダウンリストから選択できます。

［追加］ボタン

オペレーションを追加するダイアログが表示されます。

［削除］ボタン

［オペレーション］欄で選択したオペレーションを削除します。

［オペレーション情報］

サービス部品のオペレーションについての情報が表示されます。

［オペレーション名］

［ユーザ定義受付情報］の［オペレーション］欄で選択したオペレーションの名称が表示されます。

［通信モデル］

オペレーションの通信モデルが表示されます。同期または非同期をドロップダウンリストから選択できます。TP1/RPC受付およびFTP受付の場合，必ず同期を選択してください。

［要求電文］

受付がサービスリクエスタから受け取る要求電文の情報が表示されます。

［any型を使う］チェックボックス

データの型を指定しないでユーザ定義受付を作成する場合にチェックします。

［受付］

［電文フォーマット］

受付がサービスリクエスタから受け取る要求電文のフォーマット名が表示されます。表示される電文フォーマットは，受付の種類によって次のように異なります。

・TP1/RPC受付の場合：fdxファイル

・FTP受付，ファイルイベント受付，Kafka受付またはスケジュール駆動受付の場合：xsdファイル

・上記以外の場合：fdxファイルまたはxsdファイル

電文フォーマットは変更できます。

［参照］ボタン

要求電文のフォーマットを設定するダイアログが表示されます。

［表示］ボタン

要求電文のフォーマットが表示されます。

［出力］ボタン

要求電文フォーマットの出力先を指定するダイアログが表示されます。

［サービス部品］

［使う］チェックボックス

受付がビジネスプロセスに渡す要求電文を，データ変換する場合にチェックします。TP1/RPC受付の場合，必ずチェックしてください。

［電文フォーマット］

受付がビジネスプロセスに渡す要求電文のフォーマット名が表示されます。表示される電文フォーマットは，xsdファイルです。

電文フォーマットは変更できます。

［参照］ボタン

要求電文のフォーマットを設定するダイアログが表示されます。

［表示］ボタン

要求電文のフォーマットが表示されます。

［出力］ボタン

要求電文のフォーマットの出力先を指定するダイアログが表示されます。

［データ変換定義］

要求電文をデータ変換するための定義ファイル名が表示されます。TP1/RPC受付の場合，必ずデータ変換用の定義ファイルを指定してください。

［編集］ボタン

データ変換定義画面が表示されます。［データ変換定義］で設定した定義ファイルの内容を編集できます。初めて定義する場合は，［ルート要素選択］ダイアログが表示されます。電文フォーマットを変更した場合は，電文フォーマットの変更を反映するかを確認するダイアログが表示されます。

［削除］ボタン

［編集］ボタンで設定したデータ変換定義を削除します。

［応答電文］

受付がサービスリクエスタに返す応答電文の情報が表示されます。オペレーション情報の［通信モデル］で，「同期」を選択した場合だけ，設定できます。

［any型を使う］チェックボックス

データの型を指定しないでユーザ定義受付を作成する場合にチェックします。

［受付］

［電文フォーマット］

受付がサービスリクエスタに返す応答電文のフォーマット名が表示されます。表示される電文フォーマットは，受付の種類によって次のように異なります。

・TP1/RPC受付の場合：fdxファイル

・FTP受付またはファイルイベント受付の場合：xsdファイル

・上記以外の場合：fdxファイルまたはxsdファイル

電文フォーマットは変更できます。

［参照］ボタン

応答電文のフォーマットを設定するダイアログが表示されます。

［表示］ボタン

応答電文のフォーマットが表示されます。

［出力］ボタン

応答電文のフォーマットの出力先を指定するダイアログが表示されます。

［サービス部品］

［使う］チェックボックス

受付がビジネスプロセスから受け取る応答電文を，データ変換する場合にチェックします。TP1/RPC受付の場合，必ずチェックしてください。

［電文フォーマット］

受付がビジネスプロセスから受け取る応答電文のフォーマット名が表示されます。表示される電文フォーマットは，xsdファイルです。

電文フォーマットは変更できます。

［参照］ボタン

応答電文のフォーマットを設定するダイアログが表示されます。

［表示］ボタン

応答電文のフォーマットが表示されます。

［出力］ボタン

応答電文のフォーマットの出力先を指定するダイアログが表示されます。

［データ変換定義］

応答電文をデータ変換するための定義ファイル名が表示されます。TP1/RPC受付の場合，必ずデータ変換用の定義ファイルを指定してください。

［編集］ボタン

データ変換定義画面が表示されます。［データ変換定義］で設定した定義ファイルの内容を編集できます。初めて定義する場合は，［ルート要素選択］ダイアログが表示されます。電文フォーマットを変更した場合は，電文フォーマットの変更を反映するかを確認するダイアログが表示されます。

［削除］ボタン

［編集］ボタンで設定したデータ変換定義を削除します。

(b)　TP1/RPC受付，FTP受付，HTTP受付，Message Queue受付，ファイルイベント受付，Kafka受付，スケジュール駆動受付，カスタム受付の詳細画面

TP1/RPC受付，FTP受付，HTTP受付，Message Queue受付，ファイルイベント受付，Kafka受付，スケジュール駆動受付，カスタム受付の詳細画面の項目について説明します。

図1‒39　ユーザ定義受付定義画面（TP1/RPC受付，FTP受付，HTTP受付，Message Queue受付，ファイルイベント受付，Kafka受付，スケジュール駆動受付，カスタム受付の詳細画面）

［ユーザ定義受付制御情報］

独自定義ファイルおよびEARファイルの名称が表示されます。

［独自定義ファイル］

独自定義ファイルが表示されます。受付の種類に応じて，次の独自定義ファイルのファイル名が表示されます。

受付の種類

独自定義ファイル

TP1/RPC受付

TP1/RPC受付定義ファイル

FTP受付

FTP受付定義ファイル

HTTP受付

HTTP受付定義ファイル

HTTPレスポンスヘッダ定義ファイル

HTTP受付サービス選択定義ファイル（ユーザ定義受付（呼出先選択）の場合）

Message Queue受付

Message Queue受付定義ファイル

ファイルイベント受付

ファイルイベント受付定義ファイル

Kafka受付

Kafka受付定義ファイル

スケジュール駆動受付

スケジュール駆動受付定義ファイル

上記以外

カスタム受付ユーザファイル

独自定義ファイルは次のボタンで追加・編集・削除・出力先指定ができます。

［追加］ボタン

独自定義ファイルを追加するダイアログが表示されます。

［編集］ボタン

選択した独自定義ファイルを編集するためのエディタが起動します。

独自定義ファイルを複数選択してクリックした場合は，選択されたすべての独自定義ファイルに対してエディタが起動します。エディタ上で独自定義ファイルを保存したあと，ユーザ定義受付を保存することで，編集した内容がリポジトリに反映されます。独自定義ファイルの編集中にユーザ定義受付を保存しようとすると，独自定義ファイルを保存してよいか確認するダイアログが表示されます。

［出力］ボタン

独自定義ファイルの出力先を指定するダイアログが表示されます。

［削除］ボタン

選択したファイルを削除します。

［EARファイル］

［参照］ボタンで設定したEARファイルの名称が表示されます。

［参照］ボタン

インポートするEARファイルを設定するダイアログが表示されます。

1.2.6　HCSCコンポーネント情報表示画面

HCSCコンポーネントの情報を表示するHCSCコンポーネント情報表示画面について説明します。

図1‒40　HCSCコンポーネント情報表示画面

(1)　インタフェース情報

インタフェース情報の各項目について説明します。

［サービス名］

ツリービューの公開サービス一覧で選択したHCSCコンポーネントの名称が表示されます。

［オペレーション］

［サービス名］に表示されたHCSCコンポーネントのオペレーション名が表示されます。情報を表示するオペレーションを，ドロップダウンリストから選択します。

(2)　サーバ情報

サーバ情報の各項目について説明します。

［サーバ名］

サービス部品を呼び出すことができるクラスタ名が表示されます。

［Webサービス］

Webサービスの受付宛先情報（URL）が表示されます。また，取得するWSDL定義のスタイル（バインディングスタイル），およびSOAP仕様のバージョン（SOAPバージョン）を選択します。

なお，表示される受付宛先情報（URL）はSOAP1.1の場合だけです。SOAP1.2の場合は，SOAPバージョンを選択して取得したWSDLの<soap12:address>のlocationを確認してください。

［WSDL取得］ボタン

Webサービスで使用するWSDLファイルを取得する［WSDLファイルの保存］ダイアログが表示されます。

［EJB］※1

HCSCサーバのSessionBeanの受付宛先情報が表示されます。宛先情報にはJNDI名称が表示されます。

［スタブ取得］ボタン

SessionBeanで使用するRMI-IIOPスタブファイルを取得する［スタブファイルの保存］ダイアログが表示されます。

［MDB/WS-R］※2

［サーバ名］で選択したHCSCサーバのMDB（WS-R）の受付宛先情報が表示されます。宛先情報にはURLが表示されます。

［MDB/DBキュー］※2

［サーバ名］で選択したHCSCサーバのMDB（DBキュー）の受付宛先情報が表示されます。宛先情報にはキュー名称が表示されます。

注※1

クラスタがJ2EEサーバ名の異なる複数のHCSCサーバで構成されている場合，特定のHCSCサーバの情報しか表示されません。

注※2

HCSCサーバがロードバランスクラスタ構成の場合，ロードバランスクラスタ経由で非同期の実行要求（MDB（WS-R）またはMDB（DBキュー））を受け付けられません。非同期の実行要求は，個々のHCSCサーバで直接受け付けます。

クラスタにHCSCサーバが複数存在する場合，個々のHCSCサーバの受付宛先情報はコンマ（,）区切りで表示されます。

(3)　オペレーション情報

［インタフェース情報］の［オペレーション］で選択したオペレーションの情報が表示されます。

［オペレーション名］

［インタフェース情報］の［オペレーション］で選択したオペレーション名称が表示されます。

［通信モデル］

［インタフェース情報］の［オペレーション］で選択したオペレーションの通信モデルが表示されます。同期または非同期のどちらかが表示されます。

(4)　要求電文

［インタフェース情報］の［オペレーション］で選択したオペレーションの情報が表示されます。

［標準電文フォーマット］

標準の要求電文のフォーマット名が表示されます。

［表示］ボタン

［標準電文フォーマット］に表示された要求電文の内容を表示します。

［出力］ボタン

［標準電文フォーマット］に表示された要求電文の出力先を指定するダイアログが表示されます。

［フォーマットID］

標準の要求電文のフォーマットIDが表示されます。

(5)　応答電文

［インタフェース情報］の［オペレーション］で選択したオペレーションの情報が表示されます。

［標準電文フォーマット］

標準の応答電文のフォーマット名が表示されます。

［表示］ボタン

［標準電文フォーマット］に表示された応答電文の内容を表示します。

［出力］ボタン

［標準電文フォーマット］に表示された応答電文の出力先を指定するダイアログが表示されます。

［フォーマットID］

標準の応答電文のフォーマットIDが表示されます。

(6)　フォルト電文

［インタフェース情報］の［オペレーション］で選択したオペレーションの情報が表示されます。

［フォルト名］

フォルト名が表示されます。情報を表示するフォルト名を，ドロップダウンリストから選択します。

［電文フォーマット］

［フォルト名］で選択した電文のフォーマット名が表示されます。

［表示］ボタン

［電文フォーマット］に表示された電文の内容を表示します。

［出力］ボタン

［電文フォーマット］に表示された電文の出力先を指定するダイアログが表示されます。

1.2.7　ユーザ定義受付情報表示画面

パッケージング後のユーザ定義受付の定義情報を表示するユーザ定義受付情報表示画面について説明します。

図1‒41　ユーザ定義受付情報表示画面

［ユーザ定義受付情報］

［受付名］

ユーザ定義受付を追加したときにユーザ定義受付追加ウィザードに指定した受付名が表示されます。

［受付種別］

ユーザ定義受付追加ウィザードに指定した受付種別が表示されます。

［ポート名］

ユーザ定義受付を追加したときにユーザ定義受付追加ウィザードに指定したポート名が表示されます。

［同期］

情報は表示されません。

［Webサービス］

WSDLのサービスロケーションの値（wsdl:port要素内のsoap-address要素のlocation属性に設定している値）に設定するURLが表示されます。

サービスリクエスタを作成する前に，WSDLを編集して，この項目に表示された値をサービスロケーションの値として設定します。

WSDLの編集については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「9.7.2　WSDLを編集する」を参照してください。

1.3　バイナリフォーマット定義に関連するダイアログ

バイナリフォーマット定義に関連するダイアログについて説明します。

1.3.1　フォーマットダイアログ

［フォーマット］ダイアログは，バイナリフォーマット定義ファイルのフォーマット名称や文字コードを設定するときに使用します。

操作手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4.4.4　要素を定義する（CSV以外の形式の場合）」を参照してください。

図1‒42　［フォーマット］ダイアログ

［インフォメーション］

［フォーマット］ダイアログの入力情報に問題がある場合に，ダイアログの最上段に問題点を示すメッセージが表示されます。表示されるメッセージと対策については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4.4.7　バイナリフォーマット定義ファイルを検証する」を参照してください。

［フォーマット名称］

バイナリフォーマット定義ファイルのフォーマット名称を指定します。NCName型で256文字以内で指定します。

［フォーマット：CSV形式］

フォーマット形式がCSV形式の場合に表示されます。

［文字コード］

［文字コード］（Code Converterを使用する場合）

バイナリデータでCode Converterを使用する場合に，文字コードをドロップダウンリストから選択します。

選択できる文字コード種別を次の表に示します。なお，文字コードの詳細は，「付録A　文字コード対応表」を参照してください。

表1‒9　選択できる文字コード種別（Code Converterを使用する場合）

文字コード種別

コード体系

サポートする文字範囲

補足

MS932

SJIS

UCS-2

Microsoftコードページ932

ただし，IBM選択文字，NEC選定IBM拡張文字は含みません。IBM選択文字，NEC選定IBM拡張文字を使用する場合には，ユーザマッピングの定義が必要になります。

UTF8

Unicode

UCS-4※1

UnicodeのUTF-8エンコーディング※2

UTF16_BIG

Unicode

UCS-2

ビッグエンディアンで扱うUnicodeのUTF-16エンコーディング※2

UTF16_LITTLE

Unicode

UCS-2

リトルエンディアンで扱うUnicodeのUTF-16エンコーディング※2

JIS

JIS漢字コード

UCS-2

JIS X 0201，JIS C 6226，JIS X 0208，JIS X 0212，およびASCII

EUC※3

EUC

UCS-2

ASCIIとJIS X0208を使用できるEUC（EUC-JP）

コードセット3の領域も含みます。※4

EUC_HJ※3

EUC

UCS-2

外字を2バイトの範囲で使用するために，独自に拡張されたEUC

KEIS+EBCDIC

KEIS

UCS-2

KEIS'83および半角英数字がEBCDIC

KEIS+EBCDIK

KEIS

UCS-2

KEIS'83および半角英数字がEBCDIK

KEIS※5

KEIS

UCS-2

KEIS'83

IBM_CODE+EBCDIC(LATIN)

IBM漢字コード

UCS-2

IBM漢字コード＋標準または拡張英小文字セット

IBM_CODE+EBCDIC(KANA)

IBM漢字コード

UCS-2

IBM漢字コード＋標準または拡張カタカナ文字セット

IBM_CODE※5

IBM漢字コード

UCS-2

IBM漢字コード

JEF+EBCDIC

JEF

UCS-2

JEF漢字コード＋JEF版EBCDIC

JEF+EBCDIK

JEF

UCS-2

JEF漢字コード＋JEF版EBCDIK

JEF※5

JEF

UCS-2

JEF漢字コード

CUSTOM

文字コード変換UOC

UCS-2

文字コードを変換するためにユーザが作成した外部プログラム

注※1

マッピング処理（XSLT）では，UTF-16に符号化されて処理されるため，Unicode補助文字（0x10000〜0x10FFFF）はサロゲートペアに符号化されます。

注※2

BOM付きのデータは扱えません。BOM（Byte Order Mark）とは，データのバイトの並び順序を表すコードです。

注※3

バイナリデータの入力時および出力時には，EUCコードの文字のバイトサイズを先頭バイトで判別します。先頭バイトにおける文字バイト数を次の表に示します。

文字コード

先頭バイト

文字バイト数

備考

EUC

0x00〜0x7E

1バイト

ASCII

0xA1〜0xFE

2バイト

JIS X 0208（補助コードセット1）

0x8E

2バイト

JIS X 0201カタカナ（補助コードセット2）

0x8F

3バイト

JIS X 0212補助漢字（補助コードセット3）

デフォルトの変換対応については「注※4」を参照してください。

EUC-HJ

0x00〜0x7E

1バイト

ASCII

0xA1〜0xFE

2バイト

EUC-HJ領域 または

JIS X 0208（補助コードセット1）

0x8E

2バイト

JIS X 0201カタカナ（補助コードセット2）

固定長で定義する場合は，入力文字列および出力文字列のサイズがバイナリフォーマット定義に指定したデータ長を超えないよう，注意してデータ長を決めてください。

注※4

EUCコードセット3の領域内の文字の変換マッピングは，デフォルトではUnicode私用領域への領域マッピングとなります。JIS X 0212へマッピングする場合は，単体版のCode Converterを使用し，ユーザマッピングを作成することで対応してください。利用するCode Converterについては「付録A　文字コード対応表」を参照してください。

注※5

CSV形式では使用できません。

［Java提供のエンコーダー・デコーダーを使用する］チェックボックス

バイナリデータのエンコードとデコードに，Java提供のエンコーダーとデコーダーを使用する場合にチェックします。

［文字コード］（Java提供のエンコーダー・デコーダーを使用する場合）

バイナリデータでJava提供のエンコーダー・デコーダーを使用する場合に，文字コードをドロップダウンリストから選択します。

選択できる文字コード種別を次の表に示します。なお，文字コードの詳細は，「付録A　文字コード対応表」を参照してください。

表1‒10　選択できる文字コード種別（Java提供のエンコーダー・デコーダーを使用する場合）

文字コード種別

説明

windows-31j

Windows日本語

UTF-8

8ビットUnicode (UCS) Transformation Format

UTF-16BE

16ビットUnicode (UCS) Transformation Format，ビッグエンディアン・バイト順

UTF-16LE

16ビットUnicode (UCS) Transformation Format，リトルエンディアン・バイト順

ISO-2022-JP

ISO 2022形式のJIS X 0201，0208，日本語

EUC-JP

JISX 0201，0208，0212，EUCエンコーディング，日本語

x-IBM939

UDC 4370文字を含む日本語ラテン文字漢字，5035のスーパー・セット

x-IBM930

UDC 4370文字を含む日本語カタカナ漢字，5026のスーパー・セット

［未定義コード置換時の処理］

HCSCサーバランタイム定義ファイルでtelegram-undefined-character-code=REPLACE（未定義部分の文字コードをスペースに置換する）が指定されている場合，スペースまたは任意文字の置換方法を次の中から選択します。

［全角・半角スペースに置換する］

次の表に示す置換種別に従って，スペースまたは任意文字を全角・半角へ置換します。任意文字へ置換する場合は，J2EEサーバ用ユーザプロパティファイルに任意文字を指定する必要があります。置換する任意文字の指定については，マニュアル「サービスプラットフォームシステム構築・運用ガイド」の「2.3.9　J2EEサーバ用ユーザプロパティファイル（usrconf.properties）を設定する」で，未定義コードの任意文字への置換に関する説明を参照してください。

バイナリの文字コード

置換種別

MS932

半角

UTF8

半角

UTF16_BIG

UTF16_LITTLE

半角

JIS

エスケープ状態がJISC6226_1978，JISX0208_1983，JISX0212_1990の場合

全角

エスケープ状態がJISX0201_LATIN，JISX0201_JIS8，ASCIIの場合

半角

EUC

EUC_HJ

半角

KEIS+EBCDIC

KEIS+EBCDIK

シフト状態が半角の場合

半角

シフト状態が全角の場合

全角

KEIS

全角

IBM_CODE+EBCDIC(LATIN)

IBM_CODE+EBCDIC(KANA)

シフト状態が半角の場合

半角

シフト状態が全角の場合

全角

IBM_CODE

全角

JEF_EBCDIC

JEF_EBCDIK

シフト状態が半角の場合

半角

シフト状態が全角の場合

全角

JEF

全角

［全角スペースに置換する］

スペースまたは任意文字をすべて全角へ置換します。

［2進整数のエンディアン］

バイナリデータに含まれる2進整数のエンディアンをラジオボタンで選択します。

この項目は，使用するバイナリデータがCSV形式以外の場合にだけ選択できます。

［パック形式数値のカスタム定義］

パック形式数値のカスタム定義は，［単純内容要素］ダイアログの設定が次のすべての条件を満たしている場合に適用されます。

［データ種別］で［パック形式数値］を選択している

［符号の設定］で［カスタム］を選択している

［符号の有無］で［あり］を選択している

［ビット値（16進数）］

パック形式数値の符号ビットを16進数で指定します。

［正符号］

パック形式数値の正符号ビットを16進数の英数字で指定します。

［負符号］

パック形式数値の負符号ビットを16進数の英数字で指定します。

［符号なし］

パック形式数値の符号なし（絶対値）ビットを16進数の英数字で指定します。

［ゾーン形式数値のカスタム定義］

ゾーン形式数値のカスタム定義は，［単純内容要素］ダイアログの設定が次のすべての条件を満たしている場合に適用されます。

［データ種別］で［ゾーン形式数値］を選択している

［符号の設定］で［カスタム］を選択している

［符号の有無］で［あり］を選択している

［ビット値（16進数）］

ゾーン形式数値の符号ビットを16進数で指定します。

［符号の設定］が［符号ビット］の場合に適用されます。

［正符号］

パック形式数値の正符号ビットを16進数の英数字で指定します。

［負符号］

パック形式数値の負符号ビットを16進数の英数字で指定します。

［符号なし］

パック形式数値の符号なし（絶対値）ビットを16進数の英数字で指定します。

［ゾーン］

ゾーン形式数値のゾーンビットを16進数の英数字で指定します。

［符号文字（16進数）］

ゾーン形式数値で符号を表す文字を16進数で指定します。

［符号の設定］が［符号文字］の場合に適用されます。

［正符号］

正符号文字を英数字1〜2桁の16進数で指定します。

［負符号］

負符号文字を英数字1〜2桁の16進数で指定します。

［セパレータ］

［エスケープ文字］

セパレータとして使用する文字がデータ内に含まれる場合に，エスケープ文字として使用する文字を指定します。エスケープ文字として使用できる文字は，1文字のラテン文字（JIS X 0201の「0x21」〜「0x7E」）または半角スペース（JIS X 0201の「0x20」）です。

この項目は，使用するバイナリデータがCSV形式以外の場合に指定できます。

［改行指定］

セパレータで使用する改行文字をドロップダウンリストで選択します。使用できる改行コードは，CR＋LF，またはLFです。

［不要なセパレータの削除］チェックボックス

末尾のセパレータを削除する場合にチェックします。

［CSV形式］

［出力時のダブルクォーテーション「"」の囲み］チェックボックス

データ項目をダブルクォーテーションで囲む場合にチェックします。

ただし，チェックした場合でも値が空文字列の場合はダブルクォーテーションで囲みません。

［コード変換テーブル］

［デフォルトから変更する］チェックボックス

Code Converterのコード変換ライブラリから参照される，コード変換テーブルの格納ディレクトリを変更する場合にチェックします。デフォルトのディレクトリは次のとおりです。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥lib¥external¥table

［格納ディレクトリ名］

［デフォルトから変更する］チェックボックスをチェックした場合に，コード変換テーブルの格納先のディレクトリ名部分を指定します。

コード変換テーブル格納パスのルートパスは，HCSCサーバランタイム定義ファイルのcode-table-root-pathプロパティで指定されています。ここでは，そのルートパスの配下に置くディレクトリの名称を指定します。

ディレクトリ名は64文字以内で，英数字（0〜9，A〜Z，a〜z）またはアンダーバー（_）で指定します。

［OK］ボタン

指定した内容を設定して［フォーマット］ダイアログを閉じます。

［キャンセル］ボタン

指定した内容を設定しないで［フォーマット］ダイアログを閉じます。

1.3.2　単純内容要素ダイアログ

［単純内容要素］ダイアログは，バイナリフォーマット定義ファイルに単純内容要素を設定するときに使用します。

操作手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4.4.4　要素を定義する（CSV以外の形式の場合）」を参照してください。

［単純内容要素］ダイアログは，グローバル定義の単純内容要素を設定する場合と，ローカル定義の単純内容要素を設定する場合で表示されるタブが異なります。

(1)　単純内容要素タブ

単純内容要素タブは，設定する単純内容要素がグローバル定義でもローカル定義でも表示されます。単純内容要素の情報を指定します。

図1‒43　［単純内容要素］ダイアログ（単純内容要素タブ）

［データ種別］

単純内容要素として使用するデータの種別をドロップダウンリストから選択します。選択できるデータ種別と，それに応じて［詳細］に表示される内容を次に示します。

データ種別

［詳細］に表示される内容

文字列

「(a)　文字列型の場合」を参照してください。

整数

「(c)　整数・実数・固定小数部数値型の場合」を参照してください。

実数

固定小数部数値

ゾーン形式数値※

「(b)　ゾーン・パック形式数値型の場合」を参照してください。

パック形式数値※

符号付2進整数※

［詳細］には何も表示されません。

符号無2進整数※

バイト列※

「(d)　バイト列型の場合」を参照してください。

ビット列※

［詳細］には何も表示されません。

日付時刻

「(e)　日付時刻型の場合」を参照してください。

注※

バイナリデータとしてCSV形式のデータを扱う場合は選択できません。

［サイズ］

単純内容要素として使用するデータのサイズを指定します。

固定値の場合

ラジオボタンで［固定］を選択し，サイズを指定します。

データ種別と文字コードによって指定できるサイズの範囲が異なります。指定できるサイズの範囲を次の表に示します。

表1‒11　固定値の単純内容要素に指定できるサイズの範囲

データ種別

文字コード

指定できる範囲

単位

文字列，整数，実数，固定小数部数値

UTF16以外

1※〜2,147,483,647

バイト

UTF16

2※〜2,147,483,646

バイト

ゾーン形式数値，パック形式数値

−

1〜2,147,483,647

バイト

符号付2進整数，符号無2進整数

−

1〜8

バイト

バイト列

−

1〜2,147,483,647

バイト

ビット列

−

1〜64

ビット

日付時刻

CCYYMMDD

UTF16以外

8〜2,147,483,647

バイト

UTF16

16〜2,147,483,646

バイト

YYMMDD

UTF16以外

6〜2,147,483,647

バイト

UTF16

12〜2,147,483,646

バイト

hhmmss

UTF16以外

6〜2,147,483,647

バイト

UTF16

12〜2,147,483,646

バイト

CCYYMMDDhhmmss

UTF16以外

14〜2,147,483,647

バイト

UTF16

28〜2,147,483,646

バイト

YYMMDDhhmmss

UTF16以外

12〜2,147,483,647

バイト

UTF16

24〜2,147,483,646

バイト

（凡例）

−：指定できる範囲が文字コードに依存しないことを示します。

注※

データ種別が文字列のローカル単純内容要素の場合は，サイズが0バイトのデータを意味する0も指定できます。CSV形式のバイナリフォーマット定義の場合は指定できません。

可変値の場合

ラジオボタンで［可変］を選択します。サイズの決定方法は，構成要素タブ（または［構成要素］ダイアログ）の［サイズ］で設定します。

［詳細］

［データ種別］の選択内容に応じて，次のように表示内容が異なります。

(a)　文字列型の場合

［データ種別］で「文字列」を選択した場合に表示されます。なお，［サイズ］に0を指定した場合は［詳細］の各項目は非活性となり，指定できません。

図1‒44　［単純内容要素］ダイアログ（単純内容要素タブ（［データ種別］で「文字列」を選択した場合））

［個別文字コード］

単純内容要素として使用するデータの文字コードが，［フォーマット］ダイアログに設定した文字コードと異なる場合，文字コードを個別に指定します。

「サイズ」で「可変」を選択した場合は，構成要素のサイズ設定で［データの終端まで］または［サイズノード］が選択されている場合に個別文字コードが指定できます。

［指定する］チェックボックス

個別文字コードを指定する場合にチェックします。

［フォーマット設定値］

［フォーマット］ダイアログの［文字コード］グループで設定した文字コードが表示されます。

［文字コード］

指定する文字コードをドロップダウンリストから選択します。

選択できる文字コード種別については，「表1-9　選択できる文字コード種別（Code Converterを使用する場合）」または「表1-10　選択できる文字コード種別（Java提供のエンコーダー・デコーダーを使用する場合）」を参照してください。

なお，Code Converterの文字コードの詳細は，「付録A　文字コード対応表」を参照してください。

［埋め字］

単純内容要素として使用するデータが指定したサイズに満たない場合，余った部分を埋める文字をドロップダウンリストから選択します。空白で埋める場合は［スペース］を，空文字（0x00）で埋める場合は［空文字（0x00）］を選択します。

［空文字(0x00)までをデータとする］チェックボックス

空文字（0x00）までをデータとして扱う場合にチェックします。

［埋め字］で［空文字（0x00）］が選択されている場合だけ指定できます。

［左右寄せ］

データを寄せる方向を［左］ラジオボタンまたは［右］ラジオボタンで選択します。この項目は，次のどちらかの場合に指定できます。

［空文字(0x00)までをデータとする］チェックボックスが非活性である場合

［空文字(0x00)までをデータとする］チェックボックスが活性化していて，チェックされていない場合

［不要文字］

不要文字を削除するかどうかをラジオボタンで設定します。この項目は，次のどちらかの場合に指定できます。

［空文字(0x00)までをデータとする］チェックボックスが非活性である場合

［空文字(0x00)までをデータとする］チェックボックスが活性化していて，チェックされていない場合

不要文字の削除については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4.4.1　バイナリフォーマット定義ファイルのデータ型と文字コードの種類」を参照してください。

［使用不可文字］

XMLで使用できない文字が含まれている場合に，代替として使用する文字を指定します。使用できない文字は次のとおりです。

0x00〜0x1F（0x09，0x0A，0x0Dを除く）

制御コード

0xFFFE〜0xFFFF

未定義文字（Unicodeとしては本来使用禁止）

［代替文字に置換］チェックボックス

使用不可文字を代替文字に置換する場合にチェックします。

［先頭代替文字(16進数)］

代替として使用する文字を16進数で指定します。［代替文字に置換］チェックボックスがチェックされている場合に指定できます。

代替文字の最初の1文字を指定すると，続く34個分はそれぞれ0x00〜0x1F，0xFFFE〜0xFFFFに対応して代替文字として使用されます。16進数は先頭の「0x」を付けないで指定します。例えば，0x2400の場合は2400となります。

先頭の代替文字として指定できる値を次に示します。

0020〜D7DE

E000〜FFDC

デフォルト値は2400です。大文字・小文字は区別されません。

［CSV形式］

［空データとNullデータを区別する］チェックボックス

CSV形式のバイナリデータを変換する際，""（空文字列）とデータなし（Nullデータ）を識別する場合にチェックします。バイナリフォーマット定義ファイルをCSV形式で作成した場合か，親である複合内容要素のセパレータ形式が「CSV形式」である場合に指定できます。

詳細については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「付録Q　CSV形式の単純内容要素のデータなしの区別」を参照してください。

［COBOLデータ形式］

［LOW-VALUEの変換］チェックボックス

COBOL特有のデータ形式であるLOW-VALUE（0x00で埋められたデータ）を変換する場合にチェックします。

サイズが固定（0でない）で，かつ埋め字がスペースである場合に指定できます。

(b)　ゾーン・パック形式数値型の場合

［データ種別］で「ゾーン形式数値」または「パック形式数値」を選択した場合に表示されます。

図1‒45　［単純内容要素］ダイアログ（単純内容要素タブ（［データ種別］で「ゾーン形式数値」または「パック形式数値」を選択した場合））

［桁数］

桁数を設定します。

［全体］チェックボックス

ゾーン・パック形式数値型の場合は常に非活性です。そのため，全体桁数の最大値は指定できません。

［小数部］チェックボックス

小数部の桁数の最大値を0〜33で指定できます。

［符号の設定］

10進数符号の設定方法として，［自動］または［カスタム］を選択します。

［カスタム］を選択すると，［フォーマット］ダイアログで指定された項目が使用されます。

［符号の有無］

符号を付けない場合は［なし］，符号を付ける場合は［あり］を選択します。

この項目は，［符号の設定］で［カスタム］を選択した場合に指定できます。

［符号の種別］

符号を符号ビットで付ける場合は［符号ビット］，符号文字で付ける場合は［符号文字］を選択します。

この項目は，次のすべての条件を満たしている場合に指定できます。

［データ種別］で［ゾーン形式数値］を選択している

［符号の設定］で［カスタム］を選択している

［符号の有無］で［あり］を選択している

［符号の位置］

符号を前に付ける場合は［前］，符号を後ろに付ける場合は［後］を選択します。

この項目は，次のすべての条件を満たしている場合に指定できます。

［データ種別］で［ゾーン形式数値］を選択している

［符号の設定］で［カスタム］を選択している

［符号の有無］で［あり］を選択している

(c)　整数・実数・固定小数部数値型の場合

［データ種別］で「整数」，「実数」または「固定小数部数値」を選択した場合に表示されます。

図1‒46　［単純内容要素］ダイアログ（単純内容要素タブ（［データ種別］で「整数」または「実数」を選択した場合））

図1‒47　［単純内容要素］ダイアログ（単純内容要素タブ（［データ種別］で「固定小数部数値」を選択した場合））

［個別文字コード］

単純内容要素として使用するデータの文字コードが，［フォーマット］ダイアログに設定した文字コードと異なる場合，文字コードを個別に指定します。この項目は［データ種別］が「整数」または「実数」の場合に指定できます。

文字コードにKEIS，IBM_CODE，JEFは指定できません。

「サイズ」で「可変」を選択した場合は，構成要素のサイズ設定で［データの終端まで］または［サイズノード］が選択されている場合に個別文字コードが指定できます。

［指定する］チェックボックス

個別文字コードを指定する場合にチェックします。

［フォーマット設定値］

［フォーマット］ダイアログの［文字コード］グループで設定した文字コードが表示されます。

［文字コード］

指定する文字コードをドロップダウンリストから選択します。指定した文字コードは次に示すデータにも使用されます。

単純内容要素ダイアログの［符号の有無］の設定によってデータに付与されるプラス記号（+）およびマイナス記号（-）

単純内容要素ダイアログの［埋め字］の設定によってデータに付与されるスペースおよび「0」

選択できる文字コード種別については，「1.3.1　フォーマットダイアログ」の「表1-9　選択できる文字コード種別（Code Converterを使用する場合）」または「表1-10　選択できる文字コード種別（Java提供のエンコーダー・デコーダーを使用する場合）」を参照してください。なお，Code Converterの文字コードの詳細は，「付録A　文字コード対応表」を参照してください。

［桁数］

桁数を設定します。

［全体］チェックボックス

チェックすると全体桁数の最大値を1〜34で指定できます。指定できる桁数は，［サイズ］の設定によって次のように異なります。

［サイズ］で［固定］を選択した場合

全体桁数は整数部，符号，小数部の合計桁数になります。

なお，実数の場合，［小数部］の桁数に1以上の数値を指定すると，全体桁数には小数点も含まれます。

［サイズ］で［可変］を選択した場合

全体桁数には符号と小数点の桁数を含みません。

［小数部］チェックボックス

チェックすると，小数部の桁数の最大値を0〜33で指定できます。

データ種別が実数または固定小数部数値の場合に指定できます。

固定小数部数値の場合，チェックを外すことはできません。

［符号の有無］

データ種別が整数，実数または固定小数部数値の場合，正負の符号の有無をラジオボタンで選択します。

符号がない場合

［なし］を選択します。

負の符号だけある場合

［負だけあり］を選択します。

常に正負の符号がある場合

［常にあり］を選択します。

［埋め字］

データ種別が整数，実数または固定小数部数値の場合，単純内容要素として使用するデータが指定したサイズに満たないとき，余った部分を埋める文字をラジオボタンで選択します。空白で埋める場合は［スペース］を，0で埋める場合は［0］を選択します。

［左右寄せ］

データを寄せる方向を［左］ラジオボタンまたは［右］ラジオボタンで選択します。［埋め字］が［0］の場合は［左］ラジオボタンは設定できません。

［不要文字］

不要文字を削除するかどうかをラジオボタンで設定します。

［CSV形式］

［空データとNullデータを区別する］チェックボックス

CSV形式のバイナリデータを変換する際，""（空文字列）とデータなし（Nullデータ）を識別する場合にチェックします。バイナリフォーマット定義ファイルをCSV形式で作成した場合か，親である複合内容要素のセパレータ形式が「CSV形式」である場合に指定できます。

詳細については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「付録Q　CSV形式の単純内容要素のデータなしの区別」を参照してください。

［COBOLデータ形式］

［LOW-VALUEの変換］チェックボックス

COBOL特有のデータ形式であるLOW-VALUE（0x00で埋められたデータ）を変換する場合にチェックします。

サイズが固定である場合に指定できます。

(d)　バイト列型の場合

［データ種別］で「バイト列」を選択した場合に表示されます。

図1‒48　［単純内容要素］ダイアログ（単純内容要素タブ（［データ種別］で「バイト列」を選択した場合））

［エンコード形式］

エンコード形式として，スキーマのデータ型であるhexBinaryまたはbase64Binaryをラジオボタンで設定します。

(e)　日付時刻型の場合

［データ種別］で「日付時刻」を選択した場合に表示されます。

図1‒49　［単純内容要素］ダイアログ（単純内容要素タブ（［データ種別］で「日付時刻」を選択した場合））

［日付時刻］

データ種別が日付時刻の場合，日付時刻の形式を設定します。

［形式］

日付時刻の形式をドロップダウンリストから選択します。

［秒小数部桁数］

日付時刻の形式に時刻（hhmmss）が含まれる場合，秒の小数部分の桁数を0〜3で指定します。

［左右寄せ］

データの寄せる方向を［左］ラジオボタンまたは［右］ラジオボタンで選択します。

［CSV形式］

［空データとNullデータを区別する］チェックボックス

CSV形式のバイナリデータを変換する際，""（空文字列）とデータなし（Nullデータ）を識別する場合にチェックします。バイナリフォーマット定義ファイルをCSV形式で作成した場合か，親である複合内容要素のセパレータ形式が「CSV形式」である場合に指定できます。

詳細については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「付録Q　CSV形式の単純内容要素のデータなしの区別」を参照してください。

(2)　構成要素タブ

構成要素タブには，構成要素の情報を指定します。

構成要素タブは，ローカル定義の単純内容要素を設定する場合にだけ表示されます。単純内容要素タブの［サイズ］に0を指定した場合は非活性となります。

図1‒50　［単純内容要素］ダイアログ（構成要素タブ）

指定する内容は，［構成要素］ダイアログの構成要素タブと同じです。

［構成要素］ダイアログの構成要素タブについては，「1.3.4(3)　構成要素タブ（単純内容要素）」を参照してください。

(3)　各タブで共通の内容

各タブで共通の内容を次に示します。

［インフォメーション］

［単純内容要素］ダイアログの入力情報に問題がある場合に，ダイアログの最上段に問題点を示すメッセージが表示されます。表示されるメッセージと対策については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4.4.7　バイナリフォーマット定義ファイルを検証する」を参照してください。

［名称］

単純内容要素の名称を指定します。NCName型で使用できる文字を利用して256文字以内で指定します。

［OK］ボタン

指定した内容を設定して［単純内容要素］ダイアログを閉じます。

［キャンセル］ボタン

指定した内容を設定しないで［単純内容要素］ダイアログを閉じます。

1.3.3　複合内容要素ダイアログ

［複合内容要素］ダイアログは，バイナリフォーマット定義ファイルに複合内容要素を設定するときに使用します。また，複合内容要素にセパレータを設定するときにも使用します。

操作手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4.4.4　要素を定義する（CSV以外の形式の場合）」を参照してください。

［複合内容要素］ダイアログは，複合内容要素を設定する場合と，セパレータを設定する場合で操作するタブが異なります。

(1)　複合内容要素タブ

複合内容要素タブは，複合内容要素の情報を指定するときに使用します。

構成区分が［選択構成］の場合，利用する構成要素を何から選択するかによって，表示される画面が変わります。

図1‒51　［複合内容要素］ダイアログ（複合内容要素タブ：構成要素を選択条件ノードの値から選択する場合）

図1‒52　［複合内容要素］ダイアログ（複合内容要素タブ：構成要素を開始セパレータの値から選択する場合）

［構成区分］

複合内容要素に設定された構成要素の構成区分をラジオボタンで選択します。

逐次構成の場合

［逐次構成］を選択します。

選択構成の場合

［選択構成］を選択します。

［選択種別］

構成区分が［選択構成］の場合，選択構成の選択種別をラジオボタンで選択します。

選択条件ノードの値から，利用する構成要素を選択する場合

［選択条件ノード］を選択し，［ノード選択］ボタンをクリックして選択条件ノードを指定します。

構成要素の開始セパレータの値から，利用する構成要素を選択する場合

［構成要素の開始セパレータ］を選択します。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。構成要素の選択条件ノードを選択するときに使用します。

［ノード選択］ダイアログで選択したノードは次のように表示されます。

基準パスで選択した場合

基準ノードからの相対パスが表示されます。

絶対パスで選択した場合

ルート要素からのパスが表示されます。

［構成要素一覧］

複合内容要素に設定された構成要素の一覧が表示されます。

［名称］

構成要素に設定されている単純内容要素および複合内容要素の名称が表示されます。

［選択条件値］

構成区分が［選択構成］で選択種別が［選択条件ノード］の場合，構成要素に設定されている選択条件値が表示されます。構成区分が［逐次構成］の場合，および構成区分が［選択構成］で選択種別が［構成要素の開始セパレータ］の場合，この項目は表示されません。

1つの要素に複数の選択条件値が設定されている場合は，区切り文字で区切って表示されます。

構成区分が［選択構成］で選択種別が［選択条件ノード］の場合，［選択条件値］に表示されているどの値にも当てはまらないときは，選択条件値が表示されていない構成要素が出現します。このような構成要素は，構成要素の中で1つだけ設定できます。

［開始セパレータ値］

構成区分が［選択構成］で選択種別が［構成要素の開始セパレータ］の場合，構成要素に設定されている開始セパレータ値が表示されます。構成区分が［逐次構成］の場合，および構成区分が［選択構成］で選択種別が［選択条件ノード］の場合，この項目は表示されません。

構成区分が［選択構成］で選択種別が［構成要素の開始セパレータ］の場合で，［開始セパレータ値］に表示されているどの値にも当てはまらないとき，次に示す構成要素が出現します。

開始セパレータ値が表示されていない構成要素

単純内容要素である構成要素

このような構成要素は，構成要素の中で1つだけ設定できます。

［上へ］ボタン

構成要素一覧で選択した構成要素の配置を1つ上に変更します。

［下へ］ボタン

構成要素一覧で選択した構成要素の配置を1つ下に変更します。

［条件値設定］ボタン

構成区分が［選択構成］で選択種別が［選択条件ノード］の場合，このボタンをクリックすると，［条件値設定］ダイアログが表示されます。構成区分が［逐次構成］の場合，および［選択構成］で選択種別が［構成要素の開始セパレータ］の場合，このボタンは表示されません。構成要素一覧で選択した構成要素の選択条件値を設定するときに使用します。

(2)　セパレータタブ

セパレータタブは，複合内容要素にセパレータを設定する場合に使用します。

図1‒53　［複合内容要素］ダイアログ（セパレータタブ）

［セパレータ形式］

使用するセパレータ形式をドロップダウンリストから選択します。選択できるセパレータを次に示します。

ユーザ指定：ユーザが各セパレータを設定します。

CSV：CSV形式のセパレータを自動で設定します。

なお，セパレータ形式にCSVを選択した場合，開始セパレータおよび中間区切りセパレータは次のように設定されます。

開始セパレータ：なし

中間セパレータ：コンマ（,）

開始セパレータ，中間区切りセパレータ，終了セパレータとして使用するセパレータを，次の項目を利用してそれぞれ指定します。

［使用する］チェックボックス

各セパレータを使用する場合にチェックします。

［セパレータ名称］

使用するセパレータの名称を指定します。

［選択］ボタン

［セパレータ選択］ダイアログが表示されます。

［セパレータ値］

［セパレータ名称］を指定した場合，定義されているセパレータの値が表示されます。セパレータの値は［ ］で囲まれて表示されます。

(3)　各タブで共通の内容

各タブで共通の内容を次に示します。

［インフォメーション］

［複合内容要素］ダイアログの入力情報に問題がある場合に，ダイアログの最上段に問題点を示すメッセージが表示されます。表示されるメッセージと対策については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4.4.7　バイナリフォーマット定義ファイルを検証する」を参照してください。

［名称］

複合内容要素の名称を指定します。NCName型で使用できる文字を利用して256文字以内で指定します。

［OK］ボタン

指定した内容を設定して［複合内容要素］ダイアログを閉じます。

［キャンセル］ボタン

指定した内容を設定しないで［複合内容要素］ダイアログを閉じます。

1.3.4　構成要素ダイアログ

［構成要素］ダイアログは，グローバル定義の単純内容要素または複合内容要素を，複合内容要素の構成要素に設定するときに使用します。

操作手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4.4.4　要素を定義する（CSV以外の形式の場合）」を参照してください。

［構成要素］ダイアログは，グローバル定義の単純内容要素を構成要素に設定する場合と，複合内容要素を構成要素に設定する場合で表示されるタブが異なります。

(1)　単純内容要素タブ

単純内容要素タブは，単純内容要素を構成要素に設定する場合にだけ表示されます。構成要素に設定する単純内容要素の情報が表示されます。内容は変更できません。

図1‒54　［構成要素］ダイアログ（単純内容要素タブ）

表示される情報は，構成要素に設定するグローバル定義の単純内容要素を設定するときに，［単純内容要素］ダイアログの単純内容要素タブで設定した値です。

［単純内容要素］ダイアログの単純内容要素タブについては，「1.3.2(1)　単純内容要素タブ」を参照してください。

(2)　複合内容要素タブ

複合内容要素タブは，複合内容要素を構成要素に設定する場合にだけ表示されます。構成要素に設定する複合内容要素の情報が表示されます。内容は変更できません。

図1‒55　［構成要素］ダイアログ（複合内容要素タブ）

表示される情報は，構成要素に設定する複合内容要素を設定するときに，［複合内容要素］ダイアログで設定した値です。

［複合内容要素］ダイアログについては，「1.3.3　複合内容要素ダイアログ」を参照してください。

(3)　構成要素タブ（単純内容要素）

構成要素タブには構成要素の情報を指定します。構成要素タブは，構成要素に設定する要素がグローバル定義の単純内容要素でも複合内容要素でも表示されます。構成要素が単純内容要素の場合に表示される構成要素タブを次に示します。

図1‒56　［構成要素］ダイアログ（単純内容要素の構成要素タブ）

［出現回数］

構成要素の出現回数を指定します。

出現回数が固定の場合

ラジオボタンで［固定］を選択し，出現回数を1〜2,147,483,647で指定します。

出現回数を範囲で指定する場合

ラジオボタンで［範囲指定］を選択し，［最小］と［最大］で出現回数の範囲を指定します。設定できる範囲は，1〜2,147,483,647です。

データの終端までを要素とする場合

ラジオボタンで［データの終端まで］を選択します。なお，必ず1回以上出現させる場合は，［データの省略不可］チェックボックスにチェックします。

参考

データの終端とは次の場合を示します。

設定された各要素のセパレータの組み合わせからデータ終端と判断できるセパレータが出現した場合

全データを読み取った場合

設定された複合内容要素のサイズノードから，指定されたサイズのデータを読み取った場合

出現回数をほかの要素に依存させる場合

ラジオボタンで［出現回数ノード］を選択し，［ノード選択］ボタンをクリックして依存させるノードを選択します。バイナリデータとしてCSV形式のデータを扱う場合，非活性になります。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。構成要素の出現回数をほかの要素に依存させる場合，依存させるノードを選択するときに使用します。

［ノード選択］ダイアログで選択したノードは次のように表示されます。

基準パスで選択した場合

基準ノードからの相対パスが表示されます。

絶対パスで選択した場合

ルート要素からのパスが表示されます。

［サイズ］

単純内容要素タブの［サイズ］で［可変］を選択した場合に，構成要素である単純内容要素として使用するデータのサイズを設定します。バイナリデータとしてCSV形式のデータを扱う場合，非活性になります。

データの終端までを要素とする場合

ラジオボタンで［データの終端まで］を選択します。単純内容要素タブの場合だけ活性になります。

参考

データの終端とは次の場合を示します。

設定された各要素のセパレータの組み合わせからデータ終端と判断できるセパレータが出現した場合

全データを読み取った場合

設定された複合内容要素のサイズノードから，指定されたサイズのデータを読み取った場合

サイズをほかの要素に依存させる場合

ラジオボタンで［サイズノード］を選択し，［ノード選択］ボタンをクリックして依存させるノードを選択します。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。構成要素である単純内容要素のサイズをほかの要素に依存させる場合，依存させるノードを選択するときに使用します。

［ノード選択］ダイアログで選択したノードは次のように表示されます。

基準パスで選択した場合

基準ノードからの相対パスが表示されます。

絶対パスで選択した場合

ルート要素からのパスが表示されます。

［サイズ算出方法］

サイズノードのサイズの算出方法を次の中からドロップダウンリストで選択します。サイズ算出方法の設定のない過去バージョンのバイナリフォーマット定義を利用すると，「システム既定値」が仮定されます。

指定値

サイズノードの値

システム既定値（デフォルト）

サイズノードの拡張機能の有効／無効は，実行環境のJ2EEサーバ用ユーザプロパティファイル（usrconf.properties）のcsc.dt.sizeNode.includeSelfSizeプロパティの設定値に従います。

J2EEサーバ用ユーザプロパティファイルの設定については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「2.3.9　J2EEサーバ用ユーザプロパティファイル（usrconf.properties）を設定する」を参照してください。

データ長のみ

サイズノードの拡張機能は無効となり，サイズノードの長さは，サイズノードの設定元要素のサイズが適用されます。

サイズノードの長さも含める

サイズノードの拡張機能が有効となり，サイズノードの長さは，サイズノードの設定元要素のサイズと，サイズノード自身のサイズの合計が適用されます。

［サイズノード値の単位］

サイズノード値の単位を次の中から選択します。

バイト数（デフォルト）

サイズノードの値をバイト単位で換算します。

桁数

サイズノードの値をデータの桁数で換算します。

［桁数］を選択すると，［サイズ算出方法］は非活性となります。

この項目は，単純内容要素タブで［データ種別］に「パック形式数値」，［サイズ］に［可変］ラジオボタンを選択した場合に，構成要素タブで［サイズノード］ラジオボタンを選択すると活性化されます。

(4)　構成要素タブ（複合内容要素）

構成要素タブには構成要素の情報を指定します。構成要素タブは，構成要素に設定する要素がグローバル定義の単純内容要素でも複合内容要素でも表示されます。構成要素が複合内容要素の場合に表示される構成要素タブを次に示します。

図1‒57　［構成要素］ダイアログ（複合内容要素の構成要素タブ）

［出現回数］

出現回数が固定の場合

CSV形式のヘッダ要素のとき，ラジオボタンで［固定］を選択し，出現回数を0〜1で指定します。

CSV形式のレコード要素または非CSV形式のとき，ラジオボタンで［固定］を選択し，出現回数を1〜2,147,483,647で指定します。

出現回数を範囲で指定する場合

CSV形式のレコード要素または非CSV形式のとき，ラジオボタンで［範囲指定］を選択し，［最小］と［最大］で出現回数の範囲を指定します。設定できる範囲は，1〜2,147,483,647です。

CSV形式のヘッダ要素のとき，［範囲指定］は非活性になります。

データの終端までを要素とする場合

CSV形式のレコード要素または非CSV形式のとき，ラジオボタンで［データの終端まで］を選択します。なお，必ず1回以上出現させる場合は，［データの省略不可］チェックボックスにチェックします。

CSV形式のヘッダ要素のとき，［データの終端まで］は非活性になります。

参考

データの終端とは次の場合を示します。

設定された各要素のセパレータの組み合わせからデータ終端と判断できるセパレータが出現した場合

全データを読み取った場合

設定された複合内容要素のサイズノードから，指定されたサイズのデータを読み取った場合

出現回数をほかの要素に依存させる場合

非CSV形式のとき，ラジオボタンで［出現回数ノード］を選択し，［ノード選択］ボタンをクリックして依存させるノードを選択します。

CSV形式のヘッダ要素またはレコード要素のとき，［出現回数ノード］は非活性になります。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。構成要素の出現回数をほかの要素に依存させる場合，依存させるノードを選択するときに使用します。

［ノード選択］ダイアログで選択したノードは次のように表示されます。

基準パスで選択した場合

基準ノードからの相対パスが表示されます。

絶対パスで選択した場合

ルート要素からのパスが表示されます。

［サイズ］

構成要素タブの出現回数が固定で1回の場合に，構成要素である複合内容要素として使用するデータのサイズを設定します。バイナリデータとしてCSV形式のデータを扱う場合，非活性になります。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。構成要素である複合内容要素のサイズをほかの要素に依存させる場合，依存させるノードを選択するときに使用します。

［ノード選択］ダイアログで選択したノードは次のように表示されます。

基準パスで選択した場合

基準ノードからの相対パスが表示されます。

絶対パスで選択した場合

ルート要素からのパスが表示されます。

［除去］ボタン

［サイズノード］の値を削除します。

［サイズ算出方法］

サイズノードのサイズの算出方法を次の中からドロップダウンリストで選択します。

指定値

サイズノードの値

システム既定値（デフォルト）

サイズノードの拡張機能の有効／無効は，実行環境のJ2EEサーバ用ユーザプロパティファイル（usrconf.properties）のcsc.dt.sizeNode.includeSelfSizeプロパティの設定値に従います。

J2EEサーバ用ユーザプロパティファイルの設定については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「2.3.9　J2EEサーバ用ユーザプロパティファイル（usrconf.properties）を設定する」を参照してください。

データ長のみ

サイズノードの拡張機能は無効となり，サイズノードの長さは，サイズノードの設定元要素のサイズが適用されます。

サイズノードの長さも含める

サイズノードの拡張機能が有効となり，サイズノードの長さは，サイズノードの設定元要素のサイズと，サイズノード自身のサイズの合計が適用されます。

(5)　セパレータタブ

セパレータタブは，複合内容要素を構成要素に設定する場合にだけ表示されます。構成要素に設定する複合内容要素のセパレータの情報が表示されます。内容は変更できません。

図1‒58　［構成要素］ダイアログ（セパレータタブ）

表示される情報は，構成要素に設定する複合内容要素にセパレータを設定するときに，［複合内容要素］ダイアログで設定した値です。

［複合内容要素］ダイアログについては，「1.3.3　複合内容要素ダイアログ」を参照してください。

(6)　各タブで共通の内容

各タブで共通の内容を次に示します。

［インフォメーション］

［構成要素］ダイアログの入力情報に問題がある場合に，ダイアログの最上段に問題点を示すメッセージが表示されます。表示されるメッセージと対策については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4.4.7　バイナリフォーマット定義ファイルを検証する」を参照してください。

［名称］

構成要素に設定する要素の名称が表示されます。

［OK］ボタン

指定した内容を設定して［構成要素］ダイアログを閉じます。

［キャンセル］ボタン

指定した内容を設定しないで［構成要素］ダイアログを閉じます。

1.3.5　条件値設定ダイアログ

［条件値設定］ダイアログは，選択構成の複合内容要素の構成要素に選択条件値を設定するときに使用します。

操作手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4.4.4　要素を定義する（CSV以外の形式の場合）」を参照してください。

図1‒59　［条件値設定］ダイアログ

［インフォメーション］

［条件値設定］ダイアログの入力情報に問題がある場合に，ダイアログの最上段に問題点を示すメッセージが表示されます。表示されるメッセージと対策については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4.4.7　バイナリフォーマット定義ファイルを検証する」を参照してください。

［選択条件］

［ノード］

選択条件ノードが表示されます。

［データ種別］

選択条件ノードのデータ種別が表示されます。

［使用不可文字］

選択条件ノードのデータ種別が文字列の場合に，XMLで使用できない文字を置換するかどうかが次のどちらかで表示されます。

代替文字に置換しない

代替文字に置換する

［先頭代替文字］

選択条件ノードのデータ種別が文字列で，［使用不可文字］に「代替文字に置換する」が表示されている場合，代替文字の最初の1文字が0xXXXXの形式で表示されます。

［形式］

選択条件ノードのデータ種別が日付時刻の場合，日付時刻の形式が表示されます。

［全体桁数］

選択条件ノードのデータ種別が整数，実数，固定小数部数値の場合，全体桁数の設定状態が表示されます。

［小数部桁数］

選択条件ノードのデータ種別が実数，固定小数部数値，ゾーン形式数値，パック形式数値，または日付時刻（時刻を含む形式）の場合，小数部分の桁数が表示されます。小数部分の桁数が指定されていない場合は表示されません。

［符号の有無］

選択条件ノードのデータ種別が整数，実数または固定小数部数値の場合，符号の有無が表示されます。

また，ゾーン形式数値またはパック形式数値で，符号の設定が［カスタム］の場合，符号の有無が表示されます。

［エンコード形式］

選択条件ノードのデータ種別がバイト列の場合，エンコード形式としてスキーマのデータ型である次のどちらかが表示されます。

hexBinary

base64Binary

［サイズ（<単位>）］

選択条件ノードのサイズが固定値の場合，その値が表示されます。可変値の場合には「可変」と表示されます。

<単位>はデータ種別に応じて［バイト］または［ビット］が表示されます。

［名称］

選択条件値を設定する構成要素の名称が表示されます。

［条件値］

1つの要素に対して1つの選択条件値を指定する場合は［単一条件指定］，複数の選択条件値を指定する場合は［複数条件指定］を選択します。

指定できる条件値は，選択条件ノードのデータ種別によって異なります。指定できる条件値については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4.4.7　バイナリフォーマット定義ファイルを検証する」を参照してください。

［単一条件指定］

1つの要素に対して1つの選択条件値を指定する場合に，選択条件値を1,024文字以内で指定します。

［複数条件指定］

1つの要素に対して複数の選択条件値を指定する場合に，選択条件値と区切り文字を指定します。

［条件値］

選択条件値を区切り文字で区切って指定します。選択条件値の文字数に制限はありません。

［区切り文字］

区切り文字のデフォルト値「,（半角コンマ）」を変更したい場合に指定します。使用できる文字は1文字のラテン文字（0x21〜0x7E），または半角スペース（0x20）です。

区切り文字に指定した文字は，選択条件値の一部として使用できません。また，エスケープシーケンスのような定義方法はありません。

例えば，選択条件値として「aaa,bbb,ccc」，区切り文字として「,（半角コンマ）」が指定された構成要素は，選択条件ノードに対して「aaa」，「bbb」，または「ccc」を入力した際に選択されます。

複数の選択条件値を「,（半角コンマ）」で区切って指定する例を次に示します。

aaa,bbb,ccc,zzz

［OK］ボタン

指定した内容を設定して［条件値設定］ダイアログを閉じます。

［キャンセル］ボタン

指定した内容を設定しないで［条件値設定］ダイアログを閉じます。

1.3.6　ノード選択ダイアログ（バイナリフォーマット定義）

［ノード選択］ダイアログ（バイナリフォーマット定義）は，構成要素の出現回数やサイズをほかの要素から参照する場合のターゲットノードや，構成要素の選択条件値を持つ選択条件ノードを選択するときに使用します。

次のダイアログにある［ノード選択］ボタンをクリックした場合に表示されます。

［単純内容要素］ダイアログ（構成要素タブ）

［構成要素］ダイアログ（構成要素タブ）

［複合内容要素］ダイアログ

図1‒60　［ノード選択］ダイアログ（バイナリフォーマット定義）

［インフォメーション］

［ノード選択］ダイアログの入力情報に問題がある場合に，ダイアログの最上段に問題点を示すメッセージが表示されます。表示されるメッセージと対策については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4.4.7　バイナリフォーマット定義ファイルを検証する」を参照してください。

［パス指定］

ターゲットノードまたは選択条件ノードの指定方法をラジオボタンで選択します。

［基準パス］ラジオボタン

基準ノードからのパスでターゲットノードまたは選択条件ノードを指定する場合に選択します。

基準ノードとは，参照元の構成要素（依存ノード）がツリー全体に複数ある場合に，共通するツリー構成部分の最上位ノードです。

［基準パス］を選択すると，［ノード構成］には基準ノードからの構成がツリー表示されます。

［基準パス］を選択した場合の例を次の図に示します。

図1‒61　基準パスを選択した場合の例

［絶対パス］ラジオボタン

ルート要素からのパスでターゲットノードまたは選択条件ノードを指定する場合に選択します。

［絶対パス］を選択すると，［ノード構成］にはルート要素からの構成がツリー表示されます。

［絶対パス］を選択した場合の例を次の図に示します。

図1‒62　絶対パスを選択した場合の例

［ノード構成］

［パス指定］の選択に従って，ノードの構成がツリー表示されます。表示されたツリーからターゲットノードまたは選択条件ノードを選択します。

［OK］ボタン

指定した内容を設定して［ノード選択］ダイアログを閉じます。

［キャンセル］ボタン

指定した内容を設定しないで［ノード選択］ダイアログを閉じます。

1.3.7　要素選択ダイアログ

［要素選択］ダイアログは，構成要素として設定するグローバル定義の要素を選択するときに使用します。

操作手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4.4.4　要素を定義する（CSV以外の形式の場合）」を参照してください。

図1‒63　［要素選択］ダイアログ

［インフォメーション］

［要素選択］ダイアログの入力情報に問題がある場合に，ダイアログの最上段に問題点を示すメッセージが表示されます。表示されるメッセージと対策については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4.4.7　バイナリフォーマット定義ファイルを検証する」を参照してください。

［要素一覧］

構成要素として設定する要素を選択します。

［名称］

構成要素として設定できるグローバル定義の要素が表示されます。

［要素］

単純内容要素の場合は「単純内容」，複合内容要素の場合は「複合内容」と表示されます。

［OK］ボタン

指定した内容を設定して［要素選択］ダイアログを閉じます。

［キャンセル］ボタン

指定した内容を設定しないで［要素選択］ダイアログを閉じます。

1.3.8　セパレータ選択ダイアログ

［セパレータ選択］ダイアログは，複合内容要素の開始セパレータ，中間区切りセパレータおよび終了セパレータとして設定するセパレータを選択するダイアログです。

［複合内容要素］ダイアログ（セパレータタブ）の，各セパレータの指定欄にある［選択］ボタンをクリックした場合に表示されます。

図1‒64　［セパレータ選択］ダイアログ

［インフォメーション］

［セパレータ選択］ダイアログの入力情報に問題がある場合に，ダイアログの最上段に問題点を示すメッセージが表示されます。表示されるメッセージと対策については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4.4.7　バイナリフォーマット定義ファイルを検証する」を参照してください。

［セパレータ名称一覧］

［名称］

定義されているセパレータの名称が表示されます。

［値］

定義されているセパレータの値が表示されます。セパレータの値は［ ］で囲まれて表示されます。

［追加］ボタン

セパレータとして使用する文字を新たに追加するときに使用します。［セパレータ追加/変更］ダイアログが表示されます。

［変更］ボタン

すでに定義されているセパレータの名称およびセパレータの値を変更するときに使用します。［セパレータ名称一覧］から情報を変更するセパレータを選択してクリックすると，［セパレータ追加/変更］ダイアログが表示されます。

なお，次のセパレータの情報は変更できません。

「LineFeed」および「Comma」（初期設定されているセパレータ）

同じ複合内容要素の中で，すでにほかのセパレータとして指定されているセパレータ

［削除］ボタン

すでに定義されているセパレータを削除するときに使用します。［セパレータ名称一覧］から削除するセパレータを選択してクリックすると，選択したセパレータが削除されます。

なお，次のセパレータは削除できません。

「LineFeed」および「Comma」（初期設定されているセパレータ）

同じ複合内容要素の中で，すでにほかのセパレータとして指定されているセパレータ

［OK］ボタン

指定した内容を設定して［セパレータ選択］ダイアログを閉じます。

［キャンセル］ボタン

指定した内容を設定しないで［セパレータ選択］ダイアログを閉じます。

1.3.9　セパレータ追加/変更ダイアログ

［セパレータ追加/変更］ダイアログは，複合内容要素の開始セパレータ，中間区切りセパレータおよび終了セパレータとして使用するセパレータを追加したり，セパレータの情報を変更したりするダイアログです。

［セパレータ選択］ダイアログの，［追加］ボタンまたは［変更］ボタンをクリックした場合に表示されます。

図1‒65　［セパレータ追加/変更］ダイアログ

［インフォメーション］

［セパレータ追加/変更］ダイアログの入力情報に問題がある場合に，ダイアログの最上段に問題点を示すメッセージが表示されます。表示されるメッセージと対策については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4.4.7　バイナリフォーマット定義ファイルを検証する」を参照してください。

［セパレータ名称］

セパレータの名称を指定します。NCName型で256文字以内で指定します。

すでに定義されているセパレータの情報を変更する場合には，セパレータ名称が初期表示されます。セパレータを新規追加する場合には，「Sepa-」という接頭語に通し番号が付いた名称が初期表示されます。

［セパレータ値］

［文字列］ラジオボタン

セパレータの値として文字列を使用する場合に選択します。

［バイト列］ラジオボタン

セパレータの値としてバイト列を使用する場合に選択します。

［値］

セパレータの値として使用する文字列またはバイト列を指定します。文字列の場合，指定できる文字は，ラテン文字（JIS X 0201の「0x21」〜「0x7E」）または半角スペース（JIS X 0201の「0x20」）で1,024文字以内です。

セパレータの値としてASCII文字列の「012」を表現したい場合の指定例を次に示します。

文字列の場合

「012」と，文字列をそのまま指定します。

バイト列の場合

「303132」と，16進数の0x表記なしの形式で指定します。

［OK］ボタン

指定した内容を設定して［セパレータ追加/変更］ダイアログを閉じます。

［キャンセル］ボタン

指定した内容を設定しないで［セパレータ追加/変更］ダイアログを閉じます。

1.3.10　［新規バイナリフォーマット定義ファイル］ウィザードのページ

［新規バイナリフォーマット定義ファイル］ウィザードを選択したときに表示されるページの設定項目について説明します。バイナリフォーマット定義ファイルの作成手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4.4.3　バイナリフォーマット定義ファイルを新規作成する」を参照してください。

(1)　COBOL登録集原文設定ページ

変換するCOBOL登録集原文ファイルや，変換時に必要な情報を設定するページです。

図1‒66　COBOL登録集原文設定ページ

［COBOL登録集原文のファイル名］

変換するCOBOL登録集原文ファイル名を指定します。

［参照］ボタン

COBOL登録集原文ファイルを設定するダイアログが表示されます。

［PICTURE句の通貨編集文字］

PICTURE句の文字列で使用する通貨文字を指定します。初期値は「¥」が指定されています。

PICTURE句の通貨編集文字に指定できる文字を次に示します。

「!」，「#」，「$」，「%」，「&」，「<」，「>」，「?」，「@」，「F」，「G」，「H」，「I」，「J」，「K」，「L」，「M」，「O」，「Q」，「T」，「U」，「W」，「Y」，「[」，「¥」，「]」，「^」，「_」，「`」，「{」，「|」，「}」，「~」，半角カタカナ（MS932コードの0xA1〜0xDF）

［基本項目の文字コード］

基本項目で使用されている文字コードを選択します。初期値は「MS932」が選択されています。ここで選択した文字コードは，バイナリフォーマット定義ファイルの文字コードとして設定されます。

基本項目で選択できる文字コードを次に示します。

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

［2進形式のエンディアン］

2進形式のエンディアンをビッグエンディアンまたはリトルエンディアンのどちらかから選択します。初期値は「リトルエンディアン」が選択されています。

［次へ］ボタン

データ項目設定ページへ進みます。

(2)　データ項目設定ページ

COBOL登録集原文ファイルを変換した結果が表示されます。各項目は複数列のツリービューで表示されます。

図1‒67　データ項目設定ページ

［定義項目］

［レベル番号］

COBOL登録集原文ファイルで指定されていた項目のレベル番号が表示されます。集団項目で下位の項目を非表示にしたい場合は，［レベル番号］の左のボタンをクリックします。

［データ名］

COBOL登録集原文ファイルで指定されていた項目のデータ名が表示されます。

［別名］

バイナリフォーマット定義ファイルの要素名として使用される名称が表示されます。セルをクリックすることで名称を変更できます。［別名］を設定しない場合は，［データ名］に表示された名称がバイナリフォーマット定義ファイルの要素名となります。

［別名］に入力できる文字列は，次の条件を満たしている必要があります。条件を満たしていない場合，［別名］は設定されません。

NCNameで使用できる文字であること

NCNameで使用できない文字が使用されている場合は，「_」に置き換えられます。

同じ親を持つ兄弟データ項目のデータ名または別名と重複しないこと

なお，FILLERの場合は同じ親を持つ兄弟データ項目ごとに「_.00001」，「_.00002」のように，先頭2文字が「_.」で，残り5文字が昇順の番号となる名称で別名が設定されます。

［データ名］に表示された名称が，同じ親を持つ兄弟データ項目のデータ名または別名と重複する場合は，［データ名］の末尾に数値が付加された名称が別名に設定されます。

［データ種別］

変換後のバイナリフォーマット定義ファイルでの属性が表示されます。COBOLのデータ型と変換後のバイナリフォーマット定義ファイルのデータ型の対応については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4.5.2　データ項目の設定（COBOL85言語の形式を使用する場合）」のデータ型の対応の説明を参照してください。

［出現回数］

COBOL登録集原文ファイルのOCCURS句で2以上の値が指定されている場合に，指定された値が表示されます。

［次へ］ボタン

出力ファイル設定ページへ進みます。

(3)　出力ファイル設定ページ

バイナリフォーマット定義ファイルを出力するときに使用します。

図1‒68　出力ファイル設定ページ

［親フォルダを入力または選択］

入力または選択したフォルダ名が表示されます。

［ファイル名］

バイナリフォーマット定義ファイル名を指定できます。初期値は「（フォーマット名）+".fdx"」が指定されています。NCNameで使用できる文字を入力できます。

［フォーマット名］

バイナリフォーマット定義ファイルのフォーマット名を指定できます。初期値は［ファイル名］から拡張子を除いた文字列となります。NCNameで使用できる文字を入力できます。［フォーマット名］に文字を入力すると，「入力した文字+".fdx"」が［ファイル名］にも連動して設定されます。

1.4　ビジネスプロセスに関連するダイアログ

ビジネスプロセスに関連するダイアログについて説明します。

注意事項

ビジネスプロセスに関連するダイアログでは，入力項目の前後に半角スペースや全角スペースを指定できません。

1.4.1　変数・相関セット一覧ダイアログ

［変数・相関セット一覧］ダイアログは，変数や相関セットを追加，変更したり，一覧を表示したりするときに使用します。

操作手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.5.1　変数の定義」および「5.5.2　相関セットの定義」を参照してください。

図1‒69　［変数・相関セット一覧］ダイアログ（変数情報の表示）

図1‒70　［変数・相関セット一覧］ダイアログ（相関セット情報の表示）

［変数一覧］

プロセスまたはスコープに属する定義済み変数の一覧が表示されます。

［変数名］

変数名を64バイト以内で指定します。

［種別］

変数の種別を次の6種類から選択します。

XML型（XML）

バイナリ型（non-XML）

any型（any）

数値（numeric）

文字列（string）

真偽値（boolean）

［電文フォーマット］

変数の種別がメッセージ型（XML，non-XML）の場合に，電文フォーマットとなるファイルが表示されます。

［取込］ボタン

変数の種別がメッセージ型（XML，non-XML）の場合に，呼び出すサービス部品またはユーザ定義受付の要求電文，応答電文またはフォルト電文に設定されている電文フォーマットを，変数に設定する場合に使用します。

［電文フォーマットの取込］ダイアログが表示されます。［電文フォーマットの取込］ダイアログでは，変数に設定する電文フォーマットを指定します。

［参照］ボタン

変数の種別がメッセージ型（XML，non-XML）の場合に，電文フォーマットとなるファイルを指定します。

［表示］ボタン

変数の種別がメッセージ型（XML，non-XML）の場合，変数のパスを取得するときに使用します。［変数の表示］ダイアログが表示されます。

［出力］ボタン

電文フォーマットのファイルの出力先を指定するダイアログが表示されます。

［部分指定］チェックボックス

変数の種別がメッセージ型（XML，non-XML）の場合，部分指定をするためにチェックします。

［部分名］

部分指定をする場合，部分名を指定します。

部分名は，次の条件に従って指定します。

部分の型がメッセージ型（XML）の場合

部分名はビジネスプロセス内で一意である必要があります。

部分の型が数値（numeric），文字列（string）または真偽値（boolean）の場合

電文フォーマットが異なる変数で，同じ部分の型である場合，同じ部分名を使用できます。

上記以外の場合，部分名は一意である必要があります。

［指定式］

部分指定をする場合，部分名に対応する式を指定します。指定式には，［変数の表示］ダイアログの［選択パス］で取得したパスを指定します。

［型］

部分名に対応する型を選択します。

変数の種別がメッセージ型（XML）の場合

メッセージ型（XML），数値（numeric），文字列（string），真偽値（boolean）の4種類から選択します。

変数の種別がメッセージ型（non-XML）の場合

数値（numeric），文字列（string），真偽値（boolean）の3種類から選択します。

［相関セット一覧］

プロセスまたはスコープに属する定義済み相関セットの一覧が表示されます。

［相関セット名］

相関セット名を64バイト以内で指定します。

［取得部］

［利用変数］

相関セットの定義に利用する電文フォーマットを持つ変数を指定します。所属しているスコープおよびその親スコープで定義済みの，基本型の部分を持つメッセージ型の変数が表示されます。

［部分名］

［利用変数］で選択した変数に対して，相関セットとして利用する基本型の部分の，部分名を指定します。

［行追加］ボタン

部分指定または取得部指定をするための行を追加します。

［行削除］ボタン

不要な部分指定または取得部指定の行を削除します。

［追加］ボタン

定義した変数や相関セットの情報を新規追加します。

［削除］ボタン

定義した変数や相関セットの情報を削除します。

［更新］ボタン

定義済みの変数や相関セットの情報の内容を更新します。

［OK］ボタン

定義した内容で，［変数・相関セット一覧］ダイアログを閉じます。

［キャンセル］ボタン

定義した内容を取り消し，定義前の内容で［変数・相関セット一覧］ダイアログを閉じます。

1.4.2　ヘッダ割当変数ダイアログ

［ヘッダ割当変数］ダイアログは，ヘッダ割当変数を設定するときに使用します。

受付アクティビティ，応答アクティビティ，およびサービス呼出アクティビティのヘッダ割当変数の［設定］ボタンをクリックした場合に表示されます。

図1‒71　［ヘッダ割当変数］ダイアログ

［割当変数］

割当変数が昇順に表示されます。

［ルート要素］

割当変数に定義したルート要素が表示されます。

［名前空間］

ルート要素の名前空間が表示されます。

［追加］ボタン

表の最下行に新しい行を追加します。

［削除］ボタン

［割当変数］に表示された割当変数を行ごと削除します。一度に複数の割当変数の行を選択して削除できます。

［OK］ボタン

定義した内容で，［ヘッダ割当変数］ダイアログを閉じます。

［キャンセル］ボタン

定義した内容を取り消し，定義前の内容で［ヘッダ割当変数］ダイアログを閉じます。

1.4.3　割当相関セット群ダイアログ

［割当相関セット群］ダイアログは，［変数・相関セット一覧］ダイアログで定義した相関セットグループをアクティビティに割り当てるときに使用します。

受付アクティビティ，応答アクティビティ，およびサービス呼出アクティビティの［設定］ボタンをクリックした場合に表示されます。

操作手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.5.2　相関セットの定義」を参照してください。

図1‒72　［割当相関セット群］ダイアログ

［相関セット］

要求電文や応答電文に割り当てる相関セットを，ドロップダウンリストから選択します。ドロップダウンリストには，［変数・相関セット一覧］ダイアログで定義済みの相関セットだけが表示されます。

［追加］ボタン

［相関セット］で選択した相関セットを［相関セット名］に追加します。

［編集］ボタン

［変数・相関セット一覧］ダイアログが表示されます。

［削除］ボタン

［相関セット名］に表示された相関セットを行ごと削除します。一度に複数の相関セットの行を選択して削除できます。

［相関セット名］

［相関セット］で選択した相関セットが表示されます。

［初期化］

相関セットを初期化するかどうかを選択します。初期化する場合は「yes」を，初期化しない場合は「no」を選択します。

［パターン］

相関セットのパターンを選択します。受付アクティビティ，および応答アクティビティから相関セットの割当があった場合は，「−」が表示されます。

［OK］ボタン

定義した内容で，［割当相関セット群］ダイアログを閉じます。

［キャンセル］ボタン

定義した内容を取り消し，定義前の内容で［割当相関セット群］ダイアログを閉じます。

1.4.4　変数の表示ダイアログ

［変数の表示］ダイアログは，変数のパスを取得する場合に使用します。

［変数・相関セット一覧］ダイアログなどの［表示］ボタンをクリックした場合に表示されます。

操作手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.5.1　変数の定義」を参照してください。

図1‒73　［変数の表示］ダイアログ

［変数の内容］

［変数・相関セット一覧］ダイアログなどで選択した変数の内容がツリービューで表示されます。

表示された変数を選択し，右クリックして［パスの取得］を選択すると，ルート要素からの絶対パスを取得できます。取得したパスは，任意の個所に貼り付けることができます。

［選択パス］

ツリービューで表示された変数を選択すると，選択した変数のパスがルート要素からの絶対パスで表示されます。

［閉じる］ボタン

［変数の表示］ダイアログを閉じます。

1.4.5　電文フォーマットの取込ダイアログ

呼び出すサービス部品またはユーザ定義受付の，要求電文，応答電文またはフォルト電文に設定されている電文フォーマットを，変数に設定するときに使用します。

［変数・相関セット一覧］ダイアログの［取込］ボタンをクリックした場合に表示されます。

操作手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.5.1　変数の定義」を参照してください。

図1‒74　［電文フォーマットの取込］ダイアログ

［サービス/受付］

［サービス名］ラジオボタン

呼び出すサービス部品の要求電文，応答電文またはフォルト電文に設定されている電文フォーマットを，変数に設定する場合に選択します。ドロップダウンリストでは，呼び出すサービス部品を選択します。

［受付名］ラジオボタン

ユーザ定義受付に設定されている電文フォーマットを，変数に設定する場合に選択します。ドロップダウンリストでは，取り込むユーザ定義受付を選択します。

［取込対象］

［オペレーション名］

［サービス/受付］で指定したサービス部品またはユーザ定義受付のオペレーションのうち，取り込むオペレーション名をドロップダウンリストで選択します。

［電文種別］

変数に設定する電文フォーマットの種別を次の中からドロップダウンリストで選択します。

要求電文（ボディ）

応答電文（ボディ）

要求電文（ヘッダ）

応答電文（ヘッダ）

フォルト電文

［ヘッダルート要素］

選択したヘッダに設定されたルート要素が昇順で表示されます。

［名前空間］

［電文種別］で「要求電文（ヘッダ）」または「応答電文（ヘッダ）」を選択した場合，名前空間が表示されます。

［フォルト名］

［電文種別］でフォルト電文を選択した場合，［オペレーション名］で選択したオペレーションのうち，取り込むフォルト名を選択します。

［電文フォーマット］

電文フォーマットとなるXMLスキーマファイルの名称を入力します。

［OK］ボタン

ダイアログを閉じます。設定した内容は，［変数・相関セット一覧］ダイアログに反映されます。

［キャンセル］ボタン

設定した内容を保存しないでダイアログを閉じます。

1.4.6　フォルト処理の割当ダイアログ

フォルト処理の条件を設定するダイアログです。

次のどちらかの操作をした場合に表示されます。

フォルトコネクションを利用して設定した連結線をダブルクリックする

フォルトコネクションを利用して設定した連結線を選択して右クリックし，［設定］を選択する

操作方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.4.4　フォルト処理を定義する」を参照してください。

図1‒75　［フォルト処理の割当］ダイアログ

［割当変数］

フォルトの対象となる変数をドロップダウンリストで選択します。ドロップダウンリストには，該当するビジネスプロセスに定義されている変数が表示されます。

なお，定義していないフォルトが発生した場合のフォルト処理を設定する場合，ドロップダウンリストから「catch-all」を選択します。

［遷移先］

［割当変数］に指定したフォルトが発生したときに実行するフォルト処理を定義したアクティビティのアクティビティ名称を選択します。

［クリア］ボタン

選択している［割当変数］の行に指定されている内容をクリアします。

［OK］ボタン

定義内容を保存してダイアログを閉じます。

［キャンセル］ボタン

定義内容を保存しないでダイアログを閉じます。

1.4.7　受付アクティビティダイアログ

受付アクティビティの詳細を定義するダイアログです。

次のどちらかの操作をした場合に表示されます。

キャンバスの受付アクティビティをダブルクリックする

キャンバスの受付アクティビティを選択して右クリックし，［設定］を選択する

受付アクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.2　受付アクティビティ」を参照してください。

図1‒76　［受付アクティビティ］ダイアログ

［アクティビティ名］

アクティビティの名称を指定します。使用できる文字は，XMLSchemaのNCName定義文字です。また，アクティビティ名は，ビジネスプロセス（スコープ内も含む）内で一意になるように指定します。

［オペレーション名］

サービスリクエスタからサービス部品を呼び出すときに利用するオペレーション名を指定します。

オペレーション名は，ビジネスプロセス内で一意になるように指定します。ビジネスプロセス内のほかの受付アクティビティに設定されている名称と重複している場合，ビジネスプロセスの検証時にエラーになります。

オペレーション名を直接指定する場合は，255バイト以内で指定します。使用できる文字は，XMLSchemaのNCName定義文字です。

オペレーション名を受付から取り込む場合は，［取込］ボタンから［オペレーション名の取込］ダイアログを起動して指定します。

［取込］ボタン

［オペレーション名の取込］ダイアログが表示されます。［オペレーション名］に設定するオペレーション名を指定する場合にクリックします。

受付アクティビティの［オペレーション名の取込］ダイアログの詳細については，「1.4.8　オペレーション名の取込ダイアログ（受付アクティビティ）」を参照してください。

［ボディ割当変数］

ビジネスプロセスの要求電文に割り当てる変数をドロップダウンリストで選択します。ドロップダウンリストには，［変数・相関セット一覧］ダイアログで定義した変数のうち，利用可能な変数だけが表示されます。

［編集］ボタン

［変数・相関セット一覧］ダイアログが表示されます。［ボディ割当変数］に設定する変数の内容を編集する場合にクリックします。

［変数・相関セット一覧］ダイアログの詳細については，「1.4.1　変数・相関セット一覧ダイアログ」を参照してください。

［ヘッダ割当変数］

［設定］ボタンをクリックして，定義済みのヘッダ割当変数をアクティビティに割り当てます。

［設定］ボタン

［ヘッダ割当変数］ダイアログが表示されます。必要に応じて，アクティビティに割り当てるヘッダ割当変数を［ヘッダ割当変数］ダイアログで設定します。

［ヘッダ割当変数］ダイアログの詳細については，「1.4.2　ヘッダ割当変数ダイアログ」を参照してください。

［割当相関セット群］

［設定］ボタンをクリックして定義済みの相関セットグループをアクティビティに割り当てます。

［設定］ボタン

［割当相関セット群］ダイアログが表示されます。必要に応じて，アクティビティに割り当てる相関セットを［割当相関セット群］ダイアログで設定します。また，割り当てる相関セットを初期化するかどうかを設定します。

なお，［インスタンス生成］で［no］を選択した場合，初期化しない相関セットを1つだけ設定する必要があります。

［割当相関セット群］ダイアログの詳細については，「1.4.3　割当相関セット群ダイアログ」を参照してください。

［通信モデル］

オペレーションの同期または非同期を選択します。

［インスタンス生成］

要求電文を受け付けたときに，プロセスを初期化するかどうかを選択します。

［OK］ボタン

定義内容を保存してダイアログを閉じます。

［キャンセル］ボタン

定義内容を保存しないでダイアログを閉じます。

1.4.8　オペレーション名の取込ダイアログ（受付アクティビティ）

［受付アクティビティ］ダイアログで設定するオペレーション名を指定するダイアログです。［受付アクティビティ］ダイアログの［取込］ボタンをクリックした場合に表示されます。

受付アクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.2　受付アクティビティ」を参照してください。

図1‒77　［オペレーション名の取込］ダイアログ（受付アクティビティ）

［受付名］

受付名をドロップダウンリストから選択します。

ドロップダウンリストには，ビジネスプロセスのユーザ定義受付（呼出先固定）の受付名の一覧が表示されます。ユーザ定義受付（呼出先固定）が定義されていない場合は，ユーザ定義受付（呼出先選択）の受付名の一覧が表示されます。

ここで選択した受付に定義されているオペレーション名が，［オペレーション名］に一覧表示されます。

［オペレーション名］

オペレーション名をドロップダウンリストから選択します。

ドロップダウンリストには，［受付名］で選択した受付に定義されているオペレーション名の一覧が表示されます。［受付名］で受付名が未選択の場合や，選択した受付にオペレーション名が定義されていない場合は，一覧に表示されません。

［OK］ボタン

定義内容を［受付アクティビティ］ダイアログに反映してダイアログを閉じます。

［キャンセル］ボタン

定義内容を［受付アクティビティ］ダイアログに反映しないでダイアログを閉じます。

1.4.9　応答アクティビティダイアログ

応答アクティビティの詳細を定義するダイアログです。

次のどちらかの操作をした場合に表示されます。

キャンバスの応答アクティビティをダブルクリックする

キャンバスの応答アクティビティを選択して右クリックし，［設定］を選択する

応答アクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.3　応答アクティビティ」を参照してください。

図1‒78　［応答アクティビティ］ダイアログ

［アクティビティ名］

アクティビティの名称を指定します。使用できる文字は，XMLSchemaのNCName定義文字です。また，アクティビティ名は，ビジネスプロセス（スコープ内も含む）内で一意になるように指定します。

［オペレーション名］

対応する受付アクティビティに指定したオペレーション名を指定します。

オペレーション名を直接指定する場合は，255バイト以内で指定します。使用できる文字は，XMLSchemaのNCName定義文字です。

オペレーション名を受付または受付アクティビティから取り込む場合は，［取込］ボタンから［オペレーション名の取込］ダイアログを起動して指定します。

［取込］ボタン

［オペレーション名の取込］ダイアログが表示されます。［オペレーション名］に設定するオペレーション名を指定する場合にクリックします。

応答アクティビティの［オペレーション名の取込］ダイアログの詳細については，「1.4.10　オペレーション名の取込ダイアログ（応答アクティビティ）」を参照してください。

［ボディ割当変数］

応答電文に割り当てる変数をドロップダウンリストで選択します。ドロップダウンリストには，［変数・相関セット一覧］ダイアログで定義した変数のうち，利用可能な変数だけが表示されます。

［編集］ボタン

［変数・相関セット一覧］ダイアログが表示されます。［ボディ割当変数］に設定する変数の内容を編集する場合にクリックします。

［変数・相関セット一覧］ダイアログの詳細については，「1.4.1　変数・相関セット一覧ダイアログ」を参照してください。

［ヘッダ割当変数］

［設定］ボタンをクリックして，定義済みのヘッダ割当変数をアクティビティに割り当てます。

［設定］ボタン

［ヘッダ割当変数］ダイアログが表示されます。必要に応じて，アクティビティに割り当てるヘッダ割当変数を［ヘッダ割当変数］ダイアログで設定します。

［ヘッダ割当変数］ダイアログの詳細については，「1.4.2　ヘッダ割当変数ダイアログ」を参照してください。

［割当相関セット群］

［設定］ボタンをクリックして定義済みの相関セットグループをアクティビティに割り当てます。

［設定］ボタン

［割当相関セット群］ダイアログが表示されます。必要に応じて，アクティビティに割り当てる相関セットを［割当相関セット群］ダイアログで設定します。また，割り当てる相関セットを初期化するかどうかを設定します。

［割当相関セット群］ダイアログの詳細については，「1.4.3　割当相関セット群ダイアログ」を参照してください。

［フォルト名］

フォルト処理として応答アクティビティを定義して，サービスリクエスタにフォルトが発生したことを示す応答電文を送信する場合，フォルトの名称を指定します。XMLSchemaのNCName定義文字でローカル名を指定します。

フォルト名を指定しない場合，応答電文は正常な応答となります。

［OK］ボタン

定義内容を保存してダイアログを閉じます。

［キャンセル］ボタン

定義内容を保存しないでダイアログを閉じます。

1.4.10　オペレーション名の取込ダイアログ（応答アクティビティ）

［応答アクティビティ］ダイアログで設定するオペレーション名を指定するダイアログです。［応答アクティビティ］ダイアログの［取込］ボタンをクリックした場合に表示されます。

応答アクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.2　受付アクティビティ」を参照してください。

図1‒79　［オペレーション名の取込］ダイアログ（応答アクティビティ）

［ユーザ定義受付から取込］ラジオボタン

オペレーション名をユーザ定義受付から取り込む場合に選択します。

［受付名］

受付名をドロップダウンリストから選択します。

ドロップダウンリストには，ビジネスプロセスのユーザ定義受付（呼出先固定）の受付名の一覧が表示されます。ユーザ定義受付（呼出先固定）が定義されていない場合は，ユーザ定義受付（呼出先選択）の受付名の一覧が表示されます。

ここで選択した受付に定義されているオペレーション名が，［オペレーション名］に一覧表示されます。

［オペレーション名］

オペレーション名をドロップダウンリストから選択します。

ドロップダウンリストには，［受付名］で選択した受付に定義されているオペレーション名の一覧が表示されます。［受付名］で受付名が未選択の場合や，選択した受付にオペレーション名が定義されていない場合は，一覧に表示されません。

［受付アクティビティから取込］ラジオボタン

オペレーション名を受付アクティビティから取り込む場合に選択します。

［受付アクティビティ名］

受付アクティビティ名をドロップダウンリストから選択します。

ドロップダウンリストには，ビジネスプロセスに定義されている受付アクティビティの一覧が表示されます。ビジネスプロセスに受付アクティビティが存在しない場合は，一覧に表示されません。

ここで選択した受付アクティビティに定義されているオペレーション名が，［オペレーション名］に表示されます。

［オペレーション名］

［受付アクティビティ名］で選択した受付アクティビティに定義されているオペレーション名が表示されます。［受付アクティビティ名］で受付アクティビティ名が未選択の場合や，選択した受付アクティビティにオペレーション名が定義されていない場合は，表示されません。

［OK］ボタン

定義内容を［応答アクティビティ］ダイアログに反映してダイアログを閉じます。

［キャンセル］ボタン

定義内容を［応答アクティビティ］ダイアログに反映しないでダイアログを閉じます。

1.4.11　サービス呼出アクティビティダイアログ

サービス呼出アクティビティの詳細を定義するダイアログです。

次のどちらかの操作をした場合に表示されます。

キャンバスのサービス呼出アクティビティをダブルクリックする

キャンバスのサービス呼出アクティビティを選択して右クリックし，［設定］を選択する

サービス呼出アクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.4　サービス呼出アクティビティ」を参照してください。

図1‒80　［サービス呼出アクティビティ］ダイアログ

［アクティビティ名］

アクティビティの名称を指定します。使用できる文字は，XMLSchemaのNCName定義文字です。また，アクティビティ名は，ビジネスプロセス（スコープ内も含む）内で一意になるように指定します。

［サービス名］

要求電文を送信して呼び出すサービス部品をドロップダウンリストで選択します。ドロップダウンリストには，ツリービューのサービス定義一覧に表示されるサービス部品が表示されます。

［オペレーション名］

［サービス名］で指定したサービス部品のオペレーションのうち，実際に呼び出すオペレーションの名称を指定します。

［通信モデル］

［オペレーション名］で選択したオペレーションに設定されている通信モデル（同期または非同期）が表示されます。

［要求電文］

要求電文に関する割当変数を次に示す項目で指定します。

［ボディ割当変数］

サービス部品を呼び出す要求電文に割り当てる変数をドロップダウンリストで選択します。ドロップダウンリストには，［変数・相関セット一覧］ダイアログで定義した変数のうち，利用可能な変数だけが表示されます。

［編集］ボタン

［変数・相関セット一覧］ダイアログが表示されます。

［変数・相関セット一覧］ダイアログの詳細については，「1.4.1　変数・相関セット一覧ダイアログ」を参照してください。

［ヘッダ割当変数］

［ヘッダ割当変数］ダイアログが表示されます。必要に応じて，アクティビティに割り当てるヘッダ割当変数を［ヘッダ割当変数］ダイアログで設定します。

［ヘッダ割当変数］ダイアログの詳細については，「1.4.2　ヘッダ割当変数ダイアログ」を参照してください。

［応答電文］

応答電文に関する割当変数を次に示す項目で指定します。

［ボディ割当変数］

同期オペレーションから受け取る応答電文に割り当てる変数をドロップダウンリストで選択します。ドロップダウンリストには，［変数・相関セット一覧］ダイアログで定義した変数のうち，利用可能な変数だけが表示されます。

［編集］ボタン

［変数・相関セット一覧］ダイアログが表示されます。

［変数・相関セット一覧］ダイアログの詳細については，「1.4.1　変数・相関セット一覧ダイアログ」を参照してください。

［ヘッダ割当変数］

［ヘッダ割当変数］ダイアログが表示されます。必要に応じて，アクティビティに割り当てるヘッダ割当変数を［ヘッダ割当変数］ダイアログで設定します。

［ヘッダ割当変数］ダイアログの詳細については，「1.4.2　ヘッダ割当変数ダイアログ」を参照してください。

［割当相関セット群］

［設定］ボタンをクリックして定義済みの相関セットグループを割り当てます。相関セットグループは，サービス部品を呼び出す要求電文，およびサービス部品から受け取る応答電文に割り当てられます。

［設定］ボタン

［割当相関セット群］ダイアログが表示されます。サービス部品を呼び出す要求電文，およびサービス部品から受け取る応答電文に割り当てる相関セットを［割当相関セット群］ダイアログで設定します。また，割り当てる相関セットを初期化するかどうか，およびパターンを設定します。

［割当相関セット群］ダイアログの詳細については，「1.4.3　割当相関セット群ダイアログ」を参照してください。

［OK］ボタン

定義内容を保存してダイアログを閉じます。

［キャンセル］ボタン

定義内容を保存しないでダイアログを閉じます。

1.4.12　Java呼出アクティビティダイアログ

Java呼出アクティビティの詳細を定義するダイアログです。

次のどちらかの操作をした場合に表示されます。

キャンバスのJava呼出アクティビティをダブルクリックする（［Javaエディタ起動］メニューが非活性の場合だけ）

キャンバスのJava呼出アクティビティを選択して右クリックし，［設定］を選択する

Java呼出アクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.5　Java呼出アクティビティ」を参照してください。

図1‒81　［Java呼出アクティビティ］ダイアログ

［アクティビティ名］

アクティビティの名称を指定します。使用できる文字は，XMLSchemaのNCName定義文字です。また，アクティビティ名は，ビジネスプロセス（スコープ内も含む）内で一意になるように指定します。

［Javaクラス名］

Javaクラス名を指定します。指定するJavaクラス名にはパッケージ名称を含みます。なお，拡張子（「.class」，「.java」など）は指定しないでください。

［引数用割当変数］

［Javaクラス名］で指定したJavaクラスを呼び出すときの引数に割り当てる変数を指定します。変数は複数指定できます。

［変数］

［Javaクラス名］で指定したJavaクラスを呼び出すときの引数に割り当てる変数をドロップダウンリストで選択します。ドロップダウンリストには，［変数・相関セット一覧］ダイアログで定義した変数のうち，利用できる変数だけが表示されます。

選択した変数は，［追加］ボタンをクリックすると［一覧］に表示されます。

［追加］ボタン

［変数］で選択した変数を［一覧］に追加します。

［一覧］

［Javaクラス名］で指定したJavaクラスを呼び出すときの引数に割り当てる変数が表示されます。Javaクラスを呼び出すときの引数の順序は［添字］の順序と同じです。

［添字］

割り当てた変数を使用する場合の，Javaクラスの可変長引数（配列）の添字が表示されます。

09-70以前のバージョンのインタフェースを使用する場合，この値は使用されません。

［種別］

Javaクラスの引数に割り当てる変数の種別が表示されます。

［変数名］

Javaクラスの引数に割り当てる変数名が表示されます。

［削除］ボタン

［一覧］で選択した変数を削除します。複数選択して［削除］ボタンをクリックすると，選択したすべての変数が削除されます。

［上へ］ボタン

［一覧］で選択した変数の順序を1つ前に移動します。

［下へ］ボタン

［一覧］で選択した変数の順序を1つ後ろに移動します。

［戻り値用割当変数］

［Javaクラス名］で指定したJavaクラスを呼び出すときの戻り値に割り当てる変数をドロップダウンリストで選択します。ドロップダウンリストには，［変数・相関セット一覧］ダイアログで定義した変数のうち，利用可能な変数だけが表示されます。

［編集］ボタン

［変数・相関セット一覧］ダイアログが表示されます。［引数用割当変数］または［戻り値用割当変数］に設定する変数の内容を編集する場合にクリックします。

［変数・相関セット一覧］ダイアログの詳細については，「1.4.1　変数・相関セット一覧ダイアログ」を参照してください。

［OK］ボタン

定義内容を保存してダイアログを閉じます。

［キャンセル］ボタン

定義内容を保存しないでダイアログを閉じます。

1.4.13　データ変換アクティビティダイアログ

データ変換アクティビティの詳細を定義するダイアログです。

次のどちらかの操作をした場合に表示されます。

キャンバスのデータ変換アクティビティをダブルクリックする（［マッピング定義起動］メニューが非活性の場合だけ）

キャンバスのデータ変換アクティビティを選択して右クリックし，［設定］を選択する

データ変換アクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.6　データ変換アクティビティ」を参照してください。

図1‒82　［データ変換アクティビティ］ダイアログ

［アクティビティ名］

アクティビティの名称を指定します。使用できる文字は，XMLSchemaのNCName定義文字です。また，アクティビティ名は，ビジネスプロセス（スコープ内も含む）内で一意になるように指定します。

［変換元変数］

次の項目を利用して，データ変換の変換元となる変数を指定します。変数は複数指定できます。また，データ変換を定義したあとでも変更できます。

［変数］

データ変換の変換元になる変数をドロップダウンリストで選択します。ドロップダウンリストには，［変数・相関セット一覧］ダイアログで定義した変数のうち，利用可能な変数だけが表示されます。

選択した変数は，［追加］ボタンをクリックすると［一覧］に表示されます。

［追加］ボタン

［変数］で選択した変数を［一覧］に追加します。

［編集］ボタン

［変数・相関セット一覧］ダイアログが表示されます。［変数］に設定する変数の内容を編集する場合にクリックします。

［変数・相関セット一覧］ダイアログの詳細については，「1.4.1　変数・相関セット一覧ダイアログ」を参照してください。

［一覧］

データ変換の変換元になる変数が表示されます。

［削除］ボタン

［一覧］で選択した変数を削除します。複数選択して［削除］ボタンをクリックすると，選択したすべての変数が削除されます。

［変換先変数］

次の項目を利用して，データ変換の変換先となる変数を指定します。データ変換を定義したあとでも変更できます。

［変数］

データ変換の変換先になる変数をドロップダウンリストで選択します。ドロップダウンリストには，［変数・相関セット一覧］ダイアログで定義した変数のうち，利用可能な変数だけが表示されます。

［編集］ボタン

［変数・相関セット一覧］ダイアログが表示されます。［変数］に設定する変数の内容を編集する場合にクリックします。

［変数・相関セット一覧］ダイアログの詳細については，「1.4.1　変数・相関セット一覧ダイアログ」を参照してください。

［データ変換定義］

データ変換定義ファイルの論理名をXMLとして有効な文字列（<，>，'，"，&以外）で指定します。

論理名とは，データ変換定義ファイルに仮想的に付与する名称です。論理名には対応するファイル名が自動的に付与されます。

データ変換定義画面では，指定したデータ変換定義ファイルの名称でデータ変換定義を作成します。

［ファイルを削除］ボタン

［データ変換定義］に指定したデータ変換定義ファイルを削除します。

［OK］ボタン

定義内容を保存してダイアログを閉じます。

［キャンセル］ボタン

定義内容を保存しないでダイアログを閉じます。

注意事項

データ変換を定義したあとに，変換元変数または変換先変数を変更した場合は，データ変換を定義し直してください。データ変換を定義し直す方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.3.2　電文フォーマットを変更した場合の定義手順」を参照してください。

1.4.14　代入アクティビティダイアログ

代入アクティビティの詳細を定義するダイアログです。

次のどちらかの操作をした場合に表示されます。

キャンバスの代入アクティビティをダブルクリックする

キャンバスの代入アクティビティを選択して右クリックし，［設定］を選択する

代入アクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.7　代入アクティビティ」を参照してください。

図1‒83　［代入アクティビティ］ダイアログ

［アクティビティ名］

アクティビティの名称を指定します。使用できる文字は，XMLSchemaのNCName定義文字です。また，アクティビティ名は，ビジネスプロセス（スコープ内も含む）内で一意になるように指定します。

［代入操作］

［コピー元］

代入元となる変数または値が表示されます。［追加］ボタンをクリックして表示される［代入アクティビティ］サブダイアログで設定します。

［コピー先］

代入先となる変数が表示されます。［追加］ボタンをクリックして表示される［代入アクティビティ］サブダイアログで設定します。

［追加］ボタン

［代入アクティビティ］サブダイアログが表示されます。［コピー先］および［コピー元］に変数または値を追加する場合にクリックします。［代入アクティビティ］サブダイアログについては，「1.4.15　代入アクティビティサブダイアログ」を参照してください。

［編集］ボタン

［代入アクティビティ］サブダイアログが表示されます。［コピー先］および［コピー元］の変数または値を編集する場合にクリックします。［代入アクティビティ］サブダイアログについては，「1.4.15　代入アクティビティサブダイアログ」を参照してください。

［削除］ボタン

［コピー先］および［コピー元］で選択した行を削除します。複数の行を選択して［クリア］ボタンをクリックすると，選択したすべての行が削除されます。

［OK］ボタン

定義内容を保存してダイアログを閉じます。

［キャンセル］ボタン

定義内容を保存しないでダイアログを閉じます。

1.4.15　代入アクティビティサブダイアログ

［代入アクティビティ］ダイアログで定義する［コピー元］および［コピー先］を追加または編集するダイアログです。

次のどちらかの操作をした場合に表示されます。

［代入アクティビティ］ダイアログの［追加］ボタンをクリックする

［代入アクティビティ］ダイアログの［編集］ボタンをクリックする

代入アクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.7　代入アクティビティ」を参照してください。

図1‒84　［代入アクティビティ］サブダイアログ

［コピー元］

次の項目を利用して，［代入アクティビティ］ダイアログの［コピー元］に設定する値を指定します。

［変数］ラジオボタン

［コピー元］に変数を設定する場合に選択します。変数名，または変数名と部分名を組み合わせて設定します。

［名前］

［コピー元］に設定する変数名をドロップダウンリストで選択します。ドロップダウンリストには，［変数・相関セット一覧］ダイアログで定義した変数のうち，利用可能な変数だけが表示されます。

［編集］ボタン

［変数・相関セット一覧］ダイアログが表示されます。［名前］に設定する変数の内容を編集する場合にクリックします。

［変数・相関セット一覧］ダイアログの詳細については，「1.4.1　変数・相関セット一覧ダイアログ」を参照してください。

［部分名］

［名前］で選択した変数がメッセージ型の場合，部分名をドロップダウンリストで選択できます。ドロップダウンリストには，［名前］で選択した変数に設定されている部分名だけが表示されます。

［式］ラジオボタン

［コピー元］に値（数値，文字列，真偽値）を設定する場合，または［コピー元］にメッセージ型の変数の一部を絶対パス（XPath式）で指定して設定する場合に選択します。

［変数の表示］

［コピー元］の［式］で変数を利用する場合，表示する変数名をドロップダウンリストで選択します。ドロップダウンリストには，［変数・相関セット一覧］ダイアログで定義したメッセージ型の変数のうち，利用可能な変数だけが表示されます。

［表示］ボタン

［変数の表示］ダイアログが表示されます。［変数の表示］ダイアログでは，［変数の表示］で指定したメッセージ型の変数の内容から，コピー元に設定する内容を選択して，絶対パス（XPath式）を取得できます。

［変数の表示］ダイアログについては，「1.4.4　変数の表示ダイアログ」を参照してください。

［値］

［コピー元］に数値，文字列，真偽値を設定する場合，それぞれの値を指定します。

［変数の表示］でメッセージ型の変数を選択した場合とメッセージ型以外の変数を選択した場合とで，指定する値が異なります。指定する値については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.21　アクティビティ定義ダイアログのXPathの指定」を参照してください。

［固定値（テキスト）］ラジオボタン

UTF-8で表示できる固定値を指定する場合に選択します。

［テキストデータ］

固定値を直接入力するか，［参照］ボタンから指定したファイルの内容を取り込みます。

固定値は，UTF-8で表示できる値である必要があります。空白や改行もデータの一部となります。また，改行LFは，ダイアログを閉じるときにCR+LFに変換されます。

なお，［参照］ボタンでファイルの内容を取り込むと，そのとき［テキストデータ］に入力されていた内容は削除されます。

［参照］ボタン

フォルダの選択画面が表示され，固定値が記載されたファイルを指定できます。エンコードが「UTF-8」のファイルを指定してください。エンコードが「UTF-8」でない場合の動作は保証できません。制御文字もデータの一部となります。

指定したファイルの内容は［テキストデータ］に取り込まれます。

［出力］ボタン

［テキストデータ］に表示されている固定値をファイル出力するためのダイアログが表示されます。

［固定値（非テキスト）］ラジオボタン

UTF-8で表示できない固定値を指定する場合に選択します。

［ファイル名］

［参照］ボタンで指定したファイルのファイル名が表示されます。

［参照］ボタン

フォルダの選択画面が表示され，固定値が記載されたファイルを指定できます。制御文字もデータの一部となります。

［出力］ボタン

ファイルの出力先を指定するダイアログが表示されます。

［コピー先］

次の項目を利用して，［代入アクティビティ］ダイアログの［コピー先］に設定する値を指定します。

［変数名］

［コピー先］に設定する変数名をドロップダウンリストで選択します。ドロップダウンリストには，［変数・相関セット一覧］ダイアログで定義した変数のうち，利用可能な変数だけが表示されます。

［編集］ボタン

［変数・相関セット一覧］ダイアログが表示されます。［変数名］に設定する変数の内容を編集する場合にクリックします。

［変数・相関セット一覧］ダイアログの詳細については，「1.4.1　変数・相関セット一覧ダイアログ」を参照してください。

［部分名］

［変数名］で選択した変数がメッセージ型の場合，部分名をドロップダウンリストで選択できます。ドロップダウンリストには，［変数名］で選択した変数に設定されている部分名だけが表示されます。

［OK］ボタン

定義内容を［代入アクティビティ］ダイアログに反映してダイアログを閉じます。

［キャンセル］ボタン

定義内容を［代入アクティビティ］ダイアログに反映しないでダイアログを閉じます。

1.4.16　無操作アクティビティダイアログ

無操作アクティビティの詳細を定義するダイアログです。

次のどちらかの操作をした場合に表示されます。

キャンバスの無操作アクティビティをダブルクリックする

キャンバスの無操作アクティビティを選択して右クリックし，［設定］を選択する

無操作アクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.8　無操作アクティビティ」を参照してください。

図1‒85　［無操作アクティビティ］ダイアログ

［アクティビティ名］

アクティビティの名称を指定します。使用できる文字は，XMLSchemaのNCName定義文字です。また，アクティビティ名は，ビジネスプロセス（スコープ内も含む）内で一意になるように指定します。

［OK］ボタン

定義内容を保存してダイアログを閉じます。

［キャンセル］ボタン

定義内容を保存しないでダイアログを閉じます。

1.4.17　フォルト送出アクティビティダイアログ

フォルト送出アクティビティの詳細を定義するダイアログです。

次のどちらかの操作をした場合に表示されます。

キャンバスのフォルト送出アクティビティをダブルクリックする

キャンバスのフォルト送出アクティビティを選択して右クリックし，［設定］を選択する

フォルト送出アクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.9　フォルト送出アクティビティ」を参照してください。

図1‒86　［フォルト送出アクティビティ］ダイアログ

［アクティビティ名］

アクティビティの名称を指定します。使用できる文字は，XMLSchemaのNCName定義文字です。また，アクティビティ名は，ビジネスプロセス（スコープ内も含む）内で一意になるように指定します。

［割当変数］

フォルトの使い方によって次のように設定有無が異なります。

特定の電文形式のフォルトを上位のスコープまたはビジネスプロセスに送出する場合

送出するフォルトに割り当てる変数をドロップダウンリストで選択します。

ドロップダウンリストには，［変数・相関セット一覧］ダイアログで定義した変数のうち，利用可能な変数だけが表示されます。

すでに発生しているフォルトをそのまま上位のスコープまたはビジネスプロセスに送出する場合

変数は設定しないでください。

この場合，フォルト送出アクティビティはどこかのアクティビティのフォルトハンドラ内※に定義する必要があります。フォルトハンドラ内に定義されていない場合は，動作を保証しません。

注※　フォルトハンドラが多段に定義されている場合，上位のフォルトハンドラ配下の位置にはフォルト送出アクティビティを定義できません。このような位置に定義した場合は動作を保証しません。

［編集］ボタン

［変数・相関セット一覧］ダイアログが表示されます。［割当変数］に設定する変数の内容を編集する場合にクリックします。

［変数・相関セット一覧］ダイアログの詳細については，「1.4.1　変数・相関セット一覧ダイアログ」を参照してください。

［OK］ボタン

定義内容を保存してダイアログを閉じます。

［キャンセル］ボタン

定義内容を保存しないでダイアログを閉じます。

1.4.18　補償アクティビティダイアログ

補償アクティビティの詳細を定義するダイアログです。

次のどちらかの操作をした場合に表示されます。

キャンバスの補償アクティビティをダブルクリックする

キャンバスの補償アクティビティを選択して右クリックし，［設定］を選択する

補償アクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.10　補償アクティビティ」を参照してください。

図1‒87　［補償アクティビティ］ダイアログ

［アクティビティ名］

アクティビティの名称を指定します。使用できる文字は，XMLSchemaのNCName定義文字です。また，アクティビティ名は，ビジネスプロセス（スコープ内も含む）内で一意になるように指定します。

［補償するアクティビティ］

補償範囲にある補償ハンドラの起動対象を次の中から選択します。

［すべて］ラジオボタン

補償範囲内で補償ハンドラが定義されたすべてのアクティビティ※に対して，補償処理が実行されます。

［1つのみ］ラジオボタン

補償範囲内で補償ハンドラが定義されたアクティビティ※のうち，選択された1つのアクティビティの補償処理だけが実行されます。

実行するアクティビティは右側のコンボボックスで選択できます。

注※　ビジネスプロセス定義画面のプロパティ項目「スコープアクティビティのデフォルトハンドラ」がONに設定されていて，補償ハンドラが定義されていないスコープアクティビティも含みます。

［OK］ボタン

定義内容を保存してダイアログを閉じます。

［キャンセル］ボタン

定義内容を保存しないでダイアログを閉じます。

1.4.19　待機アクティビティダイアログ

待機アクティビティの詳細を定義するダイアログです。

次のどちらかの操作をした場合に表示されます。

キャンバスの待機アクティビティをダブルクリックする

キャンバスの待機アクティビティを選択して右クリックし，［設定］を選択する

待機アクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.11　待機アクティビティ」を参照してください。

図1‒88　［待機アクティビティ］ダイアログ

［アクティビティ名］

アクティビティの名称を指定します。使用できる文字は，XMLSchemaのNCName定義文字です。また，アクティビティ名は，ビジネスプロセス（スコープ内も含む）内で一意になるように指定します。

［待機時間］

次の項目を利用して，ビジネスプロセスの処理を待機する時間を指定します。

［間隔］ラジオボタン

任意の時間，処理を停止させる場合に選択します。例えば，5分間処理を停止させる場合は，［間隔］ラジオボタンを選択します。

［期限］ラジオボタン

任意の時間まで，処理を停止させる場合に選択します。例えば，2009年5月31日まで処理を停止させる場合は，［期限］ラジオボタンを選択します。

［変数］

［待機時間］の［式］で変数を利用する場合，表示する変数名をドロップダウンリストで選択します。ドロップダウンリストには，［変数・相関セット一覧］ダイアログで定義したメッセージ型の変数のうち，利用可能な変数だけが表示されます。

［表示］ボタン

［変数の表示］ダイアログが表示されます。［変数の表示］ダイアログでは，［変数の表示］で指定したメッセージ型の変数の内容から，待機時間に設定する内容を選択して，絶対パス（XPath式）を取得できます。

［変数の表示］ダイアログについては，「1.4.4　変数の表示ダイアログ」を参照してください。

［式］

待機時間の間隔または期限として指定する式をXPathで指定します。指定する値については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.11　待機アクティビティ」，および「5.6.21　アクティビティ定義ダイアログのXPathの指定」を参照してください。

［OK］ボタン

定義内容を保存してダイアログを閉じます。

［キャンセル］ボタン

定義内容を保存しないでダイアログを閉じます。

1.4.20　検証アクティビティダイアログ

検証アクティビティの詳細を定義するダイアログです。

次のどちらかの操作をした場合に表示されます。

キャンバスの検証アクティビティをダブルクリックする

キャンバスの検証アクティビティを選択して右クリックし，［設定］を選択する

検証アクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.12　検証アクティビティ」を参照してください。

図1‒89　［検証アクティビティ］ダイアログ

［アクティビティ名］

アクティビティの名称を指定します。使用できる文字は，XMLSchemaのNCName定義文字です。また，アクティビティ名は，ビジネスプロセス（スコープ内も含む）内で一意になるように指定します。

［検証する変数］

次の項目を利用して，ビジネスプロセスの処理を検証する変数を指定します。

［変数］

変数をドロップダウンリストから選択します。ドロップダウンリストには，ビジネスプロセス定義画面で定義された変数のうち，種別が「XML」の変数を表示します。また，空の要素を最後に表示します。

［追加］ボタン

［変数］で選択した変数を追加します。

［編集］ボタン

［変数・相関セット一覧］ダイアログが表示されます。［変数・相関セット一覧］ダイアログでは，［変数］で選択した変数を編集します。

［変数・相関セット一覧］ダイアログについては，「1.4.1　変数・相関セット一覧ダイアログ」を参照してください。

［一覧］

追加された変数を追加順に表示します。

変数を削除する場合は，対象となる変数を選択します。複数の変数を選択できます。

［削除］ボタン

［一覧］で選択した変数を削除します。

［OK］ボタン

定義内容を保存してダイアログを閉じます。

［キャンセル］ボタン

定義内容を保存しないでダイアログを閉じます。

1.4.21　ログ出力アクティビティダイアログ

ログ出力アクティビティの詳細を定義するダイアログです。

次のどちらかの操作をした場合に表示されます。

キャンバスのログ出力アクティビティをダブルクリックする

キャンバスのログ出力アクティビティを選択して右クリックし，［設定］を選択する

ログ出力アクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.13　ログ出力アクティビティ」を参照してください。

図1‒90　［ログ出力アクティビティ］ダイアログ

［アクティビティ名］

アクティビティの名称を指定します。使用できる文字は，XMLSchemaのNCName定義文字です。また，アクティビティ名は，ビジネスプロセス（スコープ内も含む）内で一意になるように指定します。

［ログ出力識別子］

ログ出力識別子を指定します。

ログ出力識別子はログ出力先を一意に識別する文字列です。事前にログ出力アクティビティ定義ファイルで定義したログ出力識別子の中から，出力情報に該当するログ出力識別子を1つ指定します。

ログ出力アクティビティ定義ファイルについては，「3.20.1　ログ出力アクティビティ定義ファイル」を参照してください。

［ログ出力内容］

出力するメッセージの指定方法を次の中から選択します。

［リソースKey］ラジオボタン

出力するメッセージをメッセージ定義ファイルで定義する場合に選択します。この項目を指定するには，事前にメッセージ定義ファイルの作成が必要です。

メッセージ定義ファイルの中から，出力するメッセージが定義されたプロパティのキーをテキストボックスに1つ指定します。キーの形式は「リソースKey-ログの出力レベル」です（「-」は半角ハイフン）。

メッセージ定義ファイルについては，「3.20.2　メッセージ定義ファイル」を参照してください。

［任意の文字列］ラジオボタン

出力するメッセージの内容を直接指定する場合に選択します。

メッセージの内容はテキストボックスに，次の点に注意して指定してください。

改行は指定しないでください。

制御文字は指定しないでください。

埋め込み文字を指定する場合は，添字を{ }で囲んで指定してください。

［埋め込み要素］

出力するメッセージに埋め込み文字を使用する場合に，埋め込み要素を指定します。

［一覧］

メッセージ内容の埋め込み文字に割り当てる埋め込み要素が，添字の順に一覧表示されます。

例えば，メッセージ内容に埋め込み文字を「Element = {0}, {1}」と定義する場合，{0}の部分には添字「0」の埋め込み要素値が，{1}の部分には添字「1」に設定された埋め込み要素値が埋め込まれます。

埋め込み要素の追加・編集は，［ログ出力アクティビティ］サブダイアログで設定します。

埋め込み要素と埋め込み文字の数が一致しない場合は次のようになります。

埋め込み要素の数がメッセージ内容の埋め込み文字の数より多い場合，超えた分は無視されます。

埋め込み要素の数がメッセージ内容の埋め込み文字の数より少ない場合，足りない埋め込み文字部分は埋め込まれない状態で出力されます。

例：メッセージ内容の埋め込み文字が「Element = {0}, {1}」で，埋め込み要素値が「aaa」1つしか設定されていない場合，「Element = aaa, {1}」と出力されます。

［添字］

添字が0から順に連番で表示されます。

［埋め込み要素値］

［ログ出力アクティビティ］サブダイアログで設定した埋め込み要素値が表示されます。

埋め込み要素値の表示位置は，［上へ］ボタンおよび［下へ］ボタンで変更できます。

［追加］ボタン

［ログ出力アクティビティ］サブダイアログが表示されます。［一覧］に埋め込み要素を追加する場合にクリックします。

［ログ出力アクティビティ］サブダイアログについては，「1.4.22　ログ出力アクティビティサブダイアログ」を参照してください。

［編集］ボタン

［ログ出力アクティビティ］サブダイアログが表示されます。［一覧］の埋め込み要素の内容を編集する場合にクリックします。

［ログ出力アクティビティ］サブダイアログについては，「1.4.22　ログ出力アクティビティサブダイアログ」を参照してください。

［削除］ボタン

［一覧］で選択した行を削除します。

［上へ］ボタン

［一覧］で選択した行の位置が1つ上に移動します。

［下へ］ボタン

［一覧］で選択した行の位置が1つ下に移動します。

［OK］ボタン

定義内容を保存してダイアログを閉じます。

［キャンセル］ボタン

定義内容を保存しないでダイアログを閉じます。

1.4.22　ログ出力アクティビティサブダイアログ

［ログ出力アクティビティ］ダイアログで定義する埋め込み要素値を追加または編集するダイアログです。

次のどちらかの操作をした場合に表示されます。

［ログ出力アクティビティ］ダイアログの［追加］ボタンをクリックする

［ログ出力アクティビティ］ダイアログの［編集］ボタンをクリックする

ログ出力アクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.13　ログ出力アクティビティ」を参照してください。

図1‒91　［ログ出力アクティビティ］サブダイアログ

埋め込み要素を設定するには，変数またはXPath式で指定します。

［変数］ラジオボタン

埋め込み要素値として変数を設定する場合に選択します。変数名，または変数名と部分名を組み合わせて設定します。

［名前］

［埋め込み要素］に設定する変数名をドロップダウンリストで選択します。ドロップダウンリストには，［変数・相関セット一覧］ダイアログで定義した変数のうち，利用可能な変数だけが表示されます。

［編集］ボタン

［変数・相関セット一覧］ダイアログが表示されます。［名前］に設定する変数の内容を編集する場合にクリックします。

［変数・相関セット一覧］ダイアログの詳細については，「1.4.1　変数・相関セット一覧ダイアログ」を参照してください。

［部分名］

［名前］で選択した変数がメッセージ型の場合，部分名をドロップダウンリストで選択できます。ドロップダウンリストには，［名前］で選択した変数に設定されている部分名だけが表示されます。

［式］ラジオボタン

埋め込み要素値としてXPath式を指定する場合に選択します。

［変数の表示］

式に変数を利用する場合，表示する変数名をドロップダウンリストで選択します。ドロップダウンリストには，［変数・相関セット一覧］ダイアログで定義したメッセージ型の変数のうち，利用可能な変数だけが表示されます。

［表示］ボタン

［変数の表示］ダイアログが表示されます。［変数の表示］ダイアログでは，［変数の表示］で指定したメッセージ型の変数の内容から設定する内容を選択して，絶対パス（XPath式）を取得できます。

［変数の表示］ダイアログについては，「1.4.4　変数の表示ダイアログ」を参照してください。

［値］

式に必要な値（数値，文字列，真偽値）を指定します。

指定する値については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.21　アクティビティ定義ダイアログのXPathの指定」を参照してください。

［OK］ボタン

定義内容を［ログ出力アクティビティ］ダイアログに反映してダイアログを閉じます。

［キャンセル］ボタン

定義内容を［ログ出力アクティビティ］ダイアログに反映しないでダイアログを閉じます。

1.4.23　途中終了アクティビティダイアログ

途中終了アクティビティの詳細を定義するダイアログです。

次のどちらかの操作をした場合に表示されます。

キャンバスの途中終了アクティビティをダブルクリックする

キャンバスの途中終了アクティビティを選択して右クリックし，［設定］を選択する

途中終了アクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.14　途中終了アクティビティ」を参照してください。

図1‒92　［途中終了アクティビティ］ダイアログ

［アクティビティ名］

アクティビティの名称を指定します。使用できる文字は，XMLSchemaのNCName定義文字です。また，アクティビティ名は，ビジネスプロセス（スコープ内も含む）内で一意になるように指定します。

［OK］ボタン

定義内容を保存してダイアログを閉じます。

［キャンセル］ボタン

定義内容を保存しないでダイアログを閉じます。

1.4.24　スコープアクティビティダイアログ

スコープアクティビティの詳細を定義するダイアログです。

キャンバスのスコープアクティビティを選択して右クリックし，［設定］を選択した場合に表示されます。

スコープアクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.15　スコープアクティビティ」を参照してください。

図1‒93　［スコープアクティビティ］ダイアログ

図1‒94　［スコープアクティビティ］ダイアログ（上位のスコープで［このスコープの開始時と終了時のみコミットする］ラジオボタンが選択されている場合）

［アクティビティ名］

アクティビティの名称を指定します。使用できる文字は，XMLSchemaのNCName定義文字です。また，アクティビティ名は，ビジネスプロセス（スコープ内も含む）内で一意になるように指定します。

［高度な設定］

［▼］をクリックすると，ダイアログ上の［トランザクション制御］の表示／非表示を切り替えられます。

［トランザクション制御］

トランザクションのコミットのタイミングを次のどちらかで選択します。

［アクティビティ単位でコミットする］ラジオボタン（デフォルト）

トランザクションをアクティビティ単位でコミットする場合に選択します。

［このスコープの開始時と終了時のみコミットする］ラジオボタン

トランザクションのコミットのタイミングをスコープの開始時および終了時だけとする場合に選択します。なお，この項目を選択したスコープアクティビティを定義する際には，スコープアクティビティ内に受付アクティビティ，応答アクティビティ，待機アクティビティを定義すると，検証エラーとなります。

スコープアクティビティを定義する場合の注意事項については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.15　スコープアクティビティ」を参照してください。

なお，上位のスコープで［このスコープの開始時と終了時のみコミットする］ラジオボタンが選択されている場合は，これらのラジオボタンでコミットのタイミングは設定できません。

［OK］ボタン

定義内容を保存してダイアログを閉じます。

［キャンセル］ボタン

定義内容を保存しないでダイアログを閉じます。

1.4.25　繰り返しアクティビティダイアログ

繰り返しアクティビティの詳細を定義するダイアログです。

キャンバスの繰り返しアクティビティを選択して右クリックし，［設定］を選択した場合に表示されます。

繰り返しアクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.16　繰り返しアクティビティ」を参照してください。

図1‒95　［繰り返しアクティビティ］ダイアログ

［アクティビティ名］

アクティビティの名称を指定します。使用できる文字は，XMLSchemaのNCName定義文字です。また，アクティビティ名は，ビジネスプロセス（スコープ内も含む）内で一意になるように指定します。

［繰り返しモード］

［条件指定方式］

［繰り返し条件設定］ボタンをクリックして表示される［繰り返し条件設定］ダイアログから，繰り返しの条件を設定します。［繰り返し条件設定］ダイアログについては，「1.4.27　繰り返し条件設定ダイアログ」を参照してください。

［リスト指定方式］

［繰り返しリスト設定］ボタンをクリックして表示される［繰り返しリスト設定］ダイアログから，繰り返し対象となるリストを指定します。［繰り返しリスト設定］ダイアログについては，「1.4.26　繰り返しリスト設定ダイアログ」を参照してください。

［OK］ボタン

定義内容を保存してダイアログを閉じます。

［キャンセル］ボタン

定義内容を保存しないでダイアログを閉じます。

1.4.26　繰り返しリスト設定ダイアログ

繰り返しアクティビティで繰り返し処理を設定する場合のリストを定義するダイアログです。

［繰り返しアクティビティ］ダイアログの［繰り返しリスト設定］ボタンをクリックした場合に表示されます。

繰り返しアクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.16　繰り返しアクティビティ」を参照してください。

図1‒96　［繰り返しリスト設定］ダイアログ（繰り返しアクティビティ）

［繰り返しリスト］

［変数の表示］

繰り返しリストに変数を利用した式を設定する場合，変数をドロップダウンリストで選択します。ドロップダウンリストには，［変数・相関セット一覧］ダイアログで定義したメッセージ型の変数のうち，利用できる変数だけが表示されます。

［表示］ボタン

［変数の表示］ダイアログが表示されます。［変数の表示］ダイアログでは，［変数の表示］で指定したメッセージ型（XML，non-XML）の変数の内容を確認できます。

［変数の表示］ダイアログについては，「1.4.4　変数の表示ダイアログ」を参照してください。

［式］

評価結果が繰り返し要素を定義した変数の要素のパスとなる式をXPath式で指定します。XPath式の指定については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.21　アクティビティ定義ダイアログのXPathの指定」を参照してください。なお，拡張関数は使用できません。

［変数名］

繰り返し要素を格納する変数をドロップダウンリストで選択します。ドロップダウンリストには，［変数・相関セット一覧］ダイアログで定義したXMLの変数のうち，利用できる変数だけが表示されます。

［変数・相関セット一覧］ダイアログについては，「1.4.1　変数・相関セット一覧ダイアログ」を参照してください。

［編集］ボタン

［変数・相関セット一覧］ダイアログが表示されます。［変数・相関セット一覧］ダイアログでは，変数の追加や削除ができます。

［変数・相関セット一覧］ダイアログについては，「1.4.1　変数・相関セット一覧ダイアログ」を参照してください。

［最大繰り返し回数］

［指定する］チェックボックス

最大繰り返し回数を指定する場合にチェックします。

チェックボックスをチェックしない場合は，最大で2,147,483,647回まで繰り返すことができます。

［回数］

繰り返しの回数の最大値を半角の数字で指定します。指定できる値は1〜2,147,483,647の整数です。

［OK］ボタン

定義内容を［繰り返しアクティビティ］ダイアログに反映してダイアログを閉じます。

［キャンセル］ボタン

定義内容を［繰り返しアクティビティ］ダイアログに反映しないでダイアログを閉じます。

1.4.27　繰り返し条件設定ダイアログ

繰り返しアクティビティを利用して繰り返し処理を設定する場合の条件を定義するダイアログです。

［繰り返しアクティビティ］ダイアログの［繰り返し条件設定］ボタンをクリックした場合に表示されます。

繰り返しアクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.16　繰り返しアクティビティ」を参照してください。

図1‒97　［繰り返し条件設定］ダイアログ（繰り返しアクティビティ）

［条件式］

［変数の表示］

条件に変数を利用した式を設定する場合，変数をドロップダウンリストで選択します。ドロップダウンリストには，［変数・相関セット一覧］ダイアログで定義したメッセージ型（XML）の変数のうち，利用可能な変数だけが表示されます。

［表示］ボタン

［変数の表示］ダイアログが表示されます。［変数の表示］ダイアログでは，［変数の表示］で指定したメッセージ型（XML）の変数の内容を確認できます。

［変数の表示］ダイアログについては，「1.4.4　変数の表示ダイアログ」を参照してください。

［式］

繰り返し条件の条件式をXPath式で指定します。XPath式の中では，拡張関数を使用して変数内の情報を取得し，利用することができます。拡張関数の使用方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.21　アクティビティ定義ダイアログのXPathの指定」を参照してください。

［最大繰り返し回数］

次の項目を利用して，繰り返しアクティビティでの最大繰り返し回数を指定します。

［指定する］チェックボックス

最大繰り返し回数を指定する場合にチェックします。

チェックボックスをチェックしない場合は，最大で2,147,483,647回まで繰り返すことができます。

［回数］

繰り返しの回数の最大値を半角の数字で指定します。指定できる値は1〜2,147,483,647の整数です。

［OK］ボタン

定義内容を［繰り返しアクティビティ］ダイアログに反映してダイアログを閉じます。

［キャンセル］ボタン

定義内容を［繰り返しアクティビティ］ダイアログに反映しないでダイアログを閉じます。

1.4.28　分岐アクティビティダイアログ

分岐アクティビティの詳細を定義するダイアログです。

次のどちらかの操作をした場合に表示されます。

キャンバスの分岐アクティビティをダブルクリックする

キャンバスの分岐アクティビティを選択して右クリックし，［設定］を選択する

分岐アクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.17　分岐アクティビティ」を参照してください。

図1‒98　［分岐アクティビティ］ダイアログ

［アクティビティ名］

アクティビティの名称を指定します。使用できる文字は，XMLSchemaのNCName定義文字です。また，アクティビティ名は，ビジネスプロセス（スコープ内も含む）内で一意になるように指定します。

［分岐条件］

［優先順位］

［条件名］に設定される条件の優先順位が，優先順位の高い順に表示されます。条件の優先順位は，［上へ］ボタンおよび［下へ］ボタンで変更できます。

［条件名］

条件の名称が表示されます。条件は，［条件設定］ボタンをクリックして表示される［条件設定］ダイアログで設定します。

［遷移先］

その条件を満たす場合に実行するアクティビティのアクティビティ名を選択します。

［条件設定］ボタン

［条件設定］ダイアログが表示されます。分岐の条件を設定するときにクリックします。［条件設定］ダイアログについては，「1.4.29　条件設定ダイアログ（分岐アクティビティ）」を参照してください。

［クリア］ボタン

選択した条件を削除します。

［上へ］ボタン

選択した条件の優先順位を1つ上げます。

［下へ］ボタン

選択した条件の優先順位を1つ下げます。

［OK］ボタン

定義内容を保存してダイアログを閉じます。

［キャンセル］ボタン

定義内容を保存しないでダイアログを閉じます。

1.4.29　条件設定ダイアログ（分岐アクティビティ）

［分岐アクティビティ］ダイアログで定義する分岐処理の分岐条件を設定するダイアログです。

［分岐アクティビティ］ダイアログの［条件設定］ボタンをクリックした場合に表示されます。

分岐アクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.17　分岐アクティビティ」を参照してください。

図1‒99　［条件設定］ダイアログ（分岐アクティビティ）

［条件名］

［分岐アクティビティ］ダイアログの［条件名］に設定する条件の名称を指定します。条件名は，分岐アクティビティの定義内で一意になるように指定します。

［変数の表示］

条件に変数を利用した式を設定する場合，変数をドロップダウンリストで選択します。ドロップダウンリストには，［変数・相関セット一覧］ダイアログで定義したメッセージ型の変数のうち，利用可能な変数だけが表示されます。

［表示］ボタン

［変数の表示］ダイアログが表示されます。［変数の表示］ダイアログでは，［変数の表示］で指定したメッセージ型の変数の内容を確認できます。

［変数の表示］ダイアログについては，「1.4.4　変数の表示ダイアログ」を参照してください。

［式］

分岐条件の条件式をXPath式で指定します。XPath式の中では，拡張関数を使用して変数内の情報を取得し，利用することができます。拡張関数の使用方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.21　アクティビティ定義ダイアログのXPathの指定」を参照してください。

［OK］ボタン

定義内容を［分岐アクティビティ］ダイアログに反映してダイアログを閉じます。

［キャンセル］ボタン

定義内容を［分岐アクティビティ］ダイアログに反映しないでダイアログを閉じます。

1.4.30　並列処理アクティビティダイアログ

並列処理アクティビティの詳細を定義するダイアログです。

次のどちらかの操作をした場合に表示されます。

キャンバスの並列処理開始アクティビティをダブルクリックする

キャンバスの並列処理開始アクティビティを選択して右クリックし，［設定］を選択する

並列処理アクティビティの定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.18　並列処理アクティビティ」を参照してください。

図1‒100　［並列処理アクティビティ］ダイアログ

［アクティビティ名］

アクティビティの名称を指定します。使用できる文字は，XMLSchemaのNCName定義文字です。また，アクティビティ名は，ビジネスプロセス（スコープ内も含む）内で一意になるように指定します。

［リンク定義］

［リンク名］

リンクの名称を指定します。リンクの名称は，ビジネスプロセス内で一意になるように指定します。

［追加］ボタン

［リンク名］に入力行を1行追加します。

［削除］ボタン

選択したリンク名を削除します。削除するリンク名は複数指定できます。

［OK］ボタン

定義内容を保存してダイアログを閉じます。

［キャンセル］ボタン

定義内容を保存しないでダイアログを閉じます。

1.4.31　リンクダイアログ

並列処理する複数のシーケンス間でのリンクを定義するダイアログです。

次のどちらかの操作をした場合に表示されます。

リンク対象のアクティビティ同士を連結する連結線をダブルクリックする

リンク対象のアクティビティ同士を連結する連結線を選択して右クリックし，［設定］を選択する

並列処理時のリンクの定義方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.18　並列処理アクティビティ」を参照してください。

図1‒101　［リンク］ダイアログ

［割当リンク名］

割り当てるリンクの名称をドロップダウンリストで選択します。ドロップダウンリストには，該当するスコープ内で設定したリンク名が表示されます。

［リンク情報］

［リンク元］

リンクコネクションを利用して連結されているアクティビティのうち，連結元に当たるアクティビティの名称が表示されます。

［リンク先］

リンクコネクションを利用して連結されているアクティビティのうち，連結先に当たるアクティビティの名称が表示されます。

［遷移条件］

リンクによる遷移に条件を定義するかどうかを選択します。

［遷移条件設定］ボタン

［条件設定］ダイアログが表示されます。リンクによる遷移の条件を設定するときにクリックします。条件が設定できるのは，［遷移条件］で［あり］を選択した場合だけです。［条件設定］ダイアログについては，「1.4.32　条件設定ダイアログ（並列処理アクティビティ）」を参照してください。

［OK］ボタン

定義内容を保存してダイアログを閉じます。

［キャンセル］ボタン

定義内容を保存しないでダイアログを閉じます。

1.4.32　条件設定ダイアログ（並列処理アクティビティ）

並列処理でリンクを設定した場合のリンクの条件を定義するダイアログです。

［リンク］ダイアログの［遷移条件設定］ボタンをクリックした場合に表示されます。

並列処理時のリンクの定義方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.18　並列処理アクティビティ」を参照してください。

図1‒102　［条件設定］ダイアログ（並列処理アクティビティ）

［変数の表示］

条件に変数を利用した式を設定する場合，変数をドロップダウンリストで選択します。ドロップダウンリストには，［変数・相関セット一覧］ダイアログで定義したメッセージ型の変数のうち，利用可能な変数だけが表示されます。

［表示］ボタン

［変数の表示］ダイアログが表示されます。［変数の表示］ダイアログでは，［変数の表示］で指定したメッセージ型の変数の内容を確認できます。

［変数の表示］ダイアログについては，「1.4.4　変数の表示ダイアログ」を参照してください。

［式］

遷移条件の条件式をXPath式で指定します。XPath式の中では，拡張関数を使用して変数内の情報を取得し，利用することができます。拡張関数の使用方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「5.6.21　アクティビティ定義ダイアログのXPathの指定」を参照してください。

［OK］ボタン

定義内容を［リンク］ダイアログに反映してダイアログを閉じます。

［キャンセル］ボタン

定義内容を［リンク］ダイアログに反映しないでダイアログを閉じます。

1.4.33　パレット設定ダイアログ

［パレット設定］ダイアログは，パレットの表示を設定する場合に使用します。

パレットのグループまたはツールを右クリックして，［設定］を選択した場合に表示されます。

操作手順については，「1.12.11　パレットの表示を設定する」を参照してください。

図1‒103　［パレット設定］ダイアログ

［フォント］

［変更］ボタン

パレットのグループおよびツールのフォントを変更する場合に使用します。クリックすると，［設定］ダイアログが表示されます。

［デフォルトの復元］ボタン

［変更］ボタンで変更したフォントをEclipseで設定したフォントに戻す場合に使用します。

［レイアウト］

次のどれかのラジオボタンを選択して，パレットのグループおよびツールのレイアウトを設定します。

［列］ラジオボタン

すべてのグループおよびツールを水平に整列します。

［リスト］ラジオボタン

すべてのグループおよびツールを垂直に整列します。

［アイコンのみ］ラジオボタン

すべてのツールに対して，ツール名を表示しないでアイコンだけの表示にします。

［詳細］ラジオボタン

すべてのツールに対して，詳細なフォーマットおよび記述を表示します。

［リスト・レイアウト・オプション］

［大きいアイコンを使用］チェックボックス

パレットのツールのアイコンサイズを大きくする場合にチェックします。

［ドロワー・オプション］

次のどれかのラジオボタンを選択して，パレットのツール一覧の表示方法を設定します。

［別のドロワーを開いているときは常に閉じる］ラジオボタン

1つのグループのツール一覧だけを表示します。

［十分なスペースがないときは自動的に閉じる］ラジオボタン

複数のグループのツール一覧を表示しているためパレットに十分な表示スペースがない場合，自動的にツール一覧が閉じます。

［閉じない］ラジオボタン

常にツール一覧を表示します。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

1.5　ビジネスプロセスのデバッグに関連するダイアログ

ビジネスプロセスのデバッグに関連するダイアログについて説明します。

1.5.1　デバッグ構成ダイアログ

ビジネスプロセスのデバッグの構成を定義するダイアログです。

次のどれかの操作をした場合に表示されます。

Eclipseの［デバッグ］メニューから［デバッグの構成］を選択する

ツリービューのサービス定義一覧からデバッグするビジネスプロセスを右クリックし，［デバッグの構成］を選択する

パッケージ・エクスプローラから対象のプロジェクトを右クリックし，［デバッグ］−［デバッグの構成］を選択する

Eclipseの［実行］メニューから［デバッグの構成］を選択する

ビジネスプロセスのデバッグを実行する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「10.　ビジネスプロセスのデバッグ」を参照してください。

［デバッグ構成］ダイアログの構成を次に示します。

図1‒104　［デバッグ構成］ダイアログの構成

［デバッグ構成］ダイアログは，ビジネスプロセス設定タブとデバッグ設定タブから構成されています。

(1)　ビジネスプロセス設定タブ

ビジネスプロセス設定タブの項目について説明します。

図1‒105　ビジネスプロセス設定タブ

［デバッグ対象］

デバッグするビジネスプロセスをドロップダウンリストから選択します。

(2)　デバッグ設定タブ

デバッグ設定タブの項目について説明します。

図1‒106　デバッグ設定タブ

［ソケットの設定］

ビジネスプロセスのデバッグに使用するIPアドレス，およびポート番号を指定します。

［IPアドレス］

ビジネスプロセスのデバッグに使用するIPアドレスを指定します。任意のIPアドレスを指定する場合は，［その他］ラジオボタンを選択し，テキストボックスにIPアドレスを入力します。

［ポート番号］

ビジネスプロセスのデバッグに使用するポート番号を指定します。任意のポート番号を指定する場合は，［その他］ラジオボタンを選択し，テキストボックスにポート番号を入力します。ポート番号には，0〜65535までの数字を入力できます。ポート番号に0を入力した場合，未使用のポート番号が自動で設定されます。

［通信の設定］

送受信の最大サイズおよびタイムアウト値を指定します。

［送受信の最大サイズ(MB)］

データ（電文など）の送受信の最大サイズ（単位：MB）を指定します。任意の最大サイズを指定する場合は，［その他］ラジオボタンを選択し，テキストボックスに送受信の最大サイズを入力します。送受信の最大サイズには1〜2,000までの数字を入力できます。［送受信の最大サイズ(MB)］に入力したサイズ以上のデータを送受信した場合，ビジネスプロセスのデバッグが強制的に終了します。

参考

このパラメタは，ビジネスプロセスのデバッグで扱うことができる変数値（電文）の長さ，XPath式の長さ，XPath式の評価結果の長さ，デバッグ実行時に受信するデバッグ情報のサイズに影響します。

［タイムアウト(秒)］

開発環境と実行環境の間でビジネスプロセスのデバッグのための接続が確立するまでのタイムアウト値（単位：秒）を設定します。任意のタイムアウト値を指定する場合は，［その他］ラジオボタンを選択し，テキストボックスにタイムアウト値を入力します。タイムアウト値には1〜1,800までの数字を入力できます。

［パッケージング済みビジネスプロセス］

パッケージング済みのビジネスプロセスを再パッケージングするかどうかを選択します。

［再パッケージングしない］ラジオボタンを選択した場合は再パッケージングされません。

［再パッケージングする］ラジオボタンを選択した場合は再パッケージングされます。

［サービス呼出アクティビティに設定されているサービス］

サービス呼出アクティビティに設定されているサービスを配備・開始するかどうかを選択します。

［自動的に配備・開始する］ラジオボタンを選択した場合は自動的に配備・開始されます。

［配備・開始しない］ラジオボタンを選択した場合は配備・開始されません。

1.5.2　条件設定ダイアログ

ブレークポイントの条件設定を変更するダイアログです。

図1‒107　［条件設定］ダイアログ

プロセスインスタンスの処理が中断する条件式をXPathで指定します。条件式に空文字（0x00）は使用できません。

1.5.3　値の設定ダイアログ

［値の設定］ダイアログは，メッセージ型の変数の場合とメッセージ型以外の変数の場合とで，表示される内容が異なります。

(1)　値の設定ダイアログ（メッセージ型の変数の場合）

メッセージ型の変数の値を更新するときに使用するダイアログです。

変数ビューからXML，non-XML，anyの変数を右クリックし，［値の変更］を選択した場合に表示されます。

図1‒108　［値の設定］ダイアログ（メッセージ型の変数の場合）

変数の型がXMLの場合に，入力フィールドに変数の値を入力します。バイナリ型（non-XML），any型の変数の値は入力できません。

変数の値に空文字（0x00）は使用できません。メッセージ型の変数を更新すると，XMLの文字コードは必ずUTF-8になります（UTF-8以外の文字コードを指定してもUTF-8に変換されます）。

［読み込み］ボタン

ファイルを設定するダイアログが表示されます。

［保存］ボタン

ファイルを保存するダイアログが表示されます。

［OK］ボタン

入力した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　値の設定ダイアログ（メッセージ型以外の変数の場合）

XML，non-XML，any以外の変数の値を更新するときに使用するダイアログです。

変数ビューからXML，non-XML，any以外の変数を右クリックし，［値の変更］を選択した場合に表示されます。

図1‒109　［値の設定］ダイアログ（メッセージ型以外の変数の場合）

入力フィールドに変数の値を入力します。変数の型ごとに入力できる値の範囲を次の表に示します。

表1‒12　変数の型ごとに入力できる値の範囲

変数の型

値の範囲

numeric型

java.lang.DoubleのvalueOf（java.lang.String）メソッドで解釈できる値（例：+1，3.14，1e-2d）

boolean型

trueまたはfalse

string型

任意の文字列（例：15インチLCDディスプレイ）

［OK］ボタン

入力した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

1.6　データ変換に関連するダイアログ

データ変換に関連するダイアログについて説明します。データ変換定義画面のマッピング定義時に表示されるダイアログと，ファンクションの操作時に表示されるダイアログに，大きく分類されます。

1.6.1　変換元スキーマファイル設定ダイアログ

［変換元スキーマファイル設定］ダイアログでは，N対1でデータ変換をする場合に，変換元スキーマのファイルを指定します。

次のどちらかの操作をした場合に表示されます。

新規マッピング定義ファイルのウィザードの「変換元・変換先スキーマファイル設定」ページで［N対1変換］ラジオボタンを選択し，［追加］または［編集］ボタンをクリックする

N対1のデータ変換定義作成時に，［変換元・変換先スキーマファイル設定］ダイアログの［編集］ボタンをクリックする

図1‒110　［変換元スキーマファイル設定］ダイアログ

(1)　表示項目

［変換元スキーマ］

変換元スキーマのファイルパスを指定します。

［選択］ボタン

変換元スキーマのファイルを選択するダイアログが表示されます。

［スキーマ論理名］

変換元スキーマ内で一意となるスキーマ論理名を指定します。

［OK］ボタン

設定した内容を検証したあと，設定を保存して，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［変換元スキーマファイル設定］ダイアログでは，N対1のデータ変換に使用する変換元スキーマのファイルを追加または変更できます。データ変換の定義方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.3.1　データ変換の定義手順」を参照してください。

1.6.2　変換元・変換先スキーマファイル設定ダイアログ

［変換元・変換先スキーマファイル設定］ダイアログでは，変換元スキーマのファイルと，変換先スキーマのファイルを指定します。

変換元スキーマツリービューアまたは変換先スキーマツリービューアのスキーマ論理名を右クリックし，［ルート要素選択］を選択した場合に表示されます。1対1とN対1のデータ変換では，表示されるダイアログが異なります。

図1‒111　［変換元・変換先スキーマファイル設定］ダイアログ（1対1のデータ変換の場合）

図1‒112　［変換元・変換先スキーマファイル設定］ダイアログ（N対1のデータ変換の場合）

(1)　表示項目

(a)　1対1のデータ変換の場合

［変換元スキーマ］

変換元スキーマのファイルパスを指定します。［選択］ボタンから変換元スキーマのファイルを指定できます。

［選択］ボタン

変換元スキーマのファイルを選択するダイアログが表示されます。

［変換先スキーマ］

変換先スキーマのファイルパスを指定します。［選択］ボタンから変換先スキーマのファイルを指定できます。

［選択］ボタン

変換先スキーマのファイルを選択するダイアログが表示されます。

［OK］ボタン

設定した内容を検証したあと，設定を保存して，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(b)　N対1のデータ変換の場合

［変換元スキーマ］

［ファイルパス］

以前指定した変換元スキーマのファイルパスが表示されます。

［スキーマ論理名］

以前指定した変換元スキーマのスキーマ論理名が表示されます。

［編集］ボタン

変換元スキーマが選択されている状態でクリックすると，［変換元スキーマファイル設定］ダイアログが表示され，変換元スキーマファイルとスキーマ論理名を変更できます。［変換元スキーマファイル設定］ダイアログについては，「1.6.1　変換元スキーマファイル設定ダイアログ」を参照してください。

［変換先スキーマ］

変換先スキーマのファイルパスを指定します。［選択］ボタンから変換先スキーマのファイルを指定できます。

［選択］ボタン

変換先スキーマのファイルを選択するダイアログが表示されます。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［変換元・変換先スキーマファイル設定］ダイアログでは，変換元スキーマのファイルと変換先スキーマのファイルを指定できます。データ変換の定義方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.3.1　データ変換の定義手順」を参照してください。

1.6.3　ルート要素選択ダイアログ

［ルート要素選択］ダイアログでは，マッピングするスキーマ論理名のルート要素を選択します。

次のどれかの操作をした場合に表示されます。

サービスアダプタ定義画面またはビジネスプロセス定義画面のデータ変換アクティビティから，データ変換定義画面を表示する（新規にデータ変換を定義する場合）

スキーマ（電文フォーマット）のルート要素を変更または削除してからデータ変換定義画面を表示する

変換元スキーマツリービューアまたは変換先スキーマツリービューアのスキーマ論理名を右クリックし，［ルート要素選択］を選択する

［ルート要素選択］ダイアログを次に示します。

図1‒113　［ルート要素選択］ダイアログ

(1)　表示項目

［スキーマ論理名］

マッピング対象となるXMLスキーマファイルのスキーマ論理名が表示されます。

［ルート要素］

ルート要素をドロップダウンリストから選択します。選択したルート要素のスキーマがデータ変換定義画面でツリー表示されます。

［変換元/変換先］

マッピング対象となるXMLスキーマファイルが，変換元XMLスキーマファイルの場合は「変換元」，変換先XMLスキーマファイルの場合は「変換先」と表示されます。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。ただし，次の場合にクリックするとエラーになります。

ルート要素を初めて選択する場合

電文フォーマットを変更してデータ変換を定義し直す場合

(2)　このダイアログでできる内容

［ルート要素選択］ダイアログでは，ルート要素を選択および変更することができます。選択および変更すると，ルート要素のスキーマがデータ変換定義画面でツリー表示されます。ルート要素の選択および変更方法については，マニュアル「サービスプラットフォーム開発ガイド 基本開発編」の「7.3.1　データ変換の定義手順」を参照してください。

1.6.4　マッピング元設定ダイアログ

［マッピング元設定］ダイアログでは，マッピング元となる変換元ノードおよびファンクションを指定します。

［マッピング元設定］ダイアログは，変換先ノードを右クリックして，［マッピング元］を選択した場合に表示されます。

［マッピング元設定］ダイアログを次に示します。

図1‒114　［マッピング元設定］ダイアログ

(1)　表示項目

［パス/ファンクション名］

マッピング元となる変換先ノードおよびファンクションを指定します。すでにマッピングされている場合，そのマッピング元が表示されます。

［パス/ファンクション名］での表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［依存対象］

くり返しファンクションを使用した場合，［パス/ファンクション名］で指定したくり返しファンクションに対応するくり返し依存対象が表示されます。くり返し依存対象の詳細については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.6　くり返しの設定」を参照してください。

［ノード追加］ボタン

［ノード選択］ダイアログが表示されます。［パス/ファンクション名］にマッピング元となる変換元ノードを追加する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。変換元ノードに条件を設定して，その条件を満たす場合だけマッピングさせるときにクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［ファンクション追加］ボタン

［ファンクション選択］ダイアログが表示されます。［パス/ファンクション名］にマッピング元となるファンクションを追加する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［除去］ボタン

［パス/ファンクション名］で選択した変換元ノードまたはファンクションが［パス/ファンクション名］から削除されます。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［マッピング元設定］ダイアログでは，次のことができます。

マッピングする

［マッピング元設定］ダイアログを使用したマッピング方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4　マッピングする」を参照してください。

くり返し依存対象を確認する

くり返し依存対象の確認方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.6.4　くり返し依存対象を確認する」を参照してください。

くり返し依存対象を変更する

くり返し依存対象の変更方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.6.5　くり返し依存対象を変更する」を参照してください。

1.6.5　自動マッピング元設定ダイアログ

［自動マッピング元設定］ダイアログでは，自動でマッピングさせる変換元ノードの範囲と変換先ノードの範囲を指定します。

［自動マッピング元設定］ダイアログは，変換先ノードの要素（自動でマッピングさせたい範囲の最上位要素）を右クリックして，［自動マッピング］を選択した場合に表示されます。

［自動マッピング元設定］ダイアログを次に示します。

図1‒115　［自動マッピング元設定］ダイアログ

(1)　表示項目

［パス］

［ノード追加］ボタンで選択したマッピング対象の要素が表示されます。

［自動マッピング元設定］ダイアログを閉じると［パス］に表示されている内容はリセットされ，再び［自動マッピング元設定］ダイアログを表示したときには［パス］には何も選択されていない状態になります。

［ノード追加］ボタン

［ノード選択］ダイアログが表示されます。［パス］にマッピング元となる変換元ノードの要素を追加する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［除去］ボタン

［パス］で選択した要素が［パス］から削除されます。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［自動マッピング元設定］ダイアログでは，変換元ノードの範囲と変換先ノードの範囲を指定すると，変換元ノードと変換先ノードで類似度が高い要素同士を自動でマッピングします。範囲内にマッピング候補が存在しない場合やすでに変換先ノードアダプタにマッピング線が接続されている場合は，マッピングされません。

1.6.6　自動マッピング候補選択ダイアログ

［自動マッピング候補選択］ダイアログでは，自動でマッピングさせる要素の候補を指定します。

［自動マッピング候補選択］ダイアログは，変換先ノードの要素を右クリックして，［自動マッピング候補選択］を選択した場合に表示されます。

［自動マッピング候補選択］ダイアログを次に示します。

図1‒116　［自動マッピング候補選択］ダイアログ

(1)　表示項目

［自動マッピング候補一覧］

選択した変換先ノードの要素に対して，マッピングの候補となる変換元ノードの要素が一覧で表示されます。表示順序は優先度が高い候補ほど上位になります。

自動でマッピングする候補が存在しない場合，［自動マッピング候補一覧］には何も表示されません。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［自動マッピング候補選択］ダイアログでは，変換元ノードの要素の候補を指定すると，選択した候補の要素がマッピングされ，マッピング線（代入線）が自動で設定されます。また，選択した要素のノードアダプタにマッピング線が接続済みの場合でも，同一の要素で依存関係が異なるマッピング線を接続できるときは，指定した候補とのマッピングが実行されます。

1.6.7　くり返し設定ダイアログ

［くり返し設定］ダイアログでは，マッピング元となるくり返しファンクションを指定します。［くり返し設定］ダイアログを次に示します。

［くり返し設定］ダイアログは，くり返しファンクションを使用した場合，変換先ノードを右クリックして，［くり返し］を選択したときに表示されます。

［くり返し設定］ダイアログを次に示します。

図1‒117　［くり返し設定］ダイアログ

(1)　表示項目

［ファンクション名］

マッピング元となるくり返しファンクションを指定します。くり返しファンクション名が表示されます。

［依存対象］

［ファンクション名］で指定したくり返しファンクションに対応するくり返し依存対象が表示されます。くり返し依存対象の詳細については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.6　くり返しの設定」を参照してください。

［ファンクション追加］ボタン

［ファンクション選択］ダイアログが表示されます。［ファンクション名］にマッピング元となるくり返しファンクションを追加する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［上へ］ボタン

［ファンクション名］で選択したくり返しファンクションの位置が1つ上に移動します。このボタンは，くり返しを合成する場合に使用することがあります。

［下へ］ボタン

［ファンクション名］で選択したくり返しファンクションの位置が1つ下に移動します。このボタンは，くり返しを合成する場合に使用することがあります。

［除去］ボタン

［ファンクション名］で選択したくり返しファンクションが［ファンクション名］から削除されます。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［くり返し設定］ダイアログでは，次のことができます。

マッピングする

くり返しを合成する

くり返し依存対象を確認する

くり返し依存対象を変更する

上記の方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.6　くり返しの設定」を参照してください。

1.6.8　ノード選択ダイアログ（データ変換）

［ノード選択］ダイアログ（データ変換）では，変換元ノード，または変換先ノードを指定します。

次のどれかの操作をした場合に，変換元ノードを指定する［ノード選択］ダイアログ（データ変換）が表示されます。

［マッピング元設定］ダイアログの［ノード追加］ボタンをクリックする

各ファンクションの設定ダイアログの［ノード追加］ボタンまたは［ノード選択］ボタンをクリックする

［自動マッピング元設定］ダイアログの［ノード追加］ボタンをクリックする

［複製マッピング元設定］ダイアログの［ノード追加］ボタンをクリックする

［複製マッピング範囲設定］ダイアログの［変換元ノード］の［ノード選択］ボタンをクリックする

次の操作をした場合に，変換先ノードを指定する［ノード選択］ダイアログ（データ変換）が表示されます。

［複製マッピング範囲設定］ダイアログの［変換先ノード］の［ノード選択］ボタンをクリックする

［ノード選択］ダイアログ（データ変換）を次に示します。

図1‒118　［ノード選択］ダイアログ（データ変換）

(1)　表示項目

［変換元ノード］

マッピング定義の変換元ノードが表示されます。

起動元ダイアログの項目へ設定できないノードは，グレーで表示されます。グレーで表示されたノードを選択した場合，［OK］ボタンはクリックできません。

［変換先ノード］

マッピング定義の変換先ノードが表示されます。

起動元ダイアログの項目へ設定できないノードは，グレーで表示されます。グレーで表示されたノードを選択した場合，［OK］ボタンはクリックできません。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［ノード選択］ダイアログ（データ変換）では，次のことができます。

マッピング元となる変換元ノードを指定する

［マッピング元設定］ダイアログまたは各ファンクションの設定ダイアログから表示した場合，マッピング元となる変換元ノードを指定して，［マッピング元設定］ダイアログまたは各ファンクションの設定ダイアログに変換元ノードを設定します。

自動マッピングでマッピング元となる変換元ノードを指定する

［自動マッピング元設定］ダイアログから表示した場合，自動でマッピングさせたい変換元ノードの要素を指定して，［自動マッピング元設定］ダイアログのパスに変換元ノードの要素を設定します。

構造一致の複製マッピングでコピー先となる変換元ノードを指定する

［複製マッピング元設定］ダイアログから表示した場合，コピー先となる変換元ノードを指定して，［複製マッピング元設定］ダイアログに変換元ノードを設定します。

要素名一致の複製マッピングでコピー元またはコピー先となる変換元ノードを指定する

［複製マッピング範囲設定］ダイアログの［変換元ノード］から表示した場合，マッピング定義のコピー元またはコピー先となる変換元ノードを指定して，［複製マッピング範囲設定］ダイアログに変換元ノードを設定します。

要素名一致の複製マッピングでコピー元またはコピー先となる変換先ノードを指定する

［複製マッピング範囲設定］ダイアログの［変換先ノード］から表示した場合，マッピング定義のコピー元またはコピー先となる変換先ノードを指定して，［複製マッピング範囲設定］ダイアログに変換先ノードを設定します。

1.6.9　ファンクション選択ダイアログ

［ファンクション選択］ダイアログは，マッピング元となるファンクションを指定します。

次のどちらかの操作をした場合に表示されます。

［マッピング元設定］ダイアログの［ファンクション追加］ボタンをクリックする

各ファンクションの設定ダイアログの［ファンクション追加］ボタンまたは［ファンクション選択］ボタンをクリックする

［ファンクション選択］ダイアログを次に示します。

図1‒119　［ファンクション選択］ダイアログ

(1)　表示項目

［ファンクション］

マッピング元として選択できるファンクションが表示されます。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［ファンクション選択］ダイアログでは，マッピング元となるファンクションを指定して，［マッピング元設定］ダイアログまたは各ファンクションの設定ダイアログに指定したファンクションを設定します。

1.6.10　名称検索ダイアログ

［名称検索］ダイアログでは，要素名またはファンクション名を部分一致で検索して，検索結果のパスを一覧表示します。

ダイアログを表示したまま，画面上のマッピング定義を編集することもできます。なお，ダイアログが表示された状態で画面上のファンクション名を変更した場合，動作は保証しません。

［名称検索］ダイアログは，データ変換定義画面のツリービューアまたはマッピングビューアの適当な場所で右クリックして，［名称検索］を選択した場合に表示されます。

［名称検索］ダイアログを次に示します。

図1‒120　［名称検索］ダイアログ

(1)　表示項目

［検索対象］

検索対象として，［変換元ノード］，［ファンクション］または［変換先ノード］チェックボックスを選択します。チェックボックスを複数選択することもできます。

［検索］

検索文字列を指定します。指定後に［検索］ボタンをクリックすると，検索文字列を含むノードまたはファンクションを部分一致で検索できます。

ノードを検索する場合，ノードのパス全体ではなく，パス末端の要素名だけが検索対象となります。検索対象となるノードの種別は次のとおりです。

論理名

複合内容要素

単純内容要素

属性

any要素

anyAttribute属性

#(sequence)

#(choice)

#anonymous

検索に関しては次の点に注意してください。

検索文字列の大文字と小文字は区別されません。

正規表現での検索はできません。

検索結果は，［検索結果一覧］に一覧表示されます。

［検索］ボタン

［検索］に指定した検索文字列を含む，ノードまたはファンクションを部分一致で検索できます。検索結果は［検索結果一覧］に表示されます。

［検索結果一覧］

検索結果が一覧表示されます。

［名称］

検索結果が画面上の表示順に従って一覧表示されます。表示された検索結果を選択すると，表示元のデータ変換定義画面の該当個所も選択されます。

検索対象

［名称］の表示内容

検索結果の選択時に，表示元の画面で選択される個所

変換元ノード

検索結果のノードのパス

変換元スキーマツリービューア上の該当するノード

ファンクション

検索結果のファンクション名

該当するファンクション

変換先ノード

検索結果のノードのパス

変換先スキーマツリービューア上の該当するノード

なお，検索対象が「変換元ノード」または「変換先ノード」の場合，表示されたパスは次の手順でクリップボードへコピーできます。N対1変換時は，「$<スキーマの論理名（ビジネスプロセスの変数名）>」を含むパスがコピーされます。

コピーしたいパスを選択して右クリックする

コンテキストメニューで［要素パスのコピー］を選択する

スキーマの論理名の場合は，右クリックしても［要素パスのコピー］は表示されません。

［種別］

検索結果の種別を表示します。

検索対象が「変換元ノード」または「変換先ノード」の場合は，次の内容が表示されます。

ノードの種別

［種別］に出力される内容

論理名

論理名

複合内容要素

複合内容要素

単純内容要素

単純内容要素

属性

属性

any要素

any

anyAttribute属性

anyAttribute

#(sequence)

#(sequence)

#(choice)

#(choice)

#anonymous

#anonymous

検索対象が「ファンクション」の場合は，次の内容が表示されます。

ファンクションの種別

［種別］に出力される内容

文字列連結ファンクション

concat

部分文字列取得ファンクション

substr

文字数取得ファンクション

length

文字列調査ファンクション

contain

空白除去ファンクション

trim

数値フォーマット変換ファンクション

format

数値演算ファンクション

calc

端数処理ファンクション

round

総和ファンクション

sum

否定演算ファンクション

not

論理演算ファンクション

bitop

シフト演算ファンクション

shift

ノード名取得ファンクション

name

ノード数取得ファンクション

count

ノード調査ファンクション

exist

くり返しファンクション

loop

選択ファンクション

choose

値置換えファンクション

replace

基数変換ファンクション

radix

カスタムファンクション

custom

定数ファンクション

const

XPathファンクション

xpath

［検索対象］

検索時に［検索対象］で選択した項目（「変換元ノード」，「ファンクション」，または「変換先ノード」）を表示します。

［検索要素数］

検索結果の個数が表示されます。

なお，この項目は，［検索］ボタンをクリックして検索を実行したあとに，［検索結果一覧］の下に表示されます。

［閉じる］ボタン

［名称検索］ダイアログを閉じます。

(2)　このダイアログでできる内容

［名称検索］ダイアログでは，要素名またはファンクション名を部分一致で検索できます。変換元ノード，変換先ノード，またはファンクションの数が多い場合に，使用したいノードまたはファンクションを簡単に探し出せます。

1.6.11　ノード条件設定ダイアログ

［ノード条件設定］ダイアログでは，ノード条件を設定する変換元ノードを指定し，条件を設定します。

次のどちらかの操作をした場合に表示されます。

［マッピング元設定］ダイアログの［ノード条件設定］ボタンをクリックする

各ファンクションの設定ダイアログの［ノード条件設定］ボタンをクリックする

［ノード条件設定］ダイアログを次に示します。

図1‒121　［ノード条件設定］ダイアログ

(1)　表示項目

［ノード］

［マッピング元設定］ダイアログまたは各ファンクションを設定するダイアログで選択したノードおよびその子孫ノードが表示されます。

［条件］

［条件設定］ダイアログで設定した条件が表示されます。

［条件設定］ボタン

［条件設定］ダイアログが表示されます。変換元ノードに条件を設定する場合にクリックします。

［条件設定］ダイアログについては，「1.6.12　条件設定ダイアログ（ノード条件の設定）」を参照してください。

［条件削除］ボタン

［条件］で選択した条件を［条件］から削除します。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［ノード条件設定］ダイアログでは，ノード条件を設定する変換元ノードを指定して，ノード条件を設定します。条件を設定した変換元ノードは，その条件を満たす場合だけマッピングします。変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

1.6.12　条件設定ダイアログ（ノード条件の設定）

［条件設定］ダイアログでは，条件の内容を決めます。

次のどれかの操作をした場合に表示されます。

［ノード条件設定］ダイアログの［条件設定］ボタンをクリックする

［条件追加/編集］ダイアログの［条件設定］ボタンをクリックする

［条件設定］ダイアログの［条件設定］ボタンをクリックする

［条件設定］ダイアログを次に示します。

図1‒122　［条件設定］ダイアログ（ノード条件の設定）

(1)　表示項目

［生成する条件］

［条件］で設定した条件が表示されます。

［条件の否定をとる］チェックボックスにチェックした場合，条件の先頭に「not」が表示されます。

［条件の否定をとる］チェックボックス

［条件］で設定した条件と反対の内容を条件とする場合にチェックします。

［条件］

［boolean値を返すノードまたはファンクション］ラジオボタン

論理値を条件として設定する場合に選択します。

［ノード選択］ボタンまたは［ファンクション選択］ボタンで指定したマッピング元の値によって，次の論理値が設定されます。

マッピング元の値が「true」，または「0」，「-0」，もしくは「NaN」以外の数値の場合

真が条件として設定されます。

マッピング元の値が「true」以外の文字列，または「0」，「-0」，もしくは「NaN」の数値の場合

偽が条件として設定されます。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。マッピング元に変換元ノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ファンクション選択］ボタン

［ファンクション選択］ダイアログが表示されます。マッピング元にファンクションを指定する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［条件式］ラジオボタン

指定した条件式を条件として設定する場合に選択します。

［左辺］

［Position］ラジオボタン

マッピング元のインスタンスの出現する順番を条件として設定する場合に選択します。

例えば，「Position=2」（このラジオボタンを選択し，右辺の値に「2」を指定）と指定した場合，2番目に出現するインスタンスを条件として設定します。

［ノード・ファンクション］ラジオボタン

変換元ノードまたはファンクションの値を条件として設定する場合に選択します。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。条件式の左辺に変換元ノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ファンクション選択］ボタン

［ファンクション選択］ダイアログが表示されます。条件式の左辺にファンクションを指定する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［演算］ドロップダウンリスト

条件式に設定する演算子が表示されます。表示される演算子を次に示します。

=

!=

>

<

>=

<=

［右辺］

［値］ラジオボタン

ユーザが指定した値を条件として設定する場合に選択します。指定できる文字数は，1,024文字までです。

［ノード・ファンクション］ラジオボタン

変換元ノードまたはファンクションの値を条件として設定する場合に選択します。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。条件式の右辺に変換元ノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ファンクション選択］ボタン

［ファンクション選択］ダイアログが表示されます。条件式の右辺にファンクションを指定する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［二つの条件の論理積・論理和］ラジオボタン

2つの条件を設定して，その条件の論理積または論理和を条件に設定する場合に選択します。条件に複数の「二つの条件の論理積・論理和」が存在する場合は，論理積が優先されます。ただし，前後を丸括弧「()」で囲んだ場合は，その論理式が優先されます。

［条件1］

1つ目の条件が表示されます。

［条件設定］ボタン

［条件設定］ダイアログが表示されます。1つ目の条件を設定する場合にクリックします。

［演算］ドロップダウンリスト

and（論理積）またはor（論理和）が表示されます。

［条件2］

2つ目の条件が表示されます。

［条件設定］ボタン

［条件設定］ダイアログが表示されます。2つ目の条件を設定する場合にクリックします。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［条件設定］ダイアログでは，次のことができます。

ノード条件を設定する

ノード条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

選択ファンクションの条件を設定する

選択ファンクションの条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.13　マッピング定義登録ダイアログ

［マッピング定義登録］ダイアログでは，マッピング定義をコピーするときのコピー元として登録するマッピング定義ファイル（拡張子：.mdo）を指定します。

［マッピング定義登録］ダイアログは，データ変換定義画面の変換元スキーマツリービューア，マッピングビューア，または変換先スキーマツリービューアの適当な場所で右クリックして，［マッピング定義登録］を選択した場合に表示されます。

［マッピング定義登録］ダイアログを次に示します。

図1‒123　［マッピング定義登録］ダイアログ

(1)　表示項目

［マッピング定義ファイル］

コピー元となるマッピング定義ファイルを指定します。すでにマッピング定義ファイルが登録されている場合，登録されているマッピング定義ファイルが表示されます。

［選択］ボタン

ファイルを選択するダイアログが表示されます。ファイルを選択するダイアログに最初に表示されるディレクトリは，［設定］ダイアログで任意の場所に設定できます。［設定］ダイアログについては，「1.6.18　設定ダイアログ（データ変換の設定）」を参照してください。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［マッピング定義登録］ダイアログでは，マッピング定義をコピーするときのコピー元として登録するマッピング定義ファイル（拡張子：.mdo）を設定できます。マッピング定義のコピーについては，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.8.4　マッピング定義のコピー」を参照してください。

1.6.14　複製マッピング範囲設定ダイアログ

［複製マッピング範囲設定］ダイアログでは，マッピング定義をコピーするときにコピー元およびコピー先となるノード（変換元ノードおよび変換先ノード）を指定します。

［複製マッピング範囲設定］ダイアログは，データ変換定義画面の変換先スキーマツリービューアで複合内容要素を右クリックし，［複製マッピング］から「要素名一致」を選択した場合に表示されます。

［複製マッピング範囲設定］ダイアログを次に示します。

図1‒124　［複製マッピング範囲設定］ダイアログ

(1)　表示項目

［複製マッピング元］

［変換元ノード］

複製マッピング元の変換元ノードを指定します。

変換元ノードを変更する場合は右側の［ノード選択］ボタンをクリックし，表示された［ノード選択］ダイアログで指定します。［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［変換先ノード］

複製マッピング元の変換先ノードを指定します。

変換先ノードを変更する場合は右側の［ノード選択］ボタンをクリックし，表示された［ノード選択］ダイアログで指定します。［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［複製マッピング先］

［変換元ノード］

複製マッピング先の変換元ノードを指定します。

変換元ノードを変更する場合は右側の［ノード選択］ボタンをクリックし，表示された［ノード選択］ダイアログで指定します。［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［変換先ノード］

複製マッピング先の変換先ノードを指定します。

変換先ノードを変更する場合は右側の［ノード選択］ボタンをクリックし，表示された［ノード選択］ダイアログで指定します。［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［複製マッピング範囲設定］ダイアログでは，マッピング定義のコピー元およびコピー先となるノードを設定できます。それぞれの項目に変換元ノードおよび変換先ノードを設定します。

マッピング定義のコピーについては，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.8.4　マッピング定義のコピー」を参照してください。

1.6.15　複製マッピング元設定ダイアログ

［複製マッピング元設定］ダイアログでは，マッピング定義をコピーするときにコピー先となるノード（変換元ノード）を指定します。

［複製マッピング元設定］ダイアログは，データ変換定義画面の変換先スキーマツリービューアで複合内容要素を右クリックし，［複製マッピング］から［構造一致］を選択した場合に表示されます。

［複製マッピング元設定］ダイアログを次に示します。

図1‒125　［複製マッピング元設定］ダイアログ

(1)　表示項目

［パス］

マッピング定義をコピーするときにコピー先となるノード（変換元ノード）を指定します。

［パス］での表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード追加］ボタン

［ノード選択］ダイアログが表示されます。［パス］にノード（変換元ノード）を追加する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［除去］ボタン

［パス］で選択したノード（変換元ノード）が［パス］から削除されます。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［複製マッピング元設定］ダイアログでは，マッピング定義をコピーするときにコピー先となるノード（変換元ノード）を設定できます。マッピング定義のコピーについては，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.8.4　マッピング定義のコピー」を参照してください。

1.6.16　マッピング定義のインポートダイアログ

［マッピング定義のインポート］ダイアログは，Excelで定義したマッピング内容を表形式XMLファイルでエクスポートしたあと，その定義内容をデータ変換定義画面へインポートするときに使用します。

［マッピング定義のインポート］ダイアログは，データ変換定義画面のマッピングビューア上で右クリックして，［マッピング定義のインポート］を選択した場合に表示されます。

［マッピング定義のインポート］ダイアログを次に示します。

図1‒126　［マッピング定義のインポート］ダイアログ

(1)　表示項目

［表形式XMLファイル名］

インポートする表形式XMLファイル名を指定します。

［参照］ボタン

表形式XMLファイルを設定するダイアログが表示されます。

［終了］ボタン

［マッピング定義のインポート］ダイアログを閉じます。

Excelで定義したファンクションとマッピング線が，データ変換定義画面に反映されます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［マッピング定義のインポート］ダイアログでは，Excelで定義したマッピングをインポートできます。マッピング定義のインポートについては，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.13　Excelを利用したマッピング定義のインポート」を参照してください。

1.6.17　マッピング定義のエクスポートダイアログ

［マッピング定義のエクスポート］ダイアログは，マッピング定義エディタで定義したマッピング内容を，表形式XMLファイルにエクスポートするときに使用します。

［マッピング定義のエクスポート］ダイアログは，データ変換定義画面のマッピングビューア上で右クリックして，［マッピング定義のエクスポート］を選択した場合に表示されます。

［マッピング定義のエクスポート］ダイアログを次に示します。

図1‒127　［マッピング定義のエクスポート］ダイアログ

(1)　表示項目

［ファイル名］

エクスポートする表形式XMLファイル名を指定します。

［ファイルの種類］

表形式XMLファイル(*.xml)を指定します。

［保存］ボタン

マッピング定義のエクスポートを開始するダイアログが表示されます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［マッピング定義のエクスポート］ダイアログでは，定義したマッピングを表形式XMLファイルにエクスポートできます。Excelを利用したマッピング定義のエクスポートについては，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.14　Excelを利用したマッピング定義のエクスポート」を参照してください。

1.6.18　設定ダイアログ（データ変換の設定）

データ変換について設定する場合の，［設定］ダイアログの表示手順を次に示します。

Eclipseのメニューから，［ウィンドウ］−［設定］を選択します。

［設定］ダイアログが表示されます。

ダイアログ左側から［HCSC-Definer］−［データ変換］を選択します。

データ変換定義画面の設定項目がダイアログ右側に表示されます。

ダイアログ右側に表示されるマッピングタブとカスタムファンクションタブについて，次に説明します。

(1)　表示項目

(a)　マッピングタブ

［設定］ダイアログのデータ変換のマッピングタブを次に示します。

図1‒128　［設定］ダイアログ（データ変換のマッピングタブ）

表示項目は次のとおりです。

［線の色］

［代入］

［代入］の右側にあるボタンをクリックすると，［色の設定］ダイアログが表示されます。

［くり返し］

［くり返し］の右側にあるボタンをクリックすると，［色の設定］ダイアログが表示されます。

［条件］

［条件］の右側にあるボタンをクリックすると，［色の設定］ダイアログが表示されます。

［マッピング定義フォルダ］

［フォルダ］

マッピング定義を保存するとき，およびマッピング定義を登録するときに最初に表示するフォルダを指定します。

［参照］ボタン

フォルダの選択画面が表示されます。

［デフォルトの復元］ボタン

データ変換をデフォルトの設定に戻します。データ変換のデフォルトの設定は次のとおりです。

マッピング線の色：グレー

マッピング定義フォルダ：空欄

変換ファンクション定義ファイル：空欄

変換ファンクション定義ファイルについては，「(b)　カスタムファンクションタブ」を参照してください。

［適用］ボタン

設定した内容を有効にします。ダイアログは閉じません。

［Apply and Close］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(b)　カスタムファンクションタブ

［設定］ダイアログのデータ変換のカスタムファンクションタブを次に示します。

図1‒129　［設定］ダイアログ（データ変換のカスタムファンクションタブ）

表示項目は次のとおりです。

［変換ファンクション定義ファイル］

［ファイル］

カスタムファンクションの定義で使用する変換ファンクション定義ファイルを指定します。

［参照］ボタン

ファイルの選択画面が表示されます。

［除去］ボタン

［ファイル］に指定した変換ファンクション定義ファイルが［ファイル］から削除されます。

［デフォルトの復元］ボタン

データ変換をデフォルトの設定に戻します。データ変換のデフォルトの設定は次のとおりです。

マッピング線の色：グレー

マッピング定義フォルダ：空欄

変換ファンクション定義ファイル：空欄

マッピング線の色，およびマッピング定義フォルダについては，「(a)　マッピングタブ」を参照してください。

［適用］ボタン

設定した内容を有効にします。ダイアログは閉じません。

［Apply and Close］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［設定］ダイアログでは次のことができます。

マッピングタブの場合

マッピング線の色を変更できます。詳細については，「1.13.5　マッピング線の色を変更する」を参照してください。

［マッピング定義登録］ダイアログおよび［マッピング定義保存］ダイアログで最初に参照するディレクトリを設定できます。［マッピング定義登録］ダイアログについては，「1.6.13　マッピング定義登録ダイアログ」を参照してください。

カスタムファンクションタブの場合

カスタムファンクションを定義するときに必要となる変換ファンクション定義ファイルを登録できます。カスタムファンクションの定義方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.19　文字列連結ダイアログ

［文字列連結］ダイアログでは，連結対象となる文字列を指定します。

次のどちらかの操作をした場合に表示されます。

文字列連結ファンクションを右クリックし，［設定］を選択する

文字列連結ファンクションをダブルクリックする

［文字列連結］ダイアログを次に示します。

図1‒130　［文字列連結］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクション名を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［入力］

連結対象となる文字列の変換元ノードおよびファンクションを指定します。すでに連結対象と文字列連結ファンクションがマッピングされている場合，その連結対象が表示されます。

［入力］での表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード追加］ボタン

［ノード選択］ダイアログが表示されます。［入力］に連結対象となる文字列の変換元ノードを追加する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。変換元ノードに条件を設定して，その条件を満たす場合だけマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［ファンクション追加］ボタン

［ファンクション選択］ダイアログが表示されます。［入力］に連結対象となる文字列のファンクションを追加する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［上へ］ボタン

［入力］で選択した変換元ノードまたはファンクションの位置が1つ上に移動します。

［下へ］ボタン

［入力］で選択した変換元ノードまたはファンクションの位置が1つ下に移動します。

［除去］ボタン

［入力］で選択した変換元ノードまたはファンクションが［入力］から削除されます。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［文字列連結］ダイアログでは，文字列連結ファンクションを設定できます。部分文字列取得ファンクションの設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.20　部分文字列取得ダイアログ

［部分文字列取得］ダイアログでは，1つの文字列から取り出す一部分の文字列を指定します。

次のどちらかの操作をした場合に表示されます。

部分文字列取得ファンクションを右クリックし，［設定］を選択する

部分文字列取得ファンクションをダブルクリックする

［部分文字列取得］ダイアログを次に示します。

図1‒131　［部分文字列取得］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクション名を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［入力］

一部分の文字列の取り出し元となる変換元ノードおよびファンクションを指定します。すでに取り出し元と部分文字列取得がマッピングされている場合，その取り出し元が表示されます。

［入力］での表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［入力］に一部分の文字列の取り出し元となる変換元ノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。変換元ノードに条件を設定して，その条件を満たす場合だけマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［ファンクション選択］ボタン

［ファンクション選択］ダイアログが表示されます。［入力］に一部分の文字列の取り出し元となるファンクションを指定する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［取得方法］

［先頭からの範囲指定］ラジオボタン

取り出す範囲を文字列の先頭から指定する場合に選択します。

［開始位置］

取り出す文字列の開始文字の位置を指定します。

［文字数］

取り出す文字列の文字数を指定します。指定できる文字数は0から2,147,483,647までです。

［開始位置から末尾までを取得］チェックボックス

［開始位置］で指定した開始文字の位置から末尾までの文字列を取り出したい場合にチェックします。

［末尾からの範囲指定］ラジオボタン

取り出す範囲を文字列の末尾から指定する場合に選択します。

［開始位置］

取り出す文字列の開始文字の位置を指定します。

［文字数］

取り出す文字列の文字数を指定します。指定できる文字数は0から2,147,483,647までです。

［開始位置から先頭までを取得］チェックボックス

［開始位置］で指定した開始文字の位置から先頭までの文字列を取り出したい場合にチェックします。

［分割文字列指定］ラジオボタン

文字列を2つに分割して，分割した前の部分かあとの部分かのどちらかを指定する場合に選択します。

分割文字列が複数検索される文字列の場合は，先頭から検索して最初に出現した分割文字列の位置で分割されます。また，分割文字列が検索されない場合は空文字となります。

［分割文字列］

マッピング元の文字列を分割する文字列を指定します。指定できる文字数は，1,024文字までです。

［取得部位］

前または後が表示されます。

前

先頭の文字から［分割文字列］で指定した文字列より前の文字列を取得します。

後

［分割文字列］で指定した文字列以降の文字列を取得します。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［部分文字列取得］ダイアログでは，部分文字列取得ファンクションを設定できます。部分文字列取得ファンクションの設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.21　文字数取得ダイアログ

［文字数取得］ダイアログでは，文字数を取得したい文字列を指定します。

次のどちらかの操作をした場合に表示されます。

文字数取得ファンクションを右クリックし，［設定］を選択する

文字数取得ファンクションをダブルクリックする

［文字数取得］ダイアログを次に示します。

図1‒132　［文字数取得］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクション名を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［入力］

文字数を取得したい文字列の変換元ノードおよびファンクションを指定します。すでに文字数の取得対象と文字数取得ファンクションがマッピングされている場合，その文字数の取得対象が表示されます。

［入力］での表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［入力］に文字数を取得したい文字列の変換元ノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。変換元ノードに条件を設定して，その条件を満たす場合だけマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［ファンクション選択］ボタン

［ファンクション選択］ダイアログが表示されます。［入力］に文字数を取得したい文字列のファンクションを指定する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［文字数取得］ダイアログでは，文字数取得ファンクションを設定できます。文字数取得ファンクションの設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.22　文字列調査ダイアログ

［文字列調査］ダイアログでは，特定の文字列を含むか，特定の文字列で開始するかを調査方法として選択し，その調査対象となる文字列を指定します。

次のどちらかの操作をした場合に表示されます。

文字列調査ファンクションを右クリックし，［設定］を選択する

文字列調査ファンクションをダブルクリックする

［文字列調査］ダイアログを次に示します。

図1‒133　［文字列調査］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクション名を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［入力］

調査対象となる文字列の変換元ノードおよびファンクションを指定します。すでに調査対象と文字列調査ファンクションがマッピングされている場合，その調査対象が表示されます。

［入力］での表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［入力］に調査対象となる文字列の変換元ノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。変換元ノードに条件を設定して，その条件を満たす場合だけマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［ファンクション選択］ボタン

［ファンクション選択］ダイアログが表示されます。［入力］に調査対象となる文字列のファンクションを指定する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［調査種別］

［調査文字列］で指定した文字列に対する調査種別が表示されます。表示される調査種別を次に示します。

指定文字列を含む

指定文字列から開始

［調査文字列］

調査対象となる文字列を指定します。指定できる文字数は，1,024文字までです。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［文字列調査］ダイアログでは，文字列調査ファンクションを設定できます。文字列調査ファンクションの設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.23　空白除去ダイアログ

［空白除去］ダイアログでは，空白の除去対象となる文字列を指定します。

次のどちらかの操作をした場合に表示されます。

空白除去ファンクションを右クリックし，［設定］を選択する

空白除去ファンクションをダブルクリックする

［空白除去］ダイアログを次に示します。

図1‒134　［空白除去］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクション名を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［入力］

空白の除去対象となる文字列の変換元ノードおよびファンクションを指定します。すでに空白の除去対象と空白除去ファンクションがマッピングされている場合，その空白の除去対象が表示されます。

［入力］での表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［入力］に空白の除去対象となる文字列の変換元ノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。変換元ノードに条件を設定して，その条件を満たす場合だけマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［ファンクション選択］ボタン

［ファンクション選択］ダイアログが表示されます。［入力］に空白の除去対象となる文字列のファンクションを指定する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［空白除去］ダイアログでは，空白除去ファンクションを設定できます。空白除去ファンクションの設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.24　数値フォーマット変換ダイアログ

［数値フォーマット変換］ダイアログでは，変換後のjava.text.DecimalFormatクラスの形式のパターン文字列を指定します。

次のどちらかの操作をした場合に表示されます。

数値フォーマット変換ファンクションを右クリックし，［設定］を選択する

数値フォーマット変換ファンクションをダブルクリックする

［数値フォーマット変換］ダイアログを次に示します。

図1‒135　［数値フォーマット変換］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクション名を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［入力］

変換対象となる数値の変換元ノードおよびファンクションを指定します。すでに変換対象と数値フォーマット変換ファンクションがマッピングされている場合，その変換対象が表示されます。

［入力］での表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［入力］に変換対象となる数値の変換元ノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。変換元ノードに条件を設定して，その条件を満たす場合だけマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［ファンクション選択］ボタン

［ファンクション選択］ダイアログが表示されます。［入力］に変換対象となる数値のファンクションを指定する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［パターン］

変換後のjava.text.DecimalFormatクラスの形式のパターン文字列を指定します。指定できる文字数は，1,024文字までです。

［記号の変更］を指定した場合は，変更後の記号を使用してパターンを記述してください。

［記号の変更］

［記号を変更する］チェックボックス

小数点文字または桁区切り文字をデフォルトから変更する場合にチェックします。

［小数点文字］

小数点文字を変更する場合，変更後の小数点文字の記号を指定します。

［桁区切り文字］

桁区切り文字を変更する場合，変更後の桁区切り文字の記号を指定します。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［数値フォーマット変換］ダイアログでは，数値フォーマット変換ファンクションを設定できます。数値フォーマット変換ファンクションの設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.25　数値演算ダイアログ

［数値演算］ダイアログでは，演算対象となる2つの数値と演算の種類を指定します。

次のどちらかの操作をした場合に表示されます。

数値演算ファンクションを右クリックし，［設定］を選択する

数値演算ファンクションをダブルクリックする

［数値演算］ダイアログを次に示します。

図1‒136　［数値演算］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクション名を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［入力1］

演算対象となる1つ目の数値の変換元ノードおよびファンクションを指定します。すでに演算対象と数値演算ファンクションがマッピングされている場合，その演算対象が表示されます。

［入力1］での表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［入力1］に演算対象となる数値の変換元ノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。変換元ノードに条件を設定して，その条件を満たす場合だけマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［ファンクション選択］ボタン

［ファンクション選択］ダイアログが表示されます。［入力1］に演算対象となる数値のファンクションを指定する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［演算］ドロップダウンリスト

実行できる演算が表示されます。表示される演算を次に示します。

+（加算）

-（減算）

*（乗算）

/（除算）

%（剰余）

［入力2］

演算対象となる2つ目の数値の変換元ノードおよびファンクションを指定します。表示形式は［入力1］と同じです。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［入力2］に演算対象となる数値の変換元ノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。変換元ノードに条件を設定して，その条件を満たす場合だけマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［ファンクション選択］ボタン

［ファンクション選択］ダイアログが表示されます。［入力2］に演算対象となる数値のファンクションを指定する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［数値演算］ダイアログでは，数値演算ファンクションを設定できます。数値演算ファンクションの設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.26　端数処理ダイアログ

［端数処理］ダイアログでは，端数処理の対象となる数値を指定します。

次のどちらかの操作をした場合に表示されます。

端数処理ファンクションを右クリックし，［設定］を選択する

端数処理ファンクションをダブルクリックする

［端数処理］ダイアログを次に示します。

図1‒137　［端数処理］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクション名を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［入力］

端数処理の対象となる数値の変換元ノードおよびファンクションを指定します。すでに端数処理の対象と端数処理ファンクションがマッピングされている場合，その端数処理の対象が表示されます。

［入力］での表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［入力］に端数処理の対象となる数値の変換元ノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。変換元ノードに条件を設定して，その条件を満たす場合だけマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［ファンクション選択］ボタン

［ファンクション選択］ダイアログが表示されます。［入力］に端数処理の対象となる数値のファンクションを指定する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［種別］

実行できる端数処理が表示されます。表示される端数処理を次に示します。

四捨五入

切り捨て

切り上げ

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［端数処理］ダイアログでは，端数処理ファンクションを設定できます。端数処理ファンクションの設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.27　総和ダイアログ

［総和］ダイアログでは，合計したいノードが含まれているノードセットを指定します。

次のどちらかの操作をした場合に表示されます。

総和ファンクションを右クリックし，［設定］を選択する

総和ファンクションをダブルクリックする

［総和］ダイアログを次に示します。

図1‒138　［総和］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクション名を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［入力］

合計したいノードが含まれているノードセットを指定します。すでにノードセットと総和ファンクションがマッピングされている場合，そのノードセットが表示されます。

［入力］での表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード追加］ボタン

［ノード選択］ダイアログが表示されます。［入力］に合計したいノードが含まれているノードセットを追加する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。ノードセットに条件を設定して，その条件を満たすノードセットだけをマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［除去］ボタン

［入力］で選択したノードセットが［入力］から削除されます。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［総和］ダイアログでは，総和ファンクションを設定できます。総和ファンクションの設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.28　否定演算ダイアログ

［否定演算］ダイアログでは，否定演算の対象としたいノードを指定します。

次のどちらかの操作をした場合に表示されます。

否定演算ファンクションを右クリックし，［設定］を選択する

否定演算ファンクションをダブルクリックする

［否定演算］ダイアログを次に示します。

図1‒139　［否定演算］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクション名を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［入力］

否定演算の対象としたいノードを指定します。すでにノードと否定演算ファンクションがマッピングされている場合，そのノードが表示されます。

［入力］での表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［入力］に否定演算の対象としたいノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。ノードに条件を設定して，その条件を満たすノードだけマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［ファンクション選択］ボタン

［ファンクション選択］ダイアログが表示されます。［入力］に否定演算の対象としたいファンクションを指定する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［否定演算］ダイアログでは，否定演算ファンクションを設定できます。否定演算ファンクションの設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.29　論理演算ダイアログ

［論理演算］ダイアログでは，論理演算の対象となる変換元ノードまたはファンクションを指定します。

次のどちらかの操作をした場合に表示されます。

論理演算ファンクションを右クリックし，［設定］を選択する

論理演算ファンクションをダブルクリックする

［論理演算］ダイアログを次に示します。

図1‒140　［論理演算］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクション名を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［入力1］

論理演算の対象としたいノードが含まれているノードを指定します。すでにノードと論理演算ファンクションがマッピングされている場合，そのノードが表示されます。

［入力1］での表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［入力1］に論理演算の対象としたいノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。ノードに条件を設定して，その条件を満たすノードだけマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［ファンクション選択］ボタン

［ファンクション選択］ダイアログが表示されます。［入力1］に論理演算の対象としたいファンクションを指定する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［演算］ドロップダウンリスト

条件式に設定する演算子が表示されます。表示される演算子を次に示します。

AND（論理積）

OR（論理和）

XOR（排他的論理和）

［入力2］

論理演算の対象としたいノードが含まれているノードを指定します。すでにノードと論理演算ファンクションがマッピングされている場合，そのノードが表示されます。

［入力2］での表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［入力2］に合計したいノードが含まれているノードセットを追加する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。ノードに条件を設定して，その条件を満たすノードだけマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［ファンクション選択］ボタン

［ファンクション選択］ダイアログが表示されます。［入力2］に論理演算の対象としたいファンクションを指定する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［論理演算］ダイアログでは，論理演算ファンクションを設定できます。論理演算ファンクションの設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.30　シフト演算ダイアログ

［シフト演算］ダイアログでは，シフト演算の対象となる変換元ノードまたはファンクションを指定します。

次のどちらかの操作をした場合に表示されます。

シフト演算ファンクションを右クリックし，［設定］を選択する

シフト演算ファンクションをダブルクリックする

［シフト演算］ダイアログを次に示します。

図1‒141　［シフト演算］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクション名を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［入力］

シフト演算の対象としたいノードが含まれているノードを指定します。すでにノードとシフト演算ファンクションがマッピングされている場合，そのノードが表示されます。

［入力］での表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［入力］にシフト演算の対象としたいノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。ノードに条件を設定して，その条件を満たすノードだけマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［ファンクション選択］ボタン

［ファンクション選択］ダイアログが表示されます。［入力］に論理演算の対象としたいファンクションを指定する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［詳細］

シフト演算ファンクションの詳細項目を設定します。

［シフト量］

シフトするビット数を指定します。指定できるビット数は0から64までです。

［出力サイズ］

出力する範囲を指定します。指定したサイズ分，下位ビットから取得します。指定できるビット数は1から64までです。

［シフト方向］

シフト方向として［左］ラジオボタンまたは［右］ラジオボタンを指定します。

［シフト種別］

シフト方向が［右］の場合にシフト方法を次のどちらかで指定します。

［算術シフト］ラジオボタン

最上位のビット（符号ビット）はシフト対象にならないで保持されます。

［論理シフト］ラジオボタン

最上位のビット（符号ビット）はシフト対象になります。また，シフトによって空いたビットには「0」が補完されます。

左シフトの場合は，算術シフトと論理シフトの結果が同じ値になるため，シフト種別の設定は不要です。

シフトごとの仕様を次に示します。

ビットの種類

左シフト

右シフト

算術シフト

論理シフト

符号ビットのシフト

シフトする

シフトしない

シフトする

出力サイズ未満の空きビット

"0"で埋める

符号ビットで埋める

"0"で埋める

シフト時の空きビット

"0"で埋める

符号ビットで埋める

"0"で埋める

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［シフト演算］ダイアログでは，シフト演算ファンクションを設定できます。シフト演算ファンクションの設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.31　ノード名取得ダイアログ

［ノード名取得］ダイアログでは，ノード名を取得したい変換元ノードを指定します。

次のどちらかの操作をした場合に表示されます。

ノード名取得ファンクションを右クリックし，［設定］を選択する

ノード名取得ファンクションをダブルクリックする

［ノード名取得］ダイアログを次に示します。

図1‒142　［ノード名取得］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクション名を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［入力］

ノード名を取得したい変換元ノードを指定します。すでにノード名を取得したい変換元ノードとノード名取得ファンクションがマッピングされている場合，その変換元ノードが表示されます。

［入力］での表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［入力］にノード名を取得したい変換元ノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。変換元ノードに条件を設定して，その条件を満たす場合だけマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［ノード名取得］ダイアログでは，ノード名取得ファンクションを設定できます。ノード名取得ファンクションの設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.32　ノード数取得ダイアログ

［ノード数取得］ダイアログでは，ノード数を取得したいノードセットを指定します。

次のどちらかの操作をした場合に表示されます。

ノード数取得ファンクションを右クリックし，［設定］を選択する

ノード数取得ファンクションをダブルクリックする

［ノード数取得］ダイアログを次に示します。

図1‒143　［ノード数取得］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクション名を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［入力］

ノード数を取得したいノードセットを指定します。すでにノードセットとノード数取得ファンクションがマッピングされている場合，そのノードセットが表示されます。

［入力］での表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［入力］にノード数を取得したいノードセットを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。ノードセットに条件を設定して，その条件を満たすノードセットだけをマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［ノード数取得］ダイアログでは，ノード数取得ファンクションを設定できます。ノード数取得ファンクションの設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.33　ノード調査ダイアログ

［ノード調査］ダイアログでは，ノードが存在するか調査したいマッピング元の変換元ノードを指定します。

次のどちらかの操作をした場合に表示されます。

ノード調査ファンクションを右クリックし，［設定］を選択する

ノード調査ファンクションをダブルクリックする

［ノード調査］ダイアログを次に示します。

図1‒144　［ノード調査］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクション名を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［入力］

ノードが存在するか調査したい変換元ノードを指定します。すでにノードが存在するか調査したい変換元ノードとノード調査ファンクションがマッピングされている場合，その変換元ノードが表示されます。

［入力］での表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［入力］にノードが存在するか調査したい変換元ノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。変換元ノードに条件を設定して，その条件を満たす場合だけマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［ノード調査］ダイアログでは，ノード調査ファンクションを設定できます。ノード調査ファンクションの設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.34　くり返しダイアログ

［くり返し］ダイアログでは，変換先ノードにくり返しを対応づけたい変換元ノードを指定します。また，複数回出現する変換元ノードのインスタンスのソート条件を設定します。

次のどちらかの操作をした場合に表示されます。

くり返しファンクションを右クリックし，［設定］を選択する

くり返しファンクションをダブルクリックする

［くり返し］ダイアログを次に示します。

図1‒145　［くり返し］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクション名を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［基準パス］

変換先ノードにくり返しを対応づけたい変換元ノードを指定します。すでにくり返しを対応づけたい変換元ノードとくり返しファンクションがマッピングされている場合，その変換元ノードが表示されます。

［基準パス］での表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［基準パス］にくり返しを対応づけたい変換元ノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。変換元ノードに条件を設定して，その条件を満たす場合だけマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［連携パス］

設定されているすべての連携パスが表示されます。条件設定または除去をしたい場合に連携パスを選択します。

［ノード追加］ボタン

［ノード選択］ダイアログが表示されます。連携パスを選択して［OK］ボタンをクリックすると，指定された連携パスが［連携パス］の一番下に追加されます。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。連携パスに条件を設定して，その条件を満たす場合だけマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，連携パスに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［除去］ボタン

［連携パス］で選択したパスが［連携パス］から削除されます。

［ソート条件］

［ソート条件追加/編集］ダイアログで設定した内容が表示されます。［ソート条件］に設定できるキーは8つまでです。

［ソート条件追加/編集］ダイアログについては，「1.6.35　ソート条件追加/編集ダイアログ」を参照してください。

［追加］ボタン

［ソート条件追加/編集］ダイアログが表示されます。［ソート条件］にキーを追加して，ソートする条件を設定する場合にクリックします。

［ソート条件追加/編集］ダイアログについては，「1.6.35　ソート条件追加/編集ダイアログ」を参照してください。

［編集］ボタン

［ソート条件追加/編集］ダイアログが表示されます。［ソート条件］に設定されたキーのソート条件を編集する場合にクリックします。

［ソート条件追加/編集］ダイアログについては，「1.6.35　ソート条件追加/編集ダイアログ」を参照してください。

［上へ］ボタン

［ソート条件］で選択したキーの位置が1つ上に移動します。

［下へ］ボタン

［ソート条件］で選択したキーの位置が1つ下に移動します。

［除去］ボタン

［ソート条件］で選択したキーが［ソート条件］から削除されます。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［くり返し］ダイアログでは，くり返しファンクションを設定できます。くり返しファンクションの設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.35　ソート条件追加/編集ダイアログ

［ソート条件追加/編集］ダイアログでは，［くり返し］ダイアログの［ソート条件］にキーを追加して，ソート条件を設定します。また，キーに設定されたソート条件を編集します。

［ソート条件追加/編集］ダイアログは，［くり返し］ダイアログの［追加］ボタンまたは［編集］ボタンをクリックした場合に表示されます。

［ソート条件追加/編集］ダイアログを次に示します。

図1‒146　［ソート条件追加/編集］ダイアログ

(1)　表示項目

［ソートキー］

ソートさせたいインスタンスの元となる変換元ノードを指定します。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［ソートキー］にソートさせたいインスタンスの元となる変換元ノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［順序］

インスタンスをソートする順序が表示されます。表示される順序を次に示します。

昇順

降順

［言語］

インスタンスをソートする言語が表示されます。表示される言語を次に示します。

日本語

英語

自動

なお，「自動」を選択した場合，デフォルトに設定されているシステムのロケールに対応した言語コードが指定されます。

［データタイプ］

インスタンスをソートするデータタイプが表示されます。表示されるデータタイプを次に示します。

テキスト

数値

［優先順位］

インスタンスをソートする優先順位が表示されます。［データタイプ］が「テキスト」の場合に選択します。表示される優先順位を次に示します。

大文字

小文字

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［ソート条件追加/編集］ダイアログでは，くり返しファンクションのソート条件を設定できます。くり返しファンクションのソート条件の設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.36　選択ダイアログ

［選択］ダイアログでは，条件を設定して，それに合致したものから出力する変換元ノードまたはファンクションを指定します。

次のどちらかの操作をした場合に表示されます。

選択ファンクションを右クリックし，［設定］を選択する

選択ファンクションをダブルクリックする

［選択］ダイアログを次に示します。

図1‒147　［選択］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクション名を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［条件と出力値］

［条件］

［条件追加/編集］ダイアログで設定した条件が表示されます。［条件追加/編集］ダイアログでの設定方法については，「1.6.37　条件追加/編集ダイアログ」を参照してください。設定した条件は，上から順番に評価されます。

［出力値］

条件に合致する場合に出力する出力値の変換元ノードまたはファンクションを指定します。すでに出力値の変換元ノードまたはファンクションと選択ファンクションがマッピングされている場合，その変換元ノードまたはファンクションが表示されます。

［出力値］に表示される変換元ノードまたはファンクションについては，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。なお，このダイアログの［空ノード］ラジオボタンを選択した指定した場合は「空ノード」が，［ノードを出力しない］ラジオボタンを選択した指定した場合は「出力なし」が表示されます。

［追加］ボタン

［条件追加/編集］ダイアログが表示されます。［条件と出力値］に条件および出力値を追加する場合にクリックします。

［編集］ボタン

［条件追加/編集］ダイアログが表示されます。［条件と出力値］の条件または出力値を編集する場合にクリックします。

［上へ］ボタン

［条件と出力値］で選択した条件および出力値の位置が1つ上に移動します。

［下へ］ボタン

［条件と出力値］で選択した条件および出力値の位置が1つ下に移動します。

［除去］ボタン

［条件と出力値］で選択した条件および出力値が［条件と出力値］から削除されます。

［どの条件にも合致しない場合］

［条件と出力値］で指定したすべての条件に合致しない場合の出力を設定します。

［ノードを出力する］ラジオボタン

変換先ノードを出力させるときに選択します。

［ノードを出力しない］ラジオボタン

変換先ノードを出力させないときに選択します。

［出力値］

［どの条件にも合致しない場合］の［ノードを出力する］ラジオボタンを選択した場合に設定します。

［値を出力する］ラジオボタン

変換元ノードまたはファンクションの値を出力させるときに選択します。

［値］

出力値の変換元ノードおよびファンクションを指定します。

出力値の表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［値］に出力値の変換元ノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。変換元ノードに条件を設定して，その条件を満たす場合だけマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［ファンクション選択］ボタン

［ファンクション選択］ダイアログが表示されます。［値］に出力値のファンクションを指定する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［空ノード］ラジオボタン

変換先ノードに値を出力させない（空ノードを出力）ときに選択します。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［選択］ダイアログでは，選択ファンクションを設定できます。選択ファンクションの設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.37　条件追加/編集ダイアログ

［条件追加/編集］ダイアログでは，［選択］ダイアログの［条件と出力値］に条件を追加します。また，条件と出力値の条件または出力値を編集します。

［条件追加/編集］ダイアログは，［選択］ダイアログの［追加］ボタンまたは［編集］ボタンをクリックした場合に表示されます。

［条件追加/編集］ダイアログを次に示します。

図1‒148　［条件追加/編集］ダイアログ

(1)　表示項目

［条件］

［条件設定］ダイアログで設定した条件が表示されます。［条件設定］ダイアログでの設定方法については，「1.6.12　条件設定ダイアログ（ノード条件の設定）」を参照してください。

［条件がtrueの場合］

［条件］で指定した条件に合致する場合の出力を設定します。

［ノードを出力する］ラジオボタン

変換先ノードを出力させるときに選択します。

［ノードを出力しない］ラジオボタン

変換先ノードを出力させないときに選択します。

［出力値］

［条件がtrueの場合］の［ノードを出力する］ラジオボタンを選択した場合に設定します。

［値を出力する］ラジオボタン

変換元ノードまたはファンクションの値を出力させるときに選択します。

［値］

出力値の変換元ノードおよびファンクションを指定します。

出力値の表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［値］に出力値の変換元ノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。変換元ノードに条件を設定して，その条件を満たす場合だけマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［ファンクション選択］ボタン

［ファンクション選択］ダイアログが表示されます。［値］に出力値のファンクションを指定する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［空ノード］ラジオボタン

変換先ノードに値を出力させない（空ノードを出力）ときに選択します。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［条件追加/編集］ダイアログでは，選択ファンクションの条件の追加・編集を設定できます。選択ファンクションの条件の追加・編集の設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.38　値置換えダイアログ

［値置換え］ダイアログでは，マッピング元からの入力値を置き換えてマッピング先に代入するための変換テーブルを指定します。また，置き換え元の文字列を検索する列と，置き換え元の文字列が変換テーブルに存在しなかった場合の対処を指定します。

次のどちらかの操作をした場合に表示されます。

値置換えファンクションを右クリックし，［設定］を選択する

値置換えファンクションをダブルクリックする

［値置換え］ダイアログを次に示します。

図1‒149　［値置換え］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクション名を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［入力］

置き換えの対象となる文字列の変換元ノードおよびファンクションを指定します。すでに置き換えの対象と値置換えファンクションがマッピングされている場合，その置き換えの対象が表示されます。

［入力］での表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［入力］に置き換えの対象となる文字列の変換元ノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。変換元ノードに条件を設定して，その条件を満たす場合だけマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，ノード条件の設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［ファンクション選択］ボタン

［ファンクション選択］ダイアログが表示されます。［入力］に置き換えの対象となる文字列のファンクションを指定する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［値置換え］

［変換テーブルID］

値の置き換えに使用する変換テーブルの変換テーブルIDを指定します。変換テーブルIDは，変換テーブルの作成後にJ2EEサーバ用ユーザプロパティファイル（usrconf.properties）に記述した変換テーブルの名称です。

［パスプロパティ］

［変換テーブルID］に指定した変換テーブルの格納先が設定されているプロパティ（usrconf.propertiesのキー）が表示されます。次の形式で表示されます。

csc.dt.valueTable.<変換テーブルID>

［コードプロパティ］

［変換テーブルID］に指定した変換テーブルで使用している文字コードが設定されているプロパティ（usrconf.propertiesのキー）が表示されます。次の形式で表示されます。

csc.dt.encodeType.<変換テーブルID>

［検索キー列指定］

［左列］ラジオボタン

置き換え元の文字列を変換テーブルの左列から検索して，右列の文字列に置き換える場合に選択します。

［右列］ラジオボタン

置き換え元の文字列を変換テーブルの右列から検索して，左列の文字列に置き換える場合に選択します。

［検索失敗時の動作］

［デフォルト値を代入］ラジオボタン

置き換え元の文字列の検索失敗時に，あらかじめ指定した値をマッピング先に代入する場合に選択します。

［値］

置き換え元の文字列の検索失敗時に，マッピング先に代入するデフォルト値を指定します。［デフォルト値を代入］を選択した場合に指定します。

［変換エラー］ラジオボタン

置き換え元の文字列の検索失敗時に，変換エラーを発生させる場合に選択します。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［値置換え］ダイアログでは，値置換えファンクションを設定できます。値置換えファンクションの設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.39　基数変換ダイアログ

［基数変換］ダイアログでは，基数変換の対象となる変換元ノードまたはファンクションを指定します。

次のどちらかの操作をした場合に表示されます。

基数変換ファンクションを右クリックし，［設定］を選択する

基数変換ファンクションをダブルクリックする

［基数変換］ダイアログを次に示します。

図1‒150　［基数変換］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクション名を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［入力］

基数変換の対象としたいノードを指定します。すでにノードと基数演算ファンクションがマッピングされている場合，そのノードが表示されます。

［入力］での表示形式については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.4.6　マッピング元の表示形式」を参照してください。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［入力］に基数演算の対象としたいノードを指定する場合にクリックします。

［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。ノードに条件を設定して，その条件を満たすノードだけマッピングさせる場合にクリックします。

［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。また，変換元ノードに条件を設定する方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.7　ノード条件を設定する」を参照してください。

［ファンクション選択］ボタン

［ファンクション選択］ダイアログが表示されます。［入力］に基数演算の対象としたいファンクションを指定する場合にクリックします。

［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［入力基数］ドロップダウンリスト

入力値の基数を指定します。指定できる値を次に示します。入力基数と出力基数に同じ値を指定できません。

16（進数）

10（進数）

2（進数）

［出力基数］ドロップダウンリスト

入力値を変換する基数を指定します。指定できる値を次に示します。入力基数と出力基数に同じ値を指定できません。

16（進数）

10（進数）

2（進数）

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［基数変換］ダイアログでは，基数変換ファンクションを設定できます。基数変換の設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.40　カスタムダイアログ

［カスタム］ダイアログでは，カスタムファンクションから呼び出すJavaプログラム（変換ファンクション）を設定します。

次のどちらかの操作をした場合に表示されます。

カスタムファンクションを右クリックし，［設定］を選択する

カスタムファンクションをダブルクリックする

［カスタム］ダイアログを次に示します。

図1‒151　［カスタム］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクション名を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［jarファイル］

［変換ファンクション選択］ダイアログで選択したメソッドが存在するjarファイルが表示されます。

［変換ファンクション選択］ボタン

［変換ファンクション選択］ダイアログが表示されます。［変換ファンクション選択］ダイアログについては，「1.6.43　変換ファンクション選択ダイアログ」を参照してください。

［クラス］

［変換ファンクション選択］ダイアログで選択したメソッドが存在するクラスが表示されます。

［メソッド］

［変換ファンクション選択］ダイアログで選択したメソッドが表示されます。「メソッド名（引数1，引数2，…）」の形式で表示されます。

［戻り値の型］

［変換ファンクション選択］ダイアログで選択した変換ファンクションのメソッドの戻り値の型が表示されます。

［引数の型］

［変換ファンクション選択］ダイアログで選択した変換ファンクションのメソッドの引数の型が表示されます。引数がない場合は表示されません。

［メソッドの説明］

［変換ファンクション選択］ダイアログで選択したメソッドのコメントが表示されます。

［引数］

［引数名］

［変換ファンクション選択］ダイアログで選択したメソッドの引数名が表示されます。

［入力値］

メソッドの引数に入力する値を選択します。

［ノード選択］ボタン

［ノード選択］ダイアログが表示されます。［ノード選択］ダイアログについては，「1.6.8　ノード選択ダイアログ（データ変換）」を参照してください。

［ノード条件設定］ボタン

［ノード条件設定］ダイアログが表示されます。［ノード条件設定］ダイアログについては，「1.6.11　ノード条件設定ダイアログ」を参照してください。

［ファンクション選択］ボタン

［ファンクション選択］ダイアログが表示されます。［ファンクション選択］ダイアログについては，「1.6.9　ファンクション選択ダイアログ」を参照してください。

［入力値を上へ］ボタン

［入力値］で選択した値の位置が1つ上に移動します。

［入力値を下へ］ボタン

［入力値］で選択した値の位置が1つ下に移動します。

［入力値を除去］ボタン

［入力値を除去］ダイアログが表示されます。［入力値を除去］ダイアログについては，「1.6.44　入力値を除去ダイアログ」を参照してください。

［引数の説明］

［変換ファンクション選択］ダイアログで選択したメソッドの引数のコメントが表示されます。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［カスタム］ダイアログでは，次のことができます。

カスタムファンクションから呼び出す変換ファンクションのメソッドの選択

カスタムファンクションから呼び出す変換ファンクションのメソッドの引数に入力する値の選択

カスタムファンクションの定義方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.41　定数ダイアログ

［定数］ダイアログでは，マッピング先に代入する値を指定します。

次のどちらかの操作をした場合に表示されます。

定数ファンクションを右クリックし，［設定］を選択する

定数ファンクションをダブルクリックする

［定数］ダイアログを次に示します。

図1‒152　［定数］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクション名を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［文字列］ラジオボタン

マッピング先に代入する値が文字列の場合に選択します。

［数値］ラジオボタン

マッピング先に代入する値が数値の場合に選択します。

［値］

マッピング先に代入する文字列または数値を指定します。指定できる文字数は，1,024文字までです。［文字列］ラジオボタンを選択している場合は，空欄にすることで空文字列を設定できます。

［論理値］ラジオボタン

マッピング先に代入する値が論理値の場合に選択します。

［論理値］

［真］ラジオボタン

マッピング先に代入する論理値が真の場合に選択します。

［偽］ラジオボタン

マッピング先に代入する論理値が偽の場合に選択します。

［特殊ノード］ラジオボタン

マッピング先に代入する値が特殊ノードの場合に選択します。

［値］

［ノード出力なし］ラジオボタン

マッピング先にノードを出力させない場合に選択します。

［空ノード］ラジオボタン

マッピング先のノードに値を代入しない（空ノード）場合に選択します。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

［定数］ダイアログでは，定数ファンクションを設定できます。定数ファンクションの設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.42　XPathダイアログ

［XPath］ダイアログでは，変換先ノードやファンクションへの入力値をXPath式で指定します（XPathファンクション）。

次のどちらかの操作をした場合に表示されます。

XPathファンクションを右クリックし，［設定］を選択する

XPathファンクションをダブルクリックする

［XPath］ダイアログを次に示します。

図1‒153　［XPath］ダイアログ

(1)　表示項目

［ファンクション名］

ファンクションの名称を表示します。任意の名称に変更する場合は，64文字以内で指定してください。使用できる文字は，XMLSchemaのNCName定義文字です。

［式］

XPath式を指定します。入力できる文字数に制限はありません。

(2)　このダイアログでできる内容

［XPath］ダイアログでは，XPathファンクションを設定できます。XPathファンクションの設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.43　変換ファンクション選択ダイアログ

［変換ファンクション選択］ダイアログでは，カスタムファンクションから呼び出すJavaプログラム（変換ファンクション）のメソッドを選択します。

［変換ファンクション選択］ダイアログは，［カスタム］ダイアログで［変換ファンクションの選択］ボタンをクリックした場合に表示されます。

［変換ファンクション選択］ダイアログを次に示します。

図1‒154　［変換ファンクション選択］ダイアログ

(1)　表示項目

［変換ファンクション］

変換ファンクション定義ファイルに指定されたjarファイルのメソッドが表示されます。ここで，カスタムファンクションから呼び出す変換ファンクションのメソッドを選択します。

［メソッドの説明］

［変換ファンクション］で選択したメソッドの説明が表示されます。

［OK］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

カスタムファンクションから呼び出す変換ファンクションのメソッドを設定できます。カスタムファンクションの定義方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.44　入力値を除去ダイアログ

［入力値を除去］ダイアログでは，カスタムファンクションに入力された値を除去します。

［入力値を除去］ダイアログは，［カスタム］ダイアログで［入力値を除去］ボタンをクリックした場合に表示されます。

［入力値を除去］ダイアログを次に示します。

図1‒155　［入力値を除去］ダイアログ

(1)　表示項目

［入力値］

接続された順に，カスタムファンクションに接続されたノードおよびファンクションを表示します。除去したい入力値のチェックボックスにチェックします。

［引数名］

［入力値］の値が入力される引数がある場合は，引数名が表示されます。

［OK］ボタン

［入力値］のチェックボックスにチェックした入力値を削除して，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

カスタムファンクションに入力された値を除去できます。カスタムファンクションの定義方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7.5　ファンクションを使用した値またはノードの加工」を参照してください。

1.6.45　DBアダプタマッピング設定ダイアログ

［DBアダプタマッピング設定］ダイアログでは，マッピング内容を定義したカラム定義ファイルを指定することで，DBアダプタで取得したデータを列名が要素名となるフォーマットへ自動でマッピングできます。

［DBアダプタマッピング設定］ダイアログは，DBアダプタの検索結果で変換先のマッピング対象とする要素の親要素（複合内容要素）を右クリックし，［特殊マッピング］−［DBアダプタ］を選択すると表示されます。

［DBアダプタマッピング設定］ダイアログを次に示します。

図1‒156　［DBアダプタマッピング設定］ダイアログ

(1)　表示項目

［マッピング元］

変換元スキーマのノードが，変換元スキーマのルートからのフルパスで一覧表示されます。この中からマッピング対象とするノードを選択します。

［カラム定義ファイル］

マッピング対象となる変換元列番号と変換先要素名が定義されているカラム定義ファイルを指定します。［参照］ボタンをクリックすると，カラム定義ファイルを設定するダイアログが表示されます。

［終了］ボタン

マッピングを完了してダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

(2)　このダイアログでできる内容

マッピング内容を定義したカラム定義ファイルを指定することで，DBアダプタで取得したデータを列名が要素名となるフォーマットへ自動でマッピングできます。カラム定義ファイルの作成方法およびDBアダプタのマッピング方法については，マニュアル「サービスプラットフォーム開発ガイド 基本開発編」の「付録J　DBアダプタで取得したデータの自動マッピング」を参照してください。

1.7　ユーザ定義受付に関連するダイアログ

ユーザ定義受付に関連するダイアログについて説明します。

1.7.1　ユーザ定義受付削除ダイアログ

ユーザ定義受付を削除するためのダイアログです。

ユーザ定義受付の削除方法の詳細については，マニュアル「サービスプラットフォーム 開発ガイド 受付・アダプタ定義編」の「2.16　ユーザ定義受付の削除」を参照してください。

図1‒157　［ユーザ定義受付削除］ダイアログ

［削除するユーザ定義受付を選択してください］

定義されているユーザ定義受付の一覧が表示されます。削除するユーザ定義受付をチェックボックスで選択します。

［すべて選択］ボタン

ユーザ定義受付の一覧のすべてのチェックボックスがチェックされます。

［選択をすべて解除］ボタン

ユーザ定義受付の一覧のすべてのチェックボックスのチェックが解除されます。

［OK］ボタン

指定したユーザ定義受付を削除して，ダイアログを閉じます。

［キャンセル］ボタン

ユーザ定義受付を削除しないでダイアログを閉じます。

1.8　サービスの操作に関連するダイアログ

複数のサービスを操作するダイアログについて説明します。

1.8.1　複数パッケージングダイアログ

複数のサービスをパッケージングする場合，該当するサービスを選択するためのダイアログです。

複数パッケージングの詳細については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「8.2　パッケージング」を参照してください。

図1‒158　［複数パッケージング］ダイアログ

［フィルター／ソート実行時に、選択済みのサービスを優先してソートする］チェックボックス

チェックされているサービスをサービス一覧の先頭へソートしたい場合，このチェックボックスをチェックし，列のヘッダ部分をクリックします。［名称］列でソートした例を次に示します。

フィルタ文字列

サービス一覧を特定のキーワードでフィルタリングしたい場合に入力します。これによって，該当する情報を含むサービスだけを表示できます。

サービス一覧

サービス名およびその情報が一覧表示されます。ユーザ定義受付（呼出先選択）は，ビジネスプロセスやサービスアダプタと同じ階層に表示されます。また，列のヘッダ部分をクリックすると，列の情報で行をソートできます。

サービス一覧の中から，パッケージングしたいサービスの［名称］列をチェックします。［メッセージ］列にエラーが表示されているサービスはチェックできません。

チェック状態は次の規則に従って切り替えられます。

ユーザ定義受付を持つビジネスプロセスのチェック状態を切り替える場合

チェック状態を切り替えるビジネスプロセスに属するすべてのユーザ定義受付も同じチェック状態に切り替えます。

ユーザ定義受付のチェック状態を切り替える場合

チェック状態を切り替えるユーザ定義受付の呼出元ビジネスプロセスと，呼出元ビジネスプロセスに属するすべてのユーザ定義受付も同じチェック状態に切り替えます。

複数サービスが選択されている状態で選択中のサービスのチェック状態を切り替える場合

チェックボックスをクリックしたサービス以外の選択サービスも同じチェック状態に切り替えます。

選択中のサービスの中に1.または2.が含まれる場合は，1.または2.の動作に従います。

チェック状態は次のボタンで一括で切り替えることもできます。

［表示中をすべて選択］ボタン

フィルタリング結果のサービスをすべてチェックします。

［表示中をすべて解除］ボタン

フィルタリング結果のサービスの選択状態を解除します。

［OK］ボタン

選択したサービスをパッケージングしてダイアログを閉じます。

［キャンセル］ボタン

パッケージングしないでダイアログを閉じます。

1.8.2　複数サービス追加ダイアログ

複数のサービスを追加する場合，該当するサービスを選択するためのダイアログです。

複数サービス追加については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「8.3.2　クラスタにHCSCコンポーネントを追加する」を参照してください。

図1‒159　［複数サービス追加］ダイアログ

［フィルター／ソート実行時に、選択済みのサービスを優先してソートする］チェックボックス

チェックされているサービスをサービス一覧の先頭へソートしたい場合，このチェックボックスをチェックし，列のヘッダ部分をクリックします。［名称］列でソートした例を次に示します。

フィルタ文字列

サービス一覧を特定のキーワードでフィルタリングしたい場合に入力します。これによって，該当する情報を含むサービスだけを表示できます。

サービス一覧

サービス名およびその情報が一覧表示されます。ユーザ定義受付（呼出先選択）は，ビジネスプロセスやサービスアダプタと同じ階層に表示されます。また，列のヘッダ部分をクリックすると，列の情報で行をソートできます。

サービス一覧の中から，追加したいサービスの［名称］列のチェックボックスをチェックします。［メッセージ］列にエラーが表示されているサービスはチェックできません。

チェック状態は次の規則に従って切り替えられます。

ユーザ定義受付を持つビジネスプロセスのチェック状態を切り替える場合

チェック状態を切り替えるビジネスプロセスに属するすべてのユーザ定義受付も同じチェック状態に切り替えます。

ユーザ定義受付のチェック状態を切り替える場合

チェック状態を切り替えるユーザ定義受付の呼出元ビジネスプロセスと，呼出元ビジネスプロセスに属するすべてのユーザ定義受付も同じチェック状態に切り替えます。

複数サービスが選択されている状態で選択中のサービスのチェック状態を切り替える場合

チェックボックスをクリックしたサービス以外の選択サービスも同じチェック状態に切り替えます。

選択中のサービスの中に1.または2.が含まれる場合は，1.または2.の動作に従います。

チェック状態は次のボタンで一括で切り替えることもできます。

［表示中をすべて選択］ボタン

フィルタリング結果のサービスをすべてチェックします。

［表示中をすべて解除］ボタン

フィルタリング結果のサービスの選択状態を解除します。

［OK］ボタン

サービスを追加してダイアログを閉じます。

［キャンセル］ボタン

サービスを追加しないでダイアログを閉じます。

1.8.3　複数サービス削除ダイアログ

複数のサービスを削除する場合，該当するサービスを選択するためのダイアログです。

複数サービス削除については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「8.3.3　クラスタからHCSCコンポーネントを削除する」を参照してください。

図1‒160　［複数サービス削除］ダイアログ

［フィルター／ソート実行時に、選択済みのサービスを優先してソートする］チェックボックス

チェックされているサービスをサービス一覧の先頭へソートしたい場合，このチェックボックスをチェックし，列のヘッダ部分をクリックします。［名称］列でソートした例を次に示します。

フィルタ文字列

サービス一覧を特定のキーワードでフィルタリングしたい場合に入力します。これによって，該当する情報を含むサービスだけを表示できます。

サービス一覧

サービス名およびその情報が一覧表示されます。ユーザ定義受付（呼出先選択）は，ビジネスプロセスやサービスアダプタと同じ階層に表示されます。また，列のヘッダ部分をクリックすると，列の情報で行をソートできます。

サービス一覧の中から，削除したいサービスの［名称］列のチェックボックスをチェックします。［メッセージ］列にエラーが表示されているサービスはチェックできません。

チェック状態は次の規則に従って切り替えられます。

ユーザ定義受付を持つビジネスプロセスのチェック状態を切り替える場合

チェック状態を切り替えるビジネスプロセスに属するすべてのユーザ定義受付も同じチェック状態に切り替えます。

ユーザ定義受付のチェック状態を切り替える場合

チェック状態を切り替えるユーザ定義受付の呼出元ビジネスプロセスと，呼出元ビジネスプロセスに属するすべてのユーザ定義受付も同じチェック状態に切り替えます。

複数サービスが選択されている状態で選択中のサービスのチェック状態を切り替える場合

チェックボックスをクリックしたサービス以外の選択サービスも同じチェック状態に切り替えます。

選択中のサービスの中に1.または2.が含まれる場合は，1.または2.の動作に従います。

チェック状態は次のボタンで一括で切り替えることもできます。

［表示中をすべて選択］ボタン

フィルタリング結果のサービスをすべてチェックします。

［表示中をすべて解除］ボタン

フィルタリング結果のサービスの選択状態を解除します。

［OK］ボタン

サービスを削除してダイアログを閉じます。

［キャンセル］ボタン

サービスを削除しないでダイアログを閉じます。

1.9　WSDLカスタムバインディングファイルに関連するダイアログ

WSDLカスタムバインディングファイルに関連するダイアログについて説明します。

1.9.1　設定ダイアログ（WSDLカスタムバインディングファイルの設定）

WSDLカスタムバインディングファイルを設定するためのダイアログです。SOAP1.1/1.2併用モードのSOAPアダプタまたはユーザ定義受付（SOAP受付）を作成する際に使用します。

外部バインディングファイルを利用したWSDLのカスタマイズについては，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「付録K　外部バインディングファイルを利用したWSDLのカスタマイズ」を参照してください。

WSDLカスタムバインディングファイルについて設定する場合の，［設定］ダイアログの表示手順を次に示します。

Eclipseのメニューから，［ウィンドウ］−［設定］を選択します。

［設定］ダイアログが表示されます。

ダイアログ左側から［HCSC-Definer］−［WSDLカスタムバインディング］を選択します。

WSDLカスタムバインディングの設定項目がダイアログ右側に表示されます。

WSDLカスタムバインディングの設定項目について，次に説明します。

図1‒161　［設定］ダイアログ（WSDLカスタムバインディングの設定項目）

表示項目は次のとおりです。

［外部バインディングファイル］

外部バインディングファイルの絶対パスが表示されます。［参照］ボタンから外部バインディングファイルを指定していない場合は何も表示されません。

［参照］ボタン

フォルダの選択画面が表示され，外部バインディングファイルを指定できます。

なお，09-00以前で外部バインディングファイルを使用していて，更新インストールで09-50以降にバージョンアップした場合は，09-00以前で使用していた次のファイルを指定してください。

<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥config¥tools¥custom¥custombinding.xml

［除去］ボタン

［外部バインディングファイル］に表示されているパスをクリアします。

［デフォルトの復元］ボタン

WSDLカスタムバインディングの設定値をデフォルト値へ戻します。デフォルト値は次のとおりです。

［外部バインディングファイル］：空欄

［適用］ボタン

設定した内容を有効にします。ダイアログは閉じません。

［Apply and Close］ボタン

設定した内容を有効にして，ダイアログを閉じます。

［キャンセル］ボタン

設定した内容を無効にして，ダイアログを閉じます。

1.10　検証・パッケージングに関連するダイアログ

1.10.1　設定ダイアログ（検証・パッケージングの動作設定）

検証・パッケージングの動作のうち，いくつかの項目を変更できます。設定ダイアログは次の方法で開きます。

方法

Eclipseのメニューから，［ウィンドウ］−［設定］を選択します。

［設定］ダイアログが表示されます。

ダイアログ左側から［HCSC-Definer］−［検証/パッケージング］を選択します。

検証・パッケージングの動作設定画面がダイアログ右側に表示されます。

各要素の設定について，次に説明します。

(1)　Javaソースビルドに関する設定

Javaクラスに関する次の設定を変更できます。設定変更を反映させるには，設定ダイアログの［適用］ボタン，または［Apply and Close］ボタンをクリックします。

［ビジネスプロセスの検証・パッケージング時に必ずビルドする］

検証・パッケージング実行時にJavaクラスのビルド結果を最新にします。推奨設定は，［ビジネスプロセスの検証・パッケージング時に必ずビルドする］がチェックされている状態です。09-70以前の動作にする場合は，［ビジネスプロセスの検証・パッケージング時に必ずビルドする］のチェックを外してください（非推奨）。

［src ディレクトリ以下にある Java ソースのビルドエラーを検証メッセージとして出力する］

検証・パッケージング実行時に，Javaクラスのエラーを出力します。推奨設定は，［src ディレクトリ以下にある Java ソースのビルドエラーを検証メッセージとして出力する］がチェックされている状態です。09-70以前の動作にする場合は，［src ディレクトリ以下にある Java ソースのビルドエラーを検証メッセージとして出力する］のチェックを外してください（非推奨）。

チェックありとチェックなしの動作を次に示します。

動作項目

チェックあり

チェックなし

エラー検出実行条件

検証対象のビジネスプロセスにJava呼出アクティビティがある

検証対象のビジネスプロセスにJava呼出アクティビティがある

エラー検出範囲

srcディレクトリ以下のすべてのJavaクラス

Java呼出アクティビティの「Javaクラス名」に設定されているJavaクラスだけ

(2)　Java呼出アクティビティに関する設定

Java呼出アクティビティに関する検証項目の検証レベルを設定できます。設定変更を反映させるには，設定ダイアログの［適用］ボタン，または［Apply and Close］ボタンをクリックします。

［強化された Java クラス検証項目］

推奨設定は［エラー］です。09-70以前の動作にする場合は，［警告］を設定してください（非推奨）。次の表の内容を検証します。

項番

検証内容

1

Java呼出アクティビティの「Java クラス名」に指定されているクラスが，HCSCTEプロジェクトのclassesディレクトリ内に存在するか。

2

Java呼出アクティビティの「Java クラス名」に指定されているクラスが，次の個所に1つだけ存在するか。

HCSCTEプロジェクトのclassesディレクトリ

HCSCTEプロジェクトのlib内のJARファイル内

3

Java呼出アクティビティの「Java クラス名」に指定されているクラスが，専用インターフェース（jp.co.Hitachi.soft.csc.bp.receiver.ejb.CustomClassInterfaceM，またはjp.co.Hitachi.soft.csc.bp.receiver.ejb.CustomClassInterface）を実装しているか。

4

項番3の検証に必要なクラス，またはインターフェースが存在するか※。

5

Java呼出アクティビティの「引数用割当変数」に2個以上の変数が設定されていて，かつJava呼出アクティビティの「Java クラス名」に指定されているクラスがjp.co.Hitachi.soft.csc.bp.receiver.ejb.CustomClassInterfaceMを実装しているか。

注※

実行環境のusrconf.cfg（J2EE サーバ用オプション定義ファイル）で必要なクラスを含むJARファイルをadd.class.pathで指定する運用の場合は，項番4のエラーを無視してかまいません。設定値を［警告］または［無視］にしてください。

(3)　検証アクティビティに関する設定

検証アクティビティに関する検証項目のレベルを設定できます。設定変更を反映させるには，設定ダイアログの［適用］ボタン，または［Apply and Close］ボタンをクリックします。

［検証する変数が未設定］

検証アクティビティに変数が設定されていないときの動作を指定します。推奨設定は［エラー］です。09-70以前の動作にする場合は，［警告］を設定してください（非推奨）。

1.11　バイナリフォーマット定義画面の操作

バイナリフォーマット定義画面での操作について説明します。

注意事項

以降の項での説明は，バイナリフォーマット定義画面内のバイナリフォーマット定義エディタの操作の説明です。バイナリフォーマット定義画面内のアウトラインビューには，バイナリフォーマット定義エディタでの操作結果が表示されます。

1.11.1　要素をコピーして貼り付ける

バイナリフォーマット定義エディタ上の要素をコピーして貼り付けます。

注意事項

コピーした要素は，ほかのバイナリフォーマット定義ファイルを編集しているバイナリフォーマット定義エディタ上には貼り付けできません。貼り付けできるのは，コピーした要素があるバイナリフォーマット定義エディタ上だけです。

要素をコピーして貼り付ける手順を次に示します。

コピーする要素を選択します。

右クリックして［コピー］を選択するか，［Ctrl］キー+［C］キーを押します。

貼り付け先の要素を選択します。

右クリックして［貼り付け］を選択するか，［Ctrl］キー+［V］キーを押します。

貼り付けた要素の名称は次の形式で自動設定されます（nは要素名をユニークにするための自然数）。

Copy-＜n＞-＜コピー元の要素名＞

ただし，ローカル定義の単純内容要素を別の複合内容要素の構成要素として貼り付ける場合で，同じ名称の構成要素がないときは，コピー元の要素と同じ名称の要素として貼り付けられます。

コピー元の要素と貼り付け先の要素の対応を次の表に示します。

表1‒13　コピー元の要素と貼り付け先の要素の対応

コピー元の要素

貼り付け先の要素

フォーマット

単純内容要素（グローバル定義）

複合内容要素

構成要素

（単純内容要素（グローバル定義））

構成要素

（複合内容要素）

構成要素（単純内容要素（ローカル定義））

フォーマット

−

−

−

−

−

−

単純内容要素（グローバル定義）

（1）

（2）

（2）

−

−

−

複合内容要素

（1）

（2）

（2）

−

−

−

構成要素（単純内容要素（グローバル定義））

−

−

−

−

−

−

構成要素（複合内容要素）

−

−

−

−

−

−

構成要素（単純内容要素（ローカル定義））

−

−

（3）

（4）

（4）

（4）

（凡例）

−：コピー，貼り付けはできません。

（1）

コピーしたグローバル定義の単純内容要素または複合内容要素と同じ内容で，グローバル定義の単純内容要素または複合内容要素が追加されます。すべてのグローバル定義の要素の最後尾に追加されます。

なお，複合内容要素をコピーした場合，複合内容要素に設定されている構成要素もコピーされます。

（2）

コピーしたグローバル定義の単純内容要素または複合内容要素と同じ内容で，グローバル定義の単純内容要素または複合内容要素が追加されます。貼り付け先に選択したグローバル定義の要素の上に追加されます。

なお，複合内容要素をコピーした場合，複合内容要素に設定されている構成要素もコピーされます。

（3）

コピーしたローカル定義の単純内容要素と同じ内容で，選択した複合内容要素にローカル定義の単純内容要素が追加されます。選択した複合内容要素の構成要素の最後尾に追加されます。

（4）

コピーしたローカル定義の単純内容要素と同じ内容で，ローカル定義の単純内容要素が追加されます。貼り付け先に選択した構成要素の上に追加されます。

注意事項

グローバル定義の単純内容要素をコピーして，ローカル定義の単純内容要素として貼り付けることはできません。逆に，ローカル定義の単純内容要素をコピーして，グローバル定義の単純内容要素として貼り付けることもできません。

バイナリデータとしてCSV形式のデータを利用する場合，コピーできるのは，複合内容要素（ヘッダ要素またはレコード要素）の構成要素として設定されている単純内容要素だけです。

1.11.2　要素を削除する

バイナリフォーマット定義エディタ上の要素を削除します。

要素を削除する手順を次に示します。

削除する要素を選択します。

右クリックして［削除］を選択するか，［Delete］キーを押します。

なお，次の要素の場合は削除できません。

構成要素から参照されているグローバル定義の単純内容要素および複合内容要素

ルート要素に設定されている複合内容要素

また，次の要素の場合，削除してよいかを確認する警告メッセージが表示されます。

ほかの要素の出現回数，サイズを決定する単純内容要素（ターゲットノード）

ほかの要素の選択条件値を持つ単純内容要素（選択条件ノード）

1.11.3　要素を移動する

バイナリフォーマット定義エディタ上の要素は，移動する要素（ドラッグ元）を移動先（ドロップ先）にドラッグ＆ドロップして移動できます。ドラッグ中に［Esc］キーを押すと，動作をキャンセルできます。

ドロップ先の種類と，ドラッグ時に［Ctrl］キーを押しているかどうかによって，ドラッグ＆ドロップしたときの結果は異なります。

注意事項

ドラッグ＆ドロップできる範囲は，バイナリフォーマット定義エディタ内に限定されます。バイナリフォーマット定義エディタの要素を，別のビューやエディタへドロップすることも，別のビューやエディタの要素をバイナリフォーマット定義エディタにドロップすることもできません。

ドラッグ＆ドロップによって，選択条件などの要素間の依存関係に問題が発生しても，ドラッグ＆ドロップした時点ではエラーになりません。バイナリフォーマットファイルの検証を実施したときにエラーが出力されます。

バイナリデータとしてCSV形式のデータを利用する場合，ドラッグできるのはローカル単純内容要素だけです。ドラッグしたローカル単純内容要素をドロップできるのは，複合内容要素（ヘッダ要素またはレコード要素），およびその構成要素の上辺と下辺です。

参考

ツリーがバイナリフォーマット定義エディタ内に収まらず，ドロップ先の要素が表示されていない場合，ドラッグするときのカーソルをバイナリフォーマット定義エディタの枠の近くに移動させると自動的にスクロールされます。

また，ツリーが折りたたまれていてドロップ先の要素が表示されていない場合，ドラッグするときのカーソルを折りたたまれている要素の近くに滞留させておくと自動的にツリーが展開されます。

(1)　ドロップ先の種類

ドロップ先の種類には，要素，上辺および下辺があります。

要素をドロップ先にする場合，ドロップ先の要素にドラッグしたカーソルを移動すると，要素の表示色が反転します。

上辺および下辺をドロップ先にする場合，ドロップ位置に線（[図データ]）が表示されます。

上辺および下辺にドロップする場合の例を次に示します。

図1‒162　上辺および下辺にドロップする場合の例

この図の例では，ドロップ先は構成要素「Sequence01」の下辺，かつ構成要素「Sequence03」の上辺になります。

(2)　ドラッグ＆ドロップしたときの結果

ドラッグ＆ドロップしたときの結果は，［Ctrl］キーを押しているかどうかによって異なります。

［Ctrl］キーを押さないでドラッグ＆ドロップする場合

移動

要素を移動します。ドラッグ元の要素は削除され，ドロップ先に追加されます。

参照追加

グローバル定義の複合内容要素に構成要素を追加します。ドラッグ＆ドロップして追加された構成要素の内容はデフォルト値になります。

［Ctrl］キーを押さないでドラッグ＆ドロップした場合の，ドラッグ元とドロップ先の関係を次の表に示します。

表1‒14　ドラッグ＆ドロップしたときの結果（［Ctrl］キーを利用しない場合）

ドラッグ元

ドロップ先

単純内容要素（グローバル定義）

複合内容要素（グローバル定義）

構成要素

上辺

要素

下辺

上辺

要素

下辺

上辺

要素

下辺

単純内容要素（グローバル定義）

移動

−

移動

移動

参照追加

移動

参照追加

−

参照追加

複合内容要素（グローバル定義）

移動

−

移動

移動

参照追加

移動

参照追加

−

参照追加

構成要素（単純内容要素）

−

−

−

−

−

−

移動

−

移動

構成要素（複合内容要素）

−

−

−

−

−

−

移動

−

移動

構成要素（単純内容要素（ローカル定義））

−

−

−

−

−

−

移動

−

移動

（凡例）

−：ドラッグ＆ドロップできません。

［Ctrl］キーを押したままドラッグ＆ドロップする場合

コピー追加

要素をコピーして追加します。

追加された要素の設定情報は，ドラッグ元の要素の情報が引き継がれます。

追加された要素の名称は次の形式で自動設定されます（nは要素名をユニークにするための自然数）。

Copy-＜n＞-＜ドラッグ元の要素名＞

複合内容要素をコピー追加した場合，ドラッグ元の複合内容要素に設定されている構成要素も引き継がれます。

［Ctrl］キーを押したままドラッグ＆ドロップした場合の，ドラッグ元とドロップ先の関係を次の表に示します。

表1‒15　ドラッグ＆ドロップしたときの結果（［Ctrl］キーを利用した場合）

ドラッグ元

ドロップ先

フォーマット

単純内容要素（グローバル定義）

複合内容要素（グローバル定義）

構成要素

上辺

要素

下辺

上辺

要素

下辺

上辺

要素

下辺

上辺

要素

下辺

単純内容要素（グローバル定義）

−

○

−

○

−

○

○

−

○

−

−

−

複合内容要素（グローバル定義）

−

○

−

○

−

○

○

−

○

−

−

−

構成要素（単純内容要素）

−

−

−

−

−

−

−

−

−

−

−

−

構成要素（複合内容要素）

−

−

−

−

−

−

−

−

−

−

−

−

構成要素（単純内容要素（ローカル定義））

−

−

−

−

−

−

−

○

−

○

−

○

（凡例）

−：ドラッグ＆ドロップできません。

○：コピー追加できます。

1.11.4　操作を元に戻す

バイナリフォーマット定義エディタで行った操作を元に戻します。操作は何回でも元に戻すことができます。

操作を元に戻すには次の2つの方法があります。

方法1

バイナリフォーマット定義エディタ上で右クリックして，［元に戻す］を選択します。

方法2

［Ctrl］キー+［Z］キーを押します。

1.11.5　操作をやり直す

バイナリフォーマット定義エディタで行った操作をやり直します。操作は何回でもやり直すことができます。

操作をやり直すには次の2つの方法があります。

方法1

バイナリフォーマット定義エディタ上で右クリックして，［やり直し］を選択します。

方法2

［Ctrl］キー+［Y］キーを押します。

1.12　ビジネスプロセス定義画面の操作

ビジネスプロセス定義画面での操作について説明します。

1.12.1　オブジェクトをコピーする

キャンバス上のオブジェクト（アクティビティ，コネクション，リンクコネクション，フォルトコネクション，補償コネクション，およびコメント）をコピーします。オブジェクトを複数選択した場合，選択したすべてのオブジェクトをコピーします。

オブジェクトはビジネスプロセス画面のキャンバス以外に，Word，Excelなどほかのアプリケーションにもコピーできます。ただし，開始アクティビティおよび終了アクティビティは，ほかのアプリケーションにはコピーできますが，ビジネスプロセス画面のキャンバスにはコピーはできません。

オブジェクトをコピーする手順を次に示します。

コピーしたいオブジェクトを選択します。

コネクションをコピーする場合，連結元のアクティビティおよび連結先のアクティビティも一緒に選択してください。連結元のアクティビティおよび連結先のアクティビティを一緒に選択しないと，コネクションはコピーされません。

次のどちらかの方法でコピーします。

右クリックして，［コピー］を選択します。

［Ctrl］キー+［C］キーを押します。

1.12.2　オブジェクトを切り取る

キャンバス上のオブジェクト（アクティビティ，コネクション，リンクコネクション，フォルトコネクション，補償コネクション，およびコメント）を切り取ります。切り取ることができるオブジェクトなどはコピーの場合と同じです。詳細については，「1.12.1　オブジェクトをコピーする」を参照してください。

オブジェクトを切り取る手順を次に示します。

切り取りたいオブジェクトを選択します。

コネクションを切り取る場合，連結元のアクティビティおよび連結先のアクティビティも一緒に選択してください。連結元のアクティビティおよび連結先のアクティビティを一緒に選択しないと，コネクションを切り取ることができません。

次のどちらかの方法で切り取ります。

右クリックして，［切り取り］を選択します。

［Ctrl］キー+［X］キーを押します。

1.12.3　オブジェクトを貼り付ける

コピーまたは切り取ったオブジェクト（アクティビティ，コネクション，リンクコネクション，フォルトコネクション，補償コネクション，およびコメント）を，ビジネスプロセス画面のキャンバスまたはほかのアプリケーションに貼り付けます。

(1)　貼り付け方法

オブジェクトの貼り付け方法について，貼り付け先がキャンバスの場合とほかのアプリケーションの場合とに分けて次に示します。

キャンバスの場合

次のどちらかの方法で貼り付けます。

アクティビティが選択されていない状態でキャンバス上を右クリックして，［貼り付け］を選択します。

［Ctrl］キー+［V］キーを押します。

ほかのアプリケーションの場合

［Ctrl］キー+［V］キーを押します。

(2)　貼り付け結果

貼り付け結果はオブジェクトによって次のように異なります。

注意事項

貼り付け時に簡易的なチェックが実行され，各アクティビティやコネクションで不整合が発生した場合はコンソールビューに警告メッセージが出力されます。各アクティビティやコネクションに対する整合のチェック内容については，マニュアル「サービスプラットフォーム開発ガイド 基本開発編」の「5.6　アクティビティの定義」を参照してください。

(a)　アクティビティまたはコメントをコピーまたは切り取った場合の貼り付け結果

貼り付け先によって，コピーまたは切り取り元から貼り付けられる内容が異なります。貼り付け先によるアクティビティまたはコメントの内容の違いを次の表に示します。

表1‒16　貼り付け先によるアクティビティまたはコメントの内容の違い

コピーまたは切り取り元

貼り付け先

同じキャンバス内

同じビジネスプロセスの定義内（別のスコープまたは別の繰り返し）

別のビジネスプロセスの定義

別のアプリケーション

開始アクティビティ

×

×

×

△

終了アクティビティ

×

×

×

△

データ変換アクティビティ

◎

◎※1

◎※1

△

スコープアクティビティ

◎

◎※2

◎※2

△

繰り返しアクティビティ

◎

◎※2

◎※2

△

上記以外のアクティビティ

◎

◎

◎

△

コメント

◎

◎

◎

△

（凡例）

◎：次の内容が貼り付けられます。

アクティビティまたはコメントのアイコン

アクティビティまたはコメントの定義情報

変数，相関セット，リンク，補償アクティビティのコンボボックスで設定されたアクティビティ名は，名称だけが貼り付けられます。そのため，貼り付け先に定義が存在しなければ，参照状態が不正となります。

△：次の内容が貼り付けられます。

アクティビティのアイコン

コピー先では定義できません。

×：貼り付けられません。

ただし，スコープアクティビティまたは繰り返しアクティビティがコピー対象の場合は，キャンバス上のアクティビティが貼り付けられます。

注※1

コピーまたは切り取り実行時にマッピング定義エディタが開いていれば，その編集内容で貼り付けられます。

注※2

定義した変数情報と，キャンバスで定義されたアクティビティも貼り付けられます。

(b)　コネクションをコピーまたは切り取った場合の貼り付け結果

コネクションの定義情報のうち，変数およびリンクは名称だけが貼り付けられます。そのため，貼り付け先に定義が存在しなければ，参照状態が不正となります。

1.12.4　オブジェクトを削除する

キャンバス上のオブジェクト（アクティビティ，コネクション，リンクコネクション，フォルトコネクション，補償コネクション，およびコメント）を削除します。オブジェクトを複数選択した場合，選択したすべてのオブジェクトを削除します。

オブジェクトを削除する手順を次に示します。

削除したいオブジェクトを選択します。

次のどちらかの方法で削除します。

右クリックして，［削除］を選択します。

［Delete］キーを押します。

なお，連結元のアクティビティまたは連結先のアクティビティを削除すると，連結されていたコネクション，リンクコネクション，フォルトコネクション，補償コネクション，およびコメントも削除されます。

1.12.5　オブジェクトを整列する

キャンバス上で選択した複数のオブジェクト（アクティビティ，コネクション，リンクコネクション，フォルトコネクション，補償コネクション，およびコメント）を整列します。整列の種類は，次から選択できます。

自動整列

左揃え

中央揃え（水平方向）

右揃え

上揃え

中央揃え（垂直方向）

下揃え

なお，コネクション，リンクコネクション，フォルトコネクション，および補償コネクションは，アクティビティの整列に伴い移動されるだけです。

自動整列の場合は，整列されるアクティビティ同士を連結しているコネクション（リンクコネクション，フォルトコネクション，補償コネクションを含めます）に設定されている折れ曲がり点はすべて解除されます。また，コメントは自動整列の対象外です。

一部のコネクションには，折れ曲がり点が自動で設定されます。

オブジェクトを整列する手順を次に示します。

整列したいオブジェクトを選択します。

整列したいオブジェクトの中には，必ず2つ以上のアクティビティを含めてください。

次のどちらかの方法で整列します。

右クリックして，［整列］を指定し，整列の種類を選択します。

自動整列は，［Ctrl］キー＋［Shift］キー＋［F］キーを押す方法でも実行できます。

1.12.6　操作を元に戻す

キャンバス上で行った操作を元に戻します。元に戻す操作の対象は，ビジネスプロセスごとに管理されています。よって，同じビジネスプロセス内の別のスコープアクティビティまたは繰り返しアクティビティの操作の場合は，元に戻すことができます。また，操作は50回まで元に戻すことができます。なお，次の操作は元に戻すことができません。

プロパティービューでの操作

スコープのタブまたは繰り返しのタブを，開くまたは閉じる操作

ただし，操作を元に戻してスコープアクティビティおよび繰り返しアクティビティを削除した場合，スコープのタブまたは繰り返しのタブは削除されます。

データ変換定義画面での操作

表示を拡大または縮小する操作

マッピング定義への電文フォーマット変更の反映

操作を元に戻すには，次の2つの方法があります。

方法1

アクティビティが選択されていない状態でキャンバス上を右クリックして，［元に戻す］を選択します。

方法2

［Ctrl］キー+［Z］キーを押します。

注意事項

ビジネスプロセスを保存した時点で，操作が初期化されます。したがって，ビジネスプロセスを保存すると，操作を元に戻すことができません。

1.12.7　元に戻した操作をやり直す

元に戻した操作をやり直します。やり直す操作の対象は，元に戻す操作と同様に，ビジネスプロセスごとに管理されています。また，やり直すことができる操作の回数は，連続して元に戻した回数までとなります。

操作をやり直すには，次の2つの方法があります。

方法1

アクティビティが選択されていない状態でキャンバス上を右クリックして，［やり直す］を選択します。

方法2

［Ctrl］キー+［Y］キーを押します。

注意事項

ビジネスプロセスを保存した時点で，操作が初期化されます。したがって，ビジネスプロセスを保存すると，操作を元に戻すことができません。

1.12.8　キャンバスの表示を拡大する

キャンバスの表示を拡大します。表示は200%まで拡大できます。

表示を拡大するには，次の3つの方法があります。

方法1

アクティビティが選択されていない状態でキャンバス上を右クリックして，［拡大］を選択します。

方法2

［Ctrl］キー+［+］キーを押します。

方法3

［Ctrl］キー+ホイールマウスを使用します。

1.12.9　キャンバスの表示を縮小する

キャンバスの表示を縮小します。表示は10%まで縮小できます。

表示を縮小するには，次の3つの方法があります。

方法1

アクティビティが選択されていない状態でキャンバス上を右クリックして，［縮小］を選択します。

方法2

［Ctrl］キー+［-］キーを押します。

方法3

［Ctrl］キー+ホイールマウスを使用します。

1.12.10　キャンバスの表示を元のサイズに戻す

拡大または縮小したキャンバスの表示を元のサイズ（100％）に戻します。

次の方法で表示を元のサイズに戻します。

方法

アクティビティが選択されていない状態でキャンバス上を右クリックして，［元のサイズに戻す］を選択します。

1.12.11　パレットの表示を設定する

パレットの表示を設定します。設定できる内容を次に示します。

グループおよびツールのレイアウト

アイコンのサイズ

フォント

グループ下のツール一覧の表示または非表示

パレットの表示項目については，「1.2.3(1)　パレット」を参照してください。なお，ここで設定した内容は，すべてのビジネスプロセス画面で適用されます。

(1)　グループおよびツールのレイアウトを設定する

パレットのグループおよびツールは，次のようにレイアウトを設定できます。

列

すべてのグループおよびツールを水平に整列します。

リスト

すべてのグループおよびツールを垂直に整列します。

アイコンのみ

すべてのツールに対して，ツール名を表示せずアイコンだけの表示にします。

詳細

すべてのツールに対して，詳細なフォーマットおよび記述を表示します。

グループおよびツールのレイアウトを設定するには，次の2つの方法があります。

方法1

パレットのグループまたはツールを右クリックして，［レイアウト］から設定したい項目を選択します。

方法2

パレットのグループまたはツールを右クリックして，［設定］を選択します。

［パレット設定］ダイアログが表示されます。

［レイアウト］から設定したい項目を選択します。

(2)　アイコンのサイズを設定する

パレットのツールのアイコンは，サイズを大きくできます。

ツールのアイコンのサイズを大きくするには，次の2つの方法があります。

方法1

パレットのグループまたはツールを右クリックして，［大きいアイコンを使用］を選択します。

方法2

パレットのグループまたはツールを右クリックして，［設定］を選択します。

［パレット設定］ダイアログが表示されます。

［リスト・レイアウト・オプション］の［大きいアイコンを使用］チェックボックスにチェックします。

(3)　フォントを設定する

パレットのグループおよびツールのフォントは変更できます。また，変更したフォントはデフォルトに戻すことができます。

フォントを設定する方法を，フォントを変更する場合とフォントをデフォルトに戻す場合とに分けて次に示します。

フォントを変更する場合

パレットのグループまたはツールを右クリックして，［設定］を選択します。

［パレット設定］ダイアログが表示されます。

［フォント］の［変更］ボタンをクリックします。

フォントをデフォルトに戻す場合

パレットのグループまたはツールを右クリックして，［設定］を選択します。

［パレット設定］ダイアログが表示されます。

［フォント］の［デフォルトの復元］ボタンをクリックします。

(4)　ツールの一覧の表示または非表示を設定する

パレットに表示されているツールの一覧を非表示にすることができます。また，非表示にしたツールの一覧を表示させることができます。ツールの一覧の表示および非表示の例を次に示します。

図1‒163　ツールの一覧の表示および非表示

ツールの一覧を表示または非表示にするには，次の2つの方法があります。

方法1

パレットのグループをクリックします。

方法2

パレットのグループを右クリックして，［設定］を選択します。

［パレット設定］ダイアログが表示されます。

［ドロワー・オプション］で次のラジオボタンを選択します。

［別のドロワーを開いているときは常に閉じる］ラジオボタン

一つのグループのツール一覧だけを表示させたい場合に選択します。

［十分なスペースがないときは自動的に閉じる］ラジオボタン

複数のグループのツール一覧を表示しているためパレットに十分な表示スペースがない場合，自動的にツール一覧を閉じたいときに選択します。ただし，ピン留め※が設定されているグループは，パレットに十分な表示スペースがない場合でもツール一覧は閉じません。

［閉じない］ラジオボタン

グループや表示スペースの影響によって，ツール一覧が閉じないようにしたい場合に選択します。

注※

ピン留めを設定するには，次の2つの方法があります。

方法1

パレットのグループの右側にある[図データ]（ピン）をクリックします。

方法2

パレットのグループを右クリックして，［ピン留め］を選択します。

1.12.12　コメントを最小化する

コメントを最小化します。最小化するには次の2つの方法があります。

方法1（選択したコメントを最小化する）

最小化されていないコメントを選択して右クリックし，［コメントを最小化する］を選択します。

方法2（キャンバス上のすべてのコメントを最小化する）

アクティビティが選択されていない状態でキャンバス上を右クリックして，［すべてのコメントを最小化する］を選択します。

1.12.13　コメントを元のサイズに戻す

最小化したコメントを元の大きさに戻します。コメントの大きさを戻すには次の2つの方法があります。

方法1（選択したコメントの最小化を解除する）

最小化状態のコメントを選択して右クリックし，［コメントを元のサイズに戻す］を選択します。

方法2（キャンバス上のすべてのコメントの最小化を解除する）

アクティビティが選択されていない状態でキャンバス上を右クリックして，［すべてのコメントを元のサイズに戻す］を選択します。

1.12.14　コメントの背景色を変更する

コメントの背景色を変更できます。背景色の変更手順を次に示します。

背景色を変更したいコメントを選択して，右クリックします。

コメントを複数選択して，背景色をまとめて変えることもできます。

右クリックのメニュー［背景色］のサブメニューの中から，背景色を選択します。

選択できる背景色は，黄・赤・青・緑・灰色のほか，3種類のカスタム背景色です。

カスタム背景色は次の手順で変更できます。

Eclipseのメニューから［ウィンドウ］−［設定］を選択します。

［設定］ダイアログが表示されます。

左ペインで［HCSC-Definer］−［ビジネスプロセスエディタ］を選択します。

右ペインに［ビジネスプロセスエディタ］ページが表示されます。

［コメント］の［カスタム背景色］から，変更したいカスタム背景色（［カスタム1］〜［カスタム3］）のボタンをクリックします。

表示された色の中から，変更したい色を選択します。

選択した色がダイアログに表示されます。

［適用して閉じる］ボタンをクリックします。

設定した内容を有効にして，ダイアログを閉じます。

1.12.15　アクティビティのスナップ機能の有効・無効を設定する

アクティビティのスナップ機能とは，ビジネスプロセスエディタ上のアクティビティを整列させる機能です。スナップ機能を有効にすると，ビジネスプロセス上のアクティビティをドラッグして移動した場合，ほかのアクティビティの垂直線上または平行線上に近付けると，自動で位置調整されます。

スナップ機能はデフォルトで有効になります。

無効にするには次の2つの方法があります。

方法1

［Alt］キーを押しながらドラッグします。

方法2（すべてのアクティビティのスナップ機能を解除する）

Eclipseのメニューから［ウィンドウ］−［設定］を選択します。

［設定］ダイアログが表示されます。

左ペインで［HCSC-Definer］−［ビジネスプロセスエディタ］を選択します。

右ペインに［ビジネスプロセスエディタ］ページが表示されます。

［アクティビティのスナップを有効にする］のチェックを外します。

［適用して閉じる］ボタンをクリックします。

1.12.16　アクティビティのオートコネクト機能の有効・無効を設定する

アクティビティのオートコネクト機能とは，ビジネスプロセスエディタ上に配置または移動しようとするアクティビティがほかのアクティビティと近づいた際に，コネクションをプレビュー表示する機能です。

また，連結しているアクティビティに近づくと，それらのアクティビティへ連結する別のコネクションをプレビュー表示することもできます。

この状態でアクティビティを配置すると，コネクションが確定し，アクティビティと連結されます。

オートコネクト機能はデフォルトで有効になります。オートコネクト機能を無効にしたり，設定を変更したりする手順を次に示します。

Eclipseのメニューから［ウィンドウ］−［設定］を選択します。

［設定］ダイアログが表示されます。

左ペインで［HCSC-Definer］−［ビジネスプロセスエディタ］を選択します。

右ペインに［ビジネスプロセスエディタ］ページが表示されます。

「オートコネクト」の項目を必要に応じて修正します。

既存のアクティビティとの接続を有効にするか，既存のコネクションへの挿入を有効にするか（アクティビティの新規作成時と移動時とでそれぞれ設定）

コネクションをプレビュー表示する距離

アクティビティのドラッグ中に，オートコネクト対象となる範囲を円で表示するか

［適用して閉じる］ボタンをクリックします。

1.12.17　アクティビティの自動整列機能の設定を変更する

アクティビティの自動整列機能の設定を変更する手順を次に示します。

Eclipseのメニューから［ウィンドウ］−［設定］を選択します。

［設定］ダイアログが表示されます。

左ペインで［HCSC-Definer］−［ビジネスプロセスエディタ］を選択します。

右ペインに［ビジネスプロセスエディタ］ページが表示されます。

「自動整列」の項目を必要に応じて修正します。

自動整列の方向の選択

縦方向（上から下）

横方向（左から右）

整列後のアクティビティ間隔

折れ曲がり点を生成するかどうか

［適用して閉じる］ボタンをクリックします。

1.12.18　アクティビティのアイコンのラベルサイズを変更する

ビジネスプロセスエディタ上のアクティビティのアイコンは，アイコンの下に表示されるアクティビティ名のラベルのサイズを変更できます。

ラベルサイズの表示形式には可変幅と固定幅があります。表示形式はビジネスプロセスごとに変更することもできます。

可変幅

1行のラベルにアクティビティ名全体が表示されます。そのため，アクティビティ名が長いほどラベルは長くなります。

11-00までに作成したビジネスプロセスのラベルは，可変幅で表示されます。

固定幅

ラベルの横幅が固定されます。複数行にわたって表示することもできます。

固定幅は，横幅と最大行数の組み合わせの中から選択します。最大行数でも文字列が表示しきれない場合は，ラベルの末尾が「...」と省略されます。

ラベルのサイズの変更手順を次に示します。

ビジネスプロセスエディタでキャンバスを選択します。

アクティビティとコネクションが選択されていないことを確認してください。

プロパティービューの項目「アイコンサイズ」で設定を変更します。

項目「アイコンサイズ」の設定値とその内容を次に示します。デフォルトは「固定幅（中）−ラベル1行」です。

設定値

横幅

最大行数

可変幅

アクティビティ名の長さ分

1行

固定幅（小）−ラベル1行

短い（70ピクセル）

1行

固定幅（小）−ラベル2行

2行

固定幅（小）−ラベル3行

3行

固定幅（中）−ラベル1行

中程度（105ピクセル）

1行

固定幅（中）−ラベル2行

2行

固定幅（中）−ラベル3行

3行

固定幅（大）−ラベル1行

長い（140ピクセル）

1行

固定幅（大）−ラベル2行

2行

固定幅（大）−ラベル3行

3行

1.13　データ変換定義画面の操作

データ変換定義画面での操作について説明します。

1.13.1　操作を元に戻す

データ変換定義画面で実行した操作を元に戻します。操作は何回でも元に戻すことができます。また，保存したあとでも操作を元に戻すことができます。

操作を元に戻すには，次の2つの方法があります。

方法1

データ変換定義画面上で右クリックして，［元に戻す］を選択します。

方法2

［Ctrl］キー+［Z］キーを押します。

1.13.2　操作をやり直す

データ変換定義画面で行った操作をやり直します。操作は何回でもやり直すことができます。また，保存したあとでも操作をやり直すことができます。

操作をやり直すには，次の2つの方法があります。

方法1

データ変換定義画面上で右クリックして，［やり直し］を選択します。

方法2

［Ctrl］キー+［Y］キーを押します。

1.13.3　名前空間接頭辞をXMLに出力する

名前空間接頭辞をXMLに出力するかどうかは，データ変換定義画面で切り替えられます。切り替え方法を次に示します。

方法

データ変換定義画面上で右クリックして，［名前空間接頭辞をXMLに出力する］を選択します。

［名前空間接頭辞をXMLに出力する］の左側がチェックされている場合は，XMLに名前空間接頭辞が出力されます。

1.13.4　定義を保存する

データ変換定義を保存する方法を次に示します。

方法1

Eclipseのメニューから，［ファイル］−［保存］を選択します。

方法2

Eclipseのメニューから，［ファイル］−［すべて保管］を選択します。

方法3

Eclipseのツールバーの，［保存］アイコンをクリックします。

方法4

ユーザ定義受付定義画面で，［Ctrl］キー＋［S］キーを押します。

保存したデータ変換定義は再編集できます。再編集する場合は，サービスアダプタ定義画面またはビジネスプロセス定義画面のデータ変換アクティビティから，データ変換定義画面を表示して再編集してください。

1.13.5　マッピング線の色を変更する

マッピング線の色を変更する方法を次に示します。

方法

Eclipseのメニューから，［ウィンドウ］−［設定］を選択します。

［設定］ダイアログが表示されます。

ダイアログ左側から［HCSC-Definer］−［データ変換］を選択します。

データ変換定義画面の設定項目がダイアログ右側に表示されます。データ変換定義画面の設定項目については，「1.6.18　設定ダイアログ（データ変換の設定）」を参照してください。

マッピング線の種類に応じて次のボタンをクリックし，色を設定します。

・代入線の色を設定する場合：［代入］の右側にあるボタン

・くり返し対応線とくり返し連携線の色を設定する場合：［くり返し］の右側にあるボタン

・条件線の色を設定する場合：［条件］の右側にあるボタン

各OSに対応した，色を選択するダイアログが表示されます。表示されたダイアログで，設定したい色を選択します。

［適用］ボタンをクリックします。

［Apply and Close］ボタンをクリックします。

1.13.6　スキーマツリービューアから要素のパスをコピーする

要素のパスをスキーマツリービューアからクリップボードへコピーする方法を次に示します。

方法

変換元スキーマツリービューアまたは変換先スキーマツリービューアで，コピーしたい要素を選択して右クリックし，コンテキストメニューで［要素パスのコピー］を選択します。

これによって，選択した要素のフルパスがクリップボードに保存されます。

N対1変換時は，「$<スキーマの論理名（ビジネスプロセスの変数名）>」を含むパスがコピーされます。

1.13.7　マッピングビューアのファンクションをコピーして貼り付ける

マッピングビューアのファンクションをコピーして，任意の場所に貼り付ける方法を次に示します。

方法

マッピングビューアでファンクションを選択して右クリックし，コンテキストメニューで［コピー］を選択します。

［Ctrl］キー+［C］キーを押す方法でもコピーできます。

複数のファンクションを選択してコピーすることもできます。

マッピングビューアの任意の場所で右クリックし，コンテキストメニューで［貼り付け］を選択します。

［Ctrl］キー+［V］キーを押す方法でも貼り付けられます。

1.14　アウトラインビューのフィルタ機能の設定

アウトラインビューはフィルタ機能を使用することで変数一覧表示，アクティビティ一覧表示の有効・無効を設定できます。

1.14.1　変数一覧表示の有効・無効を設定する

変数一覧表示はデフォルトで有効になります。有効・無効を設定する方法を次に示します。

方法

アウトラインビューのメニューから，［変数一覧を表示］を選択します。

表示する場合，［変数一覧を表示］をチェックしてください。表示しない場合，［変数一覧を表示］のチェックを外してください。

1.14.2　アクティビティ一覧表示の有効・無効を設定する

アクティビティ一覧表示はアクティビティの種別ごとに有効・無効を設定できます。アクティビティ一覧表示はデフォルトですべて有効になります。有効・無効を設定する方法を次に示します。

方法

アウトラインビューのメニューから，［フィルター］を選択します。

［フィルター］ダイアログが表示されます。

アウトラインビューに表示したいアクティビティ種別をチェックします。

表示する場合，［アクティビティ種別］の中の各項目をチェックしてください。表示しない場合，［アクティビティ種別］の中の各項目のチェックを外してください。

［OK］ボタンをクリックします。

2　コマンド（開発環境）

この章では，サービスプラットフォームのシステム開発に利用するコマンドについて説明します。

2.1　コマンドの種類

サービスプラットフォームの開発環境で使用するコマンドの一覧を，次の表に示します。

表2‒1　サービスプラットフォームの開発環境で使用するコマンドの一覧

コマンド

説明

csamkxmls

DBアダプタのサービス部品を実行するためのDBアダプタ用のXMLフォーマット定義ファイルを作成します。

cscbinaryparse

DOMとバイナリデータとを変換し，変換後のファイルを出力します。

cscfdx2xsd

バイナリフォーマット定義ファイルからXMLフォーマット定義ファイルを生成します。

cscgenbinary

バイナリフォーマット定義ファイルからバイナリ電文を生成します。

cscjson2xsd

JSON形式データをXSDファイルに変換し，変換後のファイルを出力します。

cscjsonxmlconv

JSON形式データとXML形式データとを変換し，変換後のファイルを出力します。

cscoas2servicedef

OpenAPI仕様書をHCSCコンポーネントの定義に変換します。

cscsoapmode

使用するSOAPモードを設定します。

csctransform

データ変換のテストを実施し，変換後のファイルを出力します。

csmexecutebp

ビジネスプロセスにリクエストを送信します。

2.2　コマンドの入力形式

コマンドの入力形式を次に示します。

コマンド名 [引数…]

各項目について説明します。なお，コマンドプロンプトを「$」，コマンド名を「cmd」と表記します。

コマンド名

実行するコマンドのファイル名を指定します。

空白を含むパスを指定してコマンドを実行する場合，パス全体を" "で囲む必要があります。

誤った指定例：$ C:¥Program Files¥Hitachi¥Cosminexus¥CC¥server¥bin¥cmd

正しい指定例：$ "C:¥Program Files¥Hitachi¥Cosminexus¥CC¥server¥bin¥cmd"

引数

引数には，オプションも含まれます。オプションの入力形式および指定規則を次に示します。

オプションの入力形式

オプションは，「-」（ハイフン）で始まる文字列です。オプションの入力形式には，オプション引数を指定しない形式と，1個のオプション引数を指定する形式があります。

オプション引数を指定しない形式

$ cmd -オプションフラグ

1個のオプション引数を指定する形式

$ cmd -オプションフラグ<スペースまたはタブ>オプション引数

（凡例）

オプションフラグ

1文字の半角英数字です。大文字と小文字が区別されます。

オプション引数

オプションフラグに対する引数です。

オプションの指定規則

オプションフラグは，1つの「-」（ハイフン）にまとめて指定できません。

誤った指定例：$ cmd -abc

正しい指定例：$ cmd -a -b -c

オプション引数を必要とするオプションフラグのオプション引数は，省略できません。

オプションフラグとオプション引数の間には，スペースまたはタブが必要です。

誤った指定例：$ cmd -afile

正しい指定例：$ cmd -a file

同じオプションフラグは，複数指定できません。

誤った指定例：$ cmd -a 1 -a 2

オプション引数に空白を含む場合，オプション引数全体を""で囲む必要があります。

誤った指定例：$ cmd -a file 1

正しい指定例：$ cmd -a "file 1"

2.3　コマンドの文法の記述形式

コマンドの文法について次の形式で説明します。

形式

コマンドの入力形式を示します。

機能

コマンドの機能について説明します。

引数

コマンドの引数およびオプションについて説明します。

使用例

コマンドの使用例について説明します。

戻り値

コマンドの戻り値について説明します。

注意事項

コマンドを実行する上での全体的な注意事項について説明します。

注

すべてのコマンドで上記の項目をすべて説明しているわけではありません。また，上記以外に，各コマンドの固有情報を記載している場合があります。

この章の文法の説明で使用している記号を次に示します。

記号

意味

　｜

横に並べられた複数の項目に対する項目間の区切りを示し，「または」を意味します。

（例）　A｜B

AまたはBを指定することを示します。

{ 　 }

この記号で囲まれている複数の項目のうちから1つを選択することを示します。項目が横に並べられ，記号｜で区切られている場合は，そのうちの1つを選択します。

（例）　｛A｜B｜C｝

A，BまたはCのどれかを指定することを示します。

［　］

この記号で囲まれている項目は省略してもよいことを示します。

（例）　［A］

「何も指定しない」か「Aを指定する」ことを示します。

<　>

この記号で囲まれている項目は，該当する要素を指定することを示します。

（例）　<プロパティ>

プロパティを記述します。

…

記述が省略されていることを示します。

（例）　ABC…

ABCの後ろに記述があり，その記述が省略されていることを示します。

〜

この記号の前に示された項目が，記号〜に続く＜　＞，((　))，<<　>>などの規則に従うことを示します。

＜　＞

項目を記述するときに従わなければならない構文要素を示します。構文要素については，次の表を参照してください。

((　))

項目で指定できる値の範囲を示します。

<<　>>

項目を省略したときに，システムが仮定する標準値を示します。

この章で使用している構文要素の種類と定義を次に示します。

種類

定義

英字

A〜Z　a〜z

英小文字

a〜z

英大文字

A〜Z

数字

0〜9

英数字

A〜Z　a〜z　0〜9

記号

_　.　-

文字列

任意の文字の配列

2.4　サービスプラットフォームの開発環境で使用するコマンド

csamkxmls（DBアダプタ用のXMLフォーマット定義ファイルの生成）

形式

csamkxmls -o <SQLオペレーション定義ファイルの名称>
          -x <DBアダプタ用のXMLフォーマット定義ファイルの名称>
         [-f]

機能

DBアダプタのサービス部品を実行するためのDBアダプタ用のXMLフォーマット定義ファイルを作成します。

このコマンドは，次の場所に格納されています。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥bin

コマンドを実行する場合は，この場所まで移動するかパスを指定してください。

引数

-o <SQLオペレーション定義ファイルの名称>　〜 ((1−200バイト))

SQL実行形式を記載しているSQLオペレーション定義ファイルの名称を指定します。SQLオペレーション定義ファイルの名称は，形式が「csa_sql_<任意の名称>.xml」のファイルを絶対パスで指定します。

-x <DBアダプタ用のXMLフォーマット定義ファイルの名称>　〜 ((1−200バイト))

作成するDBアダプタ用のXMLフォーマット定義ファイルの名称を指定します。DBアダプタ用のXMLフォーマット定義ファイルの名称は，拡張子が「.xsd」のファイルを絶対パスで指定します。なお，XMLフォーマット定義ファイルの名称は，200バイト※以内で指定してください。

注※

XMLフォーマット定義ファイルの絶対パスをUTF-8で変換したときのバイト数です。

-f

作成するDBアダプタ用のXMLフォーマット定義ファイルと同じ名称のXMLフォーマット定義ファイルがすでにある場合，上書きをします。作成するDBアダプタ用のXMLフォーマット定義ファイルと同じ名称のXMLフォーマット定義ファイルがすでにある場合に，このオプションを指定していないと，エラーになります。

戻り値

戻り値

意味

0

正常終了しました。

1

異常終了しました。

9

実行権限のチェックエラーが発生しました。

cscbinaryparse（DOMとバイナリデータの相互変換）

形式

(1)コマンドに引数を直接指定する場合

cscbinaryparse -format <バイナリフォーマット定義ファイルのパス>
               -infile <入力データファイルのパス>
               -outfile <出力データファイルのパス>
               [-inverse]
               [-uocclass <文字コード変換UOCのクラス名>
                [-uocproperty <文字コード変換UOCの独自定義ファイルのパス>]]
               [-codetablerootpath <コード変換テーブルの格納パスのルートパス>]
               [-debugtrace [-debugtracefilepath <デバッグ情報の出力先パス>]]
               [-cscdtsysprop <データ変換用システムプロパティファイルのパス>]
               [-undefinedcode {ERROR｜REPLACE}]

(2)コマンドの引数をファイルに指定する場合

cscbinaryparse -f <バイナリパースコマンドプロパティファイルのパス>

機能

DOMとバイナリデータとを変換し，変換結果をファイル出力します。

このコマンドは，次の場所に格納されています。

<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥bin

コマンドを実行する場合は，この場所まで移動するかパスを指定してください。

コマンドの引数の指定方法には次の2種類があります。

コマンドに引数を直接指定する方法

コマンド実行時に引数を指定する方法です。-fオプションと一緒に指定すると，直接指定した引数はすべて無効となり，-fオプションに指定したバイナリパースコマンドプロパティファイルに記載された引数が有効になります。

コマンドの引数をファイルに指定する方法

コマンドの引数をバイナリパースコマンドプロパティファイルにプロパティ形式で列記し，そのファイル名を-fオプションで指定する方法です。

システム環境変数COSMINEXUS_HOMEが正しく設定されていない場合，コマンドを実行するとエラーになります。

引数

(1)コマンドに引数を直接指定する場合

-format <バイナリフォーマット定義ファイルのパス>

バイナリフォーマット定義ファイル（.fdx）のパスを絶対パスまたは相対パスで指定します。この引数は省略できません。

-infile <入力データファイルのパス>

入力データファイルのパスを絶対パスまたは相対パスで指定します。この引数は省略できません。

指定できるデータの種類を次に示します。

バイナリデータ

次のどちらかのDOMデータ（XML）

バイナリデータからDOM変換で生成したDOMデータ

XMLスキーマファイル（-formatオプションで指定したバイナリフォーマット定義ファイルをcscfdx2xsdコマンドに指定して生成）に沿ったDOMデータ

-outfile <出力データファイルのパス>

出力データファイルのパスを絶対パスまたは相対パスで指定します。出力先のディレクトリが存在しない場合はエラーになります。この引数は省略できません。

指定したパスに同名のファイルが存在する場合，ファイルを上書きします。同名のファイルが存在しない場合は，ファイルを新たに作成します。

-inverse

バイナリとDOMの変換動作を指定します。この引数は省略できます。

この引数を指定した場合

DOMデータをバイナリデータに変換します。

この引数を指定しない場合

バイナリデータをDOMデータに変換します。

-uocclass <文字コード変換UOCのクラス名>

文字コード変換UOCのクラス名を完全修飾名で指定します。この引数は省略できます。

文字コード変換UOCのクラス名は，この引数とバイナリパースコマンドプロパティファイルのほかに，データ変換用システムプロパティファイルでも指定できます。指定が重複した場合は，次に示す優先順位に従って指定値が適用されます。

優先順位

プロパティファイル名／コマンド名

該当するプロパティ名／引数名

1

データ変換用システムプロパティファイル

csc.dt.ownCodeConverter.className

2

バイナリパースコマンドプロパティファイル

csctransform.uoc.class

3

cscbinaryparseコマンド

-uocclass

データ変換用システムプロパティファイルのcsc.dt.ownCodeConverter.classNameの設定については，「3.19.2　データ変換用システムプロパティファイル」を参照してください。

なお，文字コード変換UOCを使用する場合は，文字コード変換UOCのjarファイルをシステム環境変数CSC_DATA_TRANSFORM_CLASSPATHに設定してください。外部のjarファイルに定義されているクラスをカスタムファンクションや文字コード変換UOCから呼び出す場合も，該当するjarファイルを環境変数に設定する必要があります。

-uocproperty <文字コード変換UOCの独自定義ファイルのパス>

-uocclassオプションが指定されている場合に，文字コード変換UOCの独自定義ファイルのパスを絶対パスまたは相対パスで指定します。この引数は省略できます。

-uocclassオプションが指定されていない場合は，この引数の指定は無効となります。-uocclassオプションを指定してこの引数を省略した場合は，独自定義ファイルを読み込まない状態で文字コード変換UOCのクラスがデータ変換時に実行されます。

-codetablerootpath <コード変換テーブルの格納パスのルートパス>

コード変換ライブラリで使用するコード変換テーブル格納パスのルートパスを絶対パスまたは相対パスで指定します。この引数は省略できます。

-debugtrace

デバッグ情報を出力する場合に指定します。この引数は省略できます。

-debugtracefilepath <デバッグ情報の出力先パス> 〜<<コマンドを実行したカレントディレクトリ>>

-debugtraceオプションを指定している場合，デバッグ情報の出力先パスを絶対パスまたは相対パスで指定します。この引数は省略できます。

この引数を設定していない場合，出力先を指定していない場合，または指定したディレクトリが存在しない場合は，コマンドを実行したカレントディレクトリにデバッグ情報が出力されます。

-cscdtsysprop <データ変換用システムプロパティファイルのパス>

データ変換用システムプロパティファイルのパスを絶対パスまたは相対パスで指定します。この引数は省略できます。

データ変換用システムプロパティファイルは，Service Platformのデータ変換のシステムプロパティを指定したファイルです。指定方法については，「3.19.2　データ変換用システムプロパティファイル」を参照してください。

-undefinedcode {ERROR｜REPLACE}　〜<<ERROR>>

バイナリデータの文字コード変換時に未定義の文字コードを検出した場合の動作を指定します。この引数は省略できます。

指定できる値は次のとおりです。

ERROR

未定義の文字コードを検出した時点でエラーとし，処理を終了します。

REPLACE

未定義部分の文字コードを空白の文字コードに置換して処理を継続します。

(2)コマンドの引数をファイルに指定する場合

-f <バイナリパースコマンドプロパティファイルのパス>

バイナリパースコマンドプロパティファイルのパスを相対パスまたは絶対パスで指定します。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

バイナリパースコマンドプロパティファイル

cscbinaryparseコマンドの引数をJavaのプロパティファイル形式で列記したファイルです。使用できる文字コードはUTF-8だけです。

バイナリパースコマンドプロパティファイルの定義方法については，「3.19.5　バイナリパースコマンドプロパティファイル」を参照してください。

戻り値

戻り値

意味

0

正常終了しました。

1

異常終了しました。

注意事項

コマンドの実行時にスタックオーバーフローやOOM（Out Of Memory）が発生した場合，システム環境変数CSC_DATA_TRANSFORM_OPTにJavaVM起動オプションを指定して，スタック領域やヒープ領域の値を設定してください。

システム環境変数に指定できるJavaVM起動オプションを次に示します。

JavaVM起動オプション

説明

-Xms

ヒープ領域（New領域＋Old領域）の初期値

-Xmx

ヒープ領域（New領域＋Old領域）の最大値

-Xss

スレッドのスタックサイズ

-XX:MetaspaceSize

Metaspace領域に起因するFullGCの基準値の指定

-XX:MaxMetaspaceSize

Metaspace領域の最大値の指定

パスをワイルドカードで指定した場合の動作は保証しません。

cscfdx2xsd（バイナリフォーマット定義ファイルからXMLフォーマット定義ファイルの生成）

形式

cscfdx2xsd <fdxファイルパス> [<xsdファイルパス>]

機能

バイナリフォーマット定義ファイルからXMLフォーマット定義ファイルを生成します。

このコマンドは，次の場所に格納されています。

<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥bin

コマンドを実行する場合は，この場所まで移動するかパスを指定してください。

引数

<fdxファイルパス>

入力するバイナリフォーマット定義ファイルのパスを絶対パスまたは相対パスで指定します。

指定できるファイルは1つだけです。ワイルドカードの指定によって複数ファイルが選択された場合はエラーになります。

<xsdファイルパス>

出力するXMLフォーマット定義ファイルのパスを絶対パスまたは相対パスで指定します。

この指定を省略した場合，<fdxファイルパス>に指定したパスの拡張子を「.xsd」に変更したファイルパスが仮定されます。

使用例

(1) バイナリフォーマット定義ファイル「CSVFormat.fdx」からXMLフォーマット定義ファイル「CSVFormat.xsd」を生成する場合

C:¥> cscfdx2xsd CSVFormat.fdx
KECT91001-I The XML schema file was created successfully. (file = CSVFormat.xsd)
C:¥>

(2) バイナリフォーマット定義ファイル「BinFormat.fdx」からXMLフォーマット定義ファイル「XMLFormat.xsd」を生成して，既存のXMLフォーマット定義ファイル「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:¥>

戻り値

このコマンドには戻り値はありません。メッセージが標準出力に出力されます。

注意事項

次の場合はエラーになります。

バイナリフォーマット定義ファイルの検証が完了していない場合

バイナリフォーマット定義ファイルの拡張子が「.fdx」以外の場合

指定したバイナリフォーマット定義ファイルが存在しない場合

バイナリフォーマット定義ファイルとして読み込むことができない場合

バイナリフォーマット定義ファイルの指定，またはXMLフォーマット定義ファイルの指定で，ワイルドカードを使用した場合

変換処理中に何らかのエラーが発生した場合

cscgenbinary（バイナリフォーマット定義ファイルからバイナリ電文の生成）

形式

(1)コマンドに引数を直接指定する場合

cscgenbinary -format <バイナリフォーマット定義ファイルのパス>
              {-outbinfile <出力バイナリファイルのパス>
                [-inxmlfile <入力XMLファイルのパス>]
               | -outxmlfile <出力XMLファイルのパス>}
              [-genproperty <バイナリ電文生成定義ファイルのパス>]
              [-uocclass <文字コード変換UOCのクラス名>
               [-uocproperty <文字コード変換UOCの独自定義ファイルのパス>]]
              [-codetablerootpath <コード変換テーブルの格納パスのルートパス>]
              [-debugtrace [-debugtracefilepath <デバッグ情報の出力先パス>]]
              [-cscdtsysprop <データ変換用システムプロパティファイルのパス>]
              [-undefinedcode {ERROR｜REPLACE}]

(2)コマンドの引数をファイルに指定する場合

cscgenbinary -f <バイナリ電文生成コマンドプロパティファイルのパス>

機能

バイナリフォーマット定義ファイルからバイナリ電文を生成します。

このコマンドは，次の場所に格納されています。

<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥bin

コマンドを実行する場合は，この場所まで移動するかパスを指定してください。

コマンドの引数の指定方法には次の2種類があります。

コマンドに引数を直接指定する方法

コマンド実行時に引数を指定する方法です。-fオプションと一緒に指定すると，直接指定した引数はすべて無効となり，-fオプションに指定したバイナリ電文生成コマンドプロパティファイルに記載された引数が有効になります。

コマンドの引数をファイルに指定する方法

コマンドの引数をバイナリ電文生成コマンドプロパティファイルにプロパティ形式で列記し，そのファイル名を-fオプションで指定する方法です。

システム環境変数COSMINEXUS_HOMEが正しく設定されていない場合，コマンドを実行するとエラーになります。

cscgenbinaryコマンドの使用方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「10.5.7　cscgenbinaryコマンドの使用方法」を参照してください。

引数

(1)コマンドに引数を直接指定する場合

-format <バイナリフォーマット定義ファイルのパス>

エディタでの検証が完了しているバイナリフォーマット定義ファイル（.fdx）のパスを絶対パスまたは相対パスで指定します。拡張子の大文字・小文字は区別しません。この引数は省略できません。

-outbinfile <出力バイナリファイルのパス>

出力バイナリファイルのパスを絶対パスまたは相対パスで指定します。出力先のディレクトリが存在しない場合はエラーになります。

-outbinfileオプション（出力バイナリファイルのパス）と-outxmlfileオプション（出力XMLファイルのパス）は，どちらか一方を指定してください。

指定したパスに同名のファイルが存在する場合，ファイルを上書きします。同名のファイルが存在しない場合は，ファイルを新たに作成します。

-inxmlfile <入力XMLファイルのパス>

XMLファイルからバイナリ電文を生成する場合に，入力XMLファイルのパスを絶対パスまたは相対パスで指定します。この引数は省略できます。

-outxmlfileオプションと同時に指定すると，この引数の指定は無効になります。

指定する入力XMLファイルは，バイナリフォーマット定義ファイル（-formatオプションで指定）を基にcscfdx2xsdコマンドで生成したXMLスキーマファイルに沿っている必要があります。XMLスキーマファイルに沿っていない場合は動作を保証しません。

-outxmlfile <出力XMLファイルのパス>

出力XMLファイルのパスを絶対パスまたは相対パスで指定します。出力先のディレクトリが存在しない場合はエラーになります。この引数は省略できません。

-outbinfileオプション（出力バイナリファイルのパス）と-outxmlfileオプション（出力XMLファイルのパス）は，どちらか一方を指定してください。

指定したパスに同名のファイルが存在する場合，ファイルを上書きします。同名のファイルが存在しない場合は，ファイルを新たに作成します。

-genproperty <バイナリ電文生成定義ファイルのパス>

バイナリ電文生成定義ファイルのパスを絶対パスまたは相対パスで指定します。この引数は省略できます。

-inxmlfileオプションと同時に指定すると，この引数の指定は無効になります。

バイナリ電文生成定義ファイルは，単純内容要素の要素値をデフォルト値から変更したい場合に作成します。バイナリ電文生成定義ファイルについては，「3.19.4　バイナリ電文生成定義ファイル」を参照してください。

-uocclass <文字コード変換UOCのクラス名>

文字コード変換UOCのクラス名を完全修飾名で指定します。この引数は省略できます。

なお，文字コード変換UOCのクラス名は，次に示すファイルまたはコマンドでも指定できます。指定が重複した場合に適用される優先順位を次に示します。

優先順位

プロパティファイル名／コマンド名

該当するプロパティ名／引数名

1

データ変換用システムプロパティファイル

csc.dt.ownCodeConverter.className

2

バイナリ電文生成コマンドプロパティファイル

csctransform.uoc.class

3

cscgenbinaryコマンド

-uocclass

データ変換用システムプロパティファイルのcsc.dt.ownCodeConverter.classNameの設定については，「3.19.2　データ変換用システムプロパティファイル」を参照してください。

なお，文字コード変換UOCを使用する場合は，文字コード変換UOCのjarファイルをシステム環境変数CSC_DATA_TRANSFORM_CLASSPATHに設定してください。外部のjarファイルに定義されているクラスをカスタムファンクションや文字コード変換UOCから呼び出す場合も，該当するjarファイルを環境変数に設定する必要があります。

-uocproperty <文字コード変換UOCの独自定義ファイルのパス>

-uocclassオプションが指定されている場合に，文字コード変換UOCの独自定義ファイルのパスを絶対パスまたは相対パスで指定します。この引数は省略できます。

-uocclassオプションが指定されていない場合は，この引数の指定は無効となります。-uocclassオプションを指定してこの引数を省略した場合は，独自定義ファイルを読み込まない状態で文字コード変換UOCのクラスがデータ変換時に実行されます。

-codetablerootpath <コード変換テーブルの格納パスのルートパス>

コード変換ライブラリで使用するコード変換テーブル格納パスのルートパスを絶対パスまたは相対パスで指定します。この引数は省略できます。

-debugtrace

デバッグ情報を出力する場合に指定します。この引数は省略できます。

-debugtracefilepath <デバッグ情報の出力先パス> 〜<<コマンドを実行したカレントディレクトリ>>

-debugtraceオプションを指定している場合，デバッグ情報の出力先パスを絶対パスまたは相対パスで指定します。この引数は省略できます。

この引数を設定していない場合，デバッグ情報の出力先を指定していない場合，または指定したディレクトリが存在しない場合は，コマンドを実行したカレントディレクトリにデバッグ情報が出力されます。

-cscdtsysprop <データ変換用システムプロパティファイルのパス>

データ変換用システムプロパティファイルのパスを絶対パスまたは相対パスで指定します。この引数は省略できます。

データ変換用システムプロパティファイルは，Service Platformのデータ変換のシステムプロパティを指定したファイルです。指定方法については，「3.19.2　データ変換用システムプロパティファイル」を参照してください。

-undefinedcode {ERROR｜REPLACE}　〜<<ERROR>>

バイナリデータの文字コード変換時に未定義の文字コードを検出した場合の動作を指定します。この引数は省略できます。

指定できる値は次のとおりです。

ERROR

未定義の文字コードを検出した時点でエラーとし，処理を終了します。

REPLACE

未定義部分の文字コードを空白の文字コードに置換して処理を継続します。

(2)コマンドの引数をファイルに指定する場合

-f <バイナリ電文生成コマンドプロパティファイルのパス>

バイナリ電文生成コマンドプロパティファイルのパスを相対パスまたは絶対パスで指定します。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

バイナリ電文生成コマンドプロパティファイル

cscgenbinaryコマンドの引数をJavaのプロパティファイル形式で列記したファイルです。使用できる文字コードはUTF-8だけです。

バイナリ電文生成コマンドプロパティファイルの定義方法については，「3.19.3　バイナリ電文生成コマンドプロパティファイル」を参照してください。

戻り値

戻り値

意味

0

正常終了しました。

1

異常終了しました。

注意事項

コマンドの実行時にスタックオーバーフローやOOM（Out Of Memory）が発生した場合，システム環境変数CSC_DATA_TRANSFORM_OPTにJavaVM起動オプションを指定して，スタック領域やヒープ領域の値を設定してください。

システム環境変数に指定できるJavaVM起動オプションを次に示します。

JavaVM起動オプション

説明

-Xms

ヒープ領域（New領域＋Old領域）の初期値

-Xmx

ヒープ領域（New領域＋Old領域）の最大値

-Xss

スレッドのスタックサイズ

-XX:MetaspaceSize

Metaspace領域に起因するFullGCの基準値の指定

-XX:MaxMetaspaceSize

Metaspace領域の最大値の指定

パスをワイルドカードで指定した場合の動作は保証しません。

cscjson2xsd（JSON形式データからXSDファイルへの変換）

形式

cscjson2xsd -in {<JSONファイルパス>
               ｜<JSONファイルを格納したディレクトリのパス>}
            -out <XSDファイルパス>
           [-f <JSON-XML変換定義ファイルのパス>]

機能

JSON形式データからXSDファイルを生成します。

このコマンドは，次の場所に格納されています。

<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥bin

コマンドを実行する場合は，この場所まで移動するかパスを指定してください。

引数

-in {<JSONファイルパス>｜<JSONファイルを格納したディレクトリのパス>}

JSONファイル（拡張子「.json」）の格納場所を絶対パスまたは相対パスで指定します。相対パスの場合，カレントディレクトリをパスの起点とします。次のどちらかの方法で指定します。

JSONファイルのパス

入力するJSONファイルのパスを指定します。

JSONファイルを格納したディレクトリのパス

入力するJSONファイルを格納したディレクトリのパスを指定します。

指定したディレクトリ直下にあるすべてのJSONファイルが入力対象となります。指定したディレクトリ直下にJSONファイルが1つも存在しない場合は，エラーとなります。

-out <XSDファイルパス>

出力するXSDファイル（拡張子「.xsd」）のパスを絶対パスまたは相対パスで指定します。相対パスの場合，カレントディレクトリをパスの起点とします。

指定されたディレクトリが存在しない場合は，ディレクトリを生成してファイルを出力します。すでに同名のファイルがある場合はファイルを上書きします。

-f <JSON-XML変換定義ファイルのパス>　〜<<<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥config¥tools¥json¥csc_json_converter.properties>>

JSON形式データとXML形式データとの変換動作が指定されたJSON-XML変換定義ファイルのパスを絶対パスまたは相対パスで指定します。相対パスの場合，カレントディレクトリをパスの起点とします。

JSON-XML変換定義ファイルを適用するには，次の2とおりの方法があります。

引数-fで，任意のJSON-XML変換定義ファイルを指定する方法

任意のファイル名のJSON-XML変換定義ファイルを指定できます。

引数-fを指定しないで，所定のファイルを自動的に読み込ませる方法

引数-fの指定を省略すると，次に示すファイルが読み込まれます。事前にJSON-XML変換定義ファイルを次に示すファイル名で格納しておく必要があります。ファイル内容は編集することもできます。

<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥config¥tools¥json¥csc_json_converter.properties

このファイルが存在しない場合は，JSON-XML変換ライブラリのデフォルト値で動作します。JSON-XML変換ライブラリについては，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「12.2　JSON-XML変換APIを使用したデータの形式変換」を参照してください。

JSON-XML変換定義ファイル

JSON形式データとXML形式データとの変換動作をJavaのプロパティファイル形式で列記したファイルです。使用できる文字コードはUTF-8だけです。このファイルは，cscjson2xsdコマンドとcscjsonxmlconvコマンドの両方で指定できます。

テンプレートファイルを次に示します。編集後，引数-fを指定する場合は任意のファイル名で格納してください。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥msg¥templates¥csc_json_converter.properties

JSON-XML変換定義ファイルの定義方法については，「3.18.1　JSON-XML変換定義ファイル」を参照してください。

戻り値

戻り値

意味

0

正常終了しました。

1

異常終了しました。

9

実行権限のチェックエラーが発生しました。

注意事項

このコマンドは，管理者権限のあるユーザで実行してください。

システム環境変数COSMINEXUS_HOMEが正しく設定されていることが必要です。

cscjsonxmlconv（JSON形式データとXML形式データの相互変換）

形式

cscjsonxmlconv -in <入力ファイルのパス>
               -out <出力ファイルのパス>
              [-f <JSON-XML変換定義ファイルのパス>]

機能

JSON形式データとXML形式データとを相互に変換した結果をファイルとして生成します。

このコマンドは，次の場所に格納されています。

<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥bin

コマンドを実行する場合は，この場所まで移動するかパスを指定してください。

引数

-in <入力ファイルのパス>

入力ファイルのパスを絶対パスまたは相対パスで指定します。指定できるのは拡張子「.json」または「.xml」のファイルだけです。

-out <出力ファイルのパス>

出力ファイルのパスを絶対パスまたは相対パスで指定します。指定できるファイルは，-inオプションで指定したファイルによって異なります。

-inオプションで指定したファイルが，拡張子「.json」のファイルの場合

拡張子「.xml」のファイルだけ指定できます。

-inオプションで指定したファイルが，拡張子「.xml」のファイルの場合

拡張子「.json」のファイルだけ指定できます。

指定されたディレクトリが存在しない場合は，ディレクトリを生成してファイルを出力します。すでに同名のファイルがある場合はファイルを上書きします。

-f <JSON-XML変換定義ファイルのパス>　〜<<<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥config¥tools¥json¥csc_json_converter.properties>>

JSON形式データとXML形式データとの変換動作が指定されたJSON-XML変換定義ファイルのパスを絶対パスまたは相対パスで指定します。

JSON-XML変換定義ファイルを適用するには，次の2とおりの方法があります。

引数-fで，任意のJSON-XML変換定義ファイルを指定する方法

任意のファイル名のJSON-XML変換定義ファイルを指定できます。

引数-fを指定しないで，所定のファイルを自動的に読み込ませる方法

引数-fの指定を省略すると，次に示すファイルが読み込まれます。事前にJSON-XML変換定義ファイルを次に示すファイル名で格納しておく必要があります。ファイル内容は編集することもできます。

<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥config¥tools¥json¥csc_json_converter.properties

このファイルが存在しない場合は，JSON-XML変換ライブラリのデフォルト値で動作します。JSON-XML変換ライブラリについては，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「12.2　JSON-XML変換APIを使用したデータの形式変換」を参照してください。

JSON-XML変換定義ファイル

JSON形式データとXML形式データとの変換動作をJavaのプロパティファイル形式で列記したファイルです。使用できる文字コードはUTF-8だけです。このファイルは，cscjson2xsdコマンドとcscjsonxmlconvコマンドの両方で指定できます。

テンプレートファイルを次に示します。編集後，引数-fを指定する場合は任意のファイル名で格納してください。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥msg¥templates¥csc_json_converter.properties

JSON-XML変換定義ファイルの定義方法については，「3.18.1　JSON-XML変換定義ファイル」を参照してください。

戻り値

戻り値

意味

0

正常終了しました。

1

異常終了しました。

9

実行権限のチェックエラーが発生しました。

注意事項

このコマンドは，管理者権限のあるユーザで実行してください。

システム環境変数COSMINEXUS_HOMEが正しく設定されていることが必要です。

cscoas2servicedef（OpenAPI仕様書をHCSCコンポーネントの定義に変換）

形式

cscoas2servicedef -in <OpenAPI仕様書のファイルパス>
                  -out <出力先ディレクトリパス>
                 [-f <JSON-XML変換定義ファイルのパス>]

機能

OpenAPI仕様書から，HTTP受付またはビジネスプロセスの次に示す定義を生成します。

サービス定義XMLファイル

電文のスキーマ

独自定義ファイル

必要に応じて生成した定義を編集し，サービス定義のインポート機能を使ってHTTP受付またはビジネスプロセスを生成できます。

このコマンドは，次の場所に格納されています。

<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥bin

コマンドを実行する場合は，この場所まで移動するかパスを指定してください。

OpenAPI仕様書からHTTP受付を作成する方法については，マニュアル「サービスプラットフォーム 解説」の「2.15.13　OpenAPI仕様書からHCSCコンポーネントを作成するOpenAPI仕様書インポート機能」を参照してください。

引数

-in <OpenAPI仕様書のファイルパス>

OpenAPI仕様書のファイルパスを絶対パスまたは相対パスで指定します。指定できるのは拡張子「.yaml」または「.json」のファイルだけです。

なお，OpenAPI仕様書に使用できる文字コードはUTF-8だけです。UTF-8以外の文字コードのファイルを指定した場合の動作は保証しません。

-out <出力先ディレクトリパス>

出力先ディレクトリのパスを絶対パスまたは相対パスで指定します。指定したディレクトリが存在しない場合は，指定されたディレクトリ名を作成したうえでファイルを出力します。

出力されるファイルの種類については，項目「出力形式」を参照してください。

-f <JSON-XML変換定義ファイルのパス>　〜<<<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥config¥tools¥json¥csc_json_converter.properties>>

JSON-XML変換定義ファイルのパスを絶対パスまたは相対パスで指定します。

HTTP受付でJSONデータを受信する場合（JSON-XML変換機能を利用する場合）は必要に応じてJSON-XML変換定義ファイルを作成し，指定してください。

JSON-XML変換定義ファイルを適用するには，次の2とおりの方法があります。

引数-fで，任意のJSON-XML変換定義ファイルを指定する方法

任意のファイル名のJSON-XML変換定義ファイルを指定できます。

引数-fを指定しないで，所定のファイルを自動的に読み込ませる方法

引数-fの指定を省略すると，次に示すファイルが読み込まれます。事前にJSON-XML変換定義ファイルを次に示すファイル名で格納しておく必要があります。ファイル内容は編集することもできます。

<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥config¥tools¥json¥csc_json_converter.properties

このファイルが存在しない場合は，JSON-XML変換ライブラリのデフォルト値で動作します。JSON-XML変換ライブラリについては，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「12.2　JSON-XML変換APIを使用したデータの形式変換」を参照してください。

JSON-XML変換定義ファイル

JSON形式データとXML形式データとの変換動作をJavaのプロパティファイル形式で列記したファイルです。使用できる文字コードはUTF-8だけです。テンプレートファイルを次に示します。編集後，引数-fを指定する場合は任意のファイル名で格納してください。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥msg¥templates¥csc_json_converter.properties

JSON-XML変換定義ファイルの定義方法については，「3.18.1　JSON-XML変換定義ファイル」を参照してください。

出力形式

コマンド実行後，「<-outオプションで指定した出力先ディレクトリ>¥<受付名>¥」の下に，次に示すファイルが出力されます。

ファイル名

ファイルの内容

servicedef_<受付名>.xml

HTTP受付（呼出先選択）のサービス定義XMLファイル

servicedef_<ビジネスプロセス名>.xml

ビジネスプロセスのサービス定義XMLファイル

（オペレーションごとに出力）

cscurecphttp.properties

HTTP受付定義ファイル

cscurecphttp_selection.properties

HTTPサービス選択定義ファイル

http_body_request_<オペレーション名>.xsd

要求電文ボディのXML Schema

（オペレーションごとに出力）

http_body_response_<オペレーション名>_<ステータスコード>.xsd

応答電文ボディのXML Schema

（オペレーションおよびステータスコードごとに出力）

HTTP受付が複数作成されるケースでは，同様の構成が複数出力されます。

戻り値

戻り値

意味

0

正常終了しました。

1

異常終了しました。

9

実行権限のチェックエラーが発生しました。

注意事項

コマンド実行前に，環境変数COSMINEXUS_HOME，および環境変数TEMP（WindowsのTemp領域のパス）を正しく設定してください。正しく設定されていない場合，動作は保証しません。

各オプションで指定するパスには，ワイルドカードやWindowsの予約語は指定しないでください。

コマンド実行前に，次に示すディレクトリの下に，コマンドが使用する前提OSSのjarファイルを配置してください。

<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥lib¥external

cscsoapmode（SOAPモードの設定）

形式

cscsoapmode {only｜both｜-h}

機能

使用するSOAPモードを設定します。

このコマンドは，次の場所に格納されています。

<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥bin

コマンドを実行する場合は，この場所まで移動するかパスを指定してください。

引数

only

SOAP1.1モードを利用する場合に指定します。

both

SOAP1.1/1.2併用モードを使用する場合に指定します。

-h

コマンドの使用方法と，現在のSOAPモードを表示します。

戻り値

戻り値

意味

0

正常終了しました。

1

異常終了しました。

注意事項

このコマンドは，管理者権限のあるユーザで実行してください。

このコマンドはHCSCTEプロジェクトを作成する前に実行する必要があります。すでにHCSCTEプロジェクトを作成している場合の設定手順については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「3.1.5　SOAPモードを変更する」を参照してください。

コマンドを実行し，SOAPモードの設定を反映させるには，Eclipseの再起動が必要になります。

csctransform（データ変換のテスト）

形式

(1)コマンドに引数を直接指定する場合

csctransform -xsl <XSLファイル（マッピング定義）のパス>
             -informat <入力フォーマット定義ファイルのパス>
             -infile <入力ファイルのパス>
             -outformat <出力フォーマット定義ファイルのパス>
             -outfile <出力ファイルのパス>
            [-uocclass <文字コード変換UOCのクラス名>
             [-uocproperty <文字コード変換UOCの独自定義ファイルのパス>]]
            [-codetablerootpath <コード変換テーブルの格納パスのルートパス>]
            [-validate]
            [-debugtrace [-debugtracefilepath <デバッグ情報の出力先パス>]]
            [-cscdtsysprop <データ変換用システムプロパティファイルのパス>]
            [-undefinedcode {ERROR｜REPLACE}]

(2)コマンドの引数をファイルに指定する場合

csctransform -f <データ変換コマンドプロパティファイルのパス>

機能

XML形式データとバイナリデータとを変換し，変換結果をファイル出力します。

このコマンドは，次の場所に格納されています。

<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥bin

コマンドを実行する場合は，この場所まで移動するかパスを指定してください。

コマンドの引数の指定方法には次の2種類があります。

コマンドに引数を直接指定する方法

コマンド実行時に引数を指定する方法です。-fオプションと一緒に指定すると，直接指定した引数はすべて無効となり，-fオプションに指定したデータ変換コマンドプロパティファイルに記載された引数が有効になります。

1対1の変換だけ実行できます。

コマンドの引数をファイルに指定する方法

コマンドの引数をデータ変換コマンドプロパティファイルにプロパティ形式で列記し，そのファイル名を-fオプションで指定する方法です。

n対1の変換および1対1の変換を実行できます。

システム環境変数COSMINEXUS_HOMEが正しく設定されていない場合，コマンドを実行するとエラーになります。

引数

(1)コマンドに引数を直接指定する場合

-xsl <XSLファイル（マッピング定義）のパス>

XSLファイル（マッピング定義）のパスを絶対パスまたは相対パスで指定します。この引数は省略できません。

-informat <入力フォーマット定義ファイルのパス>

入力フォーマット定義ファイルのパスを絶対パスまたは相対パスで指定します。この引数は省略できません。

指定できるデータの種類は拡張子「.xsd」（XMLフォーマット）または「.fdx」（バイナリフォーマット）のファイルです。

-infile <入力ファイルのパス>

入力ファイルのパスを絶対パスまたは相対パスで指定します。この引数は省略できません。

-outformat <出力フォーマット定義ファイルのパス>

出力フォーマット定義ファイルのパスを絶対パスまたは相対パスで指定します。この引数は省略できません。

指定できるデータの種類は拡張子「.xsd」（XMLフォーマット）または「.fdx」（バイナリフォーマット）のファイルです。

-outfile <出力ファイルのパス>

存在する出力ファイルのパスを絶対パスまたは相対パスで指定します。出力先のディレクトリが存在しない場合はエラーになります。この引数は省略できません。

指定したパスに同名のファイルが存在する場合，ファイルを上書きします。同名のファイルが存在しない場合は，ファイルを新たに作成します。

-uocclass <文字コード変換UOCのクラス名>

文字コード変換UOCのクラス名を完全修飾名で指定します。この引数は省略できます。

文字コード変換UOCのクラス名は，この引数とデータ変換コマンドプロパティファイルのほかに，データ変換用システムプロパティファイルでも指定できます。指定が重複した場合は，次に示す優先順位に従って指定値が適用されます。

優先順位

プロパティファイル名／コマンド名

該当するプロパティ名／引数名

1

データ変換用システムプロパティファイル

csc.dt.ownCodeConverter.className

2

データ変換コマンドプロパティファイル

csctransform.uoc.class

3

csctransformコマンド

-uocclass

データ変換用システムプロパティファイルのcsc.dt.ownCodeConverter.classNameの設定については，「3.19.2　データ変換用システムプロパティファイル」を参照してください。

なお，文字コード変換UOCを使用する場合は，文字コード変換UOCのjarファイルをシステム環境変数CSC_DATA_TRANSFORM_CLASSPATHに設定してください。外部のjarファイルに定義されているクラスをカスタムファンクションや文字コード変換UOCから呼び出す場合も，該当するjarファイルを環境変数に設定する必要があります。

-uocproperty <文字コード変換UOCの独自定義ファイルのパス>

-uocclassオプションが指定されている場合に，文字コード変換UOCの独自定義ファイルのパスを絶対パスまたは相対パスで指定します。この引数は省略できます。

-uocclassオプションが指定されていない場合は，この引数の指定は無効となります。-uocclassオプションを指定してこの引数を省略した場合は，独自定義ファイルを読み込まない状態で文字コード変換UOCのクラスがデータ変換時に実行されます。

-codetablerootpath <コード変換テーブルの格納パスのルートパス>

コード変換ライブラリで使用するコード変換テーブル格納パスのルートパスを絶対パスまたは相対パスで指定します。この引数は省略できます。

-validate

次に示すスキーマ検証を実施する場合に指定します。

入力ファイル（XML）に対して，入力フォーマット定義ファイル（XML Schema）を使ったスキーマ検証を実施します。

出力ファイル（XML）に対して，出力フォーマット定義ファイル（XML Schema）を使ったスキーマ検証を実施します。

この引数は省略できます。

-debugtrace

デバッグ情報を出力する場合に指定します。この引数は省略できます。

-debugtracefilepath <デバッグ情報の出力先パス>　〜<<コマンドを実行したカレントディレクトリ>>

-debugtraceオプションを指定している場合，デバッグ情報の出力先パスを絶対パスまたは相対パスで指定します。この引数は省略できます。

この引数を設定していない場合，出力先を指定していない場合，または指定したディレクトリが存在しない場合は，コマンドを実行したカレントディレクトリにデバッグ情報が出力されます。

-cscdtsysprop <データ変換用システムプロパティファイルのパス>

データ変換用システムプロパティファイルのパスを絶対パスまたは相対パスで指定します。この引数は省略できます。

データ変換用システムプロパティファイルは，Service Platformのデータ変換のシステムプロパティを指定したファイルです。指定方法については，「3.19.2　データ変換用システムプロパティファイル」を参照してください。

-undefinedcode {ERROR｜REPLACE}　〜<<ERROR>>

バイナリデータの文字コード変換処理で，未定義の文字コードを検出したときの動作を指定します。この引数は省略できます。

指定できる値は次のとおりです。

ERROR

未定義の文字コードを検出した時点でエラーとし，処理を終了します。

REPLACE

未定義部分の文字コードを空白の文字コードに置換して処理を継続します。

(2)コマンドの引数をファイルに指定する場合

-f <データ変換コマンドプロパティファイルのパス>

データ変換コマンドプロパティファイルのパスを相対パスまたは絶対パスで指定します。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

データ変換コマンドプロパティファイル

csctransformコマンドの引数をJavaのプロパティファイル形式で列記したファイルです。使用できる文字コードはUTF-8だけです。

データ変換コマンドプロパティファイルの定義方法については，「3.19.1　データ変換コマンドプロパティファイル」を参照してください。

戻り値

戻り値

意味

0

正常終了しました。

1

異常終了しました。

注意事項

コマンドの実行時にスタックオーバーフローやOOM（Out Of Memory）が発生した場合，システム環境変数CSC_DATA_TRANSFORM_OPTにJavaVM起動オプションを指定して，スタック領域やヒープ領域の値を設定してください。

システム環境変数に指定できるJavaVM起動オプションを次に示します。

JavaVM起動オプション

説明

-Xms

ヒープ領域（New領域＋Old領域）の初期値

-Xmx

ヒープ領域（New領域＋Old領域）の最大値

-Xss

スレッドのスタックサイズ

-XX:MetaspaceSize

Metaspace領域に起因するFullGCの基準値の指定

-XX:MaxMetaspaceSize

Metaspace領域の最大値の指定

パスをワイルドカードで指定した場合の動作は保証しません。

csmexecutebp（ビジネスプロセスの実行）

形式

csmexecutebp [-h]
             [-processname <ビジネスプロセス名>]
             [-operation <オペレーション名>]
             [-telegram <ビジネスプロセスへ送信する電文を記載したファイルのパス>]
             [-f <ビジネスプロセス実行コマンド定義ファイルのファイルパス>]

機能

ビジネスプロセスにリクエストを送信して実行するコマンドです。標準の同期受付（Webサービス）を使用してビジネスプロセスを呼び出します。

このコマンドを実行することで，任意のユーザ定義受付を持つ場合に呼び出すリクエスタを用意しなくとも，ビジネスプロセスにリクエストを送信できます。

このコマンドは，次の場所に格納されています。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥bin

コマンドを実行する場合は，この場所まで移動するかパスを指定してください。

前提条件

このコマンドを実行すると，標準の同期受付（Webサービス）を使用してビジネスプロセスを呼び出します。そのため，次に示す前提条件を満たす必要があります。

HCSCサーバの構築時に，標準の同期受付（Webサービス）を使用するよう定義されていること

コマンドの実行時に，Webサーバ，標準の同期受付（Webサービス）および呼び出すビジネスプロセスが起動状態であること

ビジネスプロセス実行コマンド定義ファイルとの関係

次の表に示す項目は，ビジネスプロセス実行コマンド定義ファイルとcsmexecutebpコマンドの両方で指定できます。両方に同じ項目が指定された場合は，コマンドの指定が優先されます。

ビジネスプロセス実行コマンド定義ファイルのプロパティ

csmexecutebpコマンドの引数

設定内容

process-name

-processname

ビジネスプロセス名

bp-operation-name

-operation

オペレーション名

telegram-filepath

-telegram

要求電文を記載したファイルのパス

なお，ビジネスプロセス実行コマンド定義ファイルでは，例外ログの情報なども指定できます。ビジネスプロセス実行コマンド定義ファイルを使用する場合は，このコマンドの-fオプションに指定して実行します。ビジネスプロセス実行コマンド定義ファイルの指定方法については，「3.21.1　ビジネスプロセス実行コマンド定義ファイル」を参照してください。

引数

-h

コマンドの使用方法を表示します。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-processname <ビジネスプロセス名>　〜 ((1−64バイト))

呼び出すビジネスプロセスのビジネスプロセス名を指定します。64バイト以内のXMLSchemaのNCName定義文字で指定してください。サービスアダプタ名を指定した場合の動作は保証しません。

-operation <オペレーション名>　〜 ((1−255バイト))

呼び出すビジネスプロセスのオペレーション名を指定します。255バイト以内のXMLSchemaのNCName定義文字で指定してください。

-telegram <ビジネスプロセスへ送信する電文を記載したファイルのパス>

ビジネスプロセスへ送信する電文が記載されたファイルを相対パスまたは絶対パスで指定します。パスに空白が含まれる場合は，オプション引数全体をダブルクォーテーション（"）で囲む必要があります。

指定を省略した場合，ビジネスプロセスに電文が送信されません。

電文を記載したファイル

ビジネスプロセスへ送信する要求電文は，任意のディレクトリの任意のファイルに定義できます。このファイルは，管理者権限のあるユーザがアクセスできる必要があります。

-f <ビジネスプロセス実行コマンド定義ファイルのファイルパス>

ビジネスプロセス実行コマンド定義ファイルのファイルパスを相対パスまたは絶対パスで指定します。パスに空白が含まれる場合は，オプション引数全体をダブルクォーテーション（"）で囲む必要があります。

ビジネスプロセス実行コマンド定義ファイル

csmexecutebpコマンドの動作をJavaのプロパティファイル形式で定義するファイルです。使用できる文字コードはUTF-8だけです。

ビジネスプロセス実行コマンド定義ファイルの定義方法については，「3.21.1　ビジネスプロセス実行コマンド定義ファイル」を参照してください。

使用例

csmexecutebpコマンドに，ビジネスプロセス名，オペレーション名，電文のファイルパス，ビジネスプロセス実行コマンド定義ファイルのファイルパスを指定して実行する場合の例を次に示します。

csmexecutebp -processname BP1 -operation op1 -telegram C:¥telegram¥telegram_op1.xml -f C:¥definition¥csmexecutebp_definition.properties

csmexecutebpコマンドは，Eclipseの［外部ツール構成］ダイアログから実行することもできます。［外部ツール構成］ダイアログから実行する場合の手順と指定例を次に示します。

Eclipseのメニューから［実行］−［外部ツール］−［外部ツールの構成］を選択します。

［外部ツール構成］ダイアログが表示されます。

左ペインの［プログラム］を右クリックし，［新規構成］を選択します。

［構成の作成、管理、および実行］ページが表示されます。

［メイン］タブを選択して，次の内容を入力します。

項目名

設定値

名前

任意の名称を指定します。

ロケーション

ビジネスプロセス実行コマンドのパスを次のように指定します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥bin¥csmexecutebp.bat

引数

ビジネスプロセス実行コマンド定義ファイルのファイルパスを次のように指定します。

-f <ビジネスプロセス実行コマンド定義ファイルのファイルパス>

［実行］ボタンをクリックします。

コマンドが登録，および実行され，コンソールビューに実行結果が表示されます。

戻り値

戻り値

意味

0

正常終了しました。

1

異常終了しました。

9

実行権限のチェックエラーが発生しました。

注意事項

このコマンドは，管理者権限のあるユーザで実行してください。

コマンド実行時に，JavaVM起動オプションを設定することはできません。

このコマンドによるビジネスプロセスの呼び出し時には，作業フォルダが生成されません。そのため，ビジネスプロセス内で作業フォルダは使用できません。

また，ビジネスプロセスの呼び出し時にヘッダ電文の送信ができないため，ビジネスプロセスの受付アクティビティでヘッダ割当変数を指定している場合，ヘッダ割当変数に指定した変数は初期化されません。

3　定義ファイル（開発環境）

この章では，サービスプラットフォームの開発環境で使用する定義ファイルの文法について説明します。

3.1　定義ファイルの種類

開発環境の定義ファイルの種類を次に示します。

表3‒1　定義ファイル一覧（開発環境）

分類

ファイル名

概要

TP1連携で利用するファイル

TP1/RPC受付定義ファイル

TP1/RPC受付のチューニングパラメタなどの動作を制御するパラメタを設定します。

TP1アダプタ環境定義ファイル

TP1アダプタの環境定義に必要な情報を設定します。

TP1アダプタ通信構成定義ファイル

TP1アダプタの通信構成定義に必要な情報を定義します。

FTP連携で利用するファイル

FTP受付定義ファイル

FTP受付をセットアップしたあとに設定変更できる内容を設定します。

ファイル操作アダプタ定義ファイル

ファイル操作アダプタの動作情報を設定します。

SOAP連携で利用するファイル

SOAP受付定義ファイル

SOAP1.1/1.2併用モードで，ユーザ定義受付（SOAP受付）が呼び出された際の動作を定義します。

クライアント定義ファイル

SOAP1.1/1.2併用モードで，サービスアダプタからWebサービスを呼び出すときの動作を定義します。

Object Accessアダプタで利用するファイル

Object Accessアダプタ通信構成定義ファイル

Object Accessアダプタの通信定義を設定します。

Message Queueアダプタで利用するファイル

Message Queueアダプタ環境定義ファイル

Message Queueアダプタの環境定義情報を設定します。

Message Queueアダプタ通信構成定義ファイル

Message Queueアダプタの通信定義を設定します。

Message Queue受付で利用するファイル

Message Queue受付定義ファイル

Message Queue受付の動作情報を設定します。

HTTPアダプタで利用するファイル

HTTPアダプタ定義ファイル

HTTPアダプタの動作情報を設定します。

HTTP受付で利用するファイル

HTTPレスポンスヘッダ定義ファイル

HTTP受付の応答電文フォーマット（ヘッダ変数用）を省略した場合のデフォルト値として使用するHTTPレスポンスヘッダ情報を設定します。

HTTP受付サービス選択定義ファイル

ユーザ定義受付（呼出先選択）のHTTP受付から呼び出すビジネスプロセスの情報と，呼び出す条件を設定します。

HTTP受付定義ファイル

HTTP受付の動作情報を設定します。

HTTP受付ルーティング定義ファイル

HTTP受付から呼び出すビジネスプロセスや，HTTP受付で実行する機能を設定します。

ファイルイベント連携で利用するファイル

ファイルイベント受付定義ファイル

ファイルイベント受付の動作情報を設定します。

Kafkaアダプタで利用するファイル

Kafkaアダプタ定義ファイル

Kafkaアダプタの動作情報を設定します。

Kafka受付で利用するファイル

Kafka受付定義ファイル

Kafka受付の動作情報を設定します。

スケジュール駆動受付で利用するファイル

スケジュール駆動受付定義ファイル

スケジュール駆動受付の動作情報を設定します。

gRPCアダプタで利用するファイル

gRPCアダプタ独自定義ファイル

gRPCアダプタの動作情報を設定します。

gRPC受付で利用するファイル

gRPC受付定義ファイル

gRPC受付の動作情報を設定します。

JSON形式データとXML形式データの変換で利用するファイル

JSON-XML変換定義ファイル

JSON-XML変換の動作を設定します。

JSON変換ツール（cscjson2xsdコマンド，cscjsonxmlconvコマンド，およびcscoas2servicedefコマンド）で使用します。

データ変換単体テストコマンドで利用するファイル

データ変換コマンドプロパティファイル

csctransformコマンドの引数と同じ内容をプロパティファイル形式で設定します。

データ変換用システムプロパティファイル

Service Platformのデータ変換のシステムプロパティを設定します。

設定したファイルは，cscbinaryparseコマンド，csctransformコマンド，およびcscgenbinaryコマンドの実行時に指定します。

バイナリ電文生成コマンドプロパティファイル

cscgenbinaryコマンドの引数と同じ内容をプロパティファイル形式で設定します。

バイナリ電文生成定義ファイル

単純内容要素の要素値をデフォルト値から変更したい場合に設定します。

バイナリパースコマンドプロパティファイル

cscbinaryparseコマンドの引数と同じ内容をプロパティファイル形式で設定します。

ログ出力アクティビティで利用するファイル

ログ出力アクティビティ定義ファイル

ログ出力アクティビティを設定した場合に出力される，ログ出力アクティビティのログファイルの情報をプロパティファイル形式で設定します。

メッセージ定義ファイル

ログ出力アクティビティで出力するメッセージをプロパティファイル形式で設定します。

ビジネスプロセスの実行で利用するファイル

ビジネスプロセス実行コマンド定義ファイル

ビジネスプロセス実行コマンドの動作をプロパティファイル形式で設定します。

3.2　定義ファイルの入力形式

表3-1に示す定義ファイルは，一部の要素を除き，次に示すJavaのプロパティファイル形式で作成または編集します。

形式

定義ファイルの入力形式を次に示します。

<キー名称> = <値>

#<コメント>

各項目について説明します。なお，各項目は，ISO-8859-1文字エンコーディングを使用してください。

キー名称

定義するキー名称を指定します。

値

定義する値がある場合に指定します。改行までを値とするため，値の後ろには，空白やコメントなどの文字列は指定できません。

コメント

行頭に「#」を記述した場合，その行はコメントとして扱われます。

3.3　定義ファイルの文法の記述形式

以降で説明する定義ファイルの文法について，次の形式で記述します。なお，すべてのファイルを次の形式で記述しているわけではありません。また，各ファイルの固有情報を記載している場合があります。

形式

ファイルの記述形式を示します。

機能

ファイルの機能について説明します。

ファイルの格納先

ファイルの格納先を示します。

設定できる要素

ファイルの中で指定できるXMLの要素について説明します。

設定できるパラメタ

ファイルの中で指定できるパラメタについて説明します。

設定できるプロパティ

ファイルの中で指定できるプロパティについて説明します。プロパティ名の可変値は<>で囲んで示します。

記述例

ファイルの内容の記述例を示します。

注意事項

ファイルを設定または使用する際の注意事項を説明します。

この章の文法の説明で使用している記号を次に示します。

記号

意味

　｜

横に並べられた複数の項目に対する項目間の区切りを示し，「または」を意味します。

（例）　A｜B

AまたはBを指定することを示します。

{ 　 }

この記号で囲まれている複数の項目のうちから1つを選択することを示します。項目が横に並べられ，記号｜で区切られている場合は，そのうちの1つを選択します。

（例）　｛A｜B｜C｝

A，BまたはCのどれかを指定することを示します。

［　］

この記号で囲まれている項目は省略してもよいことを示します。

（例）　［A］

「何も指定しない」か「Aを指定する」ことを示します。

<　>

この記号で囲まれている項目は，該当する要素を指定することを示します。

（例）　<プロパティ>

プロパティを記述します。

…

記述が省略されていることを示します。

（例）　ABC…

ABCの後ろに記述があり，その記述が省略されていることを示します。

〜

この記号の前に示された項目が，記号〜に続く＜　＞，((　))，<<　>>などの規則に従うことを示します。

＜　＞

項目を記述するときに従わなければならない構文要素を示します。構文要素については，次の表を参照してください。

((　))

項目で指定できる値の範囲を示します。

<<　>>

項目を省略したときに，システムが仮定する標準値を示します。

この章で使用している構文要素の種類と定義を次に示します。

種類

定義

英字

A〜Z　a〜z

英小文字

a〜z

英大文字

A〜Z

数字

0〜9

英数字

A〜Z　a〜z　0〜9

記号

_　.　-

文字列

任意の文字の配列

3.4　TP1連携で利用するファイル

3.4.1　TP1/RPC受付定義ファイル

(1)　形式

　urecp-tp1rpc.activation-config.service=TP1/RPC受付のサービス名
［urecp-tp1rpc.activation-config.queue_max_length=TP1/RPC受付のスケジュールキューの長さ］
［urecp-tp1rpc.activation-config.stay_watch_queue_rate=TP1/RPC受付のスケジュールキューの滞留監視でのしきい値］
［urecp-tp1rpc.activation-config.stay_watch_check_interval=TP1/RPC受付のスケジュールキューの滞留監視での警告メッセージの抑止時間］
　urecp-tp1rpc.resource-adapter=TP1/RPC受付が使用するTP1インバウンドアダプタの表示名
［urecp-tp1rpc.pooled-instance.minimum=TP1/RPC受付のプール内のインスタンスの最小数］
［urecp-tp1rpc.pooled-instance.maximum=TP1/RPC受付のプール内のインスタンスの最大数］
［urecp-tp1rpc.ejb-transaction-timeout=TP1/RPC受付のEJBトランザクションタイムアウト時間］
［urecp-tp1rpc.dt-skip={true｜false}］

(2)　機能

TP1/RPC受付のチューニングパラメタなどの動作を制御するパラメタを設定します。

TP1/RPC受付定義ファイルは「cscurecptp1rpc.properties」というファイル名で作成します。TP1/RPC受付開始時に設定した内容が有効になります。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥samples¥urecp¥cscurecptp1rpc.properties

(4)　設定できるプロパティ

urecp-tp1rpc.activation-config.service=TP1/RPC受付のサービス名　〜＜先頭が英字の英数字およびアンダーバー（_）＞((1−31文字))

TP1/RPC受付のサービス名を指定します。

urecp-tp1rpc.activation-config.queue_max_length=TP1/RPC受付のスケジュールキューの長さ　〜＜数字＞((1−65535))<<100>>

TP1/RPC受付のスケジュールキューに設定できる要求数の最大値を整数で指定します。

urecp-tp1rpc.activation-config.stay_watch_queue_rate=TP1/RPC受付のスケジュールキューの滞留監視でのしきい値　〜＜数字＞((0−100))<<70>>

TP1/RPC受付のスケジュールキューの滞留監視でのしきい値を整数で指定します。

urecp-tp1rpc.activation-config.stay_watch_check_interval=TP1/RPC受付のスケジュールキューの滞留監視での警告メッセージの抑止時間　〜＜数字＞((1−2147483647))<<60>>

TP1/RPC受付のスケジュールキューの滞留監視で，警告メッセージを抑止する時間（単位：秒）を整数で指定します。

urecp-tp1rpc.resource-adapter=TP1/RPC受付が使用するTP1インバウンドアダプタの表示名　〜＜英数字およびアンダーバー（_）＞((1−240文字))

TP1/RPC受付が使用するTP1インバウンドアダプタの表示名を指定します。

urecp-tp1rpc.pooled-instance.minimum=TP1/RPC受付のプール内のインスタンスの最小数　〜＜数字＞((0または1−2147483647))<<0>>

TP1/RPC受付のプール内のインスタンスの最小数を整数で指定します。0を指定した場合，制限はありません。

なお，このプロパティでは，urecp-tp1rpc.pooled-instance.maximumプロパティで指定した値より小さい値を指定してください。指定した値が，urecp-tp1rpc.pooled-instance.maximumプロパティで指定した値よりも大きい場合，コマンド実行時にエラーになります。

urecp-tp1rpc.pooled-instance.maximum=TP1/RPC受付のプール内のインスタンスの最大数　〜＜数字＞((0または1−2147483647))<<0>>

TP1/RPC受付のプール内のインスタンスの最大数を整数で指定します。0を指定した場合，受付処理のプール内のインスタンスの最大数には，1が設定されます。

なお，このプロパティでは，urecp-tp1rpc.pooled-instance.minimumプロパティで指定した値より大きい値を指定してください。指定した値が，urecp-tp1rpc.pooled-instance.minimumプロパティで指定した値よりも小さい場合，コマンド実行時にエラーになります。

urecp-tp1rpc.ejb-transaction-timeout=TP1/RPC受付のEJBトランザクションタイムアウト時間　〜＜数字＞((0または1−2147483647))<<0>>

TP1/RPC受付のEJBトランザクションタイムアウト時間を秒単位で指定します。0を指定した場合，J2EEサーバに設定されたデフォルトのタイムアウト値で動作します。

urecp-tp1rpc.dt-skip={true｜false}

データ変換時に電文の構造変換をスキップするかどうかを指定します。このプロパティを省略，または値を省略した場合，構造変換をスキップしません。

true

構造変換をスキップします。

false

構造変換をスキップしません。

なお，値を指定する場合は，trueまたはfalseのどちらかを指定してください。trueまたはfalse以外の値を指定した場合，コマンド実行時にエラーになります。

(5)　記述例

記述例を次に示します。

urecp-tp1rpc.activation-config.service=refer
urecp-tp1rpc.activation-config.queue_max_length=10
urecp-tp1rpc.activation-config.stay_watch_queue_rate=70
urecp-tp1rpc.activation-config.stay_watch_check_interval=60
urecp-tp1rpc.resource-adapter=TP1_Inbound_Adapter
urecp-tp1rpc.pooled-instance.minimum=1
urecp-tp1rpc.pooled-instance.maximum=10
urecp-tp1rpc.ejb-transaction-timeout=0
urecp-tp1rpc.dt-skip=true

3.4.2　TP1アダプタ環境定義ファイル

(1)　形式

(2)　機能

TP1アダプタの環境定義に必要な情報は，XML形式のTP1アダプタの環境定義ファイルに定義します。次に示すディレクトリに格納されているサンプルファイルを利用して作成します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥TP1¥config¥templates¥customadapter_properties.xml

このファイルは，開発環境でパッケージングしたあと，実行環境にインポートすることで，実行環境に反映されます。内容を変更する場合は，開発環境で再度パッケージングして実行環境にインポートしてください。

指定を省略する場合は，開始タグおよび終了タグを含めて省略してください。開始タグおよび終了タグの記述を残して要素の値だけを省略することはできません。

<entry key="adptp1_fault_message_enable>を省略する場合の指定例を次に示します。

誤った指定例

：
<properties>
  <entry key="adptp1_deffile">adptp1_config.xml</entry>
  <entry key="adptp1_fault_message_enable"></entry>
</properties>
：

正しい指定例

：
<properties>
  <entry key="adptp1_deffile">adptp1_config.xml</entry>
</properties>
：

(3)　ファイルの格納先

サンプルファイルは任意のディレクトリにファイル名「customadapter_properties.xml」で保存してください。

(4)　設定できる要素

<?xml version="1.0" encoding="UTF-8"?>

XMLファイルであることを示すXML宣言です。

<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">

DTDサブセットを示す要素型定義宣言です。

<properties>

TP1アダプタの環境定義のルート要素です。

<entry key="adptp1_deffile">　〜＜文字列＞

実行環境での通信構成が定義された，TP1アダプタ通信構成定義ファイルのファイル名を指定する要素です。

<entry key="adptp1_fault_message_enable">　〜{ true | false }<<false>>

TP1アダプタのエラー情報の拡張オプション（拡張した要素の出力有無）を指定する要素です。次のどちらかを指定してください。

true

拡張した要素を出力します。

false

拡張した要素を出力しません。

3.4.3　TP1アダプタ通信構成定義ファイル

(1)　形式

(2)　機能

TP1アダプタの通信構成定義に必要な情報は，XML形式のTP1アダプタの通信構成定義ファイルに定義します。次に示すディレクトリに格納されているサンプルファイルを利用して作成します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥TP1¥config¥templates¥adptp1_config.xml

このファイルは，開発環境でパッケージングしたあと，実行環境にインポートすることで，実行環境に反映されます。内容を変更する場合は，開発環境で再度パッケージングして実行環境にインポートしてください。

指定を省略する場合は，開始タグおよび終了タグを含めて省略してください。開始タグおよび終了タグの記述を残して要素の値だけを省略することはできません。

<active_mode>および<standcon_mode>を省略する場合の指定例を次に示します。

誤った指定例

：
<connect_mode>STAND</connect_mode>
<active_mode></active_mode>
<standcon_mode></standcon_mode>
<con_pool_num>64</con_pool_num>
：

正しい指定例

：
<connect_mode>STAND</connect_mode>
<con_pool_num>64</con_pool_num>
：

なお，一部の要素の値は，TP1アダプタ接続先動的変更機能を使って動的に変更することもできます。詳細については，マニュアル「サービスプラットフォーム 解説」の「2.7.6　TP1アダプタの接続先動的変更」を参照してください。

(3)　ファイルの格納先

サンプルファイルは任意の名称で任意のディレクトリに保存してください。その後，TP1アダプタ環境定義ファイルの<entry key="adptp1_deffile">（TP1アダプタ通信構成定義ファイルのファイル名）で指定したファイル名を指定してください。

(4)　設定できる要素

<?xml version="1.0" encoding="UTF-8"?>

XMLファイルであることを示すXML宣言です。

<adaptertp1_properties>

TP1アダプタの通信構成定義のルート要素です。

<service_group>　〜＜識別子＞((1−31文字))

サービスグループ名を指定する要素です。この要素の値に接続先システムのサービスグループ名を指定してください。

MHP（Message Handling Program）を接続先としたTCP/IP接続の場合，この要素の値は無効となります。MHP以外の場合はこの要素は省略できません。

<operation>

オペレーション情報のルート要素です。この要素はオペレーションの数だけ定義できます。

MHPを接続先としたTCP/IP接続の場合，この要素は無効となり，この要素をルートとする要素の値も無効となります。MHP以外の場合はこの要素は省略できません。

<op_name>　〜＜英数字＞((1−256文字))

オペレーション名を指定する要素です。この要素の値に，サービスリクエスタからサービスを要求するときに指定するオペレーション名を指定してください。オペレーション名は重複しないよう指定してください。

<service_group>　〜＜識別子＞((1−31文字))

サービスグループ名を指定する要素です。この要素は省略できます。省略した場合は，ルート要素直下の<service_group>の値が適用されます。

この要素の値に接続先システムのサービスグループ名を指定してください。

<service>　〜＜識別子＞((1−31文字))

サービス名を指定する要素です。この要素は省略できません。

この要素の値に接続先システムのサービスグループに登録されているサービス名を指定してください。

<watch_time>　〜＜符号なし整数＞((0−65535))(単位：秒)<<180>>

応答監視時間を指定する要素です。この要素は省略できます。

この要素の値に，TP1アダプタから通信先のOpenTP1システムに対してサービス要求を行ってから応答を受信するまでの監視時間の最大値を指定します。なお，0を指定した場合は，応答を受信するまで無限に待ちます。

この要素の指定値は，TP1アダプタへサービス要求を行ったときに発生するOpenTP1システムとの通信にだけ有効です。有効範囲の詳細は，マニュアル「サービスプラットフォーム 解説」の「2.7.3　HCSCサーバからTP1アダプタを使ったTP1サービス部品の呼び出し」の通信処理の開始中および停止中に監視時間として適用される値について説明している表，および通信処理の運用中に監視時間に適用される値について説明している表を参照してください。

ここで指定した値は，TP1アダプタ接続先動的変更機能で動的に変更することもできます。

<connect_mode>　〜{STAND｜RAP｜STATIC｜TCPIP}

接続方式を指定する要素です。この要素は省略できません。

この要素の値に，OpenTP1システムと接続するときの接続方式を指定してください。通信先を指定した接続を指定する場合は，STATICを指定してください。

指定できる値および意味は次のとおりです。

STAND：通常RPC接続

RAP：リモートAPI接続

STATIC：通信先を指定したRPC接続

TCPIP：MHPを接続先としたTCP/IP接続

注意事項

この要素に「STATIC」を指定した場合は，active_mode要素およびstandcon_mode要素の設定が無効となります。

<active_mode>　〜{STAND｜EACH}<<STAND>>

確立方式を指定する要素です。この要素の指定値は，リモートAPI接続（connect_mode要素の設定値がRAP）の場合だけ有効です。この要素は省略できます。

この要素の値に，リモートAPI接続時に確立するコネクションの常設または非常設を指定してください。

指定できる値および意味は次のとおりです。

STAND：常設コネクション

EACH：非常設コネクション

<standcon_mode>　〜{AUTO｜MANUAL}<<AUTO>>

常設コネクションの管理方法を指定する要素です。この要素の指定値は，リモートAPI接続で常設コネクションを確立する場合だけ有効です。この要素は省略できます。

この要素の値に，リモートAPI接続時に確立する常設コネクションの管理方法を指定してください。

指定できる値は次のとおりです。

AUTO：オートコネクトモード

MANUAL：非オートコネクトモード

<static_host>　〜＜文字列＞((1−255文字))

通信先を指定した接続をする場合の接続先のホスト名を指定する要素です。この要素は省略できます。

この要素の値に，接続先スケジュールサーバのホスト名を指定してください。

この要素の指定値は，RPCで通信先を指定した接続をする場合だけ有効です。そのため，次のどちらかに該当する場合は指定しても無効です。

ネームサービス，スケジューラダイレクト機能，またはリモートAPI機能を使用したRPCで接続する場合

MHPを接続先としたTCP/IP接続をする場合

ここで指定した値は，TP1アダプタ接続先動的変更機能で動的に変更することもできます。

<static_port>　〜＜符号なし整数＞((5001−65535))

通信先を指定した接続をする場合の接続先のポート番号を指定する要素です。この要素は省略できます。

この要素の値に，接続先スケジュールサーバのポート番号を指定してください。

この要素の指定値は，RPCで通信先を指定した接続をする場合だけ有効です。そのため，次のどちらかに該当する場合は指定しても無効です。

ネームサービス，スケジューラダイレクト機能，またはリモートAPI機能を使用したRPCで接続する場合

MHPを接続先としたTCP/IP接続をする場合

ここで指定した値は，TP1アダプタ接続先動的変更機能で動的に変更することもできます。

<con_pool_num>　〜＜符号なし整数＞((1−1024))

コネクションリソースのプーリング数を指定する要素です。この要素は省略できません。

この要素の値には，次の両方の条件を満たす数値を指定してください。

サービスアダプタ定義画面で指定する最大インスタンス数（TP1アダプタの最大インスタンス数）と同じ数値を指定してください。

最大インスタンス数より少ない数値を指定すると，サービス実行要求の受け付け数がこの要素の指定値を超えた場合，コネクションリソースが割り当てられなくなり，要求されたサービスがエラーとなります。

最大インスタンス数より多い数値を指定すると，差分のコネクションリソースが未使用のまま，余分なメモリを消費した状態となります。

接続先システムの同時処理数（RPC同時処理数またはTCP/IP同時処理数）の最大数を超えない値を指定してください。

<send_buff_size>　〜＜符号なし整数＞((1−8388608))（単位：バイト）<<4096>>

送信バッファサイズを指定する要素です。この要素は省略できます。

この要素の値に，接続先OpenTP1システムに要求する送信メッセージの最大長を指定してください。

なお，TP1/Client/J環境定義ファイルのdccltrpcmaxmsgsizeオペランドで指定されている値より大きな値を指定することはできません。TP1/Client/J環境定義ファイルについては，マニュアル「サービスプラットフォーム 解説」の「付録A.2　TP1/Client/Jの定義」を参照してください。

<recv_buff_size>　〜＜符号なし整数＞((1−8388608))（単位：バイト）<<4096>>

受信バッファサイズを指定する要素です。この要素は省略できます。

この要素の値に，接続先OpenTP1システムから受信メッセージの最大長を指定してください。

なお，TP1/Client/J環境定義ファイルのdccltrpcmaxmsgsizeオペランドで指定されている値より大きな値を指定することはできません。TP1/Client/J環境定義ファイルについては，マニュアル「サービスプラットフォーム 解説」の「付録A.2　TP1/Client/Jの定義」を参照してください。

<tcpip_wait_time>　〜＜数字＞((-1−65535))（単位：秒）<<180>>

メッセージ受信時の最大待ち時間を指定する要素です。この要素は，MHPを接続先としたTCP/IP接続を利用する場合だけ有効です。それ以外の場合で値を設定しても無効となります。この要素は省略できます。

この要素の値に，MHPから送信されたメッセージがTP1アダプタで受信完了するまでの，待ち時間の最大値を指定します。指定値に応じて次のように動作します。

-1を指定した場合

受信が完了するまで無限に待ち続けます。

0を指定した場合

メッセージ受信実行時にすでにメッセージが届いていれば受信します。

受信するメッセージが無かった場合は例外が発生し，TP1アダプタは応答領域にFault情報を設定して応答を返します。

1から65535までの数値を指定した場合

指定した秒数だけメッセージの受信を待ちます。指定した秒数を過ぎてもメッセージの受信が完了しない場合は例外が発生し，TP1アダプタは応答領域にFault情報を設定して応答を返します。

ここで指定した値は，TP1アダプタ接続先動的変更機能で動的に変更することもできます。

3.5　FTP連携で利用するファイル

3.5.1　FTP受付定義ファイル

(1)　形式

［urecp-ftp.resource-adapter=受付処理が使用するFTPインバウンドアダプタの表示名］
［urecp-ftp.pooled-instance.minimum=カスタム受付フレームワークのプール内のインスタンスの最小数］
［urecp-ftp.pooled-instance.maximum=受付処理およびカスタム受付フレームワークのプール内のインスタンスの最大数］
［urecp-ftp.ejb-transaction-timeout=受付処理およびカスタム受付フレームワークのEJBトランザクションタイムアウト時間］
［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)　機能

FTP受付をセットアップしたあとに設定変更できる内容を設定します。FTP受付開始時に，FTP受付定義ファイルに設定した内容が有効になります。

なお，FTP受付に対してFTP受付定義ファイルが設定されていない場合，FTP受付定義ファイルで設定できるすべてのプロパティに，デフォルト値が仮定されます。この場合，FTP受付のデプロイ時，およびFTP受付の起動時にKDEC00410-Wメッセージを出力します。

FTP受付定義ファイルは「cscurecpftp.properties」というファイル名で作成します。「cscurecpftp.properties」以外のファイル名で作成した場合，そのファイルは無視されます。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥ftprecp¥templates¥cscurecpftp.properties

(4)　設定できるプロパティ

urecp-ftp.resource-adapter=受付処理が使用するFTPインバウンドアダプタの表示名　〜＜半角英数字とアンダーバー（_）＞((0−240文字))<<Connector属性ファイルのdisplay-nameタグの設定値>>

受付処理が使用する，FTPインバウンドアダプタの表示名を指定します。大文字と小文字は区別されます。このプロパティは省略できます。

ここでは，Connector属性ファイルのdisplay-nameタグの設定値を指定してください。

このプロパティを省略，またはこのプロパティに値を指定しなかった場合，運用コマンドおよびコマンド制御（MBean）実行時に，値のチェック処理を実行しません。

urecp-ftp.pooled-instance.minimum=カスタム受付フレームワークのプール内のインスタンスの最小数　〜＜数字＞((0−2147483647))<<0>>

カスタム受付フレームワークのプール内のインスタンスの最小数を指定します。なお，受付処理のプール内のインスタンスの最小数は固定値です。このプロパティで変更することはできません。

urecp-ftp.pooled-instance.maximumプロパティの値（受付処理およびカスタム受付フレームワークのプール内のインスタンスの最大数）以下の値を指定してください。

このプロパティを省略，またはこのプロパティに値を指定しなかった場合，運用コマンドおよびコマンド制御（MBean）実行時に，値のチェック処理を実行しません。また，コマンド制御（MBean）実行時に，FTP受付のカスタムアダプタ用アプリケーション統合属性ファイルの対象となる要素に値を適用しません。

urecp-ftp.pooled-instance.maximum=受付処理およびカスタム受付フレームワークのプール内のインスタンスの最大数　〜＜数字＞((0−2147483647))<<0>>

受付処理およびカスタム受付フレームワークのプール内のインスタンスの最大数を指定します。

urecp-ftp.pooled-instance.minimumプロパティの値（カスタム受付フレームワークのプール内インスタンスの最小数）以上の値を指定してください。

0を指定した場合，受付処理およびカスタム受付フレームワークのプール内のインスタンスの最大数には，1が設定されます。

このプロパティを省略，またはこのプロパティに値を指定しなかった場合，運用コマンドおよびコマンド制御（MBean）実行時に，値のチェック処理を実行しません。また，コマンド制御（MBean）実行時に，FTP受付のアプリケーション統合属性ファイルの対象となる要素に値を適用しません。

urecp-ftp.ejb-transaction-timeout=受付処理およびカスタム受付フレームワークのEJBトランザクションタイムアウト時間　〜＜数字＞((0−2147483647))<<0>>

受付処理およびカスタム受付フレームワークのEJBトランザクションタイムアウト時間を秒単位で指定します。0を指定した場合，J2EEサーバに設定されたデフォルトのタイムアウト値で動作します。

このプロパティを省略，またはこのプロパティに値を指定しなかった場合，運用コマンドおよびコマンド制御（MBean）実行時に，値のチェック処理を実行しません。また，コマンド制御（MBean）実行時に，FTP受付のカスタムアダプタ用アプリケーション統合属性ファイルの対象要素に値を適用しません。

数字以外の値や範囲外の値が指定された場合は，運用コマンドおよびコマンド制御（MBean）実行時にエラーとなります。

urecp-ftp.work-dir.auto-delete={true｜false}　〜<<true>>

FTP受付が作業フォルダを自動的に削除するかどうかを指定します。

true

FTP受付で自動的に作業フォルダを削除します。FTP受付がビジネスプロセスからの応答を受け取り，FTP受付の処理が正常に完了したあとに削除します。

false

FTP受付で作業フォルダを削除しません。

注意事項

ビジネスプロセスが非同期型の場合，このプロパティにfalseを指定する必要があります。

urecp-ftp.common-dir-file.auto-delete={true｜false}　〜<<false>>

FTP受付が共通フォルダ内のファイルを自動的に削除するかどうかを指定します。

true

FTP受付で自動的に共通フォルダ内のファイルを削除します。FTP受付がビジネスプロセスからの応答を受け取り，FTP受付の処理が正常に完了したあとに削除します。

false

FTP受付で共通フォルダ内のファイルを削除しません。

urecp-ftp.list-command-path-extraction={true｜false}　〜<<false>>

FTP受付がGETINFOオペレーションの情報取得パス情報を抽出するかどうかを指定します。

true

FTP受付でGETINFOオペレーションの情報取得パス情報を抽出します。

false

FTP受付でGETINFOオペレーションの情報取得パス情報を抽出しません。

(5)　記述例

記述例を次に示します。

urecp-ftp.resource-adapter=FTP_Inbound_Adapter
urecp-ftp.work-dir.auto-delete=true

(6)　注意事項

FTP受付定義ファイルの内容が不正な場合，FTP受付のデプロイ時にエラーとなります。

3.5.2　ファイル操作アダプタ定義ファイル

(1)　形式

［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｜eorseparate}］
［csc.adapter.fileOperation.transform.outputTemplateXmlFile=出力用テンプレートXMLファイルのファイル名］
［csc.adapter.fileOperation.transform.EOR=EORコード］

［csc.adapter.fileOperation.transform.headerRecord={ON｜OFF}］
［csc.adapter.fileOperation.transform.trailerRecord={ON｜OFF}］

［csc.adapter.fileOperation.transform.header.inFormat=ヘッダレコード入力用のバイナリフォーマット定義ファイル名］
［csc.adapter.fileOperation.transform.header.outFormat=ヘッダレコード出力用のバイナリフォーマット定義ファイル名］
［csc.adapter.fileOperation.transform.header.inElement=ヘッダレコードに対応する入力XMLファイルの要素のパス］
［csc.adapter.fileOperation.transform.header.outElement=ヘッダレコードに対応する出力XMLファイルの要素のパス］
［csc.adapter.fileOperation.transform.header.styleSheet=ヘッダレコード変換用のXSLファイル名］
［csc.adapter.fileOperation.transform.header.fixedSize=ヘッダレコードの固定長サイズ］
［csc.adapter.fileOperation.transform.header.batchSize=分割処理時のヘッダレコードと見なす先頭のレコード数］

［csc.adapter.fileOperation.transform.data.inFormat=データレコード入力用のバイナリフォーマット定義ファイル名］
［csc.adapter.fileOperation.transform.data.outFormat=データレコード出力用のバイナリフォーマット定義ファイル名］
［csc.adapter.fileOperation.transform.data.inElement=データレコードに対応する入力XMLファイルの要素のパス］
［csc.adapter.fileOperation.transform.data.outElement=データレコードに対応する出力XMLファイルの要素のパス］
［csc.adapter.fileOperation.transform.data.styleSheet=データレコード変換用のXSLファイル名］
［csc.adapter.fileOperation.transform.data.fixedSize=データレコードの固定長サイズ］
［csc.adapter.fileOperation.transform.data.batchSize=1回当たりのデータレコードの変換数］

［csc.adapter.fileOperation.transform.trailer.inFormat=トレーラレコード入力用のバイナリフォーマット定義ファイル名］
［csc.adapter.fileOperation.transform.trailer.outFormat=トレーラレコード出力用のバイナリフォーマット定義ファイル名］
［csc.adapter.fileOperation.transform.trailer.inElement=トレーラレコードに対応する入力XMLファイルの要素のパス］
［csc.adapter.fileOperation.transform.trailer.outElement=トレーラレコードに対応する出力XMLファイルの要素のパス］
［csc.adapter.fileOperation.transform.trailer.styleSheet=トレーラレコード変換用のXSLファイル名］
［csc.adapter.fileOperation.transform.trailer.fixedSize=トレーラレコードの固定長サイズ］

［csc.adapter.fileOperation.transform.all.inFormat=一括処理時の入力用のバイナリフォーマット定義ファイル名］
［csc.adapter.fileOperation.transform.all.outFormat=一括処理時の出力用のバイナリフォーマット定義ファイル名］
［csc.adapter.fileOperation.transform.all.styleSheet=一括処理時の変換用のXSLファイル名］

［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)　機能

ファイル操作アダプタの動作情報を設定します。

ファイル操作アダプタ定義ファイルは「cscFileOperation.properties」というファイル名で作成します。

ファイル操作アダプタの開始時に，ファイル操作アダプタ定義ファイルに設定した内容が有効になります。

(3)　設定できるプロパティ

csc.adapter.fileOperation.transform.splitLoad={ON｜OFF}　〜<<ON>>

ファイルの入出力時，レコードごとに分割処理するかどうかを指定します。

ON

分割処理

OFF

一括処理

ONまたはOFF以外の値を指定した場合は一括処理されます。

csc.adapter.fileOperation.transform.input={non-xml｜xml}　〜<<non-xml>>

入力ファイルの種別を指定します。

non-xml

バイナリ形式

xml

XML形式

non-xmlまたはxml以外の値を指定した場合はバイナリ形式として扱われます。

csc.adapter.fileOperation.transform.output={non-xml｜xml}　〜<<non-xml>>

出力ファイルの種別を指定します。

non-xml

バイナリ形式

xml

XML形式

non-xmlまたはxml以外の値を指定した場合はバイナリ形式として扱われます。

csc.adapter.fileOperation.transform.format={fixed｜separate｜eorseparate}　〜<<fixed>>

入力ファイルの形式を指定します。

csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理）を指定している場合，またはcsc.adapter.fileOperation.transform.inputプロパティでxml（XML形式）を指定した場合，このプロパティの指定は無視されます。

fixed

固定長形式

separate

改行セパレータ形式

eorseparate

EORセパレータ形式

これ以外の値を指定した場合は改行セパレータ形式になります。

csc.adapter.fileOperation.transform.outputTemplateXmlFile=出力用テンプレートXMLファイルのファイル名　〜＜文字列＞<<cscOutputTemplate.xml>>

出力用テンプレートXMLファイルのファイル名を指定します。パスは指定できません。

csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理），またはcsc.adapter.fileOperation.transform.outputプロパティでnon-xml（出力ファイルがバイナリ形式）を指定している場合，このプロパティの指定は無視されます。

csc.adapter.fileOperation.transform.EOR=EORコード　〜＜文字列＞

EORセパレータ形式で使用するEORコード（レコードの終端を示すコード）を16進数で指定します。16進数の先頭には「0x」を付与しないでください。

EORコードの最大長は8バイト（16進数文字列で16文字）です。16進数の表記に使用するアルファベットは大文字・小文字を区別しません。

csc.adapter.fileOperation.transform.formatプロパティでeorseparate（EORセパレータ形式）を指定している場合，このプロパティは省略できません。

csc.adapter.fileOperation.transform.formatプロパティでeorseparate（EORセパレータ形式）以外を指定している場合，このプロパティの指定は無視されます。

csc.adapter.fileOperation.transform.headerRecord={ON｜OFF}　〜<<ON>>

ファイルにヘッダレコードを使用するかどうかを指定します。

csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理）を指定している場合，このプロパティの指定は無視されます。

ON

ヘッダレコードを使用する

OFF

ヘッダレコードを使用しない

ONまたはOFF以外の値を指定した場合，ヘッダレコードを使用しません。

csc.adapter.fileOperation.transform.trailerRecord={ON｜OFF}　〜<<ON>>

ファイルにトレーラレコードを使用するかどうかを指定します。

csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理）を指定している場合，このプロパティの指定は無視されます。

ON

トレーラレコードを使用する

OFF

トレーラレコードを使用しない

ONまたはOFF以外の値を指定した場合，トレーラレコードを使用しません。

csc.adapter.fileOperation.transform.header.inFormat=ヘッダレコード入力用のバイナリフォーマット定義ファイル名　〜＜文字列＞

ヘッダレコード入力用のバイナリフォーマット定義ファイル名を指定します。

csc.adapter.fileOperation.transform.headerRecordプロパティでON（ファイルにヘッダレコードを使用する）を指定している場合，このプロパティは省略できません。

csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理）を指定している場合，またはcsc.adapter.fileOperation.transform.inputプロパティでxml（入力ファイルがXML形式）を指定している場合，このプロパティの指定は無視されます。

csc.adapter.fileOperation.transform.header.outFormat=ヘッダレコード出力用のバイナリフォーマット定義ファイル名　〜＜文字列＞

ヘッダレコード出力用のバイナリフォーマット定義ファイル名を指定します。

csc.adapter.fileOperation.transform.headerRecordプロパティでON（ファイルにヘッダレコードを使用する）を指定している場合，このプロパティは省略できません。

csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理）を指定している場合，またはcsc.adapter.fileOperation.transform.outputプロパティでxml（出力ファイルがXML形式）を指定している場合，このプロパティの指定は無視されます。

csc.adapter.fileOperation.transform.header.inElement=ヘッダレコードに対応する入力XMLファイルの要素のパス　〜＜文字列＞

ヘッダレコードに対応する入力XMLファイルの要素のパスを次の形式で指定します。

要素のパス ::= ( '/' [ '{' 名前空間URI '}' ] 要素名)+

入力ファイルがXML形式で，csc.adapter.fileOperation.transform.headerRecordプロパティでON（ファイルにヘッダレコードを使用する）を指定している場合，このプロパティは省略できません。

csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理）を指定している場合，またはcsc.adapter.fileOperation.transform.inputプロパティでnon-xml（入力ファイルがバイナリ形式）を指定している場合，このプロパティの指定は無視されます。

csc.adapter.fileOperation.transform.data.inElementプロパティまたはcsc.adapter.fileOperation.transform.trailer.inElementプロパティに指定した要素のパスと重複する場合はエラーとなります。

csc.adapter.fileOperation.transform.header.outElement=ヘッダレコードに対応する出力XMLファイルの要素のパス　〜＜文字列＞

ヘッダレコードに対応する出力XMLファイルの要素のパスを次の形式で指定します。

要素のパス ::= ( '/' [ '{' 名前空間URI '}' ] 要素名)+

入力ファイルがXML形式で，csc.adapter.fileOperation.transform.headerRecordプロパティでON（ファイルにヘッダレコードを使用する）を指定している場合，このプロパティは省略できません。

csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理）を指定している場合，またはcsc.adapter.fileOperation.transform.outputプロパティでnon-xml（出力ファイルがバイナリ形式）を指定している場合，このプロパティの指定は無視されます。

csc.adapter.fileOperation.transform.data.outElementプロパティまたはcsc.adapter.fileOperation.transform.trailer.outElementプロパティに指定した要素のパスと重複する場合はエラーとなります。

csc.adapter.fileOperation.transform.header.styleSheet=ヘッダレコード変換用のXSLファイル名　〜＜文字列＞

ヘッダレコード変換用のXSLファイル名（ユーザ任意のファイル名）を指定します。csc.adapter.fileOperation.transform.headerRecordプロパティでON（ファイルにヘッダレコードを使用する）を指定している場合，このプロパティは省略できません。

csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理）を指定している場合，このプロパティの指定は無視されます。

csc.adapter.fileOperation.transform.header.fixedSize=ヘッダレコードの固定長サイズ　〜＜数字＞((1−2147483647))

ヘッダレコードの固定長サイズを指定します（単位：バイト）。次に示すプロパティが両方とも設定されている場合，このプロパティは省略できません。

csc.adapter.fileOperation.transform.formatプロパティの値がfixed（入力ファイルの形式が固定長）

csc.adapter.fileOperation.transform.headerRecordプロパティの値がON（ヘッダレコードを使用する）

csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理）を指定している場合，またはcsc.adapter.fileOperation.transform.inputプロパティでxml（入力ファイルがXML形式）を指定している場合，このプロパティの指定は無視されます。また，csc.adapter.fileOperation.transform.formatプロパティでseparate（入力ファイルの形式が改行セパレータ）を指定している場合，このプロパティは省略できます。

csc.adapter.fileOperation.transform.header.batchSize=分割処理時のヘッダレコードと見なす先頭のレコード数　〜＜数字＞((0−524288000))<<0>>

分割処理方式で，ヘッダレコードと見なす先頭のレコード数を指定します。0を指定した場合は1レコードと見なされます。

0を指定した場合と，1から524288000までの数値を指定した場合とでは，改行文字の扱いが次のように異なります。

0を指定した場合（指定を省略した場合，不正な値を指定した場合，および範囲外の値を指定した場合を含む）

ヘッダレコードの終了は改行文字（EORコード）で判断されます。ヘッダレコードから改行文字を除いた部分が1レコードとして変換されます。

1から524288000を指定した場合

ヘッダレコードの区切りは改行文字（EORコード）で判断されます。ヘッダレコードは改行文字も含めて変換されます。

次のどれかに当てはまる場合，このプロパティの指定は無視されます。

csc.adapter.fileOperation.transform.splitLoadプロパティの値がOFF（入力ファイル形式の一括処理）

csc.adapter.fileOperation.transform.inputプロパティの値がxml（入力ファイルがXML形式）

csc.adapter.fileOperation.transform.formatプロパティの値がfixed（入力ファイルの形式が固定長）

csc.adapter.fileOperation.transform.headerRecordプロパティの値がOFF（ヘッダレコードを使用しない）

csc.adapter.fileOperation.transform.data.inFormat=データレコード入力用のバイナリフォーマット定義ファイル名　〜＜文字列＞

データレコード入力用のバイナリフォーマット定義ファイル名を指定します。

csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理）を指定している場合，またはcsc.adapter.fileOperation.transform.inputプロパティでxml（入力ファイルがXML形式）を指定している場合，このプロパティの指定は無視されます。

csc.adapter.fileOperation.transform.data.outFormat=データレコード出力用のバイナリフォーマット定義ファイル名　〜＜文字列＞

データレコード出力用のバイナリフォーマット定義ファイル名を指定します。

csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理）を指定している場合，またはcsc.adapter.fileOperation.transform.outputプロパティでxml（出力ファイルがXML形式）を指定している場合，このプロパティの指定は無視されます。

csc.adapter.fileOperation.transform.data.inElement=データレコードに対応する入力XMLファイルの要素のパス　〜＜文字列＞

データレコードに対応する入力XMLファイルの要素のパスを次の形式で指定します。

要素のパス ::= ( '/' [ '{' 名前空間URI '}' ] 要素名)+

csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理）を指定している場合，またはcsc.adapter.fileOperation.transform.inputプロパティでnon-xml（入力ファイルがバイナリ形式）を指定している場合，このプロパティの指定は無視されます。

csc.adapter.fileOperation.transform.header.inElementプロパティまたはcsc.adapter.fileOperation.transform.trailer.inElementプロパティに指定した要素のパスと重複する場合はエラーとなります。

csc.adapter.fileOperation.transform.data.outElement=データレコードに対応する出力XMLファイルの要素のパス　〜＜文字列＞

データレコードに対応する出力XMLファイルの要素のパスを次の形式で指定します。

要素のパス ::= ( '/' [ '{' 名前空間URI '}' ] 要素名)+

csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理）を指定している場合，またはcsc.adapter.fileOperation.transform.outputプロパティでnon-xml（出力ファイルがバイナリ形式）を指定している場合，このプロパティの指定は無視されます。

csc.adapter.fileOperation.transform.header.outElementプロパティまたはcsc.adapter.fileOperation.transform.trailer.outElementプロパティに指定した要素のパスと重複する場合はエラーとなります。

csc.adapter.fileOperation.transform.data.styleSheet=データレコード変換用のXSLファイル名　〜＜文字列＞

データレコード変換用のXSLファイル名（ユーザ任意のファイル名）を指定します。csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理）を指定している場合，このプロパティの指定は無視されます。

csc.adapter.fileOperation.transform.data.fixedSize=データレコードの固定長サイズ　〜＜数字＞((1−2147483647))

データレコードの固定長サイズを指定します（単位：バイト）。csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理）を指定している場合，またはcsc.adapter.fileOperation.transform.inputプロパティでxml（入力ファイルがXML形式）を指定している場合，このプロパティの指定は無視されます。また，csc.adapter.fileOperation.transform.formatプロパティでseparate（入力ファイルの形式が改行セパレータ）を指定している場合，このプロパティは省略できます。

csc.adapter.fileOperation.transform.data.batchSize=1回当たりのデータレコードの変換数　〜＜数字＞((0−524288000))<<0>>

データレコードを何レコードずつ変換するか指定します。1レコード当たりのデータ量が小さいと，1レコードずつ変換するよりも複数レコードを同時に変換した方が，変換性能が向上する場合があります。詳細については，マニュアル「サービスプラットフォーム 解説」の「8.7.3　ファイル変換オペレーション」の複数のデータレコードの同時変換に関する記述を参照してください。

0を指定すると1レコードずつ変換されます（小規模データ向けの変換処理）。

1以上を指定すると，変換処理が大規模データ向けに最適化されます。

csc.adapter.fileOperation.transform.trailer.inFormat=トレーラレコード入力用のバイナリフォーマット定義ファイル名　〜＜文字列＞

トレーラレコード入力用のバイナリフォーマット定義ファイル名を指定します。

csc.adapter.fileOperation.transform.trailerRecordプロパティでON（ファイルにトレーラレコードを使用する）を指定している場合，このプロパティは省略できません。

csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理）を指定している場合，またはcsc.adapter.fileOperation.transform.inputプロパティでxml（入力ファイルがXML形式）を指定している場合，このプロパティの指定は無視されます。

csc.adapter.fileOperation.transform.trailer.outFormat=トレーラレコード出力用のバイナリフォーマット定義ファイル名　〜＜文字列＞

トレーラレコード出力用のバイナリフォーマット定義ファイル名を指定します。

csc.adapter.fileOperation.transform.trailerRecordプロパティでON（ファイルにトレーラレコードを使用する）を指定している場合，このプロパティは省略できません。

csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理）を指定している場合，またはcsc.adapter.fileOperation.transform.outputプロパティでxml（出力ファイルがXML形式）を指定している場合，このプロパティの指定は無視されます。

csc.adapter.fileOperation.transform.trailer.inElement=トレーラレコードに対応する入力XMLファイルの要素のパス　〜＜文字列＞

トレーラレコードに対応する入力XMLファイルの要素のパスを次の形式で指定します。

要素のパス ::= ( '/' [ '{' 名前空間URI '}' ] 要素名)+

入力ファイルがXML形式で，csc.adapter.fileOperation.transform.trailerRecordプロパティでON（ファイルにトレーラレコードを使用する）を指定している場合，このプロパティは省略できません。

csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理）を指定している場合，またはcsc.adapter.fileOperation.transform.inputプロパティでnon-xml（入力ファイルがバイナリ形式）を指定している場合，このプロパティの指定は無視されます。

csc.adapter.fileOperation.transform.header.inElementプロパティまたはcsc.adapter.fileOperation.transform.data.inElementプロパティに指定した要素のパスと重複する場合はエラーとなります。

csc.adapter.fileOperation.transform.trailer.outElement=トレーラレコードに対応する出力XMLファイルの要素のパス　〜＜文字列＞

トレーラレコードに対応する出力XMLファイルの要素のパスを次の形式で指定します。

要素のパス ::= ( '/' [ '{' 名前空間URI '}' ] 要素名)+

入力ファイルがXML形式で，csc.adapter.fileOperation.transform.trailerRecordプロパティでON（ファイルにトレーラレコードを使用する）を指定している場合，このプロパティは省略できません。

csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理）を指定している場合，またはcsc.adapter.fileOperation.transform.outputプロパティでnon-xml（出力ファイルがバイナリ形式）を指定している場合，このプロパティの指定は無視されます。

csc.adapter.fileOperation.transform.header.outElementプロパティまたはcsc.adapter.fileOperation.transform.data.outElementプロパティに指定した要素のパスと重複する場合はエラーとなります。

csc.adapter.fileOperation.transform.trailer.styleSheet=トレーラレコード変換用のXSLファイル名　〜＜文字列＞

トレーラレコード変換用のXSLファイル名（ユーザ任意のファイル名）を指定します。

csc.adapter.fileOperation.transform.trailerRecordプロパティでON（ファイルにトレーラレコードを使用する）を指定している場合，このプロパティは省略できません。

csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理）を指定している場合，このプロパティの指定は無視されます。

csc.adapter.fileOperation.transform.trailer.fixedSize=トレーラレコードの固定長サイズ　〜＜数字＞((1−2147483647))

トレーラレコードの固定長サイズを指定します（単位：バイト）。次に示すプロパティが両方とも設定されている場合，このプロパティは省略できません。

csc.adapter.fileOperation.transform.formatプロパティの値がfixed（入力ファイルの形式が固定長）

csc.adapter.fileOperation.transform.trailerRecordプロパティの値がON（トレーラレコードを使用する）

csc.adapter.fileOperation.transform.splitLoadプロパティでOFF（入力ファイル形式の一括処理）を指定している場合，またはcsc.adapter.fileOperation.transform.inputプロパティでxml（入力ファイルがXML形式）を指定している場合，このプロパティの指定は無視されます。また，csc.adapter.fileOperation.transform.formatプロパティでseparateを指定している場合は，このプロパティは省略できます。

csc.adapter.fileOperation.transform.all.inFormat=一括処理時の入力用のバイナリフォーマット定義ファイル名　〜＜文字列＞

一括処理時の入力用のバイナリフォーマット定義ファイル名を指定します。

csc.adapter.fileOperation.transform.splitLoadプロパティでON（入力ファイル形式の分割処理）を指定している場合，またはcsc.adapter.fileOperation.transform.inputプロパティでxml（入力ファイルがXML形式）を指定している場合，このプロパティの指定は無視されます。

csc.adapter.fileOperation.transform.all.outFormat=一括処理時の出力用のバイナリフォーマット定義ファイル名　〜＜文字列＞

一括処理時の出力用のバイナリフォーマット定義ファイル名を指定します。

csc.adapter.fileOperation.transform.splitLoadプロパティでON（入力ファイル形式の分割処理）を指定している場合，またはcsc.adapter.fileOperation.transform.outputプロパティでxml（出力ファイルがXML形式）を指定している場合，このプロパティの指定は無視されます。

csc.adapter.fileOperation.transform.all.styleSheet=一括処理時の変換用のXSLファイル名　〜＜文字列＞

一括処理時の変換用のXSLファイル名（ユーザ任意のファイル名）を指定します。

csc.adapter.fileOperation.transform.splitLoadプロパティでON（入力ファイル形式の分割処理）を指定している場合は，このプロパティの指定は無視されます。

csc.adapter.fileOperation.transform.existFile={overwrite｜error}　〜<<overwrite>>

ファイル変換オペレーション時に出力するファイルと同名のファイルが存在する場合，上書きするかどうかを指定します。

overwrite

既存の内容のファイルに上書き

error

ファイル変換を中止し例外を発行

overwriteまたはerror以外の値を指定した場合，ファイル変換を中止し，例外を発行します。

csc.adapter.fileOperation.copy.existFile={overwrite｜error}　〜<<overwrite>>

ファイル複製オペレーション時に同名のファイルが存在する場合，上書きするかどうかを指定します。

overwrite

既存の内容のファイルに上書き

error

コピーを中止し例外を発行

overwriteまたはerror以外の値を指定した場合，コピーを中止し，例外を発行します。

csc.adapter.fileOperation.move.existFile={overwrite｜error}　〜<<overwrite>>

ファイル移動オペレーション時に出力するファイルと同名のファイルが存在する場合，上書きするかどうかを指定します。

overwrite

既存の内容のファイルに上書き

error

移動を中止し例外を発行

overwriteまたはerror以外の値を指定した場合，移動を中止し，例外を発行します。

csc.adapter.fileOperation.compress.existFile={overwrite｜error}　〜<<overwrite>>

ファイル圧縮オペレーション時に出力するファイルと同名のファイルが存在する場合，上書きするかどうかを指定します。

overwrite

既存の内容のファイルに上書き圧縮

error

圧縮を中止し例外を発行

overwriteまたはerror以外の値を指定した場合，圧縮を中止し，例外を発行します。

csc.adapter.fileOperation.extract.existFile={overwrite｜error}　〜<<overwrite>>

ファイル伸張オペレーション時に出力するファイルと同名のファイルが存在する場合，上書きするかどうかを指定します。

overwrite

既存の内容のファイルに上書き伸張

error

伸張を中止し例外を発行

overwriteまたはerror以外の値を指定した場合，伸張を中止し，例外を発行します。

csc.adapter.fileOperation. writeList.existFile={overwrite｜error}　〜<<overwrite>>

ファイル一覧書き込みオペレーション時に出力するファイルと同名のファイルが存在する場合，上書きするかどうかを指定します。

overwrite

既存の内容のファイルに上書き

error

一覧書き込みを中止し例外を発行

overwriteまたはerror以外の値を指定した場合，一覧書き込みを中止し，例外を発行します。

(4)　記述例

記述例を次に示します。

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　SOAP連携で利用するファイル

3.6.1　SOAP受付定義ファイル

(1)　形式

[urecp-soap.switchover.file-transfer.mode={true｜false}]

(2)　機能

SOAP1.1/1.2併用モードで，ユーザ定義受付（SOAP受付）が呼び出された際の動作を定義するファイルです。ユーザ定義受付（SOAP受付）の開始時に設定が有効になります。不正な定義が含まれていた場合，初期化処理でエラーが発生しますが開始コマンドは正常終了します。Webサービス初期化時の動作についてはマニュアル「アプリケーションサーバ Webサービス開発ガイド」の「10.9　Webサービスの初期化と破棄」を参照してください。

なお，ユーザ定義受付（SOAP受付）に対してSOAP受付定義ファイルが設定されていない場合，SOAP受付定義ファイルで設定できるすべてのプロパティに，デフォルト値が仮定されます。

SOAP受付定義ファイルは「cscurecpsoap.properties」というファイル名で作成します。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥soaprecp¥templates¥cscurecpsoap.properties

注意事項

ここに格納されているファイルはテンプレートファイルです。SOAP受付定義ファイルを編集する場合は，ユーザ定義受付（SOAP受付）の追加時にユーザ定義受付定義画面（詳細）で［独自定義ファイル］の［編集］ボタンをクリックし，定義ファイルの内容を修正してください。

(4)　設定できるパラメタ

urecp-soap.switchover.file-transfer.mode={true｜false}　〜<<false>>

リクエスト受付時にSOAP受付が作業フォルダを作成するかどうかを設定します。大文字と小文字は区別されません。

このプロパティは添付ファイルが存在しないリクエストに対して有効です。添付ファイルが存在する場合は，必ず作業フォルダが作成されます。

true

リクエストに添付ファイルが存在するかどうかに関係なく作業フォルダが作成されます。なお，作成された作業フォルダはSOAP受付では削除されません。

false

リクエストに添付ファイルが存在する場合は作業フォルダが作成されます。それ以外の場合は，作業フォルダは作成されません。

(5)　記述例

記述例を次に示します。

urecp-soap.switchover.file-transfer.mode=true

3.6.2　クライアント定義ファイル

(1)　形式

[com.cosminexus.csc.connect.timeout=接続タイムアウト値]
[com.cosminexus.csc.request.timeout=読み込みタイムアウト値]
[com.cosminexus.csc.session.maintain={true | false}]
[com.cosminexus.csc.auto-delete-incomplete-file={true｜false}]
[com.cosminexus.csc.file.read-lock.retry.count=ロックリトライ回数]
[com.cosminexus.csc.file.read-lock.retry.interval=ロックリトライ間隔]

(2)　機能

SOAP1.1/1.2併用モードで，サービスアダプタからWebサービスを呼び出すときの動作を定義するファイルです。サービスアダプタの開始時に設定が有効になります。

クライアント定義ファイルは「cscwsconf.properties」というファイル名で作成します。

(3)　設定できるパラメタ

com.cosminexus.csc.connect.timeout=接続タイムアウト値　〜＜数字＞((0−86400))<<60>>

SOAPアダプタからサービス部品にアクセスする際のソケットの接続タイムアウト値を秒単位で指定します。0を指定した場合，タイムアウトしません。このプロパティで指定したタイムアウト値は，Webサービス呼び出し時に適用されます。

com.cosminexus.csc.request.timeout=読み込みタイムアウト値　〜＜数字＞((0−86400))<<300>>

SOAPアダプタからサービス部品にアクセスする際のソケットの読み込みタイムアウト値を秒単位で指定します。0を指定した場合，タイムアウトしません。このプロパティで指定したタイムアウト値は，Webサービス呼び出し時に適用されます。

com.cosminexus.csc.session.maintain={true｜false}　〜<<false>>

HTTPセッションの維持の有無を指定します。

true

セッションが維持されます。

false

セッションが維持されません。

com.cosminexus.csc.auto-delete-incomplete-file={true｜false}　〜<<true>>

SOAPアダプタがサービス部品から添付ファイルを受信し，作業フォルダまたは共通フォルダにファイルを出力する際にエラーが発生すると不完全なファイルが生成されます。この不完全なファイルを自動的に削除するかどうかを指定します。

true

不完全なファイルを自動的に削除します。

false

不完全なファイルを自動的に削除しません。

com.cosminexus.csc.file.read-lock.retry.count =ロックリトライ回数　〜＜数字＞((0−1024))<<0>>

共通フォルダ内のファイルの共有ロック取得失敗時のロックリトライ回数を指定します。

com.cosminexus.csc.file.read-lock.retry.interval =ロックリトライ間隔　〜＜数字＞((1−1024))<<1>>

共通フォルダ内のファイルの共有ロック失敗時のロックリトライ間隔を秒単位で指定します。

(4)　記述例

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)　注意事項

同一のプロパティを複数記述しないでください。複数記述した場合，どの値が有効になるか保証されません。

3.7　Object Accessアダプタで利用するファイル

3.7.1　Object Accessアダプタ通信構成定義ファイル

(1)　形式

(2)　機能

Object Accessアダプタの通信定義をXML形式で設定します。

Object Accessアダプタ通信構成定義ファイルは次の手順で作成し，実行環境に反映してください。Object Accessアダプタ通信構成定義ファイルの作成から，Object Accessアダプタを定義するまでの流れは，マニュアル「サービスプラットフォーム開発ガイド 受付・アダプタ定義編」の「3.3.8　Object Accessアダプタを定義する」を参照してください。

次のテンプレートファイルを基に，Object Accessアダプタ通信構成定義ファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥OA¥config¥templates¥adpoa_communication1.xml

編集後のファイルは，ファイル名「adpoa_com.xml」で保存してください。

ユーザ定義ファイル作成コマンドを実行し，定義したObject Accessアダプタ通信構成定義ファイルをjarファイルにパッケージングします。

HCSC開発環境でパッケージングし，実行環境へインポートします。

Object Accessアダプタ通信構成定義ファイルの定義内容を変更した場合は，手順2〜3を実行して，実行環境へインポートしてください。

(3)　設定できる要素

<?xml version="1.0" encoding="UTF-8"?>

このファイルがXMLファイルであることを示すXML宣言です。

<adapteroa_properties>

Object Accessアダプタ通信構成定義のルート要素です。

<communication1>

オブジェクトアダプタにBOA，オブジェクト間通信にスマートエージェントを利用する通信管理要素です。1つだけ定義できます。指定は省略できません。

<operation>

IDLのオペレーションを指定する要素です。この要素はオペレーションの数だけ定義できます。指定は省略できません。

<op_name>

オペレーション名称を指定する要素です。この要素の値には，HCSC開発環境に指定するオペレーション名称を指定してください。指定は省略できません。

なお，指定した値の正誤はチェックされません。Object Accessアダプタでは，この要素の値として「exec2」を指定します。

<method_name>

IDLのメソッド名称を指定する要素です。この要素の値には，<op_name>要素で指定したオペレーション名称に対応するIDLのオペレーション宣言のメソッド名称を指定してください。指定は省略できません。

なお，オペレーション名称とメソッド名称の対応や，指定値の正誤はチェックされません。Object Accessアダプタでは，この要素の値には「exec2」を指定します。

<return_watch_time>　〜＜符号なし数字＞((0−1800000))<<180000>>

リクエスト要求に対する応答監視時間を指定する要素です。この要素の値には，Object Accessアダプタが通信先のオブジェクトに対してリクエスト要求を開始してから，応答が返るまでの待ち時間の最大値をミリ秒単位で指定してください。指定は省略できます。

0を指定した場合は，応答を受信するまで無限に待ちます。

<bind_type>　〜{Type1｜Type2}<<Type1>>

スマートエージェントへのバインド形態を指定する要素です。この要素の値には，スマートエージェントへのバインド形態のタイプを次の中から指定してください。指定は省略できます。

Type1

通信相手が複数存在し，負荷分散したい場合に指定します。

Type2

通信相手が1か所の場合に指定します。

<object_name>

オブジェクト名称を指定する要素です。この要素の値には，ORBオブジェクトを識別するオブジェクト名称を指定してください。指定は省略できません。

なお，指定値の正誤はチェックされません。

<connect_watch_time>　〜＜符号なし数字＞((0−1800000))<<0>>

コネクション確立監視時間を指定する要素です。この要素の値には，通信先のオブジェクトに対してコネクション確立の要求を開始してから，応答が返るまでの待ち時間の最大値をミリ秒単位で指定してください。指定は省略できます。

0を指定した場合は，コネクションが確立するまで無限に待ち続けます。

<repository_id>

インタフェースのリポジトリIDを指定する要素です。この要素の値には，IDLのインタフェースのリポジトリIDを指定してください。リポジトリIDについては，マニュアル「Borland(R) Enterprise Server VisiBroker(R) デベロッパーズガイド」を参照してください。指定は省略できません。

なお，指定値の正誤はチェックされません。Object Accessアダプタではこの要素の値に「IDL:OWB2:1.0」を指定します。

<host_name>

ホスト名称を指定する要素です。この要素の値には，ORBオブジェクトを探すホスト名称を識別する文字列またはIPアドレスを指定してください。指定は省略できます。

なお，指定値の正誤はチェックされません。

<interface_id>　〜＜英数字＞((1−50文字))

インタフェースIDを指定する要素です。通信インタフェースファイル作成コマンドの-interfaceidに指定したインタフェースIDを指定します。指定は省略できません。

(4)　記述例

要素の指定値を省略する場合は，各要素の開始タグと終了タグを含めて省略します。開始タグおよび終了タグだけを記述しても値を省略できません。<connect_watch_time>の指定を省略する場合の記述例を次に示します。

正しい記述方法

　　：
<object_name>Object001</object_name>
<repository_id>IDL:OWB2:1.0</repository_id>
　　：

誤った記述方法（<connect_watch_time>の指定値がない）

　　：
<object_name>Object001</object_name>
<connect_watch_time></ connect_watch_time >
<repository_id>IDL:OWB2:1.0</repository_id>
　　：

3.8　Message Queueアダプタで利用するファイル

3.8.1　Message Queueアダプタ環境定義ファイル

(1)　形式

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
  <entry key="adpmq_deffile">Message Queueアダプタ通信構成定義ファイル名称</entry>
</properties>

(2)　機能

Message Queueアダプタの環境定義情報をXML形式で設定します。

Message Queueアダプタ環境定義ファイルは次の手順で作成し，実行環境に反映してください。

次のテンプレートファイルを任意のディレクトリにコピーし，Message Queueアダプタ環境定義ファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥MQ¥config¥templates¥customadapter_properties.xml

編集後のファイルは，ファイル名「customadapter_properties.xml」で保存してください。

定義したMessage Queueアダプタ環境定義ファイルをHCSC開発環境でパッケージングし，実行環境へインポートします。

Message Queueアダプタ環境定義ファイルの定義内容を変更した場合は，手順2を実行して実行環境へインポートしてください。

(3)　設定できる要素

<?xml version="1.0" encoding="UTF-8"?>

このファイルがXMLファイルであることを示すXML宣言です。

<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">

DTDサブセットを示す要素型定義宣言です。

<properties>

Message Queueアダプタ環境定義のルート要素です。

<entry key="adpmq_deffile">　〜＜Message Queueアダプタ通信構成定義ファイル名称＞

Message Queueアダプタ通信構成定義ファイル名称を指定する要素です。この要素の値には，実行環境での通信構成を記述したMessage Queueアダプタの通信構成定義ファイル名称を記述してください。Message Queueアダプタの通信構成定義ファイルについては，「3.8.2　Message Queueアダプタ通信構成定義ファイル」を参照してください。

3.8.2　Message Queueアダプタ通信構成定義ファイル

(1)　形式

(2)　機能

Message Queueアダプタの通信定義をXML形式で設定します。通信定義には次の種類があります。

メッセージ送信用オペレーション定義

メッセージ受信用オペレーション定義

メッセージ送受信用オペレーション定義

ブラウズ・メッセージ受信用オペレーション定義

Message Queueアダプタ通信構成定義ファイルは次の手順で作成し，実行環境に反映してください。

次のテンプレートファイルを任意のディレクトリにコピーし，Message Queueアダプタ通信構成定義ファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥MQ¥config¥templates¥adpmq_communication.xml

編集後のファイルは任意のファイル名で保存してください。

HCSC開発環境でパッケージングし，実行環境へインポートします。

作成したMessage Queueアダプタ通信構成定義ファイルのファイル名は，Message Queueアダプタ環境定義ファイルの<entry key="adpmq_deffile">要素の値として指定する必要があります。詳細については，「3.8.1　Message Queueアダプタ環境定義ファイル」を参照してください。

Message Queueアダプタ通信構成定義ファイルの定義内容を変更した場合は，手順2を実行して実行環境へインポートしてください。

(3)　設定できる要素

<?xml version="1.0" encoding="UTF-8"?>

このファイルがXMLファイルであることを示すXML宣言です。

<adaptermq_properties>

Message Queueアダプタ通信構成定義のルート要素です。

<res_ref_name>　〜＜英数字，階層区切り文字＞((1−255バイト))

リソースアダプタ特定情報を指定します。この要素の値には，アプリケーション統合属性ファイルの<hitachi-session-bean-property>に含まれる<res-ref-name>要素の内容と「jms/」を含めて同じ値を指定してください。指定は省略できません。

アプリケーション統合属性ファイルの指定値と合わせる定義項目については，アプリケーション統合属性ファイルの指定方法に従ってください。アプリケーション統合属性ファイルの指定方法は，マニュアル「アプリケーションサーバ リファレンス 定義編(アプリケーション／リソース定義)」を参照してください。

<operation>

オペレーション要素です。この要素はオペレーションの数だけ定義できます。指定は省略できません。

<op_name>　〜＜英数字＞((1−256バイト))

オペレーション名を指定する要素です。この要素の値には，HCSC開発環境に指定するオペレーション名を指定してください。指定は省略できません。

<char_code>　〜{UTF8｜UTF16_BIG｜UTF16_LITTLE｜MS932｜JIS｜KEIS+EBCDIC｜KEIS+EBCDIK}<<UTF8>>

バイナリ入力形式のメッセージ送信要求電文またはメッセージ送受信要求電文に送信キュー特定情報および受信キュー特定情報を指定する場合，文字コードを指定します。指定は省略できます。

<send_operation>

メッセージ送信を指定する要素です。指定は省略できます。

メッセージ送信定義を設定する場合は必ず指定してください。

<receive_operation>

メッセージ受信を指定する要素です。指定は省略できます。

メッセージ受信定義を設定する場合は必ず指定してください。

<sndrcv_operation>

メッセージ送受信を指定する要素です。指定は省略できます。

メッセージ送受信定義を設定する場合は必ず指定してください。

<browse_operation>

ブラウズ・メッセージ受信を指定する要素です。指定は省略できます。

ブラウズ・メッセージ受信定義を設定する場合は必ず指定してください。

<res_name>　〜＜英数字，階層区切り文字＞((1−255バイト))<<要求電文設定情報>>

送信キュー特定情報または受信キュー特定情報を指定します。この要素の値には，アプリケーション統合属性ファイルの<hitachi-session-bean-property>に含まれる<resource-env-ref-name>要素内容と同じ値を指定してください。

要求電文で送信キュー特定情報または受信キュー特定情報を指定する場合は，指定を省略できます。

アプリケーション統合属性ファイルの指定値と合わせる定義項目については，アプリケーション統合属性ファイルの指定方法に従ってください。アプリケーション統合属性ファイルの指定方法は，マニュアル「アプリケーションサーバ リファレンス 定義編(アプリケーション／リソース定義)」を参照してください。

<res_inf>

メッセージ送受信要求を実行する場合，送信キュー特定情報（<snd_res_name>）および受信キュー特定情報（<rcv_res_name>）要素を指定します。指定は省略できます。

指定する場合は，送信キュー特定情報と受信キュー特定情報の両方を指定してください。一方だけは指定できません。

<snd_res_name>　〜＜英数字，階層区切り文字＞((1−255バイト))<<要求電文設定情報>>

送信キュー特定情報を指定します。この要素の値には，アプリケーション統合属性ファイルの<hitachi-session-bean-property>に含まれる<resource-env-ref-name>要素内容と同じ値を指定してください。

要求電文で送信キュー特定情報を指定する場合は，指定を省略できます。

アプリケーション統合属性ファイルの指定値と合わせる定義項目については，アプリケーション統合属性ファイルの指定方法に従ってください。アプリケーション統合属性ファイルの指定方法は，マニュアル「アプリケーションサーバ リファレンス 定義編(アプリケーション／リソース定義)」を参照してください。

<rcv_res_name>　〜＜英数字，階層区切り文字＞((1−255バイト))<<要求電文設定情報>>

受信キュー特定情報を指定します。この要素の値には，アプリケーション統合属性ファイルの<hitachi-session-bean-property>に含まれる<resource-env-ref-name>要素と同じ値を指定してください。

要求電文で受信キュー特定情報を指定する場合は，指定を省略できます。

アプリケーション統合属性ファイルの指定値と合わせる定義項目については，アプリケーション統合属性ファイルの指定方法に従ってください。アプリケーション統合属性ファイルの指定方法は，マニュアル「アプリケーションサーバ リファレンス 定義編(アプリケーション／リソース定義)」を参照してください。

<id_type>　〜{Type1 | Type2}<<Type1>>

メッセージ相関識別子を設定するかどうかを次の中から指定します。指定は省略できます。

Type1

メッセージ相関識別子を設定しません。

Type2

メッセージ相関識別子を設定します。

メッセージ送信要求の場合と，ブラウズ・メッセージ受信またはメッセージ受信要求の場合とで，次のように動作が異なります。

値

メッセージ送信要求の場合

メッセージ受信またはブラウズ・メッセージ受信要求の場合

Type1

メッセージ相関識別子を設定しないでメッセージを送信します。

メッセージ相関識別子を設定しないでメッセージを受信します。

Type2

JMSCorrelationIDにメッセージ相関識別子を設定してメッセージを送信します。メッセージ識別子はMessage Queueアダプタが自動的に生成します。

ユーザ指定のメッセージ識別子（CorrelationID）を設定してメッセージを受信します。

<message_type>　〜{BytesMessage | TextMessage}<<BytesMessage>>

送信用メッセージタイプを指定します。指定は省略できます。

BytesMessage

javax.jms.BytesMessageで送信します。

TextMessage

javax.jms.TextMessageで送信します。ただし，メッセージ送信要求（要求電文）がバイナリ形式の場合はエラーとなります。

<JMSDeliveryMode>　〜{PERSISTENT | NONPERSISTENT}<<PERSISTENT>>

送信メッセージの永続性の有無を指定します。指定は省略できます。

PERSISTENT

永続性ありを指定します。キューマネージャ再開始後，送信キューにメッセージが残ります。

NONPERSISTENT

永続性なしを指定します。キューマネージャ再開始後，送信キューにメッセージが残りません。

<JMSExpiration>　〜＜数字＞((0−65535000))<<0>>

送信メッセージ送信時の保持時間をミリ秒単位で指定します。指定は省略できます。

指定を省略するか0を指定した場合，メッセージが取得されるまで送信キューに保持し続けます。

なお，1秒未満の時間を指定すると，0ミリ秒と解釈される場合があります。JMSプロバイダの仕様を確認してください。

<JMSType>　〜＜英数字＞

メッセージタイプを指定します。この要素の値に，送受信するメッセージを特定するメッセージタイプを指定してください。指定は省略できます。

リソースアダプタのQueueプロパティのtargetClient指定に「MQ」を指定した場合，この指定は有効となりません。

<JMSCorrelID_PFX>　〜＜英数字＞((1−6バイト))

メッセージ相関識別子（CorrelationID）のプリフィックスを指定します。指定は省略できます。

この要素の値には，メッセージ相関識別子のプリフィックスを指定してください。この要素の値は，メッセージ送信要求またはメッセージ送受信要求で，<id_type>要素が「Type2」の場合に有効となります。

<receive_timeout>　〜＜数字＞((1000−65535000))<<180000>>

メッセージ応答監視時間をミリ秒単位で指定します。指定は省略できます。

この要素の値には，メッセージの受信が完了するまでの時間を指定します。この要素の値の時間内にメッセージを受信できない場合は，Fault応答情報が返ります。

(4)　記述例

要素の指定値を省略する場合は，各要素の開始タグおよび終了タグを含めて省略してください。開始タグおよび終了タグだけを記述しても，値の省略やタグ内の定義順序の変更はできません。

正しい記述方法

　　：
<JMSExpiration>0</JMSExpiration>
<JMSDeliveryMode>PERSISTENT</JMSDeliveryMode>
　　：

誤った記述方法（<JMSDeliveryMode>の指定値がない）

　　：
<JMSExpiration>0</JMSExpiration>
<JMSDeliveryMode></JMSDeliveryMode>
　　：

3.9　Message Queue受付で利用するファイル

3.9.1　Message Queue受付定義ファイル

(1)　形式

　resource-adapter=Message Queue受付が使用するMQリソースアダプタの表示名
［pooled-instance.minimum=カスタム受付フレームワークのプール内インスタンスの最小数］
［pooled-instance.maximum=Message Queue受付およびカスタム受付フレームワークのプール内インスタンスの最大数］
［ejb-transaction-timeout=Message Queue受付およびカスタム受付フレームワークのEJBトランザクションタイムアウト時間］
　activation-config.destination=メッセージを受信する宛先
　activation-config.username=キューマネージャ接続時のデフォルトユーザ名
［activation-config.ccdtURL=プロパティ値］
［activation-config.CCSID=プロパティ値］
［activation-config.channel=プロパティ値］
［activation-config.clientID=プロパティ値］
［activation-config.failIfQuiesce=プロパティ値］
［activation-config.headerCompression=プロパティ値］
［activation-config.hostName=プロパティ値］
［activation-config.localAddress=プロパティ値］
［activation-config.messageBatchSize=プロパティ値］
［activation-config.messageCompression=プロパティ値］
［activation-config.messageRetention=プロパティ値］
［activation-config.password=プロパティ値］
［activation-config.pollingInterval=プロパティ値］
［activation-config.port=プロパティ値］
［activation-config.providerVersionプロパティ値］
［activation-config.queueManager=プロパティ値］
［activation-config.rescanInterval=プロパティ値］
［activation-config.shareConvAllowed=プロパティ値］
［activation-config.transportType=プロパティ値］
［activation-config.maxMessages=プロパティ値］
［activation-config.maxPoolDepth=プロパティ値］
［activation-config.messageSelector=プロパティ値］
［activation-config.poolTimeout=プロパティ値］
［activation-config.readAheadAllowed=プロパティ値］
［activation-config.readAheadClosePolicy=プロパティ値］
［activation-config.startTimeout=プロパティ値］
［activation-config.useJNDI=プロパティ値］

(2)　機能

Message Queue受付の動作情報を設定します。

Message Queue受付開始時に，Message Queue受付定義ファイルに設定した内容が有効になります。

なお，Message Queue受付に対してMessage Queue受付定義ファイルが設定されていない場合，Message Queue受付の配備時にエラーになります。

Message Queue受付定義ファイルは「cscurecpmq.properties」というファイル名で作成します。「cscurecpmq.properties」以外のファイル名で作成した場合，そのファイルは無視されます。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-reception¥mq¥config¥templates¥cscurecpmq.properties

(4)　設定できるプロパティ

resource-adapter=Message Queue受付が使用するMQリソースアダプタの表示名　〜＜英数字およびアンダーバー（_）＞((1−240文字))

Message Queue受付が使用するMQリソースアダプタの表示名を指定します。

pooled-instance.minimum=カスタム受付フレームワークのプール内インスタンスの最小数　〜＜数字＞((0または1−2147483647))<<0>>

カスタム受付フレームワークのプール内インスタンスの最小数を整数で指定します。0を指定した場合，制限はありません。

pooled-instance.maximum=Message Queue受付およびカスタム受付フレームワークのプール内インスタンスの最大数　〜＜数字＞((0または1−2147483647))<<0>>

Message Queue受付およびカスタム受付フレームワークのプール内インスタンスの最大数を整数で指定します。0を指定した場合，受付処理のプール内のインスタンスの最大数には，1が設定されます。

ejb-transaction-timeout=Message Queue受付およびカスタム受付フレームワークのEJBトランザクションタイムアウト時間　〜＜数字＞((0または1−2147483647))<<0>>

Message Queue受付およびカスタム受付フレームワークのEJBトランザクションタイムアウト時間を秒単位で指定します。0を指定した場合，J2EEサーバに設定されたデフォルトのタイムアウト値で動作します。

activation-config.destination=メッセージを受信する宛先　〜＜英数字および記号＞

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「destination」に値を設定します。プロパティ値には，メッセージを受信する宛先（IBM MQで作成したキュー名称）を指定します。

activation-config.username=キューマネージャ接続時のデフォルトユーザ名　〜＜英数字および記号＞<<null>>

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「username」に値を設定します。プロパティ値には，キューマネージャへ接続するときに使用するデフォルトユーザ名を指定します。

activation-config.ccdtURL=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「ccdtURL」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

クライアントチャネル定義テーブルが格納されているファイルの名前と場所を識別し，このファイルのアクセス方法を指定します。

activation-config.CCSID=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「CCSID」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.channel=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「channel」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.clientID=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「clientID」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.failIfQuiesce=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「failIfQuiesce」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.headerCompression=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「headerCompression」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.hostName=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「hostName」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.localAddress=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「localAddress」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.messageBatchSize=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「messageBatchSize」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.messageCompression=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「messageCompression」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.messageRetention=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「messageRetention」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.password=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「password」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.pollingInterval=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「pollingInterval」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.port=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「port」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.providerVersion= プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「providerVersion」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.queueManager=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「queueManager」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.rescanInterval=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「rescanInterval」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.shareConvAllowed=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「shareConvAllowed」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.transportType=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「transportType」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.maxMessages=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「maxMessages」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.maxPoolDepth=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「maxPoolDepth」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.messageSelector=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「messageSelector」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.poolTimeout=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「poolTimeout」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.readAheadAllowed=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「readAheadAllowed」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.readAheadClosePolicy=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「readAheadClosePolicy」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.startTimeout=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「startTimeout」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

activation-config.useJNDI=プロパティ値

IBM MQとの接続で使用されるActivationSpecオブジェクトのプロパティ「useJNDI」に値を設定します。プロパティ値に指定できる値など，このプロパティの詳細は，IBM MQのマニュアルを参照してください。

3.10　HTTPアダプタで利用するファイル

3.10.1　HTTPアダプタ定義ファイル

(1)　形式

［adphttp.protocol.follow-redirect={true｜false}］
［adphttp.protocol.encoding-type=エンコーディング形式］
［adphttp.protocol.connect-timeout=接続タイムアウト時間］
［adphttp.protocol.read-timeout=読み込みタイムアウト時間］
［adphttp.protocol.chunked-encoding-size=チャンクサイズ］
［adphttp.protocol.https-server-authentication={true｜false}］
［adphttp.protocol.https-hostname-verification={true｜false}］

［adphttp.file.read-lock.retry.count=共有ロック取得失敗時のロックリトライ回数］
［adphttp.file.read-lock.retry.interval=共有ロック取得失敗時のロックリトライ間隔］

［adphttp.data-size-limit.body-message=HTTPレスポンスボディの最大サイズ］
［adphttp.data-size-limit.file=ファイルの最大サイズ］

［adphttp.response-code.normal=正常処理として扱うステータスコード］
［adphttp.response-code.fault=フォルト処理として扱うステータスコード］

［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)　機能

HTTPアダプタの動作情報を設定します。

HTTPアダプタ定義ファイルは「cscadphttp.properties」というファイル名で作成します。

HTTPアダプタの開始時に，HTTPアダプタ定義ファイルに設定した内容が有効になります。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥HTTP¥config¥templates¥cscadphttp.properties

注意事項

ここに格納されているファイルはテンプレートファイルです。このテンプレートファイルを任意のディレクトリにコピーしたあとファイルを編集し，定義ファイルを作成してください。

(4)　設定できるプロパティ

(a)　プロトコル動作指定関連

adphttp.protocol.follow-redirect={true｜false}　〜<<false>>

リダイレクト機能を使うかどうかを指定します。大文字と小文字は区別されません。

true

リダイレクト機能を使用します。

false

リダイレクト機能を使用しません。

HTTPアダプタのリダイレクト機能は，V9互換モードでは使用できません。リダイレクト機能については，マニュアル「サービスプラットフォーム 解説」の「2.16.11　HTTPアダプタのリダイレクト」を参照してください。

adphttp.protocol.encoding-type=エンコーディング形式　〜((gzip))

送受信するHTTPボディのエンコーディング形式を指定します。指定できるエンコーディング形式は「gzip」だけです。大文字と小文字は区別されません。デフォルトではエンコーディング形式は定義されません。

gzip

HTTPボディが自動でエンコードされます。

gzip形式でHTTPボディを送受信する場合だけ指定してください。gzip形式でHTTPボディを送受信しない場合は，プロパティをコメントアウトまたは削除してください。

adphttp.protocol.connect-timeout=接続タイムアウト時間　〜＜数字＞((0または1−2147483647))<<60000>>

接続タイムアウト時間をミリ秒単位で指定します。値に0を指定した場合はタイムアウトしません。

adphttp.protocol.read-timeout=読み込みタイムアウト時間　〜＜数字＞((0または1−2147483647))<<300000>>

読み込みタイムアウト時間をミリ秒単位で指定します。値に0を指定した場合はタイムアウトしません。

adphttp.protocol.chunked-encoding-size=チャンクサイズ　〜＜数字＞((0または1−2147483647))<<0>>

java.net.HttpURLConnection#setChunkedStreamingMode(Integer)に設定する値を指定します。ただし，指定した値でチャンク送信されるかはJDKの動作に依存します。値を設定しない（チャンク送信しない）場合は0を指定するか，またはコメントアウトしてください。

チャンク送信する設定にした場合，ベーシック認証は無効になります。また，リダイレクト処理は使用できません。

チャンクサイズは通常は「4096」を指定し，必要に応じて値を増減してください。任意の値を指定する場合は，使用する環境に合わせて次の点に注意してください。

チャンクサイズに極端に小さな値（1桁の数字など）を設定した場合は，チャンク送信されない場合があります。

チャンクサイズを小さくし過ぎると，チャンクエンコーディングに伴うオーバーヘッドが大きくなります。

チャンクサイズを大きくし過ぎると，メモリが不足しエラーが発生します。

adphttp.protocol.https-server-authentication={true｜false}　〜<<true>>

HTTPS通信時にサーバ認証をするかどうかを指定します。大文字と小文字は区別されません。

true

HTTPS通信時にサーバ認証をします。

false

HTTPS通信時にサーバ認証をしません。

adphttp.protocol.https-hostname-verification={true｜false}　〜<<true>>

HTTPS通信時にホスト名を検証するかどうかを指定します。大文字と小文字は区別されません。

true

HTTPS通信時にホスト名を検証します。

false

HTTPS通信時にホスト名を検証しません。

(b)　ファイルアクセス排他取得関連

adphttp.file.read-lock.retry.count=共有ロック取得失敗時のロックリトライ回数　〜＜数字＞((0−1024))<<0>>

共通フォルダの共有ロック取得失敗時のロックリトライ回数を指定します。

adphttp.file.read-lock.retry.interval=共有ロック取得失敗時のロックリトライ間隔　〜＜数字＞((1−1024))<<1>>

共通フォルダの共有ロック取得失敗時のロックリトライ間隔を秒単位で指定します。

(c)　データサイズ制限関連

adphttp.data-size-limit.body-message=HTTPレスポンスボディの最大サイズ　〜＜数字＞((-1−2147483647))<<-1>>

HTTPレスポンスを応答電文（ボディ）に設定する際に許容するデータの最大サイズをバイト単位で指定します。値に-1を指定した場合はサイズが制限されません。

adphttp.data-size-limit.file=ファイルの最大サイズ　〜＜数字＞((-1−2147483647))<<-1>>

HTTPレスポンスをファイルに書き出す際に許容するデータの最大サイズをバイト単位で指定します。値に-1を指定した場合はサイズが制限されません。

(d)　レスポンスコード関連

adphttp.response-code.normal=正常処理として扱うステータスコード　〜＜3桁のステータスコード＞<<200>>

正常処理として扱う3桁のステータスコードを指定します。指定したステータスコードのHTTPレスポンスがHTTPアダプタに返ると応答電文で処理されます。

ステータスコードは判定基準に従って，正常処理，フォルト処理，システム例外として扱われます。判定基準については，マニュアル「サービスプラットフォーム 解説」の「2.16.4　HTTPレスポンスと応答電文の関係」の，ステータスコードの正常処理またはフォルト処理の設定に関する説明を参照してください。

複数のステータスコードを指定する場合は，正規表現で指定します。200番台のステータスコードを正常処理として扱う場合の設定例を次に示します。

adphttp.response-code.normal=2[0-9][0-9]

正常処理またはフォルト処理のどちらにも設定していないステータスコードがHTTPアダプタに渡された場合はシステム例外となります。項目が省略された場合，または値が省略された場合は，デフォルト値で動作します。

adphttp.response-code.fault=フォルト処理として扱うステータスコード　〜＜3桁のステータスコード＞

フォルト処理として扱う3桁のステータスコードを指定します。ここで指定したステータスコードのHTTPレスポンスがHTTPアダプタに返ると，フォルト電文で処理されます。指定を省略した場合，ステータスコードは設定されません。

ステータスコードは判定基準に従って，正常処理，フォルト処理，システム例外として扱われます。判定基準については，マニュアル「サービスプラットフォーム 解説」の「2.16.4　HTTPレスポンスと応答電文の関係」の，ステータスコードの正常処理またはフォルト処理の設定に関する説明を参照してください。

複数のステータスコードを指定する場合は，正規表現で指定します。adphttp.response-code.normalプロパティで指定したステータスコード以外のすべてのステータスコードをフォルト応答にする場合の設定例を次に示します。

adphttp.response-code.fault=[1-9][0-9][0-9]

正常処理またはフォルト処理のどちらにも設定していないステータスコードがHTTPアダプタに渡された場合は，システム例外となります。

(e)　拡張機能関連

adphttp.auto-delete-incomplete-file={true｜false}　〜<<true>>

ネットワーク障害やI/Oエラー，データサイズ制限の超過などの理由で共通フォルダや作業フォルダに不完全な受信ファイルが生成された場合に，受信ファイルを自動的に削除するか指定します。大文字と小文字は区別されません。

true

不完全な受信ファイルを自動的に削除します。

false

不完全な受信ファイルを自動的に削除しません。

不完全な受信ファイルによるストレージの消費を防止する場合はtrue，障害発生時の状態の保存（保持）を優先する場合はfalseを選択してください。

不完全な受信ファイルを自動的に削除しない場合は，ストレージの空き容量が枯渇しないように，必要に応じて手動で不要なファイルを削除してください。削除方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.4.20　作業フォルダを削除する」，および「5.4.22　共通フォルダ内のファイルを削除する」を参照してください。

(f)　JSON-XML変換関連

adphttp.request.switchover.json-transfer.mode={true｜false}　〜<<false>>

HTTPアダプタのリクエスト処理時にJSON-XML変換をするかどうかを指定します。

true

HTTPアダプタのリクエスト処理時にJSON-XML変換をします。

false

HTTPアダプタのリクエスト処理時にJSON-XML変換をしません。

adphttp.response.switchover.json-transfer.mode={true｜false}　〜<<false>>

HTTPアダプタのレスポンス処理時にJSON-XML変換をするかどうかを指定します。

true

HTTPアダプタのレスポンス処理時にJSON-XML変換をします。

false

HTTPアダプタのレスポンス処理時にJSON-XML変換をしません。

(g)　OAuth 2.0認証関連

adphttp.oauth.authentication={true｜false}　〜<<false>>

HTTPアダプタ実行時にOAuth 2.0の認証フローを使用するかどうかを指定します。

true

HTTPアダプタ実行時にOAuth 2.0の認証フローを使用します。

false

HTTPアダプタ実行時にOAuth 2.0の認証フローを使用しません。

注意事項

OAuth 2.0の認証フローを使用する場合は，trueを指定しないと認証情報が不正になります。認証情報が不正な場合，HTTPリクエストがエラー応答したり，応答電文（ヘッダ）にアクセストークンが格納されなかったりすることがあります。

(5)　記述例

記述例を次に示します。

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)　注意事項

プロパティファイルは文字コードをUTF-8にして保存してください。UTF-8以外の文字コードを使用した場合，設定値を正しく解釈できない場合があります。

3.11　HTTP受付で利用するファイル

3.11.1　HTTPレスポンスヘッダ定義ファイル

(1)　形式

<キー名称>=<値>

(2)　機能

HTTP受付の応答電文フォーマット（ヘッダ変数用）を省略した場合のデフォルト値として使用するHTTPレスポンスヘッダ情報を設定します。HTTP受付定義ファイルから呼び出される任意のファイルです。

HTTPレスポンスヘッダ定義ファイルを作成する際の注意事項を次に示します。

HTTPレスポンスヘッダ定義ファイルが空の場合，またはHTTP受付定義ファイルにhttprecp.response.header.filenameプロパティを設定していない場合の動作については，マニュアル「サービスプラットフォーム 解説」の「2.15.5　HTTP受付のレスポンス処理」を参照してください。

HTTP受付定義ファイルのhttprecp.response.header.filenameプロパティの値が空の場合，または値と一致するHTTPレスポンスヘッダ定義ファイルがリポジトリにない場合はエラーが発生します。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-reception¥http¥config¥templates¥cscurecphttp_header.properties

注意事項

ここに格納されているファイルはテンプレートファイルです。HTTPレスポンスヘッダ定義ファイルを編集する場合は，HTTP受付の追加時にユーザ定義受付定義画面（詳細）で［独自定義ファイル］の［編集］ボタンをクリックし，定義ファイルの内容を修正してください。

(4)　記述例

記述例を次に示します。

Connection=close
extension-header=extension-header1

3.11.2　HTTP受付サービス選択定義ファイル

(1)　形式

<HTTPメソッド名>［,<ホスト名>］=<ビジネスプロセス名>

(2)　機能

ユーザ定義受付（呼出先選択）であるHTTP受付の場合に，HTTP受付から呼び出すビジネスプロセス，およびビジネスプロセスを呼び出す条件を設定します。このファイルは，開発環境のユーザ定義受付定義画面でユーザ定義受付（呼出先選択）のHTTP受付を定義する際に，独自定義ファイルとして設定します。

ユーザ定義受付（呼出先選択）のHTTP受付の定義手順については，マニュアル「サービスプラットフォーム 開発ガイド 受付・アダプタ定義編」の「付録L　ユーザ定義受付（呼出先選択）の定義」を参照してください。ユーザ定義受付定義画面の設定項目については，「1.2.5(3)　受付種別「TP1/RPC受付」，「FTP受付」，「HTTP受付」，「Message Queue受付」，「ファイルイベント受付」，「Kafka受付」，「スケジュール駆動受付」，「カスタム受付」の場合」を参照してください。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-reception¥http¥config¥templates¥cscurecphttp_selection.properties

注意事項

ここに格納されているファイルはテンプレートファイルです。HTTP受付サービス選択定義ファイルを編集する場合は，ユーザ定義受付（呼出先選択）であるHTTP受付の追加時にユーザ定義受付定義画面（詳細）で［独自定義ファイル］の［編集］ボタンをクリックし，定義ファイルの内容を修正してください。

(4)　設定できるプロパティ

<HTTPメソッド名>［,<ホスト名>］

HTTP受付から呼び出すビジネスプロセスの条件として，HTTPメソッド，またはHTTPメソッドおよびホストを指定します。

ホスト名の指定は，大文字小文字を区別します。

<ビジネスプロセス名>

HTTP受付から呼び出すビジネスプロセスの名称を指定します。

(5)　記述例

記述例を次に示します。

HTTPメソッドおよびホストをキーとして設定する場合

PUT,GyoumuKanri.hitachi.co.jp=BP1
DELETE,GyoumuKanri.hitachi.co.jp=BP2
GET,GyoumuKanri.hitachi.co.jp=BP3

HTTPメソッドをキーとして設定する場合

PUT=BP1
DELETE=BP2
GET=BP3

(6)　注意事項

ユーザ定義受付（呼出先選択）として定義したHTTP受付から，HTTP受付サービス選択定義ファイルを削除しないでください。削除した場合の動作は保証しません。

ユーザ定義受付（呼出先固定）として定義したHTTP受付に対し，HTTP受付サービス選択定義ファイルを追加しないでください。追加した場合の動作は保証しません。

3.11.3　HTTP受付定義ファイル

(1)　形式

［urecp-http.context-root=HTTP受付のコンテキストルート］
［urecp-http.max-threads=HTTP受付の最大同時実行スレッド数］
［urecp-http.exclusive-threads=HTTP受付の占有実行スレッド数］
［urecp-http.queue-size=HTTP受付の実行待ちキューのサイズ］
［urecp-http.pooled-instance.minimum=HTTP受付のプール内のインスタンスの最小数］
［urecp-http.pooled-instance.maximum=HTTP受付のプール内のインスタンスの最大数］
［urecp-http.ejb-transaction-timeout=HTTP受付のEJBトランザクションタイムアウト時間］

［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レスポンスヘッダ定義ファイルの名称］
［httprecp.system-exception.status-code=システム例外時のステータスコード］
［httprecp.response.generate.content-length={true｜false}］
［httprecp.file-trans.temp-file.partsize-threshold=一時ファイルを出力する閾値サイズ］
［httprecp.file-trans.maxsize.part=受信できるファイルデータの1ファイル当たりの上限サイズ］
［httprecp.file-trans.maxsize.request=受信できるHTTPリクエストボディの上限サイズ］
［httprecp.work-dir.auto-delete={true｜false}］
［httprecp.response.download.disposition-type=HTTPレスポンスヘッダのContent-Dispositionヘッダに設定する値］
［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-pattern<URLパターン識別番号>=リクエストURLのURLパターン］
［httprecp.response.compression.rule<圧縮規則識別番号>.url-mapping<URLマッピング識別番号>=HTTPレスポンス圧縮規則のURLパターン］
［httprecp.response.compression.rule<圧縮規則識別番号>.condition<圧縮条件識別番号>=メディアタイプ:圧縮しきい値］

［httprecp.use-routing-definition={true｜false}］

(2)　機能

HTTP受付の動作情報を設定します。HTTP受付開始時にHTTP受付定義ファイルに設定した内容が有効になります。

HTTP受付定義ファイルは「cscurecphttp.properties」というファイル名で作成します。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-reception¥http¥config¥templates¥cscurecphttp.properties

注意事項

ここに格納されているファイルはテンプレートファイルです。HTTP受付定義ファイルを編集する場合は，HTTP受付の追加時にユーザ定義受付定義画面（詳細）で［独自定義ファイル］の［編集］ボタンをクリックし，定義ファイルの内容を修正してください。

(4)　設定できるプロパティ

(a)　HTTP受付関連

urecp-http.context-root=HTTP受付のコンテキストルート　〜<<HTTP受付の受付ID>>

HTTP受付のコンテキストルートを半角英数字および次に示す半角記号で指定します。

ハイフン（-）

ピリオド（.）

アンダーバー（_）

波ダッシュ（~）

スラッシュ（/）

アットマーク（@）

プラス（+）

ドル（$）

感嘆符（!）

引用符（'）

丸括弧（()）

パーセント（%）

上記以外の文字を指定した場合，および次の場合はエラーとなります。

先頭または末尾に区切り文字（/）が指定されている

区切り文字（/）が多重指定されている

相対パスで指定されている

パーセントエンコーディング以外の目的でパーセント（%）が指定されている

このプロパティを省略した場合，HTTP受付の受付IDが設定されます。

urecp-http.max-threads=HTTP受付の最大同時実行スレッド数　〜＜数字＞((1−1024))<<10>>

HTTP受付の最大同時実行スレッド数を指定します。HTTP受付の占有スレッド数（urecp-http.exclusive-threadsプロパティで指定）以上の値を指定する必要があります。

urecp-http.exclusive-threads=HTTP受付の占有実行スレッド数　〜＜数字＞((0−1024))<<0>>

HTTP受付の占有実行スレッド数を指定します。HTTP受付の最大同時実行スレッド数（urecp-http.max-threadsプロパティで指定）を超えない範囲で値を指定する必要があります。

urecp-http.queue-size=HTTP受付の実行待ちキューのサイズ　〜＜数字＞((0−2147483647))<<8192>>

HTTP受付の実行待ちキューのサイズを指定します。

urecp-http.pooled-instance.minimum=HTTP受付のプール内のインスタンスの最小数　〜＜数字＞((0または1−2147483647))<<0>>

HTTP受付のプール内のインスタンスの最小数を整数で指定します。0を指定した場合，制限はありません。

なお，このプロパティでは，urecp-http.pooled-instance.maximumプロパティの値（HTTP受付のプール内のインスタンスの最大数）以下の値を指定してください。指定した値が，urecp-http.pooled-instance.maximumプロパティで指定した値よりも大きい場合，運用コマンド実行時にエラーになります。

urecp-http.pooled-instance.maximum=HTTP受付のプール内のインスタンスの最大数　〜＜数字＞((0または1−2147483647))<<0>>

HTTP受付のプール内のインスタンスの最大数を整数で指定します。0を指定した場合，制限はありません。

なお，このプロパティでは，urecp-http.pooled-instance.minimumプロパティの値（HTTP受付のプール内のインスタンスの最小数）以上の値を指定してください。指定した値が，urecp-http.pooled-instance.minimumプロパティで指定した値よりも小さい場合，運用コマンド実行時にエラーになります。

urecp-http.ejb-transaction-timeout=HTTP受付のEJBトランザクションタイムアウト時間　〜＜数字＞((0または1−2147483647))<<0>>

HTTP受付のEJBトランザクションタイムアウト時間を秒単位で指定します。0を指定した場合，J2EEサーバに設定されたデフォルトのタイムアウト値で動作します。

(b)　受付設定関連

httprecp.switchover.pass-through.mode={true｜false}　〜<<false>>

メッセージボディをビジネスプロセスに渡すときのボディ変数を生成するモードを指定します。大文字と小文字は区別されません。

true

パススルーモードを使用します。

false

標準モードを使用します。

httprecp.switchover.file-transfer.mode={true｜false}　〜<<false>>

リクエスト受付時にHTTP受付が作業フォルダを作成するかどうかを設定します。大文字と小文字は区別されません。

このプロパティはマルチパート型以外のリクエストに対して有効です。マルチパート型のデータの場合は，必ず作業フォルダが作成されます。

true

リクエストがマルチパート型かどうかに関係なく作業フォルダが必ず作成されます。

false

リクエストがマルチパート型の場合は作業フォルダが生成されます。それ以外の場合，作業フォルダは作成されません。

httprecp.http.charset={Shift_JIS｜UTF-8}　〜<<UTF-8>>

メッセージボディとクエリのエンコードに使用する文字コードを指定します。大文字と小文字は区別されません。

httprecp.response.ignore-bodymsg={true｜false}　〜<<false>>

ビジネスプロセスから受信した応答電文（ボディ）をHTTP受付が無視する（HTTPレスポンスに設定しない）かどうかを設定します。大文字と小文字は区別されません。

true

応答電文（ボディ）はHTTPレスポンスに設定されません。

false

応答電文（ボディ）はHTTPレスポンスのボディ部分に設定されます。

httprecp.response.header.filename=HTTPレスポンスヘッダ定義ファイルの名称

HTTPレスポンスヘッダ定義ファイルの名称を指定します。大文字と小文字は区別されます。

httprecp.system-exception.status-code=システム例外時のステータスコード　〜＜数字＞((000−999))<<500>>

システム例外時のステータスコードを3桁の数字で指定します。

httprecp.response.generate.content-length={true｜false}　〜<<true>>

HTTP受付でコンテンツ長を生成するかどうかを指定します。大文字と小文字は区別されません。

true

コンテンツ長を生成します。

false

コンテンツ長を生成しません。

httprecp.file-trans.temp-file.partsize-threshold=一時ファイルを出力する閾値サイズ　〜＜数字＞((0または1−2147483647))<<0>>

マルチパート型のHTTPリクエストの場合に，HTTPリクエストを一時ファイルに出力するときの閾値となるサイズをバイト単位で指定します。

HTTP受付が受信したHTTPリクエストのサイズがこの値を超えた場合，受信したHTTPリクエストは一時ファイルに出力されます。0を指定した場合，一時ファイルは必ず出力されます。

httprecp.file-trans.maxsize.part=受信できるファイルデータの1ファイル当たりの上限サイズ　〜＜数字＞((0または1−2147483647))<<2147483647>>

HTTP受付で受信できるファイルデータの1ファイル当たりの上限サイズの値をバイト単位で指定します。

HTTP受付が受信したマルチパート型HTTPリクエストの各パートのうち，ファイル形式で扱うパートのサイズがこの値を超えた場合，システム例外が発生します。

httprecp.file-trans.maxsize.request=受信できるHTTPリクエストボディの上限サイズ　〜＜数字＞((0または1−2147483647))<<2147483647>>

HTTP受付で受信できるHTTPリクエストボディの上限サイズをバイト単位で指定します。

HTTP受付が受信したHTTPリクエストボディのサイズがこの値を超えた場合，システム例外が発生します。

httprecp.work-dir.auto-delete={true｜false}　〜<<true>>

処理完了後に作業フォルダを自動的に削除するかどうかを指定します。大文字と小文字は区別されません。

true

ビジネスプロセスの処理が正常に完了したあと，作業フォルダが自動で削除されます。

false

作業フォルダは自動で削除されません。

false以外の値を指定した場合，またはキーや値を省略した場合は，trueと見なされます。ビジネスプロセスが非同期型の場合，このプロパティにはfalseを指定してください。

httprecp.response.download.disposition-type=HTTPレスポンスヘッダのContent-Dispositionヘッダに設定する値　〜<<attachment>>

HTTP受付からHTTPクライアントにデータを送信するときにHTTPレスポンスヘッダのContent-Dispositionヘッダに設定する値を指定します。大文字と小文字は区別されます。なお，指定した値が有効かどうかは検証されません。

このプロパティで設定したヘッダの値は，HTTPクライアントがダウンロードするファイルが1つの場合だけ利用されます。

httprecp.pass-through.parameter-use={true｜false}　〜<<true>>

パススルーモードで，HTTPリクエストボディにmsgキーを使用するかどうかを指定します。大文字と小文字は区別されません。

このプロパティは，httprecp.switchover.pass-through.modeプロパティでtrueを指定した場合だけ有効となります。

true

msgキーを使用します。

false

msgキーを使用しません。HTTPリクエストボディの内容が要求電文として直接ビジネスプロセスに渡されます。

(c)　JSON-XML変換関連

httprecp.request.switchover.json-transfer.mode={true｜false}　〜<<false>>

HTTP受付のリクエスト処理時にJSON-XML変換をするかどうかを指定します。

true

HTTP受付のリクエスト処理時にJSON-XML変換をします。

false

HTTP受付のリクエスト処理時にJSON-XML変換をしません。

httprecp.response.switchover.json-transfer.mode={true｜false}　〜<<false>>

HTTP受付のレスポンス処理時にJSON-XML変換をするかどうかを指定します。

true

HTTP受付のレスポンス処理時にJSON-XML変換をします。

false

HTTP受付のレスポンス処理時にJSON-XML変換をしません。

(d)　HTTPレスポンス圧縮機能関連

httprecp.response.compression.url-pattern<URLパターン識別番号>=リクエストURLのURLパターン

このプロパティはHTTPレスポンス圧縮機能に関する指定です。

このプロパティは，アプリケーション統合属性ファイルのURLマッピングを指定する<filter-mapping>タグ内の<url-pattern>タグに対応します。アプリケーション統合属性ファイルとHTTPレスポンス圧縮機能については，マニュアル「アプリケーションサーバ機能解説 互換編」の「9.2　HTTPレスポンス圧縮機能」を参照してください。

指定を省略した場合，HTTPレスポンス圧縮規則の判定は実施されません。また，同じプロパティを指定した場合の動作は保証されません。

<URLパターン識別番号>

1から始まる一意な連番を設定します。連番が途切れた場合，途切れる前までのプロパティが有効となります。

リクエストURLのURLパターン

リクエストURLのコンテキストルートからの相対パスを指定します。

大文字と小文字は区別されます。

複数のURLパターンに該当する場合は，より小さいURLパターン識別番号の設定が適用されます。

「/*」を指定した場合は，すべてのリクエストURLが一致したとみなされます。

リクエストURLがここで設定されたURLパターンに該当する場合，別のプロパティで設定されたHTTPレスポンス圧縮規則に基づいて，圧縮処理をするか判定されます。HTTPレスポンス圧縮規則は次に示すプロパティで設定します。

httprecp.response.compression.rule<圧縮規則識別番号>.url-mapping<URLマッピング識別番号>=HTTPレスポンス圧縮規則のURLパターン

httprecp.response.compression.rule<圧縮規則識別番号>.condition<圧縮条件識別番号>=メディアタイプ:圧縮しきい値

複数のURLパターンを設定する場合は，異なるURLパターン識別番号を持つプロパティを複数設定してください。

2種類のURLパターンを設定する例

httprecp.response.compression.url-pattern1=/app1/*
httprecp.response.compression.url-pattern2=/app2/*

httprecp.response.compression.rule<圧縮規則識別番号>.url-mapping<URLマッピング識別番号>=HTTPレスポンス圧縮規則のURLパターン　〜<</*>>

このプロパティはHTTPレスポンス圧縮機能に関する指定です。

このプロパティは，アプリケーション統合属性ファイルのURLパターンを指定する<hitachi-filter-property><init-param>タグの<param-value>タグに対応します。アプリケーション統合属性ファイルとHTTPレスポンス圧縮機能については，マニュアル「アプリケーションサーバ機能解説 互換編」の「9.2　HTTPレスポンス圧縮機能」を参照してください。

指定を省略した場合，すべてのリクエストURLが一致したとみなされます。また，同じプロパティを指定した場合の動作は保証されません。

<圧縮規則識別番号>

1から始まる一意な連番を指定します。連番に相当する圧縮規則識別番号がどのプロパティにもない場合は，それ以降のプロパティは無効となります。

HTTPレスポンス圧縮規則としてほかに次に示すプロパティでメディアタイプおよび圧縮しきい値を設定する場合，同じ圧縮規則識別番号を設定してください。

httprecp.response.compression.rule<圧縮規則識別番号>.condition<圧縮条件識別番号>=メディアタイプ:圧縮しきい値

<URLマッピング識別番号>

1つの圧縮規則識別番号に対して，1から始まる一意な連番を設定します。連番が途切れた場合，途切れる前までのプロパティが有効となります。

HTTPレスポンス圧縮規則のURLパターン

リクエストURLのコンテキストルートからの相対パスを設定します。

大文字と小文字は区別されます。

複数のURLパターンに該当する場合は，より小さいURLパターン識別番号の設定が適用されます。

「/*」を指定した場合は，すべてのリクエストURLが一致したとみなされます。

圧縮規則識別番号とURLマッピング識別番号を組み合わせることで，複数のHTTPレスポンス圧縮規則を設定できます。

1つのHTTPレスポンス圧縮規則に複数のURLパターンを設定する場合

同じ圧縮規則識別番号で異なるURLマッピング識別番号を持つプロパティを複数設定してください。次の例では，圧縮規則1に対して2種類のURLパターンを設定しています。

httprecp.response.compression.rule1.url-mapping1=/app/dir1/*
httprecp.response.compression.rule1.url-mapping2=/app/dir2/*

複数のHTTPレスポンス圧縮規則を設定する場合

異なる圧縮規則識別番号を持つプロパティを複数設定してください。次の例では，2種類の圧縮規則を設定しています。圧縮規則識別番号が異なるため，URLマッピング識別番号はどちらも開始番号である1になっています。

httprecp.response.compression.rule1.url-mapping1=/app/dir1/*
httprecp.response.compression.rule2.url-mapping1=/app/dir2/*

httprecp.response.compression.rule<圧縮規則識別番号>.condition<圧縮条件識別番号>=メディアタイプ:圧縮しきい値　〜<<*:100>>

このプロパティはHTTPレスポンス圧縮機能に関する指定です。

このプロパティは，アプリケーション統合属性ファイルの圧縮規則を指定する<hitachi-filter-property><init-param>タグの<param-value>タグに対応します。アプリケーション統合属性ファイルとHTTPレスポンス圧縮機能については，マニュアル「アプリケーションサーバ機能解説 互換編」の「9.2　HTTPレスポンス圧縮機能」を参照してください。

指定を省略した場合，レスポンスボディが100バイトを超えるすべてのメディアタイプのHTTPレスポンスが対象となります。

同じプロパティを指定した場合の動作は保証されません。

<圧縮規則識別番号>

1から始まる一意な連番を指定します。連番に相当する圧縮規則識別番号がどのプロパティにもない場合は，それ以降のプロパティは無効となります。

HTTPレスポンス圧縮規則としてほかに次に示すプロパティでURLパターンを設定する場合は，同じ圧縮規則識別番号を設定してください。

httprecp.response.compression.rule<圧縮規則識別番号>.url-mapping<URLマッピング識別番号>=HTTPレスポンス圧縮規則のURLパターン

<圧縮条件識別番号>

1つの圧縮規則識別番号に対して，1から始まる一意な連番を設定します。連番が途切れた場合，途切れる前までのプロパティが有効となります。

メディアタイプ:圧縮しきい値

メディアタイプと圧縮しきい値を半角のコロン（:）で区切って指定してください。

メディアタイプ

大文字と小文字は区別されません。

同じメディアタイプを複数指定した場合は，より大きい圧縮条件識別番号の設定が適用されます。

アスタリスク（*）を指定した場合は，すべてのメディアタイプが適用されます。ただし，メディアタイプごとの指定がある場合はその指定が優先されます。

圧縮しきい値

100から2,147,483,647までの整数値（単位：バイト）を設定してください。

圧縮規則識別番号と圧縮条件識別番号を組み合わせることで，複数のHTTPレスポンス圧縮規則を設定できます。

1つのHTTPレスポンス圧縮規則に複数のメディアタイプおよび圧縮しきい値を設定する場合

同じ圧縮規則識別番号で異なる圧縮条件識別番号を持つプロパティを複数設定してください。次の例では，圧縮規則1に対して2種類のメディアタイプおよび圧縮しきい値を設定しています。

httprecp.response.compression.rule1.condition1=text/html:500
httprecp.response.compression.rule1.condition2=*:1000

複数のHTTPレスポンス圧縮規則を設定する場合

異なる圧縮規則識別番号を持つプロパティを複数設定してください。次の例では，2種類の圧縮規則を設定しています。圧縮規則識別番号が異なるため，圧縮条件識別番号はどちらも開始番号である1になっています。

httprecp.response.compression.rule1.condition1=text/html:500
httprecp.response.compression.rule2.condition1=*:1000

(e)　HTTP受付のルーティング機能関連

httprecp.use-routing-definition={true｜false}　〜<<false>>

HTTP受付の実行時にHTTP受付ルーティング定義ファイルを読み込むかどうかを指定します。

HTTP受付ルーティング定義ファイルでは，HTTP受付から呼び出すビジネスプロセスや，HTTP受付で実行する機能を設定できます。HTTP受付ルーティング定義ファイルの定義内容については，「3.11.4　HTTP受付ルーティング定義ファイル」を参照してください。

true

HTTP受付の実行時にHTTP受付ルーティング定義ファイルを読み込みます。

HTTP受付サービス選択定義ファイルは読み込みません。

false

HTTP受付の実行時にHTTP受付サービス選択定義ファイルを読み込みます。

HTTP受付ルーティング定義ファイルは読み込みません。

(5)　記述例

(a)　記述例1

記述例を次に示します。

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)　記述例2：レスポンスボディをgzip形式で圧縮する場合

複数の圧縮条件を指定して，レスポンスボディをgzip形式で圧縮する場合の記述例を示します。

# 圧縮対象のHTTPリクエストの設定
httprecp.response.compression.url-pattern1=/app/*

# 圧縮規則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

# 圧縮規則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

この例では，リクエストURLのコンテキストルートからの相対パスが/app/で始まるHTTPリクエストを圧縮しています。また，次に示す2種類の圧縮規則を設定しています。

圧縮規則1

リクエストURLのコンテキストルートからの相対パスが/app/dir1/で始まるHTTPリクエスト

メディアタイプがtext/htmlで，HTTPレスポンスのボディサイズが100バイトを超えるHTTPリクエスト

メディアタイプがapplication/pdfで，HTTPレスポンスのボディサイズが1000バイトを超えるHTTPリクエスト

圧縮規則2

リクエストURLのコンテキストルートからの相対パスが，/app/dir2/または/app/dir3/で始まるHTTPリクエスト

メディアタイプがtext/htmlで，HTTPレスポンスのボディサイズが200バイトを超えるHTTPリクエスト

3.11.4　HTTP受付ルーティング定義ファイル

(1)　形式

(2)　機能

HTTP受付のマッチングの条件や，実行するプロパティ値をXML形式で設定します。

HTTP受付ルーティング定義ファイルが読み込まれるようにするには，HTTP受付定義ファイルでhttprecp.use-routing-definitionプロパティにtrueを指定する必要があります。

この定義ファイルはHTTP受付の起動時に読み込まれます。読み込み時にエラーが発生すると，HTTP受付の起動に失敗します。

HTTP受付のルーティング機能については，マニュアル「サービスプラットフォーム 解説」の「2.15.12　HTTP受付のルーティング機能」を参照してください。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-reception¥http¥config¥templates¥cscurecphttp_routing.xml

注意事項

ここに格納されているファイルはテンプレートファイルです。HTTP受付ルーティング定義ファイルを編集する場合は，ユーザ定義受付（呼出先選択）であるHTTP受付の追加時にユーザ定義受付定義画面（詳細）で［独自定義ファイル］の［編集］ボタンをクリックし，定義ファイルの内容を修正してください。

(4)　設定できる要素

<?xml version="1.0" encoding="UTF-8"?>

このファイルがXMLファイルであることを示すXML宣言です。

<urecphttp-routing>

HTTP受付ルーティング定義のルート要素です。

<path pattern="URLパターン" [server="ホスト名"]>

path要素です。path要素は複数定義することもできます。

path要素ごとに次に示す属性を設定します。

pattern="URLパターン"

pattern属性には，URLパターンとしてURLとのマッチング規則を設定します。pattern属性は必ず指定してください。

リクエストURLの中で，コンテキストルート（HTTP受付定義ファイルで指定）より後ろの部分をURLパターンとして指定します。

リクエストURLの形式を次に示します。URLパターンには「<URLセグメント>/…」以降を指定します。

http[s]://<ホスト名>:<ポート番号>/<コンテキストルート>/<URLセグメント>/…

URLパターンの詳細な仕様を次に示します。

url-pattern= strict-url-pattern | flex-url-pattern
strict-url-pattern= '/' url-segment | strict-url-pattern '/' url-segment
flex-url-pattern= strict-url-pattern '/' flex-segment
url-segment= segment | dynamic-segment
dynamic-segment= '{' path-variable-name '}'
flex-segment= '{*' path-variable-name '}'
path-variable-name= Namespaces in XML 1.0 (Third Edition)で規定するNCName※
segment= RFC 3986 - Uniform Resource Identifier (URI): Generic Syntaxで規定されるsegment

注※　NCNameで使用できる文字のうち「:」（コロン）は使用できません。

次に，URLパターンの記述について説明します。

URLパターンの記述規則

URLパターンは「/」で始まり，URLセグメント（「/」で区切られた部分）で構成します。

URLセグメントには，RFC 3986 - Uniform Resource Identifier (URI): Generic Syntaxで規定されるsegmentに加え，ワイルドカードとして使用できるURLセグメント（動的セグメント）が設定できます。動的セグメントを指定していないURLパターンの場合，コンテキストルート部分を除いたリクエストURLと完全一致する場合だけ，マッチしたと判定されます。

URLパターンの記述規則に合致しないpattern属性が指定された場合は，KDEC80463-Eメッセージを出力して，HTTP受付の開始に失敗します。

pattern属性で指定されていないURLパターンを使用してリクエストが実行された場合，エラーメッセージ（KDEC80464-E）を出力して，HTTPステータスコード（404）をリクエスタに返します。

定義ファイル内に複数定義されたURLパターンは，先に定義されたURLパターンの内容が優先されます。マッチング順序については，「(6) マッチング順序」を参照してください。

動的セグメントの指定方法

動的セグメントは「{」「}」で囲み，可変値（URLパラメタ名）を設定します。これによって，リクエストURL内の対応するセグメントにマッチします。

また，URLパターンの末尾には，リクエストURL内の対応するセグメント以降全体がマッチする動的セグメントを指定できます。この動的セグメントは，URLパラメタ名を「{*」「}」で囲んで指定します。

なお，URLパターン内でURLパラメタ名が重複していると，HTTP受付の開始に失敗します。

動的セグメントを設定した場合の抽出結果については，「(5) 動的セグメントを指定した場合の抽出結果」を参照してください。

動的セグメントを使用したURLパターンのマッチングの判定

URLパターンの動的セグメントの設定値の例と，リクエストURLにマッチするかを次に示します。

URLパターンの設定値

コンテキストルート部分を除いたリクエストURL

マッチするか

/books/{bookid}/page/{pageno}

/books/1/page/

〇

/books/1/page/2

〇

/books/1/page/2/

×

/books/1/page/2/images

×

/books/{bookid}/page/{*extraparam}

/books/1/page/

〇

/books/1/page/2

/books/1/page/2/

/books/1/page/2/images

/books/{*bookid}/page/{pageno}

（{*bookid}がURLパターンの末尾でないため，リクエストURLに関係なく，HTTP受付の起動時にエラー）

−

（凡例）

○：リクエストURLにマッチします。

×：リクエストURLにマッチしません。

−：マッチング処理は実行されません。

server="ホスト名"

server属性にはホスト名を設定します。大文字と小文字は区別されません。server属性の指定は省略することもできます。

この属性が指定された場合，クライアントからのHTTPリクエストヘッダHostとのマッチングを実施します。同一のホストに複数のドメイン名を割り当て，機能を振り分けたい場合などに使用します。

この属性が指定されなかった場合，すべてのHTTPリクエストヘッダHostがマッチします。

<HTTPメソッド要素>

HTTPメソッド要素として設定できる要素を次に示します。

設定できる要素

マッチするリクエストメソッド

<GET>…</GET>

リクエストメソッドがGETの場合

<POST>…</POST>

リクエストメソッドがPOSTの場合

<HEAD>…</HEAD>

リクエストメソッドがHEADの場合

<PUT>…</PUT>

リクエストメソッドがPUTの場合

<DELETE>…</DELETE>

リクエストメソッドがDELETEの場合

<OPTIONS>…</OPTIONS>

リクエストメソッドがOPTIONSの場合

この要素に設定されていないHTTPメソッドを使用してリクエストが実行された場合，エラーメッセージ（KDEC80464-E）を出力して，HTTPステータスコード（405）をリクエスタに返します。

HTTPメソッド要素は複数の種類を設定できますが，同じHTTPメソッド要素をpath要素内に指定すると，HTTP受付の開始に失敗します。

<invoke>

invoke要素には，HTTP受付から呼び出すビジネスプロセス名を設定します。

設定したビジネスプロセス名は，次の両方の設定値にマッチするリクエストを受信した場合に呼び出されます。

path要素の設定値（URLパターンとホスト名）

HTTPメソッド要素の設定値（HTTPメソッド）

<property>

property要素には，HTTP受付定義ファイルのプロパティと値を設定します。

次の両方の設定値にマッチするリクエストを受信した場合，HTTP受付の実行時だけプロパティ値を変更して実行できます。

path要素の設定値（URLパターンとホスト名）

HTTPメソッド要素の設定値（HTTPメソッド）

このとき，同じプロパティがHTTP受付定義ファイルに設定されていても，HTTP受付ルーティング定義ファイルのプロパティが適用されます。

HTTP受付ルーティング定義ファイルのプロパティ値と，HTTP受付定義ファイルのプロパティ値との優先順位を次に示します。

HTTP受付ルーティング定義ファイルに設定したプロパティの値

HTTP受付定義ファイルに設定したプロパティの値

HTTP受付定義ファイルに設定するプロパティのデフォルト値

property要素はHTTPメソッド要素内に複数定義できます。なお，同じプロパティ名を複数定義すると，HTTP受付の開始に失敗します。

設定形式

プロパティ名と値を次の形式で設定します。

<property key="プロパティ名">値</property>

設定できるプロパティの種類

設定できるプロパティの種類を次に示します。各プロパティの設定値については，「3.11.3　HTTP受付定義ファイル」を参照してください。

httprecp.switchover.pass-through.mode（パススルーモードまたは標準モードの指定）

httprecp.pass-through.parameter-use（パススルーモードのmsgキーの使用可否）

httprecp.request.switchover.json-transfer.mode（リクエスト処理時のJSON-XML変換の有無）

httprecp.response.switchover.json-transfer.mode（レスポンス処理時のJSON-XML変換の有無）

(5)　動的セグメントを指定した場合の抽出結果

URLパターンに動的セグメントを指定した場合，リクエストURLの対応するセグメントが抽出されます。URLパターンの末尾に「{*」「}」で囲まれた動的セグメントを指定した場合は，「/」で区切られた複数のセグメントが抽出されます。

抽出結果は，要求電文フォーマット（ヘッダ変数用）の要求ヘッダ電文の<url-parameters>要素の子要素として設定されます。HTTP受付の電文フォーマットについては，マニュアル「サービスプラットフォーム 開発ガイド 受付・アダプタ定義編」の「2.5.2　HTTP受付の電文フォーマットを作成する」を参照してください。

例として，動的セグメントを指定したURLパターンと，その抽出結果を次に示します。

URLパターンの設定値

コンテキストルート部分を除いたリクエストURL

URLパラメタの抽出結果

/books

/books

なし（動的セグメントを指定していないため）

/books/{bookid}/page/{pageno}

/books/1/page/

<url-parameters>

　<bookid>1</bookid>

　<pageno></pageno>

</url-parameters>

/books/1/page/2

<url-parameters>

　<bookid>1</bookid>

　<pageno>2</pageno>

</url-parameters>

/books/{bookid}/page/{*extra}

/books/1/page/

<url-parameters>

　<bookid>1</bookid>

　<extra></extra>

</url-parameters>

/books/1/page/2

<url-parameters>

　<bookid>1</bookid>

　<extra>2</extra>

</url-parameters>

/books/1/page/2/images

<url-parameters>

　<bookid>1</bookid>

　<extra>2/images</extra>

</url-parameters>

(6)　マッチング順序

HTTP受付ルーティング定義ファイルの中で，最初にマッチしたホスト名，URLパターンおよびHTTPメソッドが有効になります。

次の定義例のマッチング順序について説明します。

<urecphttp-routing>
  <path pattern="/books/{bookid}">
    <GET><invoke>BP01</invoke></GET>
  </path>
  <path pattern="/books/extra">
    <GET><invoke>BP02</invoke></GET>
  </path>
</urecphttp-routing>

この場合，「/books/extra」へのGETリクエストは，定義されている2つのURLパターン「/books/{bookid}」「/books/extra」のどちらにもマッチします。「/books/{bookid}」のほうが先に定義されているので，HTTP受付はビジネスプロセス「BP01」を呼び出します。BP02は呼び出されません。

「/books/extra」へのGETリクエストでBP02を呼び出し，「/books/extra」以外の/books/xxxへのリクエストでBP01を呼び出すようにするには，次のように「/books/extra」を先に定義してください。

<urecphttp-routing>
  <path pattern="/books/extra">
    <GET><invoke>BP02</invoke></GET>
  </path>
  <path pattern="/books/{bookid}">
    <GET><invoke>BP01</invoke></GET>
  </path>
</urecphttp-routing>

(7)　記述例

HTTP受付ルーティング定義ファイルの記述例をXML宣言を含めて次に示します。

<?xml version="1.0" encoding="UTF-8"?>
<urecphttp-routing xmlns="http://www.hitachi.co.jp/soft/xml/cosminexus/csc/reception/http/routing"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://www.hitachi.co.jp/soft/xml/cosminexus/csc/reception/http/routing/urecp_http_routing_definition.xsd">
  <path pattern="/api/books">
    <GET>
      <invoke>bp01</invoke>
      <property key="httprecp.switchover.pass-through.mode">true</property>
      <property key="httprecp.pass-through.parameter-use">true</property>
    </GET>
    <POST><invoke>bp02</invoke></POST>
  </path>
  <path pattern="/api/books/{book-id}">
    <GET><invoke>bp03</invoke></GET>
    <PUT><invoke>bp04</invoke></PUT>
    <DELETE><invoke>bp05</invoke></DELETE>
  </path>
  <path pattern="/api/books/{book-id}/authors/{author-idx}">
    <GET><invoke>bp06</invoke></GET>
    <PUT><invoke>bp07</invoke></PUT>
    <DELETE><invoke>bp08</invoke></DELETE>
  </path>
</urecphttp-routing>

この場合，URLパラメタの抽出結果を保持するヘッダ電文のスキーマ（urecp_http_header_urlparameter.xsd）は，次のように作成してください。

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema elementFormDefault="qualified"
targetNamespace="http://www.hitachi.co.jp/soft/xml/cosminexus/csc/reception/http/request"
 xmlns:hrc="http://www.hitachi.co.jp/soft/xml/cosminexus/csc/reception/http/request"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <xsd:complexType name="http-header-urlparametersType">
    <xsd:sequence>
      <xsd:element name="book-id" type="xsd:string"/>
      <xsd:element name="author-idx" type="xsd:string"/>
    </xsd:sequence>
  </xsd:complexType>
</xsd:schema>

3.12　ファイルイベント連携で利用するファイル

3.12.1　ファイルイベント受付定義ファイル

(1)　形式

[urecp-fileevent.thread-pool.minimum=ファイルイベント受付処理の最小スレッド数]
[urecp-fileevent.thread-pool.maximum=ファイルイベント受付処理の最大スレッド数]

[urecp-fileevent.sub-folder=監視ファイルの格納先となるサブフォルダのパス]
[urecp-fileevent.common-folder.definition-name=共通フォルダ定義名]
[urecp-fileevent.monitored-file-name.regex=監視対象のファイル名の正規表現]
[urecp-fileevent.monitored.common-folder={true｜false}]
[urecp-fileevent.file.auto-delete={true｜false}]

(2)　機能

ファイルイベント受付の動作情報を設定します。このファイルは，開発環境でのファイルイベント受付の作成時に独自定義ファイルとして設定します。

ファイルイベント受付のセットアップ後に設定内容を変更する場合は，「(3)　ファイルの格納先」に示すテンプレートファイルの内容を編集して，同じファイル名「cscurecpfileevent.properties」で保存してください。これ以外のファイル名を独自定義ファイルとして設定しても無効となります。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>CSC¥custom-reception¥fileevent¥config¥templates¥cscurecpfileevent.properties

注意事項

ファイルイベント受付定義ファイルを編集する場合は，ファイルイベント受付の追加時にユーザ定義受付定義画面（詳細）で［独自定義ファイル］の［編集］ボタンをクリックし，定義ファイルの内容を修正してください。

設定した内容はファイルイベント受付の開始時に有効になります。定義内容が不正な場合は，ファイルイベント受付の配備時または起動時にエラーとなります。

(4)　設定できるプロパティ

(a)　処理スレッドの同時実行数

urecp-fileevent.thread-pool.minimum=ファイルイベント受付処理の最小スレッド数　〜＜整数値＞((1−2147483647))<<1>>

ファイルイベント受付を呼び出すスレッドに関して，スレッドプール内で同時に実行できる数の最小値を指定します。

urecp-fileevent.thread-pool.maximum=ファイルイベント受付処理の最大スレッド数　〜＜整数値＞((1−2147483647))<<32>>

ファイルイベント受付を呼び出すスレッドに関して，スレッドプール内で同時に実行できる数の最大値を指定します。最小スレッド数以上の値を指定する必要があります。

(b)　監視ファイル

urecp-fileevent.sub-folder=監視ファイルの格納先となるサブフォルダのパス　〜＜文字列（2バイト文字含む）および空白＞

監視対象のファイルをサブフォルダに格納する場合，サブフォルダ名を相対パスで指定します。フォルダ区切りは「/」を使用します。

存在しないフォルダを指定した場合は，ファイルイベント受付のリクエスト処理が失敗します。

監視対象のファイル全体のパス長は，OSの最大パス長を超えないようにしてください。OSのパス長の上限については，各OSのドキュメントを参照してください。

urecp-fileevent.common-folder.definition-name=共通フォルダ定義名　〜＜英数字（0〜9，A〜Z，a〜z），アンダーバー（_）＞((1−64文字))<<default>>

ファイルイベント受付が取得対象ファイルの存在を確認する際に参照する，共通フォルダ定義名を指定します。

HCSCサーバランタイム定義ファイルの「common-folder-<共通フォルダ定義名>」に指定した共通フォルダ定義名を指定してください。

urecp-fileevent.monitored-file-name.regex=監視対象のファイル名の正規表現　〜＜文字列＞

ファイルイベント受付で監視の対象とするファイル名を正規表現で指定します。正規表現の記述仕様は，java.util.regex.Patternクラスの仕様に従ってください。

指定を省略した場合は，ファイル名に「.csc」を含まないファイル名のファイルがすべて監視対象となります。

urecp-fileevent.monitored.common-folder={true｜false}　〜<<false>>

ファイルイベント受付の監視対象のフォルダを共通フォルダにするか指定します。

true

共通フォルダ内の取得対象ファイルを監視します。

false

監視フォルダ内の更新完了通知ファイルを監視します。

urecp-fileevent.file.auto-delete={true｜false}　〜<<true>>

ビジネスプロセスからの応答が正常の場合に，取得対象ファイルを自動的に削除するか否かを指定します。

このプロパティは，監視対象が共通フォルダの場合だけ有効となります。

true

取得対象ファイルを削除します。

false

取得対象ファイルを削除しません。

(5)　記述例

ファイルイベント受付定義ファイルの記述例を次に示します。

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　Kafkaアダプタで利用するファイル

3.13.1　Kafkaアダプタ定義ファイル

(1)　形式

［adpkafka.xml2json={true｜false}］

［adpkafka.request.record.binary.decoding={hexBinary｜base64Binary}］

　producer.key.serializer={ByteArraySerializer｜StringSerializer}
　producer.value.serializer={ByteArraySerializer｜StringSerializer}

［producer.acks=Apache Kafkaが書き込み完了通知を返すタイミング］

［producer.compression.type={none｜gzip}］

［producer.retries=メッセージの再送信回数］

［producer.client.id=送信リクエストの実行時にBrokerに渡すid文字列］

［producer.connections.max.idle.ms=アイドル状態の接続タイムアウト時間］
［producer.delivery.timeout.ms=メッセージ送信の応答のタイムアウト時間］
［producer.max.block.ms=送信リクエストの呼び出しのタイムアウト時間］
［producer.request.timeout.ms=送信要求の応答のタイムアウト時間］
［producer.socket.connection.setup.timeout.max.ms=ソケット接続が確立されるまでクライアントが待機する最大時間］
［producer.socket.connection.setup.timeout.ms=ソケット接続が確立されるまでクライアントが待機する時間］

(2)　機能

Kafkaアダプタの動作情報を設定します。設定した内容はKafkaアダプタの開始時に有効になります。

Kafkaアダプタ定義ファイルは「adpkafka.properties」というファイル名で作成します。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥Kafka¥config¥templates¥adpkafka.properties

注意事項

ここに格納されているファイルはテンプレートファイルです。このテンプレートファイルを任意のディレクトリにコピーしたあとファイルを編集し，定義ファイルを作成してください。

(4)　設定できるプロパティ

(a)　拡張機能

adpkafka.xml2json={true｜false}　〜<<false>>

ボディ要求電文のJSON-XML変換を実施するかどうかを指定します。大文字と小文字は区別されます。

true

JSON-XML変換を実施します。

false

JSON-XML変換を実施しません。

(b)　デコード形式

adpkafka.request.record.binary.decoding={hexBinary｜base64Binary}　〜<<hexBinary>>

要求電文中の要素値をバイナリデータへデコードする際のデコード形式を指定します。

hexBinary

hexBinary形式でデコードします。

base64Binary

base64Binary形式でデコードします。

producer.key.serializerプロパティにByteArraySerializerを指定した場合，ヘッダ要求電文のメッセージのkey要素に指定した値は，ここで指定したデコード形式でデコードされてApache Kafkaへ送信されます。そのため，key要素の値はデコード形式に合わせて指定する必要があります。形式が異なる場合の動作は保証できません。

(c)　シリアライザクラス

producer.key.serializer={ByteArraySerializer｜StringSerializer}

メッセージのキーのシリアライザクラスを指定します。指定は省略できません。

ByteArraySerializer

メッセージのキーのデータ型をByte[]として扱います。

これを指定した場合，ヘッダ要求電文のメッセージのkey要素に指定した値は，adpkafka.request.record.binary.decodingプロパティに指定したデコード形式でデコードされてApache Kafkaへ送信されます。

StringSerializer

メッセージのキーのデータ型をjava.lang.Stringとして扱います。

ここで設定した値は，Apache Kafkaへのメッセージ送信に使用されるProducer APIのプロパティ「key.serializer」に設定されます。詳細はApache Kafkaの公式ドキュメントを参照してください。

producer.value.serializer={ByteArraySerializer｜StringSerializer}

メッセージの値のシリアライザクラスを指定します。指定は省略できません。

JSON-XML変換を実施（adpkafka.xml2json=trueを指定）する場合は，StringSerializerを指定してください。

ByteArraySerializer

メッセージの値のデータ型をByte[]として扱います。

StringSerializer

メッセージの値のデータ型をjava.lang.Stringとして扱います。

ここで設定した値は，Apache Kafkaへのメッセージ送信に使用されるProducer APIのプロパティ「value.serializer」に設定されます。詳細はApache Kafkaの公式ドキュメントを参照してください。

(d)　書き込み完了通知のタイミング

producer.acks=Apache Kafkaが書き込み完了通知を返すタイミング　〜<<1>>

Kafkaアダプタからの送信リクエストに対し，Apache Kafkaが書き込み完了通知（ack）を返すタイミングを指定します。

ここで設定した値は，Apache Kafkaへのメッセージ送信に使用されるProducer APIのプロパティ「acks」に設定されます。設定値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

(e)　圧縮タイプ

producer.compression.type={none｜gzip}　〜<<none>>

メッセージの圧縮タイプを指定します。

none

圧縮しません。

gzip

gzipを使用します。

ここで設定した値は，Apache Kafkaへのメッセージ送信に使用されるProducer APIのプロパティ「compression.type」に設定されます。詳細はApache Kafkaの公式ドキュメントを参照してください。

(f)　再試行回数

producer.retries=メッセージの再送信回数　〜<<2147483647>>

一時的なエラーで送信が失敗したメッセージの再送信回数を指定します。

ここで設定した値は，Apache Kafkaへのメッセージ送信に使用されるProducer APIのプロパティ「retries」に設定されます。設定できる値の範囲などの詳細はApache Kafkaの公式ドキュメントを参照してください。

(g)　クライアントID

producer.client.id=送信リクエストの実行時にBrokerに渡すid文字列　〜<<空文字列>>

送信リクエストの実行時にBrokerに渡すid文字列を指定します。デフォルト値で動作させる場合は，このプロパティを定義しないでください。

ここで設定した値は，Apache Kafkaへのメッセージ送信に使用されるProducer APIのプロパティ「client.id」に設定されます。設定値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

(h)　タイムアウト時間

producer.connections.max.idle.ms=アイドル状態の接続タイムアウト時間　〜<<540000>>

アイドル状態の接続を閉じるまでの最大待機時間をミリ秒単位で指定します。

指定した時間を過ぎると，アイドル状態となっている接続を閉じますが，メッセージ送信機能は続行します。

ここで設定した値は，Apache Kafkaへのメッセージ送信に使用されるProducer APIのプロパティ「connections.max.idle.ms」に設定されます。設定できる値の範囲などの詳細はApache Kafkaの公式ドキュメントを参照してください。

producer.delivery.timeout.ms=メッセージ送信の応答のタイムアウト時間　〜<<120000>>

Kafkaアダプタからの送信リクエストの呼び出しが返されてから，Apache Kafkaへメッセージ送信の成功または失敗を応答するまでの最大待機時間をミリ秒単位で指定します。producer.request.timeout.msプロパティの指定値以上の値を指定してください。

指定した時間を過ぎると，エラーメッセージを出力してメッセージ送信機能を停止します。

ここで設定した値は，Apache Kafkaへのメッセージ送信に使用されるProducer APIのプロパティ「delivery.timeout.ms」に設定されます。設定できる値の範囲などの詳細はApache Kafkaの公式ドキュメントを参照してください。

producer.max.block.ms=送信リクエストの呼び出しのタイムアウト時間　〜<<60000>>

送信リクエストの呼び出しまでの最大待機時間をミリ秒単位で指定します。

指定した時間を過ぎると，エラーメッセージを出力してメッセージ送信機能を停止します。

ここで設定した値は，Apache Kafkaへのメッセージ送信に使用されるProducer APIのプロパティ「max.block.ms」に設定されます。設定できる値の範囲などの詳細はApache Kafkaの公式ドキュメントを参照してください。

producer.request.timeout.ms=送信要求の応答のタイムアウト時間　〜<<30000>>

送信要求の応答までの最大待機時間をミリ秒単位で指定します。

指定した時間を過ぎると，次のように対処されます。

メッセージを再送できる場合は，リクエストが再試行されます。

メッセージを再送できない場合は，エラーメッセージを出力してメッセージ送信機能を停止します。

ここで設定した値は，Apache Kafkaへのメッセージ送信に使用されるProducer APIのプロパティ「request.timeout.ms」に設定されます。設定できる値の範囲などの詳細はApache Kafkaの公式ドキュメントを参照してください。

producer.socket.connection.setup.timeout.max.ms=ソケット接続が確立されるまでクライアントが待機する最大時間　〜<<30000>>

ソケット接続が確立されるまでのクライアントの最大待機時間をミリ秒単位で指定します。

指定した時間を過ぎると，ほかのノードに接続を切り替えます。メッセージ送信機能は続行します。

ここで設定した値は，Apache Kafkaへのメッセージ送信に使用されるProducer APIのプロパティ「socket.connection.setup.timeout.max.ms」に設定されます。設定できる値の範囲などの詳細はApache Kafkaの公式ドキュメントを参照してください。

producer.socket.connection.setup.timeout.ms=ソケット接続が確立されるまでクライアントが待機する時間　〜<<10000>>

ソケット接続が確立されるまでのクライアントの待機時間をミリ秒単位で指定します。

指定した時間を過ぎると，ほかのノードに接続を切り替えます。メッセージ送信機能は続行します。

ここで設定した値は，Apache Kafkaへのメッセージ送信に使用されるProducer APIのプロパティ「socket.connection.setup.timeout.ms」に設定されます。設定できる値の範囲などの詳細はApache Kafkaの公式ドキュメントを参照してください。

3.14　Kafka受付で利用するファイル

3.14.1　Kafka受付定義ファイル

(1)　形式

　consumer.key.deserializer={StringDeserializer｜ByteArrayDeserializer}
　consumer.value.deserializer={StringDeserializer｜ByteArrayDeserializer}
　consumer.bootstrap.servers=初期接続時のホスト/ポート
［consumer.fetch.min.bytes=フェッチ要求への返却データの最小量］
　consumer.group.id=Consumerグループの識別文字列
［consumer.heartbeat.interval.ms=ハートビート間の予想時間］
［consumer.max.partition.fetch.bytes=パーティションごとのデータの最大量］
［consumer.session.timeout.ms=クライアントの障害検出用のタイムアウト時間］
［consumer.ssl.key.password=キーストアファイル内の秘密鍵のパスワード］
［consumer.ssl.keystore.key=キーストアファイルの秘密キー］
［consumer.ssl.keystore.location=キーストアファイルの格納場所］
［consumer.ssl.keystore.password=キーストアファイルのストアパスワード］
［consumer.ssl.truststore.location=トラストストアファイルの格納場所］
［consumer.ssl.truststore.password=トラストストアファイルのパスワード］
［consumer.auto.offset.reset={earliest｜latest}］
［consumer.client.dns.lookup={use_all_dns_ips｜resolve_canonical_bootstrap_servers_only}］
［consumer.connections.max.idle.ms=アイドル状態の接続タイムアウト時間］
［consumer.fetch.max.bytes=フェッチ要求への返却データの最大量］
［consumer.max.poll.interval.ms=ポーリングの最大遅延時間］
［consumer.max.poll.records=1回のポーリングの呼び出しで返されるレコードの最大数］
［consumer.receive.buffer.bytes=TCP受信ソケットバッファのサイズ］
［consumer.request.timeout.ms=要求の応答を待機する最大時間］
［consumer.security.protocol={PLAINTEXT｜SSL}］
［consumer.send.buffer.bytes=TCP送信ソケットバッファのサイズ］
［consumer.socket.connection.setup.timeout.max.ms=ソケット接続が確立されるまでクライアントが待機する最大時間］
［consumer.socket.connection.setup.timeout.ms=ソケット接続が確立されるまでクライアントが待機する時間］
［consumer.ssl.enabled.protocols=SSL接続が有効なプロトコルのリスト］
［consumer.ssl.keystore.type=キーストアファイルのファイル形式］
［consumer.ssl.protocol=SSLContextの生成に使用するSSLプロトコル］
［consumer.ssl.provider=SSL接続に使用するセキュリティプロバイダの名称］
［consumer.ssl.truststore.type=トラストストアファイルのファイル形式］
［consumer.client.id=リクエスト時にサーバに渡すID文字列］
［consumer.fetch.max.wait.ms=フェッチ要求への応答のブロック時間］
［consumer.metadata.max.age.ms=メタデータの強制更新までの時間］
［consumer.reconnect.backoff.max.ms=Brokerへ再接続するまでの最大待機時間］
［consumer.reconnect.backoff.ms=特定のホストへの再接続を試行する前に待機する基本時間］
［consumer.retry.backoff.ms=特定のパーティションへの再要求までの待機時間］

［urecp-kafka.commit-processing.control={msg-rcv-after｜msg-proc-after}］
［urecp-kafka.commit-timeout.ms=オフセットのコミットの最大待機時間］
［urecp-kafka.poll-timeout.ms=ポーリング時の待ち時間］
　urecp-kafka.topic-name=サブスクライブするトピック
［urecp-kafka.err-message.retry-count=Kafka受付の呼び出しのリトライ回数］
［urecp-kafka.record-binary.encoding={hexBinary｜base64Binary}］
［urecp-kafka.resource-adapter=Kafkaインバウンドアダプタの表示名］
［urecp-kafka.ejb-transaction-timeout=EJBトランザクションのタイムアウト時間］
［urecp-kafka.json2xml={true｜false}］

(2)　機能

Kafkaインバウンドアダプタ内で動作するConsumerの動作や，Kafka受付の動作を設定します。設定した内容は，Kafka受付のデプロイ時，Kafka受付の起動時，またはcsccmctlコマンドの実行時に読み込まれます。

Kafka受付定義ファイルは「cscurecpkafka.properties」というファイル名で作成してください。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-reception¥kafka¥config¥templates¥cscurecpkafka.properties

注意事項

ここに格納されているファイルはテンプレートファイルです。Kafka受付定義ファイルを編集する場合は，Kafka受付の追加時にユーザ定義受付定義画面（詳細）で［独自定義ファイル］の［編集］ボタンをクリックし，定義ファイルの内容を修正してください。

(4)　設定できるプロパティ

(a)　Apache Kafkaの定義

consumer.key.deserializer={StringDeserializer｜ByteArrayDeserializer}

メッセージのキーのデシリアライザを指定します。指定は省略できません。

StringDeserializer

デシリアライザとしてStringDeserializerを使用します。

ByteArrayDeserializer

デシリアライザとしてByteArrayDeserializerを使用します。

ここで設定した値はApache KafkaのConsumer定義「key.deserializer」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.value.deserializer={StringDeserializer｜ByteArrayDeserializer}

メッセージの値のデシリアライザを指定します。指定は省略できません。

StringDeserializer

デシリアライザとしてStringDeserializerを使用します。

ByteArrayDeserializer

デシリアライザとしてByteArrayDeserializerを使用します。

ここで設定した値はApache KafkaのConsumer定義「value.deserializer」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.bootstrap.servers=初期接続時のホスト/ポート

Kafkaクラスタへの初期接続を確立するために使用するホスト/ポートを指定します。指定は省略できません。

ここで設定した値はApache KafkaのConsumer定義「bootstrap.servers」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.fetch.min.bytes=フェッチ要求への返却データの最小量　〜<<1>>

サーバがフェッチ要求に対して返す必要のあるデータの最小量を指定します。

ここで設定した値はApache KafkaのConsumer定義「fetch.min.bytes」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.group.id=Consumerグループの識別文字列

Consumerが属するConsumerグループを識別するための，一意の文字列を指定します。指定は省略できません。

ここで設定した値はApache KafkaのConsumer定義「group.id」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.heartbeat.interval.ms=ハートビート間の予想時間　〜<<3000>>

Consumerコーディネータへのハートビート間の予想時間をミリ秒で指定します。

ここで設定した値はApache KafkaのConsumer定義「heartbeat.interval.ms」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.max.partition.fetch.bytes=パーティションごとのデータの最大量　〜<<1048576>>

サーバが返すパーティションごとのデータの最大量を指定します。

ここで設定した値はApache KafkaのConsumer定義「max.partition.fetch.bytes」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.session.timeout.ms=クライアントの障害検出用のタイムアウト時間　〜<<10000>>

Apache Kafkaのグループ管理機能の使用時のタイムアウト時間をミリ秒で指定します。クライアントの障害を検出するために使用されます。

ここで設定した値はApache KafkaのConsumer定義「session.timeout.ms」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.ssl.key.password=キーストアファイル内の秘密鍵のパスワード

キーストアファイル内の秘密鍵のパスワードを指定します。

ここで設定した値はApache KafkaのConsumer定義「ssl.key.password」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.ssl.keystore.key=キーストアファイルの秘密キー

キーストアファイルの秘密キーを指定します。

ここで設定した値はApache KafkaのConsumer定義「ssl.keystore.key」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.ssl.keystore.location=キーストアファイルの格納場所

キーストアファイルの格納場所を指定します。

ここで設定した値はApache KafkaのConsumer定義「ssl.keystore.location」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.ssl.keystore.password=キーストアファイルのストアパスワード

キーストアファイルのストアパスワードを指定します。

ここで設定した値はApache KafkaのConsumer定義「ssl.keystore.password」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.ssl.truststore.location=トラストストアファイルの格納場所

トラストストアファイルの格納場所を指定します。

ここで設定した値はApache KafkaのConsumer定義「ssl.truststore.location」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.ssl.truststore.password=トラストストアファイルのパスワード

トラストストアファイルのパスワードを指定します。

ここで設定した値はApache KafkaのConsumer定義「ssl.truststore.password」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.auto.offset.reset={earliest｜latest}　〜<<latest>>

Apache Kafkaに初期オフセットがない場合や，現在のオフセットがサーバ上に存在しない場合の対処方法を次のどちらかで指定します。

earliest

最も早いオフセットに自動的にリセットします。

latest

自動的に最新のオフセットにリセットします。

ここで設定した値はApache KafkaのConsumer定義「auto.offset.reset」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.client.dns.lookup={use_all_dns_ips｜resolve_canonical_bootstrap_servers_only}　〜<<use_all_dns_ips>>

クライアントがDNSルックアップを使用する方法を次のどちらかで指定します。

use_all_dns_ips

接続が正常に確立されるまで，返された各IPアドレスに順番に接続します。すべてのIPアドレスが一度使用されると，クライアントはホスト名からIPアドレスを再度名前解決します（ただし，JVMとOSキャッシュの両方のDNS名のルックアップ）。

resolve_canonical_bootstrap_servers_only

各ブートストラップアドレスを正規名のリストで名前解決します。

ブートストラップフェーズのあとは，use_all_dns_ipsと同じ動作となります。

ここで設定した値はApache KafkaのConsumer定義「client.dns.lookup」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.connections.max.idle.ms=アイドル状態の接続タイムアウト時間　〜<<540000>>

アイドル状態の接続を閉じるまでのタイムアウト時間をミリ秒で指定します。

ここで設定した値はApache KafkaのConsumer定義「connections.max.idle.ms」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.fetch.max.bytes=フェッチ要求への返却データの最大量　〜<<52428800>>

サーバがフェッチ要求に対して返す必要のあるデータの最大量を指定します。

ここで設定した値はApache KafkaのConsumer定義「fetch.max.bytes」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.max.poll.interval.ms=ポーリングの最大遅延時間　〜<<300000>>

ポーリングの実行間隔の最大遅延時間をミリ秒で指定します。

ここで設定した値はApache KafkaのConsumer定義「max.poll.interval.ms」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.max.poll.records=1回のポーリングの呼び出しで返されるレコードの最大数　〜<<500>>

1回のポーリングの呼び出しで返されるレコードの最大数を指定します。

ここで設定した値はApache KafkaのConsumer定義「max.poll.records」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.receive.buffer.bytes=TCP受信ソケットバッファのサイズ　〜<<65536>>

TCP受信ソケットバッファのサイズを指定します。

ここで設定した値はApache KafkaのConsumer定義「receive.buffer.bytes」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.request.timeout.ms=要求の応答を待機する最大時間　〜<<30000>>

要求に対する応答を待機する最大時間をミリ秒で指定します。

ここで設定した値はApache KafkaのConsumer定義「request.timeout.ms」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.security.protocol={PLAINTEXT｜SSL}　〜<<PLAINTEXT>>

Brokerとの通信に使用するプロトコルを次のどちらかで指定します。

PLAINTEXT

PLAINTEXTを使用します。

SSL

SSLを使用します。

ここで設定した値はApache KafkaのConsumer定義「security.protocol」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.send.buffer.bytes=TCP送信ソケットバッファのサイズ　〜<<131072>>

TCP送信ソケットバッファのサイズを指定します。

ここで設定した値はApache KafkaのConsumer定義「send.buffer.bytes」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.socket.connection.setup.timeout.max.ms=ソケット接続が確立されるまでクライアントが待機する最大時間　〜<<30000>>

ソケット接続が確立されるまでクライアントが待機する時間の最大値をミリ秒で指定します。

ここで設定した値はApache KafkaのConsumer定義「socket.connection.setup.timeout.max.ms」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.socket.connection.setup.timeout.ms=ソケット接続が確立されるまでクライアントが待機する時間　〜<<10000>>

ソケット接続が確立されるまでクライアントが待機する時間をミリ秒で指定します。

ここで設定した値はApache KafkaのConsumer定義「socket.connection.setup.timeout.ms」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.ssl.enabled.protocols=SSL接続が有効なプロトコルのリスト　〜<<TLSv1.2>>

SSL接続が有効になっているプロトコルのリストを指定します。

ここで設定した値はApache KafkaのConsumer定義「ssl.enabled.protocols」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.ssl.keystore.type=キーストアファイルのファイル形式　〜<<JKS>>

キーストアファイルのファイル形式を指定します。

ここで設定した値はApache KafkaのConsumer定義「ssl.keystore.type」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.ssl.protocol=SSLContextの生成に使用するSSLプロトコル　〜<<TLSv1.2>>

SSLContextの生成に使用するSSLプロトコルを指定します。

ここで設定した値はApache KafkaのConsumer定義「ssl.protocol」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.ssl.provider=SSL接続に使用するセキュリティプロバイダの名称　〜<<null>>

SSL接続に使用するセキュリティプロバイダの名前を指定します。デフォルト値で動作させる場合は，このプロパティを定義しないでください。

ここで設定した値はApache KafkaのConsumer定義「ssl.provider」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.ssl.truststore.type=トラストストアファイルのファイル形式　〜<<JKS>>

トラストストアファイルのファイル形式を指定します。

ここで設定した値はApache KafkaのConsumer定義「ssl.truststore.type」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.client.id=リクエスト時にサーバに渡すID文字列　〜<<空文字列>>

リクエスト時にサーバに渡すID文字列を指定します。デフォルト値で動作させる場合は，このプロパティを定義しないでください。

ここで設定した値はApache KafkaのConsumer定義「client.id」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.fetch.max.wait.ms=フェッチ要求への応答のブロック時間　〜<<500>>

Consumer定義「fetch.min.bytes」で指定されたデータ最小量に達するデータがない場合，サーバがフェッチ要求に応答する前にブロックする時間をミリ秒で指定します。

ここで設定した値はApache KafkaのConsumer定義「fetch.max.wait.ms」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.metadata.max.age.ms=メタデータの強制更新までの時間　〜<<300000>>

メタデータの強制更新までの時間をミリ秒単位で指定します。

ここで設定した値はApache KafkaのConsumer定義「metadata.max.age.ms」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.reconnect.backoff.max.ms=Brokerへ再接続するまでの最大待機時間　〜<<1000>>

接続に失敗したBrokerに再接続するまでの待機時間をミリ秒単位で指定します。

ここで設定した値はApache KafkaのConsumer定義「reconnect.backoff.max.ms」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.reconnect.backoff.ms=特定のホストへの再接続を試行する前に待機する基本時間　〜<<50>>

特定のホストへの再接続を試行する前に待機する基本時間をミリ秒で指定します。

ここで設定した値はApache KafkaのConsumer定義「reconnect.backoff.ms」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

consumer.retry.backoff.ms=特定のパーティションへの再要求までの待機時間　〜<<100>>

要求が失敗した特定のトピックのパーティションに対して，要求を再試行するまでの待機時間をミリ秒で指定します。

ここで設定した値はApache KafkaのConsumer定義「retry.backoff.ms」に設定され，KafkaインバウンドアダプタのConsumer機能に使用されます。設定できる値などの詳細はApache Kafkaの公式ドキュメントを参照してください。

(b)　Kafka受付独自の定義

urecp-kafka.commit-processing.control={msg-rcv-after｜msg-proc-after}　〜<<msg-proc-after>>

KafkaインバウンドアダプタからBrokerへオフセットをコミットするタイミングを指定します。

msg-rcv-after

Apache Kafkaからメッセージを受信した直後にコミットします。

msg-proc-after

Kafka受付から応答が返ったあとでコミットします。

urecp-kafka.commit-timeout.ms=オフセットのコミットの最大待機時間　〜＜数字＞((1−2147483647))<<60000>>

KafkaインバウンドアダプタからBrokerへコミットする際に，オフセットのコミットを待機する最大時間をミリ秒で指定します。

urecp-kafka.poll-timeout.ms=ポーリング時の待ち時間　〜＜数字＞((1−2147483647))<<60000>>

Kafkaインバウンドアダプタで利用できるレコードがない場合に，ポーリングをブロックする最大時間をミリ秒で指定します。利用できるレコードがある場合はブロックしません。

urecp-kafka.topic-name=サブスクライブするトピック　〜＜半角英数字，アンダーバー（_），ハイフン（-），ピリオド（.）＞((1トピック当たり1−249文字))

Kafkaインバウンドアダプタがサブスクライブするトピックの名称を指定します。指定は省略できません。

コマンド制御（MBean）の実行時は設定値が適切かチェックされます。csccmctlコマンドの実行時はチェックされません。

トピックを複数指定する場合は，値をコンマ区切りで指定してください。

urecp-kafka.err-message.retry-count=Kafka受付の呼び出しのリトライ回数　〜＜数字＞((0−1024))<<1>>

Kafka受付がKafkaインバウンドアダプタへエラー応答をした際に，Kafka受付の呼び出しをリトライする回数を指定します。値に0を指定した場合はリトライを実行しません。

urecp-kafka.record-binary.encoding={hexBinary｜base64Binary}　〜<<hexBinary>>

Kafkaインバウンドアダプタから渡されたレコードデータをビジネスプロセスに渡す要求電文に関して，要素値に設定するレコードデータのエンコード形式を指定します。

hexBinary

レコードデータをhexBinary形式でエンコードします。

base64Binary

レコードデータをbase64Binary形式でエンコードします。

urecp-kafka.resource-adapter=Kafkaインバウンドアダプタの表示名　〜＜英数字（a〜z，A〜Z，0〜9）およびアンダーバー（_）＞((1−240文字))<<Kafka_Inbound_Resource_Adapter>>

受付処理が使用するKafkaインバウンドアダプタの表示名（Connector属性ファイルのdisplay-nameタグの設定値）を指定します。

urecp-kafka.ejb-transaction-timeout=EJBトランザクションのタイムアウト時間　〜＜数字＞((0−2147483647))<<0>>

受付処理およびカスタム受付フレームワークのEJBトランザクションのタイムアウト時間（秒）を指定します。

0を指定した場合，J2EEサーバに設定されたデフォルトのタイムアウト値で動作します。

urecp-kafka.json2xml={true｜false}　〜<<false>>

Kafka受付のリクエスト処理時にJSON-XML変換をするかどうかを指定します。大文字と小文字は区別されます。

true

JSON-XML変換機能を使用して，レコードの値をXMLに変換します。

false

JSON-XML変換機能を使用しません。

3.15　スケジュール駆動受付で利用するファイル

3.15.1　スケジュール駆動受付定義ファイル

(1)　形式

［scdrecp.event.occurrence-interval=イベント発生間隔］

［urecp-scd.task.processing-max.parallel.count=並列実行可能なタスク最大数］
［scdrecp.allow.new-task.executing={true｜false}］

［scdrecp.create.work-dir={true｜false}］
［scdrecp.work-dir.auto-delete={true｜false}］

(2)　機能

スケジュール駆動受付の動作情報を設定します。このファイルはスケジュール駆動受付の独自定義ファイルです。

このファイルは必要に応じて設定してください。設定されなかった場合は，各プロパティにデフォルト値が適用され，スケジュール駆動受付のデプロイ時にメッセージ「KDEC10106-W」が出力されます。

このファイルは，指定値のチェックのタイミングと，不正な値が検出された場合の動作が，プロパティによって次のように異なります。

プロパティの種類

チェックのタイミング

不正な値が検出された場合の動作

「urecp-scd」で始まるプロパティ

スケジュール駆動受付の配備時

スケジュール駆動受付の配備に失敗する。

csccmctlコマンド実行時

csccmctlコマンドの実行に失敗する。

「scdrecp」で始まるプロパティ

スケジュール駆動受付の起動時

スケジュール駆動受付の起動に失敗する。

csccmctlコマンド実行時

csccmctlコマンドの実行に失敗する。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>CSC¥custom-reception¥schedule¥config¥templates¥cscurecpschedule.properties

注意事項

ここに格納されているファイルはテンプレートファイルです。スケジュール駆動受付定義ファイルを編集する場合は，スケジュール駆動受付の追加時にユーザ定義受付定義画面（詳細）で［独自定義ファイル］の［編集］ボタンをクリックし，定義ファイルの内容を修正してください。

設定した内容は，デプロイ時，スケジュール駆動受付の起動時，またはcsccmctlコマンド実行時に読み込まれます。

(4)　設定できるプロパティ

(a)　イベントの発生間隔

scdrecp.event.occurrence-interval=イベント発生間隔　〜＜数字＞((1−86400))<<600>>

イベントを発生させる間隔を秒単位で指定します。

(b)　実行中のタスクの動作

urecp-scd.task.processing-max.parallel.count=並列実行可能なタスク最大数　〜＜数字＞((1−64))<<1>>

イベントの発生時刻にすでに実行中のタスクがある場合，並列して実行できるタスクの最大数を指定します。

1を設定した場合は，タスクの処理順序が「逐次」となります。

1より大きい値を指定した場合は，タスクの処理順序が「並列」となります。

タスクの処理順序については，マニュアル「サービスプラットフォーム 解説」の「3.6　ビジネスプロセスのスケジュール設定」を参照してください。

scdrecp.allow.new-task.executing={true｜false}　〜<<false>>

イベントの発生時刻にすでに実行中のタスクがある場合，新たにタスクを実行するかを次の中から指定します。

true

新たにタスクを実行します。

false

新たにタスクを実行しません。

(c)　作業フォルダ

scdrecp.create.work-dir={true｜false}　〜<<false>>

タスク実行時に作業フォルダを作成するかどうかを次の中から指定します。

true

タスク実行時に作業フォルダを作成します。

false

タスク実行時に作業フォルダを作成しません。

scdrecp.work-dir.auto-delete={true｜false}　〜<<false>>

タスクの処理の正常終了後に作業フォルダを自動的に削除するかどうかを次の中から指定します。

true

作業フォルダを自動的に削除します。

false

作業フォルダを自動的に削除しません。

3.16　gRPCアダプタで利用するファイル

3.16.1　gRPCアダプタ独自定義ファイル

(1)　形式

［adpgrpc.protocol.keepalive-time=キープアライブPINGの送信間隔］
［adpgrpc.protocol.keepalive-timeout=キープアライブタイムアウト時間］
［adpgrpc.protocol.keepalive-without-calls={true｜false}］
［adpgrpc.protocol.idle-timeout=アイドルタイムアウト時間］
［adpgrpc.protocol.deadline=リクエストの実行期限］
［adpgrpc.protocol.wait-for-ready={true｜false}］
［adpgrpc.protocol.message-compression.enabled={true｜false}］

［adpgrpc.data-size-limit.max-inbound-message-size=gRPCアダプタで受信できる最大メッセージサイズ］
［adpgrpc.data-size-limit.max-outbound-message-size=gRPC呼び出しで送信できる最大メッセージサイズ］
［adpgrpc.data-size-limit.max-inbound-metadata-size=受信できるメタデータの最大サイズ］

［adpgrpc.response-code.fault=フォルト処理するステータスコード］

(2)　機能

gRPCアダプタの動作情報を設定します。

gRPCアダプタ独自定義ファイルは「cscadpgrpc.properties」というファイル名で作成します。gRPCアダプタの作成時にサービスアダプタ定義画面の［独自定義ファイル］にこのファイルを設定することで，gRPCアダプタの開始時に設定内容が有効になります。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥gRPC¥config¥templates¥cscadpgrpc.properties

注意事項

ここに格納されているファイルはテンプレートファイルです。gRPCアダプタ独自定義ファイルを編集する場合は，gRPCアダプタの追加時にサービスアダプタ定義画面（詳細）で［独自定義ファイル］の［編集］ボタンをクリックし，定義ファイルの内容を修正してください。

(4)　設定できるプロパティ

(a)　プロトコル動作指定

adpgrpc.protocol.keepalive-time=キープアライブPINGの送信間隔　〜((10000−86400000000))

キープアライブPINGの送信間隔をミリ秒単位で指定します。範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。

gRPCサーバ側で許可されているキープアライブ時間より小さい値を設定した場合，接続が強制的に閉じられるため，必要最小限の値を設定することを推奨します。

次の場合，キープアライブは無効となります。

最大値を指定した場合

このプロパティを省略した場合

キープアライブを有効にした場合，接続先のgRPCサービスの負荷が増加することがあります。

adpgrpc.protocol.keepalive-timeout=キープアライブタイムアウト時間　〜((10−9223372036854))<<20000>>

キープアライブPINGの送信後に，接続先から応答が返ってくるまでの時間をミリ秒単位で指定します。RTT（Round-Trip Time）の複数倍の値を設定することを推奨します。

範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。

adpgrpc.protocol.keepalive-without-calls={true｜false}　〜<<false>>

未処理のRPCがない場合にキープアライブを実行するかどうかを選択します。

指定できる値を次に示します。これ以外の値を指定した場合，gRPCアダプタの起動でエラーとなります。大文字と小文字は区別されます。

true

未処理のRPCがない場合にキープアライブを実行します。gRPCサーバ側でも同様の設定がされていなければ無効になります。

「true」を選択すると未使用の接続が解放されないため，帯域幅の消費量とCPU使用率が増加します。

false

未処理のRPCがない場合にキープアライブを実行しません。

通常はデフォルトの「false」を選択し，かつアイドルタイムアウト時間をadpgrpc.protocol.idle-timeoutプロパティで設定して，未使用の接続を適切に解放することを推奨します。

adpgrpc.protocol.idle-timeout=アイドルタイムアウト時間　〜((1000−2592000000))<<1800000>>

未処理のRPCがない場合に，チャネルの状態をアイドル状態に移行するまでの時間をミリ秒単位で指定します。範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。

タイムアウトを無効にする場合，最大値を指定してください。

adpgrpc.protocol.deadline=リクエストの実行期限　〜((0−315576000000.999999999の数値を文字列で表現したもの))<<0>>

RPCがDEADLINE_EXCEEDEDでエラー終了する前の完了待ち時間を指定します。

範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。0より小さい値を設定した場合の動作は保証しません。

整数部は秒に，小数部はナノ秒に変換されます。

小数部分が9桁を超える場合，10桁以降の小数部分は無視されます。

タイムアウトを無効にする場合，0を指定するか，プロパティの指定を省略してください。

指定された実行期限を過ぎてもRPCが完了しなかった場合，リクエストはエラーとなり，ステータスコード「DEADLINE_EXCEEDED」が返却されます。

adpgrpc.protocol.wait-for-ready={true｜false}　〜<<false>>

gRPC呼び出しを待機するかどうかを次のどちらかで指定します。大文字と小文字は区別されます。これ以外の値を指定した場合，gRPCアダプタの起動でエラーとなります。

true

待機します。

false

待機しません。

adpgrpc.protocol.message-compression.enabled={true｜false}　〜<<false>>

gRPCサービスへ送信するメッセージの圧縮有無を指定します。大文字と小文字は区別されます。これ以外の値を指定した場合，gRPCアダプタの起動でエラーとなります。

true

圧縮します。

false

圧縮しません。

(b)　データサイズ制限

adpgrpc.data-size-limit.max-inbound-message-size=gRPCアダプタで受信できる最大メッセージサイズ　〜((0−2147483647))<<4194304>>

gRPCアダプタで受信できる最大メッセージサイズをバイト単位で設定します。範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。

指定された値を超える受信メッセージが受信された場合，そのメッセージは処理されないで，RPCはステータスコード「RESOURCE_EXHAUSTED」で失敗します。

adpgrpc.data-size-limit.max-outbound-message-size=gRPC呼び出しで送信できる最大メッセージサイズ　〜((0−2147483647))<<2147483647>>

gRPC呼び出しで送信できる最大メッセージサイズをバイト単位で設定します。範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。

指定された値を超えるメッセージを送信しようとした場合，そのメッセージは処理されないで，エラーメッセージ「KDEC84004-E」を出力してリクエスト処理が失敗します。

adpgrpc.data-size-limit.max-inbound-metadata-size=受信できるメタデータの最大サイズ　〜((1−2147483647))<<8192>>

受信できるメタデータの最大サイズをバイト単位で設定します。範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。

(c)　フォルト応答

adpgrpc.response-code.fault=フォルト処理するステータスコード

フォルト処理するステータスコードをコンマ（,）区切りで指定します。

指定できるステータスコードを次に示します。各ステータスコードの意味については，gRPCのドキュメントを参照してください。

CANCELLED

UNKNOWN

INVALID_ARGUMENT

DEADLINE_EXCEEDED

NOT_FOUND

ALREADY_EXISTS

PERMISSION_DENIED

RESOURCE_EXHAUSTED

FAILED_PRECONDITION

ABORTED

OUT_OF_RANGE

UNIMPLEMENTED

INTERNAL

UNAVAILABLE

DATA_LOSS

UNAUTHENTICATED

これ以外の値を設定した場合，gRPCアダプタの起動でエラーとなります。

3.17　gRPC受付で利用するファイル

3.17.1　gRPC受付定義ファイル

(1)　形式

［urecp-grpc.resource-adapter=gRPCインバウンドアダプタの表示名］
［urecp-grpc.pooled-instance.minimum=プール内インスタンスの最小数］
［urecp-grpc.pooled-instance.maximum=プール内インスタンスの最大数］
［urecp-grpc.ejb-transaction-timeout=EJBトランザクションタイムアウト時間］
［grpcrecp.system-exception.status-code=システム例外時のステータスコード］
［grpcrecp.message-compression.enabled={true｜false}］

(2)　機能

gRPCインバウンドアダプタ内で動作するgRPCサービスの動作や，gRPC受付の動作を設定します。設定した内容は，gRPC受付のデプロイ時，gRPC受付の起動時，またはcsccmctlコマンドの実行時に読み込まれます。

gRPC受付定義ファイルが設定されていない場合は，デフォルト値が適用されます。また，gRPC受付のデプロイ時にメッセージKDEC10105-Wが出力されます。

gRPC受付定義ファイルは「cscurecpgrpc.properties」というファイル名で作成してください。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-reception¥gRPC¥config¥templates¥cscurecpgrpc.properties

注意事項

ここに格納されているファイルはテンプレートファイルです。gRPC受付定義ファイルを編集する場合は，gRPC受付の追加時にユーザ定義受付定義画面（詳細）で［独自定義ファイル］の［編集］ボタンをクリックし，定義ファイルの内容を修正してください。

(4)　設定できるプロパティ

urecp-grpc.resource-adapter=gRPCインバウンドアダプタの表示名　〜＜英数字およびアンダーバー（_）＞((1−240文字))<<gRPC_Inbound_Resource_Adapter>>

受付処理が使用するgRPCインバウンドアダプタの表示名（Connector属性ファイルのdisplay-nameタグの設定値）を指定します。

gRPCインバウンドアダプタの表示名として，240バイト以内の文字列を指定します。

文字列長が上限を超えている場合や，使用できない文字を指定した場合は，gRPC受付のデプロイ時にエラーとなります。

urecp-grpc.pooled-instance.minimum=プール内インスタンスの最小数　〜＜整数＞((0または1−2147483647))<<0>>

カスタム受付フレームワークのプール内インスタンスの最小数を指定します。

0を指定した場合，制限はありません。

範囲外の値が指定された場合は，運用コマンドおよびコマンド制御（MBean）の実行時にエラーになります。

指定値がプール内インスタンスの最大数（urecp-grpc.pooled-instance.maximumプロパティで指定）より大きいと，運用コマンドおよびコマンド制御（MBean）の実行時にエラーとなります。

キーまたは値が省略された場合は次のように動作します。

運用コマンドおよびコマンド制御（MBean）の実行時に，値のチェック処理が実行されません。

コマンド制御（MBean）実行時に，gRPC受付のアプリケーション統合属性ファイルの対象要素に値が適用されません。

なお，受付処理のプール内インスタンスの最小数は「1」固定のため，このプロパティでは変更できません。

urecp-grpc.pooled-instance.maximum=プール内インスタンスの最大数　〜＜整数＞((0または1−2147483647))<<0>>

受付処理およびカスタム受付フレームワークのプール内インスタンスの最大数を指定します。

0（無制限）を指定した場合，受付処理のプール内インスタンスの最大数には1が設定されます。

範囲外の値が指定された場合は，運用コマンドおよびコマンド制御（MBean）の実行時にエラーになります。

キーまたは値が省略された場合は次のように動作します。

運用コマンドおよびコマンド制御（MBean）の実行時に，値のチェック処理が実行されません。

コマンド制御（MBean）実行時に，gRPC受付のアプリケーション統合属性ファイルの対象要素に値が適用されません。

指定値がプール内インスタンスの最小数（urecp-grpc.pooled-instance.minimumプロパティで指定）より小さいと，運用コマンドおよびコマンド制御（MBean）の実行時にエラーとなります。

urecp-grpc.ejb-transaction-timeout=EJBトランザクションタイムアウト時間　〜＜数字＞((0または1−2147483647))<<0>>

受付処理およびカスタム受付フレームワークのEJBトランザクションタイムアウト時間（秒）を指定します。

0を指定した場合，J2EEサーバに設定されたデフォルトのタイムアウト値で動作します。

grpcrecp.system-exception.status-code=システム例外時のステータスコード　〜<<INTERNAL>>

システム例外時のステータスコードを次の中から指定します。各ステータスコードの意味については，gRPCのドキュメントを参照してください。

CANCELLED

UNKNOWN

INVALID_ARGUMENT

DEADLINE_EXCEEDED

NOT_FOUND

ALREADY_EXISTS

PERMISSION_DENIED

RESOURCE_EXHAUSTED

FAILED_PRECONDITION

ABORTED

OUT_OF_RANGE

UNIMPLEMENTED

INTERNAL

UNAVAILABLE

DATA_LOSS

UNAUTHENTICATED

grpcrecp.message-compression.enabled={true｜false}　〜<<false>>

gRPCクライアントへ返却するメッセージを圧縮するかどうかを次のどちらかで指定します。メッセージの圧縮タイプはgzip形式です。

true

メッセージを圧縮します。

false

メッセージを圧縮しません。

3.18　JSON形式データとXML形式データの変換で利用するファイル

3.18.1　JSON-XML変換定義ファイル

(1)　形式

［json-xml-convert.arrays.parent-element-name=XML形式データのルート要素の名称］
［json-xml-convert.arrays.child-element-name=XML形式データの繰り返し要素の名称］
［json-xml-convert.arrays.child-simple-element-name=XML形式データの繰り返し要素内に定義される子要素の名称］
［json-xml-convert.root-element-name=XML形式データのルート要素の名称］
［json-xml-convert.json-type.include={true｜false}］

(2)　機能

JSON形式データとXML形式データとの間の変換に関する動作を設定します。このファイルは，開発環境での次に示すHCSCコンポーネントの作成時に独自定義ファイルとして設定します。

HTTP受付

Kafka受付

HTTPアダプタ

Kafkaアダプタ

このファイルは次のコマンドで使用します。JSON-XML変換APIからは使用しません。

cscjson2xsdコマンド（JSON形式データからXSDファイルへの変換）

cscjsonxmlconvコマンド（JSON形式データとXML形式データの相互変換）

cscoas2servicedefコマンド（OpenAPI仕様書をHCSCコンポーネントの定義に変換）

なお，このファイルは実行環境でも使用できます。JSON変換ツールの実行結果が同じになるよう，開発環境と実行環境で同じファイルを使用してください。

次に示すテンプレートファイルを編集して使用してください。

テンプレートファイルの場所

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥msg¥templates¥csc_json_converter.properties

JSON-XML変換定義ファイルは，次に示す手順で編集します。

サービスアダプタ定義画面（詳細）の［独自定義ファイル］の［追加］ボタンをクリックして，JSON-XML変換定義ファイルのテンプレートファイルを追加します。

［独自定義ファイル］の［編集］ボタンをクリックします。

JSON-XML変換定義ファイルを編集するためのエディタが起動します。

エディタ上でJSON-XML変換定義ファイルを編集します。

Eclipseのメニューから［ファイル］−［保存］を選択し，編集内容を保存します。

ファイル名は「csc_json_converter.properties」で固定です。これ以外のファイル名を独自定義ファイルとして設定しても無効となります。また，独自定義ファイルに「csc_json_converter.properties」を設定しない場合，JSON-XML変換はデフォルトの設定で動作します。

また，定義したJSON-XML変換定義ファイルをJSON形式データの変換時に読み込むには，cscjson2xsdコマンドまたはcscjsonxmlconvコマンドを次のどちらかの方法で実行します。

引数-fにJSON-XML変換定義ファイル名を指定してコマンドを実行する方法

次に示すパスにJSON-XML変換定義ファイルを格納しておき，引数-fを指定しないでコマンドを実行する方法

<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥config¥tools¥json¥csc_json_converter.properties

このディレクトリにファイルが格納された状態で引数-fを指定して実行すると，引数-fで指定したJSON-XML変換定義ファイルが適用されます。

JSON変換ツール（cscjson2xsdコマンドまたはcscjsonxmlconvコマンド）を使用した変換については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「13.　JSON変換ツールを使用したデータ変換」を参照してください。

設定した内容は，該当する受付またはサービスアダプタの開始時に有効になります。定義内容が不正な場合は，該当する受付またはサービスアダプタの配備時，または起動時にエラーとなります。

(3)　設定できるプロパティ

json-xml-convert.arrays.parent-element-name=XML形式データのルート要素の名称　〜＜NCName型の文字列＞<<csc-array>>

JSON形式データが配列から始まる場合に生成される，XML形式データのルート要素の名称を指定します。

json-xml-convert.arrays.child-element-name=XML形式データの繰り返し要素の名称　〜＜NCName型の文字列＞<<csc-element>>

JSON形式データの配列に対応する，XML形式データの繰り返し要素の名称を指定します。

json-xml-convert.arrays.child-simple-element-name=XML形式データの繰り返し要素内に定義される子要素の名称　〜＜NCName型の文字列＞<<csc-simple>>

JSON形式データの文字列型，数値型，またはboolean型の配列値に対応する，XML形式データの繰り返し要素内に定義される子要素の名称を指定します。

json-xml-convert.root-element-name=XML形式データのルート要素の名称　〜＜NCName型の文字列＞<<csc-object>>

JSON形式データがオブジェクト型から始まる場合に生成される，XML形式データのルート要素の名称を指定します。

json-xml-convert.json-type.include={true｜false}　〜<<false>>

JSONのデータ種別をXML形式データの属性に含めるかどうかを指定します。

true

JSON形式データのデータ種別をXML形式データの属性に含めます。

false

JSON形式データのデータ種別をXML形式データの属性に含めません。

(4)　記述例

記述例を次に示します。

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.19　データ変換単体テストコマンドで利用するファイル

3.19.1　データ変換コマンドプロパティファイル

(1)　形式

  csctransform.xsl=XSLファイル（マッピング定義）のパス
  csctransform.input.format<n>=入力フォーマット定義ファイルのパス
  csctransform.input.data<n>=入力ファイルのパス
［csctransform.input.name<n>=入力スキーマの論理名］
  csctransform.output.format=出力フォーマット定義ファイルのパス
  csctransform.output.data=出力ファイルのパス
［csctransform.uoc.class=文字コード変換UOCのクラス名］
［csctransform.uoc.property=文字コード変換UOCの独自定義ファイルのパス］
［csctransform.code.table.root.path=コード変換テーブルの格納パスのルートパス］
［csctransform.validate={true｜false}］
［csctransform.debugtrace={ON｜OFF}］
［csctransform.debugtrace.filepath=デバッグ情報の出力先パス］
［csctransform.system.properties=データ変換用システムプロパティファイルのパス］
［csctransform.undefined.code={ERROR｜REPLACE}］

(2)　機能

csctransformコマンドの引数をプロパティ形式でファイルに設定します。設定したファイルは，csctransformコマンドの-fオプションで指定できます。csctransformコマンドについては，「csctransform（データ変換のテスト）」を参照してください。

csctransformコマンドの引数との対応

このファイルで設定するプロパティと，csctransformコマンドの引数との対応を次に示します。

項番

プロパティのキー名

対応するコマンド引数

設定内容

1

csctransform.xsl

-xsl

XSLファイル（マッピング定義）のパス

2

csctransform.input.format<n>

-informat

入力フォーマット定義ファイルのパス

3

csctransform.input.data<n>

-infile

入力ファイルのパス

4

csctransform.input.name<n>

なし

入力スキーマの論理名

5

csctransform.output.format

-outformat

出力フォーマット定義ファイルのパス

6

csctransform.output.data

-outfile

出力ファイルのパス

7

csctransform.uoc.class

-uocclass

文字コード変換UOCのクラス名

8

csctransform.uoc.property

-uocproperty

文字コード変換UOCの独自定義ファイルのパス

9

csctransform.code.table.root.path

-codetablerootpath

コード変換テーブルの格納パスのルートパス

10

csctransform.validate

-validate

入力ファイルまたは出力ファイルのスキーマ検証の有無

11

csctransform.debugtrace

-debugtrace

デバッグ情報の出力有無

12

csctransform.debugtrace.filepath

-debugtracefilepath

デバッグ情報の出力先パス

13

csctransform.system.properties

-cscdtsysprop

データ変換用システムプロパティファイルのパス

14

csctransform.undefined.code

-undefinedcode

未定義の文字コードへの対処

ファイルの編集方法

ファイルはJavaのプロパティファイル形式で設定します。使用できる文字コードはUTF-8だけです。

次に示すテンプレートファイルを編集して，任意のファイル名で保存してください。

テンプレートファイルの場所

<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥template¥cscdt_csctransform.properties

(3)　設定できるプロパティ

csctransform.xsl=XSLファイル（マッピング定義）のパス

XSLファイル（マッピング定義）のパスを絶対パスまたは相対パスで指定します。

同じプロパティを複数指定した場合，どれが有効になるかは保証されません。

csctransform.input.format<n>=入力フォーマット定義ファイルのパス

入力フォーマット定義ファイル（拡張子「.xsd」または「.fdx」）のパスを絶対パスまたは相対パスで指定します。

<n>には1以上の整数（半角）を連番で指定します。重複する整数を<n>に指定した場合，どのプロパティが有効になるかは保証されません。

次のように設定すると，<n>が1から5まで連番で指定されていると解釈されます。

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

次のように設定すると，<n>が連番でない（5が指定されていない）ため，1から4までが指定されていると解釈されます。

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

次のように設定すると，<n>に1が指定されていないため，設定内容が不正と判断され，エラーになります。

csctransform.input.format2 = c:¥¥temp¥¥format2.xsd
csctransform.input.format3 = c:¥¥temp¥¥format3.xsd
csctransform.input.format4 = c:¥¥temp¥¥format4.xsd

csctransform.input.data<n>=入力ファイルのパス

入力ファイルのパスを絶対パスまたは相対パスで指定します。

<n>には1以上の整数（半角）を連番で指定します。重複する整数を<n>に指定した場合，どのプロパティが有効になるかは保証されません。

csctransform.input.name<n>=入力スキーマの論理名

n対1変換の場合に入力スキーマの論理名を指定します。省略すると，データ変換の実行でエラーになります。

<n>には1以上の整数（半角）を連番で指定します。重複する整数を<n>に指定した場合，どのプロパティが有効になるかは保証されません。

1対1変換の場合はこのプロパティの指定は不要です。指定しても無視されます。

csctransform.output.format=出力フォーマット定義ファイルのパス

出力フォーマット定義ファイル（拡張子「.xsd」または「.fdx」）のパスを絶対パスまたは相対パスで指定します。

同じプロパティを複数指定した場合，どれが有効になるかは保証されません。

csctransform.output.data=出力ファイルのパス

出力ファイルのパスを絶対パスまたは相対パスで指定します。出力先のディレクトリが存在しない場合はエラーになります。

指定したパスに同名のファイルが存在する場合，ファイルを上書きします。同名のファイルが存在しない場合は，ファイルを新たに作成します。

同じプロパティを複数指定した場合，どれが有効になるかは保証されません。

csctransform.uoc.class=文字コード変換UOCのクラス名

文字コード変換UOCのクラス名を完全修飾名で指定します。

文字コード変換UOCのクラス名の指定が重複した場合は，次に示す優先順位で指定値が適用されます。

優先順位

プロパティファイル名／コマンド名

該当するプロパティ名／引数名

1

データ変換用システムプロパティファイル

csc.dt.ownCodeConverter.className

2

データ変換コマンドプロパティファイル

csctransform.uoc.class

3

csctransformコマンド

-uocclass

データ変換用システムプロパティファイルのcsc.dt.ownCodeConverter.classNameの設定については，「3.19.2　データ変換用システムプロパティファイル」を参照してください。csctransformコマンドについては，「csctransform（データ変換のテスト）」を参照してください。

csctransform.uoc.property=文字コード変換UOCの独自定義ファイルのパス

文字コード変換UOCの独自定義ファイルのパスを絶対パスまたは相対パスで指定します。

csctransform.uoc.classプロパティ（文字コード変換UOCのクラス名）が指定されている場合だけ有効です。

同じプロパティを複数指定した場合，どれが有効になるかは保証されません。

csctransform.code.table.root.path=コード変換テーブルの格納パスのルートパス

コード変換ライブラリで使用するコード変換テーブルの格納パスのルートパスを絶対パスまたは相対パスで指定します。

csctransform.validate={true｜false}　〜<<false>>

スキーマ検証の実施有無を指定します。

true

次に示すスキーマ検証を実施します。

入力ファイル（XML）に対して，入力フォーマット定義ファイル（XML Schema）を使ったスキーマ検証を実施します。

出力ファイル（XML）に対して，出力フォーマット定義ファイル（XML Schema）を使ったスキーマ検証を実施します。

false

スキーマ検証を実施しません。

同じプロパティを複数指定した場合，どれが有効になるかは保証されません。

csctransform.debugtrace={ON｜OFF}　〜<<OFF>>

デバッグ情報を出力するかどうかを指定します。

ON

出力します。

OFF

出力しません。

csctransform.debugtrace.filepath=デバッグ情報の出力先パス　〜<<csctransformコマンドの実行カレントディレクトリ>>

デバッグ情報の出力先パスを絶対パスまたは相対パスで指定します。

csctransform.debugtraceプロパティに「ON」を指定した場合だけ有効です。

次の場合はデフォルト値が適用され，csctransformコマンドを実行したカレントディレクトリにデバッグ情報が出力されます。

このプロパティを設定していない

このプロパティに出力先を指定していない

指定したディレクトリが存在しない

csctransform.system.properties=データ変換用システムプロパティファイルのパス

データ変換用システムプロパティファイルに設定したService Platformのシステムプロパティを有効にする場合，ファイルのパスを絶対パスまたは相対パスで指定します。

データ変換用システムプロパティファイルの設定内容については，「3.19.2　データ変換用システムプロパティファイル」を参照してください。

同じプロパティを複数指定した場合，どれが有効になるかは保証されません。

csctransform.undefined.code={ERROR｜REPLACE}　〜<<ERROR>>

バイナリデータの文字コード変換処理で未定義の文字コードを検出した場合の動作を指定します。

ERROR

検出時にエラーとなり処理を終了します。

REPLACE

未定義部分の文字コードを空白の文字コードに置換して処理を継続します。

同じプロパティを複数指定した場合，どれが有効になるかは保証されません。

(4)　注意事項

パスをワイルドカードで指定した場合の動作は保証しません。

パスのセパレータに「¥」を使用する場合はエスケープしてください。

3.19.2　データ変換用システムプロパティファイル

(1)　形式

［csc.dt.codetablepath=コード変換テーブルの格納パス］
［csc.dt.ownCodeConverter.className=文字コード変換UOCのクラス名］
［csc.dt.customFuncDir=カスタムファンクションで使用するjarファイルの格納パス］
［csc.dt.valueTable.変換テーブルID=値置換えファンクションで使用する変換テーブルのファイルパス］
［csc.dt.valueTableSize=値置換えファンクションで使用する変換テーブルの合計ファイルサイズ］
［csc.dt.encodeType.変換テーブルID={MS932｜UTF8｜UTF16_BIG｜UTF16_LITTLE}］
［csc.dt.undefined.replace.データ変換種別=置換文字コード］
［csc.dt.sizeNode.includeSelfSize={true｜false}］

(2)　機能

Service Platformのデータ変換のシステムプロパティを設定します。設定したファイルは，cscbinaryparseコマンド，csctransformコマンド，およびcscgenbinaryコマンドの実行時に指定します。

(3)　ファイルの格納先

テンプレートファイルの格納場所を次に示します。任意のディレクトリにコピーし，ファイルを編集して任意のファイル名で保存してください。

テンプレートファイルの場所：

<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥template¥csctransform_sys.properties

(4)　設定できるプロパティ

csc.dt.codetablepath=コード変換テーブルの格納パス

文字コード変換UOCでコード変換のAPIを使用する場合に，Code Converterのコード変換テーブルの格納パスを次の形式で指定します。

<コード変換テーブル格納パスディレクトリ>/table

設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「2.7.2　文字コード変換UOCによる拡張」を参照してください。

csc.dt.ownCodeConverter.className=文字コード変換UOCのクラス名

開発環境で作成した文字コード変換UOCを実行環境で使用する場合に，文字コード変換UOCのクラス名を完全修飾名で登録します。設定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「付録H.2　文字コード変換UOCを使用するための設定」を参照してください。

なお，このプロパティはcscbinaryparseコマンド，csctransformコマンド，cscgenbinaryコマンド，およびそれらのコマンドプロパティファイルでも指定できます。重複して指定されている場合は，データ変換用システムプロパティファイルの指定が優先されます。該当するプロパティ名および引数名を次の表に示します。

プロパティファイル名／コマンド名

該当するプロパティ名／引数名

データ変換用システムプロパティファイル

csc.dt.ownCodeConverter.className

バイナリパースコマンドプロパティファイル（cscbinaryparseコマンドのコマンドプロパティファイル）

データ変換コマンドプロパティファイル（csctransformコマンドのコマンドプロパティファイル）

バイナリ電文生成コマンドプロパティファイル（cscgenbinaryコマンドのコマンドプロパティファイル）

csctransform.uoc.class

cscbinaryparseコマンド

csctransformコマンド

cscgenbinaryコマンド

-uocclass

csc.dt.customFuncDir=カスタムファンクションで使用するjarファイルの格納パス

カスタムファンクションで使用するjarファイルの格納先を変更する場合，パスを指定します。

注意事項

jarファイルの格納先としてサービスプラットフォームのインストールディレクトリ配下を指定すると，アンインストール時にjarファイルが削除されるおそれがあります。そのため，インストールディレクトリ配下以外の場所を設定してください。

csc.dt.valueTable.変換テーブルID=値置換えファンクションで使用する変換テーブルのファイルパス

開発環境で作成したデータ変換定義に値置換えファンクションが含まれる場合，値置換えファンクションで利用する変換テーブルのファイルパスを指定します。

変換テーブルID

変換テーブルの変換テーブルIDを指定します。

変換テーブルのファイルパス

変換テーブルのファイルパスを絶対パスで指定します。

csc.dt.valueTableSize=値置換えファンクションで使用する変換テーブルの合計ファイルサイズ　〜＜数字＞((1−2097151))<<10>>

開発環境で作成したデータ変換定義に値置換えファンクションが含まれる場合，値置換えファンクションで利用する変換テーブルの合計ファイルサイズ（単位：キロバイト）の上限値を正の整数で指定します。

指定を省略した場合は10が仮定されます。上限値を超えるサイズの変換テーブルを読み込むと，KDEC40730-EをJ2EEサーバのログファイルに出力し，HCSCサーバの起動を中断します。

csc.dt.encodeType.変換テーブルID={MS932｜UTF8｜UTF16_BIG｜UTF16_LITTLE}

開発環境で作成したデータ変換定義に値置換えファンクションが含まれる場合，値置換えファンクションで利用する文字コードを指定します。

csc.dt.undefined.replace.データ変換種別=置換文字コード

バイナリデータとUnicode文字列とを変換する場合，未定義の文字コードはデフォルトでは空白文字へ置換されますが，このプロパティに設定した任意の文字へ置換することもできます。

なお，任意の文字へ置換するには，次のどちらかにREPLACEを指定する必要があります。

csctransformコマンドの引数-undefinedcode

データ変換コマンドプロパティファイルのcsctransform.undefined.codeプロパティ

プロパティは変換する文字コードと置換種別によって，次のように異なります。置換する文字は16進数で指定してください。

バイナリデータをUnicode文字列に変換する場合

該当するシステムプロパティに置換文字コードをUnicode big endianの16進数で指定します。

指定できるシステムプロパティを次の表に示します。システムプロパティは，入力バイナリデータの置換種別ごとに指定できます。

表3‒2　システムプロパティ一覧（バイナリデータをUnicode文字列に変換する場合）

項番

キー名称

置換種別

変換先のUnicode文字列の文字コード

1

csc.dt.undefined.replace.bin2xml

半角

Unicode big endian

2

csc.dt.undefined.replace.bin2xml.full

全角

Unicode文字列をバイナリデータに変換する場合

該当するシステムプロパティに置換文字コードを16進数で指定します。

指定できるシステムプロパティを次の表に示します。システムプロパティは，変換先のバイナリデータの文字コードと置換種別ごとに指定できます。

表3‒3　システムプロパティ一覧（Unicode文字列をバイナリデータに変換する場合）

項番

キー名称

置換種別

変換先のバイナリデータの文字コード

1

csc.dt.undefined.replace.xml2utf16be

半角

UTF16 big endian

2

csc.dt.undefined.replace.xml2utf16be.full

全角

3

csc.dt.undefined.replace.xml2utf16le

半角

UTF16 little endian

4

csc.dt.undefined.replace.xml2utf16le.full

全角

5

csc.dt.undefined.replace.xml2utf8

半角

UTF8

6

csc.dt.undefined.replace.xml2utf8.full

全角

7

csc.dt.undefined.replace.xml2ms932

半角

MS932

8

csc.dt.undefined.replace.xml2ms932.full

全角

9

csc.dt.undefined.replace.xml2keisC

半角

KEIS＋EBCDIC

10

csc.dt.undefined.replace.xml2keisC.full

全角

11

csc.dt.undefined.replace.xml2keisK

半角

KEIS＋EBCDIK

12

csc.dt.undefined.replace.xml2keisK.full

全角

13

csc.dt.undefined.replace.xml2keis.full

全角

KEIS

14

csc.dt.undefined.replace.xml2ibmC.latin

半角

IBM＋EBCDIC(LATIN)

15

csc.dt.undefined.replace.xml2ibmC.latin.full

全角

16

csc.dt.undefined.replace.xml2ibmC.kana

半角

IBM＋EBCDIC(KANA)

17

csc.dt.undefined.replace.xml2ibmC.kana.full

全角

18

csc.dt.undefined.replace.xml2ibm.full

全角

IBM

19

csc.dt.undefined.replace.xml2jefC

半角

JEF＋EBCDIC

20

csc.dt.undefined.replace.xml2jefC.full

全角

21

csc.dt.undefined.replace.xml2jefK

半角

JEF＋EBCDIK

22

csc.dt.undefined.replace.xml2jefK.full

全角

23

csc.dt.undefined.replace.xml2jef.full

全角

JEF

24

csc.dt.undefined.replace.xml2jis

半角

JIS

25

csc.dt.undefined.replace.xml2jis.full

全角

26

csc.dt.undefined.replace.xml2euc

半角

EUC

27

csc.dt.undefined.replace.xml2euc.full

全角

28

csc.dt.undefined.replace.xml2euchj

半角

EUC_HJ

29

csc.dt.undefined.replace.xml2euchj.full

全角

csc.dt.sizeNode.includeSelfSize={true｜false}　〜<<false>>

サイズノードの拡張機能を使用するかどうかを指定します。

true

サイズノードの拡張機能を使用します。

false

サイズノードの拡張機能を使用しません。

3.19.3　バイナリ電文生成コマンドプロパティファイル

(1)　形式

  csctransform.format=バイナリフォーマット定義ファイルのパス
  csctransform.output.binary.data=出力バイナリファイルのパス
  csctransform.output.xml.data=出力XMLファイルのパス
［csctransform.input.xml.data=入力XMLファイルのパス］
［csctransform.generate.property=バイナリ電文生成定義ファイルのパス］
［csctransform.uoc.class=文字コード変換UOCのクラス名］
［csctransform.uoc.property=文字コード変換UOCの独自定義ファイルのパス］
［csctransform.code.table.root.path=コード変換テーブルの格納パスのルートパス］
［csctransform.debugtrace={ON｜OFF}］
［csctransform.debugtrace.filepath=デバッグ情報の出力先パス］
［csctransform.system.properties=データ変換用システムプロパティファイルのパス］
［csctransform.undefined.code={ERROR｜REPLACE}］

(2)　機能

cscgenbinaryコマンドの引数をプロパティ形式でファイルに設定します。設定したファイルは，cscgenbinaryコマンドの実行時に-fオプションで指定できます。cscgenbinaryコマンドについては，「cscgenbinary（バイナリフォーマット定義ファイルからバイナリ電文の生成）」を参照してください。

cscgenbinaryコマンドの引数との対応

このファイルで設定するプロパティと，cscgenbinaryコマンドの引数との対応を次に示します。

項番

プロパティのキー名

対応するコマンド引数

設定内容

1

csctransform.format

-format

バイナリフォーマット定義ファイルのパス

2

csctransform.output.binary.data

-outbinfile

出力バイナリファイルのパス

3

csctransform.output.xml.data

-outxmlfile

出力XMLファイルのパス

4

csctransform.input.xml.data

-inxmlfile

入力XMLファイルのパス

5

csctransform.generate.property

-genproperty

バイナリ電文生成定義ファイルのパス

6

csctransform.uoc.class

-uocclass

文字コード変換UOCのクラス名

7

csctransform.uoc.property

-uocproperty

文字コード変換UOCの独自定義ファイルのパス

8

csctransform.code.table.root.path

-codetablerootpath

コード変換テーブルの格納パスのルートパス

9

csctransform.debugtrace

-debugtrace

デバッグ情報の出力有無

10

csctransform.debugtrace.filepath

-debugtracefilepath

デバッグ情報の出力先パス

11

csctransform.system.properties

-cscdtsysprop

データ変換用システムプロパティファイルのパス

12

csctransform.undefined.code

-undefinedcode

未定義の文字コードへの対処

ファイルの編集方法

ファイルはJavaのプロパティファイル形式で設定します。使用できる文字コードはUTF-8だけです。

次に示すテンプレートファイルを編集して，任意のファイル名で保存してください。

テンプレートファイルの場所

<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥template¥cscdt_cscgenbinary.properties

(3)　設定できるプロパティ

csctransform.format=バイナリフォーマット定義ファイルのパス

エディタでの検証が完了しているバイナリフォーマット定義ファイルのパスを絶対パスまたは相対パスで指定します。

指定できるファイルの拡張子は「.fdx」だけです。拡張子の大文字・小文字は区別しません。

csctransform.output.binary.data=出力バイナリファイルのパス

出力バイナリファイルのパスを絶対パスまたは相対パスで指定します。出力先のディレクトリが存在しない場合はエラーになります。

csctransform.output.binary.data（出力バイナリファイルのパス）とcsctransform.output.xml.data（出力XMLファイルのパス）は，どちらか一方を指定してください。

指定したパスに同名のファイルが存在する場合，ファイルを上書きします。同名のファイルが存在しない場合は，ファイルを新たに作成します。

csctransform.output.xml.data=出力XMLファイルのパス

出力XMLファイルのパスを絶対パスまたは相対パスで指定します。出力先のディレクトリが存在しない場合はエラーになります。

csctransform.output.binary.data（出力バイナリファイルのパス）とcsctransform.output.xml.data（出力XMLファイルのパス）は，どちらか一方を指定してください。

指定したパスに同名のファイルが存在する場合，ファイルを上書きします。同名のファイルが存在しない場合は，ファイルを新たに作成します。

csctransform.input.xml.data=入力XMLファイルのパス

XMLファイルからバイナリ電文を生成する場合に，入力XMLファイルのパスを絶対パスまたは相対パスで指定します。

csctransform.output.xml.dataと同時に指定すると，このプロパティの指定は無効になります。

指定する入力XMLファイルは，バイナリフォーマット定義ファイル（csctransform.formatで指定）を基にcscfdx2xsdコマンドで生成したXMLスキーマファイルに沿っている必要があります。XMLスキーマファイルに沿っていない場合は動作を保証しません。

csctransform.generate.property=バイナリ電文生成定義ファイルのパス

バイナリ電文生成定義ファイルのパスを絶対パスまたは相対パスで指定します。

csctransform.input.xml.dataと同時に指定すると，このプロパティの指定は無効になります。

バイナリ電文生成定義ファイルは，単純内容要素の要素値をデフォルト値から変更したい場合に作成します。バイナリ電文生成定義ファイルについては，「3.19.4　バイナリ電文生成定義ファイル」を参照してください。

csctransform.uoc.class=文字コード変換UOCのクラス名

文字コード変換UOCのクラス名を完全修飾名で指定します。

文字コード変換UOCのクラス名は，次に示すファイルまたはコマンドでも指定できます。指定が重複した場合に適用される優先順位を次に示します。

優先順位

プロパティファイル名／コマンド名

該当するプロパティ名／引数名

1

データ変換用システムプロパティファイル

csc.dt.ownCodeConverter.className

2

バイナリ電文生成コマンドプロパティファイル

csctransform.uoc.class

3

cscgenbinaryコマンド

-uocclass

データ変換用システムプロパティファイルのcsc.dt.ownCodeConverter.classNameの設定については，「3.19.2　データ変換用システムプロパティファイル」を参照してください。cscgenbinaryコマンドについては，「cscgenbinary（バイナリフォーマット定義ファイルからバイナリ電文の生成）」を参照してください。

なお，文字コード変換UOCを使用する場合は，文字コード変換UOCのjarファイルをシステム環境変数CSC_DATA_TRANSFORM_CLASSPATHに設定してください。外部のjarファイルに定義されているクラスをカスタムファンクションや文字コード変換UOCから呼び出す場合も，該当するjarファイルを環境変数に設定する必要があります。

csctransform.uoc.property=文字コード変換UOCの独自定義ファイルのパス

文字コード変換UOCの独自定義ファイルのパスを絶対パスまたは相対パスで指定します。

csctransform.uoc.classプロパティが設定されていない場合は，このプロパティの指定は無効となります。csctransform.uoc.classプロパティを指定してこの引数を省略した場合は，独自定義ファイルを読み込まない状態で文字コード変換UOCのクラスがデータ変換時に実行されます。

csctransform.code.table.root.path=コード変換テーブルの格納パスのルートパス

コード変換ライブラリで使用するコード変換テーブルの格納パスのルートパスを絶対パスまたは相対パスで指定します。

csctransform.debugtrace={ON｜OFF}　〜<<OFF>>

デバッグ情報を出力するか指定します。

ON

出力します。

OFF

出力しません。

csctransform.debugtrace.filepath=デバッグ情報の出力先パス　〜<<cscgenbinaryコマンドの実行カレントディレクトリ>>

デバッグ情報の出力先パスを絶対パスまたは相対パスで指定します。

csctransform.debugtraceプロパティに「ON」を指定した場合だけ有効です。

次の場合はデフォルト値が適用され，cscgenbinaryコマンドを実行したカレントディレクトリにデバッグ情報が出力されます。

このプロパティを設定していない

このプロパティにデバッグ情報の出力先を指定していない

指定したディレクトリが存在しない

csctransform.system.properties=データ変換用システムプロパティファイルのパス

データ変換用システムプロパティファイルに設定したService Platformのシステムプロパティを有効にする場合，ファイルのパスを絶対パスまたは相対パスで指定します。

データ変換用システムプロパティファイルの設定内容については，「3.19.2　データ変換用システムプロパティファイル」を参照してください。

csctransform.undefined.code={ERROR｜REPLACE}　〜<<ERROR>>

バイナリデータの文字コード変換時に未定義の文字コードを検出した場合の動作を指定します。

ERROR

検出時にエラーとなり処理を終了します。

REPLACE

未定義部分の文字コードを空白の文字コードに置換して処理を継続します。

(4)　注意事項

パスをワイルドカードで指定した場合の動作は保証しません。

パスのセパレータに「¥」を使用する場合はエスケープしてください。

3.19.4　バイナリ電文生成定義ファイル

(1)　形式

次の3とおりの方法で記述できます。

指定形式1

<ルートからの絶対パスで記述した要素名>＝<設定値>

指定形式2

<要素名>＝<設定値>

指定形式3

［CSCDT_STRING=データ種別「文字列」の設定値］
［CSCDT_INT=データ種別「整数」の設定値］
［CSCDT_DOUBLE=データ種別「実数」の設定値］
［CSCDT_IMPLICIT=データ種別「固定小数部数値」の設定値］
［CSCDT_ZONE=データ種別「ゾーン形式数値」の設定値］
［CSCDT_PACK=データ種別「パック形式数値」の設定値］
［CSCDT_SIGNED=データ種別「符号付2進整数」の設定値］
［CSCDT_UNSIGNED=データ種別「符号無2進整数」の設定値］
［CSCDT_BINARY_HEX=データ種別「バイト列（hexBinary）」の設定値］
［CSCDT_BINARY_BASE64=データ種別「バイト列（base64Binary）」の設定値］
［CSCDT_BIT=データ種別「ビット列」の設定値］
［CSCDT_DATETIME=データ種別「日付時刻」の設定値］

同じ要素を異なる指定形式で記述した場合は，次の優先順に従って適用されます。

指定形式1

指定形式2

指定形式3

(2)　機能

バイナリ電文の生成時に，単純内容要素の要素値をデフォルト値から変更したい場合に設定します。文字コードはUTF-8とする必要があります。

このファイルは，バイナリ電文を次に示すコマンドまたはプロパティファイルで生成する場合に指定します。バイナリ電文をデフォルト値で生成する場合は設定不要です。設定しなかった場合はデフォルトの要素値が適用されます。

cscgenbinaryコマンド

バイナリ電文生成定義ファイルのファイル名を-genpropertyオプションで指定します。

cscgenbinaryコマンドについては，「cscgenbinary（バイナリフォーマット定義ファイルからバイナリ電文の生成）」を参照してください。

バイナリ電文生成コマンドプロパティファイル

バイナリ電文生成定義ファイルのファイル名をcsctransform.generate.propertyプロパティで指定します。

バイナリ電文生成コマンドプロパティファイルについては，「3.19.3　バイナリ電文生成コマンドプロパティファイル」を参照してください。

(3)　ファイルの格納先

テンプレートファイルの格納場所を次に示します。

テンプレートファイルの場所：

<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥template¥cscdt_generatedef.properties

テンプレートファイルは指定形式3のプロパティ形式で記述されています。テンプレートファイルは任意のディレクトリにコピーし，ファイルを編集して任意のファイル名で保存してください。

(4)　設定できる値

単純内容要素の要素値のデフォルト値と，XMLの型を次に示します。ファイルに設定する値はそれぞれのXMLの型に従って設定してください。

表3‒4　バイナリ電文生成定義ファイルの設定値

データ種別

XMLの型

デフォルト値

指定形式3のプロパティ名

文字列

xsd:string

空文字列（長さ0バイト）

CSCDT_STRING

整数

xsd:decimal

0

CSCDT_INT

実数

xsd:decimal

0

CSCDT_DOUBLE

固定小数部数値

xsd:decimal

0

CSCDT_IMPLICIT

ゾーン形式数値

xsd:decimal

0

CSCDT_ZONE

パック形式数値

xsd:decimal

0

CSCDT_PACK

符号付2進整数

xsd:integer

0

CSCDT_SIGNED

符号無2進整数

xsd:integer

0

CSCDT_UNSIGNED

バイト列（hexBinary）

xsd:hexBinary

00 (0x00)

CSCDT_BINARY_HEX

バイト列（base64Binary）

xsd:base64Binary

AA== (0x00)

CSCDT_BINARY_BASE64

ビット列

xsd:hexBinary

00 (0x00)

CSCDT_BIT

日付時刻

xsd:date

YYMMDD形式

2000-01-01

（バイナリ変換後は000101）

CCYYMMDD形式

2000-01-01

（バイナリ変換後は20000101）

CSCDT_DATETIME

xsd:time

hhmmss形式

00:00:00

（バイナリ変換後は000000）

xsd:dateTime

YYMMDDhhmmss形式

2000-01-01T00:00:00

（バイナリ変換後は000101000000）

CCYYMMDDhhmmss形式

2000-01-01T00:00:00

（バイナリ変換後は20000101000000）

指定形式の種類と指定例を次に示します。「=」の後ろに<設定値>を指定しなかった要素は，空要素となります。

指定形式1の場合

<ルートからの絶対パスで記述した要素名>＝<設定値>

要素名と，変更後の設定値を指定します。要素名は，ルートからの絶対パスで指定します。

指定例を次に示します。

例：/root/complex/element=abc

指定形式2の場合

<要素名>＝<設定値>

要素名と，変更後の設定値を指定します。要素名にパス部分は指定しません。

指定例を次に示します。

例：element=abc

指定形式3の場合

<プロパティ名>＝<設定値>

データ種別に応じて，表「バイナリ電文生成定義ファイルの設定値」に示すプロパティ名と，変更後の設定値を指定します。

指定例を次に示します。

例：CSCDT_STRING=abc

3.19.5　バイナリパースコマンドプロパティファイル

(1)　形式

  csctransform.format=バイナリフォーマット定義ファイルのパス
  csctransform.input.data=入力データファイルのパス
  csctransform.output.data=出力データファイルのパス
［csctransform.inverse={true｜false}］
［csctransform.uoc.class=文字コード変換UOCのクラス名］
［csctransform.uoc.property=文字コード変換UOCの独自定義ファイルのパス］
［csctransform.code.table.root.path=コード変換テーブルの格納パスのルートパス］
［csctransform.debugtrace={ON｜OFF}］
［csctransform.debugtrace.filepath=デバッグ情報の出力先パス］
［csctransform.system.properties=データ変換用システムプロパティファイルのパス］
［csctransform.undefined.code={ERROR｜REPLACE}］

(2)　機能

cscbinaryparseコマンドの引数をプロパティ形式でファイルに設定します。設定したファイルは，cscbinaryparseコマンドの実行時に-fオプションで指定できます。cscbinaryparseコマンドについては，「cscbinaryparse（DOMとバイナリデータの相互変換）」を参照してください。

cscbinaryparseコマンドの引数との対応

このファイルで設定するプロパティと，cscbinaryparseコマンドの引数との対応を次に示します。

項番

プロパティのキー名

対応するコマンド引数

設定内容

1

csctransform.format

-format

バイナリフォーマット定義ファイルのパス

2

csctransform.input.data

-infile

入力データファイルのパス

3

csctransform.output.data

-outfile

出力データファイルのパス

4

csctransform.inverse

-inverse

バイナリとDOMの変換動作

5

csctransform.uoc.class

-uocclass

文字コード変換UOCのクラス名

6

csctransform.uoc.property

-uocproperty

文字コード変換UOCの独自定義ファイルのパス

7

csctransform.code.table.root.path

-codetablerootpath

コード変換テーブルの格納パスのルートパス

8

csctransform.debugtrace

-debugtrace

デバッグ情報の出力有無

9

csctransform.debugtrace.filepath

-debugtracefilepath

デバッグ情報の出力先パス

10

csctransform.system.properties

-cscdtsysprop

データ変換用システムプロパティファイルのパス

11

csctransform.undefined.code

-undefinedcode

未定義の文字コードへの対処

ファイルの編集方法

ファイルはJavaのプロパティファイル形式で設定します。使用できる文字コードはUTF-8だけです。

次に示すテンプレートファイルを編集して，任意のファイル名で保存してください。

テンプレートファイルの場所

<サービスプラットフォームのインストールディレクトリ>¥CSCTE¥template¥cscdt_cscbinaryparse.properties

(3)　設定できるプロパティ

csctransform.format=バイナリフォーマット定義ファイルのパス

入力フォーマット定義ファイルのパスを絶対パスまたは相対パスで指定します。

指定できるファイルの拡張子は「.fdx」だけです。

csctransform.input.data=入力データファイルのパス

入力データファイルのパスを絶対パスまたは相対パスで指定します。

入力データファイルとして指定できるデータの種類を次に示します。

バイナリデータ

次のどちらかのDOMデータ（XML）

バイナリデータからDOM変換で生成したDOMデータ

XMLスキーマファイル（csctransform.formatで指定したバイナリフォーマット定義ファイルをcscfdx2xsdコマンドに指定して生成）に沿ったDOMデータ

csctransform.output.data=出力データファイルのパス

出力データファイルのパスを絶対パスまたは相対パスで指定します。出力先のディレクトリが存在しない場合はエラーになります。

指定したパスに同名のファイルが存在する場合，ファイルを上書きします。同名のファイルが存在しない場合は，ファイルを新たに作成します。

csctransform.inverse={true｜false}　〜<<false>>

バイナリとDOMの変換動作を切り替えます。

true

DOMデータをバイナリデータに変換します。

false

バイナリデータをDOMデータに変換します。

csctransform.uoc.class=文字コード変換UOCのクラス名

文字コード変換UOCのクラス名を完全修飾名で指定します。

文字コード変換UOCのクラス名の指定が重複した場合は，次に示す優先順位で指定値が適用されます。

優先順位

プロパティファイル名／コマンド名

該当するプロパティ名／引数名

1

データ変換用システムプロパティファイル

csc.dt.ownCodeConverter.className

2

バイナリパースコマンドプロパティファイル

csctransform.uoc.class

3

cscbinaryparseコマンド

-uocclass

データ変換用システムプロパティファイルのcsc.dt.ownCodeConverter.classNameの設定については，「3.19.2　データ変換用システムプロパティファイル」を参照してください。cscbinaryparseコマンドについては，「cscbinaryparse（DOMとバイナリデータの相互変換）」を参照してください。

csctransform.uoc.property=文字コード変換UOCの独自定義ファイルのパス

文字コード変換UOCの独自定義ファイルのパスを絶対パスまたは相対パスで指定します。

csctransform.uoc.classプロパティが設定されていない場合は，このプロパティの指定は無効となります。

csctransform.code.table.root.path=コード変換テーブルの格納パスのルートパス

コード変換ライブラリで使用するコード変換テーブルの格納パスのルートパスを絶対パスまたは相対パスで指定します。

csctransform.debugtrace={ON｜OFF}　〜<<OFF>>

デバッグ情報を出力するか指定します。

ON

出力します。

OFF

出力しません。

csctransform.debugtrace.filepath=デバッグ情報の出力先パス

デバッグ情報の出力先パスを絶対パスまたは相対パスで指定します。

csctransform.debugtraceプロパティを指定した場合だけ有効になります。

次の場合はデフォルト値が適用され，ccscbinaryparseコマンドを実行したカレントディレクトリにデバッグ情報が出力されます。

このプロパティを設定していない

このプロパティに出力先を指定していない

指定したディレクトリが存在しない

csctransform.system.properties=データ変換用システムプロパティファイルのパス

データ変換用システムプロパティファイルに設定したService Platformのシステムプロパティを有効にする場合，ファイルのパスを絶対パスまたは相対パスで指定します。

データ変換用システムプロパティファイルの設定内容については，「3.19.2　データ変換用システムプロパティファイル」を参照してください。

csctransform.undefined.code={ERROR｜REPLACE}　〜<<ERROR>>

バイナリデータの文字コード変換時に未定義の文字コードを検出した場合の動作を指定します。

ERROR

検出時にエラーとなり処理を終了します。

REPLACE

未定義部分の文字コードを空白の文字コードに置換して処理を継続します。

(4)　注意事項

パスをワイルドカードで指定した場合の動作は保証しません。

パスのセパレータに「¥」を使用する場合はエスケープしてください。

3.20　ログ出力アクティビティで利用するファイル

3.20.1　ログ出力アクティビティ定義ファイル

(1)　形式

　log-activity.<ログ出力識別子>.filepath=ログ出力アクティビティのログファイルの出力先パス
［log-activity.<ログ出力識別子>.filesize=ログ出力アクティビティのログファイルの1面当たりのファイルサイズ］
［log-activity.<ログ出力識別子>.filenum=ログ出力アクティビティのログファイルのバックアップファイルの面数］
［log-activity.<ログ出力識別子>.level={TRACE｜DEBUG｜INFO｜WARN｜ERROR｜FATAL}］
［log-activity.<ログ出力識別子>.message-definition-filepath=メッセージ定義ファイルのファイルパス］

(2)　機能

ログ出力アクティビティで任意のメッセージを出力する場合に，出力するファイルの情報をログ出力アクティビティ定義ファイルで設定します。

［ログ出力アクティビティ］ダイアログと各定義ファイルの関係，およびログファイルの出力結果については，マニュアル「サービスプラットフォーム 解説」の「3.9　ログ出力アクティビティでのログ出力」を参照してください。

また，［ログ出力アクティビティ］ダイアログの指定方法については，「1.4.21　ログ出力アクティビティダイアログ」を参照してください。

(a)　作成手順

ログ出力アクティビティ定義ファイルの作成から，ログ出力アクティビティに割り当てるまでの流れを次に示します。

次のテンプレートファイルを基に，ログ出力アクティビティ定義ファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥bp¥templates¥log_activity_definition.properties

各プロパティのキー部分にはログ出力識別子を指定します。ログ出力識別子の指定については，「(b)　ログ出力識別子の定義」を参照してください。

各プロパティの指定方法については，「(3)　設定できるプロパティ」を参照してください。

編集後のファイルをファイル名「log_activity_definition.properties」で任意のディレクトリに格納してください。

ログ出力アクティビティ定義ファイルのパスをHCSCサーバランタイム定義ファイルのbp-log-activity-definition-filepathプロパティに指定します。

bp-log-activity-definition-filepathプロパティについては，「6.5.6　HCSCサーバランタイム定義ファイル」を参照してください。

ログ出力アクティビティの定義時に，［ログ出力アクティビティ］ダイアログの［ログ出力識別子］にログ出力識別子を指定します。

ログ出力アクティビティ定義ファイルに記述したログ出力識別子を指定してください。

複数のログ出力アクティビティから，1つのログ出力識別子を指定することもできます。これによって，複数のログ出力アクティビティから同じログファイルに出力させることができます。

なお，ログ出力アクティビティ定義ファイルの定義内容は，HCSCサーバの次回起動時から有効になります。

(b)　ログ出力識別子の定義

ログ出力識別子は，ログ出力アクティビティのログの出力先を一意に識別する文字列です。

ログ出力識別子には，次の条件を満たす値を指定してください。条件を満たさない値を指定した場合の動作は保証しません。

ログ出力識別子は最大20文字で指定してください。使用できる文字は，半角英数字およびアンダーバー（_）です。

複数のログ出力識別子で，同一のログ出力先を指定しないでください。

複数のHCSCサーバで，同一のログ出力先を指定しないでください。

定義されたログ出力識別子は，ログ出力アクティビティの定義時に［ログ出力アクティビティ］ダイアログの画面項目［ログ出力識別子］に指定することで有効になります。

(3)　設定できるプロパティ

log-activity.<ログ出力識別子>.filepath=ログ出力アクティビティのログファイルの出力先パス

ログファイルの出力先のファイルパスをファイル名も含めて設定します。パスを指定する場合の注意事項を次に示します。

相対パス，親ディレクトリ表現（「..¥」，「../」），およびカレントディレクトリ表現（「.¥」，「./」）を含むパスは指定しないでください。

シンボリックリンクを含むパスは指定しないでください。

Windowsの場合，UNC形式，NTFSのストリーム名，および予約デバイス名を含むパスは指定しないでください。また，パスの大文字と小文字は区別されません。

出力先として指定されたディレクトリが存在しない場合は，自動的に作成されます。

指定された出力先ファイルを開けなかった場合は，HCSCサーバの起動に失敗します。

なお，ログファイルのファイル名は，ローテーション方式に応じて次のようになります。

ラップアラウンドモードの場合：「ファイル名<面数>.log」

シフトモードの場合：「ファイル名.log」

log-activity.<ログ出力識別子>.filesize=ログ出力アクティビティのログファイルの1面当たりのファイルサイズ　〜＜数字＞((4096−2147483647))<<2097152>>

ログファイルの1面当たりのファイルサイズを設定します。不正な値を指定した場合，HCSCサーバの起動に失敗します。

log-activity.<ログ出力識別子>.filenum=ログ出力アクティビティのログファイルのバックアップファイルの面数　〜＜数字＞((1−16))<<4>>

ログファイルのバックアップファイルの面数を設定します。不正な値を指定した場合，HCSCサーバの起動に失敗します。

log-activity.<ログ出力識別子>.level={TRACE｜DEBUG｜INFO｜WARN｜ERROR｜FATAL}　〜<<ERROR>>

ログの出力レベルを次の中から設定します。不正な値を指定した場合，HCSCサーバの起動に失敗します。

TRACE

DEBUG

INFO

WARN

ERROR

FATAL

ログ出力アクティビティ定義ファイルとメッセージ定義ファイルの間で異なる出力レベルが設定された場合，次のように出力されます。

ログ出力アクティビティ定義ファイルの出力レベルの指定

メッセージ定義ファイルの出力レベルの指定

TRACE

DEBUG

INFO

WARN

ERROR

FATAL

TRACE

○

○

○

○

○

○

DEBUG

×

○

○

○

○

○

INFO

×

×

○

○

○

○

WARN

×

×

×

○

○

○

ERROR

×

×

×

×

○

○

FATAL

×

×

×

×

×

○

（凡例）

○：出力されます。

×：出力されません。

log-activity.<ログ出力識別子>.message-definition-filepath=メッセージ定義ファイルのファイルパス

出力するメッセージがメッセージ定義ファイルに定義されている場合に，メッセージ定義ファイルのファイルパスを指定します。

このプロパティは，ログ出力アクティビティの定義時に［ログ出力アクティビティ］ダイアログで［リソースKey］を選択する場合に必要です。［任意の文字列］を選択してメッセージをダイアログ上に直接指定する場合は，このプロパティは指定不要です。

パスを指定する場合の注意事項を次に示します。

相対パス，親ディレクトリ表現（「..¥」，「../」），およびカレントディレクトリ表現（「.¥」，「./」）を含むパスは指定しないでください。

シンボリックリンクを含むパスは指定しないでください。

Windowsの場合，UNC形式，NTFSのストリーム名，および予約デバイス名を含むパスは指定しないでください。また，パスの大文字と小文字は区別されません。

存在しないファイルパスを指定した場合や，入力形式に沿っていない場合は，HCSCサーバの起動に失敗します。

3.20.2　メッセージ定義ファイル

(1)　形式

リソースKey-ログの出力レベル=出力するメッセージ
　　：

(2)　機能

(a)　ログ出力アクティビティでの任意のメッセージの出力方法

ログ出力アクティビティで任意のメッセージを出力する場合，次のどちらかの方法で指定します。

［ログ出力アクティビティ］ダイアログの［任意の文字列］に，メッセージを直接指定する

メッセージ定義ファイルにメッセージを記述しておき，該当するプロパティのキーを［ログ出力アクティビティ］ダイアログの［リソースKey］に指定する

この項では，メッセージ定義ファイルの作成について説明します。

［ログ出力アクティビティ］ダイアログと各定義ファイルの関係，およびログファイルの出力結果については，マニュアル「サービスプラットフォーム 解説」の「3.9　ログ出力アクティビティでのログ出力」を参照してください。

また，［ログ出力アクティビティ］ダイアログの指定方法については，「1.4.21　ログ出力アクティビティダイアログ」を参照してください。

(b)　作成手順

メッセージ定義ファイルの作成から，ログ出力アクティビティに割り当てるまでの流れを次に示します。

次のテンプレートファイルを基に，メッセージ定義ファイルをプロパティ形式で記述します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥bp¥templates¥message_definition.properties

メッセージ定義ファイルには次の項目を記述します。各項目の指定規則は「(3)　設定できるプロパティ」を参照してください。

キー名には，リソースKeyと，ログの出力レベルを「-（半角ハイフン）」で連結して記述します。

指定値には，出力するメッセージを記述します。

1つのメッセージ定義ファイルには複数行記述できます。

ファイルは，ログ出力識別子ごと（ログの出力先ごと）に分けて作成してください。

メッセージ定義ファイルを格納します。

格納場所とファイル名は任意です。

メッセージ定義ファイルのパスをログ出力アクティビティ定義ファイルのlog-activity.<ログ出力識別子>.message-definition-filepathプロパティに設定します。

これによってログ出力識別子に割り当てられます。パスの設定方法については，「3.20.1　ログ出力アクティビティ定義ファイル」を参照してください。

ログ出力アクティビティの定義時に，［ログ出力アクティビティ］ダイアログの［リソースKey］を指定します。

［リソースKey］には，メッセージ定義ファイルに記述したプロパティのキー「リソースKey-ログの出力レベル」を指定してください。

複数のログ出力アクティビティから，1つのメッセージ定義ファイルを指定することもできます。

なお，メッセージ定義ファイルの定義内容は，HCSCサーバの次回起動時から有効になります。

(3)　設定できるプロパティ

リソースKey

リソースKeyを指定します。

ログの出力レベル　〜＜TRACE｜DEBUG｜INFO｜WARN｜ERROR｜FATAL＞

出力するメッセージのログの出力レベルを次の中から指定します。

TRACE

DEBUG

INFO

WARN

ERROR

FATAL

ログ出力アクティビティ定義ファイルとメッセージ定義ファイルの間で異なる出力レベルが設定された場合，次のように出力されます。

ログ出力アクティビティ定義ファイルの出力レベルの指定

メッセージ定義ファイルの出力レベルの指定

TRACE

DEBUG

INFO

WARN

ERROR

FATAL

TRACE

○

○

○

○

○

○

DEBUG

×

○

○

○

○

○

INFO

×

×

○

○

○

○

WARN

×

×

×

○

○

○

ERROR

×

×

×

×

○

○

FATAL

×

×

×

×

×

○

（凡例）

○：出力されます。

×：出力されません。

出力するメッセージ　〜＜java.text.MessageFormatで解釈できる値＞

出力するメッセージをjava.text.MessageFormatで解釈できる値で指定します。なお，FormatElementにFormatTypeとFormatStyleは指定できません。これらの条件を満たさない値を指定した場合の動作は保証しません。

出力するメッセージには，改行を含む文字列は設定できません。

メッセージには埋め込み文字として，ビジネスプロセス定義画面に指定した変数や，変数内の情報を埋め込むことができます。それぞれ指定できる内容を次に示します。

変数

変数の値を埋め込むことができます。ビジネスプロセスで定義できるすべての変数を使用できます。「non-XML」「any」の変数の場合，16進数に変換した値を埋め込みます。

変数内の情報

変数の部分またはXPathで取得した変数内の情報を埋め込むことができます。

埋め込み文字を使用する場合，メッセージに添字を{ }で囲んで指定します。

添字に割り当てる変数や式は，［ログ出力アクティビティ］ダイアログの［埋め込み要素値］で指定します。［ログ出力アクティビティ］ダイアログについては，「1.4.21　ログ出力アクティビティダイアログ」を参照してください。

(4)　記述例

メッセージ定義ファイルの記述例を次に示します。

msg_id_001-ERROR= The specified element is not defined. (element name = {0})
msg_id_002-WARN = The fault message has initialized.

3.21　ビジネスプロセスの実行で利用するファイル

3.21.1　ビジネスプロセス実行コマンド定義ファイル

(1)　形式

［hostname=IPアドレスまたはホスト名］
［port=ポート番号］
［protocol={http｜https}］
［cluster-name=クラスタ名］

［process-name=ビジネスプロセス名］
［bp-operation-name=オペレーション名］
［clientID=クライアント相関ID］
［telegram-filepath=要求電文を記載したファイルのパス］

［exceptionlog-filepath=例外ログの出力先パス］
［exceptionlog-filesize=例外ログの1ファイル当たりの上限サイズ］
［exceptionlog-filenum=例外ログの最大面数］

(2)　機能

ビジネスプロセス実行コマンド（csmexecutebpコマンド）の動作や，例外ログの情報などを設定します。このファイルは設定を省略することもできます。

設定したファイルは，csmexecutebpコマンドの実行時に-fオプションで指定できます。csmexecutebpコマンドについては，「csmexecutebp（ビジネスプロセスの実行）」を参照してください。

ファイルの編集方法

ファイルはJavaのプロパティファイル形式で設定します。使用できる文字コードはUTF-8だけです。

次に示すテンプレートファイルをコピーし，任意のディレクトリに任意のファイル名で保存して編集してください。

テンプレートファイルの場所

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥msg¥templates¥csmexecutebp_definition.properties

なお，保存先のディレクトリおよびファイルは，管理者権限のあるユーザがアクセスできることが必要です。

csmexecutebpコマンドとの関係

次の表に示す項目は，ビジネスプロセス実行コマンド定義ファイルとcsmexecutebpコマンドの両方で指定できます。両方に同じ項目が指定された場合は，コマンドの指定が優先されます。

ビジネスプロセス実行コマンド定義ファイルのプロパティ

csmexecutebpコマンドの引数

設定内容

process-name

-processname

ビジネスプロセス名

bp-operation-name

-operation

オペレーション名

telegram-filepath

-telegram

要求電文を記載したファイルのパス

(3)　設定できるプロパティ

(a)　接続先関連

hostname=IPアドレスまたはホスト名　〜＜WebサーバのIPアドレスまたはホスト名＞<<localhost>>

WebサーバのIPアドレスまたはホスト名を指定します。

port=ポート番号　〜＜数字＞((1−65535))<<80>>

Webサーバのポート番号を指定します。範囲外の値を指定した場合は，csmexecutebpコマンドが異常終了します。

protocol={http｜https}　〜<<http>>

Webサーバの受付プロトコルを次のどちらかで指定します。これ以外の値を指定した場合は，csmexecutebpコマンドが異常終了します。

http

HTTPで受け付けられます。

https

HTTPSで受け付けられます。

cluster-name=クラスタ名　〜＜半角英数字およびアンダーバー（_）＞((1−8文字))<<Cluster>>

標準の同期受付（Webサービス）が配備されているHCSCサーバのクラスタ名を指定します。不正な値を指定した場合は，csmexecutebpコマンドが異常終了します。

(b)　リクエスト関連

process-name=ビジネスプロセス名　〜＜XMLSchemaのNCName定義文字＞((1−64バイト))

ビジネスプロセス名を指定します。不正な値を指定した場合は，csmexecutebpコマンドが異常終了します。

サービスアダプタ名を指定した場合の動作は保証しません。

bp-operation-name=オペレーション名　〜＜XMLSchemaのNCName定義文字＞((1−255バイト))

ビジネスプロセスのオペレーション名を指定します。不正な値を指定した場合は，csmexecutebpコマンドが異常終了します。

clientID=クライアント相関ID　〜＜半角英数字，アンダーバー（_），ハイフン（-），ピリオド（.）＞((1−255文字))

クライアント相関IDを指定します。指定を省略した場合は，クライアント相関IDは送信されません。不正な値を指定した場合は，csmexecutebpコマンドが異常終了します。

telegram-filepath=要求電文を記載したファイルのパス　〜＜文字列（2バイト文字含む）および空白＞

ビジネスプロセスへ送信する要求電文が記載されたファイルを絶対パスで指定します。管理者権限のあるユーザがアクセスできるファイルを指定してください。

ディレクトリ区切りは「/」または「¥¥」を使用してください。

存在しないパスを指定した場合は，csmexecutebpコマンドが異常終了します。

(c)　ログ関連

exceptionlog-filepath=例外ログの出力先パス　〜＜文字列（2バイト文字含む）および空白＞<<<サービスプラットフォームのインストールディレクトリ>¥CSC¥log¥msg¥csmexecutebp>>

例外ログの出力先パスを絶対パスで指定します。

ディレクトリ区切りは「/」または「¥¥」を使用してください。

存在しないディレクトリを指定した場合は，csmexecutebpコマンドが異常終了します。

exceptionlog-filesize=例外ログの1ファイル当たりの上限サイズ　〜＜数字＞((4096−16777216))<<2097152>>

例外ログの1ファイル当たりの上限サイズをバイト単位で指定します。範囲外の値を指定した場合は，csmexecutebpコマンドが異常終了します。

exceptionlog-filenum=例外ログの最大面数　〜＜数字＞((1−16))<<4>>

例外ログの最大面数を指定します。範囲外の値を指定した場合は，csmexecutebpコマンドが異常終了します。

第2編　実行環境・運用環境のリファレンス

4　画面（運用環境）

この章では，サービスプラットフォームの運用環境で使用する画面について説明します。

4.1　画面構成（運用環境）

運用環境での画面構成について説明します。

図4‒1　運用環境での画面構成

メニューバー

Eclipseのメニューバーです。運用環境の固有メニューは［HCSC-Manager］です。

ツリービュー

HCSC-Managerが管理しているシステム構成，および管理対象（サービスアダプタやビジネスプロセス）の状態がアイコンで表示されます。管理対象を示すアイコンに，その状態を表すアイコンを組み合わせて表示します。ツリービューで表示されるアイコンを次の表に示します。

表4‒1　ツリービューで表示されるアイコン

分類

アイコン/状態

説明

アイコン

HCSC-Managerを示します。

HCSC-Domainを示します。

ロードバランスクラスタまたはHAクラスタを示します。

HCSCサーバを示します。

ビジネスプロセスを示します。

サービスアダプタを示します。

ユーザ定義受付を示します。

状態

次のどちらかを示します。

HCSCサーバの起動状態

サービスアダプタの開始状態

停止状態を示します。

閉塞状態を示します。

配備前状態を示します。

取得失敗を示します。

ツリービューで管理対象を選択して右クリックすると，コンテキストメニューが表示され，管理対象に対する操作ができるようになります。

エディタエリア

ツリービューに表示される管理対象の情報を表示したり，操作したりするためのエディタです。エディタの種類を次に示します。

表4‒2　エディタの種類

エディタ名

ページ名

機能

HCSCサーバエディタ

基本情報ページ

HCSCサーバの基本情報を表示します。

定義情報ページ

HCSCサーバの定義情報を表示します。

稼働運用ページ

HCSCサーバの稼働運用操作を実行します。

稼働確認ページ

HCSCサーバのリソースの稼働情報を確認します。

ビジネスプロセスエディタ

基本情報ページ

ビジネスプロセスの基本情報を表示します。

稼働運用ページ

ビジネスプロセスの稼働運用操作を実行します。

履歴管理ページ

プロセスインスタンスの実行履歴を管理します。

サービスアダプタエディタ

基本情報ページ

サービスアダプタの基本情報を表示します。

稼働運用ページ

サービスアダプタの稼働運用を実行します。

ユーザ定義受付エディタ

基本情報ページ

ユーザ定義受付の基本情報を表示します。

定義情報ページ

ユーザ定義受付の定義情報を表示します。

稼働運用ページ

ユーザ定義受付の稼働運用操作を実行します。

タブ

エディタごとに，表4-2に示すページに切り替わります。

コンソールビュー

ログを出力する領域です。

コンソールビューには，次の形式で出力されます。

yyyy/mm/dd△hh:mm:ss△アプリケーション名△メッセージID△メッセージ本文　

アプリケーション名には，次のように表示されます。

画面操作のログの場合：「Plug-in」

Managerからのログの場合：セットアップ時に指定したManager名

出力されるメッセージが64KBを超える場合は，古いメッセージから4KBほど行単位で削除されます。

ショートカット

ツリービューやダイアログなどで，［Alt］キーを押したまま「(G)」などのアンダーライン付きの文字と同じキーを押すと，管理対象を選択できます。

この章の画面や操作の説明で使用している記号を次に示します。

記号

意味

<　　>

<　>内の名称がユーザの環境によって異なることを表します。

「　　」

入力値，可変値，またはメッセージなどのユーザが入力する内容を表します。

4.2　基本情報ページ

基本情報ページには，HCSC-Managerが管理している対象の現在の基本情報が表示されます。これらの情報は，設定内容を確認するために利用できます。

各管理対象の基本情報ページは，ツリービューから管理対象を選択し，エディタエリアで［基本情報］タブを選択すると表示されます。

基本情報ページについて，管理対象ごとに説明します。

4.2.1　HCSCサーバ基本情報

HCSCサーバの基本情報ページには，HCSCサーバの構築時の情報が表示されます。この情報で，HCSCサーバをセットアップしたあとの設定内容を確認できます。

HCSCサーバの基本情報ページの画面および表示される項目を次に示します。

図4‒2　HCSCサーバの基本情報ページ

HCSCサーバ表示名

HCSCサーバの表示名が表示されます。HCSCサーバの表示名が指定されていない場合は，HCSCサーバの名称が表示されます。

HCSCサーバ名

HCSCサーバの名称が表示されます。

標準受付セットアップ状態

次の項目について，セットアップしているかどうかが表示されます。セットアップしている場合は「ON」，セットアップしていない場合は「OFF」，基本情報の取得に失敗した場合は「取得失敗」が表示されます。

同期（Webサービス（SOAP1.1））

同期（Webサービス（SOAP1.2））

同期（SessionBean）

非同期（MDB（WS-R））

非同期（MDB（DBキュー））

依存ユーザ定義受付

HCSCサーバに依存しているユーザ定義受付の名称が表示されます。

依存ビジネスプロセス

HCSCサーバに依存しているビジネスプロセスのサービス名が表示されます。

依存サービスアダプタ

HCSCサーバに依存しているサービスアダプタのサービス名が表示されます。

4.2.2　ビジネスプロセス基本情報

ビジネスプロセスの基本情報ページには，ビジネスプロセスの基本情報が表示され，ビジネスプロセスの設定内容を確認できます。ビジネスプロセスの基本情報ページの画面および表示される項目を次に示します。

図4‒3　ビジネスプロセスの基本情報ページ

サービス名

ビジネスプロセス定義名またはサービス名が表示されます。

サービスID

ビジネスプロセスのサービスIDが表示されます。

更新日時

配備済みビジネスプロセスが更新された日時が表示されます。基本情報の取得に失敗した場合は「取得失敗」，ビジネスプロセスの配備前は「-」が表示されます。

バージョン

ビジネスプロセスのバージョンが表示されます。

依存HCSCサーバ

依存しているHCSCサーバの表示名が表示されます。

依存ユーザ定義受付

依存しているユーザ定義受付の名称が表示されます。

4.2.3　サービスアダプタ基本情報

サービスアダプタの基本情報ページには，サービスアダプタの基本情報が表示され，サービスアダプタの設定内容を確認できます。サービスアダプタの基本情報ページの画面および表示される項目を次に示します。

図4‒4　サービスアダプタの基本情報ページ（サービス種別がWebサービスの場合）

サービス名

サービスアダプタのサービス名が表示されます。

サービスID

サービスアダプタのサービスIDが表示されます。

サービス種別

サービスアダプタのサービス種別が表示されます。次の種別のうち，どれかが表示されます。

Webサービス（SOAP1.1）

Webサービス（SOAP1.2）

SessionBean

MDB（WS-R）

MDB（DBキュー）

カスタム

送信元キュー名

非同期のサービスアダプタの場合に，サービスアダプタが利用するキュー名が表示されます。サービスアダプタの配備前は「-」が表示されます。

更新日時

配備済みサービスアダプタが更新された日時が表示されます。基本情報の取得に失敗した場合は「取得失敗」，サービスアダプタの配備前は「-」が表示されます。

サービス情報

サービス種別に応じた情報が表示されます。

サービス種別と対応するサービス情報を次の表に示します。

表4‒3　サービス種別に対応するサービス情報の表示項目

サービス種別

サービス情報

項目

意味

Webサービス（SOAP1.1）

URL

WebサービスのURLが表示されます。

接続タイムアウト［秒］

サービス部品呼び出し時のソケットの接続タイムアウト値が表示されます。

読み込みタイムアウト［秒］

サービス部品呼び出し時のソケットの読み込みタイムアウト値が表示されます。

書き込みタイムアウト［秒］

サービス部品呼び出し時のソケットの書き込みタイムアウト値が表示されます。

HTTPセッションの維持

HTTPセッションを維持するかどうかを指定します。

true

セッションを維持します。

false

セッションを維持しません。

ベーシック認証の使用可否チェック

サービスアダプタがベーシック認証を使用するかどうかが表示されます。次のどちらかが表示されます。

true

使用します。

false

使用しません。

ベーシック認証のユーザ

ベーシック認証のユーザIDが設定されていた場合，「The value has already been set.」が表示されます。

ベーシック認証のパスワード

ベーシック認証のパスワードが設定されていた場合，「The value has already been set.」が表示されます。

プロキシサーバを使用しないホスト名

プロキシサーバを使用しない場合のホスト名またはIPアドレス群が表示されます。

プロキシサーバのホスト名

プロキシサーバのホスト名またはIPアドレスが表示されます。

プロキシサーバのポート番号

プロキシサーバのポート番号が表示されます。

プロキシサーバのユーザ

プロキシサーバの認証ユーザIDが設定されていた場合，「The value has already been set.」が表示されます。

プロキシサーバのパスワード

プロキシサーバの認証ユーザIDに対応するパスワードが設定されていた場合，「The value has already been set.」が表示されます。

性能解析トレース出力オプション

性能解析トレースを出力するかどうかが表示されます。次のどちらかが表示されます。

ALL

トレース取得ポイントで性能解析トレースを出力します。

NONHANDLER

トレース取得ポイントで性能解析トレースを出力しません。

トレース取得ポイントの詳細については，マニュアル「アプリケーションサーバ SOAPアプリケーション開発の手引」の「10.3　クライアント定義ファイルの設定」を参照してください。

受信SOAPEnvelopeの最大バイト数

受信できるSOAPエンベロープの最大バイト数が表示されます。

送信SOAPEnvelopeの最大バイト数

送信できるSOAPエンベロープの最大バイト数が表示されます。

Webサービス（SOAP1.2）

URL

WebサービスのURLが表示されます。

接続タイムアウト［秒］

サービス部品呼び出し時のソケットの接続タイムアウト値が表示されます。

読み込みタイムアウト［秒］

サービス部品呼び出し時のソケットの読み込みタイムアウト値が表示されます。

HTTPセッションの維持

HTTPセッションを維持するかどうかを指定します。

true

セッションを維持します。

false

セッションを維持しません。

ベーシック認証の使用可否チェック

サービスアダプタがベーシック認証を使用するかどうかが表示されます。次のどちらかが表示されます。

true

使用します。

false

使用しません。

ベーシック認証のユーザ

ベーシック認証のユーザIDが設定されていた場合，「The value has already been set.」が表示されます。

ベーシック認証のパスワード

ベーシック認証のパスワードが設定されていた場合，「The value has already been set.」が表示されます。

SessionBean

URL

ネーミングサービスのURLが表示されます。

ルックアップ名

JNDI名前空間に登録されている，呼び出すサービス部品の名称が表示されます。

EJB呼出しタイムアウト

サービス部品呼び出し時のビジネスメソッド呼び出しのタイムアウト値が表示されます。

性能解析トレース出力オプション

性能解析トレースを出力するかどうかが表示されます。次のどちらかが表示されます。

ALL

トレース取得ポイントで性能解析トレースを出力します。

NONHANDLER

トレース取得ポイントで性能解析トレースを出力しません。

トレース取得ポイントの詳細については，マニュアル「アプリケーションサーバ SOAPアプリケーション開発の手引」の「10.3　クライアント定義ファイルの設定」を参照してください。

MDB（WS-R）

送信先キュー名

サービスアダプタがメッセージを送信するキュー名が表示されます。

呼出し設定

リモートホストのサービス部品に接続するか，ローカルホストのサービス部品に接続するかが表示されます。リモートホストのサービス部品に接続する場合は，「リモート呼出し」が表示されます。ローカルホストのサービス部品に接続する場合は，「ローカル呼出し」が表示されます。

URL

サービスアダプタが使用する転送キューのメッセージ転送先のURLが表示されます。［呼出し設定］が「ローカル呼出し」の場合は，何も表示されません。

最大メッセージ数

サービスアダプタが使用する転送キューが保持できるメッセージの最大数が表示されます。［呼出し設定］が「ローカル呼出し」の場合は，何も表示されません。

順序保証

サービスアダプタが使用する転送キューがメッセージを正しい順序で転送することを保証するかどうかが表示されます。次のどちらかが表示されます。

ON

保証します。

OFF

保証しません。

［呼出し設定］が「ローカル呼出し」の場合は，何も表示されません。

転送キュー作成先RDエリア

サービスアダプタが使用する転送キューの作成先のRDエリア名が表示されます。［呼出し設定］が「ローカル呼出し」の場合は，何も表示されません。

MDB（DBキュー）

送信先キュー名

サービス部品に関連づけられるキュー名が表示されます。

依存HCSCサーバ

依存しているHCSCサーバの表示名が表示されます。

4.2.4　ユーザ定義受付基本情報

ユーザ定義受付基本情報ページには，ユーザ定義受付の基本情報が表示され，ユーザ定義受付の設定内容を確認できます。ユーザ定義受付基本情報ページの画面および表示される項目を次に示します。

図4‒5　ユーザ定義受付基本情報ページ

受付名

ユーザ定義受付の受付名が表示されます。

受付ID

ユーザ定義受付の受付IDが表示されます。

受付種別

ユーザ定義受付の受付種別として，次のどちらかが表示されます。

Webサービス

カスタム

更新日時

ユーザ定義受付が更新された日時が表示されます。基本情報の取得に失敗した場合は「取得失敗」，ユーザ定義受付の配備前は「-」が表示されます。

依存HCSCサーバ

依存しているHCSCサーバの表示名が表示されます。

依存ビジネスプロセス

依存しているビジネスプロセスのサービス名が表示されます。ユーザ定義受付（呼出先選択）の場合は「-」が表示されます。

4.3　定義情報ページ

定義情報ページには，管理対象に設定され，実行環境で反映済みの定義情報が表示されます。これらの情報は，HCSCサーバの構築後も変更できます。

各管理対象の定義情報ページは，ツリービューから管理対象を選択し，エディタエリアで［定義情報］タブを選択すると表示されます。また，変更後の定義情報を画面に表示させるには，ほかのページに切り替えてから再度，定義情報ページを開いてください。

定義情報ページについて，管理対象ごとに説明します。

4.3.1　HCSCサーバ定義情報

HCSCサーバの定義情報ページの画面および表示される項目を次に示します。

図4‒6　HCSCサーバの定義情報ページ

HCSCサーバ表示名

HCSCサーバの表示名が表示されます。

同期受付（Webサービス（SOAP1.1））

次の情報が表示されます。定義情報の取得に失敗した場合は「取得失敗」が表示されます。この受付がセットアップされていない場合は「-」が表示されます。

最大同時実行数

同期受付（Webサービス（SOAP1.1））の最大同時実行数が表示されます。

占有スレッド数

同期受付（Webサービス（SOAP1.1））の占有スレッド数が表示されます。

実行待ちキューサイズ

同期受付（Webサービス（SOAP1.1））の実行待ちキューサイズが表示されます。

同期受付（Webサービス（SOAP1.2））

次の情報が表示されます。定義情報の取得に失敗した場合は「取得失敗」が表示されます。この受付がセットアップされていない場合は「-」が表示されます。

最大同時実行数

同期受付（Webサービス（SOAP1.2））の最大同時実行数が表示されます。

占有スレッド数

同期受付（Webサービス（SOAP1.2））の占有スレッド数が表示されます。

実行待ちキューサイズ

同期受付（Webサービス（SOAP1.2））の実行待ちキューサイズが表示されます。

同期受付（SessionBean）

次の情報が表示されます。定義情報の取得に失敗した場合は「取得失敗」が表示されます。この受付がセットアップされていない場合は「-」が表示されます。

最小インスタンス数

同期受付（SessionBean）の最小インスタンス数が表示されます。

最大インスタンス数

同期受付（SessionBean）の最大インスタンス数が表示されます。

CTM連携

CTM連携をしているかどうかが表示されます。

CTM用スレッド数

CTMがアプリケーションを呼び出すために用意するスレッド数が表示されます。

非同期受付（MDB（WS-R））

次の情報が表示されます。定義情報の取得に失敗した場合は「取得失敗」が表示されます。この受付がセットアップされていない場合は「-」が表示されます。

最大インスタンス数

非同期受付（MDB（WS-R））の最大インスタンス数が表示されます。

4.3.2　ユーザ定義受付定義情報

ユーザ定義受付定義情報ページの画面および表示される項目を次に示します。

図4‒7　ユーザ定義受付定義情報ページ

情報の取得に失敗した場合は，［受付名］以外の各項目に「取得失敗」が表示されます。ユーザ定義受付の配備前は，［受付名］以外の各項目に「-」が表示されます。

受付名

ユーザ定義受付の名称が表示されます。

最大同時実行数

ユーザ定義受付に定義されている最大同時実行数が表示されます。

占有スレッド数

ユーザ定義受付に定義されている占有スレッド数が表示されます。

実行待ちキューサイズ

ユーザ定義受付に定義されている実行待ちキューサイズが表示されます。

4.4　稼働運用ページ

稼働運用ページは，ツリービューから管理対象を選択し，エディタエリアで［稼働運用］タブを選択すると表示されます。稼働運用ページでは，HCSCサーバおよび標準受付の運用操作を実行します。HCSCサーバ，サービスアダプタ，ビジネスプロセスまたはユーザ定義受付で表示される内容が異なります。

稼働運用ページについて，管理対象ごとに説明します。

4.4.1　HCSCサーバ稼働運用

HCSCサーバの稼働運用ページの画面および表示される項目を次に示します。

図4‒8　HCSCサーバの稼働運用ページ

HCSCサーバ表示名

この画面で操作するHCSCサーバの表示名が表示されます。

稼働状態

HCSCサーバの稼働状態が表示されます。次のどれかが表示されます。

停止状態

起動状態

停止中

起動中

取得失敗

HCSCサーバを起動または停止した場合以外でも，実行環境からの通知で状態が変更される場合があります。

標準受付稼働状態

標準受付の稼働状態が表示されます。次のどれかが表示されます。

停止状態

開始状態

停止中

開始中

停止失敗

開始失敗

取得失敗

標準受付を開始または停止した場合以外でも，実行環境からの通知で状態が変更される場合があります。

依存ユーザ定義受付

HCSCサーバに依存しているユーザ定義受付の稼働状態が一覧に表示されます。

受付名

依存しているユーザ定義受付の名称が表示されます。

依存サービス名

ユーザ定義受付が依存しているサービス名が表示されます。ユーザ定義受付（呼出先選択）の場合は「-」が表示されます。

稼働状態

依存しているユーザ定義受付の稼働状態が表示されます。次のどれかが表示されます。

停止状態

開始状態

停止中

開始中

停止失敗

開始失敗

取得失敗

HCSCサーバ

［起動］ボタン

HCSCサーバを起動します。

［停止］ボタン

HCSCサーバを停止します。

標準受付

［開始］ボタン

標準受付を開始します。

［通常停止］ボタン

標準受付を停止します。通常の運用で標準受付を停止する場合に利用します。

［計画停止］ボタン

標準受付を停止します。HCSCサーバをアンセットアップする場合に利用します。

4.4.2　サービスアダプタ稼働運用

サービスアダプタの稼働運用ページの画面および表示される項目を次に示します。

図4‒9　サービスアダプタの稼働運用ページ

サービス名

この画面で操作するサービスアダプタのサービス名が表示されます。

稼働状態

サービスアダプタの稼働状態が表示されます。次のどれかが表示されます。

停止状態

開始状態

停止中

開始中

停止失敗

開始失敗

取得失敗

配備前状態

サービスアダプタを開始または停止した場合以外でも，実行環境からの通知で状態が変更される場合があります。

依存HCSCサーバ

依存しているHCSCサーバの情報が表示されます。

HCSCサーバ表示名

依存しているHCSCサーバの表示名が表示されます。

稼働状態

サービスアダプタが配備されているHCSCサーバの稼働状態が表示されます。次のどれかが表示されます。

停止状態

起動状態

停止中

起動中

取得失敗

サービスアダプタを開始または停止した場合以外でも，実行環境からの通知で状態が変更される場合があります。

［開始］ボタン

サービスアダプタを開始します。

［停止］ボタン

サービスアダプタを停止します。

4.4.3　ビジネスプロセス稼働運用

ビジネスプロセスの稼働運用ページの画面および表示される項目を次に示します。

図4‒10　ビジネスプロセスの稼働運用ページ

サービス名

この画面で操作するビジネスプロセスのサービス名が表示されます。

稼働状態

ビジネスプロセスの稼働状態が表示されます。次のどれかが表示されます。

停止状態

開始状態

停止中

開始中

停止失敗

開始失敗

取得失敗

配備前状態

ビジネスプロセスを開始または停止した場合以外でも，実行環境からの通知で状態が変更される場合があります。

依存HCSCサーバ

依存しているHCSCサーバの情報が表示されます。

HCSCサーバ表示名

依存しているHCSCサーバの表示名が表示されます。

稼働状態

ビジネスプロセスが配備されているHCSCサーバの稼働状態が表示されます。次のどれかが表示されます。

停止状態

起動状態

停止中

起動中

取得失敗

ビジネスプロセスを開始または停止した場合以外でも，実行環境からの通知で状態が変更される場合があります。

依存ユーザ定義受付

依存しているユーザ定義受付の情報が表示されます。

受付名

ユーザ定義受付の受付名が表示されます。定義されているユーザ定義受付の分だけ表示されます。

稼働状態

ユーザ定義受付の稼働状態が表示されます。定義されているユーザ定義受付の分だけ表示されます。次のどれかが表示されます。

停止状態

開始状態

停止中

開始中

取得失敗

配備前状態

ビジネスプロセスを開始または停止した場合以外でも，実行環境からの通知で状態が変更される場合があります。

［開始］ボタン

ビジネスプロセスを開始します。

［停止］ボタン

ビジネスプロセスを停止します。

4.4.4　ユーザ定義受付稼働運用

ユーザ定義受付稼働運用ページの画面および表示される項目を次に示します。

図4‒11　ユーザ定義受付稼働運用ページ

受付名

この画面で操作するユーザ定義受付の受付名が表示されます。

稼働状態

ユーザ定義受付の稼働状態が表示されます。次のどれかが表示されます。

停止状態

開始状態

停止中

開始中

停止失敗

開始失敗

取得失敗

配備前状態

ユーザ定義受付を開始または停止した場合以外でも，実行環境からの通知で状態が変更される場合があります。

依存HCSCサーバ

依存しているHCSCサーバの情報が表示されます。

HCSCサーバ表示名

依存しているHCSCサーバの表示名が表示されます。

稼働状態

ユーザ定義受付が配備されているHCSCサーバの稼働状態が表示されます。次のどれかが表示されます。

停止状態

起動状態

停止中

起動中

取得失敗

ユーザ定義受付を開始または停止した場合以外でも，実行環境からの通知で状態が変更される場合があります。

依存ビジネスプロセス

依存しているビジネスプロセスの情報が表示されます。

サービス名

依存するビジネスプロセスのサービス名が表示されます。ユーザ定義受付（呼出先選択）の場合は「-」が表示されます。

稼働状態

ビジネスプロセスの稼働状態が表示されます。次のどれかが表示されます。

停止状態

開始状態

停止中

開始中

停止失敗

開始失敗

取得失敗

配備前状態

ユーザ定義受付（呼出先選択）の場合は「-」が表示されます。

ユーザ定義受付を開始または停止した場合以外でも，実行環境からの通知で状態が変更される場合があります。

［開始］ボタン

ユーザ定義受付を開始します。

［停止］ボタン

ユーザ定義受付を停止します。

4.5　稼働確認ページ

稼働確認ページには，HCSCサーバのリソースの稼働情報が表示されます。稼働確認ページは，エディタエリアで［稼働確認］タブを選択すると表示されます。

稼働確認ページの画面および表示される項目を次に示します。

図4‒12　稼働確認ページ

HCSCサーバ表示名

HCSCサーバの表示名が表示されます。

HCSCサーバ稼働状態

HCSCサーバの稼働状態が表示されます。次のどれかが表示されます。

停止状態

起動状態

停止中

起動中

取得失敗

稼働情報通知

実行環境からHCSCサーバに稼働情報を通知するかどうかが表示されます。稼働情報を通知する場合は「ON」が，稼働情報を通知しない場合は「OFF」が表示されます。

稼働情報収集時刻

稼働情報が収集された時刻が表示されます。HCSCサーバが起動状態以外の場合は「-」が表示されます。稼働情報の取得に失敗した場合は「取得失敗」が表示されます。

稼働情報は次の図に示すように，表示された稼働情報収集時刻の直前の60秒間（デフォルト）に収集された情報になります。

図4‒13　稼働情報収集時刻と収集された稼働情報の関係

Java VMヒープサイズ［MB］

HCSCサーバのJava VMヒープサイズが表示されます。「収集したJava VMヒープサイズの最大値 / Java VMヒープサイズの上限値」の形式で表示されます。

小数点以下は切り捨てられ，整数で表示されます。HCSCサーバが起動状態以外の場合は「-」が表示されます。稼働情報の取得に失敗した場合は「取得失敗」が表示されます。

なお，Java VMの-Xmxオプションで指定した値からSurvivor領域の1つ分のサイズを除いた値が表示されます。

DBコネクション数

J2EEサーバ上で稼働しているすべてのリソースアダプタの情報が表示されます。HCSCサーバが起動状態以外の場合は，情報が表示されません。稼働情報の取得に失敗した場合は「取得失敗」が表示されます。

リソースアダプタ名

リソースアダプタの表示名が表示されます。

コネクション数

HCSCサーバのDBコネクション数が表示されます。「収集したDBコネクション数の最大値 / DBコネクション数の上限値」の形式で表示されます。DBコネクション数の上限値には，1〜2,147,483,647の範囲で指定した値が表示されます。DBコネクション数の上限値に「-1」（無制限）を指定した場合は，「収集したDBコネクション数の最大値 / NA」の形式で表示されます。「NA」は無制限であることを示します。また，次の場合は，「NA / NA」（無効値）が表示されます。

DBコネクション数の上限値に「0」を指定した場合

該当のリソースアダプタがルートリソースアダプタ，またはReliable Messaging連携用DBコネクタの場合

受付

受付（標準受付またはユーザ定義受付）の情報が表示されます。標準受付の場合，標準受付がセットアップされていないときは，情報が表示されません。

受付名

標準受付の場合

「標準受付（Webサービス（SOAP1.1））」または「標準受付（Webサービス（SOAP1.2））」が表示されます。

ユーザ定義受付の場合

ユーザが定義した受付名が表示されます。

稼働状態

受付（標準受付またはユーザ定義受付）の稼働状態が表示されます。次のどれかが表示されます。

停止状態

開始状態

停止中

開始中

停止失敗

開始失敗

取得失敗

HCSCサーバが起動状態以外の場合は「-」が表示されます。ユーザ定義受付の場合，ユーザ定義受付が配備前状態のときは「配備前状態」が表示されます。

サービス名

依存しているビジネスプロセスやサービスアダプタのサービス名が表示されます。標準受付の場合は，常に「-」が表示されます。ユーザ定義受付（呼出先選択）の場合は「-」が表示されます。

キュー滞留数

受付（標準受付またはユーザ定義受付）のキュー滞留数が表示されます。「収集したキュー滞留数の最大値 / キュー滞留数の上限値」の形式で表示されます。

キュー滞留数は，0〜2,147,483,647の範囲で表示されます。HCSCサーバが起動状態以外の場合や，該当する受付が停止状態の場合は「-」が表示されます。ユーザ定義受付の場合，配備前状態のときは「-」が表示されます。稼働情報の取得に失敗した場合は「取得失敗」が表示されます。

実行数

受付（標準受付またはユーザ定義受付）の実行数が表示されます。「収集した実行数の最大値 / 実行数の上限値」の形式で表示されます。

実行数は，1〜1,024の範囲で表示されます。HCSCサーバが起動状態以外の場合や，該当する受付が停止状態の場合は「-」が表示されます。ユーザ定義受付の場合，配備前状態のときは「-」が表示されます。稼働情報の取得に失敗した場合は「取得失敗」が表示されます。

依存ビジネスプロセス

HCSCサーバに依存しているビジネスプロセスの情報が表示されます。

サービス名

依存するビジネスプロセスのサービス名が表示されます。

稼働状態

ビジネスプロセスの稼働状態が表示されます。次のどれかが表示されます。

停止状態

開始状態

停止中

開始中

停止失敗

開始失敗

取得失敗

配備前状態

HCSCサーバが起動状態以外の場合は「-」が表示されます。

実行数

ビジネスプロセスの実行数が表示されます。「収集した実行数の最大値 / NA」の形式で表示されます。「NA」は無制限であることを示します。収集した実行数の最大値には，0〜2,147,483,647の範囲で値が表示されます。HCSCサーバが起動状態以外の場合や，ビジネスプロセスが配備前状態，または停止状態の場合は「-」が表示されます。稼働情報の取得に失敗した場合は「取得失敗」が表示されます。

依存サービスアダプタ

HCSCサーバに依存しているサービスアダプタの情報が表示されます。

サービス名

サービスアダプタのサービス名が表示されます。

稼働状態

サービスアダプタの稼働状態が表示されます。次のどれかが表示されます。

停止状態

開始状態

停止中

開始中

停止失敗

開始失敗

取得失敗

配備前状態

HCSCサーバが起動状態以外の場合は「-」が表示されます。

実行数

サービスアダプタの実行数が表示されます。「収集した実行数の最大値 / 実行数の上限値」の形式で表示されます。「実行数の上限値」には「NA」が表示される場合もあります。「NA」は無制限であることを示します。収集した実行数の最大値には，0〜2,147,483,647の範囲で値が表示されます。HCSCサーバが起動状態以外の場合や，サービスアダプタが配備前状態，または停止状態の場合は「-」が表示されます。稼働情報の取得に失敗した場合は「取得失敗」が表示されます。

稼働情報通知

［ON］ボタン

実行環境からの稼働情報の通知を開始します。

［OFF］ボタン

実行環境からの稼働情報の通知を停止します。

4.6　履歴管理ページ

履歴管理ページは，ツリービューから管理対象のビジネスプロセスを選択し，［履歴管理］タブを選択すると表示されます。履歴管理ページでは，プロセスインスタンスの実行履歴の検索，削除，再実行，および詳細情報を取得できます。履歴管理ページの構成について説明します。

図4‒14　履歴管理ページの構成

・検索条件タブ

日時/状態検索，相関セット検索，または識別子検索を切り替えます。

・検索条件フィールド

検索条件の選択，入力，または検索をします。

・検索結果フィールド

検索結果の表示，実行履歴の削除，または実行履歴の再実行をします。

・詳細情報フィールド

検索結果から詳細情報の選択，または表示をします。

4.6.1　検索条件フィールド

検索条件の選択，入力，または検索をします。

(1)　日時/状態検索

図4‒15　［日時・状態検索］タブ選択時の検索条件フィールド

［日時・状態検索］タブ

検索条件として日時や状態からプロセスインスタンスを検索する画面を選択するタブです。

・プロセスインスタンスの開始日時

プロセスインスタンスの開始日時を指定してプロセスインスタンスを検索する場合に使用します。

［指定あり］ラジオボタン

プロセスインスタンスの開始日時を指定してプロセスインスタンスを検索する場合に選択します。

［指定なし］ラジオボタン

プロセスインスタンスの開始日時を指定しないでプロセスインスタンスを検索する場合に選択します。

日時条件開始入力フィールド

検索範囲の開始日時を入力します。指定した日時は，稼働しているマシンのタイムゾーンの日時として扱われます。

　年

検索範囲の開始年を西暦で指定します。4桁の整数を半角で入力します。入力できる範囲は1970〜9999です。

　月

検索範囲の開始月をドロップダウンリストから選択します。選択できる範囲は1〜12です。

　日

検索範囲の開始日をドロップダウンリストから選択します。選択できる範囲は1〜31です。

　時

検索範囲の開始時間をドロップダウンリストから選択します。選択できる範囲は0〜23です。

　分

検索範囲の開始分をドロップダウンリストから選択します。選択できる範囲は0〜59です。

　秒

検索範囲の開始秒をドロップダウンリストから選択します。選択できる範囲は0〜59です。

日時条件終了入力フィールド

検索範囲の終了日時を入力します。

年，月，日，時，分，および秒については，日時条件開始入力フィールドと同様です。

・プロセスインスタンスの状態

プロセスインスタンスの状態を指定してプロセスインスタンスを検索する場合にチェックします。複数の状態を選択して，どれかの状態の場合を検索することもできます。

［実行中］チェックボックス

実行中のプロセスインスタンスを検索する場合にチェックします。

［完了］チェックボックス

プロセスのグローバルスコープが完了したプロセスインスタンスを検索する場合にチェックします。

［フォルト終了］チェックボックス

フォルトが発生し，グローバルスコープでもキャッチできないで，フォルト終了したプロセスインスタンスを検索する場合にチェックします。

［エラー発生］チェックボックス

サービス呼出アクティビティまたはスコープアクティビティの実行中にエラーが発生し，終了したプロセスインスタンスを検索する場合にチェックします。

［途中終了］チェックボックス

プロセス実行中に実行された途中終了アクティビティによって途中終了したプロセスインスタンスを検索する場合にチェックします。

・ソート条件

検索結果の表示順序を指定します。

［開始日時の昇順］ラジオボタン

検索結果を開始日時の昇順で表示する場合に選択します。

［開始日時の降順］ラジオボタン

検索結果を開始日時の降順で表示する場合に選択します。

［指定なし］ラジオボタン

ソート条件を指定しないで検索結果を表示する場合に選択します。

・［検索］ボタン

指定した条件で検索が実行されます。

・［リセット］ボタン

選択しているタブに入力した検索条件が初期値に戻ります。

(2)　相関セット検索

図4‒16　［相関セット検索］タブ選択時の検索条件フィールド

［相関セット検索］タブ

検索条件として相関セットからプロセスインスタンスを検索する画面を選択するタブです。「相関セット定義名」および「相関セット値」の両方に入力が必要です。

相関セット定義名

検索する相関セット定義名を半角の英数字で入力します。

相関セット値

検索する相関セット値を半角の英数字で入力します。

(3)　識別子検索

図4‒17　［識別子検索］タブ選択時の検索条件フィールド

［識別子検索］タブ

検索条件としてプロセスインスタンス識別子からプロセスインスタンスを検索する画面を選択するタブです。

プロセスインスタンス識別子

検索するプロセスインスタンス識別子を入力します。

4.6.2　検索結果フィールド

検索結果件数

検索結果の総数が表示されます。

表示件数範囲

検索結果一覧に表示している検索結果の範囲について，検索結果の上位から何件目であるかの範囲が表示されます。

［＜］ボタン

検索結果の前の最大20件が表示されます。

［＞］ボタン

検索結果の次の最大20件が表示されます。

検索結果一覧

検索条件に該当した検索対象が表示されます。一度に表示できる件数は20件までです。

#

検索結果件数に対応した番号が表示されます。

ビジネスプロセス定義名

ビジネスプロセスの定義名が表示されます。

ビジネスプロセスバージョン

ビジネスプロセスのバージョンが表示されます。

状態

プロセスインスタンスの状態が表示されます。

開始日時

プロセスインスタンスの実行を開始した日時が表示されます。検索条件で指定したときと同様に「yyyy/mm/dd hh:mm:ss」の形式で表示されます。開始していない場合は表示されません。

終了日時

プロセスインスタンスの実行を終了した日時が表示されます。検索条件で指定したときと同様に「yyyy/mm/dd hh:mm:ss」の形式で表示されます。終了していない場合は表示されません。

HCSCサーバ名

最後に実行したHCSCサーバ名が表示されます。

［履歴削除］ボタン

検索結果から選択した，ある1つのプロセスインスタンスの実行履歴が削除されます。

［再実行］ボタン

検索結果から選択した，ある1つのプロセスインスタンスが再実行されます。

4.6.3　詳細情報フィールド

検索結果から詳細情報の選択，または表示をします。

(1)　相関セット情報

詳細情報件数

検索結果一覧で選択したプロセスインスタンスの詳細情報の総件数，および詳細情報の種別（相関セット情報，変数情報，またはアクティビティ情報）が表示されます。

表示件数範囲

詳細情報一覧に表示している検索結果の範囲を，検索結果の上位から何件目であるかの範囲が表示されます。

［＜］ボタン

検索結果の前の最大20件が表示されます。

［＞］ボタン

検索結果の次の最大20件が表示されます。

詳細情報一覧

詳細情報の種別（相関セット情報，変数情報，またはアクティビティ情報）で選択した項目に対応した詳細情報が表示されます。一度に表示できる件数は20件までです。

図4‒18　詳細情報一覧（相関セット情報）

図4‒19　詳細情報一覧（変数情報）

図4‒20　詳細情報一覧（アクティビティ情報）

#

詳細情報件数に対応した番号が表示されます。

相関セット定義名

［相関セット情報］ボタンをクリックした場合に相関セット定義名が表示されます。相関セット定義名の昇順で表示されます。

相関セット値

［相関セット情報］ボタンをクリックした場合に相関セット値が表示されます。

変数定義名

［変数情報］ボタンをクリックした場合に変数定義名が表示されます。変数定義名の昇順で表示されます。

変数型

［変数情報］ボタンをクリックした場合に変数のデータ型（Boolean，Numeric，String，またはMessage）が表示されます。

メッセージ型の変数であるXML型（XML），バイナリ型（non-XML），any型（any）は，「Message」と表示されます。

変数値

［変数情報］ボタンをクリックした場合に変数値が表示されます。変数型によって次の内容が表示されます。

Boolean：真偽値として，「1」（真）または「0」（偽）が表示されます。

Numeric：数値（64ビット浮動小数）が表示されます。

String：文字列が表示されます。

Message：電文（XML，non-XML，any）が表示されます。

アクティビティ定義名

［アクティビティ情報］ボタンをクリックした場合に，アクティビティ定義名が表示されます。開始日時の昇順で表示されます。また，開始日時が空欄の項目は後ろに配置されます。

アクティビティ種別

［アクティビティ情報］ボタンをクリックした場合に，次に示すアクティビティの種別が表示されます。

表4‒4　アクティビティの種別

名称

説明

受付

サービスリクエスタが送信した要求電文を受信します。

応答

同期受信をした際に，プロセスの実行結果をサービスリクエスタに応答します。

サービス呼出

要求電文をサービス部品に送信します。

代入

変数へ代入します。

スコープ

アクティビティの有効範囲を定めます。

グローバルスコープ名は，「@GLOBAL」となります。

順次処理

アクティビティを定義した順番に実行します。

順次処理アクティビティは，保持しているアクティビティの最後のアクティビティが完了したときに，完了となります。

並列処理

定義したアクティビティを同時に実行します。

ビジネスプロセス開発時の並列処理開始アクティビティと並列処理終了アクティビティは，並列処理アクティビティとして表示されます。並列処理アクティビティは，保持するすべてのアクティビティが完了したときに，完了となります。

分岐

定義した選択条件によって実行するアクティビティを選択します。

ビジネスプロセス開発時の分岐開始アクティビティと分岐終了アクティビティは，分岐アクティビティとして分岐開始アクティビティ名で表示されます。分岐アクティビティは，分岐条件によって選択されたアクティビティが完了したときに，完了となります。

繰り返し

定義した繰り返し条件が真である間，または繰り返しリストの要素数分，アクティビティの実行を繰り返します。

java呼出

決められたインターフェースに従ってjavaプログラムを呼び出します。

無操作

何もしない動作を表します。

フォルト送出

上位のスコープアクティビティに，ユーザ定義のフォルトを通知します。

このフォルトアクティビティが完了状態であっても, 通知先のアクティビティにはフォルト発生として扱われます。

補償

補償コネクションを定義したアクティビティを呼び出します。

待機

指定した一定の間隔，または期限まで，プロセスの実行を待機させます。

検証

指定されたメッセージ型変数（XML）を検証します。

ログ出力

任意のログを出力します。

途中終了

プロセスを終了します。

状態

［アクティビティ情報］ボタンをクリックした場合に，次に示すアクティビティの状態が表示されます。

表4‒5　アクティビティの状態

名称

説明

未実行

アクティビティインスタンスが未実行で，今後実行される可能性のある状態であることを示します。

未省略

アクティビティインスタンスが未実行で，今後実行が省略される状態であることを示します。

実行中

アクティビティインスタンスが実行中の状態であることを示します。

実行中（待ち受け）

アクティビティインスタンスが実行中で，かつ再実行可能な状態であることを示します。

待ち受け

受付アクティビティインスタンスが，受け付けのできる状態であることを示します。

フォルト中

スコープアクティビティインスタンスにフォルトが発生し，キャッチしたアクティビティを実行している状態であることを示します。

完了

アクティビティインスタンスが正常に実行され，終了した状態であることを示します。

完了（待ち受け）

アクティビティのインスタンスが正常に実行されて終了した状態で，再実行可能な状態であることを示します。

キャンセル

フォルトが発生し，待ち受けまたは実行中のアクティビティインスタンスの実行がキャンセルされた状態であることを示します。

フォルト終了

アクティビティインスタンスの実行中にフォルトが発生して終了した状態であることを示します。

実行省略

アクティビティインスタンスの実行が省略され終了した状態であることを示します。

エラー発生

アクティビティインスタンスの実行中にエラーが発生して終了した状態であることを示します。

補償中

補償ハンドラの配下に定義したアクティビティが実行中の状態であることを示します。

補償完了

補償ハンドラの配下に定義したアクティビティが正常に実行され，終了した状態であることを示します。

開始日時

［アクティビティ情報］ボタンをクリックした場合に，アクティビティの開始日時が検索条件フィールドの形式と同様に表示されます。

終了日時

［アクティビティ情報］ボタンをクリックした場合に，アクティビティの終了日時が検索条件フィールドの形式と同様に表示されます。

［相関セット情報］ボタン

検索結果一覧で選択したプロセスインスタンスについて，相関セットの詳細情報が表示されます。相関セット情報は，相関セット定義名で昇順にソートされます。

［変数情報］ボタン

検索結果一覧で選択したプロセスインスタンスについて，変数の詳細情報が表示されます。変数情報は，変数定義名で昇順にソートされます。

［アクティビティ情報］ボタン

検索結果一覧で選択したプロセスインスタンスについて，アクティビティの詳細情報が表示されます。アクティビティ情報は，開始日時で昇順にソートされます。なお，開始日時が空欄（未実行）の項目は後ろに並びます。

［変数値］ボタン

詳細情報一覧に表示された変数情報のデータ型がString，またはメッセージ型の場合に，変数値の内容を別ウィンドウに表示できます。

5　コマンド（運用環境・実行環境）

この章では，サービスプラットフォームの運用環境および実行環境で使用するコマンドの文法について説明します。

5.1　コマンドの種類

サービスプラットフォームの運用環境および実行環境で使用するコマンドには，3種類あります。それぞれのコマンドは，コマンドが格納されるディレクトリが異なります。

コマンドの種類

実行する環境

機能

コマンド名がcscで始まるコマンド

運用環境

HCSCサーバの構築，基本運用，およびリポジトリやユーザの管理ができます。

なお，一部のコマンドは，Management Serverと通信してHCSCサーバを管理します。そのため，コマンドを強制停止しても処理は継続されることがあります。

また，コマンド名とJavaVM起動オプションをHCSC-ManagerコマンドJavaVM起動オプション定義ファイルに設定しておくと，コマンド実行時に設定内容が適用されます。

コマンド名がcsmで始まるコマンド※

実行環境

各種アカウントの管理や，転送履歴を表示できます。

コマンド名がcsaで始まるコマンド

注※

使用するデータベースがHiRDBでJDBCドライバがHiRDB Type4 JDBC Driverの場合は，HCSC-Messagingコマンド共通定義ファイルにHiRDB Type4 JDBC Driverのパスを指定してください。

使用するデータベースがOracleの場合は，HCSC-Messagingコマンド共通定義ファイルにOracle JDBC Thin Driverのパスを指定してください。

注意事項

サービスプラットフォームの運用環境および実行環境で使用するコマンドは管理者権限のあるユーザで実行してください。なお，UNIXの場合のService Coordinatorの管理者の変更方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「付録A　Service Coordinator管理者の変更方法（UNIXの場合）」を参照してください。

5.1.1　コマンドの一覧

サービスプラットフォームのコマンドの一覧を運用環境と実行環境に分けて表で示します。

(1)　運用環境で使用するコマンドの一覧

運用環境で使用するコマンドは次の場所に格納されています。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥bin

運用環境で使用するコマンドを次の表に示します。

表5‒1　サービスプラットフォームの運用環境で使用するコマンドの一覧

機能の分類

コマンド

説明

処理の分類

大分類

小分類

管理系

ユーザ管理

cscpasswd

指定された条件に従ってユーザ情報を変更します。

A

リポジトリ管理

cscrepls

リポジトリ情報を標準出力に出力します。

C

cscrepdiff

現在のリポジトリ情報とエクスポートしたリポジトリ情報の差分を標準出力に表示します。

C

cscrepcheck

リポジトリのインポート可否を検証します。

A

cscrepctl

リポジトリ内の情報をZIP形式ファイルに出力したり，ZIP形式で保存された情報をリポジトリに展開したりします。

A

cscrepupdate

運用環境のリポジトリをアップデートします。

A

サービス管理

cscsvcls

サービス情報を標準出力に出力します。また，cscsvcctlコマンドの引数に指定する値を調べます。

C

cscsvcctl

サービス情報変更定義ファイルを出力または入力します。また，サービスアダプタに関するサービス情報を変更します。

A

環境管理

cscenvbackup

HCSC-Manager環境の復元に必要なファイルをバックアップします。

C

cscenvrestore

HCSC-Manager環境のバックアップファイルを利用して環境を復元します。

A

構築系

サーバ構築

cscsvsetup

HCSCサーバのセットアップをします。

A

cscsvunsetup

HCSCサーバのアンセットアップをします。

A

HCSCコンポーネントの構築

csccompodeploy

HCSCコンポーネントを配備します。

A

csccompoundeploy

配備済みのHCSCコンポーネントを削除します。

A

サーバ定義設定，取得

cscsvconfig

（-operationオプションにsetを指定）

HCSCサーバの定義情報を更新します。

B

cscsvconfig

（-operationオプションにgetを指定）

HCSCサーバの定義情報を取得します。

C

定義ファイルの取得，設定，削除

csccmctl（-operationオプションにgetを指定）

開発環境で設定した定義ファイルを取得します。

D

csccmctl（-operationオプションにsetを指定）

定義ファイルを運用環境上に設定します。

A

csccmctl（-operationオプションにresetを指定）

運用環境上に設定した定義ファイルを削除します。

A

HCSCコンポーネント定義設定，取得

csccompoconfig

（-operationオプションにsetを指定）

ユーザ定義受付の定義情報を更新します。

B

csccompoconfig

（-operationオプションにgetを指定）

ユーザ定義受付の定義情報を取得します。

C

簡易セットアップ

cscsetup

本番環境に適用できるシステムを容易に構築します。

A

運用系

サーバ運用

cscsvstart

HCSCサーバを起動します。

B

cscsvstop

HCSCサーバを停止します。

B

HCSCコンポーネント運用

csccompostart

HCSCコンポーネントを開始します。

B

csccompostop

HCSCコンポーネントを停止します。

B

cscprecache

フォーマット定義およびデータ変換定義を事前キャッシュします。

C

標準受付およびユーザ定義受付

cscrcptnstart

標準受付およびユーザ定義受付を開始します。

B

cscrcptnstop

標準受付およびユーザ定義受付を停止します。

B

状態確認

cscstatus

HCSCサーバ，標準受付，およびHCSCコンポーネントの状態を表示します

C

稼働確認

cscresinfo

HCSCサーバのリソースの稼働情報を表示します。

C

汎用

cscutil

次に示す操作をします。

HCSCサーバの起動と停止

HCSCコンポーネントの開始，停止および情報取得

HCSCサーバセットアップ情報，HCSCサーバ情報の取得

標準受付の開始と停止

ユーザ定義受付の情報取得

D

cscpiselect

指定された条件に従ってビジネスプロセス情報を検索しCSVまたはTSV形式で出力します。

C

cscpidelete

指定された条件に従ってビジネスプロセスの実行履歴を削除します。

C

cscpireexec

指定された条件に従って実行中のビジネスプロセスを再実行します。

C

cscapputil

HCSCサーバが管理しているアプリケーションを操作します。

C

ファイル連携

フォルダ運用

cscfscls

共通フォルダ内のファイルを参照します。

C

cscfscrm

共通フォルダ内のファイルを削除します。

B

cscfswls

作業フォルダを参照します。

C

cscfswrm

作業フォルダを削除します。

B

ツール

バージョンアップ

cscenvupdate

指定した実行環境のHCSCサーバをバージョンアップします。

A

メッセージトラッキング

cscmsgtk

メッセージトラッキングを起動し，メッセージトラッキングプロンプトを表示します。

E

（凡例）

A：リポジトリ更新コマンド（実行時にリポジトリが更新されるコマンド）です。

B：サーバ更新コマンド（実行時にHCSCサーバの情報または状態が更新されるコマンド）です。

C：参照コマンド（実行時に情報を参照するだけのコマンド）です。HCSCサーバやリポジトリは更新されません。

D：オプションによって，サーバ更新コマンドか参照コマンドかが異なります。

E：リポジトリ更新，サーバ更新，参照のどれにも該当しないコマンドです。

(2)　実行環境で使用するコマンドの一覧

実行環境で使用するコマンドは次の場所に格納されています。

csaftpで始まるコマンド

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥FTP¥bin

それ以外のコマンド

<サービスプラットフォームのインストールディレクトリ>¥CSC¥bin

実行環境で使用するコマンドを次の表に示します。

表5‒2　サービスプラットフォームの実行環境で使用するコマンドの一覧

機能の分類

コマンド

説明

処理の分類

大分類

小分類

FTP連携

ユーザの登録，更新，取得

csaftpuseradd

FTPアダプタに新規のユーザを登録します。

B

csaftpuserdel

FTPアダプタに登録されているユーザを削除します。

B

csaftpuserls

FTPアダプタに登録されているユーザを表示します。

C

csmftpaddusr

FTPインバウンドアダプタに新規のユーザを登録します。

B

csmftpdelusr

FTPインバウンドアダプタに登録されているユーザを削除します。

B

csmftplsusr

FTPインバウンドアダプタに登録されているユーザを表示します。

C

転送履歴

csmftplshistory

FTPインバウンドアダプタの転送履歴を表示します。

C

メール連携

ユーザの登録，更新，取得

csmmailaddusr

メールアダプタアカウント定義ファイルにユーザ情報を登録（または更新）します。

B

csmmaildelusr

メールアダプタアカウント定義ファイルに登録されているユーザ情報を削除します。

B

csmmaillsusr

メールアダプタアカウント定義ファイルに登録されているユーザ情報を表示します。

C

公開鍵認証

秘密鍵の情報の登録，更新，取得

csakeyadd

公開鍵認証情報に秘密鍵の情報を登録（または更新）します。

B

csakeydel

公開鍵認証情報に登録されている秘密鍵の情報を削除します。

B

csakeyls

公開鍵認証情報に登録されている秘密鍵の情報を表示します。

C

パスワード認証

ユーザの登録，更新，取得

csauseradd

パスワード認証情報にユーザおよびパスワードを登録（または更新）します。

B

csauserdel

パスワード認証情報に登録されているユーザおよびパスワードを削除します。

B

csauserls

パスワード認証情報に登録されているユーザおよびパスワードを表示します。

C

アカウント情報

ユーザの登録，更新，取得

csahttpuseradd

HTTPアダプタアカウント定義ファイルにアカウント情報を登録（または更新）します。

B

csahttpuserdel

HTTPアダプタアカウント定義ファイルに登録されているアカウント情報を削除します。

B

csahttpuserls

HTTPアダプタアカウント定義ファイルに登録されているアカウント認証のユーザ情報を表示します。

C

（凡例）

B：サーバ更新コマンド（実行時にHCSCサーバの情報または状態が更新されるコマンド）です。

C：参照コマンド（実行時に情報を参照するだけのコマンド）です。HCSCサーバやリポジトリは更新されません。

5.1.2　コマンドの同時実行について

コマンドを実行するときに，ほかの操作が実行中の場合，コマンドが実行できない場合があります。ほかの操作を実行中の場合にコマンドが実行できるかどうかを次の表に示します。

表5‒3　ほかの操作が実行中のコマンドの実行可否

実行するコマンド

現在実行中の操作，または現在の状態

リポジトリ更新コマンド実行中

サーバ更新コマンド実行中

参照コマンド実行中

画面へログインしている状態

画面からの操作中（更新系）

リポジトリ更新コマンド

×

×

×

×

×

サーバ更新コマンド

×

×

○

○

×

参照コマンド

×

○

○

○

○

（凡例）

○：コマンドが実行できます。

×：コマンドは実行できません。リポジトリ更新コマンドとリポジトリ操作（参照/更新）のあるコマンドとを同時実行した場合，排他エラーとなりリターンコード3が返ります。

注

cscutilコマンドには，サーバ更新コマンドの機能（HCSCサーバの起動，停止など）と，参照コマンドの機能（HCSCサーバ情報の取得など）があります。

ほかの操作が実行中の場合にcscutilコマンドを実行するときは，実行する機能（オプションの指定）によって，実行の可否が異なります。

5.1.3　コマンドのタイムアウト機能

実行したコマンドの応答がない場合に備え，タイムアウト機能があります。HCSCサーバが提供するタイムアウト機能を次に示します。各定義ファイルについては，「6.5　HCSCサーバの運用で利用するファイル」を参照してください。

表5‒4　HCSCサーバが提供するタイムアウト機能

定義ファイル

プロパティ

タイムアウト機能の種類

HCSC-Manager定義ファイル

cscmng.manager.<マネージャ識別名>.timeout

通信タイムアウト

cscmng.server.<HCSCサーバ名>.hws.svstop.timeout

監視時間

HCSCサーバランタイム定義ファイル

csc-command-timeout

通信タイムアウト

csc-precache-timeout

通信タイムアウト

startcsc-timeout

監視時間

stopcsc-timeout

監視時間

j2ee-stopapp-timeout

監視時間

receptionstop-monitor-timer

通信タイムアウト，

監視時間

csc-receptionstop-timeout

通信タイムアウト

（凡例）

通信タイムアウト：

通信障害を検出します。

監視時間：

コマンドの延長で，ある対象が期待する状態になるまで待機します。

「監視時間」に分類されるプロパティは，システムの拡張（HCSCコンポーネントの増加）に応じてタイムアウト値のチューニングが必要となります。

注意事項

コマンドのタイムアウト機能は，その時間を超過した時点でコマンドクライアント側に制御を返すことは保証しません。

コマンドによっては，障害発生時に巻き戻し処理が実行される場合があるため，設定した時間を超過してからクライアント側に結果が通知されるまで，設定値より長い時間を要する場合もあります。

5.1.4　コマンドの中断機能

リソースをある時間までに解放させる方法として中断機能があります。中断条件（時間）を指定しておくことで，コマンドの実行中に処理を中断できます。中断機能によって実行が中断されたコマンドは警告メッセージを出力し，終了コード「10」を返します。

HCSCサーバが提供する中断機能を次に示します。

cscpideleteコマンド（-canceltimerオプション）

cscpiselectコマンド（-canceltimerオプション）

5.2　コマンドの入力形式

コマンドの入力形式を次に示します。

コマンド名 [引数…]

各項目について説明します。なお，コマンドプロンプトを「$」，コマンド名を「cmd」と表記します。

コマンド名

実行するコマンドのファイル名を指定します。

空白を含むパスを指定してコマンドを実行する場合，パス全体を" "で囲む必要があります。

誤った指定例：$ C:¥Program Files¥Hitachi¥Cosminexus¥CC¥server¥bin¥cmd

正しい指定例：$ "C:¥Program Files¥Hitachi¥Cosminexus¥CC¥server¥bin¥cmd"

引数

引数には，オプションも含まれます。オプションの入力形式および指定規則を次に示します。

オプションの入力形式

オプションは，ハイフン（-）で始まる文字列です。オプションの入力形式には，オプション引数を指定しない形式と，1個のオプション引数を指定する形式があります。

オプション引数を指定しない形式

$ cmd -オプションフラグ

1個のオプション引数を指定する形式

$ cmd -オプションフラグ オプション引数

（凡例）

オプションフラグ

1文字の半角英数字です。大文字と小文字が区別されます。

オプション引数

オプションフラグに対する引数です。

オプションの指定規則

オプションフラグは，1つのハイフン（-）にまとめて指定できません。

誤った指定例：$ cmd -abc

正しい指定例：$ cmd -a -b -c

オプション引数を必要とするオプションフラグのオプション引数は，省略できません。

オプションフラグとオプション引数の間には，スペースまたはタブが必要です。

誤った指定例：$ cmd -afile

正しい指定例：$ cmd -a file

同じオプションフラグは，複数指定できません。

誤った指定例：$ cmd -a 1 -a 2

オプション引数に空白を含む場合，オプション引数全体を""で囲む必要があります。

誤った指定例：$ cmd -a file 1

正しい指定例：$ cmd -a "file 1"

オプション引数に特殊文字（エスケープ文字）を含む場合，特殊文字を""で囲む必要があります。

誤った指定例：$ cmd -a xyz;12

正しい指定例：$ cmd -a "xyz;12"

オプションの優先順位

各コマンドのオプションの幾つかは，HCSC-Managerコマンド共通定義ファイルに記述すると省略できます。HCSC-Managerコマンド共通定義ファイルとコマンド引数の指定は，次のような優先順位になります。

・HCSC-Managerコマンド共通定義ファイルとコマンド引数の両方に指定がある場合

コマンド引数に指定した方が有効となります。

・HCSC-Managerコマンド共通定義ファイルとコマンド引数の両方に記述がない場合

異常終了します。

HCSC-Managerコマンド共通定義ファイルの詳細については，「6.5.2　HCSC-Managerコマンド共通定義ファイル」を参照してください。

オプションの指定に優先順位はありません。例1と例2は，同一のコマンドとして扱われます。

例1：$ cmd -a file -b option

例2：$ cmd -b option -a file

5.3　コマンドの文法の記述形式

以降で説明するコマンドの文法について，次の形式で記述します。なお，各コマンドは，アルファベットの順に説明します。

形式

コマンドの入力形式を示します。

機能

コマンドの機能について説明します。

引数

コマンドの引数およびオプションについて説明します。

出力形式

コマンドの出力形式を示します。

入力例

コマンドの入力例を示します。

表示形式

コマンドの出力形式を示します。

表示例

コマンドの表示例を示します。

戻り値

コマンドの戻り値について示します。

注意事項

コマンドを実行する上での全体的な注意事項について説明します。

注

すべてのコマンドで上記の項目をすべて説明しているわけではありません。また，上記以外に，各コマンドの固有情報を記載している場合があります。

この章の文法の説明で使用している記号を次に示します。

記号

意味

　｜

横に並べられた複数の項目に対する項目間の区切りを示し，「または」を意味します。

（例）　A｜B

AまたはBを指定することを示します。

{ 　 }

この記号で囲まれている複数の項目のうちから1つを選択することを示します。項目が横に並べられ，記号｜で区切られている場合は，そのうちの1つを選択します。

（例）　｛A｜B｜C｝

A，BまたはCのどれかを指定することを示します。

［　］

この記号で囲まれている項目は省略してもよいことを示します。

（例）　［A］

「何も指定しない」か「Aを指定する」ことを示します。

<　>

この記号で囲まれている項目は，該当する要素を指定することを示します。

（例）　<プロパティ>

プロパティを記述します。

…

記述が省略されていることを示します。

（例）　ABC…

ABCの後ろに記述があり，その記述が省略されていることを示します。

〜

この記号の前に示された項目が，記号〜に続く＜　＞，((　))，<<　>>などの規則に従うことを示します。

＜　＞

項目を記述するときに従わなければならない構文要素を示します。構文要素については，次の表を参照してください。

((　))

項目で指定できる値の範囲を示します。

<<　>>

項目を省略したときに，システムが仮定する標準値を示します。

この章で使用している構文要素の種類と定義を次に示します。

種類

定義

英字

A〜Z　a〜z

英小文字

a〜z

英大文字

A〜Z

数字

0〜9

英数字

A〜Z　a〜z　0〜9

記号

_　.　-

文字列

任意の文字の配列

5.4　サービスプラットフォームの運用環境および実行環境で使用するコマンド

csaftpuseradd（FTPアダプタのユーザの登録・更新）

形式

csaftpuseradd [-h]
             { -userinfofile <ユーザ情報指定ファイルのパス>
             | -user <ログインユーザID>
               -pass <ログインパスワード>
              [-account <課金情報>] }
              [-r]
             { -f <FTPアダプタアカウント定義ファイルのパス> | -name <サービスID> }

機能

FTPアダプタアカウント定義ファイルに新規のユーザを登録します。登録できるユーザ数の上限はありません。ユーザがすでに登録されている場合は，パスワードや課金情報を更新します。

コマンドを実行する前の注意事項を次に示します。

このコマンドの-passオプションにパスワードを指定した場合，プロセスの引数を確認できるOS機能などによって，パスワードが検知されるおそれがあります。このため，-userinfofileオプションを使用した，ユーザ情報指定ファイルでのパスワードの設定を推奨します。

運用コマンドを実行する管理者にだけ，FTPアダプタアカウント定義ファイルに対する更新・参照のアクセス権を設定してください。

コマンドにユーザ情報指定ファイルを指定する場合，運用コマンドを実行する管理者にだけ，ユーザ情報指定ファイルに対する更新・参照のアクセス権を設定してください。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.4.14　FTPアダプタのユーザ情報を確認および変更する」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-userinfofile <ユーザ情報指定ファイルのパス>

ログインユーザID，ログインパスワード，課金情報が記載されているユーザ情報指定ファイルのパスを指定します。絶対パス，またはコマンド実行時のカレントディレクトリからの相対パスで指定してください。パスが空白を含む場合は，パス全体をダブルクォーテーション（"）で囲んでください。

指定されたユーザ情報指定ファイルのユーザ情報がすべて正常であれば，その内容がFTPアダプタアカウント定義ファイルに一括で登録または更新されます。ただし，次の場合はエラーとなり，登録・更新は実施されません。

指定されたファイルが存在しない場合

ファイル内のユーザ情報に1つでも不正があった場合

ファイル内にログインユーザIDが重複している場合

なお，実行対象のユーザ情報指定ファイルには，ユーザ情報の登録または更新のどちらかだけを指定できます。

ユーザ情報指定ファイルの記載方法については，「6.21.1　ユーザ情報指定ファイル」を参照してください。

-user <ログインユーザID>　〜＜半角英数字および半角記号＞ ((1−80文字))

登録または更新したいユーザIDを指定します。

使用できる文字は，半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」），および半角スペース（ASCIIコードの「0x20」）です。大文字と小文字は区別されます。使用できる半角記号を次に示します。

感嘆符（!）

ダブルクォーテーション（"）

番号記号（#）

ドル記号（$）

パーセント（%）

アンパサンド（&）

アポストロフィ（'）

始め小括弧（(）

終わり小括弧（)）

アスタリスク（*）

正符号（+）

コンマ（,）

ハイフン（-）

ピリオド（.）

スラッシュ（/）

コロン（:）

セミコロン（;）

左アングルブラケット（<）

右アングルブラケット（>）

等号（=）

クエスチョンマーク（?）

単価記号（@）

始め角括弧（[）

終わり角括弧（]）

円マーク（¥）

アクサンシルコンフレックス（^）

アンダーバー（_）

アクサングラーブ（`）

始め波括弧（{）

終わり波括弧（}）

パイプライン（|）

波ダッシュ（~）

-pass <ログインパスワード>　〜＜半角英数字および半角記号＞ ((1−80文字))

登録または更新したいユーザIDに対するパスワードを指定します。使用できる文字は，半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」），および半角スペース（ASCIIコードの「0x20」）です。大文字と小文字は区別されます。使用できる半角記号は-userオプションと同じです。

更新したい場合（-rオプションを指定する場合），更新後のパスワードを指定します。

-account <課金情報>　〜＜半角英数字および半角記号＞ ((1文字以上))

登録または更新したいユーザに対する課金情報（アカウントを示す文字列）を指定します。使用できる文字は，半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」），および半角スペース（ASCIIコードの「0x20」）です。大文字と小文字は区別されます。使用できる半角記号は-userオプションと同じです。

このオプションを省略，または<課金情報>に空文字を指定した場合，課金情報は設定されません。

なお，課金情報が設定されているユーザのパスワードを変更する場合，このオプションを指定する必要があります。

-r

すでに登録されているユーザIDのパスワードを変更する場合に指定します。

-f <FTPアダプタアカウント定義ファイルのパス>

FTPアダプタアカウント定義ファイルのパスを相対パス，または絶対パスで指定します。空白を含む場合は，オプション引数全体をダブルクォーテーション（"）で囲みます。

ファイルが存在しない場合，新規にFTPアダプタアカウント定義ファイルが作成されます。ただし，ディレクトリが存在しない場合は，エラーになります。既存のFTPアダプタアカウント定義ファイルに新規アカウントを追加する場合は，既存のFTPアダプタアカウント定義ファイルを指定してください。

-name <サービスID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

製品固定パスでFTPアダプタ単位にユーザを管理する場合に，FTPアダプタのサービスIDを指定します。

製品固定パスにファイルが存在しない場合，新規にFTPアダプタアカウント定義ファイルが作成されます。ただし，ディレクトリが存在しない場合は，エラーになります。製品固定パスの詳細は，「6.8.1　FTPアダプタアカウント定義ファイル」を参照してください。

入力例

●ユーザ情報を任意の単位・任意のパスのアカウント定義ファイルで管理する場合

(1) 課金情報を設定するユーザを登録する場合

csaftpuseradd -user user1 -pass password1 -account account1 -f account.properties

(2) 課金情報を設定しないユーザを登録する場合

csaftpuseradd -user user2 -pass password2 -f account.properties

(3) ユーザ情報指定ファイルのユーザ情報を一括で登録する場合

csaftpuseradd -userinfofile userinfo.txt -f account.properties

(4) ユーザのパスワードと課金情報を更新する場合

csaftpuseradd -user user1 -pass passwordnew -account accountnew -r -f account.properties

(5) ユーザ情報指定ファイルのユーザ情報を一括で更新する場合

csaftpuseradd -userinfofile userinfo.txt -r -f account.properties

(6) 課金情報が設定されていないユーザのパスワードを更新する場合

csaftpuseradd -user user2 -pass passwordnew -r -f account.properties

(7) すでに登録されているユーザに課金情報を追加する場合

csaftpuseradd -user user2 -pass password2 -account account2 -r -f account.properties

(8) すでに登録されているユーザの課金情報を削除する場合

csaftpuseradd -user user1 -pass password1 -r -f account.properties

●ユーザ情報をFTPアダプタ単位・製品固定パスのアカウント定義ファイルで管理する場合

(1) 課金情報を設定するユーザを登録する場合

csaftpuseradd -user user1 -pass password1 -account account1 -name adp1

(2) 課金情報を設定しないユーザを登録する場合

csaftpuseradd -user user2 -pass password2 -name adp1

(3) ユーザ情報指定ファイルのユーザ情報を一括で登録する場合

csaftpuseradd -userinfofile userinfo.txt -name adp1

(4) ユーザのパスワードと課金情報を更新する場合

csaftpuseradd -user user1 -pass passwordnew -account accountnew -r -name adp1

(5) ユーザ情報指定ファイルのユーザ情報を一括で更新する場合

csaftpuseradd -userinfofile userinfo.txt -r -name adp1

(6) 課金情報が設定されていないユーザのパスワードを更新する場合

csaftpuseradd -user user2 -pass passwordnew -r -name adp1

(7) すでに登録されているユーザに課金情報を追加する場合

csaftpuseradd -user user2 -pass password2 -account account2 -r -name adp1

(8) すでに登録されているユーザの課金情報を削除する場合

csaftpuseradd -user user1 -pass password1 -r -name adp1

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

9

実行権限のチェックエラーが発生しました。

注意事項

FTPアダプタアカウント定義ファイルは編集できません。

コマンドの実行内容（ユーザの登録・更新）は，FTPアダプタの開始後に有効となります。また，FTPアダプタが開始している状態でコマンドを実行した場合，コマンドの実行内容（ユーザの登録・更新）は，次にFTPアダプタを開始したあとに有効となります。

FTPアダプタアカウント定義ファイルは，コマンド実行中のファイルの入出力エラー（ディスクフルなど）によって壊れるおそれがあります。定期的にバックアップを取得してください。

-fオプションに「<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥common¥account.properties」を指定しないでください。

csaftpuserdel（FTPアダプタのユーザの削除）

形式

csaftpuserdel [-h]
              -user <ログインユーザID>
              { -f <FTPアダプタアカウント定義ファイルのパス> | -name <サービスID> }

機能

FTPアダプタアカウント定義ファイルに登録されているユーザを削除します。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.4.14　FTPアダプタのユーザ情報を確認および変更する」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字および半角記号＞ ((1−80文字))

削除したいユーザIDを指定します。使用できる文字は，半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」），および半角スペース（ASCIIコードの「0x20」）です。大文字と小文字は区別されます。使用できる半角記号を次に示します。

感嘆符（!）

ダブルクォーテーション（"）

番号記号（#）

ドル記号（$）

パーセント（%）

アンパサンド（&）

アポストロフィ（'）

始め小括弧（(）

終わり小括弧（)）

アスタリスク（*）

正符号（+）

コンマ（,）

ハイフン（-）

ピリオド（.）

スラッシュ（/）

コロン（:）

セミコロン（;）

左アングルブラケット（<）

右アングルブラケット（>）

等号（=）

クエスチョンマーク（?）

単価記号（@）

始め角括弧（[）

終わり角括弧（]）

円マーク（¥）

アクサンシルコンフレックス（^）

アンダーバー（_）

アクサングラーブ（`）

始め波括弧（{）

終わり波括弧（}）

パイプライン（|）

波ダッシュ（~）

-f <FTPアダプタアカウント定義ファイルのパス>

FTPアダプタアカウント定義ファイルのパスを相対パス，または絶対パスで指定します。空白を含む場合は，オプション引数全体をダブルクォーテーション（"）で囲みます。

-name <サービスID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

FTPアダプタのサービスIDを指定します。ユーザの登録で-nameオプションを指定していない場合，このオプションではなく-fオプションを使用してください。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

9

実行権限のチェックエラーが発生しました。

注意事項

FTPアダプタアカウント定義ファイルは編集できません。

FTPアダプタアカウント定義ファイルのユーザ認証情報が0個になってもFTPアダプタアカウント定義ファイルは削除されません。

コマンドを実行する前に，運用コマンドを実行する管理者にだけ，FTPアダプタアカウント定義ファイルに対する更新・参照のアクセス権を設定してください。

コマンドの実行内容（ユーザの削除）は，FTPアダプタの開始後に有効となります。また，FTPアダプタが開始している状態でコマンドを実行した場合，コマンドの実行内容（ユーザの削除）は，次にFTPアダプタを開始したあとに有効となります。

FTPアダプタアカウント定義ファイルは，コマンド実行中のファイルの入出力エラー（ディスクフルなど）によって壊れるおそれがあります。定期的にバックアップを取得してください。

-fオプションに「<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥common¥account.properties」を指定しないでください。

csaftpuserls（FTPアダプタのユーザの表示）

形式

csaftpuserls [-h]
             { -f <FTPアダプタアカウント定義ファイルのパス> | -name <サービスID> }

機能

FTPアダプタアカウント定義ファイルに登録されているユーザを表示します。表示結果は標準出力に出力します。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.4.14　FTPアダプタのユーザ情報を確認および変更する」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-f <FTPアダプタアカウント定義ファイルのパス>

FTPアダプタアカウント定義ファイルのパスを相対パス，または絶対パスで指定します。空白を含む場合は，オプション引数全体をダブルクォーテーション（"）で囲みます。

-name <サービスID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

登録されているユーザを表示したいFTPアダプタのサービスIDを指定します。

表示形式

(1)ユーザ認証情報が登録されている場合（-name指定なし）

1：ユーザID1＝課金情報

2：ユーザID2

　　：

-nameオプションを指定しないで登録したユーザ認証情報を1行ずつ表示します。ユーザIDに対する課金情報が設定されている場合は，課金情報を表示します。

(2)ユーザ認証情報が登録されていない場合（-name指定なし）

none

(3)ユーザ認証情報が登録されている場合（-name指定あり）

1：ユーザID1＝課金情報

2：ユーザID2

　　：

-nameオプションを指定して登録したユーザ認証情報を1行ずつ表示します。ユーザIDに対する課金情報が設定されている場合は，課金情報を表示します。

(4)ユーザ認証情報が登録されていない場合（-name指定あり）

none

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

9

実行権限のチェックエラーが発生しました。

注意事項

FTPアダプタアカウント定義ファイルは編集できません。

コマンドを実行する前に，運用コマンドを実行する管理者にだけ，FTPアダプタアカウント定義ファイルに対する更新・参照のアクセス権を設定してください。

-fオプションに「<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥common¥account.properties」を指定しないでください。

csahttpuseradd（HTTPアダプタで使用するアカウント情報の登録・更新）

形式

csahttpuseradd [-h]
              { -userinfofile <ユーザ情報指定ファイルのパス>
              [-aws]
              | -user <ユーザ名>
                -pass <パスワード>
                -uri <接続先URI>
              | -accesskey <アクセスキーID>
                -secretaccesskey <シークレットアクセスキー>
                -accesskeypairid <アクセスキーペアID>
                }
               [-r]
                -f <HTTPアダプタアカウント定義ファイルのパス>

機能

アカウント情報を登録・更新します。登録できるアカウント情報の数に上限はありません。

登録・更新できるアカウント情報の種類と内容を次に示します。

ベーシック認証の認証情報で使用するアカウント情報

ユーザ名，パスワードおよび接続先URIを登録します。

同じユーザ名に対して異なる接続先URIを設定すれば，別のアカウント情報として管理することもできます。なお，パスワードはユーザ名と対にする必要があります。

署名付きAWS APIリクエストの署名生成で使用するアカウント情報

アクセスキーIDとシークレットアクセスキーを登録します。また，これらを一意に区別するためのID（アクセスキーペアID）を登録します。

登録または更新したアカウント情報は，HTTPアダプタの開始後から有効になります。また，HTTPアダプタが開始している状態でこのコマンドを実行すると，登録または更新したアカウント情報は，次のHTTPアダプタの開始後から有効となります。

アカウント情報管理コマンドでは，コマンド実行時に排他制御を実行しません。そのため，アカウント情報の更新中にほかにアカウント情報を更新するコマンド（csahttpuseraddコマンドまたはcsahttpuserdelコマンド）を実行した場合はエラーとなり，メッセージKDEC81216-Eを出力します。

コマンドを実行する前の注意事項を次に示します。

このコマンドの-passオプションにパスワードを指定した場合，プロセスの引数を確認できるOS機能などによって，パスワードが検知されるおそれがあります。このため，-userinfofileオプションを使用した，ユーザ情報指定ファイルでのパスワードの設定を推奨します。

コマンドを実行する管理者に限定して，HTTPアダプタアカウント定義ファイルに対する更新・参照権限を設定してください。

コマンドにユーザ情報指定ファイルを指定する場合，コマンドを実行する管理者に限定して，ユーザ情報指定ファイルに対する更新・参照権限を設定してください。

HTTPアダプタアカウント定義ファイルを更新する場合は，バックアップファイルの作成をお勧めします。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-userinfofile <ユーザ情報指定ファイルのパス>

ユーザ情報指定ファイルのパスを指定します。絶対パス，またはコマンド実行時のカレントディレクトリからの相対パスで指定してください。パスが空白を含む場合は，パス全体をダブルクォーテーション（"）で囲んでください。

-user，-pass，-uri，-accesskey，-secretaccesskeyオプションと同時には指定できません。

ユーザ情報指定ファイルには，ユーザ情報を次の形式で記載してください。

ベーシック認証で使用するユーザ情報を指定する場合

<ユーザ名> <パスワード> <接続先URI>

署名生成で使用するユーザ情報を指定する場合（-awsオプションと併せて指定）

<アクセスキーID> <シークレットアクセスキー> <アクセスキーペアID>

指定されたユーザ情報指定ファイルのユーザ情報がすべて正常であれば，その内容がHTTPアダプタアカウント定義ファイルに一括で登録または更新されます。ただし，次の場合はエラーとなり，登録・更新は実施されません。

指定されたファイルが存在しない場合

ファイル内のユーザ情報に1つでも不正があった場合

ファイル内にユーザ名と接続先URIの同じ組み合わせがある場合

ファイル内に<アクセスキーペアID>が重複している場合

なお，実行対象のユーザ情報指定ファイルには，ユーザ情報の登録または更新のどちらかだけを指定できます。

ユーザ情報指定ファイルの記載方法については，「6.21.1　ユーザ情報指定ファイル」を参照してください。

-aws

署名生成のユーザ情報をユーザ情報指定ファイルで登録・更新する場合に指定します。

-user，-pass，-uri，-accesskey，-secretaccesskeyオプションと同時には指定できません。

このオプションは-userinfofileオプションと併せて指定します。ユーザ情報指定ファイルには，ユーザ情報を「<アクセスキーID><シークレットアクセスキー> <アクセスキーペアID>」で指定します。

-user <ユーザ名>　〜＜半角英数字および半角記号＞ ((1〜80文字))

登録または更新したいアカウント情報のユーザ名を指定します。

-userinfofile，-aws，-accesskeypairid，-accesskey，-secretaccesskeyオプションと同時には指定できません。

使用できる文字は，半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」），および半角スペース（ASCIIコードの「0x20」）です。大文字と小文字は区別されます。使用できる半角記号を次に示します。

感嘆符（!）

ダブルクォーテーション（"）

番号記号（#）

ドル記号（$）

パーセント（%）

アンパサンド（&）

アポストロフィ（'）

始め小括弧（(）

終わり小括弧（)）

アスタリスク（*）

正符号（+）

コンマ（,）

ハイフン（-）

ピリオド（.）

スラッシュ（/）

コロン（:）

セミコロン（;）

左アングルブラケット（<）

右アングルブラケット（>）

等号（=）

クエスチョンマーク（?）

単価記号（@）

始め角括弧（[）

終わり角括弧（]）

円マーク（¥）

アクサンシルコンフレックス（^）

アンダーバー（_）

アクサングラーブ（`）

始め波括弧（{）

終わり波括弧（}）

パイプライン（|）

波ダッシュ（~）

指定したユーザ名とHTTPアダプタアカウント定義ファイルのユーザ名が完全一致した場合，同一のユーザ名と判断されます。

-pass <パスワード>　〜＜半角英数字および半角記号＞ ((1〜80文字))

登録または更新するアカウント情報に対応するパスワードを指定します。

-userinfofile，-aws，-accesskeypairid，-accesskey，-secretaccesskeyオプションと同時には指定できません。

使用できる文字は，半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」），および半角スペース（ASCIIコードの「0x20」）です。大文字と小文字は区別されます。使用できる半角記号を次に示します。

感嘆符（!）

ダブルクォーテーション（"）

番号記号（#）

ドル記号（$）

パーセント（%）

アンパサンド（&）

アポストロフィ（'）

始め小括弧（(）

終わり小括弧（)）

アスタリスク（*）

正符号（+）

コンマ（,）

ハイフン（-）

ピリオド（.）

スラッシュ（/）

コロン（:）

セミコロン（;）

左アングルブラケット（<）

右アングルブラケット（>）

等号（=）

クエスチョンマーク（?）

単価記号（@）

始め角括弧（[）

終わり角括弧（]）

円マーク（¥）

アクサンシルコンフレックス（^）

アンダーバー（_）

アクサングラーブ（`）

始め波括弧（{）

終わり波括弧（}）

パイプライン（|）

波ダッシュ（~）

-uri <接続先URI>　〜＜半角英数字および半角記号＞

ベーシック認証を実施するサービスのURIを指定します。アカウント情報から作成された認証情報は，ここで指定された接続先URIでベーシック認証が実施されます。

-userinfofile，-aws，-accesskeypairid，-accesskey，-secretaccesskeyオプションと同時には指定できません。

接続先URIの指定形式を次に示します。< >で囲まれた部分は要素を表し，[ ]で囲まれた部分は省略できることを表します。

<scheme>://<host>[:<port>][<path>]

ここで指定した値は，認証情報の作成時に実行されるURIのマッチングで，次のように補完または解釈されます。

「:<port>」を省略した場合，次に示す値で補完されます。

httpの場合：80

httpsの場合：443

「<path>」を省略した場合，「/」が補完されます。

「<scheme>」および「<host>」は，大文字と小文字は区別されません。

指定した接続先URIと，HTTPアダプタアカウント定義ファイルの接続先URIを正規化して，それらの値が完全一致した場合，同一の接続先URIと判断されます。

なお，接続先URIを更新する場合は，ユーザ名および接続先URIを指定してアカウント情報を削除し，再度登録してください。

-accesskey <アクセスキーID>　〜＜半角英数字およびアンダーバー（_）＞

署名生成のユーザ情報を指定する場合に，登録または更新するアカウント情報のアクセスキーIDを指定します。

-userinfofile，-aws，-user，-pass，-uriオプションと同時には指定できません。

-secretaccesskey <シークレットアクセスキー>

署名生成のユーザ情報を指定する場合に，登録または更新するアカウント情報のシークレットアクセスキーを指定します。

-userinfofile，-aws，-user，-pass，-uriオプションと同時には指定できません。

-accesskeypairid <アクセスキーペアID>　〜＜半角英数字およびアンダーバー（_）＞

署名生成のユーザ情報を指定する場合に，登録または更新するアカウント情報のアクセスキーペア（アクセスキーIDとシークレットアクセスキー）を一意に区別するためのIDを指定します。

-userinfofile，-aws，-user，-pass，-uriオプションと同時には指定できません。

-r

次のどちらかの情報を更新する場合に指定します。

ユーザ名（-user）と接続先URI（-uri）に対応するパスワード

-passオプションと併せて指定する必要があります。

アクセスキーペアID（-accesskeypairid）に対応するアクセスキーIDとシークレットアクセスキー

-accesskeyオプション，-secretaccesskeyオプションと併せて指定する必要があります。なお，未登録のアクセスキーペアIDを指定した場合，エラーになり更新に失敗します。

-f <HTTPアダプタアカウント定義ファイルのパス>

このコマンドで定義したアカウント情報を保存するための，HTTPアダプタアカウント定義ファイルのパスを相対パスまたは絶対パスで指定します。パスに空白を含む場合は，オプション引数全体をダブルクォーテーション（"）で囲んでください。

指定したファイルが存在しない場合は次のように動作します。

アカウント情報の登録時

指定したファイル名で，HTTPアダプタアカウント定義ファイルが新規作成されます。ただし，指定したディレクトリが存在しない場合はエラーになります。

アカウント情報の更新時（引数-rを指定した場合）

エラーになります。

コマンド実行後，ここで保存したHTTPアダプタアカウント定義ファイルは，HTTPアダプタ実行環境プロパティファイルのadphttp.config.account-inf-filepathプロパティに設定することで読み込まれます。HTTPアダプタ実行環境プロパティファイルについては，「6.14.2　HTTPアダプタ実行環境プロパティファイル」を参照してください。

入力例

●アクセスキーID・シークレットアクセスキーを登録する場合

(1) コマンド引数に指定する場合

csahttpuseradd -accesskey AKIAIOSFODNN7EXAMPLE -secretaccesskey wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY -accesskeypairid EXAMPLEKEYPAIRID -f "C:¥Program Files¥Hitachi¥Cosminexus¥CSC¥custom-adapter¥HTTP¥config¥account.properties"

(2) ユーザ情報指定ファイルに指定する場合

csahttpuseradd -userinfofile C:¥temp¥userinfo.txt -aws -f "C:¥Program Files¥Hitachi¥Cosminexus¥CSC¥custom-adapter¥HTTP¥config¥account.properties"

●アクセスキーID・シークレットアクセスキーを更新する場合

(1) コマンド引数に指定する場合

csahttpuseradd -accesskey AKIAIOSFODNN7EXAMPLE -secretaccesskey wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY -accesskeypairid EXAMPLEKEYPAIRID -r -f "C:¥Program Files¥Hitachi¥Cosminexus¥CSC¥custom-adapter¥HTTP¥config¥account.properties"

(2) ユーザ情報指定ファイルに指定する場合

csahttpuseradd -userinfofile C:¥temp¥userinfo.txt -aws -r -f "C:¥Program Files¥Hitachi¥Cosminexus¥CSC¥custom-adapter¥HTTP¥config¥account.properties"

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

9

実行権限のチェックエラーが発生しました。

注意事項

HTTPアダプタアカウント定義ファイルは直接編集しないでください。

csahttpuserdel（HTTPアダプタで使用するアカウント情報の削除）

形式

csahttpuserdel [-h]
               {-user <ユーザ名>
                -uri <接続先URI>
              | -accesskeypairid <アクセスキーペアID> }
                -f <HTTPアダプタアカウント定義ファイルのパス>

機能

HTTPアダプタアカウント定義ファイルに登録されているアカウント情報を削除します。削除できるアカウント情報は次のとおりです。

ベーシック認証の認証情報で使用するアカウント情報

指定されたユーザ名と接続先URIの組み合わせを基に，アカウント情報を削除します。

署名付きAWS APIリクエストの署名生成で使用するアカウント情報

指定されたアクセスキーペアIDを基に，アカウント情報を削除します。

削除したアカウント情報は，HTTPアダプタの開始後に反映されます。また，HTTPアダプタが開始している状態でこのコマンドを実行すると，削除したアカウント情報は，HTTPアダプタの次回開始後に反映されます。

なお，HTTPアダプタアカウント定義ファイルは，アカウント情報数が0個になっても削除されません。

アカウント情報管理コマンドでは，コマンド実行時に排他制御を実行しません。そのため，アカウント情報の更新中にほかにアカウント情報を更新するコマンド（csahttpuseraddコマンドまたはcsahttpuserdelコマンド）を実行した場合はエラーとなり，メッセージKDEC81216-Eを出力します。

コマンドを実行する前の注意事項を次に示します。

コマンドを実行する管理者に限定して，HTTPアダプタアカウント定義ファイルに対する更新・参照権限を設定してください。

HTTPアダプタアカウント定義ファイルのバックアップファイルの作成をお勧めします。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ユーザ名>　〜＜半角英数字および半角記号＞ ((1〜80文字))

削除したいアカウント情報のユーザ名を指定します。大文字と小文字は区別されます。

-accesskeypairidオプションと同時には指定できません。

指定したユーザ名とHTTPアダプタアカウント定義ファイルのユーザ名が完全一致した場合，同一のユーザ名と判断されます。

-uri <接続先URI>

削除するアカウント情報の接続先URIを指定します。

-accesskeypairidオプションと同時には指定できません。

指定した接続先URIと，HTTPアダプタアカウント定義ファイルの接続先URIを正規化して，それらの値が完全一致した場合，同一の接続先URIと判断されます。

-accesskeypairid <アクセスキーペアID>　〜＜半角英数字およびアンダーバー（_）＞

署名生成のユーザ情報を指定する場合に，削除するアカウント情報のアクセスキーペアIDを指定します。未登録のアクセスキーペアIDを指定した場合，エラーとなり削除に失敗します。

-user，-uriオプションと同時には指定できません。

-f <HTTPアダプタアカウント定義ファイルのパス>

削除するアカウント情報が登録されているHTTPアダプタアカウント定義ファイルのパスを相対パスまたは絶対パスで指定します。パスに空白を含む場合は，オプション引数全体をダブルクォーテーション（"）で囲みます。

コマンド実行後，ここで指定したHTTPアダプタアカウント定義ファイルは，HTTPアダプタ実行環境プロパティファイルのadphttp.config.account-inf-filepathプロパティに設定することで読み込まれます。HTTPアダプタ実行環境プロパティファイルについては，「6.14.2　HTTPアダプタ実行環境プロパティファイル」を参照してください。

指定したファイルが存在しない場合は，エラーになります。

入力例

アクセスキーID・シークレットアクセスキーを削除する場合

csahttpuserdel -accesskeypairid EXAMPLEKEYPAIRID -f "C:¥Program Files¥Hitachi¥Cosminexus¥CSC¥custom-adapter¥HTTP¥config¥account.properties"

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

9

実行権限のチェックエラーが発生しました。

注意事項

HTTPアダプタアカウント定義ファイルは直接編集しないでください。

csahttpuserls（HTTPアダプタで使用するアカウント認証のユーザ情報の表示）

形式

csahttpuserls [-h]
              [-aws]
               -f <HTTPアダプタアカウント定義ファイルのパス>

機能

HTTPアダプタアカウント定義ファイルに登録されているアカウント情報を表示します。表示形式については「表示形式」を参照してください。

コマンドを実行する前の注意事項を次に示します。

コマンドを実行する管理者に限定して，HTTPアダプタアカウント定義ファイルに対する更新・参照権限を設定してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-aws

HTTPアダプタアカウント定義ファイルに登録されているアクセスキーペアIDを表示する場合に指定します。

このオプションを指定しない場合は，ユーザ名と接続先URIを表示します。

-f <HTTPアダプタアカウント定義ファイルのパス>

HTTPアダプタアカウント定義ファイルのパスを相対パスまたは絶対パスで指定します。パスに空白を含む場合は，指定値をダブルクォーテーション（"）で囲んでください。

指定したファイルが存在しない場合はエラーになります。

表示形式

(1)HTTPアダプタアカウント定義ファイルに登録情報がある場合

コマンドに-awsオプションを指定しないで実行した場合

接続先URIとユーザ名の間を半角スペースで区切って，1行ずつ表示します（△は半角スペース）。

-------------------------------------------------------------
接続先URI△ユーザ名
　　：
　　：
-------------------------------------------------------------

コマンドに-awsオプションを指定して実行した場合

アクセスキーペアIDを1行ずつ表示します。

-------------------------------------------------------------
アクセスキーペアID
　　：
　　：
-------------------------------------------------------------

(2)HTTPアダプタアカウント定義ファイルに登録情報がない場合

情報，ヘッダ，フッタとも表示しません。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

9

実行権限のチェックエラーが発生しました。

注意事項

HTTPアダプタアカウント定義ファイルは直接編集しないでください。

csakeyadd（公開鍵認証の秘密鍵情報の登録・更新）

形式

csakeyadd [-h]
         { -userinfofile <ユーザ情報指定ファイルのパス>
         | -keyfile <秘密鍵のファイルパス>
          [-pass <秘密鍵のパスフレーズ>]
           -keyid <鍵ID> }
          [-r]
           -f <公開鍵認証情報定義ファイルのパス>

機能

ユーザ認証のうち，公開鍵認証に必要な秘密鍵の情報を登録または更新します。登録できる公開鍵認証情報の数に上限はありません。

登録または更新した公開鍵認証情報は，それを使用するサービスアダプタの初回リクエスト時に有効となります。また，初回リクエスト後にこのコマンドを実行すると，登録または更新した公開鍵認証情報は，次のサービスアダプタの開始後から有効となります。

コマンドを実行する前の注意事項を次に示します。

このコマンドの-passオプションにパスワードを指定した場合，プロセスの引数を確認できるOS機能などによって，パスワードが検知されるおそれがあります。このため，-userinfofileオプションを使用した，ユーザ情報指定ファイルでのパスワードの設定を推奨します。

コマンドを実行する管理者に限定して，公開鍵認証情報定義ファイルと秘密鍵ファイルに対する更新・参照権限を設定してください。

コマンドにユーザ情報指定ファイルを指定する場合，コマンドを実行する管理者に限定して，ユーザ情報指定ファイルに対する更新・参照権限を設定してください。

公開鍵認証情報定義ファイルを更新する場合は，バックアップファイルの作成をお勧めします。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-userinfofile <ユーザ情報指定ファイルのパス>

秘密鍵のファイルパス，秘密鍵のパスフレーズ，鍵IDが記載されているユーザ情報指定ファイルのパスを指定します。絶対パス，またはコマンド実行時のカレントディレクトリからの相対パスで指定してください。パスが空白を含む場合は，パス全体をダブルクォーテーション（"）で囲んでください。

指定されたユーザ情報指定ファイルのユーザ情報がすべて正常であれば，その内容が公開鍵認証情報定義ファイルに一括で登録または更新されます。ただし，次の場合はエラーとなり，登録・更新は実施されません。

指定されたファイルが存在しない場合

ファイル内のユーザ情報に1つでも不正があった場合

ファイル内に鍵IDが重複している場合

なお，実行対象のユーザ情報指定ファイルには，ユーザ情報の登録または更新のどちらかだけを指定できます。

ユーザ情報指定ファイルの記載方法については，「6.21.1　ユーザ情報指定ファイル」を参照してください。

-keyfile <秘密鍵のファイルパス>

秘密鍵ファイルのパスを相対パスまたは絶対パスで指定します。パスに空白を含む場合は，オプション引数全体をダブルクォーテーション（"）で囲みます。

指定したファイルが存在しない場合はエラーになります。

-pass <秘密鍵のパスフレーズ>

対象となる秘密鍵にパスフレーズが設定されている場合，秘密鍵のパスフレーズを指定します。

-keyid <鍵ID>　〜＜半角英数字およびアンダーバー（_）＞ ((1〜8文字))

秘密鍵を一意に区別するためのIDを指定します。

公開鍵認証情報の登録時

公開鍵認証情報定義ファイル内で一意となるIDを指定してください。

公開鍵認証情報の更新時（引数-rを指定した場合）

公開鍵認証情報定義ファイルに登録されているIDを指定してください。

-r

登録済みの公開鍵認証情報を更新する場合に指定します。

-f <公開鍵認証情報定義ファイルのパス>

このコマンドで定義した公開鍵認証情報を保存するための，公開鍵認証情報定義ファイルのパスを相対パスまたは絶対パスで指定します。パスに空白を含む場合は，オプション引数全体をダブルクォーテーション（"）で囲みます。

指定したファイルが存在しない場合は次のように動作します。

公開鍵認証情報の登録時

指定したファイル名で，公開鍵認証情報定義ファイルが新規作成されます。ただし，指定したディレクトリが存在しない場合はエラーになります。

公開鍵認証情報の更新時（引数-rを指定した場合）

エラーになります。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

9

実行権限のチェックエラーが発生しました。

注意事項

公開鍵認証情報定義ファイルは直接編集しないでください。

コマンドの実行後は，秘密鍵ファイルの編集・移動はしないでください。

csakeydel（公開鍵認証の秘密鍵情報の削除）

形式

csakeydel [-h]
          -keyid <鍵ID>
          -f <公開鍵認証情報定義ファイルのパス>

機能

公開鍵認証情報定義ファイルに登録されている秘密鍵の情報を削除します。

削除した秘密鍵の情報は，認証情報を使用するサービスアダプタの開始後に反映されます。また，サービスアダプタが開始している状態でこのコマンドを実行すると，削除した秘密鍵の情報は，次のサービスアダプタの開始後に反映されます。

なお，秘密鍵ファイルは，秘密鍵の情報を削除しても削除されません。公開鍵認証情報数が0個になった場合も，公開鍵認証情報定義ファイルは削除されません。

コマンドを実行する前の注意事項を次に示します。

コマンドを実行する管理者に限定して，公開鍵認証情報定義ファイルに対する更新・参照権限を設定してください。

公開鍵認証情報定義ファイルのバックアップファイルの作成をお勧めします。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-keyid <鍵ID>　〜＜半角英数字およびアンダーバー（_）＞ ((1〜8文字))

削除したい公開鍵認証情報の秘密鍵のIDを指定します。

-f <公開鍵認証情報定義ファイルのパス>

公開鍵認証情報定義ファイルのパスを相対パスまたは絶対パスで指定します。パスに空白を含む場合は，オプション引数全体をダブルクォーテーション（"）で囲みます。

指定したファイルが存在しない場合はエラーになります。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

9

実行権限のチェックエラーが発生しました。

注意事項

公開鍵認証情報定義ファイルは直接編集しないでください。

csakeyls（公開鍵認証の秘密鍵情報の表示）

形式

csakeyls [-h]
         -f <公開鍵認証情報定義ファイルのパス>

機能

公開鍵認証情報定義ファイルに登録されている秘密鍵情報を次の形式で表示します。

---（ヘッダとして「-」を可変長で表示）
公開鍵認証情報
---（フッタとして「-」を可変長で表示）

コマンドを実行する前の注意事項を次に示します。

コマンドを実行する管理者に限定して，公開鍵認証情報定義ファイルに対する更新・参照権限を設定してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-f <公開鍵認証情報定義ファイルのパス>

公開鍵認証情報定義ファイルのパスを相対パスまたは絶対パスで指定します。パスに空白を含む場合は，オプション引数全体をダブルクォーテーション（"）で囲みます。

指定したファイルが存在しない場合はエラーになります。

表示形式

(1)公開鍵認証情報定義ファイルに登録情報がある場合

　公開鍵認証情報を1行ずつ表示します。

-------------------------------------------------------------
鍵ID パスフレーズ※ 秘密鍵のファイルパス
　　：
　　：
-------------------------------------------------------------

注※

パスフレーズが設定されている場合は「****」，設定されていない場合は「△△△△」（半角空白4つ）が表示されます。

(2)公開鍵認証情報定義ファイルに登録情報がない場合（公開鍵認証情報ファイルは存在するが，登録情報がない場合）

----
none
----

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

9

実行権限のチェックエラーが発生しました。

注意事項

公開鍵認証情報定義ファイルは直接編集しないでください。

csauseradd（パスワード認証のユーザ情報の登録・更新）

形式

csauseradd [-h]
          { -userinfofile <ユーザ情報指定ファイルのパス>
          | -user <ユーザ名>
            -pass <パスワード> }
           [-r]
           -f <パスワード認証情報定義ファイルのパス>

機能

ユーザ認証のうち，パスワード認証に必要なユーザ情報（ユーザ名およびパスワード）を登録または更新します。登録できるユーザ数に上限はありません。

登録または更新したパスワード認証情報は，それを使用するサービスアダプタの開始後から有効になります。また，サービスアダプタが開始している状態でこのコマンドを実行すると，登録または更新したパスワード認証情報は，次のサービスアダプタの開始後から有効となります。

コマンドを実行する前の注意事項を次に示します。

このコマンドの-passオプションにパスワードを指定した場合，プロセスの引数を確認できるOS機能などによって，パスワードが検知されるおそれがあります。このため，-userinfofileオプションを使用した，ユーザ情報指定ファイルでのパスワードの設定を推奨します。

コマンドを実行する管理者に限定して，パスワード認証情報定義ファイルに対する更新・参照権限を設定してください。

コマンドにユーザ情報指定ファイルを指定する場合，コマンドを実行する管理者にだけ，ユーザ情報指定ファイルに対する更新・参照のアクセス権を設定してください。

パスワード認証情報定義ファイルを更新する場合は，バックアップファイルの作成をお勧めします。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-userinfofile <ユーザ情報指定ファイルのパス>

ユーザ名，パスワードが記載されているユーザ情報指定ファイルのパスを指定します。絶対パス，またはコマンド実行時のカレントディレクトリからの相対パスで指定してください。パスが空白を含む場合は，パス全体をダブルクォーテーション（"）で囲んでください。

指定されたユーザ情報指定ファイルのユーザ情報がすべて正常であれば，その内容がパスワード認証情報定義ファイルに一括で登録または更新されます。ただし，次の場合はエラーとなり，登録・更新は実施されません。

指定されたファイルが存在しない場合

ファイル内のユーザ情報に1つでも不正があった場合

ファイル内にユーザ名が重複している場合

なお，実行対象のユーザ情報指定ファイルには，ユーザ情報の登録または更新のどちらかだけを指定できます。

ユーザ情報指定ファイルの記載方法については，「6.21.1　ユーザ情報指定ファイル」を参照してください。

-user <ユーザ名>　〜＜半角英数字および半角記号＞ ((1〜80文字))

登録または更新したいユーザ名を指定します。

使用できる文字は，半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」），および半角スペース（ASCIIコードの「0x20」）です。大文字と小文字は区別されます。使用できる半角記号を次に示します。

感嘆符（!）

ダブルクォーテーション（"）

番号記号（#）

ドル記号（$）

パーセント（%）

アンパサンド（&）

アポストロフィ（'）

始め小括弧（(）

終わり小括弧（)）

アスタリスク（*）

正符号（+）

コンマ（,）

ハイフン（-）

ピリオド（.）

スラッシュ（/）

コロン（:）

セミコロン（;）

左アングルブラケット（<）

右アングルブラケット（>）

等号（=）

クエスチョンマーク（?）

単価記号（@）

始め角括弧（[）

終わり角括弧（]）

円マーク（¥）

アクサンシルコンフレックス（^）

アンダーバー（_）

アクサングラーブ（`）

始め波括弧（{）

終わり波括弧（}）

パイプライン（|）

波ダッシュ（~）

-pass <パスワード>　〜＜半角英数字および半角記号＞ ((1〜80文字))

登録または更新するユーザに対応するパスワードを指定します。

使用できる文字は，半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」），および半角スペース（ASCIIコードの「0x20」）です。大文字と小文字は区別されます。使用できる半角記号を次に示します。

感嘆符（!）

ダブルクォーテーション（"）

番号記号（#）

ドル記号（$）

パーセント（%）

アンパサンド（&）

アポストロフィ（'）

始め小括弧（(）

終わり小括弧（)）

アスタリスク（*）

正符号（+）

コンマ（,）

ハイフン（-）

ピリオド（.）

スラッシュ（/）

コロン（:）

セミコロン（;）

左アングルブラケット（<）

右アングルブラケット（>）

等号（=）

クエスチョンマーク（?）

単価記号（@）

始め角括弧（[）

終わり角括弧（]）

円マーク（¥）

アクサンシルコンフレックス（^）

アンダーバー（_）

アクサングラーブ（`）

始め波括弧（{）

終わり波括弧（}）

パイプライン（|）

波ダッシュ（~）

-r

登録済みのユーザのパスワードを変更する場合に指定します。

-f <パスワード認証情報定義ファイルのパス>

このコマンドで定義したパスワード認証情報を保存するための，パスワード認証情報定義ファイルのパスを相対パスまたは絶対パスで指定します。パスに空白を含む場合は，オプション引数全体をダブルクォーテーション（"）で囲みます。

指定したファイルが存在しない場合は次のように動作します。

パスワード認証情報の登録時

指定したファイル名で，パスワード認証情報定義ファイルが作成されます。ただし，指定したディレクトリが存在しない場合はエラーになります。

パスワード認証情報の更新時（引数-rを指定した場合）

エラーになります。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

9

実行権限のチェックエラーが発生しました。

注意事項

パスワード認証情報定義ファイルは直接編集しないでください。

csauserdel（パスワード認証のユーザ情報の削除）

形式

csauserdel [-h]
           -user <ユーザ名>
           -f <パスワード認証情報定義ファイルのパス>

機能

パスワード認証情報定義ファイルに登録されているユーザ情報を削除します。

削除したユーザの情報は，認証情報を使用するサービスアダプタの開始後に反映されます。また，サービスアダプタが開始している状態でこのコマンドを実行すると，削除したユーザの情報は，次のサービスアダプタの開始後に反映されます。

なお，パスワード認証情報定義ファイルは，ユーザ情報数が0個になっても削除されません。

コマンドを実行する前の注意事項を次に示します。

コマンドを実行する管理者に限定して，パスワード認証情報定義ファイルに対する更新・参照権限を設定してください。

パスワード認証情報定義ファイルのバックアップファイルの作成をお勧めします。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ユーザ名>　〜＜半角英数字および半角記号＞ ((1〜80文字))

削除したいユーザ名を指定します。大文字と小文字は区別されます。

-f <パスワード認証情報定義ファイルのパス>

パスワード認証情報定義ファイルのパスを相対パスまたは絶対パスで指定します。パスに空白を含む場合は，オプション引数全体をダブルクォーテーション（"）で囲みます。

指定したファイルが存在しない場合は，エラーになります。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

9

実行権限のチェックエラーが発生しました。

注意事項

パスワード認証情報定義ファイルは直接編集しないでください。

csauserls（パスワード認証のユーザ情報の表示）

形式

csauserls [-h]
          -f <パスワード認証情報定義ファイルのパス>

機能

パスワード認証情報定義ファイルに登録されているユーザの情報を次の形式で表示します。

---（ヘッダとして「-」を可変長で表示）
ユーザ名
---（フッタとして「-」を可変長で表示）

コマンドを実行する前の注意事項を次に示します。

コマンドを実行する管理者に限定して，パスワード認証情報定義ファイルに対する更新・参照権限を設定してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-f <パスワード認証情報定義ファイルのパス>

パスワード認証情報定義ファイルのパスを相対パスまたは絶対パスで指定します。パスに空白を含む場合は，指定値をダブルクォーテーション（"）で囲みます。

指定したファイルが存在しない場合はエラーになります。

表示形式

(1)パスワード認証情報定義ファイルに登録情報がある場合

-------------------------------------------------------------
ユーザ名
　　：
　　：
-------------------------------------------------------------

(2)パスワード認証情報定義ファイルに登録情報がない場合

----
none
----

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

9

実行権限のチェックエラーが発生しました。

注意事項

パスワード認証情報定義ファイルは直接編集しないでください。

cscapputil（アプリケーションの操作）

形式

cscapputil [-h]
           -user <ログインユーザID>
           -pass <ログインパスワード>
           {-mng <Manager名>
             ｜-host <IPアドレス>:<ポート番号>
               -mnguser <管理ユーザID> [-mngpass <管理ユーザパスワード>]}
           {-operation { start｜stop｜delete }
           -j2ee <J2EEサーバ名> -app <アプリケーション名>
             ｜-operation list -j2ee <J2EEサーバ名>}

機能

HCSCサーバが管理しているアプリケーションを操作します。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，目的にあわせてマニュアル「サービスプラットフォーム システム構築・運用ガイド」の次に示す個所を参照してください。

「7.5.3　HCSCサーバのセットアップおよびアンセットアップ時の回復方法」

「7.5.4　HCSCコンポーネントの配備および削除時の回復方法」

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-mng <Manager名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

Management Serverを識別するための名称（Manager名）を指定します。リポジトリ内に存在するManager名を指定してください。

-host <ホスト名またはIPアドレス>：<ポート番号>　〜＜ホスト名またはIPアドレス：文字列，ポート番号：数字＞((文字列：1文字以上，ポート番号：1−65535))

Managerリモート管理機能のホスト名（またはIPアドレス）とポート番号を「：」で連結して指定します。IPアドレス，ポート番号ともに省略できません。

リポジトリが存在しない状態でも，-hostオプションは指定できます。-hostオプションを指定する場合，-mnguserオプションおよび-mngpassオプションを指定してください。

-mnguser <管理ユーザID>　〜 ((1文字以上))

Management Serverの管理ユーザIDを指定します。

-mngpass <管理ユーザパスワード>　〜 ((1文字以上))

Management Serverの管理ユーザパスワードを指定します。パスワードがない場合は指定しません。

-operation { start｜stop｜delete }

指定したアプリケーションの操作を指定します。

start

アプリケーションを開始します。

stop

アプリケーションを停止します。

delete

アプリケーションを削除します。

list

アプリケーションを表示します。

-j2ee <J2EEサーバ名>　〜 ((1文字以上))

J2EEサーバの論理名を指定します。

-app <アプリケーション名>　〜 ((1文字以上))

アプリケーション名称を指定します。

-operationにlistを指定した場合，このオプションは省略できます。指定した場合，値は無視されます。

入力例

(1)J2EEサーバ「J2EEServer」上にあるアプリケーション「HCSCMessaging」を開始する場合

cscapputil -user admin -pass admin -host localhost:28099 -mnguser admin -j2ee J2EEServer -app HCSCMessaging -operation start

(2)J2EEサーバ「J2EEServer」上にあるアプリケーション「HCSCMessaging」を停止する場合

cscapputil -user admin -pass admin -host localhost:28099 -mnguser admin -j2ee J2EEServer -app HCSCMessaging -operation stop

(3)J2EEサーバ「J2EEServer」上にあるアプリケーション「HCSCMessaging」を削除する場合

cscapputil -user admin -pass admin -host localhost:28099 -mnguser admin -j2ee J2EEServer -app HCSCMessaging -operation delete

(4)J2EEサーバ「J2EEServer」上にあるアプリケーションを表示する場合

cscapputil -user admin -pass admin -host localhost:28099 -mnguser admin -j2ee J2EEServer -operation list

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

このコマンドでアプリケーションを削除した場合，HCSCシステムが正常に動作しなくなるおそれがあります。そのため，十分に注意して運用してください。

csccmctl（定義ファイルの管理）

形式

csccmctl [-h]
         -user <ログインユーザID>
         -pass <ログインパスワード>
         -cluster <クラスタ名>
         -name <サービスアダプタのサービスID｜受付ID>
         -targetfilename <定義ファイル名>
         [-basedir <カレントディレクトリ>]
         -operation {get｜set｜reset}

機能

開発環境で設定した定義ファイルに対して，次の機能を利用できます。

開発環境に設定された定義ファイルの取得（-operation get）

定義ファイルを運用環境に設定（-operation set）

運用環境上に設定した定義ファイルの削除（-operation reset）

開発環境と運用環境で設定する値が異なる場合にこのコマンドを使用します。このコマンドで設定した定義ファイルは，運用環境でだけ有効になります。

このコマンドで削除できるのは運用環境に設定した定義ファイルだけです。開発環境で設定した定義ファイル自体は削除できません。開発環境で設定した定義ファイルを削除したい場合は，開発環境で定義ファイルを削除してください。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，目的にあわせてマニュアル「サービスプラットフォーム システム構築・運用ガイド」の次に示す個所を参照してください。

-operationオプションにgetを指定した場合の使用方法

「3.1.9　HCSCコンポーネントの定義ファイルを運用環境に取得する」

-operationオプションにsetを指定した場合の使用方法

「3.1.10　HCSCコンポーネントの定義ファイルを運用環境に設定，更新する」

-operationオプションにresetを指定した場合の使用方法

「3.1.11　HCSCコンポーネントの定義ファイルを運用環境から削除する」

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-cluster <クラスタ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

サービス情報を変更するサービスアダプタがあるクラスタ名を指定します。リポジトリ内に存在するクラスタが1つの場合は，HCSC-Managerコマンド共通定義ファイルに指定することで，このコマンドでの指定を省略できます。

-name <サービスアダプタのサービスID>｜<受付ID>　〜 ＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

次のどちらかを指定します。

サービスアダプタの定義ファイルを設定する場合：サービスID

ユーザ定義受付の定義ファイルを設定する場合：受付ID

-targetfilename <定義ファイル名>　〜((1文字以上))

取得，設定，更新，および消去する定義ファイル名を指定します。指定できる値はファイル名だけです。

取得，設定，および更新時に，存在しないファイル名を指定した場合はエラーになります。消去時に存在しないファイル名を指定した場合は，エラーにはなりません。処理を継続します。

ディレクトリやファイルのパスの長さは，OSに依存して制限されます。-basedirオプションに指定したカレントディレクトリと連結したパスの長さが，OSで制限された長さに達しないよう設定してください。

-basedir <カレントディレクトリ>　〜 ((1文字以上))

取得，設定，および更新する定義ファイルのディレクトリパス名を相対パスまたは絶対パスで指定します。指定値はディレクトリである必要があります。存在するディレクトリを指定してください。

このオプションを指定しない場合は，コマンド実行時のパスがカレントディレクトリと見なされます。

ディレクトリやファイルのパスの長さは，OSに依存して制限されます。-targetfilenameオプションに指定した定義ファイル名と連結したパスの長さが，OSで制限された長さに達しないよう設定してください。

なお，-operation resetオプションが指定された場合，このオプションは無視されます。

-operation {get｜set｜reset}

開発環境で設定した定義ファイルを運用環境に取得，設定，および削除します。開発環境での設定とは異なる設定をする場合に使用します。

get

-targetfilenameオプションで指定した定義ファイルが，-basedirオプションで指定したディレクトリ下に配置されます。

同一のファイル名が存在する場合，ファイルが上書きされます。

set

-basedirオプションで指定したディレクトリ下にある，-targetfilenameオプションで指定したファイルが運用環境のリポジトリに設定されます。すでに同名の定義ファイルが設定されている場合は，内容が更新されます。

reset

-targetfilenameオプションで指定したファイル名が，-operation setオプションで指定した運用環境のリポジトリのファイル名と一致する場合，定義ファイルが削除されます。

入力例

サービスアダプタの定義ファイルを設定する場合

(1)定義ファイル「adptp1_config.xml」を運用環境に取得する場合

csccmctl -cluster CLS1 -name ADP1 -targetfilename adptp1_config.xml -basedir C:¥tmp -operation get

(2)運用環境の定義ファイル「adptp1_config.xml」を設定または更新する場合

csccmctl -cluster CLS1 -name ADP1 -targetfilename adptp1_config.xml -basedir C:¥tmp -operation set

(3)運用環境の定義ファイル「adptp1_config.xml」の設定を削除する場合

csccmctl -cluster CLS1 -name ADP1 -targetfilename adptp1_config.xml -operation reset

TP1/RPC受付の定義ファイルを設定する場合

(1)定義ファイル「cscurecptp1rpc.properties」を運用環境に取得する場合

csccmctl -cluster CLS1 -name RCP1 -targetfilename cscurecptp1rpc.properties -basedir C:¥tmp -operation get

(2)運用環境の定義ファイル「cscurecptp1rpc.properties」を設定または更新する場合

csccmctl -cluster CLS1 -name RCP1 -targetfilename cscurecptp1rpc.properties -basedir C:¥tmp -operation set

(3)運用環境の定義ファイル「cscurecptp1rpc.properties」の設定を削除する場合

csccmctl -cluster CLS1 -name RCP1 -targetfilename cscurecptp1rpc.properties -operation reset

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

-operation setオプションまたは-operation resetオプションは，HCSCコンポーネントの配備前に実行してください。

-operation getオプションでは，実行環境の独自定義ファイル設定機能によって実行環境に配置された独自定義ファイルは取得されません。

csccompoconfig（HCSCコンポーネントの定義）

形式

csccompoconfig [-h]
          -user <ログインユーザID>
          -pass <ログインパスワード>
         {-operation get -csc <HCSCサーバ名>
           [-outputfile <出力先パス付きファイル名>]
          ｜-operation set -propfile
           {<ユーザ定義受付ランタイム定義ファイル名>
            ｜<アプリケーション統合属性ファイル名>}
           {-csc <HCSCサーバ名>｜-cluster <クラスタ名>}}
          -name <受付ID>

機能

ユーザ定義受付の定義情報の取得および変更をします。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，目的にあわせてマニュアル「サービスプラットフォーム システム構築・運用ガイド」の次に示す個所を参照してください。

-operationオプションにsetを指定した場合の使用方法

「3.1.15　ユーザ定義受付の定義情報を設定する」

-operationオプションにgetを指定した場合の使用方法

「3.1.16　ユーザ定義受付の定義情報を確認する」

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-operation {get｜set}

このコマンドの動作を指定します。

get

指定したユーザ定義受付に設定されている定義を標準出力に出力します。

set

-propfileオプションで指定したファイルの内容を指定したユーザ定義受付に反映します。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

HCSCサーバ名を指定します。

-outputfile <出力先パス付きファイル名>　〜 ((1−200バイト))

-operation getオプションを指定したときに，定義内容を出力するファイル名とパスを指定します。相対パス，または絶対パスで指定します。

-propfile {<ユーザ定義受付ランタイム定義ファイル名>｜<アプリケーション統合属性ファイル名>}　〜 ((1−200バイト))

次に示すどちらかの受付に定義する定義一覧を記載したファイル名を指定します。相対パス，または絶対パスで指定します。-operation setオプションを指定したときに有効になります。

SOAP受付：ユーザ定義受付ランタイム定義ファイルを設定します。

カスタム受付（ファイルイベント受付以外）：アプリケーション統合属性ファイルを設定します。

ファイルイベント受付の場合は，このコマンドでアプリケーション統合属性ファイルの変更はできません。

-cluster <クラスタ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))<<-cscオプションで指定したサーバ名>>

クラスタ名を指定します。-operation setオプションを指定したときに有効になります。また，クラスタ種別がHAのときに-clusterオプションを指定するとエラーになります。

-name <受付ID>　〜 ＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

ユーザ定義受付の受付IDを指定します。

出力形式

-operation getオプションを指定した場合の出力形式を示します。

SOAP受付

user-defined-reception-soap.threads.maximum=20
user-defined-reception-soap.queue-size=1000
user-defined-reception-soap.exclusive.threads=2

カスタム受付

アプリケーション統合属性ファイル形式に従います。

-operation getオプションを指定した場合に，-outputfileオプションに出力先パス付きファイル名を指定すると，標準出力する内容が，指定したファイルに出力されます。

入力例

(1)サーバ「CSCSrv1」に配備されているSOAPユーザ定義受付ID「URECP1」の定義を取得する場合

csccompoconfig -user admin -pass admin -csc CSCSrv1 -name URECP1 -operation get

(2)サーバ「CSCSrv1」に配備されているSOAPユーザ定義受付ID「URECP1」の定義をファイルに出力する場合

csccompoconfig -user admin -pass admin -csc CSCSrv1 -name URECP1 -operation get -outputfile runtime_recp1.properties

(3)サーバ「CSCSrv1」に配備されているカスタム受付ID「CRECP1」の定義を取得する場合

csccompoconfig -user admin -pass admin -csc CSCSrv1 -name CRECP1 -operation get

(4)サーバ「CSCSrv1」に配備されているカスタム受付ID「CRECP1」の定義をファイルに出力する場合

csccompoconfig -user admin -pass admin -csc CSCSrv1 -name CRECP1 -operation get -outputfile userdef_crecp1.xml

(5)クラスタ「CLS1」に配備されているすべてのSOAPユーザ定義受付ID「URECP1」の定義を設定する場合

csccompoconfig -user admin -pass admin -cluster CLS1 -name URECP1 -operation set -propfile cscurcptnconfig.properties

(6)クラスタ「CLS1」に配備されているすべてのカスタム受付ID「CRECP1」の定義を設定する場合

csccompoconfig -user admin -pass admin -cluster CLS1 -name CRECP1 -operation set -propfile userdef_crecp1.xml

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

2

通信タイムアウトが発生しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

SOAP受付の場合，このコマンドはHCSCコンポーネントの配備後に実施してください。

カスタム受付の場合，このコマンドはHCSCコンポーネントの配備後で，かつサービス停止時に実施してください。

配備前のHCSCコンポーネントに対してこのコマンドを実行した場合はエラーとなります。

デフォルト値から変更していない値は出力されません。

HCSCコンポーネントを削除したときに，そのHCSCコンポーネントに設定した値は無効になります。

-operation setオプションは，実行環境の独自定義ファイル設定機能を使用しているHCSCコンポーネントに対しては指定できません。実行した場合の動作は保証しません。

実行環境の独自定義ファイル設定機能については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.10.3　実行環境の独自定義ファイル設定機能を使用した独自定義ファイルの定義手順」を参照してください。

csccompodeploy（HCSCコンポーネントの配備）

形式

csccompodeploy [-h]
               -user <ログインユーザID>
               -pass <ログインパスワード>
               {-csc <HCSCサーバ名>｜-cluster <クラスタ名>}
               {-name <サービスID｜受付ID>
              ｜-all [-errskip]
              ｜-namelist <HCSCコンポーネント指定ファイル名> [-errskip]}

機能

セットアップ済みのHCSCサーバに，HCSCコンポーネントを配備します。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

また，実行対象が複数のHCSCコンポーネントである場合，一部のHCSCコンポーネントでエラー（通信障害など，HCSCコンポーネント呼び出し時に発生するエラーを含む）が発生しても，そのHCSCコンポーネントの処理をスキップして処理を継続することもできます（エラースキップ機能）。エラースキップ機能は，運用環境の運用画面や開発環境の一括実行機能（「複数サービスをサーバに配備して開始」など）からは実行できません。

このコマンドの使用方法については，目的にあわせてマニュアル「サービスプラットフォーム システム構築・運用ガイド」の次に示す個所を参照してください。

「3.1.8　サービスアダプタを配備する」

「3.1.13　ビジネスプロセスを配備する」

「3.1.14　ユーザ定義受付を配備する」

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

HCSCコンポーネントを配備するHCSCサーバ名を指定します。

-cluster <クラスタ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

HCSCコンポーネントを一括配備するクラスタ名を指定します。なお，クラスタ種別がHAのときに-clusterを指定するとエラーになります。

-name <サービスID｜受付ID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

配備するHCSCコンポーネントのサービスIDまたは受付IDを指定します。

-all

未配備のHCSCコンポーネントをすべて配備します。-cscと同時に指定した場合は，そのHCSCサーバ内で未配備のHCSCコンポーネントをすべて配備します。-clusterと同時に指定した場合は，そのクラスタ内で未配備のHCSCコンポーネントをすべて配備します。

このオプションを指定した場合のHCSCコンポーネントの配備順は次のとおりです。-errskipと同時に指定していない場合，処理中にエラーが発生すると，すべてのHCSCコンポーネントが配備されていなくても配備処理は終了します。

配備順

HCSCコンポーネントの種類

HCSCコンポーネント内の配備順

1

サービスアダプタ

サービスIDの昇順

2

ビジネスプロセス

ビジネスプロセス名の昇順

3

ユーザ定義受付

次の優先順位に従って実行されます。

ユーザ定義受付（呼出先選択）の受付IDの昇順

ビジネスプロセス名の昇順，およびユーザ定義受付（呼出先固定）の受付IDの昇順

-errskip

指定されたHCSCコンポーネントの一部で配備に失敗しても，処理を継続します（エラースキップ機能）。このオプションは，-allまたは-namelistと同時に指定してください。

エラースキップ機能を使用していて，HCSCコンポーネントでエラーが発生した場合，HCSC-Managerのログおよびコンソールへのメッセージ出力の流れは次のようになります。

一部のHCSCコンポーネントでエラーが発生すると，該当するエラーメッセージを出力して，処理を継続します。

すべてのHCSCコンポーネントの処理終了後，エラーとなったHCSCコンポーネントの件数を通知する警告メッセージを出力します。

なお，このオプションをHCSC-Managerコマンド共通定義ファイル（csccmd.properties）に定義すれば，常にエラースキップ機能が有効になり，このコマンドでの指定を省略できます。HCSC-Managerコマンド共通定義ファイルの定義方法については，「6.5.2　HCSC-Managerコマンド共通定義ファイル」を参照してください。

-namelist <HCSCコンポーネント指定ファイル名>　〜((1−200バイト))

配備するHCSCコンポーネントをHCSCコンポーネント指定ファイルで指定します。絶対パスまたは相対パスで指定します。ファイルが存在しない場合は異常終了します。HCSCコンポーネント指定ファイルについては，「6.5.5　HCSCコンポーネント指定ファイル」を参照してください。

なお，指定されたHCSCコンポーネントの配備順およびエラー発生時の処理は，-allオプションと同じです。

入力例

(1)単一のHCSCサーバにすべてのサービスアダプタを配備する場合

csccompodeploy -user <ログインユーザID> -pass <ログインパスワード> -csc <HCSCサーバ名> -all

(2)指定したサービスアダプタを単一のHCSCサーバに配備する場合

csccompodeploy -user <ログインユーザID> -pass <ログインパスワード> -csc <HCSCサーバ名> -name <サービスアダプタのサービスID>

(3)HCSCサーバ「CSCSrv1」下にあるすべてのHCSCコンポーネントを配備し，一部のHCSCコンポーネントの配備に失敗しても処理を継続する場合

csccompodeploy -csc CSCSrv1 -all -errskip

(4)HCSCサーバ「CSCSrv1」下にあるHCSCコンポーネントのうち，HCSCコンポーネント指定ファイル「hcsccomponent.txt」に指定されているHCSCコンポーネントを配備し，一部のHCSCコンポーネントの配備に失敗しても処理を継続する場合

csccompodeploy -csc CSCSrv1 -namelist hcsccomponent.txt -errskip

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

2

通信タイムアウトが発生しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

-errskipを指定する場合は，HCSCコンポーネントの処理でエラーが発生しても処理を継続するため，戻り値は「0」となります。ただし，オプションの組み合わせ不正など，HCSCコンポーネント呼び出し時以外でエラーが発生した場合，戻り値は「0」以外となるときがあります。

注意事項

このコマンドを複数のクライアントから1つのHCSCサーバに対して同時に実行すると，処理エラー（排他エラー，またはコンポーネントへの操作重複による異常終了）となるおそれがあります。エラーが発生した場合は，次のどちらかの方法でコマンドを再実行してください。

-allオプションを指定してHCSCコンポーネントを再配備する

-nameオプションを指定して個別にHCSCコンポーネントを配備する

csccompostart（HCSCコンポーネントの開始）

形式

csccompostart [-h]
              -user <ログインユーザID>
              -pass <ログインパスワード>
              {-csc <HCSCサーバ名>｜-cluster <クラスタ名>}
              {-name <サービスID｜受付ID>
              ｜-all [-errskip]
              ｜-namelist <HCSCコンポーネント指定ファイル名> [-errskip]}
              [-nogc]

機能

HCSCコンポーネントを開始します。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

また，実行対象が複数のHCSCコンポーネントである場合，一部のHCSCコンポーネントでエラー（通信障害など，HCSCコンポーネント呼び出し時に発生するエラーを含む）が発生しても，そのHCSCコンポーネントの処理をスキップして処理を継続することもできます（エラースキップ機能）。エラースキップ機能は，運用環境の運用画面や開発環境の一括実行機能（「複数サービスをサーバに配備して開始」など）からは実行できません。

このコマンドの使用方法については，目的にあわせてマニュアル「サービスプラットフォーム システム構築・運用ガイド」の次に示す個所を参照してください。

「5.3.7　サービスアダプタを開始する」

「5.3.8　ビジネスプロセスを開始する」

「5.3.9　ユーザ定義受付を開始する」

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

開始するHCSCコンポーネントのHCSCサーバ名を指定します。

-cluster <クラスタ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

HCSCコンポーネントを一括開始するクラスタ名を指定します。クラスタ種別がHAのときに-clusterを指定するとエラーになります。

-name <サービスID｜受付ID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

開始するHCSCコンポーネントのサービスIDまたは受付IDを指定します。-clusterと同時に指定した場合は，クラスタ内の同じサービスIDのHCSCコンポーネントをすべて開始します。

-all

指定範囲内で停止中のHCSCコンポーネントをすべて開始します。-cscと同時に指定した場合は，指定したHCSCサーバ内で停止中のすべてのHCSCコンポーネントを開始します。-clusterと同時に指定した場合は，指定したクラスタ内で停止中のすべてのHCSCコンポーネントを開始します。

このオプションを指定した場合のHCSCコンポーネントの開始順は次のとおりです。-errskipと同時に指定していない場合，処理中にエラーが発生すると，すべてのHCSCコンポーネントが開始されていなくても開始処理は終了します。

開始順

HCSCコンポーネントの種類

HCSCコンポーネント内の開始順

1

サービスアダプタ

サービスIDの昇順

2

ビジネスプロセス

ビジネスプロセス名の昇順

3

ユーザ定義受付

次の優先順位に従って実行されます。

ユーザ定義受付（呼出先選択）の受付IDの昇順

ビジネスプロセス名の昇順，およびユーザ定義受付（呼出先固定）の受付IDの昇順

-errskip

指定されたHCSCコンポーネントの一部で開始に失敗しても，処理を継続します（エラースキップ機能）。このオプションは，-allまたは-namelistと同時に指定してください。

エラースキップ機能を使用していて，HCSCコンポーネントでエラーが発生した場合，HCSC-Managerのログおよびコンソールへのメッセージ出力の流れは次のようになります。

一部のHCSCコンポーネントでエラーが発生すると，該当するエラーメッセージを出力して，処理を継続します。

すべてのHCSCコンポーネントの処理終了後，エラーとなったHCSCコンポーネントの件数を通知する警告メッセージを出力します。

なお，このオプションをHCSC-Managerコマンド共通定義ファイル（csccmd.properties）に定義すれば，常にエラースキップ機能が有効になり，このコマンドでの指定を省略できます。HCSC-Managerコマンド共通定義ファイルの定義方法については，「6.5.2　HCSC-Managerコマンド共通定義ファイル」を参照してください。

-namelist <HCSCコンポーネント指定ファイル名>　〜((1−200バイト))

開始するHCSCコンポーネントをHCSCコンポーネント指定ファイルで指定します。絶対パスまたは相対パスで指定します。ファイルが存在しない場合は異常終了します。HCSCコンポーネント指定ファイルについては，「6.5.5　HCSCコンポーネント指定ファイル」を参照してください。

なお，指定されたHCSCコンポーネントの開始順およびエラー発生時の処理は，-allオプションと同じです。

-nogc

FullGCを発生させないでコンポーネントを開始します。ただし，このオプションを指定しても，JavaVMが自動的に発生させるFullGCや，J2EEサーバの異常処理で発行されるFullGCは抑止されません。

HCSCコンポーネント開始時に明示的にFullGCを発生させる場合は，javagcコマンドを実行してください。javagcコマンドについては，マニュアル「アプリケーションサーバ リファレンス コマンド編」の「javagc（GCの強制発生）」を参照してください。

入力例

(1)HCSCサーバ「HCSC」下にある「BP1」を開始する場合

csccompostart -user admin -pass admin -csc HCSC -name BP1

(2)HCSCサーバ「HCSC」下にあるすべてのHCSCコンポーネントを一括開始する場合

csccompostart -user admin -pass admin -csc HCSC -all

(3)クラスタ「Cluster」下にあるHCSCサーバごとに「BP1」を一括開始する場合

csccompostart -user admin -pass admin -cluster Cluster -name BP1

(4)クラスタ「Cluster」下にあるすべてのHCSCコンポーネントを一括開始する場合

csccompostart -user admin -pass admin -cluster Cluster -all

(5)FullGCを発生させないで，HCSCサーバ「CSCSrv1」下にある「BP1」を一括開始する場合

csccompostart -user admin -pass admin -csc CSCSrv1 -name BP1 -nogc

(6)HCSCサーバ「CSCSrv1」下にあるHCSCコンポーネントのうち，HCSCコンポーネント指定ファイル「hcsccomponent.txt」に指定されているHCSCコンポーネントを一括開始する場合

csccompostart -user admin -pass admin -csc CSCSrv1 -namelist hcsccomponent.txt

(7)HCSCサーバ「CSCSrv1」下にあるすべてのHCSCコンポーネントを開始し，一部のHCSCコンポーネントの開始に失敗しても処理を継続する場合

csccompostart -csc CSCSrv1 -all -errskip

(8)HCSCサーバ「CSCSrv1」下にあるHCSCコンポーネントのうち，HCSCコンポーネント指定ファイル「hcsccomponent.txt」に指定されているHCSCコンポーネントを開始し，一部のHCSCコンポーネントの開始に失敗しても処理を継続する場合

csccompostart -csc CSCSrv1 -namelist hcsccomponent.txt -errskip

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

2

通信タイムアウトが発生しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

-errskipを指定する場合は，HCSCコンポーネントの処理でエラーが発生しても処理を継続するため，戻り値は「0」となります。ただし，オプションの組み合わせ不正など，HCSCコンポーネント呼び出し時以外でエラーが発生した場合，戻り値は「0」以外となるときがあります。

注意事項

このコマンドは停止状態のHCSCコンポーネントに対して実行してください。複数のHCSCコンポーネントが指定された場合，起動状態ではないHCSCコンポーネントが処理対象となります。起動状態のHCSCコンポーネントが指定された場合は処理をスキップします。

コマンド実行時にHCSCサーバは起動している必要があります。

-clusterや-allを指定してエラーになった場合，結果をcscstatusコマンドで確認し，障害要因を取り除いたあとに，再度コマンドを実行してください。

このコマンドを複数のクライアントから1つのHCSCサーバに対して同時に実行すると，処理エラー（排他エラー，またはコンポーネントへの操作重複による異常終了）となるおそれがあります。エラーが発生した場合は，次のどちらかの方法でコマンドを再実行してください。

-allオプションを指定してHCSCコンポーネントを起動する

-nameオプションを指定して個別にHCSCコンポーネントを起動する

csccompostop（HCSCコンポーネントの停止）

形式

csccompostop [-h]
             -user <ログインユーザID>
             -pass <ログインパスワード>
             {-csc <HCSCサーバ名>｜-cluster <クラスタ名>}
             {-name <サービスID｜受付ID>｜-all
            ｜-namelist <HCSCコンポーネント指定ファイル名>}
             [-nogc]

機能

HCSCコンポーネントを停止します。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，目的にあわせてマニュアル「サービスプラットフォーム システム構築・運用ガイド」の次に示す個所を参照してください。

「5.3.36　ユーザ定義受付を停止する」

「5.3.37　サービスアダプタを停止する」

「5.3.38　ビジネスプロセスを停止する」

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

停止するHCSCコンポーネントのHCSCサーバ名を指定します。

-cluster <クラスタ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

HCSCコンポーネントを一括停止するクラスタ名を指定します。クラスタ種別がHAのときに-clusterを指定するとエラーになります。

-name <サービスID｜受付ID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

停止するHCSCコンポーネントのサービスIDまたは受付IDを指定します。-clusterと同時に指定した場合は，クラスタ内の同じサービスIDのHCSCコンポーネントをすべて停止します。

-all

指定範囲内で開始中のHCSCコンポーネントをすべて停止します。-cscと同時に指定した場合は，そのHCSCサーバ内で開始中のすべてのHCSCコンポーネントを停止します。-clusterと同時に指定した場合は，そのクラスタ内で開始中のすべてのHCSCコンポーネントを停止します。

このオプションを指定した場合のHCSCコンポーネントの停止順は次のとおりです。処理中にエラーが発生した場合は，すべてのHCSCコンポーネントが停止されていなくても停止処理は終了します。

停止順

HCSCコンポーネントの種類

HCSCコンポーネント内の停止順

1

ユーザ定義受付

次の優先順位に従って実行されます。

ユーザ定義受付（呼出先選択）の受付IDの昇順

ビジネスプロセス名の昇順，およびユーザ定義受付（呼出先固定）の受付IDの昇順

2

ビジネスプロセス

ビジネスプロセス名の昇順

3

サービスアダプタ

サービスIDの昇順

-namelist <HCSCコンポーネント指定ファイル名>　〜((1−200バイト))

停止するHCSCコンポーネントをHCSCコンポーネント指定ファイルで指定します。絶対パスまたは相対パスで指定します。ファイルが存在しない場合は異常終了します。HCSCコンポーネント指定ファイルについては，「6.5.5　HCSCコンポーネント指定ファイル」を参照してください。

なお，指定されたHCSCコンポーネントの停止順は，-allオプションと同じです。

-nogc

FullGCを発生させないでコンポーネントを停止します。ただし，このオプションを指定しても，JavaVMが自動的に発生させるFullGCは抑止されません。

入力例

(1)HCSCサーバ「HCSC」下にある「BP1」を停止する場合

csccompostop -user admin -pass admin -csc HCSC -name BP1

(2)HCSCサーバ「HCSC」下にあるすべてのHCSCコンポーネントを一括停止する場合

csccompostop -user admin -pass admin -csc HCSC -all

(3)クラスタ「Cluster」下にあるHCSCサーバごとに「BP1」を一括停止する場合

csccompostop -user admin -pass admin -cluster Cluster -name BP1

(4)クラスタ「Cluster」下にあるすべてのHCSCコンポーネントを一括停止する場合

csccompostop -user admin -pass admin -cluster Cluster -all

(5)FullGCを発生させないで，HCSCサーバ「CSCSrv1」下にある「BP1」を一括停止する場合

csccompostop -user admin -pass admin -csc CSCSrv1 -name BP1 -nogc

(6)HCSCサーバ「CSCSrv1」下にあるHCSCコンポーネントのうち，HCSCコンポーネント指定ファイル「hcsccomponent.txt」に指定されているHCSCコンポーネントを一括停止する場合

csccompostop -user admin -pass admin -csc CSCSrv1 -namelist hcsccomponent.txt

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

2

通信タイムアウトが発生しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

このコマンドは開始状態のHCSCコンポーネントに対して実行してください。複数のHCSCコンポーネントが指定された場合，停止状態ではないHCSCコンポーネントが処理対象となります。停止状態のHCSCコンポーネントが指定された場合は処理をスキップします。

コマンド実行時にHCSCサーバは起動している必要があります。

-clusterや-allを指定してエラーになった場合，結果をcscstatusコマンドで確認し，障害要因を取り除いたあとに，再度コマンドを実行してください。

このコマンドを複数のクライアントから1つのHCSCサーバに対して同時に実行すると，処理エラー（排他エラー，またはコンポーネントへの操作重複による異常終了）となるおそれがあります。エラーが発生した場合は，次のどちらかの方法でコマンドを再実行してください。

-allオプションを指定してHCSCコンポーネントを停止する

-nameオプションを指定して個別にHCSCコンポーネントを停止する

csccompoundeploy（配備済みのHCSCコンポーネントの削除）

形式

csccompoundeploy [-h]
                 -user <ログインユーザID>
                 -pass <ログインパスワード>
                 {-csc <HCSCサーバ名>｜-cluster <クラスタ名>}
                 {-name <サービスID｜受付ID>｜-all
                ｜-namelist <HCSCコンポーネント指定ファイル名>}
                 [-force]
                 [-ignore]
                 [-nogc]

機能

実行環境に配備したHCSCコンポーネントを削除します。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，目的にあわせてマニュアル「サービスプラットフォーム システム構築・運用ガイド」の次に示す個所を参照してください。

「3.3.1　サービスアダプタを削除する」

「3.3.2　ビジネスプロセスを削除する」

「3.3.3　ユーザ定義受付を削除する」

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

実行環境から削除するHCSCコンポーネントが属しているHCSCサーバ名を指定します。

-cluster <クラスタ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

HCSCコンポーネントを一括削除するクラスタ名を指定します。なお，クラスタ種別がHAのときに-clusterを指定するとエラーになります。

-name <サービスID｜受付ID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

実行環境から削除するHCSCコンポーネントのサービスIDまたは受付IDを指定します。

-all

配備したHCSCコンポーネントをすべて削除します。-cscと同時に指定した場合は，そのHCSCサーバ内に配備されたHCSCコンポーネントをすべて削除します。-clusterと同時に指定した場合は，そのクラスタ内に配備されたHCSCコンポーネントをすべて削除します。

このオプションを指定した場合のHCSCコンポーネントの削除順は次のとおりです。処理中にエラーが発生した場合は，すべてのHCSCコンポーネントが削除されていなくても削除処理は終了します。

削除順

HCSCコンポーネントの種類

HCSCコンポーネント内の削除順

1

ユーザ定義受付

次の優先順位に従って実行されます。

ユーザ定義受付（呼出先選択）の受付IDの昇順

ビジネスプロセス名の昇順，およびユーザ定義受付（呼出先固定）の受付IDの昇順

2

ビジネスプロセス

ビジネスプロセス名の昇順

3

サービスアダプタ

サービスIDの昇順

-namelist <HCSCコンポーネント指定ファイル名>　〜((1−200バイト))

削除するHCSCコンポーネントをHCSCコンポーネント指定ファイルで指定します。絶対パスまたは相対パスで指定します。ファイルが存在しない場合は異常終了します。HCSCコンポーネント指定ファイルについては，「6.5.5　HCSCコンポーネント指定ファイル」を参照してください。

なお，指定されたHCSCコンポーネントの削除順は，-allオプションと同じです。

-force

配備したサービスアダプタを強制削除します。このオプションは，サービスアダプタに対して有効です。ビジネスプロセスおよびユーザ定義受付に対してこのオプションを指定しても，削除されません。なお，削除するサービスアダプタが非同期（MDB（WS-R））の場合，転送キューにメッセージが残っていてもサービスアダプタを削除します。

-ignore

実行環境へ配備したHCSCコンポーネントの削除に失敗した場合にも，リポジトリの情報を更新する場合に指定します。ハードディスク障害やアンセットアップ時の通信障害による実行環境とリポジトリ環境の不整合を調整するために使用します。

-nogc

FullGCを発生させないでコンポーネントを削除します。ただし，このオプションを指定しても，JavaVMが自動的に発生させるFullGCは抑止されません。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

2

通信タイムアウトが発生しました。

3

排他エラーが発生しました。

4

仕掛かっている電文があるため，サービスアダプタの削除に失敗しました。

9

実行権限のチェックエラーが発生しました。

注意事項

このコマンドを複数のクライアントから1つのHCSCサーバに対して同時に実行すると，処理エラー（排他エラー，またはコンポーネントへの操作重複による異常終了）となるおそれがあります。エラーが発生した場合は，次のどちらかの方法でコマンドを再実行してください。

-allオプションを指定してHCSCコンポーネントを削除する

-nameオプションを指定して個別にHCSCコンポーネントを削除する

cscenvbackup（HCSC-Manager環境のバックアップ）

形式

cscenvbackup [-h]
             -user <ログインユーザID>
             -pass <ログインパスワード>
             [-backupdir <バックアップファイル出力先ディレクトリ>]

機能

HCSC-Manager環境で発生した障害の復旧やスケールアップなどの環境移行をするために，HCSC-Manager環境の復元に必要なファイルをバックアップします。バックアップファイル名は，次の形式で付与されます。

IPv4の場合：cscmngBKaaabbbcccddd_YYYYMMDDhhmmss.zip

IPv6の場合：cscmngBKaaaabbbbccccddddeeeeffffgggghhhh_YYYYMMDDhhmmss.zip

cscmngBK：

HCSC-Manager環境のバックアップファイルであることを示します。

aaabbbcccddd：

コマンドを実行したマシンのIPv4アドレスを示します。ただし，IPアドレスの取得に失敗した場合は，ファイル名に含まれません。

aaaabbbbccccddddeeeeffffgggghhhh：

コマンドを実行したマシンのIPv6アドレスを示します。ただし，IPアドレスの取得に失敗した場合は，ファイル名に含まれません。

YYYYMMDDhhmmss：

バックアップした時間を示します。

YYYY：西暦年，MM：月，DD：日，hh：時，mm：分，ss：秒

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「7.9.3　運用環境のバックアップと復旧」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-backupdir <バックアップファイル出力先ディレクトリ>　((1−100バイト))

HCSC-Manager環境のバックアップファイルの出力先ディレクトリを指定します。このオプションを省略した場合，HCSC-Manager定義ファイルに指定した出力先が仮定されます。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

cscrepdiffコマンドで現在のシステム構成情報との比較はできません。

cscenvrestore（HCSC-Manager環境のリストア）

形式

cscenvrestore [-h]
              -user <ログインユーザID>
              -pass <ログインパスワード>
              -restorefile <HCSC-Manager動作環境のバックアップファイル名>

機能

次に示すHCSC-Manager環境のバックアップファイルを利用して環境を復元します。

リポジトリインポート成功時に自動的に取得したバックアップファイル

cscenvbackupコマンドで取得したバックアップファイル

これら以外のファイルから環境を復元することはできません。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「7.9.3　運用環境のバックアップと復旧」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-restorefile <HCSC-Manager動作環境のバックアップファイル名>　〜((1−200バイト))

復元するHCSC-Manager動作環境のバックアップファイル名を絶対パスまたは相対パスで指定します。デフォルトはリポジトリインポート成功時に自動取得したバックアップファイルです。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

HCSCサーバ環境に合ったHCSC-Manager環境のバックアップファイルで復元してください。

cscenvupdate（実行環境のバージョンアップ）

形式

cscenvupdate [-h]
             -csc <HCSCサーバ名>
             [-force]

機能

指定したHCSCサーバに対して，実行環境のアップデートやデータベースの更新を実行します。運用環境のリポジトリのバージョンが古い場合は，リポジトリのアップデートも同時に実行されます。

HCSCサーバ名は，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，目的にあわせてマニュアル「サービスプラットフォーム システム構築・運用ガイド」の次に示す個所を参照してください。

開発環境でリポジトリのバージョンアップをする場合

「付録G　旧バージョンからの移行」

運用環境でリポジトリのバージョンアップをする場合

「付録H　運用環境でリポジトリを旧バージョンから移行する方法」

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

バージョンアップするHCSCサーバ名を指定します。

-force

cscenvupdateコマンドを実行中ではないが，エラーとなる場合に，仕掛かり中のバージョンアップを実行します。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

データベースがHiRDBの場合にローリングアップデートをすると，エラーが発生することがあります。詳細は，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「付録G.4　ローリングアップデートの場合の移行手順」を参照してください。

コマンドがエラーになった場合は，エラーを取り除いてコマンドを再実行してください。

リポジトリのアップデート処理中にファイル入出力エラーが発生した際，コマンドの再実行時にメッセージKEOS50133-Eが出力される場合があります。この場合は，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「7.6.2　ファイルの入出力に失敗した場合の回復方法」を参照して，手動で環境を復旧してください。

運用環境のリポジトリのバージョンが古い場合は，次に示すディレクトリのあるドライブに対し，リポジトリのディスク使用量の3倍以上の空き容量があることを確認してください。

サービスプラットフォームのインストールディレクトリ

CSCMNG_HOME環境変数に設定したディレクトリ

cscfscls（共通フォルダの参照）

形式

cscfscls [-h]
         -user <ログインユーザID>
         -pass <ログインパスワード>
         {-csc <HCSCサーバ名>｜-cluster <クラスタ名>}
         {-folder <共通フォルダ定義名>｜-all}
         [-t <開始日時>｜-d <日数>]
         [-recursive]

機能

共通フォルダ内のファイルを参照します。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

共通フォルダ以下に，ユーザが作成したファイルおよびディレクトリが存在する場合は，ディレクトリ内のファイルおよびディレクトリを再帰的に参照することができます。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.4.21　共通フォルダの情報を参照する」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。大文字と小文字は区別されます。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。大文字と小文字は区別されます。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

HCSCサーバ名を指定します。大文字と小文字は区別されます。

-cluster <クラスタ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

クラスタ名を指定します。大文字と小文字は区別されます。

-folder <共通フォルダ定義名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−64文字))

共通フォルダ定義名を指定します。大文字と小文字は区別されます。

-all

すべての共通フォルダを対象とします。

-t <開始日時>

指定した日時以前の共通フォルダ内のファイルを参照します。-recursiveオプションが指定され，かつ共通フォルダ内のサブフォルダにファイルが存在しない場合は，指定した日時以前のサブフォルダを参照します。なお，指定できる日時の形式は次の形式です。また，存在する日時を省略しないで14桁で指定してください。

YYYYMMDDhhmmss

YYYY：西暦年（1970≦YYYY）

MM：月（01≦MM≦12）

DD：日（01≦DD≦31）

hh：時（00≦hh≦23）

mm：分（00≦mm≦59）

ss：秒（00≦ss≦59）

-d <日数>　〜＜整数＞ ((0−365))

指定した日数より以前の共通フォルダ内のファイルを参照します。-recursiveオプションが指定され，かつ共通フォルダ内のサブフォルダにファイルが存在しない場合は，指定した日数より以前のサブフォルダを参照します。日数を日単位で指定してください。0を指定した場合，すべての共通フォルダ内のファイルを参照します。

-recursive

サブフォルダ内のファイルを再帰的に参照します。サブフォルダ内のファイルはFileNameに共通フォルダルートからの相対パスで表示します。サブフォルダ内にファイルが存在しない場合は，FileNameにフォルダ名＋”/”を表示します。

出力形式

サブフォルダ内のファイルを再帰的に参照しない場合

HCSCServerName CommonFolderName FileSize LastModifiedTime FileName
<HCSCサーバ名> <共通フォルダ定義名> <ファイルサイズ> <ファイルの最終更新時刻> <ファイル名>
　　:
<HCSCサーバ名> <共通フォルダ定義名> <ファイルサイズ> <ファイルの最終更新時刻> <ファイル名>

サブフォルダ内のファイルを再帰的に参照する場合

HCSCServerName CommonFolderName FileSize LastModifiedTime FileName
<HCSCサーバ名> <共通フォルダ定義名> <ファイルサイズ> <ファイルまたはフォルダの最終更新時刻> <ファイル名またはフォルダ名>
　　:
<HCSCサーバ名> <共通フォルダ定義名> <ファイルサイズ> <ファイルまたはフォルダの最終更新時刻> <ファイル名またはフォルダ名>

説明

表示項目

説明

HCSCServerName

HCSCサーバ名を示します。

CommonFolderName

共通フォルダ定義名を示します。

FileSize

ファイルサイズ（バイト）を示します。フォルダを表示する場合は，0バイトを表示します。

LastModifiedTime

ファイルまたはフォルダの最終更新時刻（YYYY/MM/DD hh:mm:ss）を示します。

FileName

ファイル名またはフォルダ名を示します。ファイル名が200バイトを超える場合は，先頭から200バイトまでを表示します。

出力例を次に示します。

サブフォルダ内のファイルを再帰的に参照しない場合

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

サブフォルダ内のファイルを再帰的に参照する場合

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/

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

2

通信タイムアウトが発生しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

cscfscrm（共通フォルダの削除）

形式

cscfscrm [-h]
         -user <ログインユーザID>
         -pass <ログインパスワード>
         {-csc <HCSCサーバ名>｜-cluster <クラスタ名>}
         {-folder <共通フォルダ定義名>
         [-targetfilename <ファイル名またはフォルダ名>｜-t <削除開始日時>｜-d <日数>]
         |-all [-t <削除開始日時>｜-d <日数>]}
         [-retrycount <リトライ回数>]
         [-retryinterval <リトライ間隔(秒)>]
         [-recursive]

機能

共通フォルダ内のファイルおよびサブフォルダ配下のファイルを削除します。共通フォルダ，および共通フォルダ以下のフォルダは削除されません。共通フォルダ内にサブフォルダが存在する場合，サブフォルダ内のファイルを再帰的に削除することができます。

リトライ回数およびリトライ間隔はロックの取得時に使用します。複数のファイルを指定した場合，それぞれのファイルに対して有効になります。

複数のファイルを削除する場合，エラーが発生したあと，処理を中断します。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.4.22　共通フォルダ内のファイルを削除する」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。大文字と小文字は区別されます。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。大文字と小文字は区別されます。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

HCSCサーバ名を指定します。大文字と小文字は区別されます。

-cluster <クラスタ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

クラスタ名を指定します。大文字と小文字は区別されます。

-folder <共通フォルダ定義名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−64文字))

共通フォルダ定義名を指定します。大文字と小文字は区別されます。

-targetfilename <ファイル名またはフォルダ名>　〜((1−200バイト))

削除したいファイル名またはサブフォルダ名を指定します。サブフォルダを指定した場合は，サブフォルダ直下のファイルを削除します。サブフォルダ配下のファイルを再帰的に削除する場合は，-recursiveオプションを付与する必要があります。サブフォルダ内のファイルやフォルダを指定する場合は，共通フォルダルートからの相対パスで指定してください。

共通フォルダ内にあるファイルを指定してください。共通フォルダ内のファイルを参照するには，cscfsclsコマンドを実行してください。

-t <削除開始日時>

指定した日時以前の共通フォルダ内のファイルを削除します。-recursiveオプションが指定されている場合は，指定した日時以前のサブフォルダ内のファイルも削除します。なお，指定できる日時の形式は次の形式です。また，存在する日時を省略しないで14桁で指定してください。

YYYYMMDDhhmmss

YYYY：西暦年（1970≦YYYY）

MM：月（01≦MM≦12）

DD：日（01≦DD≦31）

hh：時（00≦hh≦23）

mm：分（00≦mm≦59）

ss：秒（00≦ss≦59）

-d <日数>　〜＜整数＞ ((0−365))

指定した日数より以前の共通フォルダ内のファイルを削除します。-recursiveオプションが指定されている場合は，指定した日時以前のサブフォルダ内のファイルも削除します。日数を日単位で指定してください。0を指定した場合，すべての共通フォルダ内のファイルを削除します。

-all

すべての共通フォルダを対象とします。

-retrycount <リトライ回数>　〜＜整数＞ ((0−10000))

リトライ回数を指定します。デフォルトは0です。

0を指定した場合，リトライをしません。

-retryinterval <リトライ間隔(秒)>　〜＜整数＞ ((0−86400))

リトライ間隔を秒で指定します。デフォルトは1です。

0を指定した場合，間隔を空けずにリトライを実施します。

-recursive

サブフォルダ内のファイルを再帰的に削除します。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

2

通信タイムアウトが発生しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

共通フォルダ内のファイルは自動では削除されません。ファイルの保持期限をあらかじめ決定して，定期的に削除することをお勧めします。

コマンドを実行する前に，共通フォルダ以下に必要なファイルがないか確認してください。

削除対象のファイルはすべてのビジネスプロセスからアクセスされていないことを確認してください。

ビジネスプロセスの実行中にこのコマンドを実行する場合，他プロセスとの競合によってファイルロックが取得できない可能性を考慮する必要があります。このコマンドおよび共通フォルダにアクセスする各機能で，適切なロックリトライ回数およびロックリトライ間隔を設定してください。

cscfswls（作業フォルダの参照）

形式

cscfswls [-h]
         -user <ログインユーザID>
         -pass <ログインパスワード>
         {-csc <HCSCサーバ名>｜-cluster <クラスタ名>}
         {-name <受付ID>｜-all}
         [-t <開始日時>｜-d <日数>]

機能

受付単位で作業フォルダを参照します。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

作業フォルダ以下に，ユーザがファイルおよびディレクトリを作成した場合，ディレクトリだけが表示されます。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.4.19　作業フォルダを参照する」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。大文字と小文字は区別されます。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。大文字と小文字は区別されます。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

HCSCサーバ名を指定します。大文字と小文字は区別されます。

-cluster <クラスタ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

クラスタ名を指定します。大文字と小文字は区別されます。

-name <受付ID>　〜 ＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

受付IDを指定します。大文字と小文字は区別されます。

-all

すべての作業フォルダを対象とします。

-t <開始日時>

指定した日時以前の作業フォルダを参照します。なお，指定できる日時の形式は次の形式です。また，存在する日時を省略しないで14桁で指定してください。

YYYYMMDDhhmmss

YYYY：西暦年（1970≦YYYY）

MM：月（01≦MM≦12）

DD：日（01≦DD≦31）

hh：時（00≦hh≦23）

mm：分（00≦mm≦59）

ss：秒（00≦ss≦59）

-d <日数>　〜＜整数＞ ((0−365))

指定した日数より以前の作業フォルダを参照します。日数を日単位で指定してください。0を指定した場合，すべての作業フォルダを参照します。

出力形式

HCSCServerName ReceptionID FolderSize LastModifiedTime FolderName
<HCSCサーバ名> <受付ID> <フォルダ内のファイルサイズ合計> <フォルダの最終更新時刻> <フォルダ名>
　　:
<HCSCサーバ名> <受付ID> <フォルダ内のファイルサイズ合計> <フォルダの最終更新時刻> <フォルダ名>

説明

表示項目

説明

HCSCServerName

HCSCサーバ名を示します。

ReceptionID

受付IDを示します。

FolderSize

フォルダ内のファイルサイズの合計のバイト数を示します。フォルダ自身のサイズは含まれません。

LastModifiedTime

フォルダの最終更新時刻（YYYY/MM/DD hh:mm:ss）を示します。

フォルダ内にファイルが存在する場合は，存在するファイルの中で最終更新時刻が最も新しいファイルの最終更新時刻を出力します。

FolderName

フォルダ名を示します。

出力例を次に示します。

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

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

2

通信タイムアウトが発生しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

cscfswrm（作業フォルダの削除）

形式

cscfswrm [-h]
         -user <ログインユーザID>
         -pass <ログインパスワード>
         {-csc <HCSCサーバ名>｜-cluster <クラスタ名>}
         {-name <受付ID>｜-all }
         [ -t <削除開始日時>｜-d <日数>]

機能

受付単位で作業フォルダを削除します。

複数のファイルを削除する場合，エラーが発生したあとの処理は終了します。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.4.20　作業フォルダを削除する」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。大文字と小文字は区別されます。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。大文字と小文字は区別されます。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

HCSCサーバ名を指定します。大文字と小文字は区別されます。

-cluster <クラスタ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

クラスタ名を指定します。大文字と小文字は区別されます。

-name <受付ID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

受付IDを指定します。大文字と小文字は区別されます。

-all

すべての作業フォルダを対象とします。

-t <削除開始日時>

指定した日時以前の作業フォルダを削除します（作業フォルダ内のファイルやフォルダも削除します）。なお，指定できる日時の形式は次の形式です。また，存在する日時を省略しないで14桁で指定してください。

YYYYMMDDhhmmss

YYYY：西暦年（1970≦YYYY）

MM：月（01≦MM≦12）

DD：日（01≦DD≦31）

hh：時（00≦hh≦23）

mm：分（00≦mm≦59）

ss：秒（00≦ss≦59）

-d <日数>　〜＜整数＞ ((0−365))

指定した日数より以前の作業フォルダ内のファイルを削除します。日数を日単位で指定してください。0を指定した場合，すべての作業フォルダを削除します。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

2

通信タイムアウトが発生しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意

作業フォルダが残り続けると，サブディレクトリ数がOSのファイルシステムの上限に達してリクエストが実行できなくなるおそれがあります。そのため，作業フォルダは定期的に削除してください。作業フォルダを削除するときは，ビジネスプロセスの実行期間などを考慮して削除開始日時および日数を決定してください。

コマンドを実行する前に，作業フォルダを管理する受付，およびその受付から呼び出されるビジネスプロセスを停止してください

削除開始日時には，実行環境の日時を指定してください。

コマンドを実行する前に，作業フォルダ以下に必要なディレクトリおよびファイルがないか確認してください。

cscmsgtk（メッセージトラッキング機能の起動）

形式

cscmsgtk [-h]
         -prf <性能解析トレースファイル名>
         [-date [<読み込み開始日時>],[<読み込み終了日時>]]

機能

指定した条件の性能解析トレースを読み込み，メッセージトラッキング機能を起動します。メッセージトラッキング機能が起動すると，メッセージトラッキング専用の対話型のプロンプトが表示されます。このプロンプトは，メッセージトラッキング機能で使用するコマンド（メッセージトラッキングプロンプト専用のコマンド）の入力待ち状態となります。

性能解析トレースファイル名は，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「7.10　メッセージトラッキングを利用した障害解析」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-prf <性能解析トレースファイル名>　〜((1−200バイト))

メッセージトラッキング機能の起動時に読み込む性能解析トレースのファイル名（CSV形式）を絶対パス，または相対パスで指定します。指定したファイルがない場合，異常終了します。

-date [<読み込み開始日時>],[<読み込み終了日時>]　〜＜半角数字＞

メッセージトラッキング機能の起動時に読み込む性能解析トレースの範囲を指定します。なお，読み込み開始日時および読み込み終了日時は，次のどれかの形式で指定してください。また，日時には存在するものを指定してください。

形式1：hhmmssMMddyyyy

形式2：hhmmssMMdd

形式3：hhmmss

hh：時（00≦hh≦23）

mm：分（00≦mm≦59）

ss：秒（00≦ss≦59）

MM：月（01≦MM≦12）

dd：日（01≦dd≦31）

yyyy：西暦年（1970≦yyyy）

西暦年だけを省略した場合（形式2），コマンド実行時の西暦年を設定します。西暦年，月，および日を省略した場合（形式3），コマンド実行時の西暦年，月，および日を設定します。読み込み開始日時を省略した場合は，最も古い性能解析トレースから読み込みます。読み込み終了日時を省略した場合は，最も新しい性能解析トレースまで読み込みます。

メッセージトラッキングプロンプトで使用するコマンド

障害解析コマンド

形式

prf <ルートアプリケーション情報のIPアドレス>/<ルートアプリケーション情報のプロセスID>/<ルートアプリケーション情報の通信番号>
[<通番>]

説明

指定したルートアプリケーション情報に一致する性能解析トレースの情報を出力します。

ルートアプリケーション情報のIPアドレス/ルートアプリケーション情報のプロセスID/ルートアプリケーション情報の通信番号

指定したルートアプリケーション情報の一連のトレースの内容を出力します。

通番

指定した性能解析トレースの詳細情報を出力します。

一覧表示コマンド

形式

ls [-e] [-t] [<表示する件数>]

説明

ルートアプリケーション情報の一覧を出力します。出力開始日時の昇順に出力されます。

-e

エラーが発生したルートアプリケーション情報を出力します。リターンコードが0以外のトレースを含むルートアプリケーション情報だけが出力されます。

-t

ルートアプリケーション情報が示す一連の性能解析トレースで，最初に出力されたトレースから最後に出力されたトレースまでの経過時間が長いルートアプリケーション情報を出力します。経過時間の昇順に出力されます。

表示する件数

指定した件数のルートアプリケーション情報を出力します。性能解析トレースの出力開始日時が新しい方から，指定した件数分が出力されます。

参考

オプションは「-et」のように，続けて指定することもできます。

（例）表示件数を3件に指定した場合

　　　ls -et 3

解析対象絞り込みコマンド

形式

focus [<絞り込み日時>]

説明

指定した絞り込み日時に実行していた処理のトレースだけを解析対象に絞り込みます。

絞り込み日時

性能解析トレースの絞り込み日時を次のどれかの形式で指定します。また，日時には存在するものを指定してください。

形式1：hhmmssMMddyyyy

形式2：hhmmssMMdd

形式3：hhmmss

hh：時（00≦hh≦23）

mm：分（00≦mm≦59）

ss：秒（00≦ss≦59）

MM：月（01≦MM≦12）

dd：日（01≦dd≦31）

yyyy：西暦年（1970≦yyyy）

西暦年だけを省略した場合（形式2），コマンド実行時の西暦年を設定します。西暦年，月，および日を省略した場合（形式3），コマンド実行時の西暦年，月，および日を設定します。

メッセージトラッキング機能の起動時の範囲に解析対象を戻したい場合は，絞り込み日時の指定を省略してfocusコマンドを実行します。

出力モード切り替えコマンド

形式

mode {normal｜detail}

説明

性能解析トレースの出力モードを切り替えます。

normal

標準出力モードで出力します。サービスプラットフォームのトレースポイントで取得される性能解析トレースだけが出力されます。

detail

詳細出力モードで出力します。すべての性能解析トレースが出力されます。

トレース取得ポイント表示コマンド

形式

id {<イベントID>｜list}

説明

性能解析トレースの取得ポイントを表示します。

イベントID

指定したイベントIDのトレース取得ポイントが表示されます。

list

サービスプラットフォームのすべてのトレース取得ポイントが表示されます。

終了コマンド

形式

quit

説明

メッセージトラッキングプロンプトを終了します。

ヘルプ表示コマンド

形式

help｜?

説明

ヘルプ情報を表示します。

入力例

(1)すべてのトレースを読み込む場合

cscmsgtk -prf prf_trace.csv

(2)コマンド実行日の8時45分00秒から17時15分00秒の間に取得したトレースを読み込む場合

cscmsgtk -prf prf_trace.csv -date 084500,171500

(3)コマンド実行年の3月23日8時45分00秒から3月24日17時15分00秒の間に取得したトレースを読み込む場合

cscmsgtk -prf prf_trace.csv -date 0845000323,1715000324

(4)2008年3月23日8時45分00秒から2008年3月24日17時15分00秒の間に取得したトレースを読み込む場合

cscmsgtk -prf prf_trace.csv -date 08450003232008,17150003242008

(5)コマンド実行日の17時15分00秒以前に取得したすべてのトレースを読み込む場合

cscmsgtk -prf prf_trace.csv -date ,171500

(6)コマンド実行日の8時45分00秒以降に取得したすべてのトレースを読み込む場合

cscmsgtk -prf prf_trace.csv -date 084500,

注意事項

次の場合はエラーになります。

コマンドの引数の構文が不正な場合

性能解析トレースファイルへのアクセスに失敗した場合

読み込み開始日時または読み込み終了日時の指定に誤りがある場合

cscmsgtkコマンドの実行中，またはメッセージトラッキング機能の起動中に表示されるメッセージは，ログファイルには出力されません。

ほかのコマンドの実行中に，ファイルサイズの大きい性能解析トレースファイルを読み込んでメッセージトラッキング機能を起動した場合，ほかのコマンドのスループットが低下するおそれがあります。

cscpasswd（ユーザの管理）

形式

cscpasswd [-h]
          -user <ログインユーザID>
          -pass <ログインパスワード>
          {-print
            ｜-cscmnguser <変更後のユーザID>
              -cscmngpass <変更後のパスワード>
            ｜-mng <Manager名>
              -mnguser <変更後のユーザID>
              [-mngpass <変更後のパスワード>]
            ｜-csc <HCSCサーバ名>
              -cscuser <変更後のユーザID>
              -cscpass <変更後のパスワード>}

機能

指定された条件に従ってユーザ情報を変更します。変更した情報は，コマンド正常終了後，次の画面でのログイン時，または次のコマンド起動時に反映されます。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「2.4.2　ユーザ情報を設定する」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-print

HCSC-Managerが管理しているHCSC-ManagerのユーザID，ManagerへアクセスするユーザID，およびHCSCサーバが使用するデータベースへアクセスするユーザIDを表示します。

-cscmnguser <変更後のユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerの変更後のユーザIDを指定します。

-cscmngpass <変更後のパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

変更後のHCSC-ManagerのユーザIDに対するパスワードを指定します。

-mng <Manager名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

Managerセットアップ時に入力したManager名を指定します。Managerへログイン時のユーザ情報を変更する場合に指定します。HCSCサーバ構成定義ファイルで指定したManager名を指定してください。

-mnguser <変更後のユーザID>　〜 ((1文字以上))

変更後のManagerのユーザIDを指定します。

-mngpass <変更後のパスワード>　〜 ((1文字以上))

変更後のManagerのユーザIDに対するパスワードを指定します。変更するManagerのユーザIDにパスワードを設定している場合にだけ，このオプションを指定します。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

HCSCサーバのセットアップ時に入力したHCSCサーバ名を指定します。HCSCサーバへログイン時のユーザ情報を変更する場合に指定します。

-cscuser <変更するユーザID>　〜 ((1文字以上))

HCSCサーバが使用するデータベースのユーザIDを指定します。

-cscpass <変更するパスワード>　〜 ((1文字以上))

変更するHCSCサーバが使用するデータベースの，ユーザIDに対するパスワードを指定します。

入力例

(1)HCSC-ManagerのユーザIDを「user1」に，パスワードを「password」に変更する場合

cscpasswd -user admin -pass admin -cscmnguser user1 -cscmngpass password

(2)Manager名がManagerのユーザIDを「admin」に，パスワードを「admin」に変更する場合

cscpasswd -user admin -pass admin -mng Manager -mnguser admin -mngpass admin

(3)HCSCサーバ「HCSC」で，アクセスするデータベースのユーザIDを「server1」に，パスワードを「password」に変更する場合

cscpasswd -user admin -pass admin -csc HCSC -cscuser server1 -cscpass password

(4)HCSCサーバ「HCSC」で，アクセスするデータベースのユーザIDを「"user1"」に，パスワードを「"pass"」に変更する場合

cscpasswd -user admin -pass admin -csc HCSC -cscuser ¥"user1¥" -cscpass ¥"pass¥"

(5)HCSC-Managerのユーザ情報を表示する場合

cscpasswd -user admin -pass admin -print

表示形式

ユーザ情報を表示する場合（-print指定時）

HCSC-Manager:HCSC-ManagerのユーザID
 + Manager名:Manager名に対応するユーザID
          HCSCサーバ名:HCSCサーバ名に対応するユーザID
          HCSCサーバ名:HCSCサーバ名に対応するユーザID
                        :
 + Manager名:Manager名に対応するユーザID
          HCSCサーバ名:HCSCサーバ名に対応するユーザID
                        :

注

データベースにユーザIDを設定していない場合，HCSCサーバ名に対応するユーザIDが表示されません。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

cscpidelete（プロセスインスタンスの実行履歴の削除）

形式

cscpidelete [-h]
            -user <ログインユーザID>
            -pass <ログインパスワード>
            -csc <HCSCサーバ名>
            {-where <where句>
              ｜-idlist <プロセスインスタンスの識別子のリストが
                        記載されたファイル名>
              ｜-wherefile <where句が記載されたファイル名>
              ｜[-processname <ビジネスプロセス定義名>]
                [-date [<照会開始日時>],<照会終了日時>]
                [-status {executing｜completed｜faulted｜error｜exited｜all}]
              ｜-force}
            [-encoding <エンコーディング名>]
            [-canceltimer <中断時間>]

機能

セットアップ後のHCSCサーバに対して，指定された条件に従ってプロセスインスタンスの実行履歴を削除します。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「6.1.4　プロセスインスタンスの実行履歴を削除する」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

SQLを実行するHCSCサーバ名を指定します。

-where <where句>　〜 ((1文字以上))

削除対象となるプロセスインスタンスのプロセス概要情報を検索するためのwhere句を指定します。where句に記載できる内容については，使用しているデータベースのSQLリファレンスマニュアルを参照してください。

なお，where句には，テーブル名の指定およびコメント行の追加はできません。where句の設定で，誤った例と正しい例を次に示します。

設定例1

　誤った例：テーブル名を指定している
　          P.Status='Completed'
　正しい例：テーブル名を指定していない
　          Status='Completed'

設定例2

　誤った例：コメント行を追加している
　          Status='Completed' AND
　          # ProcessDefinitionName like 'BP%'
　正しい例：：コメント行を追加していない
　          Status='Completed' AND
　          ProcessDefinitionName like 'BP%'

-idlist <プロセスインスタンスの識別子のリストが記載されたファイル名>　〜 ((1−200バイト))

プロセスインスタンスの識別子のリストが記載されたファイル名を指定します。プロセスインスタンスの識別子のリストは，改行区切り（「¥r¥n」または「¥n」）で記載します。ファイルパスは，絶対パス，または相対パスで指定します。1つの改行の先頭と終端の空白文字は削除します。設定例を次に示します。

設定例

ProcessIDが「11111」，「44444」，「77777」のビジネスプロセスを削除する場合（改行コードは「¥n」で表示しています）。

11111¥n
44444¥n
77777¥n

-wherefile <where句が記載されたファイル名>　〜((1−200バイト))

where句が記載されたファイル名を絶対パス，または相対パスで指定します。指定されたファイル内容に改行コードをスペースに置き換えて，プロセス概要情報を検索し，該当するプロセスインスタンスの実行履歴を削除します。

-processname <ビジネスプロセス定義名>　〜((1文字以上))

指定したビジネスプロセス定義名のプロセスインスタンスを削除します。

-date [<照会開始日時>],<照会終了日時>　〜＜半角数字＞

指定した照会開始日時から照会終了日時までの間に開始したプロセスインスタンスを削除します。照会開始日時を省略した場合，照会終了日時より前に開始したプロセスインスタンスを削除します。照会開始日時と照会終了日時の間のコンマ（,）の前後に余分なスペースを指定しないでください。

なお，照会開始日時と照会終了日時は次の形式で指定します。日時の指定にはデフォルトタイムゾーンを使用してください。

YYYYMMDDhhmmss

YYYY：西暦年（1970≦YYYY）

MM：月（01≦MM≦12）

DD：日（01≦DD≦31）

hh：時（00≦hh≦23）

mm：分（00≦mm≦59）

ss：秒（00≦ss≦59）

-status {executing｜completed｜faulted｜error｜exited｜all}　〜<<completed>>

指定した状態のプロセスインスタンスを削除します。-whereオプション，-idlistオプション，-wherefileオプション，-statusオプション，および-forceオプションをすべて省略した場合，このオプションのcompletedが有効になります。

executing

状態が「実行中」のプロセスインスタンスの履歴情報を削除します。

completed

状態が「完了」のプロセスインスタンスの履歴情報を削除します。

faulted

状態が「フォルト終了」のプロセスインスタンスの履歴情報を削除します。

error

状態が「エラー発生」のプロセスインスタンスの履歴情報を削除します。

exited

状態が「途中終了」のプロセスインスタンスの履歴情報を削除します。

all

全状態のプロセスインスタンスの履歴情報を削除します。

-force

データベース内の全プロセスインスタンスの情報を削除します。

-encoding <エンコーディング名>　〜((1文字以上)) <<JavaVMのデフォルトエンコーディング>>

-wherefileオプションや-idlistオプションで指定した入力ファイルのエンコーディング名を指定します。次のエンコーディング名を指定できます。

UTF-8

US-ASCII

ISO-8859-1

JavaVMがサポートしているエンコーディング名

-canceltimer <中断時間>　〜((0−86400)) <<0>>

特定の時間を経過しても処理が終了しない場合，処理を中断できます。処理中断までの時間を秒数で指定します。

0以外の秒数を指定した場合

指定された時間を経過すると，条件に合致するレコードが残っていても処理を中断し，資源を解放します。コマンドは戻り値10で正常終了します。その際，メッセージログとコンソールに警告メッセージが出力されます。

0を指定した場合

条件に合致するすべてのレコードの処理が終わるまで，処理は中断されません。

入力例

(1)全情報を削除する場合

cscpidelete -user admin -pass admin -csc HCSC -force

(2)ステータスが「完了」のプロセスをすべて削除する場合

cscpidelete -user admin -pass admin -where "State='Completed'"

(3)ProcessIDが「11111」，「22222」，および「33333」のプロセスを削除する場合

where句が記載されたファイルで指定する場合

cscpidelete -user admin -pass admin -wherefile delete_where.txt -csc HCSC

　delete_where.txtの中身

　　ProcessID='11111' OR ProcessID='22222' OR ProcessID='33333'

プロセスインスタンスの識別子のリストを改行区切りで作成したファイルで指定する場合

cscpidelete -user admin -pass admin -idlist idlist.txt -csc HCSC

　idlist.txtの中身

　　11111

　　22222

　　33333

(4)ステータス「完了」のプロセスをすべて削除する場合。ただし，300秒を経過しても削除処理が終わらないときは，残りの削除処理を中止する

cscpiselect -user admin -pass admin -where "State = 'Completed'" -canceltimer 300

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

2

通信タイムアウトが発生しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

10

指定された中断時間を超過したため，処理を中断しました。

注意事項

このコマンドはSQLのwhere句をオプションに指定します。そのため，使用するユーザIDおよびパスワードを定期的に変更するなどして，第三者に不当にコマンドを実行されないようにしてください。

100件以上のプロセスインスタンスを削除対象として指定し，101件目以降の削除で例外が発生した場合，削除対象となっていた前100件のプロセスインスタンスは削除済みの状態になります。その場合，前100件の削除済みの情報は，エラーメッセージの詳細情報として表示されます。

データベースを使用する場合だけ，このコマンドを使用できます。

cscpireexec（プロセスインスタンスの再実行）

形式

cscpireexec [-h]
            -user <ログインユーザID>
            -pass <ログインパスワード>
            -csc <HCSCサーバ名>
            {-processname <ビジネスプロセス定義名>
             ｜-processnamefile <ビジネスプロセス定義ファイル名>
             ｜-all}
            [{-processid <プロセスインスタンスの識別子>
            ｜-processidfile <プロセスインスタンスの識別子を記載したファイル名>
            ｜-targetcsc <再実行対象とするHCSCサーバ名>
             [-status <再実行の条件となるアクティビティの状態>]}]
            [-encoding <エンコーディング名>]
            [-summary]

機能

指定された条件に従って，中断したプロセスインスタンスを再実行します。

また，指定したHCSCサーバで実行されたプロセスインスタンスだけを再実行することもできます。その場合，再実行の対象となるプロセスインスタンスをアクティビティの状態に応じて指定できます。

再実行の対象となるプロセスインスタンスを次に示します。

サービス呼出アクティビティの状態が「実行中（Executing）」または「エラー発生（Error）」のプロセスインスタンス

待機アクティビティの状態が「実行中（Executing）」のプロセスインスタンス

スコープアクティビティの状態が「実行中（待ち受け）（Executingwait）」，「エラー発生（Error）」または「完了（待ち受け）（Completedwait）」のプロセスインスタンス

応答アクティビティの状態が「完了（待ち受け）（Completedwait）」のプロセスインスタンス

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「6.1.5　プロセスインスタンスを再実行する」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

再実行するHCSCサーバ名を指定します。

-processname <ビジネスプロセス定義名>　〜 ＜XMLスキーマのNCName型の文字列＞ ((データベースの文字コードで64バイト以内))

再実行するプロセスのビジネスプロセス定義名を指定します。

-processnamefile <ビジネスプロセス定義ファイル名>　〜 ((1−200バイト))

再実行するプロセスのビジネスプロセス定義ファイル名を絶対パス，または相対パスで指定します。ファイル内にはビジネスプロセス定義名だけを指定します。

ビジネスプロセス定義ファイルの内容が読み込まれると，前後の空白，タブ，および改行が削除され，再実行するプロセスインスタンスの識別子となります。

-all

再実行の対象となるすべてのプロセスインスタンスを一括して再実行します。

-processid <プロセスインスタンスの識別子>　〜 ((1−240バイト以内))

再実行するプロセスの，プロセスインスタンスの識別子を指定します。このオプションと-processidfileオプションを指定していない場合は，-processnameオプション，または-processnamefileオプションで指定したビジネスプロセス定義名の中断したプロセスがすべて再実行されます。

プロセスインスタンスの識別子は長い文字列（最大240文字）になる可能性があります。応答電文出力ディレクトリに深いディレクトリ階層を設定すると，ファイルを生成できない場合があるため注意してください。再実行しても，応答電文ファイルが生成されない場合はメッセージが出力されます。

-processidfile <プロセスインスタンスの識別子を記載したファイル名>　〜 ((1−200バイト))

再実行するプロセスの，プロセスインスタンスの識別子をファイルに記載しておき，ファイル名を絶対パスまたは相対パスで指定します。このファイルには，プロセスインスタンスの識別子だけを指定してください。

コマンドを実行すると，プロセスインスタンスの識別子を記載したファイルの内容が読み込まれ，前後の空白，タブ，および改行が削除され再実行するプロセスインスタンスの識別子となります。

このオプションと-processidオプションを指定していない場合は，-processnameオプションまたは-processnamefileオプションで指定したビジネスプロセス定義名の，実行中状態で中断したプロセスがすべて再実行されます。

-targetcsc <再実行対象とするHCSCサーバ名>　〜 ((1−8文字))

再実行対象とするHCSCサーバ名を指定します。指定したHCSCサーバで実行されていたプロセスインスタンスが再実行対象となります。ただし，08-70以前に実行されたプロセスインスタンスは再実行対象とはなりません。

このオプションを省略した場合，すべてのHCSCサーバで実行されていたプロセスインスタンスが再実行対象となります。

-status <再実行の条件となるアクティビティの状態>

再実行条件となるアクティビティの状態を指定します。指定できる状態は次のとおりです。コンマ（,）で区切って複数指定することもできます。

executing

状態が「実行中」のサービス呼出アクティビティまたは待機アクティビティを持つプロセスインスタンスを再実行対象とします。

error

状態が「エラー発生」のサービス呼出アクティビティまたはスコープアクティビティを持つプロセスインスタンスを再実行対象とします。

executingwait

状態が「実行中（待ち受け）」のスコープアクティビティを持つプロセスインスタンスを再実行対象とします。

completedwait

状態が「完了（待ち受け）」のスコープアクティビティまたは応答アクティビティを持つプロセスインスタンスを再実行対象とします。

このオプションを省略した場合は，上記のすべての状態が再実行対象となり，次に示すアクティビティを持つプロセスインスタンスが再実行対象となります。

状態が「実行中」のサービス呼出アクティビティまたは待機アクティビティ

状態が「エラー発生」のサービス呼出アクティビティまたはスコープアクティビティ

状態が「実行中（待ち受け）」のスコープアクティビティ

状態が「完了（待ち受け）」のスコープアクティビティまたは応答アクティビティ

-encoding <エンコーディング名>　〜 <<JavaVMのデフォルトエンコーディング>> ((1文字以上))

-processidfileオプションや-processnamefileオプションで指定した入力ファイルのエンコーディング名を指定します。次のエンコーディング名を指定できます。

UTF-8

US-ASCII

ISO-8859-1

JavaVMがサポートしているエンコーディング名

-summary

再実行の結果を成功および失敗の件数で表示する場合に指定します。

入力例

(1)プロセスインスタンスの識別子が「11111」，ビジネスプロセス定義名が「PC貸し出し」のプロセスインスタンスを再実行する場合

cscpireexec -user admin -pass admin -processidfile　process_id.txt　-csc HCSC -processnamefile processname.txt

process_id.txtの中身：11111

processname.txtの中身：PC貸し出し

(2)ビジネスプロセス定義名が「PC貸し出し」のサービス部品を一括再実行する場合

cscpireexec -user admin -pass admin -csc HCSC -processname "PC貸し出し"

(3)再実行の対象となるすべてのプロセスインスタンスを一括再実行する場合

cscpireexec -user admin -pass admin -csc HCSC -all

(4)HCSCサーバ「CSCSrv2」で実行された，「実行中」状態のプロセスインスタンスを一括再実行する場合

cscpireexec -user admin -pass admin -csc CSCSrv1 -all -targetcsc CSCSrv2 -status executing

(5)HCSCサーバ「CSCSrv2」で実行された，「実行中」，「実行中（待ち受け）」，「完了（待ち受け）」状態のプロセスインスタンスを一括再実行する場合

cscpireexec -user user1 -pass password -csc CSCSrv1 -all -targetcsc CSCSrv2 -status executing,executingwait,completedwait

表示形式

(1)-summary未指定時

ProcessID,ProcessDefinitionName,Result,ErrorMessage
PI識別子,ビジネスプロセス定義名,呼び出し結果,エラー情報
PI識別子,ビジネスプロセス定義名,呼び出し結果,エラー情報
  ：

説明

表示項目

内容

説明

ProcessID

PI識別子

プロセスインスタンスの識別子を示します。

ProcessDefinitionName

ビジネスプロセス定義名

ビジネスプロセス定義名を示します。

Result

呼び出し結果

呼び出し結果を示します。次のどちらかが表示されます。

Success：呼び出しが正常終了

Failure：呼び出しが失敗

ErrorMessage

エラー情報

エラー情報を示します。Result欄（呼び出し結果）の内容によって，次のように表示されます。

Success：「””」

Failure：エラー情報

これらの表示項目は，CSCBP_<クラスタ名>_PROCESSテーブルの1レコードの情報を示します。情報の詳細については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「付録C.1　プロセスインスタンスの実行履歴の管理に関するテーブルの情報」を参照してください。

(2)-summary指定時

KEOS52290-Iのメッセージが出力されます。KEOS52290-Iのメッセージには，再実行が成功した件数および再実行が失敗した件数が表示されます。詳細については，マニュアル「サービスプラットフォーム メッセージ」の「2.29　KEOS50000〜KEOS59999のメッセージ」を参照してください。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

2

通信タイムアウトが発生しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

データベースを使用する場合だけ，このコマンドを使用できます。

再実行の対象となるプロセスインスタンスが多数存在する場合，再実行が完了するまでに時間が掛かることがあります。

再実行の対象となるプロセスインスタンスが存在しない場合は，コマンドは異常終了します。

cscpiselect（プロセスインスタンスの検索）

形式

cscpiselect [-h]
            -user <ログインユーザID>
            -pass <ログインパスワード>
            -csc <HCSCサーバ名>
            -table
              {process｜activity｜link｜set｜string｜numeric｜boolean
              ｜message｜relation｜process_set}
            [-detail]
            [-separator {comma｜tab}]
            [{-count｜-orderby <ソート条件>}]
            [{-where <where句>
              ｜-wherefile <where句が記載されたファイル名>
              ｜[-processname <ビジネスプロセス定義名>]
                [-date [<照会開始日時>],<照会終了日時>]
                [-status {executing｜completed｜faulted｜error｜exited
                ｜executingwait｜completedwait｜all}]
                [-targetcsc <検索対象とするHCSCサーバ名>]}]
            [-encoding <エンコーディング名>]
            [-canceltimer <中断時間>]

機能

セットアップ後のHCSCサーバに対して，指定された条件に従ってビジネスプロセス情報を検索し，CSVまたはTSV形式で出力します。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，目的にあわせてマニュアル「サービスプラットフォーム システム構築・運用ガイド」の次に示す個所を参照してください。

「6.1.2　プロセスインスタンスの実行履歴を検索する」

「6.1.3　プロセスインスタンスの実行履歴の詳細情報を取得する」

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

SQLを実行するHCSCサーバ名を指定します。

-table {process｜activity｜link｜set｜string｜numeric｜boolean｜message｜relation｜process_set}

検索するテーブルを指定します。

このオプションにprocess_setを指定した場合，内部でプロセス概要情報と相関セット情報を連結して検索します。そのため，検索条件にプロセス情報のカラムを指定する場合は，where句に「P」を，相関セット情報のカラムを指定する場合は，「C」を付けてください。

このオプションにprocess_set以外を指定した場合は，where句にテーブル名の指定は不要です。where句に記載できる内容については，使用しているデータベースのSQLリファレンスマニュアルを参照してください。

process

指定した検索条件に該当するプロセスの概要情報を表示します。

なお，where句には，テーブル名の指定およびコメント行の追加はできません。where句の設定で，誤った例と正しい例を次に示します。

設定例1

　誤った例：テーブル名を指定している
　          P.Status='Completed'
　正しい例：テーブル名を指定していない
　          Status='Completed'

設定例2

　誤った例：コメント行を追加している
　          Status='Completed' AND
　          # ProcessDefinitionName like 'BP%'
　正しい例：：コメント行を追加していない
　          Status='Completed' AND
　          ProcessDefinitionName like 'BP%'

activity

検索条件に該当するアクティビティ情報を表示します。

link

検索条件に該当するリンク情報を表示します。

set

検索条件に該当する相関セット情報を表示します。

string

検索条件に該当するstring変数情報を表示します。

numeric

検索条件に該当するnumeric変数情報を表示します。

boolean

検索条件に該当するboolean変数情報を表示します。

message

検索条件に該当するmessage変数情報を表示します。

relation

検索条件に該当するメッセージ関連情報を表示します。

process_set

検索条件に該当するプロセス概要情報を相関セット情報から検索し表示します。なお，where句には，テーブル名を指定してください。where句の設定で，誤った例と正しい例を次に示します。

設定例

　誤った例：テーブル名を指定していない
　          State='Completed'
　正しい例1：テーブル名を指定している
　          P.State='Completed'
　正しい例2：テーブル名を指定している
　          P.State='Completed' AND
　          C.ProcessDefinitionName like 'BP%'

-detail

テーブルの全情報を出力する場合に指定します。

-separator {comma｜tab}　〜<<comma>>

情報を区切るセパレータを指定します。

-count

検索結果の行数だけが出力されます。このオプションは，検索結果のデータが大量にある場合に，検索件数だけを知るときに使用します（SQL文のcount(*)に相当します）。

-orderby <ソート条件>　〜 ((1文字以上))

データをソートする条件を指定します。SQL文のorder by句に相当します。-countオプションと同時には指定できません。order by句に記載できる内容については，使用しているデータベースのSQLリファレンスマニュアルを参照してください。-orderbyオプションを指定しない場合は，order by句の指定がないと仮定されます。

-where <where句>　〜 ((1文字以上))

where句を指定します。where句に記載できる内容については，使用しているデータベースのSQLリファレンスマニュアルを参照してください。

SplitKey列を指定して検索した場合，SplitKey列の情報は出力されません。また，-tableオプションの設定値によっては，次の表に示すビュー表にSplitKey列の追加が必要となります。ビュー表の構成については，マニュアル「サービスプラットフォームシステム構築・運用ガイド」の「付録C.1　プロセスインスタンスの実行履歴の管理に関するテーブルの情報」の，ビュー表の情報に関する記述を参照してください。

表5‒5　SplitKey列の追加が必要なビュー表

-tableオプションの設定値

事前にSplitKey列の追加が必要なビュー表

process

なし

activity

CSCBP_<クラスタ名>_V_ACTIVITY

link

CSCBP_<クラスタ名>_V_LINK

set

なし

string

CSCBP_<クラスタ名>_V_STR_VARIABLE

numeric

CSCBP_<クラスタ名>_V_NUM_VARIABLE

boolean

CSCBP_<クラスタ名>_V_BOOL_VARIABLE

message

CSCBP_<クラスタ名>_V_MSG_VARIABLE

relation

なし

process_set

なし

-wherefile <where句が記載されたファイル名>　〜 ((1−200バイト))

where句が記載されたファイル名を絶対パス，または相対パスで指定します。指定されたファイルの内容に改行コードをスペースに置き換えて，SQLが実行されます。記載できる内容については，使用しているデータベースのSQLリファレンスマニュアルを参照してください。

なお，SplitKey列を指定して検索する場合の注意事項は，-whereオプションと同じです。

-processname <ビジネスプロセス定義名>　〜((1文字以上))

ビジネスプロセス定義名で検索する場合に指定します。-tableオプションでrelationまたはprocess_set以外を指定した場合だけ指定できます。

-date [<照会開始日時>],<照会終了日時>　〜＜半角数字＞

プロセスインスタンスの開始日時で検索する場合に指定します。指定した照会開始日時から照会終了日時までの間に開始したプロセスインスタンスを検索します。-tableオプションでprocessまたはactivityを指定した場合だけ指定できます。照会開始日時を省略した場合，照会終了日時より前に開始したプロセスインスタンスから検索します。照会開始日時と照会終了日時の間のコンマ（,）の前後に余分なスペースを指定しないでください。

なお，照会開始日時と照会終了日時は次の形式で指定します。日時の指定にはデフォルトタイムゾーンを使用してください。

YYYYMMDDhhmmss

YYYY：西暦年（1970≦YYYY）

MM：月（01≦MM≦12）

DD：日（01≦DD≦31）

hh：時（00≦hh≦23）

mm：分（00≦mm≦59）

ss：秒（00≦ss≦59）

-status {executing｜completed｜faulted｜error｜exited｜executingwait｜completedwait｜all}　〜<<all>>

プロセスインスタンスおよびアクティビティインスタンスの状態で検索する場合に指定します。

引数executing，completed，faulted，errorは，-tableオプションでprocessまたはactivityを指定した場合だけ指定できます。引数executingwait，completedwaitは，-tableオプションでactivityを指定した場合だけ指定できます。exitedは，-tableオプションの検索するテーブルにprocessを指定した場合だけ指定できます。

executing

状態が「実行中」のプロセスインスタンスのプロセス概要情報またはアクティビティ情報を検索します。

completed

状態が「完了」のプロセスインスタンスのプロセス概要情報またはアクティビティ情報を検索します。

faulted

状態が「フォルト終了」のプロセスインスタンスのプロセス概要情報またはアクティビティ情報を検索します。

error

状態が「エラー発生」のプロセスインスタンスのプロセス概要情報またはアクティビティ情報を検索します。

exited

状態が「途中終了」のプロセスインスタンスのプロセス概要情報を検索します。

executingwait

状態が「実行中（待ち受け）」のアクティビティ情報を検索します。

completedwait

状態が「完了（待ち受け）」のアクティビティ情報を検索します。

all

全状態のプロセス概要情報またはアクティビティ情報を検索します。

-statusオプションに引数executingwaitを指定した場合を例に，-tableオプションの誤った例と正しい例を次に示します。

設定例

誤った例：-tableオプションにactivityを指定していない
          -table process -status executingwait
正しい例：-tableオプションにactivityを指定している
          -table activity -status executingwait

-targetcsc <検索対象とするHCSCサーバ名>　〜 ((1−8文字))

検索対象とするHCSCサーバ名を指定します。指定したHCSCサーバで実行されていたプロセスインスタンスが検索対象となります。なお，08-70以前に実行されたプロセスインスタンスは，検索対象とはなりません。

このオプションを省略した場合は，すべてのHCSCサーバで実行されていたプロセスインスタンスが検索対象となります。

-encoding <エンコーディング名>　〜<<JavaVMのデフォルトエンコーディング>> ((1文字以上))

-wherefileオプションで指定した入力ファイルのエンコーディング名を指定します。次のエンコーディング名を指定できます。

UTF-8

US-ASCII

ISO-8859-1

JavaVMがサポートしているエンコーディング名

-canceltimer <中断時間>　〜((0−86400)) <<0>>

特定の時間を経過しても処理が終了しない場合，処理を中断できます。処理中断までの時間を秒数で指定します。-countオプションを指定している場合は，このオプションを指定しても無視されます。

0以外の秒数を指定した場合

指定された時間を経過すると，条件に合致するレコードが残っていても処理を中断し，資源を解放します。コマンドは戻り値10で正常終了します。その際，メッセージログとコンソールに警告メッセージが出力されます。

0を指定した場合

条件に合致するすべてのレコードの処理が終わるまで，処理は中断されません。

入力例

(1)プロセスの概要情報の全情報を出力する場合

cscpiselect -user admin -pass admin -csc HCSC -table process

(2)相関セット定義名が「rentalNumber」で，相関セット値が100であるプロセスの概要情報の全情報を出力する場合

cscpiselect -user admin -pass admin -wherefile sql_where.txt -csc HCSC -table process_set

sql_where.txtの内容

C.CorrelationSetName = 'rentalNumber' AND C.CorrelationSetValue = '100'

(3)アクティビティ情報からビジネスプロセス定義名が「BP」で始まる文字列の行数を表示する場合

cscpiselect -user admin -pass admin -count -wherefile sql_where.txt -csc HCSC -table activity

sql_where.txtの内容

ProcessDefinitionName like 'BP%'

(4)リンク情報を全件検索する場合

cscpiselect -user admin -pass admin -csc HCSC -table link

(5)相関セット情報を全件検索する場合

cscpiselect -user admin -pass admin -csc HCSC -table set

(6)string変数情報をProcessID = '11111' である条件で検索する場合

cscpiselect -user admin -pass admin -wherefile sql_where.txt -csc HCSC -table string

sql_where.txtの内容

ProcessID = '11111'

(7)numeric変数情報をProcessID = '11111' ，かつ，ビジネスプロセス定義名が「BP」で始まる条件で検索する場合

cscpiselect -user admin -pass admin -wherefile sql_where.txt -csc HCSC -table numeric

sql_where.txtの内容

ProcessID = '11111' AND　ProcessDefinitionName like 'BP%'

(8)boolean変数情報をProcessID = '11111'，かつ定義値が0である条件で検索する場合

cscpiselect -user admin -pass admin -where "ProcessID = '11111' AND VariableValue = 0" -csc HCSC -table boolean

(9)message変数情報をProcessID = '11111'，かつ変数定義名にABCが含まれる条件で検索し，検索結果をProcessIDの降順で並べる場合

cscpiselect -user admin -pass admin -wherefile sql_where.txt -orderby "ProcessID DESC"-csc HCSC -table message

sql_where.txtの内容

ProcessID = '11111' AND VariableName like '%ABC%'

(10)最後に実行されたHCSCサーバを指定してプロセスの概要情報を検索し，情報を出力する場合

cscpiselect -user admin -pass admin -csc CSCSrv1 -table process -targetcsc CSCsrv2

(11)2012年3月31日までの実行履歴を検索する場合（ただし，検索時間が300秒以上掛かる場合は処理を停止し，リソースを解放する）

cscpiselect -user admin -pass admin -csc CSCSrv1 -table process -date ,20120331235959 -canceltimer 300

表示形式

(1)プロセス概要情報（process指定時，process_set指定時）

-detail未指定時

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,State,StartTime,EndTime,CSCServerName
PI識別子,ビジネスプロセス定義名,ビジネスプロセス定義バージョン,PI状態,PI開始時刻,PI終了時刻,HCSCサーバ名
PI識別子,ビジネスプロセス定義名,ビジネスプロセス定義バージョン,PI状態,PI開始時刻,PI終了時刻,HCSCサーバ名
  ：

注

ProcessID（PI識別子）からEndTime（PI終了時刻）までは改行されないで表示されます。

-detail指定時

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,State,StartTime,EndTime,ChangeCount,CSCServerName
PI識別子,ビジネスプロセス定義名,ビジネスプロセス定義バージョン,PI状態,PI開始時刻,PI終了時刻,更新回数,HCSCサーバ名
PI識別子,ビジネスプロセス定義名,ビジネスプロセス定義バージョン,PI状態,PI開始時刻,PI終了時刻,更新回数,HCSCサーバ名
  ：

注

ProcessID（PI識別子）からChangeCount（更新回数）までは改行されないで表示されます。

説明

CSCBP_<クラスタ名>_PROCESSテーブルの1レコードの情報を次の表に示します。情報の詳細については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「付録C　データベースのテーブルの情報」を参照してください。

表示項目

内容

説明

ProcessID

PI識別子

プロセスインスタンスの識別子を示します。

ProcessDefinitionName

ビジネスプロセス定義名

ビジネスプロセス定義名を示します。

ProcessDefinitionVersion

ビジネスプロセス定義バージョン

ビジネスプロセス定義バージョンを示します。

State

PI状態

プロセスインスタンスの状態を示します。

StartTime

PI開始時刻

プロセスインスタンスの開始時刻（GMT）を示します。

java.text.SimpleDateFormatで定義されているフォーマットに，YYYY/MM/DD hh:mm:ssの形式で出力されます。

YYYY：西暦年

MM：月

DD：日

hh：時

mm：分

ss：秒

EndTime

PI終了時刻

プロセスインスタンスの終了時刻（GMT）を示します。

java.text.SimpleDateFormatで定義されているフォーマットに，YYYY/MM/DD hh:mm:ssの形式で出力されます。

YYYY：西暦年

MM：月

DD：日

hh：時

mm：分

ss：秒

ChangeCount

更新回数

データの更新回数を示します。

CSCServerName※

HCSCサーバ名

最後に実行したHCSCサーバ名を示します。

注※

プロセスインスタンスの履歴情報に値が存在しない場合は，何も表示されません。

(2)アクティビティ情報（activity指定時）

-detail未指定時

ProcessID,ActivityNumber,ActivityDefinitionName,ActivityKind,State,StartTime,EndTime,WaitTime
PI識別子,ACI識別子,AC定義名,AC種別,ACI状態,AC開始時刻,AC終了時刻,AC待機解除時刻
PI識別子,ACI識別子,AC定義名,AC種別,ACI状態,AC開始時刻,AC終了時刻,AC待機解除時刻
  ：

注

ProcessID（PI識別子）からWaitTime（AC待機解除時刻）までは改行されないで表示されます。

-detail指定時

ProcessID,ActivityNumber,ProcessDefinitionName,
ProcessDefinitionVersion,ActivityDefinitionName,ActivityKind,
ParentNumber,ScopeNumber,RepeatNumber,State,
FirstChildNumber,LastChildNumber,StartTime,EndTime,WaitTime,CSCServerName
PI識別子,ACI識別子,ビジネスプロセス定義名,
ビジネスプロセス定義バージョン,AC定義名,AC種別
親ACI識別番号,所属SCI識別番号,所属RP識別番号,ACI状態,
先頭の子ACI識別番号,最後の子ACI識別番号,AC開始時刻,AC終了時刻,AC待機解除時刻,HCSCサーバ名
  ：

注

ProcessID（PI識別子）からCSCServerName（HCSCサーバ名）までは改行されないで表示されます。

説明

CSCBP_<クラスタ名>_ACTIVITYテーブルの1レコードの情報を次の表に示します。情報の詳細については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「付録C　データベースのテーブルの情報」を参照してください。

表示項目

内容

説明

ProcessID

PI識別子

プロセスインスタンスの識別子を示します。

ActivityNumber

ACI識別子

アクティビティインスタンスの識別番号を示します。

プロセスインスタンス内で一意の値です。

ProcessDefinitionName

ビジネスプロセス定義名

ビジネスプロセス定義名を示します。

ProcessDefinitionVersion

ビジネスプロセス定義バージョン

ビジネスプロセス定義バージョンを示します。

ActivityDefinitionName

AC定義名

アクティビティ定義名を示します。

ActivityKind

AC種別

アクティビティ種別を示します。

ParentNumber

親ACI識別番号

親アクティビティインスタンスの識別番号を示します。

ScopeNumber

所属SCI識別番号

所属するスコープインスタンスの識別番号を示します。

RepeatNumber

所属RP識別番号

所属する繰り返し処理の識別番号を示します。

State

ACI状態

アクティビティインスタンスの状態を示します。

FirstChildNumber

先頭の子ACI識別番号

先頭の子アクティビティインスタンスの識別番号を示します。

LastChildNumber

最後の子ACI識別番号

最後の子アクティビティインスタンスの識別番号を示します。

StartTime※

AC開始時刻

アクティビティの開始時刻（GMT）を示します。java.text.SimpleDateFormatで定義されているフォーマットに，YYYY/MM/DD hh:mm:ssの形式で出力されます。

YYYY：西暦年

MM：月

DD：日

hh：時

mm：分

ss：秒

EndTime※

AC終了時刻

アクティビティの終了時刻（GMT）を示します。java.text.SimpleDateFormatで定義されているフォーマットに，YYYY/MM/DD hh:mm:ssの形式で出力されます。

YYYY：西暦年

MM：月

DD：日

hh：時

mm：分

ss：秒

WaitTime※

AC待機解除時刻

アクティビティの待機解除時刻（GMT）を示します。java.text.SimpleDateFormatで定義されているフォーマットに，YYYY/MM/DD hh:mm:ssの形式で出力されます。

YYYY：西暦年

MM：月

DD：日

hh：時

mm：分

ss：秒

CSCServerName※

HCSCサーバ名

最後に実行したHCSCサーバ名を示します。

注※

プロセスインスタンスの履歴情報に値が存在しない場合は，何も表示されません。

(3)リンク情報（link指定時）

-detail未指定時

ProcessID,LinkDefinitionName,State
PI識別子,リンク定義名,リンク状態
PI識別子,リンク定義名,リンク状態
  ：

-detail指定時

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,
LinkDefinitionName,RepeatNumber,State
PI識別子,ビジネスプロセス定義名,ビジネスプロセス定義バージョン,
リンク定義名,所属RP識別番号,リンク状態
  ：

注

ProcessID（PI識別子）からState（リンク状態）までは改行されないで表示されます。

説明

CSCBP_<クラスタ名>_LINKテーブルの1レコードの情報を次の表に示します。情報の詳細については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「付録C　データベースのテーブルの情報」を参照してください。

表示項目

内容

説明

ProcessID

PI識別子

プロセスインスタンスの識別子を示します。

ProcessDefinitionName

ビジネスプロセス定義名

ビジネスプロセス定義名を示します。

ProcessDefinitionVersion

ビジネスプロセス定義バージョン

ビジネスプロセス定義バージョンを示します。

LinkDefinitionName

リンク定義名

リンク定義名を示します。

RepeatNumber

所属RP識別番号

所属する繰り返し処理の識別番号を示します。

State

リンク状態

リンクの状態（真偽値）を示します。

(4)相関セット情報（set指定時）

-detail未指定時

ProcessID,CorrelationSetName,CorrelationSetValue
PI識別子,相関セット定義名,相関セット値
PI識別子,相関セット定義名,相関セット値
  ：

-detail指定時

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,ScopeDefinitionName,
ScopeNumber,CorrelationSetName,CorrelationSetValue,State
PI識別子,ビジネスプロセス定義名,ビジネスプロセス定義バージョン,SC定義名,
SCI識別番号,相関セット定義名,相関セット値,相関セット有効性
PI識別子,ビジネスプロセス定義名,ビジネスプロセス定義バージョン,SC定義名,
SCI識別番号,相関セット定義名,相関セット値,相関セット有効性
  ：

注

ProcessID（PI識別子）からState（相関セット有効性）までは改行されないで表示されます。

説明

CSCBP_<クラスタ名>_CORRELATIONSETテーブルの1レコードの情報を次の表に示します。情報の詳細については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「付録C　データベースのテーブルの情報」を参照してください。

表示項目

内容

説明

ProcessID

PI識別子

プロセスインスタンスの識別子を示します。

ProcessDefinitionName

ビジネスプロセス定義名

ビジネスプロセス定義名を示します。

ProcessDefinitionVersion

ビジネスプロセス定義バージョン

ビジネスプロセス定義バージョンを示します。

ScopeDefinitionName

SC定義名

スコープ定義名を示します。

ScopeNumber

SCI識別番号

スコープインスタンスの識別番号を示します。

CorrelationSetName

相関セット定義名

相関セット定義名を示します。

CorrelationSetValue

相関セット値

相関セット値を示します。文字列化および連結され格納されます。

State

相関セット有効性

相関セットの有効性（真偽値）を示します。

(5)string変数情報（string指定時）

-detail未指定時

ProcessID,VariableName,VariableValue
PI識別子,変数定義名,変数値
PI識別子,変数定義名,変数値
　：

-detail指定時

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,
ScopeDefinitionName,ScopeNumber,VariableName,VariableValue
PI識別子,ビジネスプロセス定義名,ビジネスプロセス定義バージョン,
SC定義名,SCI識別番号,変数定義名,変数値
PI識別子,ビジネスプロセス定義名,ビジネスプロセス定義バージョン,
SC定義名,SCI識別番号,変数定義名,変数値
　：

注

ProcessID（PI識別子）からVariableValue（変数値）までは改行されないで表示されます。

説明

CSCBP_<クラスタ名>_STR_VARIABLEテーブルの1レコードの情報を次の表に示します。情報の詳細については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「付録C　データベースのテーブルの情報」を参照してください。

表示項目

内容

説明

ProcessID

PI識別子

プロセスインスタンスの識別子を示します。

ProcessDefinitionName

ビジネスプロセス定義名

ビジネスプロセス定義名を示します。

ProcessDefinitionVersion

ビジネスプロセス定義バージョン

ビジネスプロセス定義バージョンを示します。

ScopeDefinitionName

SC定義名

スコープ定義名を示します。

ScopeNumber

SCI識別番号

スコープインスタンスの識別番号を示します。

VariableName

変数定義名

変数定義名を示します。

VariableValue

変数値

変数値を示します。

(6)numeric変数情報（numeric指定時）

-detail未指定時

ProcessID,VariableName,VariableValue
PI識別子,変数定義名,変数値
PI識別子,変数定義名,変数値
　：

-detail指定時

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,
ScopeDefinitionName,ScopeNumber,VariableName,VariableValue
PI識別子,ビジネスプロセス定義名,ビジネスプロセス定義バージョン,
SC定義名,SCI識別番号,変数定義名,変数値
PI識別子,ビジネスプロセス定義名,ビジネスプロセス定義バージョン,
SC定義名,SCI識別番号,変数定義名,変数値
　：

注

ProcessID（PI識別子）からVariableValue（変数値）までは改行されないで表示されます。

説明

CSCBP_<クラスタ名>_NUM_VARIABLEテーブルの1レコードの情報を次の表に示します。情報の詳細については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「付録C　データベースのテーブルの情報」を参照してください。

表示項目

内容

説明

ProcessID

PI識別子

プロセスインスタンスの識別子を示します。

ProcessDefinitionName

ビジネスプロセス定義名

ビジネスプロセス定義名を示します。

ProcessDefinitionVersion

ビジネスプロセス定義バージョン

ビジネスプロセス定義バージョンを示します。

ScopeDefinitionName

SC定義名

スコープ定義名を示します。

ScopeNumber

SCI識別番号

スコープインスタンスの識別番号を示します。

VariableName

変数定義名

変数定義名を示します。

VariableValue

変数値

変数値を示します。

(7)boolean変数情報（boolean指定時）

-detail未指定時

ProcessID,VariableName,VariableValue
PI識別子,変数定義名,変数値
PI識別子,変数定義名,変数値
　：

-detail指定時

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,
ScopeDefinitionName,ScopeNumber,VariableName,VariableValue
PI識別子,ビジネスプロセス定義名,ビジネスプロセス定義バージョン,
SC定義名,SCI識別番号,変数定義名,変数値
PI識別子,ビジネスプロセス定義名,ビジネスプロセス定義バージョン,
SC定義名,SCI識別番号,変数定義名,変数値
　：

注

ProcessID（PI識別子）からVariableValue（変数値）までは改行されないで表示されます。

説明

CSCBP_<クラスタ名>_BOOL_VARIABLEテーブルの1レコードの情報を次の表に示します。情報の詳細については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「付録C　データベースのテーブルの情報」を参照してください。

表示項目

内容

説明

ProcessID

PI識別子

プロセスインスタンスの識別子を示します。

ProcessDefinitionName

ビジネスプロセス定義名

ビジネスプロセス定義名を示します。

ProcessDefinitionVersion

ビジネスプロセス定義バージョン

ビジネスプロセス定義バージョンを示します。

ScopeDefinitionName

SC定義名

スコープ定義名を示します。

ScopeNumber

SCI識別番号

スコープインスタンスの識別番号を示します。

VariableName

変数定義名

変数定義名を示します。

VariableValue

変数値

変数値を示します。

(8)message変数情報（message指定時）

-detail未指定時

ProcessID,VariableName,
VariableValue
PI識別子,変数定義名,
変数値
PI識別子,変数定義名,
変数値
　：

注

ProcessID（PI識別子）からVariableName（変数定義名）までは改行されないで表示され，VariableValue（変数値）は次行に表示されます。

-detail指定時

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,
ScopeDefinitionName,ScopeNumber,VariableName,
VariableValue
PI識別子,ビジネスプロセス定義名,ビジネスプロセス定義バージョン,
SC定義名,SCI識別番号,変数定義名,
変数値
PI識別子,ビジネスプロセス定義名,ビジネスプロセス定義バージョン,
SC定義名,SCI識別番号,変数定義名,
変数値
　：

注

ProcessID（PI識別子）からVariableName（変数定義名）までは改行されないで表示され，VariableValue（変数値）は次行に表示されます。

説明

CSCBP_<クラスタ名>_MSG_VARIABLEテーブルの1レコードの情報を次の表に示します。情報の詳細については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「付録C　データベースのテーブルの情報」を参照してください。

表示項目

内容

説明

ProcessID

PI識別子

プロセスインスタンスの識別子を示します。

ProcessDefinitionName

ビジネスプロセス定義名

ビジネスプロセス定義名を示します。

ProcessDefinitionVersion

ビジネスプロセス定義バージョン

ビジネスプロセス定義バージョンを示します。

ScopeDefinitionName

SC定義名

スコープ定義名を示します。

ScopeNumber

SCI識別番号

スコープインスタンスの識別番号を示します。

VariableName

変数定義名

変数定義名を示します。

VariableValue

変数値

変数値を示します。

(9)メッセージ関連情報（relation指定時）

-detail未指定時

MessageID,ProcessID,ActivityNumber,SendOrReceive
MSG識別子,PI識別子,ACI識別番号,送受信フラグ
MSG識別子,PI識別子,ACI識別番号,送受信フラグ
　：

-detail指定時

MessageID,ProcessID,ActivityNumber,SendOrReceive,AsynchronousMessagingID
MSG識別子,PI識別子,ACI識別番号,送受信フラグ,ID
MSG識別子,PI識別子,ACI識別番号,送受信フラグ,ID
　：

注

MessageID（MSG識別子）からAsynchronousMessagingID（ID）までは改行されないで表示されます。

説明

CSCBP_<クラスタ名>_MSG_RELATIONテーブルの1レコードの情報を次の表に示します。情報の詳細については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「付録C　データベースのテーブルの情報」を参照してください。

表示項目

内容

説明

MessageID

MSG識別子

メッセージの識別子を示します。

ProcessID

PI識別子

プロセスインスタンスの識別子を示します。

ActivityNumber

ACI識別番号

アクティビティインスタンスの識別番号を示します。

SendOrReceive

送受信フラグ

メッセージの送受信フラグを示します。

AsynchronousMessagingID

ID

Reliable Messagingを使用した非同期メッセージのIDを示します。

(10)カウント表示

KEOS52029-I: row count is 行のカウント数

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

2

通信タイムアウトが発生しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

10

指定された中断時間を超過したため，処理を中断しました。

注意事項

コメント行などは記載しないでください。

このコマンドはSQLのwhere句をオプションに指定します。そのため，使用するユーザIDおよびパスワードを定期的に変更するなどして，第三者に不当にコマンドを実行されないようにしてください。

データベースを使用する場合だけ，このコマンドを使用できます。

次のオプションをすべて指定しない場合は，where句の指定がないと仮定されます。

-whereオプション

-wherefileオプション

-processnameオプション

-dateオプション

-statusオプション

cscprecache（フォーマット定義およびデータ変換定義の事前キャッシュ）

形式

cscprecache [-h]
             -user <ログインユーザID>
             -pass <ログインパスワード>
             -csc <HCSCサーバ名>
            [-name <サービスID>]

機能

本番運用に入る前に，HCSCコンポーネントで定義したすべてのフォーマット定義およびデータ変換定義を解析して，HCSCサーバ上にキャッシュさせます。これによって，リクエスト処理の性能向上を図ります。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。複数のコンポーネントに解析要求を送信する場合の最大スレッド数は，HCSC-Manager定義ファイル（cscmng.properties）のプロパティに値を定義することで設定できます。また，各コンポーネントでの事前キャッシュ処理のタイムアウト時間は，HCSCサーバランタイム定義ファイル（cscsvconfig.properties）のプロパティに値を定義することで設定できます。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.3.22　ビジネスプロセスの定義情報をキャッシュする」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

解析要求を送信するHCSCサーバ名を指定します。

-name <サービスID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

解析要求を送信するサービス名を指定します。

入力例

(1)HCSCサーバ内のすべてのコンポーネントを解析する場合

cscprecache -csc <HCSCサーバ名>

(2)特定のコンポーネントだけ解析する場合

cscprecache -csc <HCSCサーバ名> -name <サービスID>

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

このコマンドをサービスアダプタまたはユーザ定義受付に対して実行するとエラーになります。

コマンドの実行前に，HCSCサーバランタイム定義ファイルのformatdef-maxcache-numプロパティおよびtransformdef-maxcache-numプロパティのキャッシュ上限値が，フォーマット定義およびデータ変換定義の設定数より大きいことを確認してください。フォーマット定義およびデータ変換定義の設定数より小さい場合はキャッシュが削除されるため，性能向上が図れないことがあります。

cscrcptnstart（標準受付およびユーザ定義受付の開始）

形式

cscrcptnstart [-h]
              -user <ログインユーザID>
              -pass <ログインパスワード>
              {-csc <HCSCサーバ名>｜-cluster <クラスタ名>}
              [{-standard｜-userdef}]
              [-nogc]

機能

受付（標準受付およびユーザ定義受付）を開始します。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，目的にあわせてマニュアル「サービスプラットフォーム システム構築・運用ガイド」の次に示す個所を参照してください。

「5.3.9　ユーザ定義受付を開始する」

「5.3.10　標準受付を開始する」

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

受付を開始するHCSCサーバ名を指定します。

-cluster <クラスタ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

受付を一括開始するクラスタ名を指定します。クラスタ種別がHAのときに-clusterを指定するとエラーになります。

-standard

標準受付だけを起動します。-standard，-userdefともに指定しない場合は，受付をすべて起動します。

-userdef

ユーザ定義受付をすべて起動します。個別のユーザ定義受付を起動する場合は，csccompostartコマンドで起動してください。-standard，-userdefともに指定しない場合は，受付をすべて起動します。

-nogc

FullGCを発生させないで受付を起動します。ただし，このオプションを指定しても，JavaVMが自動的に発生させるFullGCや，J2EEサーバの異常処理で発行されるFullGCは抑止されません。

HCSCコンポーネント開始時に明示的にFullGCを発生させる場合は，javagcコマンドを実行してください。javagcコマンドについては，マニュアル「アプリケーションサーバ リファレンス コマンド編」の「javagc（GCの強制発生）」を参照してください。

入力例

(1)HCSCサーバ「HCSC」の受付を開始する場合

cscrcptnstart -user admin -pass admin -csc HCSC

(2)クラスタ「Cluster」下にあるHCSCサーバごとに標準受付を一括開始する場合

cscrcptnstart -user admin -pass admin -cluster Cluster -standard

(3)FullGCを発生させないで，HCSCサーバ「CSCSrv1」下にある受付を一括開始する場合

cscrcptnstart -user admin -pass admin -csc CSCSrv1 -nogc

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

2

通信タイムアウトが発生しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

このコマンドは停止状態の受付に対して実行してください。

コマンド実行時にHCSCサーバは起動している必要があります。

-clusterを指定してエラーになった場合，結果をcscstatusコマンドで確認し，障害要因を取り除いたあとに，再度コマンドを実行してください。

このコマンドを複数のクライアントから1つのHCSCサーバに対して同時に実行すると，処理エラー（排他エラー，またはコンポーネントへの操作重複による異常終了）となるおそれがあります。エラーが発生した場合は，コマンドを再実行してください。

cscrcptnstop（標準受付およびユーザ定義受付の停止）

形式

cscrcptnstop [-h]
             -user <ログインユーザID>
             -pass <ログインパスワード>
             {-csc <HCSCサーバ名>｜-cluster <クラスタ名>}
             [{-standard｜-userdef}]
             [-stopfg {normal｜wait｜force}]
             [-nogc]

機能

受付（標準受付およびユーザ定義受付）を停止します。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，目的にあわせてマニュアル「サービスプラットフォーム システム構築・運用ガイド」の次に示す個所を参照してください。

「5.3.35　標準受付を停止する」

「5.3.36　ユーザ定義受付を停止する」

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

受付を停止するHCSCサーバ名を指定します。

-cluster <クラスタ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

受付を一括停止するクラスタ名を指定します。クラスタ種別がHAのときに-clusterを指定するとエラーになります。

-standard

標準受付だけを停止します。-standard，-userdefともに指定しない場合は，受付をすべて停止します。

-userdef

ユーザ定義受付をすべて停止します。個別のユーザ定義受付を停止する場合は，csccompostopコマンドで停止してください。-standard，-userdefともに指定しない場合は，受付をすべて停止します。

-stopfg {normal｜wait｜force}

標準受付の停止オプションを指定します。-userdefオプションを指定した場合，この定義は無視されます。デフォルトはnormalです。

normal

通常停止の場合に指定します。

wait

計画停止の場合に指定します。

force

強制停止の場合に指定します。

-nogc

FullGCを発生させないで受付を停止します。ただし，このオプションを指定しても，JavaVMが自動的に発生させるFullGCは抑止されません。

入力例

(1)HCSCサーバ「HCSC」の受付を停止する場合

cscrcptnstop -user admin -pass admin -csc HCSC

(2)クラスタ「Cluster」下にあるHCSCサーバごとに，受付を一括停止する場合

cscrcptnstop -user admin -pass admin -cluster Cluster

(3)FullGCを発生させないで，HCSCサーバ「CSCSrv1」下にある受付を一括停止する場合

cscrcptnstop -user admin -pass admin -csc CSCSrv1 -nogc

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

2

通信タイムアウトが発生しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

このコマンドは開始状態の受付に対して実行してください。

コマンド実行時にHCSCサーバは起動している必要があります。

-clusterを指定してエラーになった場合，結果をcscstatusコマンドで確認し，障害要因を取り除いたあとに，再度コマンドを実行してください。

このコマンドを複数のクライアントから1つのHCSCサーバに対して同時に実行すると，処理エラー（排他エラー，またはコンポーネントへの操作重複による異常終了）となるおそれがあります。エラーが発生した場合は，コマンドを再実行してください。

cscrepcheck（インポート可否の検証）

形式

cscrepcheck [-h]
            -user <ログインユーザID>
            -pass <ログインパスワード>
            -repfile <リポジトリZIPファイル名>
            [-compo [-name ｛<サービスID>｜ユーザ定義受付（呼出先選択）の<受付ID>｝] ]

機能

指定されたリポジトリZIPファイル名のインポート可否を検証します。インポート不可と検証された場合は，エラーメッセージで原因を出力します。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「4.6　コンポーネント単位でのリポジトリの追加，更新，および削除」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-repfile <リポジトリZIPファイル名>　〜 ((1−200バイト))

インポート可否の検証対象となるリポジトリZIPファイルを絶対パスまたは相対パスで指定します。

-compo

リポジトリのコンポーネント単位でのインポートができるかを検証する場合に指定します。

指定を省略した場合，リポジトリZIPファイル全体のインポートが検証の対象となります。

-name ｛<サービスID>｜<ユーザ定義受付（呼出先選択）の受付ID>｝　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

検証の対象とするHCSCコンポーネントを次のどちらかで指定します。

<サービスID>

ビジネスプロセスまたはサービスアダプタのサービスIDを指定します。

<ユーザ定義受付（呼出先選択）の受付ID>

ユーザ定義受付（呼出先選択）の受付IDを指定します。

指定を省略した場合，リポジトリZIPファイル内のすべてのHCSCコンポーネントが検証の対象となります。

入力例

(1)リポジトリZIPファイル「repository.zip」のインポート可否を検証する場合

cscrepcheck -user admin -pass admin -repfile repository.zip

(2)リポジトリZIPファイル「repository.zip」のコンポーネント単位でのインポート可否を検証する場合

cscrepcheck -user admin -pass admin -repfile repository.zip -compo

(3)リポジトリZIPファイル「repository.zip」内のサービスID「1」のHCSCコンポーネントを対象に，インポート可否を検証する場合

cscrepcheck -user admin -pass admin -repfile repository.zip -compo -name 1

(4)リポジトリZIPファイル「repository.zip」内の受付ID「2」のHCSCコンポーネントを対象に，インポート可否を検証する場合

cscrepcheck -user admin -pass admin -repfile repository.zip -compo -name 2

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

現在の運用環境のリポジトリ情報とインポートするリポジトリ情報で，データベースおよびReliable Messagingを使用するかどうかの設定が異なる場合，インポート時にエラーになることがあります。

現在の運用環境のリポジトリ情報と，インポートするリポジトリ情報のSOAPモードが異なる場合，インポート時にエラーになります。

リポジトリ内に複数のクラスタ環境がある場合，エラーになります。

cscrepctl（インポート/エクスポート）

形式

cscrepctl [-h]
          -user <ログインユーザID>
          -pass <ログインパスワード>
        ｛-import <ファイル名> [-overwrite]
          [｛-check｜-compo
            [｛-name ｛<サービスID>｜<ユーザ定義受付（呼出先選択）の受付ID>｝
             ｜-namelist <HCSCコンポーネント指定ファイル名>｝]
            [-nouoc] ｝]
             ｜-export <ファイル名>
             ｜-autoexport
             ｜-delete ｛-name ｛<サービスID>｜<ユーザ定義受付（呼出先選択）の受付ID>｝
             ｜-namelist <HCSCコンポーネント指定ファイル名>｝｝

機能

リポジトリ内の情報をZIP形式ファイルに出力したり，ZIP形式で保存された情報をリポジトリに展開したりします。また，リポジトリ内のコンポーネントの削除もできます。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，目的にあわせてマニュアル「サービスプラットフォーム システム構築・運用ガイド」の次に示す個所を参照してください。

「4.2　リポジトリのエクスポート」

「4.3　リポジトリのインポート」

「4.6　コンポーネント単位でのリポジトリの追加，更新，および削除」

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-import <ファイル名>　〜 ((1−200バイト))

展開するZIP形式ファイルを絶対パス，または相対パスで指定します。

-overwrite

インポート時にZIP形式で保存されたHCSCコンポーネントを運用環境のリポジトリに展開します。このオプションは，-import指定時に有効になります。

-overwriteオプションを指定した場合は，変更されていないHCSCコンポーネントを含め，ZIP形式ファイルに保存されたHCSCコンポーネントのすべてを運用環境のリポジトリに展開します。

-overwriteオプションを省略した場合は，ZIP形式ファイルに保存されたHCSCコンポーネントのうち変更されたHCSCコンポーネントだけが，ZIP形式ファイルから運用環境のリポジトリに展開されます。このとき，変更のないHCSCコンポーネントは，現在ある運用環境のリポジトリのHCSCコンポーネントをそのまま使用します。

-check

現在の運用環境のリポジトリ情報とインポートするリポジトリ情報で，HCSCサーバの構成情報が同じかどうかをチェックします。HCSCサーバの構成情報が異なる場合は，エラーになります。このオプションは，-import指定時に有効になります。なお，標準インポートの場合は，このオプションを指定しないでください。

-compo

コンポーネント単位でインポートします。

-name ｛<サービスID>｜<ユーザ定義受付（呼出先選択）の受付ID>｝　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

インポートまたは削除の対象を次のどちらかで指定します。

<サービスID>

ビジネスプロセスまたはサービスアダプタのサービスIDを指定します。

<ユーザ定義受付（呼出先選択）の受付ID>

ユーザ定義受付（呼出先選択）の受付IDを指定します。

-compoオプションの指定時にこのオプションを省略した場合，すべてのHCSCコンポーネントがインポートの対象となります。

-namelist <HCSCコンポーネント指定ファイル名>　〜((1−200バイト))

インポートまたは削除するHCSCコンポーネントをHCSCコンポーネント指定ファイルで指定します。

絶対パスまたは相対パスで指定します。ファイルが存在しない場合は異常終了します。HCSCコンポーネント指定ファイルについては，「6.5.5　HCSCコンポーネント指定ファイル」を参照してください。

なお，指定されたHCSCコンポーネントの実行順序に決まりはありません。

-nouoc

コンポーネント単位でのインポート時にUOCを更新しない場合に指定します。UOCとは，開発環境のHCSCTEプロジェクト内でユーザが独自に作成したソース，クラスおよびライブラリを示します。

このオプションは-compoオプションの指定時だけ指定できます。

-export <ファイル名>　〜 ((1−200バイト))

出力するZIP形式ファイルのファイル名を絶対パス，または相対パスで指定します。指定したファイルまでのディレクトリがない場合，異常終了になります。指定したファイルがすでにある場合，上書きされます。指定したファイルの拡張子を「.zip」にしなかった場合は，「.zip」が付けられます。

-autoexport

ZIPファイルをデフォルトファイル名で出力する場合に指定します。デフォルトファイル名は，次の形式で付与されます。

IPv4の場合：aaabbbcccddd_YYYYMMDDhhmmss.zip

IPv6の場合：aaaabbbbccccddddeeeeffffgggghhhh_YYYYMMDDhhmmss.zip

aaabbbcccddd：

コマンドを実行したマシンのIPv4アドレスを示します。

aaaabbbbccccddddeeeeffffgggghhhh：

コマンドを実行したマシンのIPv6アドレスを示します。

YYYYMMDDhhmmss：

バックアップした時間を示します。

YYYY：西暦年，MM：月，DD：日，hh：時，mm：分，ss：秒

出力先はcscmng.properties（HCSC-Manager定義ファイル）に指定できます。出力先を指定しなかった場合はカレントディレクトリに出力されます。

-delete

運用環境のリポジトリから，指定されたサービスIDのコンポーネントを削除します。このオプションの後ろに，削除対象のサービスIDを-nameオプションまたは-namelistオプションで指定してください。

このオプションを指定してサービスを削除すると，ほかのビジネスプロセスから呼び出されるサービスも削除されます。そのため，削除するサービスは適切に選択してください。

入力例

(1)repository.zipの内容をリポジトリに展開する場合

cscrepctl -user admin -pass admin -import repository.zip

(2)カレントディレクトリにリポジトリ情報を収集したrepository.zipを出力する場合

cscrepctl -user admin -pass admin -export repository.zip

(3)デフォルトファイル名で出力する場合

cscrepctl -user admin -pass admin -autoexport

(4)repository.zipの内容をコンポーネント単位でインポートする場合

cscrepctl -user admin -pass admin -import repository.zip -compo

(5)サービスID，またはユーザ定義受付（呼出先選択）の受付IDが1のHCSCコンポーネントをインポートする場合

cscrepctl -user admin -pass admin -import repository.zip -compo -name 1

(6)repository.zipの内容のうちHCSCコンポーネント指定ファイルhcsccomponent.txtに指定されているすべてのHCSCコンポーネントをインポートする場合

cscrepctl -user admin -pass admin -import repository.zip -compo -namelist hcsccomponent.txt

(7)サービスID，またはユーザ定義受付（呼出先選択）の受付IDが1のHCSCコンポーネントを削除する場合

cscrepctl -user admin -pass admin -delete -name 1

(8)HCSCコンポーネント指定ファイルhcsccomponent.txtに指定されているHCSCコンポーネントをすべて削除する場合

cscrepctl -user admin -pass admin -delete -namelist hcsccomponent.txt

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

運用環境にログイン中の場合は，このコマンドを実行できません。

インポートする場合は，必ずリポジトリに設定したディレクトリ以下のディレクトリおよびファイルを参照していないことを確認してから，cscrepctlコマンドを実行してください。

現在の運用環境のリポジトリ情報とインポートするリポジトリ情報で，データベースおよびReliable Messagingを使用するかどうかの設定が異なる場合，インポート時にエラーになることがあります。

現在の運用環境のリポジトリ情報と，インポートするリポジトリ情報のSOAPモードが異なる場合，インポート時にエラーになります。

cscrepdiff（リポジトリ情報の差分の表示）

形式

cscrepdiff [-h]
           -user <ログインユーザID>
           -pass <ログインパスワード>
           -repfile <エクスポートされたリポジトリZIPファイル名>
           [-allinfo]
           [｛-check
            ｜-compo [-name ｛<サービスID>｜<ユーザ定義受付（呼出先選択）の受付ID>｝ ] ｝]
           [-listfile <出力先のHCSCコンポーネント指定ファイル名>]

機能

現在の運用環境のリポジトリ情報と，指定されたリポジトリ情報とのHCSCコンポーネントの差分を出力します。このコマンドは，次に示すリポジトリ情報の項目が同じ場合，同じHCSCコンポーネントと見なして差分を表示します。

サービスアダプタのサービスID

ビジネスプロセスのサービスID

ユーザ定義受付の受付ID

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「4.5　リポジトリの差分情報の参照」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-repfile <エクスポートされたリポジトリZIPファイル名>　〜 ((1−200バイト))

エクスポートされた差分表示の対象となるZIPファイル名を絶対パス，または相対パスで指定します。

-allinfo

すべてのHCSCコンポーネントの変更情報を表示します。インポート後のHCSCコンポーネントがすべて表示されるため，リポジトリ内にHCSCコンポーネントが多いと，大量に表示される場合があります。

このオプションを省略した場合，差分が発生したHCSCコンポーネントだけが表示されます。

-check

現在の運用環境のリポジトリ情報と比較対象のリポジトリ情報で，HCSCサーバの構成情報が同じかどうかをチェックします。HCSCサーバの構成情報が異なる場合は，エラーになります。なお，標準インポートの場合は，このオプションを指定しないでください。

-compo

コンポーネント単位でインポートする場合の，HCSCコンポーネントの差分情報を表示します。

-name ｛<サービスID>｜<ユーザ定義受付（呼出先選択）の受付ID>｝　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

コンポーネント単位でインポートする場合に，ZIPファイル中のHCSCコンポーネントの種類を次のどちらかで指定します。

<サービスID>

ビジネスプロセスまたはサービスアダプタのサービスIDを指定します。

<ユーザ定義受付（呼出先選択）の受付ID>

ユーザ定義受付（呼出先選択）の受付IDを指定します。

このオプションは，-compoオプションを指定した場合に指定できます。

このオプションを省略した場合は，ZIPファイル中のすべてのHCSCコンポーネントがコンポーネント単位のインポートの対象となります。

-listfile <出力先のHCSCコンポーネント指定ファイル名>　〜((1−200バイト))

指定したファイルへ，HCSCコンポーネントの差分情報と変更種別を出力します。絶対パスまたは相対パスで指定します。パスが存在しない場合は異常終了します。

出力形式はHCSCコンポーネント指定ファイルと同じです。HCSCコンポーネント指定ファイルの記述形式については，「6.5.5　HCSCコンポーネント指定ファイル」を参照してください。

出力形式

-listfileオプションを指定した場合の，HCSCコンポーネント指定ファイルの出力形式を示します。

(1)すべての項目で変更があるリポジトリをファイルに出力する場合（-listfileオプション指定時）

(2)すべての項目で変更があるリポジトリをコンポーネント単位でファイルに出力する場合（-compo，-listfileオプション指定時）

(3)変更がある項目と変更がない項目が混在するリポジトリをファイルに出力する場合（-allinfo，-listfileオプション指定時）

表示形式

表示形式の記号の意味は次のとおりです。

<：現在のリポジトリ情報に存在するHCSCコンポーネント

>：指定したZIPファイルのリポジトリ情報に存在するHCSCコンポーネント

(1)すべての項目で変更がある場合

(2)ユーザ定義受付（呼出先選択）だけ変更がある場合

(3)ビジネスプロセスだけ変更がある場合

(4)変更がない場合（-allinfoオプション省略時）

(5)すべての項目で変更があるが，項目内に変更がないコンポーネントが含まれる場合（-allinfoオプション指定時）

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

現在の運用環境のリポジトリ情報と比較対象のリポジトリ情報で，データベースおよびReliable Messagingを使用するかどうかの設定が異なる場合，コマンド実行時にエラーになることがあります。

現在の運用環境のリポジトリ情報と，比較対象のリポジトリ情報のSOAPモードが異なる場合，コマンド実行時にエラーになります。

cscrepls（リポジトリ情報の表示）

形式

cscrepls [-h]
         -user <ログインユーザID>
         -pass <ログインパスワード>
         [{-repfile <エクスポートされたリポジトリZIPファイル名>
           ｜-envbackfile <HCSC-Manager環境バックアップファイル名>}]
         [{-csc <HCSCサーバ名>｜-oldtype｜-private}]
         [-listfile <出力先のHCSCコンポーネント指定ファイル名>]

機能

リポジトリ情報を標準出力に出力します。これによって，cscutilコマンドの引数に指定する値を確認できます。また，リポジトリに含まれるすべてのHCSCコンポーネントの一覧をファイルへ出力します。

HCSCコンポーネントのリポジトリ情報の出力順は次のとおりです。存在しないHCSCコンポーネントの情報は出力されません。

ユーザ定義受付（呼出先選択）

ビジネスプロセスまたはユーザ定義受付（呼出先固定）

サービスアダプタ

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「4.4　リポジトリの情報の参照」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-repfile <エクスポートされたリポジトリZIPファイル名>　〜((1−200バイト))

エクスポートされたリポジトリZIPファイル名を絶対パス，または相対パスで指定します。エクスポートされたリポジトリファイルの中を参照し，構成情報が出力されます。-envbackfileとは同時に指定できません。

-envbackfile <HCSC-Manager環境バックアップファイル名>　〜((1−200バイト))

HCSC-Manager環境バックアップファイル名を絶対パス，または相対パスで指定します。エクスポートされたリポジトリファイルの中を参照し，構成情報が出力されます。-repfileとは同時に指定できません。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

指定したHCSCサーバ情報だけが出力されます。

-oldtype

バージョン07-20以前の情報が出力されます。

-private

リポジトリ，またはリポジトリファイルに存在する，非公開コンポーネントを含めた情報を表示する場合に指定します。

-listfile <出力先のHCSCコンポーネント指定ファイル名>　〜((1−200バイト))

指定したファイルへ，リポジトリに含まれるすべてのHCSCコンポーネントの一覧を出力します。絶対パスまたは相対パスで指定します。パスが存在しない場合は異常終了します。

出力形式はHCSCコンポーネント指定ファイルと同じですが，変更種別は出力されません。HCSCコンポーネント指定ファイルの記述形式については，「6.5.5　HCSCコンポーネント指定ファイル」を参照してください。

出力形式

-listfileオプションを指定した場合の，HCSCコンポーネント指定ファイルの出力形式を示します。

#Command Edit Time:コマンド発行時間

#Cluster Name:クラスタ名
#HCSC-Server Name:HCSCサーバ名
#UserDefinedReception
ユーザ定義受付（呼出先選択）の受付ID
#BusinessProcess
ビジネスプロセスのサービスID
#UserDefinedReception
ユーザ定義受付（呼出先固定）の受付ID
#BusinessProcess
ビジネスプロセスのサービスID
#UserDefinedReception
ユーザ定義受付（呼出先固定）の受付ID
#ServiceAdapter
サービスアダプタのサービスID

#HCSC-Server Name:HCSCサーバ名
#UserDefinedReception
ユーザ定義受付（呼出先選択）の受付ID
#BusinessProcess
ビジネスプロセスのサービスID
#UserDefinedReception
ユーザ定義受付（呼出先固定）の受付ID
#BusinessProcess
ビジネスプロセスのサービスID
#UserDefinedReception
ユーザ定義受付（呼出先固定）の受付ID
#ServiceAdapter
サービスアダプタのサービスID

#Cluster Name:クラスタ名
#HCSC-Server Name:HCSCサーバ名
#BusinessProcess
ビジネスプロセスのサービスID
#UserDefinedReception
ユーザ定義受付（呼出先固定）の受付ID
#BusinessProcess
ビジネスプロセスのサービスID
#UserDefinedReception
ユーザ定義受付（呼出先固定）の受付ID
#ServiceAdapter
サービスアダプタのサービスID

説明

表示項目

説明

#Command Edit Time

コマンド発行時間を示します。

java.text.SimpleDateFormatで定義されているフォーマットに，YYYY/MM/DD hh:mm:ss.SSSの形式で出力されます。

YYYY：西暦年

MM：月

DD：日

hh：時

mm：分

ss：秒

SSS：ミリ秒

#Cluster Name

クラスタ名を示します。

#HCSC-Server Name

HCSCサーバ名を示します。

#UserDefinedReception

ユーザ定義受付（呼出先選択）または，ユーザ定義受付（呼出先固定）の受付IDを示します。

#BusinessProcess

ビジネスプロセスのサービスIDを示します。

#ServiceAdapter

サービスアダプタのサービスIDを示します。

表示形式

(1)-cscオプションでHCSCサーバを指定しない場合

Command Edit Time:コマンド発行時間
Domain(name:ドメイン名)
- Cluster(name:クラスタ名)
    cluster-display-name:クラスタ表示名
    cluster-type:クラスタ種別
    db-use:データベースの使用有無
    rm-use:Reliable Messagingの使用有無
    SOAP-mode:使用するSOAPモード
  - HCSC-Server(CSCSrvName:HCSCサーバ名)
      display-name:HCSCサーバ表示名
      J2EESrvName:J2EEサーバ名
      RMSystemName:RMシステム名
      Cosminexus Manager(Manager名, ManagerのホストIPアドレス:Managerのポート番号)
    - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先選択）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:受付配備状態
          modified-time:ユーザ定義受付（呼出先選択）が更新された時間
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        deployed:ビジネスプロセス配備状態
        modified-time:ビジネスプロセスが更新された時間
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:受付配備状態
          modified-time:ユーザ定義受付（呼出先固定）が更新された時間
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        deployed:ビジネスプロセス配備状態
        modified-time:ビジネスプロセスが更新された時間
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:受付配備状態
          modified-time:ユーザ定義受付（呼出先固定）が更新された時間
    - ServiceAdapter(ServiceID:サービスアダプタのサービスID)
        ServiceName:アダプタ表示名
        deployed:アダプタ配備状態
        modified-time:サービスアダプタが更新された時間
  - HCSC-Server(CSCSrvName:HCSCサーバ名)
      display-name:HCSCサーバ表示名
      J2EESrvName:J2EEサーバ名
      RMSystemName:RMシステム名
      Cosminexus Manager(Manager名, ManagerのホストIPアドレス:Managerのポート番号)
    - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先選択）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:受付配備状態
          modified-time:ユーザ定義受付（呼出先選択）が更新された時間
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        deployed:ビジネスプロセス配備状態
        modified-time:ビジネスプロセスが更新された時間
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:受付配備状態
          modified-time:ユーザ定義受付（呼出先固定）が更新された時間
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        deployed:ビジネスプロセス配備状態
        modified-time:ビジネスプロセスが更新された時間
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:受付配備状態
          modified-time:ユーザ定義受付（呼出先固定）が更新された時間
    - ServiceAdapter(ServiceID:サービスアダプタ名)
        ServiceName:アダプタ表示名
        Type:アダプタ種別
        deployed:アダプタ配備状態
        modified-time:サービスアダプタが更新された時間
- Cluster(name:クラスタ名)
    cluster-display-name:クラスタ表示名
    cluster-type:クラスタ種別
    db-use:データベースの使用有無
    rm-use:Reliable Messagingの使用有無
    SOAP-mode:使用するSOAPモード
  - HCSC-Server(CSCSrvName:HCSCサーバ名)
      display-name:HCSCサーバ表示名
      J2EESrvName:J2EEサーバ名
      RMSystemName:RMシステム名
      Cosminexus Manager(Manager名, ManagerのホストIPアドレス:Managerのポート番号)
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        deployed:ビジネスプロセス配備状態
        modified-time:ビジネスプロセスが更新された時間
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:受付配備状態
          modified-time:ユーザ定義受付（呼出先固定）が更新された時間
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        deployed:ビジネスプロセス配備状態
        modified-time:ビジネスプロセスが更新された時間
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:受付配備状態
          modified-time:ユーザ定義受付（呼出先固定）が更新された時間
    - ServiceAdapter(ServiceID:サービスアダプタのサービスID)
        ServiceName:アダプタ表示名
        Type:アダプタ種別
        deployed:アダプタ配備状態
        modified-time:サービスアダプタが更新された時間

(2)-cscオプションでHCSCサーバを指定した場合

Command Edit Time:コマンド発行時間
Domain(name:ドメイン名)
- Cluster(name:クラスタ名)
    cluster-display-name:クラスタ表示名
    cluster-type:クラスタ種別
    db-use:データベースの使用有無
    rm-use:Reliable Messagingの使用有無
    SOAP-mode:使用するSOAPモード
  - HCSC-Server(CSCSrvName:HCSCサーバ名)
      display-name:HCSCサーバ表示名
      J2EESrvName:J2EEサーバ名
      RMSystemName:RMシステム名
      Cosminexus Manager(Manager名, ManagerのホストIPアドレス:Managerのポート番号)
    - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先選択）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:受付配備状態
          modified-time:ユーザ定義受付（呼出先選択）が更新された時間
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        deployed:ビジネスプロセス配備状態
        modified-time:ビジネスプロセスが更新された時間
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:受付配備状態
          modified-time:ユーザ定義受付（呼出先固定）が更新された時間
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        deployed:ビジネスプロセス配備状態
        modified-time:ビジネスプロセスが更新された時間
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:受付配備状態
          modified-time:ユーザ定義受付（呼出先固定）が更新された時間
    - ServiceAdapter(ServiceID:サービスアダプタのサービスID)
        ServiceName:アダプタ表示名
        Type:アダプタ種別
        deployed:アダプタ配備状態
        modified-time:サービスアダプタが更新された時間

(3)-oldtypeオプションを指定した場合

Command Edit Time:コマンド発行時間
Domain(name:ドメイン名)
- Cosminexus Manager(name:Manager名)
    display-name:Manager表示名
    management-ip:ManagerのホストIPアドレス
    port:Managerのポート番号
  - HCSC-Server(CSCSrvName:HCSCサーバ名)
      display-name:HCSCサーバ表示名
      cluster-name:クラスタ名
      cluster-display-name:クラスタ表示名
      cluster-type:クラスタ種別
      J2EESrvName:J2EEサーバ名
    - SessionBean
        Url:同期サービス（SessionBean）呼び出し時に使用するURL
        LookupName:同期サービス（SessionBean）呼び出し時に使用するルックアップ名
    - WebService(SOAP1.1)
        Url:同期サービス（Webサービス・SOAP1.1）呼び出し時に使用するURL
    - WebService(SOAP1.2)
        Url:同期サービス（Webサービス・SOAP1.2）呼び出し時に使用するURL
    - MDB(WS-R)
        Url:非同期サービス（MDB（WS-R））呼び出し時に使用するURL
    - MDB(DBQueue)
        Name:DBキュー名
    - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先選択）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:受付配備状態
          modified-time:ユーザ定義受付（呼出先選択）が更新された時間
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        deployed:ビジネスプロセス配備状態
        modified-time:ビジネスプロセスが更新された時間
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:受付配備状態
          modified-time:ユーザ定義受付（呼出先固定）が更新された時間
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        deployed:ビジネスプロセス配備状態
        modified-time:ビジネスプロセスが更新された時間
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:受付配備状態
          modified-time:ユーザ定義受付（呼出先固定）が更新された時間
    - ServiceAdapter(ServiceID:サービスアダプタのサービスID)
        ServiceName:アダプタ表示名
        Type:アダプタ種別
        deployed:アダプタ配備状態
        modified-time:サービスアダプタが更新された時間
  - HCSC-Server(CSCSrvName:HCSCサーバ名)
      display-name:HCSCサーバ表示名
      cluster-name:クラスタ名
      cluster-display-name:クラスタ表示名
      cluster-type:クラスタ種別
      J2EESrvName:J2EEサーバ名
    - SessionBean
        Url:同期サービス（SessionBean）呼び出し時に使用するURL
        LookupName:同期サービス（SessionBean）呼び出し時に使用するルックアップ名
    - WebService(SOAP1.1)
        Url:同期サービス（Webサービス・SOAP1.1）呼び出し時に使用するURL
    - WebService(SOAP1.2)
        Url:同期サービス（Webサービス・SOAP1.2）呼び出し時に使用するURL
    - MDB(WS-R)
        Url:非同期サービス（MDB（WS-R））呼び出し時に使用するURL
    - MDB(DBQueue)
        Name:DBキュー名
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        deployed:ビジネスプロセス配備状態
        modified-time:ビジネスプロセスが更新された時間
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:受付配備状態
          modified-time:ユーザ定義受付（呼出先固定）が更新された時間
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        deployed:ビジネスプロセス配備状態
        modified-time:ビジネスプロセスが更新された時間
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:受付配備状態
          modified-time:ユーザ定義受付（呼出先固定）が更新された時間
- Cosminexus Manager(name:Manager名)
    display-name:Manager表示名
    management-ip:ManagerのホストIPアドレス
    port:Managerのポート番号
  - HCSC-Server(CSCSrvName:HCSCサーバ名)
      display-name:HCSCサーバ表示名
      cluster-name:クラスタ名
      cluster-display-name:クラスタ表示名
      cluster-type:クラスタ種別
      J2EESrvName:J2EEサーバ名
    - SessionBean
        Url:同期サービス（SessionBean）呼び出し時に使用するURL
        LookupName:同期サービス（SessionBean）呼び出し時に使用するルックアップ名
    - WebService(SOAP1.1)
        Url:同期サービス（Webサービス・SOAP1.1）呼び出し時に使用するURL
    - WebService(SOAP1.2)
        Url:同期サービス（Webサービス・SOAP1.2）呼び出し時に使用するURL
    - MDB(WS-R)
        Url:非同期サービス（MDB（WS-R））呼び出し時に使用するURL
    - MDB(DBQueue)
        Name:DBキュー名
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        deployed:ビジネスプロセス配備状態
        modified-time:ビジネスプロセスが更新された時間
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:受付配備状態
          modified-time:ユーザ定義受付（呼出先固定）が更新された時間
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        deployed:ビジネスプロセス配備状態
        modified-time:ビジネスプロセスが更新された時間
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:受付配備状態
          modified-time:ユーザ定義受付（呼出先固定）が更新された時間
  - HCSC-Server(CSCSrvName:HCSCサーバ名)
      display-name:HCSCサーバ表示名
      cluster-name:クラスタ名
      cluster-display-name:クラスタ表示名
      cluster-type:クラスタ種別
      J2EESrvName:J2EEサーバ名
    - SessionBean
        Url:同期サービス（SessionBean）呼び出し時に使用するURL
        LookupName:同期サービス（SessionBean）呼び出し時に使用するルックアップ名
    - WebService(SOAP1.1)
        Url:同期サービス（Webサービス・SOAP1.1）呼び出し時に使用するURL
    - WebService(SOAP1.2)
        Url:同期サービス（Webサービス・SOAP1.2）呼び出し時に使用するURL
    - MDB(WS-R)
        Url:非同期サービス（MDB（WS-R））呼び出し時に使用するURL
    - MDB(DBQueue)
        Name:DBキュー名
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        deployed:ビジネスプロセス配備状態
        modified-time:ビジネスプロセスが更新された時間
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        deployed:ビジネスプロセス配備状態
        modified-time:ビジネスプロセスが更新された時間
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:受付配備状態
          modified-time:ユーザ定義受付（呼出先固定）が更新された時間

(4)-privateオプションを指定した場合（下線部が非公開コンポーネントの情報）

Command Edit Time:コマンド発行時間
Domain(name:ドメイン名)
- Cluster(name:クラスタ名)
    cluster-display-name:クラスタ表示名
    cluster-type:クラスタ種別
    db-use:データベースの使用有無
    rm-use:Reliable Messagingの使用有無
    SOAP-mode:使用するSOAPモード
  - HCSC-Server(CSCSrvName:HCSCサーバ名)
      display-name:HCSCサーバ表示名
      J2EESrvName:J2EEサーバ名
      RMSystemName:RMシステム名
      Cosminexus Manager(Manager名, ManagerのホストIPアドレス:Managerのポート番号)
    - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先選択）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:受付配備状態
          modified-time:ユーザ定義受付（呼出先選択）が更新された時間
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        modified-time:ビジネスプロセスが更新された時間
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          modified-time:ユーザ定義受付（呼出先固定）が更新された時間
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        modified-time:ビジネスプロセスが更新された時間
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          modified-time:ユーザ定義受付（呼出先固定）が更新された時間
    - ServiceAdapter(ServiceID:サービスアダプタのサービスID)
        ServiceName:アダプタ表示名
        Type:アダプタ種別
        modified-time:サービスアダプタが更新された時間
  - HCSC-Server(CSCSrvName:HCSCサーバ名)
      display-name:HCSCサーバ表示名
      J2EESrvName:J2EEサーバ名
      RMSystemName:RMシステム名
      Cosminexus Manager(Manager名, ManagerのホストIPアドレス:Managerのポート番号)
    - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先選択）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:受付配備状態
          modified-time:ユーザ定義受付（呼出先選択）が更新された時間
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        modified-time:ビジネスプロセスが更新された時間
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          modified-time:ユーザ定義受付（呼出先固定）が更新された時間
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        modified-time:ビジネスプロセスが更新された時間
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          modified-time:ユーザ定義受付（呼出先固定）が更新された時間
    - ServiceAdapter(ServiceID:サービスアダプタのサービスID)
        ServiceName:アダプタ表示名
        Type:アダプタ種別
        deployed:アダプタ配備状態
        modified-time:サービスアダプタが更新された時間
- Cluster(name:クラスタ名)
    cluster-display-name:クラスタ表示名
    cluster-type:クラスタ種別
    db-use:データベースの使用有無
    rm-use:Reliable Messagingの使用有無
    SOAP-mode:使用するSOAPモード
  - HCSC-Server(CSCSrvName:HCSCサーバ名)
      display-name:HCSCサーバ表示名
      J2EESrvName:J2EEサーバ名
      RMSystemName:RMシステム名
      Cosminexus Manager(Manager名, ManagerのホストIPアドレス:Managerのポート番号)
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        deployed:アダプタ配備状態
        modified-time:ビジネスプロセスが更新された時間
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:アダプタ配備状態
          modified-time:ユーザ定義受付（呼出先固定）が更新された時間
    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
        deployed:アダプタ配備状態
        modified-time:ビジネスプロセスが更新された時間
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
          deployed:アダプタ配備状態
          modified-time:ユーザ定義受付（呼出先固定）が更新された時間
    - ServiceAdapter(ServiceID:サービスアダプタのサービスID)
        ServiceName:アダプタ表示名
        Type:アダプタ種別
        deployed:アダプタ配備状態
        modified-time:サービスアダプタが更新された時間
- PrivateComponents
    - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先選択）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート

    - BusinessProcess(ServiceID:ビジネスプロセスのサービスID)
        ServiceName:ビジネスプロセス表示名
      - UserDefinedReception(ReceptionID:ユーザ定義受付（呼出先固定）の受付ID)
          ReceptionName:受付名
          Type:受付種別
          ContextRoot:コンテキストルート
    - ServiceAdapter(ServiceID:サービスアダプタのサービスID)
        ServiceName:アダプタ表示名
        Type:アダプタ種別

説明（(1)-cscオプションでHCSCサーバを指定しない場合，および(2)-cscオプションでHCSCサーバを指定した場合）

表示項目

説明

Command Edit Time

コマンド発行時間を示します。

java.text.SimpleDateFormatで定義されているフォーマットに，YYYY/MM/DD hh:mm:ss.SSSの形式で出力されます。

YYYY：西暦年

MM：月

DD：日

hh：時

mm：分

ss：秒

SSS：ミリ秒

Domain（name）

ドメイン名を示します。

Cluster（name）

クラスタ名を示します。

cluster-display-name

クラスタ表示名を示します。※1

cluster-type

クラスタ種別を示します。次のどちらかが表示されます。

LB：ロードバランスクラスタ

HA：HAクラスタ

db-use

データベースを使用しているかどうかを示します。次のどちらかが表示されます。

ON：使用しています。

OFF：使用していません。

rm-use

Reliable Messagingを使用しているかどうかを示します。次のどちらかが表示されます。

ON：使用しています。

OFF：使用していません。

SOAP-mode

使用するSOAPモードを示します。次のどちらかが表示されます。

1.1：SOAP1.1モードを示します。

1.1/1.2：SOAP1.1/1.2併用モードを示します。

HCSC-Server（CSCSrvName）

HCSCサーバ名を示します。

display-name

HCSCサーバ表示名を示します。※1

J2EESrvName

J2EEサーバ名を示します。

RMSystemName

RMシステム名を示します。

Cosminexus Manager（name，ip：port）

次の情報が表示されます。

Manager名

ManagerのホストIPアドレス

Managerのポート番号

BusinessProcess（ServiceID）

ビジネスプロセスのサービスIDを示します。

ServiceAdapter（ServiceID）

サービスアダプタのサービスIDを示します。

ServiceName

ビジネスプロセス表示名，またはサービスアダプタ表示名を示します。

UserDefinedReception（ReceptionID）※2

ユーザ定義受付の受付IDを示します。

ReceptionName※2

ユーザ定義受付の受付名を示します。

Type※2

アダプタ種別の場合，次の情報が表示されます。

WebService：SOAPアダプタ

SessionBean：SessionBeanアダプタ

MDB_WSR：MDB（WS-R）アダプタ

MDB_DBQ：MDB（DBキュー）アダプタ

Custom：上記以外のサービスアダプタ（07-50より古いリポジトリの情報は，空白で表示されます）

受付種別の場合，次の情報が表示されます。

WebService：SOAP受付

Custom：SOAP受付以外のユーザ定義受付

ContextRoot※2

コンテキストルートを示します。情報が存在しない場合は空白で表示されます。

deployed※2

ビジネスプロセス，サービスアダプタ，またはユーザ定義受付が配備されているかどうかを示します。次のどちらかが表示されます。

true：配備されています。

false：配備されていません。

modified-time※2

ビジネスプロセス，サービスアダプタ，またはユーザ定義受付が更新された時間を示します。

java.text.SimpleDateFormatで定義されているフォーマットに，YYYY/MM/DD hh:mm:ssの形式で出力されます。

YYYY：西暦年

MM：月

DD：日

hh：時

mm：分

ss：秒

なお，更新時刻は開発環境でパッケージングした時間です。

注※1

次の条件の両方に当てはまる場合，文字化けが発生するおそれがあります。

HCSCサーバ表示名，クラスタ表示名，またはユーザ電文に次の文字を使用している。

・基本多言語面（BMP）以外の文字

・UnicodeのコードポイントU+10000〜U+10FFFFの範囲の文字

・UTF-16エンコーディングでのサロゲート・ペアで表される文字

Windowsでこのコマンドを使用している。

注※2

ユーザ定義受付（呼出先選択）とユーザ定義受付（呼出先固定）は別の個所に出力されます。

ユーザ定義受付（呼出先選択）の項目は，BusinessProcessより前に出力されます。

ユーザ定義受付（呼出先固定）の項目は，BusinessProcessの下位項目として出力されます。

説明（(3)-oldtypeオプションを指定した場合，および(4)-privateオプションを指定した場合）

表示項目

説明

Command Edit Time

コマンド発行時間を示します。

java.text.SimpleDateFormatで定義されているフォーマットに，YYYY/MM/DD hh:mm:ss.SSSの形式で出力されます。

YYYY：西暦年

MM：月

DD：日

hh：時

mm：分

ss：秒

SSS：ミリ秒

Domain（name）

ドメイン名を示します。

Cosminexus Manager（name）

Manager名を示します。

display-name

次のどれかが表示されます。

Manager表示名※1

HCSCサーバ表示名※1

ビジネスプロセス表示名

サービスアダプタ表示名

management-ip

ManagerのホストIPアドレスを示します。

port

Managerのポート番号を示します。

HCSC-Server（CSCSrvName）

HCSCサーバ名を示します。

cluster-name

クラスタ名を示します。

cluster-display-name

クラスタ表示名を示します。

cluster-type

クラスタ種別を示します。次のどちらかが表示されます。

LB：ロードバランスクラスタ

HA：HAクラスタ

J2EESrvName

J2EEサーバ名を示します。

RMSystemName

RMシステム名を示します。

Url

次のどれかが表示されます。

SessionBeanの場合：同期サービス（SessionBean）呼び出し時に使用するURL

WebService（SOAP1.1）の場合：同期サービス（Webサービス・SOAP1.1）呼び出し時に使用するURL

WebService（SOAP1.2）の場合：同期サービス（Webサービス・SOAP1.2）呼び出し時に使用するURL

MDB（WS-R）の場合：非同期サービス（MDB（WS-R））呼び出し時に使用するURL

LookupName

同期サービス（SessionBean）呼び出し時に使用するルックアップ名を示します。

Name

DBキュー名を示します。

BusinessProcess（ServiceID）

ビジネスプロセスのサービスIDを示します。

UserDefinedReception（ReceptionID）※2

ユーザ定義受付の受付IDを示します。

ReceptionName※2

ユーザ定義受付の受付名を示します。

Type※2

アダプタ種別の場合，次の情報が表示されます。07-50より古いリポジトリの情報は，空白で表示されます。

WebService：SOAPアダプタ

SessionBean：SessionBeanアダプタ

MDB_WSR：MDB（WS-R）アダプタ

MDB_DBQ：MDB（DBキュー）アダプタ

Custom：上記以外のサービスアダプタ

受付種別の場合，次の情報が表示されます。

WebService：SOAP受付

Custom：SOAP受付以外のユーザ定義受付

ContextRoot※2

コンテキストルートを示します。情報が存在しない場合は空白で表示されます。

deployed※2

ビジネスプロセス，またはサービスアダプタが配備されているかどうかを示します。次のどちらかが表示されます。

true：配備されています。

false：配備されていません。

modified-time※2

ビジネスプロセス，またはサービスアダプタが更新された時間を示します。

java.text.SimpleDateFormatで定義されているフォーマットに，YYYY/MM/DD hh:mm:ssの形式で出力されます。

YYYY：西暦年

MM：月

DD：日

hh：時

mm：分

ss：秒

なお，更新時刻は開発環境でパッケージングした時間です。

ServiceAdapter（ServiceID）

サービスアダプタのサービスIDを示します。

注※1

次の条件の両方に当てはまる場合，文字化けが発生するおそれがあります。

HCSCサーバ表示名，クラスタ表示名，またはユーザ電文に次の文字を使用している。

・基本多言語面（BMP）以外の文字

・UnicodeのコードポイントU+10000〜U+10FFFFの範囲の文字

・UTF-16エンコーディングでのサロゲート・ペアで表される文字

Windowsでこのコマンドを使用している。

注※2

ユーザ定義受付（呼出先選択）とユーザ定義受付（呼出先固定）は別の個所に出力されます。

ユーザ定義受付（呼出先選択）の項目は，BusinessProcessより前に出力されます。

ユーザ定義受付（呼出先固定）の項目は，BusinessProcessの下位項目として出力されます。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

-repfile指定時は，次の情報は出力されません。

ビジネスプロセスの配備状態，およびサービスアダプタの配備状態

次のサービス呼び出し時に使用するURL※

同期サービス（SessionBean）

同期サービス（Webサービス(SOAP1.1)）

同期サービス（Webサービス(SOAP1.2)）

非同期サービス（MDB（WS-R））

DBキュー名※

クラスタ種別

注※

サービス部品呼び出し時に使用するURL，およびDBキュー名は，-oldtype指定時に出力されます。

cscrepupdate（リポジトリのアップデート）

形式

cscrepupdate [-h]
             -user <ログインユーザID>
             -pass <ログインパスワード>
             -inputfile <アップデート前のZIPファイル名>
             -outputfile <アップデート後のZIPファイル名>

機能

旧バージョンで作成されたリポジトリを対象に，インストールされているバージョンで使用できるリポジトリへアップデートします。リポジトリのアップデート処理が必要ない場合は，何も出力されません。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「付録H.2　新規にインストールして運用環境のリポジトリを移行する手順」のリポジトリのアップデートに関する説明を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-inputfile <アップデート前のZIPファイル名>　〜((1−200バイト))

アップデート前の古いバージョンのリポジトリZIPファイルを絶対パスまたは相対パスで指定します。

指定したファイルが存在しない場合は，エラーになります。

-outputfile <アップデート後のZIPファイル名>　〜((1−200バイト))

アップデート後の新しいバージョンのリポジトリZIPファイルの出力先を絶対パスまたは相対パスで指定します。指定したファイルの拡張子を「.zip」にしなかった場合は，「.zip」が付加されます。-inputfileオプションと同じZIPファイルは指定できません。

指定したファイルがすでに存在する場合は上書きされます。また，次の場合はエラーになります。

指定したファイルのディレクトリが存在しない場合

ファイル以外を指定した場合

入力例

repository_old.zipの内容をアップデートし，カレントディレクトリにrepozitory_new.zipとして出力する場合

cscrepupdate -user admin -pass admin -inputfile repository_old.zip -outputfile repozitory_new.zip

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

このコマンドでアップデートできるのは08-00以降のリポジトリです。07-60以前のリポジトリをアップデートしたい場合は，開発環境でインポートを実行してリポジトリをアップデートしてください。

コマンドを実行する前に，次に示すディレクトリのあるドライブに対し，リポジトリのディスク使用量の2倍以上の空き容量があることを確認してください。

サービスプラットフォームのインストールディレクトリ

CSCMNG_HOME環境変数に設定したディレクトリ

cscresinfo（リソース稼働情報の表示）

形式

cscresinfo [-h]
           -user <ログインユーザID>
           -pass <ログインパスワード>
           -csc <HCSCサーバ名>
          [-item cache]

機能

HCSCサーバ上で開始している，リソースアダプタ，標準受付，およびHCSCコンポーネントの稼働情報を表示します。HCSCサーバが起動していない場合，これらの稼働情報は表示されません。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.3.18　HCSCサーバのリソース稼働情報を確認する」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

稼働情報を表示したいHCSCサーバ名を指定します。

-item cache

稼働情報のほかに，フォーマット定義およびデータ変換定義のキャッシュ数と，それらのキャッシュ数の上限値を表示する場合に指定します。

出力形式

HCSCサーバが起動状態で，かつ標準受付およびHCSCコンポーネントが開始状態の場合

Information Get Time : 稼働情報収集時刻
[HCSC-Server]
<クラスタ名>.<HCSCサーバ名>:active
 JavaVM Heap Size(MB)           Java VMヒープサイズ最大値/Java VMヒープサイズ上限値

[DBConnector]
 リソースアダプタ名  DBコネクション数最大値/DBコネクション数上限値

[StandardReception]
受付種別
 queue       キュー滞留数最大値/キュー滞留数上限値
 instance    実行数の最大値/実行数の上限値

[UserDefinedReception]
ユーザ定義受付の受付ID
 queue       キュー滞留数最大値/キュー滞留数上限値
 instance    実行数の最大値/実行数の上限値

[BusinessProcess]
ビジネスプロセスのサービスID    実行数の最大値/実行数の上限値

[ServiceAdapter]
サービスアダプタのサービスID    実行数の最大値/実行数の上限値

[FormatDefinition]※
Binary       バイナリフォーマット定義のキャッシュ数/フォーマット定義のキャッシュ数の上限値
XML          XMLスキーマのキャッシュ数/フォーマット定義のキャッシュ数の上限値

[TransformDefinition]※
データ変換定義のキャッシュ数/データ変換定義のキャッシュ数の上限値

注※

コマンドに「-item cache」を指定した場合に出力されます。

HCSCサーバが起動状態で，かつ開始状態の標準受付およびHCSCコンポーネントがない場合

Information Get Time : 稼働情報収集時刻
[HCSC-Server]
<クラスタ名>.<HCSCサーバ名>:active
 JavaVM Heap Size(MB)            Java VMヒープサイズ最大値/Java VMヒープサイズ上限値

[DBConnector]
 リソースアダプタ名  DBコネクション数最大値/DBコネクション数上限値

[StandardReception]※1

[UserDefinedReception]※1

[BusinessProcess]※1

[ServiceAdapter]※1

[FormatDefinition]※2
Binary       バイナリフォーマット定義のキャッシュ数/フォーマット定義のキャッシュ数上限値
XML          XMLスキーマのキャッシュ数/フォーマット定義のキャッシュ数上限値

[TransformDefinition]※2
データ変換定義のキャッシュ数/データ変換定義のキャッシュ数上限値

注※1

見出しだけが表示されます。

注※2

コマンドに「-item cache」を指定した場合に出力されます。

HCSCサーバが起動状態でない場合

[HCSC-Server]
<クラスタ名>.<HCSCサーバ名>:HCSCサーバ稼働状態※1

[FormatDefinition]※2
Binary       バイナリフォーマット定義のキャッシュ数/フォーマット定義のキャッシュ数上限値
XML          XMLスキーマのキャッシュ数/フォーマット定義のキャッシュ数上限値

[TransformDefinition]※2
データ変換定義のキャッシュ数/データ変換定義のキャッシュ数上限値

注※1

active以外が表示されます。

注※2

コマンドに「-item cache」を指定した場合に出力されます。

説明

表示項目

説明

稼働情報収集時刻

稼働情報を収集した時刻を示します。java.text.SimpleDateFormatで定義されているフォーマットに，YYYY/MM/DD hh:mm:ssの形式で出力されます。

YYYY：西暦年

MM：月

DD：日

hh：時

mm：分

ss：秒

クラスタ名

クラスタ名を示します。

HCSCサーバ名

HCSCサーバ名を示します。

Java VMヒープサイズ最大値

収集した60秒間での，Java VMヒープサイズの最大値（単位：MB）を示します。

次の場合は「-」が表示されます。

稼働情報の取得に失敗した場合

稼働情報が未取得の場合

未取得となるのは，HCSCサーバが起動してから稼働情報が収集されるまでの間（デフォルトでは60秒間）に，コマンドを実行した場合です。

Java VMヒープサイズ上限値

Java VMヒープサイズの上限値（単位：MB）を示します。

次の場合は「-」が表示されます。

稼働情報の取得に失敗した場合

稼働情報が未取得の場合

未取得となるのは，HCSCサーバが起動してから稼働情報が収集されるまでの間（デフォルトでは60秒間）に，コマンドを実行した場合です。

リソースアダプタ名

リソースアダプタ名を示します。

DBコネクション数最大値

収集した60秒間での，DBコネクションの最大値を示します。

また，次の場合はDBコネクション数上限値と合わせて「NA/NA」（無効値）が表示されます。

該当のリソースアダプタが，ルートリソースアダプタ，またはReliable Messaging連携用DBコネクタの場合

コネクションプールの上限値が0に設定されている場合

DBコネクション数上限値

DBコネクションの上限値を示します。DBコネクション数上限値だけ「NA」と表示される場合は，無制限を示します。

DBコネクション数最大値と合わせて「NA/NA」と表示される場合については，「DBコネクション数最大値」の説明を参照してください。

受付種別

標準受付の受付種別を示します。次のどちらかが表示されます。

WebService(SOAP1.1)

WebService(SOAP1.2)

キュー滞留数最大値

収集した60秒間での，キュー滞留数の最大値を示します。

次の場合は「-」が表示されます。

稼働情報の取得に失敗した場合

稼働情報が未取得の場合

未取得となるのは，対象となる受付またはHCSCコンポーネントが開始してから稼働情報が収集されるまでの間（デフォルトでは60秒間）に，コマンドを実行した場合です。

ユーザ定義受付（SOAP受付以外）の場合

キュー滞留数上限値

キュー滞留数の上限値を示します。

次の場合は「-」が表示されます。

稼働情報の取得に失敗した場合

稼働情報が未取得の場合

未取得となるのは，対象となる受付またはHCSCコンポーネントが開始してから稼働情報が収集されるまでの間（デフォルトでは60秒間）に，コマンドを実行した場合です。

ユーザ定義受付（SOAP受付以外）の場合

実行数の最大値

収集した60秒間での，実行数の最大値を示します。

次の場合は「-」が表示されます。

稼働情報の取得に失敗した場合

稼働情報が未取得の場合

未取得となるのは，対象となる受付またはHCSCコンポーネントが開始してから稼働情報が収集されるまでの間（デフォルトでは60秒間）に，コマンドを実行した場合です。

実行数の上限値

実行数の上限値を示します。「NA」または「0」と表示される場合は，無制限を示します。

次の場合は「-」が表示されます。

稼働情報の取得に失敗した場合

稼働情報が未取得の場合

未取得となるのは，対象となる受付またはHCSCコンポーネントが開始してから稼働情報が収集されるまでの間（デフォルトでは60秒間）に，コマンドを実行した場合です。

ユーザ定義受付の受付ID

ユーザ定義受付の受付IDを示します。

ビジネスプロセスのサービスID

ビジネスプロセスのサービスIDを示します。

サービスアダプタのサービスID

サービスアダプタのサービスIDを示します。

HCSCサーバ稼働状態

HCSCサーバの稼働状態を示します。次のどれかが表示されます。

active：起動状態

inactive：停止状態

startfailed：起動失敗

stopfailed：停止失敗

starting：起動中

stopping：停止中

unknown：取得失敗

バイナリフォーマット定義のキャッシュ数

バイナリフォーマット定義のキャッシュ数を示します。

次の場合は「-」が表示されます。

稼働情報の取得に失敗した場合

HCSCサーバが起動状態ではないか，データ通信に失敗した場合です。

XMLスキーマのキャッシュ数

XMLスキーマのキャッシュ数を示します。

次の場合は「-」が表示されます。

稼働情報の取得に失敗した場合

HCSCサーバが起動状態ではないか，データ通信に失敗した場合です。

フォーマット定義のキャッシュ数の上限値

フォーマット定義のキャッシュ数の上限値を示します。

次の場合は「-」が表示されます。

稼働情報の取得に失敗した場合

HCSCサーバが起動状態ではないか，データ通信に失敗した場合です。

データ変換定義のキャッシュ数

データ変換定義のキャッシュ数を示します。

次の場合は「-」が表示されます。

稼働情報の取得に失敗した場合

HCSCサーバが起動状態ではないか，データ通信に失敗した場合です。

データ変換定義のキャッシュ数の上限値

データ変換定義のキャッシュ数の上限値を示します。

次の場合は「-」が表示されます。

稼働情報の取得に失敗した場合

HCSCサーバが起動状態ではないか，データ通信に失敗した場合です。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

9

実行権限のチェックエラーが発生しました。

cscstatus（状態表示）

形式

cscstatus [-h]
          -user <ログインユーザID>
          -pass <ログインパスワード>
          [-csc <HCSCサーバ名>
           -type {system｜reception｜compo}]

機能

HCSCサーバ，標準受付，およびHCSCコンポーネントの状態を表示します。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，目的にあわせてマニュアル「サービスプラットフォーム システム構築・運用ガイド」の次に示す個所を参照してください。

「5.3.12　PRFの状態を確認する」

「5.3.13　HTTP Serverの状態を確認する」

「5.3.16　HCSCサーバの情報を確認する」

「5.3.19　サービスアダプタの情報を確認する」

「5.3.20　ビジネスプロセスの情報を確認する」

「5.3.21　ユーザ定義受付の情報を確認する」

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

標準受付またはHCSCコンポーネントの状態を表示したいHCSCサーバ名を指定します。このオプションを指定した場合，必ず-typeオプションを指定してください。このオプションを省略した場合，すべてのHCSCサーバの状態が表示されます。

-type {system｜reception｜compo}

状態を表示する標準受付またはHCSCコンポーネントの種類を指定します。

system

HCSCサーバと，HCSCサーバが管理する論理サーバの状態（PRFの状態）を表示する場合に指定します。

reception

標準受付およびユーザ定義受付の状態を表示する場合に指定します。

compo

HCSCコンポーネントの状態を表示する場合に指定します。

表示形式

(1)HCSCサーバの状態

Command Edit Time:コマンド発行時間
HCSCサーバの状態 HCSCサーバ名

説明

表示項目

説明

HCSCサーバの状態

HCSCサーバの状態を示します。次のどれかが表示されます。

active：開始状態

inactive：停止状態※

starting：起動処理中

startfailed：起動失敗状態

stopping：停止処理中

stopfailed：停止失敗状態

unknown：取得失敗

HCSCサーバ名

HCSCサーバ名を示します。次の形式で表示されます。

<クラスタ名>.<HCSCサーバ名>

注※

HCSCサーバの状態の取得に要した時間が，HCSCサーバランタイム定義ファイルのcsc-command-timeoutで設定したコマンドタイムアウト時間以上となった場合にも，inactiveで出力されます。

(2)HCSCサーバが管理する論理サーバの状態(-csc指定時)

-type system指定時

Command Edit Time:コマンド発行時間
HCSCサーバの状態 HCSCサーバ名
論理サーバの稼働状態 論理サーバ名

説明

表示項目

説明

HCSCサーバの状態

HCSCサーバの状態を示します。次のどれかが表示されます。

active：開始状態

inactive：停止状態※

starting：起動処理中

startfailed：起動失敗状態

stopping：停止処理中

stopfailed：停止失敗状態

unknown：取得失敗

論理サーバの稼働状態

論理サーバの状態を示します。次のどれかが表示されます。

active：開始状態

inactive：停止状態

starting：起動処理中

stopping：停止処理中

abnormal ended：異常停止

recovering：回復中

communication error：通信障害

auto stopping：自動停止中

auto restarting：自動再起動中

force stopping：強制停止中

planned stopping：計画停止中

注※

HCSCサーバの状態の取得に要した時間が，HCSCサーバランタイム定義ファイルのcsc-command-timeoutで設定したコマンドタイムアウト時間以上となった場合にも，inactiveで出力されます。

(3)標準受付およびユーザ定義受付の状態(-csc指定時)

-type reception指定時

Command Edit Time:コマンド発行時間
標準受付の状態 reception

ユーザ定義受付の状態

説明

表示項目

説明

標準受付の状態

標準受付の状態を示します。次のどれかが表示されます。

active：開始状態

inactive：停止状態※

starting：起動処理中

startfailed：起動失敗状態

stopping：停止処理中

stopfailed：停止失敗状態

unknown：取得失敗

ユーザ定義受付の状態

ユーザ定義受付の状態を示します。次のどれかが表示されます。

active：開始状態

inactive：停止状態

starting：起動処理中

startfailed：起動失敗状態

stopping：停止処理中

stopfailed：停止失敗状態

deleting：削除処理中

undeployed：配備前

unknown：取得失敗

注※

HCSCサーバの状態の取得に要した時間が，HCSCサーバランタイム定義ファイルのcsc-command-timeoutで設定したコマンドタイムアウト時間以上となった場合にも，inactiveで出力されます。

また，HCSCサーバの稼働状態がinactiveとなる場合，標準受付の稼働状態もinactiveで出力します。

(4)HCSCコンポーネントの状態(-csc指定時)

-type compo指定時

Command Edit Time:コマンド発行時間
ビジネスプロセスの状態 ビジネスプロセスのサービスID 更新時間※

サービスアダプタの状態 サービスアダプタのサービスID 更新時間※

ユーザ定義受付の状態 ユーザ定義受付の受付ID 更新時間※

注※

開発環境でHCSCコンポーネントをパッケージングした時間です。したがって，開発環境のマシンの時間に依存します。

説明

表示項目

説明

ビジネスプロセスの状態

サービスアダプタの状態

ユーザ定義受付の状態

ビジネスプロセス，サービスアダプタ，およびユーザ定義受付の状態を示します。次のどれかが表示されます。

active：開始状態

inactive：停止状態

starting：起動処理中

startfailed：起動失敗状態

stopping：停止処理中

stopfailed：停止失敗状態

deleting：削除処理中

undeployed：配備前

unknown：取得失敗

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

cscsetup（本番環境の簡易セットアップ）

形式

cscsetup [-h]
         {-setup <定義ファイルの格納先ディレクトリ>  [-hcscenv <CSCMNG_HOMEディレクトリ>]
          ｜-unsetup [-force] [-deleteunit <サービスユニット名>]
          ｜-change <定義ファイルの格納先ディレクトリ> [-unit <サービスユニット名>]}
         [-yes]

機能

本番環境に適用できるシステムをセットアップおよびアンセットアップします。また，簡易セットアップで設定した情報を容易に変更します。

このコマンドの使用方法と，追加構築可能環境をセットアップまたはアンセットアップする場合の注意事項については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「3.5.3　HCSC本番環境簡易セットアップ機能の実行」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-setup <定義ファイルの格納先ディレクトリ>　〜((1−100バイト))

本番環境をセットアップする場合，定義ファイルの格納先ディレクトリを絶対パスで指定してください。指定されたディレクトリの定義ファイルを参照し，本番環境をセットアップします。

ここで指定したディレクトリ内のSOA.xmlには，SOAPモード（SOAP1.1モードまたはSOAP1.1/1.2併用モード）に応じたコンテナ拡張ライブラリ用のjarファイルを設定してください。設定しない場合の動作は保証しません。

-hcscenv <CSCMNG_HOMEディレクトリ>　〜((1−100バイト))

本番環境を追加セットアップする場合，環境変数CSCMNG_HOMEに設定するディレクトリを絶対パスで指定してください。このオプションは，-setupオプションと併せて指定します。

追加構築可能環境に論理サーバ/HCSCサーバの追加セットアップを実行した場合，警告終了が発生することがあります。警告終了が発生した場合，cscsetupコマンドの実行結果を確認し，出力されている警告メッセージに従って対処してください。

-unsetup

本番環境をアンセットアップします。

-force

アンセットアップ中にエラーが発生した場合，強制的にアンセットアップを続行します。

このオプションは，-setupオプションを指定したセットアップや-unsetupオプションを指定したアンセットアップに失敗し，処理が続行できなくなった場合に使用します。通常のアンセットアップをしたい場合は，-forceオプションではなく-unsetupオプションを指定してアンセットアップすることをお勧めします。

HCSC-Manager定義ファイルにcscmng.repository.root（リポジトリのルートディレクトリパス）を指定している場合，追加構築可能環境ごとに一意の値が設定されていることを確認してから，アンセットアップを実行してください。

-deleteunit <サービスユニット名>　〜＜半角英数字，アンダーバー（_），およびハイフン（-）＞ ((1−32文字))

アンセットアップしたい論理サーバまたはHCSCサーバに対応するサービスユニット名を指定します。このオプションは，-hcscenvオプションを使用して構築した本番環境を-unsetupオプションを指定してアンセットアップする場合に指定します。

指定するサービスユニット名は，本番環境の簡易構築に使用した簡易構築定義ファイル（SOA.xml）にある，アンセットアップしたい論理サーバが定義されている<unit>下の<name>定義の値と一致する値を指定します。

-change <定義ファイルの格納先ディレクトリ>　〜((1−100バイト))

本番環境の情報を変更する場合，定義ファイルの格納先ディレクトリを絶対パスで指定してください。指定されたディレクトリの定義ファイルを参照し，本番環境の情報を変更します。

なお，変更に関しては次の点に注意してください。

構築済みの環境のSOAPモードを変更した場合，動作については保証しません。

J2EEサーバの互換モードは変更できません。変更する場合は，アンセットアップ後に再度セットアップする必要があります。

WebサーバのJ2EEサーバとの連携方法は変更できません。変更する場合は，アンセットアップ後に再度セットアップする必要があります。

-unit <サービスユニット名>　〜＜半角英数字，アンダーバー（_），およびハイフン（-）＞ ((1−32文字))

変更したい論理サーバまたはHCSCサーバに対応するサービスユニット名を指定します。このオプションは，-hcscenvオプションを使用して構築した本番環境を-changeオプションを指定して変更する場合に指定します。

指定するサービスユニット名は，本番環境の簡易構築に使用した簡易構築定義ファイル（SOA.xml）にある，変更したい論理サーバが定義されている<unit>下の<name>定義の値と一致する値を指定します。

-yes

確認メッセージが表示されないようにします。

入力例

単一サーバ構成の本番環境の場合

(1)本番環境をセットアップする場合

cscsetup -setup C:¥esb_1.1_1.2mode_v11

(2)本番環境をアンセットアップする場合

cscsetup -unsetup

(3)本番環境を強制アンセットアップする場合

cscsetup -unsetup -force

(4)本番環境の情報を変更する場合

cscsetup -change C:¥esb_1.1_1.2mode_v11

サーバ（論理サーバまたはHCSCサーバ）の追加構築を可能とする本番環境の場合

(1)本番環境をセットアップする場合

cscsetup -setup C:¥esb_1.1_1.2mode_v11 -hcscenv C:¥cscmng1

(2)本番環境にサーバを追加構築する場合

cscsetup -setup C:¥esb_1.1_1.2mode_v11_add -hcscenv C:¥cscmng2

(3)本番環境から指定したサービスユニットに構築されているサーバをアンセットアップする場合

cscsetup -unsetup -deleteunit Unit1

(4)本番環境から指定したサービスユニットに構築されているサーバを強制アンセットアップする場合

cscsetup -unsetup -force -deleteunit Unit1

(5)本番環境から指定したサービスユニットに構築されているサーバの情報を変更する場合

cscsetup -change C:¥esb_1.1_1.2mode_v11 -unit Unit1

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

9

実行権限のチェックエラーが発生しました。

20

コマンドが警告終了しました。

注意事項

UNIXの場合，定義ファイルの格納先ディレクトリにcscsetupコマンド定義ファイル（cscsetup.properties）が存在しないと，スーパーユーザで処理が実行されます。そのため，Component Container管理者を変更して運用したい場合は，cscsetupコマンド定義ファイル（cscsetup.properties）でオーナー名およびグループ名を指定してください。cscsetupコマンド定義ファイルについては，「6.4.1　cscsetupコマンド定義ファイル」を参照してください。

cscsvcctl（サービス情報の管理）

形式

cscsvcctl [-h]
          -user <ログインユーザID>
          -pass <ログインパスワード>
          {-getfile <サービス情報変更定義ファイル名>
           ｜-setfile <サービス情報変更定義ファイル名>
           ｜-cluster <クラスタ名> -name <サービスアダプタのサービスID> -props <プロパティ>}

機能

cscsvcctlコマンドには，次に示す機能があります。

サービス情報変更定義ファイルを出力する機能（-getfileオプションを使用）

サービス情報変更定義ファイルを入力し，一括してサービス情報の変更を設定する機能（-setfileオプションを使用）

サービス情報変更定義ファイルを使用しないで，個別にサービス情報の変更を設定する機能（-cluster，-name，および-propsオプションを使用）

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「3.1.6　サービス情報を変更する」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-getfile <サービス情報変更定義ファイル名>　((1−200バイト))

出力するサービス情報変更定義ファイル名を指定します。絶対パスまたは相対パスで指定します。指定したファイルまでのディレクトリがない場合，異常終了します。指定したファイルがすでにある場合，上書きされます。指定したファイル名と同名のディレクトリがある場合は，異常終了します。

なお，出力したサービス情報変更定義ファイル中で，プロキシサーバのユーザID/パスワード，ベーシック認証のユーザID/パスワードの設定値は，次のように表示されます。

値が設定されている場合：The value has already been set.

値が設定されていない場合：空白

-setfile <サービス情報変更定義ファイル名>　((1−200バイト))

入力するサービス情報変更定義ファイル名を指定します。絶対パスまたは相対パスで指定します。指定したファイルがない場合，異常終了します。

なお，サービス情報変更定義ファイルを設定する際，プロキシサーバのユーザID/パスワード，ベーシック認証のユーザID/パスワードを変更しない場合は，-getfileオプションで取得したままの値を設定してください。

-cluster <クラスタ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

サービス情報を変更するサービスアダプタがあるクラスタ名を指定します。

-name <サービスアダプタのサービスID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

サービス情報を変更するサービスアダプタのサービスIDを指定します。

-props <プロパティ>　〜((1文字以上))

操作対象に渡す情報を<key>=<value>形式で指定します。<key>はサービス情報表示コマンド（cscsvcls）で表示されるキー名称を使用します。指定値はダブルクォーテーション（"）で囲みます。また，-nameオプションで指定したサービスアダプタに関するサービス情報であれば複数指定できます。複数指定する場合，指定値をコンマ（,）で区切ります（例：-props "a=b,c=d"）。なお，サービス情報表示コマンド（cscsvcls）で確認したLocalCallの値がfalseの場合はtrueへ変更しないでください。

入力例

(1)サービス情報変更定義ファイルを出力する場合

cscsvcctl -getfile service_info.txt

(2)サービス情報変更定義ファイルを入力し，一括してサービス情報の変更を設定する場合

cscsvcctl -setfile service_info.txt

(3)サービス情報変更定義ファイルを使用しないで，個別にサービス情報の変更を設定する場合

cscsvcctl -cluster Cluster -name adapter1 -props "Url=aaa,ReadTimeout=60"

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

-setfileオプションまたは-nameオプションを指定した場合，サービス情報を変更するサービスアダプタが配備中（HCSCサーバがクラスタ構成の場合，クラスタ内のどれかのHCSCサーバに配備中）の状態になっていると，cscsvcctlコマンドはエラーになります。

cscsvcls（サービス情報の表示）

形式

cscsvcls [-h]
         -user <ログインユーザID>
         -pass <ログインパスワード>
         [-detail]

機能

サービス情報を標準出力に出力します。出力したサービス情報は，cscsvcctlコマンド（サービス情報の管理）の-propsオプションに指定するプロパティ情報として確認できます。

サービス情報は，次のアダプタ種別の場合に出力できます。

SessionBean

WebService

MDB_WSR

MDB_DBQ

これ以外（ユーザ定義受付，またはアダプタ種別がCustomのサービスアダプタ）の場合は，開発環境または運用環境で設定されている定義ファイル名と，その定義ファイルの状態（運用環境で変更しているか）を出力します。なお，定義ファイルの取得・設定は，csccmctlコマンド（定義ファイルの管理）でも実施できます。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

ただし，実行環境の独自定義ファイル設定機能を使って実行環境に配置した独自定義ファイルは，このコマンドで情報を出力できません。実行環境の独自定義ファイル設定機能については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.10.3　実行環境の独自定義ファイル設定機能を使用した独自定義ファイルの定義手順」を参照してください。

このコマンドの使用方法については，目的にあわせてマニュアル「サービスプラットフォーム システム構築・運用ガイド」の次に示す個所を参照してください。

「3.1.7　サービス情報を確認する」

「3.1.12　運用環境の定義ファイルの状態を確認する」

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-detail

開発時に設定した値を表示する場合に指定します。

出力形式

-detailを指定しない場合

Command Edit Time:コマンド発行時間
Cluster(name: クラスタ名)
- ServiceAdapter(ServiceID: サービスアダプタのサービスID, ServiceType: アダプタ種別)
  属性名: 値
- ServiceAdapter(ServiceID: サービスアダプタのサービスID, ServiceType: アダプタ種別)
  属性名： 値
- ServiceAdapter(ServiceID: サービスアダプタのサービスID, ServiceType: Custom)
    定義ファイル名: 状態
-UserDefinedReception(ReceptionID: 受付ID, ReceptionType: 受付種別)
    定義ファイル名: 状態

-detailを指定する場合

Command Edit Time:コマンド発行時間
Cluster(name: クラスタ名)
- ServiceAdapter(ServiceID: サービスアダプタのサービスID, ServiceType: サービスアダプタ種別)
  属性名(def): 開発時に設定した値
  属性名(set): 値
- ServiceAdapter(ServiceID: サービスアダプタのサービスID, ServiceType: サービスアダプタ種別)
  属性名(def): 開発時に設定した値
  属性名(set): 値
- ServiceAdapter(ServiceID: サービスアダプタのサービスID, ServiceType: Custom)
    定義ファイル名: 状態
      プロパティのキー名称：プロパティの値
-UserDefinedReception(ReceptionID: 受付ID, ReceptionType: 受付種別)
    定義ファイル名: 状態
      プロパティのキー名称=:プロパティの値

説明

表示項目

説明

Command Edit Time

コマンド発行時間を示します。

java.text.SimpleDateFormatで定義されているフォーマットに，YYYY/MM/DD hh:mm:ss.SSS形式で出力されます。

YYYY：西暦年

MM：月

DD：日

hh：時

mm：分

ss：秒

SSS：ミリ秒

Cluster（name）

クラスタ名を示します。

ServiceAdapter（ServiceID）

サービスアダプタのサービスIDを示します。

ServiceType

サービスアダプタ種別を示します。次のどれかが出力されます。

SessionBean：同期（SessionBean）

WebService：同期（Webサービス）

MDB_WSR：非同期（MDB（WS-R））

MDB_DBQ：非同期（MDB（DBキュー））

Custom：上記以外のサービスアダプタ

属性名

現在有効なサービス情報が出力されます。

属性名（def）

開発時に設定したサービス情報が出力されます。

属性名（set）

サービス情報変更定義に設定されているサービス情報が出力されます。

受付ID

受付IDを示します。

受付種別

受付種別を示します。次のどれかが出力されます。

WebService：SOAP受付

Custom：SOAP受付以外のユーザ定義受付

定義ファイル名※1

定義ファイル名を示します。

状態

定義ファイルの状態を示します。次のどれかが出力されます。

noChange：独自定義ファイルを運用環境に設定していない状態

add：独自定義ファイルを運用環境に追加した状態

changed：運用環境に追加した定義を変更している状態

プロパティのキー名称※2

定義ファイルの拡張子が「*.properties」の場合にプロパティのキー名称が出力されます。

プロパティの値※2

定義ファイルの拡張子が「*.properties」の場合にプロパティの値が出力されます。

注※1

サービスアダプタの場合，アプリケーション統合属性ファイル名が表示されることがあります。

注※2

拡張子が*.properties以外の場合は表示されません。

サービス情報の出力形式を次の表に示します。なお，表中のSOAPモードはSOAP1.1モードおよびSOAP1.1/1.2併用モードを表します。

表5‒6　サービス情報の出力形式

サービスアダプタ種別

SOAPモード

出力形式（出力順）

サービス情報変更定義ファイルの相当する属性

1.1

1.1/1.2併用

WebService

○

○

BasicAuthenticationId

basic_authentication_id※1※2

○

○

BasicAuthenticationPass

basic_authentication_pass※1※2

○

○

BasicAuthenticationUse

basic_authentication_use※1

○

SessionMaintain

c4web.application.app_maintainsession※1

○

NonProxyHosts

c4web.application.non_proxy_hosts※1

○

ProxyHost

c4web.application.proxy_host※1

○

ProxyPassword

c4web.application.proxy_password※1※2

○

ProxyPort

c4web.application.proxy_port※1

○

ProxyUser

c4web.application.proxy_user※1※2

○

AutoDeleteIncompleteFile

com.cosminexus.csc.auto-delete-incomplete-file※1

○

ConnectTimeout

c4web.application.socket_connect_timeout※1

○

com.cosminexus.csc.connect.timeout※1

○

FileReadLockRetryCount

com.cosminexus.csc.file.read-lock.retry.count※1

○

FileReadLockRetryInterval

com.cosminexus.csc.file.read-lock.retry.interval※1

○

ReadTimeout

c4web.application.socket_read_timeout※1

○

com.cosminexus.csc.request.timeout※1

○

WriteTimeout

c4web.application.socket_write_timeout※1

○

PrfTraceLevel

c4web.common.prf_trace_level※1

○

ReceiveMaxSoapEnvelopeSize

c4web.common.receive_max_soap_envelope_size※1

○

SendMaxSoapEnvelopeSize

c4web.common.send_max_soap_envelope_size※1

○

SessionMaintain

com.cosminexus.csc.session.maintain※1

○

○

Url

url

SessionBean

○

Timeout

c4web.application.ejb_timeout※1

○

PrfTraceLevel

c4web.common.prf_trace_level※1

○

LookupName

lookupName

○

Url

url

MDB_WSR

○

LocalCall

local_call

○

QueueName

queue_name

○

Url

url

○

MaxMessageNum

max_message_num

○

QosInOrder

qos_in_order

○

RdAreaName

rdarea_name

MDB_DBQ

○

○

QueueName

queue_name

（凡例）

○：サービス情報の出力に対応していることを示します。

空欄：サービス情報の出力に対応していないことを示します。

注※1

設定されていない場合は，空白が表示されます。

注※2

設定されている場合は，「The value has already been set.」が表示されます。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

cscsvconfig（HCSCサーバランタイムの定義）

形式

cscsvconfig [-h]
            -user <ログインユーザID>
            -pass <ログインパスワード>
            {-operation get -csc <HCSCサーバ名>
               ｜-operation set -propfile <HCSCサーバランタイム定義ファイル名>
            {-csc <HCSCサーバ名>｜-cluster <クラスタ名>}}

機能

サーバセットアップ後のHCSCサーバに対して，定義情報の取得や変更をします。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，目的にあわせてマニュアル「サービスプラットフォーム システム構築・運用ガイド」の次に示す個所を参照してください。

-operationオプションにsetを指定した場合の使用方法

「3.1.4　HCSCサーバの定義情報を設定する」

-operationオプションにgetを指定した場合の使用方法

「3.1.5　HCSCサーバの定義内容を確認する」

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-operation {get｜set}

このコマンドの操作を指定します。

get

指定したHCSCサーバに設定されている定義が標準出力に出力されます。

set

-propfileオプションで指定したファイルの内容が，指定したHCSCサーバに反映されます。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

定義情報の取得や変更の対象となるHCSCサーバ名を指定します。

-propfile <HCSCサーバランタイム定義ファイル名>　〜 ((1−200バイト))

HCSCサーバに定義する定義一覧を記載したファイル名を相対パス，または絶対パスで指定します。このオプションは，-operationオプションでsetを指定したときに有効になります。

-cluster <クラスタ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

HCSCサーバ定義を一括更新するクラスタ名を指定します。-operationでsetを指定したときに有効になります。ただし，クラスタ種別がHAのときにこのオプションを指定した場合はエラーになります。

入力例

(1)HCSCサーバ「HCSC」の定義を取得する場合

cscsvconfig -user admin -pass admin -csc HCSC -operation get

(2)HCSCサーバ「HCSC」の定義を設定する場合

cscsvconfig -user admin -pass admin -csc HCSC -operation set -propfile config.properties

(3)クラスタ「Cluster」に存在するすべてのHCSCサーバの定義を変更する場合

cscsvconfig -user admin -pass admin -cluster Cluster -operation set -propfile config.properties

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

2

通信タイムアウトが発生しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

cscsvsetup（HCSCサーバのセットアップ）

形式

cscsvsetup [-h]
           -user <ログインユーザID>
           -pass <ログインパスワード>
           [-csc <HCSCサーバ名>]
           [-cluster <クラスタ名>]
           -propfile <HCSCサーバ構成定義ファイル名>

機能

HCSCサーバのセットアップをします。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「3.1.3　HCSCサーバをセットアップする」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

セットアップするHCSCサーバ名を指定します。セットアップ済みのHCSCサーバ名と大文字，小文字だけが異なるHCSCサーバ名を使用しないでください。使用すると，データベーステーブル名やキュー名が重複してセットアップが失敗することがあります。このオプションの指定を省略した場合，HCSCサーバ構成定義ファイルに指定したHCSCサーバ名が仮定されます。

-cluster <クラスタ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))<<-cscオプションで指定したサーバ名>>

セットアップするHCSCサーバが属するクラスタ名を指定します。クラスタ間で一意になるクラスタ名を指定します。セットアップ済みのクラスタ名と大文字，小文字だけが異なるクラスタ名を使用しないでください。使用すると，データベーステーブル名やキュー名が重複してセットアップが失敗することがあります。このオプションの指定を省略した場合，HCSCサーバ構成定義ファイルに指定したクラスタ名が仮定されます。

-propfile <HCSCサーバ構成定義ファイル名>　〜 ((1−200バイト))

HCSCサーバ構成定義ファイル名を相対パス，または絶対パスで指定します。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

2

通信タイムアウトが発生しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

追加セットアップをする場合は，HCSCサーバ，各ビジネスプロセス，および各サービスアダプタが停止してからコマンドを実行してください。停止していない場合はエラーになります。

同じクラスタ内では，データベースおよびReliable Messagingを使用するかどうかの設定を一致させてください。

同じリポジトリ内では，すべてのHCSCサーバのSOAPモードを一致させてください。

cscsvstart（HCSCサーバの起動）

形式

cscsvstart [-h]
           -user <ログインユーザID>
           -pass <ログインパスワード>
           {-csc <HCSCサーバ名>｜-cluster <クラスタ名>}
           [{-logical <論理サーバ名>｜-system }]

機能

HCSCサーバ，または論理サーバを起動します。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，目的にあわせてマニュアル「サービスプラットフォーム システム構築・運用ガイド」の次に示す個所を参照してください。

「5.3.3　PRFを起動する」

「5.3.4　HCSCサーバを起動する」

「5.3.6　HTTP Serverを起動する」

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

起動するHCSCサーバ名を指定します。

-cluster <クラスタ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

HCSCサーバを一括起動するクラスタ名を指定します。クラスタ種別がHAのときに-clusterを指定するとエラーになります。

-logical <論理サーバ名>　〜＜半角英数字，アンダーバー（_），およびハイフン（-）＞ ((1−128文字))

起動する論理サーバ名を指定します。このオプションで設定した論理サーバの種類とその動作を次の表に示します。なお，このオプションを指定した場合，HCSCサーバは起動しません。

表5‒7　-logicalオプションに指定した論理サーバの種類とその動作（起動時）

項番

指定した論理サーバの種類

動作

1

PRF

PRFを起動します。

2

スマートエージェント

スマートエージェントを起動します。

3

CTMドメインマネジャ

CTMドメインマネジャを起動します。

4

CTMデーモン

CTMデーモンを起動します。

5

J2EEサーバ

J2EEアプリケーションを起動しないでJ2EEサーバを起動します。※

6

Webサーバ

Webサーバを起動します。

注※

HCSCサーバが起動していない状態でコマンドを実行します。

-system

HCSCサーバの起動と同時に，HCSC-Manager定義ファイルのcscmng.server.<HCSCサーバ名>.systemで定義した論理サーバを起動します。

入力例

(1)HCSCサーバ「HCSC」を起動する場合

cscsvstart -user admin -pass admin -csc HCSC

(2)クラスタ「Cluster」下にあるHCSCサーバを一括起動する場合

cscsvstart -user admin -pass admin -cluster Cluster

(3)クラスタ「Cluster」下にあるHCSCサーバを論理サーバと同時に一括起動する場合

cscsvstart -user admin -pass admin -cluster Cluster -system

(4)クラスタ「Cluster」下にある論理サーバ名PRFを一括起動する場合

cscsvstart -user admin -pass admin -cluster Cluster -logical PRF

(5)J2EEアプリケーションを起動しないで，HCSCサーバ「HCSC」にあるJ2EEサーバ「J2EEServer」を起動する場合

cscsvstart -user admin -pass admin -csc HCSC -logical J2EEServer

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

2

通信タイムアウトが発生しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

このコマンドは，セットアップ済みで，かつ停止済みのHCSCサーバに対して実行してください。

なお，このコマンドは起動状態のHCSCサーバに対して実行してもエラーになりません。

-clusterを指定してエラーになった場合，結果をcscstatusコマンドで確認し，障害要因を取り除いたあとに，再度コマンドを実行してください。

HCSCサーバの起動時にサービスアダプタまたはビジネスプロセスが開始できないと，サービスアダプタ，ビジネスプロセス，または受付が停止状態になる場合がありますが，HCSCサーバの起動は正常終了します。

cscsvstop（HCSCサーバの停止）

形式

cscsvstop [-h]
          -user <ログインユーザID>
          -pass <ログインパスワード>
          {-csc <HCSCサーバ名>｜-cluster <クラスタ名>}
          [{-logical <論理サーバ名>｜-system}]
          [-force]

機能

HCSCサーバを停止します。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，目的にあわせてマニュアル「サービスプラットフォーム システム構築・運用ガイド」の次に示す個所を参照してください。

「5.3.39　HTTP Serverを停止する」

「5.3.41　HCSCサーバを停止する」

「5.3.42　PRFを停止する」

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

停止するHCSCサーバ名を指定します。

-cluster <クラスタ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

HCSCサーバを一括停止するクラスタ名を指定します。クラスタ種別がHAのときに-clusterを指定するとエラーになります。

-logical <論理サーバ名>　〜＜半角英数字，アンダーバー（_），およびハイフン（-）＞ ((1−128文字))

停止する論理サーバ名を指定します。このオプションで設定した論理サーバの種類とその動作を次の表に示します。なお，このオプションを指定した場合，HCSCサーバは停止しません。また，-forceは無効になります。

表5‒8　-logicalオプションに指定した論理サーバの種類とその動作（停止時）

項番

指定した論理サーバの種類

動作

1

PRF

PRFを停止します。

2

スマートエージェント

スマートエージェントを停止します。

3

CTMドメインマネジャ

CTMドメインマネジャを停止します。

4

CTMデーモン

CTMデーモンを停止します。

5

J2EEサーバ

J2EEサーバを停止します。※

6

Webサーバ

Webサーバを停止します。

注※

HCSCサーバが起動していない状態でコマンドを実行します。

-system

HCSCサーバの停止と同時に，HCSC-Manager定義ファイルのcscmng.server.<HCSCサーバ名>.systemで定義した論理サーバを停止します。

-force

HCSCサーバの強制停止をします。標準受付，ユーザ定義受付が起動中でもHCSCサーバを停止します。HCSCサーバが稼働する論理J2EEサーバは通常停止します。

入力例

(1)HCSCサーバ「HCSC」を停止する場合

cscsvstop -user admin -pass admin -csc HCSC

(2)クラスタ「Cluster」下にあるHCSCサーバを一括強制停止する場合

cscsvstop -user admin -pass admin -cluster Cluster -force

(3)クラスタ「Cluster」下にあるHCSCサーバを論理サーバと同時に一括停止する場合

cscsvstop -user admin -pass admin -cluster Cluster -system

(4)クラスタ「Cluster」下にある論理サーバ「PRF」を一括停止する場合

cscsvstop -user admin -pass admin -cluster Cluster -logical PRF

(5)HCSCサーバ「HCSC」にあるJ2EEサーバ「J2EEServer」を停止する場合

cscsvstop -user admin -pass admin -csc HCSC -logical J2EEServer

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

2

通信タイムアウトが発生しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

このコマンドは，起動状態のHCSCサーバに対して実行してください。

-clusterを指定してエラーになった場合，結果をcscstatusコマンドで確認し，障害要因を取り除いたあとに，再度コマンドを実行してください。

cscsvunsetup（HCSCサーバのアンセットアップ）

形式

cscsvunsetup [-h]
             -user <ログインユーザID>
             -pass <ログインパスワード>
             -csc <HCSCサーバ名>
             [-ignore]

機能

HCSCサーバのアンセットアップをします。

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「3.3.6　HCSCサーバをアンセットアップする」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-csc <HCSCサーバ名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−8文字))

アンセットアップするHCSCサーバ名を指定します。

-ignore

実行環境側のアンセットアップに失敗した場合もリポジトリの情報を更新する場合に指定します。ハードディスク障害やアンセットアップ時の通信障害などによる実行環境とリポジトリ環境の不整合を調整するために使用します。HCSCコンポーネントが配備されていた場合は，リポジトリの情報は更新されません。HCSCコンポーネントの情報を削除する場合は，csccompoundeployコマンドで-ignoreオプションを指定して削除してください。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

2

通信タイムアウトが発生しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

HCSCサーバを停止後，各HCSCコンポーネントが未配備，または未セットアップ状態にしてからこのコマンドを実行してください。HCSCサーバが起動しているときや，各HCSCコンポーネント配備状態，またはセットアップ状態の場合はエラーになります。

cscutil（各種操作）

形式

cscutil [-h]
        -user <ログインユーザID>
        -pass <ログインパスワード>
        {-mng <Manager名>
          ｜-host <IPアドレス>:<ポート番号> -mnguser <管理ユーザID>
            [-mngpass <管理ユーザパスワード>]}
        -target {server｜compo｜compo_urecp｜request_service}
        -operation {start｜stop｜get_setup_info｜get_info
          ｜get_bp_info｜get_adapter_info}
        {-props <プロパティ>｜-propfile <プロパティファイル名>}
        [-binary <ファイル名>]

機能

次に示す操作ができます。

HCSCサーバの起動と停止

HCSCサーバセットアップ情報，HCSCサーバ情報の取得

ビジネスプロセス・サービスアダプタの開始，停止および情報取得

標準受付の開始と停止

ユーザ定義受付の情報取得

ログインユーザIDなどの必須オプションは，HCSC-Managerコマンド共通定義ファイルにデフォルト値を設定することで，このコマンドでの指定を省略できます。

-targetオプションと-operationオプションで設定する内容を操作ごとに次の表に示します。

表5‒9　-targetオプションと-operationオプションの値によって実施できる操作

操作内容

-targetオプション

-operationオプション

HCSCサーバの起動

server

start

ビジネスプロセスの開始

compo

start

サービスアダプタの開始

compo

start

標準受付の開始

request_service

start

標準受付の停止

request_service

stop

サービスアダプタの停止

compo

stop

ビジネスプロセスの停止

compo

stop

HCSCサーバの停止

server

stop

HCSCサーバのセットアップ情報取得

server

get_setup_info

HCSCサーバの情報取得

server

get_info

ビジネスプロセスの情報取得

compo

get_bp_info

サービスアダプタの情報取得

compo

get_adapter_info

ユーザ定義受付の情報取得

compo_urecp

get_info

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザID>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するユーザIDを指定します。

-pass <ログインパスワード>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

HCSC-Managerログイン時に使用するパスワードを指定します。

-mng <Manager名>　〜＜半角英数字およびアンダーバー（_）＞ ((1−16文字))

Managerのマネージャ識別名を指定します。リポジトリ内に存在するManager名を指定してください。

-host <ホスト名またはIPアドレス>：<ポート番号>　〜＜ホスト名またはIPアドレス：文字列，ポート番号：数字＞((文字列：1文字以上，ポート番号：1−65535))

Managerリモート管理機能のホスト名（またはIPアドレス）とポート番号を「:」で連結して指定します。IPアドレス，ポート番号ともに省略はできません。

リポジトリが存在しない状態でも，-hostオプションは指定できます。-hostオプションを指定する場合，-mnguserオプションおよび-mngpassオプションを指定してください。

-mnguser <管理ユーザID>　〜 ((1文字以上))

Managerの管理ユーザIDを指定します。

-mngpass <管理ユーザパスワード>　〜 ((1文字以上))

Managerの管理ユーザIDに対するパスワードを指定します。変更するManagerのユーザIDにパスワードを設定している場合だけ，このオプションを指定できます。

-target {server｜compo｜compo_urecp｜request_service}

実行する操作対象を指定します。

server

実行する操作対象が，HCSCサーバの場合に指定します。

compo

実行する操作対象が，ビジネスプロセスまたはサービスアダプタの場合に指定します。

compo_urecp

実行する操作対象が，ユーザ定義受付の場合に指定します。

request_service

実行する操作対象が，標準受付の場合に指定します。

-operation {start｜stop｜get_setup_info｜get_info｜get_bp_info｜get_adapter_info}

実行する操作を指定します。

start

指定した操作対象を開始する場合に指定します。

stop

指定した操作対象を停止する場合に指定します。

get_setup_info

指定したHCSCサーバのセットアップ情報を取得する場合に指定します。

get_info

指定したHCSCサーバの情報を取得する場合に指定します。

get_bp_info

指定したビジネスプロセスの情報を取得する場合に指定します。

get_adapter_info

指定したサービスアダプタの情報を取得する場合に指定します。

-props <プロパティ>　〜 ((0文字以上))

指定した-target（操作対象）や-operation（操作）に指定するプロパティを「<キー値>= <指定値>」の形式で指定します。指定値はダブルクォーテーション（"）で囲みます。

ただし，キー値および指定値には，次に示す文字を指定できません。指定すると，動作が不定となります。

ダブルクォーテーション（"）

等号（=）

コンマ（,）

また，複数指定する場合，各引数はコンマ（,）で区切ります。

（例）　-props "J2EESrvName=HCSCサーバをセットアップしたJ2EEサーバ名，CSCSrvName=起動するHCSCサーバ名"

次の表に，操作内容に応じた-targetおよび-operationの指定値と，-propsに指定するプロパティを示します。

表5‒10　操作内容に応じた-target（操作対象），-operation（操作），および-propsオプションの指定内容

操作内容

-target

-operation

-propsで指定するプロパティ

HCSCサーバの起動

server

start

J2EESrvName=HCSCサーバをセットアップしたJ2EEサーバ名

CSCSrvName=起動するHCSCサーバ名

ビジネスプロセスの開始

compo

start

AdapterName=起動するビジネスプロセスのサービスID

ServiceKind=アダプタ種別

bp：ビジネスプロセス

J2EESrvName=アダプタを起動するJ2EEサーバ名

CSCSrvName=アダプタを起動するHCSCサーバ名

サービスアダプタの開始

compo

start

AdapterName=起動するサービスアダプタのサービスID

ServiceKind=アダプタ種別

serviceAdapter：サービスアダプタ

J2EESrvName=アダプタを起動するJ2EEサーバ名

CSCSrvName=アダプタを起動するHCSCサーバ名

標準受付の開始

request_service

start

J2EESrvName=HCSCサーバが起動しているJ2EEサーバ名

CSCSrvName=リクエスト受付ができるHCSCサーバ名

標準受付の停止

request_service

stop

J2EESrvName=インポートするJ2EEサーバ名

CSCSrvName=リクエスト抑止するHCSCサーバ名

ForceFlag=強制停止フラグ

NORMAL_OPTION：通常停止

WAIT_OPTION：計画停止

FORCE_OPTION：強制停止

サービスアダプタの停止

compo

stop

J2EESrvName=アダプタを停止するJ2EEサーバ名

CSCSrvName=アダプタを停止するHCSCサーバ名

AdapterName=停止するサービスアダプタのサービスID

ビジネスプロセスの停止

compo

stop

J2EESrvName=アダプタを停止するJ2EEサーバ名

CSCSrvName=アダプタを停止するHCSCサーバ名

AdapterName=停止するビジネスプロセスのサービスID

HCSCサーバの停止

server

stop

J2EESrvName=HCSCサーバをセットアップしたJ2EEサーバ名

CSCSrvName=停止するHCSCサーバ名

ForceFlag=強制停止フラグ

false：通常停止

true：強制停止

HCSCサーバのセットアップ情報取得

server

get_setup_info

CSCSrvName=HCSCサーバ名

HCSCサーバの情報取得

server

get_info

CSCSrvName=状態表示するHCSCサーバ名

ビジネスプロセスの情報取得

compo

get_bp_info

CSCSrvName=HCSCサーバ名

AdapterName=ビジネスプロセスのサービスID

サービスアダプタの情報取得

compo

get_adapter_info

CSCSrvName=HCSCサーバ名

AdapterName=サービスアダプタのサービスID

ユーザ定義受付の情報取得

compo_urecp

get_info

CSCSrvName=ユーザ定義受付の情報を取得するHCSCサーバ名

-propfile <プロパティファイル名>　〜 ((1−200バイト))

引数を記述したプロパティファイル名を絶対パス，または相対パスで指定します。J2SEのプロパティファイル形式で指定します。

-binary <ファイル名>　〜 ((1−200バイト))

バイナリ形式のファイル名を絶対パス，または相対パスで指定します。このオプションは将来使用するために定義されているオプションです。

入力例

(1)HCSCサーバ「HCSC」を起動する場合

cscutil -user admin -pass admin -mng Manager -target server -operation start -props "CSCSrvName=HCSC, J2EESrvName=J2EEServer"

(2)プロパティファイル「cscutil.properties」を使用して，HCSCサーバ「HCSC」を起動する場合

cscutil -user admin -pass admin -host 10.209.13.165:9001 -mnguser admin -mngpass admin -target server -operation start -propfile cscutil.properties

cscutil.propertiesの中身

  CSCSrvName=HCSC
  J2EESrvName=J2EEServer

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

2

通信タイムアウトが発生しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

cscutilコマンドを実行する場合，参照機能（HCSCサーバ情報の参照など）は，複数同時に実行できます。

運用機能（HCSCサーバの起動やサービスアダプタの停止など）を複数同時に実行できません。

csmftpaddusr（FTPインバウンドアダプタのユーザの登録・更新）

形式

csmftpaddusr { -userinfofile <ユーザ情報指定ファイルのパス>
             | -usr <ユーザ名>
               -pass <パスワード>}
             [-r]

機能

FTPインバウンドアダプタに新規のユーザを登録します。登録できるユーザ数は2,048までです。ユーザがすでに登録されている場合は，パスワードを更新します。

コマンドを実行する前の注意事項を次に示します。

このコマンドの-passオプションにパスワードを指定した場合，プロセスの引数を確認できるOS機能などによって，パスワードが検知されるおそれがあります。このため，-userinfofileオプションを使用した，ユーザ情報指定ファイルでのパスワードの設定を推奨します。

コマンドにユーザ情報指定ファイルを指定する場合，運用コマンドを実行する管理者にだけ，ユーザ情報指定ファイルに対する更新・参照のアクセス権を設定してください。

このコマンドはHCSCサーバの稼働の状態に関係なく実行できます。このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.4.12　FTPインバウンドアダプタのユーザ情報を確認・変更する」を参照してください。

引数

-userinfofile <ユーザ情報指定ファイルのパス>

ユーザ名，パスワードが記載されているユーザ情報指定ファイルのパスを絶対パスで指定してください。パスが空白を含む場合は，パス全体をダブルクォーテーション（"）で囲んでください。

指定されたユーザ情報指定ファイルのユーザ情報がすべて正常であれば，その内容が一括で登録または更新されます。ただし，次の場合はエラーとなり，登録・更新は実施されません。

指定されたファイルが存在しない場合

ファイル内のユーザ情報に1つでも不正があった場合

ファイル内にユーザ名が重複している場合

登録済みユーザ情報とユーザ情報指定ファイル内のユーザ情報の合計数が，登録できるユーザ数の上限を上回っている場合

ユーザ名が指定されていない（anonymous）ユーザは，ユーザ情報指定ファイルに登録できません。また，実行対象のユーザ情報指定ファイルには，ユーザ情報の登録または更新のどちらかだけを指定できます。

ユーザ情報指定ファイルの記載方法については，「6.21.1　ユーザ情報指定ファイル」を参照してください。

-usr <ユーザ名>　〜＜半角英数字および半角記号＞ ((1−80文字))

登録または更新したいユーザ名を指定します。ユーザ名が指定されていない（anonymous）ユーザは登録できません。

使用できる文字は，半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」），および半角スペース（ASCIIコードの「0x20」）です。大文字と小文字は区別されます。使用できる半角記号を次に示します。

感嘆符（!）

ダブルクォーテーション（"）

番号記号（#）

ドル記号（$）

パーセント（%）

アンパサンド（&）

アポストロフィ（'）

始め小括弧（(）

終わり小括弧（)）

正符号（+）

ハイフン（-）

ピリオド（.）

スラッシュ（/）

コロン（:）

セミコロン（;）

左アングルブラケット（<）

右アングルブラケット（>）

等号（=）

クエスチョンマーク（?）

単価記号（@）

始め角括弧（[）

終わり角括弧（]）

円マーク（¥）

アクサンシルコンフレックス（^）

アンダーバー（_）

アクサングラーブ（`）

始め波括弧（{）

終わり波括弧（}）

パイプライン（|）

波ダッシュ（~）

-pass <パスワード>　〜＜半角英数字および半角記号＞ ((1−80文字))

登録または変更したいユーザ名に対するパスワードを指定します。使用できる文字は，半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」），および半角スペース（ASCIIコードの「0x20」）です。英字の大文字と小文字は区別されます。使用できる半角記号は-usrオプションと同じです。

更新したい場合（-rオプションを指定する場合），更新後のパスワードを指定します。

-r

すでに登録されているユーザIDのパスワードを変更する場合に指定します。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

FTPインバウンドアダプタが停止している状態でコマンドを実行してください。コマンドの実行内容（ユーザの登録・更新）は，FTPインバウンドアダプタの開始後に有効となります。

FTPインバウンドアダプタが開始している状態でコマンドを実行した場合，コマンドの実行内容（ユーザの登録・更新）は，次にFTPインバウンドアダプタを開始したあとに有効となります。

次の場合はエラーになります。

ユーザの登録，更新，削除および表示を実行中の場合

システム管理者以外がコマンドを実行しようとした場合

csmftpdelusr（FTPインバウンドアダプタのユーザの削除）

形式

csmftpdelusr -usr <ユーザ名>

機能

FTPインバウンドアダプタに登録されているユーザを削除します。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.4.12　FTPインバウンドアダプタのユーザ情報を確認・変更する」を参照してください。

引数

-usr <ユーザ名>　〜＜半角英数字および半角記号＞ ((1−80文字))

削除したいユーザ名を指定します。使用できる文字は，半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」），および半角スペース（ASCIIコードの「0x20」）です。英字の大文字と小文字は区別されます。使用できる半角記号を次に示します。

感嘆符（!）

ダブルクォーテーション（"）

番号記号（#）

ドル記号（$）

パーセント（%）

アンパサンド（&）

アポストロフィ（'）

始め小括弧（(）

終わり小括弧（)）

正符号（+）

ハイフン（-）

ピリオド（.）

スラッシュ（/）

コロン（:）

セミコロン（;）

左アングルブラケット（<）

右アングルブラケット（>）

等号（=）

クエスチョンマーク（?）

単価記号（@）

始め角括弧（[）

終わり角括弧（]）

円マーク（¥）

アクサンシルコンフレックス（^）

アンダーバー（_）

アクサングラーブ（`）

始め波括弧（{）

終わり波括弧（}）

パイプライン（|）

波ダッシュ（~）

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

FTPインバウンドアダプタが停止している状態でコマンドを実行してください。

HCSCサーバの稼働の状態に関係なく，コマンドを実行できます。

コマンドの実行内容（ユーザの削除）は，FTPインバウンドアダプタの開始後に有効となります。また，FTPインバウンドアダプタが開始している状態でコマンドを実行した場合，コマンドの実行内容（ユーザの削除）は，次にFTPインバウンドアダプタを開始したあとに有効となります。

次の場合はエラーになります。

ユーザの登録，更新，削除および表示を実行中の場合

システム管理者以外がコマンドを実行しようとした場合

csmftplsusr（FTPインバウンドアダプタのユーザの表示）

形式

csmftplsusr

機能

FTPインバウンドアダプタに登録されているユーザを表示します。表示結果は標準出力に出力されます。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.4.12　FTPインバウンドアダプタのユーザ情報を確認・変更する」を参照してください。

表示形式

1：ユーザID1

2：ユーザID2

3：ユーザID3

　　：

1行に1ユーザ名を表示します。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

FTPインバウンドアダプタが停止している状態でコマンドを実行してください。

HCSCサーバの稼働の状態に関係なく，コマンドを実行できます。

次の場合はエラーになります。

ユーザの登録，更新，削除および表示を実行中の場合

システム管理者以外がコマンドを実行しようとした場合

csmftplshistory（転送履歴の表示）

形式

csmftplshistory {<J2EEサーバ名> | -logdir <転送履歴ログ格納ディレクトリパス>}
                [-csv <出力ファイルパス>]
                [-date {<表示開始日時>,[<表示終了日時>] | [<表示開始日時>],<表示終了日時>}]

機能

転送履歴を表示します。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.4.18　転送履歴を取得する」を参照してください。

引数

<J2EEサーバ名>

HCSCの開始時に指定したJ2EEサーバ名を指定します。

アンセットアップされたJ2EEサーバ名を指定した場合は，アンセットアップされたJ2EEサーバで取得済みの転送履歴が表示されます。

このオプションは，-logdirオプションを指定した場合は省略できます。

-logdir <転送履歴ログ格納ディレクトリパス>　〜<<<J2EEサーバのログ出力ディレクトリ>¥csc¥inbound-adapter¥ftp¥FTP_Inbound_Resource_Adapter>>

転送履歴ログ格納ディレクトリを絶対パスまたは相対パスで指定します。ただし，Windowsの場合はドライブレター付きの相対パス（例：C:temp¥historyLogDir）は指定できません。指定すると，KDEC07581-E（パラメタ不正）を出力してコマンドが異常終了します。

指定されたディレクトリ下にあるファイル「history.log」「history<面数>.log」が，転送履歴として表示されます。

指定を省略した場合，FTPインバウンドアダプタの転送履歴ログ格納ディレクトリのファイルが，転送履歴として表示されます。

-csv <出力ファイルパス>

転送履歴をCSV形式のファイルに出力します。出力ファイルパスは絶対パスまたは相対パスを指定してください。ただし，Windowsの場合，ドライブレター付きの相対パス（例：C:temp¥history.csv）は指定できません。省略した場合は，転送履歴を標準出力に出力します。

-date <表示開始日時>,<表示終了日時>

転送コマンド開始日時が表示開始日時から表示終了日時までの転送履歴だけを出力する場合に指定します。

なお，表示開始日時と表示終了日時は次の形式で指定してください。

YYYYMMDDhhmmss

YYYY：西暦年（1970≦YYYY）

MM：月（01≦MM≦12）

DD：日（01≦DD≦31）

hh：時（00≦hh≦23）

mm：分（00≦mm≦59）

ss：秒（00≦ss≦59）

表示終了日時に，表示開始日時よりも古い日時が指定された場合は，何も表示されません。また，転送処理が異常終了した場合など，転送コマンド開始日時が転送履歴に保存されていない場合は，その転送履歴は表示されません。

出力形式

CSV形式の出力例

先頭行に出力項目の名称を出力し，1行に1回の転送の履歴情報を出力します。

TransferID UserName ServerFileName…ClientPort
10.209.12.111/2200/0x00000000000000c7 admin /service1/file1…1071
10.209.12.111/2200/0x00000000000000c8 admin /service1/file2…1072
    ：

標準出力への出力例

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
    ：

説明

表示項目

説明

TransferID

転送ごとのユニークな番号を示します。PRFのルートアプリケーションの情報となります。

xxx.xxx.xxx.xxx/aaa/bbbの形式で表示されます。

xxx.xxx.xxx.xxx：ルートアプリケーションのIPアドレス

aaa：ルートアプリケーションのプロセスID

bbb：ルートの通信番号

UserName

認証されたユーザ名を示します。

ServerFileName

クライアントから転送要求されたサーバのファイル名を示します。

/<振分識別子 >/<ファイル名>の形式で表示されます。

TransferType

送受信種別を示します。次に示すどれかが表示されます。

RETR：サーバからクライアントへのファイル転送

STOR：クライアントからサーバへのファイル転送

APPE：クライアントからサーバへのファイル転送（サーバ上のファイルへ追加書き）

TransferMode

転送要求時に指定した転送モードを示します。

ASCII：ASCIIモード

BINARY：BINARYモード

CompressionMode

転送要求時に指定した圧縮モードを示します。

compress：圧縮

uncompress：非圧縮

unknown：データコネクションのオープンに失敗

Status

ファイル転送の終了状態を示します。

SUCCESS：成功

FAILURE：失敗

TransferCmdStartTime

転送コマンドを受信して転送コマンドの処理を開始した時刻を示します。

YYYY/MM/DD HH:MM:SS.mmmの形式で表示されます。

YYYY：西暦年

MM：月

DD：日

HH：時

MM：分

SS：秒

mmm：ミリ秒

*****：転送コマンドの処理開始前にエラーが発生

TransferCmdEndTime

転送コマンドの処理を終了した時刻を示します。

YYYY/MM/DD HH:MM:SS.mmmの形式で表示されます。

YYYY：西暦年

MM：月

DD：日

HH：時

MM：分

SS：秒

mmm：ミリ秒

TransferCmdTime

転送コマンドの処理に掛かった，通算の時間を示します。

ss.SSSの形式で表示されます。

ss：秒

SSS：ミリ秒

*****：転送コマンドの処理開始前にエラーが発生

TransferStartTime

ファイル転送を開始した時刻を示します。

YYYY/MM/DD HH:MM:SS.mmmの形式で表示されます。

YYYY：西暦年

MM：月

DD：日

HH：時

MM：分

SS：秒

mmm：ミリ秒

*****：転送開始前にエラーが発生

TransferEndTime

ファイル転送を終了した時刻を示します。

YYYY/MM/DD HH:MM:SS.mmmの形式で表示されます。

YYYY：西暦年

MM：月

DD：日

HH：時

MM：分

SS：秒

mmm：ミリ秒

*****：転送に失敗

TransferTime

ファイル転送に掛かった，通算の時間を示します。

ss.SSSの形式で表示されます。

ss：秒

SSS：ミリ秒

*****：転送に失敗

TransferSize

転送したファイルのデータサイズをバイトで示します。

転送に失敗した場合は「-1」と表示されます。

ClientIP

転送が要求されたクライアントのIPアドレスを示します。

ClientPort

転送が要求されたクライアントのポート番号を示します。

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

3

排他エラーが発生しました。

9

実行権限のチェックエラーが発生しました。

注意事項

HCSCサーバの稼働の状態に関係なく，コマンドを実行できます。

FTPインバウンドアダプタの状態に関係なく，コマンドを実行できます。

システム管理者以外がコマンドを実行しようとした場合，エラーとなります。

csmmailaddusr（メールアダプタユーザ情報の登録・更新）

形式

csmmailaddusr [-h]
              { -userinfofile <ユーザ情報指定ファイルのパス>
               | -user <ログインユーザ名>
                 -pass <ログインパスワード>}
              [-r]
              -f <メールアダプタアカウント定義ファイルのパス>

機能

メールアダプタアカウント定義ファイルに新規のユーザを登録します。登録できるユーザ数の上限はありません。すでに登録されているユーザに対しては，パスワードを更新します。

コマンドを実行する前の注意事項を次に示します。

このコマンドの-passオプションにパスワードを指定した場合，プロセスの引数を確認できるOS機能などによって，パスワードが検知されるおそれがあります。このため，-userinfofileオプションを使用した，ユーザ情報指定ファイルでのパスワードの設定を推奨します。

コマンドを実行する管理者にだけ，メールアダプタアカウント定義ファイルに対する更新・参照のアクセス権を設定してください。

コマンドにユーザ情報指定ファイルを指定する場合，コマンドを実行する管理者にだけ，ユーザ情報指定ファイルに対する更新・参照のアクセス権を設定してください。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.5.1　ユーザ情報の管理」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-userinfofile <ユーザ情報指定ファイルのパス>

ログインユーザ名，ログインパスワードが記載されているユーザ情報指定ファイルのパスを指定します。絶対パス，またはコマンド実行時のカレントディレクトリからの相対パスで指定してください。パスが空白を含む場合は，パス全体をダブルクォーテーション（"）で囲んでください。

指定されたユーザ情報指定ファイルのユーザ情報がすべて正常であれば，その内容がメールアダプタアカウント定義ファイルに一括で登録または更新されます。ただし，次の場合はエラーとなり，登録・更新は実施されません。

指定されたファイルが存在しない場合

ファイル内のユーザ情報に1つでも不正があった場合

ファイル内にログインユーザ名が重複している場合

なお，実行対象のユーザ情報指定ファイルには，ユーザ情報の登録または更新のどちらかだけを指定できます。

ユーザ情報指定ファイルの記載方法については，「6.21.1　ユーザ情報指定ファイル」を参照してください。

-user <ログインユーザ名>　〜＜半角英数字および半角記号＞

登録または更新したいユーザ名を指定します。

使用できる文字は，半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」），および半角スペース（ASCIIコードの「0x20」）です。大文字と小文字は区別されます。使用できる半角記号を次に示します。

感嘆符（!）

ダブルクォーテーション（"）

番号記号（#）

ドル記号（$）

パーセント（%）

アンパサンド（&）

アポストロフィ（'）

始め小括弧（(）

終わり小括弧（)）

アスタリスク（*）

正符号（+）

コンマ（,）

ハイフン（-）

ピリオド（.）

スラッシュ（/）

コロン（:）

セミコロン（;）

左アングルブラケット（<）

右アングルブラケット（>）

等号（=）

クエスチョンマーク（?）

単価記号（@）

始め角括弧（[）

終わり角括弧（]）

円マーク（¥）

アクサンシルコンフレックス（^）

アンダーバー（_）

アクサングラーブ（`）

始め波括弧（{）

終わり波括弧（}）

パイプライン（|）

波ダッシュ（~）

-pass <ログインパスワード>　〜＜半角英数字および半角記号＞

登録または更新したいユーザ名に対応するパスワードを指定します。使用できる文字は，半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」），および半角スペース（ASCIIコードの「0x20」）です。大文字と小文字は区別されます。使用できる半角記号は-userオプションと同じです。

更新したい場合（-rオプションを指定する場合），更新後のパスワードを指定します。

-r

すでに登録されているユーザのパスワードを変更する場合に指定します。

-f <メールアダプタアカウント定義ファイルのパス>

メールアダプタアカウント定義ファイルのパスを相対パス，または絶対パスで指定します。空白を含む場合は，オプション引数全体をダブルクォーテーション（"）で囲みます。

ファイルが存在しない場合，新規にメールアダプタアカウント定義ファイルが作成されます。ただし，ディレクトリが存在しない場合は，エラーになります。既存のメールアダプタアカウント定義ファイルに新規ユーザ情報を追加する場合は，既存のメールアダプタアカウント定義ファイルを指定してください。

入力例

(1)ユーザ名「user2」，パスワード「password2」をメールアダプタアカウント定義ファイル「account.properties」に登録する場合

csmmailaddusr -user user2 -pass password2 -f account.properties

(2)ユーザ情報指定ファイル「userinfo.txt」に記載されたユーザ情報を一括でメールアダプタアカウント定義ファイル「account.properties」に登録する場合

csmmailaddusr -userinfofile userinfo.txt -f account.properties

(3)メールアダプタアカウント定義ファイル「account.properties」に登録されているユーザ名「user2」のパスワードを「passwordnew」に更新する場合

csmmailaddusr -user user2 -pass passwordnew -r -f account.properties

(4)メールアダプタアカウント定義ファイル「account.properties」に登録されているユーザ情報をユーザ情報指定ファイル「userinfo.txt」に記載されたユーザ情報で一括更新する場合

csmmailaddusr -userinfofile userinfo.txt -r -f account.properties

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

9

実行権限のチェックエラーが発生しました。

注意事項

メールアダプタアカウント定義ファイルは編集できません。

csmmaildelusr（メールアダプタユーザ情報の削除）

形式

csmmaildelusr [-h]
              -user <ログインユーザ名>
              -f <メールアダプタアカウント定義ファイルのパス>

機能

メールアダプタアカウント定義ファイルに登録されているユーザ情報を削除します。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.5.1　ユーザ情報の管理」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-user <ログインユーザ名>　〜＜半角英数字および半角記号＞

削除したいユーザ名を指定します。使用できる文字は，半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」），および半角スペース（ASCIIコードの「0x20」）です。大文字と小文字は区別されます。使用できる半角記号を次に示します。

感嘆符（!）

ダブルクォーテーション（"）

番号記号（#）

ドル記号（$）

パーセント（%）

アンパサンド（&）

アポストロフィ（'）

始め小括弧（(）

終わり小括弧（)）

アスタリスク（*）

正符号（+）

コンマ（,）

ハイフン（-）

ピリオド（.）

スラッシュ（/）

コロン（:）

セミコロン（;）

左アングルブラケット（<）

右アングルブラケット（>）

等号（=）

クエスチョンマーク（?）

単価記号（@）

始め角括弧（[）

終わり角括弧（]）

円マーク（¥）

アクサンシルコンフレックス（^）

アンダーバー（_）

アクサングラーブ（`）

始め波括弧（{）

終わり波括弧（}）

パイプライン（|）

波ダッシュ（~）

-f <メールアダプタアカウント定義ファイルのパス>

メールアダプタアカウント定義ファイルのパスを相対パス，または絶対パスで指定します。空白を含む場合は，オプション引数全体をダブルクォーテーション（"）で囲みます。

入力例

メールアダプタアカウント定義ファイル「account.properties」に登録されているユーザ名「user2」のユーザ情報を削除する場合

csmmaildelusr -user user2 -f account.properties

ユーザ情報の削除コマンドの実行によって，メールアダプタアカウント定義ファイルの内容は次のように変更されます。

【コマンド実行前】

1: user1
2: user2
　　:
　　:

【コマンド実行後】

1: user1
　　:
　　:

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

9

実行権限のチェックエラーが発生しました。

注意事項

メールアダプタアカウント定義ファイルは編集できません。

メールアダプタアカウント定義ファイルのユーザ情報が0個になってもメールアダプタアカウント定義ファイルは削除されません。

コマンドを実行する前に，コマンドを実行する管理者にだけ，メールアダプタアカウント定義ファイルに対する更新・参照のアクセス権を設定してください。

csmmaillsusr（メールアダプタユーザ情報の表示）

形式

csmmaillsusr [-h]
             -f <メールアダプタアカウント定義ファイルのパス>

機能

メールアダプタアカウント定義ファイルに登録されているユーザを表示します。表示結果は標準出力形式で出力します。

このコマンドの使用方法については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.5.1　ユーザ情報の管理」を参照してください。

引数

-h

コマンドの使用方法が表示されます。このオプションを指定している場合は，ほかのオプションを指定しても無視されます。

-f <メールアダプタアカウント定義ファイルのパス>

メールアダプタアカウント定義ファイルのパスを相対パス，または絶対パスで指定します。空白を含む場合は，オプション引数全体をダブルクォーテーション（"）で囲みます。

表示形式

(1)ユーザ情報が登録されている場合

1: User ID1
2: User ID2
　　:

　　ユーザ名は，アルファベット順に1行ずつ表示されます。

(2)ユーザ情報が登録されていない場合

none

戻り値

戻り値

意味

0

正常終了しました。

1

コマンドが異常終了しました。

9

実行権限のチェックエラーが発生しました。

注意事項

メールアダプタアカウント定義ファイルは編集できません。

コマンドを実行する前に，コマンドを実行する管理者にだけ，メールアダプタアカウント定義ファイルに対する更新・参照のアクセス権を設定してください。

6　定義ファイル（運用環境・実行環境）

この章では，サービスプラットフォームの運用環境および実行環境で使用する定義ファイルの文法について説明します。

6.1　定義ファイルの種類

運用環境・実行環境の定義ファイルの種類を次に示します。列「入力形式」のうち「任意の形式」を除くファイル形式については，「6.2　定義ファイルの入力形式」を参照してください。

表6‒1　定義ファイル一覧（運用環境・実行環境）

分類

ファイル名

概要

入力形式

HCSCサーバの構築で利用するファイル

cscsetupコマンド定義ファイル

cscsetupコマンドの動作に必要となる情報を設定します。

プロパティファイル形式

HCSCサーバ構成定義ファイル

HCSCサーバの構成定義情報を設定します。

XML形式

HCSCサーバセットアップ定義ファイル

HCSCサーバのセットアップ時に設定できる内容を設定します。

プロパティファイル形式

HCSCサーバの運用で利用するファイル

HCSC-ManagerコマンドJavaVM起動オプション定義ファイル

コマンドの実行時に適用するJavaVM起動オプションを設定します。「csc」で始まるコマンドが対象です。

Windowsの場合，バッチファイル形式

UNIXの場合，シェルスクリプトファイル形式

HCSC-Managerコマンド共通定義ファイル

各コマンドのオプションのデフォルト値を定義します。

プロパティファイル形式

HCSC-Manager定義ファイル

HCSC-Managerの動作に必要となる情報を設定します。

プロパティファイル形式

HCSC-Messagingコマンド共通定義ファイル

HCSC-Messagingコマンドの動作に必要な情報を設定します。

Windowsの場合，バッチファイル形式

UNIXの場合，シェルスクリプトファイル形式

HCSCコンポーネント指定ファイル

HCSCコンポーネントと処理内容を設定します。

テキストファイル形式

HCSCサーバランタイム定義ファイル

セットアップ後のHCSCサーバの定義情報をHCSC-Managerから設定します。

プロパティファイル形式

エミュレート設定情報定義ファイル

サービスのエミュレーション機能の設定情報をXML形式で設定します。

XML形式

コンポーネントID設定ファイル

ユーザ電文トレースへの出力有無をHCSCコンポーネントIDで設定します。

プロパティファイル形式

コンポーネント種別設定ファイル

ユーザ電文トレースへ出力するHCSCコンポーネントをHCSCコンポーネント種別で設定します。

プロパティファイル形式

サービス情報変更定義ファイル

サービスアダプタのサービス情報の変更を設定します。

プロパティファイル形式

SOAP連携で利用するファイル

SOAP Fault動作定義ファイル

targetNamespaceのURIを設定します。

独自形式

ユーザ定義受付ランタイム定義ファイル

SOAP受付の情報を設定します。

プロパティファイル形式

TP1連携で利用するファイル

TP1アダプタ実行環境プロパティファイル

TP1アダプタが実行環境で動作するときの，TP1/Client/J環境定義ファイルのパスなどを設定します。

プロパティファイル形式

FTP連携で利用するファイル

FTPアダプタアカウント定義ファイル

ユーザアカウント情報を一括管理します。ファイルの内容は運用コマンドで管理します。

（編集不可）

FTPアダプタコマンド定義ファイル

FTPアダプタで使用するコマンドのメッセージログの構成情報を設定します。

プロパティファイル形式

FTPアダプタ実行環境プロパティファイル

FTPアダプタごとの構成情報を設定します。

プロパティファイル形式

FTPアダプタ実行環境共通プロパティファイル

すべてのFTPアダプタに共通の構成情報を設定します。

プロパティファイル形式

FTP受付コンフィグファイル

FTP受付をセットアップしたあとに設定変更が発生する頻度が高い内容を設定します。

プロパティファイル形式

FTPコマンド許可リスト定義ファイル

転送前，転送後，リストコマンド実行前，またはリストコマンド実行後に実行を許可するFTPコマンドを設定します。

プロパティファイル形式

FTP実行許可リスト定義ファイル

FTP受付に関連づけられたビジネスプロセスの実行を許可するユーザや，許可しないユーザを設定します。

プロパティファイル形式

ファイル操作アダプタ実行環境プロパティファイル

ファイル操作アダプタが実行環境で動作する際のメッセージログとトレースログの出力レベルなどを設定します。

プロパティファイル形式

リストコマンドオプション定義ファイル

FTPクライアントが実行するリストコマンドの引数に指定できるオプション文字列を設定します。

独自形式

ファイルイベント連携で利用するファイル

ファイルイベント受付コンフィグファイル

特定のファイルイベント受付に関する構成情報を設定します。

プロパティファイル形式

ファイルイベント受付共通コンフィグファイル

すべてのファイルイベント受付に共通する構成情報を設定します。

プロパティファイル形式

ファイルアダプタで利用するファイル

ファイルアダプタ実行環境プロパティファイル

ファイルアダプタが実行環境で動作するときのメッセージログおよびトレースログの出力レベルなどを設定します。

プロパティファイル形式

Object Accessアダプタで利用するファイル

Object Accessアダプタ実行環境プロパティファイル

Object Accessアダプタが実行環境で動作する際のログやトレースの出力レベルなどを設定します。

プロパティファイル形式

Message Queueアダプタで利用するファイル

Message Queueアダプタ実行環境プロパティファイル

Message Queueアダプタが実行環境で動作する際のログやトレースの出力レベルなどを設定します。

プロパティファイル形式

メールアダプタで利用するファイル

メールアダプタアカウント定義ファイル

ユーザアカウント情報を一括管理します。ファイルの内容は運用コマンドで管理します。

プロパティファイル形式

メールアダプタコマンド定義ファイル

メールアダプタで使用するコマンドのメッセージログの出力情報を設定します。

プロパティファイル形式

メールアダプタ実行環境プロパティファイル

メールアダプタごとの構成情報を設定します。

プロパティファイル形式

メールヘッダ定義ファイル

ユーザが定義した任意のメールヘッダのオプションを設定します。

プロパティファイル形式

HTTPアダプタで利用するファイル

HTTPアダプタアカウント定義ファイル

ベーシック認証に必要なユーザアカウント情報を一括管理します。ファイルの内容は運用コマンドで管理します。

プロパティファイル形式

HTTPアダプタ実行環境プロパティファイル

HTTPアダプタごとの構成情報を設定します。

プロパティファイル形式

HTTPアダプタ実行環境共通プロパティファイル

すべてのHTTPアダプタに共通の構成情報を設定します。

プロパティファイル形式

コマンドアダプタで利用するファイル

実行許可コマンド定義ファイル

コマンドアダプタで実行できる外部コマンドを設定します。

任意の形式

プロセス環境変数定義ファイル

外部コマンドプロセスだけで有効になる環境変数を設定します。

プロパティファイル形式

コマンドアダプタ実行環境プロパティファイル

コマンドアダプタごとの構成情報を設定します。

プロパティファイル形式

コマンドアダプタ実行環境共通プロパティファイル

すべてのコマンドアダプタに共通の構成情報を設定します。

プロパティファイル形式

SFTPアダプタで利用するファイル

SFTPアダプタ実行環境プロパティファイル

SFTPアダプタごとの構成情報を設定します。

プロパティファイル形式

SFTPアダプタ実行環境共通プロパティファイル

すべてのSFTPアダプタに共通の構成情報を設定します。

プロパティファイル形式

Kafkaアダプタで利用するファイル

Kafkaアダプタ実行環境プロパティファイル

Kafkaアダプタごとの構成情報を設定します。

プロパティファイル形式

Kafkaアダプタ実行環境共通プロパティファイル

すべてのKafkaアダプタに共通の構成情報を設定します。

プロパティファイル形式

スケジュール駆動受付で利用するファイル

スケジュール駆動受付コンフィグファイル

特定のスケジュール駆動受付に関する構成情報を設定します

プロパティファイル形式

スケジュール駆動受付共通コンフィグファイル

すべてのスケジュール駆動受付に共通の構成情報を設定します。

プロパティファイル形式

gRPCアダプタで利用するファイル

gRPCアダプタ実行環境プロパティファイル

gRPCアダプタごとの構成情報を設定します。

プロパティファイル形式

gRPCアダプタ実行環境共通プロパティファイル

すべてのgRPCアダプタに共通の構成情報を設定します。

プロパティファイル形式

ユーザ認証情報で利用するファイル

ユーザ認証情報管理コマンド定義ファイル

ユーザ認証情報管理コマンドを実行した場合の構成定義を設定します。

プロパティファイル形式

アカウント情報管理コマンド定義ファイル

アカウント情報管理コマンドを実行した場合の構成定義を設定します。

プロパティファイル形式

ユーザ情報の登録で利用するファイル

ユーザ情報指定ファイル

ユーザ情報を設定します。

任意の形式

6.2　定義ファイルの入力形式

「6.1　定義ファイルの種類」の表の列「入力形式」の種類ごとに，定義ファイルの作成または編集時の注意事項を示します。

プロパティファイル形式

次に示すJavaのプロパティファイル形式で作成または編集します。

形式

定義ファイルの入力形式を次に示します。

<キー名称> = <値>

#<コメント>

各項目について説明します。

キー名称

定義するキー名称を指定します。

同じキーを定義ファイル内に複数指定した場合は，java.util.Propertiesクラスの仕様に基づき，最後に指定したキーの値が反映されます。

指定値を省略する場合はキー名称とあわせて省略してください。キー名称だけを記述することはできません。

区切り文字

区切り文字として「=」を指定します。スペースまたはタブでも代替できます。

値

定義する値がある場合に指定します。改行までを値とするため，値の後ろには，空白やコメントなどの文字列は指定できません。

コメント

行頭に「#」または「!」を記述した場合，その行はコメントとして扱われます。

なお，各項目は，ISO-8859-1文字エンコーディングを使用してください。ISO-8859-1文字エンコーディングで直接表現できない文字を記述した場合は，次に示すhjdk.native2ascii.jarツールを実行してUnicodeへ変換してください。

<サービスプラットフォームのインストールディレクトリ>¥jdk¥bin¥java -jar <サービスプラットフォームのインストールディレクトリ>¥jdk¥lib¥hcompatlib¥hjdk.native2ascii.jar <入力ファイルパス> <出力ファイルパス>

hjdk.native2ascii.jarツールの詳細については，JDKのドキュメントを参照してください。

XML形式

XMLの仕様に従って作成または編集します。

バッチファイル形式またはシェルスクリプトファイル形式

OSに応じて次に示すファイル形式で作成または編集します。

Windowsの場合：Win32のバッチファイル形式

UNIXの場合：シェルスクリプトファイル形式

独自形式

定義ファイル独自の仕様に従って作成または編集します。

6.3　定義ファイルの文法の記述形式

以降で説明する定義ファイルの文法について，次の形式で記述します。なお，すべてのファイルを次の形式で記述しているわけではありません。また，各ファイルの固有情報を記載している場合があります。

形式

ファイルの記述形式を示します。

機能

ファイルの機能について説明します。

DTD

ファイルのDTDについて説明します。

ファイルの格納先

ファイルの格納先を示します。

設定できる要素

ファイルの中で指定できるXMLの要素について説明します。

設定できるパラメタ

ファイルの中で指定できるパラメタについて説明します。

設定できるプロパティ

ファイルの中で指定できるプロパティについて説明します。プロパティ名の可変値は<>で囲んで示します。

記述例

ファイルの内容の記述例を示します。

使用方法

ファイルの使用方法について説明します。

注意事項

ファイルを設定または使用する際の注意事項を説明します。

この章の文法の説明で使用している記号を次に示します。

記号

意味

　｜

横に並べられた複数の項目に対する項目間の区切りを示し，「または」を意味します。

（例）　A｜B

AまたはBを指定することを示します。

{ 　 }

この記号で囲まれている複数の項目のうちから1つを選択することを示します。項目が横に並べられ，記号｜で区切られている場合は，そのうちの1つを選択します。

（例）　｛A｜B｜C｝

A，BまたはCのどれかを指定することを示します。

［　］

この記号で囲まれている項目は省略してもよいことを示します。

（例）　［A］

「何も指定しない」か「Aを指定する」ことを示します。

<　>

この記号で囲まれている項目は，該当する要素を指定することを示します。

（例）　<プロパティ>

プロパティを記述します。

…

記述が省略されていることを示します。

（例）　ABC…

ABCの後ろに記述があり，その記述が省略されていることを示します。

〜

この記号の前に示された項目が，記号〜に続く＜　＞，((　))，<<　>>などの規則に従うことを示します。

＜　＞

項目を記述するときに従わなければならない構文要素を示します。構文要素については，次の表を参照してください。

((　))

項目で指定できる値の範囲を示します。

<<　>>

項目を省略したときに，システムが仮定する標準値を示します。

この章で使用している構文要素の種類と定義を次に示します。

種類

定義

英字

A〜Z　a〜z

英小文字

a〜z

英大文字

A〜Z

数字

0〜9

英数字

A〜Z　a〜z　0〜9

記号

_　.　-

文字列

任意の文字の配列

6.4　HCSCサーバの構築で利用するファイル

6.4.1　cscsetupコマンド定義ファイル

(1)　形式

owner=Component Container管理者で設定するオーナー
group=Component Container管理者で設定するグループ

(2)　機能

cscsetupコマンドの動作に必要となる情報を設定します。HCSC本番環境簡易セットアップで使用する定義ファイルです。

(3)　ファイルの格納先

次に示すテンプレートファイルを任意のディレクトリにコピーし，コピーしたファイルを編集して定義ファイルを作成してください。

本番環境をセットアップする場合

SOAP1.1モードのテンプレートファイル

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥manager¥templates¥hsetup¥esb¥cscsetup.properties

SOAP1.1/1.2併用モードのテンプレートファイル（J2EEサーバの互換モードが推奨モードの場合）

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥manager¥templates¥hsetup¥esb_1.1_1.2mode_v11¥cscsetup.properties

SOAP1.1/1.2併用モードのテンプレートファイル（J2EEサーバの互換モードがV9互換モードの場合）

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥manager¥templates¥hsetup¥esb_1.1_1.2mode¥cscsetup.properties

セットアップ済みの本番環境にサーバを追加（追加セットアップ）する場合

SOAP1.1モードのテンプレートファイル

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥manager¥templates¥hsetup¥esb_add¥cscsetup.properties

SOAP1.1/1.2併用モードのテンプレートファイル（J2EEサーバの互換モードが推奨モードの場合）

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥manager¥templates¥hsetup¥esb_1.1_1.2mode_v11_add¥cscsetup.properties

SOAP1.1/1.2併用モードのテンプレートファイル（J2EEサーバの互換モードがV9互換モードの場合）

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥manager¥templates¥hsetup¥esb_1.1_1.2mode_add¥cscsetup.properties

(4)　設定できるパラメタ

owner=Component Container管理者で設定するオーナー　〜<<スーパーユーザ>>

Component Container管理者で設定するオーナーを指定します。

group=Component Container管理者で設定するグループ　〜<<スーパーユーザ>>

Component Container管理者で設定するプライマリGIDを指定します。

(5)　注意事項

ownerおよびgroupの値を指定しない場合は，次に示す値がデフォルト値となります。任意のComponent Container管理者に変更して運用したい場合は，この定義ファイルでオーナーおよびグループを指定してください。

Linuxの場合

オーナー：root，グループ：root

AIXの場合

オーナー：root，グループ：system

6.4.2　HCSCサーバ構成定義ファイル

(1)　形式

<?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>クラスタ名</name>
    <type>クラスタ種別</type>
  </cluster>
  <cosminexus-manager>
    <!-- Cosminexus Manager Definition -->
    <name>Manager名</name>
    <ip-address>ManagerのIPアドレスまたはホスト名</ip-address>
    <port>Managerのポート番号</port>
    <id>Management Serverの管理ユーザID</id>
    <password>Management Serverの管理ユーザパスワード</password>
    <csc-server>
      <!-- HCSC-Server Definition -->
      <name>HCSCサーバ名</name>
      <id>HCSCサーバが使用するデータベースのユーザID</id>
      <password>HCSCサーバが使用するデータベースのパスワード</password>
      <j2ee-server-name>HCSCサーバが使用するJ2EEサーバ名</j2ee-server-name>
      <setup-properties>HCSCサーバセットアップ定義ファイル名</setup-properties>
    </csc-server>
  </cosminexus-manager>
  <reception>
    <soap-reception>
      <!-- WebServer Definition -->
      <ip-address>WebサーバのIPアドレスまたはホスト名</ip-address>
      <port>Webサーバのポート番号</port>
     <protocol>プロトコル種別</protocol>
    </soap-reception>
    <jms-reception>
      <!-- WebServer Definition-->
      <ip-address>WebサーバのIPアドレスまたはホスト名</ip-address>
      <port>Webサーバのポート番号</port>
      <protocol>プロトコル種別(http or https)</protocol>
      <rm-service-context-root>RMのサービスコンテキストルート</rm-service-context-root>
    </jms-reception>
    <jms-physical-reception>
      <!-- WebServer Definition-->
      <ip-address>WebサーバのIPアドレスまたはホスト名</ip-address>
      <port>Webサーバのポート番号</port>
      <protocol>プロトコル種別</protocol>
      <rm-service-context-root>RMのサービスコンテキストルート</rm-service-context-root>
    </jms-physical-reception>
    <ejb-reception>
      <!-- NameServer Definition-->
      <ip-address>NameServerのIPアドレスまたはホスト名</ip-address>
      <port>NameServerのポート番号</port>
    </ejb-reception>
  </reception>
</csc-setup-definition>

(2)　機能

HCSCサーバの構成情報をXML形式で設定します。

(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)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥manager¥templates¥cscsvsetup.xml

(5)　設定できる要素

(a)　clusterの定義

clusterタグは省略できます。

name　クラスタ名　〜＜半角英数字とアンダーバー（_）＞ ((1−8文字))

クラスタ名を指定します。このタグを設定することで，cscsvsetupコマンドの-clusterを省略できます。

type　クラスタ種別　〜<<LB>>

クラスタ種別として，次のどちらかを指定します。ロードバランスクラスタ構成の場合は，省略できます。なお，必ず大文字で指定してください。

LB

ロードバランスクラスタ構成の場合に指定します。

HA

HAクラスタ構成の場合に指定します。

(b)　cosminexus-managerの定義

name　Manager名　〜＜半角英数字とアンダーバー（_）＞ ((1−16文字))

HCSC-ManagerがManagerを認識するためのHCSC-Manager独自の識別名を指定します。HCSC-ManagerでManager（ホスト）単位に一意になる識別名を指定します。

ip-address　ManagerのIPアドレスまたはホスト名　〜((1文字以上))

Management Serverが起動しているIPアドレスまたはホスト名を指定します。2回目以降設定を変えて再セットアップすると，値が上書きされます。

port　Managerのポート番号　〜((1−65535))

Management Serverのリモート管理機能への接続ポート番号を指定します。

com.cosminexus.mngsvr.management.portの値を指定します。指定がない場合は，28099を指定します。2回目以降設定を変えて再セットアップすると，値が上書きされます。

id　Management Serverの管理ユーザID　〜((1文字以上))

Management Serverの管理ユーザIDを指定します。

password　Management Serverの管理ユーザパスワード　〜((1文字以上))

Management Serverの管理ユーザパスワードを指定します。このタグは省略できます。省略した場合，パスワードの指定がないとみなされます。

(c)　csc-serverの定義

name　HCSCサーバ名　〜＜半角英数字とアンダーバー（_）＞ ((1−8文字))

HCSCサーバ名を指定します。このタグを設定することで，cscsvsetupコマンドの-cscを省略できます。

id　HCSCサーバが使用するデータベースのユーザID　〜((1文字以上))

HCSCサーバが使用するデータベースのユーザIDを指定します。文字列の最大値および指定できる文字は，使用するデータベースに依存します。データベースを使用する場合は，必ず設定します。データベースを使用しない場合は，省略できます。

password　HCSCサーバが使用するデータベースのパスワード

HCSCサーバが使用するデータベースのパスワードを指定します。文字列の最大値および指定できる文字は，使用するデータベースに依存します。データベースを使用する場合は，必ず設定します。データベースを使用しない場合は，省略できます。

j2ee-server-name　HCSCサーバが使用するJ2EEサーバ名　〜((1文字以上))

HCSCサーバをセットアップするJ2EEサーバ名を指定します。J2EEサーバ名は110バイト以内を推奨します。ローカルマシンにIPv6アドレスを使用している環境では，111バイト以上のJ2EEサーバ名を指定すると，プロセスインスタンスの生成でエラーが発生する可能性があります。その場合は，HCSCサーバランタイム定義のshort-processidプロパティにONを指定してください。

setup-properties　HCSCサーバセットアップ定義ファイル名

HCSCサーバセットアップ定義ファイル名を相対パス，または絶対パスで指定します。

(d)　soap-receptionの定義

同期サービス（Webサービス）呼び出しをする場合に指定します。同期サービス（Webサービス）呼び出しをしない場合は，soap-receptionタグを省略してください。

ip-address　WebサーバのIPアドレスまたはホスト名　〜<<Managerと同じIPアドレスまたはホスト名>>

Webサーバが起動しているIPアドレスまたはホスト名を指定します。受付とManagement ServerのIPアドレス（またはホスト名）が同じ場合は，省略できます。2回目以降設定を変えて再セットアップすると，値が上書きされます。

port　Webサーバのポート番号　〜((1−65535))

Webサーバの受付ポート番号を指定します。2回目以降設定を変えて再セットアップすると，値が上書きされます。

protocol　プロトコル種別

Webサーバの受付プロトコルとして，次のどちらかを指定します。2回目以降設定を変えて再セットアップすると，値が上書きされます。

http

HTTPで受け付けられます。

https

HTTPSで受け付けられます。

(e)　jms-receptionの定義

クラスタ種別がHAクラスタで，非同期サービス（MDB（WS-R））呼び出しをする場合に指定します。非同期サービス（MDB（WS-R））呼び出しをしない場合は，jms-receptionタグを省略してください。クラスタ種別がロードバランスクラスタの場合は，値を指定しても無視されます。

ip-address　WebサーバのIPアドレスまたはホスト名　〜<<Managerと同じIPアドレスまたはホスト名>>

Webサーバが起動しているIPアドレスまたはホスト名を指定します。受付とManagement ServerのIPアドレス（またはホスト名）が同じ場合は，省略できます。2回目以降設定を変えて再セットアップすると，値が上書きされます。

port　Webサーバのポート番号　〜((1−65535))

Webサーバの受付ポート番号を指定します。2回目以降設定を変えて再セットアップすると，値が上書きされます。

protocol　プロトコル種別

Webサーバの受付プロトコルとして，次のどちらかを指定します。2回目以降設定を変えて再セットアップすると，値が上書きされます。

http

HTTPで受け付けられます。

https

HTTPSで受け付けられます。

rm-service-context-root　RMのサービスコンテキストルート　〜((1文字以上))

Reliable Messagingのサービスコンテキストルート名を指定します。2回目以降設定を変えて再セットアップすると，値が上書きされます。

(f)　jms-physical-receptionの定義

クラスタ種別がロードバランスクラスタで，非同期サービス（MDB（WS-R））呼び出しをする場合に指定します。非同期サービス（MDB（WS-R））呼び出しをしない場合や，Reliable Messagingを使用しない場合は，jms-physical-receptionタグを省略してください。クラスタ種別がHAクラスタの場合は，値を指定しても無視されます。

ip-address　WebサーバのIPアドレスまたはホスト名　〜<<Managerと同じIPアドレスまたはホスト名>>

Webサーバが起動しているIPアドレスまたはホスト名を指定します。受付とManagement ServerのIPアドレス（またはホスト名）が同じ場合は，省略できます。2回目以降設定を変えて再セットアップすると，値が上書きされます。

port　Webサーバのポート番号　〜((1−65535))

Webサーバの受付ポート番号を指定します。2回目以降設定を変えて再セットアップすると，値が上書きされます。

protocol　プロトコル種別

Webサーバの受付プロトコルとして，次のどちらかを指定します。2回目以降設定を変えて再セットアップすると，値が上書きされます。

http

HTTPで受け付けられます。

https

HTTPSで受け付けられます。

rm-service-context-root　RMのサービスコンテキストルート　〜((1文字以上))

Reliable Messagingのサービスコンテキストルート名を指定します。2回目以降設定を変えて再セットアップすると，値が上書きされます。

(g)　ejb-receptionの定義

SessionBeanを呼び出す場合に指定します。SessionBeanを呼び出さない場合は，ejb-receptionタグを省略してください。

ip-address　NameServerのIPアドレスまたはホスト名　〜((1文字以上))<<Managerと同じIPアドレスまたはホスト名>>

ネームサーバが起動しているIPアドレスまたはホスト名を指定します。受付とManagement ServerのIPアドレス（またはホスト名）が同じ場合は，省略できます。2回目以降設定を変えて再セットアップすると，値が上書きされます。

port　NameServerのポート番号　〜((1−65535))

ネームサーバの受付ポート番号を指定します。2回目以降設定を変えて再セットアップすると，値が上書きされます。

(6)　記述例

HCSCサーバ構成定義ファイルの記述例を次に示します。

<?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クラスタ</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)　使用方法

cscsvsetupコマンドの-propfileオプションの引数にHCSCサーバ構成定義ファイルを指定します。詳細については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「3.1.3　HCSCサーバをセットアップする」を参照してください。

6.4.3　HCSCサーバセットアップ定義ファイル

(1)　形式

［db-use={ON|OFF}］
［rm-use={ON|OFF}］
［hcscserver-data-filepath=HCSCサーバのシステム管理情報を保存する出力先のパス］

　request-ejb={ON|OFF}
　request-soap={ON|OFF}
　request-jms={ON|OFF}
［request-jms.maxmessage=標準の非同期受付（MDB（WS-R））のキューの最大メッセージ数］
　request-dbq={ON|OFF}
［request-dbq.maxmessage=標準の非同期受付（MDB（DBキュー））のキューの最大メッセージ数］
［request-jms-rdarea=標準の非同期受付（MDB（WS-R））のRDエリア名］
［request-dbq-rdarea=標準の非同期受付（MDB（DBキュー））のRDエリア名］
［request-dbq-maxlen=標準の非同期受付（MDB（DBキュー））の最大メッセージ長］

［request-userdef-soap={ON|OFF}］

［naming-service-hostname=ネーミングサービスのホスト名］
［naming-service-port=ネーミングサービスのポート番号］

［rm-systemname=Reliable Messagingのシステム名］
［rm-displayname=Reliable Messagingの表示名］

［dbcon-xadisplayname=XATransactionまたはLocalTransaction用DB Connectorの表示名］
［dbcon-nodisplayname=NoTransaction用DB Connectorの表示名］

［dbtype={HIRDB|ORACLE11G}］
［jdbc-type={DBPSV|HIRDB-TYPE4|ORACLE-THIN}］
［jdbc-url=JDBC用データベースURL］
［jdbc-dbhostname=データベースのホスト名］
［jdbc-dbconnectinfo=データベースの接続情報］
［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=HCSC基本情報テーブル領域］
［server-trans-tbl-area=連携HCSC用テーブル領域］
［location-tbl-area=ロケーション用テーブル領域］
［routing-tbl-area=ルーティング用テーブル領域］
［cv-tbl-area=データ変換用テーブル領域］

［exehistory-tbl-area=実行履歴情報テーブル領域］
［exehistory-idx-area=実行履歴情報テーブルのインデクスを格納する領域］
［process-tbl-area=ビジネスプロセス基盤用PROCESSテーブルを格納する領域］
［process-idx-area=ビジネスプロセス基盤用PROCESSテーブルのインデクスを格納する領域］
［activity-tbl-area=ビジネスプロセス基盤用ACTIVITYテーブルを格納する領域］
［activity-idx-area=ビジネスプロセス基盤用ACTIVITYテーブルのインデクスを格納する領域］
［link-tbl-area=ビジネスプロセス基盤用LINKテーブルを格納する領域］
［link-idx-area=ビジネスプロセス基盤用LINKテーブルのインデクスを格納する領域］
［correlationset-tbl-area=ビジネスプロセス基盤用CORRELATIONSETテーブルを格納する領域］
［correlationset-idx-area=ビジネスプロセス基盤用CORRELATIONSETテーブルのインデクスを格納する領域］
［string-variable-tbl-area=ビジネスプロセス基盤用STRING-VARIABLEテーブルを格納する領域］
［string-variable-idx-area=ビジネスプロセス基盤用STRING-VARIABLEテーブルのインデクスを格納する領域］
［numeric-variable-tbl-area=ビジネスプロセス基盤用NUMERIC-VARIABLEテーブルを格納する領域］
［numeric-variable-idx-area=ビジネスプロセス基盤用NUMERIC-VARIABLEテーブルのインデクスを格納する領域］
［boolean-variable-tbl-area=ビジネスプロセス基盤用BOOLEAN-VARIABLEテーブルを格納する領域］
［boolean-variable-idx-area=ビジネスプロセス基盤用BOOLEAN-VARIABLEテーブルのインデクスを格納する領域］
［message-variable-tbl-area=ビジネスプロセス基盤用MESSAGE-VARIABLEテーブルを格納する領域］
［message-variable-idx-area=ビジネスプロセス基盤用MESSAGE-VARIABLEテーブルのインデクスを格納する領域］
［message-variable-val-area=ビジネスプロセス基盤用MESSAGE-VARIABLEテーブルのVariableValue列を格納する領域］
［message-relation-tbl-area=ビジネスプロセス基盤用MESSAGE-RELATIONテーブルを格納する領域］
［message-relation-idx-area=ビジネスプロセス基盤用MESSAGE-RELATIONテーブルのインデクスを格納する領域］
［clusterinfo-tbl-area=クラスタ情報を格納する領域］
［haasyncadp-tbl-area=クラスタ内で配備された非同期アダプタサービスIDを格納する領域］
［sql-scriptfilename=SQLスクリプトファイルパス］
［activitynumber-maximum-compatible={ON|OFF}］

［xmlanalyze-mode={standard|advanced}］

(2)　機能

HCSCサーバのセットアップ時に設定できる内容を設定します。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥manager¥templates¥cscsvsetup.properties

(4)　設定できるプロパティ

(a)　セットアップ構成関連

db-use={ON｜OFF}　〜<<ON>>

HCSCサーバでデータベースを使用するかどうかを指定します。

ON

データベースを使用します。

OFF

データベースを使用しません。

rm-use={ON｜OFF}　〜<<ON>>

HCSCサーバでReliable Messagingを使用するかどうかを指定します。db-useプロパティでOFFを指定した場合，このプロパティにONを指定するとエラーになります。

ON

Reliable Messagingを使用します。

OFF

Reliable Messagingを使用しません。

hcscserver-data-filepath=HCSCサーバのシステム管理情報を保存する出力先のパス　〜<最大100バイトの文字列><<<サービスプラットフォームのインストールディレクトリ>¥CSC¥spool¥msg>>

HCSCサーバのシステム管理情報を保存する出力先を絶対パスで指定します。ディレクトリ区切りは「/」または「¥¥」を使用します。存在しないディレクトリを指定した場合，および指定した文字列が100バイトを超える場合はエラーになります。そのため，<サービスプラットフォームのインストールディレクトリ>が84バイトを超える場合は，このプロパティを明示的に指定してください。なお，指定できる長さのバイトは，ISO-8859-1でデコードしたあとの長さになります。

(b)　標準受付関連

request-ejb={ON｜OFF}

標準の同期受付（SessionBean）を使用するかどうかを指定します。

ON

標準の同期受付（SessionBean）を使用します。

OFF

標準の同期受付（SessionBean）を使用しません。

次に示す場合は，ONを指定してください。

サービスリクエスタからSessionBeanを使用してサービス部品を呼び出す場合

運用環境の画面上でプロセスインスタンスを再実行する場合

cscpireexecコマンドを使用してプロセスインスタンスを再実行する場合

request-soap={ON｜OFF}

標準の同期受付（Webサービス）を使用するかどうかを指定します。

ON

標準の同期受付（Webサービス）を使用します。

OFF

標準の同期受付（Webサービス）を使用しません。

サービスリクエスタからWebサービスを使用してサービス部品を呼び出す場合は，ONを指定してください。

request-jms={ON｜OFF}

標準の非同期受付（MDB（WS-R））を使用するかどうかを指定します。rm-useプロパティでOFFを指定した場合，このプロパティにONを指定するとエラーになります。

ON

標準の非同期受付（MDB（WS-R））を使用します。

OFF

標準の非同期受付（MDB（WS-R））を使用しません。

次に示す場合は，ONを指定してください。

サービスリクエスタからMDB（WS-R）を使用してサービス部品を呼び出す場合

配備するビジネスプロセスで応答アクティビティを実行したあとに，基本アクティビティ（受付，サービス呼出，Java呼出，データ変換，代入，無操作，フォルト送出，補償，待機，ログ出力，途中終了）を実行するようなビジネスプロセスを定義した場合

request-jms.maxmessage=標準の非同期受付（MDB（WS-R））のキューの最大メッセージ数　〜＜数字＞((1−65535))<<1024>>

標準の非同期受付（MDB（WS-R））の受付キュー作成時の最大メッセージ数を指定します。Reliable Messagingでの設定値に依存します。request-jmsプロパティでONを指定した場合だけ有効になります。

request-dbq={ON｜OFF}

標準の非同期受付（MDB（DBキュー））を使用するかどうかを指定します。rm-useプロパティでOFFを指定した場合，このプロパティにONを指定するとエラーになります。

ON

標準の非同期受付（MDB（DBキュー））を使用します。

なお，Oracleの場合はONを指定できません。

OFF

標準の非同期受付（MDB（DBキュー））を使用しません。

サービスリクエスタから（MDB（DBキュー））を使用してサービス部品を呼び出す場合は，ONを指定してください。

request-dbq.maxmessage=標準の非同期受付（MDB（DBキュー））のキューの最大メッセージ数　〜＜数字＞((1−65535))<<1024>>

標準の非同期受付（MDB（DBキュー））の受付キュー作成時の最大メッセージ数を指定します。Reliable Messagingでの設定値に依存します。request-dbqプロパティでONを指定した場合だけ有効になります。

request-jms-rdarea=標準の非同期受付（MDB（WS-R））のRDエリア名　〜＜先頭が英字の英数字，空白，およびアンダーバー（_）＞((1−30文字))

標準の非同期受付（MDB（WS-R））のRDエリア名を指定します。データベースにOracleを使用している場合は無効になります。Reliable Messagingでの設定値に依存するため，Reliable Messagingを使用する場合だけ指定できます。

request-dbq-rdarea=標準の非同期受付（MDB（DBキュー））のRDエリア名　〜＜先頭が英字の英数字，空白，およびアンダーバー（_）＞((1−30文字))

標準の非同期受付（MDB（DBキュー））のRDエリア名を指定します。データベースにOracleを使用している場合は無効になります。Reliable Messagingでの設定値に依存するため，Reliable Messagingを使用する場合だけ指定できます。

request-dbq-maxlen=標準の非同期受付（MDB（DBキュー））の最大メッセージ長　〜＜数字＞((1000−1048576))<<33000>>

標準の非同期受付（MDB（DBキュー））の最大メッセージ長をバイト単位で指定します。Reliable Messagingでの指定値に依存します。

(c)　ユーザ定義受付関連

request-userdef-soap={ON｜OFF}　〜<<OFF>>

SOAP受付を使用するかどうかを指定します。

ON

SOAP受付を使用します。

OFF

SOAP受付を使用しません。

注意事項

OFFの場合でもユーザ定義受付を配備・実行できます。ただし，OFFの場合，開発環境でユーザ定義受付を定義するとき，サービスリクエスタからの要求先Webサービスのアドレスが表示されないので注意してください。

(d)　J2EE関連

naming-service-hostname=ネーミングサービスのホスト名　〜＜文字列＞

ネーミングサービスのホスト名を指定します。サービスプラットフォームで指定した名称に依存します。このプロパティの指定を省略した場合，Management Serverで設定しているホスト名が設定されます。

naming-service-port=ネーミングサービスのポート番号　〜＜数字＞((1−65535))

ネーミングサービスのポート番号を指定します。サービスプラットフォームでの設定値に依存します。このプロパティの指定を省略した場合，Management Serverで管理している論理J2EEサーバのインプロセスネーミングサービス用のポート番号が設定されます。

(e)　Reliable Messaging関連

rm-systemname=Reliable Messagingのシステム名　〜＜先頭が英字の大文字英字または数字＞((1−3文字))

HCSCサーバが使用するReliable MessagingのRMシステム名を指定します。Reliable Messagingを使用しない場合は指定できません。

サービスプラットフォームで指定した名称に依存します。rm-useプロパティでONを指定した場合は，必ず指定します。rm-useプロパティでOFFを指定した場合，このプロパティを指定するとエラーになります。

rm-displayname=Reliable Messagingの表示名　〜＜英数字およびアンダーバー（_）＞

HCSCサーバが使用するReliable Messaging（リソースアダプタ）の表示名をサニタイズ（半角英数字以外をアンダーバー（_）に変更）した値を指定します。Reliable Messagingを使用しない場合は指定できません。

サービスプラットフォームでの名称に依存します。rm-useプロパティでONを指定した場合は，必ず指定します。rm-useプロパティでOFFを指定した場合，このプロパティを指定するとエラーになります。

(f)　DBコネクタ関連

dbcon-xadisplayname=XATransactionまたはLocalTransaction用DB Connectorの表示名　〜＜英数字およびアンダーバー（_）＞

HCSCサーバが使用するXATransaction用，またはLocalTransaction用のDB Connectorの表示名をサニタイズ（半角英数字以外をアンダーバー（_）に変更）した値を指定します。サービスプラットフォームでの名称に依存します。db-useプロパティでONを指定した場合は，必ず指定します。db-useプロパティでOFFを指定した場合，このプロパティを指定するとエラーになります。

dbcon-nodisplayname=NoTransaction用DB Connectorの表示名

HCSCサーバが使用するNoTransaction用DB Connectorの表示名をサニタイズ（半角英数字以外をアンダーバー（_）に変更）した値を指定します。サービスプラットフォームでの名称に依存します。db-useプロパティでONを指定した場合は，必ず指定します。db-useプロパティでOFFを指定した場合，このプロパティを指定するとエラーになります。

(g)　データベース関連

dbtype={HIRDB｜ORACLE11G}

HCSCサーバで使用するデータベース種別を指定します。db-useプロパティでONを指定した場合は，必ず指定します。db-useプロパティでOFFを指定した場合，このプロパティを指定するとエラーになります。

HIRDB

使用するデータベースとしてHiRDBを使用します。

ORACLE11G

使用するデータベースとしてOracleを使用します。

jdbc-type={DBPSV｜HIRDB-TYPE4｜ORACLE-THIN}

HCSCサーバオフライン時に使用するJDBCドライバの種別を指定します。db-useプロパティでONを指定した場合は，必ず指定します。db-useプロパティでOFFを指定した場合，このプロパティを指定するとエラーになります。

DBPSV

DABroker LibraryのJdbcDbpsvDriverを使用します。DBPSVを指定した場合は，必ずjdbc-dbhostnameプロパティ，およびjdbc-dbconnectinfoプロパティを指定します。DABroker Libraryを使用してOracleへのデータベースにはアクセスできません。J2EEサーバの互換モードがV9互換モードの場合だけ指定できます。

HIRDB-TYPE4

HiRDB Type4 JDBC Driverを使用します。HIRDB-TYPE4を指定した場合は，必ずjdbc-dbhostnameプロパティ，およびjdbc-dbconnectinfoプロパティを指定します。

ORACLE-THIN

Oracle JDBC Thin Driverを使用します。dbtypeプロパティで，使用するデータベース種別にORACLE11Gを指定した場合は，必ず指定します。また，ORACLE-THINを指定した場合は，必ずjdbc-urlプロパティを指定します。

jdbc-url=JDBC用データベースURL　〜＜文字列＞

HCSCサーバオフライン時に使用するJDBCドライバごとに対応した接続設定情報として，Driver.connectメソッドで接続する際に指定する，接続先のデータベースのURLを指定します。jdbc-typeプロパティで，JDBCドライバ種別にORACLE-THINを指定した場合は必ず指定します。

jdbc-typeプロパティにDBPSVを指定した場合

jdbc-urlプロパティの指定は無効になります。

jdbc-typeプロパティにHIRDB-TYPE4を指定した場合

jdbc-urlプロパティの指定は無効になります。

jdbc-typeプロパティにORACLE-THINを指定した場合

Oracle JDBC Thin Driverがデータベースに接続する際に使用するURLを指定します。「jdbc:oracle:thin:@」より後ろの部分を指定します。URLの形式については，Oracleのマニュアルを参照してください。データベースに接続する際に使用するユーザ名とパスワードを含むURLは指定しないでください。なお，データベースに接続する際のユーザ名とパスワードは，HCSCサーバ構成定義ファイルで指定します。

jdbc-dbhostname=データベースのホスト名　〜＜文字列＞((最大2086文字))

HCSCサーバオフライン時にHCSCサーバが使用するHiRDBのホスト名またはIPアドレスを指定します。jdbc-typeプロパティで，JDBCドライバ種別にDBPSVおよびHIRDB-TYPE4を指定した場合は必ず指定します。jdbc-typeプロパティにORACLE-THINを指定した場合，jdbc-dbhostnameプロパティの指定は無効になります。

jdbc-dbconnectinfo=データベースの接続情報　〜＜英数字＞

HCSCサーバオフライン時に使用する接続情報（ポート番号，または環境変数グループ名）を指定します。ディレクトリ区切りは「/」または「¥¥」を使用します。DABrokerまたはHiRDBの設定値に依存します。jdbc-typeプロパティで，JDBCドライバ種別にDBPSVおよびHIRDB-TYPE4を指定した場合は必ず指定します。

jdbc-typeプロパティにDBPSVを指定した場合

HiRDBシステムのポート番号，またはHiRDBクライアントの環境変数グループ名を指定します。環境変数グループ名を指定する場合，必ず先頭の@DABENVGRPを含めて指定します。

jdbc-typeプロパティにHIRDB-TYPE4を指定した場合

HiRDBシステムのポート番号，またはHiRDBクライアントの環境変数グループファイル名を指定します。環境変数グループファイル名を指定する場合，必ず先頭の@HIRDBENVGRP=指定に続けて，環境変数グループファイル名を絶対パス名で指定します。

jdbc-typeプロパティにORACLE-THINを指定した場合

jdbc-dbconnectinfoプロパティの指定は無効になります。

db-character-sets={ASCII｜Shift_JIS｜UTF-8｜EUC-JP}

使用するデータベースで指定した文字コード種別を指定します。

コマンド受付（MBean）や標準受付で入力チェックの際に「XMLスキーマ定義のNCName」の長さ（データベースに入れることができる文字列のバイト数）を，指定された文字コードに変換してチェックするために使用します。

db-useプロパティでONを指定した場合は，必ず指定します。データベースを使用しない場合は，このプロパティの指定を省略できます。db-useプロパティでOFFを指定した場合で，このプロパティを指定しなかったときは，UTF-8に変換してチェックします。UTF-8以外を指定した場合は，指定された文字コードでチェックします。

ASCII

使用するデータベースで指定した文字コード種別がASCIIの場合に指定します。

Shift_JIS

使用するデータベースで指定した文字コード種別がShift_JISの場合に指定します。

UTF-8

使用するデータベースで指定した文字コード種別がUTF-8の場合に指定します。

EUC-JP

使用するデータベースで指定した文字コード種別がEUC-JPの場合に指定します。

db-tbl-split-key={NONE｜MONTH}　〜<<NONE>>

日付データによるテーブルのレンジ分割機能を使用するかどうかを指定します。

NONE

レンジ分割機能を使用しません。

MONTH

レンジ分割機能を使用します。プロセスインスタンスが開始された月（GMT）を分割キーとして，テーブルに登録されます。

テーブルのレンジ分割機能を使う場合の分割方法は，sql-scriptfilenameプロパティで指定されたSQLスクリプトファイルで定義します。テーブルの構成については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「付録C　データベースのテーブルの情報」を参照してください。

db-tbl-split-corcheck-use={ON｜OFF}　〜<<OFF>>

相関セットの重複チェックを強化するかどうかを指定します。HiRDBで実行履歴情報テーブルの分割機能を利用する場合はONを指定してください。

ON

相関セットの重複チェックを強化します。

OFF

相関セットの重複チェックを強化しません。

テーブルの分割機能を利用する場合，分割方法はsql-scriptfilenameに指定するSQLスクリプトファイルで定義します。テーブルの構成については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「付録C　データベースのテーブルの情報」を参照してください。

(h)　ビジネスプロセスの状態の互換性

bp-status-compatible={ON｜OFF}

次の内容を指定します。永続化するビジネスプロセスを使用する場合に有効となります。

ビジネスプロセスのサービス呼出アクティビティが実行中の状態で例外（エラー）が発生した場合，プロセスインスタンスおよびアクティビティをエラー状態（Error）に設定するかどうか

通信モデルが同期のサービス呼出アクティビティの実行時以外で，トランザクションを終了または開始するかどうか

サービス呼出アクティビティのトランザクションおよびステータス遷移は，bp-status-compatibleとbp-invoke-status-compatibleの組み合わせによって異なります。詳細については，マニュアル「サービスプラットフォーム解説」の「3.4.4　サービス呼出アクティビティのトランザクション」を参照してください。

08-10以降を新規インストールした場合のデフォルト値は「OFF」です。また，08-00以前のバージョンから移行した場合のデフォルト値は「ON」です。

(i)　サービス呼出アクティビティの状態の互換性

bp-invoke-status-compatible={ON｜OFF}

ビジネスプロセスのサービス呼出アクティビティの実行が正常に完了した場合，トランザクションを終了または開始するかどうかを指定します。

bp-status-compatibleに「OFF」を指定した場合に有効になります。また，永続化するビジネスプロセスを使用する場合に有効となります。

サービス呼出アクティビティのトランザクションおよびステータス遷移は，bp-status-compatibleとbp-invoke-status-compatibleの組み合わせによって異なります。詳細については，マニュアル「サービスプラットフォーム解説」の「3.4.4　サービス呼出アクティビティのトランザクション」を参照してください。

新規インストールした場合のデフォルト値は「OFF」です。また，08-70以前のバージョンから移行した場合のデフォルト値は「ON」です。

(j)　データベースのRDエリア（表領域）情報

cscserverinfo-tbl-area=HCSC基本情報テーブル領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

HCSC基本情報テーブルを作成するテーブル領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってテーブル領域が決定されます。

server-trans-tbl-area=連携HCSC用テーブル領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

連携HCSCディレクトリを作成するテーブル領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってテーブル領域が決定されます。

location-tbl-area=ロケーション用テーブル領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

ロケーションディレクトリを作成するテーブル領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってテーブル領域が決定されます。

routing-tbl-area=ルーティング用テーブル領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

ルーティングディレクトリを作成するテーブル領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってテーブル領域が決定されます。

cv-tbl-area=データ変換用テーブル領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

データ変換ディレクトリを作成するテーブル領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってテーブル領域が決定されます。

exehistory-tbl-area=実行履歴情報テーブル領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

実行履歴情報テーブルを作成するテーブル領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってテーブル領域が決定されます。

exehistory-idx-area=実行履歴情報テーブルのインデクスを格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

実行履歴情報テーブルのインデクスを作成する領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってインデクス領域が決定されます。

process-tbl-area=ビジネスプロセス基盤用PROCESSテーブルを格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

ビジネスプロセス基盤用PROCESSテーブルを作成する領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってテーブル領域が決定されます。

process-idx-area=ビジネスプロセス基盤用PROCESSテーブルのインデクスを格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

ビジネスプロセス基盤用PROCESSテーブルのインデクスを作成する領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってインデクス領域が決定されます。

activity-tbl-area=ビジネスプロセス基盤用ACTIVITYテーブルを格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

ビジネスプロセス基盤用ACTIVITYテーブルを作成する領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってテーブル領域が決定されます。

activity-idx-area=ビジネスプロセス基盤用ACTIVITYテーブルのインデクスを格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

ビジネスプロセス基盤用ACTIVITYテーブルのインデクスを作成する領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってインデクス領域が決定されます。

link-tbl-area=ビジネスプロセス基盤用LINKテーブルを格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

ビジネスプロセス基盤用LINKテーブルを作成する領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってテーブル領域が決定されます。

link-idx-area=ビジネスプロセス基盤用LINKテーブルのインデクスを格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

ビジネスプロセス基盤用LINKテーブルのインデクスを作成する領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってインデクス領域が決定されます。

correlationset-tbl-area=ビジネスプロセス基盤用CORRELATIONSETテーブルを格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

ビジネスプロセス基盤用CORRELATIONSETテーブルを作成する領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってテーブル領域が決定されます。

correlationset-idx-area=ビジネスプロセス基盤用CORRELATIONSETテーブルのインデクスを格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

ビジネスプロセス基盤用CORRELATIONSETテーブルのインデクスを作成する領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってインデクス領域が決定されます。

string-variable-tbl-area=ビジネスプロセス基盤用STRING-VARIABLEテーブルを格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

ビジネスプロセス基盤用STRING-VARIABLEテーブルを作成する領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってテーブル領域が決定されます。

string-variable-idx-area=ビジネスプロセス基盤用STRING-VARIABLEテーブルのインデクスを格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

ビジネスプロセス基盤用STRING-VARIABLEテーブルのインデクスを作成する領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってインデクス領域が決定されます。

numeric-variable-tbl-area=ビジネスプロセス基盤用NUMERIC-VARIABLEテーブルを格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

ビジネスプロセス基盤用NUMERIC-VARIABLEテーブルを作成する領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってテーブル領域が決定されます。

numeric-variable-idx-area=ビジネスプロセス基盤用NUMERIC-VARIABLEテーブルのインデクスを格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

ビジネスプロセス基盤用NUMERIC-VARIABLEテーブルのインデクスを作成する領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってインデクス領域が決定されます。

boolean-variable-tbl-area=ビジネスプロセス基盤用BOOLEAN-VARIABLEテーブルを格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

ビジネスプロセス基盤用BOOLEAN-VARIABLEテーブルを作成する領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってテーブル領域が決定されます。

boolean-variable-idx-area=ビジネスプロセス基盤用BOOLEAN-VARIABLEテーブルのインデクスを格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

ビジネスプロセス基盤用BOOLEAN-VARIABLEテーブルのインデクスを作成する領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってインデクス領域が決定されます。

message-variable-tbl-area=ビジネスプロセス基盤用MESSAGE-VARIABLEテーブルを格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

ビジネスプロセス基盤用MESSAGE-VARIABLEテーブルを作成する領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってテーブル領域が決定されます。

message-variable-idx-area=ビジネスプロセス基盤用MESSAGE-VARIABLEテーブルのインデクスを格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

ビジネスプロセス基盤用MESSAGE-VARIABLEテーブルのインデクスを作成する領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってインデクス領域が決定されます。

message-variable-val-area=ビジネスプロセス基盤用MESSAGE-VARIABLEテーブルのVariableValue列を格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

ビジネスプロセス基盤用MESSAGE-VARIABLEテーブルのVariableValue列を作成する領域を指定します。

HiRDBの場合

指定は不要です。このプロパティを指定しても無効となります。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってテーブル領域が決定されます。

message-relation-tbl-area=ビジネスプロセス基盤用MESSAGE-RELATIONテーブルを格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

ビジネスプロセス基盤用MESSAGE-RELATIONテーブルを作成する領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってテーブル領域が決定されます。

message-relation-idx-area=ビジネスプロセス基盤用MESSAGE-RELATIONテーブルのインデクスを格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

ビジネスプロセス基盤用MESSAGE-RELATIONテーブルのインデクスを作成する領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってインデクス領域が決定されます。

clusterinfo-tbl-area=クラスタ情報を格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

クラスタ内でセットアップされたクラスタ情報を格納するテーブルを作成する領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってテーブル領域が決定されます。

haasyncadp-tbl-area=クラスタ内で配備された非同期アダプタサービスIDを格納する領域　〜＜文字列，RDエリア名の場合：先頭が英字の英数字と空白＞((RDエリア名の場合：1−30文字))

クラスタ内で配備された非同期アダプタサービスIDを格納するテーブルを作成する領域を指定します。使用するデータベースの種類によって，指定する値が異なります。

HiRDBの場合

RDエリア名を指定します。

Oracleの場合

表領域を指定します。

このプロパティの指定を省略した場合，使用するデータベースに従ってテーブル領域が決定されます。

sql-scriptfilename=SQLスクリプトファイルパス　〜＜文字列＞

データベース作成用のSQLスクリプトファイルパスを絶対パスで指定します。ディレクトリ区切りは「/」または「¥¥」を使用します。

このプロパティはオプション機能です。このプロパティでユーザSQLファイルを指定する場合，SQLファイルのTABLE名，INDEX名，VIEW名を誤らないようにしてください。誤ったものを指定すると動作は保証されません。また，HCSCサーバのアンセットアップ時には，SQLファイルの内容に関係なく，HCSCサーバが使用するテーブル一式が削除されます。ただし，HAクラスタ内で共有できるテーブルについては，クラスタ内で最後のHCSCサーバをアンセットアップする場合にだけ削除します。HCSCサーバが使用するテーブル一式については，マニュアル「サービスプラットフォームシステム構築・運用ガイド」の「7.5.3　HCSCサーバのセットアップおよびアンセットアップ時の回復方法」を参照してください。

また，SQLスクリプトファイルについては，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「付録D　SQLスクリプトファイルの設定」を参照してください。

なお，このプロパティを指定した場合，次に示すプロパティは無効になります。

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)　アクティビティインスタンスの最大数の互換性

activitynumber-maximum-compatible={ON｜OFF}　〜<<OFF>>

1つのプロセスインスタンスで生成できるアクティビティインスタンスの識別番号の上限値を指定します。

ON

最大32,768個を生成できます。

OFF

最大2,147,483,648個を生成できます。

デフォルト値は次のとおりです。

08-50以降を新規インストールした場合

デフォルト値は「OFF」です。

08-10以前のバージョンから移行した場合

データベースを使用していない環境ではデフォルト値は「OFF」，データベースを使用している環境ではデフォルト値は「ON」です。

(l)　XML解析

xmlanalyze-mode={standard｜advanced}　〜<<standard>>

XMLの解析モードを次の中から選択します。XML解析処理で09-00以前との互換性を重視する場合，またはSOAP添付ファイル機能を利用する場合は，「standard」を設定してください。

standard

XML全体を解析します。

advanced

次に示す処理を実行する場合に，メモリ使用量や処理性能が改善します。

SOAP1.1/1.2併用モードのSOAP受付を使用する場合

SOAP1.1/1.2併用モードのSOAPアダプタを使用する場合

DBアダプタを使用する場合

データ変換を実行する場合

「advanced」を指定した場合の注意事項を次に示します。

XML文章全体を解析しないため，不正なXMLであってもエラーが発生しない場合があります。

SOAP添付ファイル機能が利用できません。

次に示すコンポーネントは，XML電文の解析にStAXを使用します。

SOAP受付（SOAP1.1/1.2併用モードの場合）

SOAPアダプタ（SOAP1.1/1.2併用モードの場合）

DBアダプタ

ビジネスプロセス（ヘッダ割当て処理）

そのため，次の点に注意してリクエスタやサービスを作成してください。

XMLバージョン1.1の電文を設定した場合，例外が発生します。

ISO-10646-UCS-4エンコーディングを使用した場合，例外が発生します。

XML文書に「:」で始まる要素名が含まれる場合，例外は発生しません。

XML文書中の文字データの中にCDATAセクション終了区切り子（"]]>"）が単独で含まれる場合，例外は発生しません。

空要素タグは次のように，開始タグと終了タグで出力されます。

（例）　<sample></sample>

StAXを使用する場合の注意事項については，マニュアル「XML Processor ユーザーズガイド」の「6.4　StAXに関する注意事項」を参照してください。

(5)　記述例

HiRDBを使用した場合の例を次に示します。

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)　使用方法

HCSCサーバ構成定義ファイルの要素setup-propertiesにHCSCサーバセットアップ定義ファイルを指定します。

(7)　注意事項

同じプロパティを複数指定した場合は，動作は保証されません。

標準受付を使用しない場合でも，次のプロパティのどれかには"ON"を設定してください。ONに設定した場合は，関連するHCSCサーバ構成定義ファイルの<reception>タグも併せて設定してください。設定していない場合，HCSCサーバセットアップ時にメッセージKDEC10073-Eが出力されます。

request-ejb

request-soap

request-jms

request-dbq

パスを指定する場合の注意事項を次に示します。

相対パス，親ディレクトリ表現（「..¥」，「../」），およびカレントディレクトリ表現（「.¥」，「./」）を含むパスは指定しないでください。

シンボリックリンクを含むパスは指定しないでください。

Windowsの場合，UNC形式，NTFSのストリーム名，および予約デバイス名を含むパスは指定しないでください。また，パスの大文字と小文字は区別されません。

6.5　HCSCサーバの運用で利用するファイル

6.5.1　HCSC-ManagerコマンドJavaVM起動オプション定義ファイル

(1)　形式

Windowsの場合

Win32のバッチファイル形式で指定してください。△は半角スペースを示します。

set△cscjvmopt_<コマンド名>=<JavaVM起動オプション1>［△<JavaVM起動オプション2>］［△…］

UNIXの場合

シェルスクリプトファイル形式で指定してください。△は半角スペースを示します。

cscjvmopt_<コマンド名>="<JavaVM起動オプション1>［△<JavaVM起動オプション2>］［△…］"

(2)　機能

コマンドごとに，適用するJavaVM起動オプションを設定します。対象となるコマンドは，運用環境または実行環境のコマンドのうち，コマンド名が「csc」で始まるコマンドです。運用環境または実行環境のコマンドについては，「5.　コマンド（運用環境・実行環境）」を参照してください。

設定したJavaVM起動オプションは，コマンドの環境変数（UNIXの場合は変数）の値として設定されます。そのため，ファイルを設定または変更した場合は，次回のコマンド実行時から適用されます。

ファイルの作成時には次の点に注意してください。

UNIXの場合，オプション全体を「"」（ダブルクォーテーション）で囲んで指定してください。

"="の前後にはスペースを入れないでください。

スペルミスなど，JavaVM起動オプションとして不正な値が設定された場合の挙動はJavaVMに依存します。

なお，JavaVM起動オプションを設定した場合の動作はJavaVMの仕様に従います。コマンドの実行時にJavaVMエラーが発生するなど，期待どおりの動作とならない場合は，ファイルを修正してコマンドを再実行してください。

JavaVM起動オプションの引数に次のようなファイルパスを指定した場合，動作は保証しません。

スペースを含むファイルパスを指定した場合。

ファイルパスを「"」（ダブルクォーテーション）や「'」（シングルクォーテーション）で囲んだ場合。

指定誤りの例（UNIXの場合）

cscjvmopt_cscpiselect=-XX:HitachiJavaLog:"/opt/Program△Files"

(3)　ファイルの格納先

Windowsの場合

テンプレートファイル：

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥manager¥templates¥cscjvmopt.bat

設定したファイルの格納場所およびファイル名：

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥manager¥cscjvmopt.bat

UNIXの場合

テンプレートファイル：

/opt/Cosminexus/CSC/config/manager/templates/cscjvmopt

設定したファイルの格納場所およびファイル名：

/opt/Cosminexus/CSC/config/manager/cscjvmopt

(4)　設定できるJavaVM起動オプション

JavaVM起動オプションの引数の設定範囲など詳細については，マニュアル「アプリケーションサーバ リファレンス 定義編(サーバ定義)」の「14.　JavaVM起動オプション」を参照してください。ここに記載していないJavaVM起動オプションを設定した場合，動作は保証できません。

-Xms

ヒープ領域（New領域＋Old領域）の初期値を指定します。

-Xmx

ヒープ領域（New領域＋Old領域）の最大値を指定します。

-Xss

スレッドのスタックサイズを指定します。

-XX:MetaspaceSize

Metaspace領域の初期値を指定します。

-XX:MaxMetaspaceSize

Metaspace領域の最大値を指定します。

-XX:HitachiJavaLog

JavaVMログファイルのプリフィックスおよびログファイルの出力先ディレクトリを指定します。

複数のHCSC-Manager環境を構築した場合のログファイル出力先の設定について

環境変数CSCMNG_HOMEを複数設定して1台のマシンに複数のHCSC-Manager環境を構築した場合，ログファイル出力先が重複しないよう設定してください。同じログファイル出力先を設定した場合は動作を保証できません。環境変数CSCMNG_HOMEについては，マニュアル「サービスプラットフォームシステム構築・運用ガイド」の「2.9.2　1台のマシンに複数の環境を構築する流れ」を参照してください。

HCSC-Manager環境ごとにログファイル出力先を切り替えるには，引数に環境変数CSCMNG_HOMEを含めることを推奨します（例：-XX:HitachiJavaLog:%CSCMNG_HOME%¥log）。

この場合，ログファイルの出力先は次のようにHCSC-Manager環境ごとに切り替えられます。

環境変数CSCMNG_HOMEの設定（HCSC-Manager環境1）

set CSCMNG_HOME=C:¥WorkPri

これによってログファイル出力先は次のようになります。

C:¥WorkPri¥log¥javalog01.log

環境変数CSCMNG_HOMEの設定（HCSC-Manager環境2）

set CSCMNG_HOME=C:¥WorkSec

これによってログファイル出力先は次のようになります。

C:¥WorkSec¥log¥javalog01.log

注意事項

環境変数CSCMNG_HOMEに設定されたパスに空白が含まれている場合は，ログ出力先のパスに環境変数CSCMNG_HOMEは設定できません。この場合は代わりに，空白を含まないパスを設定した任意の環境変数を使用し，環境変数CSCMNG_HOMEとあわせて切り替えるよう運用してください。

-XX:HitachiJavaLogFileSize

JavaVMログファイルの1ファイル当たりのファイルサイズの上限値を指定します。

-XX:HitachiJavaLogNumberOfFile

作成するJavaVMログファイルの最大ファイル数を指定します。

-XX:[+|-]HitachiVerboseGC

GCが発生した場合に拡張verbosegc情報を出力するかどうかを指定します。

(5)　記述例

cscpiselectコマンドにJavaVM起動オプションを設定する例を次に示します。

Windowsの場合

set cscjvmopt_cscpiselect=-Xmx512m -Xms512m

UNIXの場合

cscjvmopt_cscpiselect="-Xmx512m -Xms512m"

6.5.2　HCSC-Managerコマンド共通定義ファイル

(1)　形式

J2SEのプロパティファイル形式です。

csc.all.<コマンド引数名>=値
csc.<コマンド識別子>.<コマンド引数名>=値

(2)　機能

各コマンドのオプションのデフォルト値を設定します。設定ファイルの変更後，次回コマンドの発行時に更新情報が反映されます。この定義ファイルおよびコマンドの両方でオプションの値を指定した場合，コマンドの指定が有効になります。

この定義ファイルには，ユーザIDやパスワードなどの情報が含まれるため，適切にファイルパーミッションを設定してください。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥manager¥csccmd.properties

(4)　設定できるパラメタ

csc.all.<コマンド引数名>=値

すべてのコマンドに共通する引数のデフォルト値を指定します。コマンド引数名はハイフン（-）を除いた値を指定してください。値がない場合は値の指定は不要です。

（指定例1）

すべてのコマンドの-userオプションに，指定値「admin」を仮定する場合

csc.all.user=admin

（指定例2）

すべてのコマンドに，-allオプションが指定されていると仮定する場合

csc.all.all=

csc.<コマンド識別子>.<コマンド引数名>=値

コマンド識別子に対応したコマンドのデフォルト引数を定義します。コマンド識別子はコマンド名から"csc"を除いた値を指定してください。コマンド引数名はハイフン（-）を除いた値を指定してください。値がない場合は値の指定は不要です。

（指定例1）

cscpiselectコマンドの-cscオプションに，指定値「HCSC」を仮定する場合

csc.piselect.csc=HCSC

（指定例2）

cscsvstartコマンドに，-systemオプションが指定されていると仮定する場合

csc.svstart.system=

(5)　注意事項

次の例に示すように，HCSC-Managerコマンド共通定義ファイルの指定内容と，コマンド引数の指定に矛盾がある場合，コマンド引数が不正になります。

HCSC-Managerコマンド共通定義ファイルの内容

csc.all.user=AAA
csc.all.pass=BBB
csc.repctl.autoexport=

コマンド入力例

> cscrepctl -import repository.zip

この例では，cscrepctlコマンドで，-importオプションと-autoexportオプションの両方が指定されています。そのため，コマンド引数の不正でエラーとなります。

6.5.3　HCSC-Manager定義ファイル

(1)　形式

cscmng.repository.root=リポジトリのルートディレクトリパス

cscmng.log.dir=ログ出力先ディレクトリパス
cscmng.log.<チャネル名>.filesize=ログファイルサイズ
cscmng.log.<チャネル名>.filenum=ログファイル面数

cscmng.manager.<マネージャ識別名>.timeout=読み込みタイムアウト値

cscmng.pireexec.response.dir=応答電文格納ディレクトリパス
cscmng.pireexec.response.encoding=応答電文格納文字コード

cscmng.server.<HCSCサーバ名>.system=論理サーバ名

cscmng.repctl.export.dir=エクスポートファイルの出力先ディレクトリパス

cscmng.envbackup.dir=環境バックアップの出力先ディレクトリパス
cscmng.envbackup.dir.envrestore=リストア前の環境バックアップの出力先ディレクトリパス
cscmng.envbackup.dir.import=インポート前の環境バックアップの出力先ディレクトリパス
cscmng.envbackup.autoget={ON｜OFF}
cscmng.envbackup.autoget.off={envrestore｜import｜envrestore,import}

cscmng.precache.thread.maximum=cscprecacheコマンドで並列処理するスレッドの最大数

cscmng.server.<HCSCサーバ名>.hws.svstop={normal｜wait}
cscmng.server.<HCSCサーバ名>.hws.svstop.timeout=HTTP Server計画停止時のタイムアウト値

(2)　機能

HCSC-Managerの動作に必要となる情報を設定します。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥manager¥cscmng.properties

(4)　設定できるパラメタ

(a)　リポジトリ設定

cscmng.repository.root=リポジトリのルートディレクトリパス　〜<最大100バイトの文字列><<<サービスプラットフォームのインストールディレクトリ>¥CSC¥repository>>

リポジトリのルートディレクトリを絶対パスで指定します。ディレクトリ区切りは「/」または「¥¥」を使用します。

相対パスを指定した場合，エラーになる場合があります。存在しないディレクトリを指定した場合，および指定した文字列が100バイトを超える場合はエラーになります。そのため，<サービスプラットフォームのインストールディレクトリ>が84バイトを超える場合は，このプロパティを明示的に指定してください。

なお，1台のマシンに複数の運用・実行環境を構築（環境変数CSCMNG_HOMEを設定）している場合，省略値は次のようになります。

%CSCMNG_HOME%¥repository

(b)　ログ設定

cscmng.log.dir=ログ出力先ディレクトリパス　〜<最大100バイトの文字列><<<サービスプラットフォームのインストールディレクトリ>¥CSC¥log¥manager>>

ログ出力先ディレクトリを絶対パスで指定します。ディレクトリ区切りは「/」または「¥¥」を使用します。相対パスを指定した場合，エラーになる場合があります。存在しないディレクトリを指定した場合，および指定した文字列が100バイトを超える場合はエラーになります。そのため，<サービスプラットフォームのインストールディレクトリ>が84バイトを超える場合は，このプロパティを明示的に指定してください。

なお1台のマシンに複数の運用・実行環境を構築（環境変数CSCMNG_HOMEを設定）している場合，省略値は次のようになります。

%CSCMNG_HOME%¥log¥manager

cscmng.log.<チャネル名>.filesize=ログファイルサイズ　〜＜数字＞((4096−16777216))<<1048576>>　チャネルがmaintenanceの場合は＜数字＞((4096−16777216))<<4194304>>

ログファイル1つ当たりの上限サイズをバイト単位で指定します。不正な値を指定した場合は，省略値が指定されます。チャネル名には，次のどれか1つを指定します。

message：メッセージログ

exception：例外ログ

maintenance：メンテナンスログ

cscmng.log.<チャネル名>.filenum=ログファイル面数　〜＜数字＞((1−16))<<2>>

ログファイル面数を指定します。不正な値を指定した場合は，省略値が指定されます。チャネル名には，次のどれか1つを指定します。

message：メッセージログ

exception：例外ログ

maintenance：メンテナンスログ

(c)　Manager設定

cscmng.manager.<マネージャ識別名>.timeout=読み込みタイムアウト値　〜＜数字＞((0−86400))<<0>>

Managerとの接続の読み込みタイムアウトを秒単位で指定します。0を指定した場合はタイムアウトしません。不正な値を指定した場合は，省略値が指定されます。マネージャ識別名はHCSCサーバ構成定義ファイルに指定したManager名を設定してください。

(d)　プロセスインスタンス再実行設定

cscmng.pireexec.response.dir=応答電文格納ディレクトリパス　((1−100バイト))

プロセスインスタンス再実行で応答電文を受け取った場合の応答電文格納ディレクトリを絶対パスで指定します。ディレクトリ区切りは「/」または「¥¥」を使用します。相対パスを指定した場合，エラーになる場合があります。指定しない場合は，応答電文が格納されません。存在しないパスを指定した場合，エラーになります。また，パスを含むファイル長がOSのMAX_PATHを超える場合はファイルを作成できません。

cscmng.pireexec.response.encoding=応答電文格納文字コード　〜<<UTF-8>>

応答電文格納時の出力文字コードを，JavaVMがサポートしているエンコーディング名で指定します。存在しない文字コードを指定した場合，省略値が指定されます。

(e)　HCSCサーバ運用設定

cscmng.server.<HCSCサーバ名>.system=論理サーバ名

HCSCシステムの管理下におく論理サーバを指定します。管理下におくと，論理サーバの各種運用（HCSCサーバとの一括起動・停止，および状態の参照）ができるようになります。

論理サーバ名は，「論理サーバ名,論理サーバ名,…」のようにコンマ（,）区切りで指定します。コンマ前後の半角スペースやタブ文字は無視されます。論理サーバの起動停止順序は，Managerで設定した順序になります。HCSCサーバも同時に起動する場合は，J2EEサーバの起動順序になります。

（指定例）

HCSCサーバ（HCSC）上に，論理パフォーマンストレーサ（PRF），および論理Webサーバ（WebServer）を同時に起動停止する場合

cscmng.server.HCSC.system=PRF,WebServer

(f)　リポジトリエクスポート

cscmng.repctl.export.dir=エクスポートファイルの出力先ディレクトリパス　〜((1−100バイト))

cscrepctlコマンドでリポジトリをエクスポートする場合，エクスポートファイルの出力先ディレクトリを指定します。

(g)　環境バックアップ

cscmng.envbackup.dir=環境バックアップの出力先ディレクトリパス　〜((1−100バイト))<<カレントディレクトリ>>

cscenvbackupコマンドで環境をバックアップする場合，環境バックアップファイルの出力先ディレクトリを指定します。

cscmng.envbackup.dir.envrestore=リストア前の環境バックアップの出力先ディレクトリパス　〜((1−100バイト))

cscenvrestoreコマンドで環境をリストアする場合，リストア前の環境バックアップファイルの出力先ディレクトリを指定します。このパラメタの指定は，cscmng.envbackup.dirパラメタの指定よりも優先されます。このパラメタを省略した場合，リストア前の環境バックアップファイルは，cscmng.envbackup.dirパラメタで指定したディレクトリに出力されます。cscmng.envbackup.dirパラメタも省略した場合は，次のディレクトリに出力されます。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥spool¥manager¥

なお，1台のマシンに複数の運用・実行環境を構築（環境変数CSCMNG_HOMEを設定）している場合，省略値は次のようになります。

%CSCMNG_HOME%¥spool¥manager

cscmng.envbackup.dir.import=インポート前の環境バックアップの出力先ディレクトリパス　〜((1−100バイト))

cscrepctlコマンドで-importオプションを指定してリポジトリをインポートする場合，インポート前の環境バックアップファイルの出力先ディレクトリを指定します。このパラメタの指定は，cscmng.envbackup.dirパラメタの指定よりも優先されます。このパラメタを省略した場合，インポート前の環境バックアップファイルは，cscmng.envbackup.dirパラメタで指定したディレクトリに出力されます。cscmng.envbackup.dirパラメタも省略した場合は，次のディレクトリに出力されます。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥spool¥manager

なお，1台のマシンに複数の運用・実行環境を構築（環境変数CSCMNG_HOMEを設定）している場合，省略値は次のようになります。

%CSCMNG_HOME%¥spool¥manager

cscmng.envbackup.autoget={ON｜OFF}　〜<<ON>>

自動でバックアップするかどうかを指定します。

ON

自動でバックアップします。

OFF

自動でバックアップしません。

cscmng.envbackup.autoget.off={envrestore｜import｜envrestore,import}

環境をリストアする際，またはリポジトリをインポートする際に，自動バックアップをしない場合に指定します。環境のリストア，およびリポジトリのインポートの両方で自動バックアップをしない場合は，envrestoreとimportをコンマ（,）区切りで指定します。コンマ前後のスペース文字は無視されます。

envrestore

cscenvrestoreコマンドを実行して環境をリストアした場合に，自動バックアップをしません。

import

cscrepctlコマンドで-importオプションを指定してリポジトリをインポートした場合に，自動バックアップをしません。

（指定例）

環境をリストアする際に自動バックアップをしない場合

cscmng.envbackup.autoget.off=envrestore

リポジトリをインポートする際に自動バックアップをしない場合

cscmng.envbackup.autoget.off=import

環境をリストアする際，およびリポジトリをインポートする際に自動バックアップをしない場合

cscmng.envbackup.autoget.off=envrestore,import

ポイント

cscmng.envbackup.autogetパラメタとcscmng.envbackup.autoget.offパラメタの指定の組み合わせによって，環境をリストアする際，またはリポジトリをインポートする際に，自動バックアップをするかどうかが異なります。cscmng.envbackup.autogetパラメタとcscmng.envbackup.autoget.offパラメタの関係を次の表に示します。

表6‒2　cscmng.envbackup.autogetパラメタとcscmng.envbackup.autoget.offパラメタの関係

cscmng.envbackup.autogetパラメタの指定

cscmng.envbackup.autoget.offパラメタの指定

環境のリストア時

リポジトリのインポート時

なし

なし

○

○

なし

envrestore

×

○

なし

import

○

×

なし

envrestore,import

×

×

ON

なし

○

○

ON

envrestore

×

○

ON

import

○

×

ON

envrestore,import

×

×

OFF

なし

×

×

OFF

envrestore

×

×

OFF

import

×

×

OFF

envrestore,import

×

×

（凡例）

○：自動バックアップをします。

×：自動バックアップをしません。

(h)　コマンド用スレッド設定

cscmng.precache.thread.maximum=cscprecacheコマンドで並列処理するスレッドの最大数　〜＜数字＞((1−1024))<<16>>

cscprecacheコマンドで並列して事前解析要求を送信する場合の最大スレッド数を指定します。未指定または不正な値を指定した場合，エラーになります。

解析要求を送信する対象がないまたは1つだけの場合，スレッドは生成されないため，このプロパティの値は無視されます。

(i)　HTTP Server運用設定

cscmng.server.<HCSCサーバ名>.hws.svstop={normal｜wait}　〜<<wait>>

HTTP Server停止時の動作を指定します。不正な値を指定した場合は，省略値が指定されます。このパラメタは，論理サーバを一括で停止する場合，HTTP Serverの論理サーバを停止する場合，および運用環境の画面からHCSCサーバを停止する場合に有効になります。

normal

通常停止します。

wait

計画停止します。

cscmng.server.<HCSCサーバ名>.hws.svstop.timeout=HTTP Server計画停止時のタイムアウト値　〜＜数字＞((0以下，または60−1800))<<300>>

HTTP Server計画停止時のタイムアウトを秒単位で指定します。不正な値を指定した場合は，省略値が指定されます。

0以下の値を指定した場合は，Management Serverに設定されている停止監視時間が指定されます。設定されている停止監視時間が0のときはタイムアウトしません。停止監視時間については，マニュアル「アプリケーションサーバ 運用管理ポータル操作ガイド」の「11.11.1　Webサーバの起動／停止の設定」を参照してください。

このパラメタは，論理サーバを一括で停止する場合，HTTP Serverの論理サーバを停止する場合，および運用環境の画面からHCSCサーバを停止する場合に有効になります。

なお，HWSGracefulStopTimeoutディレクティブに0以外の値を指定している場合は，HWSGracefulStopTimeoutディレクティブに指定した値でもタイムアウト監視します。HWSGracefulStopTimeoutディレクティブについては，マニュアル「HTTP Server」の「6.2.4　E，F，G，H，Iで始まるディレクティブ」を参照してください。

(5)　記述例

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)　注意事項

HCSC-Manager定義ファイルは，画面およびコマンドのプロセス起動時に1度だけ読み込みます。そのため，HCSC-Manager定義ファイルを変更した場合，変更した設定値は次にプロセスを起動した際に反映されます。ただし，ファイルサイズ/面数の変更を有効にするためには，ファイルの退避，または削除が必要です。詳細については，マニュアル「サービスプラットフォームシステム構築・運用ガイド」の「7.3.1(3)　ログおよびトレース取得時の注意事項（全般的な注意事項）」を参照してください。

HCSCサーバをセットアップしたあと，アンセットアップするまではcscmng.repository.rootパラメタの値を変更しないでください。変更した場合，セットアップ済みのHCSCサーバに対する操作ができなくなるおそれがあります。

HWSGracefulStopTimeoutディレクティブは，HCSC-Managerが自動的に設定するディレクティブです。セットアップウィザードで構築した環境の場合，HWSGracefulStopTimeoutディレクティブの設定は運用管理ポータルから変更できません。HTTP Server定義ファイル（httpsd.conf）でHWSGracefulStopTimeoutディレクティブの設定を直接書き換えた場合も，設定情報を配布するときに設定が元に戻るため注意してください。

パスを指定する場合の注意事項を次に示します。

相対パス，親ディレクトリ表現（「..¥」，「../」），およびカレントディレクトリ表現（「.¥」，「./」）を含むパスは指定しないでください。

シンボリックリンクを含むパスは指定しないでください。

Windowsの場合，UNC形式，NTFSのストリーム名，および予約デバイス名を含むパスは指定しないでください。また，パスの大文字と小文字は区別されません。

6.5.4　HCSC-Messagingコマンド共通定義ファイル

(1)　形式

Windowsの場合

@echo off
set HCSC_ADDCLASSPATH=<HiRDB Type4 JDBC Driver または Oracle JDBC Thin Driverのパス>

UNIXの場合

#!/bin/sh
HCSC_ADDCLASSPATH=<HiRDB Type4 JDBC Driver または Oracle JDBC Thin Driverのパス>

(2)　機能

HCSC-Messagingコマンド（csmで始まるコマンド）の動作に必要な情報を設定します。

(3)　ファイルの格納先

Windowsの場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥msg¥cmdconf.bat

UNIXの場合

/opt/Cosminexus/CSC/config/msg/cmdconf

(4)　設定できるパラメタ

HCSC_ADDCLASSPATH

各データベースのドライバのファイル名を絶対パスで指定します。

HiRDBの場合

HiRDB Type4 JDBC Driverを使用するとき，HiRDB Type4 JDBC Driver（pdjdbc2.jar）のファイル名を絶対パスで指定します。

Oracleの場合

Oracle JDBC Thin Driverを使用するとき，Oracle JDBC Thin Driverのファイル名を絶対パスで指定します。

上記以外の場合は環境変数の定義だけを指定して，値は指定しないでください。

注意事項

環境変数として，HCSC_ADDCLASSPATH以外を設定しないでください。

(5)　記述例

HCSC-Messagingコマンド共通定義ファイルの記述例を次に示します。

Windowsの場合

@echo off
set HCSC_ADDCLASSPATH=C:¥win32app¥hitachi¥hirdb_s¥CLIENT¥UTL¥pdjdbc2.jar

UNIXの場合

#!/bin/sh
HCSC_ADDCLASSPATH=/opt/HiRDB_S/client/lib/pdjdbc2.jar

6.5.5　HCSCコンポーネント指定ファイル

(1)　形式

［<変更種別>.］{<サービスID>｜<受付ID>}
　　　　　　　　　：
［<変更種別>.］{<サービスID>｜<受付ID>}

(2)　機能

HCSCコンポーネントの追加・変更・削除をテキストファイル形式で設定します。複数のHCSCコンポーネントを記載する場合は，1行ずつ記載してください。作成したHCSCコンポーネント指定ファイルをコマンドに指定することで，複数のHCSCコンポーネントに対する処理を一括で実行できます。

HCSCコンポーネント指定ファイルはテキストファイル形式で入力することもできますが，次のコマンドでHCSCコンポーネントの情報をファイル出力して作成することもできます。

cscrepdiffコマンドの-listfileオプション（HCSCコンポーネントの差分情報を出力）

cscreplsコマンドの-listfileオプション（HCSCコンポーネントの一覧を出力）

(3)　ファイルの格納先

HCSCコンポーネント指定ファイルの格納先となるパスおよびファイル名は任意です。

(4)　設定できるパラメタ

［<変更種別>.］{<サービスID>｜<受付ID>}

追加・変更・削除するHCSCコンポーネントをサービスIDまたは受付IDで指定します。

HCSCコンポーネントの変更種別は次の中から指定します。

add

指定したHCSCコンポーネントを処理対象に追加します。

change

配備済みのHCSCコンポーネントに変更が生じた場合に，HCSCコンポーネントを再配備します。

delete

配備済みのHCSCコンポーネントを処理対象から削除します。

指定なし

指定したHCSCコンポーネントを配備状態に関係なく，すべてのコマンドで処理対象とします。

-namelistオプションでHCSCコンポーネント指定ファイルを指定できるコマンドと，指定できる変更種別の組み合わせを次に示します。

コマンド名

変更種別

add

change

delete

指定なし

csccompostart

○

○

×

○

csccompostop

×

○

○

○

csccompodeploy

○

○

×

○

csccompoundeploy

×

○

○

○

cscrepctl -import -compo

○

○

×

○

cscrepctl -delete

×

×

○

○

（凡例）

○：有効となります。

×：無効となります。

(5)　記述例

HCSCコンポーネント指定ファイルの記述例を次に示します。

#[BusinessProcess]
change.BP2
delete.BP3
add.BP4

#[ServiceAdapter]
change.adp2
delete.adp3
add.adp4

#[UserDefinedReception]
change.rcp2
delete.rcp3
add.rcp4

(6)　使用方法

作成したHCSCコンポーネント指定ファイルは，次に示すコマンドの-namelistオプションの引数に指定します。各コマンドの実行方法については，「5.　コマンド（運用環境・実行環境）」の各コマンドの記述を参照してください。

csccompostartコマンド

csccompostopコマンド

csccompodeployコマンド

csccompoundeployコマンド

cscrepctl -import -compoコマンド

cscrepctl -deleteコマンド

(7)　注意事項

複数のHCSCコンポーネントを指定した場合，HCSCコンポーネントの実行順序はコマンドによって異なります。実行順序については，各コマンドの説明を参照してください。

サービスIDまたは受付IDの指定が重複していると，変更種別が異なっていてもエラーとなります。

配備するHCSCコンポーネントが配備済みの場合など，処理対象外であるHCSCコンポーネントはスキップされます。

各行の先頭1文字にシャープ（#）を指定した行はコメントと見なされます。

各行の先頭と終端の半角空白はトリムされます。

空行の場合は参照されないでスキップされます。

6.5.6　HCSCサーバランタイム定義ファイル

(1)　形式

［methodtrace-filepath=メソッドトレース・例外ログ出力先パス］
［methodtrace-filenum=メソッドトレース面数］
［methodtrace-filesize=メソッドトレースファイルサイズ］
［methodtrace-level={1｜2｜3｜4｜5}］
［requesttrace={ON｜OFF}］
［requesttrace-filepath=リクエストトレース出力先パス］
［requesttrace-filenum=リクエストトレース面数］
［requesttrace-filesize=リクエストトレースファイルサイズ］
［telegramtrace={ON｜OFF}］
［telegramtrace-filepath=ユーザ電文トレース出力先パス］
［telegramtrace-filenum=ユーザ電文トレース面数］
［telegramtrace-filesize=ユーザ電文トレースファイルサイズ］
［telegramtrace-trigger={NORMAL｜SYSERR｜FAULT｜DTERR}］
［telegramtrace-component-type-filepath=ユーザ電文トレースのコンポーネント種別設定ファイルのパス］
［telegramtrace-component-id-filepath=ユーザ電文トレースのコンポーネントID設定ファイルのパス］
［telegramtrace-format={FIXED｜READABLE}］
［bpacttrace={ON｜OFF}］
［bpacttrace-filenum=ビジネスプロセスのアクティビティトレース面数］
［bpacttrace-filesize=ビジネスプロセスのアクティビティトレースファイルサイズ］
［bpacttrace-extend-item={NONE｜PROCESSINSTANCEID}］
［bptrace-level={0｜10｜20｜30}］
［bptrace-filenum=BPトレースの面数］
［bptrace-filesize=BPトレースのサイズ］
［bpexptrace-filenum=ビジネスプロセス基盤の例外ログ面数］
［bpexptrace-filesize=ビジネスプロセス基盤の例外ログファイルサイズ］
［cscexptrace-filenum=メッセージング基盤の例外ログ面数］
［cscexptrace-filesize=メッセージング基盤の例外ログファイルサイズ］
［kafka-protocoltrace-enabled={ON｜OFF}］
［kafka-protocoltrace-level={ERROR｜WARN｜INFO｜DEBUG｜TRACE}］
［kafka-protocoltrace-filenum=Kafkaプロトコルトレース面数］
［kafka-protocoltrace-filesize=Kafkaプロトコルトレースファイルサイズ］
［grpc-transporttrace-enabled={ON｜OFF}］
［grpc-transporttrace-level={SEVERE｜WARNING｜INFO｜CONFIG｜FINE｜FINER｜FINEST}］
［grpc-transporttrace-filenum=gRPC通信ログの最大面数］
［grpc-transporttrace-filesize=gRPC通信ログの1面当たりの最大サイズ］

［request-ejb.instance.minimum=標準の同期受付（SessionBean）のインスタンス最小数］
［request-ejb.instance.maximum=標準の同期受付（SessionBean）のインスタンス最大数］
［request-ejb.ctm={true｜false}］
［request-ejb.parallel.count=CTMがアプリケーションを呼び出すために用意するスレッド数］
［request-ejb.optional.name=標準の同期受付（SessionBean）の別名］
［request-soap.instance.minimum=標準の同期受付（Webサービス・SOAP1.1）の最小同時実行数］
［request-soap.instance.maximum=標準の同期受付（Webサービス・SOAP1.1）の最大同時実行数］
［request-soap.exclusive.threads=標準の同期受付（Webサービス・SOAP1.1）の占有スレッド数］
［request-soap.queue-size=標準の同期受付（Webサービス・SOAP1.1）の実行待ちキューのサイズ］
［request-soap1_2.instance.minimum=標準の同期受付（Webサービス・SOAP1.2）の最小同時実行数］
［request-soap1_2.instance.maximum=標準の同期受付（Webサービス・SOAP1.2）の最大同時実行数］
［request-soap1_2.exclusive.threads=標準の同期受付（Webサービス・SOAP1.2）の占有スレッド数］
［request-soap1_2.queue-size=標準の同期受付（Webサービス・SOAP1.2）の実行待ちキューのサイズ］
［request-jms.instance.maximum=標準の非同期受付（MDB（WS-R））のインスタンス最大数］
［request-jms.rollback-count=標準の非同期受付（MDB（WS-R））ロールバック警告メッセージ出力回数］
［receptionstop-monitor-timer=受付キュー監視タイムアウト時間］
［csc-receptionstop-timeout=受付終了待ち通信タイムアウト時間］

［soapfault-targetnamespace-filepath=SOAP Fault動作定義ファイルの絶対パス］
［soapfault-handling-mode={DETAIL｜FAULTCODE}］
［oa-adapter-character-code={SJIS｜MS932}］

［formatdef-maxcache-num=フォーマット定義をキャッシュできる数］
［transformdef-maxcache-num=サーバ単位にデータ変換定義をキャッシュできる数］
［xmltelegram-maxcache-num=XML電文をキャッシュできる数］
［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=コード変換テーブル格納パスのルートパスの絶対パス］

［syserr-to-fault-convert={ON｜OFF}］
［syserr-to-fault-convert-all-activity={ON｜OFF}］
［validate-fault-compatible={ON｜OFF}］
［bp-reply-after-min-thread-pool-size=応答アクティビティ後のアクティビティを実行するために使用するスレッドの最小数］
［bp-reply-after-max-thread-pool-size=応答アクティビティ後のアクティビティを実行するために使用するスレッドの最大数］
［bp-reply-after-thread-pool-keep-alive=応答アクティビティ後のアクティビティを実行するために使用するスレッドの保持時間］
［service-emulate.enable={true｜false}］
［service-emulate-def-filepath=エミュレート設定情報定義ファイルの絶対パス］
［bp-log-activity-definition-filepath=ログ出力アクティビティ定義ファイルの絶対パス］

［j2ee-stopapp-timeout=J2EEアプリケーション停止監視時間］
［startcsc-timeout=J2EEサーバ起動監視時間］
［stopcsc-timeout=J2EEサーバ停止監視時間］

［csc-command-timeout=コマンドタイムアウト時間］
［csc-precache-timeout=事前キャッシュ処理のためのビジネスプロセスへのEJB通信のタイムアウト時間］

［cookie-parsing={ON｜OFF}］

［work-folder=作業フォルダルートの絶対パス］
［common-folder-<共通フォルダ定義名>=共通フォルダの絶対パス］
［definition-file-base-path=実行環境の独自定義ファイルの格納先ディレクトリの絶対パス］

［dba-separate-transaction={true｜false}］

［common-uoc-prop-path=コンポーネント共通UOC用プロパティファイル格納フォルダ］

［short-processid-servername=プロセスインスタンスの識別子で使用するHCSCサーバ名の識別子］
［short-processid={ON｜OFF}］

［xml-pooled-instance-minimum=XML処理に使用するクラスのインスタンスプールの最小数］
［xml-pooled-instance-maximum=XML処理に使用するクラスのインスタンスプールの最大数］

［request-id-separate-key={slash｜atsign｜period}］
［fileevent-reception.monitored-file.enabled={true｜false}］
［fileevent-reception.monitored-folder=監視フォルダの絶対パス］
［fileevent-reception.monitor-interval=ファイル監視の間隔］
［fileevent-reception.monitor-starting.delay=ファイル監視の開始待ち時間］

(2)　機能

セットアップ後のHCSCサーバの定義情報をHCSC-Managerから設定します。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥manager¥templates¥cscsvconfig.properties

(4)　設定できるプロパティ

(a)　ログトレース

methodtrace-filepath=メソッドトレース・例外ログ出力先パス　〜＜文字列（2バイト文字含む）および空白＞<<<J2EEサーバのログ出力先ディレクトリ>¥csc¥maintenance>>

メッセージング基盤およびビジネスプロセス基盤の，メソッドトレースと例外ログの出力先パスを絶対パスで指定します。

ディレクトリ区切りは「/」または「¥¥」を使用します。存在しないディレクトリを指定した場合は，省略値が使用されます。省略値はサービスプラットフォームの設定値に依存します。

methodtrace-filenum=メソッドトレース面数　〜＜数字＞((1−16))<<8>>

メソッドトレースの最大面数を指定します。

methodtrace-filesize=メソッドトレースファイルサイズ　〜＜数字＞((4096−2147483647))<<2097152>>

メソッドトレースファイルの1面当たりの最大サイズをバイト単位で指定します。

methodtrace-level={1｜2｜3｜4｜5}　〜<<3>>

メソッドトレースの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

出力情報

出力レベル

1

2

3

4

5

入力ファイルおよび出力ファイルの情報（ファイルパス，ファイルの形式，ファイルサイズ，レコード数）※1

○※1

○※1

○※1

○※1

○※1

標準受付メソッドの入口／出口情報（クラス名，メソッド名，引数，戻り値）※2

×※2

○※2

○※2

○※2

○※2

外部（BPなど）のインターフェースの入口／出口情報（クラス名，メソッド名，引数，戻り値）

×

×

○

○

○

コンポーネント内インターフェースの入口／出口情報（クラス名，メソッド名，引数，戻り値）

×

×

×

○

○

デバッグ情報（処理の分岐などの情報）

×

×

×

×

○

（凡例）

○：出力されます。

×：出力されません。

注※1

ファイル変換オペレーションの場合だけ出力します。

注※2

DBアダプタの場合は該当しません。

requesttrace={ON｜OFF}　〜<<ON>>

リクエストトレースを採取するかどうかを指定します。

ON

採取します。

OFF

採取しません。

requesttrace-filepath=リクエストトレース出力先パス　〜＜文字列（2バイト文字含む）および空白＞<<<J2EEサーバのログ出力先ディレクトリ>¥csc>>

リクエストトレースの出力先パスを絶対パスで指定します。requesttraceプロパティでONを設定した場合だけ有効になります。

ディレクトリ区切りは「/」または「¥¥」を使用します。存在しないディレクトリを指定した場合は，省略値が使用されます。省略値はサービスプラットフォームの設定値に依存します。

requesttrace-filenum=リクエストトレース面数　〜＜数字＞((1−16))<<4>>

リクエストトレースの最大面数を指定します。requesttraceプロパティでONを設定した場合だけ有効になります。

requesttrace-filesize=リクエストトレースファイルサイズ　〜＜数字＞((4096−2147483647))<<2097152>>

リクエストトレースファイルの1面当たりの最大サイズをバイト単位で指定します。requesttraceプロパティでONを設定した場合だけ有効になります。

telegramtrace={ON｜OFF}　〜<<OFF>>

ユーザ電文トレースを採取するかどうかを指定します。デバッグ情報を出力する場合はONを指定してください。

ON

採取します。

OFF

採取しません。

telegramtrace-filepath=ユーザ電文トレース出力先パス　〜＜文字列（2バイト文字含む）および空白＞<<<J2EEサーバのログ出力先ディレクトリ>¥csc>>

ユーザ電文トレースの出力先パスを絶対パスで指定します。telegramtraceプロパティでONを設定した場合だけ有効になります。

ディレクトリ区切りは「/」または「¥¥」を使用します。存在しないディレクトリを指定した場合は，省略値が使用されます。省略値はサービスプラットフォームの設定値に依存します。

telegramtrace-filenum=ユーザ電文トレース面数　〜＜数字＞((1−16))<<4>>

ユーザ電文トレースの最大面数を指定します。telegramtraceプロパティでONを設定した場合だけ有効になります。

telegramtrace-filesize=ユーザ電文トレースファイルサイズ　〜＜数字＞((4096−2147483647))<<2097152>>

ユーザ電文トレースファイルの1面当たりの最大サイズをバイト単位で指定します。telegramtraceプロパティでONを設定した場合だけ有効になります。

telegramtrace-trigger={NORMAL｜SYSERR｜FAULT｜DTERR}　〜<<NORMAL>>

ユーザ電文トレースの出力契機を指定します。telegramtraceプロパティでONを設定した場合だけ有効になります。

NORMAL

正常処理時に出力。NORMALを指定する場合は，HCSCサーバの処理性能への影響を考慮して，テスト環境やデバッグ環境で指定してください。

SYSERR

システム例外検出時に出力

FAULT

フォルト検出時に出力

DTERR

バイナリデータの変換処理でエラーが発生した場合にデバッグ情報を出力

NORMAL，SYSERR，FAULTの出力契機と，出力される電文との組み合わせは次のとおりです。

出力契機

タイミング

電文の種類

要求電文

応答電文

フォルト電文

NORMAL

正常処理時

○

○

×

システム例外検出時

×

×

×

フォルト検出時（catchなし）

×

×

×

フォルト検出時（catchあり）

×

×

×

SYSERR

正常処理時

×

×

×

システム例外検出時

○

×

×

フォルト検出時（catchなし）

○

×

×

フォルト検出時（catchあり）

×

×

×

FAULT

正常処理時

×

×

×

システム例外検出時

×

×

×

フォルト検出時（catchなし）

○

×

○

フォルト検出時（catchあり）

○

×

○

（凡例）

○：出力されます。

×：出力されません。

DTERRの出力契機と，出力される情報との組み合わせは次のとおりです。

出力契機

タイミング

出力される情報

DTERR

バイナリデータの読込処理（バイナリ→DOMの変換）時

エラー発生時までに処理できた電文（バイナリ，DOM）の情報

バイナリデータの生成処理（DOM→バイナリの変換）時

エラー発生時までに処理できた電文（DOM）の情報

設定値はコンマ区切りで複数指定できます。複数の契機を指定した場合も，同じ情報は繰り返し出力されません。例えば，正常処理時に要求電文が出力済みであった場合，システム例外時またはフォルト検出時には出力されません。

telegramtrace-component-type-filepath=ユーザ電文トレースのコンポーネント種別設定ファイルのパス　〜＜文字列（2バイト文字含む）および空白＞

ユーザ電文トレースに特定のコンポーネント種別の情報だけを出力したい場合，コンポーネント種別が記述されたコンポーネント種別設定ファイルを絶対パスで指定します。ディレクトリ区切りは「/」または「¥¥」を使用します。存在しないファイルを指定した場合は，エラーになります。

telegramtraceプロパティでON，telegramtrace-triggerプロパティでNORMALを設定した場合だけ有効になります。

コンポーネント種別設定ファイルの定義方法については，「6.5.9　コンポーネント種別設定ファイル」を参照してください。

なお，正常処理時のユーザ電文トレースの出力対象とするHCSCコンポーネントは，次の2とおりの方法で指定できます。同じHCSCコンポーネントに対して，コンポーネントID設定ファイルとコンポーネント種別設定ファイルの両方で設定した場合，コンポーネントID設定ファイルの設定が適用されます。

コンポーネント種別で指定（telegramtrace-component-type-filepathプロパティ）

HCSCコンポーネントのIDで指定（telegramtrace-component-id-filepathプロパティ）

HCSCコンポーネントを指定したユーザ電文トレースの出力内容については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「7.4.4　ユーザ電文トレース」を参照してください。

telegramtrace-component-id-filepath=ユーザ電文トレースのコンポーネントID設定ファイルのパス　〜＜文字列（2バイト文字含む）および空白＞

ユーザ電文トレースに特定のHCSCコンポーネントの情報だけを出力したい場合，HCSCコンポーネントのIDと出力要否を記述したコンポーネントID設定ファイルを絶対パスで指定します。ディレクトリ区切りは「/」または「¥¥」を使用します。存在しないファイルを指定した場合は，エラーになります。

telegramtraceプロパティでON，telegramtrace-triggerプロパティでNORMALを設定した場合だけ有効になります。

コンポーネントID設定ファイルの定義方法については，「6.5.8　コンポーネントID設定ファイル」を参照してください。

なお，正常処理時のユーザ電文トレースの出力対象とするHCSCコンポーネントは，次の2とおりの方法で指定できます。同じHCSCコンポーネントに対して，コンポーネントID設定ファイルとコンポーネント種別設定ファイルの両方で設定した場合，コンポーネントID設定ファイルの設定が適用されます。

コンポーネント種別で指定（telegramtrace-component-type-filepathプロパティ）

HCSCコンポーネントのIDで指定（telegramtrace-component-id-filepathプロパティ）

HCSCコンポーネントを指定したユーザ電文トレースの出力内容については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「7.4.4　ユーザ電文トレース」を参照してください。

telegramtrace-format={FIXED｜READABLE}　〜<<FIXED>>

ユーザ電文トレースの出力形式を指定します。telegramtraceプロパティでONを指定している場合だけ有効になります。

FIXED

16進数形式データとASCII形式データを同じ行に出力します。

文字は次の基準で出力します。

0x20〜0x7Eの範囲にある文字は，ASCII文字として出力します。

0x00〜0x1F，0x7F〜0xFFの範囲にある文字は，ピリオド（.）に変換して出力します。

READABLE

16進数形式データとUTF-8形式データはそれぞれ別の行に出力します。

文字は次の基準で出力します。

0x20〜0x7Eの範囲にある文字は，ASCII文字として出力します。

次の範囲にある文字は，ピリオド（.）に変換して出力します。

0x00〜0x08

0x0B〜0x0C

0x0E〜0x1F

0x7F

0x09の場合は，水平タブを出力します。

改行コード（0x0aまたは0x0d）は，改行の位置やデータの種類に関係なく，出力されません。

0xFE〜0xFFの範囲にある文字は，クエスチョンマーク（?）を出力します。

存在するマルチバイト文字が記述されている場合は，マルチバイト文字として出力します。

マルチバイト文字の区分と文字コードの範囲を次の表に示します。この範囲内で，存在するマルチバイト文字が記述されている場合に出力されます。出力するデータの並びが文字セットにとって不当な場合や，出力するデータの並びが正当でも有効な文字に対応付けできない場合は，クエスチョンマーク（?）を出力します。

表6‒3　UTF-8のマルチバイト文字の文字コードの範囲

区分

文字コードの範囲（16進数）

2バイト文字の開始バイト

0xC0〜0xDF

3バイト文字の開始バイト

0xE0〜0xEF

4バイト文字の開始バイト

0xF0〜0xF7

5バイト文字の開始バイト

0xF8〜0xFB

6バイト文字の開始バイト

0xFC〜0xFD

マルチバイト文字の2バイト目以降

0x80〜0xBF

なお，対応しない文字コードで記述された電文やバイナリデータも，範囲内に該当するデータがあれば，UTF-8のマルチバイト文字で出力されます。

bpacttrace={ON｜OFF}　〜<<OFF>>

ビジネスプロセスのアクティビティトレースを採取するかどうかを指定します。アクティビティトレースについては，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「7.4.5　アクティビティトレース」を参照してください。

ON

採取します。

OFF

採取しません。

bpacttrace-filenum=ビジネスプロセスのアクティビティトレース面数　〜＜数字＞((1−16))<<4>>

ビジネスプロセスのアクティビティトレースの最大面数を指定します。bpacttraceプロパティでONを設定した場合だけ有効になります。

bpacttrace-filesize=ビジネスプロセスのアクティビティトレースファイルサイズ　〜＜数字＞((4096−2147483647))<<2097152>>

ビジネスプロセスのアクティビティトレースファイルの1面当たりの最大サイズをバイト単位で指定します。bpacttraceにONを設定した場合だけ有効になります。

bpacttrace-extend-item={NONE｜PROCESSINSTANCEID}　〜<<NONE>>

ビジネスプロセスのアクティビティトレースに対し，出力項目を追加するか指定します。bpacttraceにONを設定した場合だけ有効になります。

NONE

アクティビティトレースへ追加で出力する項目はなし。

PROCESSINSTANCEID

アクティビティトレースにプロセスインスタンスの識別子を出力する。

応答アクティビティのあとにアクティビティを実行した場合，応答アクティビティの前後でスレッドIDが異なりますが，プロセスインスタンスの識別子を出力することでリクエストを特定できます。

bptrace-level={0｜10｜20｜30}　〜<<10>>

ビジネスプロセス基盤のメソッドトレースの出力レベルを指定します。出力レベルと出力内容を次の表に示します。

出力レベル

出力内容

0

エラー情報

10

エラー情報，他プログラム※との入出力／データ

主要な関数の入出力／データ

ビジネスプロセスのデバッグ実行機能が実行する通信の開始／終了，デバッグ処理の開始／終了

20

エラー情報，他プログラム※との入出力／データ

関数の入出力／データ

30

エラー情報，他プログラム※との入出力情報

関数の入出力／データ

主要な個所のポイント情報

注※

メッセージング基盤，データ変換基盤も含みます。

bptrace-filenum=BPトレースの面数　〜＜数字＞((1−16))<<16>>

ビジネスプロセス基盤のメソッドトレースの面数を指定します。

bptrace-filesize=BPトレースのサイズ　〜＜数字＞((4096−2147483647))<<2097152>>

ビジネスプロセス基盤のメソッドトレースのサイズをバイト単位で指定します。

bpexptrace-filenum=ビジネスプロセス基盤の例外ログ面数　〜＜数字＞((1−16))<<16>>

ビジネスプロセス基盤の例外ログの最大面数を指定します。

bpexptrace-filesize=ビジネスプロセス基盤の例外ログファイルサイズ　〜＜数字＞((4096−2147483647))<<2097152>>

ビジネスプロセス基盤の例外ログファイルの1面当たりの最大サイズをバイト単位で指定します。

cscexptrace-filenum=メッセージング基盤の例外ログ面数　〜＜数字＞((1−16))<<16>>

メッセージング基盤の例外ログの最大面数を指定します。

cscexptrace-filesize=メッセージング基盤の例外ログファイルサイズ　〜＜数字＞((4096−2147483647))<<2097152>>

メッセージング基盤の例外ログファイルの1面当たりの最大サイズをバイト単位で指定します。

kafka-protocoltrace-enabled={ON｜OFF}　〜<<OFF>>

Kafkaプロトコルトレースを採取するかどうかを指定します。

ON

プロトコルトレースを採取します。

OFF

プロトコルトレースを採取しません。

Kafkaプロトコルトレースを採取する場合はONを指定してください。Kafkaプロトコルトレースは，KafkaインバウンドアダプタとKafkaアダプタで共通して使用されます。

Kafkaプロトコルトレースについては，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「7.7.20(6)　Kafkaプロトコルトレース（Kafkaアダプタ・Kafkaインバウンドアダプタ共通）」を参照してください。

kafka-protocoltrace-level={ERROR｜WARN｜INFO｜DEBUG｜TRACE}　〜<<ERROR>>

Kafkaプロトコルトレースの出力レベルを指定します。

出力情報と出力レベルを次の表に示します。

情報種別

出力レベル

ERROR

WARN

INFO

DEBUG

TRACE

エラーレベルのログ

○

○

○

○

○

警告レベルのログ

×

○

○

○

○

情報レベルのログ

×

×

○

○

○

デバッグレベルのログ

×

×

×

○

○

詳細なログ

×

×

×

×

○

（凡例）

○：出力されます。

×：出力されません。

kafka-protocoltrace-filenum=Kafkaプロトコルトレース面数　〜＜数字＞((1−16))<<4>>

Kafkaプロトコルトレースの出力ファイル面数を指定します。kafka-protocoltrace-enabledにONを設定した場合だけ有効になります。

kafka-protocoltrace-filesize=Kafkaプロトコルトレースファイルサイズ　〜＜数字＞((1−2048))<<10>>

Kafkaプロトコルトレースの出力ファイルサイズをメガバイト単位で指定します。kafka-protocoltrace-enabledにONを設定した場合だけ有効になります。

grpc-transporttrace-enabled={ON｜OFF}　〜<<OFF>>

gRPC通信ログ機能（gRPC OSSライブラリが出力するログメッセージを採取する機能）を有効にするかどうかを指定します。

ON

有効にします。

OFF

無効にします。

grpc-transporttrace-level={SEVERE｜WARNING｜INFO｜CONFIG｜FINE｜FINER｜FINEST}　〜<<FINEST>>

gRPC通信ログの出力レベルを指定します。

出力情報と出力レベルを次の表に示します。

情報種別

出力レベル

SEVERE

WARNING

INFO

CONFIG

FINE

FINER

FINEST

致命的な処理の失敗が発生した旨を示すメッセージ

○

○

○

○

○

○

○

警告レベルのメッセージ

×

○

○

○

○

○

○

情報メッセージ

×

×

○

○

○

○

○

静的な構成に関するメッセージ

×

×

×

○

○

○

○

トレース情報を提供するメッセージ

×

×

×

×

○

○

○

詳細なトレース情報を提供するメッセージ

×

×

×

×

×

○

○

非常に詳細なトレース情報を提供するメッセージ

×

×

×

×

×

×

○

（凡例）

○：出力されます。

×：出力されません。

例えば，INFOを指定した場合，致命的な処理の失敗が発生した旨を示すメッセージ，警告レベルのメッセージ，情報メッセージが出力されます。

grpc-transporttrace-filenum=gRPC通信ログの最大面数　〜＜数字＞((1−16))<<4>>

gRPC通信ログの最大面数を指定します。

grpc-transporttrace-enabledにONを設定した場合だけ有効です。

grpc-transporttrace-filesize=gRPC通信ログの1面当たりの最大サイズ　〜＜数字＞((1−2147483647))<<10485760>>

gRPC通信ログの1面当たりの最大サイズをバイト単位で指定します。

grpc-transporttrace-enabledにONを設定した場合だけ有効です。

(b)　標準受付関連

request-ejb.instance.minimum=標準の同期受付（SessionBean）のインスタンス最小数　〜＜数字＞((0，または1−request-ejb.instance.maximumプロパティでの設定値))<<request-ejb.instance.maximumプロパティでの設定値>>

プール内の標準の同期受付（SessionBean）のインスタンス最小数を指定します。HCSCサーバセットアップ定義ファイルのrequest-ejbプロパティでONを指定している場合だけ有効になります。

request-ejb.instance.maximum=標準の同期受付（SessionBean）のインスタンス最大数　〜＜数字＞((1−1024))<<10>>

プール内の標準の同期受付（SessionBean）のインスタンス最大数を指定します。HCSCサーバセットアップ定義ファイルのrequest-ejbプロパティでONを指定している場合だけ有効になります。

CTMを使用している場合でCTMの同時実行数を動的に変更するときは，127以上を指定してください。

request-ejb.ctm={true｜false}　〜<<false>>

CTM連携をするかどうかを指定します。HCSCサーバセットアップ定義ファイルのrequest-ejbプロパティでONを指定している場合だけ有効になります。

true

CTM連携をします。

false

CTM連携をしません。

request-ejb.parallel.count=CTMがアプリケーションを呼び出すために用意するスレッド数　〜＜数字＞((1−127))<<1>>

CTMがアプリケーションを呼び出すために用意するスレッド数を指定します。request-ejb.ctmプロパティでtrueを指定している場合だけ有効になります。なお，request-ejb.instance.maximumプロパティで指定した値以下の値を指定してください。

request-ejb.optional.name=標準の同期受付（SessionBean）の別名　〜＜英数字，アンダーバー（_），ピリオド（.），およびスラッシュ（/）＞((1≦文字列長≦255))

標準の同期受付（SessionBean）の別名を指定します。標準受付を利用する場合はすべてのHCSCサーバで同じ別名を設定してください。

このプロパティは，JavaVMのシステムプロパティでejbserver.cui.optionalname.enabledがtrueに設定されている場合だけ有効になります。ejbserver.cui.optionalname.enabledについては，マニュアル「アプリケーションサーバリファレンス 定義編(サーバ定義)」の「5.2.3　usrconf.properties（サーバ管理コマンド用システムプロパティファイル）」を参照してください。

なお，次の名前を指定した場合，リクエスト受付の起動に失敗します。

次の値と重複した名前（起動状態のもの）

サービスアダプタのサービスID

ビジネスプロセスのサービスID

ユーザ定義受付の受付ID

そのほか，J2EEアプリケーションのoptional-nameの指定値など

"HITACHI_EJB"で始まる名前

名前の先頭または末尾に，スラッシュ（/）またはピリオド（.）を指定した名前

スラッシュ（/）だけ，またはピリオド（.）だけの名前

スラッシュ（/）が連続している名前

スラッシュ（/）およびピリオド（.）が連続している名前

また，文字列の前後に空白または改行がある場合は，取り除かれて設定されます。文字列の途中に空白，改行がある場合はエラーになります。

request-soap.instance.minimum=標準の同期受付（Webサービス・SOAP1.1）の最小同時実行数　〜＜数字＞((0，または1−request-soap.instance.maximumプロパティでの設定値))<<request-soap.instance.maximumプロパティでの設定値>>

プール内の標準の同期受付（Webサービス・SOAP1.1）の最小同時実行数を指定します。HCSCサーバセットアップ定義ファイルのrequest-soapプロパティでONを指定している場合だけ有効になります。

request-soap.instance.maximum=標準の同期受付（Webサービス・SOAP1.1）の最大同時実行数　〜＜数字＞((1−1024))<<10>>

プール内の標準の同期受付（Webサービス・SOAP1.1）の最大同時実行数を指定します。HCSCサーバセットアップ定義ファイルのrequest-soapプロパティでONを指定している場合だけ有効になります。

request-soap.exclusive.threads=標準の同期受付（Webサービス・SOAP1.1）の占有スレッド数　〜＜数字＞((0−1024))<<0>>

プール内の標準の同期受付（Webサービス・SOAP1.1）の占有スレッド数を指定します。最大同時実行数（request-soap.instance.maximum）を超えない範囲で値を指定してください。0を指定した場合，スレッドは占有されません。

なお，この指定値はWARの属性thread-control-exclusive-threadsに設定されます。このため，Webコンテナ全体の最大同時実行スレッド数や最大接続数などの値を考慮して指定する必要があります。

request-soap.queue-size=標準の同期受付（Webサービス・SOAP1.1）の実行待ちキューのサイズ　〜＜数字＞((0−2147483647))<<8192>>

プール内の標準の同期受付（Webサービス・SOAP1.1）の実行待ちキューのサイズを指定します。

request-soap1_2.instance.minimum=標準の同期受付（Webサービス・SOAP1.2）の最小同時実行数　〜＜数字＞((0，または1−request-soap1_2.instance.maximumプロパティでの設定値))<<request-soap1_2.instance.maximumプロパティでの設定値>>

プール内の標準の同期受付（Webサービス・SOAP1.2）の最小同時実行数を指定します。HCSCサーバセットアップ定義ファイルのrequest-soapプロパティでONを指定している場合だけ有効になります。

request-soap1_2.instance.maximum=標準の同期受付（Webサービス・SOAP1.2）の最大同時実行数　〜＜数字＞((1−1024))<<10>>

プール内の標準の同期受付（Webサービス・SOAP1.2）の最大同時実行数を指定します。HCSCサーバセットアップ定義ファイルのrequest-soapプロパティでONを指定している場合だけ有効になります。

request-soap1_2.exclusive.threads=標準の同期受付（Webサービス・SOAP1.2）の占有スレッド数　〜＜数字＞((0−1024))<<0>>

プール内の標準の同期受付（Webサービス・SOAP1.2）の占有スレッド数を指定します。最大同時実行数（request-soap1_2.instance.maximum）を超えない範囲で値を指定してください。0を指定した場合，スレッドは占有されません。

なお，この指定値はWARの属性thread-control-exclusive-threadsに設定されます。このため，Webコンテナ全体の最大同時実行スレッド数や最大接続数などの値を考慮して指定する必要があります。

request-soap1_2.queue-size=標準の同期受付（Webサービス・SOAP1.2）の実行待ちキューのサイズ　〜＜数字＞((0−2147483647))<<8192>>

プール内の標準の同期受付（Webサービス・SOAP1.2）の実行待ちキューのサイズを指定します。

request-jms.instance.maximum=標準の非同期受付（MDB（WS-R））のインスタンス最大数　〜＜数字＞((1−1024))<<10>>

プール内の標準の非同期受付（MDB（WS-R））のインスタンス最大数を指定します。HCSCサーバセットアップ定義ファイルのrequest-jmsプロパティでONを指定している場合だけ有効になります。

request-jms.rollback-count=標準の非同期受付（MDB（WS-R））ロールバック警告メッセージ出力回数　〜＜数字＞((1−2147483647))<<0>>

MDB（WS-R）受付で，キューから同一メッセージの抜き出しとロールバックが指定した回数以上実行された場合に，警告メッセージ（KDEC00049-W）を出力します。0を指定した場合は，警告メッセージを出力しません。

receptionstop-monitor-timer=受付キュー監視タイムアウト時間　〜＜数字＞((0−600))<<0>>

非同期標準受付（MDB（WS-R），MDB（DBキュー））のメッセージ処理のタイムアウト時間を秒単位で指定します。

キューの最大メッセージ数とメッセージ1件当たりの処理時間から，キューの中に仕掛かり中のメッセージが残る最大時間を算出して，それより大きな秒数を指定してください。0以外を指定する場合は，csc-receptionstop-timeoutプロパティにも値を指定する必要があります。

なお，次のどちらかに該当する場合は，デフォルト値（タイムアウトしない）のままでかまいません。

非同期標準受付（MDB（WS-R），MDB（DBキュー））を利用しない場合

計画停止を実行しない場合

0を指定した場合はタイムアウトしません。なお，Reliable Messagingにデッドメッセージキューを設定しない場合，ロールバックによって無限ループになるおそれがあるため，0は指定しないでください。

csc-receptionstop-timeout=受付終了待ち通信タイムアウト時間　〜＜数字＞((0−86400))<<csc-command-timeoutプロパティの設定値>>

非同期標準受付（MDB（WS-R），MDB（DBキュー））の通信処理のタイムアウト時間を秒単位で指定します。receptionstop-monitor-timerプロパティの設定値より長いタイムアウト時間を指定してください。

なお，次のどちらかに該当する場合は，デフォルト値（csc-command-timeoutプロパティの設定値）のままでかまいません。

非同期標準受付（MDB（WS-R），MDB（DBキュー））を利用しない場合

計画停止を実行しない場合

0を指定した場合はタイムアウトしません。

(c)　サービスアダプタ関連

soapfault-targetnamespace-filepath=SOAP Fault動作定義ファイルの絶対パス〜＜文字列＞

SOAP Fault動作定義ファイルを絶対パスで指定します。ディレクトリ区切りは「/」または「¥¥」を使用します。このプロパティは，SOAPアダプタでWebサービスからのSOAP Faultをすべてフォルトとして扱う場合に指定します。

SOAP Fault動作定義ファイルの詳細については，「6.6.1　SOAP Fault動作定義ファイル」を参照してください。

soapfault-handling-mode={DETAIL｜FAULTCODE}　〜<<FAULTCODE>>

SOAPアダプタでWebサービスからのSOAP Faultをフォルトとして扱うかどうか判別する処理の動作モードを指定します。このプロパティには「DETAIL」を指定することを推奨します。09-70以前との互換性を重視する場合は，「FAULTCODE」を指定してください。

DETAIL

SOAP1.1のSOAP Faultのdetail要素の直下の子要素，またはSOAP1.2のSOAP FaultのDetail要素の直下の子要素によって，フォルトとして扱うかどうか判別します。

FAULTCODE

SOAP1.1のSOAP Faultのfaultcode要素の値によって，フォルトとして扱うかどうか判別します。SOAP1.2のSOAP Faultはフォルトとして扱いません。

oa-adapter-character-code={SJIS｜MS932}　〜<<SJIS>>

Object Accessアダプタがサービス部品と送受信する電文の文字コードを指定するプロパティです。

すべてのObject Accessアダプタで，指定した文字コードが使用されます。

(d)　データ変換関連

formatdef-maxcache-num=フォーマット定義をキャッシュできる数　〜＜数字＞((1−2147483647))<<2147483647>>

フォーマット定義をキャッシュできる数の上限を指定します。この上限は，XMLフォーマット定義とバイナリフォーマット定義とで別々に適用されます。

なお，HCSCサーバが使用するフォーマット定義は，次に示す数の総和です。any型は対象外となります。

それぞれのビジネスプロセスで定義している全メッセージ型変数の数

それぞれのユーザ定義受付で定義している全要求電文フォーマットの数

それぞれのユーザ定義受付で定義している全応答電文フォーマットの数

それぞれのサービスアダプタで定義している全要求電文フォーマットの数

それぞれのサービスアダプタで定義している全応答電文フォーマットの数

もし，この総和を超えた値をプロパティに指定しても，不必要なメモリが使用されることはありません。リポジトリ中の全フォーマット定義をキャッシュさせたい場合は，大きい値を設定してください。

transformdef-maxcache-num=サーバ単位にデータ変換定義をキャッシュできる数　〜＜数字＞((1−2147483647))<<2147483647>>

データ変換定義をキャッシュできる数を指定します。データ変換定義が再利用されるためには，定義したデータ変換の数以上の数を指定します。

もし，定義したデータ変換の数以上の数をプロパティに指定しても，不必要なメモリが使用されることはありません。リポジトリ中の全データ変換定義をキャッシュさせたい場合は，大きい値を設定してください。

xmltelegram-maxcache-num=XML電文をキャッシュできる数　〜＜数字＞((0−2147483647))<<0>>

XML電文オブジェクトをキャッシュできる数を指定します。キャッシュされたXML電文オブジェクトが再利用されることによって，同じ形式のXML電文の処理時間を短縮できます。XML電文が再利用されるためには，次に示す値以上の数を指定します。

（サービスアダプタ・ビジネスプロセスのデータ変換設定数）＋（ビジネスプロセスのパス操作設定数）

0を指定した場合は，キャッシュされません。

なお，要素数の少ないXML電文の場合，処理時間が遅くなることがあります。

telegram-validation={ON｜OFF}　〜<<OFF>>

指定した電文フォーマットに対して，送受信する電文が適切かどうかを検証します（データ検証機能）。

ON

検証します。

OFF

検証しません。

データ検証機能については，マニュアル「サービスプラットフォーム 解説」の「6.2　データ検証機能」を参照してください。

xmltelegram-namespace-complement={ON｜OFF}　〜<<OFF>>

HCSCサーバ内を流れるXML電文に対して，XML電文内に存在する属性値に指定した名前空間接頭辞に対応する名前空間宣言を補完するかどうかを指定します。

ON

名前空間接頭辞に対応する名前空間宣言を補完します。

OFF

名前空間接頭辞に対応する名前空間宣言を補完しません。

HCSCサーバ内を流れるユーザ電文で，XMLスキーマの属性値の型にQName型を使用する場合は，ONを指定してください。ただし，ONを指定すると，OFFを指定した場合よりも電文サイズが大きくなるため注意してください。

詳細については，マニュアル「サービスプラットフォーム 解説」の「4.5　XML電文内の属性値に指定した名前空間接頭辞の補完」を参照してください。

telegram-undefined-character-code={ERROR｜REPLACE}　〜<<ERROR>>

バイナリデータの文字コード変換処理で，未定義の文字コードが検出された場合の動作を指定します。

ERROR

検出時にエラーとなり処理を終了します。

REPLACE

未定義部分の文字コードを空白，または任意の文字コードに置換して処理を継続します。

空白はすべて全角に置換することも，シフト・エスケープ状態にあわせて全角・半角に置換することもできます。設定方法については，「1.3.1　フォーマットダイアログ」を参照してください。

telegram-notfound-soapheader={ERROR｜IGNORE}　〜<<IGNORE>>

ビジネスプロセスで定義したヘッダ割当変数に該当するデータが，送受信する電文に含まれない場合に，処理を継続するかどうかを指定します。

ERROR

エラーメッセージを出力して処理を中断します。

IGNORE

処理を継続します。

validation-activity={ON｜OFF}　〜<<ON>>

検証アクティビティでメッセージ型変数（XML）を検証するかどうかを定義します。HCSCサーバ内すべてのビジネスプロセスの検証アクティビティが対象となります。

ON

検証アクティビティに指定したメッセージ型変数（XML）を検証します。

OFF

検証アクティビティに指定したメッセージ型変数（XML）を検証しません。

transform-binary-error-check={ON｜OFF}　〜<<ON>>

バイナリデータ変換時のエラーチェックの実施有無を定義します。データ変換アクティビティの延長で，生成したバイナリデータがバイナリフォーマット定義に沿っているかをチェックできます。

ON

バイナリフォーマット定義に沿っているかのエラーチェックをします。データ変換でバイナリデータに変換する場合はONを設定してください。

OFF

バイナリフォーマット定義に沿っているかのエラーチェックをしません。

code-table-root-path=コード変換テーブル格納パスのルートパスの絶対パス　〜＜文字列（2バイト文字含む）および空白＞<<<サービスプラットフォームのインストールディレクトリ>¥¥CSC¥¥userlib¥¥codetables>>

コード変換テーブル格納パスのルートパスを絶対パスで指定します。ディレクトリ区切りは「/」または「¥¥」を使用します。存在しないディレクトリを指定した場合は，HCSCサーバの起動に失敗します。

(e)　ビジネスプロセス関連

syserr-to-fault-convert={ON｜OFF}　〜<<OFF>>

システム例外が発生した場合に汎用フォルトを発生させるかどうかを定義します。

次に示すアクティビティが対象です。syserr-to-fault-convert-all-activityプロパティとは対象となるアクティビティが異なりますが，出力する汎用フォルト電文の内容は同じです。

データ変換アクティビティ

代入アクティビティ

分岐アクティビティ

汎用フォルト電文の出力内容については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「7.12.1　汎用フォルト電文を定義するスキーマファイル」を参照してください。

このプロパティは，syserr-to-fault-convert-all-activityプロパティと同時に指定してもエラーにはなりません。syserr-to-fault-convert-all-activityプロパティと指定が異なる場合は，ONを指定したプロパティが適用され汎用フォルトが発生します。

プロパティには次のどちらかを指定します。

ON

システム例外をキャッチして汎用フォルトを発生させます。

OFF

システム例外発生時に汎用フォルトを発生させません。

syserr-to-fault-convert-all-activity={ON｜OFF}　〜<<OFF>>

システム例外が発生した場合に汎用フォルトを発生させるかどうかを定義します。汎用フォルトが発生するすべてのアクティビティおよびコネクションが対象です。

対象となるアクティビティおよびコネクションを次に示します。syserr-to-fault-convertプロパティとは対象となるアクティビティが異なりますが，出力する汎用フォルト電文の内容は同じです。

Java呼出アクティビティ

データ変換アクティビティ※

代入アクティビティ※

フォルト送出アクティビティ

検証アクティビティ

ログ出力アクティビティ

繰り返しアクティビティ

分岐アクティビティ※

リンクコネクション

注※

syserr-to-fault-convertプロパティと指定が異なる場合は，ONを指定したプロパティが適用され汎用フォルトが発生します。

汎用フォルト電文の出力内容については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「7.12.1　汎用フォルト電文を定義するスキーマファイル」を参照してください。

このプロパティは，syserr-to-fault-convertプロパティと同時に指定してもエラーにはなりません。

プロパティには次のどちらかを指定します。

ON

システム例外をキャッチして汎用フォルトを発生させます。

OFF

システム例外発生時に汎用フォルトを発生させません。

validate-fault-compatible={ON｜OFF}　〜<<ON>>

検証フォルトで送られるフォルト電文のフォーマットを09-00以前まで使用していたフォーマットとするかどうかを定義します。

ON

フォルト電文を09-00形式以前のフォーマットで送信します。

OFF

プロセスインスタンス識別子やアクティビティ名を持つ，新しいフォーマットでフォルト電文を送信します。

bp-reply-after-min-thread-pool-size=応答アクティビティ後のアクティビティを実行するために使用するスレッドの最小数　〜＜数字＞((1−2147483647))<<16>>

応答アクティビティ後のアクティビティを実行するために使用するスレッドの，スレッドプール内で使用していないスレッドを保存する最小数を定義します。

定義内容はHCSCサーバ単位で有効となるため，HCSCサーバ内で応答後にアクティビティを定義したビジネスプロセスの同時実行数を考慮した値を設定してください。

bp-reply-after-max-thread-pool-sizeより大きい値を設定した場合は，cscsvconfigコマンド実行時にエラーとなります。

bp-reply-after-max-thread-pool-size=応答アクティビティ後のアクティビティを実行するために使用するスレッドの最大数　〜＜数字＞((1−2147483647))<<32>>

応答アクティビティ後のアクティビティを実行するために使用するスレッドの，スレッドプール内に生成できる最大数を定義します。

定義内容はHCSCサーバ単位で有効となるため，HCSCサーバ内で応答後にアクティビティを定義したビジネスプロセスの同時実行数を考慮した値を設定してください。

bp-reply-after-thread-pool-keep-alive=応答アクティビティ後のアクティビティを実行するために使用するスレッドの保持時間　〜＜数字＞((1−2147483647))<<60>>

応答アクティビティ後のアクティビティの実行で使用していないスレッド数が，bp-reply-after-min-thread-pool-sizeで指定した数を超えている場合，スレッドの終了までに保存しておく時間（単位：秒）を定義します。

定義内容はHCSCサーバ単位で有効となるため，HCSCサーバ内で応答後にアクティビティを定義したビジネスプロセスの同時実行数を考慮した値を設定してください。

service-emulate.enable={true｜false}　〜<<false>>

サービスのエミュレーション機能を有効にするかどうかを指定します。

true

サービスのエミュレーション機能を有効にします。

false

サービスのエミュレーション機能を有効にしません。

service-emulate-def-filepath=エミュレート設定情報定義ファイルの絶対パス　〜＜文字列（2バイト文字含む）および空白＞

実行環境でサービスのエミュレーション機能を実行（service-emulate.enable=trueを指定）する場合に，エミュレート設定情報定義ファイルのパスを絶対パスで指定します。ディレクトリ区切りは「/」または「¥¥」を使用してください。

service-emulate.enable=trueが指定されている場合にこのプロパティの指定を省略すると，cscsvconfigコマンド実行時にエラーになります。

エミュレート設定情報定義ファイルの定義方法については，「6.5.7　エミュレート設定情報定義ファイル」を参照してください。

bp-log-activity-definition-filepath=ログ出力アクティビティ定義ファイルの絶対パス　〜＜文字列（2バイト文字含む）および空白＞

ログ出力アクティビティを使用するする場合に，ログ出力アクティビティ定義ファイルのパスを絶対パスで指定します。ディレクトリ区切りは「/」または「¥¥」を使用してください。

(f)　J2EE関連

j2ee-stopapp-timeout=J2EEアプリケーション停止監視時間　〜＜数字＞((0−2147483647))<<60>>

リクエスト受付停止，ビジネスプロセスまたはサービスアダプタの停止コマンドで発行するJ2EEアプリケーションが停止した際の監視時間を秒単位で指定します。リクエスト処理中の場合，指定された時間だけ待機します。

タイムアウト発生後，リクエスト受付，ビジネスプロセス，サービスアダプタを強制停止します。

startcsc-timeout=J2EEサーバ起動監視時間　〜＜数字＞((1−2147483647))<<180>>

HCSCサーバ起動コマンドで，J2EEサーバ起動を監視する監視値を秒単位で指定します。HCSCサーバ起動コマンドでタイムアウトが発生しても，J2EEサーバの起動処理は継続されます。

なお，09-50以降でこのプロパティを設定しても無効になるため，設定は不要です。

stopcsc-timeout=J2EEサーバ停止監視時間　〜＜数字＞((1−2147483647))<<180>>

HCSCサーバ停止コマンドで，J2EEサーバ停止を監視する監視時間を秒単位で指定します。HCSCサーバ停止コマンドでタイムアウトが発生しても，J2EEサーバの停止処理は継続されます。

なお，09-50以降でこのプロパティを設定しても無効になるため，設定は不要です。

(g)　コマンドの通信のタイムアウト時間の監視

csc-command-timeout=コマンドタイムアウト時間　〜＜数字＞((0−86400))<<300>>

次に示す機能で，J2EEサーバのスローダウンや，J2EEサーバとデータベースの間で通信障害が発生した場合に，クライアント側に通知するためのタイムアウト時間を秒単位で指定します。

cscで始まるコマンド

運用管理GUI（Eclipse）

開発画面GUI（Eclipse）

0を指定した場合は，タイムアウトしません。

csc-precache-timeout=事前キャッシュ処理のためのビジネスプロセスへのEJB通信のタイムアウト時間　〜＜数字＞((0−86400))<<0>>

各ビジネスプロセスでの事前キャッシュ処理のタイムアウト時間を秒単位で指定します。

0を指定した場合は，タイムアウトしません。

(h)　Cookie情報の引き継ぎ

cookie-parsing={ON｜OFF}　〜<<OFF>>

Cookie情報を引き継ぐかどうかを指定します。

ON

Cookie情報を暗黙的に引き継ぎます。

OFF

Cookie情報を暗黙的に引き継ぎません。

(i)　フォルダ関連

work-folder=作業フォルダルートの絶対パス　〜＜文字列（2バイト文字含む）および空白＞<<<サービスプラットフォームのインストールディレクトリ>¥¥CSC¥¥spool¥¥ftp¥¥work>>

作業フォルダルートを絶対パスで指定します。ディレクトリ区切りは「/」または「¥¥」を使用します。存在しないディレクトリを指定した場合は，HCSCサーバの起動に失敗します。

指定した作業フォルダの配下には，製品として153バイトのパスが必要です。任意の作業フォルダルートを指定する場合は，OSの最大パス長を超えないようにしてください。

common-folder-<共通フォルダ定義名>=共通フォルダの絶対パス　〜＜文字列（2バイト文字含む）および空白＞((1≦文字列長≦64))<<<サービスプラットフォームのインストールディレクトリ>¥¥CSC¥¥spool¥¥ftp¥¥com>>

共通フォルダの絶対パスを指定します。異なる共通フォルダ定義名を指定すると，同じディレクトリを指定できます。

<共通フォルダ定義名>

共通フォルダ定義名に指定できる値は，半角英数字とアンダーバー（_）です。

指定を省略した場合の共通フォルダ定義名は「default」になります。

共通フォルダの絶対パス

ディレクトリ区切りは「/」または「¥¥」を使用します。存在しないディレクトリを指定した場合は，HCSCサーバの起動に失敗します。

なお，共通フォルダの使用時は，共通フォルダの配下に次に示す長さのパスが作成されます。これを考慮して，パス全体の長さがOSの最大パス長を超えないよう共通フォルダを指定してください。

ユーザ指定ファイル名の長さ＋106バイト

なお，HTTPアダプタとメールアダプタの場合は，機能に応じて使用するパスの長さが異なります。機能ごとに必要なパス長を次に示します。

サービスアダプタの種類

使用する機能

パス全体の長さ※1

HTTPアダプタ

HTTPリクエストでファイルを送信する場合

以下を合計したバイト数

共通フォルダルートのパスのバイト数

共通フォルダの配下のパスのバイト数（106バイト※2）

使用するファイル名のバイト数

HTTPレスポンスでファイルをダウンロードする場合

以下を合計したバイト数

共通フォルダルートのパスのバイト数

共通フォルダの配下のパスのバイト数（156バイト※2）

メールアダプタ

メール本文として使用するファイルを送信する場合

以下を合計したバイト数

共通フォルダルートのパス

共通フォルダの配下のパスのバイト数（106バイト※2）

使用するファイル名のバイト数

メールの添付ファイルを送信する場合

注※1

サブフォルダを使用する場合は，サブフォルダの相対パス長も加算されます。

注※2

サブフォルダを使用する場合は，さらにパス長が1バイト加算されます。

definition-file-base-path=実行環境の独自定義ファイルの格納先ディレクトリの絶対パス　〜＜文字列（2バイト文字含む）および空白＞<<<サービスプラットフォームのインストールディレクトリ>¥¥CSC¥¥config¥¥services>>

実行環境の独自定義ファイル設定機能を使用する場合に，独自定義ファイル格納ディレクトリを絶対パスで指定します。ディレクトリ区切りは「/」または「¥¥」を使用します。実行環境の独自定義ファイル設定機能については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.10.3　実行環境の独自定義ファイル設定機能を使用した独自定義ファイルの定義手順」を参照してください。

ネットワーク経由で他ホスト上のディレクトリを指定した場合は，動作を保証しません。該当するディレクトリを次に示します。

Windowsの場合：ネットワークドライブおよびUNCで参照できるディレクトリ

UNIXの場合：NFSマウントで参照できるディレクトリ

(j)　DBアダプタ関連

dba-separate-transaction={true｜false}　〜<<false>>

DBアダプタのトランザクションをビジネスプロセスとは別に開始するかどうかを指定します。

ビジネスプロセスとは別にDBアダプタのトランザクションを開始する場合，「true」を指定するか，SQLオペレーション定義ファイルのdba_separate_transaction属性に「Y」を指定したうえで，DBアダプタのアプリケーション統合属性ファイルのtrans-attribute要素指定値をRequiredからRequiresNewに変更してください。

true

ビジネスプロセスとは別にDBアダプタのトランザクションを開始します。

false

ビジネスプロセスと同一のトランザクションをDBアダプタでも使用します。

(k)　コンポーネント共通UOC関連

common-uoc-prop-path=コンポーネント共通UOC用プロパティファイル格納フォルダ　〜＜文字列（2バイト文字含む）＞

コンポーネント共通UOC用プロパティファイルの格納フォルダを絶対パスで指定します。フォルダ区切りは「/」または「¥¥」を使用してください。なお，プロパティ名だけ指定して格納フォルダを指定しないと，HCSCサーバランタイム定義ファイルの読み込み時に例外が発生します。

コンポーネント共通UOC用プロパティファイルを指定すると，コンポーネント共通UOC機能が使用され，UOCクラスの呼び出しの前後で性能解析トレースが出力されます。

コンポーネント共通UOC用プロパティファイルの指定方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「付録G　コンポーネント共通UOC」を参照してください。また，コンポーネント共通UOC機能で出力される性能解析トレースについては，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「7.4.3　性能解析トレース」を参照してください。

(l)　HCSCサーバ関連

short-processid-servername=プロセスインスタンスの識別子で使用するHCSCサーバ名の識別子　〜＜半角英数字，アンダーバー（_）＞((1−8文字))<<HCSCサーバ名>>

プロセスインスタンスの識別子で使用するHCSCサーバ名の識別子を指定します。クラスタ内で一意となる識別子を設定してください。一意でない値を設定した場合は動作を保証しません。

このプロパティは，short-processidプロパティでONを指定した場合だけ有効です。

short-processid={ON｜OFF}　〜<<OFF>>

プロセスインスタンスの識別子を短縮するかどうかを設定します。ローカルマシンにIPv6アドレスを使用し，かつJ2EEサーバ名が111バイト以上である場合は，プロセスインスタンスの生成でエラーが発生する可能性があります。その場合はONを指定してください。

ON

プロセスインスタンスの識別子を短縮します。

OFF

プロセスインスタンスの識別子を短縮しません。

(m)　インスタンスのプール

xml-pooled-instance-minimum=XML処理に使用するクラスのインスタンスプールの最小数　〜＜数字＞((0−2147483647))<<0>>

要求電文・応答電文の処理に使用するクラスのインスタンスをキャッシュする最小数を指定します。xml-pooled-instance-maximumプロパティの設定値以下の値を設定してください。xml-pooled-instance-maximumプロパティより大きい値を設定すると，cscsvconfigコマンドの実行時にエラーが発生します。

HCSCサーバの起動時には，このプロパティに指定された数のインスタンスを生成してプールに設定します。0を指定すると，HCSCサーバの起動時にインスタンスはキャッシュされません。

usrconf.properties（J2EEサーバ用ユーザプロパティファイル）のcsc.dt.pool.DocumentBuilder.initialSizeプロパティが設定されている場合は，それと同じ値を設定してください。

xml-pooled-instance-maximum=XML処理に使用するクラスのインスタンスプールの最大数　〜＜数字＞((0−2147483647))<<64>>

要求電文・応答電文の処理に使用するクラスのインスタンスをキャッシュする最大数を指定します。

usrconf.properties（J2EEサーバ用ユーザプロパティファイル）のcsc.dt.pool.DocumentBuilder.maxSizeプロパティが設定されている場合は，それと同じ値を設定してください。csc.dt.pool.DocumentBuilder.maxSizeプロパティを設定していない場合は，HCSCサーバ内のすべてのリクエスト受付の，最大実行数の総和以上の値を指定してください。

0を指定した場合はキャッシュされません。

設定した最大数を超えるリクエストが来た場合，リクエストの処理待ちが発生する場合があります。

(n)　カスタム受付関連

request-id-separate-key={slash｜atsign｜period}　〜<<slash>>

FTP受付およびHTTP受付で生成するリクエストIDの分割キーを指定します。

slash

リクエストIDの分割キーとして半角スラッシュ（/）が使用されます。

atsign

リクエストIDの分割キーとして半角アットマーク（@）が使用されます。

period

リクエストIDの分割キーとして半角ピリオド（.）が使用されます。

注意事項

リクエストIDの分割キーを変更する際は，エラーまたは実行中状態のプロセスインスタンスが存在しない状態で変更してください。

この訂正内容は，Service Coordinator 09-51-01以降で該当します。

fileevent-reception.monitored-file.enabled={true｜false}　〜<<false>>

ファイル監視の可否を指定します。

true

ファイル監視機能を有効にします。ファイルイベント受付を使用する場合は，trueを設定してください。

false

ファイル監視機能を無効にします。

fileevent-reception.monitored-folder=監視フォルダの絶対パス　〜<文字列（2バイト文字含む）および空白><<<サービスプラットフォームのインストールディレクトリ>¥¥CSC¥¥spool¥¥fileevent>>

監視フォルダのパスを絶対パスで指定します。ディレクトリ区切りは「/」または「¥¥」を使用します。共通フォルダと同じディレクトリは指定しないでください。

絶対パスで指定されていない場合や，存在しないディレクトリを設定した場合は，HCSCサーバの起動に失敗します。

取得対象ファイルを監視する場合はこのプロパティの指定は不要です。指定しても無効となります。

fileevent-reception.monitor-interval=ファイル監視の間隔　〜＜数字＞((1−44640))<<10>>

ファイル監視の間隔を分単位で指定します。

fileevent-reception.monitor-starting.delay=ファイル監視の開始待ち時間　〜＜数字＞((1−44640))<<10>>

HCSCサーバの起動の何分後にファイル監視を開始するかを指定します。

ファイル監視は，HCSCサーバの起動コマンドを実行した時点から，ここで指定した時間が経過したのちに開始されるようになります。

(5)　記述例

サンプルファイルを次に示します。

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)　使用方法

cscsvconfigコマンドの-propfileオプションの引数にHCSCサーバランタイム定義ファイルを指定します。詳細については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「3.1.4　HCSCサーバの定義情報を設定する」を参照してください。

(7)　注意事項

パスを指定する場合の注意事項を次に示します。

相対パス，親ディレクトリ表現（「..¥」，「../」），およびカレントディレクトリ表現（「.¥」，「./」）を含むパスは指定しないでください。

シンボリックリンクを含むパスは指定しないでください。

Windowsの場合，UNC形式，NTFSのストリーム名，および予約デバイス名を含むパスは指定しないでください。また，パスの大文字と小文字は区別されません。

6.5.7　エミュレート設定情報定義ファイル

(1)　形式

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE HCSCAutoEmulate SYSTEM "debug_auto_emulate_list_file_1_0.dtd">
<HCSCAutoEmulate>
<viewState>
<emulate condition="(条件式)" operation="(オペレーション名)" service="(サービス名)" type="(応答種別)" valid="(エミュレーションの実行有無)" xmlfile="(応答電文ファイルのパス)"/>
<emulate condition="(条件式)" operation="(オペレーション名)" service="(サービス名)" type="(応答種別)" valid="(エミュレーションの実行有無)" xmlfile="(応答電文ファイルのパス)"/>
　　　　　　　　　　　　　　　　　：
</viewState>
</HCSCAutoEmulate>

(2)　機能

エミュレーション機能の設定情報をXML形式で設定します。サービスのエミュレーション機能については，マニュアル「サービスプラットフォーム 解説」の「4.13　サービスのエミュレーション機能の概要」を参照してください。

エミュレート設定情報定義ファイルは，リクエストごとに次に示すタイミングで読み込んで解析されます。

ビジネスプロセス内で最初に定義されているサービス呼出アクティビティの実行時

応答アクティビティ後の最初に定義されているサービス呼出アクティビティの実行時

待機アクティビティ後に最初に定義されているサービス呼出アクティビティの実行時

また，プロセスインスタンスの再実行時には，再実行の範囲内で最初に定義されているサービス呼出アクティビティ実行時に読み込んで解析されます。

ファイル内のxmlfile属性に設定した応答電文ファイルも，リクエストのたびに読み込まれます。そのため，エミュレート設定情報定義ファイルや応答電文ファイルの内容を変更すると，変更内容は次回のリクエストで反映されます。なお，リクエスト実行中にこれらのファイルの内容を変更した場合の動作は保証しません。

注意事項

開発環境のビジネスプロセスのデバッグ機能で応答電文をエミュレーションした場合，該当するサービス呼出アクティビティでは，エミュレート設定情報定義ファイルの設定は有効となりません。

エミュレーション実行時はサービスアダプタを呼び出さないため，サービスアダプタで実行するサービスアダプタ固有の機能や，ビジネスプロセスのサービス呼出アクティビティの機能の一部は使用できません。

エミュレート設定情報定義ファイルは次の手順で作成し，実行環境に反映してください。

次のテンプレートファイルを任意のディレクトリにコピーします。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥msg¥templates¥service_emulate_info.aels

必ずテンプレートファイルを基に定義してください。それ以外の方法で作成した場合の動作は保証しません。

要素の記述を編集して，拡張子「.aels」の任意のファイル名で保存します。

拡張子が「.aels」でない場合は，cscsvconfigコマンド（HCSCサーバランタイムの定義）実行時にエラーとなります。

(3)　設定できる要素

<?xml version="1.0" encoding="UTF-8"?>

このファイルがXMLファイルであることを示すXML宣言です。

<!DOCTYPE HCSCAutoEmulate SYSTEM "debug_auto_emulate_list_file_1_0.dtd">

DTDサブセットを示す要素型定義宣言です。

<HCSCAutoEmulate>

エミュレート設定情報定義のルート要素です。

<viewState>

エミュレート設定情報定義のルート要素です。

<emulate condition="(条件式)" operation="(オペレーション名)" service="(サービス名)" type="(応答種別)" valid="(エミュレーションの実行有無)" xmlfile="(応答電文ファイルのパス)"/>

エミュレート設定情報を定義します。emulate要素は複数定義することもできます。

次の条件を満たす複数のemulate要素が定義された場合，emulate要素は出現順に有効となります。

condition属性に設定された条件式の評価結果が「真」

service属性とoperation属性の値が同じ

valid属性がtrue

emulate要素の優先順位の詳細については，「(4) エミュレーション時に使用する定義の優先順位」を参照してください。

emulate要素の指定内容を次に示します。

condition="(条件式)"

サービスをエミュレーションする条件式をstring型のXPathで入力します。

条件式は，要求電文の変数種別が「XML」または「non-XML」の場合だけ設定できます。「any」の場合は動作を保証しません。

条件式は，valid=true（エミュレーション機能が有効）が設定されている場合に評価されます。

条件式の指定に関する注意事項を次に示します。

条件式を使用しない場合は空文字列を指定してください。条件式を使用しない場合，条件式の評価結果は真とみなされます。

条件式には，bpws:getVariablePropertyなどの拡張関数や，変数名を直接指定して情報を取得する方法でXPathを指定しないでください。指定した場合の動作は保証しません。

条件式にエスケープ文字「< > & " '」を含める場合は，実体参照で指定してください。

operation="(オペレーション名)"

サービスアダプタのオペレーション名をstring型で指定します。

service="(サービス名)"

サービスアダプタのサービス名をstring型で指定します。

type="(応答種別)"

応答種別を次のどちらかで指定します。

RESPONSE_NORMAL

通常応答の場合に指定します。

応答電文ファイルの内容を応答電文として返します。

RESPONSE_FAULT

フォルト応答の場合に指定します。

応答電文ファイルの内容をフォルト電文として返します。

valid="(エミュレーションの実行有無)"　〜<<false>>

エミュレーションの実行有無を次のどちらかで指定します。

true

エミュレーションを実行します。

false

エミュレーションを実行しないでサービスアダプタを呼び出します。

xmlfile="(応答電文ファイルのパス)"

エミュレーションする電文が記載された応答電文ファイルのパスをstring型の絶対パスで指定します。

パスの区切り文字は，HCSCサーバがWindows上にある場合は「¥」，UNIX上にある場合は「/」を指定してください。

ファイルパスにエスケープ文字「< > & " '」を含める場合は，実体参照で指定してください。

応答電文にXML形式のデータを指定する場合は，XMLの文字コードがUTF-8である必要があります。

なお，応答電文ファイルにXSLTスタイルシート（ファイル拡張子「.xsl」）を指定すると，要求電文をXSLTスタイルシートで変換した結果を応答電文としてエミュレーションできます。このエミュレーションでの注意点を次に示します。

要求電文と応答電文の両方の変数種別がXMLの場合だけ実行できます。両方の変数種別がXMLでない場合，動作は保証しません。

変換元（要求電文）を複数指定することはできません。

XSLTスタイルシートには，マッピング定義エディタから生成したデータ変換定義ファイルで，かつファイル拡張子が「.xsl」のファイルを指定する必要があります。それ以外のファイルを指定した場合の動作は保証しません。

(4)　エミュレーション時に使用する定義の優先順位

エミュレーションで使用する定義の優先順位は，エミュレート設定情報定義ファイルのemulate要素の出現順となります。

優先順位は，エミュレート設定情報定義ファイル内で次の条件を満たすemulate要素同士で適用されます。

service属性とoperation属性が同一である

valid属性がtrueである

次の例では，1番目のemulate要素のvalid属性にfalseが設定されています。そのため，2番目のemulate要素の設定情報がエミュレーションの実行対象となります。

　　　　　　　　　　　　　：
<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>
　　　　　　　　　　　　　：

なお，この優先順位は，condition属性に設定された条件式の評価結果が偽であるemulate要素には適用されません。そのため，条件式の評価結果に応じて，エミュレーションする応答電文を変えることができます。

次の例では，一部のemulate要素のcondition属性に条件式を設定しています。条件式では，要求電文のelm1要素の設定値に応じて，エミュレーションの実行対象となる応答電文が変わるよう定義しています。

図6‒1　エミュレート設定情報定義ファイルに条件式を設定する場合の定義例

条件式（XPath）を定義するには，評価する要求電文の要素のパスが必要です。パスは，ビジネスプロセス定義画面の変数一覧から該当する変数を選択し，［表示］ボタンをクリックすることで取得できます。

図中の3つのemulate要素は，service属性とoperation属性の値が同じで，valid属性がtrueです。そのため，condition属性に設定された条件式の評価結果に応じて，有効となるemulate要素が次のように変わります。

要求電文の値が「exec1」の場合

1番目のemulate要素が有効となります。

要求電文の値が「exec2」の場合

1番目のemulate要素の条件式の評価結果が「偽」であるため，2番目のemulate要素の条件式が評価されます。

2番目のemulate要素の条件式の評価結果が「真」であるため，2番目のemulate要素が有効となります。

要求電文の値が「exec3」の場合

1番目・2番目のemulate要素の条件式の評価結果が「偽」であるため，3番目に出現したemulate要素が有効となります。

(5)　記述例

エミュレート設定情報定義ファイルの記述例を次に示します。この例では，TP1アダプタのexecオペレーションをエミュレーションしています。

<?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>

この例では次の値を設定しています。

属性名

設定値

condition

条件を定義しないことを示す空文字列（""）を設定しています。

operation

サービス呼出アクティビティのオペレーション名で選択されている「exec」を設定しています。

service

サービス呼出アクティビティのサービス名で選択されている「TP1Adapter」を設定しています。

type

通常応答を意味する「RESPONSE_NORMAL」を設定しています。

valid

エミュレーション機能を実行するため「true」を設定しています。

xmlfile

応答電文ファイル「/data/telegram/exec1」を設定しています。

このファイルの内容は，サービス呼出アクティビティの応答電文のボディ割当変数「out」に設定されます。

6.5.8　コンポーネントID設定ファイル

(1)　形式

［<HCSCコンポーネントID>={ON｜OFF}］
　　　　　　　　　：
［<HCSCコンポーネントID>={ON｜OFF}］

(2)　機能

ユーザ電文トレースへのHCSCコンポーネントの出力要否をHCSCコンポーネントID（受付IDまたはサービスID）で設定します。HCSCコンポーネントは1行ずつ，J2SEのプロパティファイル形式で設定します。

参考

ユーザ電文トレースの出力有無をHCSCコンポーネント種別で設定するには，コンポーネント種別設定ファイルを設定してください。

コンポーネントID設定ファイルとコンポーネント種別設定ファイルは，両方設定することもできます。同じHCSCコンポーネントに対して，コンポーネントID設定ファイルとコンポーネント種別設定ファイルの両方で設定した場合，コンポーネントID設定ファイルの設定が適用されます。

(3)　ファイルの格納先

コンポーネントID設定ファイルにはテンプレートファイルはありません。

作成したコンポーネントID設定ファイルのファイル名，格納先は任意です。

作成したコンポーネントID設定ファイルを有効にするには，HCSCサーバランタイム定義ファイルのtelegramtrace-component-id-filepathプロパティでパスを指定してください。

(4)　設定できるパラメタ

<HCSCコンポーネントID>={ON｜OFF}

ユーザ電文トレースへのHCSCコンポーネントの出力要否を指定します。

<HCSCコンポーネントID>

サービスIDまたは受付IDを指定します。

{ON｜OFF}

指定されたHCSCコンポーネントをユーザ電文トレースへ出力するか指定します。

ON：ユーザ電文トレースへ出力します。

OFF：ユーザ電文トレースへ出力しません。

設定値（ONまたはOFF）は完全一致で判定されるため，それ以外の値や空文字を指定した場合は，コンポーネントIDを指定しなかった場合と同じ動作となります。

なお，ユーザ電文トレースへのHCSCコンポーネントの出力要否は，コンポーネント種別設定ファイル（HCSCコンポーネント種別での指定）でも指定できます。同じHCSCコンポーネントに対して，コンポーネントID設定ファイルとコンポーネント種別設定ファイルの両方で設定した場合，コンポーネントID設定ファイルの設定が適用されます。

(5)　記述例

ユーザ電文トレースへ次に示す情報を出力する場合を例に示します。

HCSCコンポーネントID「RCP1」の情報を出力する

HCSCコンポーネントID「ADP1」の情報を出力しない

この場合，コンポーネントID設定ファイルには次のように記述します。

RCP1=ON
ADP1=OFF

ユーザ電文トレースに，HCSCコンポーネントID「FTP_RCP1」「FTP_ADP1」「FTP_ADP3」を除くすべてのFTP受付とFTPアダプタの情報を出力する場合，コンポーネント種別設定ファイルとコンポーネントID設定ファイルを組み合わせて次のように記述します。

コンポーネント種別設定ファイルの内容（FTP受付とFTPアダプタを出力）

reception.urecp.ftp
adapter.ftp

コンポーネントID設定ファイルの内容（HCSCコンポーネントID「FTP_RCP1」「FTP_ADP1」「FTP_ADP3」を出力対象から除外）

FTP_RCP1=OFF
FTP_ADP1=OFF
FTP_ADP3=OFF

6.5.9　コンポーネント種別設定ファイル

(1)　形式

［<HCSCコンポーネント種別>］
　　　　　　：
［<HCSCコンポーネント種別>］

(2)　機能

ユーザ電文トレースへ出力するHCSCコンポーネントの種別を1行ずつ設定します。J2SEのプロパティファイル形式で設定します。

参考

ユーザ電文トレースの出力有無をHCSCコンポーネントIDで設定するには，コンポーネントID設定ファイルを設定してください。

コンポーネントID設定ファイルとコンポーネント種別設定ファイルは，両方設定することもできます。同じHCSCコンポーネントに対して，コンポーネントID設定ファイルとコンポーネント種別設定ファイルの両方で設定した場合，コンポーネントID設定ファイルの設定が適用されます。

(3)　ファイルの格納先

テンプレートファイルは次の場所に格納されています。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥msg¥templates¥csctelegram_component_type.properties

作成したコンポーネント種別設定ファイルのファイル名，格納先は任意です。

作成したコンポーネント種別設定ファイルを有効にするには，HCSCサーバランタイム定義ファイルのtelegramtrace-component-type-filepathプロパティでパスを指定してください。

(4)　設定できるパラメタ

<HCSCコンポーネント種別>

ユーザ電文トレースに出力するHCSCコンポーネントの種別を指定します。指定するHCSCコンポーネントの種別を次の表に示します。

表6‒4　HCSCコンポーネントの種別

種類

指定する種別

受付

標準受付

標準受付（Webサービス）

reception.standard.soap

標準受付（SessionBean）

reception.standard.ejb

標準受付（MDB（WS-R））

reception.standard.wsr

標準受付（MDB（DBキュー））

reception.standard.dbq

ユーザ定義受付

SOAP受付

reception.urecp.soap

TP1/RPC受付

reception.urecp.tp1

FTP受付

reception.urecp.ftp

HTTP受付

reception.urecp.http

Message Queue受付

reception.urecp.mq

ファイルイベント受付

reception.urecp.fileevent

Kafka受付

reception.urecp.kafka

スケジュール駆動受付

reception.urecp.scheduletriggered

gRPC受付

reception.urecp.grpc

カスタム受付

reception.urecp.rcpfw

サービスアダプタ

SOAPアダプタ

adapter.soap

SessionBeanアダプタ

adapter.ejb

MDB（WS-R）アダプタ

adapter.wsr

MDB（DBキュー）アダプタ

adapter.dbq

DBアダプタ

adapter.db

TP1アダプタ

adapter.tp1

ファイルアダプタ

adapter.ff

Object Accessアダプタ

adapter.oa

Message Queueアダプタ

adapter.mq

FTPアダプタ

adapter.ftp

ファイル操作アダプタ

adapter.fop

メールアダプタ

adapter.mail

HTTPアダプタ

adapter.http

コマンドアダプタ

adapter.cmd

SFTPアダプタ

adapter.sftp

Kafkaアダプタ

adapter.kafka

gRPCアダプタ

adapter.grpc

汎用カスタムアダプタ

adapter.custom

(5)　記述例

ユーザ電文トレースに，FTP受付とFTPアダプタの情報だけを出力する場合の記述例を次に示します。

reception.urecp.ftp
adapter.ftp

6.5.10　サービス情報変更定義ファイル

(1)　形式

各サービスに対応する情報が，キーの昇順でソートされて出力されます。

(a)　SOAPアダプタ（SOAP1.1モード）用のサービス情報

<クラスタ名>.<サービスID>.WebService.url=サービス部品の呼び出しに使用するURL
<クラスタ名>.<サービスID>.WebService.c4web.application.socket_read_timeout=読み込みタイムアウト値
<クラスタ名>.<サービスID>.WebService.c4web.application.socket_connect_timeout=接続タイムアウト値
<クラスタ名>.<サービスID>.WebService.c4web.application.socket_write_timeout=書き込みタイムアウト値
<クラスタ名>.<サービスID>.WebService.c4web.application.proxy_host=プロキシサーバのホスト名
<クラスタ名>.<サービスID>.WebService.c4web.application.non_proxy_hosts=プロキシサーバを使用しないホスト名
<クラスタ名>.<サービスID>.WebService.c4web.application.proxy_port=プロキシサーバのポート番号
<クラスタ名>.<サービスID>.WebService.c4web.application.proxy_user=プロキシサーバのユーザ
<クラスタ名>.<サービスID>.WebService.c4web.application.proxy_password=プロキシサーバのパスワード
<クラスタ名>.<サービスID>.WebService.c4web.common.prf_trace_level=性能解析トレース出力オプション
<クラスタ名>.<サービスID>.WebService.c4web.common.receive_max_soap_envelope_size=受信SOAPEnvelopeの最大バイト数
<クラスタ名>.<サービスID>.WebService.c4web.common.send_max_soap_envelope_size=送信SOAPEnvelopeの最大バイト数
<クラスタ名>.<サービスID>.WebService.basic_authentication_use={true｜false}
<クラスタ名>.<サービスID>.WebService.basic_authentication_id=ベーシック認証のユーザ
<クラスタ名>.<サービスID>.WebService.basic_authentication_pass=ベーシック認証のパスワード
<クラスタ名>.<サービスID>.WebService.c4web.application.app_maintainsession={true｜false}

(b)　SOAPアダプタ（SOAP1.1/1.2併用モード）用のサービス情報

<クラスタ名>.<サービスID>.WebService.url=サービス部品の呼び出しに使用するURL
<クラスタ名>.<サービスID>.WebService.com.cosminexus.csc.request.timeout=読み込みタイムアウト値
<クラスタ名>.<サービスID>.WebService.com.cosminexus.csc.connect.timeout=接続タイムアウト値
<クラスタ名>.<サービスID>.WebService.com.cosminexus.csc.session.maintain={true | false}
<クラスタ名>.<サービスID>.WebService.com.cosminexus.csc.auto-delete-incomplete-file={true | false}
<クラスタ名>.<サービスID>.WebService.com.cosminexus.csc.file.read-lock.retry.count=ロックリトライ回数
<クラスタ名>.<サービスID>.WebService.com.cosminexus.csc.file.read-lock.retry.interval=ロックリトライ間隔
<クラスタ名>.<サービスID>.WebService.basic_authentication_use={true｜false}
<クラスタ名>.<サービスID>.WebService.basic_authentication_id=ベーシック認証のユーザ
<クラスタ名>.<サービスID>.WebService.basic_authentication_pass=ベーシック認証のパスワード

(c)　SessionBeanアダプタのサービス情報

<クラスタ名>.<サービスID>.SessionBean.url=サービス部品の呼び出しに使用するURL
<クラスタ名>.<サービスID>.SessionBean.lookup_name=ルックアップ名
<クラスタ名>.<サービスID>.SessionBean.c4web.application.ejb_timeout=呼び出しタイムアウト値
<クラスタ名>.<サービスID>.SessionBean.c4web.common.prf_trace_level=性能解析トレース出力オプション

(d)　MDB（WS-R）アダプタのサービス情報

<クラスタ名>.<サービスID>.MDB_WSR.queue_name=サービスアダプタがメッセージを送信するキュー名
<クラスタ名>.<サービスID>.MDB_WSR.local_call={true｜false}
<クラスタ名>.<サービスID>.MDB_WSR.url=転送先のキュー間転送用WebアプリケーションのURL
<クラスタ名>.<サービスID>.MDB_WSR.max_message_num=転送キューが保持できるメッセージの最大数
<クラスタ名>.<サービスID>.MDB_WSR.qos_in_order={true｜false}
<クラスタ名>.<サービスID>.MDB_WSR.rdarea_name=転送キュー作成先RDエリア名

(e)　MDB（DBキュー）アダプタのサービス情報

<クラスタ名>.<サービスID>.MDB_DBQ.queue_name=サービス部品に関連づけられているキュー名

(2)　機能

サービスアダプタのサービス情報の変更を設定します。

(3)　ファイルの格納先

cscsvcctlコマンドの-getfileオプションに指定したパスに格納されます。

(4)　設定できるパラメタ

(a)　SOAPアダプタ（SOAP1.1モード）用のサービス情報

<クラスタ名>.<サービスID>.WebService.url=サービス部品の呼び出しに使用するURL

サービス部品の呼び出しに使用するURLを指定します。

<クラスタ名>.<サービスID>.WebService.c4web.application.socket_read_timeout=読み込みタイムアウト値

サービスアダプタのソケットの読み込みタイムアウト値（単位：秒）を指定します。指定する値については，マニュアル「アプリケーションサーバ SOAPアプリケーション開発の手引」の「10.3　クライアント定義ファイルの設定」の「c4web.application.socket_read_timeout」の説明を参照してください。

<クラスタ名>.<サービスID>.WebService.c4web.application.socket_connect_timeout=接続タイムアウト値

サービスアダプタのソケットの接続タイムアウト値（単位：秒）を指定します。指定する値については，マニュアル「アプリケーションサーバ SOAPアプリケーション開発の手引」の「10.3　クライアント定義ファイルの設定」の「c4web.application.socket_connect_timeout」の説明を参照してください。

<クラスタ名>.<サービスID>.WebService.c4web.application.socket_write_timeout=書き込みタイムアウト値

サービスアダプタのソケットの書き込みタイムアウト値（単位：秒）を指定します。指定する値については，マニュアル「アプリケーションサーバ SOAPアプリケーション開発の手引」の「10.3　クライアント定義ファイルの設定」の「c4web.application.socket_write_timeout」の説明を参照してください。

<クラスタ名>.<サービスID>.WebService.c4web.application.proxy_host=プロキシサーバのホスト名

プロキシサーバのホスト名またはIPアドレスを指定します。指定する値については，マニュアル「アプリケーションサーバ SOAPアプリケーション開発の手引」の「10.3　クライアント定義ファイルの設定」の「c4web.application.proxy_host」の説明を参照してください。

<クラスタ名>.<サービスID>.WebService.c4web.application.non_proxy_hosts=プロキシサーバを使用しないホスト名

プロキシサーバを使用しない場合のホスト名またはIPアドレス群を指定します。指定する値については，マニュアル「アプリケーションサーバ SOAPアプリケーション開発の手引」の「10.3　クライアント定義ファイルの設定」の「c4web.application.non_proxy_hosts」の説明を参照してください。

<クラスタ名>.<サービスID>.WebService.c4web.application.proxy_port=プロキシサーバのポート番号

プロキシサーバのポート番号を指定します。指定する値については，マニュアル「アプリケーションサーバ SOAPアプリケーション開発の手引」の「10.3　クライアント定義ファイルの設定」の「c4web.application.proxy_port」の説明を参照してください。

<クラスタ名>.<サービスID>.WebService.c4web.application.proxy_user=プロキシサーバのユーザ

プロキシサーバの認証ユーザIDを指定します。指定する値については，マニュアル「アプリケーションサーバ SOAPアプリケーション開発の手引」の「10.3　クライアント定義ファイルの設定」の「c4web.application.proxy_user」の説明を参照してください。

<クラスタ名>.<サービスID>.WebService.c4web.application.proxy_password=プロキシサーバのパスワード

プロキシサーバの認証ユーザIDに対応するパスワードを指定します。指定する値については，マニュアル「アプリケーションサーバ SOAPアプリケーション開発の手引」の「10.3　クライアント定義ファイルの設定」の「c4web.application.proxy_password」の説明を参照してください。

<クラスタ名>.<サービスID>.WebService.c4web.common.prf_trace_level=性能解析トレース出力オプション

性能解析トレースの出力オプションを指定します。指定する値については，マニュアル「アプリケーションサーバ SOAPアプリケーション開発の手引」の「10.3　クライアント定義ファイルの設定」の「c4web.common.prf_trace_level」の説明を参照してください。

<クラスタ名>.<サービスID>.WebService.c4web.common.receive_max_soap_envelope_size=受信SOAPEnvelopeの最大バイト数

受信できるSOAPエンベロープの最大バイト数を指定します。指定する値については，マニュアル「アプリケーションサーバ SOAPアプリケーション開発の手引」の「10.3　クライアント定義ファイルの設定」の「c4web.common.receive_max_soap_envelope_size」の説明を参照してください。

<クラスタ名>.<サービスID>.WebService.c4web.common.send_max_soap_envelope_size=送信SOAPEnvelopeの最大バイト数

送信できるSOAPエンベロープの最大バイト数を指定します。指定する値については，マニュアル「アプリケーションサーバ SOAPアプリケーション開発の手引」の「10.3　クライアント定義ファイルの設定」の「c4web.common.send_max_soap_envelope_size」の説明を参照してください。

<クラスタ名>.<サービスID>.WebService.basic_authentication_use={true｜false}

サービスアダプタがベーシック認証を使用するかどうかを指定します。ベーシック認証を設定する場合は，ベーシック認証を使用する，使用しないにかかわらず必ず指定します。

true

使用します。

false

使用しません。

<クラスタ名>.<サービスID>.WebService.basic_authentication_id=ベーシック認証のユーザ　〜＜半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」※），および半角スペース（ASCIIコードの「0x20」）＞((1文字以上))

ベーシック認証のユーザIDを指定します。ベーシック認証を設定する場合は，ベーシック認証を使用する，使用しないにかかわらず必ず指定します。

値の先頭に半角スペース（ASCIIコードの「0x20」）を指定する場合は，半角スペースの前に「¥」と指定してください。また，値に「¥」を指定する場合は，「¥¥」と指定してください。

注※

#（ハッシュマーク），:（コロン），?（クエスチョン），@（アットマーク），/（スラッシュ）は使用できません。

<クラスタ名>.<サービスID>.WebService.basic_authentication_pass=ベーシック認証のパスワード　〜＜半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」※），および半角スペース（ASCIIコードの「0x20」）＞((1−40文字))

ベーシック認証のパスワードを指定します。ベーシック認証を設定する場合は，ベーシック認証を使用する，使用しないにかかわらず必ず指定します。

値の先頭に半角スペース（ASCIIコードの「0x20」）を指定する場合は，半角スペースの前に「¥」と指定してください。また，値に「¥」を指定する場合は，「¥¥」と指定してください。

注※

#（ハッシュマーク），:（コロン），?（クエスチョン），@（アットマーク），/（スラッシュ）は使用できません。

<クラスタ名>.<サービスID>.WebService.c4web.application.app_maintainsession={true｜false}

HTTPセッションの維持の有無を指定します。指定する値については，マニュアル「アプリケーションサーバ SOAPアプリケーション開発の手引」の「10.3　クライアント定義ファイルの設定」の「c4web.application.app_maintainsession」の説明を参照してください。

(b)　SOAPアダプタ（SOAP1.1/1.2併用モード）用のサービス情報

<クラスタ名>.<サービスID>.WebService.url=サービス部品の呼び出しに使用するURL

サービス部品の呼び出しに使用するURLを指定します。

<クラスタ名>.<サービスID>.WebService.com.cosminexus.csc.request.timeout=読み込みタイムアウト値

サービスアダプタのソケットの読み込みタイムアウト値（単位：秒）を指定します。指定する値については，「3.6.2　クライアント定義ファイル」の設定項目の「com.cosminexus.csc.request.timeout」の説明を参照してください。

<クラスタ名>.<サービスID>.WebService.com.cosminexus.csc.connect.timeout=接続タイムアウト値

サービスアダプタのソケットの接続タイムアウト値（単位：秒）を指定します。指定する値については，「3.6.2　クライアント定義ファイル」の設定項目の「com.cosminexus.csc.connect.timeout」の説明を参照してください。

<クラスタ名>.<サービスID>.WebService.com.cosminexus.csc.session.maintain={true | false}

HTTPセッションの維持の有無を指定します。指定する値については，「3.6.2　クライアント定義ファイル」の設定項目の「com.cosminexus.csc.session.maintain」の説明を参照してください。

<クラスタ名>.<サービスID>.WebService.com.cosminexus.csc.auto-delete-incomplete-file={true | false}

SOAPアダプタがサービス部品から添付ファイルを受信し，作業フォルダまたは共通フォルダにファイルを出力する際にエラーが発生すると不完全なファイルが生成されます。この不完全なファイルを自動的に削除するかどうかを指定します。指定する値については，「3.6.2　クライアント定義ファイル」の設定項目の「com.cosminexus.csc.auto-delete-incomplete-file」の説明を参照してください。

<クラスタ名>.<サービスID>.WebService.com.cosminexus.csc.file.read-lock.retry.count=ロックリトライ回数

共通フォルダ内のファイルの共有ロック取得失敗時のロックリトライ回数を指定します。指定する値については，「3.6.2　クライアント定義ファイル」の設定項目の「com.cosminexus.csc.file.read-lock.retry.count」の説明を参照してください。

<クラスタ名>.<サービスID>.WebService.com.cosminexus.csc.file.read-lock.retry.interval=ロックリトライ間隔

共通フォルダ内のファイルの共有ロック失敗時のロックリトライ間隔を秒単位で指定します。指定する値については，「3.6.2　クライアント定義ファイル」の設定項目の「com.cosminexus.csc.file.read-lock.retry.interval」の説明を参照してください。

<クラスタ名>.<サービスID>.WebService.basic_authentication_use={true｜false}

サービスアダプタ定義でのベーシック認証の使用可否チェックを指定します。

true

使用します。

false

使用しません。

<クラスタ名>.<サービスID>.WebService.basic_authentication_id=ベーシック認証のユーザ　〜＜半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」※），および半角スペース（ASCIIコードの「0x20」）＞((1文字以上))

サービスアダプタ定義でのベーシック認証のユーザ名を指定します。

注※

:（コロン），/（スラッシュ）は使用できません。

<クラスタ名>.<サービスID>.WebService.basic_authentication_pass=ベーシック認証のパスワード　〜＜半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」※），および半角スペース（ASCIIコードの「0x20」）＞((1−40文字))

サービスアダプタ定義でのベーシック認証のパスワードを指定します。

注※

:（コロン），/（スラッシュ）は使用できません。

(c)　SessionBeanアダプタのサービス情報

<クラスタ名>.<サービスID>.SessionBean.url=サービス部品の呼び出しに使用するURL

サービス部品の呼び出しに使用するURLを指定します。

<クラスタ名>.<サービスID>.SessionBean.lookup_name=ルックアップ名

サービス部品の呼び出しに使用するルックアップ名を指定します。

<クラスタ名>.<サービスID>.SessionBean.c4web.application.ejb_timeout=呼び出しタイムアウト値

サービス部品の呼び出しタイムアウト値（単位：秒）を指定します。0〜86400の値を指定します。0を指定した場合はタイムアウトしません。

<クラスタ名>.<サービスID>.SessionBean.c4web.common.prf_trace_level=性能解析トレース出力オプション

性能解析トレースの出力オプションを指定します。指定する値については，マニュアル「アプリケーションサーバ SOAPアプリケーション開発の手引」の「10.3　クライアント定義ファイルの設定」の「c4web.common.prf_trace_level」の説明を参照してください。

(d)　MDB（WS-R）アダプタのサービス情報

<クラスタ名>.<サービスID>.MDB_WSR.queue_name=サービスアダプタがメッセージを送信するキュー名

サービスアダプタがメッセージを送信するキュー名を指定します。

<クラスタ名>.<サービスID>.MDB_WSR.local_call={true｜false}

サービスアダプタがローカルホスト，またはリモートホストのどちらのサービス部品に接続するかを指定します。

true

ローカルホストのサービス部品に接続します。

false

リモートホストのサービス部品に接続します。

サービス情報変更定義ファイルで設定するパラメタに，すべて正しい値を指定している場合だけ，local_callの値をtrueからfalseへ変更できます。なお，local_callの値は，falseからtrueへ変更しないでください。

<クラスタ名>.<サービスID>.MDB_WSR.url=転送先のキュー間転送用WebアプリケーションのURL

サービスアダプタが使用する転送キューのメッセージ転送先を指定します。メッセージ転送先には，転送先のキュー間転送用WebアプリケーションのURLを指定します。local_callパラメタがfalseの場合だけ有効になります。

<クラスタ名>.<サービスID>.MDB_WSR.max_message_num=転送キューが保持できるメッセージの最大数　〜＜数字＞((1−65535))

サービスアダプタが使用する転送キューが保持できるメッセージの最大数を指定します。local_callパラメタがfalseの場合だけ有効になります。

クラスタ名>.<サービスID>.MDB_WSR.qos_in_order={true｜false}

サービスアダプタが使用する転送キューがメッセージを正しい順序で転送することを保証するかどうかを指定します。local_callパラメタがfalseの場合だけ有効になります。

true

保証します。

false

保証しません。

<クラスタ名>.<サービスID>.MDB_WSR.rdarea_name=転送キュー作成先RDエリア名　〜＜半角英数字，アンダーバー（_）および半角スペース（ ）＞((30バイト以内))

サービスアダプタが使用する転送キューの作成先のRDエリア名を指定します。local_callパラメタがfalseの場合だけ有効になります。なお，ALLは指定しないでください。

(e)　MDB（DBキュー）アダプタのサービス情報

<クラスタ名>.<サービスID>.MDB_DBQ.queue_name=サービス部品に関連づけられているキュー名

サービス部品に関連づけられているキュー名を指定します。

(5)　使用方法

cscsvcctlコマンドの-getfileオプションにファイル名を指定してサービス情報変更定義ファイルを取得します。取得したファイルに変更内容を定義し，cscsvcctlコマンドの-setfileオプションにファイル名を指定して設定します。

運用環境で変更していないサービス情報は，パラメタの先頭にコメントを表す「#」が付けられています。サービス情報を変更する場合，該当するパラメタに付けられている「#」を削除してください。

運用環境での変更を無効にする場合（開発環境の設定値を有効にする場合）は，パラメタの先頭にコメントを表す「#」を付けてください。

(6)　注意事項

値の先頭に半角スペース（ASCIIコードの「0x20」）を指定する場合は，半角スペースの前に「¥」と指定してください。また，値に「¥」を指定する場合は，「¥¥」と指定してください。

値を設定または変更する場合は，Javaのプロパティファイル形式として編集してください。

cscsvcctlコマンドの-getfileオプションで取得したサービス情報に次に示す文字が含まれていた場合は，「¥」を付加した形で出力されます。

半角感嘆符（!）

半角番号記号（#）

半角コロン（:）

半角等号（=）

6.6　SOAP連携で利用するファイル

6.6.1　SOAP Fault動作定義ファイル

(1)　形式

［targetNamespaceのURI］
［targetNamespaceのURI］
    :

(2)　機能

targetNamespaceのURIを設定します。targetNamespaceのURIは，サービスアダプタがWebサービスからSOAP Faultを受け取った場合に，Faultとして扱うかどうかの判別をするために使用されます。設定された内容はHCSCサーバの起動後に有効となります。

(3)　指定方法

targetNamespaceのURIを改行で区切って指定します。サービスアダプタの作成に使用するWDSLのtargetNamespaceの記述をそのまま指定してください。

targetNamespaceに使用できる文字は，ISO-8859-1文字エンコーディングでの次に示す文字です。

英数字

感嘆符（!）

ダブルクォーテーション（"）

番号記号（#）

ドル記号（$）

パーセント（%）

アンパサンド（&）

アポストロフィ（'）

始め小括弧（(）

終わり小括弧（)）

正符号（+）

コンマ（,）

ハイフン（-）

ピリオド（.）

スラッシュ（/）

コロン（:）

セミコロン（;）

左アングルブラケット（<）

右アングルブラケット（>）

等号（=）

クエスチョンマーク（?）

単価記号（@）

始め角括弧（[）

終わり角括弧（]）

円マーク（¥）

アクサンシルコンフレックス（^）

アンダーバー（_）

アクサングラーブ（`）

始め波括弧（{）

終わり波括弧（}）

パイプライン（|）

波ダッシュ（~）

行頭に「#」を記述した場合はコメントと扱われます。

空行は無視されます。また，行頭および行末の半角スペースとタブも無視されます。

WSDLに宣言されているtargetNamespace属性値が空文字（値がない）の場合やtargetNamespace属性が定義されていない場合は，「""」（ダブルクォーテーション2つ）を記述してください。

(4)　不正な定義がある場合の動作

「指定方法」に示すルールに合わない定義がある場合（ただし，ISO-8859-1文字エンコーディングの条件に合っていない場合は除く）は，HCSCサーバの起動に失敗します。

次の場合，サービス部品からSOAP Faultが返ってきたときに，正常に動作しないことがあるため注意してください。

誤ったtargetNamespaceを指定した場合※

WSDLのtargetNamespaceとして使用できない文字を指定した場合

指定した文字エンコーディング以外を使用した場合

注※

サービスアダプタの作成に使用するWDSLのtargetNamespaceの記述をそのまま記述してください。「http://www.xxx.com/」と，「http://w%77w.xxx.com/」はURIとしては同義ですが，別のURIとして認識されます。

(5)　記述例

http://dictionary.com
urn:sample.co.jp:xmlns:wsdl:2007-06

6.6.2　ユーザ定義受付ランタイム定義ファイル

(1)　形式

user-defined-reception-soap.threads.maximum=最大同時実行数
user-defined-reception-soap.exclusive.threads=占有スレッド数
user-defined-reception-soap.queue-size=実行待ちキューサイズ

(2)　機能

SOAP受付の情報を設定します。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥manager¥templates¥cscurcptnconfig.properties

(4)　設定できるパラメタ

user-defined-reception-soap.threads.maximum=最大同時実行数　〜＜数字＞((1−1024))<<10>>

SOAP受付の最大同時実行数を指定します。占有スレッド数以上の値を指定する必要があります。

user-defined-reception-soap.exclusive.threads=占有スレッド数　〜＜数字＞((0−1024))<<0>>

SOAP受付の占有スレッド数を指定します。最大実行数を超えない範囲で値を指定する必要があります。0を指定した場合，スレッドは占有されません。

なお，この指定値はWARの属性thread-control-exclusive-threadsに設定されます。このため，Webコンテナ全体の最大同時実行スレッド数や最大接続数などの値を考慮して指定する必要があります。

user-defined-reception-soap.queue-size=実行待ちキューサイズ　〜＜数字＞((0−2147483647))<<8192>>

SOAP受付の実行待ちキューのサイズを指定します。

(5)　使用方法

ユーザ定義受付ランタイム定義ファイルは，csccompoconfigコマンドの-propfileオプションの引数に指定します。詳細については，マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「3.1.15　ユーザ定義受付の定義情報を設定する」を参照してください。

6.7　TP1連携で利用するファイル

6.7.1　TP1アダプタ実行環境プロパティファイル

(1)　形式

tp1client.config=TP1/Client/J環境定義ファイルのパス
［buffer.keep={true｜false}］
［message.level={0｜10｜20}］
［trace.level={0｜10｜20}］
［trace.filesize=トレースログの出力サイズ］
［trace.filenum=トレースログの出力面数］

(2)　機能

(a)　ファイルの種類

TP1アダプタ実行環境プロパティファイルは，TP1アダプタが実行環境で動作する場合のTP1/Client/J環境定義ファイルのパスなどを定義します。

また，1つのマシンに複数のHCSCサーバをセットアップした場合，TP1アダプタ実行環境プロパティファイルをHCSCサーバごとに定義することもできます。プロパティファイル間で同じプロパティが指定された場合，プロパティの優先度は次のようになります。

ファイルの種類

プロパティ重複時の優先度

TP1アダプタ実行環境プロパティファイル

（HCSCサーバ単位の指定：あり）

高

TP1アダプタ実行環境プロパティファイル

（HCSCサーバ単位の指定：なし）

低

なお，重複しないプロパティの指定はマージされます。

(b)　作成手順

サンプルファイルを利用して作成します。サンプルファイルの格納先を次に示します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥TP1¥config¥templates¥adptp1.properties

TP1アダプタ実行環境プロパティファイルの作成手順を次に示します。

サンプルファイルをコピーして，次のディレクトリに格納します。

全HCSCサーバ共通の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥TP1¥config

特定のHCSCサーバ用の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥TP1¥config¥<HCSCサーバ名>

サブディレクトリ<HCSCサーバ名>を作成する際は，Windowsでは大文字・小文字は区別されないので，注意してください。

サブディレクトリ<HCSCサーバ名>には，HCSCサーバの管理者（Service Coordinator管理者）がアクセスできるよう，適切なアクセス権限を設定してください。

ファイル名を<サービスID>.propertiesに変更します。

定義内容を編集して保存します。

TP1アダプタ実行環境プロパティファイルは，TP1アダプタの開始時に実行環境に反映されます。そのため，TP1アダプタ実行環境プロパティファイルの内容を変更する場合は，TP1アダプタを停止してから実施してください。TP1アダプタを再開始すると，変更内容が実行環境に反映されます。

(3)　設定できるプロパティ

tp1client.config=TP1/Client/J環境定義ファイルのパス　〜<文字列>

TP1/Client/J環境定義ファイルのパスを記述します。パスのディレクトリ区切りは「¥」ではなく，「¥¥」を使用してください。

TP1/Client/J環境定義ファイルの定義方法については，マニュアル「サービスプラットフォーム 解説」の「付録A.2　TP1/Client/Jの定義」を参照してください。

buffer.keep={true｜false}　〜<<true>>

送受信バッファ生成のオプションを指定します。

true

TP1アダプタ起動時に送受信バッファを生成・保持します。

false

RPC通信時に送受信バッファを生成・解放します。

上記以外を指定した場合，警告メッセージ（KDEE12021-W）が出力されtrue指定時の動作となります。また，buffer.keepプロパティ自体を記述していない場合は，警告メッセージは出力されないでtrue指定時の動作となります。

message.level={0｜10｜20}　〜<<10>>

メッセージログの出力レベルを指定します。

0：メッセージ種別「E（Error）」のメッセージを出力します。

10：メッセージ種別「E（Error）」，「W（Warning）」のメッセージを出力します。

20：全メッセージを出力します。

trace.level={0｜10｜20}　〜<<10>>

トレースログの出力レベルを指定します。

0：メソッドトレース情報を取得しません。

10：メソッドトレース情報を取得します。

20：メソッドトレース情報・データトレース情報を取得します。

trace.filesize=トレースログの出力サイズ　〜＜符号なし整数＞((4096−2147483647))<<2097152>>

TP1アダプタが取得するトレース情報の出力ファイルサイズを指定します（単位：バイト）。

trace.filenum=トレースログの出力面数　〜＜符号なし整数＞((1−16))<<8>>

TP1アダプタが取得するトレース情報の出力ファイル面数を指定します。

(4)　注意事項

パスを指定する場合の注意事項を次に示します。

相対パス，親ディレクトリ表現（「..¥」，「../」），およびカレントディレクトリ表現（「.¥」，「./」）を含むパスは指定しないでください。

シンボリックリンクを含むパスは指定しないでください。

Windowsの場合，UNC形式，NTFSのストリーム名，および予約デバイス名を含むパスは指定しないでください。また，パスの大文字と小文字は区別されません。

6.8　FTP連携で利用するファイル

6.8.1　FTPアダプタアカウント定義ファイル

(1)　機能

FTPアダプタで接続するFTPサーバのユーザ認証情報を一括管理します。

ファイルの内容は次に示す運用コマンドで管理します。ファイルを直接編集することはできません。

csaftpuseraddコマンド（FTPアダプタのユーザの登録・更新）

csaftpuserdelコマンド（FTPアダプタのユーザの削除）

csaftpuserlsコマンド（FTPアダプタのユーザの表示）

(2)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥FTP¥config¥templates¥account.properties

FTPアダプタアカウント定義ファイルは，csaftpuseraddコマンドで指定したパスとファイル名で作成されます。

作成したFTPアダプタアカウント定義ファイルを有効にするには，ファイルの絶対パスをFTPアダプタ実行環境プロパティファイルのftpadp.account-inf-filepathプロパティに指定する必要があります。プロパティを省略した場合，次に示すディレクトリに格納されているFTPアダプタアカウント定義ファイルが利用されます。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥common¥account.properties

また，csaftpuseraddコマンドを-nameオプション指定で実行すると，上記パスにFTPアダプタアカウント定義ファイルが自動生成されます。上記パスにFTPアダプタアカウント定義ファイルが格納されていない場合，FTPアダプタの起動時にエラーになります。

6.8.2　FTPアダプタコマンド定義ファイル

(1)　形式

［ftpadp.command.messagelog.filepath=FTPアダプタコマンドのメッセージログファイルの出力先ディレクトリの絶対パス］
［ftpadp.command.messagelog.filenum=FTPアダプタコマンドのメッセージログファイルの面数］
［ftpadp.command.messagelog.filesize=FTPアダプタコマンドのメッセージログファイルの1面当たりの最大サイズ］

(2)　機能

FTPアダプタコマンドのメッセージログの構成情報を定義するファイルです。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥FTP¥config¥adpftpcommand.properties

(4)　設定できるパラメタ

ftpadp.command.messagelog.filepath=FTPアダプタコマンドのメッセージログファイルの出力先ディレクトリの絶対パス　〜＜文字列（2バイト文字含む）および空白＞<<<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥FTP¥log>>

FTPアダプタ関連コマンドのメッセージログファイルの出力先ディレクトリを絶対パスで指定します。存在しないディレクトリを指定した場合は，省略値が使用されます。

なお，メッセージログは「message<面数>.log」という名で作成されます。

ftpadp.command.messagelog.filenum=FTPアダプタコマンドのメッセージログファイルの面数　〜＜数字＞((1−64))<<2>>

FTPアダプタ関連コマンドのメッセージログファイルの面数を指定します。

ftpadp.command.messagelog.filesize=FTPアダプタコマンドのメッセージログファイルの1面当たりの最大サイズ　〜＜数字＞((4096−16777216))<<1048576>>

FTPアダプタ関連コマンドのメッセージログファイルの1面当たりの最大サイズをバイト単位で指定します。

(5)　注意事項

パスを指定する場合の注意事項を次に示します。

相対パス，親ディレクトリ表現（「..¥」，「../」），およびカレントディレクトリ表現（「.¥」，「./」）を含むパスは指定しないでください。

シンボリックリンクを含むパスは指定しないでください。

Windowsの場合，UNC形式，NTFSのストリーム名，および予約デバイス名を含むパスは指定しないでください。また，パスの大文字と小文字は区別されません。

6.8.3　FTPアダプタ実行環境プロパティファイル

(1)　形式

［ftpadp.host-ipaddr=接続するFTPサーバのIPアドレスまたはホスト名］
［ftpadp.host-con-port=接続するFTPサーバの制御コネクション用のポート番号］
［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=HCSCサーバのIPアドレス］
［ftpadp.client-con-port.min=FTPアダプタの制御コネクションポート番号の範囲の最小値］
［ftpadp.client-con-port.max=FTPアダプタの制御コネクションポート番号の範囲の最大値］
［ftpadp.client-pasv-port.min=データコネクションがPASVモードの場合のFTPアダプタがデータコネクション確立するポート番号の範囲の最小値］
［ftpadp.client-pasv-port.max=データコネクションがPASVモードの場合のFTPアダプタがデータコネクション確立するポート番号の範囲の最大値］
［ftpadp.listen-port.min=データコネクションがPORTモードの場合のFTPアダプタがデータコネクションを待ち受けるポート番号の範囲の最小値］
［ftpadp.listen-port.max=データコネクションがPORTモードの場合のFTPアダプタがデータコネクションを待ち受けるポート番号の範囲の最大値］

［ftpadp.ftp-user=接続するFTPサーバのログインユーザ名］
［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=保守用ログの出力先ディレクトリの絶対パス］
［ftpadp.methodtrace.filenum=保守用ログの面数］
［ftpadp.methodtrace.filesize=保守用ログの1面当たりの最大サイズ］

［ftpadp.ftpprotocoltrace.filenum=プロトコルトレースファイルの面数］
［ftpadp.ftpprotocoltrace.filesize=プロトコルトレースファイルの1面当たりの最大サイズ］

［ftpadp.messagelog.level={0｜10｜20}］

［ftpadp.account-inf-filepath=FTPアダプタアカウント定義ファイルの絶対パス］
［ftpadp.cscthrough-filepath=FTPコマンド許可リスト定義ファイルの絶対パス］

［ftpadp.control-con.retry.count=制御コネクションを確立できなかったときのリトライ回数］
［ftpadp.control-con.retry.interval=制御コネクションを確立できなかったときのリトライ間隔］
［ftpadp.control-con.connect.timeout=制御コネクションの接続タイムアウト時間］

［ftpadp.data-con.retry.count=PASVモードでデータコネクションを確立できなかったときのリトライ回数］
［ftpadp.data-con.retry.interval=PASVモードでデータコネクションを確立できなかったときのリトライ間隔］
［ftpadp.data-con.connect.timeout=データコネクションの接続タイムアウト時間］

［ftpadp.read-lock.retry.count=共通フォルダのファイルの共有ロック失敗時のリトライ回数］
［ftpadp.read-lock.retry.interval=共通フォルダのファイルの共有ロック失敗時のリトライ間隔］
［ftpadp.write-lock.retry.count=共通フォルダのファイルの占有ロック失敗時のリトライ回数］
［ftpadp.write-lock.retry.interval=共通フォルダのファイルの占有ロック失敗時のリトライ間隔］

［ftpadp.data-con-put.timeout=データ転送時タイムアウト時間］
［ftpadp.data-con-get.timeout=データ取得時タイムアウト時間］

［ftpadp.ftp-command-reply.timeout=リプライタイムアウト時間］

［ftpadp.listen.timeout=Listenタイムアウト時間］

［ftpadp.data-con.read.timeout=パッシブモードでのデータコネクションの受信バッファからの読み込みタイムアウト時間］

［ftpadp.put-client-buffer.size=ファイル転送（送信）するときのクライアントバッファサイズ］
［ftpadp.get-client-buffer.size=ファイル転送（受信）するときのクライアントバッファサイズ］
［ftpadp.exptrace.filenum=例外ログの面数］
［ftpadp.exptrace.filesize=例外ログの1面当たりの最大サイズ］

［ftpadp.listen-port.reuse={TRUE｜FALSE}］

(2)　機能

FTPアダプタの実行環境に依存するパラメタを設定します。

(a)　ファイルの種類

FTPアダプタ実行環境プロパティファイルは，次に示す2種類があります。

FTPアダプタ実行環境プロパティファイル

有効範囲：特定のFTPアダプタ

FTPアダプタ実行環境共通プロパティファイル

有効範囲：すべてのFTPアダプタ

これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。

また，1つのマシンに複数のHCSCサーバをセットアップした場合，FTPアダプタ実行環境プロパティファイルをHCSCサーバごとに定義することもできます。これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。

プロパティファイル間で同じプロパティが指定された場合，プロパティの優先度は次のようになります。

ファイルの種類

プロパティ重複時の優先度

FTPアダプタ実行環境プロパティファイル

（HCSCサーバ単位の指定：あり）

高

FTPアダプタ実行環境共通プロパティファイル

（HCSCサーバ単位の指定：あり）

｜

FTPアダプタ実行環境プロパティファイル

（HCSCサーバ単位の指定：なし）

｜

FTPアダプタ実行環境共通プロパティファイル

（HCSCサーバ単位の指定：なし）

低

(b)　作成手順

FTPアダプタ実行環境プロパティファイル，およびFTPアダプタ実行環境共通プロパティファイルは，テンプレートファイルを基に作成します。

FTPアダプタ実行環境プロパティファイルは次の手順で作成してください。FTPアダプタ実行環境共通プロパティファイルの作成手順は，「6.8.4　FTPアダプタ実行環境共通プロパティファイル」を参照してください。

次のテンプレートファイルを基に，FTPアダプタ実行環境プロパティファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥FTP¥config¥templates¥adpftp.properties

編集後のファイルをファイル名「<サービスID>.properties」で次のディレクトリに格納します。

全HCSCサーバ共通の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥FTP¥config

特定のHCSCサーバ用の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥FTP¥config¥<HCSCサーバ名>

サブディレクトリ<HCSCサーバ名>を作成する際は，Windowsでは大文字・小文字は区別されないので，注意してください。

サブディレクトリ<HCSCサーバ名>には，HCSCサーバの管理者（Service Coordinator管理者）がアクセスできるよう，適切なアクセス権限を設定してください。

(3)　設定できるプロパティ

(a)　要求電文またはFTPアダプタ実行環境プロパティファイルでの設定が必須のプロパティ

次に示すプロパティは，要求電文またはFTPアダプタ実行環境プロパティファイルのどちらかで必ず設定しなければならないプロパティです。要求電文とFTPアダプタ実行環境プロパティファイルの両方に設定している場合，要求電文の値が有効になります。

ftpadp.host-ipaddr=接続するFTPサーバのIPアドレスまたはホスト名
ftpadp.ftp-user=接続するFTPサーバのログインユーザ名

要求電文の指定方法については，マニュアル「サービスプラットフォーム 開発ガイド 受付・アダプタ定義編」の「3.3.10　FTPアダプタを定義する」を参照してください。

●サーバ情報関連

ftpadp.host-ipaddr=接続するFTPサーバのIPアドレスまたはホスト名

接続するFTPサーバのIPアドレスまたはホスト名を指定します。

FTPアダプタの要求電文でも指定が可能です。重複して指定されている場合，要求電文の値が有効になります。

注意事項

Windowsを使用する場合，ループバックIPアドレス（127.0.0.1またはlocalhost）を指定すると，FTP接続に失敗する場合があります。実IPアドレスまたはホスト名を設定してください。

●FTP設定関連

ftpadp.ftp-user=接続するFTPサーバのログインユーザ名　〜＜文字列＞((1-80文字))

FTPアダプタアカウント定義ファイルに指定した，FTPアダプタが接続するFTPサーバのログインユーザ名を指定します。

使用できる文字は，半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」），および半角スペース（ASCIIコードの「0x20」）です。大文字と小文字は区別されます。使用できる半角記号を次に示します。

感嘆符（!）

ダブルクォーテーション（"）

番号記号（#）

ドル記号（$）

パーセント（%）

アンパサンド（&）

アポストロフィ（'）

始め小括弧（(）

終わり小括弧（)）

アスタリスク（*）

正符号（+）

コンマ（,）

ハイフン（-）

ピリオド（.）

スラッシュ（/）

コロン（:）

セミコロン（;）

左アングルブラケット（<）

右アングルブラケット（>）

等号（=）

クエスチョンマーク（?）

単価記号（@）

始め角括弧（[）

終わり角括弧（]）

円マーク（¥）

アクサンシルコンフレックス（^）

アンダーバー（_）

アクサングラーブ（`）

始め波括弧（{）

終わり波括弧（}）

パイプライン（|）

波ダッシュ（~）

指定するログインユーザ名はファイル操作の実行権限が与えられている必要があります。ここで指定した値はUSERコマンドの引数として使用されます。

また，FTPアダプタの要求電文でも指定が可能です。重複して指定されている場合，要求電文の値が有効になります。

このプロパティの指定を省略した場合は，必ずFTPアダプタの要求電文でログインユーザ名を指定してください。ログインユーザ名を指定しないと，FTPアダプタの呼び出し時にシステム例外が発生します。

(b)　要求電文およびFTPアダプタ実行環境プロパティファイルで設定できるプロパティ

次に示すプロパティは，必要に応じて要求電文またはFTPアダプタ実行環境プロパティファイルで設定するプロパティです。要求電文とFTPアダプタ実行環境プロパティファイルの両方に設定している場合，要求電文の値が有効になります。FTPアダプタ実行環境共通プロパティファイルを使用して運用時に管理する定義ファイルの数を削減したい場合で，一部リクエスト単位で異なる値を設定したいプロパティがあるときは，要求電文で設定してください。

ftpadp.host-con-port=接続するFTPサーバの制御コネクション用のポート番号
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}

●サーバ情報関連

ftpadp.host-con-port=接続するFTPサーバの制御コネクション用のポート番号　〜＜数字＞((1−65535))<<21>>

接続するFTPサーバの制御コネクション用のポート番号を指定します。

FTPアダプタの要求電文でも指定が可能です。重複して指定されている場合，要求電文の値が有効になります。

ftpadp.file-name.charset={UTF-8｜MS932}　〜<<UTF-8>>

FTPサーバとの間で次の情報を送受信する際に使用する，文字セットの名称を指定します。

制御コネクションで送受信する情報（ファイル名など）

LISTコマンドまたはNLSTコマンドの実行時に，データコネクションを介してFTPサーバから受け取る情報（ファイルの一覧情報）

FTPアダプタの要求電文でも指定できます。重複して指定されている場合，要求電文の値が有効になります。

指定できる値は次のとおりです。大文字と小文字は区別されません。

UTF-8

文字セットとしてUTF-8を使用します。

MS932

文字セットとしてMS932を使用します。

●FTP設定関連

ftpadp.ftp-type={A｜a｜I｜i}

転送するデータのタイプとして，次のどちらかを指定します。ここで指定した値はTYPEコマンドの引数として使用されます。

Aまたはa

ASCII形式で転送します。

Iまたはi

image（BINARY）形式で転送します。

FTPアダプタの要求電文でも指定が可能です。重複して指定されている場合，要求電文の値が有効になります。

指定が省略された場合は，FTPプロトコルの仕様（RFC959）に従ってASCII形式で転送されます。

ftpadp.ftp-mode={S｜s｜C｜c}　〜<<S>>

転送するデータを圧縮するかどうかを指定します。ここで指定した値はMODEコマンドの引数として使用されます。

Sまたはs

ファイルを圧縮しないで転送します。

Cまたはc

ファイルを圧縮して転送します。

FTPアダプタの要求電文でも指定が可能です。重複して指定されている場合，要求電文の値が有効になります。

ftpadp.pasvport={PASV｜pasv｜PORT｜port}　〜<<PASV>>

データコネクションの接続モードを次のどちらかに指定します。

PASVまたはpasv

PASVモードでデータコネクションを設定します。

PORTまたはport

PORTモードでデータコネクションを設定します。

●ファイルサイズチェック関連

ftpadp.file-size-check={TRUE｜FALSE}　〜<<FALSE>>

送信側と受信側で，転送されたファイルのサイズが正しいかどうかを確認する機能を，実行するかどうかを指定します。

TRUE

ファイルサイズを確認します。

FALSE

ファイルサイズを確認しません。

●FTPS関連

ftpadp.ftps.enable={TRUE｜FALSE}　〜<<FALSE>>

FTPサーバとの接続にFTPSを使用するかどうかを指定します。

FTPアダプタの要求電文でも指定できます。重複して指定されている場合，要求電文の値が有効になります。

TRUE

FTPサーバとの接続にFTPSを使用します。

TRUEを選択すると，制御コネクションおよびデータコネクションの通信は暗号化されます（データコネクションの通信の暗号化を抑止する設定となっている場合は，暗号化されません）。ただし，接続先のFTPサーバがFTPSによる接続をサポートしている必要があります。

FALSE

FTPサーバとの接続に通常のFTPを使用します。

FALSEを選択すると，制御コネクションおよびデータコネクションの通信は暗号化されません。

接続先のFTPサーバがFTPSのImplicitモードで動作している場合にFALSEを指定すると，FTPサーバに接続してからタイムアウトが発生するまで待ち状態となるときがあります。タイムアウト発生までの時間は，次の2つのタイムアウト時間のうち短い方の時間が適用されます。

ftpadp.control-con.connect.timeoutプロパティで指定した値（制御コネクションの接続タイムアウト時間）

この値でタイムアウトとなった場合，ftpadp.control-con.retry.countプロパティで指定した回数分リトライしたあと，メッセージKDEK30407-Eを出力します。

接続先FTPサーバ側で設定されたタイムアウト値

この値でタイムアウトとなった場合，メッセージKDEK30428-Eを出力します。

ftpadp.ftps.protocol-name={TLS｜SSL}　〜<<TLS>>

FTPサーバとの接続でFTPSを使用する場合に使用する，セキュリティ通信用のプロトコルを指定します。この指定は，FTPサーバとの接続にFTPSを使用する場合だけ有効となります。

FTPアダプタの要求電文でも指定できます。重複して指定されている場合，要求電文の値が有効になります。

TLS

セキュリティ通信用のプロトコルにTLSを使用します。

SSL

セキュリティ通信用のプロトコルにSSLを使用します。

ftpadp.ftps.implicit-mode={TRUE｜FALSE}　〜<<FALSE>>

FTPサーバとの接続にFTPSを使用する場合に，FTPSのImplicitモードを使用するかどうかを指定します。この指定は，FTPサーバとの接続にFTPSを使用する場合だけ有効となります。

FTPアダプタの要求電文でも指定できます。重複して指定されている場合，要求電文の値が有効になります。

TRUE

Implicitモード（FTPサーバに接続した直後から暗黙的に暗号化された通信が開始されるモード）を使用します。FTPサーバに接続した直後から暗黙的に暗号化された通信が開始されるモードを使用します。

FALSE

Explicitモード（FTPサーバに接続したあとにFTPクライアント側からAUTHコマンドを実行して，明示的に暗号化された通信を開始するモード）を使用します。FTPサーバに接続したあとにFTPクライアント側からAUTHコマンドを実行して，明示的に暗号化された通信を開始するモードを使用します。

接続先のFTPサーバがFTPSのImplicitモードで動作している場合にFALSEを指定すると，FTPサーバに接続してからタイムアウトが発生するまで待ち状態となるときがあります。タイムアウト発生までの時間は，次の2つのタイムアウト時間のうち短い方の時間が適用されます。

ftpadp.control-con.connect.timeoutプロパティで指定した値（制御コネクションの接続タイムアウト時間）

この値でタイムアウトとなった場合，ftpadp.control-con.retry.countプロパティで指定した回数分リトライしたあと，メッセージKDEK30407-Eを出力します。

接続先FTPサーバ側で設定されたタイムアウト値

この値でタイムアウトとなった場合，メッセージKDEK30428-Eを出力します。

ftpadp.ftps.data-con-secure={TRUE｜FALSE}　〜<<TRUE>>

FTPサーバとの接続にFTPSを使用する場合に，データコネクションの通信を暗号化するかどうかを指定します。この指定は，FTPサーバとの接続にFTPSを使用するときだけ有効となります。

FTPアダプタの要求電文でも指定できます。重複して指定されている場合，要求電文の値が有効になります。

TRUE

データコネクションの通信を暗号化します。

FALSE

データコネクションの通信は暗号化しません。

ftpadp.ftps.server-authentication={TRUE｜FALSE}　〜<<FALSE>>

FTPサーバとの接続にFTPSを使用する場合に，FTPサーバのサーバ認証をするかどうかを指定します。この指定は，FTPサーバとの接続にFTPSを使用するときだけ有効となります。

FTPアダプタの要求電文でも指定できます。重複して指定されている場合，要求電文の値が有効になります。

TRUE

サーバ認証をします（証明書をチェックします）。

FTPSの接続先であるFTPサーバの公開鍵の証明書が信頼できるかどうかをチェックし，信頼できる場合だけ処理を実行します。

TRUEを指定する場合は，トラストストアに関する設定が必要です。トラストストアの設定に関しては，マニュアル「サービスプラットフォーム 開発ガイド 受付・アダプタ定義編」の「付録H.2　セキュアプロトコルによる暗号化・認証（FTPインバウンドアダプタ）」を参照してください。

FALSE

証明書をチェックしません。

FTPSの接続先であるFTPサーバの公開鍵の証明書が信頼できるかどうかはチェックしないで，処理を実行します。

(c)　FTPアダプタ実行環境プロパティファイルでだけ設定できるプロパティ

次に示すプロパティは，FTPアダプタ実行環境プロパティファイルで設定するプロパティです。運用時に管理する定義ファイルの数を削減したい場合は，FTPアダプタ実行環境共通プロパティファイルを利用してください。

ftpadp.client-ipaddr=HCSCサーバのIPアドレス
ftpadp.client-con-port.min=FTPアダプタの制御コネクションポート番号の範囲の最小値
ftpadp.client-con-port.max=FTPアダプタの制御コネクションポート番号の範囲の最大値

ftpadp.control-con.retry.count=制御コネクションを確立できなかったときのリトライ回数
ftpadp.control-con.retry.interval=制御コネクションを確立できなかったときのリトライ間隔
ftpadp.control-con.connect.timeout=制御コネクションの接続タイムアウト時間

ftpadp.client-pasv-port.min=データコネクションがPASVモードの場合のFTPアダプタがデータコネクション確立するポート番号の範囲の最小値
ftpadp.client-pasv-port.max=データコネクションがPASVモードの場合のFTPアダプタがデータコネクション確立するポート番号の範囲の最大値

ftpadp.data-con.retry.count=PASVモードでデータコネクションを確立できなかったときのリトライ回数
ftpadp.data-con.retry.interval=PASVモードでデータコネクションを確立できなかったときのリトライ間隔
ftpadp.data-con.connect.timeout=データコネクションの接続タイムアウト時間

ftpadp.listen-port.min=データコネクションがPORTモードの場合のFTPアダプタがデータコネクションを待ち受けるポート番号の範囲の最小値
ftpadp.listen-port.max=データコネクションがPORTモードの場合のFTPアダプタがデータコネクションを待ち受けるポート番号の範囲の最大値

ftpadp.listen-port.reuse={TRUE｜FALSE}

ftpadp.listen.timeout=Listenタイムアウト時間

ftpadp.data-con.read.timeout=パッシブモードでのデータコネクションの受信バッファからの読み込みタイムアウト時間

ftpadp.exptrace.filenum=例外ログの面数
ftpadp.exptrace.filesize=例外ログの1面当たりの最大サイズ

ftpadp.ftpprotocoltrace.filenum=プロトコルトレースファイルの面数
ftpadp.ftpprotocoltrace.filesize=プロトコルトレースファイルの1面当たりの最大サイズ

ftpadp.methodtrace.level={1｜2｜3｜4｜5}
ftpadp.methodtrace.filepath=保守用ログの出力先ディレクトリの絶対パス
ftpadp.methodtrace.filenum=保守用ログの面数
ftpadp.methodtrace.filesize=保守用ログの1面当たりの最大サイズ

ftpadp.messagelog.level={0｜10｜20}

ftpadp.account-inf-filepath=FTPアダプタアカウント定義ファイルの絶対パス
ftpadp.cscthrough-filepath=FTPコマンド許可リスト定義ファイルの絶対パス

ftpadp.read-lock.retry.count=共通フォルダのファイルの共有ロック失敗時のリトライ回数
ftpadp.read-lock.retry.interval=共通フォルダのファイルの共有ロック失敗時のリトライ間隔
ftpadp.write-lock.retry.count=共通フォルダのファイルの占有ロック失敗時のリトライ回数
ftpadp.write-lock.retry.interval=共通フォルダのファイルの占有ロック失敗時のリトライ間隔

ftpadp.data-con-put.timeout=データ転送時タイムアウト時間
ftpadp.data-con-get.timeout=データ取得時タイムアウト時間

ftpadp.ftp-command-reply.timeout=リプライタイムアウト時間

ftpadp.put-client-buffer.size=ファイル転送（送信）するときのクライアントバッファサイズ
ftpadp.get-client-buffer.size=ファイル転送（受信）するときのクライアントバッファサイズ

●クライアント情報関連（基本設定）

ftpadp.client-ipaddr=HCSCサーバのIPアドレス

HCSCサーバのIPアドレスを指定します。ここで指定したIPアドレスが制御コネクションおよびデータコネクションで使用されます。

このプロパティの指定を省略した場合，システムによって自動的に任意のIPアドレスが割り当てられます。IPアドレスはjava.net.NetworkInterfaceクラスでまとめて取得し，そのうち最初に見つかった実IPアドレスが割り当てられます。実IPアドレスが存在しない場合はループバックIPアドレスが割り当てられます。

注意事項

Windowsを使用する場合，ループバックIPアドレスを指定すると，FTP接続に失敗する場合があります。実IPアドレスを設定してください。

ftpadp.client-con-port.min=FTPアダプタの制御コネクションポート番号の範囲の最小値　〜＜数字＞((1024−65535))

FTPアダプタの制御コネクションポート番号の範囲の最小値を指定します。

指定できる値を次に示します。

ftpadp.client-con-port.maxプロパティ（FTPアダプタの制御コネクションポート番号の範囲の最大値）以下の範囲の値

ftpadp.client-pasv-port.minプロパティ（データコネクションがPASVモードの場合のFTPアダプタがデータコネクション確立するポート番号の範囲の最小値）から，ftpadp.client-pasv-port.maxプロパティ（データコネクションがPASVモードの場合のFTPアダプタがデータコネクション確立するポート番号の範囲の最大値）までに指定した範囲と重複しない値

ftpadp.listen-port.minプロパティ（データコネクションがPORTモードの場合のFTPアダプタがデータコネクションを待ち受けるポート番号の範囲の最小値）から，ftpadp.listen-port.maxプロパティ（データコネクションがPORTモードの場合のFTPアダプタがデータコネクションを待ち受けるポート番号の範囲の最大値）までに指定した範囲と重複しない値

上記以外の値を指定した場合，FTPアダプタの起動時，またはFTPアダプタの要求電文の<pasvport>でデータコネクションの接続モードを変更したリクエストの処理時にエラーとなります。

注意事項

ftpadp.client-con-port.maxプロパティ（FTPアダプタの制御コネクションポート番号の範囲の最大値）を省略した場合はこのプロパティも省略してください。省略しない場合は，FTPアダプタの起動時にエラーとなります。

このプロパティの指定を省略した場合，システムによって自動的に任意のポート番号が設定されます。

ftpadp.client-con-port.max=FTPアダプタの制御コネクションポート番号の範囲の最大値　〜＜数字＞((1024−65535))

FTPアダプタの制御コネクションポート番号の範囲の最大値を指定します。

指定できる値を次に示します。

ftpadp.client-con-port.minプロパティ（FTPアダプタの制御コネクションポート番号の範囲の最小値）以上の範囲の値

ftpadp.client-pasv-port.minプロパティ（データコネクションがPASVモードの場合のFTPアダプタがデータコネクション確立するポート番号の範囲の最小値）から，ftpadp.client-pasv-port.maxプロパティ（データコネクションがPASVモードの場合のFTPアダプタがデータコネクション確立するポート番号の範囲の最大値）までに指定した範囲と重複しない値

ftpadp.listen-port.minプロパティ（データコネクションがPORTモードの場合のFTPアダプタがデータコネクションを待ち受けるポート番号の範囲の最小値）から，ftpadp.listen-port.maxプロパティ（データコネクションがPORTモードの場合のFTPアダプタがデータコネクションを待ち受けるポート番号の範囲の最大値）までに指定した範囲と重複しない値

上記以外の値を指定した場合，FTPアダプタの起動時，またはFTPアダプタの要求電文の<pasvport>でデータコネクションの接続モードを変更したリクエストの処理時にエラーとなります。

注意事項

ftpadp.client-con-port.minプロパティ（FTPアダプタの制御コネクションポート番号の範囲の最小値）を省略した場合はこのプロパティも省略してください。省略しない場合は，FTPアダプタの起動時にエラーとなります。

このプロパティの指定を省略した場合，システムによって自動的に任意のポート番号が設定されます。

●制御コネクションの接続タイムアウト関連

ftpadp.control-con.retry.count=制御コネクションを確立できなかったときのリトライ回数　〜＜数字＞((0−10000))<<5>>

制御コネクションを確立できなかったときのリトライ回数を指定します。0を指定した場合，リトライしません。

ftpadp.control-con.retry.interval=制御コネクションを確立できなかったときのリトライ間隔　〜＜数字＞((0−86400))<<2>>

制御コネクションを確立できなかったときのリトライ間隔を秒単位で指定します。0を指定した場合，間隔を空けないでリトライします。

ftpadp.control-con.connect.timeout=制御コネクションの接続タイムアウト時間　〜＜数字＞((1−3600))<<10>>

制御コネクションの接続のタイムアウト時間を秒単位で指定します。

●クライアント情報関連（データコネクションがPASVモードの場合）

ftpadp.client-pasv-port.min=データコネクションがPASVモードの場合のFTPアダプタがデータコネクション確立するポート番号の範囲の最小値　〜＜数字＞((1024−65535))

データコネクションがPASVモードの場合の，FTPアダプタがデータコネクション確立するポート番号の範囲の最小値を指定します。このプロパティはデータコネクションがPASVモードの場合だけ有効になります。

指定できる値を次に示します。

ftpadp.client-pasv-port.maxプロパティ（データコネクションがPASVモードの場合のFTPアダプタがデータコネクション確立するポート番号の範囲の最大値）以下の範囲の値

ftpadp.client-con-port.minプロパティ（FTPアダプタの制御コネクションポート番号の範囲の最小値）から，ftpadp.client-con-port.maxプロパティ（FTPアダプタの制御コネクションポート番号の範囲の最大値）までに指定した範囲と重複しない値

上記以外の値を指定した場合，FTPアダプタの起動時，またはFTPアダプタの要求電文の<pasvport>でデータコネクションの接続モードを変更したリクエストの処理時にエラーとなります。

注意事項

ftpadp.client-pasv-port.maxプロパティ（データコネクションがPASVモードの場合のFTPアダプタがデータコネクション確立するポート番号の範囲の最大値）を省略した場合はこのプロパティも省略してください。省略しない場合は，FTPアダプタの起動時にエラーとなります。

このプロパティの指定を省略した場合，システムによって自動的に任意のポート番号が設定されます。

このプロパティの値とftpadp.client-pasv-port.maxプロパティの値の範囲内にある値をポート番号に指定します。

指定した値がポート番号として使用できなかった場合に範囲内にある，ほかの値をポート番号に指定しリトライを実施します。

リトライを実施する場合，メッセージKDEK30410-Wが出力されます。

このプロパティを省略してデータコネクションの確立に失敗した場合，または範囲内の値すべてがデータコネクションのポート番号として使用できなかった場合，メッセージKDEK30409-Eが出力されます。

ftpadp.client-pasv-port.max=データコネクションがPASVモードの場合のFTPアダプタがデータコネクション確立するポート番号の範囲の最大値　〜＜数字＞((1024−65535))

データコネクションがPASVモードの場合の，FTPアダプタがデータコネクション確立するポート番号の範囲の最大値を指定します。このプロパティはデータコネクションがPASVモードの場合だけ有効になります。

指定できる値を次に示します。

ftpadp.client-pasv-port.minプロパティ（データコネクションがPASVモードの場合のFTPアダプタがデータコネクション確立するポート番号の範囲の最小値）以上の範囲の値

ftpadp.client-con-port.minプロパティ（FTPアダプタの制御コネクションポート番号の範囲の最小値）から，ftpadp.client-con-port.maxプロパティ（FTPアダプタの制御コネクションポート番号の範囲の最大値）までに指定した範囲と重複しない値

上記以外の値を指定した場合，FTPアダプタの起動時にエラーとなります。

次の場合，このプロパティを省略してください。省略しない場合は，FTPアダプタの起動時，またはFTPアダプタの要求電文の<pasvport>でデータコネクションの接続モードを変更したリクエストの処理時にエラーとなります。

注意事項

ftpadp.client-pasv-port.minプロパティ（データコネクションがPASVモードの場合のFTPアダプタがデータコネクション確立するポート番号の範囲の最小値）を省略した場合はこのプロパティも省略してください。省略しない場合は，FTPアダプタの起動時にエラーとなります。

このプロパティの指定を省略した場合，システムによって自動的に任意のポート番号が設定されます。

このプロパティの値とftpadp.client-pasv-port.minプロパティの値の範囲内にある値をポート番号に指定します。

指定した値がポート番号として使用できなかった場合に範囲内にある，ほかの値をポート番号に指定しリトライを実施します。

リトライを実施する場合，メッセージKDEK30410-Wが出力されます。

このプロパティを省略してデータコネクションの確立に失敗した場合，または範囲内の値すべてがデータコネクションのポート番号として使用できなかった場合，メッセージKDEK30409-Eが出力されます。

●データコネクションの接続タイムアウト関連

ftpadp.data-con.retry.count=PASVモードでデータコネクションを確立できなかったときのリトライ回数　〜＜数字＞((0−10000))<<5>>

PASVモードでデータコネクションを確立できなかったときのリトライ回数を指定します。0を指定した場合，リトライしません。

リトライをする場合，メッセージKDEK30410-Wを出力します。リトライ回数がこの値以上になった場合，メッセージKDEK30409-Eが出力されます。

ftpadp.data-con.retry.interval=PASVモードでデータコネクションを確立できなかったときのリトライ間隔　〜＜数字＞((0−86400))<<2>>

PASVモードでデータコネクションを確立できなかったときのリトライ間隔を秒単位で指定します。0を指定した場合，間隔を空けないでリトライします。

ftpadp.data-con.connect.timeout=データコネクションの接続タイムアウト時間　〜＜数字＞((1−3600))<<10>>

PASVモードでの，データコネクション接続のタイムアウト時間を秒単位で指定します。

●クライアント情報関連（データコネクションがPORTモードの場合）

ftpadp.listen-port.min=データコネクションがPORTモードの場合のFTPアダプタがデータコネクションを待ち受けるポート番号の範囲の最小値　〜＜数字＞((1024−65535))<<49152>>

データコネクションがPORTモードの場合の，FTPアダプタがデータコネクションを待ち受けるポート番号の範囲の最小値を指定します。

このプロパティはデータコネクションがPORTモードの場合だけ有効になります。

指定できる値を次に示します。

ftpadp.listen-port.maxプロパティ（データコネクションがPORTモードの場合のFTPアダプタがデータコネクションを待ち受けるポート番号の範囲の最大値）以下の範囲の値

ftpadp.client-con-port.minプロパティ（FTPアダプタの制御コネクションポート番号の範囲の最小値）から，ftpadp.client-con-port.maxプロパティ（FTPアダプタの制御コネクションポート番号の範囲の最大値）までに指定した範囲と重複しない値

上記以外の値を指定した場合，FTPアダプタの起動時，またはFTPアダプタの要求電文の<pasvport>でデータコネクションの接続モードを変更したリクエストの処理時にエラーとなります。

このプロパティとftpadp.listen-port.maxプロパティで指定した範囲内の値を待ち受けるポート番号に指定します。

指定した値がポート番号として使用できなかった場合，範囲内にある，ほかの値をポート番号に指定しリトライを実施します。

リトライを実施する場合，メッセージKDEK30410-Wが出力されます。

範囲内の値すべてが待ち受けるポート番号として使用できなかった場合，メッセージKDEK30409-Eが出力されます。

ftpadp.listen-port.max=データコネクションがPORTモードの場合のFTPアダプタがデータコネクションを待ち受けるポート番号の範囲の最大値　〜＜数字＞((1024−65535))<<65535>>

データコネクションがPORTモードの場合の，FTPアダプタがデータコネクションを待ち受けるポート番号の範囲の最大値を指定します。

このプロパティはデータコネクションがPORTモードの場合だけ有効になります。

指定できる値を次に示します。

ftpadp.listen-port.minプロパティ（データコネクションがPORTモードの場合のFTPアダプタがデータコネクションを待ち受けるポート番号の範囲の最小値）以上の範囲の値

ftpadp.client-con-port.minプロパティ（FTPアダプタの制御コネクションポート番号の範囲の最小値）から，ftpadp.client-con-port.maxプロパティ（FTPアダプタの制御コネクションポート番号の範囲の最大値）までに指定した範囲と重複しない値

上記以外の値を指定した場合，FTPアダプタの起動時，またはFTPアダプタの要求電文の<pasvport>でデータコネクションの接続モードを変更したリクエストの処理時にエラーとなります。

このプロパティとftpadp.listen-port.minプロパティで指定した範囲内の値を待ち受けるポート番号に指定します。

指定した値がポート番号として使用できなかった場合，範囲内にある，ほかの値をポート番号に指定しリトライを実施します。

リトライを実施する場合，メッセージKDEK30410-Wが出力されます。

範囲内の値すべてが待ち受けるポート番号として使用できなかった場合，メッセージKDEK30409-Eが出力されます。

●ポート再利用関連

ftpadp.listen-port.reuse={TRUE｜FALSE}　〜<<TRUE>>

OSがLinuxかAIXで，かつデータコネクションの接続モードがPORTモードの場合に，TIME_WAIT状態のポートを再利用するかどうかを指定します。データコネクションの接続モードがPORTモード以外の場合，このプロパティの指定は無視されます。

再利用するポートはftpadp.listen-port.minの設定値からftpadp.listen-port.maxの設定値までの範囲のポート番号が対象です。

TRUE

TIME_WAIT状態のポートを再利用します。

また，SO_REUSEADDRが有効になります。

このプロパティを省略した場合や，プロパティ名だけが指定された場合も，TRUE選択時と同じ状態となります。

注意事項

PASVモードで使用するポート番号（ftpadp.client-pasv-port.minの設定値からftpadp.client-pasv-port.maxの設定値までの範囲）の指定有無によって，ポート番号に次に示す重複がないよう注意してください。重複する場合の動作は保証しません。

PASVモードで使用するポート番号を指定しているとき

PORTモードで使用するポート番号の範囲（ftpadp.listen-port.minの設定値からftpadp.listen-port.maxの設定値までの範囲）と重複しないようにしてください。

PASVモードで使用するポート番号を指定していないとき

OSの動的ポートの使用できる範囲をPORTモードで使用するポート番号の範囲（ftpadp.listen-port.minの設定値からftpadp.listen-port.maxの設定値までの範囲）と重複しないようにしてください。

FALSE

TIME_WAIT状態のポートを再利用しません。

また，SO_REUSEADDRが無効になります。

Windowsでこのプロパティを指定した場合は，FTPアダプタの起動時にエラーとなります。

注意事項

LinuxまたはAIXでこのプロパティを指定する場合は，HCSCサーバ内にあるすべてのPORTモードのFTPアダプタに同じ値を指定してください。同じ値を指定しなかった場合の動作は保証しません。

●Listenタイムアウト関連

ftpadp.listen.timeout=Listenタイムアウト時間　〜＜数字＞((1−3600))<<60>>

PORTモードの場合，PORTコマンドのリプライを受けたあと，Listen状態での監視時間を秒単位で指定します。指定した時間を経過してもサーバからデータコネクションの接続要求がなかった場合は例外（エラー）が発生します。

●データ読み込みタイムアウト関連

ftpadp.data-con.read.timeout=パッシブモードでのデータコネクションの受信バッファからの読み込みタイムアウト時間　〜＜数字＞((0−3600))<<0>>

パッシブモードでの，データコネクションの受信バッファからの読み込みタイムアウト時間を秒単位で設定します。

0を設定した場合はタイムアウトしません。

●例外ログ関連

ftpadp.exptrace.filenum=例外ログの面数　〜＜数字＞((1−16))<<8>>

例外ログの面数を指定します。

ftpadp.exptrace.filesize=例外ログの1面当たりの最大サイズ　〜＜数字＞((4096−2147483647))<<2097152>>

例外ログの1面当たりの最大サイズをバイト単位で指定します。

●FTPプロトコルトレース関連

ftpadp.ftpprotocoltrace.filenum=プロトコルトレースファイルの面数　〜＜数字＞((1−16)) <<8>>

プロトコルトレースファイルの面数を指定します。

ftpadp.ftpprotocoltrace.filesize=プロトコルトレースファイルの1面当たりの最大サイズ　〜＜数字＞((4096−2147483647)) <<2097152>>

プロトコルトレースファイルの1面当たりの最大サイズ数をバイト単位で指定します。

●保守用ログ関連

ftpadp.methodtrace.level={1｜2｜3｜4｜5}　〜<<3>>

保守用ログの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

出力情報

出力レベル

1

2

3

4

5

エラー情報（例外発生原因）

○

○

○

○

○

リクエスタサービスメソッドの入口／出口情報（クラス名，メソッド名，引数，戻り値）

×

○

○

○

○

外部（BPなど）のインターフェースの入口／出口情報（クラス名，メソッド名，引数，戻り値）

×

×

○

○

○

コンポーネント内インターフェースの入口／出口情報（クラス名，メソッド名，引数，戻り値）

×

×

×

○

○

デバッグ情報（処理の分岐などの情報）

×

×

×

×

○

（凡例）

○：出力されます。

×：出力されません。

ftpadp.methodtrace.filepath=保守用ログの出力先ディレクトリの絶対パス　〜＜文字列（2バイト文字含む）および空白＞<<<J2EEサーバのログ出力先ディレクトリ>¥CSCADP¥FTPADP¥maintenance¥<サービスID>>>

保守用ログの出力先ディレクトリを絶対パスで指定します。

<J2EEサーバのログ出力先ディレクトリ>はusrconf.cfg（J2EEサーバ用オプション定義ファイル）のejb.server.log.directoryで指定します。

指定したパスの直下にサービスIDのディレクトリが作成され，そのディレクトリの中に保守用ログが作成されます。なお，保守用ログは「cscftpadpmtd_<HCSCサーバ名>_<面数>.log」という名前で作成されます。

存在しないディレクトリを指定した場合，またはサービスIDのディレクトリを作成できなかった場合，メッセージKDEK20903-Wを出力して，デフォルトの出力先ディレクトリに出力されます。

ftpadp.methodtrace.filenum=保守用ログの面数　〜＜数字＞((1−16))<<8>>

保守用ログの面数を指定します。

ftpadp.methodtrace.filesize=保守用ログの1面当たりの最大サイズ　〜＜数字＞((4096−2147483647))<<2097152>>

保守用ログの1面当たりの最大サイズをバイト単位で指定します。

●メッセージログ関連

ftpadp.messagelog.level={0｜10｜20}　〜<<10>>

メッセージログの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

出力情報

出力レベル

0

10

20

エラー情報

例外または障害の発生原因

○

○

○

警告情報

発生した問題など

×

○

○

インフォメーション

電文や引数の内容

HCSC-Messagingの状態の変更（起動時や終了時）

コマンド受付時と実行完了時

イベントの通知

×

×

○

（凡例）

○：出力されます。

×：出力されません。

●パス関連

ftpadp.account-inf-filepath=FTPアダプタアカウント定義ファイルの絶対パス　〜＜文字列（2バイト文字含む）および空白＞

FTPアダプタアカウント定義ファイルのパスを絶対パスで指定します。

ftpadp.cscthrough-filepath=FTPコマンド許可リスト定義ファイル（FTPアダプタ用）の絶対パス　〜＜文字列（2バイト文字含む）および空白＞

FTPコマンド許可リスト定義ファイル（FTPアダプタ用）のパスを絶対パスで指定します。指定を省略した場合，ユーザ指定のFTPコマンドは，転送前，転送後，リストコマンド実行前，およびリストコマンド実行後には実行できません。

●排他取得タイムアウト関連

ftpadp.read-lock.retry.count=共通フォルダのファイルの共有ロック失敗時のリトライ回数　〜＜数字＞((0−1024))<<0>>

共通フォルダのファイルの共有ロック失敗時のリトライ回数を指定します。

ftpadp.read-lock.retry.interval=共通フォルダのファイルの共有ロック失敗時のリトライ間隔　〜＜数字＞((1−1024))<<1>>

共通フォルダのファイルの共有ロック失敗時のリトライ間隔を秒単位で指定します。

ftpadp.write-lock.retry.count=共通フォルダのファイルの占有ロック失敗時のリトライ回数　〜＜数字＞((0−1024))<<0>>

共通フォルダのファイルの占有ロック失敗時のリトライ回数を指定します。

ftpadp.write-lock.retry.interval=共通フォルダのファイルの占有ロック失敗時のリトライ間隔　〜＜数字＞((1−1024))<<1>>

共通フォルダのファイルの占有ロック失敗時のリトライ間隔を秒単位で指定します。

●データ転送取得タイムアウト関連

ftpadp.data-con-put.timeout=データ転送時タイムアウト時間　〜＜数字＞((1−86400))<<60>>

データ送信時に，ファイル全体の送信が完了するまでの監視時間を秒単位で指定します。指定した時間を経過しても送信が完了しない場合は例外（エラー）が発生します。

ftpadp.data-con-get.timeout=データ取得時タイムアウト時間　〜＜数字＞((1−86400))<<60>>

データ受信時に，ファイル全体の受信が完了するまでの監視時間を秒単位で指定します。指定した時間を経過しても受信が完了しない場合は例外（エラー）が発生します。

●FTPコマンドリプライタイムアウト関連

ftpadp.ftp-command-reply.timeout=リプライタイムアウト時間　〜＜数字＞((1−3600))<<60>>

FTPコマンドを発行して，リプライされるまでの監視時間を秒単位で指定します。指定した時間を経過してもコマンドのリプライがなかった場合は，例外（エラー）が発生します。

●バッファサイズ関連

ftpadp.put-client-buffer.size=ファイル転送（送信）するときのクライアントバッファサイズ　〜＜数字＞((512−262144))<<40960>>

ファイル転送（送信）するときのクライアントバッファのメモリのサイズを，バイト単位で指定します。

この値は，メモリが制限されるときや転送効率を上げたいときなどに変更してください。なお，転送効率は回線の速度や利用状況，CPUの性能などによって変動します。

ftpadp.get-client-buffer.size=ファイル転送（受信）するときのクライアントバッファサイズ　〜＜数字＞((512−262144))<<40960>>

ファイル転送（受信）するときのクライアントバッファのメモリのサイズを，バイト単位で指定します。

この値は，メモリが制限されるときや転送効率を上げたいときなどに変更してください。なお，転送効率は回線の速度や利用状況，CPUの性能などによって変動します。

(4)　注意事項

次に示すプロパティは，PORTモードのすべてのFTPアダプタで同じ値を設定する必要があるため，FTPアダプタ実行環境共通プロパティファイルで定義することを推奨します。FTPアダプタごとに異なる値が設定された場合の動作は保証しません。

ftpadp.listen-port.reuse

パスを指定する場合の注意事項を次に示します。

相対パス，親ディレクトリ表現（「..¥」，「../」），およびカレントディレクトリ表現（「.¥」，「./」）を含むパスは指定しないでください。

シンボリックリンクを含むパスは指定しないでください。

Windowsの場合，UNC形式，NTFSのストリーム名，および予約デバイス名を含むパスは指定しないでください。また，パスの大文字と小文字は区別されません。

6.8.4　FTPアダプタ実行環境共通プロパティファイル

(1)　形式

ファイルの記述形式はFTPアダプタ実行環境プロパティファイルと同じです。記述形式については，「6.8.3　FTPアダプタ実行環境プロパティファイル」を参照してください。

(2)　機能

すべてのFTPアダプタに共通する構成情報を設定します。

(a)　ファイルの種類

FTPアダプタ実行環境プロパティファイルは，次に示す2種類があります。

FTPアダプタ実行環境プロパティファイル

有効範囲：特定のFTPアダプタ

作成手順については「6.8.3　FTPアダプタ実行環境プロパティファイル」を参照してください。

FTPアダプタ実行環境共通プロパティファイル

有効範囲：すべてのFTPアダプタ

これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。

また，1つのマシンに複数のHCSCサーバをセットアップした場合，FTPアダプタ実行環境共通プロパティファイルをHCSCサーバごとに定義することもできます。

プロパティファイル間で同じ内容が複数設定された場合のプロパティの優先度については，「6.8.3　FTPアダプタ実行環境プロパティファイル」を参照してください。

(b)　作成手順

FTPアダプタ実行環境共通プロパティファイルは次の手順で作成してください。

次のテンプレートファイルを基に，FTPアダプタ実行環境共通プロパティファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥FTP¥config¥templates¥adpftp.properties

編集後のファイルを次のディレクトリに格納します。

なお，ファイル名「adpftp.properties」は変更しないでください。

全HCSCサーバ共通の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥FTP¥config¥common

特定のHCSCサーバ用の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥FTP¥config¥<HCSCサーバ名>¥common

サブディレクトリ名の<HCSCサーバ名>と「common」を作成する際は，Windowsでは大文字・小文字は区別されないので，注意してください。

サブディレクトリ<HCSCサーバ名>には，HCSCサーバの管理者（Service Coordinator管理者）がアクセスできるよう，適切なアクセス権限を設定してください。

(3)　設定できるプロパティ

設定できるプロパティは，FTPアダプタ実行環境プロパティファイルと一部差異があります。設定できるプロパティについては，「6.8.3　FTPアダプタ実行環境プロパティファイル」を参照してください。

6.8.5　FTP受付コンフィグファイル

(1)　形式

［urecp-ftp.permission-def.filepath=FTP実行許可リスト定義ファイルのパス］
［urecp-ftp.ftp-command-allow.filepath=FTPコマンド許可リスト定義ファイルのパス］
［urecp-ftp.request-timeout=FTP受付後のビジネスプロセスの処理時間］
［urecp-ftp.resident-thread.count=FTP受付後の処理時間の監視で利用する常駐スレッド数］
［urecp-ftp.timer-thread.maximum=FTP受付の処理時間の監視で利用する最大スレッド数］
［urecp-ftp.list-command-option.filepath=リストコマンドオプション定義ファイルのパス］
［urecp-ftp.read-lock.retry.count=共通フォルダのファイルの共有ロック失敗時のリトライ回数］
［urecp-ftp.read-lock.retry.interval=共通フォルダのファイルの共有ロック失敗時のリトライ間隔］
［urecp-ftp.write-lock.retry.count=共通フォルダのファイルの占有ロック失敗時のリトライ回数］
［urecp-ftp.write-lock.retry.interval=共通フォルダのファイルの占有ロック失敗時のリトライ間隔］

(2)　機能

FTP受付をセットアップしたあとに，設定変更が発生する頻度が高い内容を設定します。FTP受付開始時に，FTP受付コンフィグファイルに設定した内容が有効になります。

FTP受付の実行環境に依存するパラメタを設定します。

FTP受付コンフィグファイルは，FTP受付ごとに設定する個別定義ファイルと，すべてのFTP受付に適用される共通定義ファイルの2種類があります。すべてのFTP受付に適用される共通定義ファイルのことをFTP受付共通コンフィグファイルと呼びます。

FTP受付コンフィグファイルとFTP受付共通コンフィグファイルの両方が設定されている場合，2つのファイルの定義内容がマージされます。同じプロパティが設定されている場合，FTP受付コンフィグファイルの内容が有効になります。

FTP受付コンフィグファイル，およびFTP受付共通コンフィグファイルは，テンプレートファイルを基に作成します。

●FTP受付コンフィグファイルの作成手順

FTP受付コンフィグファイルは次の手順で作成してください。

次のテンプレートファイルを基に，FTP受付コンフィグファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥ftprecp¥templates¥ftprecp_config.properties

編集後のFTP受付コンフィグファイルのファイル名を「<受付ID>.properties」という名称に変更し，次のディレクトリに格納します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥ftprecp

●FTP受付共通コンフィグファイルの作成手順

FTP受付共通コンフィグファイルは次の手順で作成してください。

次のテンプレートファイルを基に，FTP受付共通コンフィグファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥ftprecp¥templates¥ftprecp_config.properties

編集後のFTP受付共通コンフィグファイルを次のディレクトリに格納します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥ftprecp¥common

ファイル名は変更しないでください。

(3)　設定できるプロパティ

urecp-ftp.permission-def.filepath=FTP実行許可リスト定義ファイルのパス　〜＜文字列（2バイト文字含む）および空白＞

FTP実行許可リスト定義ファイルのパスを絶対パスで指定します。

このプロパティの指定を，個別定義ファイルと共通定義ファイルの両方で省略した場合，すべてのユーザに対して，FTP受付が関連づけられたビジネスプロセスの実行を許可します。

urecp-ftp.ftp-command-allow.filepath=FTPコマンド許可リスト定義ファイルのパス　〜＜文字列（2バイト文字含む）および空白＞

FTPコマンド許可リスト定義ファイル（FTP受付用）のパスを絶対パスで指定します。

このプロパティの指定を，個別定義ファイルと共通定義ファイルの両方で省略した場合，転送前，転送後，リストコマンド実行前，およびリストコマンド実行後にユーザ指定のFTPコマンドの実行を許可しません。

urecp-ftp.request-timeout=FTP受付後のビジネスプロセスの処理時間　〜＜数字＞ ((0−2147483647))<<0>>

FTP受付後にビジネスプロセスに要求電文を渡して応答電文が返ってくるまでの処理時間を秒単位で指定します。

0を指定した場合や，キーまたは値を省略した場合は，処理時間は監視されません。

1以上を指定した場合，処理時間を監視するためにスレッドが常駐します。常駐スレッド数はurecp-ftp.resident-thread.countプロパティで指定してください。

数字以外の値や範囲外の値が指定された場合は，コマンド実行時にエラーとなります。

urecp-ftp.resident-thread.count=FTP受付後の処理時間の監視で利用する常駐スレッド数　〜＜数字＞ ((0−2147483647))<<0>>

FTP受付後にビジネスプロセスでの処理時間を監視する際，常駐させるスレッド数を指定します。常駐スレッドはFTP受付の起動時に生成されます。

また，監視を実行しない場合はスレッドが生成されないため，このプロパティに指定された値は無視されます。

数字以外の値や範囲外の値が指定された場合は，コマンド実行時にエラーとなります。また，urecp-ftp.timer-thread.maximumプロパティの指定値より大きい値を指定した場合，コマンド実行時にエラーとなります。

urecp-ftp.timer-thread.maximum=FTP受付の処理時間の監視で利用する最大スレッド数　〜＜数字＞ ((0−2147483647))<<FTP受付定義ファイルのurecp-ftp.pooled-instance.maximumの指定値>>

FTP受付の処理時間の監視で利用する最大スレッド数を指定します。処理時間を監視しない場合はスレッドが生成されないため，このプロパティに指定された値は無視されます。

キーまたは値を省略した場合は，デフォルト値としてFTP受付定義ファイルのurecp-ftp.pooled-instance.maximum（受付処理およびカスタム受付フレームワークのプール内のインスタンスの最大数）の指定値が適用されます。csccompoconfigコマンドによる変更は適用されません。

次の場合，最大スレッド数は1となります。

0を指定した場合

デフォルト値が適用された際に，FTP受付定義ファイルのurecp-ftp.pooled-instance.maximumの指定値が0である場合

urecp-ftp.list-command-option.filepath=リストコマンドオプション定義ファイルのパス　〜＜文字列（2バイト文字含む）および空白＞

リストコマンドオプション定義ファイルのパスを絶対パスで指定します。

このプロパティの指定を，個別定義ファイルと共通定義ファイルの両方で省略した場合，リストコマンドの引数に指定された情報はすべてパスの情報と解釈されます。

urecp-ftp.read-lock.retry.count=共通フォルダのファイルの共有ロック失敗時のリトライ回数　〜＜数字＞ ((0−1024))<<0>>

共通フォルダのファイルの共有ロック失敗時のリトライ回数を指定します。共通フォルダを使用しない場合，ファイルの共有ロックは行われないため，このプロパティに指定された値は無視されます。

キーまたは値を省略した場合は，デフォルト値で動作します。

数字以外の値や範囲外の値が指定された場合は，コマンド実行時にエラーとなります。

urecp-ftp.read-lock.retry.interval=共通フォルダのファイルの共有ロック失敗時のリトライ間隔　〜＜数字＞ ((1−1024))<<1>>

共通フォルダのファイルの共有ロック失敗時のリトライ間隔を秒単位で指定します。共通フォルダを使用しない場合，ファイルの共有ロックは行われないため，このプロパティに指定された値は無視されます。

キーまたは値を省略した場合は，デフォルト値で動作します。

数字以外の値や範囲外の値が指定された場合は，コマンド実行時にエラーとなります。

urecp-ftp.write-lock.retry.count=共通フォルダのファイルの占有ロック失敗時のリトライ回数　〜＜数字＞ ((0−1024))<<0>>

共通フォルダのファイルの占有ロック失敗時のリトライ回数を指定します。共通フォルダのファイルを削除しない場合，ファイルの占有ロックは行われないため，このプロパティに指定された値は無視されます。

キーまたは値を省略した場合は，デフォルト値で動作します。

数字以外の値や範囲外の値が指定された場合は，コマンド実行時にエラーとなります。

urecp-ftp.write-lock.retry.interval=共通フォルダのファイルの占有ロック失敗時のリトライ間隔　〜＜数字＞ ((1−1024))<<1>>

共通フォルダのファイルの占有ロック失敗時のリトライ間隔を秒単位で指定します。共通フォルダのファイルを削除しない場合，ファイルの占有ロックは行われないため，このプロパティに指定された値は無視されます。

キーまたは値を省略した場合は，デフォルト値で動作します。

数字以外の値や範囲外の値が指定された場合は，コマンド実行時にエラーとなります。

(4)　記述例

記述例を次に示します。

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

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)　注意事項

パスを指定する場合の注意事項を次に示します。

相対パス，親ディレクトリ表現（「..¥」，「../」），およびカレントディレクトリ表現（「.¥」，「./」）を含むパスは指定しないでください。

シンボリックリンクを含むパスは指定しないでください。

Windowsの場合，UNC形式，NTFSのストリーム名，および予約デバイス名を含むパスは指定しないでください。また，パスの大文字と小文字は区別されません。

6.8.6　FTPコマンド許可リスト定義ファイル

(1)　形式

［ftp-command.allow=実行を許可するFTPコマンド］
［ftp-command.site.allow=SITEコマンドで実行を許可するコマンド］

(2)　機能

転送前，転送後，リストコマンド実行前，またはリストコマンド実行後に実行を許可するFTPコマンドを設定します。

FTPコマンド許可リスト定義ファイルには，FTPアダプタ用とFTP受付用の2種類があります。

FTP受付またはFTPアダプタの開始時に，FTPコマンド許可リスト定義ファイルに設定した内容が有効になります。

FTPコマンド許可リスト定義ファイルは，テンプレートファイルを基に作成します。

●FTPコマンド許可リスト定義ファイル（FTP受付用）の作成手順

FTPコマンド許可リスト定義ファイル（FTP受付用）は次の手順で作成してください。

次のテンプレートファイルを基に，FTPコマンド許可リスト定義ファイル（FTP受付用）を定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥ftprecp¥templates¥ftp_command_allow.properties

編集後の，FTPコマンド許可リスト定義ファイル（FTP受付用）を次のディレクトリに格納します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥ftprecp¥common

ファイル名は変更しないでください。

参考

次のプロパティを指定した場合，FTPコマンド許可リスト定義ファイル（FTP受付用）を任意のパスに任意のファイル名で格納できます。

FTP受付コンフィグファイルのurecp-ftp.ftp-command-allow.filepathプロパティ

このプロパティを省略した場合，手順2.で示したディレクトリに格納されているFTPコマンド許可リスト定義ファイルが利用されます。手順2.で示したディレクトリにFTPコマンド許可リスト定義ファイルが格納されていない場合，すべてのFTPコマンドの実行を許可しません。

●FTPコマンド許可リスト定義ファイル（FTPアダプタ用）の作成手順

FTPコマンド許可リスト定義ファイル（FTPアダプタ用）は次の手順で作成してください。

次のテンプレートファイルを基に，FTPコマンド許可リスト定義ファイル（FTPアダプタ用）を定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥FTP¥config¥templates¥cscthrough.properties

編集後の，FTPコマンド許可リスト定義ファイル（FTPアダプタ用）を次のディレクトリに格納します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥FTP¥config¥common

ファイル名は変更しないでください。

参考

次のプロパティを指定した場合，FTPコマンド許可リスト定義ファイル（FTPアダプタ用）を任意のパスに任意のファイル名で格納できます。

FTPアダプタ実行環境プロパティファイルのftpadp.cscthrough-filepathプロパティ

このプロパティを省略した場合，手順2.で示したディレクトリに格納されているFTPコマンド許可リスト定義ファイルが利用されます。手順2.で示したディレクトリにFTPコマンド許可リスト定義ファイルが格納されていない場合，すべてのFTPコマンドの実行を許可しません。

(3)　設定できるプロパティ

ftp-command.allow=実行を許可するFTPコマンド　〜＜文字列または半角アスタリスク（*）＞

転送前，または転送後にビジネスプロセスで実行することを許可するFTPコマンドを指定します。大文字と小文字は区別されません。

このプロパティの指定を省略した場合，SITEコマンド以外のすべてのFTPコマンドの実行を許可しません。

注意事項

このプロパティの設定は，FTP受付コンフィグファイルまたはFTPアダプタ実行環境プロパティファイルに，この定義ファイルのパスを設定しているFTP受付またはFTPアダプタにだけ適用されます。

SITEコマンドの引数として指定するコマンドは，ftp-command.site.allowプロパティで許可するかどうかを指定するため，このプロパティにSITEコマンドを指定する必要はありません。

複数のコマンドを指定する場合は，「コマンド,コマンド,…」のようにコンマ（,）区切りで指定します。コンマ前後の半角スペースやタブ文字は無視されます。

半角アスタリスク（*）だけを指定した場合，サービスプラットフォームでサポートするSITEコマンド以外のすべてのFTPコマンドが許可されます。

STORコマンド，APPEコマンド，STOUコマンド，RETRコマンド，LISTコマンドおよびNLSTコマンドは，サービスプラットフォームでサポートしていないため，指定しても許可されません。半角アスタリスク（*）を指定している場合も，同様に許可されません。

ftp-command.site.allow=SITEコマンドで実行を許可するコマンド　〜＜文字列または半角アスタリスク（*）＞

転送前，または転送後にビジネスプロセスで実行することを許可する，FTPサーバが独自にサポートしているコマンドを指定します。このプロパティでは，SITEコマンドの第1引数として指定されるコマンドが対象になります。大文字と小文字は区別されません。

このプロパティの指定を省略した場合，すべてのSITEコマンドの実行を許可しません。

注意事項

このプロパティの設定は，FTP受付コンフィグファイルまたはFTPアダプタ実行環境プロパティファイルに，この定義ファイルのパスを設定しているFTP受付またはFTPアダプタにだけ適用されます。

SITE FSIZEコマンドは，FTPインバウンドアダプタで処理されるので，このプロパティの値にFSIZEを指定しても無視されます。

複数のコマンドを指定する場合は，「コマンド,コマンド,…」のようにコンマ（,）区切りで指定します。コンマ前後の半角スペースやタブ文字は無視されます。

半角アスタリスク（*）だけを指定した場合，FSIZE以外のすべてのSITEコマンドが許可されます。

(4)　記述例

記述例を次に示します。

ftp-command.allow=STAT, RNFR, RNTO, DELE, RMD
ftp-command.site.allow=CHMOD, UMASK

記述例の詳細を次に示します。

許可するFTPコマンド（SITEコマンド以外）：STAT，RNFR，RNTO，DELE，およびRMDコマンド

許可するSITEコマンド：CHMOD，およびUMASKコマンド

6.8.7　FTP実行許可リスト定義ファイル

(1)　形式

［urecp-ftp.permission.allow=実行を許可するユーザ名］
［urecp-ftp.permission.deny=実行を許可しないユーザ名］

(2)　機能

FTP受付に関連づけられたビジネスプロセスの実行を許可する，または許可しないユーザを設定します。

FTP実行許可リスト定義ファイルは，テンプレートファイルを基に作成します。

FTP実行許可リスト定義ファイルは，次の手順で作成してください。

次のテンプレートファイルを基に，FTP実行許可リスト定義ファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥ftprecp¥templates¥ftp_permission_allow.properties

編集後の，FTP実行許可リスト定義ファイルを次のディレクトリに格納します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥ftprecp¥common

ファイル名は変更しないでください。

参考

次のプロパティを指定した場合，FTP実行許可リスト定義ファイルを任意のパスに任意のファイル名で格納できます。

FTP受付コンフィグファイルのurecp-ftp.permission-def.filepathプロパティ

このプロパティを省略した場合，手順2.で示したディレクトリに格納されているFTP実行許可リスト定義ファイルが利用されます。手順2.で示したディレクトリにFTP実行許可リスト定義ファイルが格納されていない場合，すべてのFTPコマンドの実行を許可しません。

(3)　設定できるプロパティ

urecp-ftp.permission.allow=実行を許可するユーザ名　〜＜文字列または半角アスタリスク（*）＞<<*>>

FTP受付に関連づけられたビジネスプロセスの実行を許可するユーザのユーザ名を指定します。

複数のユーザを指定する場合は，「ユーザ名,ユーザ名,…」のように半角コンマ（,）区切りで指定します。半角コンマ前後の半角スペースやタブ文字は無視されます。

また，空のユーザ名（長さ0のユーザ名）も無視されます。次のように指定した場合は，空文字を無視してFTP受付が正常に起動します。

urecp-ftp.permission.allow = <ユーザ名1>,
urecp-ftp.permission.allow = <ユーザ名1>,△
urecp-ftp.permission.allow = <ユーザ名1>,△,<ユーザ名2>
urecp-ftp.permission.allow = <ユーザ名1>,,,,,,,,,,<ユーザ名2>
urecp-ftp.permission.allow = ,<タブ文字><ユーザ名1><タブ文字>,<タブ文字><タブ文字>

（凡例）

△：半角スペースを示します。

半角アスタリスク（*）だけを指定した場合，すべてのユーザに実行が許可されます。なお，次に示す形式のユーザ名を指定する場合は，前後をタブ文字で囲んでください。

半角コンマ（,）の文字を含むユーザ名

先頭または末尾に半角スペースがあるユーザ名

半角アスタリスク（*）1文字のユーザ名

このプロパティを省略した場合，半角アスタリスク（*）が設定されます。

注意事項

urecp-ftp.permission.denyプロパティ（実行を許可しないユーザ名）で指定されたユーザは，FTP受付に関連づけられたビジネスプロセスの実行は許可されません。

urecp-ftp.permission.deny=実行を許可しないユーザ名　〜＜文字列または半角アスタリスク（*）＞

FTP受付に関連づけられたビジネスプロセスの実行を許可しないユーザのユーザ名を指定します。

複数のユーザを指定する場合は，「ユーザ名,ユーザ名,…」のように半角コンマ（,）区切りで指定します。半角コンマ前後の半角スペースやタブ文字は無視されます。

また，空のユーザ名（長さ0のユーザ名）も無視されます。次のように指定した場合は，空文字を無視してFTP受付が正常に起動します。

urecp-ftp.permission.deny = <ユーザ名1>,
urecp-ftp.permission.deny = <ユーザ名1>,△
urecp-ftp.permission.deny = <ユーザ名1>,△,<ユーザ名2>
urecp-ftp.permission.deny = <ユーザ名1>,,,,,,,,,,<ユーザ名2>
urecp-ftp.permission.deny = ,<タブ文字><ユーザ名1><タブ文字>,<タブ文字><タブ文字>

（凡例）

△：半角スペースを示します。

なお，次に示す形式のユーザ名を指定する場合は，前後をタブ文字で囲んでください。

半角コンマ（,）の文字を含むユーザ名

先頭または末尾に半角スペースがあるユーザ名

注意事項

このプロパティで指定したユーザは，urecp-ftp.permission.allowプロパティ（実行を許可するユーザ名）でユーザ名を指定，または半角アスタリスク（*）を指定されていても，FTP受付に関連づけられたビジネスプロセスの実行は許可されません。

(4)　記述例

記述例を次に示します。

すべてのユーザを許可する場合（デフォルト）

urecp-ftp.permission.allow=*

なお，FTP受付コンフィグファイルで，urecp-ftp.permission-def.filepathプロパティ（FTP実行許可リスト定義ファイルのパス）を指定しない場合も，すべてのユーザが許可されます。

ユーザ名「root」およびユーザ名「admin」だけを許可する場合

urecp-ftp.permission.allow=root,admin

ユーザ名「guest1」およびユーザ名「guest2」以外のユーザを許可する場合

urecp-ftp.permission.allowプロパティ（実行を許可するユーザ名）を指定する場合

urecp-ftp.permission.allow=*
urecp-ftp.permission.deny=guest1,guest2

urecp-ftp.permission.allowプロパティを省略する場合

urecp-ftp.permission.deny=guest1,guest2

6.8.8　ファイル操作アダプタ実行環境プロパティファイル

(1)　形式

［messagelog-level={0｜10｜20}］

［methodtrace-level={1｜2｜3｜4｜5}］
［methodtrace-filenum=保守用ログの面数］
［methodtrace-filesize=保守用ログの1面当たりの最大サイズ］

［exptrace-filenum=例外ログの面数］
［exptrace-filesize=例外ログの1面当たりの最大サイズ］

［readLock.retry.count=共有ロック取得失敗時のロックリトライ回数］
［readLock.retry.interval=共有ロック取得失敗時のロックリトライ間隔］
［writeLock.retry.count=占有ロック取得失敗時のロックリトライ回数］
［writeLock.retry.interval=占有ロック取得失敗時のロックリトライ間隔］

［transform.limitsize=ファイルの変換を打ち切る入力ファイルのサイズ］
［transform.timeout=ファイルの変換を打ち切るタイムアウト時間］
［compress.inputfile.limitsize=ファイルの圧縮を打ち切る入力ファイルのサイズ］
［compress.outputfile.limitsize=ファイルの圧縮を打ち切る出力ファイルのサイズ］
［compress.timeout=ファイルの圧縮を打ち切るタイムアウト時間］
［extract.inputfile.limitsize=ファイルの伸張を打ち切る入力ファイルのサイズ］
［extract.outputfile.limitsize=ファイルの伸張を打ち切る出力ファイルのサイズ］
［extract.timeout=ファイルの伸張を打ち切るタイムアウト時間］
［writeList.outputfile.limitsize=ファイルの一覧書き込みを打ち切る出力ファイルサイズ］
［read.limitsize=ファイルの読み込みを打ち切る入力ファイルのサイズ］
［write.limitsize=ファイルの書き込みを打ち切る出力ファイルのサイズ］
［write.output-folder-name=共通フォルダ定義名］
［write.output-file-name=出力ファイルパス］
［write.output-mode={new｜append}］
［write.output-file-validation={ON｜OFF}］

(2)　機能

ファイル操作アダプタが実行環境で動作する際のメッセージログとトレースログの出力レベルなどを設定します。

(3)　ファイルの格納先

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥adpfop¥<サービスID>.properties

(4)　設定できるプロパティ

(a)　メッセージログ

messagelog-level={0｜10｜20}　〜<<10>>

メッセージログの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

出力情報

出力レベル

0

10

20

エラー情報

例外または障害の発生原因

○

○

○

警告情報

発生した問題など

△

○

○

インフォメーション

電文や引数の内容

HCSC-Messagingの状態の変更（起動時や終了時）

コマンド受付時と実行完了時

イベントの通知

△

△

△

（凡例）

○：出力されます。

△：重要なログメッセージだけ出力されます。

(b)　保守用ログ

methodtrace-level={1｜2｜3｜4｜5}　〜<<3>>

保守用ログの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

出力情報

出力レベル

1

2

3

4

5

リクエスタサービスメソッドの入口／出口情報（クラス名，メソッド名，引数，戻り値）

×

○

○

○

○

外部（BPなど）のインターフェースの入口／出口情報（クラス名，メソッド名，引数，戻り値）

×

×

○

○

○

コンポーネント内インターフェースの入口／出口情報（クラス名，メソッド名，引数，戻り値）

×

×

×

○

○

デバッグ情報（処理の分岐などの情報）

×

×

×

×

○

（凡例）

○：出力されます。

×：出力されません。

methodtrace-filenum=保守用ログの面数　〜＜数字＞((1−16))<<8>>

保守用ログの面数を指定します。

methodtrace-filesize=保守用ログの1面当たりの最大サイズ　〜＜数字＞((4096−2147483647))<<2097152>>

保守用ログの1面当たりの最大サイズをバイト単位で指定します。

(c)　例外ログ

exptrace-filenum=例外ログの面数　〜＜数字＞((1−16))<<8>>

例外ログの面数を指定します。

exptrace-filesize=例外ログの1面当たりの最大サイズ　〜＜数字＞((4096−2147483647))<<2097152>>

例外ログの1面当たりの最大サイズをバイト単位で指定します。

(d)　排他取得

readLock.retry.count=共有ロック取得失敗時のロックリトライ回数　〜＜数字＞((0−1024))<<0>>

共有ロック取得失敗時のロックリトライ回数を指定します。

readLock.retry.interval=共有ロック取得失敗時のロックリトライ間隔　〜＜数字＞((1−1024))<<1>>

共有ロック取得失敗時のロックリトライ間隔を秒単位で指定します。

writeLock.retry.count=占有ロック取得失敗時のロックリトライ回数　〜＜数字＞((0−1024))<<0>>

占有ロック取得失敗時のロックリトライ回数を指定します。

writeLock.retry.interval=占有ロック取得失敗時のロックリトライ間隔　〜＜数字＞((1−1024))<<1>>

占有ロック取得失敗時のロックリトライ間隔を秒単位で指定します。

(e)　その他

transform.limitsize=ファイルの変換を打ち切る入力ファイルのサイズ　〜＜数字＞((0−2147483647))<<62914560>>

ファイル変換オペレーションで，変換対象とする入力ファイルの上限サイズをバイト単位で指定します。入力ファイルが上限サイズを超える場合，エラーメッセージ（KDEC80051-E）を出力し，処理を終了します。0を指定した場合は，無制限となります。

transform.timeout=ファイルの変換を打ち切るタイムアウト時間　〜＜数字＞((0−86400))<<60>>

ファイル変換オペレーションで，分割処理方式のタイムアウト時間を秒単位で指定します。ファイル変換オペレーションの実行開始から，分割されたすべてのレコードの処理が完了するまでの経過時間が，指定したタイムアウト時間を過ぎた場合，エラーメッセージ（KDEC80052-E）を出力し，処理を終了します。

なお，一括処理方式では指定しても無視されます。

0を指定した場合はタイムアウトしません。

compress.inputfile.limitsize=ファイルの圧縮を打ち切る入力ファイルのサイズ　〜＜数字＞((1−9223372036854775807))<<4294967296>>

ファイル圧縮オペレーションで，圧縮対象とする入力ファイルの上限サイズをバイト単位で指定します。最大値を指定した場合は無制限の扱いとなります。入力ファイルが上限サイズを超える場合，エラーメッセージ（KDEC80105-E）を出力し，処理を終了します。

compress.outputfile.limitsize=ファイルの圧縮を打ち切る出力ファイルのサイズ　〜＜数字＞((1−9223372036854775807))<<4294967296>>

ファイル圧縮オペレーションで，圧縮対象とする出力ファイルの上限サイズをバイト単位で指定します。最大値を指定した場合は無制限の扱いとなります。出力ファイルが上限サイズを超える場合，エラーメッセージ（KDEC80106-E）を出力し，処理を終了します。

compress.timeout=ファイルの圧縮を打ち切るタイムアウト時間　〜＜数字＞((0−86400))<<60>>

ファイル圧縮オペレーションで，圧縮のタイムアウト時間を秒単位で指定します。ファイル圧縮オペレーションの実行開始からファイルの圧縮までの時間が，ここで指定したタイムアウト時間を過ぎた場合，エラーメッセージ（KDEC80107-E）を出力し，処理を終了します。

0を指定した場合はタイムアウトしません。

extract.inputfile.limitsize=ファイルの伸張を打ち切る入力ファイルのサイズ　〜＜数字＞((1−9223372036854775807))<<4294967296>>

ファイル伸張オペレーションで，伸張対象とする入力ファイルの上限サイズをバイト単位で指定します。最大値を指定した場合は無制限の扱いとなります。入力ファイルが上限サイズを超える場合，エラーメッセージ（KDEC80126-E）を出力し，処理を終了します。

extract.outputfile.limitsize=ファイルの伸張を打ち切る出力ファイルのサイズ　〜＜数字＞((1−9223372036854775807))<<4294967296>>

ファイル伸張オペレーションで，伸張対象とする出力ファイルの上限サイズをバイト単位で指定します。最大値を指定した場合は無制限の扱いとなります。出力ファイルが上限サイズを超える場合，エラーメッセージ（KDEC80127-E）を出力し，処理を終了します。

extract.timeout=ファイルの伸張を打ち切るタイムアウト時間　〜＜数字＞((0−86400))<<60>>

ファイル伸張オペレーションで，伸張のタイムアウト時間を秒単位で指定します。ファイル伸張オペレーションの実行開始からファイルの伸張までの時間が，ここで指定したタイムアウト時間を過ぎた場合，エラーメッセージ（KDEC80128-E）を出力し，処理を終了します。

0を指定した場合はタイムアウトしません。

writeList.outputfile.limitsize=ファイルの一覧書き込みを打ち切る出力ファイルサイズ　〜＜数字＞((0−214743647))<<62914560>>

ファイル一覧書き込みオペレーションで，ファイル一覧情報を出力するファイルの上限サイズをバイト単位で指定します。出力ファイルが上限サイズを超える場合，エラーメッセージ（KDEC80182-E）を出力し，処理を終了します。0を指定した場合は，無制限となります。

read.limitsize=ファイルの読み込みを打ち切る入力ファイルのサイズ　〜＜数字＞((1−9223372036854775807))<<4294967296>>

ファイル読み込みオペレーションで読み込める入力ファイルの上限サイズをバイト単位で指定します。最大値を指定した場合は，無制限となります。

write.limitsize=ファイルの書き込みを打ち切る出力ファイルのサイズ　〜＜数字＞((1−9223372036854775807))<<4294967296>>

ファイル書き込みオペレーションで書き込める出力ファイルの上限サイズをバイト単位で指定します。最大値を指定した場合は，無制限となります。

write.output-folder-name=共通フォルダ定義名　〜＜文字列＞

ファイル書き込みオペレーションの要求電文（ヘッダ）が省略された場合に適用される，共通フォルダ定義名を指定します。要求電文（ヘッダ）のoutput-folder-nameの指定値の代わりとなります。作業フォルダで指定しても無効になります。

要求電文（ヘッダ）の指定がある場合は，このプロパティの指定は無視されます。要求電文とこのプロパティの両方とも指定されていない場合は，ファイル書き込みオペレーション実行時にエラーになります。

write.output-file-name=出力ファイルパス　〜＜文字列＞

ファイル書き込みオペレーションの要求電文（ヘッダ）が省略された場合に適用される，出力ファイルパスを指定します。要求電文（ヘッダ）のoutput-file-nameの指定値の代わりとなります。作業フォルダで指定しても無効になります。

出力ファイルパスは，共通フォルダからの相対パスで指定します。また，出力ファイルパスには次に示す記号は使用できません。

円マーク（¥）

スラッシュ（/）

コロン（:）

アスタリスク（*）

クエスチョンマーク（?）

ダブルクォーテーション（"）

左アングルブラケット（<）

右アングルブラケット（>）

パイプライン（|）

要求電文（ヘッダ）の指定がある場合は，このプロパティの指定は無視されます。要求電文とこのプロパティの両方とも指定されていない場合は，ファイル書き込みオペレーション実行時にエラーになります。

write.output-mode={new｜append}　〜<<new>>

ファイル書き込みオペレーションの要求電文（ヘッダ）が省略された場合に適用される，ファイルの出力方式を指定します。要求電文（ヘッダ）のoutput-modeの指定値の代わりとなります。

new

ファイルを新規作成します。既存のファイルがある場合は上書きします。

append

既存のファイルの末尾に追加します。

要求電文（ヘッダ）の指定がある場合は，このプロパティの指定は無視されます。

write.output-file-validation={ON｜OFF}　〜<<OFF>>

ファイル書き込みオペレーションの要求電文（ヘッダ）が省略された場合に適用される，ファイルの検証有無を指定します。要求電文（ヘッダ）のoutput-file-validationの指定値の代わりとなります。

ON

出力ファイルを検証します。

OFF

出力ファイルを検証しません。

要求電文（ヘッダ）の指定がある場合は，このプロパティの指定は無視されます。

(5)　記述例

記述例を次に示します。

messagelog-level=10
methodtrace-level=3
methodtrace-filenum=8
methodtrace-filesize=2097152
  ：

6.8.9　リストコマンドオプション定義ファイル

(1)　形式

［<オプション文字列1>］
［<オプション文字列2>］
　　　　　：
［<オプション文字列n>］

(2)　機能

FTPクライアントが実行するリストコマンド（LISTコマンドおよびNLSTコマンド）の引数となるオプション文字列を1行ずつ設定します。複数のオプション文字列を設定できますが，1つのコマンドに適用されるオプション文字列は1つだけです。

リストコマンドオプション定義ファイルを定義しない場合と定義した場合の，リストコマンドの実行形式の違いを次に示します。△は1文字の半角スペースを示します。

リストコマンドオプション定義ファイルを定義しない場合

リストコマンドの実行形式は次のとおりです。

LIST［△<パス>］
NLST［△<パス>］

この場合，リストコマンドの引数で指定された情報は，すべてパス情報と解釈されます。

リストコマンドオプション定義ファイルを定義した場合

リストコマンドオプションとして<オプション文字列>を定義しておくことで，次の実行形式のリストコマンドを実行できます。

LIST［△<オプション文字列>］［△<パス>］
NLST［△<オプション文字列>］［△<パス>］

リストコマンドの引数に指定した情報は，FTP受付がリストコマンドオプション定義ファイルの定義に従って<オプション文字列>と<パス>に分割し，実行されます。

(3)　ファイルの格納先

リストコマンドオプション定義ファイルは，テンプレートファイルがないため，ファイルを新規に作成してください。

リストコマンドオプション定義ファイルの格納先となるパスおよびファイル名は任意です。

ただし，リストコマンドオプション定義ファイルの格納場所は，FTP受付コンフィグファイルのurecp-ftp.list-command-option.filepathプロパティに絶対パスで指定する必要があります。urecp-ftp.list-command-option.filepathプロパティを省略した場合は，次のディレクトリに格納されているリストコマンドオプション定義ファイル（ftp_command_option.txt）が利用されます。次のディレクトリにリストコマンドオプション定義ファイルが格納されていない場合，リストコマンドの引数で指定された情報は，すべてパス情報と解釈されます。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥FTP¥config¥common

(4)　設定できるプロパティ

<オプション文字列>　〜＜文字列＞

リストコマンドの引数で指定できるオプション文字列を設定します。

使用できる文字は，半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」），および半角スペース（ASCIIコードの「0x20」）です。大文字と小文字は区別されます。先頭および末尾に半角スペースおよびタブ文字は指定できません。

使用できる半角記号を次に示します。

感嘆符（!）

ダブルクォーテーション（"）

番号記号（#）

ドル記号（$）

パーセント（%）

アンパサンド（&）

アポストロフィ（'）

始め小括弧（(）

終わり小括弧（)）

アスタリスク（*）

正符号（+）

コンマ（,）

ハイフン（-）

ピリオド（.）

スラッシュ（/）

コロン（:）

セミコロン（;）

左アングルブラケット（<）

右アングルブラケット（>）

等号（=）

クエスチョンマーク（?）

単価記号（@）

始め角括弧（[）

終わり角括弧（]）

円マーク（¥）

アクサンシルコンフレックス（^）

アンダーバー（_）

アクサングラーブ（`）

始め波括弧（{）

終わり波括弧（}）

パイプライン（|）

波ダッシュ（~）

(5)　記述例

オプションを「-al」と「-la」のどちらでも指定できるようにしたい場合は，次のように両方の形式のオプション文字列を指定します。

-al
-la

オプションを「-l」と「-L」のどちらでも指定できるようにしたい場合は，次のように両方の形式のオプション文字列を指定します。

-l
-L

(6)　注意事項

リストコマンドオプション定義ファイルの指定内容を変更した場合，指定値を有効にするために，そのリストコマンドオプション定義ファイルを使用しているFTP受付を再起動してください。

オプション文字列の先頭および末尾に半角スペースは指定できません。

指定されたオプション文字列の先頭が「¥」の場合，「¥」はエスケープ文字と解釈され，それ以降の文字列がオプション文字列と見なされます。

なお，オプション文字列の途中に指定した「¥」は，エスケープ文字でなく通常の文字列「¥」と扱われます。

「#」または「¥」で始まるオプション文字列を定義する場合は，その前にエスケープ文字「¥」を付けてください。

エスケープ文字「¥」の直後に半角スペースまたはタブ文字を指定したり，エスケープ文字「¥」だけの行を定義したりすることはできません。指定するとエラーになります。

改行までが値になります。ただし，先頭および末尾の半角スペースおよびタブ文字は無視されます。

指定された文字列の先頭の非空白文字（半角スペースでもタブ文字でもない文字）が"#"の場合，その行はコメントとみなされます。

6.9　ファイルイベント連携で利用するファイル

6.9.1　ファイルイベント受付コンフィグファイル

(1)　形式

[urecp-fileevent.trace.filenum=ファイルイベントトレースの面数]
[urecp-fileevent.trace.filesize=ファイルイベントトレースの1面当たりの最大サイズ]

(2)　機能

ファイルイベント受付のセットアップ後に，特定のファイルイベント受付に関する構成情報を変更する場合に設定します。変更頻度が高い情報を設定する場合にも使用します。

(a)　ファイルの種類

ファイルイベント受付コンフィグファイルには次の種類があります。同じプロパティが両方のファイルに設定されている場合，ファイルイベント受付コンフィグファイルのプロパティ値が適用されます。

ファイルイベント受付コンフィグファイル

有効範囲：特定のファイルイベント受付

ファイルイベント受付共通コンフィグファイル

有効範囲：すべてのファイルイベント受付

作成手順については「6.9.2　ファイルイベント受付共通コンフィグファイル」を参照してください。

(b)　作成手順

ファイルイベント受付コンフィグファイルは次の手順で作成してください。

次のテンプレートファイルを基に，ファイルイベント受付コンフィグファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-reception¥fileevent¥config¥templates¥fileeventrecp_config.properties

編集後のファイルをファイル名「<受付ID>.properties」で次のディレクトリに格納します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-reception¥fileevent¥config¥

作成したファイルはファイルイベント受付の開始時に読み込まれ，設定内容が有効になります。

(3)　設定できるプロパティ

urecp-fileevent.trace.filenum=ファイルイベントトレースの面数　〜＜数字＞((1−16))<<8>>

ファイルイベントトレースの面数を指定します。

プロパティ名と値のどちらかが省略された場合はデフォルト値で動作します。数字以外の値や範囲外の値が指定された場合はエラーとなります。

urecp-fileevent.trace.filesize=ファイルイベントトレースの1面当たりの最大サイズ　〜＜数字＞((4096−2147483647))<<2097152>>

ファイルイベントトレースの1面当たりの最大サイズをバイト単位で指定します。

プロパティ名と値のどちらかが省略された場合はデフォルト値で動作します。数字以外の値や範囲外の値が指定された場合はエラーとなります。

(4)　記述例

ファイルイベント受付コンフィグファイルの記述例を次に示します。

urecp-fileevent.trace.filenum=8
urecp-fileevent.trace.filesize=2097152

6.9.2　ファイルイベント受付共通コンフィグファイル

(1)　形式

ファイルの記述形式はファイルイベント受付コンフィグファイルと同じです。記述形式については，「6.9.1　ファイルイベント受付コンフィグファイル」を参照してください。

(2)　機能

すべてのファイルイベント受付に共通する構成情報を設定します。

(a)　ファイルの種類

ファイルイベント受付コンフィグファイルには次の種類があります。同じプロパティが両方のファイルに設定されている場合，ファイルイベント受付コンフィグファイルのプロパティ値が適用されます。

ファイルイベント受付コンフィグファイル

有効範囲：特定のファイルイベント受付

作成手順については「6.9.1　ファイルイベント受付コンフィグファイル」を参照してください。

ファイルイベント受付共通コンフィグファイル

有効範囲：すべてのファイルイベント受付

(b)　作成手順

ファイルイベント受付共通コンフィグファイルは次の手順で作成してください。

次のテンプレートファイルを基に，ファイルイベント受付共通コンフィグファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-reception¥fileevent¥config¥templates¥fileeventrecp_config.properties

編集後のファイルをファイル名「fileeventrecp_config.properties」で次のディレクトリに格納します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-reception¥fileevent¥config¥common¥

作成したファイルはファイルイベント受付の開始時に読み込まれ，設定内容が有効になります。

(3)　設定できるプロパティ

設定できるプロパティはファイルイベント受付コンフィグファイルと同じです。記述形式については，「6.9.1　ファイルイベント受付コンフィグファイル」を参照してください。

(4)　記述例

記述例はファイルイベント受付コンフィグファイルと同じです。記述形式については，「6.9.1　ファイルイベント受付コンフィグファイル」を参照してください。

6.10　ファイルアダプタで利用するファイル

6.10.1　ファイルアダプタ実行環境プロパティファイル

(1)　形式

［message.level={0｜10｜20}］
［methodtrace.level={0｜10｜20｜30}］
［methodtracefile.size=メソッドトレースの出力サイズ］
［methodtracefile.num=メソッドトレースの出力面数］
　fileaccess.path1=入出力許可ファイルパス1
［fileaccess.path2=入出力許可ファイルパス2］
［fileaccess.path3=入出力許可ファイルパス3］
［fileaccess.path4=入出力許可ファイルパス4］
［fileaccess.path5=入出力許可ファイルパス5］
［fileaccess.maxsize=入力ファイル最大サイズ］
　character.code={MS932｜UTF8｜UTF16_BIG｜UTF16_LITTLE｜JIS｜KEIS+EBCDIC｜KEIS+EBCDIK}
［codetable.path=変換テーブル格納パス］

(2)　機能

ファイルアダプタ実行環境プロパティファイルは，ファイルアダプタが実行環境で動作するときのメッセージログおよびトレースログの出力レベルなどを定義します。サンプルファイルを利用して作成します。

サンプルファイルの格納先を次に示します。

<実行環境のサービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥File¥config¥templates¥adpff_exe.properties

ファイルアダプタ実行環境プロパティファイルの作成手順を次に示します。

サンプルファイルをコピーして，次のディレクトリに格納します。

<実行環境のサービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥File¥config

ファイル名を<サービスID>.propertiesに変更します。

定義内容を編集して保存します。

ファイルアダプタ実行環境プロパティファイルは，ファイルアダプタを開始する際に実行環境に反映されます。ファイルアダプタ実行環境プロパティファイルの内容を変更する場合は，ファイルアダプタを停止してから作業をします。ファイルアダプタを再開始すると，変更内容が実行環境に反映されます。

(3)　設定できるプロパティ

message.level={0｜10｜20}　〜<<10>>

メッセージログの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

情報種別

出力レベル

0

10

20

エラー情報

○

○

○

警告情報

△

○

○

インフォメーション

△

△

○

（凡例）

○：すべて出力されます。

△：重要なメッセージログだけ出力されます。

methodtrace.level={0｜10｜20｜30}　〜<<10>>

メソッドトレースの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

情報種別

出力レベル

0

10

20

30

メソッド内のエラー

○

○

○

○

外部から呼び出されるメソッド情報およびファイル入出力メソッドの開始・終了情報

×

○

○

○

ほかのHCSCコンポーネントから参照するpublicメソッドの開始・終了情報

×

×

○

○

ほかのHCSCコンポーネントから参照しない内部メソッド（public以外のメソッド）の開始・終了情報

×

×

×

○

（凡例）

○：出力されます。

×：出力されません。

methodtracefile.size=メソッドトレースの出力サイズ　〜＜数字＞((4096−2147483647))<<4194304>>

ファイルアダプタが取得するメソッドトレース情報の出力ファイルサイズをバイト単位で指定します。

methodtracefile.num=メソッドトレースの出力面数　〜＜数字＞((1−16))<<4>>

ファイルアダプタが取得するメソッドトレース情報の出力ファイル面数を指定します。2面以上を推奨します。

fileaccess.path((1−5))=入出力許可ファイルパス

ファイル入出力を許可するディレクトリの絶対パスを指定します。これらのキーに指定されたディレクトリ配下でファイルの入出力ができます。また，サブディレクトリを作成できます。

ファイル入出力を許可するディレクトリの絶対パスは5つまで指定できます。

fileaccess.maxsize=入力ファイル最大サイズ〜＜数字＞((1−524288000))<<4194304>>

読み込みを行うファイルの最大サイズを指定します。

character.code={MS932｜UTF8｜UTF16_BIG｜UTF16_LITTLE｜JIS｜KEIS+EBCDIC｜KEIS+EBCDIK}

バイナリデータの文字コードを指定します。このプロパティを設定した場合は，必ず「codetable.path」プロパティを設定してください。このプロパティはファイル形式が固定長形式，レングスタグ形式，またはセパレータ形式で，書き込みモードの機能を実行する場合に設定してください。

codetable.path=変換テーブル格納パス

コード変換機能の変換テーブル（ユーザマッピングファイル）の格納パスとして，ユーザマッピングファイルのカスタマイズの有無に応じて次に示すパスを指定します。なお，パス指定時はディレクトリ区切りとして「¥¥」を使用してください。

ユーザマッピングファイルをカスタマイズしないで，標準値で利用する場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥lib¥external¥table

Code Converterを利用して，任意にカスタマイズしたユーザマッピングファイルを利用する場合

Code Converterの変換テーブル（ユーザマッピングファイル）の格納パス

このプロパティを設定した場合は，必ず「character.code」プロパティを設定してください。このプロパティはファイル形式が固定長形式，レングスタグ形式，またはセパレータ形式で，書き込みモードの機能を実行する場合に設定してください。

(4)　注意事項

パスを指定する場合の注意事項を次に示します。

相対パス，親ディレクトリ表現（「..¥」，「../」），およびカレントディレクトリ表現（「.¥」，「./」）を含むパスは指定できません。

シンボリックリンクを含むパスは指定しないでください。

Windowsの場合，UNC形式，NTFSのストリーム名，および予約デバイス名を含むパスは指定できません。また，パスの大文字と小文字は区別されません。なお，パスのディレクトリ区切りは「¥¥」を使用してください。

パス長はUTF-8で変換した際に1〜198バイトの範囲で指定できます。

6.11　Object Accessアダプタで利用するファイル

6.11.1　Object Accessアダプタ実行環境プロパティファイル

(1)　形式

［message.level={0｜10｜20}］
［trace.level={0｜10｜20｜30}］
［methodtracefile.size=メソッドトレースの出力サイズ］
［methodtracefile.num=メソッドトレースの出力面数］
［datatracefile.size=データトレースの出力サイズ］
［datatracefile.num=データトレースの出力面数］
［exptracefile.size=例外ログの出力サイズ］
［exptracefile.num=例外ログの出力面数］

(2)　機能

Object Accessアダプタが実行環境で動作する際に出力される，ログやトレースの情報を定義します。

Object Accessアダプタ実行環境プロパティファイルは次の手順で作成してください。

次のテンプレートファイルを基に，Object Accessアダプタ実行環境プロパティファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥OA¥config¥templates¥adpoa.properties

編集後のObject Accessアダプタ実行環境プロパティファイルを次に示すファイル名で保存します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥OA¥config¥<サービスID>.properties

Object Access実行環境プロパティファイルは，Object Accessアダプタの開始時に実行環境に反映されます。

Object Access実行環境プロパティファイルの内容を変更する場合は，Object Accessアダプタを停止してから変更してください。変更後は，変更内容を実行環境に反映するためにObject Accessアダプタを再開始してください。

(3)　設定できるプロパティ

message.level={0｜10｜20}　〜<<10>>

メッセージログの出力レベルを指定します。

指定できる出力レベルと，出力レベルに対応する出力情報を次の表に示します。

情報種別

出力レベル

0

10

20

エラー情報

○

○

○

警告情報

△

○

○

インフォメーション

△

△

○

（凡例）

○：すべて出力します。

△：重要なログメッセージだけ出力します。

trace.level={0｜10｜20｜30}　〜<<10>>

メソッドトレースおよびデータトレースの出力レベルを指定します。

指定できる出力レベルと，出力レベルに対応する出力情報を次の表に示します。

情報種別

出力レベル

0

10

20

30

外部から呼び出されるメソッド情報

×

○

○

○

外部メソッドのうち，引数を持つメソッド，または通信をするメソッドの呼び出し情報

×

○

○

○

外部メソッドの呼び出し情報，およびほかのコンポーネントから参照するpublicメソッドの開始・終了情報

×

×

○

○

ほかのコンポーネントから参照しない内部メソッド（public以外のメソッド）の開始・終了情報

×

×

×

○

メソッド内のエラー

○

○

○

○

（凡例）

○：出力します。

×：出力しません。

methodtracefile.size=メソッドトレースの出力サイズ　〜＜符号なし数字＞((4096−2147483647))<<4194304>>

Object Accessアダプタが取得するメソッドトレース情報の出力ファイルサイズをバイト単位で指定します。

methodtracefile.num=メソッドトレースの出力面数　〜＜符号なし数字＞((1−16))<<4>>

Object Accessアダプタが取得するメソッドトレース情報の出力ファイル面数を指定します。「2」以上を推奨します。

datatracefile.size=データトレースの出力サイズ　〜＜符号なし数字＞((4096−2147483647))<<1048576>>

Object Accessアダプタが取得するデータトレース情報の出力ファイルサイズをバイト単位で指定します。

datatracefile.num=データトレースの出力面数　〜＜符号なし数字＞((1−16))<<4>>

Object Accessアダプタが取得するデータトレース情報の出力ファイル面数を指定します。「2」以上を推奨します。

exptracefile.size=例外ログの出力サイズ　〜＜符号なし数字＞((4096−2147483647))<<4194304>>

Object Accessアダプタが取得する例外情報の出力ファイルサイズをバイト単位で指定します。

exptracefile.num=例外ログの出力面数　〜＜符号なし数字＞((1−16))<<4>>

Object Accessアダプタが取得する例外情報の出力ファイル面数を指定します。

(4)　記述例

指定値を省略する場合はキー名を含めて省略してください。キー名だけを記述し値を省略することはできません。trace.levelを省略する場合の記述例を次に示します。

正しい記述方法

　　：
message.level=20
methodtracefile.size=4194304
　　：

誤った記述方法（trace.levelの値が指定されていない）

　　：
message.level=20
trace.level=
methodtracefile.size=4194304
　　：

6.12　Message Queueアダプタで利用するファイル

6.12.1　Message Queueアダプタ実行環境プロパティファイル

(1)　形式

［message.level={0｜10｜20}］
［trace.level={0｜10｜20｜30}］
［methodtracefile.size=メソッドトレースの出力サイズ］
［methodtracefile.num=メソッドトレースの出力面数］
［datatracefile.size=データトレースの出力サイズ］
［datatracefile.num=データトレースの出力面数］
　codetable.path=変換テーブル格納パス
［exptracefile.size=例外ログの出力サイズ］
［exptracefile.num=例外ログの出力面数］
［transaction.local={true｜false}］

(2)　機能

Message Queueアダプタが実行環境で動作する際に出力される，ログやトレースの情報を定義します。

Message Queueアダプタ実行環境プロパティファイルは次の手順で作成してください。

次のテンプレートファイルを基に，Message Queueアダプタ実行環境プロパティファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥MQ¥config¥templates¥adpmq.properties

編集後のMessage Queueアダプタ実行環境プロパティファイルを次に示すファイル名で保存します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥MQ¥config¥<サービスID>.properties

Message Queueアダプタ実行環境プロパティファイルは，Message Queueアダプタの開始時に実行環境に反映されます。

Message Queueアダプタ実行環境プロパティファイルの内容を変更する場合は，Message Queueアダプタを停止してから変更してください。変更後は，変更内容を実行環境に反映するためにMessage Queueアダプタを再開始してください。

(3)　設定できるプロパティ

message.level={0｜10｜20}　〜<<10>>

メッセージログの出力レベルを指定します。メッセージログの出力レベルを次に示します。

表6‒5　出力レベルと出力情報の対応

情報種別

出力レベル

0

10

20

エラー情報

○

○

○

警告情報

△

○

○

インフォメーション

△

△

○

（凡例）

○：すべて出力します。

△：重要なログメッセージだけ出力します。

trace.level={0｜10｜20｜30}　〜<<10>>

メソッドトレースとデータトレースの出力レベルを指定します。

メソッドトレースの出力レベルを次に示します。

情報種別

出力レベル

0

10

20

30

外部から呼び出されるメソッド情報およびメッセージ送信・受信入出力メソッドの開始・終了情報

×

○

○

○

ほかのHCSCコンポーネントから参照するpublicメソッドの開始・終了情報

×

×

○

○

ほかのHCSCコンポーネントから参照しない内部メソッド（public以外のメソッド）の開始・終了情報

×

×

×

○

メソッド内のエラー

○

○

○

○

（凡例）

○：出力します。

×：出力しません。

データトレースの出力レベルを次に示します。

情報種別

出力レベル

0

10

20

30

メッセージ送受信要求データ情報

×

×

×

○

メッセージ送受信応答データ情報

×

×

○

○

Fault情報のDetail情報

○

○

○

○

メッセージ送信失敗および受信メッセージのXML形式変換失敗

○

○

○

○

（凡例）

○：出力します。

×：出力しません。

データトレースの出力レベルを20以上にした場合のメリットとデメリットを次に示します。メリット，デメリットを考慮して出力レベルを指定してください。

表6‒6　データトレース出力レベルのメリット・デメリット

メリット・デメリット

出力レベル

10

20以上

メリット

データトレースはエラーが発生した場合だけ出力されます。そのため，出力レベル20以上と比べると，格段に処理性能が良くなります。

データトレースを出力するディスク容量は要求エラーの発生回数分であるため少量で済みます。

メッセージ受信やメッセージ送受信要求が失敗した場合，ユーザデータが紛失するおそれがあります。

この場合，データトレースから復旧できます。

デメリット

メッセージ受信やメッセージ送受信要求が失敗した場合，ユーザデータが紛失するおそれがあります。

この場合，紛失したユーザデータを回復できなくなります。

ユーザデータがデータトレースに出力されます。そのため，出力レベル10と比べると処理性能が大幅に劣化します。

データトレースを出力するディスク容量にはメッセージ送受信量に応じた容量が必要になります。

methodtracefile.size=メソッドトレースの出力サイズ　〜＜符号なし数字＞((4096−2147483647))<<4194304>>

Message Queueアダプタが取得するメソッドトレース情報の出力ファイルサイズを バイト単位で指定します。

methodtracefile.num=メソッドトレースの出力面数　〜＜符号なし数字＞((1−16))<<4>>

Message Queueアダプタが取得するメソッドトレース情報の出力ファイル面数を指定します。

datatracefile.size=データトレースの出力サイズ　〜＜符号なし数字＞((4096−2147483647))<<1048576>>

Message Queueアダプタが取得するデータトレース情報の出力ファイルサイズをバイト単位で指定します。

datatracefile.num=データトレースの出力面数　〜＜符号なし数字＞((1−16))<<4>>

Message Queueアダプタが取得するデータトレース情報の出力ファイル面数を指定します。

codetable.path=変換テーブル格納パス　〜＜コード変換機能の変換テーブル（ユーザマッピングファイル）の格納パス＞

コード変換機能の変換テーブル（ユーザマッピングファイル）の格納パスを指定します。Windowsの場合，パスのディレクトリ区切りは「¥」ではなく，「¥¥」を使用してください。

バイナリ形式メッセージを送信する場合，要求電文に送信キュー特定情報または受信キュー特定情報を指定する場合は必ず指定してください。

ユーザマッピングファイルのカスタマイズの有無に応じて，次に示すパスを指定してください。

ユーザマッピングファイルをカスタマイズしないで標準値でのユーザマッピングファイルを利用する場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥lib¥external¥table

コード変換機能を利用して任意にカスタマイズしたユーザマッピングファイルを利用する場合

<コード変換機能の変換テーブル（ユーザマッピングファイル）の格納パス>

パスを指定する場合の注意事項を次に示します。

相対パス，親ディレクトリ表現（「..¥」，「../」），カレントディレクトリ表現（「.¥」，「./」）およびシンボリックリンクを含むパスは指定できません。

Windowsの場合，UNC形式，NTFSのストリーム名，および予約デバイス名を含むパスは指定しないでください。また，パスの大文字と小文字は区別されません。

パス長は，UTF-8への変換結果が1〜198バイトになるよう指定してください。

exptracefile.size=例外ログの出力サイズ　〜＜数字＞((4096−2147483647))<<4194304>>

Message Queueアダプタが取得する例外情報（スタックトレース）の出力ファイルサイズをバイト単位で指定します。

exptracefile.num=例外ログの出力面数　〜＜数字＞((1−16))<<4>>

Message Queueアダプタが取得する例外情報（スタックトレース）の出力ファイル面数を指定します。

transaction.local={true｜false}　〜<<true>>

Message Queueアダプタで，トランザクション決着処理を実行するかどうか指定します。リソースアダプタのトランザクションサポートレベルにXATransactionを指定する場合は，falseを設定してください。

また，リソースアダプタのトランザクションサポートレベルにLocalTransactionを指定する場合，falseを指定していると，トランザクションの決着は，ビジネスプロセスのトランザクションをコミットするタイミングで実行されます。

6.13　メールアダプタで利用するファイル

6.13.1　メールアダプタアカウント定義ファイル

メールアダプタアカウント定義ファイルは，メールアダプタからメールサーバに接続するときの認証に必要なユーザ名およびパスワードを管理するためのファイルです。

メールアダプタアカウント定義ファイルは，csmmailaddusrコマンドで指定したパスとファイル名で作成されます。csmmailaddusr（メールアダプタユーザ情報の登録・更新）コマンドの詳細は，「5　コマンド（運用環境・実行環境）」の「csmmailaddusr（メールアダプタユーザ情報の登録・更新）」を参照してください。

作成したメールアダプタアカウント定義ファイルを有効にするには，ファイルの絶対パスをメールアダプタ実行環境プロパティファイルのmailadp.account.file.pathキーに指定する必要があります。

なお，ファイル内容は運用コマンドで管理するため，編集はできません。

6.13.2　メールアダプタコマンド定義ファイル

(1)　形式

［mailadp.command.messagelog.filepath=コマンドメッセージログの出力先ディレクトリ］
［mailadp.command.messagelog.filenum=コマンドメッセージログの面数］
［mailadp.command.messagelog.filesize=コマンドメッセージログの1面当たりの最大サイズ］
［mailadp.command.messagelog.level={10｜20｜30}］

(2)　機能

メールアダプタで使用するコマンドのメッセージログの出力先，出力レベルなどを設定するためのファイルです。

メールアダプタコマンド定義ファイルは「adpmailcommand.properties」というファイル名で作成します。

(3)　ファイルの格納先

テンプレートファイルの場所：

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥mail¥templates¥adpmailcommand.properties

メールアダプタコマンド定義ファイルの格納場所：

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥mail

(4)　設定できるプロパティ

mailadp.command.messagelog.filepath=コマンドメッセージログの出力先ディレクトリ　〜＜文字列（2バイト文字含む）および空白＞

コマンドメッセージログの出力先ディレクトリを絶対パスで指定します。

ディレクトリ区切りは「/」または「¥¥」を使用します。指定を省略した場合，または指定したフォルダが存在しない場合，<サービスプラットフォームのインストールディレクトリ>¥csc¥log¥adapter¥commandに出力されます。

mailadp.command.messagelog.filenum=コマンドメッセージログの面数　〜＜数字＞((1−64))<<2>>

コマンドメッセージログの面数を指定します。

mailadp.command.messagelog.filesize=コマンドメッセージログの1面当たりの最大サイズ　〜＜数字＞((4096−16777216))<<1048576>>

コマンドメッセージログの1面当たりの最大サイズをバイト単位で指定します。

mailadp.command.messagelog.level={10｜20｜30}　〜<<20>>

コマンドメッセージログの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

出力情報

出力内容

出力レベル

10

20

30

エラー情報

例外またはエラーの発生原因

○

○

○

警告情報

発生した問題など

インフォメーション

引数の内容

コマンド受付時と実行完了時

イベントの通知

スタックトレース情報

エラー発生時のスタックトレース

×

○

○

デバッグ情報

エラー発生時のデバッグ情報

×

×

○

（凡例）

○：出力されます。

×：出力されません。

(5)　記述例

メールアダプタコマンド定義ファイルの記述例を次に示します。

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)　注意事項

2バイト文字などは不正な文字列に解釈されるため，次に示すhjdk.native2ascii.jarツールで変換してください。

<サービスプラットフォームのインストールディレクトリ>¥jdk¥bin¥java -jar <サービスプラットフォームのインストールディレクトリ>¥jdk¥lib¥hcompatlib¥hjdk.native2ascii.jar <入力ファイルパス> <出力ファイルパス>

hjdk.native2ascii.jarツールの詳細については，JDKのドキュメントを参照してください。

パスを指定する場合の注意事項を次に示します。

相対パス，親ディレクトリ表現（「..¥」，「../」），およびカレントディレクトリ表現（「.¥」，「./」）を含むパスは指定しないでください。

シンボリックリンクを含むパスは指定しないでください。

Windowsの場合，UNC形式，NTFSのストリーム名，および予約デバイス名を含むパスは指定しないでください。また，パスの大文字と小文字は区別されません。

6.13.3　メールアダプタ実行環境プロパティファイル

(1)　形式

　mailadp.smtp.host.name=接続するメールサーバのIPアドレスまたはホスト名
［mailadp.smtp.port=接続するメールサーバのポート番号］

［mailadp.user=接続するメールサーバのログインユーザ名］
　mailadp.addr.from=メールのFROMフィールドに設定するアドレス
［mailadp.addr.to=メールのTOフィールドに設定するアドレス］
［mailadp.addr.cc=メールのCCフィールドに設定するアドレス］
［mailadp.addr.bcc=メールのBCCフィールドに設定するアドレス］
［mailadp.addr.count.max=設定できるアドレスの最大数］
［mailadp.mail.body.size=メール本文のサイズ］
［mailadp.attach.path.<n>=添付ファイルの絶対パス］
［mailadp.attach.file.size=メールの添付ファイルの最大サイズ］
［mailadp.max.attach.count.per.mail=最大添付ファイル数］
［mailadp.mail.format={text/plain｜text/html｜text/xml}］
［mailadp.mail.body-text=メール本文に挿入するテキスト］
［mailadp.mail.body-filepath=メール本文に挿入するテキストのファイルのパス］
［mailadp.mail.body-filecharset={UTF-8｜MS932}］
［mailadp.subject.size=メール主題のサイズ］
［mailadp.subject.text=メール主題に挿入するテキスト］
［mailadp.smtp.encoding=メール用エンコード］
［mailadp.smtp.auth={LOGIN｜PLAIN}］
［mailadp.user.header.path=メールヘッダ定義ファイルの絶対パス］
［mailadp.account.file.path=メールアダプタアカウント定義ファイルの絶対パス］

［mailadp.methodtrace.level={1｜2｜3｜4｜5}］
［mailadp.methodtrace.filepath=メンテナンスログの出力先ディレクトリ］
［mailadp.methodtrace.filenum=メンテナンスログの面数］
［mailadp.methodtrace.filesize=メンテナンスログの1面当たりの最大サイズ］

［mailadp.messagelog.level={0｜10｜20}］

［mailadp.smtp.timeout=メール送信時のタイムアウト時間］
［mailadp.smtp.connectiontimeout=メールサーバ接続のタイムアウト時間］

［mailadp.read-lock.retry.count=共通フォルダのファイルの共有ロック失敗時のリトライ回数］
［mailadp.read-lock.retry.interval=共通フォルダのファイルの共有ロック失敗時のリトライ間隔］

［mailadp.exptrace.filenum=例外ログファイルの最大出力面数］
［mailadp.exptrace.filesize=例外ログファイルの最大出力ファイルサイズ］

［mailadp.smtps.enable={TRUE｜FALSE}］
［mailadp.smtps.starttls.enable={TRUE｜FALSE}］
［mailadp.smtps.starttls.required={TRUE｜FALSE}］

(2)　機能

(a)　ファイルの種類

メールアダプタ実行環境プロパティファイルは，メールアダプタの構成情報を設定します。

また，1つのマシンに複数のHCSCサーバをセットアップした場合，メールアダプタ実行環境プロパティファイルをHCSCサーバごとに定義することもできます。これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。

プロパティファイル間で同じプロパティが指定された場合，プロパティの優先度は次のようになります。

ファイルの種類

プロパティ重複時の優先度

メールアダプタ実行環境プロパティファイル

（HCSCサーバ単位の指定：あり）

高

メールアダプタ実行環境プロパティファイル

（HCSCサーバ単位の指定：なし）

低

(b)　作成手順

次のテンプレートファイルを基に，メールアダプタ実行環境プロパティファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥mail¥templates¥adpmail.properties

編集後のファイルをファイル名「<サービスID>.properties」で次のディレクトリに格納します。

全HCSCサーバ共通の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥mail

特定のHCSCサーバ用の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥mail¥<HCSCサーバ名>

サブディレクトリ<HCSCサーバ名>を作成する際は，Windowsでは大文字・小文字は区別されないので，注意してください。

サブディレクトリ<HCSCサーバ名>には，HCSCサーバの管理者（Service Coordinator管理者）がアクセスできるよう，適切なアクセス権限を設定してください。

(3)　設定できるプロパティ

(a)　サーバ情報関連

mailadp.smtp.host.name=接続するメールサーバのIPアドレスまたはホスト名

接続するメールサーバのIPアドレスまたはホスト名を指定します。このプロパティは省略できません。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.smtp.port=接続するメールサーバのポート番号　〜＜数字＞((1−65535))<<25>>

接続するメールサーバのポート番号を指定します。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

(b)　メール設定関連

mailadp.user=接続するメールサーバのログインユーザ名

接続するメールサーバのログインユーザ名を設定します。使用できる文字は，半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」），および半角スペース（ASCIIコードの「0x20」）です。大文字と小文字は区別されます。

使用できる半角記号を次に示します。

感嘆符（!）

ダブルクォーテーション（"）

番号記号（#）

ドル記号（$）

パーセント（%）

アンパサンド（&）

アポストロフィ（'）

始め小括弧（(）

終わり小括弧（)）

アスタリスク（*）

正符号（+）

コンマ（,）

ハイフン（-）

ピリオド（.）

スラッシュ（/）

コロン（:）

セミコロン（;）

左アングルブラケット（<）

右アングルブラケット（>）

等号（=）

クエスチョンマーク（?）

単価記号（@）

始め角括弧（[）

終わり角括弧（]）

円マーク（¥）

アクサンシルコンフレックス（^）

アンダーバー（_）

アクサングラーブ（`）

始め波括弧（{）

終わり波括弧（}）

パイプライン（|）

波ダッシュ（~）

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

SMTP認証の型がLOGINの場合はこのプロパティを必ず設定してください。SMTP認証の型がPLAINの場合，設定は不要です。

mailadp.addr.from=メールのFROMフィールドに設定するアドレス

送信メールのFROMフィールドに設定する有効なアドレスを指定します。このプロパティは省略できません。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.addr.to=メールのTOフィールドに設定するアドレス

送信メールのTOフィールドに設定する有効なアドレスを指定します。複数のアドレスを指定する場合は，区切り文字としてコンマ（,）を挿入してください。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.addr.cc=メールのCCフィールドに設定するアドレス

送信メールのCCフィールドに設定する有効なアドレスを指定します。複数のアドレスを指定する場合は，区切り文字としてコンマ（,）を挿入してください。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.addr.bcc=メールのBCCフィールドに設定するアドレス

送信メールのBCCフィールドに設定する有効なアドレスを指定します。複数のアドレスを指定する場合は，区切り文字としてコンマ（,）を挿入してください。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.addr.count.max=設定できるアドレスの最大数　〜＜数字＞((1−2147483647))<<768>>

アドレスフィールドに設定できるアドレスの最大数を指定します。

アドレスの最大数は，TO，CC，およびBCCフィールドに設定するアドレスの合計数を指します。同一のアドレスが複数設定されている場合，それぞれが1件としてカウントされます。

mailadp.mail.body.size=メール本文のサイズ　〜＜数字＞((1−2147483647))<<1024000>>

メール本文のサイズをバイト単位で指定します。

mailadp.attach.path.<n>=添付ファイルの絶対パス

添付ファイルのパスを絶対パスで指定します。<n>には添付ファイルの数に応じて1〜100までの自然数を指定します。指定例を次に示します。

添付ファイルが1つの場合

mailadp.attach.path.1=C:¥¥temp¥¥attach1.txt

添付ファイルが複数の場合

mailadp.attach.path.1= C:¥¥temp¥¥attach1.txt
mailadp.attach.path.2= C:¥¥temp¥¥attach2.txt
：

ディレクトリ区切りは「/」または「¥¥」を使用します。添付ファイルを複数指定する場合，同じファイルを2つ指定したときは同じファイルが2つ添付されます。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.attach.file.size=メールの添付ファイルの最大サイズ　〜＜数字＞((0−2147483647))<<5242880>>

メールの添付ファイル1つの最大サイズをバイト単位で指定します。

mailadp.max.attach.count.per.mail=最大添付ファイル数　〜＜数字＞((0−2147483647))<<10>>

1つのメールに添付できるファイルの最大数を指定します。

mailadp.mail.format={text/plain｜text/html｜text/xml}　〜<<text/plain>>

メールのフォーマットとして，text/plain，text/htmlまたはtext/xml※を指定します。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

注※

text/xmlを指定した場合，メールアダプタではプレーンテキスト形式で表示されます。

mailadp.mail.body-text=メール本文に挿入するテキスト

メール本文に挿入するテキストを設定します。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.mail.body-filepath=メール本文に挿入するテキストのファイルのパス

任意のファイルパスを指定します。ここで設定したファイルのテキストがメール本文に読み込まれます。ディレクトリ区切りは「/」または「¥¥」を使用します。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.mail.body-filecharset={UTF-8｜MS932}　〜<<UTF-8>>

mailadp.mail.body-filepathキーで指定したファイルの文字セットを指定します。大文字と小文字は区別されません。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.subject.size=メール主題のサイズ　〜＜数字＞((0−2147483647))<<80>>

メール主題のサイズを指定します。主題の文字数が指定したサイズを超えた場合，超えた文字が切り落とされます。

mailadp.subject.text=メール主題に挿入するテキスト

メール主題に挿入するテキストを指定します。設定しない場合，主題なしのメールが送信されます。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.smtp.encoding=メール用エンコード　〜<<ISO-2022-JP>>

メール用エンコードを指定します。設定されたエンコードがメール送信中に使用されます。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.smtp.auth={LOGIN｜PLAIN}　〜<<PLAIN>>

メールサーバに対する認証の型を指定します。大文字と小文字は区別されません。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.user.header.path=メールヘッダ定義ファイルの絶対パス

メールヘッダ定義ファイルのパスを絶対パスで指定します。ディレクトリ区切りは「/」または「¥¥」を使用します。

メールアダプタの要求電文フォーマットでも設定できます。重複して指定されている場合，要求電文フォーマットの値が有効になります。

mailadp.account.file.path=メールアダプタアカウント定義ファイルの絶対パス

メールアダプタアカウント定義ファイルのパスを絶対パスで指定します。ディレクトリ区切りは「/」または「¥¥」を使用します。

(c)　メンテナンスログ関連

mailadp.methodtrace.level={1｜2｜3｜4｜5}　〜<<3>>

メンテナンスログの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

出力情報

出力レベル※

1

2

3

4

5

エラー情報（例外発生原因）

○

○

○

○

○

リクエスタサービスメソッドの入口／出口情報（クラス名，メソッド名，引数，戻り値）

×

○

○

○

○

外部（BPなど）のインターフェースの入口／出口情報（クラス名，メソッド名，引数，戻り値）

×

×

○

○

○

コンポーネント内インターフェースの入口／出口情報（クラス名，メソッド名，引数，戻り値）

×

×

×

○

○

メール送信情報（メールサーバの接続，メールの詳細，メッセージトレース）

×

×

×

○

○

デバッグ情報（処理の分岐などの情報）

×

×

×

×

○

（凡例）

○：出力されます。

×：出力されません。

注※

メンテナンスログの出力レベルに4または5を指定した場合，メール送信に使用するメールアドレスが出力されます。

mailadp.methodtrace.filepath=メンテナンスログの出力先ディレクトリ

メンテナンスログの出力先ディレクトリを絶対パスで指定します。このディレクトリに例外ログも出力されます。ディレクトリ区切りは「/」または「¥¥」を使用します。

指定したフォルダが存在しない場合は，<J2EEサーバの作業ディレクトリ>¥ejb¥<J2EEサーバ名>¥logs¥CSCADP¥MAILADP¥maintenance¥<サービスID>に出力されます。

なお，<J2EEサーバの作業ディレクトリ>¥ejb¥<J2EEサーバ名>¥logsはusrconf.cfg（J2EEサーバ用オプション定義ファイル）のejb.server.log.directoryキーで変更できます。usrconf.cfgの詳細は，マニュアル「アプリケーションサーバ リファレンス 定義編(サーバ定義)」の「2.2.2　usrconf.cfg（J2EEサーバ用オプション定義ファイル）」を参照してください。

mailadp.methodtrace.filenum=メンテナンスログの面数　〜＜数字＞((1−16))<<8>>

メンテナンスログの面数を指定します。

mailadp.methodtrace.filesize=メンテナンスログの1面当たりの最大サイズ　〜＜数字＞((4096−147483647))<<2097152>>

メンテナンスログの1面当たりの最大サイズをバイト単位で指定します。

(d)　メッセージログ関連

mailadp.messagelog.level={0｜10｜20}　〜<<10>>

メッセージログの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

出力情報

出力内容

出力レベル

0

10

20

エラー情報

例外または障害の発生原因

○

○

○

警告情報

発生した問題など

×

○

○

インフォメーション

電文や引数の内容

HCSC-Messagingの状態の変更（起動時や終了時）

コマンド受付時と実行完了時

イベントの通知

×

×

○

（凡例）

○：出力されます。

×：出力されません。

(e)　再接続関連

mailadp.smtp.timeout=メール送信時のタイムアウト時間　〜＜数字＞((0−3600))<<180>>

メール送信時のタイムアウト時間を秒単位で指定します。0を指定した場合は，タイムアウトしません。

このプロパティの値は，SMTPサーバへメールの送信時に使用するJavaMailのセッションプロパティ"mail.smtp.timeout"へ設定します。

mailadp.smtp.connectiontimeout=メールサーバ接続のタイムアウト時間　〜＜数字＞((0−86400))<<180>>

メールサーバ接続のタイムアウト時間を秒単位で指定します。0を指定した場合は，タイムアウトしません。

このプロパティの値は，SMTPサーバへメールの送信時に使用するJavaMailのセッションプロパティ"mail.smtp.connectiontimeout"へ設定します。

(f)　排他取得タイムアウト関連

mailadp.read-lock.retry.count=共通フォルダのファイルの共有ロック失敗時のリトライ回数　〜＜数字＞((0−1024))<<0>>

共通フォルダのファイルの共有ロックに失敗した場合のリトライ回数を指定します。

mailadp.read-lock.retry.interval=共通フォルダのファイルの共有ロック失敗時のリトライ間隔　〜＜数字＞((1−1024))<<1>>

共通フォルダのファイルの共有ロックに失敗した場合のリトライ間隔を秒単位で指定します。

(g)　例外ログ関連

例外ログはメンテナンスログと同じディレクトリに出力されます。出力先の指定方法についてはmailadp.methodtrace.filepathプロパティを参照してください。

mailadp.exptrace.filenum=例外ログファイルの最大出力面数　〜＜数字＞((1−16))<<8>>

例外ログファイルの最大出力面数を指定します。

mailadp.exptrace.filesize=例外ログファイルの最大出力ファイルサイズ　〜＜数字＞((4096−2147483647))<<2097152>>

例外ログファイルの最大出力ファイルサイズをバイト単位で指定します。

(h)　TLS関連

mailadp.smtps.enable={TRUE｜FALSE}　〜<<FALSE>>

SMTPサーバとの接続にTLSを使用するかどうかを指定します。大文字と小文字は区別されません。

TRUE

TLSを使用してSMTPサーバに接続します。

FALSE

TLSを使用しません。SMTPでSMTPサーバに接続します。

mailadp.smtps.starttls.enable={TRUE｜FALSE}　〜<<TRUE>>

SMTPサーバとの接続にTLSを使用する場合に，STARTTLSを使用するかどうかを指定します。mailadp.smtps.enableでTRUEを指定した場合だけ有効になります。大文字と小文字は区別されません。

TRUE

STARTTLSを使用します。通常のSMTPで通信を開始し，STARTTLSで双方がTLSに対応しているか確認したあとに，TLSで再接続します。

FALSE

STARTTLSを使用しません。SMTP通信がすべてTLSによって暗号化されます。

mailadp.smtps.starttls.required={TRUE｜FALSE}　〜<<FALSE>>

メールアダプタでSTARTTLSを使用する場合，接続先のSMTPサーバで次の現象が発生した際に，メールアダプタからエラーを発生させるかどうかを指定します。

接続先のSMTPサーバがSTARTTLSをサポートしていない

接続先のSMTPサーバでSTARTTLSの処理中にエラーが発生した

mailadp.smtps.enableとmailadp.smtps.starttls.enableの両方でTRUEを指定した場合だけ有効になります。大文字と小文字は区別されません。

TRUE

メールアダプタでエラーを発生させます。

FALSE

SMTPを使用してSMTPサーバに接続します。

(4)　記述例

メールアダプタ実行環境プロパティファイルの記述例を次に示します。

mailadp.smtp.host.name=domainName.com
mailadp.smtp.port=25
mailadp.user=john
mailadp.addr.from=sampleuser@XXXXXX.com

(5)　注意事項

次に示すプロパティのうち，一つも指定されていない場合はエラーになります。

mailadp.addr.to

mailadp.addr.cc

mailadp.addr.bcc

2バイト文字などは不正な文字列に解釈されるため，次に示すhjdk.native2ascii.jarツールで変換してください。

<サービスプラットフォームのインストールディレクトリ>¥jdk¥bin¥java -jar <サービスプラットフォームのインストールディレクトリ>¥jdk¥lib¥hcompatlib¥hjdk.native2ascii.jar <入力ファイルパス> <出力ファイルパス>

hjdk.native2ascii.jarツールの詳細については，JDKのドキュメントを参照してください。

パスを指定する場合の注意事項を次に示します。

相対パス，親ディレクトリ表現（「..¥」，「../」），およびカレントディレクトリ表現（「.¥」，「./」）を含むパスは指定しないでください。

シンボリックリンクを含むパスは指定しないでください。

Windowsの場合，UNC形式，NTFSのストリーム名，および予約デバイス名を含むパスは指定しないでください。また，パスの大文字と小文字は区別されません。

6.13.4　メールヘッダ定義ファイル

(1)　形式

［<キー名称>=<値>］

(2)　機能

メールの重要度，返信要求の有無など，ユーザが定義した任意のメールヘッダのオプションを設定するためのファイルです。

メールヘッダ定義ファイルは，任意のパスに任意のファイル名で格納できます。ただし，メールヘッダ定義ファイルの絶対パスが，メールアダプタ実行環境プロパティファイルのmailadp.user.header.pathキーで指定されている必要があります。

(3)　ファイルの格納先

テンプレートファイルの場所：

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥mail¥templates¥mail-header.properties

(4)　記述例

メールヘッダ定義ファイルの記述例を次に示します。

Importance=High
Sensitivity=Private

(5)　注意事項

キー名と値を重複して指定した場合，動作は保証されません。

同一のヘッダが複数回定義された場合，動作は保証されません。

キー名に対して空の値は指定できません。空の値を指定した場合はエラーになります。

メールヘッダ定義ファイルに何も定義されていない場合，ユーザ定義のメールヘッダなしでメールが送信されます。

メールヘッダ定義ファイルの動作は，メールサーバおよびメールを受信するクライアントに依存します。

メールアダプタ実行環境プロパティファイルまたは要求電文に定義されたメールヘッダと同一のメールヘッダをメールヘッダ定義ファイルに定義しないことを推奨します。同一のメールヘッダをメールアダプタ実行環境プロパティファイルおよびメールヘッダ定義ファイルに指定した場合，動作はメールサーバに依存します。

2バイト文字などは不正な文字列に解釈されるため，次に示すhjdk.native2ascii.jarツールで変換してください。

<サービスプラットフォームのインストールディレクトリ>¥jdk¥bin¥java -jar <サービスプラットフォームのインストールディレクトリ>¥jdk¥lib¥hcompatlib¥hjdk.native2ascii.jar <入力ファイルパス> <出力ファイルパス>

hjdk.native2ascii.jarツールの詳細については，JDKのドキュメントを参照してください。

6.14　HTTPアダプタで利用するファイル

6.14.1　HTTPアダプタアカウント定義ファイル

HTTPアダプタアカウント定義ファイルは，次の内容を管理するためのファイルです。

ベーシック認証に必要な認証情報（ユーザ名，パスワードおよび接続先URI）

署名付きAWS APIリクエストの署名情報付与で使用する情報（アクセスキーID，シークレットアクセスキーおよびアクセスキーペアID）

HTTPアダプタアカウント定義ファイルは，csahttpuseraddコマンドの-fオプションで指定したパスおよびファイル名で作成されます。csahttpuseraddコマンドの詳細は，「5.4　サービスプラットフォームの運用環境および実行環境で使用するコマンド」の「csahttpuseradd（HTTPアダプタで使用するアカウント情報の登録・更新）」を参照してください。

作成したHTTPアダプタアカウント定義ファイルを有効にするには，ファイルの絶対パスをHTTPアダプタ実行環境プロパティファイルのadphttp.config.account-inf-filepathキーに指定する必要があります。

なお，ファイル内容は運用コマンドで管理するため，編集はできません。

6.14.2　HTTPアダプタ実行環境プロパティファイル

(1)　形式

［adphttp.request.method={GET｜HEAD｜POST｜OPTIONS｜PUT｜DELETE}］
［adphttp.request.uri-scheme-authority=URIのスキームとオーソリティ］
［adphttp.request.uri-path=URIのパス］
［adphttp.request.uri-query.<追番>=URIのクエリ］

［adphttp.request.header.authorization.type={none｜raw｜basic}］
［adphttp.request.header.authorization=認証情報］

［adphttp.request.header.content-type.charset=Content-Typeヘッダの文字コード］
［adphttp.request.header.content-type=Content-Typeヘッダのメディアタイプ］

［adphttp.request.header.userdef.<追番>=リクエストヘッダ］

［adphttp.request.body.style={single｜multipart/form-data}］

［adphttp.request.part.message.binding={none｜raw｜form-data}］
［adphttp.request.part.message.part-id=HTTPリクエストボディのパートに付与するID］
［adphttp.request.part.message.content-type.charset=Content-Typeの文字コード］
［adphttp.request.part.message.content-type=Content-Typeの値］

［adphttp.request.part.file.<追番>.part-id=ファイルのパートに付与するID］
［adphttp.request.part.file.<追番>.input-folder-name=共通フォルダ定義名］
［adphttp.request.part.file.<追番>.local-file-name=読み込み対象のファイル名］
［adphttp.request.part.file.<追番>.file-name=送信時のファイル名］
［adphttp.request.part.file.<追番>.content-type.charset=Content-Typeの文字コード］
［adphttp.request.part.file.<追番>.content-type=Content-Typeの値］

［adphttp.request.output-folder-name=共通フォルダ定義名］
［adphttp.request.output-sub-folder=ファイル出力先のサブフォルダ名］

［adphttp.config.account-inf-filepath=HTTPアダプタアカウント定義ファイルのパス］

［adphttp.config.trace.path=ログの出力先の親ディレクトリ］
［adphttp.config.messagelog.level={0｜10｜20}］
［adphttp.config.methodtrace.level={1｜2｜3｜4｜5}］
［adphttp.config.methodtrace.filenum=メンテナンスログファイルの面数］
［adphttp.config.methodtrace.filesize=メンテナンスログファイルのファイルサイズ］
［adphttp.config.exptrace.filenum=例外ログファイルの面数］
［adphttp.config.exptrace.filesize=例外ログファイルのファイルサイズ］

［adphttp.config.password-auth-inf-filepath=パスワード認証情報定義ファイルのパス］

［adphttp.config.publickey-auth-inf-filepath=公開鍵認証情報定義ファイルのパス］

［adphttp.request.header.signed.aws.api.request.type={none｜header}］
［adphttp.request.header.signed.aws.api.request=アクセスキーペアID］
［adphttp.request.header.signed.aws.api.request.version=署名バージョン］
［adphttp.request.header.signed.aws.api.request.service=接続先AWSサービス］
［adphttp.request.header.signed.aws.api.request.region=接続先AWSリージョン］

(2)　機能

HTTPアダプタごとの構成情報を設定します。

(a)　ファイルの種類

HTTPアダプタ実行環境プロパティファイルは，次に示す2種類があります。

HTTPアダプタ実行環境プロパティファイル

有効範囲：特定のHTTPアダプタ

HTTPアダプタ実行環境共通プロパティファイル

有効範囲：すべてのHTTPアダプタ

作成手順については「6.14.3　HTTPアダプタ実行環境共通プロパティファイル」を参照してください。

これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。

また，1つのマシンに複数のHCSCサーバをセットアップした場合，HTTPアダプタ実行環境プロパティファイルをHCSCサーバごとに定義することもできます。これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。

同じ内容が要求電文（ヘッダ），HTTPアダプタ実行環境プロパティファイル，HTTPアダプタ実行環境共通プロパティファイルの間で複数設定された場合，次の表でより優先度の高いものが適用されます。

指定個所

重複時の優先度

要求電文（ヘッダ）

高

HTTPアダプタ実行環境プロパティファイル

（HCSCサーバ単位の指定：あり）

｜

HTTPアダプタ実行環境共通プロパティファイル

（HCSCサーバ単位の指定：あり）

｜

HTTPアダプタ実行環境プロパティファイル

（HCSCサーバ単位の指定：なし）

｜

HTTPアダプタ実行環境共通プロパティファイル

（HCSCサーバ単位の指定：なし）

低

プロパティ名と要求電文（ヘッダ）との対応については，マニュアル「サービスプラットフォーム 解説」の「2.16.14　要求電文（ヘッダ）とHTTPアダプタ実行環境（共通）プロパティファイルのパラメタの対応関係」を参照してください。

(b)　作成手順

HTTPアダプタ実行環境プロパティファイルは次の手順で作成してください。HTTPアダプタ実行環境共通プロパティファイルの作成手順は，「6.14.3　HTTPアダプタ実行環境共通プロパティファイル」を参照してください。

次のテンプレートファイルを基に，HTTPアダプタ実行環境プロパティファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥HTTP¥config¥templates¥serviceid.properties

編集後のファイルをファイル名「<サービスID>.properties」で次のディレクトリに格納してください。

全HCSCサーバ共通の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥HTTP¥config

特定のHCSCサーバ用の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥HTTP¥config¥<HCSCサーバ名>

サブディレクトリ<HCSCサーバ名>を作成する際は，Windowsでは大文字・小文字は区別されないので，注意してください。

サブディレクトリ<HCSCサーバ名>には，HCSCサーバの管理者（Service Coordinator管理者）がアクセスできるよう，適切なアクセス権限を設定してください。

(3)　設定できるプロパティ

(a)　リクエストライン

adphttp.request.method={GET｜HEAD｜POST｜OPTIONS｜PUT｜DELETE}

リクエストのHTTPメソッド名を指定します。

GET，HEAD，POST，OPTIONS，PUT，DELETE以外のメソッド名を指定した場合は，動作を保証しません。

adphttp.request.uri-scheme-authority=URIのスキームとオーソリティ

URIのスキームとオーソリティを「<スキーム>://<オーソリティ>」の形式で指定します。

adphttp.request.uri-path=URIのパス

URIのパス部分を指定します。URIのパスがルートパス（"/"）の場合は指定を省略できます。

adphttp.request.uri-query.<追番>=URIのクエリ

URIのクエリ部分を「<キー>=<値>」の形式で1つずつ指定します。

<追番>には1〜1024の数字を指定できます。

(b)　WWW認証

adphttp.request.header.authorization.type={none｜raw｜basic}　〜<<none>>

WWW認証の認証タイプを指定します。大文字と小文字は区別されません。

none

認証情報は送信されません。

raw

adphttp.request.header.authorizationプロパティに指定した認証情報（任意の認証文字列）が，HTTPリクエストヘッダのAuthorizationに設定されて送信されます。

basic

ベーシック認証の場合に指定します。認証情報は次のように取得・設定して送信されます。

adphttp.request.header.authorizationプロパティに指定した認証情報（ユーザ名）を基に，対応するパスワードがHTTPアダプタアカウント定義ファイルから取得されます。

HTTPリクエストヘッダのAuthorizationに，HTTPアダプタ内部で生成したベーシック認証用文字列が設定されます。

このプロパティを指定した場合は，必ずadphttp.request.header.authorizationプロパティに認証情報を指定してください。

adphttp.request.header.authorization=認証情報

WWW認証の認証情報を次のように指定します。

adphttp.request.header.authorization.typeプロパティでnoneを指定した場合

コメントを外してください（空文字列を指定）。

adphttp.request.header.authorization.typeプロパティでrawを指定した場合

任意の認証情報を指定してください。

adphttp.request.header.authorization.typeプロパティでbasicを指定した場合

HTTPアダプタアカウント定義ファイルに登録したユーザ名を指定してください。

ベーシック認証の場合の指定例を次に示します。

adphttp.request.header.authorization.type=basic
adphttp.request.header.authorization=user1

(c)　HTTPヘッダのContent-Typeヘッダ

adphttp.request.header.content-type.charset=Content-Typeヘッダの文字コード

HTTPリクエストヘッダのContent-Typeヘッダの文字コードを指定します。

要求電文（ボディ）のバインド方法にform-dataを指定した場合，ここで指定した文字コードにフォームデータを変換してからHTTPリクエストが送信されます。指定できる文字コードはJavaVMが使用できる文字コードに限ります。

要求電文（ボディ）のバインド方法にrawを指定した場合，要求電文（ボディ）の文字コードに合わせて文字コードを指定してください。

adphttp.request.header.content-typeプロパティを指定しなかった場合，このプロパティの指定は無視されます。キーだけ指定して値を指定しない場合はエラーになります。

adphttp.request.header.content-type=Content-Typeヘッダのメディアタイプ

HTTPリクエストヘッダのContent-Typeヘッダのメディアタイプを「*/*」の形式で指定します。キーだけ指定して値を指定しない場合はエラーになります。

(d)　HTTPヘッダの任意指定

adphttp.request.header.userdef.<追番>=リクエストヘッダ

任意のリクエストヘッダ（1つのヘッダ）を「<フィールド名>:<フィールド値>」の形式で指定します。<追番>には1〜1024の数字を指定できます。

このプロパティは拡張ヘッダの設定を推奨します。標準ヘッダを定義した場合の動作は保証しません。また，特殊なHTTPヘッダは指定しても無視されます。詳細については，マニュアル「サービスプラットフォーム 解説」の「2.16.3　HTTPリクエストと要求電文の関係」の，HTTPリクエストヘッダに関する記述を参照してください。

設定した値は，最初の「:」を区切り文字として<フィールド名>と<フィールド値>に分割してHTTPヘッダに設定されます。<フィールド名>と<フィールド値>に余分な空白文字が含まれていても除去されません。

<フィールド名>と<フィールド値>には改行文字を指定しないでください。改行文字が含まれる場合，エラーになります。

(e)　リクエストボディのパート形式

adphttp.request.body.style={single｜multipart/form-data}　〜<<single>>

リクエストボディのパート形式を次の中から指定します。大文字と小文字は区別されません。

single

単一パートの送信処理を実行します。

multipart/form-data

マルチパート型の処理を実行します。マルチパート型の処理については，マニュアル「サービスプラットフォーム 解説」の「2.16.3　HTTPリクエストと要求電文の関係」を参照してください。

(f)　要求電文（ボディ）

adphttp.request.part.message.binding={none｜raw｜form-data}　〜<<none>>

要求電文（ボディ）のHTTPリクエストボディへのバインド方法を指定します。大文字と小文字は区別されません。

none

HTTPリクエストボディを送信しません。

raw

パススルーモードとして，要求電文（ボディ）で指定したデータがそのままHTTPリクエストボディに設定されます。

form-data

ノーマルモードとして，要求電文（ボディ）のフォームデータが「Content-Type: application/x-www-form-urlencoded」の形式でHTTPリクエストボディに設定されます。

OAuth 2.0が対応する認証フローを使用する場合は，認証情報をフォームデータとして送信するため，form-dataを設定してください。

adphttp.request.part.message.part-id=HTTPリクエストボディのパートに付与するID　〜<任意のパートID>

HTTPリクエストボディのパートに付与するIDを指定します。マルチパート型の場合に，各パートのContent-Dispositionヘッダのname属性の値として使用されます。

「csc_http_adapter_telegram_name」で始まる値は設定できません。設定した場合の動作は保証しません。

未定義の場合，HTTPアダプタで生成されたシーケンス番号が使用されます。未定義かつ次に示す条件をすべて満たす場合は，「csc_http_adapter_telegram_name_1」が設定されます。

リクエストボディのパート形式が「multipart/form-data」である

ボディ要求電文のリクエストボディへのバインド方法が「raw」である

adphttp.request.part.message.content-type.charset=Content-Typeの文字コード　〜<任意の文字コード名>

HTTPリクエストボディのパートのContent-Typeの文字コードを指定します。マルチパート型の場合に，各パートのContent-Typeヘッダのcharset属性として使用されます。未定義の場合はcharset属性を設定しません。

adphttp.request.part.message.content-typeプロパティを指定しなかった場合，このプロパティの指定は無視されます。

adphttp.request.part.message.content-type=Content-Typeの値　〜<任意のメディアタイプ>

HTTPリクエストボディのパートのContent-Typeの値を指定します。マルチパート型の場合に，各パートのContent-Typeヘッダの値として使用されます。未定義の場合はContent-Typeを設定しません。

なお，adphttp.request.part.message.content-type.charsetプロパティに有効な値が設定されていて，かつcharset属性を付加した場合，動作は保証しません。

(g)　入力ファイル

注意事項

ここで記載するプロパティ名の<追番>には，プロパティ名を一意とするための数値を1〜1,024の範囲で指定します。<追番>の指定時の留意点を次に示します。

「001」のように数値の前に0は付けないでください。

1つのプロパティを複数指定する場合，重複しない数値を指定してください。連番にする必要はありません。また，数値の大小は参照順などに影響しません。

同じ入力ファイルを定義するプロパティ同士には，同じ数値を指定してください。

また，ここに記載するプロパティと要求電文のfile要素と同時に指定した場合，要求電文の指定が優先されます。

adphttp.request.part.file.<追番>.part-id=ファイルのパートに付与するID　〜<任意のパートID>

ファイルのパートに付与するIDを指定します。マルチパート型の場合に，各パートのヘッダのContent-Dispositionのnameパラメタの値として使用します。

<追番>の指定については，「(g) 入力ファイル」の冒頭の説明を参照してください。

「csc_http_adapter_file_name」で始まる値は設定できません。設定した場合の動作は保証しません。

未定義の場合，HTTPアダプタで生成されたシーケンス番号が使用されます。未定義かつ次に示す条件をすべて満たす場合は，「csc_http_adapter_file_name_<1から始まる連番>」が設定されます。連番は製品内で採番されます。

adphttp.request.body.styleプロパティの値に「multipart/form-data」を指定した

adphttp.request.part.file.<追番>.input-folder-nameプロパティおよびadphttp.request.part.file.<追番>.local-file-nameプロパティが設定されている

adphttp.request.part.file.<追番>.input-folder-name=共通フォルダ定義名

読み込み対象のファイルが格納された共通フォルダの定義名を指定します。

<追番>の指定については，「(g) 入力ファイル」の冒頭の説明を参照してください。

指定した共通フォルダ定義名が不正な場合は，エラーになります。キーだけ指定して値を指定しない場合はエラーになります。共通フォルダを使用しない場合は指定を省略できます。

このプロパティを指定した場合は，必ずadphttp.request.part.file.<追番>.local-file-nameプロパティに読み込み対象のファイル名を指定してください。

adphttp.request.part.file.<追番>.local-file-name=読み込み対象のファイル名

読み込み対象のファイルの名称を指定します。

<追番>の指定については，「(g) 入力ファイル」の冒頭の説明を参照してください。

階層構造や上位のパスを指定した場合はエラーになります。サブフォルダを使用する場合は，共通フォルダルートからファイル名までの相対パスで設定してください。キーだけ指定して値を指定しない場合はエラーになります。

このプロパティを指定した場合は，必ずadphttp.request.part.file.<追番>.input-folder-nameプロパティに共通フォルダ定義名を指定してください。

シンボリックリンク以外のファイルを指定してください。

adphttp.request.part.file.<追番>.file-name=送信時のファイル名

送信時のファイルの名称を指定します。マルチパート型の場合に，各パートのContent-Dispositionヘッダのfilename属性の値として使用されます。未定義の場合，filename属性は設定されません。

<追番>の指定については，「(g) 入力ファイル」の冒頭の説明を参照してください。

adphttp.request.part.file.<追番>.content-type.charset=Content-Typeの文字コード　〜<任意の文字コード名>

ファイルのパートのContent-Typeの文字コードとして，任意の文字コード名称を指定します。マルチパート型の場合に，各パートのContent-Typeヘッダのcharset属性として使用されます。未定義の場合，charset属性は設定されません。

このプロパティを指定した場合は，必ずadphttp.request.part.file.<追番>.content-typeプロパティを指定してください。

<追番>の指定については，「(g) 入力ファイル」の冒頭の説明を参照してください。

adphttp.request.part.file.<追番>.content-type=Content-Typeの値　〜<任意のメディアタイプ>

ファイルのパートのContent-Typeの値として，任意のメディアタイプを指定します。マルチパート型の場合に，各パートのContent-Typeヘッダの値として使用されます。未定義の場合，Content-Typeは設定されません。

<追番>の指定については，「(g) 入力ファイル」の冒頭の説明を参照してください。

なおadphttp.request.part.file.<追番>.content-type.charsetプロパティに有効な値が設定されていて，かつcharset属性を付加した場合，動作は保証しません。

(h)　出力ファイル

adphttp.request.output-folder-name=共通フォルダ定義名

書き込み対象のファイルを格納する共通フォルダの定義名を指定します。

指定した共通フォルダ定義名が不正な場合は，エラーになります。キーだけ指定して値を指定しない場合はエラーになります。

共通フォルダを使用しない場合は指定を省略できます。

adphttp.request.output-sub-folder=ファイル出力先のサブフォルダ名

HTTPレスポンス時にダウンロードファイルを出力するサブフォルダを指定します。

adphttp.request.output-folder-nameプロパティで共通フォルダを指定し，かつサブフォルダを使用する場合に，書き込み対象のファイルを出力するサブフォルダを指定します。

共通フォルダルートからサブフォルダまでの相対パスを設定してください。相対パスの先頭および末尾のファイル区切り文字（/）は省略できます。

指定したサブフォルダが存在しない場合は，実行時にフォルダを作成します。

共通フォルダルートより上位のパスを指定した場合はエラーになります。

adphttp.request.output-folder-nameプロパティで共通フォルダ定義名が定義されていない場合，指定値は無視されます。

(i)　HTTPアダプタアカウント定義ファイル

adphttp.config.account-inf-filepath=HTTPアダプタアカウント定義ファイルのパス

HTTPアダプタアカウント定義ファイルのパスを絶対パスで指定します。

署名付きAWS APIリクエストの署名情報付与機能に関する設定を要求電文（ヘッダ）で設定する場合も，このプロパティの指定が必要です。

HTTPアダプタアカウント定義ファイルは，csahttpuseraddコマンドで登録した情報が入ったファイルです。csahttpuseraddコマンドについては，「5.　コマンド（運用環境・実行環境）」の「csahttpuseradd（HTTPアダプタで使用するアカウント情報の登録・更新）」を参照してください。

(j)　ロギング

adphttp.config.trace.path=ログの出力先の親ディレクトリ　〜<<<J2EEサーバ用オプション定義ファイル（usrconf.properties）のejb.server.log.directoryキーで指定したログ出力ディレクトリ>>>

メンテナンスログおよび例外ログの出力先の親ディレクトリを絶対パスで指定します。指定したフォルダが存在しない場合はHTTPアダプタ起動時にフォルダを作成します。

ここで指定したパスを基に，ログファイルは次の個所へ出力されます。

<adphttp.config.trace.pathで指定したパス>¥CSCADP¥ADPHTTP¥maintenance¥<サービスID>

adphttp.config.messagelog.level={0｜10｜20}　〜<<10>>

メッセージログの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

出力情報

出力内容

出力レベル

0

10

20

エラー情報

例外または障害の発生原因

○

○

○

警告情報

発生した問題など

△

○

○

インフォメーション

電文や引数の内容

HTTPアダプタの状態の変更（起動時や終了時）

イベントの通知

△

△

○

（凡例）

○：出力されます。

△：重要なログメッセージだけ出力されます。

adphttp.config.methodtrace.level={1｜2｜3｜4｜5}　〜<<3>>

メンテナンスログの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

出力情報

出力レベル

1

2

3

4

5

エラー情報（例外発生原因）

○

○

○

○

○

主要な外部モジュールのインターフェースの入口／出口情報（クラス名，メソッド名，引数，戻り値）

×

○

○

○

○

外部モジュールのインターフェースの入口／出口情報（クラス名，メソッド名，引数，戻り値）

×

×

○

○

○

主要なコンポーネント内インターフェースの入口／出口情報（クラス名，メソッド名，引数，戻り値）

×

×

×

○

○

コンポーネント内インターフェースの入口／出口情報（クラス名，メソッド名，引数，戻り値）や，デバッグ情報（処理の分岐などの情報）

×

×

×

×

○

（凡例）

○：出力されます。

×：出力されません。

adphttp.config.methodtrace.filenum=メンテナンスログファイルの面数　〜＜数字＞((1−16)) <<8>>

メンテナンスログのファイルの面数を指定します。

adphttp.config.methodtrace.filesize=メンテナンスログファイルのファイルサイズ　〜＜数字＞((4096−2147483647)) <<2097152>>

メンテナンスログの1面当たりの最大ファイルサイズをバイト単位で指定します。

adphttp.config.exptrace.filenum=例外ログファイルの面数　〜＜数字＞((1−16)) <<8>>

例外ログの面数を指定します。

adphttp.config.exptrace.filesize=例外ログファイルのファイルサイズ　〜＜数字＞((4096−2147483647)) <<2097152>>

例外ログの1面当たりの最大ファイルサイズをバイト単位で指定します。

(k)　パスワード認証情報定義ファイル

adphttp.config.password-auth-inf-filepath=パスワード認証情報定義ファイルのパス

パスワード認証のユーザ情報をcsauseraddコマンドで登録している場合，パスワード認証情報定義ファイルのファイル名を絶対パスで指定します。csauseraddコマンドの実行時に-fオプションで指定したパスワード認証情報定義ファイルのパスを指定してください。

指定するファイルには，HCSCサーバの管理者のアクセス権限が必要です。

指定したファイルが存在しない場合は，サービスアダプタの開始時にエラーとなります。

(l)　公開鍵認証情報定義ファイル

adphttp.config.publickey-auth-inf-filepath=公開鍵認証情報定義ファイルのパス

公開鍵認証の秘密鍵情報をcsakeyaddコマンドで登録している場合，公開鍵認証情報定義ファイルのファイル名を絶対パスで指定します。csakeyaddコマンドの実行時に-fオプションで指定した公開鍵認証情報定義ファイルのパスを指定してください。

指定するファイルには，HCSCサーバの管理者のアクセス権限が必要です。

指定したファイルが存在しない場合は，サービスアダプタの開始時にエラーとなります。

(m)　署名付きAWS APIリクエスト

adphttp.request.header.signed.aws.api.request.type={none｜header}　〜<<none>>

署名付きAWS APIリクエストの認証方法を指定します。

none

署名付きAWS APIリクエストの署名情報を生成しません。

header

署名付きAWS APIリクエストの署名情報を生成し，署名情報をリクエストヘッダに付与して送信します。

adphttp.request.header.signed.aws.api.request=アクセスキーペアID

署名付きAWS APIリクエストで使用するアクセスキーペアIDを指定します。

指定されたアクセスキーペアIDをキーにして，HTTPアダプタアカウント定義ファイルから署名付きAWS APIリクエストの署名生成に必要なアクセスキーID，シークレットアクセスキーを取得します。

adphttp.request.header.signed.aws.api.request.version=署名バージョン　〜<<aws4_request>>

署名付きAWS APIリクエストの署名バージョンを指定します。指定できる値を次に示します。

aws4_request

署名バージョン4

adphttp.request.header.signed.aws.api.request.service=接続先AWSサービス

接続先AWSサービスを指定します。指定できる値を次に示します。

s3

Amazon S3へ接続します。

存在しないAWSサービス名を指定した場合は，AWSサーバがエラー応答を返します。

adphttp.request.header.signed.aws.api.request.region=接続先AWSリージョン

接続先AWSリージョンを次の中から指定します。存在しない接続先AWSリージョンを指定した場合は，AWSサーバがエラー応答を返します。

指定できる値

接続先AWSリージョン

us-east-2

米国東部（オハイオ）

us-east-1

米国東部（バージニア北部）

us-west-1

米国西部（北カリフォルニア）

us-west-2

米国西部（オレゴン）

af-south-1

アフリカ（ケープタウン）

ap-east-1

アジアパシフィック（香港）

ap-south-2

アジアパシフィック（ハイデラバード）

ap-southeast-3

アジアパシフィック（ジャカルタ）

ap-southeast-4

アジアパシフィック（メルボルン）

ap-south-1

アジアパシフィック（ムンバイ）

ap-northeast-3

アジアパシフィック（大阪）

ap-northeast-2

アジアパシフィック（ソウル）

ap-southeast-1

アジアパシフィック（シンガポール）

ap-southeast-2

アジアパシフィック（シドニー）

ap-northeast-1

アジアパシフィック（東京）

ca-central-1

カナダ（中部）

ca-west-1

カナダ西部（カルガリー）

eu-central-1

欧州（フランクフルト）

eu-west-1

欧州（アイルランド）

eu-west-2

欧州（ロンドン）

eu-south-1

欧州（ミラノ）

eu-west-3

欧州（パリ）

eu-south-2

欧州（スペイン）

eu-north-1

欧州（ストックホルム）

eu-central-2

欧州（チューリッヒ）

il-central-1

イスラエル（テルアビブ）

me-south-1

中東（バーレーン）

me-central-1

中東（アラブ首長国連邦）

sa-east-1

南米（サンパウロ）

us-gov-east-1

AWS GovCloud（米国東部）

us-gov-west-1

AWS GovCloud（米国西部）

(4)　記述例

記述例を次に示します。

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)　注意事項

プロパティファイルは文字コードをUTF-8にして保存してください。UTF-8以外の文字コードを使用した場合，設定値を正しく解釈できない場合があります。

パスを指定する場合の注意事項を次に示します。

相対パス，親ディレクトリ表現（「..¥」，「../」），およびカレントディレクトリ表現（「.¥」，「./」）を含むパスは指定しないでください。

シンボリックリンクを含むパスは指定しないでください。

Windowsの場合，UNC形式，NTFSのストリーム名，および予約デバイス名を含むパスは指定しないでください。また，パスの大文字と小文字は区別されません。

6.14.3　HTTPアダプタ実行環境共通プロパティファイル

(1)　形式

ファイルの記述形式はHTTPアダプタ実行環境プロパティファイルと同じです。記述形式については，「6.14.2　HTTPアダプタ実行環境プロパティファイル」を参照してください。

(2)　機能

すべてのHTTPアダプタに共通する構成情報を設定します。

(a)　ファイルの種類

HTTPアダプタ実行環境プロパティファイルは，次に示す2種類があります。

HTTPアダプタ実行環境プロパティファイル

有効範囲：特定のHTTPアダプタ

作成手順については「6.14.2　HTTPアダプタ実行環境プロパティファイル」を参照してください。

HTTPアダプタ実行環境共通プロパティファイル

有効範囲：すべてのHTTPアダプタ

これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。

また，1つのマシンに複数のHCSCサーバをセットアップした場合，HTTPアダプタ実行環境共通プロパティファイルをHCSCサーバごとに定義することもできます。

プロパティファイルおよび要求電文間で同じ内容が複数設定された場合のプロパティの優先度については，「6.14.2　HTTPアダプタ実行環境プロパティファイル」を参照してください。

プロパティ名と要求電文（ヘッダ）との対応については，マニュアル「サービスプラットフォーム 解説」の「2.16.14　要求電文（ヘッダ）とHTTPアダプタ実行環境（共通）プロパティファイルのパラメタの対応関係」を参照してください。

(b)　作成手順

HTTPアダプタ実行環境共通プロパティファイルは次の手順で作成してください。

次のテンプレートファイルを基に，HTTPアダプタ実行環境共通プロパティファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥HTTP¥config¥templates¥adphttpcom.properties

編集後のファイルを次のディレクトリに格納します。

なお，ファイル名「adphttpcom.properties」は変更しないでください。

全HCSCサーバ共通の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥HTTP¥config¥common

特定のHCSCサーバ用の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥HTTP¥config¥<HCSCサーバ名>¥common

サブディレクトリ名の<HCSCサーバ名>と「common」を作成する際は，Windowsでは大文字・小文字は区別されないので，注意してください。

サブディレクトリ<HCSCサーバ名>には，HCSCサーバの管理者（Service Coordinator管理者）がアクセスできるよう，適切なアクセス権限を設定してください。

(3)　設定できるプロパティ

設定できるプロパティはHTTPアダプタ実行環境プロパティファイルと同じです。詳細は「6.14.2　HTTPアダプタ実行環境プロパティファイル」を参照してください。

(4)　注意事項

プロパティファイルは文字コードをUTF-8にして保存してください。UTF-8以外の文字コードを使用した場合，設定値を正しく解釈できない場合があります。

6.15　コマンドアダプタで利用するファイル

6.15.1　実行許可コマンド定義ファイル

(1)　形式

チェック対象文字列を受理する正規表現を，改行文字区切りで記述します。

使用できる文字コードはUTF-8です。

空文字列行は無視されます。

正規表現の記述仕様は，java.util.regex.Patternクラスの仕様に従います。

(2)　機能

コマンドアダプタで実行できる外部コマンドとコマンドライン引数の組み合わせを正規表現で設定します。

コマンドアダプタへのリクエスト時，要求電文で指定された外部コマンドと各コマンドライン引数をそれぞれ半角空白で結合した文字列に対して，実行許可コマンド定義ファイルに指定した正規表現で判定します。

実行許可コマンド定義ファイルは次の手順で作成してください。

コマンドアダプタで実行を許可するファイルパス，および指定可能とするコマンドライン引数の仕様をまとめます。

チェック対象文字列を受理する正規表現を作成して，ファイルに記載します。

作成した実行許可コマンド定義ファイルは，任意の場所に任意のファイル名で保存します。

注意事項

実行許可コマンド定義ファイルを有効にするには，コマンドアダプタ実行環境プロパティファイルのadpcmd.config.command.allow-file-pathプロパティに保存先のファイルパスを指定してください。

(3)　記述例

実行許可コマンド定義ファイルの記述例を次に示します。

/bin/ls(?: -l)?
/usr/share/product/bin/[^ /]+.sh[^&|<>]*

(4)　注意事項

外部コマンドやコマンドライン引数の部分の受理正規表現は適切に設定してください。特に，システム設計時に次に示す前提条件がある場合は，システム管理者が意図しないプロセスの起動を抑止することで，セキュリティのリスクを回避できます。

ビジネスプロセスを介さないでアダプタを直接呼び出せる状態（標準受付起動時）である

ビジネスプロセス上で，エンドユーザのリクエスタからの値が直接コマンドアダプタの要求電文にマッピングされている

参考

不適切な正規表現の一例を次に示します。

任意文字列を受理する表現（例えば，.+や.*など）

意図しないプロセスの起動を防げません。

シェルやコマンドプロンプトで実行制御の意味を持つ特殊な文字（例えば，&，|，>，<など）

コマンドライン引数内に意図しないプロセスを指定された場合に起動を防げません。

6.15.2　プロセス環境変数定義ファイル

(1)　形式

Javaのプロパティファイル形式です。

1行に1つの環境変数を指定してください。

<環境変数名1>=<変数値1>
<環境変数名2>=<変数値2>
　　　　：
<環境変数名n>=<変数値n>

注意事項

ASCII文字以外を使用する場合は，次のどちらかの対策をしてください。

ファイルをUTF-8で保存

Javaのjava.util.Propertiesクラスで規定するUnicodeエスケープで指定

(2)　機能

プロセス環境変数定義ファイルでは，外部コマンドプロセスだけで有効になる環境変数を設定します。

プロセス環境変数定義ファイルは次の手順で作成してください。

外部コマンドプロセスで使用する環境変数の仕様（環境変数名と変数値）をまとめます。

Javaのプロパティファイル形式に従って，環境変数名と変数値をファイルに記述します。

作成したプロセス環境変数定義ファイルは，任意の場所に任意のファイル名で保存します。

注意事項

プロセス環境変数定義ファイルを有効にするには，コマンドアダプタ実行環境プロパティファイルのadpcmd.config.process-environment.variable-file-pathプロパティに保存先のファイルパスを指定してください。

(3)　記述例

プロセス環境変数定義ファイルの記述例を次に示します。

SIZE_OF_LIST=20000
OPTION_STATUS=1

(4)　注意事項

環境変数名の大文字と小文字を区別するかどうかは，オペレーティングシステムの仕様に依存します。

Javaのプロパティファイル形式のため，環境変数名，変数値ともに，エスケープが必要となるケースがあります。

ほかの変数値を参照することや，自身の元の値を参照することはできません。

同一のキーを複数指定した場合，どれが有効になるかは不定です。

6.15.3　コマンドアダプタ実行環境プロパティファイル

(1)　形式

adpcmd.config.command.allow-file-path=実行許可コマンド定義ファイルのパス

［adpcmd.config.process-environment.variable-file-path=プロセス環境変数定義ファイルのパス］
［adpcmd.config.process-environment.working-dir-path=外部コマンドプロセスの作業ディレクトリパス］

［adpcmd.config.timeout.value=外部コマンドプロセスのタイムアウト値］
［adpcmd.config.timeout.enable-kill-process={true｜false}］

［adpcmd.config.stdout.size=応答電文で取得する標準出力の上限サイズ］

［adpcmd.log.messagelog.level={0｜10｜20}］
［adpcmd.log.methodtrace.level={1｜2｜3｜4｜5}］
［adpcmd.log.methodtrace.filenum=メンテナンスログファイルの面数］
［adpcmd.log.methodtrace.filesize=メンテナンスログファイルのファイルサイズ］
［adpcmd.log.exptrace.filenum=例外ログファイルの面数］
［adpcmd.log.exptrace.filesize=例外ログファイルのファイルサイズ］
［adpcmd.log.stderr.enable={true｜false}］
［adpcmd.log.stderr.charset={UTF-8｜MS932｜EUC-JP}］
［adpcmd.log.stderr.filenum=標準エラー出力ログファイルの面数］
［adpcmd.log.stderr.filesize=標準エラー出力ログファイルのファイルサイズ］

(2)　機能

コマンドアダプタごとの構成情報を設定します。

(a)　ファイルの種類

コマンドアダプタ実行環境プロパティファイルは，次に示す2種類があります。

コマンドアダプタ実行環境プロパティファイル

有効範囲：特定のコマンドアダプタ

コマンドアダプタ実行環境共通プロパティファイル

有効範囲：すべてのコマンドアダプタ

作成手順については「6.15.4　コマンドアダプタ実行環境共通プロパティファイル」を参照してください。

これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。

また，1つのマシンに複数のHCSCサーバをセットアップした場合，コマンドアダプタ実行環境プロパティファイルをHCSCサーバごとに定義することもできます。これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。

同じ内容が要求電文，コマンドアダプタ実行環境プロパティファイル，コマンドアダプタ実行環境共通プロパティファイルの間で複数設定された場合，次の表でより優先度の高いものが適用されます。

指定個所

重複時の優先度

要求電文

高

コマンドアダプタ実行環境プロパティファイル

（HCSCサーバ単位の指定：あり）

｜

コマンドアダプタ実行環境共通プロパティファイル

（HCSCサーバ単位の指定：あり）

｜

コマンドアダプタ実行環境プロパティファイル

（HCSCサーバ単位の指定：なし）

｜

コマンドアダプタ実行環境共通プロパティファイル

（HCSCサーバ単位の指定：なし）

低

(b)　作成手順

コマンドアダプタ実行環境プロパティファイルは次の手順で作成してください。コマンドアダプタ実行環境共通プロパティファイルの作成手順は，「6.15.4　コマンドアダプタ実行環境共通プロパティファイル」を参照してください。

次のテンプレートファイルを基に，コマンドアダプタ実行環境プロパティファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥Command¥config¥templates¥serviceid.properties

編集後のファイルをファイル名「<サービスID>.properties」で次のディレクトリに格納してください。

全HCSCサーバ共通の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥Command¥config

特定のHCSCサーバ用の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥Command¥config¥<HCSCサーバ名>

サブディレクトリ<HCSCサーバ名>を作成する際は，Windowsでは大文字・小文字は区別されないので，注意してください。

サブディレクトリ<HCSCサーバ名>には，HCSCサーバの管理者（Service Coordinator管理者）がアクセスできるよう，適切なアクセス権限を設定してください。

(3)　設定できるプロパティ

(a)　実行許可コマンド定義ファイルのパス

adpcmd.config.command.allow-file-path=実行許可コマンド定義ファイルのパス

実行許可コマンド定義ファイルのパスを絶対パスまたは相対パスで指定します。相対パスを指定した場合の基点ディレクトリを次に示します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥Command¥config

参考

<サービスプラットフォームのインストールディレクトリ> が 「C:¥Example」で，実行許可コマンド定義ファイル「acc.txt」を「C:¥Example¥CSC¥custom-adapter¥Command¥config」に作成したと仮定した場合，次の2つの例はどちらを指定しても動作は同じです。

● 絶対パス指定の例

adpcmd.config.command.allow-file-path=C:¥¥Example¥¥CSC¥¥custom-adapter¥¥Command¥¥config¥¥acc.txt

● 相対パス指定の例

adpcmd.config.command.allow-file-path=acc.txt

(b)　外部コマンドプロセスの環境設定

adpcmd.config.process-environment.variable-file-path=プロセス環境変数定義ファイルのパス

プロセス環境変数定義ファイルのファイルパスを絶対パスまたは相対パスで指定します。相対パスを指定した場合の基点ディレクトリを次に示します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥Command¥config

adpcmd.config.process-environment.working-dir-path=外部コマンドプロセスの作業ディレクトリパス　〜<<<サービスプラットフォームのインストールディレクトリ>¥CSC¥spool¥Command>>

外部コマンドプロセスの作業ディレクトリを絶対パスで指定します。

(c)　タイムアウト

adpcmd.config.timeout.value=外部コマンドプロセスのタイムアウト値　〜＜数字＞((0−86400)) <<60>>

外部コマンドプロセスのタイムアウト値（単位：秒）を指定します。

0を指定した場合，プロセスがタイムアウトなしとなり，外部コマンドプロセスが終了するまで待ちます。

注意事項

サービスプラットフォームでは，運用環境から外部コマンドプロセスを停止する手段を提供していません。したがって，確実に終了する外部コマンドを指定するか，状態が確認できる外部コマンドを作成してください。

adpcmd.config.timeout.enable-kill-process=タイムアウト発生時の外部コマンドプロセス強制終了可否　〜{true｜false} <<true>>

タイムアウトが発生した際に，その時点で外部コマンドプロセスの強制終了を試みるかどうかを指定します。

true

強制終了を試みます。

false

強制終了しません。

trueの場合でも，外部コマンドプロセスの状態によっては強制終了に失敗するケースがあります。強制終了の成功可否については，メッセージログで確認してください。

falseの場合，コマンドアダプタやHCSCサーバの状態に関係なく，起動した外部コマンドプロセスは処理を継続します。

注意事項

サービスプラットフォームでは，運用環境から外部コマンドプロセスを停止する手段を提供していません。したがって，確実に終了する外部コマンドを指定するか，状態が確認できる外部コマンドを作成してください。

(d)　応答電文で取得する標準出力の上限サイズ

adpcmd.config.stdout.size=応答電文で取得する標準出力の上限サイズ　〜＜数字＞((0−104857600)) <<2097152>>

応答電文で取得する標準出力の上限サイズ（単位：バイト）を指定します。

0を指定した場合，標準出力を応答電文で取得できません。

外部コマンドプロセスの標準出力への出力データサイズが，このプロパティの指定値を超えた時点で，メッセージログに警告メッセージが出力されます。ただし，0を指定した場合，警告メッセージは出力されません。

(e)　ロギング

adpcmd.log.messagelog.level={0｜10｜20}　〜<<10>>

メッセージログの出力レベルを指定します。

出力情報と出力レベルを次の表に示します。

出力情報

出力内容

出力レベル

0

10

20

エラー情報

例外または障害の発生原因

○

○

○

警告情報

システムを運用する上で確認する必要がある状態

△

○

○

インフォメーション

コマンドアダプタの状態変更（起動および停止）

イベント通知（外部コマンドの起動および終了）

△

△

○

（凡例）

○：すべて出力されます。

△：重要なログメッセージだけ出力されます。

adpcmd.log.methodtrace.level={1｜2｜3｜4｜5}　〜<<3>>

メンテナンスログの出力レベルを指定します。

出力情報と出力レベルを次の表に示します。

出力情報

出力レベル

1

2

3

4

5

エラー情報（例外発生原因）

○

○

○

○

○

主要外部モジュールのインターフェース情報（カスタムアダプタフレームワーク関連）

×

○

○

○

○

外部モジュールのインターフェース情報（外部コマンドプロセス関連）

×

×

○

○

○

主要なコンポーネント内インターフェース情報

×

×

×

○

○

デバッグ情報

×

×

×

×

○

（凡例）

○：出力されます。

×：出力されません。

adpcmd.log.methodtrace.filenum=メンテナンスログファイルの面数　〜＜数字＞((1−16))<<8>>

メンテナンスログの面数を指定します。

adpcmd.log.methodtrace.filesize=メンテナンスログファイルのファイルサイズ　〜＜数字＞((4096−2147483647)) <<2097152>>

メンテナンスログの1面当たりの最大ファイルサイズ（単位：バイト）を指定します。

adpcmd.log.exptrace.filenum=例外ログファイルの面数　〜＜数字＞((1−16))<<8>>

例外ログの面数を指定します。

adpcmd.log.exptrace.filesize=例外ログファイルのファイルサイズ　〜＜数字＞((4096−2147483647)) <<2097152>>

例外ログの1面当たりの最大ファイルサイズ（単位：バイト）で指定します。

adpcmd.log.stderr.enable={true｜false}　〜<<true>>

外部コマンドプロセスの標準エラー出力への出力内容をログファイルに書き込むかを指定します。

true

標準エラー出力ログを有効とします。

false

標準エラー出力ログを無効とします。

adpcmd.log.stderr.charset={UTF-8｜MS932｜EUC-JP}　〜<<UTF-8>>

外部コマンドプロセスが標準エラー出力へ出力する際の文字コードを指定します。

外部コマンドプロセスがASCII文字だけを出力する場合は，文字コードの指定を省略（デフォルトの設定を利用）できます。

adpcmd.log.stderr.filenum=標準エラー出力ログファイルの面数　〜＜数字＞((1−16)) <<8>>

標準エラー出力ログの面数を指定します。

adpcmd.log.stderr.filesize=標準エラー出力ログファイルのファイルサイズ　〜＜数字＞((4096−2147483647)) <<2097152>>

標準エラー出力ログの1面当たりの最大ファイルサイズ（単位：バイト）を指定します。

6.15.4　コマンドアダプタ実行環境共通プロパティファイル

(1)　形式

ファイルの記述形式はコマンドアダプタ実行環境プロパティファイルと同じです。記述形式については，「6.15.3　コマンドアダプタ実行環境プロパティファイル」を参照してください。

(2)　機能

すべてのコマンドアダプタに共通する構成情報を設定します。

(a)　ファイルの種類

コマンドアダプタ実行環境プロパティファイルは，次に示す2種類があります。

コマンドアダプタ実行環境プロパティファイル

有効範囲：特定のコマンドアダプタ

作成手順については「6.15.3　コマンドアダプタ実行環境プロパティファイル」を参照してください。

コマンドアダプタ実行環境共通プロパティファイル

有効範囲：すべてのコマンドアダプタ

これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。

また，1つのマシンに複数のHCSCサーバをセットアップした場合，コマンドアダプタ実行環境プロパティファイルをHCSCサーバごとに定義することもできます。

プロパティファイルおよび要求電文間で同じ内容が複数設定された場合のプロパティの優先度については，「6.15.3　コマンドアダプタ実行環境プロパティファイル」を参照してください。

(b)　作成手順

コマンドアダプタ実行環境共通プロパティファイルは次の手順で作成してください。

次のテンプレートファイルを基に，コマンドアダプタ実行環境共通プロパティファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥Command¥config¥templates¥serviceid.properties

編集後のファイルをファイル名「adpcmdcom.properties」で次のディレクトリに格納します。

全HCSCサーバ共通の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥Command¥config¥common

特定のHCSCサーバ用の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥Command¥config¥<HCSCサーバ名>¥common

サブディレクトリ名の<HCSCサーバ名>と「common」を作成する際は，Windowsでは大文字・小文字は区別されないので，注意してください。

サブディレクトリ<HCSCサーバ名>には，HCSCサーバの管理者（Service Coordinator管理者）がアクセスできるよう，適切なアクセス権限を設定してください。

(3)　設定できるプロパティ

設定できるプロパティはコマンドアダプタ実行環境プロパティファイルと同じです。詳細は，「6.15.3　コマンドアダプタ実行環境プロパティファイル」を参照してください。

注意事項

次に示すプロパティに相対パスを指定したときの基点ディレクトリは，コマンドアダプタ実行環境共通プロパティファイルの配置ディレクトリ（<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥Command¥config¥common）です。

adpcmd.config.command.allow-file-path

adpcmd.config.process-environment.variable-file-path

<サービスプラットフォームのインストールディレクトリ> が 「C:¥Example」で，実行許可コマンド定義ファイル「acc.txt」を「C:¥Example¥CSC¥custom-adapter¥Command¥config」に作成したと仮定した場合，次の2つの例はどちらを指定しても動作は同じです。

● 絶対パス指定の例

adpcmd.config.command.allow-file-path=C:¥¥Example¥¥CSC¥¥custom-adapter¥¥Command¥¥config¥¥acc.txt

● 相対パス指定の例

adpcmd.config.command.allow-file-path=acc.txt

6.16　SFTPアダプタで利用するファイル

6.16.1　SFTPアダプタ実行環境プロパティファイル

(1)　形式

［sftpadp.host-ipaddr=接続するSFTPサーバのIPアドレスまたはホスト名］
［sftpadp.host-con-port=接続するSFTPサーバのポート番号］
［sftpadp.user=接続するSFTPサーバのログインユーザ名］

［sftpadp.client-ipaddr=HCSCサーバのIPアドレス］
［sftpadp.client-port.min=セッション確立するポート番号の範囲の最小値］
［sftpadp.client-port.max=セッション確立するポート番号の範囲の最大値］

［sftpadp.data-compression={true｜false}］
［sftpadp.strict-hostkey-checking={true｜false}］
［sftpadp.host-auth-inf-filepath=ホスト公開鍵ファイルの絶対パス］
［sftpadp.user-auth-type={password｜publickey}］
［sftpadp.password-auth-info=パスワード認証のユーザ名］
［sftpadp.password-auth-inf-filepath=パスワード認証情報定義ファイルの絶対パス］
［sftpadp.publickey-auth-info=公開鍵認証で使用する認証情報のID］
［sftpadp.publickey-auth-inf-filepath=公開鍵認証情報定義ファイルの絶対パス］
［sftpadp.kex-exchange.algorithm=暗号化通信で使用する鍵交換方式の優先順位］
［sftpadp.common-key.cryptosystem.c2s=共通鍵暗号方式の優先順位（クライアントからサーバへの通信）］
［sftpadp.common-key.cryptosystem.s2c=共通鍵暗号方式の優先順位（サーバからクライアントへの通信）］
［sftpadp.message-authentication-code.c2s=メッセージ認証コード方式の優先順位（クライアントからサーバへの通信）］
［sftpadp.message-authentication-code.s2c=メッセージ認証コード方式の優先順位（サーバからクライアントへの通信）］
［sftpadp.host-key.algorithm=ホスト認証の方式の優先順位］
［sftpadp.data-compression.algorithm.c2s=データ圧縮アルゴリズムの優先順位（クライアントからサーバへの通信）］
［sftpadp.data-compression.algorithm.s2c=データ圧縮アルゴリズムの優先順位（サーバからクライアントへの通信）］
［sftpadp.strict.key.exchange.enabled={true｜false}］
［sftpadp.required.strict.key.exchange={true｜false}］
［sftpadp.pubkey.accepted.algorithms=公開鍵認証で許可する署名アルゴリズム］

［sftpadp.session.timeout=セッション接続処理のタイムアウト時間］
［sftpadp.session-con.retry.count=セッション確立失敗時のリトライ回数］
［sftpadp.session-con.retry.interval=セッション確立失敗時のリトライ間隔］

［sftpadp.read-lock.retry.count=共通フォルダの共有ロック失敗時のリトライ回数］
［sftpadp.read-lock.retry.interval=共通フォルダの共有ロック失敗時のリトライ間隔］
［sftpadp.write-lock.retry.count=共通フォルダの占有ロック失敗時のリトライ回数］
［sftpadp.write-lock.retry.interval=共通フォルダの占有ロック失敗時のリトライ間隔］

［sftpadp.data-read.timeout=SFTPサーバからの応答監視時間］

［sftpadp.methodtrace.level={1｜2｜3｜4｜5}］
［sftpadp.methodtrace.filenum=保守用ログの面数］
［sftpadp.methodtrace.filesize=保守用ログの1面当たりの最大サイズ］

［sftpadp.exptrace.filenum=例外ログの面数］
［sftpadp.exptrace.filesize=例外ログの1面当たりの最大サイズ］

［sftpadp.sftpprotocoltrace.filenum=SFTPプロトコルトレースファイルの面数］
［sftpadp.sftpprotocoltrace.filesize=SFTPプロトコルトレースファイルの1面当たりの最大サイズ］

(2)　機能

SFTPアダプタごとの構成情報を設定します。

(a)　ファイルの種類

SFTPアダプタ実行環境プロパティファイルは，次に示す2種類があります。

SFTPアダプタ実行環境プロパティファイル

有効範囲：特定のSFTPアダプタ

SFTPアダプタ実行環境共通プロパティファイル

有効範囲：すべてのSFTPアダプタ

作成手順については「6.16.2　SFTPアダプタ実行環境共通プロパティファイル」を参照してください。

これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。

また，1つのマシンに複数のHCSCサーバをセットアップした場合，SFTPアダプタ実行環境プロパティファイルをHCSCサーバごとに定義することもできます。これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。

同じ内容が要求電文，SFTPアダプタ実行環境プロパティファイル，SFTPアダプタ実行環境共通プロパティファイルの間で複数設定された場合，次の表でより優先度の高いものが適用されます。

指定個所

重複時の優先度

要求電文

高

SFTPアダプタ実行環境プロパティファイル

（HCSCサーバ単位の指定：あり）

｜

SFTPアダプタ実行環境共通プロパティファイル

（HCSCサーバ単位の指定：あり）

｜

SFTPアダプタ実行環境プロパティファイル

（HCSCサーバ単位の指定：なし）

｜

SFTPアダプタ実行環境共通プロパティファイル

（HCSCサーバ単位の指定：なし）

低

(b)　作成手順

SFTPアダプタ実行環境プロパティファイルは次の手順で作成してください。SFTPアダプタ実行環境共通プロパティファイルの作成手順は，「6.16.2　SFTPアダプタ実行環境共通プロパティファイル」を参照してください。

次のテンプレートファイルを基に，SFTPアダプタ実行環境プロパティファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥SFTP¥config¥templates¥adpsftp.properties

編集後のファイルをファイル名「<サービスID>.properties」で次のディレクトリに格納してください。

全HCSCサーバ共通の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥SFTP¥config

特定のHCSCサーバ用の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥SFTP¥config¥<HCSCサーバ名>

サブディレクトリ<HCSCサーバ名>を作成する際は，Windowsでは大文字・小文字は区別されないので，注意してください。

サブディレクトリ<HCSCサーバ名>には，HCSCサーバの管理者（Service Coordinator管理者）がアクセスできるよう，適切なアクセス権限を設定してください。

(3)　設定できるプロパティ

(a)　サーバ情報

sftpadp.host-ipaddr=接続するSFTPサーバのIPアドレスまたはホスト名

接続するSFTPサーバのIPアドレスまたはホスト名を指定します。IPアドレスを指定する場合は，IPv4ドット記法またはIPv6コロン記法で指定してください。

要求電文のhost-ipaddr要素とこのプロパティの両方が設定されている場合は，host-ipaddr要素の設定が優先されます。両方とも設定されていない場合は，リクエスト処理がエラーとなります。host-ipaddr要素については，マニュアル「サービスプラットフォーム開発ガイド 受付・アダプタ定義編」の「3.3.15　SFTPアダプタを定義する」を参照してください。

sftpadp.host-con-port=接続するSFTPサーバのポート番号　〜＜数字＞((1−65535))

接続するSFTPサーバのポート番号を指定します。

要求電文のhost-con-port要素とこのプロパティの両方が設定されている場合は，host-con-port要素の設定が優先されます。両方とも設定されていない場合は，リクエスト処理がエラーとなります。host-con-port要素については，マニュアル「サービスプラットフォーム開発ガイド 受付・アダプタ定義編」の「3.3.15　SFTPアダプタを定義する」を参照してください。

sftpadp.user=接続するSFTPサーバのログインユーザ名　〜＜文字列＞((1−80文字))

接続するSFTPサーバのログインユーザ名を指定します。

使用できる文字は，半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」），および半角スペース（ASCIIコードの「0x20」）です。大文字と小文字は区別されます。使用できる半角記号を次に示します。

感嘆符（!）

ダブルクォーテーション（"）

番号記号（#）

ドル記号（$）

パーセント（%）

アンパサンド（&）

アポストロフィ（'）

始め小括弧（(）

終わり小括弧（)）

アスタリスク（*）

正符号（+）

コンマ（,）

ハイフン（-）

ピリオド（.）

スラッシュ（/）

コロン（:）

セミコロン（;）

左アングルブラケット（<）

右アングルブラケット（>）

等号（=）

クエスチョンマーク（?）

単価記号（@）

始め角括弧（[）

終わり角括弧（]）

円マーク（¥）

アクサンシルコンフレックス（^）

アンダーバー（_）

アクサングラーブ（`）

始め波括弧（{）

終わり波括弧（}）

パイプライン（|）

波ダッシュ（~）

指定するログインユーザには，ファイル操作の実行権限が与えられている必要があります。

要求電文のsftp-user要素とこのプロパティの両方が設定されている場合は，sftp-user要素の設定が優先されます。両方とも設定されていない場合は，リクエスト処理がエラーとなります。sftp-user要素については，マニュアル「サービスプラットフォーム開発ガイド 受付・アダプタ定義編」の「3.3.15　SFTPアダプタを定義する」を参照してください。

(b)　クライアント情報関連

sftpadp.client-ipaddr=HCSCサーバのIPアドレス

HCSCサーバのIPアドレスを指定します。IPアドレスを指定する場合は，IPv4ドット記法またはIPv6コロン記法で指定してください。

指定されたIPアドレスが不正な場合はシステム例外が発生します。このプロパティの指定を省略した場合は，システムによって自動的に任意のIPアドレスが割り当てられます。

sftpadp.client-port.min=セッション確立するポート番号の範囲の最小値　〜＜数字＞((1024−65535))

SFTPアダプタがセッションを確立するポート番号の範囲をsftpadp.client-port.maxプロパティと対で指定します。このプロパティにはポート番号の範囲の最小値を指定し，sftpadp.client-port.maxプロパティには最大値を指定してください。これらのプロパティの指定を両方とも省略した場合は，システムによって自動的に任意のポート番号が割り当てられます。

次の場合は，SFTPアダプタの開始時にエラーとなります。

ポート番号の範囲の最大値（sftpadp.client-port.maxプロパティで指定）を超える値を指定した場合

sftpadp.client-port.minプロパティとsftpadp.client-port.maxプロパティのどちらか一方だけ指定した場合

sftpadp.client-port.max=セッション確立するポート番号の範囲の最大値　〜＜数字＞((1024−65535))

SFTPアダプタがセッションを確立するポート番号の範囲をsftpadp.client-port.minプロパティと対で指定します。このプロパティにはポート番号の範囲の最大値を指定し，sftpadp.client-port.minプロパティには最小値を指定してください。これらのプロパティの指定を両方とも省略した場合は，システムによって自動的に任意のポート番号が割り当てられます。

次の場合は，SFTPアダプタの開始時にエラーとなります。

ポート番号の範囲の最小値（sftpadp.client-port.minプロパティで指定）を下回る値を指定した場合

sftpadp.client-port.minプロパティとsftpadp.client-port.maxプロパティのどちらか一方だけ指定した場合

(c)　SFTP設定

sftpadp.data-compression={true｜false}　〜<<false>>

転送データを圧縮するかどうかを指定します。

true

転送データを圧縮します。

false

転送データを圧縮しません。

要求電文のdata-compression要素とこのプロパティの両方が設定されている場合は，data-compression要素の設定が優先されます。両方とも設定されていない場合は，デフォルト値が適用されます。data-compression要素については，マニュアル「サービスプラットフォーム開発ガイド 受付・アダプタ定義編」の「3.3.15　SFTPアダプタを定義する」を参照してください。

sftpadp.strict-hostkey-checking={true｜false}　〜<<false>>

ホスト認証時に厳格なホスト鍵チェックを実施するか指定します。

true

厳格なホスト鍵チェックを実施します。

SFTPサーバから受けとったホスト鍵と，sftpadp.host-auth-inf-filepathプロパティに指定されたホスト鍵とを比較し，接続先が目的のサーバであるかが検証されます。ホスト鍵が存在しない場合や，ホスト鍵が変更されている場合はエラーとなります。

ホスト認証にはホスト公開鍵ファイルを使用するため，sftpadp.host-auth-inf-filepathプロパティでホスト公開鍵ファイルの絶対パスを指定する必要があります。

false

厳格なホスト鍵チェックは実施しません。

要求電文のstrict-hostkey-checking要素とこのプロパティの両方が設定されている場合は，strict-hostkey-checking要素の設定が優先されます。両方とも設定されていない場合は，デフォルト値が適用されます。strict-hostkey-checking要素については，マニュアル「サービスプラットフォーム開発ガイド 受付・アダプタ定義編」の「3.3.15　SFTPアダプタを定義する」を参照してください。

sftpadp.host-auth-inf-filepath=ホスト公開鍵ファイルの絶対パス

ホスト公開鍵ファイルを絶対パスで指定します。ホスト公開鍵ファイルはユーザが事前に作成し，HCSCサーバの管理者のアクセス権限を付与する必要があります。

指定したホスト公開鍵ファイルが存在しない場合，SFTPアダプタの開始時にエラーとなります。また，厳格なホスト鍵チェックを実施する場合（sftpadp.strict-hostkey-checking=trueを指定）にこのプロパティが設定されていないと，リクエスト処理時にエラーになります。

sftpadp.user-auth-type={password｜publickey}

ユーザ認証の方式を指定します。

password

パスワード認証を実施します。

publickey

公開鍵認証を実施します。

要求電文のuser-auth-type要素とこのプロパティの両方が設定されている場合は，user-auth-type要素の設定が優先されます。両方とも設定されていない場合は，リクエスト処理がエラーとなります。user-auth-type要素については，マニュアル「サービスプラットフォーム開発ガイド 受付・アダプタ定義編」の「3.3.15　SFTPアダプタを定義する」を参照してください。

sftpadp.password-auth-info=パスワード認証のユーザ名　〜＜文字列＞((1−80文字))

パスワード認証を実施する場合に，パスワード認証に使用するユーザ名を指定します。

csauseraddコマンドで登録したユーザ名を指定してください。使用できる文字は，半角英数字，半角記号（ASCIIコードの「0x21」〜「0x7E」），および半角スペース（ASCIIコードの「0x20」）です。大文字と小文字は区別されます。使用できる半角記号を次に示します。

感嘆符（!）

ダブルクォーテーション（"）

番号記号（#）

ドル記号（$）

パーセント（%）

アンパサンド（&）

アポストロフィ（'）

始め小括弧（(）

終わり小括弧（)）

アスタリスク（*）

正符号（+）

コンマ（,）

ハイフン（-）

ピリオド（.）

スラッシュ（/）

コロン（:）

セミコロン（;）

左アングルブラケット（<）

右アングルブラケット（>）

等号（=）

クエスチョンマーク（?）

単価記号（@）

始め角括弧（[）

終わり角括弧（]）

円マーク（¥）

アクサンシルコンフレックス（^）

アンダーバー（_）

アクサングラーブ（`）

始め波括弧（{）

終わり波括弧（}）

パイプライン（|）

波ダッシュ（~）

要求電文のuser-auth-info要素とこのプロパティの両方が設定されている場合は，user-auth-info要素の設定が優先されます。user-auth-info要素，sftpadp.publickey-auth-infoプロパティ，およびこのプロパティのどれも設定されていない場合は，リクエスト処理がエラーとなります。user-auth-info要素については，マニュアル「サービスプラットフォーム開発ガイド 受付・アダプタ定義編」の「3.3.15　SFTPアダプタを定義する」を参照してください。

sftpadp.password-auth-inf-filepath=パスワード認証情報定義ファイルの絶対パス

パスワード認証を実施する場合に，パスワード認証情報定義ファイルの絶対パスを指定します。csauseraddコマンドで作成したパスワード認証情報定義ファイルを指定してください。

指定するパスワード認証情報定義ファイルには，HCSCサーバの管理者のアクセス権限が必要です。

指定したパスワード認証情報定義ファイルが存在しない場合は，SFTPアダプタの開始時にエラーとなります。また，パスワード認証を実施する場合にこのプロパティが設定されていないと，リクエスト処理時にエラーとなります。

注意事項

ユーザ認証は必ず実施されるため，このプロパティか，またはsftpadp.publickey-auth-inf-filepathプロパティのどちらか1つを必ず指定してください。どちらも省略した場合はリクエスト処理時にエラーになります。

sftpadp.publickey-auth-info=公開鍵認証で使用する認証情報のID　〜＜半角英数字とアンダーバー（_）＞((1−8文字))

公開鍵認証を実施する場合に，公開鍵認証に使用する認証情報のIDを指定します。csakeyaddコマンドで登録した鍵IDを指定してください。

要求電文のuser-auth-info要素とこのプロパティの両方が設定されている場合は，user-auth-info要素の設定が優先されます。user-auth-info要素，sftpadp.password-auth-infoプロパティ，およびこのプロパティのどれも設定されていない場合は，リクエスト処理がエラーとなります。user-auth-info要素については，マニュアル「サービスプラットフォーム開発ガイド 受付・アダプタ定義編」の「3.3.15　SFTPアダプタを定義する」を参照してください。

sftpadp.publickey-auth-inf-filepath=公開鍵認証情報定義ファイルの絶対パス

公開鍵認証を実施する場合に，公開鍵認証情報定義ファイルの絶対パスを指定します。csakeyaddコマンドで作成した公開鍵認証情報定義ファイルを指定してください。

指定する公開鍵認証情報定義ファイルには，HCSCサーバの管理者のアクセス権限が必要です。

指定した公開鍵認証情報定義ファイルが存在しない場合は，SFTPアダプタの開始時にエラーとなります。また，公開鍵認証を実施する場合にこのプロパティが設定されていないと，リクエスト処理時にエラーとなります。

注意事項

ユーザ認証は必ず実施されるため，このプロパティか，またはsftpadp.password-auth-inf-filepathプロパティのどちらか1つを必ず指定してください。どちらも省略した場合はリクエスト処理時にエラーになります。

sftpadp.kex-exchange.algorithm=暗号化通信で使用する鍵交換方式の優先順位

鍵交換方式の優先順位を指定します。鍵交換方式は，暗号化通信を確立するために使用されます。

指定できる鍵交換方式と，デフォルトの優先順位を次の表に示します。これらの鍵交換方式を優先順位の高い順に，「sftpadp.kex-exchange.algorithm=鍵交換方式,鍵交換方式,鍵交換方式」のようにコンマで区切って指定してください。この表にない鍵交換方式を指定すると，SFTPアダプタの開始時にエラーとなります。

デフォルトの優先順位

鍵交換方式

高

ecdh-sha2-nistp256

↑

ecdh-sha2-nistp384

｜

ecdh-sha2-nistp521

｜

diffie-hellman-group-exchange-sha256

｜

diffie-hellman-group16-sha512

↓

diffie-hellman-group18-sha512

低

diffie-hellman-group14-sha256

sftpadp.common-key.cryptosystem.c2s=共通鍵暗号方式の優先順位（クライアントからサーバへの通信）

クライアントからサーバへの暗号化通信の確立に使用する，共通鍵暗号方式の優先順位を指定します。

指定できる共通鍵暗号方式と，デフォルトの優先順位を次の表に示します。これらの共通鍵暗号方式を優先順位の高い順に，「sftpadp.common-key.cryptosystem.c2s=共通鍵暗号方式,共通鍵暗号方式,共通鍵暗号方式」のようにコンマで区切って指定してください。この表にない共通鍵暗号方式を指定すると，SFTPアダプタの開始時にエラーとなります。

デフォルトの優先順位

共通鍵暗号方式

高

aes128-ctr

↑

aes192-ctr

｜

aes256-ctr

↓

aes128-gcm@openssh.com

低

aes256-gcm@openssh.com

sftpadp.common-key.cryptosystem.s2c=共通鍵暗号方式の優先順位（サーバからクライアントへの通信）

サーバからクライアントへの暗号化通信の確立に使用する，共通鍵暗号方式の優先順位を指定します。

指定できる共通鍵暗号方式と，デフォルトの優先順位を次の表に示します。これらの共通鍵暗号方式を優先順位の高い順に，「sftpadp.common-key.cryptosystem.s2c=共通鍵暗号方式,共通鍵暗号方式,共通鍵暗号方式」のようにコンマで区切って指定してください。この表にない共通鍵暗号方式を指定すると，SFTPアダプタの開始時にエラーとなります。

デフォルトの優先順位

共通鍵暗号方式

高

aes128-ctr

↑

aes192-ctr

｜

aes256-ctr

↓

aes128-gcm@openssh.com

低

aes256-gcm@openssh.com

sftpadp.message-authentication-code.c2s=メッセージ認証コード方式の優先順位（クライアントからサーバへの通信）

クライアントからサーバへの通信で使用する，メッセージ認証コード方式（データの改ざんを防ぐ機構）の優先順位を指定します。

指定できるメッセージ認証コード方式と，デフォルトの優先順位を次の表に示します。これらのメッセージ認証コード方式を優先順位の高い順に，「sftpadp.message-authentication-code.c2s=コード方式,コード方式,コード方式」のようにコンマで区切って指定してください。この表にないメッセージ認証コード方式を指定すると，SFTPアダプタの開始時にエラーとなります。

デフォルトの優先順位

メッセージ認証コード方式

高

hmac-sha2-256-etm@openssh.com

↑

hmac-sha2-512-etm@openssh.com

｜

hmac-sha1-etm@openssh.com

｜

hmac-sha2-256

↓

hmac-sha2-512

低

hmac-sha1

sftpadp.message-authentication-code.s2c=メッセージ認証コード方式の優先順位（サーバからクライアントへの通信）

サーバからクライアントへの通信で使用する，メッセージ認証コード方式（データの改ざんを防ぐ機構）の優先順位を指定します。

指定できるメッセージ認証コード方式と，デフォルトの優先順位を次の表に示します。これらのメッセージ認証コード方式を優先順位の高い順に，「sftpadp.message-authentication-code.s2c=コード方式,コード方式,コード方式」のようにコンマで区切って指定してください。この表にないメッセージ認証コード方式を指定すると，SFTPアダプタの開始時にエラーとなります。

デフォルトの優先順位

メッセージ認証コード方式

高

hmac-sha2-256-etm@openssh.com

↑

hmac-sha2-512-etm@openssh.com

｜

hmac-sha1-etm@openssh.com

｜

hmac-sha2-256

↓

hmac-sha2-512

低

hmac-sha1

sftpadp.host-key.algorithm=ホスト認証の方式の優先順位

ホスト認証の方式の優先順位を指定します。

指定できるホスト認証の方式と，デフォルトの優先順位を次の表に示します。これらのホスト認証の方式を優先順位の高い順に，「sftpadp.host-key.algorithm=ホスト認証の方式,ホスト認証の方式,ホスト認証の方式」のようにコンマで区切って指定してください。この表にないホスト認証の方式を指定すると，SFTPアダプタの開始時にエラーとなります。

デフォルトの優先順位

ホスト認証の方式

高

ecdsa-sha2-nistp256

↑

ecdsa-sha2-nistp384

｜

ecdsa-sha2-nistp521

↓

rsa-sha2-512

低

rsa-sha2-256

sftpadp.data-compression.algorithm.c2s=データ圧縮アルゴリズムの優先順位（クライアントからサーバへの通信）

クライアントからサーバへの通信で使用する，データ圧縮アルゴリズムの優先順位を指定します。

指定できるデータ圧縮アルゴリズムと，デフォルトの優先順位を次の表に示します。これらのデータ圧縮アルゴリズムを優先順位の高い順に，「sftpadp.data-compression.algorithm.c2s=データ圧縮アルゴリズム,データ圧縮アルゴリズム,データ圧縮アルゴリズム」のようにコンマで区切って指定してください。この表にないデータ圧縮アルゴリズムを指定すると，SFTPアダプタの開始時にエラーとなります。

デフォルトの優先順位

データ圧縮アルゴリズム

高

zlib@openssh.com

低

zlib

sftpadp.data-compression.algorithm.s2c=データ圧縮アルゴリズムの優先順位（サーバからクライアントへの通信）

サーバからクライアントへの通信で使用する，データ圧縮アルゴリズムの優先順位を指定します。

指定できるデータ圧縮アルゴリズムと，デフォルトの優先順位を次の表に示します。これらのデータ圧縮アルゴリズムを優先順位の高い順に，「sftpadp.data-compression.algorithm.s2c=データ圧縮アルゴリズム,データ圧縮アルゴリズム,データ圧縮アルゴリズム」のようにコンマで区切って指定してください。この表にないデータ圧縮アルゴリズムを指定すると，SFTPアダプタの開始時にエラーとなります。

デフォルトの優先順位

データ圧縮アルゴリズム

高

zlib@openssh.com

低

zlib

sftpadp.strict.key.exchange.enabled={true｜false}　〜<<true>>

SFTPサーバとの接続時に厳密な鍵交換をするかどうかを指定します。このプロパティまたはsftpadp.required.strict.key.exchangeプロパティにtrueが設定された場合は，厳密な鍵交換が実施されます。

true

SFTPサーバとの接続時に厳密な鍵交換（strict key exchange）を実施します。

ただし，接続先のOpenSSHサーバが厳密な鍵交換機能をサポートしていなければ，厳密な鍵交換は実施されません。

false

SFTPサーバとの接続時に厳密な鍵交換（strict key exchange）を実施しません。

sftpadp.required.strict.key.exchange={true｜false}　〜<<false>>

厳密な鍵交換機能をサポートしていないSFTPサーバとの接続を禁止するかどうかを指定します。このプロパティまたはsftpadp.strict.key.exchange.enabledプロパティにtrueが設定された場合は，厳密な鍵交換が実施されます。

true

厳密な鍵交換機能をサポートしていないSFTPサーバとの接続を禁止します。

厳密な鍵交換機能をサポートしていないSFTPサーバと接続しようとした場合，リクエスト処理を中断してエラー終了します。

false

厳密な鍵交換機能をサポートしていないSFTPサーバとの接続を禁止しません。

厳密な鍵交換機能をサポートしていないSFTPサーバとの接続は許可されます。

sftpadp.pubkey.accepted.algorithms=公開鍵認証で許可する署名アルゴリズム

公開鍵認証で許可する署名アルゴリズムを指定します。

指定できる署名アルゴリズムと，デフォルトの優先順位を次の表に示します。これらの署名アルゴリズムを優先順位の高い順に，「sftpadp.pubkey.accepted.algorithms=署名アルゴリズム,署名アルゴリズム,署名アルゴリズム」のようにコンマで区切って指定してください。この表にない署名アルゴリズムを指定すると，SFTPアダプタの開始時にエラーとなります。

デフォルトの優先順位

署名アルゴリズム

高

ecdsa-sha2-nistp256

↑

ecdsa-sha2-nistp384

｜

ecdsa-sha2-nistp521

↓

rsa-sha2-512

低

rsa-sha2-256

(d)　セッション接続タイムアウト

sftpadp.session.timeout=セッション接続処理のタイムアウト時間　〜＜数字＞((1−3600))<<10>>

セッション接続処理のタイムアウトまでの待ち時間を指定します（単位：秒）。

sftpadp.session-con.retry.count=セッション確立失敗時のリトライ回数　〜＜数字＞((0−10000))<<5>>

相手先のビジーなどによってセッションを確立できなかった場合に，接続をリトライする回数を指定します。0を指定した場合はリトライされません。

sftpadp.session-con.retry.interval=セッション確立失敗時のリトライ間隔　〜＜数字＞((0−86400))<<2>>

相手先のビジーなどによってセッションを確立できなかった場合，接続をリトライする間隔を指定します（単位：秒）。0を指定した場合は，間隔をあけないでリトライします。

(e)　排他取得タイムアウト

sftpadp.read-lock.retry.count=共通フォルダの共有ロック失敗時のリトライ回数　〜＜数字＞((0−1024))<<0>>

共通フォルダのファイルの共有ロックに失敗した場合のリトライ回数を指定します。

sftpadp.read-lock.retry.interval=共通フォルダの共有ロック失敗時のリトライ間隔　〜＜数字＞((1−1024))<<1>>

共通フォルダのファイルの共有ロックに失敗した場合のリトライ間隔を指定します（単位：秒）。

sftpadp.write-lock.retry.count=共通フォルダの占有ロック失敗時のリトライ回数　〜＜数字＞((0−1024))<<0>>

共通フォルダのファイルの占有ロックに失敗した場合のリトライ回数を指定します。

sftpadp.write-lock.retry.interval=共通フォルダの占有ロック失敗時のリトライ間隔　〜＜数字＞((1−1024))<<1>>

共通フォルダのファイルの占有ロックに失敗した場合のリトライ間隔を指定します（単位：秒）。

(f)　データ読み込みタイムアウト

sftpadp.data-read.timeout=SFTPサーバからの応答監視時間　〜＜数字＞((1−3600))<<60>>

GETオペレーション実行時のファイルデータ取得やアルゴリズムネゴシエーションの結果取得など，SFTPサーバからの応答の監視時間を指定します（単位：秒）。

指定した時間を経過しても受信が完了しない場合は，例外（エラー）が発生します。

(g)　保守用ログ

sftpadp.methodtrace.level={1｜2｜3｜4｜5}　〜<<3>>

保守用ログの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

出力情報

出力レベル

1

2

3

4

5

リクエスタサービスメソッドの入口／出口情報（クラス名，メソッド名，引数，戻り値）

×

○

○

○

○

外部（BPなど）のインターフェースの入口／出口情報（クラス名，メソッド名，引数，戻り値）

×

×

○

○

○

コンポーネント内インターフェースの入口／出口情報（クラス名，メソッド名，引数，戻り値）

×

×

×

○

○

デバッグ情報（処理の分岐などの情報）

×

×

×

×

○

（凡例）

○：出力されます。

×：出力されません。

sftpadp.methodtrace.filenum=保守用ログの面数　〜＜数字＞((1−16))<<8>>

保守用ログの面数を指定します。

sftpadp.methodtrace.filesize=保守用ログの1面当たりの最大サイズ　〜＜数字＞((4096−2147483647))<<2097152>>

保守用ログの1面当たりの最大サイズをバイト単位で指定します。

(h)　例外ログ

sftpadp.exptrace.filenum=例外ログの面数　〜＜数字＞((1−16))<<8>>

例外ログの面数を指定します。

sftpadp.exptrace.filesize=例外ログの1面当たりの最大サイズ　〜＜数字＞((4096−2147483647))<<2097152>>

例外ログの1面当たりの最大サイズをバイト単位で指定します。

(i)　SFTPプロトコルトレース

sftpadp.sftpprotocoltrace.filenum=SFTPプロトコルトレースファイルの面数　〜＜数字＞((1−16)) <<8>>

プロトコルトレースファイルの面数を指定します。

sftpadp.sftpprotocoltrace.filesize=SFTPプロトコルトレースファイルの1面当たりの最大サイズ　〜＜数字＞((4096−2147483647)) <<2097152>>

プロトコルトレースファイルの1面当たりの最大サイズ数をバイト単位で指定します。

6.16.2　SFTPアダプタ実行環境共通プロパティファイル

(1)　形式

ファイルの記述形式はSFTPアダプタ実行環境プロパティファイルと同じです。記述形式については，「6.16.1　SFTPアダプタ実行環境プロパティファイル」を参照してください。

(2)　機能

すべてのSFTPアダプタに共通する構成情報を設定します。

(a)　ファイルの種類

SFTPアダプタ実行環境プロパティファイルは，次に示す2種類があります。

SFTPアダプタ実行環境プロパティファイル

有効範囲：特定のSFTPアダプタ

作成手順については「6.16.1　SFTPアダプタ実行環境プロパティファイル」を参照してください。

SFTPアダプタ実行環境共通プロパティファイル

有効範囲：すべてのSFTPアダプタ

これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。

また，1つのマシンに複数のHCSCサーバをセットアップした場合，SFTPアダプタ実行環境共通プロパティファイルをHCSCサーバごとに定義することもできます。

プロパティファイルおよび要求電文間で同じ内容が複数設定された場合のプロパティの優先度については，「6.16.1　SFTPアダプタ実行環境プロパティファイル」を参照してください。

(b)　作成手順

SFTPアダプタ実行環境共通プロパティファイルは次の手順で作成してください。

次のテンプレートファイルを基に，SFTPアダプタ実行環境共通プロパティファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥SFTP¥config¥templates¥adpsftp.properties

編集後のファイルを次のディレクトリに格納します。

なお，ファイル名「adpsftp.properties」は変更しないでください。

全HCSCサーバ共通の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥SFTP¥config¥common

特定のHCSCサーバ用の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥SFTP¥config¥<HCSCサーバ名>¥common

サブディレクトリ名の<HCSCサーバ名>と「common」を作成する際は，Windowsでは大文字・小文字は区別されないので，注意してください。

サブディレクトリ<HCSCサーバ名>には，HCSCサーバの管理者（Service Coordinator管理者）がアクセスできるよう，適切なアクセス権限を設定してください。

(3)　設定できるプロパティ

設定できるプロパティはSFTPアダプタ実行環境プロパティファイルと同じです。設定できるプロパティについては，「6.16.1　SFTPアダプタ実行環境プロパティファイル」を参照してください。

6.17　Kafkaアダプタで利用するファイル

6.17.1　Kafkaアダプタ実行環境プロパティファイル

(1)　形式

［message.level={0｜10｜20}］

［methodtrace.level={1｜2｜3｜4｜5}］
［methodtracefile.num=メソッドトレースの出力面数］
［methodtracefile.size=メソッドトレースの出力サイズ］

［datatrace.level={0｜10｜20}］
［datatracefile.num=データトレースの出力面数］
［datatracefile.size=データトレースの出力サイズ］

［exptracefile.num=例外ログの出力面数］
［exptracefile.size=例外ログの出力サイズ］

　producer.bootstrap.servers=Kafkaクラスタへの初期接続を確立するために使用するホスト/ポート

［producer.buffer.memory=レコードをバッファリングするために使用できるメモリの合計バイト数］
［producer.receive.buffer.bytes=TCP受信ソケットバッファのサイズ］
［producer.send.buffer.bytes=TCP送信ソケットバッファのサイズ］

［producer.security.protocol={PLAINTEXT｜SSL}］
［producer.ssl.key.password=キーストアファイル内の秘密鍵のパスワード］
［producer.ssl.keystore.key=キーストアファイルの秘密キー］
［producer.ssl.keystore.location=キーストアファイルの格納場所］
［producer.ssl.keystore.password=キーストアファイルのストアパスワード］
［producer.ssl.truststore.location=トラストストアファイルの格納場所］
［producer.ssl.truststore.password=トラストストアファイルのパスワード］
［producer.ssl.enabled.protocols=SSL接続が有効になっているプロトコルのリスト］
［producer.ssl.keystore.type=キーストアファイルのファイル形式］
［producer.ssl.protocol=SSLコンテキストの生成に使用されるSSLプロトコル］
［producer.ssl.provider=SSL接続に使用されるセキュリティプロバイダの名前］
［producer.ssl.truststore.type=トラストストアファイルのファイル形式］

(2)　機能

Kafkaアダプタごとの構成情報を設定します。

(a)　ファイルの種類

Kafkaアダプタ実行環境プロパティファイルは，次に示す2種類があります。

Kafkaアダプタ実行環境プロパティファイル

有効範囲：特定のKafkaアダプタ

Kafkaアダプタ実行環境共通プロパティファイル

有効範囲：すべてのKafkaアダプタ

作成手順については「6.17.2　Kafkaアダプタ実行環境共通プロパティファイル」を参照してください。

これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。

また，1つのマシンに複数のHCSCサーバをセットアップした場合，Kafkaアダプタ実行環境プロパティファイルをHCSCサーバごとに定義することもできます。これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。

同じ内容がKafkaアダプタ実行環境プロパティファイルとKafkaアダプタ実行環境共通プロパティファイルの間で複数設定された場合，次の表でより優先度の高いものが適用されます。

指定個所

重複時の優先度

Kafkaアダプタ実行環境プロパティファイル

（HCSCサーバ単位の指定：あり）

高

Kafkaアダプタ実行環境共通プロパティファイル

（HCSCサーバ単位の指定：あり）

｜

Kafkaアダプタ実行環境プロパティファイル

（HCSCサーバ単位の指定：なし）

｜

Kafkaアダプタ実行環境共通プロパティファイル

（HCSCサーバ単位の指定：なし）

低

(b)　作成手順

Kafkaアダプタ実行環境プロパティファイルは次の手順で作成してください。Kafkaアダプタ実行環境共通プロパティファイルの作成手順は，「6.17.2　Kafkaアダプタ実行環境共通プロパティファイル」を参照してください。

次のテンプレートファイルを基に，Kafkaアダプタ実行環境プロパティファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥Kafka¥config¥templates¥serviceid.properties

編集後のファイルをファイル名「<サービスID>.properties」で次のディレクトリに格納してください。

全HCSCサーバ共通の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥Kafka¥config

特定のHCSCサーバ用の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥Kafka¥config¥<HCSCサーバ名>

サブディレクトリ<HCSCサーバ名>を作成する際は，Windowsでは大文字・小文字は区別されないので，注意してください。

サブディレクトリ<HCSCサーバ名>には，HCSCサーバの管理者（Service Coordinator管理者）がアクセスできるよう，適切なアクセス権限を設定してください。

(3)　設定できるプロパティ

(a)　メッセージログ関連

message.level={0｜10｜20}　〜<<10>>

メッセージログの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

情報種別

出力レベル

0

10

20

エラー情報

○

○

○

警告情報

△

○

○

インフォメーション

△

△

○

（凡例）

○：出力されます。

△：重要なメッセージログだけ出力されます。

(b)　メソッドトレース関連

methodtrace.level={1｜2｜3｜4｜5}　〜<<3>>

メソッドトレースの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

情報種別

出力レベル

1

2

3

4

5

メソッド内のエラー

○

○

○

○

○

外部から呼び出されるメソッド情報およびファイル入出力メソッドの開始・終了情報

×

○

○

○

○

ほかのHCSCコンポーネントから参照するpublicメソッドの開始・終了情報

×

×

○

○

○

ほかのHCSCコンポーネントから参照しない内部メソッド（public以外のメソッド）の開始・終了情報

×

×

×

○

○

デバッグ情報

×

×

×

×

○

（凡例）

○：出力されます。

×：出力されません。

methodtracefile.num=メソッドトレースの出力面数　〜＜数字＞((1−16))<<8>>

Kafkaアダプタが取得するメソッドトレース情報の出力ファイル面数を指定します。

methodtracefile.size=メソッドトレースの出力サイズ　〜＜数字＞((4096−2147483647))<<4194304>>

Kafkaアダプタが取得するメソッドトレース情報の出力ファイルサイズをバイト単位で指定します。

(c)　データトレース関連

datatrace.level={0｜10｜20}　〜<<0>>

データトレースの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

情報種別

出力レベル

0

10

20

メッセージ送信成功

×

×

○

メッセージ送信失敗

×

○

○

（凡例）

○：出力されます。

×：出力されません。

datatracefile.num=データトレースの出力面数　〜＜数字＞((1−16))<<8>>

Kafkaアダプタが取得するデータトレース情報の出力ファイル面数を指定します。

datatracefile.size=データトレースの出力サイズ　〜＜数字＞((4096−2147483647))<<67108864>>

Kafkaアダプタが取得するデータトレース情報の出力ファイルサイズをバイト単位で指定します。

(d)　例外ログ関連

exptracefile.num=例外ログの出力面数　〜＜数字＞((1−16))<<8>>

Kafkaアダプタが取得する例外ログの出力ファイル面数を指定します。

exptracefile.size=例外ログの出力サイズ　〜＜数字＞((4096−2147483647))<<4194304>>

Kafkaアダプタが取得する例外ログの出力ファイルサイズをバイト単位で指定します。

(e)　サーバ情報

producer.bootstrap.servers=Kafkaクラスタへの初期接続を確立するために使用するホスト/ポート

Kafkaクラスタへの初期接続を確立するために使用するホスト/ポートを指定します。指定は省略できません。

指定した値は，Kafkaサーバへのメッセージ送信に使用されるProducer APIのプロパティ「bootstrap.servers」に設定されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。

(f)　データサイズ制限

producer.buffer.memory=レコードをバッファリングするために使用できるメモリの合計バイト数　〜<<33554432>>

レコードをバッファリングするために使用できるメモリの合計バイト数を指定します。

指定した値は，Kafkaサーバへのメッセージ送信に使用されるProducer APIのプロパティ「buffer.memory」に設定されます。設定できる値の範囲などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。

producer.receive.buffer.bytes=TCP受信ソケットバッファのサイズ　〜<<32768>>

TCP受信ソケットバッファのサイズを指定します。

指定した値は，Kafkaサーバへのメッセージ送信に使用されるProducer APIのプロパティ「receive.buffer.bytes」に設定されます。設定できる値の範囲などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。

producer.send.buffer.bytes=TCP送信ソケットバッファのサイズ　〜<<131072>>

TCP送信ソケットバッファのサイズを指定します。

指定した値は，Kafkaサーバへのメッセージ送信に使用されるProducer APIのプロパティ「send.buffer.bytes」に設定されます。設定できる値の範囲などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。

(g)　セキュリティ情報

producer.security.protocol={PLAINTEXT｜SSL}　〜<<PLAINTEXT>>

Brokerとの通信に使用されるプロトコルを指定します。

PLAINTEXT

Brokerとの通信用のプロトコルにPLAINTEXTを使用します。

SSL

Brokerとの通信用のプロトコルにSSLを使用します。

指定した値はProducer APIのプロパティ「security.protocol」に設定され，Kafkaサーバへのメッセージ送信に使用されます。詳細については，Apache Kafkaの公式ドキュメントを参照してください。

producer.ssl.key.password=キーストアファイル内の秘密鍵のパスワード　〜<<null>>

キーストアファイル内の秘密鍵のパスワードを指定します。デフォルト値で動作させる場合は，このプロパティを定義しないでください。

指定した値はProducer APIのプロパティ「ssl.key.password」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。

producer.ssl.keystore.key=キーストアファイルの秘密キー　〜<<null>>

キーストアファイルの秘密キーを指定します。デフォルト値で動作させる場合は，このプロパティを定義しないでください。

指定した値はProducer APIのプロパティ「ssl.keystore.key」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。

producer.ssl.keystore.location=キーストアファイルの格納場所　〜<<null>>

キーストアファイルの格納場所を指定します。デフォルト値で動作させる場合は，このプロパティを定義しないでください。

指定した値はProducer APIのプロパティ「ssl.keystore.location」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。

producer.ssl.keystore.password=キーストアファイルのストアパスワード　〜<<null>>

キーストアファイルのストアパスワードを指定します。デフォルト値で動作させる場合は，このプロパティを定義しないでください。

指定した値はProducer APIのプロパティ「ssl.keystore.password」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。

producer.ssl.truststore.location=トラストストアファイルの格納場所　〜<<null>>

トラストストアファイルの格納場所を指定します。デフォルト値で動作させる場合は，このプロパティを定義しないでください。

指定した値はProducer APIのプロパティ「ssl.truststore.location」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。

producer.ssl.truststore.password=トラストストアファイルのパスワード　〜<<null>>

トラストストアファイルのパスワードを指定します。デフォルト値で動作させる場合は，このプロパティを定義しないでください。

指定した値はProducer APIのプロパティ「ssl.truststore.password」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。

producer.ssl.enabled.protocols=SSL接続が有効になっているプロトコルのリスト　〜<<TLSv1.2,TLSv1.3>>

SSL接続が有効になっているプロトコルのリストを指定します。

指定した値はProducer APIのプロパティ「ssl.enabled.protocols」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。

producer.ssl.keystore.type=キーストアファイルのファイル形式　〜<<JKS>>

キーストアファイルのファイル形式を指定します。

指定した値はProducer APIのプロパティ「ssl.keystore.type」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。

producer.ssl.protocol=SSLコンテキストの生成に使用されるSSLプロトコル　〜<<TLSv1.3>>

SSLコンテキストの生成に使用されるSSLプロトコルを指定します。

指定した値はProducer APIのプロパティ「ssl.protocol」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。

producer.ssl.provider=SSL接続に使用されるセキュリティプロバイダの名前　〜<<null>>

SSL接続に使用されるセキュリティプロバイダの名前を指定します。デフォルト値で動作させる場合は，このプロパティを定義しないでください。

指定した値はProducer APIのプロパティ「ssl.provider」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。

producer.ssl.truststore.type=トラストストアファイルのファイル形式　〜<<JKS>>

トラストストアファイルのファイル形式を指定します。

指定した値はProducer APIのプロパティ「ssl.truststore.type」に設定され，Kafkaサーバへのメッセージ送信に使用されます。設定できる値などの詳細については，Apache Kafkaの公式ドキュメントを参照してください。

6.17.2　Kafkaアダプタ実行環境共通プロパティファイル

(1)　形式

ファイルの記述形式はKafkaアダプタ実行環境プロパティファイルと同じです。記述形式については，「6.17.1　Kafkaアダプタ実行環境プロパティファイル」を参照してください。

(2)　機能

すべてのKafkaアダプタに共通する構成情報を設定します。

(a)　ファイルの種類

Kafkaアダプタ実行環境プロパティファイルは，次に示す2種類があります。

Kafkaアダプタ実行環境プロパティファイル

有効範囲：特定のKafkaアダプタ

作成手順については「6.17.1　Kafkaアダプタ実行環境プロパティファイル」を参照してください。

Kafkaアダプタ実行環境共通プロパティファイル

有効範囲：すべてのKafkaアダプタ

これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。

また，1つのマシンに複数のHCSCサーバをセットアップした場合，Kafkaアダプタ実行環境共通プロパティファイルをHCSCサーバごとに定義することもできます。

プロパティファイル間で同じ内容が複数設定された場合のプロパティの優先度については，「6.17.1　Kafkaアダプタ実行環境プロパティファイル」を参照してください。

(b)　作成手順

Kafkaアダプタ実行環境共通プロパティファイルは次の手順で作成してください。

次のテンプレートファイルを基に，Kafkaアダプタ実行環境共通プロパティファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥Kafka¥config¥templates¥adpkafkacom.properties

編集後のファイルを次のディレクトリに格納します。

なお，ファイル名「adpkafkacom.properties」は変更しないでください。

全HCSCサーバ共通の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥Kafka¥config¥common

特定のHCSCサーバ用の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥Kafka¥config¥<HCSCサーバ名>¥common

サブディレクトリ名の<HCSCサーバ名>と「common」を作成する際は，Windowsでは大文字・小文字は区別されないので，注意してください。

サブディレクトリ<HCSCサーバ名>には，HCSCサーバの管理者（Service Coordinator管理者）がアクセスできるよう，適切なアクセス権限を設定してください。

(3)　設定できるプロパティ

設定できるプロパティはKafkaアダプタ実行環境プロパティファイルと同じです。設定できるプロパティについては，「6.17.1　Kafkaアダプタ実行環境プロパティファイル」を参照してください。

6.18　スケジュール駆動受付で利用するファイル

6.18.1　スケジュール駆動受付コンフィグファイル

(1)　形式

［urecp-scd.eventhistory.log.enabled={true｜false}］
［urecp-scd.eventhistory.log.filenum=イベント履歴ログのファイル面数］
［urecp-scd.eventhistory.log.filesize=イベント履歴ログのファイルサイズ］

［urecp-scd.request-timeout=タスク実行時のビジネスプロセスの処理時間］
［urecp-scd.resident-thread.count=常駐させるスレッド数］

(2)　機能

スケジュール駆動受付のセットアップ後に，スケジュール駆動受付に関する構成情報の変更に使用します。変更頻度が高い情報を変更できます。

このファイルは必要に応じて設定してください。

(a)　ファイルの種類

スケジュール駆動受付コンフィグファイルには次の種類があります。同じプロパティが両方のファイルに設定されている場合，スケジュール駆動受付コンフィグファイルのプロパティ値が適用されます。

スケジュール駆動受付コンフィグファイル

有効範囲：特定のスケジュール駆動受付

スケジュール駆動受付共通コンフィグファイル

有効範囲：すべてのスケジュール駆動受付

作成手順については「6.18.2　スケジュール駆動受付共通コンフィグファイル」を参照してください。

(b)　作成手順

スケジュール駆動受付コンフィグファイルは次の手順で作成してください。

次のテンプレートファイルを基に，スケジュール駆動受付コンフィグファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-reception¥schedule¥config¥templates¥scheduletriggeredrecp_config.properties

編集後のファイルをファイル名「<受付ID>.properties」で次のディレクトリに格納します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-reception¥schedule¥config

作成したファイルはスケジュール駆動受付の開始時に読み込まれ，設定内容が有効になります。

(3)　設定できるプロパティ

(a)　イベント履歴ログ

urecp-scd.eventhistory.log.enabled={true｜false}　〜<<true>>

イベント履歴ログを出力するかどうかを設定します。

true

イベント履歴ログを出力します。

false

イベント履歴ログを出力しません。

urecp-scd.eventhistory.log.filenum=イベント履歴ログのファイル面数　〜＜数字＞((1−16))<<8>>

イベント履歴ログのファイル面数を指定します。

urecp-scd.eventhistory.log.filesize=イベント履歴ログのファイルサイズ　〜＜数字＞((4096−2147483647))<<2097152>>

イベント履歴ログの1面当たりのファイルサイズをバイト単位で指定します。

(b)　タイマ監視

urecp-scd.request-timeout=タスク実行時のビジネスプロセスの処理時間　〜＜数字＞ ((0−2147483647))<<0>>

タスク実行時のビジネスプロセスの処理時間を秒単位で指定します。

0を指定すると，タイマ監視は実行されません。

1以上を指定した場合，タイマ監視のため内部的にスレッドを生成して常駐させます。常駐スレッド数はurecp-scd.resident-thread.countプロパティで定義します。

urecp-scd.resident-thread.count=常駐させるスレッド数　〜＜数字＞ ((0−64))<<0>>

タスク実行時のビジネスプロセスの処理時間をタイマ監視する場合に，常駐させるスレッド数を指定します。常駐スレッドは，スケジュール駆動受付を起動したときに生成されます。タイマ監視をしない場合は，スレッドが生成されないため指定された値は無視されます。

指定値は，スケジュール駆動受付定義ファイルのurecp-scd.task.processing-max.parallel.countプロパティの指定値を超えない数値にしてください。この条件を満たさない場合，運用コマンド実行時にエラーとなります。

6.18.2　スケジュール駆動受付共通コンフィグファイル

(1)　形式

ファイルの記述形式はスケジュール駆動受付コンフィグファイルと同じです。記述形式については，「6.18.1　スケジュール駆動受付コンフィグファイル」を参照してください。

(2)　機能

すべてのスケジュール駆動受付に共通する構成情報を設定します。

(a)　ファイルの種類

スケジュール駆動受付コンフィグファイルには次の種類があります。同じプロパティが両方のファイルに設定されている場合，スケジュール駆動受付コンフィグファイルのプロパティ値が適用されます。

スケジュール駆動受付コンフィグファイル

有効範囲：特定のスケジュール駆動受付

作成手順については「6.18.1　スケジュール駆動受付コンフィグファイル」を参照してください。

スケジュール駆動受付共通コンフィグファイル

有効範囲：すべてのスケジュール駆動受付

(b)　作成手順

スケジュール駆動受付共通コンフィグファイルは次の手順で作成してください。

次のテンプレートファイルを基に，スケジュール駆動受付共通コンフィグファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-reception¥schedule¥config¥templates¥scheduletriggeredrecp_config.properties

編集後のファイルをファイル名「scheduletriggeredrecp_config.properties」で次のディレクトリに格納します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-reception¥schedule¥config¥common

作成したファイルはスケジュール駆動受付の開始時に読み込まれ，設定内容が有効になります。

(3)　設定できるプロパティ

設定できるプロパティはスケジュール駆動受付コンフィグファイルと同じです。記述形式については，「6.18.1　スケジュール駆動受付コンフィグファイル」を参照してください。

6.19　gRPCアダプタで利用するファイル

6.19.1　gRPCアダプタ実行環境プロパティファイル

(1)　形式

　adpgrpc.request.target=接続するgRPCサーバ
［adpgrpc.request.use-plaintext={true｜false}］

［adpgrpc.config.messagelog.level={0｜10｜20}］
［adpgrpc.config.methodtrace.level={1｜2｜3｜4｜5}］
［adpgrpc.config.methodtrace.filenum=メソッドトレースのファイル面数］
［adpgrpc.config.methodtrace.filesize=メソッドトレースのファイルサイズ］
［adpgrpc.config.exptrace.filenum=例外ログのファイル面数］
［adpgrpc.config.exptrace.filesize=例外ログのファイルサイズ］
［adpgrpc.config.datatrace.enabled={true｜false}］
［adpgrpc.config.datatrace.filenum=データトレースのファイル面数］
［adpgrpc.config.datatrace.filesize=データトレースのファイルサイズ］

［adpgrpc.security.tls.certificate-chain=証明書チェーンのファイルパス］
［adpgrpc.security.tls.client.certificate-chain=クライアントの証明書チェーンのファイルパス］
［adpgrpc.security.tls.client.private-key=クライアントの秘密鍵のファイルパス］
［adpgrpc.security.tls.client.private-key-password=クライアントの秘密鍵のパスワード］
［adpgrpc.security.token-based-auth.scope=OAuth 2.0スコープ］
［adpgrpc.security.token-based-auth.credentials=サービスアカウントキーファイル］

(2)　機能

gRPCアダプタごとの構成情報を設定します。

(a)　ファイルの種類

gRPCアダプタ実行環境プロパティファイルは，次に示す2種類があります。

gRPCアダプタ実行環境プロパティファイル

有効範囲：特定のgRPCアダプタ

gRPCアダプタ実行環境共通プロパティファイル

有効範囲：すべてのgRPCアダプタ

作成手順については「6.19.2　gRPCアダプタ実行環境共通プロパティファイル」を参照してください。

これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。

また，1つのマシンに複数のHCSCサーバをセットアップした場合，gRPCアダプタ実行環境プロパティファイルをHCSCサーバごとに定義することもできます。これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。

同じ内容がgRPCアダプタ実行環境プロパティファイルとgRPCアダプタ実行環境共通プロパティファイルの間で複数設定された場合，次の表でより優先度の高いものが適用されます。

指定個所

重複時の優先度

gRPCアダプタ実行環境プロパティファイル

（HCSCサーバ単位の指定：あり）

高

gRPCアダプタ実行環境共通プロパティファイル

（HCSCサーバ単位の指定：あり）

｜

gRPCアダプタ実行環境プロパティファイル

（HCSCサーバ単位の指定：なし）

｜

gRPCアダプタ実行環境共通プロパティファイル

（HCSCサーバ単位の指定：なし）

低

(b)　作成手順

gRPCアダプタ実行環境プロパティファイルは次の手順で作成してください。gRPCアダプタ実行環境共通プロパティファイルの作成手順は，「6.19.2　gRPCアダプタ実行環境共通プロパティファイル」を参照してください。

次のテンプレートファイルを基に，gRPCアダプタ実行環境プロパティファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥gRPC¥config¥templates¥serviceid.properties

編集後のファイルをファイル名「<サービスID>.properties」で次のディレクトリに格納してください。

全HCSCサーバ共通の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥gRPC¥config

特定のHCSCサーバ用の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥gRPC¥config¥<HCSCサーバ名>

サブディレクトリ<HCSCサーバ名>を作成する際は，Windowsでは大文字・小文字は区別されないので，注意してください。

サブディレクトリ<HCSCサーバ名>には，HCSCサーバの管理者（Service Coordinator管理者）がアクセスできるよう，適切なアクセス権限を設定してください。

(3)　設定できるプロパティ

(a)　プロトコル動作指定

adpgrpc.request.target=接続するgRPCサーバ　〜＜文字列＞

接続するgRPCサーバを次の形式で指定します。「:」は半角のコロンです。

IPアドレスまたはホスト名:ポート番号

このプロパティが定義されていない場合や，不正な値が設定されている場合は，gRPCアダプタの起動でエラーとなります。

adpgrpc.request.use-plaintext={true｜false}　〜<<false>>

gRPCサーバへのプレーンテキスト接続の有無を設定します。大文字と小文字は区別されます。

true

gRPCサーバへプレーンテキスト接続します。

false

TLSによるgRPCサーバとの接続を実施します。

範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。

(b)　ロギング

adpgrpc.config.messagelog.level={0｜10｜20}　〜<<10>>

メッセージログの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

情報種別

出力レベル

0

10

20

エラー情報

○

○

○

警告情報

△

○

○

インフォメーション

△

△

○

（凡例）

○：出力されます。

△：重要なメッセージログだけ出力されます。

範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。

adpgrpc.config.methodtrace.level={1｜2｜3｜4｜5}　〜<<3>>

メソッドトレースの出力レベルを指定します。出力情報と出力レベルを次の表に示します。

情報種別

出力レベル

1

2

3

4

5

メソッド内のエラー

○

○

○

○

○

外部から呼び出されるメソッド情報およびファイル入出力メソッドの開始・終了情報

×

○

○

○

○

ほかのHCSCコンポーネントから参照するpublicメソッドの開始・終了情報

×

×

○

○

○

ほかのHCSCコンポーネントから参照しない内部メソッド（public以外のメソッド）の開始・終了情報

×

×

×

○

○

デバッグ情報

×

×

×

×

○

（凡例）

○：出力されます。

×：出力されません。

範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。

adpgrpc.config.methodtrace.filenum=メソッドトレースのファイル面数　〜＜数字＞((1−16))<<8>>

メソッドトレースのファイル面数を指定します。

範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。

adpgrpc.config.methodtrace.filesize=メソッドトレースのファイルサイズ　〜＜数字＞((4096−2147483647))<<2097152>>

メソッドトレースのファイルサイズをバイト単位で指定します。

範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。

adpgrpc.config.exptrace.filenum=例外ログのファイル面数　〜＜数字＞((1−16))<<8>>

例外ログのファイル面数を指定します。

範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。

adpgrpc.config.exptrace.filesize=例外ログのファイルサイズ　〜＜数字＞((4096−2147483647))<<2097152>>

例外ログのファイルサイズをバイト単位で指定します。

範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。

adpgrpc.config.datatrace.enabled={true｜false}　〜<<false>>

データトレースの出力有無を指定します。大文字と小文字は区別されます。

true

データトレースを出力します。

false

データトレースを出力しません。

範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。

adpgrpc.config.datatrace.filenum=データトレースのファイル面数　〜＜数字＞((1−16))<<8>>

データトレースのファイル面数を指定します。

範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。

adpgrpc.config.datatrace.filesize=データトレースのファイルサイズ　〜＜数字＞((4096−2147483647))<<2097152>>

データトレースのファイルサイズをバイト単位で指定します。

範囲外の値を指定した場合，gRPCアダプタの起動でエラーとなります。

(c)　セキュリティ

adpgrpc.security.tls.certificate-chain=証明書チェーンのファイルパス

証明書チェーンのファイルパスを指定します。

存在しないファイルを指定した場合，gRPCアダプタの起動でエラーとなります。

証明書チェーンはPEMエンコードとする必要があります。PEMエンコードでない場合は動作を保証しません。

指定を省略した場合は，信頼できる証明書を格納したキーストア（トラストストア）が使用されます。詳細については，マニュアル「サービスプラットフォーム 開発ガイド 受付・アダプタ定義編」の「付録K.1　キーストアに関する設定」を参照してください。

adpgrpc.security.tls.client.certificate-chain=クライアントの証明書チェーンのファイルパス

クライアントの証明書チェーンのファイルパスを指定します。

存在しないファイルを指定した場合，gRPCアダプタの起動でエラーとなります。

証明書チェーンはPEMエンコードとする必要があります。PEMエンコードでない場合は動作を保証しません。

adpgrpc.security.tls.client.private-key=クライアントの秘密鍵のファイルパス

クライアントの秘密鍵のファイルパスを指定します。

存在しないファイルを指定した場合，gRPCアダプタの起動でエラーとなります。

秘密鍵はPKCS#8形式とする必要があります。PKCS#8形式でない場合は動作を保証しません。

adpgrpc.security.tls.client.private-key-password=クライアントの秘密鍵のパスワード

クライアントの秘密鍵のパスワードを指定します。

不正なパスワードを指定した場合，gRPCアダプタの起動でエラーとなります。

adpgrpc.security.token-based-auth.scope=OAuth 2.0スコープ

Google APIへのアクセスに必要となるOAuth 2.0スコープを「コンマ（,）」区切りで指定します。認証されたユーザを承認するか判定するために使用されます。

不正な値を指定した場合，gRPCアダプタの起動でエラーとなります。

adpgrpc.security.token-based-auth.credentials=サービスアカウントキーファイル

サービスアカウントキーファイルのファイルパスを指定します。指定されたファイルがJSON形式でない場合の動作は保証しません。

存在しないファイルを指定した場合，gRPCアダプタの起動でエラーとなります。

6.19.2　gRPCアダプタ実行環境共通プロパティファイル

(1)　形式

ファイルの記述形式はgRPCアダプタ実行環境プロパティファイルと同じです。記述形式については，「6.19.1　gRPCアダプタ実行環境プロパティファイル」を参照してください。

(2)　機能

すべてのgRPCアダプタに共通する構成情報を設定します。

(a)　ファイルの種類

gRPCアダプタ実行環境プロパティファイルは，次に示す2種類があります。

gRPCアダプタ実行環境プロパティファイル

有効範囲：特定のgRPCアダプタ

作成手順については「6.19.1　gRPCアダプタ実行環境プロパティファイル」を参照してください。

gRPCアダプタ実行環境共通プロパティファイル

有効範囲：すべてのgRPCアダプタ

これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。

また，1つのマシンに複数のHCSCサーバをセットアップした場合，gRPCアダプタ実行環境共通プロパティファイルをHCSCサーバごとに定義することもできます。

プロパティファイル間で同じ内容が複数設定された場合のプロパティの優先度については，「6.19.1　gRPCアダプタ実行環境プロパティファイル」を参照してください。

(b)　作成手順

gRPCアダプタ実行環境共通プロパティファイルは次の手順で作成してください。

次のテンプレートファイルを基に，gRPCアダプタ実行環境共通プロパティファイルを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥gRPC¥config¥templates¥adpgrpccom.properties

編集後のファイルを次のディレクトリに格納します。

なお，ファイル名「adpgrpccom.properties」は変更しないでください。

全HCSCサーバ共通の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥gRPC¥config¥common

特定のHCSCサーバ用の定義の場合

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥gRPC¥config¥<HCSCサーバ名>¥common

サブディレクトリ名の<HCSCサーバ名>と「common」を作成する際は，Windowsでは大文字・小文字は区別されないので，注意してください。

サブディレクトリ<HCSCサーバ名>には，HCSCサーバの管理者（Service Coordinator管理者）がアクセスできるよう，適切なアクセス権限を設定してください。

(3)　設定できるプロパティ

設定できるプロパティはgRPCアダプタ実行環境プロパティファイルと同じです。設定できるプロパティについては，「6.19.1　gRPCアダプタ実行環境プロパティファイル」を参照してください。

6.20　ユーザ認証で利用するファイル

6.20.1　ユーザ認証情報管理コマンド定義ファイル

(1)　形式

［authinfo.command.messagelog.filepath=メッセージログファイルの出力先ディレクトリの絶対パス］
［authinfo.command.messagelog.filenum=メッセージログファイルの面数］
［authinfo.command.messagelog.filesize=メッセージログファイルの1面当たりの最大サイズ］

(2)　機能

次に示すユーザ認証情報管理コマンドを実行した場合の構成定義を設定します。

csakeyaddコマンド（公開鍵認証の秘密鍵情報の登録・更新）

csakeydelコマンド（公開鍵認証の秘密鍵情報の削除）

csakeylsコマンド（公開鍵認証の秘密鍵情報の表示）

csauseraddコマンド（パスワード認証のユーザ情報の登録・更新）

csauserdelコマンド（パスワード認証のユーザ情報の削除）

csauserlsコマンド（パスワード認証のユーザ情報の表示）

ユーザ認証情報管理コマンド定義ファイルは次の手順で作成してください。

次のテンプレートファイルを基に，プロパティを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥msg¥templates¥authinfocommand.properties

編集後のファイルを次のディレクトリに格納してください。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥config¥msg

ファイル名「authinfocommand.properties」は変更しないでください。

(3)　設定できるプロパティ

authinfo.command.messagelog.filepath=メッセージログファイルの出力先ディレクトリの絶対パス　〜＜文字列（2バイト文字含む）および空白＞<<<サービスプラットフォームのインストールディレクトリ>¥CSC¥log¥msg¥command>>

ユーザ認証情報管理コマンドのメッセージログファイルの出力先ディレクトリを絶対パスで指定します。

authinfo.command.messagelog.filenum=メッセージログファイルの面数　〜＜数字＞((1−64))<<2>>

ユーザ認証情報管理コマンドのメッセージログファイルの面数を指定します。

authinfo.command.messagelog.filesize=メッセージログファイルの1面当たりの最大サイズ　〜＜数字＞((4096−16777216))<<1048576>>

ユーザ認証情報管理コマンドのメッセージログファイルの1面当たりの最大サイズをバイト単位で指定します。

(4)　注意事項

同一のプロパティを複数記述しないでください。複数記述した場合，どの値が有効になるか保証されません。

6.20.2　アカウント情報管理コマンド定義ファイル

(1)　形式

［authinfo.command.messagelog.filepath=メッセージログファイルの出力先ディレクトリの絶対パス］
［authinfo.command.messagelog.filenum=メッセージログファイルの面数］
［authinfo.command.messagelog.filesize=メッセージログファイルの1面当たりの最大サイズ］

(2)　機能

次に示すアカウント情報管理コマンドを実行した場合の構成定義を設定します。

csahttpuseraddコマンド（HTTPアダプタで使用するアカウント情報の登録・更新）

csahttpuserdelコマンド（HTTPアダプタで使用するアカウント情報の削除）

csahttpuserlsコマンド（HTTPアダプタで使用するアカウント認証のユーザ情報の表示）

アカウント情報管理コマンド定義ファイルは次の手順で作成してください。

次のテンプレートファイルを基に，プロパティを定義します。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥HTTP¥config¥templates¥authinfocommand.properties

編集後のファイルを次のディレクトリに格納してください。

<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥HTTP¥config

ファイル名「authinfocommand.properties」は変更しないでください。

(3)　設定できるプロパティ

authinfo.command.messagelog.filepath=メッセージログファイルの出力先ディレクトリの絶対パス　〜＜文字列（2バイト文字含む）および空白＞<<<サービスプラットフォームのインストールディレクトリ>¥CSC¥log¥adapter¥command>>

アカウント情報管理コマンドのメッセージログファイルの出力先ディレクトリを絶対パスで指定します。

authinfo.command.messagelog.filenum=メッセージログファイルの面数　〜＜数字＞((1−64))<<2>>

アカウント情報管理コマンドのメッセージログファイルの面数を指定します。

authinfo.command.messagelog.filesize=メッセージログファイルの1面当たりの最大サイズ　〜＜数字＞((4096−16777216))<<1048576>>

アカウント情報管理コマンドのメッセージログファイルの1面当たりの最大サイズをバイト単位で指定します。

(4)　注意事項

同一のプロパティを複数記述しないでください。複数記述した場合，どの値が有効になるか保証されません。

6.21　ユーザ情報の登録で利用するファイル

6.21.1　ユーザ情報指定ファイル

(1)　形式

ユーザ情報指定ファイルの指定形式は，コマンドによって次のように異なります。コマンド内でパラメタの指定順序は変更できません。

csaftpuseraddコマンドの場合

<ログインユーザID><タブ文字><ログインパスワード><タブ文字>[<課金情報>]

csmftpaddusrコマンドの場合

<ユーザ名><タブ文字><パスワード>

csmmailaddusrコマンドの場合

<ログインユーザ名><タブ文字><パスワード>

csakeyaddコマンドの場合

<秘密鍵のファイルパス><タブ文字><鍵ID><タブ文字>[<秘密鍵のパスフレーズ>]

csauseraddコマンドの場合

<ユーザ名><タブ文字><パスワード>

csahttpuseraddコマンドの場合

<ユーザ名><タブ文字><パスワード><タブ文字><接続先URI>

または

<アクセスキーID><タブ文字><シークレットアクセスキー><タブ文字><アクセスキーペアID>

(2)　機能

ユーザ情報指定ファイルには，コマンドに応じたユーザ情報を記載します。コマンドのオプション「-userinfofile」にファイルパスを指定して実行することで，設定されたユーザ情報を登録または更新できます。

ユーザ情報指定ファイルを指定できるコマンドを次に示します。これらのコマンドについては，「5.4　サービスプラットフォームの運用環境および実行環境で使用するコマンド」にある，該当するコマンドの説明を参照してください。

csaftpuseraddコマンド（FTPアダプタのユーザの登録・更新）

csmftpaddusrコマンド（FTPインバウンドアダプタのユーザの登録・更新）

csmmailaddusrコマンド（メールアダプタユーザ情報の登録・更新）

csakeyaddコマンド（公開鍵認証の秘密鍵情報の登録・更新）

csauseraddコマンド（パスワード認証のユーザ情報の登録・更新）

csahttpuseraddコマンド（HTTPアダプタで使用するアカウント情報の登録・更新）

ユーザ情報指定ファイルの指定規則を次に示します。

パラメタの間はタブ文字で区切って指定してください。

複数のユーザ情報を記載する場合は，改行文字で区切ってください。空行は無視されます。

ファイルに使用できる文字コードは，BOMコード無しのUTF-8だけです。それ以外の文字コードを使用した場合の動作は保証しません。

ユーザ情報指定ファイルの内容が次の状態である場合は，コマンド実行時にエラーとなります。

指定が必要なパラメタが記載されていない

指定できないパラメタが記載されている

ユーザ情報指定ファイルが空（または改行だけ）である

(3)　ファイルの格納先

任意のファイル名で任意のディレクトリに保存してください。

(4)　設定できるパラメタ

(a)　csaftpuseraddコマンドの場合

設定できるパラメタを次に示します。各パラメタの設定方法は，列「該当するコマンドオプション」に示すオプションと同じです。

パラメタ

該当するコマンドオプション

ログインユーザID

-user

ログインパスワード

-pass

課金情報

-account

設定方法については，「csaftpuseradd（FTPアダプタのユーザの登録・更新）」の該当するオプションの記載を参照してください。

なお，ファイル内に同じログインユーザIDが重複して記載されている場合，コマンド実行時にエラーとなります。

(b)　csmftpaddusrコマンドの場合

設定できるパラメタを次に示します。各パラメタの設定方法は，列「該当するコマンドオプション」に示すオプションと同じです。

パラメタ

該当するコマンドオプション

ユーザ名

-usr

パスワード

-pass

設定方法については，「csmftpaddusr（FTPインバウンドアダプタのユーザの登録・更新）」の該当するオプションの記載を参照してください。

なお，ファイル内に同じユーザ名が重複して記載されている場合，コマンド実行時にエラーとなります。

(c)　csmmailaddusrコマンドの場合

設定できるパラメタを次に示します。各パラメタの設定方法は，列「該当するコマンドオプション」に示すオプションと同じです。

パラメタ

該当するコマンドオプション

ログインユーザ名

-user

ログインパスワード

-pass

設定方法については，「csmmailaddusr（メールアダプタユーザ情報の登録・更新）」の該当するオプションの記載を参照してください。

なお，ファイル内に同じログインユーザ名が重複して記載されている場合，コマンド実行時にエラーとなります。

(d)　csakeyaddコマンドの場合

設定できるパラメタを次に示します。各パラメタの設定方法は，列「該当するコマンドオプション」に示すオプションと同じです。

パラメタ

該当するコマンドオプション

秘密鍵のファイルパス

-keyfile

鍵ID

-keyid

秘密鍵のパスフレーズ

-pass

設定方法については，「csakeyadd（公開鍵認証の秘密鍵情報の登録・更新）」の該当するオプションの記載を参照してください。

なお，ファイル内に同じ鍵IDが重複して記載されている場合，コマンド実行時にエラーとなります。

(e)　csauseraddコマンドの場合

設定できるパラメタを次に示します。各パラメタの設定方法は，列「該当するコマンドオプション」に示すオプションと同じです。

パラメタ

該当するコマンドオプション

ユーザ名

-user

パスワード

-pass

設定方法については，「csauseradd（パスワード認証のユーザ情報の登録・更新）」の該当するオプションの記載を参照してください。

なお，ファイル内に同じユーザ名が重複して記載されている場合，コマンド実行時にエラーとなります。

(f)　csahttpuseraddコマンドの場合

設定できるパラメタを次に示します。各パラメタの設定方法は，列「該当するコマンドオプション」に示すオプションと同じです。

パラメタ

該当するコマンドオプション

ユーザ名

-user

パスワード

-pass

接続先URI

-uri

アクセスキーID

-accesskey

シークレットアクセスキー

-secretaccesskey

アクセスキーペアID

-accesskeypairid

設定方法については，「csahttpuseradd（HTTPアダプタで使用するアカウント情報の登録・更新）」の該当するオプションの記載を参照してください。

なお，ファイル内にユーザ名と接続先URIの同じ組み合わせが重複して記載されている場合，コマンド実行時にエラーとなります。

(5)　記述例

csaftpuseraddコマンドの-userinfofileオプションで指定する，ユーザ情報指定ファイルの記述例を次に示します。

user1<タブ文字>pass1
user2<タブ文字>pass2<タブ文字>account2

付録

付録A　文字コード対応表

ここでは，Code Converterでの文字コードの対応表を掲載しています。

Code Converterのユーザマッピングを作成する場合，または文字コード変換UOC内でCode ConverterのAPIを利用する場合には，次に示すバージョンのCode Converterを使用してください。

Windowsの場合

実行環境

Code Converter - Server Runtime for Java　04-02以降

開発環境

Code Converter - Development Kit for Java　04-02以降

Linuxの場合

実行環境

Code Converter - Runtime for Java　04-02以降

付録A.1　半角コードの対応表

Code Converterの半角コードの変換対応表を次に示します。

図A‒1　半角コードの変換対応表

（凡例）

−：該当する文字がありません

注1

EBCDICおよびEBCDIK（KEIS版）は準標準版に対応しているコードです。

標準版では，(5D)₁₆が(4F)₁₆に，(21)₁₆が(5A)₁₆になります。

注2

EBCDICおよびEBCDIK（KEIS版）で，(0A)₁₆は全角コードと半角コードの切り替えコードとして扱います。

注3

EBCDIC（IBM版）では，(0E)₁₆と(0F)₁₆は全角コードと半角コードの切り替えコードとして扱います。

注4

EBCDIC（JEF版）およびEBCDIK（JEF版）では，(28)₁₆，(29)₁₆，および(38)₁₆は全角コードと半角コードの切り替えコードとして扱います。

出力時には，(28)₁₆と(29)₁₆だけを全角コードと半角コードの切り替えコードとして扱います。

付録A.2　特殊文字のコード対応表

Code Converterの特殊文字のコード対応表を次に示します。

Code Converterは，ベンダ特殊文字としてWindows特殊文字，IBM選択文字，およびNEC選定IBM拡張文字の3種類に対応しています。IBM選択文字，NEC選定IBM拡張文字を使用する場合には，ユーザマッピングの定義が必要になります。

表A‒1　ベンダ特殊文字のコード対応表の変換内容一覧

変換内容

記載個所

Windows特殊文字

SJISとUnicode（UCS-2）

付録A.2(1)(a)

Unicode（UCS-2）からSJIS

付録A.2(1)(b)

IBM選択文字

付録A.2(2)

NEC選定IBM拡張文字

付録A.2(3)

(1)　Windows特殊文字の変換対応表

(a)　Windows特殊文字の対応表（SJISとUnicode（UCS-2））

注1

表中のH/L欄の数字は，SJISです。フォント（字体）が記載されている欄の数字は，Unicode（UCS-2）です。

注2

太枠部分は，SJISからUnicode（UCS-2）への変換だけです。Unicode（UCS-2）からSJISへの変換対応は，「(b)　Windows特殊文字の対応表（Unicode（UCS-2）からSJIS）」のようになります。

(b)　Windows特殊文字の対応表（Unicode（UCS-2）からSJIS）

(2)　IBM選択文字の対応表

(a)　IBM選択文字の対応表（SJISとUnicode（UCS-2））

注1

表中のH/L欄の数字は，SJISです。フォント（字体）が記載されている欄の数字は，Unicode（UCS-2）です。

注2

太枠部分は，SJISからUnicode（UCS-2）への変換だけです。Unicode（UCS-2）からSJISへの変換対応は，「(b)　IBM選択文字の対応表（Unicode（UCS-2）からSJIS）」のようになります。

(b)　IBM選択文字の対応表（Unicode（UCS-2）からSJIS）

(c)　IBM選択文字の対応表（IBMコードとUnicode（UCS-2））

(3)　NEC選定IBM拡張文字の対応表

(a)　NEC選定IBM拡張文字の対応表（SJISとUnicode（UCS-2））

(b)　NEC選定IBM拡張文字の対応表（Unicode（UCS-2）からSJIS）

付録B　用語解説

マニュアルで使用する用語について

マニュアル「アプリケーションサーバ & BPM/ESB基盤 用語解説」を参照してください。

索引

C

csaftpuseradd[1]

csaftpuserdel[1]

csaftpuserls[1]

csahttpuseradd[1]

csahttpuserdel[1]

csahttpuserls[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]

cscoas2servicedef[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コマンド定義ファイル[1]

cscsoapmode[1]

cscstatus[1]

cscsvcctl[1]

cscsvcls[1]

cscsvconfig[1]

cscsvsetup[1]

cscsvstart[1]

cscsvstop[1]

cscsvunsetup[1]

csctransform[1]

cscutil[1]

csmexecutebp[1]

csmftpaddusr[1]

csmftpdelusr[1]

csmftplshistory[1]

csmftplsusr[1]

csmmailaddusr[1]

csmmaildelusr[1]

csmmaillsusr[1]

D

DBアダプタマッピング設定ダイアログ[1]

DBアダプタ用のXMLフォーマット定義ファイルの生成[1]

DOMとバイナリデータの相互変換[1]

F

FTPアダプタアカウント定義ファイル[1]

FTPアダプタコマンド定義ファイル[1]

FTPアダプタ実行環境プロパティファイル[1]

FTPアダプタ実行環境プロパティファイル[1]

FTPアダプタのユーザの削除[1]

FTPアダプタのユーザの登録・更新[1]

FTPアダプタのユーザの表示[1]

FTPインバウンドアダプタのユーザの削除[1]

FTPインバウンドアダプタのユーザの登録・更新[1]

FTPインバウンドアダプタのユーザの表示[1]

FTP受付コンフィグファイル[1]

FTP受付定義ファイル[1]

FTPコマンド許可リスト定義ファイル[1]

FTP実行許可リスト定義ファイル[1]

FTP連携で利用するファイル〔運用環境・実行環境〕[1]

FTP連携で利用するファイル〔開発環境〕[1]

G

gRPCアダプタ実行環境共通プロパティファイル[1]

gRPCアダプタ実行環境プロパティファイル[1]

gRPCアダプタで利用するファイル〔運用環境・実行環境〕[1]

gRPCアダプタで利用するファイル〔開発環境〕[1]

gRPCアダプタ独自定義ファイル[1]

gRPC受付定義ファイル[1]

gRPC受付で利用するファイル〔開発環境〕[1]

H

HCSCTE結果ビュー〔HCSCコンポーネントおよびデータ変換定義作成時〕[1]

HCSC XPath 評価ビュー[1]

HCSC エミュレートビュー[1]

HCSCコンポーネント指定ファイル[1]

HCSCコンポーネント情報表示画面[1]

HCSCコンポーネントの開始[1]

HCSCコンポーネントの定義[1]

HCSCコンポーネントの停止[1]

HCSCコンポーネントの配備[1]

HCSCコンポーネントを作成する画面の構成[1]

HCSCサーバ構成定義ファイル[1]

HCSCサーバセットアップ定義ファイル[1]

HCSCサーバのアンセットアップ[1]

HCSCサーバの運用で利用するファイル[1]

HCSCサーバの起動[1]

HCSCサーバの構築で利用するファイル[1]

HCSCサーバのセットアップ[1]

HCSCサーバの停止[1]

HCSCサーバランタイム定義ファイル[1]

HCSCサーバランタイムの定義[1]

HCSC 自動エミュレートビュー[1]

HCSC-Manager環境のバックアップ[1]

HCSC-Manager環境のリストア[1]

HCSC-ManagerコマンドJavaVM起動オプション定義ファイル[1]

HCSC-Managerコマンド共通定義ファイル[1]

HCSC-Manager定義ファイル[1]

HCSC-Messagingコマンド共通定義ファイル[1]

HTTPアダプタアカウント定義ファイル[1]

HTTPアダプタ実行環境共通プロパティファイル[1]

HTTPアダプタ実行環境プロパティファイル[1]

HTTPアダプタ定義ファイル[1]

HTTPアダプタで使用するアカウント情報の削除[1]

HTTPアダプタで使用するアカウント情報の登録・更新[1]

HTTPアダプタで使用するアカウント認証のユーザ情報の表示[1]

HTTPアダプタで利用するファイル〔運用環境・実行環境〕[1]

HTTPアダプタで利用するファイル〔開発環境〕[1]

HTTP受付サービス選択定義ファイル[1]

HTTP受付定義ファイル[1]

HTTP受付で利用するファイル〔開発環境〕[1]

HTTP受付ルーティング定義ファイル[1]

HTTPレスポンスヘッダ定義ファイル[1]

I

IBM選択文字の対応表（IBMコードとUnicode（UCS-2））[1]

IBM選択文字の対応表（SJISとUnicode（UCS-2））[1]

IBM選択文字の対応表（Unicode（UCS-2）からSJIS）[1]

J

Java呼出アクティビティダイアログ[1]

JSON形式データからXSDファイルへの変換[1]

JSON形式データとXML形式データの相互変換[1]

JSON形式データとXML形式データの変換で利用するファイル〔開発環境〕[1]

JSON-XML変換定義ファイル[1]

K

Kafkaアダプタ実行環境共通プロパティファイル[1]

Kafkaアダプタ実行環境プロパティファイル[1]

Kafkaアダプタ定義ファイル[1]

Kafkaアダプタで利用するファイル〔運用環境・実行環境〕[1]

Kafkaアダプタで利用するファイル〔開発環境〕[1]

Kafka受付定義ファイル[1]

Kafka受付で利用するファイル〔開発環境〕[1]

M

Message Queueアダプタ環境定義ファイル[1]

Message Queueアダプタ実行環境プロパティファイル[1]

Message Queueアダプタ通信構成定義ファイル[1]

Message Queueアダプタで利用するファイル〔運用環境・実行環境〕[1]

Message Queueアダプタで利用するファイル〔開発環境〕[1]

Message Queue受付定義ファイル[1]

Message Queue受付で利用するファイル[1]

N

NEC選定IBM拡張文字の対応表（SJISとUnicode（UCS-2））[1]

NEC選定IBM拡張文字の対応表（Unicode（UCS-2）からSJIS）[1]

O

Object Accessアダプタ実行環境プロパティファイル[1]

Object Accessアダプタ通信構成定義ファイル[1]

Object Accessアダプタで利用するファイル〔運用環境・実行環境〕[1]

Object Accessアダプタで利用するファイル〔開発環境〕[1]

OpenAPI仕様書をHCSCコンポーネントの定義に変換[1]

S

SFTPアダプタ実行環境共通プロパティファイル[1]

SFTPアダプタ実行環境プロパティファイル[1]

SFTPアダプタで利用するファイル〔運用環境・実行環境〕[1]

SOAP Fault動作定義ファイル[1]

SOAP受付定義ファイル[1]

SOAPモードの設定[1]

SOAP連携で利用するファイル〔運用環境・実行環境〕[1]

SOAP連携で利用するファイル〔開発環境〕[1]

T

TP1/RPC受付定義ファイル[1]

TP1アダプタ環境定義ファイル[1]

TP1アダプタ実行環境プロパティファイル[1]

TP1アダプタ通信構成定義ファイル[1]

TP1連携で利用するファイル〔運用環境・実行環境〕[1]

TP1連携で利用するファイル〔開発環境〕[1]

U

URLパターン[1]

URLパラメタ[1]

W

Windows特殊文字の対応表（SJISとUnicode（UCS-2））[1]

Windows特殊文字の対応表（Unicode（UCS-2）からSJIS）[1]

WSDLカスタムバインディングファイルに関連するダイアログ[1]

X

XPathダイアログ[1]

あ

アイコンのサイズを設定する〔パレット〕[1]

アウトラインビュー[1]、[2]

アウトラインビューのフィルタ機能の設定[1]

アウトラインビュー〔ビジネスプロセス定義画面〕[1]

アカウント情報管理コマンド定義ファイル[1]

アクティビティ一覧表示の有効・無効を設定する[1]

アクティビティのアイコンのラベルサイズを変更する[1]

アクティビティのオートコネクト機能[1]

アクティビティの自動整列機能[1]

アクティビティのスナップ機能[1]

値置換えダイアログ[1]

値の設定ダイアログ[1]

アプリケーションの操作[1]

い

一覧表示コマンド（cscmsgtk）[1]

色を変更する〔マッピングの線〕[1]

インポート[1]

インポート可否の検証[1]

う

受付アクティビティダイアログ[1]

え

エクスポート[1]

エディタエリア[1]

エミュレート設定情報定義ファイル[1]

お

応答アクティビティダイアログ[1]

オートコネクト機能[1]

オブジェクトを切り取る[1]

オブジェクトをコピーする[1]

オブジェクトを削除する[1]

オブジェクトを整列する[1]

オブジェクトを貼り付ける[1]

オペレーション名の取込ダイアログ（受付アクティビティ）[1]

オペレーション名の取込ダイアログ（応答アクティビティ）[1]

か

解析対象絞り込みコマンド（cscmsgtk）[1]

各種操作[1]

カスタムダイアログ[1]

稼働運用ページ[1]

稼働運用ページ〔HCSCサーバ〕[1]

稼働運用ページ〔サービスアダプタ〕[1]

稼働運用ページ〔ビジネスプロセス〕[1]

稼働運用ページ〔ユーザ定義受付〕[1]

稼働確認ページ[1]

画面（運用環境）[1]

画面（開発環境）[1]

画面構成（運用環境）[1]

画面構成（開発環境）[1]

き

基数変換ダイアログ[1]

基本アクティビティ[1]

基本情報ページ[1]

基本情報ページ〔HCSCサーバ〕[1]

基本情報ページ〔サービスアダプタ〕[1]

基本情報ページ〔ビジネスプロセス〕[1]

基本情報ページ〔ユーザ定義受付〕[1]

キャンバス[1]

キャンバスの表示を拡大する[1]

キャンバスの表示を縮小する[1]

キャンバスの表示を元のサイズに戻す[1]

共通フォルダの削除[1]

共通フォルダの参照[1]

く

空白除去ダイアログ[1]

クライアント定義ファイル[1]

繰り返しアクティビティダイアログ[1]

繰り返し条件設定ダイアログ[1]

くり返し設定ダイアログ[1]

くり返しダイアログ[1]

繰り返しリスト設定ダイアログ[1]

け

検索結果フィールド〔履歴管理ページ〕[1]

検索条件フィールド〔履歴管理ページ〕[1]

検証アクティビティダイアログ[1]

検証・パッケージングに関連するダイアログ[1]

こ

公開鍵認証の秘密鍵情報の削除[1]

公開鍵認証の秘密鍵情報の登録・更新[1]

公開鍵認証の秘密鍵情報の表示[1]

構成要素ダイアログ[1]

構造アクティビティ[1]

コマンド（開発環境）[1]

コマンドアダプタ実行環境共通プロパティファイル[1]

コマンドアダプタ実行環境プロパティファイル[1]

コマンドアダプタで利用するファイル〔運用環境・実行環境〕[1]

コマンドの種類〔運用環境・実行環境〕[1]

コマンドの種類〔開発環境〕[1]

コマンドの同時実行[1]

コマンドの入力形式〔運用環境・実行環境〕[1]

コマンドの入力形式〔開発環境〕[1]

コマンドの文法の記述形式〔運用環境・実行環境〕[1]

コマンドの文法の記述形式〔開発環境〕[1]

コメントの背景色を変更する[1]

コメントを最小化する[1]

コメントを元のサイズに戻す[1]

コンソールビュー〔HCSCコンポーネントおよびデータ変換定義作成時〕[1]

コンソールビュー〔運用環境・実行環境〕[1]

コンソールビュー〔バイナリフォーマット作成時〕[1]

コンポーネントID設定ファイル[1]

コンポーネント共通UOC機能[1]

コンポーネント種別設定ファイル[1]

さ

サービスアダプタ定義画面[1]

サービスアダプタ定義画面（MDB（DBキュー）の基本画面）[1]

サービスアダプタ定義画面（MDB（WS-R）の基本画面）[1]

サービスアダプタ定義画面（MDB（WS-R）の詳細画面）[1]

サービスアダプタ定義画面（SessionBeanの基本画面）[1]

サービスアダプタ定義画面（SessionBeanの詳細画面）[1]

サービスアダプタ定義画面（Webサービスの基本画面）[1]

サービスアダプタ定義画面（Webサービスの詳細画面）[1]

サービスアダプタ定義画面（汎用カスタムアダプタの基本画面）[1]

サービスアダプタ定義画面（汎用カスタムアダプタの詳細画面）[1]

サービス情報の管理[1]

サービス情報の表示[1]

サービス情報変更定義ファイル[1]

サービスの操作に関連するダイアログ[1]

サービスプラットフォームの運用環境および実行環境で使用するコマンド[1]

サービスプラットフォームの開発環境で使用するコマンド[1]

サービス呼出アクティビティダイアログ[1]

作業フォルダの削除[1]

作業フォルダの参照[1]

し

識別子検索[1]

実行環境のバージョンアップ[1]

実行許可コマンド定義ファイル[1]

自動整列機能[1]

自動マッピング候補選択ダイアログ[1]

自動マッピング元設定ダイアログ[1]

シフト演算ダイアログ[1]

終了コマンド（cscmsgtk）[1]

出力モード切り替えコマンド（cscmsgtk）[1]

障害解析コマンド（cscmsgtk）[1]

条件設定ダイアログ[1]

条件設定ダイアログ（ノード条件の設定）[1]

条件設定ダイアログ（分岐アクティビティ）[1]

条件設定ダイアログ（並列処理アクティビティ）[1]

条件値設定ダイアログ[1]

条件追加/編集ダイアログ[1]

詳細情報フィールド〔履歴管理ページ〕[1]

状態表示[1]

［新規バイナリフォーマット定義ファイル］ウィザードのページ[1]

す

数値演算ダイアログ[1]

数値フォーマット変換ダイアログ[1]

スキーマツリービューアから要素のパスをコピーする[1]

スキーマ論理名[1]

スケジュール駆動受付共通コンフィグファイル[1]

スケジュール駆動受付コンフィグファイル[1]

スケジュール駆動受付定義ファイル[1]

スケジュール駆動受付で利用するファイル〔運用環境・実行環境〕[1]

スケジュール駆動受付で利用するファイル〔開発環境〕[1]

スコープアクティビティダイアログ[1]

スナップ機能[1]

せ

設定ダイアログ（WSDLカスタムバインディングファイルの設定）[1]

設定ダイアログ（検証・パッケージングの動作設定）[1]

設定ダイアログ（データ変換の設定）[1]

セパレータ選択ダイアログ[1]

セパレータ追加/変更ダイアログ[1]

選択ダイアログ[1]

そ

相関セット検索[1]

操作を元に戻す〔データ変換定義画面〕[1]

操作を元に戻す〔バイナリフォーマット定義エディタ〕[1]

操作を元に戻す〔ビジネスプロセス定義画面〕[1]

操作をやり直す〔データ変換定義画面〕[1]

操作をやり直す〔バイナリフォーマット定義エディタ〕[1]

総和ダイアログ[1]

ソート条件追加/編集ダイアログ[1]

属性[1]

た

待機アクティビティダイアログ[1]

代入アクティビティサブダイアログ[1]

代入アクティビティダイアログ[1]

タブ[1]

タブ〔ビジネスプロセス定義画面〕[1]

タブを閉じる[1]

タブを開く〔上位階層のタブ〕[1]

単純内容[1]

単純内容要素ダイアログ[1]

ち

置換種別（［フォーマット］ダイアログ）[1]

つ

ツールの一覧の表示または非表示を設定する[1]

ツリービュー〔HCSCコンポーネントおよびデータ変換定義作成時〕[1]

ツリービュー〔運用環境・実行環境〕[1]

て

定義画面および情報表示画面[1]

定義情報ページ[1]

定義情報ページ〔HCSCサーバ〕[1]

定義情報ページ〔ユーザ定義受付〕[1]

定義ファイル（運用環境・実行環境）[1]

定義ファイル（開発環境）[1]

定義ファイルの管理[1]

定義ファイルの種類〔運用環境・実行環境〕[1]

定義ファイルの種類〔開発環境〕[1]

定義ファイルの入力形式〔運用環境・実行環境〕[1]

定義ファイルの入力形式〔開発環境〕[1]

定義ファイルの文法の記述形式〔運用環境・実行環境〕[1]

定義ファイルの文法の記述形式〔開発環境〕[1]

定義領域〔HCSCコンポーネントおよびデータ変換定義作成時〕[1]

定義を保存する[1]

定数ダイアログ[1]

データ変換アクティビティダイアログ[1]

データ変換コマンドプロパティファイル[1]

データ変換単体テストコマンドで利用するファイル〔開発環境〕[1]

データ変換定義画面[1]

データ変換定義画面の操作[1]

データ変換に関連するダイアログ[1]

データ変換のテスト[1]

データ変換用システムプロパティファイル[1]

データ変換を定義する画面の構成[1]

デバッグ構成ダイアログ[1]

デバッグビュー[1]

転送履歴の表示[1]

電文フォーマットの取込ダイアログ[1]

と

特殊文字のコード対応表[1]

途中終了アクティビティダイアログ[1]

トレース取得ポイント表示コマンド（cscmsgtk）[1]

な

名前空間接頭辞をXMLに出力する〔データ変換定義画面〕[1]

に

日時/状態検索[1]

入力値を除去ダイアログ[1]

の

ノード条件設定ダイアログ[1]

ノード数取得ダイアログ[1]

ノード選択ダイアログ（データ変換）[1]

ノード選択ダイアログ（バイナリフォーマット定義）[1]

ノード調査ダイアログ[1]

ノード名取得ダイアログ[1]

は

バイナリ電文生成コマンドプロパティファイル[1]

バイナリ電文生成定義ファイル[1]

バイナリパースコマンドプロパティファイル[1]

バイナリフォーマット定義エディタ[1]

バイナリフォーマット定義画面[1]

バイナリフォーマット定義画面の操作[1]

バイナリフォーマット定義に関連するダイアログ[1]

バイナリフォーマット定義ファイルからXMLフォーマット定義ファイルの生成[1]

バイナリフォーマット定義ファイルを定義する画面の構成[1]

配備済みのHCSCコンポーネントの削除[1]

端数処理ダイアログ[1]

パスワード認証のユーザ情報の削除[1]

パスワード認証のユーザ情報の登録・更新[1]

パスワード認証のユーザ情報の表示[1]

パッケージ・エクスプローラー[1]

パレット設定ダイアログ[1]

パレット〔データ変換定義画面〕[1]

パレットの表示を設定する[1]

パレット〔ビジネスプロセス定義画面〕[1]

半角コードの対応表[1]

ひ

ビジネスプロセスエディタ[1]

ビジネスプロセス実行コマンド定義ファイル[1]

ビジネスプロセス定義画面[1]

ビジネスプロセス定義画面の操作[1]

ビジネスプロセスに関連するダイアログ[1]

ビジネスプロセスの実行[1]

ビジネスプロセスの実行で利用するファイル〔開発環境〕[1]

ビジネスプロセスのデバッグ画面の構成[1]

ビジネスプロセスのデバッグに関連するダイアログ[1]

否定演算ダイアログ[1]

非表示にする〔パレットのツールの一覧〕[1]

表示させる〔パレットのツールの一覧〕[1]

標準受付およびユーザ定義受付の開始[1]

標準受付およびユーザ定義受付の停止[1]

ふ

ファイルアダプタ実行環境プロパティファイル[1]

ファイルアダプタで利用するファイル〔運用環境・実行環境〕[1]

ファイルイベント受付共通コンフィグファイル[1]

ファイルイベント受付コンフィグファイル[1]

ファイルイベント受付定義ファイル[1]

ファイルイベント連携で利用するファイル[1]

ファイルイベント連携で利用するファイル〔開発環境〕[1]

ファイル操作アダプタ実行環境プロパティファイル[1]

ファイル操作アダプタ定義ファイル[1]

ファンクション選択ダイアログ[1]

フォーマットダイアログ[1]

フォーマット定義およびデータ変換定義の事前キャッシュ[1]

フォルト処理の割当ダイアログ[1]

フォルト送出アクティビティダイアログ[1]

フォントを設定する〔パレット〕[1]

複合内容[1]

複合内容要素ダイアログ[1]

複数サービス削除ダイアログ[1]

複数サービス追加ダイアログ[1]

複数パッケージングダイアログ[1]

複製マッピング範囲設定ダイアログ[1]

複製マッピング元設定ダイアログ[1]

部分文字列取得ダイアログ[1]

ブレークポイントビュー[1]

プロセスインスタンスの検索[1]

プロセスインスタンスの再実行[1]

プロセスインスタンスの実行履歴の削除[1]

プロセス環境変数定義ファイル[1]

プロパティービュー〔HCSCコンポーネントおよびデータ変換定義作成時〕[1]

プロパティービュー〔バイナリフォーマット作成時〕[1]

分岐アクティビティダイアログ[1]

へ

並列処理アクティビティダイアログ[1]

ヘッダ割当変数ダイアログ[1]

ヘルプ表示コマンド（cscmsgtk）[1]

変換先スキーマツリービューア[1]

変換ファンクション選択ダイアログ[1]

変換元スキーマツリービューア[1]

変換元スキーマファイル設定ダイアログ[1]

変換元・変換先スキーマファイル設定ダイアログ[1]

変数一覧表示の有効・無効を設定する[1]

変数の表示ダイアログ[1]

変数ビュー[1]

変数・相関セット一覧ダイアログ[1]

ほ

補償アクティビティダイアログ[1]

本番環境の簡易セットアップ[1]

ま

マッピング線の色を変更する[1]

マッピング定義登録ダイアログ[1]

マッピング定義のインポートダイアログ[1]

マッピング定義のエクスポートダイアログ[1]

マッピングビューア[1]

マッピングビューアのファンクションをコピーして貼り付ける[1]

マッピング元設定ダイアログ[1]

む

無操作アクティビティダイアログ[1]

め

名称検索ダイアログ[1]

メールアダプタアカウント定義ファイル[1]

メールアダプタコマンド定義ファイル[1]

メールアダプタ実行環境プロパティファイル[1]

メールアダプタで利用するファイル〔運用環境・実行環境〕[1]

メールアダプタユーザ情報の削除[1]

メールアダプタユーザ情報の登録・更新[1]

メールアダプタユーザ情報の表示[1]

メールヘッダ定義ファイル[1]

メッセージ定義ファイル[1]

メッセージトラッキング機能の起動[1]

メッセージトラッキングプロンプトで使用するコマンド（cscmsgtk）[1]

メニューバー[1]

も

文字コード対応表[1]

文字数取得ダイアログ[1]

文字列調査ダイアログ[1]

文字列連結ダイアログ[1]

元に戻した操作をやり直す〔ビジネスプロセス定義画面〕[1]

問題ビュー〔HCSCコンポーネントおよびデータ変換定義作成時〕[1]

問題ビュー〔バイナリフォーマット作成時〕[1]

ゆ

ユーザ情報指定ファイル[1]

ユーザ情報の登録で利用するファイル[1]

ユーザ定義受付削除ダイアログ[1]

ユーザ定義受付情報表示画面[1]

ユーザ定義受付定義画面[1]

ユーザ定義受付定義画面（SOAP受付の基本画面）[1]

ユーザ定義受付に関連するダイアログ[1]

ユーザ定義受付ランタイム定義ファイル[1]

ユーザ認証情報管理コマンド定義ファイル[1]

ユーザ認証で利用するファイル[1]

ユーザの管理[1]

よ

要素選択ダイアログ[1]

要素を移動する[1]

要素をコピーする[1]

要素を削除する[1]

要素を貼り付ける[1]

り

リストコマンドオプション定義ファイル[1]

リソースKey[1]

リソース稼働情報の表示[1]

リポジトリ情報の差分の表示[1]

リポジトリ情報の表示[1]

リポジトリのアップデート[1]

履歴管理ページ[1]

リンクダイアログ[1]

る

ルート要素選択ダイアログ[1]

れ

レイアウトを設定する〔パレット〕[1]

ろ

ログ出力アクティビティサブダイアログ[1]

ログ出力アクティビティダイアログ[1]

ログ出力アクティビティ定義ファイル[1]

ログ出力アクティビティで利用するファイル〔開発環境〕[1]

ログの出力レベル[1]

論理演算ダイアログ[1]

わ

割当相関セット群ダイアログ[1]