Interface: HRMS - Définition d'objets Version 2017.10

This documentation describes the AbaConnect Interface Définition d'objets for the HRMS Application.


General Information

General information about the AbaConnect interface.

AbaConnect Interface Information
Application :HRMS
Interface Name :Définition d'objets
ID :ObjectDefinitionData ( ObjectAdministration )
Version :2017.10
Status:Productive


Displays the possible import and export features for this interface.

Export / Import Modus
Export :XML
Import :XML


Displays additional information for this interface.

Additional Information

                                  Highest field Revision for this interface : 0



Mapping Information

The following displays the Mapping details for this interface.

Mapping Information
Mapping ID :AbaDefault
Mapping Name :Définition d'objets
Description :

                



Example AbaConnect XML Structure

The following is an example of an XML Header structure. This information is also visible in an AbaConnect XML Export file, that has been exported via the Abacus AbaConnect User Interface.

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>
      <!-- Attention : The client number (Mandant) is optional and implies that the data can only be imported into specified client (Mandant) -->
      <!-- The Client Option (Mandant) only has an influence when importing data. It can be configured in the AbaConnect Export Settings. -->
      <!-- By default, the client number (Mandant) is not written to the export file -->
      <Mandant>7777</Mandant>
    </Parameter>
    <Transaction>
      <ObjectDefinitionData mode='SAVE'>
          <!-- The specific data fields for the AbaConnect interface are included here. -->
      </ObjectDefinitionData>
    </Transaction>
  </Task>
</AbaConnectContainer>



Example AbaConnect Command Line

The following includes examples of AbaConnect Command Line. The AbaConnect Command Line is executed with the abaconnectexportconsole.exe and abaconnectimportconsole.exe programmes. The AbaConnect Command Line must be run direct on the Abacus server. More detailed information about AbaConnect Command Line is available on the Abacus Homepage. The following examples serve as starting point for creating a simple 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. : For importing XML data, it is not necessary to specify the Interface ID and Mapping on the Command Line. This information is contained in the XML Import file.



Mapping Structure

The following displays a simplified mapping structure for this interface.
The XML-Element and Parent-Name are always in english. Click on the row to display additional information.

XML Element Name Field Name Parent Name Type Length Mandatory
+ ObjectDefinitionDataDéfinition d'objets---Yes
    - IdID interneObjectDefinitionDataNumber14Yes
    - NumberNumberObjectDefinitionDataNumber10Yes
    - ParentIdCatégorie supérieure (Id)ObjectDefinitionDataNumber14Yes
    - DesignationDesignationObjectDefinitionDataText50Yes
    - DescriptionDescriptionObjectDefinitionDataText50Yes
    - BehaviourAtDepartureComportement à la sortieObjectDefinitionDataNumber1Yes
    - KeepsCopiesGérer les exemplairesObjectDefinitionDataBoolean-Yes
    - CopyListExpandableAtEntryCopy list expandable at entryObjectDefinitionDataBoolean-Yes
    - NumberOfCopiesNombreObjectDefinitionDataNumber10Yes
    - NotesNotesObjectDefinitionDataText-1Yes
    + TimeAxisAxes temporelsObjectDefinitionData--No
        - TimeAxisDateAxe temporelTimeAxisDate-Yes
        - IsActiveAxe temporel jour actifTimeAxisBoolean-Yes
        - TypeOfUsageFeesGenre de la taxe d'utilisationTimeAxisNumber1Yes
        - UsageFeeTaxe d'utilisationTimeAxisNumber6Yes
        - TypeOfDepositGenre du dépôtTimeAxisNumber1Yes
        - DepositDépôtTimeAxisNumber6Yes
    + CopyExemplaireObjectDefinitionData--No
        - CopyNumberNuméro exemplaireCopyNumber12Yes
        - CopyIdID exemplaireCopyText100Yes
        - IsActiveActifCopyBoolean-Yes
        - DesignationDesignationCopyText100Yes
        + AnlageImmobilisationCopy--No
            - AssetNumberAsset numberAnlageNumber10Yes
        + FreeFieldValuesCopyValue of free fieldsCopy--No
            + FreeFieldValueCopyValue of free fieldsFreeFieldValuesCopy--No
                - IdIdFreeFieldValueCopyText-1Yes
                - ValueValueFreeFieldValueCopyText-1Yes
    + FreeFieldsFree fieldsObjectDefinitionData--No
        + FreeFieldDefinitionDefinitionFreeFields--No
            - FieldNumberField numberFreeFieldDefinitionNumber2Yes
            - SortOrderOrdreFreeFieldDefinitionNumber2Yes
            - MandatoryMandatoryFreeFieldDefinitionBoolean-Yes
            - BookableCan be entered toFreeFieldDefinitionBoolean-Yes
            - InheritanceToCopiesDoesCopyInheritFieldFreeFieldDefinitionBoolean-Yes
        + FreeFieldValuesValue of free fieldsFreeFields--No
            + FreeFieldValueValue of free fieldsFreeFieldValues--No
                - IdIdFreeFieldValueText-1Yes
                - ValueValueFreeFieldValueText-1Yes
    + AnlageAssetObjectDefinitionData--No
        - AssetNumberAsset numberAnlageNumber10Yes
    + DossierDossierObjectDefinitionData--No
        - NameName of dossierDossierText50No
        - DescriptionDescriptionDossierText200No
        - DocumentIDUnique number of the documentDossierText36No
        - FileNameDossierText-1No
        - OriginalFileNameOriginal file nameDossierText-1No
    - ImageFileNamePhotoObjectDefinitionDataBinary-No



