IBM FileNet P8, Version 5.2.1            

Custom Subclasses Added to Abstract Search Result

The custom subclasses added to the Abstract Search Result class define the class of objects that are returned in the background search results.

The following custom subclasses derive from the system Abstract Search Result (CmAbstractSearchResult) class, each representing the results of a background search defined in the Reporting Base Class and Subclasses.

Document Usage By Class Result
Document Usage By Month Result
Document Usage By StorageArea Result
Document Usage By User Result
Document Usage By User By Class Result
Document Usage By User Record Result
Document Usage By Year Result

You can view these subclasses in the Administration Console for Content Platform Engine, under the object store navigation pane in Data Design > Classes > Other Classes > Abstract Search Result. You can also view these subclasses in the Data Design > Background Search Result Classes folder.

Document Usage By Class Result

The Document Usage By Class Result class defines the class of objects that are returned in the Document Usage By Class background search.

Properties on the Document Usage By Class Result class include those that are inherited from the base CmAbstractSearchResult class, as well as those that are described in the following table.

Class metadata:

Table 1. Custom properties on the Document Usage By Class Result class
Property name (symbolic name) Type Can this property be modified? Description
Class (CmRptClass) String true

The document class.

Maximum length: 64

Object Count (CmRptObjectCount) Float64 true Total number of documents per class.
Content Size (CmRptContentSize) Float64 true The total size of the documents in the class.
Date First Created (CmRptDateFirstCreated) Date true The first date that a document of that class was created.
Date Last Created (CmRptDateLastCreated) Date true The last date that a document of that class was created.
Date Last Modified (CmRptDateLastModified) Date true The date that a document of that class was last modified.

Document Usage By Month Result

The Document Usage By Month Result class defines the class of objects that are returned in the Document Usage By Month background search.

Properties on the Document Usage By Month Result class include those that are inherited from the base CmAbstractSearchResult class, as well as those that are described in the following table.

Class metadata:

Table 2. Custom properties on the Document Usage By Month Result class
Property name (symbolic name) Type Can this property be modified? Description
Date (CmRptDate) String true

The month and year the document was created.

Maximum length: 64

Object Count (CmRptObjectCount) Float64 true Total number of documents per class.
Content Size (CmRptContentSize) Float64 true The total size of the documents in the class.

Document Usage By Storage Area Result

The Document Usage By Storage Area Result class defines the class of objects that are returned in the Document Usage By Storage Area background search.

Properties on the Document Usage By Storage Area Result class include those that are inherited from the base CmAbstractSearchResult class, as well as those that are described in the following table.

Class metadata:

Table 3. Custom properties on the Document Usage By Storage Area Result class
Property name (symbolic name) Type Can this property be modified? Description
Storage Area (CmRptStorageArea) String true

The storage area where documents reside.

Maximum length: 64

Object Count (CmRptObjectCount) Float64 true Total number of documents per class.
Content Size (CmRptContentSize) Float64 true The total size of the documents in the class.
Date First Created (CmRptDateFirstCreated) Date true The first date that a document of that class was created.
Date Last Created (CmRptDateLastCreated) Date true The last date that a document of that class was created.

Document Usage By User Result

The Document Usage By User Result class defines the class of objects that are returned in the Document Usage By User background search.

Properties on the Document Usage By User Result class include those that are inherited from the base CmAbstractSearchResult class, as well as those that are described in the following table.

Class metadata:

Table 4. Custom properties on the Document Usage By User Result class
Property name (symbolic name) Type Can this property be modified? Description
User (CmRptUser) String true

The creator of the documents.

Maximum length: 80

Object Count (CmRptObjectCount) Float64 true Total number of documents per class.
Content Size (CmRptContentSize) Float64 true The total size of the documents in the class.
Date First Created (CmRptDateFirstCreated) Date true The first date that a document of that class was created.
Date Last Created (CmRptDateLastCreated) Date true The last date that a document of that class was created.

Document Usage By User By Class Result

The Document Usage By User By Class Result class defines the class of objects that are returned in the Document Usage By User By Class background search.

Properties on the Document Usage By User By Class Result class include those that are inherited from the base CmAbstractSearchResult class, as well as those that are described in the following table.

Class metadata:

Table 5. Custom properties on the Document Usage By User By Class Result class
Property name (symbolic name) Type Can this property be modified? Description
User (CmRptUser) String true

The creator of the documents.

Maximum length: 80

Class (CmRptClass) String true

The document class.

Maximum length: 64

Object Count (CmRptObjectCount) Float64 true Total number of documents per class.
Content Size (CmRptContentSize) Float64 true The total size of the documents in the class.
Date First Created (CmRptDateFirstCreated) Date true The first date that a document of that class was created.
Date Last Created (CmRptDateLastCreated) Date true The last date that a document of that class was created.
Date Last Modified (CmRptDateLastModified) Date true The date that a document of that class was last modified.

Document Usage By User Record Result

The Document Usage By User Record Result class defines the class of objects that are returned in the Document Usage By User Record background search.

Properties on the Document Usage By User Record class include those that are inherited from the base CmAbstractSearchResult class, as well as those that are described in the following table.

Class metadata:

Table 6. Custom properties on the Document Usage By User Record Result class
Property name (symbolic name) Type Can this property be modified? Description
User Record (CmRptUserRecord) Object true An instance of the CmRptUserRecord class that is associated with the user specified in the CmRpt::UserRecord custom function.
Object Count (CmRptObjectCount) Float64 true Total number of documents per class.
Content Size (CmRptContentSize) Float64 true The total size of the documents in the class.
Date First Created (CmRptDateFirstCreated) Date true The first date that a document of that class was created.
Date Last Created (CmRptDateLastCreated) Date true The last date that a document of that class was created.

Document Usage By Year Result

The Document Usage By Year Result class defines the class of objects that are returned in the Document Usage By Year background search.

Properties on the Document Usage By Year class include those that are inherited from the base CmAbstractSearchResult class, as well as those that are described in the following table.

Class metadata:

Table 7. Custom properties on the Document Usage By Year Result class
Property name (symbolic name) Type Can this property be modified? Description
Date (CmRptDate) String true

The year the document was created.

Maximum length: 64

Object Count (CmRptObjectCount) Float64 true Total number of documents per class.
Content Size (CmRptContentSize) Float64 true The total size of the documents in the class.


Last updated: March 2016
p8pcc155.htm

© Copyright IBM Corporation 2016.