Interface: LOHN - Base definition Version 2023.00

This documentation describes the AbaConnect Interface Base definition for the LOHN Application.


General Information

General information about the AbaConnect interface.

AbaConnect Interface Information
Application :LOHN
Interface Name :Base definition
ID :HierarchyBaseDefinition ( PayrollTypes )
Version :2023.00
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 : 1



Mapping Information

The following displays the Mapping details for this interface.

Mapping Information
Mapping ID :AbaDefault
Mapping Name :Bases definition
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>LOHN</Application>
      <Id>HierarchyBaseDefinition</Id>
      <MapId>AbaDefault</MapId>
      <Version>2023.00</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>
      <HierarchyBaseDefinitionDefinition mode='SAVE'>
          <!-- The specific data fields for the AbaConnect interface are included here. -->
      </HierarchyBaseDefinitionDefinition>
    </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"  "-aLOHN"  "-version2023.00"  "-M7777"  "-acidHierarchyBaseDefinition"  "-mapidAbaDefault"  "-datamodeXML"  "-responseYES"  "-responsefileX:\response.xml"  "-exportfileX:\data.xml"

Import :
abaconnectimportconsole.exe "/USRuser" "/PWxxx"  "-aLOHN"  "-version2023.00"  "-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
HierarchyBaseDefinitionDefinitionBases definition---Yes
    BaseDefinitionBases definitionHierarchyBaseDefinitionDefinition--No
        - InactiveBaseDefinitionBoolean-No
        - AmountNumberNumberBaseDefinitionNumber3Yes
        - GermanDesignationGerman designationBaseDefinitionText100No
        - FrenchDesignationFrench designationBaseDefinitionText100No
        - ItalianDesignationItalian designationBaseDefinitionText100No
        - EnglishDesignationEnglish designationBaseDefinitionText100No
        - Language5DesignationDesignation language 5BaseDefinitionText100No
        - Language6DesignationDesignation language 6BaseDefinitionText100No
        - ShowInReportShow basis in reportBaseDefinitionBoolean-Yes
        - TransferToNewYearTransfer to new yearBaseDefinitionBoolean-Yes
        - InactiveBeforeGrossPaymentInactive before gross paymentBaseDefinitionBoolean-Yes
        - InactiveAfterGrossPaymentInactive after gross paymentBaseDefinitionBoolean-Yes
        - FunctionFunctionBaseDefinitionNumber3Yes
        AnnualMaximumAnnual maximumBaseDefinition--No
            - ValidFromValid fromAnnualMaximumDate-Yes
            - ValueValid fromAnnualMaximumNumber10Yes
            - TableIDTable IDAnnualMaximumText3Yes
            - FieldIDField IDAnnualMaximumText16Yes
        - MaximaTypeMaximum wage typeBaseDefinitionEnum-No
        - BaseCategoryBase categoryBaseDefinitionEnum-No
    SalaryBaseDefinitionSalary basis definitionHierarchyBaseDefinitionDefinition--No
        - SalaryBaseTypeSalary basis typeSalaryBaseDefinitionText15Yes
        - PayTypePayr. typeSalaryBaseDefinitionNumber4Yes
        - GermanDesignationGerman designationSalaryBaseDefinitionText50No
        - FrenchDesignationFrench designationSalaryBaseDefinitionText50No
        - ItalianDesignationItalian designationSalaryBaseDefinitionText50No
        - EnglishDesignationEnglish designationSalaryBaseDefinitionText50No
        - Language5DesignationDesignation language 5SalaryBaseDefinitionText50No
        - Language6DesignationDesignation language 6SalaryBaseDefinitionText50No



Field Information

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

Bases definition
XML Element Name:BaseDefinition
Parent Element:HierarchyBaseDefinitionDefinition
Field Type:Array List
Action Type:Import und Export
Field Length:   1Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   -
Description:

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

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

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

Number
XML Element Name:AmountNumber
Parent Element:BaseDefinition
Field Type:Nummer
Action Type:Import und Export
Field Length:   3Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   -
Description:

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

German designation
XML Element Name:GermanDesignation
Parent Element:BaseDefinition
Field Type:Text
Action Type:Import und Export
Field Length:   100Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   -
Description:

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

French designation
XML Element Name:FrenchDesignation
Parent Element:BaseDefinition
Field Type:Text
Action Type:Import und Export
Field Length:   100Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   -
Description:

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

