Um die Kommunikation mit Fremdarchiven zu ermöglichen, müssen die betroffenen Archivstämme mit dem Kennzeichen "Fremdarchiv" aktiviert werden. Zusätzlich kann je Archivstamm ein eigener Exportpfad angegeben werden (siehe Feld "XML-Exportverzeichnis Fremdarchiv"). Ist dieser Pfad nicht vorhanden, gilt der Standardexportpfad.

3. Grundsätze

Sobald ein Archiv zum Abgleich mit Fremdarchiv gekennzeichnet wurde, werden sämtliche Dokumente virtuell abgelegt. Das physische Dokument muss somit immer im Fremdarchiv liegen.

4. Kommunikation mit dem Fremdarchiv

4.1. Export

Sämtliche Änderungen an den Dokumentmetadaten werden dem Fremdarchiv zur Verfügung gestellt. Um den Typ der Änderung feststellen zu können, wird dem Fremdarchiv ein Funktionskennzeichen bekanntgegeben. Die möglichen Ausprägungen sind:

Neu
Ändern
Löschen
Öffnen

und werden über die XML-Konstante "ACTION" abgebildet (siehe 5.2.13 Gruppe DOCUMENTACTION).

4.1.1. Neuanlage

Hier werden alle angebotenen XML-Datenfelder in ein XML-File geschrieben und der Pfad des physischen Dokuments. Dieses liegt immer im gleichen Pfad wie das XML-File. Das Dokument besitzt die Formatkonvention DOC-[ArchivNr]-[DokumentenNr][Extension].

Als ACTION wird der Wert NEW geschrieben.

4.1.2. Änderung

Wie Neuanlage jedoch optional mit dem physischen Dokument. Per Parameter kann hier aktiviert werden, dass nur geänderte Dokumentendaten in den XML-File geschrieben werden (default = alle möglichen Felder).
ACTION =UPDATE

4.1.3. Löschen

Beim Löschen eines Dokuments werden ebenfalls alle Dokumentendaten geschrieben.

ACTION = DELETE

4.1.4. Öffnen

Um ein Dokument aus BMDDMS öffnen zu können, muss das physische Dokument aus dem Fremdarchiv zuerst angefordert werden. Dazu wird wie bei allen anderen Actions ein XML-File generiert, der den Zielpfad des Dokuments im Parameter ‚FILENAME‘ enthalten muss.

4.1.5. XML-File

Die Struktur des XML-Files wird unterhalb genauer verdeutlicht, besteht aber im Grunde aus folgenden Teilen (Details siehe nachfolgende Beschreibung):

Key
Daten
Dokumentenzuordnungen
Funktionstyp
temp. File (nur bei Neuanlage)

4.2. Import

Der Import wird über die Servicekonstante MCS_MDDOKUMENTXMLTRANSFER_IMPORT aufgerufen und muss den Übergabeparameter "STP_FILENAME" mit dem Pfad des zu importierenden XML-Files enthalten.

4.2.1. Pflichtfelder

Beim Import muss entweder die Dokumentennummer oder das XML-ID übergeben werden. Sind beide Felder nicht enthalten oder wird das Dokument über die übergebenen Schlüssel nicht gefunden, wird eine automatische Neuanlage durchgeführt. Bei der Neuanlage müssen bestimmte Datenfelder immer fix übergeben werden, ansonsten wird diese abgebrochen (sind fett-markiert in der Beschreibung).

4.2.2. Dokumentenzuordnungen

Für alle Dokumentenzuordnungen gilt:
Sind sie beim Import nicht vorhanden, werden sie beim Import ignoriert.
Ist zumindest der Hauptordner vorhanden, werden alle Zuordnungen gelöscht und die angegebenen Daten importiert.

5. Mögliche Datenfelder

5.1. Grundstruktur

Die XML-Datei besteht aus folgender Grobstruktur:

5.2. Felder

5.2.1. Dokument-Keydaten

Beschreibung:
Enthält die Key-Daten des Dokuments. Diese müssen immer beim Zugriff auf das Dokument angegeben werden, wobei dieser entweder über die Archivnummer + Dokument oder über die externe Dokumentennummer erfolgen kann.

Feldname	XML-Name	Info
Archivnummer	ARCHIVENO	ArchivNummer des Dokuments
DokumentenNr	DOCUMENTID	Eindeutige Dokumentennummer
Externe DokumentenNr	SYNCID	Dient als externer, eindeutiger Zugriffsschlüssel des Dokuments. Dieser Keywert muss bei jedem externen Zugriff auf das Dokument angegeben werden. Alternativ ist auch ein Zugriff auf das Dokument über die Archiv- und Dokumenten-Nr. notwendig.

