Schnittstelle: HRMS - ObjectAssignmentData Version 2017.10

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


Allgemeine Informationen

Allgemeine Informationen zur Schnittstelle.

AbaConnect Schnittstellen Information
Applikation:HRMS
Schnittstellen-Name:Gegenstände Bewegungsdaten
ID:ObjectAssignmentData ( 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 : 1



Mapping Informationen

Im Folgenden werden die Informationen über das Mapping angezeigt.

Mapping Informationen
Mapping ID:AbaDefault
Mapping Name:Gegenstände Bewegungsdaten
Beschreibung:
Einfügen (Insert):
Beim Insert darf das Feld Buchungsnummer (BookNumber) nicht gesetzt sein, da diese fortlaufende Nummer automatisch vergeben wird.
Es ist möglich, das auszugebende Objekt entweder über die Objekt-ID (ObjectID) oder Objekt-Nummer (ObjectNumber) zu referenzieren. 
Es wird empfohlen, die Objekt-ID (ObjectID) zu verwenden, da diese ID nicht angepasst werden kann. 
Die Objekt-Nummer (ObjectNumber) ist zwar eindeutig, kann aber geändert werden. 
Wenn die Objekt-ID (ObjectID) und die Objekt-Nummer (ObjectNumber) mitgegeben werden, müssen diese den gleichen Gegenstand referenzieren. 
Wenn dies nicht der Fall ist, wird eine Fehlermeldung geworfen.

Aktualisieren (Update):
Beim Update muss das Feld Buchungsnummer (BookINumber) gesetzt sein. Alle anderen Felder sind optional. Das heisst, die Felder, welche geändert werden sollen (z.B. Feld Ausgabe (Issue)), sind abzufüllen. 
Falls die Buchungsnummer (BookNumber) ungültig ist, erfolgt eine Fehlermeldung.

Löschen (Delete):
Bei Löschen muss das Feld Buchungsnummer (BookINumber) gesetzt sein. Alle anderen Felder sind optional und werden bei der Verarbeitung der Transaktion ignoriert.

Speichern (Save):
Save verhält sich analog der Operation Insert oder Update, je nachdem, welche Felder abgefüllt sind.
Wenn Save ohne Buchungsnummer (BookINumber) aufgerufen wird, erfolgt ein Insert.
Wenn Save mit Buchungsnummer (BookINumber) aufgerufen wird, erfolgt ein Update.



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>ObjectAssignmentData</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>
      <ObjectAssignmentData mode='SAVE'>
          <!-- Hier können spezifische Datenfelder für die AbaConnect Schnittstelle definiert werden. -->
      </ObjectAssignmentData>
    </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"  "-acidObjectAssignmentData"  "-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
ObjectAssignmentDataBuchung---Ja
    - BookNumberBuchungsnummerObjectAssignmentDataNummer14Nein
    - ObjectIDGegenstand IDObjectAssignmentDataNummer8Nein
    - ObjectNumberGegenstandsnummerObjectAssignmentDataNummer10Nein
    - CopyNumberExemplarObjectAssignmentDataNummer12Nein
    - CopyIDExemplar IDObjectAssignmentDataText100Nein
    - AddressNumberAdresseObjectAssignmentDataNummer10Nein
    - IssueDateAusgabeObjectAssignmentDataDatum-Nein
    - ReturnDateRückgabeObjectAssignmentDataDatum-Nein
    - UsageFeeBenutzungObjectAssignmentDataNummer6Nein
    - DepositFeeDepotObjectAssignmentDataNummer6Nein
    - Text1Buchungstext 1ObjectAssignmentDataText100Nein
    - Text2Buchungstext 2ObjectAssignmentDataText100Nein
    DossierDossierObjectAssignmentData--Nein
        - NameName des DossiersDossierText50Nein
        - DescriptionBeschreibungDossierText200Nein
        - DocumentIDEindeutige Nummer des DokumentsDossierText36Nein
        - FileNameDateiname für diese TransaktionDossierText-1Nein
        - OriginalFileNameursprünglicher DateinameDossierText-1Nein
    FreeFieldsFreie FelderObjectAssignmentData--Nein
        FreeFieldValueWerte der freie FelderFreeFields--Nein
            - IdFreeFieldValueText-1Ja
            - ValueFreeFieldValueText-1Ja
    - NoteNotizObjectAssignmentDataText-1Nein



Detaillierte Feld-Informationen

Detaillierte Beschreibung der Schnittstellen-Felder.

Buchungsnummer
XML Element Name:BookNumber
Parent Element:ObjectAssignmentData
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   14Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   1
Beschreibung:

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

Gegenstand ID
XML Element Name:ObjectID
Parent Element:ObjectAssignmentData
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   8Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   2
Beschreibung:

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

Gegenstandsnummer
XML Element Name:ObjectNumber
Parent Element:ObjectAssignmentData
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   10Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   1Ascii ID :   14
Beschreibung:

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

Exemplar
XML Element Name:CopyNumber
Parent Element:ObjectAssignmentData
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   12Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   3
Beschreibung:

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

Exemplar ID
XML Element Name:CopyID
Parent Element:ObjectAssignmentData
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   100Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   15
Beschreibung:

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

Adresse
XML Element Name:AddressNumber
Parent Element:ObjectAssignmentData
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   10Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   4
Beschreibung:

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

Ausgabe
XML Element Name:IssueDate
Parent Element:ObjectAssignmentData
Feld Typ:Datum (2000-03-20)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   5
Beschreibung:

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

Rückgabe
XML Element Name:ReturnDate
Parent Element:ObjectAssignmentData
Feld Typ:Datum (2000-03-20)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   6
Beschreibung:

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

Benutzung
XML Element Name:UsageFee
Parent Element:ObjectAssignmentData
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   6Dezimal-Stellen:   2Zwingendes Feld:   NeinRevision:   0Ascii ID :   7
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.

Depot
XML Element Name:DepositFee
Parent Element:ObjectAssignmentData
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   6Dezimal-Stellen:   2Zwingendes Feld:   NeinRevision:   0Ascii ID :   8
Beschreibung:

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

Buchungstext 1
XML Element Name:Text1
Parent Element:ObjectAssignmentData
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   100Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   9
Beschreibung:

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

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")
                    

Dateiname für diese Transaktion
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")
                    

Buchungstext 2
XML Element Name:Text2
Parent Element:ObjectAssignmentData
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   100Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   10
Beschreibung:

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

Werte der freie Felder
XML Element Name:FreeFieldValue
Parent Element:FreeFields
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")
                    

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")
                    

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")
                    

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

                

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

                

Notiz
XML Element Name:Note
Parent Element:ObjectAssignmentData
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   -1Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   13
Beschreibung:

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