Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
maxLevel2
minLevel2
absoluteUrltrue
excludeSee Also
typeflat
printablefalse
separatorpipe

...

If a Cloud instance is used for the remote instance then you will need to configure an API token in the user account Atlassian administration. Make sure the API token needed for the user password field is requested by the user who will appear to publish the articles.

Local setup

For remote publishing to work, the server hosting the local Confluence instance must be able to access the remote instance. These steps should be performed on the local instance where the content is initially created.

...

Configuration

Description

Name

The name of this publishing profile

Base URL

The base URL for the remote instance, for example

  • https://www.company.com/confluence/

User

The username of the user you created on remote instance

  • content updates on the remote instance will be carried out by this user account

Password

The password of the user created on the the remote instance - added as User in this configuration

Note

If publishing to a cloud Confluence instance you will need to enter an API token here, not the user's password.  An API token can be generated when logged into an Atlassian account here: https://id.atlassian.com/manage/api-tokens

Space Key

The SPACEKEY of the space to publish in to on the remote Instance

We recommend you set up a user on the remote instance that only has access to the spaces you are publishing to for security purposes. This will also help to prevent any accidental overwrite of other spaces.

Publishing content

Content will now be published to the public instance when the page transitions to the Published state.

Publishing requires connection and transmitting data to the other instance, and this could take some time.

As we want to minimize any chance of error or session expiration we queue the request by adding the queue=true parameter to each publishing trigger.

A pending message is shown when the page is submitted for publishing.

...

If a published page is updated in the source space, the workflow status is changed to draft state. This does not affect the remote instance space page. In order to publish any updates to the remote instance space the page would have to be re-approved.

Comala Remote Publishing does not add a publishing status breadcrumb to either the source instance space page or the remote instance space page. Management of the published page is based on the applied workflow state and the action of the workflow remote publishing trigger.

Publishing all pages in the Space

If you want all the existing pages in the space to be published remotely, then you need to set the state of all pages to the Published state.

You can do this through the Initialize states feature available for each workflow in the space tools Document Management dashboard.

...

Tip

Hierarchy of the source instance space pages is maintained in the published remote instance space but initial publishing action publishes pages to the root of the remote space. Once initial whole space is published, reorder the remote space pages and if necessary edit the home page of the remote space to the published home page from the source space.

Further publishing of source space instance pages retain the page hierarchy if the parent exists in the target remote instance space.

Workflow markup

The publishing is triggered by an action macro remotepublish-page. This action macro is added to a Comala Document Management workflow trigger.

...

The workflow is also configured to hide this Remove state from the workflow popup progress tracker when the page or blog post is in any other state in the workflow.

The overall example workflow looks like

...

Here’s the complete workflow markup for this example. This includes a remote publishing process for blog posts using the newsstatechanged event, a Newsarchived state and publishing archived blog posts to a different remote instance remote2.

...

Workflow Exchange

See also

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
cqllabel = "concept-publishing" and space = currentSpace ( ) and parent = "6428167913"

...