ブログ

アナリティクスに関する聡明な考えに触れ、インサイトとアイデアが得られます。
AndrewL
Alteryx
Alteryx

@AndrewL  による投稿(英語から翻訳)

 

このガイドは、新規ユーザーが Cloud Execution for Desktop をスムーズに使い始めるためのものです。サインインからスケジューリングまでの詳細、注意点、落とし穴を網羅しています。付属のサンプルワークフローに沿って進めてください。

 

要件

 

Cloud Execution for Desktop を使い始める前に、以下が必要です:

-Alteryx Analytics Cloud (AAC) エンタープライズ版

o Cloud Execution for Desktop は、管理者がワークスペースで有効化する必要があります  。

o プライベートデータの取り扱いが必要です。

-Alteryx Designer Desktop バージョン 2023.1 パッチ1以降

-データ接続マネージャー(DCM)が、Designer DesktopでAAC ワークスペースを認証するために必要です。

-ユーザーには Cloud Execution for Desktop クリエイターのロールが割り当てられている必要があります。

 

Link Designer Desktop Alteryx Analytics Cloud の連携

 

Cloud Execution for Desktop を利用する前に、Designer Desktop と Alteryx Analytics Cloud (AAC) ワークスペースの間にリンクを作成する必要があります。そのためには...

  1. Designer Desktop で File > Manage Connections を開き、DCMを起動します。
  2. 左側のメニューから Alteryx Links を選択し、+ New ボタンをクリックします。

 

image-20241212-172456.png

 

 

  1. Analytics Cloud はデフォルトのテクノロジーとしてあらかじめ選択されています。必要な情報を入力します:

o データソース名: このリンクの表示名(ラベル)です。この名前は[Save As]および[Open]メニューに表示されます。わかりやすいラベルを使用すると、将来接続を識別しやすくなります。

o クラウドインスタンスURL:Alteryx Analytics Cloud Platform にアクセスするためのURLです。この情報はAAC管理者にお問い合わせください。

o ワークスペース名:URLに表示されるAACワークスペース名です。例えば、https://company.alteryxcloud.com/?workspace=my-workspace でアクセスする場合は、Workspace Name フィールドに my-workspace と入力します。この情報はAAC管理者にお問い合わせください。

 

image-20241212-173118.png

 

 

  1. Save を選択します。
  2. 次に資格情報をリンクする必要があります。+ Connect Credential を選択します。
  3. Cloud Execution for Desktop は、OpenID Connect (OIDC) 認証方式をサポートしています。このオプションは Authentication Methodドロップダウンであらかじめ選択されています。

 

image-20241212-175623.png

 

 

  1. OIDC TOKENSセクションで、Credentialドロップダウンから既存の資格情報を選択するか、新規資格情報を作成します。
  2. 新しい資格情報を作成する場合は、資格情報名を入力してください。このラベルは将来識別する際に役立ちます。

 

image-20241212-180236.png

 

 

  1. Vault(保管庫)はデフォルトでDCMです。
  2. Test Connection を選択します。このステップは任意ですが、接続情報が正しいかを確認できます。
  3. Create and Link を選択して完了します。AACワークスペースにサインインしていない場合、ブラウザで認証を求められます。

 

接続に失敗した場合は、AAC接続のクラウドインスタンスURLとワークスペース名が正しいか確認してください。

 

Designer Desktop を Alteryx Analytics Cloud Platform に正常に接続すると、接続情報は  File > Manage Connections > Alteryx Links から確認できます。[Name]列のデータソース名を選択すると、詳細の確認、編集、削除が可能です。

 

Alteryxリンクの表示、編集、同期

 

Designer Desktop と AACのリンクを作成すると、Designer Desktop DCM接続を、AACとシームレスに接続して同期でき、Cloud Execution for Desktop で利用可能になります。これにより両プラットフォームで接続情報を一貫して保つことができます。

 

あなたの資格情報は Alteryx Links で作成した各リンクの「接続」セクションから同期できます。

 

  1. File > Manage Connections > Alteryx Links に移動します。
  2. 既存のリンク名を選択し、リンクを開いて詳細を表示します。
  3. リンクを更新するには、Edit ボタンをクリックします。必要な変更を加え、Save、または Cancel を選択して前の画面に戻ります。
  4. Connections セクションで Synchronize を選択し、Designer Desktop と AACの間で資格情報を同期します。

 

