Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 127 Next »

Settings explained within the Performer Suite, with examples of how changes will affect your documentations.


Settings Variant

jump to top

Determines the level of detail of the technical documentation by pre-checking the checkboxes of the settings.

  • IT standard documentation (Expert View)

  • Business standard documentation (Basic View)

  • Custom Settings Variant can be created: "Templates and Variants" > "Settings Variants"

If used with a centralized DB, all "Settings Variants" are synced.

Exception: The following settings are only local user-settings, and are not saved to the settings variant.

  1. Documents path

  2. Confluence Path

  3. Filename settings

  4. Proxy Settings


General

Export

jump to top

Path settings

Documents path

jump to top

  • Changes the output folder for documentations

  • Default path:

    ..\DocuPerformer\AppData\Generated\

Create folder for object type

jump to top

  • ON: Generates the output into an additional folder Object Type

    ..\DocuPerformer\AppData\<system>\<object_type>
  • OFF: Generates the output directly into:

    ..\Generated\<system>

Create daily folder

jump to top

  • Generates the output into an additional folder current date (instead of Object Type folder):

     ..\Generated\<system>\20180625

Filename settings

jump to top

Change via drag & drop the order of the filename.

Functional

One file per documentation

jump to top

  • ON (default): Each entity will get its own file if you select multiple entities for documentation.

  • OFF: Only one file (WORD, PDF) will be generated if you select multiple entities for documentation.

Reduce images in InfoProvider documentation & Reduce images in Query documentation

jump to top

  • Some icons become simplified.

Include comments

jump to top

Insert main comment header

jump to top

Create table of contents & Depth of TOC

jump to top

  • Content overview with depth (eg. depth 2 = 1.1.)

Suppress Repeated Key Values

jump to top

  • Shows "Key Values" only one time (simplified EXCEL view).

Include generation timestamp into technical documentation

jump to top


Include personal data into documentation

jump to top


Show Docu Performer Settings in documentation

jump to top


Add chapter "General information" to the documentation (Scenarios only)


Appearance

jump to top

General

Application skins: changes the theme /look of the complete Docu Performer.

It can be temporarily saved for the current session or to the Settings Variant .

Background color for table headers 

jump to top

Sets the color of the table headers (example: color peach).

Comment settings

jump to top

Sets the default font and font size of Comments.

Text properties of sourcecode in Word documents (default)

jump to top

Sets the default font and font size for source code in WORD documentations.


Comments and Custom Fields

jump to top

Custom fields

Categories:

jump to top

Quickly assign set values to entities.

Grid Comments

jump to top

Custom language-related Grid Comments.
Drag & Drop the columns from the Column Chooser into the Entity Grid.

Customization of file descriptions for comment upload to SAP (Transaction RSA1)

jump to top

Explanations of changes to comments

jump to top

Option to give short feedback on why you changed the Comment.


Database Settings

jump to top

Database backup settings

Set a reminder after how many days the Docu Performer should remind you to back up your DB.

Database shrink settings

Set a reminder after how many days the Docu Performer should ask you to shrink your SQLite DB.


Scenarios

jump to top

Insert scenario headline above table of contents

jump to top

Heading settings for the export of SAP entities in Scenarios

jump to top

Adjusts the heading of SAP entities in Scenarios. The green text is a preview of what the heading will look like.

Subchapter headings in Scenarios

jump to top

Sets if the subchapters should have headings and what they say.


Proxy Settings

jump to top

It can be used for a Confluence and BO connection.


Business Warehouse

jump to top

InfoProvider and InfoObjects

jump to top

InfoProvider Export Settings / InfoObject Export Settings

jump to top

These settings select which elements should be included in the documentation of an InfoProvider or an InfoObject respectively.

Data Flow Settings

jump to top

In this area, you can select whether the Data Flow should be included in the documentation. If this is activated, you can select if you can select the Data Flow View or Transformations, which should be considered for the documentation.

If both are activated, this window will appear when starting the documentation of an InfoProvider:

Related Reporting Elements

jump to top

Select, if related Reporting elements should be included in the documentation.

If activated, it is possible to select which Reporting element types should be included, if a full documentation of them should be created, or if they should only be displayed as a list.


Reporting

jump to top

Docu Queries settings

jump to top

Select what should be included in the documentation of a Query.

(info) If the checkbox in the 'Show'-column is disabled, the element is not included in the documentation of a query and the other settings in this row have no effect.

Users

jump to top

Select if the Users that are authorized to either "execute, change or show the Query" should be listed.

Settings for reusable Key Figures and Structure elements documentation (standalone)

jump to top

Specify if the properties of calculated and restricted Key Figures and Structure elements should be included when they are documented not as a part of a Query.

Settings for documentation of Workbooks (BW)

jump to top

Select if a documentation of the related Queries should be part of the documentation.

