Schnittstelle: SHOP - XML Participant Version 2019.50

Dieses Dokument beschreibt die AbaConnect-Schnittstelle XML Participant der Applikation SHOP .


Allgemeine Informationen

Allgemeine Informationen zur Schnittstelle.

AbaConnect Schnittstellen Information
Applikation:SHOP
Schnittstellen-Name:XML Participant
ID:XML Participant ( Masterdata )
Version:2019.50
Status:Productiv


Mögliche Export- und Import-Funktionen der Schnittstelle

Export / Import Funktionen
Export:XML
Import:XML


Zusätzliche Informationen zur Schnittstelle

Zusatzinformation

                                  Höchste Feld Revision für dieser Schnittstelle : 0



Mapping Informationen

Im Folgenden werden die Informationen über das Mapping angezeigt.

Mapping Informationen
Mapping ID:AbaDefault
Mapping Name:E-Business Netzwerk Teilnehmer-Identifikation
Beschreibung:

                



Beispiel AbaConnect XML-Struktur

Es folgt ein Beispiel einer XML Header-Struktur. Diese Information kann man auch in einer AbaConnect XML-Exportdatei anschauen, die über die Abacus AbaConnect Maske exportiert wurde.

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>
      <!-- Achtung : Die Mandantennummer ist optional und bedeutet, dass die Daten nur in den definierten Mandanten importiert werden können -->
      <!-- Die Option Mandant hat nur beim Datenimport einen Einfluss. Dies kann in den AbaConnect Export-Einstellungen konfiguriert werden. -->
      <!-- Die Mandantennummer wird standardmässig nicht in die Export-Datei geschrieben -->
      <Mandant>7777</Mandant>
    </Parameter>
    <Transaction>
      <Participant mode='SAVE'>
          <!-- Hier können spezifische Datenfelder für die AbaConnect Schnittstelle definiert werden. -->
      </Participant>
    </Transaction>
  </Task>
</AbaConnectContainer>



Beispiel AbaConnect Command Line

Es folgen Beispiele für die AbaConnect Command Line. AbaConnect Command Line wird mit den Programmen abaconnectexportconsole.exe und abaconnectimportconsole.exe ausgeführt. Die AbaConnect Command Line muss direkt auf dem Abacus Server ausgeführt werden. Detaillierte Informationen über AbaConnect Command Line sind auf der Abacus Homepage zu finden. Die folgenden Beispiele dienen als Ausgangspunkt für die Erstellung einer einfachen 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. : Beim Import von XML-Daten muss die Schnittstellen-ID und das Mapping auf der Command Line nicht angegeben werden. Diese Information ist in der XML Import-Datei enthalten.



Mapping Felder / Struktur

Die folgende Tabelle zeigt die Daten des Mappings in vereinfachter Form an.
Das XML-Element und der Parent-Name werden immer in Englisch geschrieben. Mit einem Mausklick auf eine Zeile werden zusätzliche Informationen angezeigt.

