Ansicht
Dokumentation

Änderungen und neue Funktionen in den Dokumentationswerkzeugen ( RELNBC_DOKU-WERKZEUGE )

ABAP Short Reference   CL_GUI_FRONTEND_SERVICES - Frontend Services  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Kurztext

Änderungen und neue Funktionen in den Dokumentationswerkzeugen

Beschreibung

1. Anbindung der Dokumentation an das SAP-Berechtigungskonzept.
   Die Berechtigung für die Dokumentation wird jetzt über Profile gesteuert. Die alte Methode zur Steuerung von Berechtigungen ist in Release 2.1 noch gültig bis zum nächsten Release.
2. Verschieben der Korrekturanfrage.
   Die Korrekturanfrage, die stattfand, wenn der Dokumentationsbaustein zur Bearbeitung aufgerufen wurde, findet jetzt beim Sichern des Dokumentationsbausteins statt.
3. Ändern von SAP-Originalen.
   Sie können von SAP ausgelieferte Dokumentation ändern.

Soft-/Hardwarevoraussetzungen

keine

Besonderheiten bei der Installation

keine

Auswirkungen auf die Systemverwaltung

keine

Auswirkungen auf das Customizing

keine

Auswirkungen auf Batch-Input

keine

Änderungen an der Oberfläche

Die Einträge unter der Menüoption Einstellung -> Dokumentationstyp wurden umbenannt.

• SAP-Endanwender heißt jetzt Endanwender Original.

• Kunden-Endanwender heißt jetzt Endanwender Änderung.
  

Wenn Sie eine Änderung vornehmen möchten , wählen Sie Einstellung -> Dokumentationstyp -> Endanwender Änderung. Andernfalls wählen Sie Einstellung -> Dokumentationstyp -> Endanwender Original. Zur Zeit kann mit der Transaktion SE61 keine technische Dokumentation gepflegt werden.

Änderungen in der Vorgehensweise

Anbindung der Dokumentation an das SAP-Berechtigungskonzept

Es gibt technische Dokumentation und Dokumentation für den Endanwender:

• Endanwenderdokumentation ist zum Beispiel die F1-Hilfe, die angezeigt wird, wenn Sie die Taste F1 wählen, beispielsweise für ein Eingabe-/Ausgabefeld oder eine Fehlermeldung im SAP-System. Die Endanwenderdokumentation für das entsprechende Datenelement oder die entsprechende Meldung wird angezeigt.

• Technische Dokumentation beschreibt Objekte in der Entwicklungsumgebung, wie z.B. Funktionsbausteine oder Korrekturen. Für technische Dokumentation benötigen Sie keine besondere Dokumentationsberechtigung.

Mit Release 2.1 werden Dokumentationsberechtigungen mit Berechtigungsprofilen abgeglichen. Diese Profile müssen in den Stammdaten des Benutzers eingetragen werden. Wenn es in den Stammdaten kein Profil zur Pflege von Dokumentation gibt, wird in Release 2.1 mit den alten Berechtigungstabellen TSDOC und TSDDD abgeglichen.

Bei der Endanwenderdokumentation soll folgende Vorgehensweise bei der Dokumentation die Qualitätssicherung verbessern. Von einem Software-Entwickler wird erwartet, dass er seinen Quelltext dokumentiert. Diese Dokumentation soll im Status "roh" angelegt werden. Sie erscheint dann im Arbeitsvorrat eines Dokumentationsentwicklers als Dokumentation im Status "nicht überarbeitet" und kann überarbeitet werden. Endanwenderdokumentation im Status "roh" kann nicht transportiert werden. Deshalb sollte ein Entwickler nur die Berechtigung zur Pflege von Rohdokumentation haben. Dadurch wird sichergestellt, dass Dokumentation mit korrektem Inhalt, aber verbesserungsbedürftigem Stil, nicht aus dem Entwicklungs- oder Testsystem in das Produktivsystem transportiert wird. Deshalb hat der Dokumentationsentwickler oder derjenige, der die endültige Überarbeitung eines Dokuments vornimmt, die Berechtigung die Endfassung des Dokuments zu pflegen.

Ein Benutzer ohne Berechtigung zur Dokumentationspflege kann die Transaktion SE61 nur im Anzeigemodus verwenden.

Man kann auch aus der Anwendung heraus, zum Beispiel aus der Entwicklungsumgebenung, ohne Dokumentationsberechtigung auf die Dokumentation zugreifen. Dies ist sinnvoll, da ein Systembenutzer, der berechtigt ist, Reports mit der Transaktion SE38 anzulegen, nicht verstehen würde, wieso eine zusätzliche Dokumentationsberechtigung notwendig ist, um diese Programme zu dokumentieren. In diesem Fall wird das Dokument mit dem höchsten möglichen Status gesichert, zumindest aber als "Rohfassung".

