マクロ

バージョン:

2023.1

Last modified: February 21, 2023

マクロとは、別のワークフローに挿入できる単一のツールに組み込まれたワークフローまたはツールのグループです。繰り返し実行する分析プロセスを保存するマクロを作成します。毎回分析プロセスを作成し直すことなく、ワークフロー内でマクロを使用します。

マクロを .yxmc ファイルとして保存し、Designer で使用するか、Alteryx Analytics Gallery (gallery.alteryx.com) またはプライベート Gallery にアップロードして共有します。

マクロタイプ

標準マクロ: このマクロは、ワークフロー内のプロセスを、ワークフローに挿入できるツールとしてパッケージ化するために設計されています。
バッチマクロ: このマクロはワークフローで複数回実行され、実行ごとに出力が作成されます。マクロは、各レコードまたはデータの選択されたレコードグループに対して1回実行されます。マクロには、入力として[制御パラメータ]ツールが必要です。
反復マクロ: このマクロは、構成で設定された回数だけ、または条件が満たされるまで連続してワークフロー内で実行されます。
位置最適化マクロ: このマクロは、ネットワーク分析で 1 つ以上の最適な場所を特定するために使用できる反復マクロです。

マクロを構築する

マクロは、[インターフェース]ツールを使用して作成されたワークフローとユーザーインターフェースで構成されます。詳細については、インターフェースツールおよびインターフェースデザイナーウィンドウを参照してください。または、HTML-GUI ライブラリツールを使用してカスタムユーザインターフェースを作成することもできます。

マクロを構築するには、以下の手順に従います。

既存のワークフローを使用している場合は、マクロとして保存するワークフローの部分を選択し、新しいワークフロータブにコピーしアンドペーストします。

新しいワークフローを作成するか、既存のワークフローを開きます。
マクロ入力を追加する：
- ワークフローに入力が含まれていない場合は、[マクロ入力]ツールを追加します。
- ワークフローに入力ツール (データ入力ツールやテキスト入力ツールなど) が含まれている場合は、そのツールを右クリックして [ マクロ入力に変換する] を選択します。
マクロ入力ツールを構成します。
マクロ出力ツールを追加して構成します。

既定では、[マクロ入力]ツールがワークフローに追加されると、ワークフロータイプは標準マクロに変更されます。ワークフローにコントロールパラメーターツールを追加すると、マクロタイプはデフォルトでバッチマクロになります。反復マクロを作成するには、マクロタイプを反復に設定します。

マクロのタイプを設定するには：

キャンバスを選択し、[ワークフロー設定] ウィンドウで [ ワークフロー ] タブを選択します。
マクロの隣りの タイプで、マクロタイプを選択します。

マクロに変換する

マクロを最初から作成するだけでなく、既存のワークフロー (またはワークフローの一部) をマクロに変換することもできます。マクロに変換する前に、次の要件と制限事項を確認してください。

最初にワークフローを実行し、データが利用可能な場所すべてを参照する必要があります。
マクロに変換する前に、ワークフローを保存する必要があります。
選択するすべてのツールは、連続したパス内にあり、互いに接続されている必要があります (コメント、エクスプローラーボックス、およびツールコンテナは例外です)。
選択したツールにエラーがあってはなりません。
選択したツールにIn-DBツールを含めることはできません。
選択したツールは、アクションツールに接続できません。
選択したツールにPythonツールを含めることはできません。
選択したツールには、空間データ型、BLOB データ型、またはレポートデータ型を含むデータを含めることはできません。

マクロに変換するには、以下の手順に従いします。

ワークフローで 1 つ以上のツールを選択します。ワークフローキャンバスをクリックしてドラッグし、複数のツールを選択します。
選択したツールの 1 つを右クリックして、ツールメニューを開きます。
ドロップダウンから [ マクロに変換する ] を選択して、 マクロに変換 ウィンドウを開きます。
[マクロに変換] ウィンドウで、次の操作を実行します。
- マクロの [ ファイル名 ] を入力します。
- マクロを保存する [ 場所 ] を選択します。
- マクロの [ アイコン ] を選択します。
ワークフローまたはワークフローの一部をマクロに変換するには、[ 変換 ] を選択します。このプロセスを中止するには、[ キャンセル ] を選択します。
新しく作成されたマクロファイルはDesignerの新しいタブで開きますが、元のワークフローでは、選択したツールがマクロに変換されて表示されます。

