App構築ガイドライン

Version:
Current
Last modified: June 02, 2020

Alteryx 分析アプリは、ユーザーに対して特定の機能を実行する自己完結型のプログラムです。インターフェイスはシンプルで、単一の目標を念頭に置いて設計されたアプリでなければなりません。アプリは、最適なユーザー エクスペリエンスに重点を置いた限られた範囲のタスクを実行する必要があります。ユーザーが Web ブラウザーで構築するアプリを実行していることを考慮すると、バックエンド設計は巧妙でエレガントで効率的である必要があります。

最新のヴィンテージデータセット

特定のデータセットを使用するアプリをオーサリングする場合、選択したデータセットは、最新のヴィンテージバージョンのデータセットを使用するように設定する必要があります。つまり、Designer はユーザーのコンピュータにインストールされているデータセットの最新バージョンを自動的に使用します。これは、人口統計解析ツール(Allocate)、行動解析ツール(Solocast)、カルガリーツール、Drivetimes、ジオコーダー、またはマッピングツールの参照ベースマップに適用されます。データセットを設定するには、[オプション] > [ユーザー設定] > [ユーザー設定の編集] > [データセットの既定値]の順に移動します。

[メタ情報]タブ

-ERR:REF-NOT-FOUND-ワークフロー構成ウィンドウの[メタ情報]タブに入力された情報は、Web 上のアプリの詳細に表示されます。

  • ファイル名を使用して、ファイルの名前を表示します。または、[カスタム:] を選択して、アプリに 「フレンドリー」な名前を付けます。たとえば、アプリファイル自体が Download_Weather_Data と呼ばれることがありますし、カスタム名は同じになりますが、アンダースコア、ダウンロードの天気データなし。
  • 説明: ここに入力された説明は、アプリの web 上に表示される説明になりますので、それが正確な説明であり、ユーザーフレンドリーであることを確認してください。
  • URL: URL フィールドは、外部 Web サイトへのリンクを含める機能を提供します。
  • 著者: 名前、ヴィンテージ (YYYY を含む分析アプリケーションの作成者の詳細を提供します。Qtr)、会社、および著作権。

拡張子 yxwz

アプリを作成するときに、ワークフローの種類を分析アプリに変更した場合でも、ファイルを yxwz ファイルとして保存していることを確認します。ファイル拡張子が yxmd として残っている場合は、アプリとしてではなくワークフローとして開きます。

バージョン9.0 で作成されたアプリは、yxmd ファイルとして保存できなくなりました。

マップ入力

-ERR:REF-NOT-FOUND-マップ入力ツールを使用すると、アプリコンシューマーは、マップ入力機能を使用して場所を選択したり、ポリゴンまたはラインを描画したりできます。 マップの質問は短いけれども説明的にする必要があり、ベースマップを常に使用する必要があります。 ベース マップを選択するときは、[最新のビンテージ]を選択していることを確認します。

最後に、[描画モード] を選択した場合は、[ユーザーがラベルフィーチャにラベルを付けることができる]設定が常にオンになっていることを確認します。 これにより、各カスタムポリゴンに名前を追加するオプションをユーザーに提供します。

レポート出力

アプリをギャラリーに保存すると、レポートの出力が PCXML として表示される場合、エンドユーザーは Web 上でレポートをプレビューするだけでなく、サポートされているレポート形式でレポートをダウンロードすることもできます。 サポートされているレポート形式には、PDF、Microsoft Word、Microsoft Excel、およびHTMLなどがあります。 

アプリを作成する際、出力はサポートされているレポート形式のいずれかになります。 PCXML を使用するには、レンダリング ツール[出力モード] を[特定の出力ファイルを選択] に設定し、[出力ファイル] に対しては APP_NAME.pcxmlを使用します。

PCXML でレポートをプレビューすると、フッターは表示されませんが、PDF、Word、または Excel ドキュメントとしてダウンロードすると、フッターは使用できます。

ファイルの読み取り/書き込み: アプリ内のマクロ

