Interface:
HRMS
-
Object transaction data
Version
2017.10
This documentation describes the AbaConnect Interface
Object transaction data
for the
HRMS
Application.
General Information
General information about the AbaConnect interface.
| AbaConnect Interface Information |
| Application : | HRMS |
| Interface Name : | Object transaction data |
| ID : | ObjectAssignmentData
(
ObjectAdministration
)
|
| Version : | 2017.10 |
| Status: | Productive |
Displays the possible import and export features for this interface.
Displays additional information for this interface.
|
Highest field Revision for this interface : 1 |
Mapping Information
The following displays the Mapping details for this interface.
| Mapping ID : | AbaDefault |
| Mapping Name : | Object transaction data |
| Description : |
Insert (Insert):
When inserting , the field entry number (BookINumber) cannot be set since these running numbers are assigned automatically.
It is possible to reference the object to be output either via the object ID (ObjectID) or object number (ObjectNumber).
It is recommended to use the object ID (ObjectID) since this ID cannot be modified.
The object number (ObjectNumber) is unique but can be modified.
When the object ID (ObjectID) and the object number (ObjectNumber) are given they must reference the same object.
If this is not the case an error message will appear.
Update (Update):
When updating ,the field entry number (BookINumber) must be set. All other fields are optional. This means that fields which should be modified (e.g. field output (Issue)) should be filled out.
If the entry number (BookId) is invalid an error message will appear.
Delete (Delete):
When deleting ,the field entry number (BookINumber) must be set. All other fields are optional and will be ignored during processing of the transaction.
Save (SAVE):
Save behaves similarly to the operation Insert or Update, depending on which fields are filled out.
If Save is executed without an entry number (BookINumber), an Insert takes place.
If Save is executed with an entry number (BookINumber), an Update takes place.
|
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>ObjectAssignmentData</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>
<ObjectAssignmentData mode='SAVE'>
<!-- The specific data fields for the AbaConnect interface are included here. -->
</ObjectAssignmentData>
</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"
"-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. : 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.
Field Information
The following is a detailed description of the fields used in this interface.
| XML Element Name: | BookNumber |
| Parent Element: | ObjectAssignmentData |
| Action Type: | Import und Export |
| Field Length:
14 | Decimal Places:
0 | Mandatory Field:
No | Revision:
0 | Ascii ID :
1 |
| Description: |
(The internal field ID for this element is "BookId")
|
| XML Element Name: | ObjectID |
| Parent Element: | ObjectAssignmentData |
| Action Type: | Import und Export |
| Field Length:
8 | Decimal Places:
0 | Mandatory Field:
No | Revision:
0 | Ascii ID :
2 |
| Description: |
(The internal field ID for this element is "ObjectId")
|
| XML Element Name: | ObjectNumber |
| Parent Element: | ObjectAssignmentData |
| Action Type: | Import und Export |
| Field Length:
10 | Decimal Places:
0 | Mandatory Field:
No | Revision:
1 | Ascii ID :
14 |
| Description: |
(The internal field ID for this element is "ObjectNr")
|
| XML Element Name: | CopyNumber |
| Parent Element: | ObjectAssignmentData |
| Action Type: | Import und Export |
| Field Length:
12 | Decimal Places:
0 | Mandatory Field:
No | Revision:
0 | Ascii ID :
3 |
| Description: |
(The internal field ID for this element is "Copy")
|
| XML Element Name: | CopyID |
| Parent Element: | ObjectAssignmentData |
| Action Type: | Import und Export |
| Field Length:
100 | Decimal Places:
0 | Mandatory Field:
No | Revision:
0 | Ascii ID :
15 |
| Description: |
(The internal field ID for this element is "CopyId")
|
| XML Element Name: | AddressNumber |
| Parent Element: | ObjectAssignmentData |
| Action Type: | Import und Export |
| Field Length:
10 | Decimal Places:
0 | Mandatory Field:
No | Revision:
0 | Ascii ID :
4 |
| Description: |
(The internal field ID for this element is "AddressNr")
|
| XML Element Name: | IssueDate |
| Parent Element: | ObjectAssignmentData |
| Field Type: | Datum (2000-03-20) |
| Action Type: | Import und Export |
| Field Length:
- | Decimal Places:
0 | Mandatory Field:
No | Revision:
0 | Ascii ID :
5 |
| Description: |
(The internal field ID for this element is "Issue")
|
| XML Element Name: | ReturnDate |
| Parent Element: | ObjectAssignmentData |
| Field Type: | Datum (2000-03-20) |
| Action Type: | Import und Export |
| Field Length:
- | Decimal Places:
0 | Mandatory Field:
No | Revision:
0 | Ascii ID :
6 |
| Description: |
(The internal field ID for this element is "Back")
|
| XML Element Name: | UsageFee |
| Parent Element: | ObjectAssignmentData |
| Action Type: | Import und Export |
| Field Length:
6 | Decimal Places:
2 | Mandatory Field:
No | Revision:
0 | Ascii ID :
7 |
| 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.
|
| XML Element Name: | DepositFee |
| Parent Element: | ObjectAssignmentData |
| Action Type: | Import und Export |
| Field Length:
6 | Decimal Places:
2 | Mandatory Field:
No | Revision:
0 | Ascii ID :
8 |
| Description: |
(The internal field ID for this element is "DepositeFee")
The decimal separator for numbers must be represented with a point, as defined by the XML standards from W3C.
|
| XML Element Name: | Text1 |
| Parent Element: | ObjectAssignmentData |
| Action Type: | Import und Export |
| Field Length:
100 | Decimal Places:
0 | Mandatory Field:
No | Revision:
0 | Ascii ID :
9 |
| Description: |
(The internal field ID for this element is "Text1")
|
| XML Element Name: | Name |
| Parent Element: | Dossier |
| Action Type: | Import und Export |
| Field Length:
50 | Decimal Places:
0 | Mandatory Field:
No | Revision:
0 | Ascii ID :
1 |
| Description: |
(The internal field ID for this element is "Name")
|
| Action Type: | Import und Export |
| Field Length:
200 | Decimal Places:
0 | Mandatory Field:
No | Revision:
0 | Ascii ID :
2 |
| Description: |
(The internal field ID for this element is "Description")
|
| XML Element Name: | DocumentID |
| Parent Element: | Dossier |
| Action Type: | Import und Export |
| Field Length:
36 | Decimal Places:
0 | Mandatory Field:
No | Revision:
0 | Ascii ID :
3 |
| Description: |
(The internal field ID for this element is "DID")
|
| XML Element Name: | FileName |
| Parent Element: | Dossier |
| Action Type: | Import und Export |
| Field Length:
-1 | Decimal Places:
0 | Mandatory Field:
No | Revision:
0 | Ascii ID :
4 |
| Description: |
(The internal field ID for this element is "Filename")
|
| Action Type: | Import und Export |
| Field Length:
-1 | Decimal Places:
0 | Mandatory Field:
No | Revision:
0 | Ascii ID :
5 |
| Description: |
(The internal field ID for this element is "OriginalFilename")
|
| XML Element Name: | Text2 |
| Parent Element: | ObjectAssignmentData |
| Action Type: | Import und Export |
| Field Length:
100 | Decimal Places:
0 | Mandatory Field:
No | Revision:
0 | Ascii ID :
10 |
| Description: |
(The internal field ID for this element is "Text2")
|
| Action Type: | Import und Export |
| Field Length:
- | Decimal Places:
0 | Mandatory Field:
No | Revision:
0 | Ascii ID :
1 |
| Description: |
(The internal field ID for this element is "SstExtendedFieldData")
|
| XML Element Name: | Id |
| Parent Element: | FreeFieldValue |
| Action Type: | Import und Export |
| Field Length:
-1 | Decimal Places:
0 | Mandatory Field:
Yes | Revision:
0 | Ascii ID :
1 |
| Description: |
(The internal field ID for this element is "Id")
|
| XML Element Name: | Value |
| Parent Element: | FreeFieldValue |
| Action Type: | Import und Export |
| Field Length:
-1 | Decimal Places:
0 | Mandatory Field:
Yes | Revision:
0 | Ascii ID :
2 |
| Description: |
(The internal field ID for this element is "Value")
|
| XML Element Name: | Dossier |
| Parent Element: | ObjectAssignmentData |
| Action Type: | Import und Export |
| Field Length:
- | Decimal Places:
0 | Mandatory Field:
No | Revision:
0 | Ascii ID :
11 |
| XML Element Name: | FreeFields |
| Parent Element: | ObjectAssignmentData |
| Action Type: | Import und Export |
| Field Length:
- | Decimal Places:
0 | Mandatory Field:
No | Revision:
0 | Ascii ID :
12 |
| XML Element Name: | Note |
| Parent Element: | ObjectAssignmentData |
| Action Type: | Import und Export |
| Field Length:
-1 | Decimal Places:
0 | Mandatory Field:
No | Revision:
0 | Ascii ID :
13 |
| Description: |
(The internal field ID for this element is "Note")
|