ReportForm: Collecting Report-Specific Parameters

Most reports allow you to set filters that constrain the contents of the generated report. In custom reports, report-specific parameters are collected from the report user through a custom form, that is referenced through a ReportForm element in the report definition. The form must be specified as a separate XML document and imported into IdentityIQ. The Form object is described in Report Forms.

The ReportForm element references the form like this:

Copy 
<ReportForm>
<Reference class="sailpoint.object.Form" id="4028460238edaba40138edb36b330010" name="Uncorrelated Account Report Custom Fields"/>
</ReportForm>

The referenced ReportForm is presented to the user in the Edit Report window between the two standard form pages that are part of every report's specification: Standard Properties and Report Layout. Those two standard pages are rendered based on a Form object called Report Skeleton using values specified in the report's TaskDefinition XML. These tables indicate which TaskDefinition elements and attributes determine the values for fields on the Standard Properties and Report Layout pages.

Standard Properties Field

TaskDefinition Source

Name

If editing a customized report instance, <TaskDefinition> name attribute

<TaskDefinition name="Uncorrelated Accounts - Financials" … >

If creating a new report instance based on a template, none (not populated)

 

Previous Result Action

<TaskDefinition> resultAction attribute<TaskDefinition name="Uncorrelated Accounts Report" resultAction="Rename" … >

Description

<Description> element

Scope*

 resultScope entry in Attributes map (value contains ID of selected scope)

<entry key="resultScope" value="2c9082ee38e813a20138e934eb210146"/>

Email Recipients*

emailIdentities entry in Attributes map (List contains Identity ID values)

<entry key="emailIdentities">
<value>
<List>
<String>4028460238edaba40138edb35653000b</String>
</List>
</value>
</entry>

Usually specified in instance XML instead of template XML

Allow Concurrency

<TaskDefinition> concurrent attribute (concurrent="true")<TaskDefinition concurrent="true" name="Uncorrelated Accounts Report" … >

Require Signoff*

<SignoffConfig> element

<SignoffConfig>
<WorkItemConfig created="1344962495866" escalationStyle="none" id="4028460238edaba401392603057a1464">
<NotificationEmailTemplateRef><Reference class="sailpoint.object.EmailTemplate" id="4028460238ed9b8e0138ed9bd8690106" name="Default Report Template"/>
</NotificationEmailTemplateRef>
<Owners><Reference class="sailpoint.object.Identity" id="4028460238edaba40138edb36b33016d" name="Aaron.Nichols"/>
</Owners>
</WorkItemConfig>
</SignoffConfig>

 

Report Layout Field

TaskDefinition Source

Sort By*

reportSortBy entry in Attributes map

<entry key="reportSortBy" value="accountGroupDisplayName"/>

Sort Ascending*

reportSortAsc entry in attributes map

<entry key="reportSortAsc">
<value>
<Boolean>true</Boolean>
</value>
</entry>

Group By*

reportGroupBy entry in Attributes map

<entry key="reportGroupBy" value="application"/>

Columns

<ReportColumnConfig> header attributes; hidden="true" attribute places column in left pane - available but not included on report detail by default

<ReportColumnConfig field="accountGroupName" header="rept_app_account_grp_memb_col_name" property="value" sortable="true" />

Disable Report Summary Display*

disableSummary entry in Attributes map

<entry key="disableSummary" value="true"/>

Disable Report Detail Display*

disableDetail entry in Attributes map

<entry key="disableDetail" value="true"/>

* These fields are typically specified through the UI for customized instances of reports and saved into the My Reports instances' attributes map, rather than being specified in the report template XML. However, they can be specified in the template XML if they apply to the report's default configuration.

Although most reports do include a custom form, it is not required. When one is not specified, the Edit Report window still displays the Standard Properties and Report Layout pages; the Identity Status Summary report shows an example of this.