Einrichtung Build Connector - Finance 2024.2.2

Owned by von Reeken, Björn
Dec 11, 2024
5 min read

Vorwort

"Build Connector" ist eine App von NEVARIS Finance, die eine Integration mit NEVARIS Build über ODataV4 ermöglicht.
Hierbei wird im "Build Connector" ein Webdienst veröffentlicht der sogenannte "unbound actions" (Funktionen / Endpunkte) bereitstellt, über die alle notwendigen Integrations-Funktionen des abgelösten NAS-Dienstes abgebildet werden. 
Die Kommunikation / Synchronisation von Daten über den bekannten Nevis-Dienst erfolgt ebenfalls über den Webdienst.

Denken Sie daran, die Anwendung BUILD auf den aktuellen Stand 2024.2 zu updaten (auch den Server auf dem NEVIS - Integrationsdienst ausgeführt wird), bevor Sie hier fortfahren.

 

Bevor Sie die "Build Connector Einrichtung" in Finance ausführen, stellen Sie bitte sicher, dass das SSL Zertifikat und die "PublicODataBaseUrl" in der Mittelschicht korrekt eingerichtet sind und funktionieren.

 

Einrichtung

Für eine vollständige Einrichtung muss lediglich eine Verbindung zum Nevis-Dienst eingerichtet werden. Der Webdienst wird automatisch bei der Installation von "Build Connector" für Sie angelegt und veröffentlicht.  

  • Im WebClient suchen Sie bitte nach folgendem Punkt:

Alternativ können Sie auch nach "Nevis" suchen.

 

Bei der Kommunikation zwischen dem Nevis-Dienst und dem Webdienst wird die Authentifizierungsmethode "oauth2" verwendet. Hierzu benötigt der Nevis-Dienst die "Client-ID":  der in Finance eingerichteten Entra-Anwendung und den jeweiligen Geheimschlüssel:

Entra-Anwendung

 

Nevis Endpunkt

  • Tragen Sie den Namen ein, mit dem sich Finance beim Nevis-Dienst anmelden soll. (Dieser ist frei wählbar. Ein sprechender Name ist zu empfehlen)

Verbindungsinformationen

Die Verbindungsinformationen werden bei der Installation / Erstellung der Einrichtung automatisch vorbelegt. In der Regel müssen diese nicht mehr angepasst werden.

Grant type:

Gibt den "Grant type" an, der bei der Authentifizierungsmethode "oauth2" verwendet wird.

Zugriffstoken URL:

Gibt die Zugriffstoken URL an, die bei der Authentifizierungsmethode "oauth2" verwendet wird.

Scope:

Gibt den "Scope" an, der bei der Authentifizierungsmethode "oauth2" verwendet wird. Dieser muss angepasst werden, folgen Sie dem unteren Punkt.

Scope anpassen bei Verbindungen mit anderen Produkten (Build Connector, Build-Administration, BfW)

Der Scope setzt sich zusammen aus der Application ID URI der WebClient App-Registrierung und den Berechtigungen .default und offline_access:

Beispiel:  api://XXXXXX-XXXXXX-XXXXX-XXXXX/.default offline_access

Die URI finden Sie in Ihrer AppProperties.json:

Bitte beachten Sie, dass Sie diesen Scope für alle Produkte wie (BfW | Bau für Windows), Build Connector in Finance und auch in der Build-Administration nutzen. Ansonsten ist keine Kommunikation möglich. Für weitere Informationen konsultieren Sie bitte die Anleitungen der anderen Produkte.

Webdienst

Die ODataV4 Basis URL wird bei der Installation / Erstellung der Einrichtung automatisch vorbelegt. In der Regel muss diese nicht mehr angepasst werden.

Webdienst aktiviert:

Gibt an, ob der Webdienst veröffentlicht ist. Sollte dies nicht der Fall sein, dann bitte nach der Anpassung der ODataV4 Basis URL - sofern erforderlich - die Aktion “Webdienst hinzufügen“ (zu finden über Weitere Optionen > Aktionen) ausführen.

ODataV4 Basis URL:

Gibt die Basis URL an, unter der ODataV4 Endpunkte von Finance zu erreichen sind.

Webdienst Servicename:

Gibt den Servicenamen an, unter dem der Webdienst veröffentlicht ist.

ODataV4 Daten lesen URL:

Vollständige ODataV4 URL zum lesen von Daten in Finance.

ODataV4 Daten einfügen URL:

Vollständige ODataV4 URL zum einfügen von Daten in Finance.

ODataV4 Daten löschen URL:

Vollständige ODataV4 URL zum löschen von Daten in Finance.

ODataV4 Daten aktualisieren URL:

Vollständige ODataV4 URL zum aktualisieren von Daten in Finance.

ODataV4 Funktionen ausführen URL:

Vollständige ODataV4 URL zum ausführen von bestimmten Funktionen in Finance.

ODataV4 Synchronisierung URL:

Vollständige ODataV4 URL zum synchronisieren von Daten zwischen Finance und Build. (Verwendet vom Nevis-Dienst)

Bei Nevis registrieren

  • Führen Sie die Funktion "Bei Nevis registrieren" aus. Hierbei werden neben der Registrierung von Finance alle für die Kommunikation notwendigen Informationen an den Nevis-Dienst übertragen. 

  • An dem Kennzeichen "In Nevis registriert" können Sie erkennen, ob die Registrierung abgeschlossen ist.

Funktionsumfang

Bei Nevis registrieren

Registriert Finance beim Nevis-Dienst. Ist nur möglich, wenn der Webdienst veröffentlicht ist. (Ermöglicht zum Beispiel die Synchronisation von Daten zwischen NEVARIS Build und Finance)

Nevis Registrierung aufheben

Hebt die Finance Registrierung beim Nevis-Dienst auf. (Es werden keine Informationen von Nevis mehr empfangen)

Verbindung prüfen

Prüft die Verbindung zwischen Finance und dem Nevis-Dienst.

Webdienst hinzufügen

Falls nicht bereits vorhanden, wird der notwendige Webdienst erstellt und veröffentlicht. 

Webdienst entfernen

Löscht den veröffentlichen Webdienst, falls Finance nicht beim Nevis-Dienst registriert ist. 

Mögliche Fehler

Falls folgender Fehler bei der Prüfung der OData-Schnittstelle als Antwort zurück kommt, (vorher immer mit Postman eine Testabfrage stellen!) Bspw: https://FINANCESERVERMITMITTELSCHICHT:ODATAPORTDERINSTANZ/INSTANZNAMEMITODATA/api/nevaris/finance/v2.0/companies (https://finance:7048/BAU/api/nevaris/finance/v2.0/companies).

Fehler
{ "error": { "code": "Unknown", "message": "One or more errors occurred. ('.', hexadecimal value 0x00, is an invalid character. Line 9128, position 15.) CorrelationId: " } }

dann liegt das an der fehlenden Berechtigung in der App-Registrierung (AIO ..):

 

Diese bitte ergänzen.

 

 

Gehen Sie nun zurück zur Hauptseite und folgen der weiteren Anleitung
NEVARIS Finance Version 2024.2