Richtlinien zur App-Erstellung

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.

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.

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.

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.

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.

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.“

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:<Report Type="summary">Age By Sex Summary Report</Report>

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.

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“.

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 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 .

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 .

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, 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