Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3
outlinefalse
typeflat
separatorpipe
printablefalse

Status
colourGreen
titleDATA 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 will need to have the workflow data updated to use document activity capabilities.

The Document Activity Upgrade console is available from Comala Document Management 6.17+ release to allow allows Confluence Administrators to

  • complete pre-upgrade data checks to validate the existing page activity in their instance, and

  • start planning the upgrades prior to the release 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 Document Activity Upgrade console is available from Comala Document Management 6.17+ release to enable the running of pre-upgrade checks prior to an install of Comala Document Management 7.0 (Data Center only)

...

The following spaces in your data center instance will 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 in the space

Document Activity Upgrade console

...

The Document Activity Upgrade console allows you to identify the current spaces that use Comala Document Management workflows and to prepare for the upgrade by

...

validating your existing data

...

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

...

Below the The Run Checks button the console table displays the pages with activity includingspaces

  • a list of the spaces that will 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

...

A summary of thecheck can be copied using the option in the Pre-upgrade checks statistics dialog box

Once the check has been completed and no errors are identified the selected space(s) can be upgraded to use document activity data.

Info

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 will display displays the upgrade check progress for each selected space.

...

...

Tip

...

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 upgrade check progress bar for each individual space.

...

This can be done, for example, to mitigate any performance impact.

Tip

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 will display displays the following warning message if an a pre-upgrade error has been found in one or more spaces.

...

Upgrade validation pre-upgrade check errors for a space will be are displayed in the Status column. This includes

...

A link to download a Support Package is also added to each space listing where an error has been found.

If a validation pre-upgrade check error occurs

  • download the Support Package for each space with a validation error

  • contact Comala 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 Comala Document Management v7, 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

Info

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

Info

Site banner message is enabled by default when enabling Read-only mode

Navigate to the Comala app global Upgrade Activity screen

  • check the space(s) to be upgraded

...

  • choose Upgrade

Info

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 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)

...

Info

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.

...

Insert excerpt
Why can't I see the page activity report when I access a page?
Why can't I see the page activity report when I access a page?
namedocactivitystatus_pagetools
nopaneltrue

Accessing workflow events in spaces

Table of Contents
minLevel4
maxLevel4
outlinefalse
typelist
printablefalse

Space with no previous workflow events

Insert excerpt
Why can't I see the page activity report when I access a page?
Why can't I see the page activity report when I access a page?
nameupgradestatus_nopreviouswf
nopaneltrue

Non-upgraded space with previous workflow events

Insert excerpt
Why can't I see the page activity report when I access a page?
Why can't I see the page activity report when I access a page?
nameupgradestatus_wfactivitynotupgraded
nopaneltrue

Upgrade successful status space with workflow events

Insert excerpt
Why can't I see the page activity report when I access a page?
Why can't I see the page activity report when I access a page?
nameupgradestatus_successful
nopaneltrue

Moving upgraded pages and non-upgraded pages to other spaces

Child pages (Children Display)
pageTroubleshooting - Comala Document Management 7
first2