モジュールインターフェース

モジュールインターフェースは、埋め込まれた親モジュールの変数にマッピングできる変数と、URLから初期化される変数のセットです。モジュールインターフェースは、WorkshopモジュールのAPIと考えることができます。

モジュールインターフェースに変数を追加するには、変数の設定パネルに移動し、外部IDを追加し、モジュールインターフェースのトグルが有効になっていることを確認します。オプションで、モジュールインターフェース変数に表示名と説明を付けることができます。これは、モジュールが埋め込まれている場合や、Open Workshop module eventで使用される場合に表示されます。

埋め込まれたモジュールインターフェース

モジュールを埋め込むと、そのモジュールのモジュールインターフェース変数が入力として設定できるようになります。これについては、埋め込まれたモジュールのドキュメント内の 変数間のやり取りで詳しく説明されています。

Open Workshopモジュールイベント

Open Workshopモジュールイベントを使うと、下記のように手動でURLを作成する手間が省けます。選択したモジュールのインターフェースが表示され、現在のモジュールから選択されたモジュールのインターフェース変数に変数の値を渡すことができます。イベントが呼び出されると、URLは現在の値を使用して選択されたモジュールを開きます。

モジュールインターフェース変数を含むURLの作成

Open Workshopモジュールイベント以外では、URLクエリパラメーター値を使ってモジュールインターフェース変数を設定し、アプリケーションの状態をカスタマイズしたリンクで共有できるように、手動で動的にURLを生成することができます。以下の手順に従ってください：

1. Workshopアプリにログインします。
2. ブラウザからURLをコピーします。ビューモードになっていることを確認し、編集モードではありません。このURLは固定されているので、適切な権限を持つ他のユーザーと共有することができます。
3. 編集モードに戻ります。
4. 左サイドバーにある変数メニューを選択します。
5. 新しい変数 > 文字列 > 静的 を作成します。
6. 変数の設定タブに移動し、外部IDを追加します。
7. ステップ2のURLに ? を追加し、外部ID、 = 、設定したい値を続けて追加します。例： ?interfaceVariable=123。他のモジュールインターフェース変数を追加するには、アンパサンド & と追加の外部ID、等号 = 、値を続けて追加します。

リンクが使用できるようになり、URLで設定された値をモジュールインターフェース変数として定義します。このリンクは、変数変換を使用して動的に生成され、アクションフォーム、関数、または他の変数変換からの値が使用されます。

テスト目的で、URLの /latest/ を /dev/ に変更すると、リンクは最後に保存されたWorkshopアプリケーションのバージョンにリダイレクトされるようになります（最後に公開されたバージョンではなく）。