Document toolboxDocument toolbox

Recommended Comment Templates

Goal

What information in SAP Analytics is worth considering for Performer Suite Comment Templates?

The Scenario is the central element combining all Aspects!

SAP BW

Object typeGermanEnglish

Data Source

Grundsätzlich: Dokumentation ist Pflicht

  • DataSource-Typ im Quellsystem
    • CDS-View, FuBa, View, …
  • Extraktionslogik Überblick
    • Source System Implementierung
    • Welche Tabellen, Joins, Logiken, Filter, Appends,…?
  • Delta/Full
    • Hinweis ob Delta-Fähigkeit besteht bzw. ob bewusst FULL geladen wird obwohl Deltafähig
  • Vorgehensweise Neuaufbau
    • Verbuchungsfreie Zeit notwendig?
    • Muss vorher die Delta-Queue (LBWQ) gelöscht werden?
  • Vorgehensweise Transport/Abhängigkeiten
  • Sonstige Hinweise
    • OPTIONAL
  • Ansprechpartner für Spezial-Themen
    • OPTIONAL

General: Documentation is mandatory!

  • DataSource type in source system
    • CDS-View, Function Module, View,...
  • Extraction Logic:
    • Source System implementation
    • Which Tables, Joins, Logics, Filters, Appends,...?
  • Delta/Full:
    • Notice if Delta-capability is available or if FULL gets loaded consciously even if Delta-capability exists
  • Procedure recompilation:
    • Off-time necessary?
    • Does the Delta queue have to be deleted beforehand?
  • Procedure transport/dependencies
  • Other notices
    • OPTIONAL
  • Contact person for special topics
    • OPTIONAL
Transformation

Grundsätzlich: Dokumentation ist Pflicht (Ausnahme: Transformation ohne jegliche Logik) - Hinweis: Bereits die Umstellung von Überschreiben auf Summation oder eine Formel ist Logik!

  • Ziel / Fachliche Beschreibung
  • Geschäftslogik
  • Start-, End-, Experten- und Feldroutine, Formeln
    • nur fachlich, Details im ABAP
    • Umstellung Kennzahlen auf Summation
  • Sonstige Hinweise:
    • OPTIONAL
    • Regelgruppen
    • RECORDMODE-Anpassungen
    • Anpassung des Schlüssels
    • Aggregation etc.

General: Documentation is mandatory (Exception: Transformation without any logic) - Notice: Even the change of overwriting to summation or a formula is logic

  • Objective / Technical description
  • Business logic
  • Start, end, expert and field routine, formulas
    • just technical, details in ABAP
    • Change Key Figures to summation
  • Other notices:
    • OPTIONAL
    • Rule groups
    • RECORDMODE adjustments
    • Adjustment of the key
    • aggregation etc.
DTP
  • Filter
    • Begründung, Variablen, etc.
  • Einstellungen Semantische Gruppen
    • Warum, wozu, etc.?
  • Filter
    • Explanation, Variables, etc.
  • Settings Semantic Groups
    • Why. what for, etc.?
ADSO/DSO/InfoCube

Grundsätzlich: Dokumentation ist Pflicht

  • Ziel / Fachliche Beschreibung
    • Was sind das für Daten, was ist das Ziel (2 Sätze)
  • Löschen / Neuaufbau
    • Was muss bei einem Neuaufbau beachtet werden (z. B. migrierte Daten)
    • Welche anderen ADSOs werden bei der Beladung nachgelesen bzgl. Reihenfolge
    • Gibt es Abhängigkeiten zu anderen ADSOs  oder Applikationen?
  • Testfälle und Verifikation
    • Optional
    • Falls es Testfälle gibt, die nach einer Neubeladung geprüft werden können, da ein definiertes Ergebnis da ist.
    • Wo ist der Testfall dokumentiert?
  • Sonstige Hinweise
    • OPTIONAL
    • Nearline Storage
  • Housekeeping Aspekte
    • OPTIONAL
    • Falls Einstellung von der allgemeinen Vorgabe abweicht

General: Documentation is mandatory

  • Objective / Technical description
    • What kind of data is this, what is the objective (2 sentences)
  • Deletion / Reconstruction
    • What has to be considered while reconstructing (e.g. migrated data)?
    • Which other ADSOs are read while loading, regarding an order?
    • Are there any dependencies to other ADSOs or applications?
  • Test cases and verification
    • OPTIONAL
    • If there are any test cases, that can be checked after a new loading, because a defined result exists
    • Where is the documentation of the test case?
  • Other notices
    • OPTIONAL
    • Nearline Storage
  • Housekeeping aspects
    • OPTIONAL
    • If settings diverge from the general specification
Composite Provider / HANA Composite Provider / Multi-Provider

Grundsätzlich: Dokumentation ist Pflicht

  • Ziel / Fachliche Beschreibung
  • Verwendung von Joins
  • Virtuelle Merkmale und Kennzahlen
  • Berechtigungskonzept
    • Welche Merkmale sind Berechetigungsrelevant?
    • Wie werden diese Verwendet? Z.B. Berechtigungsexit Variablen o.ä.?
    • Welche berechtigungsrelevanten Objekte werden verwendet, welche explizit übersteuert?
  • Sonderlogiken
    • OPTIONAL
    • Zuordnungen die nicht 1:1 sind, also unterschiedliches Quell- und Zielobjekt
    • BadI und ABAP-Klasse
  • Verwendung von Open ODS Views
    • OPTIONAL
  • Globale Kennzahlen und Strukturen
    • OPTIONAL
  • Anpassungen an Laufzeit-Eigenschaften
    • OPTIONAL

