Mandanten-Verwaltung

Administrative Tätigkeiten bezogen auf die Verwaltung eines oder mehrerer Mandanten.

• Features verwalten
• System API

Features verwalten

Die Feature-Verwaltung ermöglicht es experimentelle bzw. neue Features je Mandant (und wahlweise für alle Mandanten einer Umgebung) zu aktivieren / deaktivieren. Somit ist es möglich Endkunden phasenweise an neue Funktionen zu gewöhnen oder optionale Features grundsätzlich zu deaktivieren.

Die Feature-Verwaltung wird sich langfristig zwischen On-Premis und SaaS-Angeboten unterscheiden.

Die Features eines Mandanten werden aktuell (Stand Q3 2022) als Teil der Server- und Mandantenkonfiguration gespeichert.

Feature-Übersicht

Flag	Funktion	Im Standard aktiviert?	Verfügbar ab Version
v2Viewer	Ist der v2 Viewer in der v2 UI nutzbar?	X	< 2.3.0
v1Viewer	Ist der v1 Viewer in der v2 UI nutzbar?	X	< 2.3.0
v2Ui	Ist die v2 UI nutzbar?	X	< 2.3.0
v1Ui	Ist die v1 UI nutzbar?	X	< 2.3.0
masterDataTablePermissions	Soll ein komplexeres Berechtigungssytsem in der Stammdatenverwaltung genutzt werden?		< 2.3.0
jobManagement	Soll das v2 Jobsystem in der Benutzeroberfläche sichtbar sein?		< 2.3.0
documentLog	Darf in der UI auf Dokumenten-Logs zugegriffen werden können? (Aktuell nur in Ergänzung mit Logging in Elasticsearch nutzbar)		< 2.3.0
newsSidebar	Noch nicht veröffentlicht, wird nicht aktiv gepflegt: Falls aktiv, zeigt in der UI ein vereinfachtes Changelog an.		< 2.3.0
validationFieldLayout	Experimentell: Soll ein komplexeres Feldlayouting (inkl. Layout-Editor) in der v2 UI für die Validierung genutzt werden?		< 2.3.0
savedDocumentSearches	Können User Dokumenten-Suchen abspeichern und sehen diese als gespeicherte Suchen im Dashboard uws.?		>= 2.3.0
translationAdministration	Können User in der Administration Sprachen und Übersetungen administrieren?		>= 2.3.0
uiConfigExport	Können User in der Administration Dokumentenklassen exportieren?		>= 2.5.0
uiConfigImport	Können User in der Administration Dokumentenklassen importieren?		>= 2.5.0
uiAllowDocumentUpload	Können User Dokumente hochladen?	X	>= 2.5.0
uiAllowDocumentSplit	Können User Dokumente aufteilen?	X	>= 2.5.0
pipelineAllowMultipleStepExecutions	Können Verarbeitungsschritte mehrfach mit dem selben Dokument ausgeführt werden?		>= 2.6.0
configurableFieldAmountFormatting	Darf die Formatierung der Betragsfelder konfigurierbar sein?		>= 2.7.0
reportValidatedDocuments	Werden Report-Daten für die Auswertung der Extraktionsqualität erhoben und angezeigt? Warnung Stand April 2024: Dieses Feature ist noch nicht vollständig umgesetzt und könnte zur Ansammlung großer Datenmengen führen.		>= 2.7.0
workerManager	Sollen Jobs über den Worker Manager verteilt & verwaltet werden?   Serverseitig überschreibar über die Umgebungsvariable SQZ_WORKER_MANAGER_FORCE		>= 2.10
asyncExportAfterValidation	Ist es möglich, dass Dokumente nach einer manuellen Validierung im Hintergrund exportiert werden? Bei sehr langsamen Export-Schnittstellen nützlich.   Bei Aktivierung ist die entsprechende Stapelklassen-Eigenschaft nutzbar.	X	>= 2.12
formTraining	Ist Formularbasiertes Training möglich?		>= 2.12
xmlEditor	Ist der administrative Editor zum Pflegen der XML Verarbeitung aktiv? Achtung, das Feature ist experimentell: Wenn sie dieses Flag aktivieren, ohne die explizite Freigabe eines DEXPRO Mitarbeiters dafür eingeholt zu haben, behalten wir uns das Recht vor, Supportfälle zum Thema XML zu lösen. Diese Einschränkung gilt, solange das Feature der XML Verarbeitung mittels Editor nicht über die Release Notes im Forum freigegeben wurde.		>= 2.13
xmlTraining	Ist das XML-Training für Kopfdaten und Positionen aktiv?		>= 2.13

Konfiguration via Mandanten-Konfig.

Folgendes Beispiel aktiviert zwei und deaktivieren ein Feature für den betroffenen Mandanten.

{
  "...": {
    "...": "..."
  },
  "features": {
    "v2Ui": true,
    "v2Viewer": true,
    "oldFeature": false
  }
}

System API

Beschreibung

Diese Seite dokumentiert die System API von Squeeze. Mit dieser können Mandanten und das System verwaltet werden.

URL

Die URL unter welcher Squeeze erreichbar ist, in Kombination mit dem folgenden Path: /api/system/v1/dist/,
Beispielsweise https://test.staging.squeeze.one/api/system/v1/dist/.
So erreichen Sie die im Swagger UI, welche die Verwendung unserer System API vereinfacht.

Absicherung

Die System API ist mit einer einfachen Basis-Authentifizierung abgesichert. Die Zugangsdaten, ein Benutzername und ein Passwort, befinden sich in der docker-compose.yml ihrer Squeeze Installation oder sollten Ihnen mitgeteilt worden sein.
Ist dies nicht der Fall kontaktieren Sie uns bitte, damit wir Ihnen diese zukommen lassen können.

System API Anfrage authentifizieren

Swagger UI

In der Swagger UI finden Sie einen Button mit dem Namen "Authorize". Durch die Verwendung von diesem Element öffnet sich ein Modaler Dialog, in dem Sie Ihre Nutzerdaten (Benutzername und Passwort) hinterlegen können.
Suchen Sie hierfür nach der "HTTP Basic Authentication"-Methode, welche, im Regelfall, als oberste Methode aufgeführt wird.

Selbst erstellte Anfrage

Sie müssen Ihre Zugangsdaten mit der Base64-Methode enkodieren, wobei das Format der zu enkodierenden Zeichenkette Username:Passwort lautet.
So ergibt beispielsweise der Username system und das Passwort system die nach Base64-Methode enkodierte Zeichenkette c3lzdGVtOnN5c3RlbQ==.
Der Präfix "Basic" wird der enkodierten Zeichenkette beigefügt und als eine Zeichenkette dem Header, mit dem Key "Authorization", beigefügt; Beispiel: Authorization: Basic c3lzdGVtOnN5c3RlbQ==.

Wenn Sie beispielsweise alle Tenants aufgeführt haben möchten, als Teil Ihrer selbst erstellten Anfrage, sähe Ihre Anfrage wie folgt aus (den Beispielen dieser Seite folgend, unter Verwendung von cURL):

curl --location 'http://test.staging.squeeze.one/api/system/v1/tenants' --header 'Authorization: Basic c3lzdGVtOnN5c3RlbQ=='