Import/Export-Formate
Inhaltsverzeichnis
- 1 Einleitung
- 2 Import/Export-Format-Ident (IEF)
- 2.1 Schlüssel
- 2.2 Übersicht (IEF)
- 2.3 Einzelsatzanwendung (IEFE)
- 2.4 Platzhalter in den Default-Dateinamen
- 3 Felder für Import/Export-Formate (IEFDEF)
- 4 Zuordnung Import-Felder zu Formaten (IEFFEL)
- 5 Beispiele
1 Einleitung
Exporte aus IDL.KONSIS heraus sowie Importe nach IDL.KONSIS dienen sowohl als Schnittstellen zu anderen Informationssystemen als auch zur Übertragung von Daten zwischen zwei IDL.KONSIS-Installationen. Diese Funktionen stehen für einen Großteil der IDL.KONSIS-Daten zur Verfügung (s. Aktionen/Folgeanwendungen der Anwendung IMPORT).
Sowohl externe als auch interne Schnittstellen müssen definiert werden, um eine korrekte Übertragung der Daten zu ermöglichen. Diese Definition wird in IDL.KONSIS als Import/Export-Format (kurz: IEF) bezeichnet und in drei Datenbanktabellen gespeichert, zu denen es jeweils eine Übersichts- und eine Einzelsatzanwendung gibt:
- IEF
- bezeichnet den Kopfsatz eines Import/Export-Formats. Hier werden neben dem Namen des Formats allgemeingültige Eigenschaften festgelegt.
- IEFDEF
- gibt eine Übersicht, welche Felder je Objekttyp in einer Formatdefinition enthalten sein können bzw. müssen, und legt einige formatunabhängige Eigenschaften der Felder fest.
- IEFFEL
- legt fest, welche dieser Felder in einem Format enthalten sind und welche formatspezifischen Eigenschaften sie haben.
Sowohl beim Export von Daten aus IDL.KONSIS heraus als auch beim Import von Daten nach IDL.KONSIS kann das jeweilige Import/Export-Format angegeben werden.
2 Import/Export-Format-Ident (IEF)
2.1 Schlüssel
Der Schlüssel eines Import/Export-Formats besteht aus zwei Teilen:
- Der Objekttyp bezeichnet den Datenbestand, für den dieses Format gilt. Die Auswahlliste der Objekttypen ist von IDL vorgegeben und umfasst die Datenbestände, für die aktuell eine Importfunktion verfügbar ist (s.o.).
- Die Format-ID unterscheidet verschiedene Formate je Objekttyp. Hier gibt es von IDL definierte Formate, erkennbar am führenden '#', aber auch kundenindividuelle Formate können über eine eigene Format-ID definiert werden. Das von IDL zur Verfügung gestellte Standardformat heißt '#TXT'.
Der Schlüssel eines Objekttyps entspricht i.d.R. der Menü-ID der zugeordneten Pflegeanwendung. Ausnahmen gibt es im Bereich der Stammdaten, da die neuen Anwendungen (...DEF) i.d.R. Daten verschiedener Objekttypen verwalten. So umfasst z.B. die Anwendung 'SPIDEF' die Pflege der Objekttypen Spiegel (SPI), Spiegelbereiche (SBE), Spiegelspalten (SSP), Buchungsschlüsselgruppierungen (BSG) und Buchungsschlüssel (BSL). Die Objekttypen sind dann gemäß den früheren Einzelanwendungen bezeichnet.
Die in der Format-ID mit '#' beginnenden Formate werden ausschließlich durch IDL gepflegt und mit den Metadaten bei Versionswechsel ausgeliefert. Sie dürfen kundenseitig nicht verändert werden.
2.2 Übersicht (IEF)
Der Objekttyp und die Format-ID sind Pflichteingabefelder im Selektionsbereich der Übersicht 'IEF', wobei auch mehrdeutige Eingaben (Teilschlüssel+'%') zugelassen sind. So werden beide Felder beim Erstaufruf der Anwendung mit '%' (alle Daten) vorbelegt. Daneben ist die Sprache ein optionales Eingabefeld im Selektionsbereich, mit der die Sprache der in der Tabelle angezeigten Bezeichnungen gesteuert werden kann.
Die Tabelle zeigt die entsprechend selektierten Format-IDs mit ihren Eigenschaften an. Die Angaben über die letzte Änderung beziehen sich dabei nur auf Änderungen an diesen Datensätzen selbst, aber nicht auf Änderungen an den untergeordneten Formatspezifikationen.
Über die Werkzeugleiste bzw. das Kontextmenü sind die üblichen Aktionen zum Einfügen, Bearbeiten und Löschen eines Import/Export-Format-IDs sowie zum Anzeigen, Editieren und Löschen eines Hilfetexts aufrufbar. Außerdem stehen im Kontextmenü folgende Folgeanwendungen zur Verfügung:
- Zuordnung IDL-Felder zu Formaten
- Aufruf der Übersicht für die Zuordnung von IDL-Feldern zu Formaten (IEFFEL) mit Schlüsseln der markierten Formatdefinition
- Felder für IDL-Formate
- Aufruf der Übersicht für die Felder für Import/Export-Formate (IEFDEF) mit Schlüsseln der markierten Formatdefinition
2.3 Einzelsatzanwendung (IEFE)
In der Einzelsatzanwendung 'IEFE' können folgende Eigenschaften eines Formats festgelegt werden:
- Bezeichnung und Kurztext
- ermöglichen sprachabhängige Betextungen des Formats
- Format
- unterscheidet zwischen folgenden grundlegenden Typen von Import/Export-Formaten:
- 'TABLE' besagt, dass die Schnittstelle in Form einer Datenbanktabelle vorliegt. Diese Tabellen werden in der IDL.KONSIS-Datenbank durch IDL vorgegeben (s. Anwendung 'IEJOB'). Daher kann dieses Format nur beim Standardformat '#DB' angegeben werden.
- 'TXT' bezeichnet Formate, die in Form von zeilenorientierten Dateien (ein Datensatz je Zeile) vorliegen. Es kann sich dabei sowohl um Formate mit festen Feldlängen (wie beim Standardformat '#TXT') als auch um Formate mit bestimmten Trennzeichen zwischen den Feldern (CSV-Formate) handeln.
- 'XML' bezeichnet Formate im XML-Format. Diese werden zurzeit nur für einige wenige Datentypen ('KTOSAL', 'ICKTOSAL', 'ANLBEW') unterstützt. Das Standardformat '#XML' bezeichnet dabei das IDL-intern verwendete XML-Standardformat. Andere XML-Formate, wie z.B. das Format für die Schnittstelle CODA (Format-ID '#XMLCODA') müssen die Transformationsregeln zwischen diesen Formaten (xslt-Definition) im zugehörigen Hilfetext spezifizieren.
- Separator
- spezifiziert bei CSV-Formaten das Trennzeichen zwischen den Feldern. Zugelassen sind bisher Komma (,), Semikolon (;), Leerzeichen (SPACE) und das Tabulatorzeichen (TAB).
- Maskierungszeichen
- spezifiziert ein weiteres Sonderzeichen, mit dem Felder eingeschlossen und somit als ein Feld interpretiert werden, auch wenn sie das Separator-Zeichen enthalten (z.B. in Bezeichnungen). Hier wird zurzeit nur das Anführungszeichen (") unterstützt.
- Wert invertieren
- Dieses Feld hat derzeit keine Bedeutung.
- Codepage
- gibt einen abweichenden Zeichensatz der Eingabedatei an.
- Umsetzgruppe
- spezifiziert eine Umsetzgruppe (Anwendung UMS), die standardmäßig im Zusammenhang mit einem Export/Import-Format anzuwenden ist.
- Objekt-ID der Imp/Exp-Tabelle
- gibt den Namen der IDL.KONSIS-Datenbanktabelle an, in die die Daten beim Import geschrieben werden
- Default-Dateiname
- Der Default-Dateiname definiert die Vorbelegung des Dateinamens sowohl für den Import als auch für den Export in den jeweiligen Dialogen, kann dort aber auch überschrieben werden. Für den Export kann der Dateiname auch mit variablen Bestandteilen versehen werden (s.u.).
- Import-API-Relevanz
- Diese Angabe ist nur IDL-intern relevant und darf bei kundenindividuellen Formaten nicht gesetzt werden.
- XML-Prefix
- Dieses Feld wird nur für die seitens IDL definierten XML-Formate benötigt.
- Kommentar-Zeichenfolge
- Für eine Datei im Format 'TXT' kann hier spezifiziert werden, welche Zeichenfolge am Anfang einer Zeile diese Zeile als Kommentarzeile, die beim Import ignoriert werden soll, kennzeichnet, z.B. '**' für die Standardformate '#TXT'.
- Fixe Anzahl Kommentarzeilen
- Diese Zahl gibt für eine Datei im Format 'TXT' an, wie viele Zeilen am Anfang der Datei (z.B. Tabellenüberschrift) als Kommentarzeilen behandelt und somit beim Import ignoriert werden sollen.
- Exportieren Tabellen-Header / Exportieren Kommentarzeilen
- Diese Schalter werden nur beim Export ausgewertet und steuern an, ob nur die reinen Datenzeilen exportiert werden sollen oder auch die Tabellenüberschrift bzw. die weiteren Zeilen (Leerzeilen, Summenzeilen, Prüfsummen etc.).
- Import-Reihenfolge-Nummer
- Diese Angabe ist insbesondere bei der Export-Funktion von IDL.XLSLINK relevant, wenn in der Excel-Datei Export-Bezüge unterschiedlicher Tabellen enthalten sind. Dann wird anhand dieser Nummer entschieden, in welcher Reihenfolge die Daten importiert werden, um Fehler wegen zwischenzeitlich fehlender Referenzen zu vermeiden. Diese Angabe wird nur bei der Standard-Format-ID '#TXT' gepflegt.
Die Felder Invert und Codepage sind noch nicht aktiviert.
2.4 Platzhalter in den Default-Dateinamen
Zur Flexibilisierung des Pfades und/oder des Dateinamens stehen z.Zt. folgende Platzhalter zur Verfügung:
VAR | Bezeichnung |
---|---|
%KTK | Konzern/Teilkonzern |
%GES | Gesellschaft |
%UBR | Geschäftsbereich |
%ABR | Periode im Format yyyyMM |
%FAC | Datenart |
Für folgende Beispiele wird die Angabe "C:\IDL\BATCH\" für den Import-Pfad im Optionsdialog unterstellt:
- C:\XYZ\Import_Salden.ABC
- ==> C:\XYZ\Import_Salden.ABC (keine Änderung da Laufwerk und Suffix bereits angegeben und keine Platzhalter)
- KTOSAL
- ==> C:\IDL\BATCH\KTOSAL.TXT (Ergänzung Import-Pfad und Suffix, da keine Vorgabe)
- %GES\%ABR\KTOSAL_%FAC
- ==> C:\IDL\BATCH\001\200712\KTOSAL_I4.TXT (bei Vorgabe Gesellschaft = '001', Periode = '12.2007' und Datenart = 'I4')
Die Nutzung von Variablen ist abhängig von den zur Verfügung stehenden Parametern aus den Anwendungen. Nachfolgende Tabelle zeigt, welche der z.Zt. zulässigen Variablen für welches Format vom Importmenü zur Verfügung gestellt werden:
Format-ID: | KTK | GES | UBR | ABR | FAC |
---|---|---|---|---|---|
ANLBEW | X | X | X | X | X |
ANLOBJ | X | X | X | X | X |
BEL | X | X | X | X | X |
BUCH | X | X | X | X | X |
CNTSAL | X | X | X | X | X |
GESGES | X | X | X | X | X |
GESUBR | X | X | X | X | X |
ICANLBEW | X | X | X | X | X |
ICANLOBJ | X | X | X | X | X |
ICBEW | X | X | X | X | |
ICKONV | X | X | X | X | X |
ICKTOSAL | X | X | X | X | X |
KAPBEW | X | X | X | X | X |
KONBEL | X | X | X | ||
KONBUCH | X | X | X | ||
KST | X | ||||
KTK | |||||
KTKGES | X | X | X | ||
KTO | X | ||||
KTOSAL | X | X | X | X | X |
KTOUAW | X | X | X | X | |
RUEBEW | X | X | X | X | X |
SPIBEW | X | X | X | X | X |
3 Felder für Import/Export-Formate (IEFDEF)
3.1 Kurzbeschreibung
Die Anwendung "Felder für Import/Export-Formate" (IEFDEF) zeigt die nutzbaren Felder zu einem flexiblen Im-/Exportformat an. Diese Daten werden von IDL geliefert und gepflegt.
3.2 Selektionsmöglichkeiten
Über folgende Felder ist eine Selektion möglich
- Objekttyp
- Hier werden die möglichen Datenbestände zur Auswahl vorgegeben.
- Feld-ID
- Das erste Feld beschreibt, ob es sich um ein fachliches Feld aus IDL.KONSIS ('KON') oder um ein allgemeingültiges Feld ('IAR') handelt. Eingabemöglichkeiten im zweiten Feld sind gültiger Schlüssel, Teilschlüssel+% oder %. Auch die hier verwendeten Feldnamen sind IDL-seitig definiert.
- Umsetzungsobjekttyp
- Die Auswahl zeigt die Objekttypen an, für die innerhalb einer Umsetzgruppe eine Umsetzung zwischen externem und internem Schlüssel definiert werden kann. Durch Selektion nach dem Objekttyp erhält man einen Überblick, an welchen Stellen Umsetzgruppen beim Import oder Export genutzt werden können.
- Sprache
- ermöglicht die Anzeige der Feldbezeichnungen in verschiedenen Sprachen.
3.3 Tabellenspalten
In der Tabelle werden folgende Spalten angezeigt:
- Im-/Export-Objekttyp
- s. Selektionsmöglichkeiten
- Projekt-ID, Feld-ID
- s. Selektionsmöglichkeiten
- Bezeichnung, Spaltenüberschrift, Kurztext
- Betextungen des jeweiligen Feldes
- IE-Datentyp
- Bezeichnet den technischen Datentyp des Feldes, z.B. CHAR (Zeichenfolge), DATE (Datum) oder DECIMAL (Zahl mit Dezimaltrenner)
- F
- Die Feldformat-Zusatzangabe spezifiziert, ob die Buchstaben eines Feldes automatisch in Großschrift umgesetzt werden.
- E
- Der IEF-Feld-Eingabetyp zeigt an, ob es sich bei einem Feld um eine Muss- (M) oder Kanneingabe (K) handelt.
- PN
- Die Parameter-Aktivierung gibt an, ob das Feld über eine Parameterangabe (Selektionsbereich der Anwendung IMPORT, Angabe "#KEY" in einer Automatensteuerung) gesetzt werden kann und über welchen Parameter die Zuweisung erfolgt.
- IoA
- Das Initialisierungskennzeichen für optionale Attribute '*' gibt an, dass der bestehende Inhalt eines Feldes durch die Angabe '*' im Import-Datensatz gelöscht werden kann, während die Angabe leer bewirkt, dass der bisherige Inhalt des Feldes erhalten bleibt. Felder ohne das Initialisierungskennzeichen für optionale Attribute werden dagegen durch die Angabe leer auf leer gesetzt bzw. gelöscht.
- GUI Col ID
- IDL-interne Referenz zur Identifizierung des auszugebenden Feldes in der Anwendung IDL.KONSIS
- Typ, Umsetzeinschr.
- Umsetzungsobjekttyp (s. Selektionsmöglichkeiten), hier ergänzt um die Umsetzeinschränkung, wie sie in den Umsetzgruppen definiert werden können
- XML-Pfad
- IDL-interne Angabe: XML-Pfad muss eingegeben werden, wenn zum Standardformat '#TXT' auch ein Format '#XML' definiert ist.
- Property
- IDL-interne Angabe: Property muss eingegeben werden, wenn dieses Format von der Import-API verwendet wird. Das Format beschreibt die Feld-Hilfe.
4 Zuordnung Import-Felder zu Formaten (IEFFEL)
4.1 Kurzbeschreibung
Die Anwendung "Zuordnung Import-Felder zu Formaten" (IEFFEL) zeigt alle Feld-Zuordnungen zu einem ausgewählten Import/Export-Format mit ihren Eigenschaften an. Die Eigenschaften hängen vom Formattyp ab.
4.2 Selektionsmöglichkeiten
Über folgende Felder ist eine Selektion möglich
- Format
- Hier werden die möglichen Objekttypen und Format-IDs gemäß Definition in der Anwendung IEF zur Auswahl vorgegeben.
- Sprache
- ermöglicht die Anzeige der Feldbezeichnungen in verschiedenen Sprachen.
4.3 Tabellenspalten
In der Tabelle werden folgende Spalten angezeigt, die teils in der Anwendung IEFDEF, teils in der Anwendung IEFFEL selbst festgelegt werden:
- Feld-ID
- Name des referenzierten Feldes
- GUI Col ID
- IDL-interne Referenz zur Identifizierung des auszugebenden Feldes in der Anwendung IDL.KONSIS gemäß Tabelle IEFDEF
- Bezeichnung, Spaltenüberschrift
- Betextungen des jeweiligen Feldes
- Startpos. bzw. Spaltennr.
- Position des Feldes in der Import-Datei (nur für TXT-Formate): Bei festen Feldlängen ist dies die Position, an der das Feld beginnt (Startpos.), bei csv-Formaten wird hierüber die Reihenfolge der Felder festgelegt und entspricht der Anzahl vorhergehender Trennzeichen minus 1 (Spaltennr.).
- Länge
- Länge des Feldes in der Eingabedatei (nur für TXT-Formate mit festen Feldlängen)
- E
- IEF-Feld-Eingabetyp gemäß Tabelle IEFDEF (s.o.)
- PN
- IEF-Parameter-Aktivierung gemäß Tabelle IEFDEF (s.o.)
- IoA
- Initialisierungskennzeichen für optionale Attribute gemäß Tabelle IEFDEF (s.o.)
- IE-Datentyp
- Import/Export-Datentyp gemäß Tabelle IEFDEF (s.o.)
- F
- Feldformat-Zusatzangabe gemäß Tabelle IEFDEF (s.o.)
- Format-String
- dient zur Interpretation und Umsetzung von Datums- und Uhrzeitangaben in bestimmte Formate (z.B. "dd.MM.yyyy").
- Default
- Default-Wert: Hier kann ein Standardwert (z.B. Textkonstante) vorgegeben werden für den Fall, dass die Quelldatei keinen Wert liefert. Für die Übernahme der definierten Parameter (siehe Spalte PN) muss hier '#KEY' eingetragen werden. Vorrang hat der Wert, der in der Eingabedatei steht. Nur wenn in der Eingabedatei kein Wert vorhanden ist, wird der hier eingetragene Wert übernommen.
- Typ, Umsetzeinschr.
- Umsetzobjekt-Typ und Umsetzobjekt-Einschränkung gemäß Tabelle IEFDEF (s.o.)
4.4 Einzelsatzanwendung (IEFFELE)
Die zur Übersicht gehörige Einzelsatzanwendung ermöglicht die Pflege der in der Tabelle angezeigten Eigenschaften, sofern diese nicht bereits durch die Anwendung IEFDEF festgelegt sind. Dies sind
- Startposition bzw. Spaltennummer
- Feldlänge
- Faktor (derzeit nicht genutzt)
- Format-String
- Default-Wert
Als Schlüssel ist die Feld-ID anzugeben. Als Felder stehen nur die in der Tabelle IEFDEF für den jeweiligen Objekttyp spezifizierten Felder zur Verfügung, wobei mit "I" beginnende Feldschlüssel ausschließlich für das Format '#DB' reserviert sind und daher nicht für individuelle Formate verwendet werden können.
Der Format-String dient zur Umsetzung von Datumsangaben aus der Eingabedatei in das interne Format. Die einzelnen Formatteile (siehe Tabelle) können mit/ohne Trennzeichen genutzt werden. Beispiel: dd.MM.yyyy = Standard-Format für Gültig-Ab-Datum. Durch die Angabe eines Format-Strings aus mehreren Nullen (z.B. "00000") kann spezifiziert werden, dass die zugehörigen nummerischen Werte (z.B. Kontonummern) durch führende Nullen auf die angegebene Länge (im Beispiel 5 Stellen) erweitert werden. Dies ist u.a. sinnvoll, wenn in IDL.KONSIS alphanummerisch definierte Schlüssel in Fremdsystemen rein nummerisch definiert sind. In der Angabe des Format-Strings können folgende Zeichenfolgen verwendet werden:
Formatteil | Beschreibung |
---|---|
yyyy | Jahr, immer vierstellig |
MM | Monat, immer zweistellig |
M | Monat, ein- oder zweistellig |
dd | Tag, immer zweistellig |
d | Tag, ein- oder zweistellig |
HH | Stunde 00 bis 23, immer zweistellig |
H | Stunde 0 bis 23, ein- oder zweistellig |
hh | Stunde 01 bis 12, immer zweistellig |
h | Stunde 1 bis 12, ein- oder zweistellig |
mm | Minute, immer zweistellig |
a | AM/PM-Marker, ein- oder zweistellig |
5 Beispiele
5.1 Kontensalden als einfache Saldenliste in Excel
Eine Gesellschaft liefert ihre Kontensalden in einer Excel-Tabelle, die nur die Spalten Kontonr. und Betrag enthält. Diese Excel-Tabelle kann im CSV-Format gespeichert und so für den Import verwendet werden.
Dazu ist in IEF ein Format mit folgenden Attributen zu definieren:
Spalte | Wert |
---|---|
Import/Export Objekttyp | KTOSAL |
Import/Export Format-ID | SUMSAL-117 |
Bezeichnung | Summensaldenliste von Ges. 117 |
Kurztext | SumSal 117 |
Formattyp | TXT |
Separator | ; |
Default-Dateiname | D:\IDL\import\von_117\SUMSAL.csv |
Fixe Anzahl Kommentarzeilen | 1 (für Tabellenüberschrift) |
Format-ID, Betextungen und Default-Dateiname sind hier mit Beispielnamen versehen und können beliebig gewählt werden. Diesem Format sind in IEFFEL folgende Felder zuzuordnen:
Feld ID | Spaltennr. | Default-Wert |
---|---|---|
KON / K003-K010-KTOM | 1 | |
KON / K003-WERT-LW | 2 | |
KON / K003-GES | #KEY | |
KON / K003-K011-FAC | #KEY | |
KON / K003-ABR-MON-JAHR | #KEY |
Das heißt, die Import-Datei enthält, wie oben genannt, nur die Angaben für Kontonummer und Betrag in Landeswährung. Die weiteren Angaben der resultierenden Datensätze in der Datenbank ergeben sich wie folgt:
- Die Schlüssel für Gesellschaft, Datenart und Periode werden beim Import als Parameter (z.B. im Selektionsbereich der Anwendung IMPORT) angegeben. Ggf. kann hier auf dieselbe Art auch ein Geschäftsbereich angegeben werden.
- Der Kontenplan wird durch die Gesellschaft oder die Datenart bestimmt.
- Das Soll/Haben-Kennzeichen ergibt sich aus dem Bilanz/GuV-Kennzeichen des Kontos.