XML Element Name Feld Name Parent Name Typ Feld Länge Zwingend
ParticipantTeilnehmer---Ja
    FieldMappingAssignmentDokumentmappingParticipant--Nein
        - DirectionRichtungFieldMappingAssignmentNummer2Ja
        - DocumentTypeDokumentartFieldMappingAssignmentNummer4Ja
        - ModuleModulFieldMappingAssignmentNummer2Ja
        - ValidFromGültig abFieldMappingAssignmentDatum/Zeit-Nein
        - ValidUntilGültig bisFieldMappingAssignmentDatum/Zeit-Nein
        - MappingIDVerknüpfungFieldMappingAssignmentNummer10Nein
        - OutboundSendPaperDocumentZusätzlich in Papierform ausdruckenFieldMappingAssignmentBoolean-Nein
        - OutboundSendPdfDocumentAls PDF versendenFieldMappingAssignmentBoolean-Nein
        - OutboundAttachDossierToPdfDossierinhalt an PDF anfügenFieldMappingAssignmentNummer1Nein
        - OutboundTestDocumentTestdokumentFieldMappingAssignmentBoolean-Nein
        - OutboundSuppressTotalZeroIgnorieren bei Totalbetrag 0.00FieldMappingAssignmentBoolean-Nein
        - OutboundSubmitDocumentsAutomatisch versendenFieldMappingAssignmentBoolean-Nein
        - OutboundAttachDocumentFromDiskVerzeichnisinhalt an PDF anfügenFieldMappingAssignmentBoolean-Nein
        - InboundTestDocumentProcessingTestdokumente automatisch verarbeitenFieldMappingAssignmentBoolean-Nein
        - InboundDocumentProcessingAutomatisch verarbeitenFieldMappingAssignmentBoolean-Nein
        - InboundGenerateProjectOrderOrOfferProjektauftrag generierenFieldMappingAssignmentBoolean-Nein
        - InboundCopyPdfToFolderPDF in Verzeichnis kopierenFieldMappingAssignmentBoolean-Nein
        - InboundCopyPdfToDossierPDF in Dossier ablegenFieldMappingAssignmentNummer1Nein
        - InboundCopyPdfAttachmentsToFolderPDF-Anhänge in Verzeichnis kopierenFieldMappingAssignmentBoolean-Nein
        - InboundCopyPdfAttachmentsToDossierPDF-Anhänge in Dossier ablegenFieldMappingAssignmentNummer1Nein
        - ProcessRuleNumberRegelsetFieldMappingAssignmentNummer10Nein
    - DivisionGeschäftsbereichParticipantNummer8Nein
    - IdentificationTypeIdentifikationstypParticipantNummer2Ja
    - IdentificationNumberTeilnehmer-Nr.ParticipantNummer10Ja
    - NetworkNumberNetzwerk-Nr.ParticipantNummer4Ja
    - AddressNumberAdress-Nr.ParticipantNummer10Ja
    - SubjectNumberKontakt-Nr.ParticipantNummer10Nein
    - ReceiverIDEmpfänger-IDParticipantText100Nein
    - SenderIDAbsender-IDParticipantText100Nein
    - SubIDZusatz-IDParticipantText50Nein
    - ValidFromGültig abParticipantDatum/Zeit-Nein
    - ValidUntilGültig bisParticipantDatum/Zeit-Nein



Detaillierte Feld-Informationen

Detaillierte Beschreibung der Schnittstellen-Felder.

Dokumentmapping
XML Element Name:FieldMappingAssignment
Parent Element:Participant
Feld Typ:ID
Action Typ:Import und Export
Feld Länge:   1Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                

Richtung
XML Element Name:Direction
Parent Element:FieldMappingAssignment
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   2Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "Direction")
                    

Dokumentart
XML Element Name:DocumentType
Parent Element:FieldMappingAssignment
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   4Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   -
Beschreibung:
Siehe PED.DocType
(Den internen Feld ID für dieses Element ist "DocType")

Modul
XML Element Name:Module
Parent Element:FieldMappingAssignment
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   2Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "Module")
                    

Gültig ab
XML Element Name:ValidFrom
Parent Element:FieldMappingAssignment
Feld Typ:Datum/Zeit (2006-08-08T10:16:54.509+02:00)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "ValidFrom")
                    

Gültig bis
XML Element Name:ValidUntil
Parent Element:FieldMappingAssignment
Feld Typ:Datum/Zeit (2006-08-08T10:16:54.509+02:00)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "ValidUntil")
                    

Verknüpfung
XML Element Name:MappingID
Parent Element:FieldMappingAssignment
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   10Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "PamId")
                    

Zusätzlich in Papierform ausdrucken
XML Element Name:OutboundSendPaperDocument
Parent Element:FieldMappingAssignment
Feld Typ:Boolean (true oder false)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "SendPaperDocument")
                    

Als PDF versenden
XML Element Name:OutboundSendPdfDocument
Parent Element:FieldMappingAssignment
Feld Typ:Boolean (true oder false)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "SendPdfDocument")
                    

Dossierinhalt an PDF anfügen
XML Element Name:OutboundAttachDossierToPdf
Parent Element:FieldMappingAssignment
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   1Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "AttachPdfDocument")
                    

Testdokument
XML Element Name:OutboundTestDocument
Parent Element:FieldMappingAssignment
Feld Typ:Boolean (true oder false)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "OutboundTestDocument")
                    

Ignorieren bei Totalbetrag 0.00
XML Element Name:OutboundSuppressTotalZero
Parent Element:FieldMappingAssignment
Feld Typ:Boolean (true oder false)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "OutboundSuppressTotalZero")
                    

Automatisch versenden
XML Element Name:OutboundSubmitDocuments
Parent Element:FieldMappingAssignment
Feld Typ:Boolean (true oder false)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "OutboundSubmitDocuments")
                    

