API zum Starten von Formularprozessen - Automate_Evolve - Automate_Studio_Manager - Latest

Benutzerhandbuch zu Automate Evolve

Product type
Software
Portfolio
Integrate
Product family
Product
Automate > Automate Evolve
Automate > Automate Studio Manager
Version
Latest
Language
Deutsch
Product name
Automate Evolve
Title
Benutzerhandbuch zu Automate Evolve
Copyright
2024
First publish date
2018
ft:lastEdition
2024-05-23
ft:lastPublication
2024-05-23T16:24:42.750458

Über die API zum Starten von Formularprozessen können Sie einen Formular-Workflow-Prozess starten. Diese API verwendet die POST-Methode zum Starten eines Workflow-Prozesses. Die anfänglichen Formulardaten sollten im XML-Format gesendet werden. Das XML-Format sollte gültig sein, da beim Speichern dieser Formulardaten keine Datenvalidierung durchgeführt wird oder Regeln ausgeführt werden.

Übersicht über die API

Nachfolgend finden Sie eine Übersicht über die API zum Starten von Prozessen:

  1. Sie unterstützt die Funktion „Namensvorlage“. Die Namensvorlage sollte mit der Formularnamensteuerung konfiguriert werden. Die Eigenschaft des Form Name-Steuerelements Run At sollte auf Endgesetzt werden. Beim Aufrufen der Digital Access API sollte das Formularfeld, das der Eigenschaft „Feldname“ des Steuerelements „ Formularname “ zugeordnet ist, leer sein.

  2. Der Evolve Benutzer, der als Formularübermittler angegeben ist, muss in der Lösung, für die ein neuer Formularprozess gestartet werden muss, die Rolle Urheber innehaben.

  3. Optional kann in der API-Anforderung auch ein Prozessteilnehmer oder Swimlane-Benutzer angegeben werden.

  4. Ein Formular-Workflow, der über die API gestartet wird, wird als API-Dokument markiert. Im Falle einer manuellen erneuten Übermittlung gilt das stornierte Prozessdokument weiterhin als API-Dokument. Diese Informationen werden bei der Lizenzabrechnung berücksichtigt.

  5. Durch Kopieren eines Formulardokuments wird im System ein neues Dokument erstellt. Das aus einem API-Dokument kopierte Dokument, das über die Web-Benutzeroberfläche gestartet/übermittelt wurde, gilt als Nicht-API-Dokument (d. h. ein manuell übermitteltes Dokument).

Anforderungs- und Antworttext

Zu Beginn eines Formularprozesses über die API weisen Anforderung und Antwort folgende Struktur auf:

Datenvertrag Anforderung:

Name Typ Einschränkung Beschreibung
AppName Zeichenfolge Erforderlich Anwendungsname der „Formularlösung“.
Kommentare Zeichenfolge - Kommentare zum Startknoten.
FormXML Zeichenfolge - Dies sind die Formulardaten des neuen Formularprozesses. Dies sollte ein gültiges XML-Formular für die Formularlösung sein.
LibName Zeichenfolge Erforderlich Bibliotheksname der „Formularlösung“.
ParticipantsInfoArray Array von { “SwimlaneName” : ”abc”, “UserName”: ”xyz” } -

Dies sollte der Swimlane-Name sein, der durch angegebene Benutzer aufgelöst wird.

  • „SwimlaneName“: Name der Swimlane.

  • „UserName“: Durch Kommas getrennte Liste von Benutzernamen.

In Fällen, in denen dieser Parameter leer gelassen wird oder keine spezifischen Swimlane-Details bereitgestellt werden, löst die Anwendung diese Swimlanes gemäß dem im Workflow definierten Verhalten auf.

Bei der Swimlane vom Typ „Person“ im Formular-Workflow kann der Swimlane-Benutzerwert nicht überschrieben werden, während das Formular über die API gestartet wird.

TemplateName Zeichenfolge Erforderlich Name der „Formularlösung“.
UserName Zeichenfolge Erforderlich Benutzername des Benutzers, der als Urheber des Prozesses festgelegt wird. Der Benutzer muss in der Lösung, für die ein neuer Formularprozess gestartet werden muss, die Rolle „Urheber“ innehaben.

Datenvertrag Antwort:

Name Typ Einschränkung Beschreibung
ProcessId Guid - Rückgabe-ID des Prozesses.
FormItemId Guid - Rückgabe-ID des Formulardokuments.

Anforderungs- und Antwortbeispiel

Im folgenden Beispiel wird die Verwendung der API veranschaulicht.

Route: http://Winshuttle.EvolveUrl/svr/api/v1/Processextn/StartFormProcess

Anforderungsnutzlast

{   "AppName":"My API",   "LibName": "Form Process Ext",   "TemplateName": "API Product Example",   "UserName": "mydomain\\user1",   "Comments": "Process from API2",   "FormXml": "<my:myFields xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xhtml=\"http://www.w3.org/1999/xhtml\" xmlns:d=\"http://schemas.microsoft.com/office/infopath/2003/ado/dataFields\"  xmlns:dfs=\"http://schemas.microsoft.com/office/infopath/2003/dataFormSolution\" xmlns:my=\"http://schemas.microsoft.com/office/infopath/2003/myXSD\" xmlns:xd=\"http://schemas.microsoft.com/office/infopath/2003\"  xmlns:msxsl=\"urn:schemas-microsoft-com:xslt\"> <my:Product_Name>Evolve</my:Product_Name><my:Product_Description>Evolve product desc</my:Product_Description></my:myFields>",   "ParticipantsInfoArray": [     {       "SwimLaneName": "PersonSwimlane",       "UsersName": "mydomain\\user1"     },     {       "SwimLaneName": "TeamSwimlane",       "UsersName": "mydomain\\user1,mydomain\\user2"     }   ] }

Antwortnutzlast

{     "ProcessId": "93ae1e24-366e-4e54-af5c-dbf34ec15797",     "FormItemId": "0e6c9998-3e3d-4e89-9fd4-e8086312cb32" }