Aktionen

Der Interact Web-API-Dienst bietet mehrere Aktionen. Aufgerufen werden sie mit dem Blue Prism Objekt (Hilfsprogramm – Interact API). Die folgenden Abschnitte beschreiben, wie Sie die unterschiedlichen Aktionen in Ihren Automatisierungen verwenden können.

Alle Web-API-Dienst-Aktionen sollten über das visuelle Geschäftsobjekt „Hilfsprogramm – Interact API“ in Blue Prism aufgerufen werden und nicht direkt über den Webdienst.

Einsendung abrufen

Die Aktion „Einsendung abrufen“ ist der Aktion „Nächstes Element abrufen“ sehr ähnlich, wenn es darum geht, Informationen aus einer Warteschlange abzurufen.

Um die Aktion zu nutzen, wird eine Aktion zu Ihrem Prozess und dem ausgewählten Geschäftsobjekt hinzugefügt. Die Aktion wird auf Einsendung abrufen eingestellt. Es gibt nur einen Eingabeparameter, und zwar die Einsende-ID (siehe unten).

Der Ausgabeparameter ruft den Inhalt des Interact Formulars unter Verwendung der Einsende-ID in einer Sammlung ab.

Wenn Sie eine Einsendung mit dieser Methodik abrufen, ist die Formatierung der Datumselemente anders als bei der Standardaktion „Nächstes Element abrufen“. Bei „Nächstes Element abrufen“ wird das Datum im Textformat angezeigt. Bei „Einsendung abrufen“ wird es im DateTime-Format angezeigt (siehe unten).

Eine vollständige Liste der Einschränkungen finden Sie unter Interact Web-API-Dienst-Objekteinschränkungen.

Sie können die Aktion „Einsendung abrufen“ nur dann verwenden, wenn Sie die Einsende-ID kennen, da diese je nach Einsendung einzigartig ist und nicht in Ihre Automatisierung hartkodiert werden kann. In diesem Fall ist ein Abruf über die Aktion „Nächstes Element abrufen“ erforderlich.

Formularschema abrufen

Mit der Aktion „Formularschema abrufen“ erhalten Sie die Struktur eines Interact Formulars in einer Sammlung, die Sie bearbeiten und dann mit der Aktion „Einsendung erstellen“ ein leeres oder teilweise erstelltes Interact Formular erstellen können, das ein Benutzer ausfüllen und abschicken kann.

Es gibt nur einen Eingabeparameter, und zwar den Namen des Formulars in Interact, für das Sie die Struktur abrufen (siehe unten).

Die Ausgabeparameter ähneln der Aktion „Einsendung abrufen“, bei der der Anfragenstatus zusammen mit einer Sammlung zurückgegeben wird, die die Felder enthält.

Die abgerufene Sammlung ist eine leere Sammlung, die die Struktur des Formulars enthält.

Die Struktur der gezeigten Felder ist in einem ähnlichen Format wie das Format „Nächstes Element abrufen“ und daher fordert das Element „Datum“ die Übermittlung eines Textdatentyps an. Der Grund dafür, dass der Texttyp verwendet wird, ist die Unterstützung der Elementtypen „Datum“ im Mehrfachformat innerhalb von Interact, wobei das Datum im britischen, US-amerikanischen oder internationalen Format bereitgestellt werden kann.

Der Unterschied zwischen den Formaten „Nächstes Element abrufen“ und „Formularschema abrufen“ ist das Feld zum Hochladen des Elements. Die Aktion „Nächstes Element abrufen“ gibt einen Link zum Speicherort der Datei zurück. Die Aktion „Formularschema abrufen“ gibt eine Sammlung zurück, die nicht nur einen Link, sondern Details der hochgeladenen Datei enthält. Dies ist auch erforderlich, wenn Sie die Aktion „Datei hochladen“ verwenden.

