Dokumente über den Business Integration Service importieren

In dieser Dokumentation werden die Vorgehensweisen für den Umgang mit der Anwen­dung Daten importieren bezogen auf Dokumente beschrieben. Diese Vorgehensweise ent­hält allgemeine Anleitungsschritte und Sie werden außerdem über mögliche Vorausset­zungen und Auswirkungen informiert.

Die Beschreibung der Anwendung Daten importieren, die unter ande­rem auch Feld- und Button-Beschreibungen enthält, finden Sie in der Dokumentation Daten importieren.

Begriffsbestimmung

  • Dokumentarten – Die Dokumentart ist Teil der Identifikation eines Dokuments. Dokumentart und Nummer identifizieren ein Dokument eindeutig. Mit der Dokumentart werden Vorschlagswerte für ein Dokument festgelegt. So kann z. B. eine Dokumentvorlage hinterlegt werden, nach welcher weitere Dokumente dieser Art erzeugt werden. Mit der Dokumentart bestimmen Sie außerdem, welche weiteren Felder im Dokument angezeigt werden und zu füllen sind.
  • Dokument – Ein Dokument ist ein Objekt, mit dem Sie Dokumentdateien verwalten und Verknüpfungen zu anderen Objekten im ERP-System herstellen. Ein Dokument ist wie ein virtueller Umschlag für die Metadaten zu einem Dokument und für die Dokumentdateien (physische Dateien, die im Knowledge Store abgelegt werden). Außerdem dient das Dokument dazu, neue Dokumentdateien zu erstellen, indem Adressaten und eine Dokumentvorlage dem Dokument hinzugefügt werden. Daraus erzeugt das ERP-System eine neue Dokumentdatei, beispielsweise einen Serienbrief.
  • Notizen – Mit einer Notiz können individuelle Informationen zu Business Entitys erfasst werden. Beispielsweise können Sie mit einer Notiz einen Vertriebsauftrag kommentieren. Eine Notiz ist ein spezieller Dokumenttyp, der stets verfügbar ist, auch wenn Sie das Dokumenten-Management nicht nutzen. Die Dokument-Datei einer Notiz wird mit dem gewählten Business Entity verknüpft und im HTML-Format im Knowledge Store abgelegt.
  • Dokument-Vorlage – Eine Dokument-Vorlage dient dem standardisierten Erfassen oder Erzeugen von Dokumenten oder Notizen. Die Vorlage ist wiederum ein Dokument, welches möglicherweise mit einer Dokument-Datei verbunden ist.
  • Adressaten – Einem Dokument können beliebig viele Adressaten zugeordnet werden, beispielsweise für Serienbriefe oder Serien-E-Mails. Die Adressaten können vorhandene Partner im ERP-System sein oder völlig frei erfasst werden, ohne dass ein zugehöriger Partner existiert. Die vom Partner übernommene Adresse ist eine Kopie der Stammdaten und kann verändert werden.
  • Dokument-Verknüpfungsarten – Dokument-Verknüpfungsarten dienen der Klassifizierung der Dokumente. Angeboten werden vordefinierte Arten:
    • für Grafiken, wie Logos zu Partner und Artikel, und
    • für Marketing-Informationen, die ausschließlich im Beziehungs-Management verwendet werden.

    Darüber hinaus können selbst definierte Dokument-Verknüpfungsarten in der Anwendung Customizing für Partner, Aufträge und sonstige Belege für Vertrieb, Beschaffung, Produktion, Lagerlogistik und Versand hinterlegt werden. Diese werden herangezogen, wenn Sie die vom System erzeugten Dokumentdateien automatisch im Dokumenten-Management ablegen möchten. Außerdem können Sie weitere Arten für Verknüpfungen zu Dokumenten verwenden

  • Dokument-Datei – Die Dokument-Datei ist die physische Datei, die im Knowledge Store abgelegt wird. Die Dateien können einem beliebigen MIME-Type-Format entsprechen. So können beispielsweise sowohl Text-, Grafik- als auch Audio-Dateien im Knowledge Store abgelegt werden.

