API-Profil (Zusatzmodul)

Die Verwendung der SmartProcess API ist nur für authentifizierte Benutzer mit einer Designer-Lizenz möglich. Zur Authentifizierung wird aus Sicherheitsgründen nicht das Anwendungspasswort für SmartProcess verwendet, sondern ein API-Schlüssel, der in diesem Einstellungspunkt generiert werden kann.

API-Profil anlegen

Über <+ Neuer Eintrag> wird ein neues API-Profil angelegt und ein API-Schlüssel für dieses Profil generiert. Im Feld 'Profilname' können Sie dem Profil einen beliebigen Namen geben.

Ein angelegtes API-Profil können Sie über den Button <Löschen> wieder entfernen.

API-Konfiguration

Nachdem das Profil angelegt wurde, muss das Profil über den Button <Bearbeiten> konfiguriert werden.

Register Allgemein

Dem Profil muss ein Benutzer zugeordnet werden, der Zugriff auf die API bekommen soll.

Der eingetragene Benutzer kann sich in der Folge zum Aufrufen der SmartProcess API mit seinem Benutzernamen und dem zuvor generierten API-Schlüssel authentifizieren.

Um einem Benutzer den Zugriff auf die SmartProcess API wieder zu entziehen oder einem anderen Benutzer den Zugriff zu gewähren, können Sie den Benutzer aus dem Feld einfach löschen oder einen anderen Benutzer zuweisen.

Die Standardsprache bestimmt zwei Dinge:

1. wie Felder in der API initial benannt werden und
2. wie sprachgebundene Felder (Optionsfelder, die Kategorie eines Katalogeintrags etc.) übersetzt werden. Ist die Standardsprache z.B. Englisch, wird eine Ja-/Nein-Auswahl mit „Yes“ und „No“ ausgegeben bzw. eingelesen.

Im Feld Basis-URL für den API-Zugriff finden Sie die URL, die Sie für den API-Zugriff verwenden können.

Teilbereiche konfigurieren (Vorgänge, Katalogeinträge, Anhänge)

Die Bereiche, die für die API zur Verfügung stehen sollen, müssen einzeln konfiguriert werden. Die Tabelle für die Konfiguration ist in jedem Bereich gleich und besteht aus folgenden Spalten:

API-Anzeigename	Der in der API genutzte Name des Objekts. Muss dem NCName-Schema entsprechen und darf keinen Bindestrich oder Leerzeichen. Die praktischen Einschränkungen von NCName sind, dass er nicht Symbolzeichen wie :, @, $, %, &, /, +, ,, ;, Leerzeichen oder verschiedene Klammern enthalten darf. Außerdem kann ein NCName nicht mit einer Zahl, einem Punkt oder einem Minuszeichen beginnen, obwohl sie später in einem NCName erscheinen können. Der automatisch generierte Name kann jederzeit geändert werden indem Sie auf den kleinen Bearbeiten-Button klicken. Mit einem Klick auf + lässt sich der Eintrag aufklappen, sodass auch die Unterelemente ausgewählt werden können.
SmartProcess-Anzeigename	Der in SmartProcess genutzte Name des Objekts.
Aktiv	Auswahl, ob das Objekt über die API zur Verfügung stehen soll.
Schlüsselfeld?	Auswahl, ob das Feld ein Schlüsselfeld ist. Jede Entität (Vorgänge, Katalogeinträge etc.) benötigt mindestens ein aktives Schlüsselfeld, durch das sie eindeutig identifiziert wird. Ein Schlüsselfeld muss immer auch als aktiv ausgewählt sein!

Besonderheiten

• Feld Link: Dieses Feld liefert den Link zurück, über den der Vorgang aufgerufen werden kann. Wird ein Vorgang erstellt, kann der Link direkt (ohne zusätzliche Anfrage) zurückgegeben und im eigenen System hinterlegt werden.
  Wie alle Elemente muss auch dieses vor Nutzung im API-Profil aktiviert werden.
• Gelöschte Elemente, die vorher in der API aktiv waren, werden in der Tabelle rot angezeigt und beim nächsten Speichern gelöscht (es wird ein Hinweis angezeigt).

  

• Hauptworkflows, die in einem anderen Prozess verlinkt sind (z.B. Standardworkflow Maßnahme), können an der verlinkten Stelle nicht aufgeklappt oder umbenannt werden. „Aktiv“ bedeutet in diesem Kontext, dass die Verbindung zwischen beiden Workflows aktiv ist. Name und Unterelemente des verlinkten Workflows werden nicht im verlinkten Bereich übernommen.

  

  Die Felder des Hauptworkflows müssen in diesem Fall ebenfalls aktiv geschaltet werden.
  
  
• Subworkflows, die in einem anderen Workflow verlinkt sind, werden behandelt, als wären sie nicht verlinkt.

  

• Workflows, die sich selbst wieder aufrufen, werden nicht unterstützt.

API-Anbindung