Web アプリの場合、アプリまたは下位フォルダーと同じフォルダー内にあるファイル (アプリを含むフォルダー内にあるフォルダー) の読み取りと書き込みのみが可能です。(1 レベル以上下がることができます。このルールは、Alteryx 製品インストーラーまたはデータインストーラーの一部である標準マクロでない限り、アプリで使用するマクロにも適用されます。

%temp%

ギャラリーに保存するワークフローまたはアプリをビルドするときに%temp、%を使用して一時ディレクトリに書き込みないでください。すべてのファイルパスをワークフロー内に保持します。連鎖アプリを開発する場合は、ファイル パス%tempではなくファイル名のみを使用します。 それを閲覧してファイルを選択し、次に[ワークフローの依存関係]ウィンドウを使用して、ファイル依存パスを相対パスに変更します。

禁止されているツールとイベント

さまざまな構成と実行できるアクションにより、Alteryx パブリック ギャラリー (gallery.alteryx.com) では、次の Alteryx Designer のツールとイベントは、分析ギャラリー (別名) で禁止されています。

ワークフローで禁止されているツールまたはイベントのいずれかを安全に使用する場合は、Alteryx Analytics ギャラリーでワークフローを実行するための免除を申請できます。免除を申請する.

  1. 電子メール-ERR:REF-NOT-FOUND-@alteryxキュレーター .comとワークフローの一般的な目的と共に、各禁止ツールを使用する方法と理由を説明します。
  2. プライベート スタジオでワークフローを公開し、このワークフローをダウンロードするオプションを確認します。
  3. ワークフローをコレクションに追加し、-ERR:REF-NOT-FOUND-キュレーター.com@alteryxのAlteryxキュレーターと共有します。
  4. あなたのワークフローを見直すために最長2営業日、Alterxの管理人がリクエストのステータスをEメールで送付します。

R ツールを使用する Designer に含まれる予測マクロ-ERR:REF-NOT-FOUND-は、Alteryx パブリック ギャラリーで許可されます。

Web でサポートされていないアプリの機能

これらは、分析ギャラリー Web 環境ではサポートされていません。

  • フォルダ閲覧
  • ファイルの参照 (名前を付けて保存) は、アップロードは、Web 上で正常に動作します。
  • アプリがDesktop環境でエラーをスローした場合、それをギャラリーに保存することはできません。

アプリを構築するためのベストプラクティス

更新アクション

アクションツールを使用して値を更新/変更する場合は、実際に必要でない限り、「特定の文字列を置き換える:」オプションを使用しないでください。継続的な開発のため、ワークフローのツール構成を変更すると、その特定の文字列が存在しなくなる可能性があるため、そのアクションツールを破損させることがあります。明らかに、そのオプションを使用する必要があるときに、ツールでその文字列を変更すると、アクションツールも更新する必要があることに注意してください。

回り道の更新

[アクション] ツールを使用して迂回ツールを更新する場合は、両方の可能性 (左に迂回し、右に迂回する) の両方について、迂回を完了して更新します。それ以外の場合は、1 つの条件を更新し、開発中にワークフローを変更した場合、ワークフローが必要な時期を考慮していません。

エンド回り道

特に、分岐からワークフロー内の他の場所にデータストリームを結合する前に、すべての分岐を終了させる必要があります。-ERR:REF-NOT-FOUND-迂回終了ツールは構成を必要としないため、使いやすいです。必ず、出力ツールを使用して、それらを使用するか、迂回を終了します。

エラー メッセージ ツールを使用する

質問を書くときは、よくある間違いを予測して、ユーザーを考慮してください。エラー メッセージ ツール を使用してエラー メッセージを発行する必要があります。たとえば、ユーザーがオプションを選択し、何も選択しないときにエラーをスローする必要がある場合、これは、ユーザーがエラーを修正する方法を理解するのに十分な意味がない可能性があるエンジンスローエラーを回避できます。理想的には、ユーザーが記入する必要があるすべての質問についてスローエラーがあるようにします。また、より複雑な条件を実行して、彼らが正しく記入したことを確認することもできます。例えば、最大5つのトレードエリアをカンマで区切ってテキストボックスに記入する必要がある場合(例:1, 2, 3, 4, 5)、正規表現の条件を使用して、テキストボックスに4つを超えるカンマがないことを確認します。

メッセージ ツールでエラーを発生する

これらの同じ行に沿って、適切に構成されていてもアプリが失敗する可能性のあるケースを予測してください。例えば、ユーザーは、ジオコーディングに失敗して結果をレンダリングしないアドレスに入力する場合があります。不正なジオコードをフィルタリングしてアプリ内のメッセージングを簡単に処理し、メッセージ-ERR:REF-NOT-FOUND-ツールを使用してユーザーにメッセージを返すことができます。アドレスが有効であることを確認し、それに適切な変更を加えるか、別のアドレスを入力して再実行してください。"

生の XML を更新し、HTML メタ文字をエスケープする

ツールの生の XML を更新する場合や、アプリで特殊文字を使用している場合は、Web 上でこれが期待どおりに機能しない場合があることを念頭に置いてください。たとえば、エンジンのドロップダウン ツールまたはリスト ボックス ツールの選択には、次のようなテキストが含まれている可能性があります:年齢性別サマリー レポート:年齢ごとの性別サマリー レポート

しかし、これがウェブ上で使用されている際は、実際に質問を正しく表示することはできません。従って、これがアクションで使用された場合は、おそらく望ましい効果は得られません。解決策は、テキストを変更することです:年齢別性別サマリーレポート:<レポートタイプ="概要">年齢別セックスサマリーレポート</レポート>

次に、アクションで質問応答を使用している場合は、EscapeXMLMeta文字([アファリケートサマリーレポート])に更新する必要があります。

Escape XML Metacharacters関数がバージョン8.0の式ライブラリに追加されました。Specializedカテゴリからアクセスできます。この関数は、すべてのXMLメタキャラクタをエスケープされたバージョンに置き換えます。

変数ツリーを割り当てる

Allocate変数ツリーを空のままにすると、ウェブとエンジンは異なる値を返します。アプリに質問タイプとして変数ツリーの割り当てがある場合は、ユーザーが何かを選択したか、空のままにしたかどうかを確認する条件を記述できます。エンジンについては次のように書き込むことができます:

[割り当て変数]== " "

変数ツリーに何も選択されていない場合  は、返されます。ただし、Web 上では、返される値は実際には何もないので、次の条件が必要になります。

isempty([割り当て変数])

当然のことながら、アプリはウェブとデスクトップの両方で動作するため、条件は実際には次のようになる必要があります:

[割り当て変数]== " " または空 ([割り当て変数])

また、および / 文字を Web 上で使用する方法についても心配している場合は、条件を次のように変更できます。, >

REGEX_CountMatches([割り当て変数]、"変数") == 1 または空 ([割り当て変数])

ユニオンツール

ほとんどの場合、ワークフローは実行時に変更されるため、手動で-ERR:REF-NOT-FOUND-Union ツールを任意のアプリから除外しておくことをお考えください。ユニオンツールを手動モードで構成するのではなく、ユニオンツールに入る各接続に選択ツールを挿入します。Select ツールを設定するときは、フィールドの名前を変更し、必要に応じて、動的/未知のフィールドを含まないように適切な注意をします。名前による自動構成または位置による自動構成のいずれかを使用して、ユニオンツールを構成します。

ツールコンテナとアプリの構成

アプリの組織は、アプリのさまざまなセクションに異なるツールコンテナーを使用して一部で行われます。たとえば、すべてのレポートツールは、通常、アプリの最後のセクションであり、"レポート" というラベルの付いたツールコンテナに配置できます。

 ツール コンテナー ツールは、強調表示されている機能に基づいて色分けできます。色分けツールコンテナを使用すると、特に小さなズームで見た際に、アプリが何をしているのかを簡単に理解することができます。これは、他のユーザーが作成したアプリのトラブルシューティングやデバッグに役立ちます。

インターフェイス ツールは、独自のコンテナーに配置し、色分けされるようにする必要があります。マルチタブ アプリの場合は、各タブを構成するツールを独自のコンテナーに配置すると便利です。

ワークフローとアプリの注釈

注釈は、特定のツールに添付されたテキスト ボックスであり、個々のツールの役割を説明するのに非常に役立ちます。 主な利点の1つは、ツールを移動すると注釈も一緒に移動することです。  -ERR:REF-NOT-FOUND-ワークフロー構成で、表示するアニテーションを設定します。 

必要に応じて、個々の注釈をツールの上部または下部に配置するように設定することもできます。  -ERR:REF-NOT-FOUND-[アニテーション]を変更するには、ツールをクリックし、[アニテーション]タブを選択し、[上にアニテーションを配置] を選択または選択解除します。

マクロ固有のガイドライン

すべての以前のガイドラインは、アプリと同じくマクロにも適用されますが、次の例外はマクロにのみ適用されます。

マクロ入力

-ERR:REF-NOT-FOUND-マクロ入力ツールにはデータを含める必要があります。データが含まれていると、問題が発生した場合にトラブルシューティングやデバッグが非常に簡単になります。マクロ入力ツールにはテキスト入力が組み込まれています。これは、マクロ入力に適した方法です。  データ入力として機能するために大きなファイルが必要な場合は、可能であればマクロに含める必要があります。マクロのデータファイルの依存関係は、パターンに従って命名する必要があります。

名前を指定します。

入力名と出力名には、それらに関連付けられたツール番号を使用しないでください。[マクロ入力プロパティ]タブで、名前が十分説明的であることを確認します。ここで指定された名前は、マクロツールの構成時にユーザーに表示されます。

複数の入力と出力がある場合、コネクタの省略形を追加すると、ツールがキャンバスに配置されたときにツール アンカーにラベルを付けてツールを構成するのに役立ちます。「-ERR:REF-NOT-FOUND-マクロ入力ツール」または「-ERR:REF-NOT-FOUND-マクロ出力ツール」を参照してください。

ネーミングタブ

ユーザーがマクロツールを構成している間は、タブ名は使いやすいように記述的にする必要があります。構成時にタブがユーザーに表示されます。デフォルトのタブ名は "質問" です。これは記述的な名前ではなく、通常は単一のタブでマクロ(またはアプリ)を開発する際の見落としです。「-ERR:REF-NOT-FOUND-インターフェイス デザイナ ウィンドウ」を参照してください。

サポートマクロ

親ワークフローで使用されるマクロのサポートは、親マクロまたはサポートディレクトリに存在し、NameOfParent.NameOf

Was This Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support.