Generating Certification Campaign Reports

This chapter describes how to create reports for a certification campaign.

About the Default Report Templates

DirX Identity provides some default reports that you can use immediately. They are located in Provisioning → Domain Configuration → Reports → Default → CertificationCampaigns. Each report contains the following files (for example, see Campaign with all properties):

  • Campaign with all properties – this file contains the search base and search filter for the report and a list with all attributes to be retrieved from the LDAP directory. This file contains the export formats for reports, by default: HTML, XML and RAW (to be passed to a XSLT transformer).

  • Settings for Producer/Selector – this file contains values for search filter, sort criteria, name of the report, search level, and attributes to be retrieved from LDAP.

  • Settings for Templates – this file contains flags to display or hide different fields from reports.

  • Templates – this file in XSLT format is the markup for the report.

Producing a Report

To run a report, right click on a certification campaign entry and then select Report. The dialog Run report pops up and lists the available reports for certification campaigns. Select one of them from the list.

Near the bottom of the dialog there is a description for the report and some parameter fields. Leave the search base and the scope: they refer to the folder for the selected campaign. Switch the type to HTML for a nice output format. Change the name of the output file or check Output to viewer if you want to check the report output in the dialog window.

Select XML as the output format if you want to check all available attributes and their values or if you want to process the file later on with an XML tool. In HTML format, some attributes and values are sometimes hidden during the XLST transformation depending on the settings in the report template.

Adding or Extending Reports

You can create a new report definition by starting with an existing report. For example, you can copy Campaign with Failed.Prepare certificates and then modify it to generate a report which contains certifications where applying the changes failed; that is, with the state FAILED.APPLY.CHANGES.

To adjust the search filter, change the following line in the entry Settings for Producer/Selector:

<var name="SearchFilter" value="(|(objectClass= dxrCertificationCampaign)(&amp;(objectClass=dxrCertificationEntry)(|(dxrState=FAILED.PREPARE)(dxrState=FINISHED))))"/>

to

<var name="SearchFilter" value="(|(objectClass= dxrCertificationCampaign)(&amp;(objectClass=dxrCertificationEntry)(dxrState=FAILED.APPLY.CHANGES))))"/>

Now this report will contain only the certification tasks where the changes could not be applied successfully.