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

Previous Topic: Create a Snapshot Database Connection

Next Topic: The Snapshot Parameter XML File

Create a Snapshot Definition

A snapshot reflects the state of objects in CA Identity Manager at a given time. You use this snapshot data to build a report. To capture CA Identity Manager object data, you create a snapshot definition that exports the 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 or Copy an object of type Snapshot Type.
  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. Select the XML file associated with the report you want to run.

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

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

    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 use the default XML files that only export the data you need to run a specific report.

    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.