Das Format der Sammlung, die die Details der hochgeladenen Datei enthält, muss korrekt eingestellt werden, wie oben dargestellt:

  • Name – Der Name der Datei einschließlich der Dateierweiterung.
  • Größe – Die Größe der Datei in Bytes.
  • Erweiterung – Die Dateierweiterung ohne vorangestellten Punkt.
  • Link – Der Link zur hochgeladenen Datei.
  • Typ – Der Typ der Datei, zum Beispiel „Anwendung/pdf“ oder „Bild/png“.

Benutzer nach Formularname abrufen

Mit „Benutzer nach Formularname abrufen“ können Sie eine Liste von Benutzern, die mit einem bestimmten Formularnamen verknüpft sind, abrufen.

Die Eingabe für die Aktion ist der Formularname, wie unten dargestellt.

Die Ausgabe ist eine Sammlung, die die mit diesem Formularnamen verknüpften Benutzer auflistet.

Einsendung erstellen

Es gibt vier Parameter, die für die Aktion „Einsendung erstellen“ definiert werden müssen.

Das sind die folgenden vier Parameter:

  • Benutzername – Dies ist der Benutzername des Interact Benutzers, für den die Einsendung erstellt wird.
  • Passwort – Das Passwort für diesen Interact Benutzer.
  • Formularname – Das Formular, das in Interact erstellt wird.
  • Felder – Die Werte, die innerhalb der erstellten Einsendung festgelegt werden.

Zur Unterstützung bei der Erstellung einer neuen Einsendung kann Formularschema abrufen verwendet werden, um die grundlegende Struktur des Formulars abzurufen. Dieses kann dann mit neuen Datenelementen befüllt und dann als neue Einsendung für einen Benutzer erstellt werden.

Um eine Einsendung zu erstellen, müssen die Felder und das Formularschema mit dem des Formulars in Interact übereinstimmen. Fehlende Felder oder eine falsche Struktur führen zu einer fehlerhaften Einsendung.

Sobald die erstellte Einsendung gestartet wurde, wird sie im Einsendungsverlauf der angegebenen Benutzer als eingereichtes Formular angezeigt und der angegebenen Blue Prism Warteschlange hinzugefügt, die im Formular-Konstrukt detailliert aufgeführt ist.

Der Benutzer, dessen Anmeldedaten zur Erstellung der neuen Einsendung verwendet werden, muss auf das Formular zugreifen können. Die Interact Rolle, die das Formular enthält, muss den Benutzer also in der Benutzerliste angeben.

Es gibt keine Ausgabeparameter für die Aktion „Einsendung erstellen“.

Einsendung einreichen

Mit der Aktion „Einsendung einreichen“ können Sie eine Einsendung im Posteingangsordner eines Benutzers erstellen. Die eingereichte Einsendung kann ganz, halb oder gar nicht ausgefüllt sein – das hängt von Ihren Anforderungen ab.

Wenn das Formular, auf dem Ihre Einsendung basiert, den Optionsgruppen-Erfassungstyp enthält, können Sie keine leere Einsendung erstellen. Für die Optionsgruppe muss ein Wert festgelegt werden. Weitere Informationen zu Formularerfassungstypen: Erfassungstypen in Formularen verwenden.

Die Eingaben für die Aktion sind der Formularname, die Benutzer-ID (die Sie über Benutzer nach Formularname abrufen einholen können) und die Daten, die in die Felder geladen werden sollen, wie unten dargestellt. Die geladene Datendatei kann durch Ausführen des Befehls Formularschema abrufen erstellt werden.

Es gibt keine Ausgaben für die Aktion „Einsendung einreichen“.

Wenn Sie „Einsendung einreichen“ zusammen mit Datei hochladen verwenden, stellen Sie sicher, dass Sie das richtige Format für die Sammlung mit den Details der anzuhängenden Datei verwenden. Siehe Formularschema abrufen für weitere Details über das Format der Sammlung.

Datei hochladen

Mit der Aktion „Datei hochladen“ können Sie eine Datei in den lokalen Speicher hochladen, zum Beispiel eine Bilddatei oder ein Dokument. Es kann gemeinsam verwendet werden mit:

Die Aktion „Datei hochladen“ lädt jeweils nur eine einzige Datei hoch. Wenn Sie mehrere Dateien in ein Formular hochladen, müssen Sie die Aktion „Datei hochladen“ für jede Datei ausführen und dann die Ausgabelinks separat speichern.

Die Aktion umfasst die vier unten gezeigten Eingaben:

  • Formularname – Das Formular in Interact, mit dem die hochgeladene Datei verknüpft wird.
  • Feldname – Die Automatisierungs-ID des Feldes auf dem Formular.
  • Dateiname – Die Datei, die in den lokalen Speicher hochgeladen wird. Dies umfasst sowohl den vollständigen Namen der Datei als auch die Dateierweiterung.
  • Datei – Der Inhalt der Datei, die mit einem Datenelement angehängt wurde, dessen Typ auf „Binär“ eingestellt ist.

Wenn Sie eine Datei hochladen, erhalten Sie einen Link, den Sie bei Einsendung erstellen oder Einsendung einreichen verwenden können.

Sobald die Datei hochgeladen wurde, können Sie den Inhalt der Datei bei Einsendung erstellen oder Einsendung einreichen anhängen. Gehen Sie dazu wie folgt vor:

  1. Datei hochladen – Laden Sie die Datei im lokalen Speicher hoch.
  2. Formularschema abrufen – Rufen Sie die Struktur des Formulars ab, an das die Datei angehängt wird.
  3. Einsendung erstellen oder Einsendung einreichen – Verweist auf die geänderte Formularstruktur und hängt die hochgeladene Datei an die neue Einsendung an.

Wenn Sie „Einsendung erstellen“ verwenden, kann die angehängte Datei über die Registerkarte „Einsendungsverlauf“ in Interact heruntergeladen und angezeigt werden. Wenn Sie „Einsendung einreichen“ verwenden, kann der Benutzer nur den Link, der die Datei ersetzt, bearbeiten. Er kann die angehängte Datei nicht anzeigen (außer, wenn es sich um ein Bild handelt) und sie nicht herunterladen.

Feldwert der Einsendung bearbeiten

Die Aktion „Feldwert der Einsendung bearbeiten“ wird wie alle anderen Aktionen auch vom Objekt aufgerufen. Es gibt mehrere Aktionen innerhalb des Objekts, die es Ihnen ermöglichen, bestimmte Feldelemente zu aktualisieren. Diese Aktionen sind direkt mit dem Elementtyp verknüpft, der im Interact Formular verwendet wird.

Der Feldname in den folgenden Abschnitten ist die Automatisierungs-ID, die im Formulardesigner erstellt wurde.

Details zu den verschiedenen Elementtypen werden in den folgenden Abschnitten beschrieben.

Kontrollkästchenelement (einzeln)

„Kontrollkästchen – Wert bearbeiten“ bezieht sich auf zwei Aktionen, die jeweils ein einzelnes oder mehrere Kontrollkästchen unterstützen. Um die Werte für ein einzelnes Kontrollkästchen zu aktualisieren, wird eine einfache Textzeichenfolge übermittelt.

Kontrollkästchenelement (mehrere)

„Kontrollkästchen – Wert bearbeiten (mehrere)“ ist wieder eine einfache Textzeichenfolge, die übermittelt wird. Allerdings können hier unterschiedliche Werte per Komma abgetrennt werden.

Datumselement

Das Datumselement verwendet das Textformat, um Werte in einem Interact Formular zu bearbeiten. So können drei unterschiedliche Formate im Interact Formular unterstützt werden. Das Formular ermöglicht es Ihnen, folgende Formate für Datumsangaben zu verwenden:

  • TT/MM/JJJJ – britisches Format;
  • MM/TT/JJJJ – US-amerikanisches Format;
  • JJJJ/MM/TT – internationales Format.

Wenn Sie das Interact Formular auf das internationale Datumsformat eingestellt haben und dann ein britisches oder US-amerikanisches Format eingeben, zeigt das Interact Formular eine Nachricht zu ungültigen Daten an.

Dropdown-Element (einzeln)

