Schnittstelle: DF - Dossier Version 2018.00

Dieses Dokument beschreibt die AbaConnect-Schnittstelle Dossier der Applikation DF .


Allgemeine Informationen

Allgemeine Informationen zur Schnittstelle.

AbaConnect Schnittstellen Information
Applikation:DF
Schnittstellen-Name:Archivierung
ID:Dossier ( Dossier )
Version:2018.00


Mögliche Export- und Import-Funktionen der Schnittstelle

Export / Import Funktionen
Export:XML
Import:XML


Zusätzliche Informationen zur Schnittstelle

Zusatzinformation

                                  Höchste Feld Revision für dieser Schnittstelle : 2



Mapping Informationen

Im Folgenden werden die Informationen über das Mapping angezeigt.

Mapping Informationen
Mapping ID:AbaDefault
Mapping Name:FileContainer
Beschreibung:



Beispiel AbaConnect XML-Struktur

Es folgt ein Beispiel einer XML Header-Struktur. Diese Information kann man auch in einer AbaConnect XML-Exportdatei anschauen, die über die Abacus AbaConnect Maske exportiert wurde.

AbaConnect XML-Struktur
<?xml version='1.0' encoding='UTF-8'?>
<AbaConnectContainer>
  <TaskCount>1</TaskCount>
  <Task>
    <Parameter>
      <Application>DF</Application>
      <Id>Dossier</Id>
      <MapId>AbaDefault</MapId>
      <Version>2018.00</Version>
      <!-- Achtung : Die Mandantennummer ist optional und bedeutet, dass die Daten nur in den definierten Mandanten importiert werden können -->
      <!-- Die Option Mandant hat nur beim Datenimport einen Einfluss. Dies kann in den AbaConnect Export-Einstellungen konfiguriert werden. -->
      <!-- Die Mandantennummer wird standardmässig nicht in die Export-Datei geschrieben -->
      <Mandant>7777</Mandant>
    </Parameter>
    <Transaction>
      <Archive mode='SAVE'>
          <!-- Hier können spezifische Datenfelder für die AbaConnect Schnittstelle definiert werden. -->
      </Archive>
    </Transaction>
  </Task>
</AbaConnectContainer>



Beispiel AbaConnect Command Line

Es folgen Beispiele für die AbaConnect Command Line. AbaConnect Command Line wird mit den Programmen abaconnectexportconsole.exe und abaconnectimportconsole.exe ausgeführt. Die AbaConnect Command Line muss direkt auf dem Abacus Server ausgeführt werden. Detaillierte Informationen über AbaConnect Command Line sind auf der Abacus Homepage zu finden. Die folgenden Beispiele dienen als Ausgangspunkt für die Erstellung einer einfachen Command Line.

AbaConnect Command Line
Export :
abaconnectexportconsole.exe "/USRuser" "/PWxxx"  "-aDF"  "-version2018.00"  "-M7777"  "-acidDossier"  "-mapidAbaDefault"  "-datamodeXML"  "-responseYES"  "-responsefileX:\response.xml"  "-exportfileX:\data.xml"

Import :
abaconnectimportconsole.exe "/USRuser" "/PWxxx"  "-aDF"  "-version2018.00"  "-M7777"  "-datamodeXML"  "-responseYES"  "-responsefileX:\response.xml"  "-importfileX:\data.xml"

N.B. : Beim Import von XML-Daten muss die Schnittstellen-ID und das Mapping auf der Command Line nicht angegeben werden. Diese Information ist in der XML Import-Datei enthalten.



Mapping Felder / Struktur

Die folgende Tabelle zeigt die Daten des Mappings in vereinfachter Form an.
Das XML-Element und der Parent-Name werden immer in Englisch geschrieben. Mit einem Mausklick auf eine Zeile werden zusätzliche Informationen angezeigt.

XML Element Name Feld Name Parent Name Typ Feld Länge Zwingend
ArchiveArchiv---Ja
    - NameArchivnameArchiveText50Ja
    - TypeArchivetypArchiveText7Ja
    - ArchiveYearJahr des ArchivsArchiveNummer4Nein
    - DescriptionDateibeschreibungArchiveText200Nein
    - ApplicationApplikationArchiveText4Nein
    - ObjectDateiobjekt-IDArchiveNummer8Nein
    - UDKUDKArchiveText26Nein
    - DocumentIdDokument-IDArchiveText36Nein
    - ArchiveIDArchive-IDArchiveText36Nein
    - HashModifiedModifikationshashArchiveText40Nein
    - ModifiedTimestampÄnderungsdatumArchiveText30Nein
    - FileSizeDateigrösseArchiveNummer12Nein
    - FileNameDateinameArchiveText250Ja
    - OriginalFileNameOriginaler DateinameArchiveText250Nein
    - ExportPreviewOnlyPreview exportierenArchiveBoolean-Nein
    SearchTermSuchbegriffeArchive--Nein
        - NameName des SuchbegriffsSearchTermText100Nein
        - ValueSuchbegriffSearchTermText10000Nein
    CategoryKategorienArchive--Nein
        - CategoryNumberNummer der KategorieCategoryNummer4Ja
        CategoryCaptionKategorie BezeichnungenCategory--Nein
            - LanguageCodeSprachcodeCategoryCaptionText5Nein
            - CategoryNameKategorie BezeichnungCategoryCaptionText50Nein
    - ExtendedIDErweiterte ID (EID)ArchiveText36Nein
    TagTagArchive--Nein
        - DisplayNameBezeichnungTagText50Nein
    FolderOrdnerArchive--Nein
        - FolderIdIdFolderGUID36Nein
        - ParentIdElternknoten-IdFolderGUID36Nein
        - IsMainIst Ziel-OrdnerFolderBoolean-Nein
        FolderCaptionsOrdner BezeichnungenFolder--Nein
            - LanguageCodeSprachcodeFolderCaptionsText5Nein
            - FolderCaptionOrdner BezeichnungFolderCaptionsText50Nein



Detaillierte Feld-Informationen

Detaillierte Beschreibung der Schnittstellen-Felder.

Archivname
XML Element Name:Name
Parent Element:Archive
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   50Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "Name")
                    

Archivetyp
XML Element Name:Type
Parent Element:Archive
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   7Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "Type")
                    

Jahr des Archivs
XML Element Name:ArchiveYear
Parent Element:Archive
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   4Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "ArchiveYear")
                    

Dateibeschreibung
XML Element Name:Description
Parent Element:Archive
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   200Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "Description")
                    

Applikation
XML Element Name:Application
Parent Element:Archive
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   4Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "Application")
                    

Dateiobjekt-ID
XML Element Name:Object
Parent Element:Archive
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   8Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "Object")
                    

UDK
XML Element Name:UDK
Parent Element:Archive
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   26Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "UDK")
                    

Dokument-ID
XML Element Name:DocumentId
Parent Element:Archive
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   36Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "DID")
                    

Archive-ID
XML Element Name:ArchiveID
Parent Element:Archive
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   36Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "AID")
                    

Modifikationshash
XML Element Name:HashModified
Parent Element:Archive
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   40Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "HashModified")
                    

Änderungsdatum
XML Element Name:ModifiedTimestamp
Parent Element:Archive
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   30Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "ModifiedTimestamp")
                    

Dateigrösse
XML Element Name:FileSize
Parent Element:Archive
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   12Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "FileSize")
                    

Dateiname
XML Element Name:FileName
Parent Element:Archive
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   250Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "FileName")
                    

Originaler Dateiname
XML Element Name:OriginalFileName
Parent Element:Archive
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   250Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "OriginalFileName")
                    

Preview exportieren
XML Element Name:ExportPreviewOnly
Parent Element:Archive
Feld Typ:Boolean (true oder false)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "ExportPreviewOnly")
                    

Suchbegriffe
XML Element Name:SearchTerm
Parent Element:Archive
Feld Typ:Linked List
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "SearchTerm")
                    

Name des Suchbegriffs
XML Element Name:Name
Parent Element:SearchTerm
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   100Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "Name")
                    

Suchbegriff
XML Element Name:Value
Parent Element:SearchTerm
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   10000Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "Value")
                    

Kategorien
XML Element Name:Category
Parent Element:Archive
Feld Typ:Linked List
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "Category")
                    

Nummer der Kategorie
XML Element Name:CategoryNumber
Parent Element:Category
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   4Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "CategoryNumber")
                    

Kategorie Bezeichnungen
XML Element Name:CategoryCaption
Parent Element:Category
Feld Typ:Linked List
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "CategoryCaption")
                    

Sprachcode
XML Element Name:LanguageCode
Parent Element:CategoryCaption
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   5Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "LanguageCode")
                    

Kategorie Bezeichnung
XML Element Name:CategoryName
Parent Element:CategoryCaption
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   50Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "Name")
                    

Erweiterte ID (EID)
XML Element Name:ExtendedID
Parent Element:Archive
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   36Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   2
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "EID")
                    

Tag
XML Element Name:Tag
Parent Element:Archive
Feld Typ:Array List
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "Tags")
                    

Bezeichnung
XML Element Name:DisplayName
Parent Element:Tag
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   50Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   2Ascii ID :   2
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "DisplayName")
                    

Ordner
XML Element Name:Folder
Parent Element:Archive
Feld Typ:Array List
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "Folder")
                    

Id
XML Element Name:FolderId
Parent Element:Folder
Feld Typ:GUID
Action Typ:Import und Export
Feld Länge:   36Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "FolderId")
                    

Elternknoten-Id
XML Element Name:ParentId
Parent Element:Folder
Feld Typ:GUID
Action Typ:Import und Export
Feld Länge:   36Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "ParentId")
                    

Ist Ziel-Ordner
XML Element Name:IsMain
Parent Element:Folder
Feld Typ:Boolean (true oder false)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "Main")
                    

Ordner Bezeichnungen
XML Element Name:FolderCaptions
Parent Element:Folder
Feld Typ:Linked List
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "Captions")
                    

Sprachcode
XML Element Name:LanguageCode
Parent Element:FolderCaptions
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   5Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "LanguageCode")
                    

Ordner Bezeichnung
XML Element Name:FolderCaption
Parent Element:FolderCaptions
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   50Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "Name")