ユーザ定義ロジック

ユーザ定義ロジックとは

ユーザ定義ロジックとは、複数のMapperロジックを一つのロジックとしてまとめ、ドキュメントMapperおよび変数Mapper上で共有できる機能です。
ユーザ定義ロジック自体への変更は配置したユーザ定義ロジックすべてに反映されるため、共通の変換処理を一カ所にまとめることができ、同じ処理を複数箇所に作成する方法に比べ、開発効率のアップおよび修正漏れの防止につながります。

ユーザ定義ロジックは、「グローバルユーザ定義ロジック」と「ローカルユーザ定義ロジック」の二種類が存在します。

グローバルユーザ定義ロジックは、すべてのプロジェクト・スクリプトから使用できます。プロジェクト間で共通のユーザ定義ロジックを使用することができ、特に大規模なスクリプト開発において、生産性の向上に貢献します。
プロジェクトとは別に管理されるため、サーバ移行のエクスポートで別のDataSpiderServerに移行でき、共通ライブラリ的な使い方もできます。
すべてのプロジェクト・スクリプトで使用できるため、変更や削除の際の影響も大きくなります。そのような場合には、「参照元の検索」を使用し、影響範囲や配置先の簡単な確認が可能です。

ローカルユーザ定義ロジックは、一つのプロジェクト内でのみ使用できます。そのため、プロジェクト内でのみユーザ定義ロジックを共有したい場合や、プロジェクトと一括でユーザ定義ロジックを管理したい場合はローカルユーザ定義ロジックの使用が適切です。

ローカルユーザ定義ロジックをグローバルユーザ定義ロジックに(またはその逆も)移行することはできません。

グローバルユーザ定義ロジック

  1. 作成方法
  2. 編集方法
  3. マッピングキャンバスへの配置
  4. 移動・複製方法
  5. 参照元の検索
  6. 削除方法
  7. 仕様制限

作成方法

  1. Mapperエディタを開き、ツールパレットの「グローバルユーザ定義」パレットの右クリックメニュー[追加]-[ユーザ定義ロジック]を選択します。
    グループを用いてユーザ定義ロジックを分類することもできます。
    項目の説明
    項目名 説明 備考
    追加 ユーザ定義ロジック 新しいグローバルユーザ定義ロジックを追加します。  
    グループ 新しいグループを追加します。  

  2. グローバルユーザ定義ロジック名を設定します。
    項目の説明
    項目名 説明 備考
    ユーザ定義ロジック名 グローバルユーザ定義ロジック名を入力します。  
    コメント コメントを入力します。  

  3. 新しいグローバルユーザ定義ロジックが作成され、ツールパレット上に表示されます。

編集方法

  1. ツールパレットの「グローバルユーザ定義」パレットにあるグローバルユーザ定義ロジックをダブルクリックしてグローバルユーザ定義エディタを開きます。
    マッピングキャンバスに配置したグローバルユーザ定義ロジックアイコンをダブルクリックして開くこともできます。


  2. 入力元のルート要素(入力ハンドラ)の右クリックメニューで[ハンドラの新規作成]を選択します。
    項目の説明
    項目名 説明 備考
    ハンドラの新規作成 入力ハンドラを追加します。  

  3. 入力ハンドラ名を設定します。
    項目の説明
    項目名 説明 備考
    ハンドラ名 入力ハンドラ名を入力します。  
    コメント コメントを入力します。  

  4. ツールパレットからMapperロジックをキャンバスに配置し、グローバルユーザ定義ロジックのマッピングを作成します。
作成した入力ハンドラの右クリックメニュー[編集]から、ハンドラ名やコメントの編集ができます。
作成した入力ハンドラの右クリックメニュー[削除]から、ハンドラの削除ができます。
出力ハンドラは通常のロジックと同じように扱われるため、出力は一種類になります。そのため編集することはできません。

注意事項

マッピングキャンバスへの配置

ツールパレットの「グローバルユーザ定義」パレットからグローバルユーザ定義ロジックをマッピングキャンバスにドラッグ&ドロップします。
入出力の型はすべて文字列型です。

移動・複製方法

移動

  1. ツールパレットの「グローバルユーザ定義」パレットにあるグローバルユーザ定義ロジックの右クリックメニュー[切り取り]を選択します。
  2. 移動したい場所(グループまたは「グローバルユーザ定義」パレット上の空白部分)の右クリックメニュー[貼り付け]を選択します。
    同一の階層には移動できません。
    移動先に同名のグローバルユーザ定義ロジックが存在した場合、グローバルユーザ定義ロジック名の末尾に半角アンダースコアと番号が自動で付与されます。

複製

  1. ツールパレットの「グローバルユーザ定義」パレットにあるグローバルユーザ定義ロジックの右クリックメニュー[コピー]を選択します。
  2. グループまたは「グローバルユーザ定義」パレット上の空白部分の右クリックメニュー[貼り付け]を選択します。
    複製先に同名のグローバルユーザ定義ロジックが存在した場合、グローバルユーザ定義ロジック名の末尾に半角アンダースコアと番号が自動で付与されます。

参照元の検索