Field Information

The following is a detailed description of the fields used in this interface.

ID interne
XML Element Name:Id
Parent Element:ObjectDefinitionData
Field Type:Nummer
Action Type:Import und Export
Field Length:   14Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   1
Description:
The internal ID is unique and cannot be changed.  If the ID is 0, a new ID is automatically generated.
(The internal field ID for this element is "Id")

Number
XML Element Name:Number
Parent Element:ObjectDefinitionData
Field Type:Nummer
Action Type:Import und Export
Field Length:   10Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   2
Description:

                                  (The internal field ID for this element is "Number")
                    

Catégorie supérieure (Id)
XML Element Name:ParentId
Parent Element:ObjectDefinitionData
Field Type:Nummer
Action Type:Import und Export
Field Length:   14Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   3
Description:

                                  (The internal field ID for this element is "ParentId")
                    

Designation
XML Element Name:Designation
Parent Element:ObjectDefinitionData
Field Type:Text
Action Type:Import und Export
Field Length:   50Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   4
Description:

                                  (The internal field ID for this element is "Designation")
                    

Description
XML Element Name:Description
Parent Element:ObjectDefinitionData
Field Type:Text
Action Type:Import und Export
Field Length:   50Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   5
Description:

                                  (The internal field ID for this element is "Description")
                    

Comportement à la sortie
XML Element Name:BehaviourAtDeparture
Parent Element:ObjectDefinitionData
Field Type:Nummer
Action Type:Import und Export
Field Length:   1Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   6
Description:

                                  (The internal field ID for this element is "LeavingBehaviour")
                    

Gérer les exemplaires
XML Element Name:KeepsCopies
Parent Element:ObjectDefinitionData
Field Type:Boolean (true oder false)
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   7
Description:
If copies are used then every possible copy must be entered in the list of copies. Copies are uniquely identifiable through the assignment of an ID/Number. The list of copies can be extended at booking, if desired.
(The internal field ID for this element is "KeepsCopies")

Copy list expandable at entry
XML Element Name:CopyListExpandableAtEntry
Parent Element:ObjectDefinitionData
Field Type:Boolean (true oder false)
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   8
Description:

                                  (The internal field ID for this element is "ExpandCopies")
                    

Nombre
XML Element Name:NumberOfCopies
Parent Element:ObjectDefinitionData
Field Type:Nummer
Action Type:Import und Export
Field Length:   10Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   9
Description:
The number determines how many times an object can be assigned simultaneously. If the number 0 is stored then the object may be assigned any number of times.
(The internal field ID for this element is "NumberOfCopies")