Das Dropdown-Element unterstützt wie das Kontrollkästchenelement zwei Aktionen für einen oder mehrere Einträge. Um die Werte für ein einzelnes Dropdown zu aktualisieren, wird eine einfache Textzeichenfolge übermittelt.

Dropdown-Element (mehrere)

„Dropdown – Wert bearbeiten (mehrere)“ ist wieder eine einfache Textzeichenfolge, die übermittelt wird. Allerdings können hier unterschiedliche Werte per Komma abgetrennt werden.

Zahlelement

Das Zahlelement erfordert entweder eine Zahl oder einen Text, der oder die an es weitergeben wird. Obwohl es sich beim Feldtyp um den Typ „Text“ handelt, müssen Sie eine Zahl angeben, die nur die erlaubten Trennzeichen wie Kommas oder Punkte enthalten darf. Wenn Text eingegeben wird, zeigt das Interact Formular eine Nachricht zu ungültigen Daten an.

Optionsgruppenelement

Das Optionsgruppenelement ist wie ein einzelnes Kontrollkästchen- oder Dropdown-Element. Der bearbeitete Wert ist ein einzelnes Textfeld, das den erforderlichen aktualisierten Wert enthält.

Tabellenelement

Das Tabellenelement verwendet eine Sammlung, damit Sie die Werte aktualisieren können. Die Sammlung muss die gleiche Anzahl von Spalten enthalten wie das Formularfeld innerhalb des Zielformulars. Für die Feldnamen der Sammlung müssen Automatisierungs-IDs verwendet werden. Die Anzahl der Zeilen kann erhöht oder verringert werden, um die aktualisierten Daten zu berücksichtigen.

Die Aktion „Tabelle bearbeiten“ überschreibt die gesamte Tabelle im Gegensatz zum Anfügen von Zeilen an eine vorhandene Tabelle.

Textelement

Das Textelement erfordert ein einfaches Textfeld, das an es weitergeben wird.

Textbereich-Element

Das Element „Textbereich“ akzeptiert einen Text-String mit einer Länge von bis zu 3.500 Zeichen.

Zeitelement

Das Zeitelement verwendet das Textformat, um Werte in einem Interact Formular zu bearbeiten. Sie können die Zeit in einem von zwei Formaten angeben:

  • 03:00:00 PM; oder
  • 15:00:00.

Beide geben 3 Uhr nachmittags in Interact zurück.

Hochladen

Mit der Aktion „Wert des Upload-Felds bearbeiten“ kann eine vorhandene Datei, wie z. B. ein Bild oder Dokument, durch eine neue Datei ersetzt werden.

Bei Verwendung dieser Aktion mit:

  • Formularschema abrufen können Sie mit einer leeren Einsendung beginnen und diese Aktion zum Hochladen einer Datei verwenden.
  • Einsendung abrufen oder Nächstes Element abrufen (aus den internen Geschäftsobjekten bzw. Arbeitswarteschlangen von Blue Prism) muss bereits eine Datei vorhanden sein, die durch „Wert des Upload-Felds bearbeiten“ ersetzt werden soll.

Feldstatus zu „Optional“ ändern

Die Aktion „Feldstatus zu ‚Optional‘ ändern“ ermöglicht es Ihnen, den Status eines Felds innerhalb der Einsendung zu ändern und es als „Optional“ festzulegen.

Die Eingaben für die Aktion sind die Einsende-ID und der Feldname, den Sie in den Status „Optional“ ändern, wie unten dargestellt. Dieses Beispiel zeigt ein Feld mit dem Namen „security“, dessen Status auf „Optional“ gesetzt wurde.

Es gibt keine Ausgaben für „Feldstatus zu ‚Optional‘ ändern“.

Feldstatus zu „Obligatorisch“ ändern

Die Aktion „Feldstatus zu ‚Obligatorisch‘ ändern“ ermöglicht es Ihnen, den Status eines Felds innerhalb der Einsendung zu ändern und es als „Obligatorisch“ festzulegen.

