Skip to content

AIDEX-Q Administratorhandbuch

Inhalt

Dieses Handbuch richtet sich an Systemadministratoren, deren Aufgabe darin besteht, ein AIDEX-Q System auf einem docuvita System einzurichten.

Voraussetzungen

  • ein installiertes, eingerichtetes und funktionstüchtiges docuvita System (erreichbar vom Internet)

ODER - ein gestartetes douvita-online System

Grundeinrichtung ELIS

API Key erstellen

Für die Verwendung von AIDEX-Q ist ein API-Key notwendig. Dieser kann über den AIDEX API Endpunkt https://aidex.faktur.digital/api/v1/ui/#!/Customer/customer_create_customer erstellt oder über den Endpunkt https://aidex.faktur.digital/api/v1/ui/#!/Customer/customer_read_all aus der AIDEX Datenbank gelesen werden. Obligatorisch für die Funktion des AIDEX-Q in Verbindung mit dem AICON Service ist eine eingetragene und erreihbare System-URL.

Elis Workspace einrichten

Pro Kunde wird ein eigener Workspace angelegt. Dieser bekommt die eine Benamung nach dem Schema (Kundennummer)(Matchcode)(Langbezeichnung)

elisctl>workspace create 10305 ISA Internatonal School Augsburg

Elis Queue einrichten

Pro Rechnungsart wird in der Rossum UI eine neue Queue angelegt. Die Benennung der Queue erfolgt je nach Dokumentart, z.B. “Eingangsrechnungen EU”. Einige Einstellungen für die Queue können ebenfalls vorgenommen werden. Da sich die Enstellungemöglichkeiten jederzeit ändern können, ist an dieser Stelle auf eine Dokumentation verzichtet worden. Eine technische Dokumentation kann unter https://developers.rossum.ai/docs abgerufen werden.

Schema einrichten

Das Dokumentschema kann pro Queue festgelet werden und entscheidet, welche Felder von der Rossum-AI extrahiert werden, und welche kundenspezifischen Felder angezeigt werden. Dieses Schema kann frei konfiguriert werden. Ein Startschema befindet sich im Workspace 99999_aidev Development AIDEX, welches bequem über die Konfigurationsoberfläche kopiert, bearbitet und an anderer Stelle auch wieder eingefügt werden kann.

Elis Benutzer einrichten

Für jede benutzerspezifische Queue wird ein eigener Benutzer in Elis erstellt. Dieser bekommt den Benutzernamen

(AIDEX-API-KEY)@aidex.ai
Der Benutzer wird über elisctl angelegt, da nur über elisctl ein eigens definiertes Passwort für einen Benutzer hinterlegt werden kann.
elisctl>user create -p <Passwort siehe KeePass> -q <Queue ID der neu anglegten Queue> -g annotator (AIDEX_API_KEY)@aidex.ai
Elisctl gibt nun eine Benutzer-Id aus. Diese ist durch die Angabe der Queue-Id auch bereits bei der Queue hinterlegt. Damit auch der faktur:digital Developer acount auf die Queue zureifen kann, empfielt es sich, auch diesen der neuen Queue zuzuordnen. Dies geschieht am einfachsten über die Rossum UI.

Webhook

Der Webhook trägt im wesentlichen dazu bei, dass Statusupdates von Rossum an den AIDEX gemeldet werden. Die Einrichtung erfolgt über elisctl

elisctl> webhook create -q <QueueId der neu angelegten Queue> -active True -e annotation_status --config-url https://aidex.faktur.digital/api/v1/webhook_annotation_changed --config-secret <siehe KeePass> webhook-<Queue ID der neu angelegten Queue>

Connector

Der Connector verbindet den AICON Service mit der Elis Validierungsmaske. Er reagiert auf Benutzereingaben und ist hauptsächlich für die Lieferantensuche notwendig, kann aber grundsätzlich auch für andere Anwendungen genutzt werden. Ein Connector wird, ähnlich wie der Webhook, per Queue erstellt

elisctl>connector create -q <QueueId der neu angelegten Queue> -u https://aidex.faktur.digital/api/v1/vendor_connector -t <siehe KeePass> connector-<Matchcode>

Grundeinrichtung AICON

Für die Konfiguration des AICON stehen 3 API Enpunkte auf https://aicon.faktur.digital/api/v1/ zur Verfügung

/getConfigurationTemplate

Mit diesem Endpunkt kann einfach ein Konfigurationstemplate für den AICON erstellt werden. Dazu werden alle nötigen Parameter ausgefüllt. Das Ergebnis kann z.B. kopiert und mit einem Texteditor verändert werden.

Beispiel - Fieldmappingeintrag