Settings for documentation of Web Templates

jump to top

Select what you want to include in the documentation of Web Templates.

Authorization Roles

jump to top

Select if related Roles should be included in the Query documentation.
Select if they should only appear in a list or if a detailed documentation should be included and further if SAP standard roles should be excluded.


Customer Exit Variables

jump to top

For an in-depth look at the settings for Customer Exit Variables, you can check this page: User Manual.


ABAP Stack and SAP Tables

jump to top

Docu SAP Tables

jump to top

Select whether the technical settings and the table content should be included in the documentation, as well as the maximum number of rows for Word and Excel documentation.

Docu ABAP Report and Function Modules

jump to top

Select whether the SAP documentation and text elements should be included in the documentation of ABAP Reports and Function Modules.


Data Flows

jump to top

Adjust the settings for the PowerPoint export of a Data Flow.
Select what text should be included, the format, the symbol size as well as the space between symbols.


Process Chains

jump to top

Choose what should be included in the documentation of Process Chains.

Show process details

Additional chapter with an overview of InfoProvider-related processes

Add Sub-Chains called in Process Chains automatically
The Sub-Process Chains will automatically be documented in the same export (incl. Source Code).
The detection of Sub-Process Chains takes place in a recursive way so that also Sub-Process Chains called via Sub-Process Chains will be detected.

Show dialog for selection of Sub-Chains

On export, an extra dialog opens, in which you can select the Sub-Chains to be documented.

Show messages
Optional display of symbols for messages.
Dependent on the message type (failure, success) the corresponding symbol will be shown.

or or

Show usage of Process Chain in other chains

Show overview of Process Chain as network


Roles and Authorizations

jump to top

A detailed description of the Roles & Authorizations tab can be found in our User Manual.


Business Objects

Design Studio

jump to top

Elements

jump to top

Edit precisely which components of the Design Studio report should be included in the documentation.
Select by folders and precisely by component type.

Sections

jump to top

Choose which sections should be included in your documentation.

If the "Include report structure" option is activated, a tree structure of all included elements, similar to the result of the Analyze/Compare function, will be included in the documentation.
The "Include Coding" checkbox activates the documentation of the coding, which can either be displayed in the Event section of the documentation of each component or in an additional chapter.

Integration of included BW objects

jump to top

Set which details of the DataSources from the source system should be included in the documentation of the Design Studio report.
The two checkboxes under "Selection of related BW entities to be included in the documentation" adds a chapter to the documentation, in which the included Queries and InfoProvider are documented.

If any of these options are activated, you will have also to connect to the source system.

Properties

jump to top

Select which properties should be included in the documentation of the selected elements.


Web Intelligence

jump to top

All options in this area are a selection of what should be included in the documentation of Web Intelligence Reports for the different object types.

Integration of included BW objects

jump to top

Set which details of the DataSources from the source system should be included in the documentation of the Webi Reports.

If any of these options are activated, you will have also to connect to the source system.


Analysis Office Workbook

jump to top

Elements

jump to top

Edit precisely which components of the AfO Workbook should be included in the documentation.

General

jump to top

Select if CUIDs and details for selections & Formulas from BW Queries should be included in the documentation.

Preview, if both are activated:

Integration of included BW objects

jump to top

Set which details of the DataSources from the source system should be included in the documentation of Analysis for Office Workbooks.
The two checkboxes under "Selection of related BW entities to be included in the documentation" add a chapter to the documentation, in which the included Queries and InfoProvider are documented.

If any of these options are activated, you will also have to connect to the source system.


Lumira 2.x

jump to top

Elements

jump to top

Edit precisely which components of the Lumira report should be included in the documentation.
Select by folders and precisely by component type.

Properties

jump to top

Select which properties should be included in the documentation of the included elements.

Integration of included BW objects

jump to top

Set which details of the DataSources out of the source system should be included in the documentation of Lumira Documents.
The two checkboxes under "Selection of related BW entities to be included in the documentation" add a chapter to the documentation, in which the included Queries and InfoProvider are documented.

If any of these options are activated, you will also have to connect to the BW source system.


BPC

jump to top

Documentation of Models

jump to top

Set which component of a Model should be included in the documentation.

Documentation of Environments

jump to top

Set which component of an Environment should be included in the documentation.


HANA

jump to top

Details to be included in the documentation for Attribute, Analytic & Calculation Views

jump to top

Set which details should be included in your documentation of Attribute, Analytic or Calculation Views.

Documentation of Calculation Views

jump to top

Set what should be included in the documentation of Calculation Views.

Documentation of Analytic Privileges

jump to top

Set, if details for the Assign Restrictions should be documented.


Translations

jump to top

History

jump to top

Set the period for how long the history of the translation is kept.

Language order

jump to top

Adjust the order of the languages in the language selection dropdown for each system.



  • No labels