Skip to main content

Richtlinien zur App-Erstellung

Eine Alteryx-Analyse-App ist ein eigenständiges Programm, das eine spezifische Funktion für den Benutzer ausführt. Die Benutzeroberfläche muss einfach und die App auf ein konkretes Ziel ausgerichtet sein. Die App sollte eine begrenzte Anzahl von Aufgaben erfüllen und auf ein optimales Benutzererlebnis ausgerichtet sein. Benutzer führen die von Ihnen erstellten Apps in einem Webbrowser aus, daher muss das Backend-Design clever, elegant und effizient sein.

Most Recent Vintage Dataset

Wenn Sie eine App erstellen, die ein spezifisches Dataset verwendet, sollte das ausgewählte Dataset so eingestellt sein, dass es die aktuelle Vintage-Version (Most Recent Vintage Dataset) dafür verwendet. Dies bedeutet, dass Designer automatisch die aktuelle Version des Datasets verwendet, die auf dem Computer des Benutzers installiert ist. Dies gilt für die Demografische- Analyse- (Allocate), Verhalten-Analyse- (Solocast), die Calgary-, Fahrzeiten-, das Geocoder-Tool oder für die Referenzbasiskarten in Tools, die Karten erstellen. Um die Registerkarte anzuzeigen, gehen Sie zu Optionen  >  Benutzereinstellungen  > Benutzereinstellungen bearbeiten  > Dataset-Standardwerte .

Metainfo-Registerkarte

Informationen, die auf der  Metainfo -Registerkarte im Workflow-Konfigurationsfenster  ausgefüllt werden, erscheinen in den App-Details im Web.

  • Verwenden Sie Dateiname , um den Namen der Datei darzustellen.

  • Alternativ können Sie Benutzerdefiniert auswählen, um der App einen benutzerfreundlichen Anzeigenamen zu geben. Der Name einer App-Datei könnte beispielsweise „Wetterdaten_Download“ lauten und der benutzerdefinierte Name entsprechend ohne Unterstrich „Wetterdaten-Download“.

  • Beschreibung : Die hier eingegebene Beschreibung wird für die App auch im Web angezeigt. Daher sollten Sie sicherstellen, dass die Beschreibung akkurat und benutzerfreundlich ist.

  • URL : Im URL-Feld kann ein Link zu einer externen Webseite eingegeben werden.

  • Anzeigetext (optional) : Verwenden Sie dieses Feld, um den Anzeigetext für die URL anzugeben.

  • (Nur Makros) Tool-Einstellungen : Diese Einstellungen gelten nur für Makros. Weitere Informationen zum Makro-Repository finden Sie unter Makros in den Benutzereinstellungen . Diese Einstellungen ermöglichen Ihnen das Erstellen mehrerer Versionen eines Makros. Makros, die in einem Makro-Repository gespeichert wurden, werden in der Werkzeugpalette angezeigt.

    • Stamm-Tool-Name : Geben Sie einen Namen für das Tool ein. Sie können mehrere Tools mit demselben Stamm-Tool-Namen haben; es wird jedoch nur ein Tool in der Tool-Palette angezeigt.

    • Tool-Version : Geben Sie die Tool-Versionsnummer an. Die neueste Version eines Tools wird in der Werkzeugpalette angezeigt. Damit Sie ein Menü für den Zugriff auf ältere Versionen eines Makro-Tools einsehen können, müssen Sie das Tool auf den Canvas ziehen und mit der rechten Maustaste darauf klicken.

    • In-Datenbank-Tool? : Wählen Sie diese Option aus, wenn das Tool in einem Workflow zusammen mit In-DB-Tools verwendet werden kann.

  • (Nur Makros) Tool-Palette : Die Einstellungen gelten nur für Makro-Workflows. Weitere Informationen zum Makro-Repository finden Sie unter Makros in den Benutzereinstellungen . Diese Einstellungen steuern, wie Makros in der Werkzeugpalette angezeigt werden. Makros, die in einem Makro-Repository gespeichert wurden, werden in der Werkzeugpalette angezeigt.

    • Kategoriename : Geben Sie den Namen der Kategorie ein, unter der das Makro in der Tool-Palette angezeigt werden soll.

    • Such-Tags : Geben Sie die Begriffe ein, die ein Benutzer zur Suche nach dem Makro verwenden kann. Standardmäßig werden der Dateiname, der benutzerdefinierte Name, der Name des Autors und der Firmenname als Suchbegriffe verwendet.

  • Ersteller – Gibt Detailinformationen zum Ersteller der Analyse-App an.

    • Name : Geben Sie den Namen des Workflow-Autors ein.

    • Unternehmen : Geben Sie das Unternehmen ein, dem der Autor angehört.

    • Copyright : Geben Sie Copyright-Informationen ein.

  • Als Standard festlegen : Wählen Sie dies, um Ihre Arbeit rückgängig zu machen und den Standardtext zu verwenden.

  • Als Standard speichern : Speichern Sie den eingegebenen Text als Standard.