Die Inputs für die Aktion sind die Einsende-ID und der Feldname, den Sie in den Status „Obligatorisch“ ändern, wie unten dargestellt. Dieses Beispiel zeigt ein Feld mit dem Namen „security“, dessen Status auf „Obligatorisch“ gesetzt wurde.

Es gibt keine Ausgaben für „Feldstatus zu ‚Obligatorisch‘ ändern“.

Feldstatus zu „Schreibgeschützt“ ändern

Die Aktion „Feldstatus zu ‚Schreibgeschützt‘ ändern“ ermöglicht es Ihnen, den Status eines Felds innerhalb der Einsendung zu ändern und es als „Schreibgeschützt“ festzulegen.

Die Eingaben für die Aktion sind die Einsende-ID und der Feldname, den Sie in den Status „Schreibgeschützt“ ändern, wie unten dargestellt. Dieses Beispiel zeigt ein Feld mit dem Namen „security“, dessen Status auf „Schreibgeschützt“ gesetzt wurde.

Es gibt keine Ausgaben für „Feldstatus zu ‚Schreibgeschützt‘ ändern“.

Feldstatus zu „Ausgeblendet“ ändern

Die Aktion „Feldstatus zu ‚Ausgeblendet‘ ändern“ ermöglicht es Ihnen, den Status eines Felds innerhalb der Einsendung zu ändern und es als „Ausgeblendet“ festzulegen.

Die Inputs für die Aktion sind die Einsende-ID und der Feldname, den Sie in den Status „Ausgeblendet“ ändern, wie unten dargestellt. Dieses Beispiel zeigt ein Feld mit dem Namen „security“, dessen Status auf „Ausgeblendet“ gesetzt wurde.

Es gibt keine Ausgaben für „Feldstatus zu ‚Ausgeblendet‘ ändern“.

Seitenstatus zu „Sichtbar“ ändern

Die Aktion „Seitenstatus zu ‚Sichtbar‘ ändern“ ermöglicht es Ihnen, eine Seite innerhalb einer Einsendung sichtbar zu machen.

Die Inputs für die Aktion sind die Einsende-ID und der Seitenname, den Sie in den Status „Sichtbar“ ändern, wie unten dargestellt. Dieses Beispiel zeigt eine Seite mit dem Namen „inputs“, deren Status auf „Sichtbar“ gesetzt wurde.

Es gibt keine Ausgaben für „Seitenstatus zu ‚Sichtbar‘ ändern“.

Seitenstatus zu „Ausgeblendet“ ändern

Die Aktion „Seitenstatus zu ‚Ausgeblendet‘ ändern“ ermöglicht es Ihnen, eine Seite innerhalb einer Einsendung auszublenden.

Die Eingaben für die Aktion sind die Einsende-ID und der Seitenname, den Sie in den Status „Ausgeblendet“ ändern, wie unten dargestellt. Dieses Beispiel zeigt eine Seite mit dem Namen „inputs“, deren Status auf „Ausgeblendet“ gesetzt wurde.

Es gibt keine Ausgaben für „Seitenstatus zu ‚Ausgeblendet‘ ändern“.

Einsendung auf die Registerkarte „Verlauf“ verschieben

Die Aktion „Einsendung auf die Registerkarte ‚Verlauf‘ verschieben“ ermöglicht es Ihnen, eine Einsendung aus ihrem aktuellen Ordner in den Ordner Einsendungsverlauf unter Verlauf zu verschieben. Diese Aktion ändert außerdem den Status der Einsendung zu „Eingesendet“. Der Statusfilter in Interact kann dazu verwendet werden, nur die Einsendungen mit diesem Status anzuzeigen.

Die Eingabe für die Aktion ist die Einsende-ID der zu verschiebenden Einsendung, wie unten dargestellt.

Es gibt keine Ausgaben für „Einsendung auf die Registerkarte ‚Verlauf‘ verschieben“.

Einsendung auf die Registerkarte „Genehmigt“ verschieben

