Watermark Advanced - User Documentation



Name Description
Name Watermark Advanced
Version 1.8
ID wex-watermark-adv


This extension allows a watermark to be superimposed on any PDF in the system. The extension provides the ability to add, update and remove a watermark through a user interface or to be automatically applied to collections of objects in Promotions or Changes. This advanced version will allow to apply a permanent watermark (non-removable by the user) and watermark multiple parts in one action.

The watermark will contain text and images. It uses a vector format meaning that watermarks are designed for a paper ratio, ensuring that the watermark will scale to match the source page size. The document is sent to an external server to be watermarked; this server may be in the cloud or on-premise.

This Advanced version of the Watermark Extension offers a set of flexible preset templates. The size of the PDF is unlimited.

This is the latest version of this document


  • Adds a watermark to a single PDF.
  • Watermark can be updated and removed.
  • Permanent Watermark option
  • Possibility to watermark multiple parts
  • Can be in a document, drawing or associated part
  • Supports all paper sizes
  • Watermark applied by an external server
  • Flexible preset templates
  • Supports cloud servers and on-premise



An introduction to Watermark Advanced

Configure a new template

A video to show how the administator can configure a new template

User Guide

User Interface

The following objects are supported

  • CAD
  • Parts (through association)
  • Documents (Primary and representations)
  • Baseline
  • Collection
  • Promotion Request
  • Change Notice

Each of the above objects may reference a PDF either directly or via links to associated objects e.g. Part - CAD - Drawing Or consist consist of these objects (baseline, collection, promotion request, change notice)

If a PDF is available a new menu will appear (This menu may be restricted to only appear for admin users) file

Note the object must have a PDF associated or the menu will not appear.

This menu will show the following screen


This screen allows the to either

  • Download - Download directly a watermarked version of the document
  • Overwrite Content - Update the PDF within the system with a watermarked version
  • Remove - Remove the watermark from the PDF

Automatic Watermarking

You administrator can setup watermarking to happen based on object or management objects e.g. promotions, changing state.

Administrator Guide



The listeners use a queue which will be created


If it is not started automatically, it has to be started manually.

The listeners have to be mapped as shown above.

The Template Map section declares states and actions that can be taken when object/collections transitions to the state (no action, remove watermark, watermark with selected template).

The Trigger objects-states map specifies which states will trigger the event (watermark) for the designated objects. In the example above:

  • Documents will trigger the watermarking when sat as either Released or Canceled
  • Baselines will trigger when set as Released

Note for change object only objects in the affected table are watermarked

The watermark can also be triggered on the publish successful event


The workflow is available via a wex invoke call in the server. It is an asynchronous call that will pass the job to the watermark queue. The argument is the self e.g. the workflow process.

com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-watermark-adv", "workflowmethods.watermark", self);


There are special keys to send to the engine.


See server manager guide for more information on the standard set of keys.

For how to configure the templates now, please read the Watermark Templates Configuration

Pseudo States

This allows a new key ${pseudostate} to be defined and used in a template.


User Interface

This controls if the watermark UI will be made available to non-admin users.


The retries and time between retries if a failure occurs



As this extension uses a queue to watermark, any failures will be communicated via email. This feature is limited to 1 email per 30 minutes per user.



All watermarking actions are logged. Logs will be archived after 20,000 entries



Ensure the queue is started


Release Notes


  • Added logging


  • Minor corrections


  • Minor corrections


  • Added user and userid


  • Minor fixes


  • Sorted template list in UI
  • Added A-E page sizes to templates (cloud not version related)


  • Added publish event
  • Added additional business data such as numbers, names of promotions


  • Fixed watermark keys being saved
  • Documentation improvements
  • Added pseudo states
  • Workflow robots
  • Flexible templates
Was this article helpful? Votes: 0
Article details:
Published date: 23/10/2019 8:53AM
Last updated: 26/11/2020 5:30PM (author@wincom-plm.com - author@wincom-plm.com)
Share article: 
Author: Simon Heath (simonh@wincom-consulting.com)
Permalink: https://wex.wincom-plm.com/kb/articles/watermark-advanced-user-doc