Skip to main content
Skip table of contents

Administrationshandbuch (EVI-ITC)

Installation

Installationsaufwand (PT)

0,25 PT

Voraussetzungen für die Verwendung des Moduls

  • Das Modul EVI-BASIS muss lizenziert sein.

  • Das Modul EVI-ITC muss lizenziert sein.

  • In EVI muss ein dedizierter User für die Portal-Kommunikation eingerichtet werden

Technische Dokumentation

Komponentenübersicht

Skriptbibliothek

  • SC12ITCUtils

  • SC12ITCTestUtils

Übersteuerungsmöglichkeiten

Grundsätzlich können die mit dem Modul bereitgestellten Komponenten wie BPM-Prozesse, -teilprozesse, Suchen und Skriptbibliotheksmethoden übersteuert werden, um diese an individuelle Anforderungen und Bedürfnisse anzupassen.
Nach dem Einspielen eines Moduls sollte geprüft werden, ob bereits Methoden im Projekt übersteuert wurden und ob die Methodenänderung aus dem Standard im Projekt übernommen werden sollte.

Suchen

Folgende Suchen ermitteln die Daten, die an das Portal geliefert werden. Sollten die Daten kundenspezifisch über andere Wege ermittelt werden, sind die Suchen zu übersteuern und anzupassen.

  • C12ITC_BudgetBillingPlan: Diese Suche wird verwendet, um den Abschlagsplan zu einem Abrechnungsvertrag zu ermitteln.

  • C12ITC_CheckLogin: Ermittelt den Portal-Login-Datensatz zu einem Ansprechpartner im Status AKTIV.

  • C12ITC_Consumptions: Ermittelt die Verbräuche zu einer Anlage.

  • C12ITC_Contacts: Liefert alle Ansprechpartner zu einem Geschäftspartner

  • C12ITC_Context: Liefert Vertragsinformationen, die im Portal einen Überblick geben und für das Befüllen des Dashboards verwendet werden.

  • C12ITC_ContractAccount: Liefert Informationen zu einem Vertragskonto

  • C12ITC_CreditAccount: Ermittelt das Auszahlungskonto zu einem Vertragskonto

  • C12ITC_CustomerProfile: Liefert alle notwendigen Daten für ein Geschäftspartnerprofil

  • C12ITC_DebitAccount: Ermittelt das Einzahlungskonto zu einem Vertragskonto

  • C12ITC_Installation: Ermittelt die Anlagendaten

  • C12ITC_InstallationAccount: Liefert Vertragsinformationen zu einer Lieferstelle

  • C12ITC_InvoiceAddress: Ermittelt die Rechnungsadresse zu einem Vertragskonto

  • C12ITC_InvoiceRecipient: Liefert den Rechnungsempfänger zu einem Vertragskonto

  • C12ITC_MeasuringDevice: Liefert Zählerinformationen zu einem Vertragskonto

  • C12ITC_Meter: Liefert Informationen zu einer Messeinrichtung und den Zählwerken

  • C12ITC_MeterRead: Liefert die Zählerstände zu einer Messeinrichtung und den Zählwerken

  • C12ITC_Product: Liefert Produkte für den Produktvergleich

Skriptbibliotheksmethoden

Skriptklasse: SC12ITCUtils

Methodenname

Funktionalität

addCustomParameterProductSearch

Diese Methode kann genutzt werden, um weitere (projektspezifische) Suchparameter zur Produktsuche hinzuzufügen.

convertToLookup

Konvertiert einen Wert aus dem Portal in einen Nachschlagewert. Sollte eine andere Konvertierung gewünscht sein, kann diese Methode übersteuert und erweitert werden.

formatDate

Formatiert ein Datum in eine Zeichenkette. Diese Methode kann übersteuert werden, wenn ein anderes Format genutzt werden soll. Diese Anpassung ist mit ITC abzustimmen, da die Datumswerte dort verwendet werden.

getActivityEntry

Erzeugt einen IContainer der Entität "Aktivität" aus den übergebenen Informationen. Sollten die Informationen anderweitig in die Aktivität geschrieben werden, kann diese Methode übersteuert werden. Der erzeugte Datensatz ist nicht in der Datenbank gespeichert.

getC12EDITBANKAEntry

Erzeugt einen IContainer der Entität "Bankverbindung ändern" aus den übergebenen Informationen. Sollten die Informationen anderweitig in den Datensatz geschrieben werden, kann diese Methode übersteuert werden. Der erzeugte Datensatz ist nicht in der Datenbank gespeichert.

getC12INVRECIPIEntry

Erzeugt einen IContainer der Entität "Rechnungsempfänger- / Adresse ändern" aus den übergebenen Informationen. Sollten die Informationen anderweitig in den Datensatz geschrieben werden, kann diese Methode übersteuert werden. Der erzeugte Datensatz ist nicht in der Datenbank gespeichert.

getC12PORTALLOGEntry

Erzeugt einen IContainer der Entität "Portal-Login" aus den übergebenen Informationen. Sollten die Informationen anderweitig in den Datensatz geschrieben werden, kann diese Methode übersteuert werden. Der erzeugte Datensatz ist nicht in der Datenbank gespeichert. 

getC12READINGEntry

Erzeugt einen IContainer der Entität Aktivität aus den übergebenen Informationen. Sollten die Informationen anderweitig in die Aktivität geschrieben werden, kann diese Methode übersteuert werden. Der erzeugte Datensatz ist nicht in der Datenbank gespeichert.

getContactPersonEntry

