Ansicht
Dokumentation

CL_BDS_DOCUMENT_SET - BusinessDocumentSet

Fill RESBD Structure from EBP Component Structure   ABAP Short Reference  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Funktionalität

Der Business Document Service (BDS) stellt allgemeine und einfach integrierbare Dokumentenverwaltungsfunktionalität für die unterschiedlichen SAP-Anwendungen bereit. Zentraler Bestandteil dieser Dokumentenverwaltung ist die Navigationsoberfäche des Business Document Navigator (BDN). Mit dieser Benutzeroberfläche werden allgemeine Dokumentenverwaltungs-Funktionen zur Verfügung gestellt, z.B. Anzeigen, Anlegen und Löschen von Dokumenten. Diese Funktionen können von Benutzern interaktiv ausgeführt werden.

Zusätzlich bietet der BDS eine Verbindung mit den Geschäftsprozessen in einem Unternehmen, was insbesondere in den Allgemeinen Objektverknüpfungen Ausdruck findet. Zusammen mit der SAP Desktop Office Integration stellt der BDS eine solution package für die Integration allgemeiner Desktop-Office Anwendungen bereit.

Der BDS bietet folgendes:

• einfaches Handling von Desktop Office Produkten

• Unterstützung von Szenarien für

• Authoring

• Publishing

• Retrieval

• Ablage von privaten und allgemeinen Dokumenten

• Benutzeroberfläche zur

• Attributierung

• Klassifikation

• Detail- und Dokumentinformationen

• Anzeige

• Änderung

• Navigation

• Anschluß an das Change & Transport System
  
  

Zentraler Bestandteil des BDS ist die Klasse CL_BDS_DOCUMENT_SET.

Der BDS stellt eine Schnittstelle zur Verfügung, die typischerweise auf der Basis der Identifikation eines Business Document Sets und Kontextinformationen operiert. Eine Anwendung muß zur Identifikation nur ihr eigenes logisches System, ihren Klassennamen, eventuell ihren Mandanten und ihren Objekschlüssel kennen.

Die Funktionen, die von der Klasse CL_BDS_DOCUMENT_SET angeboten werden, unterteilen sich in allgemeine Funktionen, die sich auf den Business Document Set beziehen und spezielle Funktionen:

• allgemeine Funktionen

• DELETE

• GET_INFO

• GET_INFO_NEWEST_ONLY

• CALL_NAVIGATOR

• CONFIRM_CREATE/_UPDATE

• CREATE_WITH_FILES/_URL/_TABLE/AS_TABLE

• UPDATE_WITH_FILES/_URL/_TABLE/AS_TABLE

• GET_WITH_FILES/_URL/_TABLE/AS_TABLE

• DELETE_PROPERTIES

• CHANGE_PROPERTIES

• spezielle Funktionen

• Funktionen für Versionen und Varianten

- CREATE_VERSION_WITH_FILES/_URL/_TABLE/AS_TABLE

- CREATE_VARIANT_WITH_FILES/_URL/_TABLE/AS_TABLE

• Funktionen für Relationen

- GET_RELATIONS

- CREATE_RELATION

- DELETE_RELATIONS

- QUERY_RELATIONS

• Funktionen für den Transport

- GET_TRANSPORT_INFOS

Parameter

Die Identifikation des Anwendungsobjekts geschieht durch die folgenden Parameter:

• LOGICAL_SYSTEM

logisches System, Kennung der SAP-Systeminstanz

• CLASSNAME

Klassenname, Name der Anwendungsklasse

• CLASSTYPE

Klassentyp, Typ der Anwendungsklasse

• OBJKEY

Objektschlüssel

• CLIENT

Mandant
Dieser Parameter ist optional. Er muß nur bei mandantenabhängigen Dokumenten eingesetzt werden.

Das Anwendungsobjekt wird identifiziert und der zugehörige Document Set wird ermittelt, indem eine Query nach allen Dokumenten, die diesem Anwendungsobjekt zugeordnet sind, ausgeführt wird.

Ein einzelnes Dokument wird durch die folgenden Parameter spezifiziert:

• DOC_ID

Dokumenten-Identifikation

• DOC_VER_NO

Dokumenten-Versionsnummer

• DOC_VAR_ID

Dokumenten-Varianten-Identifikation

Tabellen

Signaturtabelle

Die Identifikation des Dokuments oder der Dokumente erfolgt über die Signaturtabelle, d.h. über den Parameter SIGNATURE. Über diese Tabelle wird sowohl die Anfrage als auch die Rückmeldung durchgeführt: Spezifizieren Sie, was Sie über das betreffende Dokument oder die betreffenden Dokumente wissen, dann erhalten Sie die Menge von Dokumenten zurück, die den Kriterien entsprechen. In der Signaturtabelle können Attribute von einem oder mehreren Dokumenten übergeben werden. Die Signaturtabelle hat folgende Felder:

• DOC_COUNT

Dokumenten-Zähler
Dieses Feld zählt einzelne Dokument-Varianten durch. Es kann mehrere Einträge pro Variante geben. In diesem Fall unterscheiden sich die einzelnen Einträge lediglich in den Feldern Attributname und Attributwert.

• DOC_ID

Dokumenten-Identifikation

• DOC_VER_NO

Dokumenten-Versionsnummer

• DOC_VAR_ID

Dokumenten-Variantenidentifikation

• DOC_VAR_TG