Verzeichnisinhalt an PDF anfügen
XML Element Name:OutboundAttachDocumentFromDisk
Parent Element:FieldMappingAssignment
Feld Typ:Boolean (true oder false)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "AttachDocumentFromDisk")
                    

Testdokumente automatisch verarbeiten
XML Element Name:InboundTestDocumentProcessing
Parent Element:FieldMappingAssignment
Feld Typ:Boolean (true oder false)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "InboundProcessTestDocuments")
                    

Automatisch verarbeiten
XML Element Name:InboundDocumentProcessing
Parent Element:FieldMappingAssignment
Feld Typ:Boolean (true oder false)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "InboundProcessDocuments")
                    

Projektauftrag generieren
XML Element Name:InboundGenerateProjectOrderOrOffer
Parent Element:FieldMappingAssignment
Feld Typ:Boolean (true oder false)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "InboundGenerateProjectOrderOrOffer")
                    

PDF in Verzeichnis kopieren
XML Element Name:InboundCopyPdfToFolder
Parent Element:FieldMappingAssignment
Feld Typ:Boolean (true oder false)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "PdfCopy")
                    

PDF in Dossier ablegen
XML Element Name:InboundCopyPdfToDossier
Parent Element:FieldMappingAssignment
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   1Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "PdfDossier")
                    

PDF-Anhänge in Verzeichnis kopieren
XML Element Name:InboundCopyPdfAttachmentsToFolder
Parent Element:FieldMappingAssignment
Feld Typ:Boolean (true oder false)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "PdfAttachmentsCopy")
                    

PDF-Anhänge in Dossier ablegen
XML Element Name:InboundCopyPdfAttachmentsToDossier
Parent Element:FieldMappingAssignment
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   1Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "PdfAttachmentsDossier")
                    

Regelset
XML Element Name:ProcessRuleNumber
Parent Element:FieldMappingAssignment
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   10Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "ProcessRuleNumber")
                    

Geschäftsbereich
XML Element Name:Division
Parent Element:Participant
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   8Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "Division")
                    

Identifikationstyp
XML Element Name:IdentificationType
Parent Element:Participant
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   2Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "PeiType")
                    

Teilnehmer-Nr.
XML Element Name:IdentificationNumber
Parent Element:Participant
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   10Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "PeiNr")
                    

Netzwerk-Nr.
XML Element Name:NetworkNumber
Parent Element:Participant
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   4Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "NetworkNumber")
                    

Adress-Nr.
XML Element Name:AddressNumber
Parent Element:Participant
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   10Dezimal-Stellen:   0Zwingendes Feld:   JaRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "AdrINr")
                    

Kontakt-Nr.
XML Element Name:SubjectNumber
Parent Element:Participant
Feld Typ:Nummer
Action Typ:Import und Export
Feld Länge:   10Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "SubjectNumber")
                    

Empfänger-ID
XML Element Name:ReceiverID
Parent Element:Participant
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   100Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:
PeiType 1: An diese Adresse sendet eine externe Firma
                  PeiType 2: Diese Adresse verwenden um einer externen Firma etwas zu senden.
                
(Den internen Feld ID für dieses Element ist "ReceiverId")

Absender-ID
XML Element Name:SenderID
Parent Element:Participant
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   100Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:
PeiType 1: Diese Adresse als Absender-Adresse verwenden
                  PeiType 2: Die externe Firma verwendet diese als Absender-Adresse.
                
(Den internen Feld ID für dieses Element ist "SenderId")

Zusatz-ID
XML Element Name:SubID
Parent Element:Participant
Feld Typ:Text
Action Typ:Import und Export
Feld Länge:   50Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "SubId")
                    

Gültig ab
XML Element Name:ValidFrom
Parent Element:Participant
Feld Typ:Datum/Zeit (2006-08-08T10:16:54.509+02:00)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "ValidFrom")
                    

Gültig bis
XML Element Name:ValidUntil
Parent Element:Participant
Feld Typ:Datum/Zeit (2006-08-08T10:16:54.509+02:00)
Action Typ:Import und Export
Feld Länge:   -Dezimal-Stellen:   0Zwingendes Feld:   NeinRevision:   0Ascii ID :   -
Beschreibung:

                                (Den internen Feld ID für dieses Element ist "ValidUntil")