6.6. WF連携設定を行う¶
ここでは、IM-FormaDesignerで作成したアプリケーションをIM-Workflowで利用するための方法を説明します。設定を行う際には、あらかじめ対象のアプリケーションが作成済みであることが前提条件です。
Contents
- WF連携設定とは
- 「WF連携設定」画面の機能と各部の説明
- 「連携情報」画面の機能と各部の説明
- 「承認画面設定登録」画面の機能と各部の説明
- 「案件プロパティ登録」画面の機能と各部の説明
- 「追記設定登録」画面の機能と各部の説明
- アプリケーションにIM-Workflowで利用するために必要な項目を設定する
- IM-Workflowにアプリケーションを登録して、申請・承認画面として利用する
- IM-Workflow連携情報の更新
- IM-Workflow連携情報の解除(削除)
- 複数のフォームからスマートフォン版の画面遷移(フォーム遷移)を設定する
- IM-FormaDesigner 2013 Springより前のバージョンで作成したアプリケーションをスマートフォンで利用する
- IM-FormaDesigner 2015 Winter以前のバージョンで作成したアプリケーションに、セッション情報を削除する処理を設定する
6.6.1. WF連携設定とは¶
IM-FormaDesignerで作成したアプリケーションは、IM-Workflowの申請画面や承認画面として利用できます。作成したIM-FormaDesignerのアプリケーションをIM-Workflowで利用するための設定を「WF連携設定」といいます。
6.6.3. 「連携情報」画面の機能と各部の説明¶
コンテンツ連携情報を登録する画面の内容は以下の通りです。
コンテンツID
IM-Workflowのコンテンツ定義の識別用IDを半角英数字で入力します。
アプリケーション名
コンテンツ定義連携情報を登録する対象のアプリケーションを表示します。
アプリケーション名を案件名に設定する
IM-Workflowの申請実行時に案件名のデフォルト値として、アプリケーション名を設定できます。印影を利用するための設定を追加する
アプリケーションのフォームに画面アイテム「印影表示」を利用する場合に設定します。開始日
作成したコンテンツ定義のバージョン期間(開始日)を設定します。終了日
作成したコンテンツ定義のバージョン期間(終了日)を設定します。入力しない場合は既定の値として、”2999/12/31”を設定します。コンテンツ名
コンテンツ定義として、一意に識別できる名称をロケールごとに設定します。入力した内容は、IM-Workflowのコンテンツ定義の基本情報の「コンテンツ名」に反映されます。備考
コンテンツの備考として表示したい内容を設定します。入力した内容は、IM-Workflowのコンテンツ定義の基本情報の「備考」に反映されます。
6.6.4. 「承認画面設定登録」画面の機能と各部の説明¶
「承認画面設定登録」画面の内容は以下の通りです。
対象バージョン選択
承認画面設定を行うアプリケーション履歴番号を検索する画面を表示します。
アプリケーション履歴番号
承認画面設定を行うアプリケーション履歴番号を設定します。
フローID
承認画面設定を行う対象のフロー定義のフローIDを設定します。ノードID
承認画面設定を行う対象のフロー定義のノードIDを設定します。参照遷移
アプリケーションのフォーム遷移情報に複数の参照画面を設定している場合、対象のフロー定義・ノードの時に表示する参照画面を選択します。コラム
「承認画面設定」、「案件プロパティ設定」、「追記設定」の対象ノードに「縦配置」および「横配置」を設定した場合、設定内容は「縦配置」および「横配置」が展開されたノードすべてに適用されます。
6.6.5. 「案件プロパティ登録」画面の機能と各部の説明¶
「案件プロパティ登録」画面の内容は以下の通りです。
対象バージョン選択
案件プロパティ登録を行うアプリケーション履歴番号を検索する画面を表示します。
フローID
案件プロパティ登録を行う対象のフロー定義のフローIDを設定します。ノードID
案件プロパティ登録を行う対象のフロー定義のノードIDを設定します。案件プロパティキー
IM-Workflowのコンテンツ定義を選択します。項目ID
案件プロパティとして値を登録するアプリケーションのフォーム上の「フィールド識別ID」「フィールド識別名」の組み合わせを選択します。
案件プロパティに設定できる画面アイテムの条件
案件プロパティに設定できる項目は、以下の条件にすべて合致したものが対象です。
- メインフォームにフィールド識別IDが同一の画面アイテムが配置されていること
- フィールド値DB登録が有効(チェック:オン)であること
- 表示タイプ:設定したノードの画面種類に対して、入力可、または参照に設定されていること
- 設定したノードが申請、承認、縦配置、横配置、動的承認のいずれかであること
- 画面アイテム「明細テーブル」でないこと
案件プロパティの値を登録・更新するタイミング
案件プロパティの値は、以下のタイミングで登録・更新します。
- 申請ノードで「一時保存」または「申請」、「再申請」が行われる
- 承認、縦配置、横配置、動的承認ノードで以下の処理が行われる
- 一時保存
- 承認
- 承認終了
- 否認
- 保留
- 保留解除
- 差戻し
6.6.6. 「追記設定登録」画面の機能と各部の説明¶
「追記設定登録」画面の内容は以下の通りです。
対象バージョン選択
追記設定を行うアプリケーション履歴番号を検索する画面を表示します。
アプリケーション履歴番号
追記設定を行うアプリケーション履歴番号を設定します。
フローID
追記設定を行う対象のフロー定義のフローIDを設定します。ノードID
追記設定を行う対象のフロー定義のノードIDを設定します。フォームID
追記設定を行う対象のアプリケーションのフォーム名を設定します。項目ID
追記設定の対象とする項目の「アイテム名」を選択します。追記種別
設定したフロー定義のノードの処理時に、追記設定の対象項目の属性(追記可能/非表示)を選択します。
追記設定に設定できる画面アイテムの条件
追記設定に設定できる項目は、以下の条件にすべて合致したものが対象です。
- メインフォームにフィールド識別IDが同一の画面アイテムが配置されていること
- フィールド値DB登録が有効(チェック:オン)であること
- 表示タイプ:承認に対して、参照に設定されていること
- 設定したノードが承認、縦配置、横配置、動的承認のいずれかであること
6.6.7. アプリケーションにIM-Workflowで利用するために必要な項目を設定する¶
6.6.7.1. ステップ1:アプリケーション種別を設定する¶
IM-FormaDesignerで作成したアプリケーションをIM-Workflowで利用するためには、アプリケーション種別を「IM-Workflow」にします。
アプリケーション基本情報を表示します。→ IM-FormaDesigner のアプリケーションの基本情報を設定する
「アプリケーション種別」が「IM-Workflow」と表示されていることを確認します。「標準」と表示されている場合は、「IM-Workflow」に変更し、「更新」をクリックします。
6.6.7.2. ステップ2:画面アイテムを表示する画面を設定する¶
作成したアプリケーションのフォームに配置した画面アイテムを画面ごとに表示・入力の可否を設定していきます。
- 「フォーム・デザイナ」画面を表示します。→ アプリケーションのフォームを作成する
- 配置済みの画面アイテムをクリックし、「プロパティ」アイコンをクリックします。
- 表示されたプロパティウィンドウの「アイテム」をクリックします。
- ウィンドウ下部の「表示タイプ」をクリックし、表示・入力設定欄を表示します。表示タイプの設定方法の詳細→ 画面アイテムの表示タイプについて
- 処理画面単位に表示・入力の設定内容を変更します。
- 設定内容の変更が完了したら、「フォーム・デザイナ」画面の「更新」をクリックして保存します。
6.6.7.3. ステップ3:承認用画面(フォーム)を追加する¶
作成したアプリケーションを承認(参照)画面として利用する場合に、異なるレイアウトのフォームを利用する場合に設定します。承認(参照)時のレイアウトを単一とする場合には設定する必要はありません。注意
1つのIM-FormaDesignerのアプリケーションに、複数の参照(承認)画面を設定することはできますが、登録・更新画面は1つしか設定できませんので、注意してください。
ステップ3-1:フォームを追加する¶
- ステップ3:フォームのレイアウトを編集する を参照して、アプリケーションにフォームを追加します。
ステップ3-2:フォームのレイアウトを編集する¶
- 「フォーム・デザイナ」画面で「再利用」をクリックし、メインフォームのレイアウトを追加したフォームにコピーします。
- 追加したフォームのレイアウトで、画面アイテムの追加・削除を行い、「更新」をクリックしてフォームを保存します。
- 「フォーム・デザイナ」画面のツールバー左の「戻る」をクリックして、「フォーム一覧」を表示します。
ステップ3-3:追加したフォームをアプリケーションの参照画面に設定する¶
- ステップ3-2の最後の手順で表示した「フォーム一覧」画面の「フォーム遷移一覧」をクリックします。
- 「参照画面遷移」の「追加」をクリックします。
- 「フォーム遷移名」に作成したフォームの画面名称を入力し、「登録」をクリックします。
- 「フォーム遷移名」は、ステップ4の「WF連携設定」で「承認画面設定」の「参照遷移名」に利用されます。
- 新しく表示された「追加」をクリックします。
- 「フォーム検索」画面から対象のフォーム名の左のラジオボタンをクリックします。
- 追加したフォームのフォーム遷移情報を保存するために「更新」をクリックして保存します。
- 追加したフォームを既定(デフォルト)の承認(参照)画面とする場合、参照画面遷移の「デフォルト」をクリックします。
- デフォルトの欄にチェックマークがついているフォームが既定(デフォルト)の承認(参照)画面に設定されます。
- 「{フォーム遷移名}をデフォルトのフォーム遷移に設定してよいですか」というメッセージダイアログで「OK」をクリックします。
6.6.8. IM-Workflowにアプリケーションを登録して、申請・承認画面として利用する¶
IM-FormaDesignerでの設定を行った後、作成したアプリケーションをIM-Workflowに登録します。
6.6.8.1. ステップ1:IM-Workflowと連携するための基本情報を設定する(「コンテンツ定義」)¶
- メニューの「アプリ一覧」を表示します。
- 対象のアプリケーション名の「編集」をクリックします。
- 「WF連携設定」をクリックします。
- ワークフローのコンテンツ(画面部品)に必要な情報を入力します。
- 両項目の入力内容については、「IM-Workflow管理者操作ガイド」を参照してください。
- 必要な情報を入力したら、「登録」をクリックします。
フォームに画面アイテム「印影表示」を使用する場合は、「印影を利用するための設定を追加する」のチェックボックスにチェックを入れてください。登録するコンテンツに、印影処理のためのユーザプログラムが追加されます。
- 作成したアプリケーションがIM-Workflowのコンテンツ定義に追加されます。
注意
IM-FormaDesigner と IM-Workflow との連携設定について、既定の設定内容については変更しないでください。連携設定の既定の内容を変更した場合、 IM-Workflow と連携したアプリケーションが正しく動作しなくなる可能性があります。
6.6.8.3. ステップ3:IM-Workflowのフロー定義を設定する「フロー定義」¶
- IM-Workflowのフロー定義の手順に基づき、フロー定義 を設定します。
- 「フロー定義 - 編集」画面の「バージョン」のタブで、「コンテンツ定義」にステップ1で登録したアプリケーション(コンテンツ定義)を設定します。
- フロー定義に必要な情報を入力し、「更新」をクリックすると、フロー定義が保存されます。
6.6.8.4. ステップ4:IM-Workflowの承認画面を設定する¶
この手順は、下記の条件を満たす場合に行ってください。
- コンテンツ定義に利用したアプリケーションに承認用画面を追加している → ステップ3:承認用画面(フォーム)を追加する
- 承認者(ノード)ごとに、異なる参照画面(フォーム)を表示する
- メニューの「アプリ一覧」を表示します。
- 対象のアプリケーション名の「編集」をクリックします。
- 「WF連携設定」をクリックします。
- 「承認画面設定」をクリックし、「承認画面設定」画面を表示します。
- 画面上部のツールバーの「登録」をクリックします。
- フローIDの右の虫眼鏡のアイコンをクリックし、「フロー検索」画面から対象のフロー、ノードを選択し、「決定」をクリックします。
- 「参照遷移」のドロップダウンリストから設定する承認画面用フォームを選択し、「登録」をクリックし、承認画面が設定されます。
6.6.8.5. ステップ5:IM-Workflowの案件プロパティ情報を設定する¶
申請時に画面で入力した項目の値をIM-Workflowの各機能で利用する場合に設定します。
《設定例》
- [未処理一覧]画面や[処理済一覧]画面の項目として表示する
- メールの本文内に入力した値を含めて、 処理通知メール(承認依頼メール等)を作成し、自動送信する
- 入力値に応じて、フローの分岐条件として利用する
《前提条件》
- 「IM-Workflow管理者操作ガイド」の案件プロパティの登録手順に基づいて、案件プロパティキーを登録済みであること
- メニューの「アプリ一覧」を表示します。
- 対象のアプリケーション名の「編集」をクリックします。
- 「WF連携設定」をクリックします。
- 「案件プロパティ設定」をクリックし、「案件プロパティ設定」画面を表示します。
- 画面上部のツールバーの「登録」をクリックします。
- フローIDの右の虫眼鏡のアイコンをクリックし、フロー検索画面から対象のフロー、ノードを選択し、「決定」をクリックします。
- 「案件プロパティキー」には、事前に作成した案件プロパティキーを設定します。
- 「項目ID」は選択した案件プロパティキーに対応できるアプリケーションのフォームに配置した画面アイテムが候補として表示されます。
- 案件プロパティキーに対応する項目IDを設定し、「登録」をクリックすると、案件プロパティ項目として登録されます。
コラム
項目IDには案件プロパティと連携できる項目のみ表示されます。 案件プロパティ設定の登録後、フォームの該当する画面アイテムを変更し、案件プロパティ連携できる条件を満たさないと、申請、承認時に案件プロパティへ値はセットされません。 案件プロパティ設定する項目は、案件プロパティキーと型をそろえる必要があります。異なる型で登録を行った場合、登録時にエラーとなったり、登録は成功しても、IM-Workflowの一覧の該当項目でソートを行うとエラーが発生する場合があります。 日付型やタイムスタンプ型の項目を設定する場合は、フォーマットを「yyyy/MM/dd」にして、案件プロパティキーの型を文字列に設定する必要があります。フォーマットが異なる場合、検索条件にマッチしません。注意
項目IDにデータサイズが大きいアイテム項目(画面アイテム「リッチテキストボックス」、「スプレッドシート」のスプレッドシートID)を選択すると実行時にエラーになる可能性があります。画面アイテム「スプレッドシート」の値を指定する場合は、フィールド定義で設定したフィールドを指定することを推奨します。
6.6.8.6. ステップ6:「追記設定」でIM-Workflowの承認画面で入力・変更が可能な項目を設定する¶
「追記設定」を行うと、ワークフローの利用時に承認者が編集(入力)できます。追記設定を正しく行うと、特定の承認者のみ承認画面の項目の入力・編集ができる、または、項目を表示しない、といった細やかな設定が行えます。《前提条件》
追記設定する項目は、フォームの該当する画面アイテムが以下の条件を満たしていなければなりません。
- [表示タイプ:承認]が「参照」であること。
- [フィールド値DB登録]がONであること。
- メニューの「アプリ一覧」を表示します。
- 対象のアプリケーション名の「編集」アイコンをクリックします。
- 「WF連携設定」タブをクリックします。
- 「追記設定」タブをクリックし、「追記設定」画面を表示します。
- 画面上部のツールバーの「登録」をクリックします。
- フローIDの右の虫眼鏡のアイコンをクリックし、フロー検索画面から対象のフロー、ノードを選択し、「決定」をクリックします。
- 「フォームID」「項目ID」「追記種別」を設定し、「登録」をクリックすると、設定した承認ノードの承認者の画面で指定した画面アイテムが入力・表示できます。
- フォームID:作成したアプリケーションで利用しているフォームを設定します。(ドロップダウンリスト)
- 項目ID:対象のアプリケーションのフォームに配置した画面アイテムで追記設定を行いたい画面アイテムを設定します。
- 追記種別:設定した承認ノードでの承認画面で、表示・入力できる場合には「追記可能」、表示させない場合は「非表示」を選択します。
コラム
項目IDには追記設定できる項目のみ表示されます。 追記設定登録後、フォームの該当する画面アイテムを変更し、追記設定できる条件を満たさないと、承認時に追記設定は機能しません。 フォームの画面アイテムの設定を変更する場合は、不整合を起こさないように注意してください。(例)メインフォームの画面アイテムの[表示タイプ:承認]を[参照]から[入力可]に変更すると、追記設定するためには[参照]でなければならないので、追記設定は機能しません。
6.6.9. IM-Workflow連携情報の更新¶
6.6.9.1. ステップ1:IM-Workflowの「連携情報設定」画面を表示する¶
- メニューの「アプリ一覧」を表示します。
- 対象のアプリケーション名の「編集」をクリックします。
- 「WF連携設定」をクリックします。
6.6.9.2. ステップ2:IM-Workflowの承認画面を変更する¶
承認画面を追加する場合¶
- 「承認画面設定」をクリックし、「承認画面設定」画面を表示します。
- 承認画面を追加する場合には、画面上部のツールバーの「登録」をクリックします。
- フローIDの右の虫眼鏡のアイコンをクリックし、フロー検索画面から対象のフロー、ノードを選択し、「決定」をクリックします。
- 「参照遷移」のドロップダウンリストから設定する承認画面用フォームを選択し、「登録」をクリックし、承認画面が設定されます。
承認画面を変更する場合¶
- 「承認画面設定」をクリックし、「承認画面設定」画面を表示します。
- 登録済みの承認画面設定の一覧から変更対象の内容の「編集」をクリックします。
- 「参照遷移」のドロップダウンリストから設定する承認画面用フォームを選択し、「登録」をクリックし、承認画面が設定されます。
6.6.9.3. ステップ3:IM-Workflowの案件プロパティ情報を変更する¶
- メニューの「アプリ一覧」を表示します。
- 対象のアプリケーション名の「編集」をクリックします。
- 「WF連携設定」をクリックします。
- 「案件プロパティ設定」をクリックし、「案件プロパティ設定」画面を表示します。
案件プロパティを追加する場合¶
- 画面上部のツールバーの「登録」をクリックします。
- フローIDの右の虫眼鏡のアイコンをクリックし、フロー検索画面から対象のフロー、ノードを選択し、「決定」をクリックします。
- 「案件プロパティキー」には、事前に作成した案件プロパティキーを設定します。
- 「項目ID」は選択した案件プロパティキーに対応できるアプリケーションのフォームに配置した画面アイテムが候補として表示されます。
- 案件プロパティキーに対応する項目IDを設定し、「登録」をクリックすると、案件プロパティ項目として登録されます。
案件プロパティを変更する場合¶
- 画面に表示されている登録済みの案件プロパティの一覧から、変更を行う案件プロパティの行の「編集」をクリックします。
- 「案件プロパティキー」には、事前に作成した案件プロパティキーを設定します。
- 「項目ID」は選択した案件プロパティキーに対応できるアプリケーションのフォームに配置した画面アイテムが候補として表示されます。
- 案件プロパティキーに対応する項目IDを設定し、「更新」をクリックすると、案件プロパティ項目の内容が変更されます。
6.6.9.4. ステップ4:「追記設定」でIM-Workflowの承認画面で入力・変更が可能な項目を変更する¶
- メニューの「アプリ一覧」を表示します。
- 対象のアプリケーション名の「編集」をクリックします。
- 「WF連携設定」をクリックします。
- 「追記設定」をクリックし、「追記設定」画面を表示します。
追記設定が可能な項目を追加する場合¶
- 画面上部のツールバーの「登録」をクリックします。
- フローIDの右の虫眼鏡のアイコンをクリックし、フロー検索画面から対象のフロー、ノードを選択し、「決定」をクリックします。
- 「フォームID」「項目ID」「追記種別」を設定し、「登録」をクリックすると、設定した承認ノードの承認者の画面で指定した画面アイテムが入力・表示できます。
- フォームID:作成したアプリケーションで利用しているフォームを設定します。(ドロップダウンリスト)
- 項目ID:対象のアプリケーションのフォームに配置した画面アイテムで追記設定を行いたい画面アイテムを設定します。
- 追記種別:設定した承認ノードでの承認画面で、表示・入力できる場合には「追記可能」、表示させない場合は「非表示」を選択します。
追記設定が可能な項目を変更する場合¶
- 画面に表示されている追記設定の一覧から対象のデータの「編集」をクリックします。
- 「フォームID」「項目ID」「追記種別」を設定し、「更新」をクリックすると、追記設定の項目が変更されます。
6.6.10. IM-Workflow連携情報の解除(削除)¶
6.6.10.1. ステップ1:IM-Workflowのコンテンツ定義を削除する¶
- 詳細手順については、「IM-Workflow管理者操作ガイド」を参照してください。
6.6.10.2. ステップ2:IM-Workflowの連携情報を削除する¶
- メニューの「アプリ一覧」を表示します。
- 対象のアプリケーション名の「編集」アイコンをクリックします。
- 「WF連携設定」タブをクリックします。
- 「コンテンツ連携情報」画面で「削除」をクリックします。
6.6.10.3. ステップ3:アプリケーションを削除する¶
アプリケーションも削除する場合は、次の手順に従って行います。
6.6.11. 複数のフォームからスマートフォン版の画面遷移(フォーム遷移)を設定する¶
6.6.11.1. ステップ1:フォームの「スマートフォン設定」を設定する¶
すでに作成済みのフォームに対して、「スマートフォン版」での表示レイアウトを設定するには、「スマートフォン設定」を実行します。
6.6.11.2. ステップ2:フォーム遷移からスマートフォン表示を設定する(承認画面)¶
フォーム遷移で、処理画面の種類に合わせて画面遷移・スマートフォン表示を設定します。今回は、承認画面でのスマートフォン表示の設定となるため、「参照画面遷移」へのスマートフォン表示を設定します。
6.6.11.3. ステップ3:承認画面へのスマートフォン表示のフォーム遷移を設定する¶
フォーム遷移で登録したスマートフォン表示を、特定のノードの承認画面に設定します。
6.6.12. IM-FormaDesigner 2013 Springより前のバージョンで作成したアプリケーションをスマートフォンで利用する¶
IM-FormaDesigner 2013 Springより前のバージョンでWF連携設定を行ったアプリケーションからスマートフォンで申請・承認を行うためには以下の設定を行います。
6.6.12.1. コンテンツ定義にスマートフォン用画面設定を行う¶
「サイトマップ」→「ワークフロー」→「ワークフロー管理者」→「マスタ定義」→「コンテンツ定義」の順にクリックします。
作成済みのコンテンツ定義の「編集」をクリックします。
「バージョン」をクリックします。
対象のバージョンの「編集」をクリックします。
「画面」をクリックします。
「新規作成」をクリックします。
以下の画面の通りに入力し、「登録」をクリックします。
6~7の手順を繰り返し、以下の種類の画面をすべて登録します。
申請(起票案件)画面
一時保存画面
再申請画面
処理画面
確認画面
以上で、コンテンツ定義にスマートフォン用の設定ができました。
6.6.13. IM-FormaDesigner 2015 Winter以前のバージョンで作成したアプリケーションに、セッション情報を削除する処理を設定する¶
IM-FormaDesigner 2015 Winter以前のバージョンでWF連携設定を行ったアプリケーションのコンテンツ定義に、セッション情報を削除する処理を設定するには、以下の設定を行います。本項の設定を行うことにより、コンテンツ定義の申請・承認アクション処理後に、セッション情報を削除する処理を実行できます。注意
本設定は、 IM-FormaDesigner 2016 Spring以降のバージョンで作成したアプリケーションのコンテンツ定義では、自動的に設定されます。IM-FormaDesigner 2015 Winter以前のバージョンからアップデートする場合、必要に応じて設定してください。
6.6.13.1. コンテンツ定義にセッション情報を削除するユーザプログラムの設定を行う¶
「サイトマップ」→「ワークフロー」→「ワークフロー管理者」→「マスタ定義」→「コンテンツ定義」の順にクリックします。
作成済みのコンテンツ定義の「編集」をクリックします。
「バージョン」をクリックします。
対象のバージョンの「編集」をクリックします。
「ユーザプログラム」をクリックします。
「新規作成」をクリックします。
以下の画面の通りに入力し、「登録」をクリックします。
同じ手順を繰り返し、承認・処理後のアクション処理にもセッション情報の削除処理を登録します。
処理画面
項目 入力値 プログラム名 セッション情報削除処理 プラグイン種別 アクション処理 対象ノード 承認ノード プラグイン種類 【アクション処理】スクリプト開発モデルforma/imw/process/session_clear実行順番 999 以上で、コンテンツ定義に申請/承認アクション処理後にセッション情報を削除するための設定ができました。