yxiファイルを作ってマクロをパッケージ化する

[ozawa]

作成したマクロを配布する際には、yxmcファイルをそのまま共有したりPublic GalleryやAlteryx Serverにアップロードしたりといった方法があります。
これは非常に簡単な方法ですが、マクロの中で別なマクロを作成して利用していたり、HTML GUIを使ったマクロだったりすると、配布すべき対象が増えてしまい管理が煩雑になります。

yxiファイルを作成することでそれらの依存ファイルをまとめて1つのファイルとしてパッケージングできるとともに、Alteryxから利用可能となるよう簡単インストールできます。

yxiファイルで実現できること

yxiファイルを実行すると、Alteryx Designerが起動して以下のようなウインドウが表示されます

この画面で「Install」を選択することで、必要なファイルが自動的に%APPDATA%\Alteryx\Tools以下に展開されてマクロが利用可能な状態となります。

自作のマクロを配布する際にはこのyxiファイルのみを共有すればいいため複数のファイルで構成されるツールを配布するときには非常に便利です。

yxiファイルの作成方法

では、この構成からどのようにyxiファイルを作成するか解説していきます。

まずは、Config.xmlファイルを作成します。
このファイルの中身は以下のようになっています。

<?xml version="1.0"?>
<AlteryxJavaScriptPlugin>
  <Properties>
    <MetaInfo>
      <Name>Simple Macro</Name>
      <Description><![CDATA[Simple Macro]]></Description>
      <ToolVersion>1</ToolVersion>
      <CategoryName>Sample Macros</CategoryName>
      <Author>Yuya Ozawa</Author>
      <Icon>SimpleMacro.png</Icon>
    </MetaInfo>
  </Properties>
</AlteryxJavaScriptPlugin>

これらの値は、先ほどの画像のツールをインストールする画面に表示される項目になります。
他の場面では利用されないため、ツールそのものへの影響はありません。
MetaInfoタグ内の各項目がインストール画面に表示されている項目に対応しているのがわかるかと思います。
また、pngの画像ファイルもここで表示するアイコンのためのものになっています。

これで必要なファイルがそろいました。

あとはこれをもとにyxiファイルを作成するのですが、この方法はAlteryx側でその機能を提供しているわけではありません。
というのも非常にシンプルな方法で、Config.xmlファイルが直下に配置されるようにzipで圧縮して、拡張子をyxiに変更するだけです。
これで以下のようなファイルが作成されます。

注意点としては必ず直下にConfig.xmlファイルが配置されているようにすることです。
例えばzipの中身が以下のような構成はOKです。

zipの中身
    │  Config.xml
    │  SimpleMacro.png
    │
    └─SimpleMacro
        │  SimpleMacro.png
        │  SimpleMacroConfig.xml
        │  SimpleMacroGui.html
        │
        └─Supporting_Macros
                simple_macro.yxmc

一方以下のような構成はNGです。

zipの中身
└─SimpleMacro
    │  Config.xml
    │  SimpleMacro.png
    │
    └─SimpleMacro
        │  SimpleMacro.png
        │  SimpleMacroConfig.xml
        │  SimpleMacroGui.html
        │
        └─Supporting_Macros
                simple_macro.yxmc

yxiファイルのGalleryでの配布

ver.2019.1現在までの機能としてyxiファイルを直接Alteryx ServerやPublic Galleryにアップロードする方法はありません。

代替手段として

1. yxiファイルをダウンロード可能なサイトにアップロードしておく
2. 説明文および出力にダウンロード先へのリンクを張ったワークフローをアップロードする

という方法がよくとられているようです。