Über das Register Einstellungen werden für die Ersteinrichtung alle serverrelevanten Parameter eingetragen. Die zur Schnittstelle erhaltenen Serverparameter werden in den entsprechenden Feldern der Server-Einstellungen hinterlegt. Diese Einrichtung muss einmalig vorgenommen werden.
Die Konfigurationen und Einstellungen werden für Produktivsystem und Testsystem separat vorgenommen. Im Feld Konfiguration und Einstellungen wählen Sie aus, ob die nachfolgenden Parameter für das Produktivsystem oder das Testsystem gelten.
Die nachfolgenden Parameter sind i. d. R. auch in der Parametermaske erläutert.
| Server-Einstellungen | |
Konfiguration und Einstellungen | Auswahl, Produktivsystem oder Testsystem. Die nachfolgenden Einstellungen gelten daher für das hier ausgewählte System. |
Link Datensynchronisation | Serveradresse zur Anbindung an das Mieterportal casavi. Die URL lautet i. d. R. https://api.mycasavi.com. |
Passwort / Secret (Synchronisation) (zwei Felder) | Passwort / Secret für die Datensynchronisation Das Passwort/Secret muss zur Kontrolle der korrekten Eingabe im zweiten Feld wiederholt eingegeben werden. Die Darstellung erfolgt aus Sicherheitsgründen verdeckt. |
Schlüssel / API-Key (Synchronisation) (zwei Felder) | Schlüssel /API-Key für die Datensynchronisation. Der Schlüssel / API-Key muss zur Kontrolle der korrekten Eingabe im zweiten Feld wiederholt eingegeben werden. Die Darstellung erfolgt aus Sicherheitsgründen verdeckt. |
| Allgemeine Datenkonfiguration | |
Objektbereich | Auswahl, Liste der Objekte, die mit casavi synchronisiert werden sollen. Übertragen werden von Meldungen nur offene seit Beginn des letzten Kalenderjahres. |
Objektbereich - Vollständige Meldungshistorie | Auswahl, Liste der Objekte, die mit casavi synchronisiert werden sollen, wobei die komplette Meldungshistorie berücksichtigt werden soll. Diese Spezialeinstellung wird i. d. R. durch Consulting der CREM SOLUTIONS konfiguriert. |
Personentyp | Auswahl der Personentypen, die mit casavi synchronisiert werden sollen. Nicht gewählte Personentypen, z. B. Interessenten, werden nicht synchronisiert. |
Dokumententyp | Auswahl, der Dokumententypen, deren Anzeige einem Zeitfilter unterliegt. Es werden i. d. R. nur die Dokumente seit Beginn des letzten Kalenderjahres synchronisiert. |
Dokumententypen ohne Zeitfilter | Auswahl, diese Dokumententypen unterliegen jedoch keinem Zeitfilter. |
Benutzerteam | Komfortpaket vorausgesetzt, kann hier eine Zuordnung von Teams konfiguriert werden. Hierüber kann der verantwortliche Benutzer pro Objekt in iX-Haus plus ermittelt werden. |
DocuWare-Filter | Filter, die vom Consultant der CREM SOLUTIONS eingerichtet werden, um spezielle Amnbindung mit DMS-System DocuWare zu konfigurieren. Alternativ muss ein Dokument Empfängertyp (P=Person, K=Kreditor), Objektnummer, EmpfängerHeaderID als Merkmale aufweisen (insbesodere bei externen Dokumenten ist dies relevant). |
Mieterportalaccount … Tage | Zahl, Anzahl der Tage vor Vertragsbeginn, wo das Portal dem Mieter schon zugänglich sein soll. |
| Sonstiges | |
iX-Haus Benutzer | dreistellige Benutzernummer, dieser Benutzer wird in iX-Haus plus bei Meldungen eingetragen, die über das casavi-Mieterportal in iX-Haus plus Meldungen eingetragen werden. Dieser Benutzer muss entsprechende Rechte für iX-Haus plus aufweisen. |
Das Register Protokoll ermöglicht die Übersicht über den Datenstrom der casavi-Schnittstelle. Die Protokolle werden nach Datum gefiltert angezeigt. Unabhängig vom Datumsfilter werden für die letzte protokollierte Abfrage Datum, Uhrzeit, Anzahl der gesendete Daten und Anzahl Fehler benannt.
Mit der Schaltfläche Protokolleinträge aktualisieren werden Protokolleinträge erneut eingelesen, um Protokolldaten anzeigen zu können, welche seit Aufruf des Protokollregisters neu hinzugekommen sind.
Interne Tipps für Consulting
Details der Protokolle liefert die Datei tmp\log\mplog.txt. Die Fehler werden aber auch schon hier in der Protokollverwaltung komfortabel mit den relevanten Infos in dem unteren Grid dargestellt.
Durch Existenz der Datei @mpSave im log-Verzeichnis wird die Schnittstelle instruiert, die XML-Dateien der Übertragung nicht zu löschen. So können die XML-Dateien im Supportfall noch kontrolliert werden. Besteht dieser Bedarf nicht mehr, kann man die Datei mit führendem Unterstrich maskieren, um unnötige Datenspeicherung zu vermeiden.
Durch Existenz der Datei @noDwSync im log-Verzeichnis wird die Schnittstelle instruiert, keine Synchronisation mit DMS-System DocuWare vorzunehmen. Das macht Sinn, wenn DokuWare gar nicht im Einsatz ist.
Für die für casavi freigegebenen Objekte werden die Daten aller aktiven Personen – Personen mit einem gültigen Vertrag - an casavi gesendet. Die Daten der über die Personentypen nicht freigeschalteten Personen werden mit dem Kenner PortalUser=False an casavi übertragen, damit diese gegebenenfalls auch aus casavi entfernt werden können. Nach dem Auszug eines Mieters wird dieser nach Ablauf der in der Konfiguration vorgegebenen Frist an casavi als gelöscht gemeldet, damit dieser ebenfalls entfernt werden kann. Sollten die Mieterdaten davor in iX-Haus anonymisiert worden sein, wird dies ebenfalls mit dem Serviceportal synchronisiert.
Wenn die Personen in der Partnerverwaltung angelegt/übertragen wurde, werden diese entsprechend übertragen. In diesem Fall werden auch die in der Partnerverwaltung eingegebenen Mitbewohner und Vertragspartner an casavi übertragen.
Es werden die folgenden Daten je Person übertragen:
Kontostände werden momentan auf casavi Seite nicht gespeichert und werden zukünftig nicht mehr übertragen. Buchungen der letzten 12 Monate werden momentan auf casavi Seite nicht gespeichert und werden zukünftig nicht mehr übertragen.
Die laut der casavi-Konfiguration freigegebenen Dokumente werden an casavi übertragen. Die nicht freigegebenen Dokumente der freigegebenen Objekte werden als gelöscht an casavi gemeldet. Dabei wird der Inhalt des Dokumentes nicht übertragen.
Werden nur dann übertragen, wenn Lizenz Objekteigentümer aktiviert ist.
Werden nur dann übertragen, wenn Lizenz Hausmeister aktiviert ist.
Es werden nur die freigegebenen Objekte übertragen.
Beim ersten Export der Daten werden alle offenen (nicht abgeschlossen oder storniert) Meldungen der freigegebenen Objekte mit dem Serviceportal synchronisiert. Sollten nur bestimmte Benutzerteams freigeschaltet sein, so werden nur die Meldungen dieser Teams oder diejenigen ohne Teamzuordnung mit casavi synchronisiert.
Je nach Meldungsart werden synchronisierte Meldungen aus iX-Haus plus in casavi zugeordnet.
Serviceportal-Sperre: keine Synchronisation
Hausmitteilung (Pinnwand): Übertragung ohne Status für die casavi-Pinnwand. Ist der Vorgang in iX-Haus plus abgeschlossen, wird der Eintrag auf der casavi-Pinnwand wieder entfernt.
Serviceportal - Objektmeldung: Meldungen werden in der Regel für Mieter individuell übertragen, eine Objektmeldung geht hingegen an alle im Objekt! Ein Mieter/Eigentümer kann selbst in casavi keine Objektmeldung generieren.
Nicht registrierte Kontakte per E-Mail benachrichtigen: Wenn der Kontakt in iX-Haus plus E-Mail-Daten aufweist, kann er per E-Mail benachrichtigt werden, während der Portalbenutzer via casavi Info bekommt.
Bei Beauftragung Notiz für Serviceportal erzeugen: Eine platzhalterunterstützte Notiz kann bei Beauftragung auf Basis einer Meldung automatisch generiert werden. Der casavi-Anwender kann somit eine Rückmeldung über eine Beauftragung/den Fortschritt bzgl. seiner Meldung bekommen.
Interne Notizen aus iX-Haus plus werden nicht nach casavi übertragen. Interne Notizen aus casavi werden nicht nach iX-Haus plus übertragen. Die beiden Notiztypen stellen generell unterschiedliche programmspezifische Datenblöcke dar und werden untereinander nicht sysnchronisiert.
Die nachfolgenden technischen Informationen sind für den normalen Benutzer i. d. R. nicht relevant, helfen aber beim Verständnis, wie mit bestimmten Datenkonstellationen verfahren wird.
Die iX-Haus – casavi Schnittstelle synchronisiert die für casavi-relevanten iX-Haus Daten mit dem casavi-Portal. Diese Synchronisation wird in regelmäßigen Abständen i. d. R. zwischen 1 und 5 Minuten aus iX-Haus (über einen Windows geplanten Task oder den iX-Haus Scheduler) aufgerufen und ruft die notwendigen casavi web services (API) auf. Die Daten werden in XML-Format geliefert und empfangen.
Nach einem einmaligen Vollexport (Übertragung aller Daten) liefert die Schnittstelle i. d .R. nur die Daten, die sich nach dem letzten Lauf verändert haben oder gelöscht wurden. Daten werden in casavi gelöscht, wenn seitens iX-Haus Objektende, Vertragsende, Anonymisierung oder Rekonfiguration der Personentypenfreischaltung vorliegt.
Interne Infos Für einzelne Datengruppen existieren jedoch eine Ausnahme, welche immer vollständig werden übertragen. Der Grund dafür ist, dass bei diesen Datensätzen kein delete-Flag (s. u.) übertragen werden kann. Beim Import von den vollständig übertragenen Datengruppen ist darauf zu achten, nicht mehr vorhandenen Datensätze zu löschen. Die betroffenen Gruppen werden im Bereich Daten erläutert.
hash wird generell die iX-Haus ID geschrieben, es sei denn die ID ist mit der Prefix ‚fremd_id_‘ eingetragen. Dann handelt es sich um die casavi id.
Die XML-Bereiche werden in folgender Reihenfolge übertragen bzw. empfangen.
1. Neue/geänderte Meldungen von casavi abholen
2. Neue/geänderte Stammdaten an casavi übertragen
COM 100
PROP 1 .. 2
PARTNER 1 .. 40
Wenn z. B. die 50 MB bei Partner 15 erreicht werden, so werden zwei Dateien an casavi gesendet.
Datei 1:
COM 100
PROP 1 .. 2
PARTNER 1 .. 15 (inklusive Dokumente)
Datei 2:
PARTNER 1 .. 15 (ohne Dokumente) PARTNER 16 .. 40 (inklusive Dokumente)
3. Neue/geänderte Meldungen an casavi übertragen
4. Lesebestätigung abholen
5. IntegrityCheck Daten an casavi senden (1 x täglich, möglichst zwischen 22 und 5 Uhr)
Daten
| Stammdaten | |||
|---|---|---|---|
| Ebene | Tag | Beschreibung | Technische Hinweise |
| 1 | DOC_GUID | Eindeutige Dokument-Id | |
| 2 | DOC_VERSION | Version des Dokuments | |
| 3 | COM | Hauptbuchungskreise | Keine Relevanz für casavi |
| 3.1 | PROP | Objekte | |
| 3.1.1 | UNIT | Flächen | Wird bei Änderungen des Vertrags oder der Flächen vollständig gesendet inkl. LEASE, LEASE_UNIT ohne die TERMs |
| 3.1.2 | LEASE | Verträge – in iX-Haus ist das die Personenebene | Wird bei Änderungen des Vertrags oder der Flächen vollständig gesendet inkl. LEASE_UNIT ohne die TERMs. In diesem Fall wird auch die UNIT gesendet. Feld debitor – Verweis auf den Hauptmieter. Somit irrelevant für casavi. Die Vertragspartner werden über Partner → Partner_Role → Lease ermittelt Ein Lease kann mehrere Partner haben (mehrere Partner_Roles können auf dieselbe LEASE verweisen). |
| 3.1.2.1 | LEASE_UNIT | Beteiligte Flächen – in iX-Haus ist das die Vertragsebene | Wird bei Änderungen des Vertrags oder der Flächen vollständig gesendet inkl. ohne die TERMs. In diesem Fall werden auch LEASE und die UNIT gesendet. |
| 3.1.2.1.1 | TERM | Vertragskonditionen - Sollbeträge, Flächengröße | |
| 3.1.3 | DOC | Objektdokumente | |
| 4 | Partner | Partner - Mieter, IX-Haus User, Objekteigentümer, Hausmeister | |
| 4.1 | Partner_Role | Rollen des Partners | Lease – Verweis auf den Mitvertrag (COM → PROP → LEASE) des Partners Ein Lease kann mehrere Partner haben (mehrere Partner_Roles können auf dieselbe LEASE verweisen) |
| 4.1.1 | DOC | Dokumente des Partners | |
| 5 | Role_Issue_Type | Meldungsarten je PartnerRolle-Typ | |
| 5.1 | RoleType | PartnerRolle-Typ | Wird immer gesendet |
| 5.1.1. | IssueType | Erlaubte Meldungsarten | Entweder leer oder vollständig bei Änderungen |
| 6 | Role_Issue_Status | Meldungsstatus je PartnerRolle-Typ | |
| 6.1 | RoleType | PartnerRolle-Typ | Wird immer gesendet |
| 6.1.1 | IssueStatus | Erlaubte Meldungsstatus | Entweder leer oder vollständig bei Änderungen |
| 7 | Role_Issue_Prio | Meldungsprioritäten je PartnerRolle-Typ | |
| 7.1 | RoleType | PartnerRolle-Typ | Wird immer gesendet |
| 7.1.1 | IssuePrio | Erlaubte Meldungsprioritäten | Entweder leer oder vollständig bei Änderungen |
| 8 | Facility_Team | iX-Haus Benutzerteams | |
| 8.1 | Partner_Role | Verweis auf die Partner_Rolle des Team-Benutzers | Entweder leer oder vollständig bei Änderungen |
| 8.1.1 | Responsible_Prop | Liste der verantwortlichen Objekte | Entweder leer oder vollständig bei Änderungen |
| 9 | Issue_Notice | Meldungshinweise | |
| 10 | Role_Issue_Sector | Gewerke je PartnerRolle-Typ | |
| 10.1 | RoleType | PartnerRolle-Typ | Wird immer gesendet |
| 10.1.1 | Issue_Sector | Erlaubte Gewerke | Entweder leer oder vollständig bei Änderungen |
| 11 | TechObjects | Technische Objekte | |
| Meldungen | |||
|---|---|---|---|
| Ebene | Tag | Beschreibung | Technische Hinweise |
| 1 | DOC_GUID | Eindeutige Dokument-Id | |
| 2 | DOC_VERSION | Version des Dokuments | |
| 3 | Issue | Vorgänge, Meldungen | |
| 4 | Issue_Note | Kommentare zu den Vorgängen, Meldungsnotizen | Besonderheit: ContentAsBase64 wird hier als PlainText übertragen, zukünftig als Base64 und HTML |
| 5 | Issue_Doc | Dokumente zu den Vorgangskommentare, Meldungsmultimedia | |
| Lesebestätigung | |||
|---|---|---|---|
| Ebene | Tag | Beschreibung | Technische Hinweise |
| 1 | DOC_GUID | Eindeutige Dokument-Id | |
| 2 | DOC_VERSION | Version des Dokuments | |
| 3 | DocInfo | Info zum Dokument | |
| 3.1 | ReadTimestamp | Lesezeitstamp | |
| IntegrityCheck Lesebestätigung | |||
|---|---|---|---|
| Ebene | Tag | Beschreibung | Technische Hinweise |
| 1 | DOC_GUID | Eindeutige Dokument-Id | |
| 2 | DOC_VERSION | Version des Dokuments | |
| 3 | IXLICENCE | iX-Haus Lizenznummer | |
| 4 | IXCUSTOMER | iX-Haus Kundenname | |
| 5 | COUT_PROP | Anzahl Objekte | |
| 6 | COUT_UNIT | Anzahl Flächen | |
| 7 | COUT_LEASE | Anzahl Verträge | |
| 8 | COUT_PARTNER_RELATION | Anzahl Parter | |
| 9 | COUT_PARTNER_DOCS | Anzahl Personendokumente | |
| 10 | COUT_ISSUES | Anzahl Meldungen | |
| 11 | COUT_ISSUE_DOCS | Anzahl Meldungsmultimedia | |