Interface: DF - Appointments Version 2017.00

This documentation describes the AbaConnect Interface Appointments for the DF Application.

General Information

General information about the AbaConnect interface.

AbaConnect Interface Information

Application :	DF
Interface Name :	Appointments
ID :	Calendar ( Calendar )
Version :	2017.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 :	Appointments
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>DF</Application>
      <Id>Calendar</Id>
      <MapId>AbaDefault</MapId>
      <Version>2017.00</Version>
      
      
      
      <Mandant>7777</Mandant>
    </Parameter>
    <Transaction>
      <Event mode='SAVE'>
          
      </Event>
    </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" "-aDF" "-version2017.00" "-M7777" "-acidCalendar" "-mapidAbaDefault" "-datamodeXML" "-responseYES" "-responsefileX:\response.xml" "-exportfileX:\data.xml"

Import :
abaconnectimportconsole.exe "/USRuser" "/PWxxx" "-aDF" "-version2017.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
+ Event	Appointments	-	-	-	Yes
+ Participant	Appointment participant	Event	-	-	No
- EventNumber	Appointment	Participant	Number	8	No
- ParticipantType	Participant type	Participant	Number	2	No
- ParticipantNumber	Participant	Participant	Number	10	No
- ParticipantRole	Participant role	Participant	Number	2	No
- ParticipantEmail	Free participant e-mail address	Participant	Text	255	No
- ParticipantName	Free participant name	Participant	Text	150	No
- ParticipantAvailability	Availability	Participant	Number	2	No
- EventNumber	Appointment	Event	Number	8	No
- EventTitle	Appointment title	Event	Text	4032	No
- EventType	Appointment type	Event	Number	8	No
- StartTime	Start	Event	Date/Time	-	No
- EndTime	End	Event	Date/Time	-	No
- CreationTime	Creation	Event	Date/Time	-	No
- CreationUser	Entered by	Event	Number	8	No
- MutationTime	Modification date	Event	Date/Time	-	No
- MutationUser	Modified by	Event	Number	8	No
- Application	Application	Event	Number	2	No
- Identifier	Key	Event	Text	26	No
- SyncKey	Synchronization key	Event	GUID	36	No
- ReadOnly	Read-only	Event	Boolean	-	No
- Classification	Classification	Event	Number	2	No
- Location	Location	Event	Text	255	No
- AllDay	Daytime appointment	Event	Boolean	-	No
+ Notes	Notes	Event	-	-	No
- Content	Content	Notes	Text	99999999	No
+ NoteAttachment	Attachments	Notes	-	-	No
- ContentId	Content id	NoteAttachment	Text	180	No
- Attachmentname	Attachment name	NoteAttachment	Text	255	No
- FilePath	File path	NoteAttachment	Binary	-	Yes

Field Information

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

Appointment participant

XML Element Name:	Participant
Parent Element:	Event

Field Type:

Action Type:

Import und Export

Field Length: 1

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

Appointment

XML Element Name:	EventNumber
Parent Element:	Participant

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 8

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

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

Participant type

XML Element Name:	ParticipantType
Parent Element:	Participant

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 2

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

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

Participant

XML Element Name:	ParticipantNumber
Parent Element:	Participant

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 10

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

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

Participant role

XML Element Name:	ParticipantRole
Parent Element:	Participant

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 2

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

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

Free participant e-mail address

XML Element Name:	ParticipantEmail
Parent Element:	Participant

Field Type:

Text

Action Type:

Import und Export

Field Length: 255

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

E-mail address of free participant

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

Free participant name

XML Element Name:	ParticipantName
Parent Element:	Participant

Field Type:

Text

Action Type:

Import und Export

Field Length: 150

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

Name of free participant

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

Availability

XML Element Name:	ParticipantAvailability
Parent Element:	Participant

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 2

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

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

Appointment

XML Element Name:	EventNumber
Parent Element:	Event

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 8

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

Unique number of the appointment.

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

Appointment title

XML Element Name:	EventTitle
Parent Element:	Event

Field Type:

Text

Action Type:

Import und Export

Field Length: 4032

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

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

Appointment type

XML Element Name:	EventType
Parent Element:	Event

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 8

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

The appointment type serves for categorising appointments.

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

Start

XML Element Name:	StartTime
Parent Element:	Event

Field Type:

Datum/Zeit (2006-08-08T10:16:54.509+02:00)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

Time from which the appointment starts.

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

End

XML Element Name:	EndTime
Parent Element:	Event

Field Type:

Datum/Zeit (2006-08-08T10:16:54.509+02:00)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

Time at which the appointment ends.

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

Creation

XML Element Name:	CreationTime
Parent Element:	Event

Field Type:

Datum/Zeit (2006-08-08T10:16:54.509+02:00)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

Creation time of appointment.

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

Entered by

XML Element Name:	CreationUser
Parent Element:	Event

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 8

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

User who created the appointment.

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

Modification date

XML Element Name:	MutationTime
Parent Element:	Event

Field Type:

Datum/Zeit (2006-08-08T10:16:54.509+02:00)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

Time the appointment was last modified

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

Modified by

XML Element Name:	MutationUser
Parent Element:	Event

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 8

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

User who last modified the appointment

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

Application

XML Element Name:	Application
Parent Element:	Event

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 2

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

Source application

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

Key

XML Element Name:	Identifier
Parent Element:	Event

Field Type:

Text

Action Type:

Import und Export

Field Length: 26

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

Key of source application

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

Synchronization key

XML Element Name:	SyncKey
Parent Element:	Event

Field Type:

GUID

Action Type:

Import und Export

Field Length: 36

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

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

Read-only

XML Element Name:	ReadOnly
Parent Element:	Event

Field Type:

Boolean (true oder false)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

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

Classification

XML Element Name:	Classification
Parent Element:	Event

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 2

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

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

Location

XML Element Name:	Location
Parent Element:	Event

Field Type:

Text

Action Type:

Import und Export

Field Length: 255

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

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

Daytime appointment

XML Element Name:	AllDay
Parent Element:	Event

Field Type:

Boolean (true oder false)

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 1

Ascii ID : 1

Description:

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

Notes

XML Element Name:	Notes
Parent Element:	Event

Field Type:

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

Content

XML Element Name:	Content
Parent Element:	Notes

Field Type:

Text

Action Type:

Import und Export

Field Length: 99999999

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

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

Attachments

XML Element Name:	NoteAttachment
Parent Element:	Notes

Field Type:

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

Content id

XML Element Name:	ContentId
Parent Element:	NoteAttachment

Field Type:

Text

Action Type:

Import und Export

Field Length: 180

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

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

Attachment name

XML Element Name:	Attachmentname
Parent Element:	NoteAttachment

Field Type:

Text

Action Type:

Import und Export

Field Length: 255

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

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

File path

XML Element Name:	FilePath
Parent Element:	NoteAttachment

Field Type:

Binary data

Action Type:

Import und Export

Field Length: -

Decimal Places: 0

Mandatory Field: Yes

Revision: 0

Ascii ID : 1

Description:

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