
【Alteryx Server Tips】 Alteryx Serverにワークフローをアップロード
こんにちは
Alteryx Serverについて書いていきましょうの3回目です。
前回Server UI にサインインするところまで説明しました。早速Alteryx Serverでワークフローを実行しましょう、といきたいのですが、その為にはDesignerで作成したワークフローをServerにアップロードしないとダメ。
ということで今回はServerへのワークフローをアップロードする方法についてです。
まずは簡単な流れを説明してから、細かいところをいくつか触れていこうと思います。
ワークフローアップロード手順
Serverへワークフローをアップロードする方法はいくつかありますが、Designerからアップロードするのが一般的です。
管理者UIやServer APIを利用してアップロードすることも可能。管理者UIやServer APIの利用は、ワークフローのアップロードを厳密に管理してたり、Designerとのバージョン互換性の問題から管理者UI、Server APIを利用して管理者サイドでアップロードするケースでの利用が考えられます。まあ大抵の場合は開発者自身が作成したワークフローをDesignerからServerにアップロードしているのではないでしょうか。
ということで今回のワークフローアップロードの説明はDesignerから行う方法で説明します。なお今回もAlteryx Serverの認証方式はビルトイン認証であることを前提に進めますのでご承知おきを。
管理者UI、Server APIを利用する場合については後日説明しようとは思っていますが、いまのところまだ結構先になる見込みです。。。
Designerでアップロードするワークフローを開きましょう
まずはDesignerでアップロードしたいワークフローを開いておきます。既存のyxmdやyxwzのファイルを開いてもいいですし、新規にワークフロー作成でも構いません。
実際にServerにアップロードしてみましょう
Designerのメニューバーのファイル
⇒名前を付けて保存(A)
⇒Alteryx Server
⇒新しいServerを追加
でAlteryx Serverへ接続するための画面を開きましょう。
新しいServerを追加
を選択すると下記のダイアログが表示されますのでワークフローをアップロードするServerのURLを入力します。
URLはhttp://xxxxxxxx/gallery
もしくは https://xxxxxxxx/gallery
となります。
※ xxxxxxxxはServerのホストを指定します。
例
- http:// alteryx-server-○○○○.co.jp/gallery
- http:// 35.xxx.xxx.xx/gallery
- https:// alteryx-server-○○○○.co.jp/gallery
- https:// 35.xxx.xxx.xx/gallery
URLを入力して「接続」ボタンを押すと認証画面がでてきます。
Eメール
、パスワード
の入力を求められますので、Serverにログイン時のアカウント情報を入力して接続
ボタンを押下してServerに接続!
ワークフローを保存のダイアログが表示されますので、必要に応じてワークフロー名などを変更してアップロードします。
今回はアセット(ワークフローと一緒にアップロードするファイル)から出力ファイルを外すので、ワークフローアセットを管理する
をポチっとします。
アセットに含めたくないので出力ファイルとして表示されているyxdbファイルのチェックボックスをOFFにして完了
ボタン。
アセットの設定が終わったら保存
ボタン押してServerにアップロード。
アップロード中・・・・
「保存しました」とでればワークフローのアップロードは完了です。
Server UI でワークフローがアップロードされたかを確認してみましょう
ちゃんとアップロードできたかな?Server UI 上で確認してみます。
「保存しました」と出てアップロードできていないってことはまずありませんが一応念のために確認しておきます。
アップロード完了ダイアログの真ん中あたりに「ブラウザで表示」というボタンがありますのでそれをポチっと。
Server UI の該当ワークフローの画面が表示されますのでワークフロー名やアップロード日時等確認してみてください。
「マイワークスペース」のリストからも確認できますので、こちらで確認してもらってもOKですよ。
少し細かく説明します
Server UI への接続
Server UI へ接続の部分についてですが、一度接続すると次からはそのServerが選べるようになります。My Company's Server
として接続先が保存され、下記の画像みたいに保存されている接続先を選択することで、次からはServer UI のURLを入力しなくて済みます。
登録されたServer情報を削除したい場合はEメール
、パスワード
を入力するダイアログのサーバー接続を削除
、から実施。
もしくはワークフロー保存ダイアログの歯車をクリックしてServerを削除
で行います。
時たまServer 接続情報を削除してから再接続を試してみて、ということがあったりするので覚えておいてもらえるといいかと思います。
アップロード時の設定
ワークフローを保存のダイアログで設定する項目等について細かくみていきましょう。
説明 | デフォルト値 | |
ワークフロー名 | Serverに保存されるワークフロー名
必要に応じてワークフロー名は変更が可 |
対象のワークフロー名
一度もワークフローを保存していない場合は「新しいワークフロー1」など |
場所 | ワークフロー保存先のStudioが表示されます | ログインしているユーザーが所属しているStudio |
ワーカータグ | ワークフローを実行するワーカーを指定するタグを選択することができる
ワーカータグを指定するにはユーザー毎にワーカータグ指定の権限を設定する必要がある(デフォルトでは権限無)
|
なし |
詳細 | コメントを記載します | - |
ワークフローオプション
ワークフローを検証後に保存する |
チェックONの場合はワークフローに禁止されたツールやコマンドが存在しないかチェックしてから保存します | ON |
ワークフローオプション
ワークフローアセットを管理する |
ワークフローのアセットに含める入出力ファイルやマクロなどを選択します | - |
ワークフローオプション
ワークフローのロックを有効にする |
ワークフローロックのオプションを利用する場合に使用します | - |
ワークフローアセットを管理するの画面については下記のような対象ファイルを選択する画面が表示されます。アセットに含めたいファイルにチェックをつけてください。
ツール別にアセットをグループ化する
にチェックをつけるとツール毎にグループ化され、マクロの中から呼出しているマクロは呼出元マクロでグループ化されます。
ワークフローのロックを有効にする
を選択するとワークフローロックのオプションを設定する画面が表示されます。
このワークフローのロックを有効にする
にチェックをつけるとワークフローロックの設定をすることが可能になります。
特定のシリアル番号
にはシリアル番号 (メールアドレス) を設定します。Serverでワークフローを実行する場合は既定のServer管理者(ServerのSystemSettingsで指定しているDefault Gallery Administrator)を指定しておきます。
また有効期限を設定することができます。有効期限が過ぎるとワークフローの実行、アクセスができなくなります。(Defaultは無期限)
右上の歯車では、Serverの削除
とServerからのログオフ
が実行できます。
またワークフローを保存のダイアログではワークフローの状態、サーバーの設定により下記のような設定もできる場合があります。
- このバージョンのワークフローを公開する(既に公開されているワークフローを更新する場合)
- ワークフローの資格情報を設定する(Window認証でかつServer側で管理者が資格情報を利用できるように設定している場合)
これらについては別途説明できる機会があれば触れてみたいと思います。
DesignerとServerのバージョンについて
Server - Designer間でのバージョンについては同じバージョンであれば問題はありませんが、Designerのほうが新しいバージョンだとダメです。そもそも接続できません。
またDesignerのバージョンが古い場合でも注意が必要です。Server のバージョンが2023.1以降の場合はDesignerのバージョンが2022.3 パッチ3 以降でないとDesignerからServerへワークフローのアップロードはできない、という制限があったりします。(2025年5月時点で2022.3以前のDesignerを使っているかたはほぼいないとは思いますけど)
今回利用したServerのバージョンは2024.2なのですが、2022.3.1.395(メジャーリリース)のDesignerでワークフローをアップロードしようとしてもダメです。Serverに接続できてもワークフローをアップロードする時にエラーになるんですよね。
このようにServer- Designer間でのバージョン互換に制約がありますので頭の片隅にいれておいてください。リリースノートでServerと互換性のあるDesignerのバージョンについての注意書きがでてきたら要チェックです。
現時点では、「Serverより新しいバージョンのDesignerはダメ」、「Designerのバージョンが2022.3 パッチ3以降かどうかで互換性があるかないかが変わる」という2点についてご注意を。
DesignerがServerより新しいバージョン | Designer 2022.3 パッチ2以前 |
Designer 2022.3 パッチ3以降(Serverより新しくない) |
|
Server 2023.1 以降 |
× | × | ○ |
Serverが2023.1より前の場合の表は割愛します。今でも2022.4を使ってる、、、ということも、もうあまり無いとは思いますので。
まとめ
今回はDesignerでServerにワークフローをアップロードする一連の流れについて説明してみました。
今回は触れなかったワークフローアップロード時の注意事項等あったりもしますがそれはまた別の機会にまとめようと思います。
つぎはワークフローの実行です。
※Alteryx Server 2024.2.1.94 Patch: 3 時点の情報です
運用、導入について弊社でご相談に乗ることが可能ですので、お気軽にお問い合わせください。