Bei den von SAP gelieferten Profilen gelten die folgenden Namenskonventionen: Alle die Dokumentation betreffenden Profile beginnen mit "S_DOKU....".

Es gibt genau ein Profil namens "S_DOKU_RAW" zum Pflegen der Rohfassung von Endanwenderdokumentation. Ein Benutzer benötigt dieses Profil in seinen Stammdaten, um die Rohfassung von Endanwenderdokumentation zu pflegen.

Die Pflege von Endanwenderdokumentation im Status "Endfassung" wird für mindestens ein Paket vergeben.

SAP bietet eine Grundmenge von Berechtigungsprofilen, die bei der Berechtigungsprüfung generisch interpretiert werden. Ein Profil zur Pflege von Endanwenderdokumentation der Klasse "S" gewährt automatisch Berechtigung zur Pflege aller Pakete, die mit "S" beginnen. Der Name eines solchen Profils beginnt mit "S_DOKUF", direkt gefolgt von dem Paketnamen. Das Profil für Endanwenderdokumentation von Paketen, die mit "S" beginnen, ist deshalb: "S_DOKUFS", wobei "F" für "Endfassung" steht.

SAP liefert für Release 2.1 das Profil "S_DOKUF*" aus. Das Zeichen "*" entspricht den Buchstaben des Alphabets: "A - Z". Das Profil "S_DOKUFZ" ist für Kundendokumentation vorgesehen. Sie können weitere Profile anlegen, wenn Sie für Ihre Entwicklungen detailliertere Berechtigungen vergeben möchten.

Sie benötigen die Berechtigung für ein SAP-Paket, um die von SAP gelieferte Dokumentation zu ändern. Informationen dazu finden Sie im Abschnitt Änderung von Originalen von SAP in diesen Release-Informationen.

Es gibt keine Berechtigungen für die Aktivierung. Überarbeitete Endanwenderdokumentation im Status "Endfassung" wird automatisch aktiviert wenn sie transportiert wird. Sie können jedoch Profile zur Aktivierungsberechtigung anlegen, wenn Sie dies für notwendig halten. Berechtigungen zur Aktivierung werden auch für bestimmte Pakete vergeben und müssen der Namenskonvention "S_DOKUA*" entsprechen, wobei "*" für das Paket steht und "A" for "aktivieren".

Es gibt ein globales Berechtigungsprofil, das alle Dokumentationsberechtigungen kombiniert, die vergeben werden können. Es sollte nur bei einer begrenzten Anzahl von Benutzern in die Stammdaten eingetragen werden, vorzugsweise nur in die Stammdaten von Systemverwaltern. Der Profilname ist "S_DOKU_AUTH".

Ein Profil zur Pflege der Endfassung von Endanwenderdokumentation schließt die Pflege von Rohdokumentation ein. Ein Dokument im Status "Endfassung" kann deshalb auf den Status "Rohfassung" gesetzt werden. Der Entwickler kann es daher pflegen ohne die Berechtigung zur Pflege der "Endfassung" von Endanwenderdokumentation zu haben. Dieser Mechanismus ist nützlich, wenn ein Dokument, das bereits überarbeitet wurde, geändert werden muss.

Um neue Berechtigungsprofile anzulegen, müssen Sie zuerst neue Berechtigungen mit dem gleichen Namen anlegen. Berechtigungen sind Versionen von Berechtigungsobjekten. Das Berechtigungsobjekt für Dokumentation heißt "S_DOKU_AUT" und wird von SAP mit Release 2.1 ausgeliefert.

Die Namenskonvention für Berechtigungen ist die gleiche wie für Berechtigungsprofile.

Die von SAP ausgelieferten Berechtigungen finden Sie unter Werkzeuge -> Administration -> Benutzerpflege -> Berechtigungen in der Klasse "Basis:Development environment". Positionieren Sie den Cursor auf jeweilige Zeile und wählen Sie F2. Die Objektliste für die Klasse wird angezeigt. Das Berechtigungsobjekt für die Dokumentation finden Sie unter dem Kurztext "Berechtigung zur Dokumentationspflege mit SE61". Eine Liste der vorhandenen Berechtigungen wird angezeigt, wenn Sie in dieser Zeile F2 wählen.

