4.16.1 JSON形式のプロパティファイルの形式について
JSON形式のプロパティファイルの形式を次に示します。
JSON形式のプロパティファイルは,次のように記述してください。
{ "properties": [ { "keyName": "プロパティ1のキー", "displayName": "プロパティ表示名" "description": "プロパティの説明" "type": "プロパティのデータ型" "value": "プロパティ値" }, { "keyName": "プロパティ2のキー", "displayName": "プロパティ表示名" "description": "プロパティの説明" "type": "プロパティのデータ型" "value": "プロパティ値" }, ] }
RFC 4627に従ってください。
文字セットはUTF-8を使用してください。
JSON形式のプロパティファイルの冒頭には,連想配列のpropertiesを記述してください。
「keyname」「value」フィールドは必ず指定してください。
プロパティ値を設定しない状態にするには「"value": ""」と記述してください。
Password型プロパティの値は,平文または暗号文のどちらでも記述できます。ただし,プロパティファイルのエクスポート時は,Password型プロパティの「value」フィールドは出力されません。
プロパティファイルには,プロパティ値を設定したいプロパティだけを記述してください。インポートの際に定義されていないプロパティには,インポート操作前の値が保持されます。
プロパティファイルに定義できるプロパティの数の上限は,ユーザー設定プロパティファイル(config_user.properties)に指定した個数を超えないようにしてください。
プロパティファイルをエクスポートすると,「service_properties.json」のファイル名で保存されます。ファイル名は変更できます。ファイル名にはマルチバイト文字を使用できます。ただし,拡張子は「.json」を使用してください。
JSON形式のプロパティファイルの定義不正になる項目とインポート時の処理内容を次に示します。定義不正のプロパティファイルをインポートすると,プロパティ値が反映されなかったり,エラーとなったりする場合があります。
定義不正になる項目 |
[サービス設定]画面または[サービス実行]画面からのインポート |
[Service Builder Debug]画面からのインポート |
submittaskコマンドからのインポート |
---|---|---|---|
プロパティファイルに定義できるプロパティの数の上限が,ユーザー設定プロパティファイル(config_user.properties)に指定した個数を超えている |
○ |
○ |
× |
インポートするサービスに存在しないプロパティが定義されている |
△ |
△ |
× ※1 |
同じプロパティキーに対する定義が複数記述されている |
○ ※2 |
○ ※2 |
× |
「keyName」の長さが制限値を超えている |
△ |
△ |
× |
プロパティに妥当でない値(データ型や制約条件を満たしていないプロパティ値)が定義されている |
○ ※3 |
○ |
× |
- (凡例)
○:プロパティ値が反映されます。 △:プロパティ値が反映されないで処理がスキップされます。 ×:エラーとなります。
- 注※1
可視性が「設定画面のみ」のプロパティをインポートしようとするとエラーとなります。
- 注※2
同じプロパティキーに対する定義を複数記述した場合は,あとに記述した内容が有効になります。
- 注※3
データ型がlist型またはboolean型のプロパティに,操作画面から設定できない値が定義されている場合は,空の値が反映されます。