Publish_version – Kofax DM API User Manual

Page 464

Advertising
background image

444 C

HAPTER

5

%PUBLISH_VERSION

%PUBLISH_VERSION

Use this token to publish a document version.

Returns

The

%PUBLISH_VERSION

token returns

SUCCESS

if the document

version was published without error. If the user does not have sufficient
security rights to make the document version read only, then a

PCD_ERR_INSUFFICIENT_RIGHTS

error will be returned.

Usage

To publish a version, follow the following steps:

1 Create a

PCDClient.PCDDocObject

.

2 Set the object type to whatever value is appropriate.

3 Set the DM security token (DST).

4 Set the

%TARGET_LIBRARY

token equal to the library name.

5 Set the

%OBJECT_IDENTIFIER

token equal to the document

number of the document version that is to be published.

6 Set the

%VERSION_ID

token equal to the version number to which

this publish action applies.

7 Set the

%VERSION_DIRECTIVE

token equal to

%PUBLISH_VERSION

, indicating that you want to make this

document version read only.

8 Execute the

Update

method.

Related Items

See the

PCDDocObject

object.

See the

%UNPUBLISH_VERSION

method.

See the following tokens:

%ADD_ATTACHMENT

%MAKE_READ_ONLY

Advertising