Creating Watermarks

Watermarks help ensure the security of a document by uniquely identifying the document and controlling copyright infringement. For example, you can create and place a watermark that states Confidential on all pages of a document. After a watermark is created, you can include it as part of a policy. That is, you can set the policy’s watermark attribute with the newly created watermark. After a policy that contains a watermark is applied to a document, the watermark appears in the policy-protected document.

Note: Only users with Rights Management administrative privileges can create watermarks. That is, you must specify such a user when defining connection settings required to create a Rights Management service client object.

Note: For more information about the Rights Management service, see LiveCycle ES Services.

Summary of steps

To create a watermark, perform the following steps:

1.	Include project files.

2.	Create a Rights Management Client API object.

3.	Set the watermarks attributes.

4.	Register the watermark with the Rights Management service.

Include project files

Include necessary files into your development project. If you are creating a client application using Java, then include the necessary JAR files. If you are using web services, then make sure that you include the proxy files.

Create a Rights Management Client API object

Before you can programmatically perform a Rights Management service operation, you must create a Rights Management service client object. If you are using the Java API, create a RightsManagementClient object. If you are using the Rights Management web service API, create a RightsManagementServiceService object.

Set the watermarks attributes

To create a new watermark, you must set watermark attributes. The name attribute must always be defined. In addition to the name attribute, you must set at least one of the following attributes:

•	Custom Text

•	DateIncluded

•	UserIdIncluded

•	UserNameIncluded

The following table lists key and value pairs that are required when creating a watermark using web services.

 

Key Name	Description	Value
WaterBackCmd:IS_USERNAME_ ENABLED	Specifies if the user name of the user opening the document is part of the watermark.	True or False
WaterBackCmd:IS_USERID_ ENABLED	Specifies if the identification of the user opening the document is part of the watermark.	True or False
WaterBackCmd:IS_CURRENTDATE_ ENABLED	Specifies if the current date is part of the watermark.	True or False
WaterBackCmd:IS_CUSTOMTEXT_ ENABLED	If this value is true, then the value of the custom text must be specified using WaterBackCmd:SRCTEXT.	True or False
WaterBackCmd:OPACITY	Specifies the opacity of the watermark. The default value is 0.5 if it is not specified.	A value between 0.0 and 1.0.
WaterBackCmd:ROTATION	Specifies the rotation of the watermark. The default value is 0 degrees.	A value between 0 and 359.
WaterBackCmd:SCALE	If this value is specified, then WaterBackCmd:IS_SIZE_ENABLED must be present and the value must be true. If this attribute is not specified, the default behavior is fit to page.	A value greater than 0.0 and less than or equal to 1.0.
WaterBackCmd:HORIZ_ALIGN	Specifies the watermark’s horizontal alignment. The default value is center.	left, center, or right
WaterBackCmd:VERT_ALIGN	Specifies the watermark’s vertical alignment. The default value is center.	top, center, or bottom
WaterBackCmd:IS_USE_ BACKGROUND	Specifies if the watermark is a background. The default value is false.	True or False
WaterBackCmd:IS_SIZE_ENABLED	True if a custom scale is specified. If this value is true, SCALE must also be specified. If this value is false, then the default is fit to page.	True or False
WaterBackCmd:SRCTEXT	Specifies the custom text for a watermark. If this value is present, then WaterBackCmd:IS_CUSTOMTEXT_ENABLED must also be present and set to true.	True or False

All watermarks must have one of the following attributes defined:

•	WaterBackCmd:IS_USERNAME_ENABLED

•	WaterBackCmd:IS_USERID_ENABLED

•	WaterBackCmd:IS_CURRENTDATE_ENABLED

•	WaterBackCmd:IS_CUSTOMTEXT_ENABLED

All other attributes are optional.

Register the watermark

A new watermark must be registered with the Rights Management service before it can be used. After you register a watermark, you can use it within policies.

 

View Java walkthrough

View web service walkthrough

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/help/000556.html

Add Comment