ステート保存

ステート保存は、モジュールの利用者がモジュール内の作業の現在の状態を保存し、その保存した状態に戻るか、他のユーザーと共有することができる強力な Workshop の機能です。

ステート保存は、Workshop で複雑で長時間かかるワークフローを構築するのを容易にし、ユーザー間の共同作業を促進します。ステート保存の使用例には以下のようなものがあります：

• Status プロパティが "Unresolved" 、 Location プロパティが "Zurich" の Alert オブジェクトをフィルター処理し、その状態を将来参照するために保存します。
• 特定の興味のあるオブジェクトを選択し、そのビューを共有するために保存します。
• ネイティブの Workshop ウィジェット（例：テキスト入力ウィジェットや日付入力ウィジェット）で構成された入力フォームを部分的に完成させ、データ入力を後で完成させるために状態を保存します。

ステートが保存されると、Workshop は次の2つを保存します：（1）Workshop モジュール内のプロモートされた変数の現在の値（"ステート"）と（2）オプションで、ユーザーが現在閲覧しているページ。Workshop の Edit モードでは、モジュールビルダーは、どの変数がプロモート（つまり保存）されるかを決定し、他のステート保存オプションを設定することができます。Workshop の View モードでは、モジュールの利用者は、ワークフローに必要なステートを保存、開く、共有することができます。

以下のスクリーンショットは、ステート保存の例を表示しています。この場合、モジュールビルダーは、ステート保存を設定して Filter List によって出力される Object Set Filter 変数を保存し、NYC の空港からの高優先度と中優先度の未対応アラートのフィルター処理基準を保存します。また、モジュールビルダーは、Object Table ウィジェットによって出力される現在の Object Set 変数も設定し、これにより、テーブルで現在強調表示されているアラートが保存され、その後、このモジュールの右側の Object View ウィジェットで表示されます。このステートが保存されると、モジュールの利用者は、将来この特定の NYC フライトアラートのビューに容易に戻ることができ、また、そのビューを他のユーザーとリンクで共有することができます。

ステート保存を有効にする方法

Workshop の Edit モードでは、ビルダーユーザーは以下の三つのステップでステート保存を有効にすることができます。詳細は以下に説明します：

1. 保存したいモジュール変数をプロモートします
2. モジュール設定パネルを開き、"Enable State Saving" をオンにします
3. オプションで、このモジュールの保存されたステートの許可される保存場所とショートカットを設定します

モジュール変数をプロモートする

まず、Variables パネルを開き、ステートを保存したいモジュール変数をプロモートします。そのためには、変数を選択し、その変数をプロモートして変数に外部 ID を割り当てるために星のアイコンをクリックします。以下のスクリーンショットは、Filter List によって出力される Object Set Filter 変数（これにより、ユーザーの選択したフィルター処理基準が保存されます）をプロモートする例を示しています：

ステート保存をオンにする

次に、 Pages & Layers パネルを開き、設定アイコン () をクリックしてモジュール全体の設定パネルを開きます。このパネル内で、下に示すように Enable State Saving トグルを有効にします。

オプション設定を設定する

Pages & Layers パネル内で、保存されたステート内でユーザーの現在のページを保持する設定を設定することができます。また、このモジュールの保存されたステートの許可される保存場所とフォルダーショートカットを設定することもできます。フォルダーショートカットを設定することで、このモジュールのすべての共有可能なステートが同じ場所に保存されることを確認するのが容易になります。

設定オプション

ステート保存に関して、主要な設定オプションは以下の通りです：

• ステート保存を有効にする： このトグルは、現在のモジュールに対してステート保存が有効かどうかを制御します。true の場合、モジュールの利用者は、プロモートされた変数のステートとモジュール内の現在のページを保存することができます。false の場合、モジュールの利用者はステート保存オプションを見ることはありません。
• 表示
  • ステート表示名： このフィールドは、単一の保存されたステートがどのように参照されるかを決定し、これは消費者ユーザーに対してこのモジュール内で参照され、特定のアプリケーションのニーズに画面上の言語を適応させることを意図しています。デフォルトでは、これは module state に設定されています。 inbox に設定すると、モジュールの利用者は画面上で saved inbox を参照し、 saved module state ではなく参照します。
  • ステート表示名（複数形）： このフィールドは、複数の保存されたステートがどのように参照されるかを決定し、これは消費者ユーザーに対してこのモジュール内で参照され、特定のアプリケーションのニーズに画面上の言語を適応させることを意図しています。デフォルトでは、これは module states に設定されています。 inboxes に設定すると、モジュールの利用者は画面上で saved inboxes を参照し、 saved module states ではなく参照します。
• データ
  • プロモートされた変数： ステートを保存すると、常にモジュール内の任意のプロモートされた変数の現在の値が保存されます。
  • ページ： 有効にすると、ステートを保存するとモジュール内の現在アクティブなページが保存されます。
• 場所
  • ショートカットを追加： このオプションは、ビルダーがこのモジュールのステートを保存できる特定のプロジェクトフォルダーへのショートカットを設定することを許可します。各フォルダーショートカットにはオプションでカスタム表示名を設定できます。
  • ユーザーのホームフォルダー： 有効にすると、ステートをユーザーのプライベートホームフォルダーに保存できます。
  • 任意の Compass 場所： 有効にすると、モジュールの利用者が選択した任意のプロジェクトフォルダーにステートを保存できます。

サポートされる変数タイプとウィジェット

ステート保存では、以下の Workshop 変数タイプの値を保存できます：

• Object Set
• Object Set Filter
• Boolean
• Date
• Number
• Timestamp
• String

ステート保存は、上記の変数タイプの一つを出力するウィジェットにも対応しています。これらの対応するウィジェットには以下のようなものがあります：

• Checkbox
• Date Input
• Date Time Picker
• Filter List
• Numeric Input
• Object Dropdown
• Object List
• Object Table
• String Dropdown