API zum Starten eines Excel-Prozesses - Automate_Evolve - Automate_Studio_Manager - Latest

Übersicht über die API

Nachfolgend finden Sie eine Übersicht über die API zum Starten eines Excel-Prozesses:

1. Sie unterstützt die Funktion „Namensvorlage“ im Excel-Workflow. Die Eigenschaft „ExcelWorkflowObj.DataFile.Title“ wird ignoriert, wenn der Excel-Zielprozess mit der Namensvorlage der Datendatei konfiguriert ist. Darüber hinaus wird der nächste Name aus der Namensvorlage für die Festlegung des Dokumentnamens verwendet.

2. Die API unterstützt die Einstellung „Versionsüberwachung: Versionsüberwachung für Datenvorlagen“. Diese Einstellung auf Anwendungsebene wird unterstützt, wenn die Datendatei an die API-Route/-Vorlage übermittelt wird.

   Auch Route/Datei kann verwendet werden, um eine Excel-Datei für diejenigen zu übermitteln, die nicht über „Datenvorlagendatei“ erstellt wurden. An diese Route übermittelte Dateien gelten als neueste Vorlagendatei. Die Einstellung „Versionsüberwachung für Datenvorlagen“ hat dabei also keinerlei Bedeutung.

3. Der Evolve Benutzer, der als Dateiübermittler angegeben ist, muss in der Lösung die Rolle Urheber innehaben.

4. Der als Dateiübermittler angegebene Evolve Benutzer muss über eine gültige Benutzernamenslizenz verfügen (d. h. Ausführer oder Standard usw.).

5. In der API-Anforderung darf kein ein Prozessteilnehmer oder Swimlane-Benutzer angegeben werden. Dies entspricht dem Senden einer Excel-Datei über das Microsoft Excel-Add-In für Studio.

6. Unterstützt die Synchronisierungsfunktion für Lösungsfelder.

7. Unterstützt die Abfrage der Where-Bedingung (d. h. RTV-Format). Die automatische Ausführung für das Abfrageskript mit einer Eingabedatei über die Excel-Prozess-API würde gut funktionieren, wenn die RTV-Informationen bereitgestellt werden.

8. Eine Excel-Datendatei, die über „Excel-Datei mit Lösungsvorlage“ erstellt wurde, sollte an folgende Route gesendet werden: {API Route}/Template.

9. Eine Excel-Datendatei, die nicht über „Excel-Datei mit Lösungsvorlage“ erstellt wurde, sollte an folgende Route gesendet werden: {API Route}/File.

   • Dabei wird die Versionsüberwachung für die Datenvorlage nicht unterstützt.

   • Die Spalten/Datenstruktur der übermittelten Excel-Datei sollte(n) der Zuordnung entsprechen, die für bestimmte Excel-Lösungsskripte definiert ist. Eine falsche Datei führt zu Fehlern bei der Workflow-Ausführung oder der Datenverbuchung.

10. Wenn entweder Vorlage oder Datei nicht angegeben ist, verarbeitet das System die Anforderung wie bei der Route mit „{API Route}/File“.

11. Das erneute Senden von Datendateien mit demselben Namen über die API ist nicht zulässig.

12. Ein Excel-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.

Anforderungs- und Antworttext

Zu Beginn eines Excel-Prozesses über die API mit der angegebenen Excel-Vorlage weisen Anforderung und Antwort folgende Struktur auf:

Datenvertrag Anforderung

JSON-Schemadetails zum ExcelWorkflowObj-Parameter:

"ExcelWorkflowObj":{ "DataFile":[{   "Title": "ExcelDataFileName1.xlsx",   "RTVInfo": "",   "Description": "",   "DataFileBlob": "<<Base64EncodedString>>" }], "SupportingFiles":[{   "Title": "SupportingFileName1.xlsx",   "Description": "",   "FileBlob": "<<supporting file blob>>"}, {   "Title": "SupportingFileName2.txt",   "Description": "",   "FileBlob": "<<Base64EncodedString>>" }] }

ExcelWorkflowObj.DataFile: Dies ist zwar ein Arraytyp, aber es wird nur das erste Arrayelement unterstützt und von der API verwendet.

ExcelWorkflowObj.SupportingFiles : Es können mehrere unterstützende Dateien übermittelt werden.

Datenvertrag Antwort:

Anforderungs- und Antwortbeispiel

Im folgenden Beispiel wird die Verwendung der API veranschaulicht:

Anforderungsnutzlast

{   "LibName":"Excel Workbooks",   "UserName":"wsdt\\centraluser",   "ExcelWorkflowObj":   {     "DataFile":     [       {       "Description":"",       "DataFileBlob":"UEsDBBQABgAIAAAAIQComKncbgEAAJUFAAATAAgCW0NvbnRlbnRfVHlw...",       "RTVInfo":"",       "Title":"publish10474.xlsx"       }     ]   },   "TemplateName":"MM02_EPIM",   "AppName":"Arpit App" }

Antwortnutzlast

{     "DocumentItemId": "ea03a42e-7eca-4b5d-af8f-d8e778d75e84" }