Getting Started with Comala Publishing for Confluence Cloud

Overview

Comala Publishing for Confluence Cloud is a separate app that enables the publishing of pages between spaces in the same Confluence site - pages are published from a source (draft) space to a target (published) space.

Comala Publishing is used to publish your draft pages from one space to another space in the same Confluence site

as a standalone app
together with an added Appfire Comala workflow

The publishing action copies each page’s content from the source (draft) space to the target (public) space maintaining the page hierarchy where possible.

To publish pages a user requires view and edit permissions on both the draft space and the public space content.

Enable Comala Publishing for a space

Publishing must be enabled and configured for a space via the space tools App links Comala Publishing dashboard in the source (draft) space.

cpc_spacesettings_publishing_dashboard_not_configured.png

Publishing setup wizard

In the Comala Publishing dashboard

choose Configure Publishing to open the space publishing set-up configuration wizard to enable Comala Publishing in the space

The publishing set-up tool is only available if the space is being setup for the first time or any publishsing configuration has been cleared using the Clear Publishing Configuration option.

Error rendering macro 'excerpt-include' : No link could be created for 'CPCL:Space publishing configuration set-up tool'.

Publishing dashboard

When a target space is selected and saved in the publishing dashboard and publishing is enabled the app can publish a page from the current space to a target (public) space.

By default, on adding the target space the following options are displayed.

Publishing Setting	Default - on adding the target space	Notes
Enable publishing	(Enabled)	the app can publish content from your source space to your target space must be enabled to allow both single-page publishing and space publishing of pages must be enabled to allow publishing with a Comala Document Management family of apps workflow
Copy content Properties	Displayed as (enabled by default)	page content properties are copied when publishing a page in the space using single-page publishing and space publishing can be disabled by the space administrator may want to disable this option if there is a 3rd party app in the target space and do not want to override the page properties when publishing a page, for example, if you have applied a Comala workflow on pages in both the source space and the target space
Enable single page publishing	Displayed as (enabled by default)	adds a Publish button to each page in the source space to allow a user to publish each individual page to the target space can be disabled by the space administrator so only whole space publishing can be undertaken
Space publishing	Displayed with Publish space button	a space administrator can publish all the source space content at one time

Publishing Pages

Once a space is configured for publishing you can publish pages using standalone publishing or with an applied workflow from one of the Comala Document Management family of apps.

These publishing actions are

Single-page publishing

A user can publish each page manually using the publishing byline added to the page.

Single-page publishing can be disabled for a space by the space administrator. This can be useful if you want to limit publishing to whole space publishing by the space administrator or publishing on an applied Comala workflow event.

Space publishing

A space administrator can publish all the content from a source space to a target space in a single publishing action using the Publish space option in the space settings publishing dashboard.

A progress bar displays the space publishing action progress.

Successful publishing is confirmed in the dashboard. The confirmation includes the date, time and the user who actioned space publishing.

If the space publish action was unable to publish all the source pages, the space publishing dashboard will display a listing of the unsuccessful pages.

If the space has no pages (except the home page), space publishing will not occur. This will be confirmed in an on-screen notification.

Publish content on an applied Comala workflow event

You can also choose to publish pages together with an applied Comala Document Management workflow.

Publishing on the added workflow transition to a final state

A Comala workflow can invoke the publishing action to a specified target (public) space when the workflow reaches the workflow final state on the page in the source (draft) space.

Publish pages using a workflow JSON trigger

Comala Document Management workflow can be edited to add an event trigger to publish a page, for example, on a change of state event.

[{"event":"_transition/change-state","conditions":[{"state":"In Approval"}],"actions":[{"action":"publishing/sync-page"}]}]

Publishing confirmation

Successful publishing of a page to the target space is confirmed in an on-screen message.

A message is displayed on a page for a single-page publish action and a successful publish action using a Comala workflow.

You will need to refresh the source space page to display the publishing confirmation message.

When using the Publish space option in the space settings publishing dashboard, a publishing progress bar is displayed for the space.

On each published page in the source space, a Page published confirmation message is displayed on viewing the page.

What is copied from the draft pages to the target space?

Each published page will include

the content title
the content body
attachments
content properties*
content labels

When publishing the page

links to local pages in the source space are replaced with the links for the content in the target space

When publishing a previously published updated page

Comala Publishing deletes the previously published page and copies the updated page as a new page in the target space

* Copying content properties when publishing a page can be disabled in the source space settings publishing dashboard.

What is not copied?

Comala Publishing Cloud does not support publishing

the home page of a space
blog posts.
custom content properties for Comala Read Confirmations app and Comala Document Management Family of apps
the source space Confluence version

The following is also not published from the source space

inline comments
page-level permissions
comments
archived pages

Publishing status is copied but is not visible on the content for users with view-only permission.

Content properties are copied by default when publishing a page. This can be disabled for a space in the space settings publishing dashboard.

Page hierarchy

The publish action maintains the page hierarchy where possible although in some circumstances, the order of the content is not necessarily maintained.

When the hierarchy is not maintained in a publish action, the page is published to the root of the destination space.

the hierarchy is maintained as long as the parent page exists in the destination space
if the hierarchy cannot be maintained the page is copied into the root of the destination space and a warning message is shown to the user

If a previous publish action resulted in the page being published to the root of the destination space, any subsequent publishing of the source space page copies the page but not changes in the page tree parent.

Publishing user permissions

To configure publishing a user needs to have space administrator permission in the source space and target space.

When publishing space pages

a space administrator requires view and edit permission for all the pages in the source space and target space
a user publishing an individual page needs view and edit permission for the page in the source space and target space

A user also needs to have the following permissions in the target space to publish a draft page:

View All
Add and Delete Pages
Add and Delete Attachments

For successful publishing, the published page has no page-level restrictions limiting access in the target space.

Comala Publishing does not publish a page If the space administrator does not have view/edit permission for a page AND the page is not included in the list of 'Pages not published' in the source space Publishing dashboard report when the space publishing action is complete.