oder

5.2.2. Dokumentendaten

Pflichtfelder sind fett markiert:

Feldname	XML-Name	Typ	Info
Dokumentenpfad	FILENAME	A(255)	Name des physischen Dokuments. Bei der Neuanlage eines Dokuments im BMDDMS enthält dieses Datenfeld den Pfad des physischen Dokuments. Beim Öffnen des Dokuments aus BMDDMS wird in diesem Feld der Dokumentenname bekanntgegeben, der als Ablageort des physischen Dokuments für das Fremdarchiv dient. Das angeforderte temporäre Dokument wird dann von BMDDMS wieder gelöscht. Zusätzlich dient dieser Wert zur Ermittlung der Dokumentextension. Somit sollte hier immer ein gültiger bzw. vollständiger Dateiname enthalten sein.
Dokumentendatum	DATE	DATE	Datum des Dokuments
Betreff	SUBJECT	A(250)	Betreff
Kategorie	CATEGORY	A(10)	Kategorie
Belegnummer	Voucher	A(20)	Belegnummer Fibu
Belegsymbol	Vouchersymbol	A(4)	Belegsymbol Fibu
Postart	MAILTYPE	N(1)	0 = Eingang, 1 = Ausgang, 2 = Versandfertig, -1 = kein Poststück
Datenbesitzer Ansehen	SHOWDOG	A(10)	Entspricht den NTCS Datenbesitzergruppen
Freifeld N1	FREEFIELD01	N(5)	Freifeld
Freifeld NK1	FREEFIELD02	N(24,9)	Freifeld
Jahr	YEAR	N(4)	Jahr
Monat	MONTH	N(2)	Monat
Priorität	PRIORITY	N(1)	1 = Hoch, 2 = Mittel, 3 = Niedrig

5.2.3. Gruppe PERSON

Beschreibung:

Betroffene Person des Dokuments. Möglich sind hier folgende Personenarten:

Kunde
Mitarbeiter
Gesellschafter
Diverse Personen

Die Personenfelder sind bei Neuanlage Pflicht.

Feldname	XML-Name	Typ	Pflichtfeld	Info
Firma	COMPANY	N(10)	Ja
PersonenNr	PERSONNO	N(10)	Ja
Personenart	PERSONTYPE	A(2)	Notwendig wenn PersonenNr auch bei anderen Personenarten vergeben wurde.	Gibt an, um welche Art der Person (z. B. Kunde, Gesellschafter …) es sich handelt. Alle möglichen Personenarten sind nachfolgend angeführt. Dieses Feld soll dann angegeben werden, wenn keine PersonenID vorhanden oder die PersonenNr nicht eindeutig ist.
Person	PERSONNAME		Nein	Bei diesem Feld handelt es sich um einen zusätzliche Info für das XML-File und das Fremdsystem. Für die BMD NTCS hat dieses Feld keine Auswirkung, die Person wird anhand der PersonenNr ermittelt.

Mögliche Personenarten:

Personenart	Beschreibung
KL	Kunde, Lieferant
GE	Gesellschafter
MA	Mitarbeiter
DI	Diverse Person

5.2.4. Gruppe CONTACT

Beschreibung:

Betroffene Kontaktperson des Dokuments. Möglich ist hier jede Personenart (Kunde, Mitarbeiter …)
Pflichtfeld: nein

Feldname	XML-Name	Typ	Info
Firma	COMPANY	N(10)
PersonenNr	PERSONNO	N(10)
Personenart	PERSONTYPE	A(2)	Gibt an, um welche Art der Person (z. B. Kunde, Gesellschafter …) es sich handelt. Alle möglichen Personenarten sind bei der Gruppe Contact angeführt. Dieses Feld soll dann angegeben werden, wenn keine PersonenID vorhanden oder die PersonenNr nicht eindeutig ist.

5.2.5. Gruppe ADMINISTRATOR

Beschreibung:

Betroffener Sachbearbeiter (= Betreuer) des Dokuments.
Pflichtfeld: nein

Feldname	XML-Name	Typ	Info
Firma	COMPANY	N(10)	Mitarbeiterfirma
PersonenNr	PERSONNO	N(10)	Mitarbeiternummer

5.2.6. Gruppe MANAGER

Beschreibung:

Betroffener Geschäftsführer des Dokuments.
Pflichtfeld: nein