YXWZ-Erweiterung

Stellen Sie bei der Erstellung einer App sicher, dass Sie die Datei als YXWZ-Datei gespeichert haben, auch wenn Sie den Workflow-Typ in Analyse-App geändert haben. Wenn Sie die YXMD-Dateierweiterung beibehalten, wird die Datei als Workflow und nicht als App geöffnet.

In Version 9.0 erstellte Apps können nicht mehr als YXMD-Dateien gespeichert werden.

Karteneingabe

Mit der Karteneingabefunktion im  Karteneingabe-Tool können App-Benutzer einen Standort auswählen oder ein Polygon oder eine Linie zeichnen. Kartenfragen sollten kurz, aber aussagekräftig sein, und es sollte immer eine Basiskarte verwendet werden. Bei der Auswahl einer Basiskarte sollten Sie immer die aktuelle Vintage-Version auswählen.

Und schließlich sollten Sie die Option Benutzer kann Eigenschaften kennzeichnen immer aktiviert haben, wenn der Zeichnen -Modus ausgewählt ist. Dadurch haben Benutzer die Möglichkeit, jedem ihrer benutzerdefinierten Polygone einen Namen hinzuzufügen.

Berichtausgabe

Wenn Sie eine App in der Galerie speichern und die Ausgabe des Berichts als PCXML angezeigt wird, bietet die Anwendung den Endbenutzern die Möglichkeit, nicht nur eine Vorschau des Berichts im Web anzuzeigen, sondern den Bericht auch in einem unserer unterstützten Berichtsformate herunterzuladen. Zu den unterstützten Berichtsformaten gehören: PDF, Microsoft Word, Microsoft Excel und HTML.

Wenn Sie eine App erstellen, kann die Ausgabe in jedem unserer unterstützten Berichtsformate erfolgen. Um PCXML zu verwenden, stellen Sie den Ausgabemodus im Anzeigen-Tool auf Spezifische Ausgabedatei wählen ein und verwenden Sie als Ausgabedatei APP_NAME.pcxml .

Wenn Sie einen Bericht in PCXML in der Vorschau anzeigen, werden keine Fußzeilen angezeigt, aber sie sind verfügbar, wenn der Bericht als PDF-, Word- oder Excel-Dokument heruntergeladen wird.

Dateien lesen/schreiben: Makros in einer App

Bei Web-Apps können Sie nur Dateien lesen und schreiben, die sich im selben Ordner wie Ihre App oder in einem untergeordneten Ordner befinden, d. h. in jedem Ordner, der sich innerhalb des Ordners befindet, der die App enthält (sie können auch mehr als eine Ebene tiefer liegen). Diese Regel gilt auch für Makros, die Sie für Ihre App verwenden möchten, sofern es sich nicht um ein Standard-Makro handelt, das im Umfang des Installationsprogramms für Alteryx-Produkte oder eines Daten-Installers enthalten ist.

%temp%

