Hitachi

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


cscoas2servicedef(OpenAPI仕様書をHCSCコンポーネントの定義に変換)

〈このページの構成〉

形式

cscoas2servicedef -in <OpenAPI仕様書のファイルパス>
                  -out <出力先ディレクトリパス>
                 [-f <JSON-XML変換定義ファイルのパス>]

機能

OpenAPI仕様書から,HTTP受付またはビジネスプロセスの次に示す定義を生成します。

必要に応じて生成した定義を編集し,サービス定義のインポート機能を使ってHTTP受付またはビジネスプロセスを生成できます。

このコマンドは,次の場所に格納されています。

<サービスプラットフォームのインストールディレクトリ>\CSCTE\bin

コマンドを実行する場合は,この場所まで移動するかパスを指定してください。

OpenAPI仕様書からHTTP受付を作成する方法については,マニュアル「サービスプラットフォーム 解説」の「2.14.12 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.15.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

実行権限のチェックエラーが発生しました。

注意事項