Providing and adapting the report function

Attention

Attention: Adapting and providing reports as well as defining and setting parameters of the search fields for configuring reports in the Report manager requires knowledge of the CRM data model and should be carried out preferably by administrators with customizing knowledge.

Administra­tion / reports /...

Explanation, usage

Report manage­ment

Overview of standard and customized reports

Report search groups

Grouping search conditions

report types

Types of reports in the CRM including a pictogram

Report time selection

For displaying hours, days, weeks, etc., when adjusting reporting periods

Template status

Management of the template statuses, for example: in process, approved...

Report elements

Elements that are used regularly with template management. There’s an import function at the list.

Berichtsfarben

 

Report objects

Selection menu in the template management "for object". As the value the tables are set that are used by the template.

Report handler

- Preview handler for generating reports and editing in a report preview.
- Check-in handler for postprogramming office 2007 couplings (when using already adapted preview handlers)

Report tools

List of the report tools used in the CRM including the implementation class

Template areas

Management of areas for structured filing of templates (area/topic)

In the administration area, the Report management is available (menu Administration/Reports). Administra­tors and report developers get a full overview of standard and customized client-specific reports  (Windward report, Crystal Reports, CSV export, Excel export) with the following control options:

  • Providing the reports for masks
  • Report status (show, inactive, invalid)
  • Select and NoSelect report printout
  • Parameterization of the report printout (analogously to the earlier report function PSA_GEN_RPT_… )
  • Definition of search fields for each report the user is permitted to configure.   
  • Journal for change tracking and upgrade security

List report manager

Field title

Annotation

Icon / Type

Type of the report: Windward reports, Crystal reports, CSV-export, Excel-export

Name

Name of the report: Displayed in the list of the report manger.

Object (Ident)

A freely chosen object name. It establishes the connection to a mask (via an INI-Tag).
See also below: Adding reports in the report management

Object additional query

Restriction of the objects to records with a specific process ID (from the process definition).
See also below: Further options

Description

Displayed as additional information for the user in the “Description” field in the report manager .

Status

Controls whether the report is in the report list of the report manager or not. [Show, Inactive, Invalid]
See also below: Further options

Select
NoSelect

Controls whether the report contains data from the selected or from all records of the mask.
See also below: Further options

Report name

Template ID. Establishes the connection to the template management.

Collumns in the yel­low area

Parameter of the previously used report function PSA_GEN_RPT_…

Parameter

Parameters that are passed additionally to the report engine and are evaluated at the report manager as well.

Base relation

Association name in case the report receives its data from a DTO different from the report of the header mask.
See also below: Further options

Copy search condi­tions

Controls whether a search condition on the mask should be applied.
See also below: Further options

Dialog

Follow-up dialog of the report manager (customizing).
See also below: Further options

Adding reports in the report management

Internal and especially client-specific reports must exist in the CRM template man­agement as a complete report template with an XML loader and layout.

  • Create a new report record in the Report management list, and assign name and description.
  • Assign an object name (Ident). The identifier can be freely chosen, and links to the mask.
  • In the Report name column, enter the template ID of the report from the template management.
  • In the following yellow columns, specify the parameters of the previously used report function PSA_­GEN_RPT_….
  • Set the Status to Show to display the report in the report generator.

Making reports available in masks

Only if a report is available in a mask, it is displayed in the report list of the report manager, where one can select it.

The Startup dialog field used in the template management is replaced with following assignment in the mask: Enter the INI-Tag with the method PSA_INI_RPT_MNG in the mask and assign the parameter OBJ_NAM: = object name (see in the standard list the PSC_TAG data object).

Note: This field is no longer used since standard features for report generation in the function bar were discontinued and the Report Manager was launched.

Further options

Object additional query

In overview lists, as for example in the sales cases overview PSA_PRO_SAL_ESL, different objects (e.g., business opportunities, quotes, orders) can be displayed. In this case it must be ensured that, e.g., in the selected quote record, no order report is created.

To realize this, the process ID to which the report applies must be specified in the Object additional query column, e.g., PSA_PRO_QUO. Furthermore, in the parameter of the INI-Tag at the mask, exactly that field needs to be specified in the form OBJ_FLD=field name  which should capture the object restriction as a search condition, e.g., OBJ_FLD=SAP_IDN.

Select and NoSelect reports

Most reports are executed for the selected record (the check box in the Select column is set). For reports of all records in the mask, additionally or alternatively tick the checkbox in the NoSelect column.

Basis relation (only for reports of the CSV export type)

For reports that take their data from a different data class than that of the header mask (e.g., a contact report at a case form), the name of the respective association defined in the data class of the mask must be specified in the Basis relation column.

The Copy search conditions flag controls whether a query condition in the mask should be applied or not.

Defining a follow-up dialog for the manager dialog (customizing)

If a customer-specific follow-up dialog is required for the report manager for querying further report options, a corresponding dialog name can be specified in the Dialog column. The dialog opens after selecting the report and confirming in report manager with "Execu­tion".

Hiding standard reports and replacing them with customized reports

Report records in the report management can be overloaded. For this, the Status of the standard report needs to be set to Inactive, and the customer-specific report must be set to Show. The overloading can be traced in the journal and is considered when upgrading.

Report availability and active subforms

For masks with submasks, the environment variable PSA_RPT_MNG_CAL_TOP can be used to control globally whether the reports of the submask (according to the INI tag) or the reports of the header mask (according to the INI tag) should be offered in the Report Manager when the submask is active.

Defining the search fields for report configuration as a user

The search fields can be defined in the Search condition sublist. The search fields are created at runtime and are displayed in the report manager in the Search conditions section.

Note: If the scroll bar is missing in the Search conditions section of the Report Manager for all reports with multiple search conditions, then the value of the variable PSC_CFR_SCL_DLG is probably set to n, and you may no longer be able to reach the conditions below. In this case, change the value of the variable to y for the users or groups concerned.

Loader: Macro for the export language

To implement a dynamic search condition for reports that depends on the template language and queries the current export language, $EXP_LNG can be used in the Loader.

Meaning of the fields in the “Search conditions” sublist

Field title

Annotation

Ask

Activates the interactive query of the search condition in the report dialog. A deactivated flag lets you define "hidden" static query conditions that are always executed.

Sequence

Presentation order of the search fields in the report manager

Group

Groups search conditions. The search fields are shown in the report manager as a block and receive the group name as a heading. The administration list of the group names can be accessed via the Administration/Reports/Report query groups menu.

Object

Name of the data class (for the "CSV export" report type) or the external name of the export class in the XML loader (for the "Windward report" report type).

Title

The title placed in front of the search fields in the report manager.

Field

Qualified name of the field in the data class on which the query should be exe­cuted. SELECT generates a checkbox in which users can select or unselect the whole group. The type needs to be L. The SELECT entry should always be the first entry of the group.

Type

D generates two fields for specifying a time period using the calendar (from >= date/time and to <= date/time)

F/I generates two fields for specifying a value span. The query conditions can con­tain operators and is not qualified automatically.

L generates a checkbox with three states.

S generates a field for specifying a query condition that can con­tain operators. The query condition is not qualified automatically.

Value

Presets the search field with a search condition.

Selector

Name of the selector at the search field. The selector must exist and must not contain parameters that reference other fields.