Dokumenten-Varianten-Tag
Die Art der Variante wird spezifiziert. Eine Variante kann drei Ausprägungen haben:

• Original

• Sprachvariante

• Formatvariante

• COMP_COUNT

Komponenten-Zähler

• PROP_NAME

Attributname

• PROP_VALUE

Attributwert

Je mehr Felder Sie spezifizieren, desto geringer wird die Treffermenge. Dadurch haben Sie die Möglichkeit, sich z.B. auf eine einzige Variante zu beziehen.

Komponententabelle

Die Tabelle COMPONENTS bezieht sich auf Komponenten eines Document Set. Es können Komponenten für mehrere Dokumente übergeben werden:

• DOC_COUNT

Dokumenten-Zähler
Dieses Feld zählt einzelne Dokument-Varianten durch. Es kann mehrere Einträge pro Variante geben. In diesem Fall unterscheiden sich die einzelnen Einträge lediglich in den Feldern Attributname und Attributwert.

• COMP_COUNT

Komponentenzähler eines Dokuments
Der Zähler wird hinaufgesetzt, wenn es mehrere Komponenten eines Dokuments gibt.

• COMP_ID

Komponenten-Identifikation

• MIMETYPE

Mime-Type der Komponente

• COMP_SIZE

Größe der Komponente

Dateientabelle

Die Tabelle FILES dient der Handhabung von Inhalten über lokale Dateien. In dieser Tabelle werden die folgenden Felder spezifiziert:

• DOC_COUNT

Dokumenten-Zähler
Dieses Feld zählt einzelne Dokument-Varianten durch. Es kann mehrere Einträge pro Variante geben. In diesem Fall unterscheiden sich die einzelnen Einträge lediglich in den Feldern Attributname und Attributwert.

• COMP_COUNT

Komponentenzähler eines Dokuments
Der Zähler wird hinaufgesetzt, wenn es mehrere Komponenten eines Dokuments gibt.

• DIRECTORY

Name des Quellverzeichnisses

• FILENAME

Dateiname

• MIMETYPE

Mime-Type der Komponente

URL-Tabelle

In der URL-Tabelle wird der Inhalt über URLs transferiert, d.h. es werden fertige URLs übergeben. Somit wird spezifiziert, wohin die Dokumente abgelegt werden können. Die URL-Tabelle hat folgende Felder:

• DOC_COUNT

Dokumenten-Zähler
Dieses Feld zählt einzelne Dokument-Varianten durch. Es kann mehrere Einträge pro Variante geben. In diesem Fall unterscheiden sich die einzelnen Einträge lediglich in den Feldern Attributname und Attributwert.

• COMP_COUNT

Komponentenzähler eines Dokuments
Der Zähler wird hinaufgesetzt, wenn es mehrere Komponenten eines Dokuments gibt.

• URI_COUNT

URL-Zähler
In dieses Feld wird, in Abhängigkeit von URI, die Anzahl der Felder eingetragen. Die einzelnen URI-Teile werden durchnumeriert.

• URI

URL
Dieses Feld hat eine begrenzte Länge (4096 Zeichen). Sollte die URL in dieses Feld nicht vollständig hineinpassen, dann wird sie zerschnitten und ein weiteres Feld gefüllt. Daraufhin wird der Zähler URI_COUNT um eins hochgesetzt.

Inhaltstabelle

In der Tabelle CONTENT werden Inhalte selbst direkt übergeben. Die Übergabe geschieht über eine interne Tabelle. Das dazugehörige Feld heißt LINE:

• Datenelement: SDOK_SDATX

• Datentyp: RAW

• Länge: 1022

• Beschreibung: Zeile für binären Dokumentinhalt, Länge für Upload

Mehrere Komponenten unterschiedlicher Dokumente können in einer Content-Tabelle übergeben werden: Pro Komponente wird mit einer neuen Zeile begonnen, und aus der Größe der einzelnen Komponenten (Tabelle COMPONENTS) ergeben sich Anfang und Ende (Zeile x) in der Inhaltstabelle.

In der Tabelle ASCII_CONTENT werden Inhalte direkt übergeben. Die Übergabe geschieht über eine interne Tabelle. Das dazugehörige Feld heißt LINE:

• Datenelement: SDOK_SDAT

• Datentyp: CHAR

• Länge: 1022

• Beschreibung: Zeile für Textdokumentinhalt, Länge wie bei Upload

Mehrere Komponenten unterschiedlicher Dokumente können in einer Content-Tabelle übergeben werden: Pro Komponente wird mit einer neuen Zeile begonnen, und aus der Größe der einzelnen Komponenten (Tabelle COMPONENTS) ergeben sich Anfang und Ende (Zeile x) in der Inhaltstabelle.

Relationentabelle

In der Tabelle RELATIONS werden Beziehungen zwischen Dokumenten spezifiziert. Dazu sind die folgenden Attribute vorgesehen:

• DOC_COUNT

Dokumenten-Zähler
Dieses Feld zählt einzelne Dokument-Varianten durch. Es kann mehrere Einträge pro Variante geben. In diesem Fall unterscheiden sich die einzelnen Einträge lediglich in den Feldern Attributname und Attributwert.

• RELA_ID

Relations-Identifikation

Properties-Tabelle

In der Tabelle PROPERTIES werden die beiden Attribute übergeben:

• PROP_NAME

Attributname

• PROP_VALUE

Attributwert

