=====XML-Meldungsimport ===== Über den ''XML-Meldungsimport'' (in iX-Haus im Menü unter ''Dienstprogramme'' -> ''[[schnittstellen:start|Schnittstellen]]'' -> ''Weitere Schnittstellen'') können Meldungsdaten (Meldungen und Meldungsnotizen) aus XML-Dateien aus einem vordefinierten Ordner importiert werden und nutzt DocuWare als Datenquelle. Der Import kann zudem über eine Batch-Datei gestartet werden, die aus dem iX-Haus-Ordner gestartet werden muss. Für einen regelmäßigen Import kann die Batch-Datei auch als geplante Aufgabe unter Windows eingerichtet und automatisch ausgeführt werden. Dieses Modul ist lizenzpflichtig. Bei Interesse wenden Sie sich bitte an den Vertrieb der CREM SOLUTIONS. Beachten Sie bitte, dass es auch in iX-Haus plus eine Möglichkeit besteht, Meldungen zu importieren (s. [[ix-haus_plus:ix-haus_import:parameter#meldung-import|Stammdatenimporte in iX-Haus plus]]). ===== Wie mache ich es? ===== ==== Start des Meldungsimports ==== ++++| Die Dateien werden aus dem Verzeichnis ''xmlmeldungsimport'' im iX-Haus Stammpfad importiert. Die verarbeiteten Importdateien werden in Unterverzeichnisse verschoben, um eine mehrfache Einlesung zu vermeiden. Die Meldungsdaten werden aus XML-Dateien in iX-Haus importiert. Die Datenstruktur der XML-Datei ist nachfolgend beschrieben. ===automatisierter Import=== Der Meldungsimport kann über eine Batch-Datei gestartet werden. Bei einem regelmäßigen Import kann die Batch-Datei als geplante Aufgabe unter Windows eingerichtet und automatisch ausgeführt werden. Die Batch-Datei muss aus dem iX-Haus-Ordner gestartet werden und kann folgendermaßen aufgebaut sein: exe\iexmlmeldungsimport.exe -sImpFile "d:\xmlMeldungen" -userid 85 == Parameter == ^Maske^Batch^Info^ |''ImportPfad''|''sImpFile''|Verzeichnis für die Importdateien| | ---- |''userid''|iX-Haus-Benutzer-Id des Benutzers| Alternativ kann der XML-Meldungsimport aus dem Modul ''XML Meldungsimport'' gestartet werden. Das Modul ''XML-Meldungsimport'' befindet sich im Menü unter Dienstprogramme -> ''Schnittstellen'' -> ''Weitere Schnittstellen''. Im Register ''Parameter'' geben Sie den Pfad zum Importordner an. ===manueller Import === - Speichern Sie die Importdateien, i. d. R. im Verzeichnis ''xmlmeldungsimport'' im Stammpfad von iX-Haus. - Rufen Sie das Modul ''XML-Meldungsimport'' unter Dienstprogramme > Schnittstellen > weitere Schnittstellen auf. - Geben Sie im Register ''Parameter'' den Pfad zum Importordner an. - Starten Sie den Import über die Schaltfläche ''Daten importieren''. - Im Anschluss wird ein Protokoll generiert, die Importdateien werden automatisch in das Unterverzeichnis ''importiert'' oder ''fehler'' verschoben. ++++ ==== Aktualisierung der Meldungen ==== Der XML-Meldungsimport prüft die Datensätze anhand der ''objectIdReceiver''. Wenn die ''objectIdReceiver'' schon vorhanden ist, dann wird der Datensatz aktualisiert, sonst neu angelegt. Dies gilt auch für die Notizen. ==== Historisierung ==== Die durchgeführten Importe werden in einer Historie angezeigt. Je Eintrag kann per rechter Maustaste über das Protokoll aus der Datenbank aufgerufen werden. Die Historie wird in dem Register ''Historie'' angezeigt. In der Historie werden angezeigt: • Importzeit • Benutzer ==== Protokollierung ==== ++++| Am Ende jedes Importvorgangs wird ein Protokoll erzeugt, das insbesondere eventuell aufgetretene Fehler aufzeigt. \\ In der Laufhistorie lässt sich das Importprotokoll zu jedem historisierten Lauf mit der rechten Maustaste aufrufen. === iX-Haus plus Protokollverwaltung === In der [[ix-haus_plus:protokollverwaltung:start|Protokollverwaltung]] kann für den Import die Protokollierung eingerichtet werden. Nach der erfolgreichen Einrichtung werden E-Mails vollautomatisch an den verantwortlichen User gesendet, in denen der Status jedes Laufes mitgeteilt wird. === Fehlerbehandlung === Die Fehlerbehandlung bei dem XML-Meldungsimport erfolgt über den View ''vDwMeldungsImportStat''. Dieser View muss als Teil der DocuWare-Integration vorhanden sein - er wird bei der Installation der Schnittstelle durch die Business-Unit der CREM SOLUTIONS eingerichtet. Dort werden der Status und die Fehlermeldungen des Laufs ausgegeben. Die Pflichtfelder werden in der Beschreibung der einzelnen Datenfelder dargestellt. ++++ ===== Was brauche ich dazu? ===== ====Import-Ordner==== ++++| Als Verzeichnisse werden benötigt bzw. im Stammpfad von iX-Haus angelegt: xmlmeldungsimport xmlmeldungsimport\importiert xmlmeldungsimport\fehler Damit die Dateien nicht mehrfach importieren werden können, wird im iX-Haus Stammpfad das Verzeichnis ''xmlmeldungsimport'' angelegt. In diesem Verzeichnis werden importierte Dateien abgelegt. In das Unterverzeichnis ''xmlmeldungsimport\importiert'' werden erfolgreich importierte Läufe verschoben. Im Unterverzeichnis ''xmlmeldungsimport\fehler'' werden fehlerhafte Importe abgelegt. ++++ ==== Datenstruktur für den Meldungsimport ==== Die Daten für den XML-Meldungsimport werden in Form einer XML-Datei für iX-Haus bereitgestellt. Die Daten der zu importierenden Meldungen werden in einzelne Meldungs-XML-Elemente eingegeben. ++++Beispielhafte Basisstruktur:| Meldung1 Meldung2 ++++ ===Leere XML=== ++++| ++++ Die einzelnen Meldungen werden so dargestellt: ++++| Schlüssel verloren **Beschreibung**: brauchen dringen einen neuen Schlüssel Mieter 2018-02-21T20:23:20Z Freie Notitz äöß 2018-02-21T20:23:20Z 2018-02-27T20:23:20Z Test Meldung **Beschreibung**: Test Beschreibung Mieter 2018-02-21T20:23:20Z Freie Notitz äöß 2018-02-21T20:23:20Z 2018-02-27T20:23:20Z PUBLIC 2018-02-21T20:25:08.000Z Notiz1 PUBLIC 2018-02-21T20:25:08.000Z Notiz2 PUBLIC 2018-02-21T20:25:08.000Z Notiz3 zur Meldung mit MeldungsHdrId 12345 ++++ ====Beschreibung der einzelnen Datenfelder aus der XML-Struktur==== Beschreibung der einzelnen XML-Elemente, die im XML-Element enthalten sind: ===XML-Element LIST_OF_ISSUE=== ++++| ^XML-Element^XML-Attribut^Pflicht^Datentyp^Werte^Beschreibung^ |''ISSUE''|''objectIdReceiver''|Ja|Text|12345, dw188|''ISSUE'' ist Hauptelement für die Meldung, ''objectIdReceiver'' ist die externe ID der Meldung.| |''Type''|''hash''|Ja|Ganzzahl|11111|Meldungsart HeaderId (Pflichtfeld)| |''Reason''|''-------''|Ja|Text| |Betreff oder Grund der Meldung (Pflichtfeld)| |''ReportingPerson''|''hash''|Ja|Text|P1111, H70000, U85|Melder (P + HeaderId = Person); (H + HeaderId = Hausmeister (Kreditor)); (U + UserId = User); (OBJOWNER + HeaderId = Eigentümer)| |''ReportingPersonRoleType''|''------''|Nein|Text|Wohnungseigentuemer, Hausmeister, Objekteigentuemer, iX-Haus Benutzer|Typ des Melders Person, Wohnungseigentuemer, Hausmeister (Kreditor), Objekteigentümer, iX-Haus Benutzer| |''ReportingTimestamp''|''------''|Nein|Time-stamp|2018-02-21T20:23:20Z|Meldungsdatum| |''Prop''|''objectIdSender''|Ja|Ganzzahl|12345|Objekt HeaderId (Pflichtfeld)| |''Unit''|''hash''|Nein|Ganzzahl|12345|Flächen HeaderId| |''Sector''|''hash''|Nein|Ganzzahl|12345|Kreditor Gewerk HeaderId aus der Tabelle kreGew| |''Status''|''hash''|Nein|Ganzzahl|12345|Status HeaderId| |''NoticeFree''|''------''|Nein|Text| |Hinweisfeld 1,\\ bis zu 4.000 Zeichen| |''TechnicalObject''|''hash''|Nein|Ganzzahl|12345|HeaderId Verantwortliches Team| |''FacilityTeam''|''hash''|Nein|Ganzzahl|12345|HeaderId Verantwortliches UserTeam| |''FacilityManager''|''hash''|Nein|Ganzzahl|12345|UserId Verantwortlicher Teammitglied (Pflichtfeld)| |''Prio''|''hash''|Nein|Ganzzahl|12345|HeaderId Priorität der Meldung| |''CompletingStart''|''-----''|Nein|Time-stamp|2018-02-21T20:23:20Z|Zeitpunkt Erledigen ab| |''CompletingEnd''|''-----''|Nein|Time-stamp|2018-02-21T20:23:20Z|Zeitpunkt Erledigen bis| |''InsurantCase''|''-----''|Nein|1, 0 oder true, false| |Kennzeichnet, ob es sich um einen Versicherungsschaden handelt| |''InsuranceCaseNumber''|''-----''|Nein| | |Versicherungsschadennummer| |''InsuranceCaseId''|''-----''|Nein| | |iX-Haus plus Versicherungsfall-ID| |''InsuranceKreditor''|''-----''|Nein|Ganzzahl| |Kreditor-ID (Versicherung) | |''AuftragsRelevanteBemerkung''|''-----''|Nein| | |Für den Auftrag relevante Bemerkung| |''GebaeudeNr''|''---------''|Nein| | |Gebäudenummer| |''GebaeudeteilNr''|''----------''|Nein| | |Gebäudeteilnummer| |''GeschossNr''|''-----------''|Nein| | |Geschossnummer| ++++ ===XML-Element LIST_OF_ISSUE_NOTE=== ++++| ^XML-Element^XML-Attribut^Pflicht^Datentyp^Werte^Beschreibung^ |''ISSUE_NOTE''|''objectIdReceiver''|Ja|Ganzzahl|11111|''ISSUE_NOTE'' ist Hauptelement für die Notiz, ''objectIdReceiver'' ist die externe ID der Notiz.| |''ISSUE''|''objectIdReceiver''|Ja|Ganzzahl|11111|externe ID der Meldung im Attribut ObjectIdReceiver \\ oder \\ die interne iX-Haus MeldungsId im Attribut hash| |''Type''|''-----''|Ja|Text|PUBLIC, PRIVATE|Typ der Notiz - öffentlich oder privat| |''Author''|''hash''|Ja|Text|P + HeaderId = Person.\\ H + HeaderId = Hausmeister(Kreditor).\\ U + UserId = User|Autor des Kommentars| |''ContentAsBase64''|''-----''|Ja|Text| |Notiz Text| ++++