Previous Topic: Limit the Scope of the Report SnapshotNext Topic: How LDAP Queries Limit the User and Group Data in the Report Snapshot

Implementation Guide › Implementing Enterprise Reporting › How to Set Up Reporting Service Server Components › Create a Snapshot Definition › Snapshot Parameter XML File Syntax—Limit Report Snapshot

Snapshot Parameter XML File Syntax—Limit Report Snapshot

The snapshot parameter XML file specifies that report data that CA ControlMinder Enterprise Management collects. You can limit the scope of the report snapshot by editing the snapshot parameter XML file.

CA ControlMinder Enterprise Management collects report data only for the objects that meet the criteria that you define in the snapshot parameter XML file. Each collector in the file defines a set of objects that CA ControlMinder Enterprise Management collects.

Each collector has the following structure:

<export object=" ">
	<where attr=" " satisfy=" ">
		<value> </value>
	</where>
	<exportattr attr=" " />
</export>

Note: The <where>, <value>, and <exportattr> elements are optional.

Each collector contains the following elements:

<export>

Indicates the object data that CA ControlMinder Enterprise Management collects. For example, the <export> element may specify that CA ControlMinder Enterprise Management collects user data.

The <export> element can include one or more <exportattr> and <where> elements, which let you collect only the data that meets certain criteria. If you do not specify any <exportattr> or <where> elements, CA ControlMinder Enterprise Management collects all of the data for the object.

The <export> element has only the object parameter.

<where>

Filters the collected data based on the criteria defined by the <value> element. A <where> element must include at least one <value> element. You can specify multiple <where> elements to refine your filter (they act as OR elements).

The following table describes the parameters for the <where> element:

Parameter

Description

attr

Indicates the attribute to use in the filter.

satisfy

 

Indicates whether some or all of the value evaluations must be satisfied for the object or attributes to be collected.

  • ALL—An attribute or object must satisfy all of the value evaluations.
  • ANY—An attribute or object must satisfy at least one value evaluation.
<value>

Defines, in a <where> element, the condition that an attribute or an object must meet to be collected. The <value> element requires the operator (op) parameter. The operator can be EQUALS or CONTAINS.

Note: In the <!--PUPM COLLECTORS--> section of the snapshot parameter XML file, you can use LDAP syntax in <value> elements. The LDAP syntax lets you specify the user and group data that CA ControlMinder Enterprise Management collects from Active Directory.

<exportattr>

Indicates a specific attribute to collect. Use the <exportattr> element to collect a subset of attributes for the object you are collecting. For example, you can use the <exportattr> element to collect only a user’s ID.

The <exportattr> element has the attr parameter.

The following table shows attributes that can be used in a <where> element or an <exportattr> element, by object:

Object

Attributes you can use in a <where> element

Attributes you can use in an <exportattr> element

role

You can filter with the name attribute.

name—the roles with names that satisfy the filter

You can collect any of the following attributes:

  • |tasks|—all tasks associated with the role
  • |rules|—all member, admin, owner, and scope rules that apply to the role
  • |users|—all members, administrators, and owners of the role
  • |rolemembers|—all role members
  • |roleadmins|—all role administrators
  • |roleowners|—all role owners

user

Any well-known or physical attribute and any of the following attributes:

  • |groups|—the members of a group
  • |roles|—the members of a role
  • |orgs|—users whose profiles exist in organizations that satisfy the filter

You can collect any of the following attributes:

  • |all_attributes|—all available user attributes
  • |groups|—all groups where the user is a member or admin
  • |roles|—all roles where the user is a member, admin, or an owner

group

Any well-known or physical attribute or the following attribute:

|groups|—the list of nested groups within a group that satisfies the filter

You can collect any well-known or physical attribute or any of the following attributes:

  • |all_attributes|—all attributes defined for the Group object in the directory configuration file (directory.xml)
  • |groups|—all nested groups within the group
  • |users|—all members of the group
  • |groupadmins|—all users who are administrators of the specified group
  • |groupmembers|—all users who are members of the specified group
  • |users|—all group administrators and members

organization

Any well-known or physical attribute

You can collect any well-known or physical attribute or any of the following attributes:

  • |all_attributes|—all attributes defined for the Organization object in the directory configuration file (directory.xml)
  • |orgs|—all nested organizations within the organization
  • |groups|—all groups in the organization
  • |users|—all users in the organization