Diese Tabelle wird für Methoden eingesetzt, die lediglich ein einziges Dokument adressieren.

Allgemeine Funktionen

ASSIGN

Diese Methode erlaubt die Zuordnung eines Dokumentes zu einem anderen Anwendungsobjekt. Übergeben wird die Kennung des Anwendungsobjektes und die Dokument-ID des betreffenden Dokumentes.

CALL_NAVIGATOR

Die Identifikation des Anwendungsobjekts (Document Set) geschieht über die im Abschnitt Parameter beschriebenen Attribute.

Dokumente werden über die Signaturtabelle identifiziert (siehe Abschnitt Tabellen).

In der Tabelle EXCLUDING können Sie angeben, welche Funktionen nicht angeboten werden sollen. Die folgenden Werte sind für EXCLUDING definiert:

• 'NO_MODIFY'

kein Bearbeiten

• 'NO_DELETE'

kein Löschen

• 'NO_TRANSPORT'

kein Transportieren

• 'NO_CREATE'

kein Anlegen

• 'NO_STANDARD_DOCS'

keine Standarddokumentarten

• 'NO_MODIFY_ATTRIS'

kein Ändern der Attribute/Schlagworte

• 'NO_COPY'

kein Kopieren

• 'NO_USER_OPTIONS'

keine benutzerspezifischen Einstellungen

• 'NO_KEYWORDS'

keine Schlagworte

• 'NO_DOCINFO'

keine Dokumenteninfo

• 'NO_DISPLAY'

keine Anzeige der Dokumente

Beispielsweise kann es sein, daß im BDN lediglich die Möglichkeit des Anzeigens von Dokumenten gegeben sein soll, d.h. die Funktionen zum Bearbeiten und Löschen werden in der Tabelle EXCLUDING explizit ausgenommen.

CHANGE_PROPERTIES

Mit dieser Methode werden die Attribute von Dokumenten verändert oder neu gesetzt.

Die Identifikation des Anwendungsobjekts (Document Set) geschieht über die im Abschnitt Parameter beschriebenen Attribute. Einzelne Dokumente werden über die Attribute spezifiziert, die ebenfalls im Abschnitt Parameter beschrieben werden. Das Verändern der Attribute geschieht über die Tabelle PROPERTIES, die im Abschnitt Tabellen beschrieben wird.

DELETE

Diese Methode dient zum Löschen von Dokumenten.

Die Identifikation des Anwendungsobjekts (Document Set) geschieht über die im Abschnitt Parameter beschriebenen Attribute.

In der Signaturtabelle (siehe Abschnitt Tabellen) wird spezifiziert, auf welche Dokumente sich das Löschen beziehen soll. Da der Objektschlüssel optional ist, kann sogar alles gelöscht werden.

GET_FAST_INFO

Diese Methode liefert kein Dokument zurück, sondern Informationen über bestehende Dokumente. Diese Informationen sind in der Signaturtabelle (siehe Abschnitt Tabellen) abgelegt. In der Signaturtabelle sind allgemeine Informationen und Attribute abgelegt. In der Komponententabelle sind technische Informationen zu den einzelnen Komponenten, aus denen die Dokumente bestehen, beinhaltet. Die Identifikation des Anwendungsobjekts (Document Set) geschieht über die im Abschnitt Parameter beschriebenen Attribute.

Im Unterschied zur Methode GET_INFO liefert die Methode GET_FAST_INFO keine Informationen über die Komponenten der Dokumente zurück und auch keine Detailinformationen über alle Einzeldokumente.

In Abhängigkeit von der Ausprägung des Parameters GET_PROPERTIES werden einige (GET_PROPERTIES = 'X') oder keine Dokumentattribute zurückgeliefert.

GET_INFO

Diese Methode liefert kein Dokument zurück, sondern Informationen über bestehende Dokumente. Diese Informationen sind in der Signatur- und Komponententabelle (siehe Abschnitt Tabellen) abgelegt. In der Signaturtabelle sind allgemeine Informationen und Attribute abgelegt. In der Komponententabelle sind technische Informationen zu den einzelnen Komponenten, aus denen die Dokumente bestehen, beinhaltet.

Die Identifikation des Anwendungsobjekts (Document Set) geschieht über die im Abschnitt Parameter beschriebenen Attribute.

GET_INFO_NEWEST_ONLY

Diese Methode liefert nur Informationen über die neueste Version eines Dokuments zurück. Damit entspricht diese Methode - bis auf das Zurückliefern der jeweils neuesten Version - der Methode GET_INFO.

QUERY_DOCUMENT

Diese Methode erlaubt eine flexible Abfragen nach Attributen von Dokumenten.

Die Selektionskriterien werden in der Tabelle QUERY spezifiziert. Jeder Eintrag liefert Einschränkungen zu einem Attribut analog der Struktur einer Ranges-Tabelle.

COPY

Mit dieser Methode kann ein Dokument kopiert werden.

Die Identifikation des Anwendungsobjekts (Document Set) geschieht über die im Abschnitt Parameter beschriebenen Attribute. Die Inhaltsversion wird durch die Attribute gekennzeichnet, die ebenfalls im Abschnitt Parameter beschrieben werden.

Ein Dokument wird kopiert und dabei wird die Verknüpfung mit kopiert. Dabei dienen die folgenden Attribute als Übergabeparameter:

• NEW_CLASSNAME

Klassenname, Name der Anwendungsklasse

