Developing Custom Reports

IdentityIQ includes a reporting architecture that greatly simplifies the process of developing custom reports by allowing the developer to specify the report requirements in a TaskDefinition XML document. The executor uses IdentityIQ's Forms API to generate the UI form for specifying parameters, and creates the report output based on column configurations specified in the TaskDefinition. The XML specifies the report's Standard Properties values, the report-specific parameters, the columns that are available for the report, how the data is retrieved for inclusion on the report, and how the report results are laid out in both the detail and summary sections.

The standard report templates provide some good examples of how to define reports through XML. Excerpts from these standard templates are used in this section to illustrate how to configure custom reports. Many of the excerpts come from the Uncorrelated Accounts Report, a simple example that can be used to explore the basics of defining a custom report.

It can be helpful to examine the full XML for these reports to see the tags' usage in context as they are referenced and excerpted in this section. The reports can be viewed through the Debug pages as described in XML Representation of Reports and Instances, or the entire set of TaskDefinition objects can be exported to a file through the iiq console and explored in a text editor. The console export command to write the system's TaskDefinition objects to a file is "export taskDefs.xml TaskDefinition" (where "taskDefs.xml" is the name of the file to which the objects are exported). Note that the file contains all tasks including reports because no filter available on the export command to select only a subset of objects of a given type.

See:

• Reports in the IdentityIQ Object Model

• Report Definition

• Report Forms

• Reports DataSource Example