Document Activity Upgrade
DATA CENTER
Overview
Comala Document Management 7 and later (data center only app) use Document Activity to record workflow events and activity.
The Document Activity Upgrade console lets a Confluence global administrator:
Run checks to validate the existing workflow activity in a space, and
Upgrade a space to use document activity
Use Revert Upgrade to roll back the data upgrade in a space (from v7.11.0+)
Workflow data with an applied workflow in a space created prior to the installation of the v7.0+ release needs to have the workflow data updated to use document activity capabilities.
The following spaces in your data center instance automatically utilize document activity in
New spaces, when a workflow is applied in the space
Existing spaces without an applied workflow (prior to installation of the data center-only app), on applying a workflow to a page or blog post in the space
These spaces are listed in the document activity upgrade console and identified as using document activity data.
A Document Management REST API is available for customers and partners. This REST API includes endpoints for
Document data upgrade pre-checks (Run checks)
Document data upgrade (Upgrade), and
Rollback of a document data upgrade (Revert Upgrade)
This REST API can be used, together with your existing business tools, to report on your workflow document activity data.
Document Activity Upgrade console
In Confluence Administration,
Choose Comala Document Management > Upgrade Activity.
The Document Activity Upgrade console lets you identify the current spaces that use Comala Document Management workflows and require upgrading.
The console lets a global administrator select one or more spaces, and
Run checks to validate the workflow data in the space to check for errors, or
Upgrade the workflow data to validate the workflow data and upgrade it to use document activity.
For a selected space, the global administrator can also
Use the Revert Upgrade to roll back the document activity data upgrade (from v7.11.0+)
The Activity Upgrade console table displays
A list of the spaces that need upgrading
The total number of pages in each space
The total number of pages with workflow activity in each space
The current upgrade check and upgrade status
The report also indicates the spaces that were created after Comala Document Management 7+ was installed.
The upgrade counter for spaces only shows the count of pending spaces for a document activity data upgrade and does not include new spaces.
A summary of the console table can be copied using the option in the Pre-upgrade checks statistics dialog box.
Only spaces with workflow events or activity are listed in the console, and only these spaces have a document activity upgrade status.
Once the check has been completed and no errors are identified, the selected space(s) can be upgraded to use document activity data.
If a space is already using document activity data to record workflow events and activities, the global administrator can choose the Revert Upgrade option to roll back the document activity data upgrade. This removes all data from document activity reports and reverts to page activity reporting (from v7.11.0+).
If no errors are identified, the pre-upgrade checks and upgrade of a space can be undertaken in a single action in Comala Document Management v7.0+.
Run the document activity pre-upgrade checks
To run the upgrade checks
Select one or more spaces listed in the console
Choose Run checks
A progress bar displays the upgrade check progress for each selected space.
If a space was created (or first had a workflow applied) after the installation of Comala Document Management 7 or later, the space automatically uses document activity data. It is listed in the console but cannot be selected.
The Status column displays the date and time of each space's successful validation of the pre-upgrade check and the duration of the upgrade.
A global administrator can cancel an in-progress pre-upgrade check by clicking on the progress bar for each individual space.
This can be done, for example, to mitigate any performance impact.
Each pre-upgrade check runs in parallel, and you might notice some performance impacts when starting a large number of checks at the same time. We recommend that you consider:
Scheduling checks for low traffic hours
Doing checks in small batches
Using the Upgrade checks REST API endpoints to manage the initiation and reporting on the pre-upgrade checks
Pre-upgrade check errors
The console displays the following warning message if a pre-upgrade error has been found in one or more spaces.
Upgrade validation pre-upgrade check errors for a space are displayed in the Status column. This includes
Unsuccessful status
Date and time of the validation check
Estimated time duration for any upgrade
Number of pages in space where errors where validation errors were found
Pages that have duplicated states in the page activity
A link to download a Support Package is also added to each space listing where an error has been found.
A validation pre-upgrade check error prevents the data upgrade from being run. If an error occurs, it must be fixed before the upgrade can proceed.
You can download the Support Package for each space with a validation error to view the errors and related pages.
If required, contact Appfire Support and include the Support Package as an attachment to this request.
Data upgrade in each space
After installing the data center-only version of the app, one or more spaces can be upgraded in the document activity upgrade console
Confluence data center Read-only mode must be enabled to run the data upgrade
Choosing the Upgrade button runs a data pre-check and upgrade in a single action
The Run Checks option can be selected to run document activity upgrade checks on selected spaces - this option does not require Read-only mode.
Enable Read-only mode
In Confluence global administration, under Administration
choose Maintenance
Select Edit
Check the box to enable Read-only mode
choose Submit
The site banner message is enabled by default when enabling Read-only mode.
Navigate to the Comala app global Upgrade Activity screen
All spaces with workflow events on at least one page or blog post are listed with their current data upgrade status: Check not started, Check successful, Upgrade successful, Upgrade unsuccessful, Check unsuccessful.
Check the checkbox for each space(s) to be upgraded
Choose Upgrade
The Status column displays a progress bar for each space chosen to be upgraded in the current upgrade action.
When the process is complete, the Status column displays the upgrade status, date, and time of the upgrade, and duration of the process.
Remember to disable Read-only mode after completing the data upgrade process.
New spaces created or later automatically use document activity (and there is no need to run any data upgrade process)
The new space displays the Upgrade successful status in the Activity Upgrade console when a workflow is applied to a page or blog post in the space.
Existing spaces with no previous workflow activity automatically use document activity on applying a workflow to any page in the space. The space is then displayed in the Activity Upgrade console with an Upgrade successful status
Space data status
The space data status is displayed in the document activity console.
The displayed page tools menu option and workflow status byline link to the workflow activity are based on the space data status and not the page data status.
Roll back a document activity data upgrade
A global administrator can choose the Revert Upgrade option in the Document Activity Upgrade console to roll back a space that has been upgraded to use document activity to record workflow events and activities.
This reverts the workflow event and activity history in a selected space to page activity. It also updates the related content properties including the Document Activity Upgrade Status, to indicate that the workflow data has not been upgraded to use document activity.
The data upgrade rollback action deletes any recorded workflow activity data used in the document activity report for the space, but this is not lost, as your workflow events are recorded in the page activity report.
To revert the document activity data upgrade in a selected space, in Confluence global administration:
Set the instance to Read-Only Mode
Navigate to the Document Activity Upgrade console
Use a checkbox to select a space (only one space can be selected)
Choose Revert Upgrade
Only one space can be selected for Revert Upgrade. Checking more than one space deselects the Revert Upgrade option.
Confirm the Revert Upgrade in the dialog box.
When the Revert Upgrade is complete, the space is set as Check not started.
On completion of the rollback of the upgrade:
No data related to the previous data upgrade is stored in Confluence
Page activity is rendered for all the pages with workflow events and activities
After reverting the upgrade for a space, you can run the data upgrade again.
Remember to make Read Only Mode inactive after you have run the Revert Upgrade process.
Accessing workflow events in spaces
Space with no previous workflow events
Non-upgraded space with previous workflow events
Upgrade successful status space with workflow events
Moving upgraded pages and non-upgraded pages to other spaces
Need support? Create a request with our support team.