Über Berechtigung -> Anlegen können Sie eine neue Berechtigung anlegen. Geben Sie den Namen der neuen Berechtigung ein. Sie muss mit "S_DOKUF" beginnen, gefolgt von dem Paket, zum Beispiel "ZAKS". Die Namenskonvention für Berechtigungen, die von Kunden angelegt werden, hat ein "K" an der letzten Position. Die Berechtigung zur Pflege der Endfassung von Endanwenderdokumentation heißt folglich "S_DOKUFZAKSK".

Geben Sie den Namen ein und pflegen Sie einen sinnvollen Kurztext. Aus Gründen der Übersichtlichkeit sollten Sie alle Berechtigungen und Profile nach einem gemeinsamen Muster benennen. Wählen Sie Datenfreigabe. Die drei Felder des Berechtigungsobjekts "S_DOKU_AUT" werden angezeigt:

• Berechtigung zur Pflege, zum Übersetzen

• Berechtigungsvergabe abhängig vom Dokumentationstyp

• Paket für die Dokumentationsberechtigung

Sie müssen Werte pflegen, die die Version der Berechtigungsobjekte in allen drei Feldern darstellen. Springen Sie mit F2 zu dem relevanten Feld in der Pflegetransaktion. Machen Sie alle Ihre Einträge in Großbuchstaben.

1. Die folgenden Werte sind gültig für das Feld "Dokumentationstypabhängige Berechtigungsvergabe":

• RAW_VERS für die Berechtigung "S_DOKU_RAW".
  Diese ist bereits vorhanden.

• FINAL_VERS für die Berechtigung zur Pflege der Endfassung von Endanwenderdokumentation.

• ACTIVATE für die Berechtigung zur Aktivierung der Endfassung von Endanwenderdokumentation.
  Wie bereits erwähnt ist dieser Berechtigungstyp nicht notwendig und nur der Vollständigkeit halber implementiert.
  Geben Sie einen dieser drei Werte (in Großbuchstaben) ein und bestätigen Sie mit Datenfreigabe.

1. Pflegen Sie jetzt das zweite Feld "Paket für die Dokumentationsberechtigung" (in Großbuchstaben). Gültige Werte sind alle im System vorhandenen Paketen. Generische Einträge werden linksbündig geschrieben. Obwohl Sie eine Kombination von einzelnen Werten und Bereichen pflegen können, sollten Sie das nicht tun. Ein solches Profil könnte über die Namenskonvention nicht erkannt werden und wäre deshalb schwierig zu verwalten. Sie sollten deshalb genau einen Eintrag in das Feld eingeben. Dieser Eintrag kann auch generisch sein, zum Beispiel "Z* ","ZA* ","ZAK*","ZAKS". Bestätigen Sie mit Datenfreigabe.
2. Geben Sie "MAINTAIN" (in Großbuchstaben) in das dritte Feld ein. Der zweite gültige Eintrag "TRANSLATE" ist für eine zukünftige Verbindung zum Übersetzungssystem reserviert und hat im Moment keine Funktion. Bestätigen Sie mit Datenfreigabe.
3. Sichern Sie die Berechtigung mit F11 und aktivieren Sie sie mit F7.

Die Pflege der Berechtigung ist hiermit abgeschlossen. Sie müssen jetzt ein Profil mit dem gleichen Namen anlegen. Springen Sie zurück zur Liste mit den Berechtigungen und wählen Sie Benutzerpflege -> Profile.

1. Bestätigen Sie mit Datenfreigabe, um eine Liste aller Profile im System zu erhalten. Blättern Sie durch die Liste bis zu den von SAP ausgelieferten Dokumentationsprofilen. Wählen Sie Profil -> Anlegen. Geben Sie den Namen des Profils ein. Der Profilname entspricht dem Namen der Berechtigung, die Sie gerade angelegt haben. Geben Sie einen beschreibenden Kurztext ein. Da es sich bei den Profilen für die Dokumentationspflege um Einzelprofile handelt, wählen Sie das Feld "Einzelprofil" aus. Bestätigen Sie mit Datenfreigabe.
2. Wählen Sie im nachfolgenden Bild F8, um dem Profil eine Berechtigung hinzuzufügen. Wählen Sie aus der Liste der Objektklassen mit F2 diejenigen aus, in denen Sie bereits eine Berechtigung angelegt haben. Sie sehen jetzt eine Liste aller Berechtigungen für diese Klasse. Ist die von Ihnen angelegte Berechtigung nicht in der Liste, wurde sie entweder nicht aktiviert oder befindet sich in einer anderen Berechtigungsklasse. Wenn Sie die gesuchte Berechtigung gefunden haben, markieren Sie sie auf der linken Seite. Fügen Sie die Berechtigung über Datenfreigabe dem Profil hinzu. Sichern Sie das Profil mit F11, kehren Sie mit F3 zur Liste der Profile zurück, und aktivieren Sie Ihr neues Profil.

