Reports › Create a Snapshot Definition

Create a Snapshot Definition

A snapshot reflects the state of objects in Identity Manager at a given time, and extracts this data, which can be used in one or more reports. You must create a snapshot definition before you can export data to the Reporting Database.

To create a snapshot definition

1. Click Reports, Manage Snapshot Definition, Create Snapshot Definition.
2. Create a new snapshot or copy an existing snapshot.
3. Enter the following details under the Profile tab:
   • Snapshot Definition Name

     Specifies the unique name given for the snapshot definition.

   • Snapshot Definition Description

     Displays any additional information to describe the snapshot.

   • Enabled

     Specifies that Identity Manager will create a snapshot based on the current snapshot definition at the scheduled time.

     Note: If this option is not selected, the snapshot will not be captured at the scheduled time. Also, the snapshot definition will not be listed in the Capture Snapshot Data screen.

   • Identifier

     Specifies the Snapshot Parameters XML file that defines the objects and their attributes, which will be exported into the Reporting Database. ExportAll.xml is the default Identifier file that will export all data for reporting. The sample Identifier files are located in the following directory:

     IdentityMinder.ear\config\com\netegrity\config\imrexport\sample

     Note: Previously, these files were known as export command files and were used by the imrexport tool. If you used reporting in a previous version of Identity Manager and have existing export command files, move them to the Identifier file directory for management in the User Console.

   • Keep Last

     Specifies the number of successful snapshots to be stored in the Reporting Database.

     Note: The number of snapshots should be greater than zero. If you do not specify a value for this field, Identity Manager will store unlimited snapshots.

4. Click the Recurrence tab to schedule the exporting of snapshot data for a later date and time.

   The scheduling details for the snapshot definition appear.

   Important! Exporting snapshot data can take a long time if you have a large amount of data to export. We recommend you schedule your snapshots with this in mind. If you do not schedule the snapshot, manually export the snapshot data using the Capture Snapshot Data screen.

5. Click Submit.

   Identity Manager is configured to create snapshots of the objects mentioned in the Identifier XML file.