Archive Manager

For the most up-to-date documentation, please visit docs.brix.ch

Advanced-UI

The Archive Manager allows to automatically delete assets (or remove assets from all nodes but the configured one) according to the specified filter criteria. An archived asset is removed from all the nodes and added to the archive node. Assets can be unarchived again, so that they are linked to the same nodes as before the archive action took place. There can be one configuration for the menu and several configurations for the automation. Unarchiving is only possible via the menu, so automatically archived assets can only be unarchived if they have the same archive node as the automation (both need to have the same setting for the month node property).

Properties

To be configured in {home}/appserver/conf/custom.properties

archiveManager.license

type: string, required: yes, default: -

The license key for the plugin (product: archiveManager), provided by brix.

archiveManager.cronExpression

type: string, required: no, default: 0 0 1 * * ? (each night at 01:00)

When and how often the task is running.

archiveManager.enableAutomation

type: boolean, required: no, default: false

Enable/disable automation (to disable/enable automation just for a scope use the active property).

archiveManager.enableMenu

type: boolean, required: no, default: false

Enable/disable the menu (menuNodeId required if enabled).

archiveManager.menuNodeId

type: integer, required: no, default: -

Archive node for the menu. Has to be a permission defining node.

archiveManager.menuAllowedUserGroupIds

type: comma-separated list of integers, required: no, default: - (superadmins only)

User groups that are allowed to use the archive menu.

archiveManager.menuShowSummary

type: boolean, required: no, default: true

Show a message box summary after (un-)archiving assets via the menu.

archiveManager.menuMonthNodes

type: boolean, required: no, default: false

Whether month nodes should be created or not (contains assets archived during this month).

archiveManager.{scope}.userId

type: string, required: no, default: (api-User)

The user id used to execute the search (only assets visible to the user will be returned).

archiveManager.{scope}.filter

type: string, required: yes, default: -

The filter expression (see Search Util 2).

archiveManager.{scope}.nodeId

type: string, required: no, default: - (delete assets)

Archive node for the automated configuration. Has to be permission defining.

archiveManager.{scope}.active

type: string, required: no, default: true

Whether a configuration is active or not.

archiveManager.{scope}.monthNodes

type: string, required: no, default: false

Filter Examples

Assets expired 100 days ago or earlier and is linked to node 88 or 99 or one of their children: expires <= now - 100 and anyNodeRecursive = 88, 99

Assets where checkbox with id 123 is checked: field_123 = true

Assets where custom date information field with id 77 has a date at least 20 days in the past: field_77 <= now - 20

Compatibility Matrix

Archive Manager CELUM
1.0.0 6.4
1.1.0 6.4 (tested up to 6.8)

Release Notes

1.1.0

Released 2021-01-12

Made Archive Manager Toolkit-safe and added the monthNodes and menuMonthNodes properties

1.0.0

Released 2020-12-01

Initial version