グローバルスキーマとは
グローバルスキーマとは、任意のプロジェクト・スクリプトに含まれるコンポーネントの入出力スキーマを登録し、ドキュメントMapperの入出力スキーマから参照できる機能です。
グローバルスキーマはスクリプトキャンバス上のコンポーネントアイコンまたはMapperエディタの入出力スキーマから登録し、Mapperエディタの入出力スキーマから参照することができます。
また、コントロールパネルから表示・削除・セキュリティに関する設定変更などの管理を行うことができます。
グローバルスキーマには以下のような利点があります。
- 複数のプロジェクト・スクリプトへの同一スキーマの設定
複数のプロジェクトやスクリプトを連携させるかたちで開発を行う際、同一のスキーマを持ったデータを複数のプロジェクトやスクリプトで扱いたい場合があります。
そのような場合、グローバルスキーマを登録・参照することで、複数のプロジェクトやスクリプトに含まれるドキュメントMapperに同一のスキーマを設定することができます。
- スキーマの一括変更
スクリプトを開発・運用するうえで、スキーマを変更する場面がでてきます。
その際、複数のプロジェクト・スクリプト・コンポーネントで同一のスキーマを使用している場合、それらのスキーマをすべて同様に変更する必要があります。
あらかじめグローバルスキーマを参照するように設定しておくことで、スキーマの変更をプロジェクト・スクリプト・コンポーネントごとにそれぞれ行うのではなく、マスタとなるスキーマを変更するだけですべてのスキーマを一括変更することができます。
- スキーマの一元管理
グローバルスキーマは、コントロールパネルの「グローバルスキーマの設定」で一元管理することが可能です。
「グローバルスキーマの設定」では、グローバルスキーマの表示・削除・セキュリティに関する設定変更を行うことができます。
使用方法
グローバルスキーマの登録・参照・更新・参照の解除の方法については、サービスガイドの「グローバルスキーマの活用」を参照してください。
スクリプトキャンバスでは、固有の入力スキーマまたは出力スキーマを持ち、スキーマの編集ができないコンポーネントからグローバルスキーマを登録できます。
登録可能なコンポーネントの場合、コンポーネントアイコンの右クリックメニューの[グローバルスキーマ]が有効になります。
各オペレーションのページで、「Mapperでのスキーマ読み込み」項に「スキーマは自動で読み込まれます。」と記載されているものが固有のスキーマを持つコンポーネントです。
スキーマの編集が可能な場合、スクリプトキャンバスからの登録はできません。ドキュメントMapperにデータフローを引いて、Mapperエディタから登録してください。
「グローバルスキーマの登録」画面の「参照コンポーネントの更新」では、グローバルスキーマを参照しているコンポーネントのスキーマを一括変更することができます。
このとき、変更対象のすべてのプロジェクトをクライアント側に展開し、各スキーマを変更してからサーバに保存します。
そのため、参照コンポーネントの更新を実行する際には、Studioを操作するクライアントマシンの性能が重要となります。
仕様制限
- グローバルスキーマは、ドキュメントMapperでのみ使用できます。
- グローバルスキーマ名の文字制約について
- シングルバイト、ダブルバイトの英数文字、日本語を使用することができます。
- DataSpider Cloudで使用できない文字を使うことはできません。
詳細については、「DataSpider Cloud使用禁止文字について」を参照してください。
- 使用できない文字を含むグローバルスキーマを作成すると、エラーが発生しDataSpider Cloudファイルシステムに不正な状態でグローバルスキーマの設定が残る場合があります。
- 同名の要素が複数存在するスキーマをグローバルスキーマとして登録すると、自動的にインデックスが付与されます。
注意事項
- グローバルスキーマの登録について
- グローバルスキーマの登録は、デザイナで開いているすべてのプロジェクトを保存するか、登録元のプロジェクトを保存し、それ以外のプロジェクトを閉じてから行う必要があります。
- プロジェクトを意図せず上書きしてしまうことを防ぐため、グローバルスキーマの登録を行う際は、デザイナを複数開かないようにしてください。