同期が完了すると確認メッセージが表示されます。同期に問題がある場合はエラーメッセージが表示されます。

 

接続や資格情報に変更を加えたときや新しい接続や資格情報を設定したときは、必ず同期を行うのがベストプラクティスです。これにより、DCM接続が Cloud Execution for Desktop で利用可能になります。

 

ワークスペースに保存する

 

AACで認証ができ、環境で Cloud Execution for Desktop が有効になり、Designer Desktop と AAC をリンクできたので、次はワークフローやアプリを保存しましょう。

 

このガイドでは、添付のサンプルワークフロー PharmacySpatialProcess.yxmd を使用します。サンプルワークフローをダウンロードして一緒に進めても構いませんし、すでに完成しているワークフローやアプリを開いていただいても構いません。

 

なお、PharmacySpatialProcess.yxmd のサンプルワークフローを示すスクリーンショットでは、入力が Amazon S3 Download コネクタになっていますが、添付のバージョンでは Text Input ツールを使用しています。

 

ワークフローやアプリの準備ができたら、先ほど作成したリンクを使ってAACに直接保存します。ワークフローやアプリをAACに保存するには...

 

  1. File > Save As > Alteryx Analytics Cloud を選択し、利用可能な接続リストから使用するワークスペースを選びます。探しているワークスペースがリストにない場合は、Add New Link を選択し、上記手順に従ってリンクを作成します。

 

image-20241217-211242.png

 

 

  1. ワークフローやアプリの名前は、デフォルトで Workflow Name フィールドに入力されています。必要に応じて変更してください。ワークフローやアプリに含まれるすべてのアセットがワークフロー名の下に一覧表示されます。ここには、入力・出力・マクロなど、ワークフローと一緒にパッケージ化する必要があるものが含まれます。

 

image-20241217-211800.png

 

 

  1. Group Assets by tool チェックボックスをオンにすると、どのツールがアセットを使用しているか確認できます。不要なアセットのチェックは外してください。

image-20241217-212250.png

 

 

メモ:このチェックボックスを使ってもアセットの関連付けやパッケージ方法は変わりません。リストを見やすくし、確認を容易にするためのものです。

 

  1. この例では HeaderMacro.yxmc はデフォルトでインストールされるレポートヘッダーツールで使用されるため、不要なのでチェックを外しています。
  2. Save を選択します。AACワークスペースにまだサインインしていない場合、ブラウザーが開き、サインインを促します。認証されると、Alteryxがワークフローやアプリで禁止されている(非DCMの)データ接続を使用していないか検証します。 ツール、エンジン、ドライバー、コネクタの互換性を参照すると、サポート対象の一覧を確認できます。保存が正常に完了すると、キャンバス下部に緑色の通知バーが表示されます。

 

image-20250131-205845.png

 

 

検証は保存中に行われ、別のアクションではありません。検証に失敗しない限り、何も表示されません。

 

保存後はAACでワークフローやアプリを確認できます。ブラウザーでワークスペースにアクセスするか、保存後に表示される緑色の通知バーでViewを選択してください。

 

画面上部の Library を選び、左のリストから Designer Desktop をクリックします。ここで Cloud Execution for Desktop で利用可能なすべてのアセットを確認できます。Owned by me または Shared with me で表示を絞り込むことも可能です。

 

ワークフローやアプリの名前、共有相手、所有者、最終更新日が表示されます。AACに直接保存したものは、すべてあなたが所有者として表示されます。

 

image-20241217-220215.png

 

 

Cloud Execution for Desktop の使用

 

ワークフローがAACに保存されました。次はどうしましょう?ワークフローやアプリをAACに保存したら、いくつかの方法で使用できます。

 

ワークフロー

 

AACに保存された Designer Desktop のワークフローは、Cloud Execution for Desktop を使ってさまざまな方法で実行できます。ワークフローはオンデマンドで実行できるほか、指定した時間にスケジュールしたり、Plans に追加したりできます。

 

手動で実行

 

ワークフローを手動で実行するには...

  1. Library に移動し、左側のパネルから Designer Desktop を選択します。
  2. 実行したいワークフローを探し、その横にある三点リーダーメニューを選択します。次に Run を選択します。

