WoodWing Help Center

Adding custom buttons to a Publish Form in Content Station 9

Adding custom buttons to a Publish Form in Content Station 9

Info: This feature requires Content Station 9.8.2 or higher.

You can add extra buttons to the toolbar of a Publish Form and link them to specific functionality.

Examples:

  • A button for opening a Web page in an external browser (especially handy for those pages that contain content that does not show well when viewed in Content Station).
  • Buttons linked to workflow actions such as quickly setting the Publish Form to a particular status.
  • A button to automatically fill the Publish Form with content from the Dossier.
  • A button to view analytics for a published story.

Custom buttons are added to the right of the default buttons in the toolbar.

How actions are provided

The action that is performed when the button is clicked should be provided in the form of a script (this can be any file such as a .php file), an Enterprise Server plug-in, or an external Web site.

Where to get actions from

The actions need to be created or obtained yourself; they are not provided by WoodWing (although sometimes actions are made available on WoodWing Labs.)

Tip: Use the Content Station forum to ask the Community if the scripts that you are after already exist.

Adding custom buttons

Adding custom buttons to a Publish Form is done by defining them between the following tags in the WWSettings.xml file:

<PublishFormToolbarActions>
        <PublishFormToolbarAction your action here />
</PublishFormToolbarActions>

The following syntax is used:

Summarized version:

<PublishFormToolbarAction label="label" tooltip="tooltip" icon="icon" url="url" displayMode="external"/>

Full version:

<PublishFormToolbarAction label="Print" tooltip="Print" icon="http://myserver.com/print.png" url="http://myserver.com/print.php"/>

  • label is the label that appears on the button in the toolbar.

Tip: The button is not very wide so use a short name.

  • tooltip is the text that will appear in the tooltip when the mouse pointer is hovered over the button. Use this to explain the purpose of the button.
  • icon is the path to the icon for the button. This can be a path to the Server or to an icon hosted online. Use a size of 16x16 pixels and make sure it is in JPG or PNG format. It supports the following wildcards:
  • {SERVER_URL} The path to the current instance of Enterprise Server
  • {SESSION_ID} The current ticket
  • url is the path to the location that performs the action. This can be a Web site, a script, a Server plug-in in Enterprise, and so on. It supports the following wildcards:
  • {SERVER_URL} The path to the current instance of Enterprise Server
  • {SESSION_ID} The current ticket
  • {DOSSIER_ID}
  • {ISSUE_ID}
  • {CHANNEL_ID}
  • {PUBLISH_FORM_ID}

Note: The Brand, Issue, Edition, Category and Status values are taken from the selections made in the lists of the Search pane.

Example:

{SERVER_URL}/config/plugins/myplugin.php?sessionid={SESSION_ID}&issue={ISSUE_ID}

Results in:

http://127.0.0.1/Enterprise/config/plugins/myplugin.php?sessionid=1234&issue=5

  • displayMode Defines whether the URL is opened in Content Station or in the default Web browser. Possible values:
  • internal: (Content Station AIR only, default behavior) In a new tab, including a URL address bar and a Refresh button.
  • internalNoNavigation: (Content Station AIR only) In a new tab, without a URL address bar or a Refresh button.
  • external: For Content Station AIR: in the system browser; for Content Station Web: in the same browser.
  • silent: The URL is not opened in a browser. If the page returns text this is shown in an alert message.
  • popup: The URL is shown in a HTML component within a pop-up window.
  • Important: Make sure to validate the WWSettings.xml file for correct content. See Validating the WWSettings.xml file.

Was this article helpful?
0 out of 0 found this helpful / Created: / Updated:
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.