This topic describes IBM® Enterprise Records classes and properties that are most commonly used with IBM Enterprise Records Report-related queries.
These are not the only classes and properties that you can use in report queries, but rather these are the most commonly used items in typical reporting scenarios.
The following sections refer to these classes and properties by their locale-neutral "symbolic name" as opposed to their UI-related display name. You must use the symbolic name of a P8 CM RM class or P8 CM RM property as table and column identifiers in P8 CM RM report query SQL statements.
The following table describes several IBM Enterprise Records property types that are common to many IBM Enterprise Records classes and are useful for reporting purposes.
Symbolic Name | Data Type | Description |
---|---|---|
Id | Id | Unique identity of each P8 CM instance object |
Aggregation | String | Indicates the general type of an IBM Enterprise Records object. Allowable values are "RecordInfo", "ClassificationScheme", "RecordCategory", "RecordFolder" and "Volume". |
DateCreated | DateTime | Date of instance original creation |
Creator | String | Creator user name |
DateLastModified | DateTime | Date of instance last modification |
LastModifier | String | User name of last instance modifier |
IsDeleted | boolean | "True" if the IBM Enterprise Records object has been logically deleted. Typically included as a check for "False" in a WHERE clause |
Location, HomeLocation | Object [Location] | Typically applies to physical records and physical containers. This property value is often used within a LEFT OUTER JOIN clause with the Location table to determine the Location object's LocationName value. |
RMEntityType | A read-only, unique value assigned to each OOTB IBM Enterprise
Records class. Common values are:
Most often used in a WHERE clause to specify a
specific sub-type.
|
The following table describes several IBM Enterprise Records property types that are common to the out-of-the-box (OOTB) record container classes (For example, Record Category, Record Folder, Volume) and are useful for reporting purposes.
Symbolic Name | Data Type | Description |
---|---|---|
PathName | String | Full path name within the ObjectStore. |
DateOpened | DateTime | Represents the original date on which the container was first opened. |
DateClosed | DateTime | Represents the date on which the container was last closed. |
ReOpenedDate | DateTime | Represents the date on which a closed container was reopened. |
Inactive | boolean | "True" if the container is no longer active. |
DisposalSchedule | Object [Disposal Schedule] | The schedule, if any, assigned to the container. |
DisposalSchedule AllocationDate | DateTime | Date on which DispositionSchedule was associated with this instance. |
CurrentPhaseAction | Object [Action1] | Action instance associated with the current disposition phase. |
CurrentPhase ReviewDecision | String | Review comments for current disposition phase. |
CurrentPhase DecisionDate | DateTime | Date of current phase review decision. |
The syntax used to specify a descendent sub-container depends upon how deep into a container hierarchy the query is to search.
SELECT ... FROM RecordFolder rf WHERE rf.This INSUBFOLDER '/...'
SELECT ... FROM RecordFolder rf WHERE rf.This INFOLDER '/...'
SELECT ... FROM RecordFolder rf WHERE rf.Parent = OBJECT('/...')
SELECT ... FROM RecordInfo ri INNER JOIN ReferentialContainmentRelationship rcr ON ri.This = rcr.Head WHERE rcr.Tail = OBJECT('/...')
Symbolic Name | Data Type | Description |
---|---|---|
Head | Object [RecordInfo] | Reference to the containee object |
Tail | Object [Folder] | Reference to the container object |
ContainmentName | String | Unique name for the containee within the container. |
The following table describes several IBM Enterprise Records property types that are common to the OOTB record classes (e.g., Electronic Record, Marker Record, ...) and that are useful for reporting purposes:.
Symbolic Name | Data Type | Description |
---|---|---|
DocumentTitle | String | Name of the record. Not necessarily the same as the record's containmentName within a container. |
Associated RecordType | Object [RecordType] | The RecordType instance, if any, associated with a record instance. |
CutOffInherited From | Id | The Id of the object by which a record is associated with a Disposition Schedule. Id is that of either a record container or a RecordType. |
CurrentPhaseAction | Object [Action1] | Action instance associated with the current disposition phase. |
CurrentPhase ReviewDecision | String | Review comments for current disposition phase. |
CurrentPhase DecisionDate | DateTime | Date of current phase review decision. |
IsVitalRecord | boolean | "True" if record is vital type.. |
VitalRecord ReviewDate | DateTime | Date of last vital record review. |
VitalRecord NextReviewDate | DateTime | Date of next vital record review. |
CurrentClassification | String | (DoD Classified) Current security marking set value. |
DowngradeOnDate | DateTime | (DoD Classified) Date of scheduled record downgrade. |
Downgrade Instructions | String | (DoD Classified) Downgrade instructions. |
DeclassifyOnDate | DateTime | (DoD Classified) Date of scheduled record declassification. |
Symbolic Name | Data Type | Description |
---|---|---|
DisposalSchedule Name | String | Schedule name. |
CutoffDisposal Trigger | Object [Disposal Trigger] | Trigger associated with this schedule. |
Symbolic Name | Data Type | Description |
---|---|---|
DisposalTrigger Name | String | Trigger name. |
EventType | integer | Uses "EventType" choice list:
|
Symbolic Name | Data Type | Description |
---|---|---|
PhaseName | String | Phase name. |
PhaseAction | Object [Action1] |
Symbolic Name | Data Type | Description |
---|---|---|
ActionName | String | Action name. |
ActionType | integer | Uses "ActionType" choice list:
|
Symbolic Name | Data Type | Description |
---|---|---|
RecordTypeName | String | RecordType name |
DisposalSchedule | Object [Disposal Schedule] | The Disposal Schedule instance associated with the RecordType instance |
DisposalSchedule AllocationDate | DateTime | Date on which DispositionSchedule was associated with this instance. |
Location class objects are associated with both physical record and physical record container classes. Such classes typically have a Location property of type object that accepts instances of class Location. In some instances, there is also a HomeLocation property of the same type.
Symbolic Name | Data Type | Description |
---|---|---|
LocationName | String | Location name |
BarcodeID | String | Represents a barcode value scanned from an actual physical container. |
An IBM Enterprise Records hold can be applied to individual records or record containers. Instances of the RecordHold class represent distinct hold situations that are applied to zero or more items. The RecordHold class is used for both records and record containers. There is a many-to-many relationship between holds and held items: a given RecordHold instance can be applied to more than one record/record container and any given record/record container can be associated with more than one RecordHold at a time. These relationships are instituted by means of either the RecordHoldLink or RMFolderHoldLink classes.
Symbolic Name | Data Type | Description |
---|---|---|
HoldName | String | Hold name |
HoldType | String | Associated with the "HoldTypeList" choice list |
Active | boolean | "True" indicates that the hold instance is currently active.. |
Symbolic Name | Data Type | Description |
---|---|---|
Head | Object [RecordInfo] or [RMFolder] | The held item member of this link |
Tail | Object [RecordHold] | The hold member of this link. |
DateCreated | DateTime | Represents the date on which this held item was "placed on hold". |
IsDynamicHold | Boolean | "True" to indicate that this hold relationship was established by means of the IBM Enterprise Records Hold Sweep service as opposed to having been manually applied. |
If IBM Enterprise Records auditing is enabled, then you can use instances of the RMAudit class to report actions by users on various IBM Enterprise Records class instances (For example, records, record containers, and other entities).
Symbolic Name | Data Type | Description |
---|---|---|
SourceObjectID | Id | Id of the object that was operated upon to trigger the audit event. |
LastModifier | String | Short name of user that operated on the source object |
InitiatingUser | String | Name of user in the form of a principal name or distinguished name. |
DateLastModified | DateTime | Date on which the event occurred. |
AuditActionType | String | Action name, for example, Declassify, Delete, Destroy, Downgrade, Export, Relocate, Transfer, Upgrade, Hold, Remove Hold, Undeclare. |