Administration Guide › Reporting › How to Create a Custom Report › Create a Snapshot Definition

Create a Snapshot Definition

A snapshot reflects the state of objects in Identity Management at a given time. The snapshot data is used to build a report. To capture snapshot data, you create a snapshot definition that exports the data to the Snapshot Database. Using the snapshot definition, you define the rules to load users, endpoints, admin roles, provisioning roles, groups, and organizations.

Follow these steps:

1. In the User Console, go to Reports, Snapshot Tasks, Manage Snapshot Definition, Create Snapshot Definition.
2. Select Create or Copy an object of type Snapshot Type.
3. Click Ok.
4. Under the Profile tab, complete the following fields to create a snapshot definition profile:

   Snapshot Definition Name

   Identifies the unique name that is given for the snapshot definition.

   Snapshot Definition Description

   Displays any additional information that you want to describe the snapshot.

   Enabled

   Specifies that data is exported to the snapshot database at the scheduled time.

   Note: If this option is not selected, you cannot schedule to generate a snapshot report for this profile. Also, the snapshot definition is not listed in the Capture Snapshot Data screen.

   Number of snapshots retained

   Specifies the number of successful snapshots retained in the Snapshot Database.

   Note: If you do not specify a value for this field, Identity Management stores unlimited snapshots.

5. On the Snapshot Policies tab, select the objects that are related to the policies to export.
6. On the Role Settings tab, select one or more role components and available attributes for the snapshot to export.
7. On the User Attributes Details tab, select one or more user attributes for the snapshot to export.

   Note: In the Snapshot Policies tab, if you select only the User object, by default, all user attributes related data are exported.

8. On the Endpoint Account Attributes tab, select one or more account attributes for an endpoint type.

   Note: For a selected endpoint type, by default, all data related to endpoint account attributes is exported. To capture data related to a specific attribute, select the appropriate attribute. For more information about selecting attributes that are necessary to export for an endpoint type, see the Default Reports section in the Configuration Guide.

9. (Optional) Select the Export Orphan Accounts check box to include endpoint accounts with no global user in the Provisioning Server.

   Note: To export report data for non-standard, non-standard-trend and orphan account reports, select exceptionAccount attribute and Export Orphan Accounts check boxes.

10. Click Submit.

    Identity Management is configured to create snapshots of the objects mentioned in the snapshot definition.

Now that you have created a snapshot definition, you can capture snapshot data immediately or can schedule the snapshot data export at a later time.

More information:

Recurrence Tab