image-20250110-180825.png

 

  1. 左下にジョブ開始の通知が表示されます。

 

image-20250110-180950.png

 

結果を確認するには...

  1. Jobs に移動し、Designer Desktop を選択します。
  2. ジョブは新しいものから古いものの順に一覧表示されます。
  3. 結果を確認したいジョブを見つけて、出力ボタンを選択します。

 

image-20250110-181419.png

 

  1. Job Outputs ウィンドウが開き、ジョブから返されたすべての出力が表示されます。ダウンロードしたい出力のダウンロードボタンを選択してください。

image-20250110-181528.png

 

Jobs タブには、ジョブID、アセット名、実行タイプ、実行者、実行日時(実行時間を含む)などの情報も表示されます。

 

image-20250110-182135 (1).png

 

このジョブ一覧は、フィルターオプションを使って自分が実行したジョブだけを表示することも可能です。フィルターオプションでは、アセット名、実行タイプ、実行者、ステータスで絞り込みができます。

 

image-20250110-182322.png

 

各フィルターはチェックボックスリスト形式で表示され、選択した条件で結果を絞り込めます。例えば「Status」でフィルターをかけると、「Queued」「Running」「Success」「Cancelled」「Failure」から選択できます。確認したいステータスにチェックを入れてください。複数選択も可能です。

 

image-20250110-182656.png

 

スケジュール

 

ワークフローをスケジュールするには...

  1. Library に移動し、左側のパネルから Designer Desktop を選択します。
  2. スケジュールしたいワークフローを探し、その横の三点リーダーメニューを選択し、Schedule をクリックします。

 

image-20250110-183135.png

 

  1. +Add New Schedule を選択します。

 

image-20241218-212416.png

 

  1. スケジュールの名前を入力します。

 

image-20241218-212630.png

 

  1. Occurrence(実行頻度)を設定します。各オプションの詳細は以下を参照してください。

 

image-20241218-212819.png

 

  1. Schedule を選択します。おめでとうございます!最初のスケジュールが設定されました。

 

頻度は何を選べばよいでしょうか?各オプションの動作を確認し、自分のニーズに合ったものを選びましょう。

  • Recurring オプションでは、スケジュールを実行する頻度を設定できます。これは、同じ間隔でワークフローを繰り返し実行したい場合に便利です。設定できる頻度には、毎時、毎日、毎週、毎月があります。それぞれのオプションには異なる設定項目があります。例えば「毎時」では、スケジュールを実行する分単位の指定、使用するタイムゾーン、開始日時と終了日時を設定できます。「毎月」では、月の日付(1〜31日)または月の第何週(1〜5週)と曜日を選択できます。その後、スケジュールの実行時刻、タイムゾーン、開始日と終了日を指定できます。
  • Once オプションでは、スケジュールを実行する日時と使用するタイムゾーンを指定します。
  • Custom オプションでは、cron構文を使ってスケジュールを指定できます。cron構文を使うと、毎時から毎年まで、さまざまな間隔で柔軟にスケジュールを設定できます。cronスケジュールは、スペースで区切られた値の文字列で定義されます。値は「分・時・日・月・曜日」の順に並びます。例えば、3月23日の午後10:15に実行したい場合は「15 22 23 3 *」と入力します。この例では、*(アスタリスク)が曜日を問わないワイルドカードとして使われ、3月23日が何曜日であっても午後10:15にスケジュールが実行されます。cron構文の詳細はこちらをご覧ください。

 

-Event Trigger オプションでは、トリガーとなるイベントが発生した際にスケジュールを実行するよう設定できます。例えば、データベースやファイルの更新、新規ファイルの作成などです。Event Trigger を頻度として選択すると設定が始まります。

 

image-20250110-190623.png

 

o 必要な接続を選択するか、接続がない場合は Create Connection を選択して接続ページを開きます。

o 右上の Create Connection をクリックします。

o 作成したい接続を選び、指示に従って設定を完了してください。必要な情報は接続の種類によって異なります。

 

image-20250110-191230.png

 

ワークフローをスケジュールする別の方法として、ページ上部の Schedules を開き、 New を選択します。

 

image-20241218-221118.png

 

スケジュール設定ウィンドウが開きます。この方法で入ると、設定メニューの見え方が少し異なります。ここではスケジュール対象のアセットタイプを指定し、対象のアセットを選択する必要があります。

 

