EVI-Schleupen Auslösen von Änderungsvorgängen EVI2Schleupen

Allgemeine Funktionsweise

In EVI ausgelöste Änderungsvorgänge wie bspw. eine Zählerstandmeldung, Kündigung eines Vertrages etc. werden über die Eventsteuerung (Events (Admin)) in EVI zur Verarbeitung an Drittsysteme bereitgestellt.

Sobald die Schleupen-Integration über das Modul EVI-Schleupen eingerichtet ist, lauscht diese auf eingehende Events und überträgt entsprechende Änderungen an definierte und durch Schleupen zur Verfügung gestellte Webservices. Hierbei wird die Schleupen REST-API angesprochen.

Die übertragenen Änderungen werden von der Schleupen CS.VA entgegengenommen und automatisch oder nach Prüfung durch einen Anwender für die weitere Verarbeitung freigegeben.

Voraussetzungen

Zur Verarbeitung von Änderungsvorgängen aus EVI in Richtung Schleupen muss deas Modul EVI-Schleupen eingespielt, lizenziert und konfiguriert sein.
Um die Änderungsvorgänge in EVI bedienen zu können, müssen die Prozesse des Moduls EVI-SLP lizenziert und konfiguriert sein
Die Kommunikation zwischen den EVI-Applikationsservern und den Schleupen CS.VA-Systemen erfolgt verschlüsselt via https. Entsprechende Verschlüsselungszertifikat, Firewall- und Netzwerkregelungen sind projektindividuell mit der IT des Auftraggebers, Schleupen, CURSOR und ggf. dritten IT-Dienstleistern oder Rechenzentrumsbetreibern abzustimmen.
Sofern das anzusprechende Schleupen CS.VA System in einem ISO 27001 zertifiziertem Rechenzentrum betrieben wird, sind entsprechende Zertifikate erforderlich.
Da die Übertragung einer Stammdatenänderung EVI2Schleupen noch nicht vollumfänglich umgesetzt ist, ist in EVI die globale Variable C12MasterDataChange_IsActive = false zu setzen und damit die Funktionsweise zu deaktivieren

Voraussetzungen Schleupen

Versionsvoraussetzung Schleupen: Schleupen.CS Basissystem ab Winterversion WV21
Lizenzierung Schleupen: Für die Ausführung der über die Webservices ausgelösten Vorgänge wird der Vorgangsdatenaustausch der CS.VA Vertragsabrechnung sowie der Vertragsdatenmanager von CS.NM_Netzzugangsmanagement genutzt. Es wird eine entsprechende Lizenz für diese Module benötigt.

Webservice

Schleupen REST-API: Benutzerdokumentation REST-API Schleupen
Die Authentifizierung erfolgt via Basic-Authentifizierung. Entsprechend sind Benutzername und Kennwort für das jeweilige Schleupen-System anzufordern und in den jeweiligen globalen Variablen in EVI zu hinterlegen
- User zur Anmeldung am Webservice: globale Variable: C12SchleupenWebserviceUserName
- Passwort zur Anmeldung am Webservice: globale Variable: C12SchleupenWebserviceUserPassword
Die einzelnen Endpunkte der zu realisierenden Webservice werden unter folgender Basis-URL bereitgestellt: http://{Servername}/Schleupen/IVP/SchnittstelleProzessanbindung
- Die Basis-URL ist in der globalen Variable C12SchleupenBaseUrl entsprechend unter Angabe der in den Zertifikaten definierten Endpunkte anzugeben bspw. https://cursor.demo.schleupen.cloud:443
- Der Methodenpfad wird in der globalen Variable C12SchleupenMethodPath definiert und ist meist gleich bleibend (/Schleupen/IVP/SchnittstelleProzessanbindung)
Der jeweilige Prozessendpunkt bspw. http://{Servername}/Schleupen/IVP/SchnittstelleProzessanbindung/Person ist in der jeweils zur Übertragung aus EVI vorgesehenen Skriptklasse definiert.
Im Aufruf sind entsprechend weitere Header_informationen mit zu übergeben. Diese sind je System entsprechend anzupassen und können in den aufgeführten Variablen in EVI hinterlegt werden.
- X-Datasource:
  - globale Variable C12SchleupenDataSource
  - Angabe des Datenquellennamens im Schleupen.CS System
  - Beispiel: X-Datasource: Echtdatenbank
- X-Mandant:
  - globale Variable C12SchleupenMandant
  - Angabe des Kürzels des Mandanten im Schleupen.CS System
  - Beispiel: X-Mandant: 0001
- Datasource und Mandant werden auch für die Schleupen-Aufrufintegration verwendet.

Änderungsvorgänge

