3.15.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変換定義ファイルは，次に示す手順で編集します。

1. サービスアダプタ定義画面（詳細）の［独自定義ファイル］の［追加］ボタンをクリックして，JSON-XML変換定義ファイルのテンプレートファイルを追加します。

2. ［独自定義ファイル］の［編集］ボタンをクリックします。

   JSON-XML変換定義ファイルを編集するためのエディタが起動します。

3. エディタ上でJSON-XML変換定義ファイルを編集します。

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

ページの先頭へ