Verwenden Sie zum Schreiben in das Temp-Verzeichnis nicht den Ausdruck %temp% , wenn Sie Workflows oder Apps erstellen, die in Server gespeichert werden sollen. Behalten Sie alle Dateipfade im Workflow. Verwenden Sie bei der Entwicklung einer verketteten App nur den Dateinamen statt einen Dateipfad (z. B. .\fileOutput.yxdb und nicht %temp%\fileOutput.yxdb oder etwas Ähnliches. Wählen Sie eine Datei aus, indem Sie zu ihr navigieren und anschließend im Fenster Workflow-Abhängigkeiten den Dateiabhängigkeitspfad in einen relativen Pfad ändern.

Nicht zulässige Tools und Ereignisse

Diese Alteryx Designer-Tools und -Ereignisse sind wegen der Vielzahl der möglichen Konfigurationen und Aktionen in der Community Gallery, auch als Analytics Gallery bekannt, nicht zulässig:

Wenn Ihr Workflow auf sichere Weise eines der verbotenen Tools oder Ereignisse verwendet, können Sie eine Ausnahme beantragen, um den Workflow in der Gallery auszuführen. So beantragen Sie eine Ausnahme:

  1. Senden Sie eine E-Mail an curator@alteryx.com, erläutern Sie, wie und warum die einzigen unzulässigen Tools verwendet werden, und beschreiben Sie den allgemeinen Zweck des Workflows.

  2. Veröffentlichen Sie den Workflow in Ihrem Private Studio, und aktivieren Sie die Option Andere dürfen diesen Workflow herunterladen.

  3. Fügen Sie den Workflow zu einer Sammlung hinzu und geben Sie diese für den Alteryx-Kurator curator@alteryx.com frei.

  4. Die Prüfung Ihres Workflows kann bis zu zwei Arbeitstage in Anspruch nehmen. Ein Alteryx-Administrator teilt Ihnen dann den Status Ihres Antrags per E-Mail mit.

Die in Designer enthaltenen Prognose-Makros, die das R-Tool verwenden, sind in der Community Gallery zulässig.

Nicht unterstützte App-Funktionen für Web

Diese Tools sind in der Analytics Gallery-Webumgebung nicht unterstützt.

  • Ordnerauswahl

  • Datei durchsuchen (Speichern unter), der Upload funktioniert im Web problemlos.

  • Wenn eine App Fehler in der Desktop-Umgebung auslöst, können Sie diese nicht auf Server speichern.

  • App-Ketten, die länger als sieben Apps sind, funktionieren nicht auf Server.

Bewährte Praktiken für die Erstellung von Apps

Aktionen aktualisieren

Wenn Sie das Aktion-Tool für „Wert aktualisieren/ändern“ verwenden, sollten Sie die Option Spezifische Zeichenfolge ersetzen nicht verwenden, es sei denn, Sie brauchen sie wirklich. Wenn Sie die Tool-Konfiguration in Ihrem Workflow aufgrund der Weiterentwicklung ändern, könnten Sie dieses Aktion-Tool beschädigen, weil die spezifische Zeichenfolge vielleicht nicht mehr existiert. Natürlich kann es vorkommen, dass Sie diese Option verwenden müssen, aber bedenken Sie, dass Sie bei einer Änderung der Zeichenfolge im Tool möglicherweise auch das Aktion-Tool aktualisieren müssen.

Prozess-Umleitungen aktualisieren

Wenn Sie ein Aktion-Tool zur Aktualisierung eines Prozess-umleiten-Tools verwenden, versuchen Sie, die Umleitung für beide Möglichkeiten, d. h. Umleitung links und Umleitung rechts, fertigzustellen und zu aktualisieren. Wenn Sie nur die eine Bedingung aktualisieren und den Workflow bei der Entwicklung ändern, dann haben Sie nicht berücksichtigt, dass es erforderlich sein könnte, dass der Workflow möglicherweise auch in die andere Richtung geht.

Prozess-Umleitungen beenden

Alle Umleitungen müssen enden, insbesondere bevor Sie Datenströme von einer Umleitung mit einer anderen Stelle im Workflow verknüpfen. Ein Prozess-umleiten-Ende-Tool muss nicht konfiguriert werden und ist daher leicht zu verwenden. Verwenden Sie sie entsprechend oder beenden Sie die Umleitung mit einem Ausgabe-Tool.

Fehlermeldung-Tool verwenden

Wenn Sie Fragen schreiben, denken Sie an Ihre Benutzer, indem Sie häufige Fehler im Voraus bedenken. Sie sollten Fehlermeldungen mit einem Fehlermeldung-Tool  ausgeben. Wenn der Benutzer beispielsweise eine Option auswählen muss und dann eine Fehlermeldung erhält, wenn keine Auswahl getroffen wurde, kann dies verhindern, dass die Engine Fehler ausgibt, die für den Benutzer möglicherweise nicht aussagekräftig genug sind, um zu verstehen, wie der Fehler behoben werden kann. Idealerweise sollten Sie bei jeder Frage, die der Benutzer ausfüllen muss, einen Fehler ausgeben. Sie können auch komplexere Bedingungen einbeziehen, um sicherzugehen, dass Benutzer alles korrekt ausfüllen. Wenn Benutzer beispielsweise ein Textfeld mit bis zu fünf Handelsbereichen durch Komma getrennt ausfüllen müssen (z. B. 1, 2, 3, 4, 5), dann sollten Sie eine Regex-Bedingung verwenden, um sicherzustellen, dass in das Textfeld nicht mehr als vier Kommas eingetragen werden.

Fehler mit dem Meldungen-Tool ausgeben

Versuchen Sie in diesem Sinne, Fälle abzusehen, in denen die App selbst bei ordnungsgemäßer Konfiguration fehlschlagen könnte. Beispielsweise kann der Benutzer eine Adresse eingeben, die nicht geokodiert werden kann und keine Ergebnisse anzeigt. Sie können Meldungen in Ihrer App einfach handhaben, indem Sie fehlerhafte Geocodes filtern und dann das Meldung-Tool verwenden, um dem Benutzer eine Meldung zu senden: „Die von Ihnen angegebene Adresse konnte nicht geokodiert werden. Prüfen Sie, ob die Adresse gültig ist, und nehmen Sie die entsprechenden Änderungen vor, oder geben Sie eine andere Adresse ein und führen Sie die Anwendung erneut aus.“

Aktualisieren von unformatierten XML-Dateien, Ersetzen von HTML-Platzhalterzeichen durch die Escape-Version

Wenn Sie unformatierte XML-Dateien für ein Tool aktualisieren oder in Ihrer App Sonderzeichen verwenden, dann sollten Sie daran denken, dass es im Web ggf. nicht wie erwartet funktioniert. Beispiel: Eine Auswahl in einem Dropdown-Tool oder Auswahllisten-Tool in der Engine könnte etwa folgenden Text enthalten: Age By Sex Summary Report:<Report Type="summary">Age By Sex Summary Report</Report> (Zusammenfassender Bericht zum Alter nach Geschlecht)

Wird dies im Web verwendet, dann wird die Frage nicht richtig angezeigt und daher wahrscheinlich bei Verwendung in einer Aktion nicht den gewünschten Effekt haben. A Eine Lösung wäre, den Text wie folgt zu ändern:  Age By Sex Summary Report:&lt;Report Type=&quot;summary&quot;&gt;Age By Sex Summary Report&lt;/Report&gt;

Wenn Sie dann die Antwort auf die Frage in einer Aktion verwenden, müssen Sie sie folgendermaßen ändern: EscapeXMLMetacharacters([AllocateSummaryReport])

Die Funktion „Ersetzen von XML-Platzhalterzeichen durch die Escape-Version“ wurde in der Formelbibliothek in Version 8.0 geändert. Sie können von der Kategorie „Spezialisiert“ aus darauf zugreifen. Diese Funktion ersetzt alle XML-Platzhalterzeichen durch ihre Escape-Version.

Allocate-Variablenbäume

Das Web und die Engine geben verschiedene Werte zurück, wenn ein Allocate-Variablenbaum leer bleibt. Wenn die App einen Allocate-Variablenbaum als Fragetyp hat, dann könnten Sie eine Bedingung schreiben, durch die überprüft wird, ob der Benutzer etwas ausgewählt oder dieses Feld leer gelassen hat. Für die Engine könnten Sie etwas schreiben wie:

[AllocateVariables] == "<Variables />"

Denn wenn im Variablenbaum nichts ausgewählt wurde, wird <Variables />> zurückgegeben. Im Web würde der zurückgegebene Wert jedoch nichts bedeuten, daher müsste die Bedingung wie folgt lauten:

isempty([AllocateVariables])

Wir möchten natürlich, dass die Apps sowohl im Web als auch am Desktop funktionieren, daher muss die Bedingung wie folgt lauten:

[AllocateVariables] == "<Variables />" or isempty([AllocateVariables])

Bei Bedenken, die Zeichen <, > und / im Web zu verwenden, könnten wir die Bedingung entsprechend ändern in:

REGEX_CountMatches([AllocateVariables], "Variables") == 1 or isempty([AllocateVariables])

Zusammenführung-Tool

Es ist am besten, ein manuell konfiguriertes Zusammenführung-Tool bei Apps zu vermeiden, da sich dabei in den meisten Fällen der Workflow bei der Ausführung ändert. Statt das Zusammenführung-Tool im manuellen Modus zu konfigurieren, sollten Daten-auswählen-Tools in jede Verbindung eingefügt werden, die in das Zusammenführung-Tool eingebracht wird. Beim Konfigurieren des Datenfelder-auswählen-Tools müssen Sie Felder wie erforderlich umbenennen und neu ordnen und genauestens darauf achten, dass KEINE dynamischen/unbekannten Felder enthalten sind. Konfigurieren Sie das Zusammenführung-Tool entweder mit „Automatisch nach Name konfigurieren“ oder „Automatisch nach Position konfigurieren“.

Tool-Behälter und App-Strukturierung

Apps werden teilweise durch die Verwendung verschiedener Tool-Behälter für verschiedene Abschnitte der App strukturiert. Beispiel: Alle Berichterstellung-Tools sind in der Regel der letzte Abschnitt einer App und können in einem Tool-Behälter mit der Bezeichnung „Reporting“ (Berichterstellung) platziert werden.

Ein Tool-Behälter-Tool kann farbkodiert werden, basierend auf der Funktion, die dadurch hervorgehoben wird. Wenn Tool-Container farbkodiert sind, ist die Funktion einer App leichter zu verstehen, insbesondere wenn die Anzeige nicht vergrößert ist. Dies ist hilfreich bei der Fehlerbehandlung oder Fehlerbehebung einer App, die jemand anders erstellt hat.

Schnittstellen-Tools sollten in eigene Behälter platziert werden und als solche farbkodiert werden. Für Apps mit mehreren Registerkarten ist es hilfreich, die Tools, die jeweils eine Registerkarte ausmachen, in eigene Behälter zu platzieren.

Anmerkungen für Workflows und Apps

Anmerkungen sind Textfelder, die einem spezifischen Tool beigefügt werden. Sie können sehr nützlich sein bei der Beschreibung der Rolle einzelner Tools. Ein entscheidender Vorteil besteht darin, dass die Anmerkung mit verschoben wird, wenn das Tool verschoben wird. Legen Sie in der Workflow-Konfiguration die Anmerkungen  fest, die Sie anzeigen möchten.

Falls erforderlich können Sie einzelne Anmerkungen auch so festlegen, dass sie in einem Tool entweder oben oder unten platziert werden. Um die Anmerkung zu ändern, klicken Sie auf das Tool, wählen Sie die Registerkarte Anmerkung aus und aktivieren oder deaktivieren Sie Anmerkung oben platzieren .

Makrospezifische Richtlinien

Alle oben genannten Richtlinien gelten sowohl für Makros als auch für Apps. Eine Ausnahme sind die folgenden Richtlinien, die sich nur auf Makros beziehen.

Makroeingaben

Ein Makroeingabe-Tool sollte Daten enthalten. Wenn Daten enthalten sind, ist es viel einfacher, Fehler zu behandeln oder zu beheben, wenn etwas schief läuft. Im Makroeingabe-Tool ist eine Texteingabe eingebettet. Dies ist die bevorzugte Methode für Makroeingaben. Wenn Sie eine größere Datei für die Dateneingabe benötigen, dann sollte diese möglichst im Makro enthalten sein. Datendateiabhängigkeiten für ein Makro sollten gemäß diesem Muster benannt werden:

NameOfMacro.NameOfDataFile.yxdb

Mit Eingabe- und Ausgabenamen sollten keine Tool-Nummern verbunden sein. Vergewissern Sie sich, dass der Name auf der Registerkarte „Makroeingabeeigenschaften“ so aussagekräftig wie möglich ist. Der hier angegebene Name ist für die Benutzer sichtbar, wenn sie das Makro-Tool konfigurieren.

Wenn mehrere Eingaben und Ausgaben vorhanden sind, hilft das Hinzufügen einer Konnektor-Abkürzung dem Benutzer dabei, das Tool zu konfigurieren. Dadurch wird auf dem Tool-Anker eine Beschriftung angezeigt, wenn das Tool auf dem Canvas platziert wird. Weitere Informationen finden Sie unter Makroeingabe-Tool oder Makroausgabe-Tool .

Registerkarten benennen

Die Namen der Registerkarten sollten aussagekräftig sein, damit der Benutzer das Makro-Tool einfach konfigurieren kann. Die Registerkarten sind zum Zeitpunkt der Konfiguration für den Benutzer sichtbar. Der Standardname für Registerkarten lautet „Fragen“, was kein sehr aussagekräftiger Name ist, und dies ist in der Regel ein Versehen bei der Entwicklung eines Makros (oder einer Anwendung) mit einer einzigen Registerkarte. Siehe Fenster Schnittstellen-Designer .

Unterstützende Makros

Unterstützende Makros, die in einem übergeordneten Workflow verwendet werden, sollten mit dem übergeordneten Makro oder in einem unterstützenden Verzeichnis verfügbar sein und als solches bezeichnet werden: NameOfParent.NameOfSupporting.yxmc