Interface: SHOP - XML Participant Version 2019.50

This documentation describes the AbaConnect Interface XML Participant for the SHOP Application.

General Information

General information about the AbaConnect interface.

AbaConnect Interface Information

Application :	SHOP
Interface Name :	XML Participant
ID :	XML Participant ( Masterdata )
Version :	2019.50
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 :	E-Business Network Participant Identification
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>SHOP</Application>
      <Id>XML Participant</Id>
      <MapId>AbaDefault</MapId>
      <Version>2019.50</Version>
      
      
      
      <Mandant>7777</Mandant>
    </Parameter>
    <Transaction>
      <Participant mode='SAVE'>
          
      </Participant>
    </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" "-aSHOP" "-version2019.50" "-M7777" "-acidXML Participant" "-mapidAbaDefault" "-datamodeXML" "-responseYES" "-responsefileX:\response.xml" "-exportfileX:\data.xml"

Import :
abaconnectimportconsole.exe "/USRuser" "/PWxxx" "-aSHOP" "-version2019.50" "-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
+ Participant	Participant	-	-	-	Yes
+ FieldMappingAssignment	Document mapping	Participant	-	-	No
- Direction	Direction	FieldMappingAssignment	Number	2	Yes
- DocumentType	Document type	FieldMappingAssignment	Number	4	Yes
- Module	Module	FieldMappingAssignment	Number	2	Yes
- ValidFrom	Valid from	FieldMappingAssignment	Date/Time	-	No
- ValidUntil	Valid to	FieldMappingAssignment	Date/Time	-	No
- MappingID	Link	FieldMappingAssignment	Number	10	No
- OutboundSendPaperDocument	Print additionally in paper form	FieldMappingAssignment	Boolean	-	No
- OutboundSendPdfDocument	Send as PDF	FieldMappingAssignment	Boolean	-	No
- OutboundAttachDossierToPdf	Add dossier content to PDF	FieldMappingAssignment	Number	1	No
- OutboundTestDocument	Test document	FieldMappingAssignment	Boolean	-	No
- OutboundSuppressTotalZero	Ignore when total amount is 0.00	FieldMappingAssignment	Boolean	-	No
- OutboundSubmitDocuments	Send automatically	FieldMappingAssignment	Boolean	-	No
- OutboundAttachDocumentFromDisk	Add directory content to PDF	FieldMappingAssignment	Boolean	-	No
- InboundTestDocumentProcessing	Automatically process test documents	FieldMappingAssignment	Boolean	-	No
- InboundDocumentProcessing	Process automatically	FieldMappingAssignment	Boolean	-	No
- InboundGenerateProjectOrderOrOffer	Generate project order	FieldMappingAssignment	Boolean	-	No
- InboundCopyPdfToFolder	Copy PDF to directory	FieldMappingAssignment	Boolean	-	No
- InboundCopyPdfToDossier	File PDF in dossier	FieldMappingAssignment	Number	1	No
- InboundCopyPdfAttachmentsToFolder	Copy PDF attachments to directory	FieldMappingAssignment	Boolean	-	No
- InboundCopyPdfAttachmentsToDossier	File PDF attachment to dossier	FieldMappingAssignment	Number	1	No
- ProcessRuleNumber	Rule set	FieldMappingAssignment	Number	10	No
- Division	Division	Participant	Number	8	No
- IdentificationType	Identification type	Participant	Number	2	Yes
- IdentificationNumber	ID	Participant	Number	10	Yes
- NetworkNumber	Network no.	Participant	Number	4	Yes
- AddressNumber	Address no.	Participant	Number	10	Yes
- SubjectNumber	Contact no.	Participant	Number	10	No
- ReceiverID	Recipient ID	Participant	Text	100	No
- SenderID	Sender ID	Participant	Text	100	No
- SubID	Sub-ID	Participant	Text	50	No
- ValidFrom	Valid from	Participant	Date/Time	-	No
- ValidUntil	Valid to	Participant	Date/Time	-	No

Field Information

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

Document mapping

XML Element Name:	FieldMappingAssignment
Parent Element:	Participant

Field Type:

Action Type:

Import und Export

Field Length: 1

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

Direction

XML Element Name:	Direction
Parent Element:	FieldMappingAssignment

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 2

Decimal Places: 0

Mandatory Field: Yes

Revision: 0

Ascii ID : -

Description:

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

Document type

XML Element Name:	DocumentType
Parent Element:	FieldMappingAssignment

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 4

Decimal Places: 0

Mandatory Field: Yes

