Overview
Remote-space publishing allows you to edit content on a local Confluence Server or Data Center, and then publish it to a remote Confluence Cloud, Server or Data Center instance.
| The Comala Remote Publishing app must be installed on the source instance to enable remote-space publishing. |
Activating remote-space publishing
Once the Comala Remote Publishing app is installed there are three steps to setting up different-space publishing:
- set-up the remote Confluence instance
- set-up the local Confluence instance
- update your workflow to trigger the publishing process
Remote instance setup
These steps should be performed on the remote Confluence instance which you plan to publish content to
- create the space where content will be published to
- set up a user account with user permissions to view, add, and delete content in the space for the published content
When content is published into this remote space it will appear to be authored and edited by the user you have set up.
The remote instance can be a Server, Data Center or Cloud instance.
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
These steps should be performed on the local instance where the content is initially created. For remote publishing to work, the server hosting the local Confluence instance must be able to access the remote instance.
In the space that holds the source content, navigate to Space Tools → Workflows → Remote Publishing tab.
You will see a form to add a configuration:
| Field | Notes |
|---|---|
| Name | The name of this publishing profile |
| Base URL | The base URL for the remote instance, for example
|
| 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 that user 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 |
Workflow markup
The publishing is triggered by an action macro, {remotepublish-page}, which must be used in a {trigger}.
For this example, we'll assume you created a remote publishing profile with the name "remote".
{workflow:name=Remote Publishing Workflow|key=dm.remotepublishing}
{description}
This workflow allows one-way synchronization of a remote confluence instance. Please visit the [workflow's page|https://wiki.comalatech.com/display/CDML/Remote-space+publishing] for instructions on how to set up the _private_ and _remote_ instances.
{description}
{state:Draft|submit=For Review}
{state}
{state:For Review|approved=Published|rejected=Draft}
{approval:Publish}
{state}
{state:Published|updated=For Review}
{state}
{state:Remove|hidefrompath=true}
{state}
{trigger:statechanged|state=Published}
{set-message:type=note}Page publishing pending...{set-message}
{trigger}
{trigger:statechanged|state=For Review}
{set-message}{set-message}
{trigger}
{trigger:statechanged|state=Published|queue=true|newevent=pagepublished}
{remotepublish-page:remote}
{trigger}
{trigger:newsstatechanged|state=Published}
{set-message:type=note}Page publishing pending...{set-message}
{trigger}
{trigger:newsstatechanged|state=For Review}
{set-message}{set-message}
{trigger}
{trigger:newsstatechanged|state=Published|queue=true|newevent=pagepublished}
{remotepublish-page:remote}
{trigger}
{trigger:newsstatechanged|state=Archived|queue=true|newevent=pagepublished}
{remotepublish-page:remote2}
{trigger}
{trigger:pagepublished|success=true}
{set-message:style=info}Page Published!{set-message}
{trigger}
{trigger:pagepublished|success=false}
{set-state:For Review}
{set-message:user=@user@|style=warning}publishing failed: @errormessage@{set-message}
{trigger}
{trigger:statechanged|state=Remove}
{remoteremove-page:remote}
{trigger}
{workflow}
The example markup above is based on the example from same-space publishing, but we've added the {trigger} at the bottom.
When the state changes to Published, the trigger is activated and the {remotepublish-page} macro instructs the Remote Publishing for Comala Document Management app to send the published content to the remote space.
Note: The final=true parameter for a state is not necessary for remote space publishing, all the work is done by the {remotepublish-page} macro added as a workflow trigger action macro
Macros
-
remotepublish-page macro — Publish a page to a remote Confluence instance
-
remoteremove-page macro — Unpublish (remove) a page from a remote Confluence instance
-
workflowproperties macro — DEPRECATED
Examples
