intra-mart Accel Platform IM-LogicDesigner仕様書 第23版 2023-10-01

4.2. ユーザ定義タスク

ユーザ定義タスクの構成要素と、動作仕様について説明します。

4.2.1. バージョニング(履歴管理)

IM-LogicDesignerでは、ユーザ定義タスクのバージョニング(履歴管理)を行います。

注意

ロジックフローで有効になるバージョンについて

ロジックフローで利用する場合ユーザ定義タスクは常に最新のバージョンが利用されます。
最新バージョンが更新されたタイミングで、対象とするユーザ定義タスクを利用している全てのロジックフローの動作は変更されます。

コラム

フロー内でのみ利用するユーザ定義タスクのバージョニングは、ロジックフローのバージョニング(履歴管理)にて行われます。
設定についての詳細は、「IM-LogicDesigner ユーザ操作ガイド」 - 「ユーザ定義編集 - 共通設定」の「フロー内でのみ利用する」を参照してください。

4.2.1.1. バージョン番号

ユーザ定義タスクのバージョン番号は、ロジックフローのバージョンに用いられるバージョン番号の仕様と同じです。
詳細は「バージョニング(履歴管理)」-「バージョン番号」を参照してください。

4.2.1.2. バージョンの持つ情報

各バージョンは、ユーザ定義タスクの持つ全ての情報を保持します。
バージョンが扱う情報の具体例は以下の通りです。
  • ユーザ定義ID/定義名
  • ユーザカテゴリ
  • ソート番号
  • アイコン
  • 入力値/返却値
  • 各タスク毎の詳細情報

注意

期間化情報について

ユーザ定義タスクのバージョンでは、期間化の情報は持ちません。

4.2.1.3. バージョンの削除

ユーザ定義タスクのバージョンの削除は、ロジックフローのバージョンに用いられる削除の仕様と同じです。
詳細は「バージョニング(履歴管理)」-「バージョン削除」を参照してください。

4.2.2. 国際化

IM-LogicDesignerでは、ユーザ定義タスクの名称の国際化に対応しています。

4.2.2.1. 標準表示名

ユーザ定義タスクの標準表示名は、ロジックフローのバージョンに用いられる標準表示名の仕様と同じです。
詳細は「function_specification_logic_flow_i18n」-「標準表示名」を参照してください。

4.2.3. ユーザカテゴリ

ユーザカテゴリは、ユーザ定義タスクの利用用途や適用範囲を分類するための情報です。
IM-LogicDesignerはユーザ定義タスクの管理・分類するための情報としてユーザカテゴリを利用します。
ユーザカテゴリの詳細な仕様は、「ユーザアイコン」の指定を除き、ロジックフローのフローカテゴリに用いられる仕様と同じです。
詳細は「フローカテゴリ」を参照してください。

4.2.4. ユーザアイコン

ユーザアイコンは、ロジックフローの編集時において、ユーザ定義タスクを視覚的にわかりやすく表現するための画像です。
ユーザ定義タスクに紐付けたユーザアイコンは、ロジックフロー定義編集画面のパレットとデザイナで使用されます。
ユーザアイコンは、IM-LogicDesignerに登録されているアイコンデータベースから選択します。
アイコンデータベースには、次項の仕様に従ったアイコンを登録することが可能です。
アイコンの種別として「パレット用」と「デザイナ用」があり、アイコンIDを同一として、必ずペアで登録する必要があります。

4.2.4.1. 共通仕様

ユーザアイコンの共通仕様は、以下の通りです。
ユーザアイコンをアイコンデータベースに登録する際は、以下の仕様に準拠する必要があります。
項目 説明
画像の種類 SVG, PNG, JPEG, GIF, BitMap(BMP)

注意

SVGの使用について

SVGを登録した場合、CSS等の影響により、線の色や太さなどの表現が変更されて表示されることがあります。
必ずロジックフロー定義編集画面で、画面上での表示を確認してください。

また、以下のルールに従ったファイルを用意する必要があります。
  1. 1行目に以下のxml宣言を記述してください。

    <?xml version="1.0" encoding="utf-8"?>
  2. 画像データ (data stream) は使用しないでください。

4.2.4.2. パレット用アイコン仕様

項目 説明
アイコン種別 palette
解像度 40x40

コラム

画像サイズについて

SVGの場合、画像の縮尺は変更されません。 必ず 40x40 に収まるサイズにしてください。
SVG以外の場合、画像サイズが 40x40 になるように、自動的に縮尺が変更されます。

4.2.4.3. デザイナ用アイコン仕様

項目 説明
アイコン種別 designer
解像度 50x50

コラム

画像サイズについて

SVGの場合、画像の縮尺は変更されません。 必ず 50x50 に収まるサイズにしてください。
SVG以外の場合、画像サイズが 50x50 になるように、自動的に縮尺が変更されます。

4.2.5. 処理種別(タイプ)

ユーザ定義タスクでは、その処理内容に応じた処理種別(タイプ)が定義されます。
IM-LogicDesignerはユーザ定義タスクを、定義された処理種別(タイプ)と対応する詳細な処理内容を元に実行します。

4.2.5.2. タイプ別新規作成リンク

ユーザ定義の一覧画面ではタイプ別の新規作成リンクを提供します。
../../../_images/create_menu.png

図:新規作成リンク

この新規作成リンクは以下の順序でリンク情報の検索を行い、生成します。
  1. メニューグループIDが「logic_designer_sm-pc」と合致するメニューグループを検索します。

  2. 該当するメニューグループが存在した場合、以下の条件を満たすメニューアイテムを配下から検索します。
    • URL 中に「/user_definition/${category}/」文字列が含まれること。
      • ${category}は処理種別(タイプ)を表す任意の文字列。
        例: javascript(JavaScript)、rest(REST)、sql(2WaySQL)
    • URL の末尾が「/.new」文字列であること。

  3. 該当するメニューアイテムのメニューアイテム名、および、URLをもとにリンク情報を生成します。