Administration Guide › Reporting › How to Run Snapshot Reports › Create a Snapshot Definition

Create a Snapshot Definition

A snapshot reflects the state of objects in CA 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 Snapshot Database.

To create a snapshot definition

1. In the User Console, go to Reports, Snapshot Tasks, Manage Snapshot Definition, Create Snapshot Definition.
2. Create a 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 CA Identity Manager creates a snapshot based on the current snapshot definition at the scheduled time.

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

   • Snapshot Parameter XML File

     Specifies the Snapshot Parameter XML file that defines the objects and their attributes, which are exported into the Snapshot Database.

     The sample Snapshot Parameter XML files are located in the following directory:

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

     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 CA Identity Manager, and have existing export command files, move them to the sample Snapshot Parameter XML file directory for management in the User Console.

     Important! ExportAll.xml is the default XML file, but it is intended as a sample XML file only. If you use the ExportAll.xml file, it exports all of your data for reporting and can take a long time to complete. We recommend that you create custom XML files that only export the data you need to run your reports.

   • Keep Last

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

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

4. Click Submit.

   CA Identity Manager is configured to create snapshots of the objects mentioned in the Snapshot Parameter XML file.