• NEW_CLASSTYPE

Klassentyp, Typ der Anwendungsklasse

• NEW_OBJKEY

Objektschlüssel

• NEW_CLIENT

Mandant
Dieser Parameter ist optional. Er muß nur bei mandantenabhängigen Dokumenten eingesetzt werden.

In der Tabelle PROPERTIES werden Attributname und -wert übergeben.

Das neue Dokument wird entweder an das Ausgangs-Business Objekt oder an ein neues Dokument angehängt. Die neue Variante wird, analog zur Identifikation der Inhaltsversion, durch folgende Attribute spezifiziert:

• NEW_DOC_ID,

Dokumenten-Identifikation

• NEW_DOC_VER_NO

Dokumenten-Versionsnummer

• NEW_DOC_VAR_ID

Dokumenten-Varianten-Identifikation

Dadurch kann diese Methode sowohl zum Kopieren als auch zum Umhängen verwendet werden.

CREATE_WITH_FILES/_URL/_TABLE/_AS_TABLE

Zum Anlegen von Dokumenten stehen die folgenden vier Methoden zur Verfügung:

• CREATE_WITH_FILES

• CREATE_WITH_TABLE

• CREATE_WITH_AS_TABLE

• CREATE_WITH_URL

Diese Methoden unterscheiden sich in der Quelle, von der die Daten abgeholt werden. Die Quelle kann entweder ein Dateiname, eine Tabelle oder eine URL sein.

Die Identifikation des Anwendungsobjekts (Document Set) geschieht über die im Abschnitt Parameter beschriebenen Attribute.

Die Methode CREATE_WITH_FILES ist durch die folgenden zusätzlichen Parameter (siehe Abschnitt Tabellen) gekennzeichnet:

• FILES

• SIGNATURE

Die Methode CREATE_WITH_TABLE ist durch die folgenden zusätzlichen Parameter (siehe Abschnitt Tabellen) gekennzeichnet:

• COMPONENTS

• CONTENT

• SIGNATURE

Die Methode CREATE_WITH_AS_TABLE ist durch die folgenden zusätzlichen Parameter (siehe Abschnitt Tabellen) gekennzeichnet:

• COMPONENTS

• ASCII_CONTENT

• SIGNATURE

Die Methode CREATE_WITH_URL ist durch die folgenden zusätzlichen Parameter (siehe Abschnitt Tabellen) gekennzeichnet:

• COMPONENTS

• URIS

• SIGNATURE

Hinweis
CREATE_WITH_URL muß immer in Zusammenhang mit CONFIRM_CREATE aufgerufen werden, damit ein Dokument als erfolgreich abgelegt gekennzeichnet werden kann.
Bei dieser Methode wird lediglich eine Ziel-URL übergeben. Über CONFIRM_CREATE wird die Information weitergegeben, daß das Anlegen eines Dokuments erfolgreich war.

CREATE_WITH_OWN_URL

Diese Methode stellt eine kleine Modifikation zur Methode CREATE_WITH_URL zur Verfügung. Die Quell-URL wird in diesem Falle nicht mitgeneriert, sondern kann von außen vorgegeben werden. Dieses setzt natürlich voraus, daß der Inhalt des Dokumentes über diese URL erreicht werden kann.

Über den Parameter URL wird die Quell-URL übergeben.

Im Parameter MIMETYPE muß der MIMETYPE des Dokumentes übergeben werden.

Im Parameter BINARY_FLAG wird spezifiziert, ob der Inhalt des Dokumentes binär ist (BINARY_FLAG = 'X').

Der nachfolgende Aufruf der Methode CONFIRM_CREATE ist hierbei nicht erforderlich.

UPDATE_WITH_FILES/_URL/_TABLES

Zum Ändern von Dokumenten stehen die folgenden vier Methoden zur Verfügung:

• UPDATE_WITH_FILES

• UPDATE_WITH_TABLE

• UPDATE_WITH_AS_TABLE

• UPDATE_WITH_URL

Diese vier Methoden unterscheiden sich in der Quelle, von der die Daten abgeholt werden. Die Quelle kann entweder ein Dateiname, eine Tabelle oder eine URL sein. Bei der Tabelle kann es sich entweder um eine ASCII- oder eine Binärtabelle handeln.

Die Identifikation des Anwendungsobjekts (Document Set) und des Dokuments geschieht über die im Abschnitt Parameter beschriebenen Attribute.

Die Methode UPDATE_WITH_FILES ist durch die folgenden zusätzlichen Parameter (siehe Abschnitt Tabellen) gekennzeichnet:

• FILES

• SIGNATURE

Die Methode UPDATE_WITH_TABLE ist durch die folgenden zusätzlichen Parameter (siehe Abschnitt Tabellen) gekennzeichnet:

• COMPONENTS

• CONTENT

• SIGNATURE

Die Methode UPDATE_WITH_AS_TABLE ist durch die folgenden zusätzlichen Parameter (siehe Abschnitt Tabellen) gekennzeichnet:

• COMPONENTS

• ASCII_CONTENT

• SIGNATURE

Die Methode UPDATE_WITH_URL ist durch die folgenden zusätzlichen Parameter (siehe Abschnitt Tabellen) gekennzeichnet:

• COMPONENTS

• URIS

• SIGNATURE