Allgemeines

Lesen Sie nachfolgend allgemeine Informationen zu Dokumenten. Sie erfahren, wie die zu importierenden Datenobjekte zusammengesetzt sind.

Dokumente bestehen aus Basisdaten und aus folgenden Datenobjekten, die Teil des Dokuments sind und nicht separat, sondern nur mit Zuordnung zu einem eindeutig identifizierten Dokument importiert werden:

  • Prüferzuordnungen
  • Dokumentverknüpfungen
  • Daten der Weiteren Felder
  • Dokumenthistorie
  • Dokumentinhalt
  • Dokumentadressaten

Vorgehensweisen

Lesen Sie nachfolgend, die Vorgehensweisen beim Import von Dokumenten:

Daten importieren

  1. Öffnen Sie die Anwendung Daten importieren.
  2. Lassen Sie sich den bzw. einen Filter für das Business Object com.cisag.app.general.docman.obj.Documentanzeigen.
    → Der Filter für den Import der Daten wird angezeigt.
  1. Die ausgewählten Attribute des Filters sind bereits markiert. Bei Bedarf können Sie die Attribute noch anpassen.
  2. Drücken Sie in der Standard-Symbolleiste den Button [Daten importieren].
    → Das Dialogfenster Daten importieren wird geöffnet.
  1. In diesem Dialogfenster können Sie Einstellung für die Importdatei vornehmen. Eine ausführliche Beschreibung der Felder finden Sie in der Dokumentation Daten importieren im gleichnamigen Abschnitt.
  2. Durch Drücken des Buttons Im Hintergrund oder Sofort können Sie den Import durchführen.
Hinweis
Beim Import von Daten ist die Option Verarbeitung im Hintergrund nur für voneinander unabhängige Daten empfohlen.

Notwendige Attribute für den Import

Geben Sie mindestens folgende Attribute pro Business Entity an:

  • Identifikationsattribute (Business Key)
  • Pflichtfelder

Ohne die Identifikationsattribute kann das Business Entity nicht zugeordnet werden und fehlt ein Pflichtfeld wird in jedem Fall die Nachbearbeitung gestartet. Die Pflichtfelder und Identifikationsattribute der einzelnen Business Objects werden im Abschnitt Übersicht: Identifikations- und Pflichtfelder zusammengestellt.

Zusätzlich gibt es noch Beziehungen zu anderen Business Objects, die nicht direkt zum Business Entity Dokument gehören (Beziehungen über Fremdschlüssel, erkennbar durch Kursivschrift im Filter). Um diese Beziehungen auflösen zu können, müssen die Identifikationsattribute dieser Business Objects im Filter ausgewählt werden. Über Fremdschlüssel referenzierte Daten können nicht gemeinsam importiert werden. Sie müssen bereits im System vorhanden sein. Werden über die Fremdschlüssel-Beziehung andere Attribute angegeben als deren Identifikationsattribute, so werden diese ignoriert.

Wenn der Primärschlüssel eines Business Objects ganz oder teilweise aus Fremdschlüsseln besteht, dann muss in der Importdatei das Business Object, auf das sich dieser Fremdschlüssel bezieht, über seine Identifikationsattribute aufgelöst werden.

Zum Beispiel enthält ein Dokument das Attribut type. Dieses Attribut bezieht sich auf die Dokumentart, die über die Fremdschlüssel-Beziehung durch eine Identifikation (String) spezifiziert werden kann.

Import neuer Dokumente

In der Importdatei müssen alle Identifikations- und Pflichtattribute der Basisdaten angegeben werden. Prüferzuordnungen, Dokumentverknüpfungen, die Daten der Weiteren Felder, Dokumenthistorie, Dokumentinhalt und Dokumentadressaten können sowohl in der gleichen, als auch in einer separaten Importdatei angeben werden.

