スキーマ

スキーマリソースとは、任意のプロジェクト・スクリプトに含まれるコンポーネントの入出力スキーマを登録し、ドキュメントMapperの入出力スキーマから参照できるようにする機能です。

 

スキーマリソースの設定には、以下の利点があります。

  • 複数のプロジェクトおよびスクリプトへの同一スキーマの設定ができます。

    複数のプロジェクトやスクリプトを連携させる形で開発を行う際、同一のスキーマを持ったデータを複数のプロジェクトやスクリプトで扱いたい場合があります。

    そのような場合、スキーマリソースを登録および参照することで、複数のプロジェクトやスクリプトに含まれるドキュメントMapperに同一のスキーマを設定できます。

  • スキーマの一括変更ができます。

    スクリプトを開発および運用する上で、スキーマを変更する場面がでてきます。

    その際、複数のプロジェクト、スクリプト、およびコンポーネントで同一のスキーマを使用している場合、それらのスキーマをすべて同様に変更する必要があります。

    あらかじめスキーマリソースを参照するように設定しておくことで、スキーマの変更をプロジェクト、スクリプト、およびコンポーネントごとにそれぞれ行うのではなく、マスタとなるスキーマリソースを変更するだけですべてのスキーマを一括変更できます。

 

変更に強いスクリプト開発を行うために、スキーマリソースの活用をお勧めします。

対象のスキーマをスキーマリソースに登録し、複数のドキュメントMapperから参照することで、通常のスキーマ設定よりも容易に設定できます。

構造の変更が行われる際には、登録元のスキーマリソースを変更して、それを参照するスキーマに一括で反映するといったように、変更の手間も大きく減らすことができます。

注意

スキーマリソースは、ドキュメントMapperでのみ使用できます。

以下のスキーマリソースの操作を説明します。

 

スキーマリソースの登録

スキーマリソースは以下の画面から登録できます。

> HULFT INTEGRATE > スキーマからの登録手順

スキーマでは、JSON形式またはXML形式のスキーマをスキーマリソースとして登録できます。

登録手順についての詳細は、以下のチュートリアルを参照してください。

 

スキーマリソースの参照

スキーマリソースは、Mapperエディターから参照できます。

Mapperエディターでは以下の参照方法があります。

Mapperエディターでは、編集可能な入出力スキーマからスキーマリソースを参照できます。

ここでは、入力スキーマを例にMapperエディターでスキーマリソースを参照する方法について説明します。

= 備考 =

ドキュメントMapperからのみ参照が可能です。変数MapperおよびマージMapperから参照できません。

 

 

リソースからスキーマを読み込む手順

  1. 入力スキーマの「入力データ」直下のノードの右クリックメニューから、リソースからスキーマを読み込むを選択します。

  2. スキーマの読み込みダイアログが表示されます。

  3. 任意のスキーマリソースを選択します。

  4. 完了をクリックします。

コンポーネント/ファイルからスキーマを読み込む手順

  1. 入力スキーマの「入力データ」直下のノードの右クリックメニューから、コンポーネント/ファイルからスキーマを読み込むを選択します。

  2. スキーマの読み込みダイアログが表示されます。

  3. スキーマの読み込み方法を選択します。

    各項目の詳細は、「スキーマ編集」を参照してください。

  4. 完了をクリックします。

スキーマリソースの更新

スキーマリソースは以下の画面から更新できます。

> HULFT INTEGRATE > スキーマからの更新手順

スキーマでは、作成したJSON形式またはXML形式のスキーマを更新できます。

  1. スキーマページで作成済みのスキーマのアクションメニューを選択します。

  2. アクションメニューで情報を選択します。

  3. スキーマ > スキーマ名ページで、編集を選択します。

  4. JSON定義またはXML定義を修正します。

    = 備考 =

    インポートからファイルを選択して上書きすることもできます。

  5. 完了を選択します。

仕様制限

  • スキーマは、ドキュメントMapperでのみ使用できます。

  • スキーマ名の文字制約について

    • シングルバイト、マルチバイトの英数文字、日本語を使用できます。

    • HULFT Squareで使用できない文字を使うことはできません。

      = 参照 =

      詳細については、「HULFT Square使用禁止文字について」を参照してください。

    • 使用できない文字を含むスキーマを作成すると、エラーが発生しHULFT Squareのファイルシステムに不正な状態でスキーマの設定が残る場合があります。

  • 同名の要素が複数存在するスキーマをスキーマとして登録すると、自動的にインデックスが付与されます。

注意事項

  • スキーマの登録について

    • スキーマの登録は、デザイナーで開いているすべてのプロジェクトを保存するか、登録元のプロジェクトを保存し、それ以外のプロジェクトを閉じてから行う必要があります。

    • プロジェクトを意図せず上書きしてしまうことを防ぐため、スキーマの登録を行う際は、複数のデザイナーを同時に開かないようにしてください。