Italian designation
XML Element Name:ItalianDesignation
Parent Element:BaseDefinition
Field Type:Text
Action Type:Import und Export
Field Length:   100Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   -
Description:

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

English designation
XML Element Name:EnglishDesignation
Parent Element:BaseDefinition
Field Type:Text
Action Type:Import und Export
Field Length:   100Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   -
Description:

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

Designation language 5
XML Element Name:Language5Designation
Parent Element:BaseDefinition
Field Type:Text
Action Type:Import und Export
Field Length:   100Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   -
Description:

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

Designation language 6
XML Element Name:Language6Designation
Parent Element:BaseDefinition
Field Type:Text
Action Type:Import und Export
Field Length:   100Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   -
Description:

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

Show basis in report
XML Element Name:ShowInReport
Parent Element:BaseDefinition
Field Type:Boolean (true oder false)
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   -
Description:

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

Transfer to new year
XML Element Name:TransferToNewYear
Parent Element:BaseDefinition
Field Type:Boolean (true oder false)
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   -
Description:

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

Inactive before gross payment
XML Element Name:InactiveBeforeGrossPayment
Parent Element:BaseDefinition
Field Type:Boolean (true oder false)
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   -
Description:

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

Inactive after gross payment
XML Element Name:InactiveAfterGrossPayment
Parent Element:BaseDefinition
Field Type:Boolean (true oder false)
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   -
Description:

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

Function
XML Element Name:Function
Parent Element:BaseDefinition
Field Type:Nummer
Action Type:Import und Export
Field Length:   3Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   -
Description:

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

Valid from
XML Element Name:ValidFrom
Parent Element:AnnualMaximum
Field Type:Datum (2000-03-20)
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   -
Description:

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

Valid from
XML Element Name:Value
Parent Element:AnnualMaximum
Field Type:Nummer
Action Type:Import und Export
Field Length:   10Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   -
Description:

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

Table ID
XML Element Name:TableID
Parent Element:AnnualMaximum
Field Type:Text
Action Type:Import und Export
Field Length:   3Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   -
Description:

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

Field ID
XML Element Name:FieldID
Parent Element:AnnualMaximum
Field Type:Text
Action Type:Import und Export
Field Length:   16Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   -
Description:

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

Annual maximum
XML Element Name:AnnualMaximum
Parent Element:BaseDefinition
Field Type:Array List
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   -
Description:

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

Maximum wage type
XML Element Name:MaximaType
Parent Element:BaseDefinition
Field Type:Enum
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   NoRevision:   1Ascii ID :   3
Description:

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

Base category
XML Element Name:BaseCategory
Parent Element:BaseDefinition
Field Type:Enum
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   4
Description:

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

Salary basis definition
XML Element Name:SalaryBaseDefinition
Parent Element:HierarchyBaseDefinitionDefinition
Field Type:Array List
Action Type:Import und Export
Field Length:   -Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   -
Description:

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

Salary basis type
XML Element Name:SalaryBaseType
Parent Element:SalaryBaseDefinition
Field Type:Text
Action Type:Import und Export
Field Length:   15Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   -
Description:

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

Payr. type
XML Element Name:PayType
Parent Element:SalaryBaseDefinition
Field Type:Nummer
Action Type:Import und Export
Field Length:   4Decimal Places:   0Mandatory Field:   YesRevision:   0Ascii ID :   -
Description:

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

German designation
XML Element Name:GermanDesignation
Parent Element:SalaryBaseDefinition
Field Type:Text
Action Type:Import und Export
Field Length:   50Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   -
Description:

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

French designation
XML Element Name:FrenchDesignation
Parent Element:SalaryBaseDefinition
Field Type:Text
Action Type:Import und Export
Field Length:   50Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   -
Description:

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

Italian designation
XML Element Name:ItalianDesignation
Parent Element:SalaryBaseDefinition
Field Type:Text
Action Type:Import und Export
Field Length:   50Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   -
Description:

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

English designation
XML Element Name:EnglishDesignation
Parent Element:SalaryBaseDefinition
Field Type:Text
Action Type:Import und Export
Field Length:   50Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   -
Description:

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

Designation language 5
XML Element Name:Language5Designation
Parent Element:SalaryBaseDefinition
Field Type:Text
Action Type:Import und Export
Field Length:   50Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   -
Description:

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

Designation language 6
XML Element Name:Language6Designation
Parent Element:SalaryBaseDefinition
Field Type:Text
Action Type:Import und Export
Field Length:   50Decimal Places:   0Mandatory Field:   NoRevision:   0Ascii ID :   -
Description:

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