Lesen Sie die Dokumentation zur Anwendung Daten importieren, um zu erfahren, wie separate Importdateien verknüpft werden.

Beispiel für das Importieren neuer Dokumente mit einer Importdatei:

Type number description Approvers.
Partner
content
456 00124 Kundenbrief von Kunde K19347 zu Artikel A1745. M34 content50.doc
455 12678 Antwort zu Kundenbrief 456-00124 an Kunde K19347. M34 content51.doc

Aktualisieren vorhandener Dokumente

Voraussetzung für diesen Weg des Imports von Dokumenten ist, dass die Basisdaten bereits erfolgreich importiert wurden. In der Importdatei müssen lediglich die Identifikationsattribute (type, number) der Basisdaten angegeben werden. Sollten andere Attribute der Basisdaten angegeben werden, werden die vorhandenen Daten überschrieben.

Sie sollten diese Importmöglichkeit nur zum Aktualisieren von Dokumenten anwenden. Der getrennte Import von Daten führt zu Performance-Einbußen.

Beispiel einer Importdatei für das Aktualisieren von Prüfern:

Type number Approvers.Partner
456 00124 M56
455 12678 M56

Besonderheiten

Dokumentinhalt

Der Dokumentinhalt für Dokumente und Notizen befindet sich in der Dokumentdatei. Möchten Sie ein Dokument mit Dokumentdatei importieren, so legen Sie die Datei im gleichen Ordner des Knowledge Store ab, in dem sich auch die Importdatei befindet. Um Namenskonflikte zu vermeiden, kann der Dateiname der zu importierenden Dokumentdatei beliebig sein. Mit dem Attribut contentgeben Sie den festgelegten Dateinamen an. Den endgültigen Dateiname und den Speicherort im Knowledge Store bestimmen Sie mit dem Attribut uri. Ordner die Sie im Attribut uriangegeben haben werden vom System angelegt, wenn sie nicht vorhanden sind. Sie brauchen somit vor dem Import die Verzeichnisstruktur nicht vorbereiten.

Dokumenthistorie

Die Dokumenthistorie kann nur beim Erfassen eines neuen Dokuments importiert werden. Wenn Sie in der Importdatei Historieneinträge für vorhandene Dokumente angeben, so werden diese ignoriert.

Dokumentverknüpfungen

Mit Dokumentverknüpfungen stellen Sie eine Beziehung des Dokuments mit beliebigen anderen Business Entitys her. Zur Identifikation des verknüpften Business Entitys wird das Attribut instancemit folgender Notation des Attributwertes erwartet:

be=<vollqualifizierter Name des BusinessEntities>&<Business Entity Key Attribut1>=<Wert>&<Business Entity Key Attribut2>=<Wert>...

 

Beispiel csv-Format: be=com.cisag.app.sales.obj.SalesOrder&Number=VA0555&Type=AD1
Beispiel xml-Format: be=com.cisag.app.sales.obj.SalesOrder&amp;Number=VA0555&amp;Type=AD1

Hinweis
Beachten Sie, dass die Notation das Sonderzeichen „&“ enthält. Zu weiterführenden Information wie Sonderzeichen in den einzelnen Import-Dateiformaten geschrieben werden lesen sie die Dokumentation Einführung: Datenaustausch.

Dokumentadressaten

Die Angabe des Adressaten verfügt nicht über eine eigene Identifikation. Um vorhandene Dokumentadressaten ändern zu können, müssen folgende Attribute mit dem gespeicherten Adressaten übereinstimmen:

Attributpfad Bezeichnung Fremdschlüssel-Beziehung
DocumentAddresses.nameAdress.partner Partner DocumentAddresses.nameAdress.Partner
DocumentAddresses.nameAdress.name[0] Name1 des Partners
DocumentAddresses.nameAdress.contact Ansprechpartner DocumentAddresses.nameAdress.ContactPartner
DocumentAddresses.nameAdress.contactName.surname Nachname des Ansprechpartners