{
      "alternative_search_name": "",
      "fieldid": 586,
      "name": "Account"
    }
In die Eigenschaft “alternative_search_name” kann eine kommagetrennte Liste an alternativen Suchnamen eingetragen werden. Dies ist dann hilfreich, wenn Beispielsweise nach Standard Feldnamen gesucht werden soll. Der AIDEX sucht mit seinem Connector Endpunkt immer nach der eigenschaft “SellerTradePartyName” als Lieferantenname. Ist im konfigurierten System allerdings kein Feld mit diesem technischen Namen verfügbar, so kann ein “SellerTradePartyName” als alternativer Suchname für das Ersatzfeld (bspw. “VendorName”) eingetragen werden. Eine durch den AICON ausgeführte Suche würde nun ein Ergebnis finden, wenn nach “VendorName” oder “SellerTradePartyName” gesucht werden würde.

/setConfiguration

Eine mit /getConfigurationTemplate erstellte und erweiterte Konfiguration kann mit /setConfiguration in die Datenbank geschrieben werden. Ist eine entsprechende Konfiguration bereits vorhanden, wird die vorhandene Version durch die neue ersetzt. Diese Änderung ist nicht rückgängig zu machen.

/getConfiguration

Mit diesem Endpunkt kann eine bereits bestehende Konfiguration ausgelesen werden. Es empfielt sich, zuerst eine Konfiguration zu suchen bevor eine neue Konfiguration angelegt wird, um zu verhindern, dass eine eventuell bestehende Konfiguration überschrieben wird.

docuvita Konfiguration

AIDEX dll´s

Im /plugins Verzeichnis des docuvita Servers müssen sich alle notwendigen dll´s für den Betrieb des AIDEX befinden. Sie bekommen diese dll´s von faktur:digital bereitgestellt oder können diese aus dem Downloadbreich herunterladen.

Mögliche Versionskonflikte

Laden Sie sich stets das aktuelle Paket herunter. Ältere Versionen benutzen Sie bitte nur nach Absprache, da es zu Inkompatibilitäten kommen kann und der AIDEX-Q eventuell nicht richtig funktioniert.

Objecttypen

Die nachfolgenden Objekttypen müssen, sofern noch nicht vorhanden, im docuvita-System eingerichtet werden:

Adresse

Die Adressakte bezeichnet einen Lieferanten oder Kunden, enthält also jewerils ein Feld für Kunden- und Lieferantennummer. Der aktuelle Objekttyp Adresse kann unter https://h02.docuvita.online/aidextemplate/services/web angesehen und exportiert werden

Eingangsbeleg

Der aktuelle Objekttyp Eingangsbeleg kann unter https://h02.docuvita.online/aidextemplate/services/web angesehen und exportiert werden

Ausgangsbeleg

Der aktuelle Objekttyp Ausgangsbeleg kann unter https://h02.docuvita.online/aidextemplate/services/web angesehen und exportiert werden

Workflows

Folgende Workflows müssen, sofern noch nicht vorhanden, im docuvita-System eingerichtet werden:

AIDEX_EXT_Validierung

Der aktuelle Validierunsgsworkflow kann unter https://h02.docuvita.online/aidextemplate/services/web angesehen und exportiert werden. Nach dem Import sollten benutze Workflowactions neu konfiguriert werden.

AIDEX_EXT_Freigabe

Der aktuelle Freigabeworkflow kann unter https://h02.docuvita.online/aidextemplate/services/web angesehen und exportiert werden. Nach dem Import sollten benutze Workflowactions neu konfiguriert werden.

CustomValidation-Scripts

Sie benötigen das CustomValidation-Script “startEmbeddedMode”. Dieses finden Sie im AIDEX-Pack, das Ihnen zur Verfügung gestellt wurde oder Sie heruntergeladen haben. Dieses Script schreiben Sie in die docuvita dwadmin.serversettings Tabelle

insert into dwadmin.serversettings (settingid, settingkey, systemreference,  settingtext) values ([settingid],'[settingkey]',[systemreference],'[settingtext]')
|Parameter|Typ|Beschreibung| | — | — | — | |settingid|Integer|Die Ordnungzahl des Eintrages. Diese muss eindeutig sein und darf noch nicht in dieser Tabelle vorhanden sein| |settingkey|VarChar| beginnt mit ***CustomValidationScript_** gefolgt vom Namen der Funktion, die vom CustomValidationScript aufgerufen wird. Beispiel: CustomValidationScript_startEmbeddedMode| |systemreference|Integer|Die Id der Systemreference, für den dieses Script gelten soll.| |settingtext|Text|Enthält das eigentliche Script, den kompletten Inhalt der JavaScript Datei des entsprechenden Scripts|