Hinweis
UPDATE_WITH_URL muß immer in Zusammenhang mit CONFIRM_UPDATE aufgerufen werden, damit ein Dokument als erfolgreich geändert gekennzeichnet werden kann.
Bei dieser Methode wird lediglich eine Ziel-URL übergeben. Über CONFIRM_UPDATE wird die Information weitergegeben, daß das Ändern eines Dokuments erfolgreich war.

GET_WITH_FILES/_URL/_TABLE/_AS_TABLE

Diese Methoden dienen der Rückgabe eines Dokuments. Vier verschiedene Methoden werden zur Verfügung gestellt:

• GET_WITH_FILES

• GET_WITH_TABLE

• GET_WITH_AS_TABLE

• GET_WITH_URL

Diese vier Methoden unterscheiden sich in der Quelle, von der die Daten abgeholt werden. Die Quelle kann entweder ein Dateiname, eine Tabelle oder eine URL sein.

Die Identifikation des Anwendungsobjekts (Document Set) geschieht über die im Abschnitt Parameter beschriebenen Attribute.

Die Methode GET_WITH_FILES ist durch die folgenden zusätzlichen Parameter (siehe Abschnitt Tabellen) gekennzeichnet:

• FILES

Hier wird das Ziel-Directory in der Tabelle FILES übergeben.

• SIGNATURE

Beim Aufruf wird diese Tabelle zur Einschränkung der Treffermenge verwendet. Nach dem Aufruf wird sie zur Information genutzt.

Die Methode GET_WITH_TABLE ist durch die folgenden zusätzlichen Parameter (siehe Abschnitt Tabellen) gekennzeichnet:

• COMPONENTS

• CONTENT

• SIGNATURE

Die Methode GET_WITH_AS_TABLE ist durch die folgenden zusätzlichen Parameter (siehe Abschnitt Tabellen) gekennzeichnet:

• COMPONENTS

• ASCII_CONTENT

• SIGNATURE

Die Methode GET_WITH_URL ist durch die folgenden zusätzlichen Parameter (siehe Abschnitt Tabellen) gekennzeichnet:

• SIGNATURE

• COMPONENTS

Diese Tabelle stellt den ganzen Inhalt zur Verfügung.

• URIS

Diese Tabelle gibt nur die URL an, die auf das Dokument zeigt.

• URL_LIFETIME

Zeitrahmen für die Gültigkeit einer URL, Lebensdauer. Dieser Parameter kann zwei unterschiedliche Bedeutungen haben:

1. Dieser Parameter bezieht sich lediglich auf URIs des SAP-Systems. Er gibt die Lebensdauer sowohl der URL als auch dessen, worauf sie zeigt, an.
   Wenn der Inhalt des Dokuments in der R/3-Datenbank liegt, dann wird mit URL_LIFETIME die Lebensdauer der Tabelle auf dem Client gesteuert.
   Weitere Informationen finden Sie in der Dokumentation zum Funktionsbaustein DP_CREATE_URL, insbesondere in der Dokumentation des Parameters LIFETIME.
2. Wenn GET_WITH_URL eine allgemeine URL auf einen externen Content Server zurückliefert, dann ergibt sich die Lebensdauer aus der Gültigkeit der URL, die maximal zwei Stunden beträgt. Voraussetzung hierfür ist die Verwendung einer digitalen Signatur.

CONFIRM_CREATE

Diese Methode wird immer in Zusammenhang mit CREATE_WITH_URL, CREATE_VARIANT_WITH_URL und CREATE_VERSION_WITH_URL aufgerufen.

Diese Methode muß immer aufgerufen werden, wenn die Ablage über die URL erfolgreich war. Ansonsten sollten die Verwaltungsdaten mittels DELETE gelöscht werden.

Die Identifikation des Anwendungsobjekts (Document Set) geschieht über die im Abschnitt Parameter beschriebenen Attribute.

Weiterhin wird diese Methode über die folgenden Parameter spezifiziert:

• COMPONENTS

• URIS

• SIGNATURE

CONFIRM_UPDATE

Diese Methode wird in Zusammenhang mit UPDATE_WITH_URL aufgerufen.

Diese Methode muß immer aufgerufen werden, wenn die Ablage über die URL erfolgreich war. Ansonsten sollten die Verwaltungsdaten mittels DELETE gelöscht werden.

Die Identifikation des Anwendungsobjekts (Document Set) geschieht über die im Abschnitt Parameter beschriebenen Attribute.

Weiterhin wird diese Methode über die folgenden Parameter spezifiziert:

• COMPONENTS

• URIS

• SIGNATURE

Damit entspricht diese Methode CONFIRM_CREATE, mit dem Unterschied, daß es hier um das Aktualisieren und nicht das Anlegen von Dokumenten geht.

Spezielle Funktionen

Funktionen für Relationen

CREATE_RELATION

Mit dieser Methode werden Beziehungen zu einem Anwendungsobjekt angelegt.

Das Ausgangsdokument wird über die im Abschnitt Parameter beschriebenen Attribute dargestellt. Zu diesem Dokument werden die über die Tabelle SIGNATURE spezifizierten Beziehungen erzeugt und über die Tabelle RELATION rückgemeldet.

GET_RELATIONS

Mit dieser Methode werden die zu einem Dokument existierenden Beziehungen mit den zugehörigen Partnern zur Verfügung gestellt.

Das Ausgangsdokument wird über die im Abschnitt Parameter beschriebenen Attribute dargestellt. In der Tabelle RELATION sind die zu dem Dokument existierenden Beziehungen enthalten. In der Tabelle SIGNATURE sind die Partner-Dokumente spezifiziert.