Nach der Bearbeitung des Geschäftsprozesses in EVI wird ein EVI-EVENT zur asynchronen Weiterverarbeitung erzeugt. Je Nach Geschäftsprozess können die zu übertragenen Daten aus der jeweiligen Transaktionstabelle entnommen werden.
Die Schnittstelle in EVI stellt entsprechende Logiken zur Verfügung, welche auf die o.g. Events reagieren und auf Grundlage der im Event definierten Transaktionstabelle die jeweiligen Daten sammelt und an den jeweiligen Schleupen Webservice überträgt.
Auf die Neuanlage eines Events wird reagiert und der jeweilige Prozess zur Datenselektion und Aufruf des Webservice getriggert
Nach der Verarbeitung des Webserviceaufruf wird das jeweilige Event mit einem Eventresult (OK /ERROR) quitiert. In dem EventResult werden die Responses aus dem jeweiligen Webservice aufgenommen (Error, Strukturdaten).
Im Antwort-Kopf wird im Element „Location“ die relative Adresse zur Abfrage des Vorgangsstatus übermittelt (vgl. Kapitel 4.4.6 der Schleupen REST-API Dokumentation /Schleupen/IVP/SchnittstelleProzessanbindung/Vorgangsstatus/{Id_des_Vorgangs})
Der Wert Location wird zunächst in das EventResult, Feld Description.C12EventResult übernommen. Eine Abfrage des Status über o.g. Prozess noch kein Bestandteil der Standard-Integration.
Im Fehlerfall wird der auslösende User über das Benachrichtigungssystem informiert
Die Stammdatenänderung in Schleupen erwartet immer den aktuellen Zustand des Datensatzes. Nicht gelieferte Informationen werden als gelöscht / geleert betrachtet und entsprechend verarbeitet. Die Information zur eigentlichen Daten-Änderung (Änderungsprotokoll) ist nicht relevant.
Durch eine übertragene Änderung nach Schleupen wird in Schleupen CS.VA eine Änderung ausgelöst, die wiederum über die REST API an EVI zurück gesendet gesendet wird.

Folgende Änderungsvorgänge stehen im Modul EVI-Schleupen zur Verfügung.

Änderungsvorgang	Mapping	Schleupen Webservice	Aufrufadresse (Beispiel)	Beschreibung	EVI Prozess	Auslösendes EVI-Event
Zählerstandsmeldung	Importieren von Zählerständen	Importieren von Zählerständen	http://{Servername}/Schleupen/IVP/SchnittstelleProzessanbindung/Zaehlerstandsimport	Prozess zur Übermittlung eines in EVI gemeldeten Zählerstandes. Bei einer Zählerstandsmeldung in EVI wird ein Event SLP_CREATE_METERREADING ausgelöst, welches auf die relevanten Daten in der Transaktionstabelle C12READING verweist. Ein Event beinhaltet immer genau eine Zählerstandsmeldung und ruft den jeweiligen Webservice in Schleupen auf.	Zählerstand erfassen	SLP_CREATE_METERREADING
Abschlagsänderung	Änderung von Abschlägen	Änderung von Abschlägen	http://{Servername}/Schleupen/IVP/SchnittstelleProzessanbindung/Abschlagsaenderung	Prozess zur Übermittlung eines in EVI geänderten Abschlagswertes. Bei Änderung eines Abschlages in EVI wird ein Event CHANGE_BILLINGPLAN ausgelöst, welches auf die relevanten Daten in der Transaktionstabelle C12EDITAPAY verweist. Ein Event beinhaltet immer genau eine Abschlagsänderung und ruft den jeweiligen Webservice in Schleupen auf.	Abschlag ändern	CHANGE_BILLINGPLAN
Auflösung von Verträgen	Auflösung von Verträgen	Vertragsaufloesung	http://{Servername}/Schleupen/IVP/SchnittstelleProzessanbindung/Vertragsauflösung	Prozess zur Übermittlung eines in EVI gekündigten Vertrages. Bei einer Vertragskündigung in EVI wird ein Event PC_CANCEL_BILLINGCONTRACT ausgelöst, welches auf die relevanten Daten in der Transaktionstabelle C12CANCELLATION verweist. Ein Event beinhaltet immer genau eine Kündigung und ruft den jeweiligen Webservice in Schleupen auf.	Kündigung	PC_CANCEL_BILLINGCONTRACT
Wechsel von Tarifen / Produktwechsel	.Wechsel von Tarifen vSprint24	Wechsel von Tarifen	http://{Servername}/Schleupen/IVP/SchnittstelleProzessanbindung/Tarifwechsel	Prozess zur Übermittlung eines in EVI durchgeführten Produktwechsels zu einem bestehenden Vertragsverhältnis. Bei Annahme eines Angebotes Produktwechsel wird in EVI ein Event CHANGE_PRODUCT ausgelöst, welches auf die relevanten Daten in der Transaktionstabelle C12ProductChange verweist. Ein Event beinhaltet immer genau einen Produktwechsel und ruft den jeweiligen Webservice in Schleupen auf.	Privatkunden - Produktwechsel	PC_CHANGE_PRODUCT

Monitoring

Jede Übertragung EVI2Schleupen wird in Schnittstellenübersicht zum monitoring überwacht. Die Ergebnisse werden auch im Systemmonitoring aufgeführt

