WoodWing Help Center

Adding custom buttons to the Publication Overview Application of Content Station 9

Adding custom buttons to the Publication Overview Application of Content Station 9

Info: This feature requires Content Station version 9.2 or higher.

Additional buttons can be added to the toolbar of the Publication Overview Application of Content Station and linked to specific functionality.

Example: You can add a button to export the overview of the displayed pages as a PDF file so that it can be printed.

Tip: Use the Print Publication Overview sample from WoodWing Labs to add buttons for performing the following actions:

  • Printing the full Publication Overview to PDF
  • Printing selected layouts to PDF only
  • Download all layouts as a PDF

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

Figure: A custom button added to the toolbar of the Publication Overview Application.

See this feature demonstrated in this short video:

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.

Configuration

Custom buttons for the Publication Overview Application are added by defining them between the <PublicationOverviewActions> </PublicationOverviewActions> tags of the WWSettings.xml file.

The following syntax is used:

Summarized version:

<PublicationOverviewAction tooltip="tooltip" icon="icon" url="url" displayMode="external"/>

Full version:

<PublicationOverviewAction tooltip="My action" icon="{SERVER_URL}/config/images/icon.gif" url="{SERVER_URL}/config/plugins/myplugin.php?sessionid={SESSION_ID}&issue={ISSUE_ID}" external="false" />

  • 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
  • {BRAND_ID}
  • {ISSUE_ID}
  • {EDITION_ID} (-1 is used when no Editions are available)
  • {CATEGORY_ID} (-1 is used for All Categories)
  • {STATUS_ID} (-1 is used for All Statuses)

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.
  • 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.