変換済みAlteryxアプリの使用
PlaidCloud は、Alteryx 分析アプリの質問を、制御されたワークフロー変数に変換します。ユーザーは実行前にそれらの変数を設定でき、PlaidCloud はその値を、式、フィルター、ファイルパス、条件、マクロパラメーター、下流のステップ設定に適用します。
App Runner フロントエンド
Section titled “App Runner フロントエンド”Alteryx 分析アプリ(.yxwz)を変換すると、そのインターフェースも、公開済みのPanel「App Runner」として具体化されます。これは、Alteryx の質問が集めていたものと同じ値を収集し、その値で変換済みワークフローを実行する、実際に動作する入力フォームです。このフロントエンドは変換の一環として自動的に作成されます。入力ウィジェットのないアプリはスキップされます。
アプリの質問は App Runner のコントロールになります。テキスト、数値、日付、チェックボックス、ラジオボタン、ドロップダウン、リストボックス、ツリー、ファイル参照、フォルダー参照があります。各コントロールは、変換済みステップが読み取るワークフロー変数に書き込むため、App Runner からの実行は、変数を手動で設定した場合と同じロジックを動かします。実際のワークフロー変数にバインドされていないコントロールには、値を黙って収集してどこにも届かないままにするのではなく、目に見える注記が表示されます。内容を確認し、意図した変数に紐付けてください。
フォームは、アプリ作成者自身によるグループ分け(作成者がアプリを組み立てたときのタブとラベル付きボックス)に沿って配置され、作成者による説明テキスト(Alteryx の Label ツール)も、それが説明する質問の横に表示されます。デザイン時に固定されたアプリの質問、たとえばインターフェースの質問に制御されていない Detour などは、質問としてはまったく表示されません。
フォームは、ワークフローの変数に保存されている値で開きます。誰かが別の値を保存していない限り、作成者のデフォルト値です。保存値のない質問は空白になります。保存済みの値が質問の選択肢のいずれにも一致しなくなった場合は、古い選択として表示されるのではなく、無視されます。数値の質問では、作成者が設定した最小値、最大値、ステップが適用されるため、小さな範囲に制約された質問に範囲外の値を答えることはできません。
変換済みワークフローが分岐する場合、App Runner はその分岐をラベル付きの選択肢として表示します。これにより、Alteryx アプリが行っていたのと同じように、実行がたどるパスを実行時に選べます。
ファイルとフォルダーの質問
Section titled “ファイルとフォルダーの質問”ファイルまたはフォルダーの質問にはそれぞれ参照ボタンがあり、ドキュメントブラウザーが開くので、パスを記憶に頼って入力する代わりに選択できます。
- 参照では、アクセスできるドキュメントアカウントが表示され、デフォルトではアプリ自身のアカウントが選ばれています。アカウントは切り替えられます。
- 質問の現在の回答が示すフォルダーで開きます。まだ回答がない場合は、アカウントの最上位で開きます。
- 上部のパンくずリストで上の階層に戻れます。一覧でフォルダーを選択するとそのフォルダーが開き、ファイルを選択するとそのファイルが選ばれます。
- 選択を押す前に、入力されるパスが表示されます。何も強調表示されていない場合、選択は現在表示しているフォルダーを対象にします。アカウントの最上位を選ぶにはこの方法を使います。
- フォルダーを一覧表示できない場合は、一覧にその旨と理由が表示され、選択は、確認していないパスを入力することはありません。20 秒以内に応答がない一覧表示では、アカウントが応答しなかったと表示されます。
アプリを実行する
Section titled “アプリを実行する”フォームに入力して、実行を押します。
回答は実行とともに渡され、その実行にのみ有効です。ワークフローには保存されないため、あるユーザーの回答が別のユーザーの実行に影響することはなく、アプリを実行するのにワークフローを変更する権限は必要ありません。これは、行を制限するプロジェクトで重要です。そのようなプロジェクトは、アーキテクトだけが変更できます。フォームが開くときの値を変更するには、後述のとおり、その値をワークフローに保存してください。
回答は、実行が始まる前に確認されます。回答されていない選択式の質問があると、実行が始まる前に停止し、該当する質問が示されます。1 時間近くかかることもある実行の途中で初めて発覚する、ということはありません。
実行中、フォームには、進行状況バー、ワークフローの総ステップ数に対する N of M steps、経過時間、現在実行中のステップが表示されます。一時停止と停止は、実行中のみ実行の横に表示されます。一時停止中は、一時停止が再開に変わります。
失敗したステップは、失敗した時点でフォーム上に名前が表示され、実行が終了すると、フォームには失敗した各ステップのメッセージが引用されます。停止した理由を調べるために、ワークフローを開く必要はありません。前のステップが失敗したために実行できなかったステップは、失敗ではなく未実行として別に表示され、進行状況バーにも含まれるため、バーは最後まで進みます。
ページを閉じたり接続が切れたりしても、実行は続行されます。実行がまだ続いている間にアプリをもう一度開くと、待機中のフォームではなく、一時停止と停止が付いた実行中の画面が表示されます。
実行の横にあるワークフローを開くリンクをクリックすると、基になるワークフローが PlaidCloud の新しいタブで開きます。DAG ワークフローの場合は、そのキャンバスで開きます。フォーム自身が実行状況の更新を停止していても、このリンクは機能します。
後述のとおり、変数を設定してワークフローを直接実行することも引き続き可能です。App Runner は、アプリのような追加の入り口です。
アプリを最新の状態に保つ
Section titled “アプリを最新の状態に保つ”App Runner アプリは、app.py、widget_map.py、requirements.txt を PlaidCloud が生成するPanelサーバーアプリです。PlaidCloud が App Runner を更新すると、既存のアプリは自動的に新しいバージョンを取り込みます。各アプリは現在のファイルに更新され、次に PlaidCloud が更新されたとき、および アプリ 画面でアプリを再ビルドまたは編集したときに、再ビルドされます。アプリの設定とワークフローは変更されません。
- ファイルの保存場所。 管理対象の PlaidCloud Git 接続では、App Runner アプリは、ワークスペースの
appsリポジトリ内に、アプリ名を付けたフォルダーとして、他のPanelアプリと並んで保存されます。独自のリポジトリがあったアプリは自動的にそのフォルダーへ移され、古いリポジトリはアーカイブされます(読み取り専用で保持され、削除されることはありません)。appsへのプッシュでアプリが再ビルドされるのは、そのアプリ自身のフォルダー、またはリポジトリのルートにあるrequirements.txtが変更された場合のみです。 - ロックされたアプリはそのまま維持されます。 ロックを解除して再ビルドをクリックすると、最新の状態になります。
- 生成されたファイルへの手動編集は置き換えられます。 更新を行うと、現在の
app.py、widget_map.py、requirements.txtがあなたの変更の上に書き込まれます。以前のバージョンは、アプリの Git 履歴に残ります。
変換される入力タイプ
Section titled “変換される入力タイプ”PlaidCloud は、Alteryx アプリの一般的なコントロールを、型付きのワークフロー入力に変換します。
- テキストボックスはテキスト変数になります。
- 数値コントロールは数値変数になります。
- 日付コントロールは ISO 日付変数になります。
- チェックボックス、ラジオボタン、ドロップダウン、リストボックス、ツリーは、制御された選択式の変数になります。
- ファイル参照コントロールはドキュメントのファイル変数になります。
- フォルダー参照コントロールはドキュメントのフォルダー変数になります。
変換済みワークフローは、Alteryx アプリが元の質問の値を使っていたすべての箇所で、これらの変数を使用します。
実行前に値を設定する
Section titled “実行前に値を設定する”変換済みアプリのワークフローを実行する前に、次の手順を行います。
- 変換済みワークフローを開きます。
- ワークフロー変数を確認します。
- 必須のテキスト、数値、日付、選択、ファイル、フォルダーの値を設定します。
- ドキュメントのファイルパスとフォルダーパスが、インポートした依存関係の場所、または承認済みの別のドキュメントパスを指していることを確認します。
- ワークフローを実行します。
スケジュール実行では、スケジュールが実行されるたびに使用する変数値を保存してください。
条件、警告、エラー
Section titled “条件、警告、エラー”Alteryx アプリの条件とエラーチェックは、PlaidCloud のステップ条件に変換されます。条件では、次のことができます。
- ワークフローの続行を許可する。
- 警告メッセージを出力する。
- アプリのルールで求められる場合に、明確なエラーでワークフローを停止する。
- 実行を別の分岐に振り分ける。
この動作を使うと、PlaidCloud でワークフローを実行しながら、アプリレベルの検証を維持できます。
ファイルとフォルダーの入力
Section titled “ファイルとフォルダーの入力”ファイルとフォルダーの質問では、ドキュメントのパスを使用します。
- ファイル入力では、ドキュメントからファイルを選択します。
- フォルダー入力では、ドキュメントのフォルダーを選択します。
- インポートしたデスクトップの依存関係は、インポート時に選択したドキュメントパスに保存されます。
- 動的入力ステップでは、変数を使って、実行時に最終的なドキュメントパスを解決できます。
これにより、変換済みアプリは、ユーザーやスケジュール実行をまたいでも移植可能です。
マクロパラメーター
Section titled “マクロパラメーター”変換済みアプリがマクロを呼び出す場合、アプリの変数をマクロパラメーターに渡せます。PlaidCloud は、マクロの入力パラメーターと制御パラメーターの処理を通じて、これらの値を生成されたマクロワークフローに渡します。
並行して実行されるマクロは互いに分離されているため、複数のワークフロー実行が、中間状態を共有することなく、同じ変換済みマクロを使用できます。
検証チェックリスト
Section titled “検証チェックリスト”変換済みのアプリごとに、次の点を確認します。
- 想定されるすべての質問が、ワークフロー変数として表示されている。
- デフォルト値を設定していた場合、元のアプリのデフォルト値と一致している。
- 制御されたリストに、想定される選択肢が含まれている。
- ファイル変数とフォルダー変数が、ドキュメントのパスを指している。
- 条件によって、想定されるメッセージ、警告、または停止動作が生成される。
- 選択した変数値で、出力パリティが成功する。