Erzeugt einen IContainer der Entität "Ansprechpartner" aus den übergebenen Informationen. Sollten die Informationen anderweitig in den Ansprechpartner geschrieben werden, kann diese Methode übersteuert werden. Der erzeugte Datensatz ist nicht in der Datenbank gespeichert.

getCountryLookup

Liefert einen Nachschlagewert für das Länderkennzeichen. Diese Funktion wird für die Aktion "getKeys" verwendet und ist zu übersteuern, wenn die gewünschte Spache nicht in der aktuellen Ausprägung vorhanden ist.

getDocumentEntry

Erzeugt einen IContainer der Entität "Dokumente" aus den übergebenen Informationen. Sollten die Informationen anderweitig in das Dokument geschrieben werden, kann diese Methode übersteuert werden. Der erzeugte Datensatz ist nicht in der Datenbank gespeichert.

getErrorCodes

Liefert ein Mapping von Fehlercodes auf internationalisierte Fehlermeldungen. Sollten kundenspezifisch zusätzliche Fehlermeldungen notwendig sein, kann diese Methode übersteuert und erweitert werden.

getInitialAccountState

Liefert den Status, der in den neu anzulegenden Portal-Login-Datensatz zu schreiben ist. Standardmäßig ist der Status "AKTIV". Sollte ein anderer Status gewünscht sein, ist zuvor der entsprechende Schlüssel in der Schlüsselgruppe "Portal-Account-Status" anzulegen. In diese Methode ist dann der Primärschlüssel des angelegten Schlüssels einzutragen. Je nach Logik muss die Suche "C12ITC_CheckLogin" angepasst werden. 

getLanguageConstants

Liefert die Sprachkonstanten für die Aktion "getKeys" zurück. Sollten weitere Sprache gewünscht sein, sind diese in dieser Methode aufzunehmen.

getLastReading

Sucht den zuletzt gemeldeten Zählerstand für eine Messeinrichtung, damit gegen diesen Datensatz geprüft werden kann. Sollte die Ermittlung des Datensatzes über einen anderen Weg erfolgen, so ist dieser durch Übersteuerung der Methode zu implementieren.

getMappingFor*

Alle Methoden, die mit diesem Präfix beginnen, enthalten das Mapping von EVI-Feldern auf ITC-Webservice-Felder für jedes Objekt. Sollte eine Anpassung notwendig sein, kann die Methode Objekt-spezifisch übersteuert und angepasst werden.

getReadingByKey

Liefert den Schlüssel für den Ablesegrund. Sollte ein anderer Schlüssel gewünscht sein, kann er durch Übersteuern der Methode hinterlegt werden.

replaceLookups

Diese Methode ersetzt Nachschlagewerte aus EVI durch Werte, die das Portal verarbeiten kann. Das Standardmapping ist hier hinterlegt. Durch Übersteuerung kann das Mapping erweitert werden.

searchAddressForCustomer

Sucht einen Adressdatensatz zu einem Geschäftspartner anhand der Eingabeparameter. Diese Methode ist zu Übersteuern, wenn die Adresse über einen anderen Weg zu ermitteln ist.

setAddressForC12INVRECIPI

Beschreibt die Adressfelder auf der Entität "Rechnungsempfänger / -adresse ändern". Durch Übersteuern kann hier beispielsweise die Behandlung von Postfachadressen geändert werden.

setCustomValues

Diese Methode kann genutzt werden, um in Objekte, die an das Portal gesendet werden, kundenspezifische Werte einzusetzen oder bestehende Werte anzupassen. 

Liste der Fehlermeldungen (errorCodes)

Nummer

Meldung DE

0

Es ist ein nicht näher spezifizierter Fehler aufgetreten.

1

Es wurden nicht alle Pflichtparameter übergeben.

2

Registrierungsparameter1 existiert nicht im System.

3

Die übergebenen Parameter passen nicht zusammen.

5

Die Verbrauchsstellennummer passt nicht zur Kunden- und Vertragsnummer.

6

Die Zählernummer passt nicht zur Verbrauchsstellennummer.

7

Das Ab-Datum darf nicht nach dem Bis-Datum liegen.

8

Technischer Fehler EVI: Mapping für die Aktion nicht vorhanden.

9

Technischer Fehler EVI: Daten konnten nicht in die vorgegebene Struktur geschrieben werden.

10

Fachlicher Fehler EVI: Die Daten konnten nicht ermittelt werden.

11

Fehler beim Schreiben der Daten

Interner Ablauf

Die gesamte Integration richtet sich nach dem folgenden Muster:

  1. Start über den Zeitereignis-Rest-Webservice

    1. Dispatcher-Mechanismus erkennt anhand des Eventtyps "ag.itc.<METHODENNAME>", dass die Klasse SC12ITCUtils aufzurufen ist

      1. Sollte keine Lizenz vorliegen, wird die Methode nicht ausgeführt

    2. Aufruf wird an Klasse und Methode weitergeleitet

  2. Die aufgerufene Methode

    1. Pflichtfeldprüfung

      1. über die Methode SC12ITCUtils.checkMandatoryFields werden die Pflichtfelder geprüft.

        1. Wenn diese nicht vollständig sind, wird eine Meldung an das Portal ausgegeben

    2. Lesen von Daten

      1. Mapping über Methode getMappingForOBJEKT abfragen

      2. Lesende Methode readOBJEKT aufrufen

      3. Ausgabedaten entsprechen füllen

    3. Schreiben von Daten

      1. Schreibende Methode writeOBJEKT aufrufen

        1. Eingabedaten sammeln

        2. Container über get<ENTITAET>Entry Methode erzeugen

        3. Daten ggf. prüfen und persistieren

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close