Loading...
Area: Optimizely CMS
Applies to versions: 10.9 and higher
Other versions:

Activity logging

Recommended reading 
Note: This documentation is for the preview version of the upcoming release of CMS 12/Commerce 14/Search & Navigation 14. Features included here might not be complete, and might be changed before becoming available in the public release. This documentation is provided for evaluation purposes only.

The Optimizely Activity system is a facility where recent changes to the solution are tracked.

Note: The Activity API supersedes the deprecated ChangeLog API.

For example, changes to pages, blocks, and media items are logged as an Activity.

Activities are needed to support the project activity feed, mirroring, and other platform features, as well as providing a general short term auditing mechanism.

Activities are stored at least one month unless another platform feature has a dependency to certain activities, in which case they may remain for an additional period. Activities without remaining dependencies are archived or deleted by a scheduled job.

Archived activities are persisted for 12 months by default, but you can modify this by configuring the ArchiveRetentionPeriod property on ActivityOptions. (For CMS 10.9-11, add an activityArchiveRetentionPeriod attribute to the applicationSettings element in the web.config instead). The property value represents the number of months for which to retain activities in the archive.

  • To disable archiving completely, set the value to 0.
  • To disable the cleanup of the archive and let activities remain indefinitely, set the value to -1. You should not use this setting unless you put external safeguards in place.

You can retrieve archived activities only by using the IActivityQueryService.ListActivitiesAsync method, providing a query with the IncludeArchived flag set.

Administrators Change Log

The Change Log is an interface for administrators to list recent activities in Optimizely. For further information on the Change Log view, see the Change Log section in the Optimizely User Guide.

Programming interfaces

The classes and interfaces for the Activities API are in the EPiServer.DataAbstraction.Activities namespace in the EPiServer assembly.

Related information

Blog posts

external-link.png Episerver activity log with custom content security activity

Do you find this information helpful? Please log in to provide feedback.

Last updated: Jul 02, 2021

Recommended reading