General: Documentation is mandatory

  • Objective / Technical description
  • Usage of Joins
  • Virtual Characteristics and Key Figures
  • Authorization concept
    • Which characteristics are authorization-relevant?
    • How are they used? E.g. Authorization exit Variables?
    • Which authorization-relevant Entities are used, which explicitly overridden?
  • Special logics
    • OPTIONAL
    • Assignments, that are not 1:1, so different Source and Target Entity
    • BadI and ABAP classes
  • Usage of Open ODS Views
    • OPTIONAL
  • Global Key Figures and Structures
    • OPTIONAL
  • Adjustments to the runtime characterisitcs
    • OPTIONAL
BEx Query

Grundsätzlich: Dokumentation ist Pflicht

  • Ziel / Fachliche Beschreibung
    • 2-3 Sätze Überblick welche fachlichen Daten enthalten sind
  • Sonderlogiken
    • Zelldefinitionen
      • Warum wurden diese verwendet? Gibt es grundsätzliche Abhängigkeiten unter den Zelldefinitionen usw.!
    • Exceptions & Conditions
    • Virtuelle Merkmale und Kennzahlen
      • Nur Hinweis (Beschreibung bei CompositeProvider)
  • Anpassungen an Laufzeit-Eigenschaften
    • OPTIONAL

General: Documentation is mandatory

  • Objective / Technical description
    • 2-3 sentences: an overview of which technical data is contained
  • Special logics
    • Cell definitions
      • Why were they used? Are there general dependencies between the cell definitions etc.!
    • Exceptions & Conditions
    • Virtual Characteristics and Key Figures
      • Just notice (Description for CompositeProvider)
  • Adjustments to runtime characteristics
    • OPTIONAL
BEx Variable

Grundsätzlich: Dokumentation ist Pflicht (Nur für Customer-Exit und Ersetzungspfad)

  • Ziel / Fachliche Beschreibung
  • F4-Hilfe
  • Variablenlogik
    • OPTIONAL
    • Ersetzungspfad
    • Customer Exit
      • Berechtigung
      • Implementierung
      • BadI und ABAP-Klasse

General: Documentation is mandatory (just for customer exit and replacement path)

  • Objective / Technical description
  • F4-help
  • Variable logic
    • OPTIONAL
    • Replacement path
    • Customer Exit
      • Authorizations
      • Implementation
      • BadI and ABAP class
Characteristics/Key Figures/InfoObject Category

Grundsätzlich: Dokumentation ist Pflicht (nur relevante Kennzahlen und Merkmale)

Hinweis: Kennzahlen sind relevant, wenn .... haben

Hinweis: Merkmale sind relevant wenn sie Besonderheiten aufweisen

Hinweis: Keine Dokumentation von Business Content Objekten

  • Ziel / Fachliche Beschreibung
  • Sonderfälle
    • Hierarchien, transitive Merkmale, Merkmalsroutine, eigene Konvertierungsroutine, Referenz auf 0er-Objekt oder K-Objekt  

General: Documentation is mandatory (just relevant Key Figures and Characteristics)

Notice: Key Figures are relevant when they are...

Notice: Characteristics are relevant if they have special features

Notice: No documentation of Business Content Objects

  • Objective / Technical description
  • Special cases
    • Hierarchies, transitive Characteristics, Characteristics routine, own conversion routine, reference to Null Objects or K-Objects
InfoSourceKeine DokumentationNo documentation
OpenODS-ViewKeine DokumentationNo documentation
Process Chain
  • Inhaltsübersicht der Kette
    • Wichtig: nicht einzelne Schritte, sondern ein Überblick, generelle Daten/Metadaten etc.
  • Start/Einplanung
  • Abhängigkeiten
  • Vorgehen bei Abbrüchen
  • Implementierungshinweise für die Regionen
  • Content overview of the chain
    • Important: not single steps, but an overview, general data/metadata etc.
  • Start / Scheduling
  • Dependencies
  • Procedure if Cancellation occurs
  • Implementation notes for the regions

SAP BO

coming soon...


SAP HANA (native)

coming soon...


SAP BPC

coming soon...


© 2024 bluetelligence GmbH. All rights reserved.
No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of bluetelligence GmbH. The information contained herein may be changed without prior notice. bluetelligence and Performer Suite and their respective logos are trademarks or registered trademarks of bluetelligence GmbH. SAP, ABAP, BAPI, SAP NetWeaver, SAP BI, SAP BW, SAC, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany or an SAP affiliate company. All other product and service names mentioned are the trademarks of their respective companies.
Impressum – Legal Notice: https://bluetelligence.de/en/imprint
Privacy policy: https://performersuite.de/en/privacy-policy
Atlassian privacy policy: https://www.atlassian.com/legal/privacy-policy