DELETE_RELATIONS

Mit dieser Methode werden die zu einem Dokument existierenden Beziehungen gelöscht.

Das Anwendungsobjekt (Document Set) wird über die im Abschnitt Parameter beschriebenen Attribute spezifiziert. Zu diesem Dokument werden die über die Tabelle RELATION spezifizierten existierenden Beziehungen explizit gelöscht.

QUERY_RELATIONS

Diese Methode erlaubt eine flexible Abfragen nach Attributen einer Beziehung sowie über die Attribute der Dokumente, zu denen eine Beziehung bestehen soll. Neben der Identifikation des Anwendungsobjektes und des Dokumentes, vom dem aus die zu findenden Beziehungen ausgehen sollen, hat die Methode noch zwei Übergabeparameter für die Attribute der zu findenden Dokumente (Parameter SIGNATURE) und zur Übergabe des Suchbereichs der zu findenden Beziehungsattribute (Parameter QUERY).

Die Selektionskriterien werden in der Tabelle QUERY spezifiziert. Jeder Eintrag liefert Einschränkungen zu einem Attribut analog der Struktur einer Ranges-Tabelle.

Funktionen für Versionen und Varianten

CREATE_VARIANT_WITH_FILES/_TABLE/_AS_TABLE/_URL

Zum Anlegen von Sprach- und Formatvarianten stehen die folgenden vier Methoden zur Verfügung:

• CREATE_VARIANT_WITH_FILES

• CREATE_VARIANT_WITH_TABLE

• CREATE_VARIANT_WITH_AS_TABLE

• CREATE_VARIANT_WITH_URL

Diese vier Methoden unterscheiden sich - analog zu CREATE_WITH_FILES, CREATE_WITH_TABLE, CREATE_WITH_AS_TABLE und CREATE_WITH_URL - in der Quelle, von der die Daten abgeholt werden. Die Quelle kann entweder ein Dateiname, eine Tabelle oder eine URL sein.

Die Identifikation des Anwendungsobjekts (Document Set) geschieht über die im Abschnitt Parameter beschriebenen Attribute. Die Variante wird durch die Attribute gekennzeichnet, die ebenfalls im Abschnitt Parameter beschrieben werden.

Die neue Variante wird durch die folgenden Parameter gekennzeichnet:

• NEW_DOC_VAR_ID

neue Varianten-Id

• NEW_DOC_VAR_TG

neues Varianten-Tag
Das Varianten-Tag kann die folgenden Ausprägungen haben:

• Original

• Sprachvariante

• Formatvariante

Eine dieser Ausprägungen muß beim Aufruf dieser Methode übergeben werden. Zurückgeliefert wird die neue Varianten-Id.

Anstelle des Parameters SIGNATURE wird der Parameter PROPERTIES (siehe Abschnitt Tabellen) verwendet.

Die Methode CREATE_VARIANT_WITH_FILES ist durch den zusätzlichen Parameter FILES (siehe Abschnitt Tabellen) gekennzeichnet.

Die Methode CREATE_VARIANT_WITH_TABLE ist durch die folgenden zusätzlichen Parameter (siehe Abschnitt Tabellen) gekennzeichnet:

• COMPONENTS

• CONTENT

Die Methode CREATE_VARIANT_WITH_TABLE ist durch die folgenden zusätzlichen Parameter (siehe Abschnitt Tabellen) gekennzeichnet:

• COMPONENTS

• ASCII_CONTENT

Die Methode CREATE_VARIANT_WITH_URL ist durch die folgenden zusätzlichen Parameter (siehe Abschnitt Tabellen) gekennzeichnet:

• COMPONENTS

• URIS

Hinweis

CREATE_VARIANT_WITH_URL muß immer in Zusammenhang mit CONFIRM_CREATE aufgerufen werden, damit ein Dokument als erfolgreich abgelegt gekennzeichnet werden kann.
Bei dieser Methode wird lediglich eine Ziel-URL übergeben. Über CONFIRM_CREATE wird die Information weitergegeben, daß das Anlegen eines Dokuments erfolgreich war.

CREATE_VERSION_WITH_FILES/TABLE/URL

Zum Anlegen von Inhaltsversionen stehen die folgenden vier Methoden zur Verfügung:

• CREATE_VERSION_WITH_FILES

• CREATE_VERSION_WITH_TABLE

• CREATE_VERSION_WITH_AS_TABLE

• CREATE_VERSION_WITH_URL

Diese vier Methoden unterscheiden sich - analog zu CREATE_WITH_FILES, CREATE_WITH_TABLE, CREATE_WITH_AS_TABLE und CREATE_WITH_URL - in der Quelle, von der die Daten abgeholt werden. Die Quelle kann entweder ein Dateiname, eine Tabelle oder eine URL sein.

Die Identifikation des Anwendungsobjekts (Document Set) geschieht über die im Abschnitt Parameter beschriebenen Attribute. Die Version wird durch die Attribute gekennzeichnet, die ebenfalls im Abschnitt Parameter beschrieben werden.

Die neue Variante wird durch den Parameter NEW_DOC_VER_NO, d.h. durch die neue Versionsnummer, gekennzeichnet.

Anstelle des Parameters SIGNATURE wird der Parameter PROPERTIES verwendet.

