Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt
hiddentrue

Unpublish (remove) a page from a remote Confluence instance

The {remoteremove-page} macro is used as an Actionaction to remove previously published content from a space on a different Confluence Server, Data Center or Cloud instance.

  • Content

    content is developed in a space on the source server

  • Published

    published content is pushed to a space on a remote server

  • The {

    the remoteremove-page

    }

     macro can remove the published content from the remote server

This is generally only required when content becomes obsolete and should be removed from the remote published content.

For more information, see: Remote-space publishing

Requirements

This macro requires the installation of the Comala Remote Publishing app for Comala Document Management.

Before using this macro, you must ensure both the source and target Confluence instances are properly configured.

For more information, see Remote-space publishing.

Where to use it?

Optional.

One or more {remoteremove-page} macros can be put in a {trigger} macrotrigger macro.

Parameters

Parameter

Required

Default

Notes

config_name

(tick)

(tick)


The name of the remote publishing configuration to use.

  • remoteremove=<config_name>

where config_name is the name of the remote publishing profile added to the Document Management dashboard remote publishing configuration.

(info) The configuration defines the remote server URL and destination space, as well as the username and password for an account on that server which has Edit Content permissions in the target space.

Basic example

This example will remote - publish to a remote Confluence instance defined by the "MyDestination" publishing configuration.

Code Block
{trigger:statechanged|state=Published}
      {remotepublish-page:MyDestination}
{trigger}

Once published, the user will have an option to unpublish the page. This can be done using the workflow popup on the page (submit=Unpublish) at which point the published page will be source space page to transition the content to the Unpublish state submit=Unpublish.

The trigger added to listen for this state transition and action the removal uses the remoteremove-page macro.

Code Block
languagetext
{trigger:statechanged|state=Obsolete}
      {remoteremove-page:MyDestination}
{trigger}

The published page is removed from the remote Confluence instance. From the Unpublished state, they can either republish it, or make it obsolete.

Here's the full markup for the example workflow:

Code Block
languagetext
themeRDark
{workflow:Remote-space publishing}
   {state:Editing|submit=Review}
   {state}
   {state:Review|approved=Published|rejected=Editing}
      {approval:Review}
   {state}
   {state:Published|updated=Editing|final=true|submit=Unpublish}
   {state}
   {state:Unpublish|approved=Published|rejected=Obsolete|hidefrompath=true|updated=Editing}
      {approval:Page Unpublished|approvelabel=Republish|rejectlabel=Make Obsolete}
   {state}
   {state:Obsolete|submit=Editing|updated=Editing}
   {state}
   {trigger:statechanged|state=Published}
      {remotepublish-page:MyDestination}
   {trigger}
   {trigger:statechanged|state=Obsolete}
      {remoteremove-page:MyDestination}
   {trigger}
{workflow}

...

The final=true parameter on the Published state is not required for remote-space publishing, however it helps to clarify which versions of content are published in the source space.

All examples

Filter by label (Content by label)
showLabelsfalse
max100
showSpacefalse
sorttitle
excerptTypesimple
cqllabel = "macro-remotepublish-page" and label = "example" and space = currentSpace ( )

See also

External links:

Workflow Authoring Guide: