Schnittstelle: HRMS - ObjectDefinitionData Version 2017.10

Dieses Dokument beschreibt die AbaConnect-Schnittstelle ObjectDefinitionData der Applikation HRMS .


Allgemeine Informationen

Allgemeine Informationen zur Schnittstelle.

AbaConnect Schnittstellen Information
Applikation:HRMS
Schnittstellen-Name:Gegenstandsdefinitionen
ID:ObjectDefinitionData ( ObjectAdministration )
Version:2017.10
Status:Productiv


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 : 0



Mapping Informationen

Im Folgenden werden die Informationen über das Mapping angezeigt.

Mapping Informationen
Mapping ID:AbaDefault
Mapping Name:Gegenstandsdefinitionen
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>HRMS</Application>
      <Id>ObjectDefinitionData</Id>
      <MapId>AbaDefault</MapId>
      <Version>2017.10</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>
      <ObjectDefinitionData mode='SAVE'>
          <!-- Hier können spezifische Datenfelder für die AbaConnect Schnittstelle definiert werden. -->
      </ObjectDefinitionData>
    </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"  "-aHRMS"  "-version2017.10"  "-M7777"  "-acidObjectDefinitionData"  "-mapidAbaDefault"  "-datamodeXML"  "-responseYES"  "-responsefileX:\response.xml"  "-exportfileX:\data.xml"

Import :
abaconnectimportconsole.exe "/USRuser" "/PWxxx"  "-aHRMS"  "-version2017.10"  "-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
ObjectDefinitionDataGegenstandsdefinition---Ja
    - IdInterne IdObjectDefinitionDataNummer14Ja
    - NumberNummerObjectDefinitionDataNummer10Ja
    - ParentIdÜbergeordnete Kategorie (Id)ObjectDefinitionDataNummer14Ja
    - DesignationBezeichnungObjectDefinitionDataText50Ja
    - DescriptionBeschreibungObjectDefinitionDataText50Ja
    - BehaviourAtDepartureVerhalten bei AustrittObjectDefinitionDataNummer1Ja
    - KeepsCopiesExemplare führenObjectDefinitionDataBoolean-Ja
    - CopyListExpandableAtEntryExemplarliste beim Buchen erweiterbarObjectDefinitionDataBoolean-Ja
    - NumberOfCopiesAnzahlObjectDefinitionDataNummer10Ja
    - NotesNotizenObjectDefinitionDataText-1Ja
    TimeAxisZeitachseObjectDefinitionData--Nein
        - TimeAxisDateZeitachseTimeAxisDatum-Ja
        - IsActiveZeitachse aktivTimeAxisBoolean-Ja
        - TypeOfUsageFeesArt der BenutzungsgebührTimeAxisNummer1Ja
        - UsageFeeBenutzungsgebührTimeAxisNummer6Ja
        - TypeOfDepositArt des DepotsTimeAxisNummer1Ja
        - DepositDepotTimeAxisNummer6Ja
    CopyExemplarObjectDefinitionData--Nein
        - CopyNumberExemplarnummerCopyNummer12Ja
        - CopyIdExemplar-IDCopyText100Ja
        - IsActiveAktivCopyBoolean-Ja
        - DesignationBezeichnungCopyText100Ja
        AnlageAnlageCopy--Nein
            - AssetNumberAnlagenummerAnlageNummer10Ja
        FreeFieldValuesCopyWerte der freien FelderCopy--Nein
            FreeFieldValueCopyWerte der freie FelderFreeFieldValuesCopy--Nein
                - IdIdFreeFieldValueCopyText-1Ja
                - ValueWertFreeFieldValueCopyText-1Ja
    FreeFieldsFreie FelderObjectDefinitionData--Nein
        FreeFieldDefinitionDefinitionFreeFields--Nein
            - FieldNumberFeldnummerFreeFieldDefinitionNummer2Ja
            - SortOrderReihenfolgeFreeFieldDefinitionNummer2Ja
            - MandatoryZwingendFreeFieldDefinitionBoolean-Ja
            - BookableBebuchbarFreeFieldDefinitionBoolean-Ja
            - InheritanceToCopiesVererbung auf ExemplareFreeFieldDefinitionBoolean-Ja
        FreeFieldValuesWerte der freien FelderFreeFields--Nein
            FreeFieldValueWerte der freie FelderFreeFieldValues--Nein
                - IdIdFreeFieldValueText-1Ja
                - ValueWertFreeFieldValueText-1Ja
    AnlageAnlageObjectDefinitionData--Nein
        - AssetNumberAnlagenummerAnlageNummer10Ja
    DossierDossierObjectDefinitionData--Nein
        - NameName des DossiersDossierText50Nein
        - DescriptionBeschreibungDossierText200Nein
        - DocumentIDEindeutige Nummer des DokumentsDossierText36Nein
        - FileNameDossierText-1Nein
        - OriginalFileNameUrsprünglicher DateinameDossierText-1Nein
    - ImageFileNameFotoObjectDefinitionDataBinär-Nein



Detaillierte Feld-Informationen

Detaillierte Beschreibung der Schnittstellen-Felder.

Interne Id
XML Element Name:Id
Parent Element:ObjectDefinitionData
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   14Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   1
Beschreibung:
Die interne Id ist eindeutig und kann nicht mehr geändert werden.  Ist die ID 0, so wird automatisch eine neue ID generiert.
(Den internen Feld ID für dieses Element ist "Id")

Nummer
XML Element Name:Number
Parent Element:ObjectDefinitionData
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   10Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   2
Beschreibung:

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

Übergeordnete Kategorie (Id)
XML Element Name:ParentId
Parent Element:ObjectDefinitionData
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   14Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   3
Beschreibung:

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

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

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

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

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

Verhalten bei Austritt
XML Element Name:BehaviourAtDeparture
Parent Element:ObjectDefinitionData
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   1Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   6
Beschreibung:

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

Exemplare führen
XML Element Name:KeepsCopies
Parent Element:ObjectDefinitionData
Feld Typ:Boolean (true oder false)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   7
Beschreibung:
Werden Exemplare geführt, so muss jedes mögliche Exemplar in der Exemplarliste erfasst werden. Exemplare sind durch die Vergabe einer ID/Nummer eindeutig identifizierbar. Die Exemplarliste lässt sich, falls gewünscht, beim Buchen erweitern.
(Den internen Feld ID für dieses Element ist "KeepsCopies")

Exemplarliste beim Buchen erweiterbar
XML Element Name:CopyListExpandableAtEntry
Parent Element:ObjectDefinitionData
Feld Typ:Boolean (true oder false)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   8
Beschreibung:

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

Anzahl
XML Element Name:NumberOfCopies
Parent Element:ObjectDefinitionData
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   10Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   9
Beschreibung:
Die Anzahl legt fest, wie oft ein Gegenstand gleichzeitig vergeben werden kann. Wird die Anzahl 0 hinterlegt, so kann der Gegenstand beliebig oft zugewiesen werden.
(Den internen Feld ID für dieses Element ist "NumberOfCopies")

Notizen
XML Element Name:Notes
Parent Element:ObjectDefinitionData
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   -1Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   10
Beschreibung:

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

Zeitachse
XML Element Name:TimeAxis
Parent Element:ObjectDefinitionData
Feld Typ:ID
Action Typ:Import und Export
Feld Länge:   1Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   11
Beschreibung:

                

Zeitachse
XML Element Name:TimeAxisDate
Parent Element:TimeAxis
Feld Typ:Datum (2000-03-20)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   1
Beschreibung:

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

Zeitachse aktiv
XML Element Name:IsActive
Parent Element:TimeAxis
Feld Typ:Boolean (true oder false)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   2
Beschreibung:

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

Art der Benutzungsgebühr
XML Element Name:TypeOfUsageFees
Parent Element:TimeAxis
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   1Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   3
Beschreibung:

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

Benutzungsgebühr
XML Element Name:UsageFee
Parent Element:TimeAxis
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   6Dezimal-Stellen:   2Zwingendes Feld:   JaRevision:   0Ascii ID :   4
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "UsageFee")
                    
Als Dezimaltrenner muss ein Punkt verwendet werden. Dies gemäss dem XML Standard von W3C.

Art des Depots
XML Element Name:TypeOfDeposit
Parent Element:TimeAxis
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   1Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   5
Beschreibung:

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

Depot
XML Element Name:Deposit
Parent Element:TimeAxis
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   6Dezimal-Stellen:   2Zwingendes Feld:   JaRevision:   0Ascii ID :   6
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "Deposit")
                    
Als Dezimaltrenner muss ein Punkt verwendet werden. Dies gemäss dem XML Standard von W3C.

Exemplar
XML Element Name:Copy
Parent Element:ObjectDefinitionData
Feld Typ:ID
Action Typ:Import und Export
Feld Länge:   1Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   13
Beschreibung:

                

Exemplarnummer
XML Element Name:CopyNumber
Parent Element:Copy
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   12Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   1
Beschreibung:

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

Exemplar-ID
XML Element Name:CopyId
Parent Element:Copy
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   100Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   2
Beschreibung:

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

Aktiv
XML Element Name:IsActive
Parent Element:Copy
Feld Typ:Boolean (true oder false)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   3
Beschreibung:

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

Bezeichnung
XML Element Name:Designation
Parent Element:Copy
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   100Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   4
Beschreibung:

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

Anlage
XML Element Name:Anlage
Parent Element:Copy
Feld Typ:ID
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   7
Beschreibung:

                

Werte der freien Felder
XML Element Name:FreeFieldValuesCopy
Parent Element:Copy
Feld Typ:ID
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   8
Beschreibung:

                

Werte der freie Felder
XML Element Name:FreeFieldValueCopy
Parent Element:FreeFieldValuesCopy
Feld Typ:Linked List
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   1
Beschreibung:

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

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

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

Wert
XML Element Name:Value
Parent Element:FreeFieldValueCopy
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   -1Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   2
Beschreibung:

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

Freie Felder
XML Element Name:FreeFields
Parent Element:ObjectDefinitionData
Feld Typ:ID
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   14
Beschreibung:

                

Definition
XML Element Name:FreeFieldDefinition
Parent Element:FreeFields
Feld Typ:ID
Action Typ:Import und Export
Feld Länge:   1Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   1
Beschreibung:

                

Feldnummer
XML Element Name:FieldNumber
Parent Element:FreeFieldDefinition
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   2Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   1
Beschreibung:

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

Reihenfolge
XML Element Name:SortOrder
Parent Element:FreeFieldDefinition
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   2Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   2
Beschreibung:

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

Zwingend
XML Element Name:Mandatory
Parent Element:FreeFieldDefinition
Feld Typ:Boolean (true oder false)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   3
Beschreibung:

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

Bebuchbar
XML Element Name:Bookable
Parent Element:FreeFieldDefinition
Feld Typ:Boolean (true oder false)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   4
Beschreibung:

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

Vererbung auf Exemplare
XML Element Name:InheritanceToCopies
Parent Element:FreeFieldDefinition
Feld Typ:Boolean (true oder false)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   5
Beschreibung:

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

Werte der freien Felder
XML Element Name:FreeFieldValues
Parent Element:FreeFields
Feld Typ:ID
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   2
Beschreibung:

                

Werte der freie Felder
XML Element Name:FreeFieldValue
Parent Element:FreeFieldValues
Feld Typ:Linked List
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   1
Beschreibung:

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

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

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

Wert
XML Element Name:Value
Parent Element:FreeFieldValue
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   -1Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   2
Beschreibung:

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

Anlage
XML Element Name:Anlage
Parent Element:ObjectDefinitionData
Feld Typ:ID
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   15
Beschreibung:

                

Anlagenummer
XML Element Name:AssetNumber
Parent Element:Anlage
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   10Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   1
Beschreibung:

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

Dossier
XML Element Name:Dossier
Parent Element:ObjectDefinitionData
Feld Typ:ID
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   16
Beschreibung:

                

Name des Dossiers
XML Element Name:Name
Parent Element:Dossier
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   50Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   1
Beschreibung:

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

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

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

Eindeutige Nummer des Dokuments
XML Element Name:DocumentID
Parent Element:Dossier
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   36Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   3
Beschreibung:

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

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

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

Ursprünglicher Dateiname
XML Element Name:OriginalFileName
Parent Element:Dossier
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   -1Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   5
Beschreibung:

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

Foto
XML Element Name:ImageFileName
Parent Element:ObjectDefinitionData
Feld Typ:Binär-Daten
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   17
Beschreibung:

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