マッピング設定で利用できる暗黙的な変数とは？
kodamad
この記事では、マッピング設定で利用できる暗黙的な変数について紹介します。
IM-LogicDesignerでは、マッピング設定の入力値として、ユーザ情報やシステム日時など、頻繁に使用される情報を暗黙的な変数として利用できます。この機能により、マッピング設定内で必要な情報を簡単に参照できるため、データ取得に関する複雑な設定を省略できます。IM-LogicDesignerで利用できる暗黙的な変数には、どのような種類があるのか、それらの特徴もあわせて確認してみましょう。
暗黙的な変数とは？
暗黙的な変数とは、開発者が明示的に定義することなく、システムやフレームワークによって自動的に生成される変数のことです。これらの変数は、特定の処理やイベントに応じて自動的に値が割り当てられるため、開発者が効率的に情報を使うことができます。
IM-LogicDesignerでは、intra-mart Accel Platformで扱う情報を暗黙的な変数として利用できます。これらの変数は、使用目的に応じて以下のカテゴリに分類されています。
- アカウントコンテキスト
- 外部ユーザコンテキスト
- セッション情報
- 処理結果情報
- ユーザコンテキスト
暗黙的な変数を入力値に追加したい場合は、セレクトボックスから追加したいカテゴリを選択し、「+入力を追加」をクリックします。必要に応じて、複数のカテゴリを設定することも可能です。
暗黙的な変数の利用方法
マッピング設定画面に暗黙的な変数を追加する方法について確認できます。暗黙的な変数は入力値のみに追加して利用できます。
暗黙的な変数の種類と特徴
IM-LogicDesignerでは、用途に応じてさまざまな種類の暗黙的な変数が用意されています。各変数の種類と特徴について見ていきましょう。
ユーザに関する情報を保持する変数
ユーザの状態（ステータス）やユーザのプロファイル情報など、ユーザに関する情報を保持する変数について紹介します。
アカウントコンテキスト
アカウントコンテキストの変数では、アクセス中のユーザの状態（ステータス）に関する情報を保持します。この変数を設定することで、ユーザコードやロケールなどのアカウント情報や認証状況などのプロパティを取得できます。
アカウントコンテキストの各変数から取得できる情報は、ロジックフローを実行したユーザが対象となります。「ユーザ切り替え」制御要素を含む場合は、切り替え後のユーザが対象となります。
アカウントコンテキストの仕様
アカウントコンテキストに含まれる変数のプロパティ一覧と詳細な仕様について確認できます。
【参考】ユーザコードを入力値として利用する
チュートリアルガイドでは、アカウントコンテキストのuserCdという変数を入力値としたマッピング設定の例について確認できます。ここでは、登録者を操作ユーザとするために、アカウントコンテキストを利用しています。また、登録日を操作タイミングの時間とするため、この後に説明するセッション情報の利用についても触れています。
ユーザコンテキスト
ユーザコンテキストの変数では、IM-共通マスタで保有するユーザプロファイル情報を保持します。この変数を設定することで、プロファイル情報や組織所属情報などを取得できます。
ユーザコンテキストの各変数から取得できる情報は、ロジックフローを実行したユーザが対象となります。「ユーザ切り替え」制御要素を含む場合、切り替え後のユーザが対象となります。
ユーザコンテキストの仕様
ユーザコンテキストに含まれる変数のプロパティ一覧と詳細な仕様について確認できます。
【参考】ユーザ名を変数に代入する
チュートリアルガイドでは、ユーザコンテキストのuserNameという変数を入力値としたマッピング設定の例について確認できます。ここでは、ユーザ名を変数に代入するために、ユーザコンテキストを利用しています。また、登録日を操作タイミングの時間とするため、この後に説明するセッション情報を利用しています。
外部ユーザコンテキスト
外部ユーザコンテキストの変数では、外部ユーザに関する情報を保持します。この変数を設定することで、外部ユーザかどうかを表すプロパティを取得できます。
intra-martでは、従来の一般ユーザと異なる権限を付与したユーザを「外部ユーザ」として設定できます。たとえば、社内ユーザを一般ユーザ、社外ユーザを外部ユーザとして、それぞれ権限を分けて管理できます。
外部ユーザコンテキストの仕様
外部ユーザコンテキストに含まれる変数のプロパティ一覧と詳細な仕様について確認できます。
フローに関する情報を保持する変数
実行中のフロー情報やタスクの処理結果など、フローに関する情報を保持する変数について紹介します。
セッション情報
セッション情報の変数では、セッション内に実行中のロジックフローに関する情報を保持します。この変数を設定することで、フローIDやバージョンといった情報、日付情報、定数値などを取得できます。
セッション情報の仕様
セッション情報に含まれる変数のプロパティ一覧と詳細について確認できます。
【参考】システム日時を利用する
チュートリアルガイドでは、セッション情報のsystemDateという変数を入力値としたマッピング設定の例について確認できます。ここでは、システム日時をアンケート回答登録日とするため、セッション情報を利用しています。また、回答者を操作ユーザとするため、アカウントテキストの利用についても触れています。
処理結果情報
処理結果情報の変数では、マッピング対象となるタスクから一つ前のタスクに対し、その処理結果の情報を保持します。この変数を設定することで、エラー情報などを取得できます。
処理結果情報の仕様
処理結果情報に含まれる変数のプロパティ一覧と詳細について確認できます。
【参考】エラーメッセージをログに出力する
チュートリアルガイドでは、処理結果情報のerrorMessageという変数を入力値としたマッピング設定の例について確認できます。ここでは、エラーメッセージをログ出力の値とするため、処理結果情報を利用しています。
まとめ
IM-LogicDesignerのマッピング設定で暗黙的な変数を使用することで、設定の効率化だけでなく、コードの可読性や保守性も向上します。暗黙的な変数は、特定の処理やイベントに応じて自動的に値が割り当てられるため、開発者が明示的に定義する必要はありません。マッピング設定とあわせて、暗黙的な変数の種類や特徴を把握し、適切に使いこなせるようになることをおすすめします。
intra-martでは、IM-LogicDesignerをもっと知っていただくためにマニュアルやコンテンツなどを豊富にご用意しています。IM-LogicDesignerの機能を最大限に発揮させるためにも、ぜひご活用ください。
