Allgemeinen Schnittstellenbeschreibung: Unterschied zwischen den Versionen
Netmax (Diskussion | Beiträge) (→Formate) |
|||
| Zeile 17: | Zeile 17: | ||
*Eine Archivierung von alten Veranstaltungen erfolgt nicht. | *Eine Archivierung von alten Veranstaltungen erfolgt nicht. | ||
| + | Das Fremdsystem generiert in bestimmten Abständen alle aktuelle Datensätze, die dann regelmäßig vom viewMAX Interface ausgelesen, validiert und importiert werden. Der Intervall zum Datenimport ist auf der viewMAX Seite frei wählbar. | ||
== Datensatzbeschreibung == | == Datensatzbeschreibung == | ||
| Zeile 49: | Zeile 50: | ||
Datum und Zeit können bei Bedarf getrennt werden | Datum und Zeit können bei Bedarf getrennt werden | ||
| − | == | + | == Import aus CSV Textdatei == |
| − | + | Der CSV Datensatz wird über das in der ''viewMAX Director/[[Configuration]]'' hinterlegte Schema beschrieben. | |
| − | === | + | === Schema Feldbeschreibung === |
| + | *InterfaceID = Eindeutige Datensatz ID (optional) | ||
| + | *RoomName = Raumname | ||
| + | *DateTimeFrom = Begin der Veranstaltung Datum und Uhrzeit (ISO, zusammengefasst) | ||
| + | *DateTimeTo = Ende der Veranstaltung Datum und Uhrzeit (ISO, zusammengefasst) | ||
| + | *DateFrom = Begin der Veranstaltung Datum | ||
| + | *DateTo = Ende der Veranstaltung Datum | ||
| + | *TimeFrom = Ende der Veranstaltung Uhrzeit | ||
| + | *TimeTo = Ende der Veranstaltung Uhrzeit | ||
| + | *Notes1 = 1. Veranstaltungsfeld | ||
| + | *Notes2 = 2. Veranstaltungsfeld | ||
| + | *Notes3 = 3. Veranstaltungsfeld | ||
| + | *Timestamp = Letzte Datensatzänderung (optional) | ||
| − | ''' | + | ===Formate=== |
| + | ''RoomName'': entspricht dem Felt InterfaceID im viewMAX Director [[Room setup]] | ||
| − | + | ''Datum und Zeit Felder'': ISO „YYYY-MM-DD hh:mm:ss“ bevorzugt | |
| − | + | ''Timestamp'': beliebig numerisch, fortlaufend | |
| − | + | ''Codierung der Datei'': UTF-8 (CSV Datei mit und ohne BOM Signature) | |
| − | + | ''CSV Feldtrennung'' [tab] ASCII 10 | |
| − | + | ===1. Beispiel: Einfaches Schema mit zwei Veranstaltungsfeldern=== | |
| − | + | ''CSV Datensatz:'' 732[tab]Raum 1[tab]2012-08-24 08:00:00[tab]2012-08-24 08:00:00[tab]netMAX GmbH[tab]Tagung | |
| − | + | ||
| + | ''Import Schema:'' 0:InterfaceID,1:RoomName,2:DateTimeFrom,3:DateTimeTo,4:Notes1,5:Notes2 | ||
| + | |||
| + | |||
| + | ===2. Beispiel: Tagesschema ohne Enddatum mit drei Veranstaltungsfeldern=== | ||
| + | |||
| + | ''CSV Datensatz:'' A45[tab]Raum B[tab]2012-09-14[tab]08:00[tab]14:00[tab]netMAX GmbH[tab]Tagung[tab]Dr. Meier | ||
| + | ''Import Schema:'' 0:InterfaceID,1:RoomName,2:DateFrom,2:DateTo,3:TimeFrom,3:TimeTo,4:Notes1,5:Notes2 | ||
| + | |||
| + | == Import aus XML Datei == | ||
| + | |||
| + | Der Import aus einer XML Datei muss individuell angepasst werden | ||
Version vom 2. Oktober 2014, 10:00 Uhr
Das viewMAX Interface ist eine Import-Schnittstelle. Datensätze können nur aus anderen Systemen übernommen werden, ein Rückkanal steht nicht zur Verfügung.
Inhaltsverzeichnis
Datentransfer
Das viewMAX Interface bietet drei Verfahren zum Datentransfer über IP Netzwerke:
- Import aus Textdatei (bevorzugt aus CSV-Dateien) über Netzwerkfreigaben oder FTP
- Import aus XML Datei (nicht empfohlen)
- SOAP via HTTP/HTTPS (erfordert individuelle Anpassungen)
- Direktes Auslesen der Daten aus fremden SQL Datenbanken (z.B. per Views; erfordert individuelle Anpassungen)
Vorausetzung für den Datenabgleich via Datei
- Für den aktuelle Tag müssen ständig alle Datensätze im Exportmedium vorhanden sein.
- Veranstaltungen die nicht weiter übermittelt werden, fehlerhafte oder nicht mehr aktuelle Datensätze, werden aus dem viewMAX System gelöscht.
- Eine Archivierung von alten Veranstaltungen erfolgt nicht.
Das Fremdsystem generiert in bestimmten Abständen alle aktuelle Datensätze, die dann regelmäßig vom viewMAX Interface ausgelesen, validiert und importiert werden. Der Intervall zum Datenimport ist auf der viewMAX Seite frei wählbar.
Datensatzbeschreibung
| Name | Anzahl | Beschreibung |
|---|---|---|
| Eindeutige ID | 1 | Wird vom Fremdsystem generiert |
| Timestamp | 1 | Zeitstempel an dem der Datensatz erstellt oder zum letzten Mal verändert wurde. |
| Name | 1 | Raumname |
| Zeitraum | 2 | Anfangs- und Endzeit |
| Text | 3 | Freie Textfelder wie z.B. Name der Veranstaltung, Beschreibung, Trainer usw. |
Je Veranstaltung nur ein Datensatz !
Datum und Zeit können bei Bedarf getrennt werden
Import aus CSV Textdatei
Der CSV Datensatz wird über das in der viewMAX Director/Configuration hinterlegte Schema beschrieben.
Schema Feldbeschreibung
- InterfaceID = Eindeutige Datensatz ID (optional)
- RoomName = Raumname
- DateTimeFrom = Begin der Veranstaltung Datum und Uhrzeit (ISO, zusammengefasst)
- DateTimeTo = Ende der Veranstaltung Datum und Uhrzeit (ISO, zusammengefasst)
- DateFrom = Begin der Veranstaltung Datum
- DateTo = Ende der Veranstaltung Datum
- TimeFrom = Ende der Veranstaltung Uhrzeit
- TimeTo = Ende der Veranstaltung Uhrzeit
- Notes1 = 1. Veranstaltungsfeld
- Notes2 = 2. Veranstaltungsfeld
- Notes3 = 3. Veranstaltungsfeld
- Timestamp = Letzte Datensatzänderung (optional)
Formate
RoomName: entspricht dem Felt InterfaceID im viewMAX Director Room setup
Datum und Zeit Felder: ISO „YYYY-MM-DD hh:mm:ss“ bevorzugt
Timestamp: beliebig numerisch, fortlaufend
Codierung der Datei: UTF-8 (CSV Datei mit und ohne BOM Signature)
CSV Feldtrennung [tab] ASCII 10
1. Beispiel: Einfaches Schema mit zwei Veranstaltungsfeldern
CSV Datensatz: 732[tab]Raum 1[tab]2012-08-24 08:00:00[tab]2012-08-24 08:00:00[tab]netMAX GmbH[tab]Tagung
Import Schema: 0:InterfaceID,1:RoomName,2:DateTimeFrom,3:DateTimeTo,4:Notes1,5:Notes2
2. Beispiel: Tagesschema ohne Enddatum mit drei Veranstaltungsfeldern
CSV Datensatz: A45[tab]Raum B[tab]2012-09-14[tab]08:00[tab]14:00[tab]netMAX GmbH[tab]Tagung[tab]Dr. Meier Import Schema: 0:InterfaceID,1:RoomName,2:DateFrom,2:DateTo,3:TimeFrom,3:TimeTo,4:Notes1,5:Notes2
Import aus XML Datei
Der Import aus einer XML Datei muss individuell angepasst werden
