Watermark Settings

Watermarks are text that appears grayed out in the background of a previewed file in FileCloud. Administrators can add single line or multiline watermarks to document previews generated in FileCloud.

Note: In addition to appearing on document previews, watermarks appear on documents when edited in Collabora.

Preview with a single line watermark:

Preview with a multiline watermark:

On the Watermarks page in the admin portal, you can configure rules that determine which previewed files have watermarks applied to them. For example, you could apply a watermark to:

• all files previewed by users in a certain group

• all files containing ITAR metadata.

Once you have specified the watermark filter conditions, you can add the watermark text, choose the single-line or multiline watermark template, and select the watermark font size.

Adding a watermark rule

To add a watermark rule:

1. In the admin portal navigation pane, click Watermark.
   The Watermark page opens.

2. In the upper-right corner, click Add rule.

   

   
   The Add Watermark Rule dialog box opens to the Filters window.

3. In Rule Name, enter a name for the watermark rule.

4. Click Add Filter Condition.

   

   
   A drop-down list of predefined filter conditions opens. See Filter conditions, below, for information about the predefined conditions.

5. In the example below, we first choose User’s effective policy name is equal to [SalesAssoc] users with the specified policy name are selected by the filter and their files display the watermark when previewed.

   

   
   Note: Instead of choosing a predefined condition, you may click Switch to Code Editor and write your condition in Expression Language if you are familiar with it. For help with expression language, see https://symfony.com/doc/current/reference/formats/expression_language.html.

6. Once you have selected a condition, enter any values it requires.

7. Enter any number of filters.
   In the example, the filter condition User type is [Full Access] is also chosen.
   By default, multiple filters are given an OR relationship, but you may change it to AND.

   

8. To go to the Watermark window, click Next.

9. In Watermark Text, enter the text of the watermark. Parameters are available for you to use.
   To select from a list of available parameters, enter / in the Watermark Text box, then click on a parameter:

   

10. In Template, leave Default selected for a single line watermark, or choose Multiline for a multiline watermark.

11. In Font Size, choose the font size of the watermark.
    The window shows a preview of the watermark.

    

    
    

12. Click Create.
    The watermark rule is listed on the Watermark page. If it is the first watermark you are creating, its Priority is listed as 1; otherwise it is listed as the lowest rule in priority, and will be checked if none of the other rules are true.

    

13. To change a rule’s priority, drag and drop it to a new position from the drag bars:

    

14. Under Actions, click the toggle button to activate the watermark rule.

    

Once you enable a watermark rule, it is listed on the Watermark tab in of the Policy settings for all policies that it applies to.
For example, in the following image, the Watermark tab shows that the watermark rules rule1 and SalesAssoc policy apply to users and groups in the SalesAssoc policy.

Filter conditions

In the Filter Condition drop-down list, choices are provided for you and required formats are shown in the value fields where applicable. For a guide to all of the expressions you can use for specifying conditions in the code editor, See Watermark Parameters for Code Editor.

Utils
The only option under utils is Anything. Select Anything to apply the watermark to all files.

File
File conditions apply to the file extension, path, name, size, and word count.

User
User conditions apply to the user’s username, email, type, group, and email domain.

Request
Request conditions apply to the IP address or country code of the user making the request, or the agent (client application) making the request.

Policy
Policy conditions look at the policy name.

Share
Share conditions look at the share path, the type of share (public or private), or the emails or domains of the users shared with.

Metadata
Metadata conditions look at metadata values. These conditions check if a a certain metadata attribute on the file has a specified value (or any value).

Displaying an encrypted User ID in a watermark

To display an encrypted User ID instead of the actual User ID in a watermark:

1. In the Watermark Text, use the parameter ^PREVIEW_ID^ instead of ^USERNAME^

   

   
   

   This produces a preview with a watermark like the following one:

   

   Note that if the user previews the file additional times, it will have different preview IDs each time.

   
   

2. To identify the user who previewed the file, go to the Audit Logs, and locate the log with the encrypted ID in the message. The message will identify the actual user who previewed the file, and, as with any audit log record, the IP address of the device where the action was performed.

   

Customizing preview IDs

Use the following two parameters to customize the preview ID size and length:

To customize ^PREVIEW_ID^ size and length:

1. Open cloudconfig.php:
   Windows Location: XAMPP DIRECTORY/htdocs/config/cloudconfig.php
   Linux Location: /var/www/config/cloudconfig.php

2. Add the above parameters with custom values:

   
   define("TONIDOCLOUD_PREVIEW_ID_SIZE", "medium");
   define("TONIDOCLOUD_PREVIEW_ID_CUSTOM_DICTIONARY", "0123456789ABCDEF");