Wird über die Identifikationsattribute ein Adressat gefunden, so geht das System davon aus, dass Sie den Adressaten ändern möchten. Alle weiteren Attribute der Partattribute nameAddressund addressDatawerden ignoriert. Alle Änderungen müssen in den Zusatzattributen newNameAddressund newAddressDataenthalten sein.

Wird über die Identifikationsattribute kein Adressat gefunden, so geht dass System davon aus, dass Sie den Adressaten hinzufügen möchten. Der neue Adressat wird mit den Angaben der Partattribute nameAddressund addressDataerfasst. Die Angaben der Zusatzattribute newNameAddressund newAddressDatawerden ignoriert.

Beispiel für die Änderung des Ansprechpartners eines Dokumentadressaten:

Type number Document­Adresses.
nameAddress.
name[0]
Document­Adresses.
nameAddress.
ContactPartner
Document­Adresses.
newNameAddress.
ContactPartner
456 00124 Mandesmann AG 71001 71002
Archivierte Dokumente

Ein in einem externen Archivsystem abgelegtes Dokument, kann in das ERP-System importiert werden. Hierzu geben Sie die Archiv-ID, des Dokuments mit dem Attribut externalDocumentIdan. Die Ziel-URI (Attribut uri) und die Dokument-Datei (Attribut content) dürfen für archivierte Dokumente nicht angegeben werden.

Type number kind externalDocumentId
456 00124 DOCUMENT DOC91001

Übersicht: Identifikations- und Pflichtfelder

In diesem Kapitel werden die Identifikations- und Pflichtattribute zusammengestellt.

Basisdaten

Attributpfad Bezeichnung Fremdschlüssel-Beziehung
type (K) Dokumentart Type
number (K) Dokumentnummer
kind Dokumenttyp (Dokument oder Notiz)
description Bezeichnung
uri Speicherort eines Dokuments, für Notizen kein Pflichtattribut

Prüferzuordnungen

Attributpfad Bezeichnung Fremdschlüssel-Beziehung
Approvers.partner Prüfer Approvers.Partner

Dokumentverknüpfungen

Attributpfad Bezeichnung Fremdschlüssel-Beziehung
DocumentReferences.
type
Dokumentverknüpfungsart DocumentReferences.
Type
DocumentReferences.instance vollqualifizierter Name und Werte der der Business Key Attribute des verknüpften Business Entitys

Daten der Weiteren Felder

Die Weiteren Felder eines Dokuments werden durch die Dokumentart bestimmt. In der Anwendung Dokumentarten finden Sie die Information, welche Weiteren Felder Pflichtfelder sind.

Dokumenthistorie

Attributpfad Bezeichnung Fremdschlüssel-Beziehung
DocumentHistories.
employee
Mitarbeiter DocumentHistories.
Employee
DocumentHistories.
updateTime
Änderungszeitpunkt
DocumentHistories.
status
Status

Dokumentinhalt

Attributpfad Bezeichnung Fremdschlüssel-Beziehung
content Dokumentinhalt, siehe Abschnitt Dokumentinhalt

Dokumentadressaten

Attributpfad Bezeichnung Fremdschlüssel-Beziehung
DocumentAddresses.nameAdress.name[0] Name1 des Partners, Angabe alternative zu DocumentAddresses.nameAdress.contactName.surname
DocumentAddresses.nameAdress.contactName.surname Nachname des Ansprechpartners, Angabe alternative zu DocumentAddresses.nameAdress.name[0]
DocumentAddresses.addressData.city Ort
DocumentAddresses.addressData.postalCode PLZ
DocumentAddresses.addressData.country Land DocumentAddresses.addressData.Country

 

Czy ten artykuł był pomocny?