Feldname	XML-Name	Typ	Info
Firma	COMPANY	N(10)	Geschäftsführerfirma
PersonenNr	PERSONNO	N(10)	Geschäftsführernummer

5.2.7. Gruppe INSTITUTION

Beschreibung:

Betroffene Institution des Dokuments.
Pflichtfeld: nein

Feldname	XML-Name	Typ	Info
Institutionsart	INSTITUTIONTYPE	A(2)	Art der Institution. Alle Typen werden unterhalb angeführt.
Institutionsland	INSTITUTIONCOUNTRY	A(3)	2- oder 3-stelliger Land-Isocode
InstitutionsNr	INSTITUTIONNO	N(12)	Nummer der Institution

Mögliche Institutionsarten:

Institutionsart	Beschreibung
FM	Firma
FA	Finanzamt
BA	Bank
GR	Gericht
GM	Gemeinde
GK	Gesundheitskasse
SO	Sozialversicherung
GW	Gewerkschaft
MK	Mitarbeitervorsorgekasse

5.2.8. Gruppe DOCUMENTRELATIONS

Beschreibung:

Dient als Hauptgruppe für Dokumentenzuordnungen (siehe ab Punkt 5.2.9)
Pflichtfeld: nein

5.2.9. Gruppe RELATEDKEYWORDS

Beschreibung:

Enthält die Schlagwortzuordnungen dieses Dokuments.
Pflichtfeld: nein

Feldname	XML-Name	Typ	Info
Schlagwort	KEYWORD	A(100)	Schlagwortname

5.2.10. Gruppe RELATEDREFERENCES

Beschreibung:

Enthält die Dokumentenverweise dieses Dokuments. Alle Key-Informationen der verwiesenen Dokumente sind im Ordner zusammengefasst (gekapselt). Hier kann (wie bei den Keydaten) auf das Dokument entweder über die Archivnummer + Dokumentennummer oder über die SyncID zugegriffen werden.
Pflichtfeld: nein

Feldname	XML-Name	Info
Archivnummer	ARCHIVENO	ArchivNummer des Dokuments (optional wenn Externe DokumentenNr vorhanden ist)
DokumentenNr	DOCUMENTID	ArchivNummer des Dokuments (optional wenn Externe DokumentenNr vorhanden ist)
Externe DokumentenNr	SYNCID	Dient als externer, eindeutiger Zugriffsschlüssel des Dokuments. Dieser Keywert muss bei jedem externen Zugriff auf das Dokument angegeben werden. Alternativ ist auch ein Zugriff auf das Dokument über die Archiv- und Dokumenten-Nr. möglich.

5.2.11. Gruppe DOCUMENTFINANCE

Beschreibung:

Dieser Block verwaltet alle für die Fibu relevanten Daten. Diese Felder sind aber in BMD NTCS nicht sichtbar und werden nur im Fremdsystem verwendet bzw. im XML-File gespeichert.

Pflichtfeld: nein

Feldname	XML-Name	Typ	Info
Währung	CURRENCY	N(15,2)	Dreistelliges Währungskürzel
Bruttobetrag	AMOUNT_GROSS	N(15,2)	Bruttobetrag
Nettobetrag	AMOUNT_NET	N(4)	Nettobetrag
Geschäftsjahr	FINANCIALYEAR	A(3)	Aktuelles Geschäftsjahr der Fibu

5.2.12. Gruppe IMPERSONAL_ACCOUNTS

Beschreibung:

Dieser Block enthält die Sachkontenzuordnungen zum Dokument. Diese Felder sind aber in BMD NTCS nicht sichtbar und werden nur im Fremdsystem verwendet bzw. im XML-File gespeichert.

Feldname	XML-Name	Typ	Info
SachkontoNr	ACCOUNTNO	N(10)	SachkontoNr
Sachkontoname	ACCOUNTNAME	A(100)	SachkontoNam

5.2.13. Gruppe DOCUMENTACTION

Beschreibung:

Die Action entscheidet über die Funktionsweise der XML-Daten. Mögliche Action-Ausprägungen sind NEW, DELETE, UPDATE und OPEN. Die Action OPEN dient nur für BMDDMS-ausgehende Aktionen, also zum Dokument-Ansehen. Alle anderen Ausprägungen werden für ein- und ausgehende XML-Operationen unterstützt.
Pflichtfeld: ja

Feldname	XML-Name	Mögliche Werte
Aktionskennzeichen	ACTION	NEW, DELETE, UPDATE, OPEN

Siehe auch:

Doku Fremdarchiv Allgemeines

Fremdarchiv Technische Dokumentation

Fremdarchiv Implementierung