Die Aktion „Einsendung auf die Registerkarte ‚Genehmigt‘ verschieben“ ermöglicht es Ihnen, eine Einsendung aus ihrem aktuellen Ordner in den Ordner Einsendungsverlauf unter Verlauf zu verschieben. Diese Aktion ändert außerdem den Status der Einsendung zu „Genehmigt“. Der Statusfilter in Interact kann dazu verwendet werden, nur die Einsendungen mit diesem Status anzuzeigen.

Die Eingabe für die Aktion ist die Einsende-ID der zu verschiebenden Einsendung, wie unten dargestellt.

Es gibt keine Ausgaben für „Einsendung zu ‚Genehmigt‘ verschieben“.

Einsendung auf die Registerkarte „Überprüfung“ verschieben

Die Aktion „Einsendung auf die Registerkarte ‚Überprüfung‘ verschieben“ ermöglicht es Ihnen, die Einsendung für den Einsender in den Ordner Genehmigung ausstehend unter Verlauf zu verschieben und für den Genehmiger in den Ordner Genehmigungen unter Meine Aufgaben.

Hierfür muss ein Formular entweder als Einzelner Genehmiger oder Jeglicher Genehmiger konfiguriert sein. Ist dies nicht der Fall, wird das Formular in den Ordner Genehmigung ausstehend verschoben, nicht jedoch auf die Registerkarte Meine Aufgaben eines Genehmigers.

Die Eingabe für die Aktion ist die Einsende-ID der zu verschiebenden Einsendung, wie unten dargestellt.

Es gibt keine Ausgaben für „Einsendung auf die Registerkarte ‚Überprüfung‘ verschieben“.

Einsendung auf die Registerkarte „Abgelehnt“ verschieben

Die Aktion „Einsendung auf die Registerkarte ‚Abgelehnt‘ verschieben“ ermöglicht es Ihnen, eine Einsendung aus ihrem aktuellen Ordner in den Ordner Einsendungsverlauf unter Verlauf zu verschieben. Diese Aktion ändert außerdem den Status der Einsendung zu „Abgelehnt“. Der Statusfilter in Interact kann dazu verwendet werden, nur die Einsendungen mit diesem Status anzuzeigen.

Die Eingabe für die Aktion ist die Einsende-ID der zu verschiebenden Einsendung, wie unten dargestellt.

Es gibt keine Ausgaben für „Einsendung auf die Registerkarte ‚Abgelehnt‘ verschieben“.

Einsendung auf die Registerkarte „Entwurf“ verschieben

Die Aktion „Einsendung auf die Registerkarte ‚Entwurf‘ verschieben“ ermöglicht es Ihnen, eine Einsendung aus ihrem aktuellen Ordner in den Ordner Entwurf unter Meine Aufgaben zu verschieben.

Die Eingabe für die Aktion ist die Einsende-ID der zu verschiebenden Einsendung, wie unten dargestellt.

Es gibt keine Ausgaben für „Einsendung auf die Registerkarte ‚Entwurf‘ verschieben“.

Einsendung auf die Registerkarte „Posteingang“ verschieben

Die Aktion „Einsendung auf die Registerkarte ‚Posteingang‘ verschieben“ ermöglicht es Ihnen, eine Einsendung aus ihrem aktuellen Ordner in den Ordner Posteingang unter Meine Aufgaben zu verschieben.

Die Eingabe für die Aktion ist die Einsende-ID der zu verschiebenden Einsendung, wie unten dargestellt.

Es gibt keine Ausgaben für „Einsendung auf die Registerkarte ‚Posteingang‘ verschieben“.

Einsendung auf die Registerkarte „Archiviert“ verschieben

Die Aktion „Einsendung auf die Registerkarte ‚Archiviert‘ verschieben“ ermöglicht es Ihnen, eine Einsendung aus ihrem aktuellen Ordner in den Ordner „Archiviert“ unter Verlauf zu verschieben.

Die Eingabe für die Aktion ist die Einsende-ID der zu verschiebenden Einsendung, wie unten dargestellt.

Es gibt keine Ausgaben für „Einsendung auf die Registerkarte ‚Archiviert‘ verschieben“.