Die Methode CREATE_VERSION_WITH_FILES ist durch den zusätzlichen Parameter FILES (siehe Abschnitt Tabellen) gekennzeichnet.

Die Methode CREATE_VARIANT_WITH_TABLE ist durch die folgenden zusätzlichen Parameter (siehe Abschnitt Tabellen) gekennzeichnet:

• COMPONENTS

• CONTENT

Die Methode CREATE_VARIANT_WITH_AS_TABLE ist durch die folgenden zusätzlichen Parameter (siehe Abschnitt Tabellen) gekennzeichnet:

• COMPONENTS

• ASCII_CONTENT

Die Methode CREATE_VERSION_WITH_URL ist durch die folgenden zusätzlichen Parameter (siehe Abschnitt Tabellen) gekennzeichnet:

• COMPONENTS

• URIS

Hinweis

CREATE_VERSION_WITH_URL muß immer in Zusammenhang mit CONFIRM_CREATE aufgerufen werden, damit ein Dokument als erfolgreich abgelegt gekennzeichnet werden kann.
Bei dieser Methode wird lediglich eine Ziel-URL übergeben. Über CONFIRM_CREATE wird die Information weitergegeben, daß das Anlegen eines Dokuments erfolgreich war.

Funktionen für den Transport

GET_TRANSPORT_INFOS

Mit dieser Methode werden die notwendigen Einträge für den Transport bereitgestellt.

Die Identifikation des Anwendungsobjekts (Document Set) geschieht über die im Abschnitt Parameter beschriebenen Attribute. Die Identifikation des Dokuments oder der Dokumente erfolgt über die Signaturtabelle, d.h. über den Parameter SIGNATURE (siehe Abschnitt Tabellen).

Der Parameter COMMFILE_ENTRIES stellt die notwendigen Angaben für den Transport bereit, d.h. die einzelnen Objekteinträge für Aufträge und Aufgaben im Workbench Organizer.

DOCUMENT_ENQUEUE

Diese Methode sperrt ein Dokument für andere Benutzer. Nur eine logische Sperre kann abgesetzt werden. Diese Sperre ist nur auf der logischen Ebene wirksam. Eine Verwendung der übrigen Methoden ist nach wie vor möglich. Die Methode DOCUMENT_ENQUEUE sollte immer dann abgesetzt werden, wenn die Möglichkeit besteht, daß mehrere Personen gleichzeitig modifizierend auf ein Dokument zugreifen können. Kommt es beim Aufruf dieser Methode zu einem Fehler, etwa weil das Dokument bereits durch einen anderen Benutzer gesperrt ist, sollte auf die Ausführung modifizierender Methoden verzichtet werden, da ansonsten keine Datenkonsistenz gewährleistet werden kann.

Nach Abschluß der Modifikationen sollte die Methode DOCUMENT_DEQUEUE aufgerufen werden, die das Dokument wieder entsperrt.

DOCUMENT_DEQUEUE

Diese Methode eintsperrt ein zuvor mit der Methode DOCUMENT_ENQUEUE gesperrtes Dokument.

Wie eine Integration der Klasse CL_BDS_DOCUMENT_SET möglich ist

Die Integration des BDS in SAP-Anwendungen gliedert sich in drei Phasen:

1. Analyse
2. Diskussion und Entscheidung
3. Implementierung

Im folgenden werden die einzelnen Phasen weiter erläutert.

1. Analyse

In der Analysephase werden allgemeine Fragen sowie der Umfang der beabsichtigten Integration des BDS in die jeweilige SAP-Anwendung spezifiziert:

• Um welchen betriebswirtschaftlichen Hintergrund handelt es sich?

• Für welches Release soll die Integration des BDS erfolgen?

• Welche Arten von Dokumenten sollen abgelegt werden?

Beispiel: Bitmaps, Office-Dokumente, etc.

• Wie hoch ist die voraussichtliche Anzahl von Dokumenten?

• Braucht die SAP-Anwendung eigene Verwaltungstabellen?

• Welche Auslieferungsklasse sollen die Verwaltungstabellen haben?

• Wie ist die ID der Anwendungsklasse?

• Um welchen Typ von Anwendungsklasse handelt es sich?

• Business Object Repository

• R/3-Klassenbibliothek

• Sonstiges

• Ist ein Transportanschluß gewünscht?

• Ist der Anwendungskontext mandantenabhängig?

• Welche BDS-Methoden werden voraussichtlich verwendet?

Beispiel: CALL_NAVIGATOR (der BDN soll aufgerufen werden) oder CREATE_VARIANT_WITH_FILES (eine Variante soll angelegt und dabei der Dateiname mit übergeben werden).

• Werden spezielle Attribute benötigt? Wenn ja, welche?

2. Diskussion und Entscheidung

In dieser Phase nehmen Sie Kontakt mit der BDS-Integrationsgruppe auf. Sie diskutieren gemeinsam mit der Entwicklungsgruppe, wie Ihre Anforderungen am besten umgesetzt werden können. Sie entscheiden gemeinsam über das zu verwendende Datenmodell und die Methoden, die für Ihre Anwendung eingesetzt werden sollen.

3. Implementierung

Sie integrieren die für Ihre Anwendung notwendigen Methoden.

Anwendungsbeispiele

Der BDS kann in alle SAP-Anwendungen integriert werden, in deren Kontext Dokumente vorkommen und die keine Spezialanforderungen an eine Dokumentenverwaltung haben.