マクロを保存

将来の使用と共有のためにマクロを保存します。マクロを一意の名前で特定の場所に保存します。Designerでは、コンピュータまたはネットワーク上の場所にマップされたマクロリポジトリを作成し、マクロを簡単に保存してワークフローで使用することができます。

マクロを保存するには、以下の手順に従います。

[ ファイル ] > [ 名前を付けて保存] を選択します。
マクロを保存するとき、コンピュータまたはネットワーク上のフォルダを探し出します。
マクロの一意の名前を入力して [ 保存] を選択します。

カスタムマクロを使用するワークフローを共有するには、ワークフローをエクスポートして、マクロを含むすべてのワークフローの依存関係をワークフローとともに保存するようにします。ワークフローには、マクロへの相対パスを含める必要があります。詳細については、ワークフロー管理およびワークフローの依存関係を参照してください。

マクロリポジトリを作成する

Designerで、マクロを保存した場所にマップすると、マクロリポジトリを作成してマクロを保存し、ワークフローで使用することが簡単にできます。選択した場所にあるマクロ.yxmcファイルがツールパレットのツールカテゴリに表示されます。

マクロリポジトリを作成するには、以下の手順に従います。

[ オプション ] > [ ユーザー設定 ] > [ ユーザー設定の編集 ] > [ マクロ] の順に移動します。
[+] ボタンを選択します。
[ カテゴリ名] に名前を入力します。既定の名前はMacrosです。
[...] ボタンを選択して、コンピューターまたはネットワーク上のマクロを保存する場所を参照します。

検索パス内のサブフォルダーは、その親フォルダーがすでにマクロリポジトリに存在する場合は、個別に追加することはできません。

既定のリポジトリの場所を設定するには、以下の手順に従います。

リスト内のリポジトリ検索パスを選択します。
既定に設定を選択します。既定のリポジトリーの横にアスタリスク (*) が表示されます。

ワークフローでのマクロの使用

マクロリポジトリに保存されているマクロを使用するには、ツールパレットでマクロを検索するか、[検索]を使用します。

ツールパレットにないマクロを使用するには、ワークフローキャンバスを右クリックし、[ 挿入 ] > [ マクロ] の順に選択します。キャンバスで現在開いているマクロは、このリストから選択するか、別のマクロ* .yxmcファイルの場所を閲覧できます。

ワークフローで特定のマクロバージョンを使用するには、マクロを右クリックして、実行するバージョンを選択します。マクロのバージョンはすべて同じディレクトリに保存する必要があります。この場所は ユーザー設定 で構成できます。

マクロをワークフロー中のツールと区別するには、[ ツールのマクロインジケーターを表示する ] オプションを選択して、[ ユーザー設定 ] > [ キャンバス ] の画面で +アイコンが表示されるようにします。詳細については、ユーザー設定を参照してください。

マクロのワークフローを表示するには、ワークフロー内のマクロを右クリックし、[ マクロを開く] を選択します。ワークフロー内のマクロは、そのマクロに対する変更が保存されると自動的に更新されます。

サンプルマクロ

Designerには、マクロの使用方法や作成方法を学習するためのマクロが含まれています。マクロにアクセスするには、以下の手順に従いいます。

コンピューターの Program Files から、 \Program Files\Alteryx\bin\RuntimeData\Macrosに移動します。
Designer で、次の操作を実行します。
- [ ヘルプ ] > [ サンプルワークフロー ] > [ チュートリアル ] > [ マクロの構築] の順に選択します。
- ツールパレットの一部のツールはマクロです。たとえば、サンプル作成ツールとデータクレンジングツールです。ツールを右クリックし、[ マクロを開く ] があればそれを選択し、マクロワークフローを表示します。
Alteryx Analytics Gallery で、 Alteryx パブリック Galleryで公開されているアプリにアクセスします。