Skip to main content
Skip table of contents

Abfrage Dokumente (getDocuments)

  • Kunde ist am Portal angemeldet

  • Kunde navigiert in sein Postfach im Portal

  • Portal fragt an EVI alle verfügbaren Dokumente an für die übergebene Kundennummer sowie dem Ab- und Bis-Datum

  • EVI ermittelt Rechnungen und Dokumente aus EVI selbst

  • Außerdem ermittelt EVI Rechnungen und Dokumente aus angebundenen Schnittstellen

    • Hiermit wird dann der Binar Code an das Portal zurückgegeben zum Anzeigen des Dokumentes.

  • EVI stellt die Metainformationen zu den ermittelten Dokumenten dem Portal zur Verfügung

  • Portal fragt anhand des documentPk über den REST-Webservice v1/documents/{documentPk}/read das Dokument aus EVI ab

    • Hiermit wird dann der Binar Code an das Portal zurückgegeben zum Anzeigen des Dokumentes

    • Portal stellt dem Endanwender das Dokument im Browser zur Verfügung

Besonderheiten Ablauf 

Die gesamte Integration richtet sich im Ablauf nach einem Muster. Dieses ist unter Interner Ablauf auf der Seite Administrationshandbuch beschrieben. Wenn sich die hier dokumentierte Funktion von diesem Muster unterscheidet, sind die Besonderheiten hier im Folgenden aufgelistet.

Folgende Suchen ermitteln die Daten, die an das Portal geliefert werden. Sollten die Daten kundenspezifisch über andere Wege ermittelt werden, ist die programmierte Suche in der Methode SC12ITCUtils.readDocument anzupassen.

Feldmapping

Request

ITC

EVI

Feldname

Datentyp

Pflicht

Bemerkung

Entität

interner Name

Feld

interner Name

Bemerkung

customerNo 

String(250) 

Ja   

Kundennummer 

Geschäftspartner

Customer

Geschäftspartnernummer

CustomerNo2


fromDate 

Date

Nein 

Ab-Datum (ISO-Format)

Dokumente

Document

Erstellungsdatum

FileSystemCreation

Zur Einschränkung der Dokumentenmenge über einen gewünschten Zeitraum

toDate 

Date

Nein 

Bis-Datum (ISO-Format)

Dokumente

Document

Erstellungsdatum

FileSystemCreation

Zur Einschränkung der Dokumentenmenge über einen gewünschten Zeitraum

Response

ITC

Feldname

Datentyp

Pflicht

Bemerkung

status 

String 

Ja 

  • DONE

  • ERROR

errorCode 

Integer 

Nein 

Liste der Fehlermeldungen (errorCodes)

documents

List<@document>

Nein 

Sonstige Dokumente 

In den Dokumenten (document) sind folgende Informationen enthalten

ITC-Portal

EVI

Feldname

Datentyp

Pflichtfeld

Bedeutung

Entität

Techn. Entitätsname

Feld

Techn. Feldname

Werte-Mapping

Kommentar

documentNo

String(250)

Ja

Dokumentennummer

Dokumente

Document

Primärschlüssel

Pk


Es geht hier um die dargestellte Nummer eines Dokuments. Wenn es keine gibt, kann auch der PK verwendet werden.

documentDate

Date

Ja

Dokumentendatum (ISO-Format)

Dokumente

Document

Erstellungsdatum

FileSystemCreation



documentType

String(40)

Ja

Dokumententyp

Dokumente

Document

Kategorie

DocumentCategoryKey


displayName

String(250)

Ja

Anzeigename

Dokumente

Document

Betreff

ShortAbstract



documentPk

String(250)

Ja

DokumentenPk

Dokumente

Document

Primärschlüssel

Pk



Im Standard werden Dokumente mit dem Dokumententyp M - E-Mail nicht an das Portal übertragen und sind dort nicht sichtbar. Welche Dokumententypen bei der Übertragung ausgeschlossen werden, kann in der Skriptbibliothek in der Methode SC12ITCUtils.getExcludedDocumentTypes hinterlegt werden.

JavaScript errors detected

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

If this problem persists, please contact our support.