Identity Manager 8.1 - Configuration Guide

Example of a simple report with data grouping

We want to create a report that lists all employees as grouped in their respective departments.

1. A new report is created.
   • The report is given the name CCC_Employee_by_Department. The display name defined is Employees by Department %UID%.
   • A data source, Employee by Department, is created for the report with the SQL query module. The data query should return the employees assigned to a department. The department is found with (XObjectKey). This is passed as a parameter to the report. The employee‘s first name (firstname), last name (lastname) and department name (departmentname) are queried.

     Select Firstname, Lastname, Departmentname

     from person join Department

     on person.uid_Department = department.uid_Department

     where Department.XObjectKey = @UIDDepartment

   • This adds the UIDDepartment parameter to the report. It is populated with a sample value for the preview.
2. The control elements for the database columns are arranged on the report form.
   • For data grouping, add a band of the Group header type from the Report Designer’s toolbox to the report form. The column name used for grouping must be entered as a grouping condition. In the example, this is Departmentname.

   Figure 38: Specifying the Grouping Condition

   

3. Drag and drop the Departmentname column from the Report Designer‘s dictionary (Dictionary tab) into the group header. This creates a new control element on the report form.

   Figure 39: Creating a Group

   

4. To display employees, add a Data band to the report form from the Report Designer‘s toolbox. Specify the data source as Employee by Department.

   Figure 40: Specify the Data Source

   

5. Drag and drop the Lastname and Firstname columns from the Report Designer‘s dictionary (Dictionary tab) to the data band. This creates the respective control elements on the report form.

   Figure 41: Organizing Control Elements on a Report Form

   

6. Other control elements such as a title (PageHeader) can be added as necessary with the Report Designer. The Report Designer Properties window allows you to customize individual control elements.
7. The preview can be used to view the report during setup. The preview uses the sample parameter values in the parameter view of the report edit dialog to determine the data for this.

   Figure 42: Report Preview

   

Detailed information about this topic

• Editing the general report properties
• Creating and editing a data source
• Report parameters
• Editing the report form

Translating reports

A report can contain several elements which require translating in order to display the report in more than one language:

• Database columns used in the report definition.

  Translate database columns with the Language Editor in the Designer.

• Display name/ReportAlias.

  The report's display name used when a report is created as ReportAlias. The display name is entered in the report properties dialog. Translate the given text using the button.

• Text elements on the report form.

  Translate the text elements directly in the Report Editor with the Globalization Editor.

To translate all text elements in a report

1. Select the report in the report list and open it with double-click or with Edit from the context menu.

   This opens the report form in the Report Designer.

2. Start the Globalization Editor.
   • Click on the button in the Report Designer toolbar.

     - OR -

   • Select the report from the menu on the Properties tab in the Report Designer’s properties view and use Globalization Strings to open the Globalization Editor.

     NOTE: You can only start the Globalization Editor from the Report Designer’s properties view if you have selected Professional. You can change the configuration type later in the edit view using the context menu in the property view.

3. Ensure Auto localize report on run is set.

   This means the report is generated in the current language.

4. Enter a culture for the language using Add culture and translate each entry.

To translate single captions

1. Select the report in the report list and open it with double-click or with Edit from the context menu.

   This opens the report form in the Report Designer.

2. Select the caption on the report form.
3. Open the dialog box using the in the Report Designer toolbar.
4. Translate the text and confirm the changes with OK.

Related Topics

• Displaying the translations in the Language Editor
• Editing the general report properties

Embedding reports in the user interface

In order to present a report in a One Identity Manager administration tool, such as Manager, you need to link in the report as a custom interface form. Create the interface form in the program Designer.

To create a user interface form

1. In Designer, select User interface | Forms | User interface forms.
2. Select Edit form in the task view.

3. Select Form | Insert.

4. Edit the interface form's master data.

   Take the following cases into account:

   • Use the VI_Report form definition.

     This form definition is configured for displaying in the graphical user interface and in web applications. You only need to set up one interface form for this. Which form template will be used to display the interface form is decided dynamically, depending on usage.

   • In the form’s configuration data, enter the name of the report to be run and the report parameters in the SpecialSheetData" section.

     Syntax:

     <DialogSheetDefinition FormatVersion="1.0">

     <SpecialSheetData>Report name|Parameter1=value1|Parameter2=value2 ..

     ...

     </SpecialSheetData>

     </DialogSheetDefinition>

     Example:

     <DialogSheetDefinition FormatVersion="1.0">

     <SpecialSheetData>CCC_Employee_by_Department|UIDDepartment=%UID_Department%</SpecialSheetData>

     </DialogSheetDefinition>

5. Assign the user interface form to the applications and permissions groups.
6. (Optional) Assign the user interface form to the object definitions.
7. (Optional) Assign the user interface form to the menu items.

Related Topics

• Editing user interface forms
• Creating a new user interface form
• Assigning a user interface form to an application
• Assigning a user interface form to a permissions group
• Assigning a user interface form to a menu item
• Assigning a user interface form to an object definition

Creating and exporting reports on a cyclical basis

You can create customer-specific processes to control the creation of reports and perform the export on a cyclical or event-controlled basis.

You can use the ReportComponent process component to create reports and export them to different file formats. The following formats are supported: HTML, PDF, RTF, TEXT, XLS, TIFF, XML, CSV, XPS, DOCX,and XLSX.

To exports reports in CSV format, you can also use the ScriptComponent process component with the CSVExport or CSVExportSingle process functions.

Related Topics

• Defining processes