In this page
CQL fields
The Better Content Archiving app introduces the following CQL fields that you can use in your queries.
You can, of course, use these fields in combination with the built-in CQL fields or fields provided by other third party apps. Note that the arch.* prefix is used to avoid conflict with other CQL fields, effectively creating a unique namespace for the Better Content Archiving app.
Status
| Field | Description |
|---|---|
| arch.status | The name of the content's status. |
| arch.status.id |
The ID of the content's status. (Searching by status ID is less readable than by name, but it is stable if the status is renamed. On the other hand, a status with a specific name can be re-created any time. Which one is optimal depends on your use case. To figure out the ID of a status, see the value of the "arch.status.id" CQL field for any content in that status through the Status details → CQL fields tab.) |
| arch.previousStatus |
The name of the content's previous status. (It is the status from which the content entered its current status.) |
| arch.previousStatus.id |
The ID of the content's previous status. (Searching by status ID is less readable than by name, but it is stable if the status is renamed. On the other hand, a status with a specific name can be re-created any time. Which one is optimal depends on your use case. To figure out the ID of a status, see the value of the "arch.status.id" CQL field for any content in that status through the Status details → CQL fields tab.) |
| arch.status.changedOn |
The timestamp when the status was last changed. (It is when the content entered its current status.) |
Views (view analytics)
| Field | Description |
|---|---|
| arch.event.lastViewedBy | The user ID who last viewed the content. |
| arch.event.lastViewedOn |
The timestamp when the content was last viewed. (Page views are tracked from the time of app installation. That's why it is particularly dangerous to archive or delete contents that were last viewed e.g. more than 100 days ago if the app was installed less than 100 days ago!) |
Updates (update analytics)
| Field | Description |
|---|---|
| arch.event.lastUpdatedBy | The user ID who last updated the content. |
| arch.event.lastUpdatedOn | The timestamp when the content was last updated. |
Owners
| Field | Description |
|---|---|
| arch.anyOwner |
The list of the user IDs who own the content, either directly or through inheritance. This field consolidates both types of ownership into a single list. (It can contain zero, one or multiple IDs.) |
| arch.anyOwner.count | The number of the users who own the content, either directly or through inheritance. |
| arch.anyOwner.setOn | The timestamp when the content owners were set, either directly or through inheritance. |
| arch.directOwner |
The list of the user IDs who own the content, directly. It includes the owners and tree owners set on this content. (It can contain zero, one or multiple IDs.) |
| arch.directOwner.count | The number of the users who own the content, directly. |
| arch.directOwner.setOn | The timestamp when the content owners were set, directly. |
| arch.inheritedOwner |
The list of the user IDs who own the content, through inheritance. It includes the tree owners set on any ancestor of this content. (It can contain zero, one or multiple IDs.) |
| arch.inheritedOwner.count | The number of the users who own the content, through inheritance. |
| arch.inheritedOwner.setOn | The timestamp when the content owners were set, through inheritance. |
The following, more granular fields are also available. These are primarily used internally by the app and are less useful for end-user searches.
| Field | Description |
|---|---|
| arch.owner | The list of the user IDs who own the content and are not inherited by descendants. (It can contain zero, one or multiple IDs.) |
| arch.owner.count | The number of the users who own the content and are not inherited by descendants. |
| arch.owner.setBy | The user ID who set the content owners. |
| arch.owner.setOn | The timestamp when the content owners were set. |
| arch.treeOwner |
The list of the user IDs who own the content and are inherited by descendants. These effectively own the entire content tree rooted at this content. (It can contain zero, one or multiple IDs.) |
| arch.treeOwner.count | The number of the users who own the content tree. |
| arch.treeOwner.setBy | The user ID who set the content tree owners. |
| arch.treeOwner.setOn | The timestamp when the content tree owners were set. |
Expiration
| Field | Description |
|---|---|
| arch.expirationDate | The timestamp when the content expires. |
| arch.expirationDate.inherited | A flag that represents whether descendant pages inherit the expiration date. |
| arch.expirationDate.setBy | The user ID who set the content expiration date. |
| arch.expirationDate.setOn | The timestamp when the expiration date was set. |
Archiving
| Field | Description |
|---|---|
| arch.archivingDate | The timestamp when the content is going to be archived. |
| arch.archivingDate.inherited | A flag that represents whether descendant pages inherit the archiving date. |
| arch.archivingDate.setBy | The user ID who set the archiving date. |
| arch.archivingDate.setOn | The timestamp when the archiving date was set. |
| arch.event.archivedOn | The timestamp when the content was archived. |
Excluded
| Field | Description |
|---|---|
| arch.exclusion | A flag that represents whether the content is excluded from content lifecycle management. |
| arch.exclusion.inherited | A flag that represents whether descendant pages are also excluded (i.e. "inherit the exclusion"). |
| arch.exclusion.setBy | The user ID who set the exclusion. |
| arch.exclusion.setOn | The timestamp when the exclusion was set. |
| arch.inExcludedSpace | A flag that represents whether the content is in a space that is excluded from content lifecycle management. |
Questions?
Ask us any time.