image-20241218-221327.png

 

アセットタイプでは、Workflow、Desktop Workflow、Plan、Reporting Project から選択できます。AACに保存したワークフローをスケジュールする場合は、Desktop Workflowを選びます。選択すると、アセットドロップダウンにはスケジュール可能なデスクトップワークフローだけが表示されます。

 

image-20241219-203525.png

 

アセットタイプとアセットを選択したら、残りの設定は前述と同じです。使用したい頻度を選び、必要なオプションを入力して、Schedule をクリッ

クします。

 

完了すると、新しく設定されたスケジュールが Schedules ページに表示されます。

 

image-20241219-203950.png

 

既存のスケジュールを更新

 

新規スケジュールの作成と同じように、既存のスケジュールもLibraryページまたはSchedulesページから更新できます。

  1. Library ページにいる場合は、ワークフローの横にある三点リーダーメニューを選択し、Schedule をクリックします。ダイアログボックスには、すべての既存スケジュールが表示され、新規スケジュールを追加するオプションも表示されます。

 

image-20241219-210206.png

 

  1. 既存のスケジュールを編集するには、スケジュール名の右にある三点リーダーメニューをクリックします。スケジュールを編集、無効化、または削除することができます。

 

image-20241219-210524.png

 

  1. Edit を選択してスケジュール設定ウィンドウを開き、必要な設定を更新して Save をクリックします。

 

Schedules ページからスケジュールを更新する場合も同様です。更新したいスケジュールの横にある三点リーダーメニューを選択し、Edit をクリックして設定を変更します。

 

Plans

 

AACに保存された Designer Desktop ワークフローをプランに追加することもできます。Plans を使うと、Alteryx Analytics Cloud で複数の個別タスクを順番に実行できます。詳しくはヘルプページをご覧ください。

 

PlansにCloud Execution タスクを追加するには...

  1. 左側のパネルから Plans に移動します。

 

image-20250110-185042.png

 

  1. 右上の + New をクリックします。
  2. Plans が開いたら、左側のパネルから Designer Desktop をプランキャンバスにドラッグします。

 

image-20250110-185359.png

 

  1. タスクをキャンバスに追加したら、右側のメニューから使用する Designer Desktop ワークフローを選択し、Select をクリックします。

 

image-20250110-185545.png

 

  1. タスクはワークフロー名で更新されます。

 

image-20250110-185727.png

 

左側のパネルに表示される項目から、複数のタスクを1つのプランに追加できます。タスク同士は接続線を使って順番に実行させることができます。これは Designer Desktop ツール間の接続線と同じ仕組みです。各出力アンカーは、その条件に応じて接続されたタスクをトリガーします。チェックマークの出力アンカーは現在のタスクが成功したときに下流タスクを実行します。「>」アンカーは成功・失敗に関係なく下流タスクを実行し、「x」アンカーはタスクが失敗した場合のみ下流タスクを実行します。

 

分析アプリ

 

ワークフローと同じように、Designer Desktop から AAC に Analytic Apps を保存できますが、これらはスケジュール設定できません。Cloud Execution for Desktop を使って分析アプリを実行するには...

  1. Library ページに移動します。
  2. 実行したい分析アプリを探し、その右にある三点リーダーメニューを選択します。
  3. Run Analytic App を選択します。

 

実行を選択すると、新しいブラウザタブが開き、Alteryx App Builder が起動します。ここでアプリのUIが表示されます。必要な値を入力して Run をクリックしてください。ジョブ実行中はブラウザに処理中であることが表示されます。

 

image-20241220-144904.png

 

完了するとアプリ設定画面に戻り、画面下部に通知バーが表示されます。

 

image-20241220-144414.png

 

結果を確認するには、通知バーから Download をクリックします。アプリの出力を含む ZIPファイルがダウンロードされます。

 

image-20241220-144538.png

 

まとめ

 

これで、Cloud Execution for Desktop を使って Designer Desktop のワークフローやアプリを実行・スケジュールする方法を理解していただけたと思います。この記事内で紹介したリンクはすべてヘルプドキュメントにまとめられています。まだ試していない方は、ぜひ添付のサンプルワークフローをダウンロードして実際に使ってみてください!