Eine Beispiel-Anwendung ist Büro -> Business Documents -> Dokumente -> Suchen.

Glossar

• Business Document Navigator

BDN.
Benutzeroberfläche des Business Document Service.

• Business Document Set

Menge aller zusammengehörigen Dokumente zu einem gegebenen Anwendungsobjekt.

• DOI

Desktop Office Integration

• Dokument

Üblicherweise wird unter Dokument eine Urkunde bzw. ein amtliches Schriftstück verstanden, aus dem Lateinischen abgeleitet von documentum = das zur Belehrung über etwas bzw. zur Erhellung von etw. Dienliche, Beweis. Diese Interpretation von Dokument basiert auf der Vorstellung einer dinglich vorliegenden, üblicherweise auf Papier, Pergament, Mikrofilm oder sonstigen dinglichen Grundlage aufgezeichneten schriftlichen Information.
Im Zuge der Digitalisierung von Informationen kann ein Dokument aber jede Form von digitalisierter Information umfassen, also z.B. auch Bild- und Tonaufzeichnungen. Aber natürlich auch nach wie vor schriftliche Informationen.
Im Rahmen eines Dokumentenverwaltungssystems kann ein Dokument im Rahmen seiner gesamten Lebensgeschichte betrachtet werden, d.h. als Abfolge unterschiedlicher Inhalts-, Sprach- und Formatversionen. Weiterhin werden noch Kontextinformationen und Verknüpfungen zu anderen Objekten und Dokumenten betrachtet.

• Mime-Type

Durch Mime-Types wird das Format eines Dokuments spezifiziert. Die Angabe des Mime-Types setzt sich aus den Bestandteilen content-type/subtype zusammen.
Mime-Types werden bei der IANA (Internet Assigned Number Authority) registriert, über die auch eine Liste der "offiziellen" Mime-Types zu erhalten ist. Neben den registrierten Mime-Types sind auch solche in Gebrauch, die noch nicht über die IANA registriert wurden. Diese werden (über den Einschub x-) durch die Syntax type/x-subtype von den registrierten Typen unterschieden.

• Klasse

Definition der Attribute, Operationen und der Semantik für eine Menge von Objekten.

• Klassenname

Eindeutige Bezeichnung der Klasse.

• Klassentyp

Bezeichnung des Typs einer Klasse. Z.Z. sind folgende Typen definiert:

• BO

Business Object Repository

• CL

Class Library

• OT

Other

• Logisches System

Instanz eines SAP-Systems

• Objekt

Eine im laufenden System konkret vorhandene und agierende Einheit. Jedes Objekt ist ein Exemplar einer Klasse.

• Objektschlüssel

Eindeutige Identifikation eines Objekts.
Eindeutige Kennzeichnung der Instanz innerhalb des logischen Systems und der Klasse. Die SAP-Anwendung kann selbst den Objektschlüssel vergeben. Alternativ kann der BDS den Objekttyp in Form einer GUID generieren (dies gilt nur für die CREATE-Methode).

• Variante

Von jeder Inhaltsversion können Varianten abgeleitet werden, die zu der Inhaltsversion semantisch gleichwertig sind, die jedoch den gleichen Inhalt in einer anderen Sprache oder in einem anderen technischen Format darstellen. Diese Dokumente werden als Varianten bezeichnet.

• Version

Dokumente können in ihrem Lebenszyklus unterschiedliche Zustände aufweisen. Eine mögliche Zustandsänderung ist durch die Inhaltsversionierung gegeben. Inhaltsversion wird hier synonym mit Version verwendet. Neue Versionen setzten Möglichkeiten zum Editieren voraus.

Beziehungen

Beispiel

Beispiel: CREATE_WITH_FILES

data: o_document_set type ref to cl_bds_document_set.

create object o_document_set.

move: '1' to wa_signature-doc_count,

'1' to wa_files-doc_count,

'C:\SAPPCADM' to wa_files-directory,

'BDSPresentation.PPT' to wa_files-filename.

append wa_signature to i_signature.

append wa_files to i_files.

call method o_document_set->create_with_files

exporting

classname = ‘MyApplication'

classtype = ‘OT'

changing

object_key = i_object_key

files = i_files

signature = i_signature.

Beispiel: GET_WITH_FILES

data: o_document_set type ref to cl_bds_document_set.

create object o_document_set.

move: '1' to wa_signature-doc_count,

‘BDS_LOC1 B18EBB28E773D21197E70060B0672A3C'

to wa_signature-doc_id,

'1' to wa_signature-doc_ver_no,

'1' to wa_signature-doc_var_id,

'1' to wa_files-doc_count,

'C:\SAPPCADM' to wa_files-directory.

append wa_signature to i_signature.

append wa_files to i_files.

call method o_document_set->get_with_files

exporting

classname = ‘MyApplication'

classtype = ‘OT'

object_key = ‘0815'

changing

files = i_files

signature = i_signature.

Hinweise

Der BDS wird erstmals zu R/3 Release 4.6A für Pilotprojekte zur Verfügung gestellt.

Weiterführende Informationen

Weitere Informationen zum Business Document Service (BDS) finden Sie in der SAP-Bibliothek unter Basis - Basis Services - Business Document Service.

ABAP Short Reference   ROGBILLS - Synchronize billing plans  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Length: 49234 Date: 20240420 Time: 074708     sap01-206 ( 538 ms )