Notes
XML Element Name:Notes
Parent Element:ObjectDefinitionData
Field Type:Text
Action Type:Import und Export
Field Length:   -1Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   10
Description:

                                  (The internal field ID for this element is "Notes")
                    

Axes temporels
XML Element Name:TimeAxis
Parent Element:ObjectDefinitionData
Field Type:ID
Action Type:Import und Export
Field Length:   1Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   11
Description:

                

Axe temporel
XML Element Name:TimeAxisDate
Parent Element:TimeAxis
Field Type:Datum (2000-03-20)
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   1
Description:

                                  (The internal field ID for this element is "TimeAxis")
                    

Axe temporel jour actif
XML Element Name:IsActive
Parent Element:TimeAxis
Field Type:Boolean (true oder false)
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   2
Description:

                                  (The internal field ID for this element is "IsActive")
                    

Genre de la taxe d'utilisation
XML Element Name:TypeOfUsageFees
Parent Element:TimeAxis
Field Type:Nummer
Action Type:Import und Export
Field Length:   1Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   3
Description:

                                  (The internal field ID for this element is "TypeOfUsageFees")
                    

Taxe d'utilisation
XML Element Name:UsageFee
Parent Element:TimeAxis
Field Type:Nummer
Action Type:Import und Export
Field Length:   6Decimal Places:   2Mandatory Field:   YesRevision:   0Ascii ID :   4
Description:

                                  (The internal field ID for this element is "UsageFee")
                    
The decimal separator for numbers must be represented with a point, as defined by the XML standards from W3C.

Genre du dépôt
XML Element Name:TypeOfDeposit
Parent Element:TimeAxis
Field Type:Nummer
Action Type:Import und Export
Field Length:   1Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   5
Description:

                                  (The internal field ID for this element is "TypeOfDeposit")
                    

Dépôt
XML Element Name:Deposit
Parent Element:TimeAxis
Field Type:Nummer
Action Type:Import und Export
Field Length:   6Decimal Places:   2Mandatory Field:   YesRevision:   0Ascii ID :   6
Description:

                                  (The internal field ID for this element is "Deposit")
                    
The decimal separator for numbers must be represented with a point, as defined by the XML standards from W3C.

Exemplaire
XML Element Name:Copy
Parent Element:ObjectDefinitionData
Field Type:ID
Action Type:Import und Export
Field Length:   1Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   13
Description:

                

Numéro exemplaire
XML Element Name:CopyNumber
Parent Element:Copy
Field Type:Nummer
Action Type:Import und Export
Field Length:   12Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   1
Description:

                                  (The internal field ID for this element is "CopyNumber")
                    

ID exemplaire
XML Element Name:CopyId
Parent Element:Copy
Field Type:Text
Action Type:Import und Export
Field Length:   100Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   2
Description:

                                  (The internal field ID for this element is "CopyId")
                    

Actif
XML Element Name:IsActive
Parent Element:Copy
Field Type:Boolean (true oder false)
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   3
Description:

                                  (The internal field ID for this element is "IsActive")
                    

Designation
XML Element Name:Designation
Parent Element:Copy
Field Type:Text
Action Type:Import und Export
Field Length:   100Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   4
Description:

                                  (The internal field ID for this element is "Designation")
                    

Immobilisation
XML Element Name:Anlage
Parent Element:Copy
Field Type:ID
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   7
Description:

                

Value of free fields
XML Element Name:FreeFieldValuesCopy
Parent Element:Copy
Field Type:ID
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   8
Description:

                

Value of free fields
XML Element Name:FreeFieldValueCopy
Parent Element:FreeFieldValuesCopy
Field Type:Linked List
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   1
Description:

                                  (The internal field ID for this element is "SstExtendedFieldData")
                    

Id
XML Element Name:Id
Parent Element:FreeFieldValueCopy
Field Type:Text
Action Type:Import und Export
Field Length:   -1Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   1
Description:

                                  (The internal field ID for this element is "Id")
                    

Value
XML Element Name:Value
Parent Element:FreeFieldValueCopy
Field Type:Text
Action Type:Import und Export
Field Length:   -1Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   2
Description:

                                  (The internal field ID for this element is "Value")
                    