Ein aktives Profil kann in die Stammdaten eines Benutzers eingetragen werden. Beachten Sie, dass Änderungen an den Stammdaten eines Benutzers erst nach der nächsten Anmeldung am System wirksam werden.

Wenn Sie mehrere Berechtigungsprofile anlegen möchten, verlassen Sie die Profilpflege nachdem Sie ein neues Profil aktiviert haben und rufen Sie sie erneut auf.

Verschieben der Korrekturanfrage

Bei Dokumentation wird mit Release 2.1 das Transportsystem nur aufgerufen, wenn die Berechtigung gesichert ist. Ein Dokumentationsbaustein kann nicht von mehreren Benutzern gleichzeitig bearbeitet werden. Bei einem zweiten Benutzer wird der Dokumentationsbaustein im Editor automatisch nur im Anzeigmodus angeboten. Wenn ein Dokumentationsbaustein gesichert wird, wird er bei normaler Systemeinstellung in eine Korrektur des sichernden Benutzers aufgenommen. Wenn ein anderer Benutzer diesen Dokumentationsbaustein bearbeiten möchte, wird der ausgewählte Dokumentationsbaustein im Editor im Bearbeitungsmodus angezeigt. Eine Nachricht informiert den Benutzer, dass der Dokumentationsbaustein durch die Korrektur eines anderen Benutzers gesperrt ist.

Aktuell ist es nicht möglich zu sehen, ob diese Korrektur bereits mit der eigenen Korrektur verknüpf ist. Ist dies der Fall, können Sie den Dokumentationsbaustein sichern. Wenn Sie diese Nachricht erhalten, sollten Sie deshalb den Dokumentationsbaustein sichern bevor Sie ihn bearbeiten. Wenn Sie ihn nicht sichern können, bitten Sie den Benutzer, der den Dokumentationsbaustein in einer Korrektur verwendet, um Änderungsberechtigung.

Der andere Benutzer kann Ihnen diese mit der Transaktin SE01 gewähren. Er geht dabei in die Korrektur, die das Dokument sperrt, und wechselt in den Korrekturänderungsmodus. Dann wählt er Bearbeiten -> Änderungsberechtigung übertragen. Er gibt die Korrektur ein und sichert sie.

Ändern von Originalen von SAP

Sie können eine Änderung an der mit Release 2.1 von SAP ausgelieferten Dokumentation anlegen. Hierzu benötigen Sie eine generelle Änderungsberechtigung für SAP-Systemobjekte. Wenn Sie einen von SAP ausgelieferten Dokumentationsbaustein modifizieren, ändern Sie ihn nicht, sondern Sie legen einen neuen Dokumentationsbaustein mit dem gleichen Namen an. Sie können eine Änderung nur mit der Transaktion SE61 anlegen. Aktuell können Sie nur Datenelemente und Datenelementzusätze modifizieren.

Wählen Sie Einstellung -> Dokumentationstyp -> Endanwender Änderung -> Rohfassung. Im SE61-Einstiegsbild können Sie jetzt unter drei Optionen eine auswählen:

1. Sie können ein Dokument anlegen, dessen Inhalt von der SAP-Dokumentation unabhängig ist. Die Verbindung zur SAP-Dokumentation geht komplett verloren.
2. Sie können den SAP-Dokumentationsbaustein in der Änderung berücksichtigen. Verwenden Sie diese Option, um Änderungen an der Dokumentation vorzunehmen. Beachten Sie, dass Sie keine spätere Version dieser Dokumentation mehr sehen können.
3. Sie können die SAP-Dokumentation als INCLUDE-Zeile in Ihre Dokumentation einfügen. Sie können so die SAP-Dokumentation erweitern und haben immer einen Link zu der neuesten Version des SAP-Dokuments. SAP empfiehlt, dass Sie diese Option verwenden.

Ihre Änderung wird nur dann über F1 in einem Eingabefeld angezeigt, wenn sie sich zum Beispiel im Status "Endfassung" oder "aktiv" befindet. Wenn Sie die Änderung als Endfassung sichern und vom Testsystem in das Produktivsystem transportieren, wird sie automatisch aktiviert. Wenn Sie die Änderung löschen oder als Rohfassung sichern, wird stattdessen die SAP-Dokumentation angezeigt.

Abhängige Funktionen

keine

Planungen

keine

Weitere Hinweise

keine

General Data in Customer Master   BAL Application Log Documentation  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Length: 18860 Date: 20240523 Time: 182755     sap01-206 ( 344 ms )