Kickstart4process-App

_{Alle Dokumentationen zur d.ecs kickstart4process-API verlieren mit der Veröffentlichung dieser Version ihre Gültigkeit.}

_{^{Die in dieser Dokumentation enthaltenen Informationen sind mit größter Sorgfalt erstellt und durch unsere Qualitätssicherung nach dem allgemeinen Stand der erprobten Technik geprüft. Dennoch sind Fehler nicht auszuschließen. Aus diesem Grund stellen die in der vorliegenden Dokumentation enthaltenen Informationen keine Verpflichtung, zugesicherte Eigenschaft oder Garantie dar. Die d.velop AG übernimmt auf Basis dieser Dokumentation keine Haftung oder Gewährleistung. Ansprüche nach dem Produkthaftungsgesetz sowie nach Deliktsrecht bleiben unberührt, sofern sie nicht individualvertraglich ausgeschlossen wurden.
Aussagen über gesetzliche, rechtliche und steuerliche Vorschriften und deren Auswirkungen haben nur für die Bundesrepublik Deutschland Gültigkeit.
Die d.velop AG behält sich vor, in ihrer Software vorhandene Komponenten von Drittanbietern durch funktionsadäquate Komponenten anderer Hersteller zu ersetzen. Die d.velop AG behält sich in Ausübung Ihrer jeweils gültigen Releasepolitik vor, Produktfeatures und einzelne Softwareprodukte nicht mehr durch Softwarepflege- und Supportleistungen zu unterstützen. Näheres dazu finden Sie im Supportlebenszyklus des d.velop-Service-Portals unter https://portal.d-velop.de.}}

^{Die Verwendung der Texte, Bilder, Grafiken sowie deren Arrangements, auch auszugsweise, sind ohne vorherige Zustimmung der d.velop AG nicht erlaubt.
Alle verwendeten Hard- und Softwarenamen sind Handelsnamen und/oder Warenzeichen der jeweiligen Hersteller/Inhaber, die diese zur Verfügung gestellt haben.}

^{Sofern Teile oder einzelne Formulierungen dieser Dokumentation der geltenden Rechtslage nicht, nicht mehr oder nicht vollständig entsprechen sollen, bleiben die übrigen Teile der Dokumentation in ihrem Inhalt und ihrer Gültigkeit davon unberührt.
In der Dokumentation können Sie über Links zu externen Internetseiten gelangen, die nicht von uns betrieben werden. Derartige Links werden von uns entweder eindeutig gekennzeichnet oder sind durch einen Wechsel in der Adresszeile Ihres Browsers erkennbar. Für die Inhalte dieser externen Internetseiten sind wir nicht verantwortlich.}

^{Kontakt
d.velop AG
Schildarpstraße 6-8
48712 Gescher, Deutschland}

^{Fon +49 2542 9307-0
d-velop.de oder info@d-velop.de}

^{Vertretungsberechtigte Personen: Sebastian Evers (Co-CEO), Rainer Hehmann (Co-CEO), Dr. Stephan Held (CFO), Christoph Pliete (CAO)
Vorsitzender des Aufsichtsrates: Dr. Helmut Bäumer
Handelsregister beim Amtsgericht Coesfeld, Nr. HRB 4903
Umsatzsteueridentifikationsnummer: DE 813062165} 

^{Bei Fragen zu dieser Dokumentation oder zur Software wenden Sie sich bitte an uns.
Fon +49 2542 9307-6000
support@d-velop.de
© d.velop AG. Alle Rechte vorbehalten.}

_{Dieses Dokument wurde zuletzt am 25.06.2020 überarbeitet und bezieht sich auf die d.ecs kickstart4process-API ab Version 1.0.0.}

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

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.

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.

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

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.

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

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

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