Installation

Die Installation der Integration EVI-Schleupen Datenaktualisierung bei Änderung Schleupen2EVI beschränkt sich seitens EVI auf

das Einspielen des Modulpakete EVI-Schleupen und die jeweilige Konfiguration
die Herstellung des Verbindungsaufbaus zwischen den jeweiligen Serversystemen. Diese ist im wesentlichen abhängig von der IT-Infrastruktur des Kunden

Installationsaufwand (PT)

0,25 PT für Modulimport EVI +

0,5 ~ 1 PT für Abstimmungen mit den jeweiligen IT Abteilungen und Herstellung der Verbindung der Systemumgebungen.

Updateaufwand (PT)

Voraussetzungen für die Verwendung des Moduls

Für die Verwendung des Moduls ist eine Verbindung zu dem Schleupen-System des Kunden erforderlich, dieses ist von dessen IT in Zusammenarbeit mit Schleupen bereitzustellen.

Eine weitere Voraussetzung ist die Lizenzierung des C1-Moduls C12SCHLEUPEN

Da die Übertragung einer Stammdatenänderung EVI2Schleupen noch nicht vollumfänglich umgesetzt ist, ist in EVI die globale Variable C12MasterDataChange_IsActive = false zu setzen und damit die Funktionsweise zu deaktivieren

Update

Technische Dokumentation

Komponentenübersicht

Prozesse

C12SCHLEUPEN_Evi2Schleupen

Prüft nach der Neuanlage von Events (C0Event) ob ein für die Schleupen Integration relevantes dabei ist (SC12SCHLEUPENCallUtils.isStartCheckEvi2Schleupen(IContainer event)). Ist das der Fall, wird die Skriptbibliothek angesteuert (SC12SCHLEUPENCallUtils.startEvi2Schleupen(IContainer event)).

Skriptbibliothek

SC12SCHLEUPENCallUtils

Die Methode isStartCheckEvi2Schleupen wird in der Startbedingung des Prozesses C12SCHLEUPEN_Evi2Schleupen aufgerufen und entscheidet, ob das erstellte Event für die Schnittstelle relevant ist.

Ist die Prüfung der Startbedingung positiv, wird die Einstiegsmethode startEvi2Schleupen aufgerufen. Diese verzweigt abhängig vom Event und führt dann jeweils den folgenden Ablauf durch:

Suchen der im Event benannten Daten
Ausgehend davon sammeln und mappen aller relevanten Daten.
Ausführen des REST Aufrufs

Dabei sind die Methoden je Event über einen Methodenprefix gruppiert. read<Entity> Methoden sammeln jeweils Daten. <Prefix>Add<Entity>Data Methoden mappen jeweils die Daten einer Entität in die Schleupen Struktur.

Globale Variablen

C12SchleupenBaseUrl

Die Basis-URL, bereits beschrieben unter Webservice.

C12SchleupenDataSource

Angabe des Datenquellennamens im Schleupen.CS System, bereits beschrieben unter Webservice.

C12SchleupenHerkunft

Optionale Angabe der Herkunft zur Identifikation der Vorgänge, welche aus dem Fremdsystem übernommen wurden, wird so an Schleupen übermittelt.

C12SchleupenMandant

Angabe des Kürzels des Mandanten im Schleupen.CS System, bereits beschrieben unter Webservice.

C12SchleupenMethodPath

Der Methodenpfad Anteil der REST URL, bereits beschrieben unter Webservice.

C12SchleupenRestUserName

Das Kürzel des Schleupen-Benutzers für eingehende REST-Aufrufe, um zu vermeiden, dass Änderungen von Schleupen wieder direkt zurück geschickt werden.

C12SchleupenWebserviceUserName

User zur Anmeldung am REST Service, bereits beschrieben unter Webservice.

C12SchleupenWebserviceUserPassword

Passwort zur Anmeldung am REST Service, bereits beschrieben unter Webservice.

Administrationsmöglichkeiten

Neben den Globalen Variablen ist keine weiter Administration notwendig.

Übersteuerungsmöglichkeiten

Info über generelle allgemeine Übersteuerungsmöglichkeiten

Teilprozesse, ... → ausformulieren

Methodenname	Methodensignatur	Funktionalität
isStartCheckEvi2Schleupen	SC12SCHLEUPENCallUtils.isStartCheckEvi2Schleupen(IContainer event)	Hier könnten einzelne Events ausgeschlossen werden, wenn diese nicht genutzt werden sollen (siehe auch startEvi2Schleupen)
startEvi2Schleupen	SC12SCHLEUPENCallUtils.startEvi2Schleupen(IContainer event)	Hier könnten einzelne Events ausgeschlossen werden, wenn diese nicht genutzt werden sollen (siehe auch isStartCheckEvi2Schleupen)

Interner Ablauf

technische Ablaufbeschreibung als BPM Prozessdiagramm od. textuelle Beschreibung