Kickstart4process-App

Kickstart4process-App

Einleitung

In diesem Thema findest du allgemeine Informationen zur Kickstart4process-App.

Über die Kickstart4process-API

In dieser Dokumentation erfährst du, wie du die Programmierschnittstelle der Kickstart4process-App für eigene Entwicklungen nutzen kannst.
Diese Dokumentation richtet sich an Entwickler von Anwendungen, die in der d.ecs architecture-Systemumgebung ausgeführt werden sollen.

Die Kickstart4process-App ist eine Anwendung, mit der du Prozesse erstellen kannst.

JSON-Objekte, URLs und Abfrageparameter (Query) können jederzeit erweitert werden, ohne dass die API ihre Gültigkeit verliert. Es sind ausschließlich die in dieser Dokumentation beschriebenen Eigenschaften, Objekte und Parameter für die API-Programmierung freigegeben.

Funktionsumfang der Kickstart4process-App

Die Kickstart4process-App ist eine Anwendung, mit der du Prozesse einfach erstellen kannst. Du kannst Prozesse durch das Auswählen von Aktivitäten erstellen und sie mithilfe von Formularen und verschiedenen Bedienelementen individuell gestalten.

Mit der Kickstart4process-App bist du in der Lage, Geschäftsprozesse zu automatisieren. Du kannst andere Anwender in Form von Aufgaben an Prozessen teilnehmen lassen oder automatisierte Serviceaktivitäten ausführen. Du hast zudem die Möglichkeit, Prozesse auf Basis von gespeicherten Dokumenten zu starten.

Als Arbeitserleichterung beim Erstellen eines Prozesses kannst du Werte einer Aktivität in einer späteren Aktivität wiederverwenden. Durch die Verwendung von solchen variablen Werten kannst du deine Prozesse dynamisch gestalten, und beispielsweise den Bearbeiter einer Aufgabe flexibel angeben.

Verwenden der API-Funktionen

Nachfolgend erfährst du, wie du Schnittstelle der Kickstart4process-API für eigene Entwicklungen verwenden kannst.

Bereitstellen eines externen Dienstes

Um eigene Elemente in Kickstart4process hinzuzufügen, kann eine App auf ihrer Root-Ressource die Link-Relation processServices bereitstellen. Diese Link-Relation sollte folgendermaßen aussehen:

{
    "_links": {
        "processServices": {
            "href": "/someapp/someurl/i/like/as/dev/"
        }
    }
}


Die Ressource wird von Kickstart4Process mit dem Header Accept-Language aufgerufen, damit das externe Element lokalisierte Beschreibungen zurückgeben kann.

Wichtig

Die Verarbeitung und Beantwortung dieser Anfrage ist zeitkritisch und sollte demnach möglichst schnell durchgeführt werden. Die Abfrage der bereitgestellten Dienste durch die weiterverarbeitenden Apps wird mit einem geringen Timeout durchgeführt.

Der zurückgegebene Body des Elementes im JSON-Format muss folgendermaßen aufgebaut sein:

{
	"services": {
		"ocr": {
			"name": "OCR recognition",
			"symbolUrl": "/inbound/img/ocr.png",
		    "endpoint": "/inbound/service/ocr",
            "asynchronous": true,
			"inputVariables": {
				"fileFormat": {
					"label": "file format",
					"type": "String!",
					"options": [
                		{"value": "pdf", "display": "PDF"},
                		{"value": "txt", "display": "text file"}
            		]
				},
				"pageSize": {
					"label": "number of pages",
					"type": "Number"
				},
				"inputFile": {
					"label": "file to be read",
					"type": "String"
				},
				"dmsObject": {
					"label": "DMS link to d.3 document",
					"type": "DmsObject"
				},
				"fast": {
					"label": "extra fast",
					"type": "String",
					"options": [
                		{"value": "true", "display": "yes"},
                		{"value": "false", "display": "no"}
            		]
				},
				"editor": {
					"label": "editor",
					"type": "Identity"
				},
			},
			"outputVariables": {
				"outputFile": {
					"label": "created file",
					"type": "String"
				},
				"fileSize": {
					"label": "file size",
					"type": "Number"
				}
			}
		}
	}
}

Erklärung der Eigenschaften

  • Key der Elemente: Ein eindeutiger Bezeichner für den Service. In diesem Beispiel "ocr". Maximal 255 Zeichen lang.
  • name: Unter diesem Namen wird das benutzerdefinierte Element in der Kickstart4process-App angezeigt. Maximal 50 Zeichen lang.
  • symbolUrl: Mit dieser URL kannst du ein Icon angeben, welches im process modeler für dieses benutzerdefinierte Element angezeigt wird. (Optional. Wenn du keine URL angibst, wird das Standard-Icon für Serviceaktivitäten verwendet.)
  • endpoint: URL, mit der der Service Anfragen entgegen nimmt.
  • asynchronous: true, wenn der Service asynchron arbeitet, sonst false.
  • inputVariables
    • key: Eindeutiger Key der Variablen in folgendem Format: [A-Za-z][A-Za-z0-9_]*. Maximal 255 Zeichen lang.
    • label: Anzeigename der Variablen in der Kickstart4process-App. Maximal 30 Zeichen lang.
    • type: Datentyp der Variablen. Mögliche Werte: String, Number, Identity, DmsObject (im Sinne der Datentypen der Process-App, jeweils nur Einzelwerte).
    • options: Array der auswählbaren Elemente jeweils mit Wert (value) und Anzeigenamen (display, maximal 100 Zeichen lang). Nur bei Datentyp String, Number und Identity. Der Wert (value) darf nicht leer und maximal 500 Zeichen lang sein. 
  • outputVariables
    • key: Eindeutiger Key der Variablen in folgendem Format: [A-Za-z][A-Za-z0-9_]*. Maximal 90 Zeichen lang.
    • label: Anzeigename der Variablen in der Kickstart4process-App. Maximal 30 Zeichen lang.
    • type: Datentyp der Variablen. Mögliche Werte: String, Number, Identity (im Sinne der Datentypen der Process-App, jeweils nur Einzelwerte).

Hinweis

Um Prozesse in der Kickstart4process-App für Anwender einfach zu gestalten, ist die Anzahl der Input- und Output-Variablen jeweils auf 6 Variablen begrenzt.

Angeben des Keys

Der Key der Elemente muss eine bestimmte Form einhalten. Er darf nur folgende Zeichen enthalten: a-z, A-Z, 0-9, _ (Beispiel: "ocr_123").

Wichtig

Wenn der Key ungültige Zeichen enthält, wird der Service ignoriert und in der Kickstart4process-App nicht angezeigt.

Ändern der Parameterreihenfolge

Die Konfiguration des Services innerhalb der Kickstart4process-App führt die Eingabeparameter in der Reihenfolge auf, wie sie im Body (JSON-Format) zurückgegeben werden. Du kannst die Reihenfolge der Eingabeparameter auf der Oberfläche der Kickstart4process-App beeinflussen, indem du die Reihenfolge im Body änderst.

Verwenden von Caching

Mit dem Response-Header Cache-Control: max-age=<seconds> kannst du steuern, wie lange die Servicebeschreibung zwischengespeichert (gecached) werden darf.