Reporting Base Class and Subclasses
This base class (CmRptReportingBase) and its subclasses define the background searches from which their results are generated into comma-separated value (CSV) reports.
The following subclasses derive from Reporting Base class, each representing a document usage report based on age or scope:
Document Usage By Class
Document Usage By Month
Document Usage By StorageArea
Document Usage By User
Document Usage By User By Class
Document Usage By User Record
Document Usage By Year
A subscription called "Reporting Subscription" is set on the Reporting Base class. This subscription invokes an event action that generates a CSV report based on the results of the background search.
Properties on the Reporting Base class include those that are inherited from the Background Search class, as well as those that are described in the following table.
You can view this class in the Administration Console for Content Platform Engine, under the object store navigation pane in Data Design > Classes > Sweep > Background Search.
- Allows instances: false
- Hidden: false
- Subclassed from: Background Search (CmBackgroundSearch) class
| Property name (symbolic name) | Type | Can this property be modified? | Description |
|---|---|---|---|
| Search Results CSV Document (CmRptSearchResultsCSVDocument) | Object | true | The Search Results CSV Document (CmRptSearchResultsCSVDocument) object that contains the CSV report that is generated by the background search. |
| Generate CSV(CmRptGenerateCSV) | Boolean | true | Indicates whether the CSV report should be generated after upon completion of the background search. |
CmRptDocumentUsageByClass
The Document Usage By Class class defines the background search for document usage by class.
Properties on the Document Usage By Class class are inherited from the Reporting Base class and the Background Search class.
You can view this subclass in the Administration Console for Content Platform Engine, under the object store navigation pane in Data Design > Classes > Sweep > Background Search. You can also view this subclass in the Data Design > Background Search Templates folder.
Class metadata:
- Allows instances: true
- Hidden: false
- Subclassed from: Reporting Base (CmRptReportingBase) class
CmRptDocumentUsageByMonth
The Document Usage By Month class defines the background search for document usage by month.
Properties on the Document Usage By Month class are inherited from the Reporting Base class and the Background Search class.
You can view this subclass in the Administration Console for Content Platform Engine, under the object store navigation pane in Data Design > Classes > Sweep > Background Search. You can also view this subclass in the Data Design > Background Search Templates folder.
- Allows instances: true
- Hidden: false
- Subclassed from: Reporting Base (CmRptReportingBase) class
CmRptDocumentUsageByStorageArea
The Document Usage By Storage Area class defines the background search for document usage by storage area.
Properties on the Document Usage By Storage Area class are inherited from the Reporting Base class and the Background Search class.
You can view this subclass in the Administration Console for Content Platform Engine, under the object store navigation pane in Data Design > Classes > Sweep > Background Search. You can also view this subclass in the Data Design > Background Search Templates folder.
- Allows instances: true
- Hidden: false
- Subclassed from: Reporting Base (CmRptReportingBase) class
CmRptDocumentUsageByUser
The Document Usage By User class defines the background search for document usage by user.
Properties on the Document Usage By User class are inherited from the Reporting Base class and the Background Search class.
You can view this subclass in the Administration Console for Content Platform Engine, under the object store navigation pane in Data Design > Classes > Sweep > Background Search. You can also view this subclass in the Data Design > Background Search Templates folder.
Class metadata:
- Allows instances: true
- Hidden: false
- Subclassed from: Reporting Base (CmRptReportingBase) class
CmRptDocumentUsageByUserByClass
The Document Usage By User By Class class defines the background search for document usage by user by class.
Properties on the Document Usage By User By Class class are inherited from the Reporting Base class and the Background Search class.
You can view this subclass in the Administration Console for Content Platform Engine, under the object store navigation pane in Data Design > Classes > Sweep > Background Search. You can also view this subclass in the Data Design > Background Search Templates folder.
- Allows instances: true
- Hidden: false
- Subclassed from: Reporting Base (CmRptReportingBase) class
CmRptDocumentUsageByUserRecord
The Document Usage By User Record class defines the background search for document usage by user record, which associates a user of a document, such as the creator or last modifier, with an instance of the
CmRptUserRecord class. By default, this background search does not generate a CSV report.
It returns an CmRptUserRecord object on the Document Usage By User Record Result instance.
Properties on the Document Usage By User Record class are inherited from the Reporting Base class and the Background Search class.
You can view this subclass in the Administration Console for Content Platform Engine, under the object store navigation pane in Data Design > Classes > Sweep > Background Search. You can also view this subclass in the Data Design > Background Search Templates folder.
- Allows instances: true
- Hidden: false
- Subclassed from: Reporting Base (CmRptReportingBase) class
CmRptDocumentUsageByYear
The Document Usage By Year class defines the background search for document usage by year.
Properties on the Document Usage By Year class are inherited from the Reporting Base class and the Background Search class.
You can view this subclass in the Administration Console for Content Platform Engine, under the object store navigation pane in Data Design > Classes > Sweep > Background Search. You can also view this subclass in the Data Design > Background Search Templates folder.
- Allows instances: true
- Hidden: false
- Subclassed from: Reporting Base (CmRptReportingBase) class