Show TOC

Function documentationRule Database Locate this document in the navigation structure

 

The Solution Documentation Assistant offers a rule database with an overview of all available step checks, including those that are not assigned to any analysis project.

In the rule database you can

  • Search for check steps and display relevant details

  • Edit and copy check steps, and create new check steps

  • Download check steps as a file, to reuse them in another implementation of the Solution Documentation Assistant (for example, for another customer).

Prerequisites

You have called the Rule Database view in the Solution Documentation Assistant.

Features

The rule database searches for check steps. The results table displays all check steps in the rule database that meet the search criteria.

When searching for check steps, you can, for example:

  • search for the name of the check step.

  • search for check steps of type transaction, report or function module (RFC), by entering the name of the transaction of the report or function module (RFC) affected, in the Object Name field.

  • You can search for check steps of type BAdI, SQL, or usage procedure logging (UPL) as follows:

    • In the Object Name field, enter:

      • SQL: name of the table

      • BAdI: name of the BAdI

      • UPL: name of the class

    • In the Subobject Name field, also enter:

      • SQL: name of a table field

      • BAdI: name of the BAdI implementation

      • UPL: name of the method

For each check step, the standard view of the table displays:

  • Name of the check step, by default this is made up of the name and description of the Referenced Object, in a transaction, for example SE16 – Data Browser.

  • Type of check step, for example, transaction

  • Last Changed by, the user who last changed the check step

  • Changed on, time of last change

For each check step, the following detailed information is provided on the following tab pages:

  • Object Detail shows information about the object that the check step refers to:

    • Object Name, for example, transaction name

    • Object Type, for example, transaction or report

    • Object Description, for example Data Browser, in the case of the object for transaction SE16

  • Attributes

  • Use shows to which check items the check step is assigned, and so to which structure nodes in which analysis projects. The following is displayed for each use or assignment:

    • Name of the Check Item to which the check step is assigned

    • Node Type: Structure node type to which the check item is assigned, for example, a business process

    • Node Name: Name of the structure node, for example, Create Order.

    • Analysis Project: Name of the analysis project to the analysis structure of which the executed node belongs.

Activities

  • You can search for check steps with detailed criteria. Enter at least the type of the check steps that you want to search for.

    The search shows all check steps of the selected type, in a table.

  • Select a check step, to display its detailed information.

  • To create a new check step, choose Create.

  • To change a check step, select it, and choose Edit.

  • To create a new check step from an existing one, select it and choose Copy.

    Note Note

    For check steps assigned to only one single object (such as transactions or reports), copying is not necessary. In such cases, a message appears, stating that copying is not permitted.

    End of the note.
  • To delete one or more check steps, select them, and choose Delete.

    Note Note

    You can only delete check steps that you have created yourself.

    You cannot delete check steps that are still used. In this case, check the use of the check step. Once all assignments of the check step have been removed, you can delete it from the rule database.

    End of the note.
  • To save one or more check steps on a data medium, choose Download.

  • To unlock one or more password-protected SQL check steps, choose Unlock.