参照元の検索とは、グローバルユーザ定義ロジックを使用しているMapperを検索する機能です。
  1. ツールパレットの「グローバルユーザ定義」パレットにあるグローバルユーザ定義ロジックの右クリックメニュー[参照元の検索...]を選択します。
  2. 「参照元の検索」画面が起動します。
    当該ロジック(右クリックメニューを開いたグローバルユーザ定義ロジック)を参照しているMapperの情報が表示されます。
    読み取り権限のないプロジェクトまたはサービスは表示されません。

    項目の説明
    項目名 説明 備考
    プロジェクト プロジェクト 当該ロジックを使用しているプロジェクト名を表示します。  
    スクリプト 当該ロジックを使用しているスクリプト名を表示します。  
    Mapper 当該ロジックを使用しているMapperのコンポーネントアイコン名を表示します。  
    レイヤ 当該ロジックを使用しているMapperのレイヤ名を表示します。  
    コメント 当該ロジックのコメントを表示します。  
    サービス サービス 当該ロジックを使用しているサービス名を表示します。  
    スクリプト 当該ロジックを使用しているスクリプト名を表示します。  
    Mapper 当該ロジックを使用しているMapperのコンポーネントアイコン名を表示します。  
    レイヤ 当該ロジックを使用しているMapperのレイヤ名を表示します。  
    コメント 当該ロジックのコメントを表示します。  

  3. [Mapper一覧]の行を選択し、[Mapperを開く]ボタンを押下すると、当該ロジックを使用しているMapperエディタが起動します。その際、当該ロジックは選択状態になります。
    同じコメントが設定された同一のグローバルユーザ定義ロジックがひとつのレイヤに複数配置されている場合、当該ロジックすべてが選択状態になります。

削除方法

ツールパレットの「グローバルユーザ定義」パレットにあるグローバルユーザ定義ロジックの右クリックメニュー[削除]を選択します。
グローバルユーザ定義ロジックを削除すると、当該ロジックを参照しているスクリプトやサービスが実行できなくなります。「参照元の検索」で影響範囲を必ず確認のうえ、削除してください。
グローバルユーザ定義ロジックの削除を行った際に、当該ロジックを参照している配置済みのグローバルユーザ定義ロジックの削除がすぐに行われない場合があります。その場合、プロジェクトを開きなおしてください。

仕様制限

ローカルユーザ定義ロジック

  1. 作成方法
  2. 編集方法
  3. マッピングキャンバスへの配置
  4. 削除方法
  5. 仕様制限

作成方法

  1. Mapperエディタを開き、ツールパレットの「ローカルユーザ定義」パレットの右クリックメニュー[追加]-[ユーザ定義ロジック]を選択します。
    グループを用いてユーザ定義ロジックを分類することもできます。
    項目の説明
    項目名 説明 備考
    追加 ユーザ定義ロジック 新しいローカルユーザ定義ロジックを追加します。  
    グループ 新しいグループを追加します。  

  2. ユーザ定義ロジック名を設定します。
    項目の説明
    項目名 説明 備考
    ユーザ定義ロジック名 ローカルユーザ定義ロジック名を入力します。  
    コメント コメントを入力します。  

  3. 新しいローカルユーザ定義ロジックが作成され、ツールパレット上に表示されます。

変更方法

  1. ツールパレットの「ローカルユーザ定義」パレットにあるローカルユーザ定義ロジックをダブルクリックしてMapperエディタを開きます。
    マッピングキャンバスに配置したローカルユーザ定義ロジックアイコンをダブルクリックして開くこともできます。


  2. 入力元のルート要素(入力ハンドラ)の右クリックメニューで[ハンドラの新規作成]を選択します。
    項目の説明
    項目名 説明 備考
    ハンドラの新規作成 入力ハンドラを追加します。  

  3. 入力ハンドラ名を設定します。
    項目の説明
    項目名 説明 備考
    ハンドラ名 入力ハンドラ名を入力します。  
    コメント コメントを入力します。  

  4. 4.ツールパレットからMapperロジックをキャンバスに配置し、ローカルユーザ定義ロジックのマッピングを作成します。
入力ハンドラの増減はマッピングキャンバスに配置したローカルユーザ定義ロジックアイコンにも反映されます。入力ハンドラが削除された場合には結びついていたリンクも同時に削除されます。
出力ハンドラは通常のロジックと同じように扱われるため、出力は一種類になります。そのため編集することはできません。
作成した入力ハンドラの右クリックメニュー[編集]から、ハンドラ名やコメントの編集ができます。
作成した入力ハンドラの右クリックメニュー[削除]から、ハンドラの削除ができます。

マッピングキャンバスへの配置

ツールパレットの「ローカルユーザ定義」パレットからローカルユーザ定義ロジックをマッピングキャンバスにドラッグ&ドロップします。
入出力の型はすべて文字列型です。

削除方法

ツールパレットの「ローカルユーザ定義」パレットにあるローカルユーザ定義ロジックの右クリックメニュー[削除]を選択します。
ローカルユーザ定義ロジックの削除を行った際に、当該ロジックを参照している配置済みのローカルユーザ定義ロジックの削除がすぐに行われない場合があります。その場合、プロジェクトを開きなおしてください。

仕様制限