Revision: 0

Ascii ID : -

Description:

See PED.DocType

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

Module

XML Element Name:	Module
Parent Element:	FieldMappingAssignment

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 2

Decimal Places: 0

Mandatory Field: Yes

Revision: 0

Ascii ID : -

Description:

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

Valid from

XML Element Name:	ValidFrom
Parent Element:	FieldMappingAssignment

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:

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

Valid to

XML Element Name:	ValidUntil
Parent Element:	FieldMappingAssignment

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:

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

Link

XML Element Name:	MappingID
Parent Element:	FieldMappingAssignment

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

Print additionally in paper form

XML Element Name:	OutboundSendPaperDocument
Parent Element:	FieldMappingAssignment

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

Send as PDF

XML Element Name:	OutboundSendPdfDocument
Parent Element:	FieldMappingAssignment

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

Add dossier content to PDF

XML Element Name:	OutboundAttachDossierToPdf
Parent Element:	FieldMappingAssignment

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 1

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

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

Test document

XML Element Name:	OutboundTestDocument
Parent Element:	FieldMappingAssignment

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

Ignore when total amount is 0.00

XML Element Name:	OutboundSuppressTotalZero
Parent Element:	FieldMappingAssignment

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

Send automatically

XML Element Name:	OutboundSubmitDocuments
Parent Element:	FieldMappingAssignment

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

Add directory content to PDF

XML Element Name:	OutboundAttachDocumentFromDisk
Parent Element:	FieldMappingAssignment

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

Automatically process test documents

XML Element Name:	InboundTestDocumentProcessing
Parent Element:	FieldMappingAssignment

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

Process automatically

XML Element Name:	InboundDocumentProcessing
Parent Element:	FieldMappingAssignment

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

Generate project order

XML Element Name:	InboundGenerateProjectOrderOrOffer
Parent Element:	FieldMappingAssignment

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

Copy PDF to directory

XML Element Name:	InboundCopyPdfToFolder
Parent Element:	FieldMappingAssignment

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

File PDF in dossier

XML Element Name:	InboundCopyPdfToDossier
Parent Element:	FieldMappingAssignment

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 1

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

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

Copy PDF attachments to directory

XML Element Name:	InboundCopyPdfAttachmentsToFolder
Parent Element:	FieldMappingAssignment

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

File PDF attachment to dossier

XML Element Name:	InboundCopyPdfAttachmentsToDossier
Parent Element:	FieldMappingAssignment

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 1

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

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

Rule set

XML Element Name:	ProcessRuleNumber
Parent Element:	FieldMappingAssignment

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

Division

XML Element Name:	Division
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 "Division")

Identification type

XML Element Name:	IdentificationType
Parent Element:	Participant

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 2

Decimal Places: 0

Mandatory Field: Yes

Revision: 0

Ascii ID : -

Description:

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

XML Element Name:	IdentificationNumber
Parent Element:	Participant

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 10

Decimal Places: 0

Mandatory Field: Yes

Revision: 0

Ascii ID : -

Description:

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

Network no.

XML Element Name:	NetworkNumber
Parent Element:	Participant

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 4

Decimal Places: 0

Mandatory Field: Yes

Revision: 0

Ascii ID : -

Description:

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

Address no.

XML Element Name:	AddressNumber
Parent Element:	Participant

Field Type:

Nummer

Action Type:

Import und Export

Field Length: 10

Decimal Places: 0

Mandatory Field: Yes

Revision: 0

Ascii ID : -

Description:

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

Contact no.

XML Element Name:	SubjectNumber
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 "SubjectNumber")

Recipient ID

XML Element Name:	ReceiverID
Parent Element:	Participant

Field Type:

Text

Action Type:

Import und Export

Field Length: 100

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

PeiType 1: An external company sends to this address
                  PeiType 2: Use this address to send something to an external company.

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

Sender ID

XML Element Name:	SenderID
Parent Element:	Participant

Field Type:

Text

Action Type:

Import und Export

Field Length: 100

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

PeiType 1: Use this address as sender address
                  PeiType 2: The external company uses it as sender address.

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

Sub-ID

XML Element Name:	SubID
Parent Element:	Participant

Field Type:

Text

Action Type:

Import und Export

Field Length: 50

Decimal Places: 0

Mandatory Field: No

Revision: 0

Ascii ID : -

Description:

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

Valid from

XML Element Name:	ValidFrom
Parent Element:	Participant

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:

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

Valid to

XML Element Name:	ValidUntil
Parent Element:	Participant

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:

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