Free fields
XML Element Name:FreeFields
Parent Element:ObjectDefinitionData
Field Type:ID
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   14
Description:

                

Definition
XML Element Name:FreeFieldDefinition
Parent Element:FreeFields
Field Type:ID
Action Type:Import und Export
Field Length:   1Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   1
Description:

                

Field number
XML Element Name:FieldNumber
Parent Element:FreeFieldDefinition
Field Type:Nummer
Action Type:Import und Export
Field Length:   2Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   1
Description:

                                  (The internal field ID for this element is "FieldNumber")
                    

Ordre
XML Element Name:SortOrder
Parent Element:FreeFieldDefinition
Field Type:Nummer
Action Type:Import und Export
Field Length:   2Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   2
Description:

                                  (The internal field ID for this element is "SortOrder")
                    

Mandatory
XML Element Name:Mandatory
Parent Element:FreeFieldDefinition
Field Type:Boolean (true oder false)
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   3
Description:

                                  (The internal field ID for this element is "IsMandatory")
                    

Can be entered to
XML Element Name:Bookable
Parent Element:FreeFieldDefinition
Field Type:Boolean (true oder false)
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   4
Description:

                                  (The internal field ID for this element is "IsBookable")
                    

DoesCopyInheritField
XML Element Name:InheritanceToCopies
Parent Element:FreeFieldDefinition
Field Type:Boolean (true oder false)
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   5
Description:

                                  (The internal field ID for this element is "DoesCopyInheritField")
                    

Value of free fields
XML Element Name:FreeFieldValues
Parent Element:FreeFields
Field Type:ID
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   2
Description:

                

Value of free fields
XML Element Name:FreeFieldValue
Parent Element:FreeFieldValues
Field Type:Linked List
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   1
Description:

                                  (The internal field ID for this element is "SstExtendedFieldData")
                    

Id
XML Element Name:Id
Parent Element:FreeFieldValue
Field Type:Text
Action Type:Import und Export
Field Length:   -1Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   1
Description:

                                  (The internal field ID for this element is "Id")
                    

Value
XML Element Name:Value
Parent Element:FreeFieldValue
Field Type:Text
Action Type:Import und Export
Field Length:   -1Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   2
Description:

                                  (The internal field ID for this element is "Value")
                    

Asset
XML Element Name:Anlage
Parent Element:ObjectDefinitionData
Field Type:ID
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   15
Description:

                

Asset number
XML Element Name:AssetNumber
Parent Element:Anlage
Field Type:Nummer
Action Type:Import und Export
Field Length:   10Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   1
Description:

                                  (The internal field ID for this element is "AssetNumber")
                    

Dossier
XML Element Name:Dossier
Parent Element:ObjectDefinitionData
Field Type:ID
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   16
Description:

                

Name of dossier
XML Element Name:Name
Parent Element:Dossier
Field Type:Text
Action Type:Import und Export
Field Length:   50Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   1
Description:

                                  (The internal field ID for this element is "Name")
                    

Description
XML Element Name:Description
Parent Element:Dossier
Field Type:Text
Action Type:Import und Export
Field Length:   200Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   2
Description:

                                  (The internal field ID for this element is "Description")
                    

Unique number of the document
XML Element Name:DocumentID
Parent Element:Dossier
Field Type:Text
Action Type:Import und Export
Field Length:   36Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   3
Description:

                                  (The internal field ID for this element is "DID")
                    

XML Element Name:FileName
Parent Element:Dossier
Field Type:Text
Action Type:Import und Export
Field Length:   -1Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   4
Description:

                                  (The internal field ID for this element is "Filename")
                    

Original file name
XML Element Name:OriginalFileName
Parent Element:Dossier
Field Type:Text
Action Type:Import und Export
Field Length:   -1Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   5
Description:

                                  (The internal field ID for this element is "OriginalFilename")
                    

Photo
XML Element Name:ImageFileName
Parent Element:ObjectDefinitionData
Field Type:Binary data
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   17
Description:

                                  (The internal field ID for this element is "ImageFileName")