Document Activity Upgrade
- Technical Communications
- Robert Alexander Marshall
- Alain Martínez
DATA CENTER
Overview
Comala Document Management 7 and later (data center only app) use Document Activity to record workflow events and activity.
Workflow data in existing spaces with an applied workflow prior to installation of the data center only app need to have the workflow data updated to use document activity capabilities.
The Document Activity Upgrade console allows Confluence Administrators to
complete pre-upgrade data checks to validate the existing page activity in their instance, and
estimate the time for the data upgrade for each space data to support planning for the data upgrade process
upgrade the data in each space to utilize document activity
The Activity Upgrade console is available from Comala Document Management 6.17+ release to enable the running of pre-upgrade data checks prior to an install of Comala Document Management 7.0 or later (Data Center only).
The following spaces in your data center instance automatically utilize document activity
new spaces on the application of a workflow in the space
existing spaces without an applied workflow (prior to installation of the data center-only app) on the application of 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.
Activity Upgrade console
In Confluence Admin, choose Comala Document Management > Upgrade Activity.
The Document Activity Upgrade console allows you to identify the current spaces that use Comala Document Management workflows and require upgrading.
The console runs pre-upgrade checks to
select one or more spaces to check and upgrade
validate your existing data in the selected spaces
provide estimates of the time to complete the upgrade for each space
run data upgrades for spaces (only available when the Comala data center app is installed)
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/upgrade status
The report indicates 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.
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. 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.
The pre-upgrade checks and upgrade of a space can be undertaken in a single action in Comala Document Management v7.0+ if no errors are identified.
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.
Successful validation of the pre-upgrade check for each space is displayed in the Status column including the date and time of the check. A duration time for the upgrade of the space is also displayed.
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, you may 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 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 running the data upgrade. If an error occurs, it must be fixed before running the data upgrade. You should:
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.
Pre-upgrade checks Rest API
REST API endpoints are provided for customers and partners to manage and run pre-upgrade checks.
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 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
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 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 the upgrade for each space chosen to be upgraded in the current upgrade action.
On completion of the process, the Status column displays the upgrade status, date and time of upgrade, and duration of the process.
Remember to disable Read-only mode on 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 has Upgrade successful status displayed in the Activity Upgrade console on the application of a workflow to a page or blog post in the space.
existing spaces with no previous workflow activity automatically use document activity on the application of 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.
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.