Tokens supported by dm api methods and properties – Kofax DM API User Manual
Page 61
A
N
O
VERVIEW
OF
THE
DM API 41
Tokens Supported by DM API Methods and Properties
Tokens Supported by DM API Methods and Properties
Tokens are special identifiers that instruct the DM Server to perform
specific actions. They are often used as a short-hand reference to an
object that otherwise could only be described by a longer text string,
such as a reference to a SQL table and column. For example, the
%LOGIN_DATE token can substitute for as a reference for the
PEOPLE.LAST_LOGIN_DATE column of the SQL database.
Token identifiers are easily recognized. When used in application code,
each token must be enclosed within double quote marks and must
always be written in UPPERCASE. Each token begins with a percent
sign (%), a syntax requirement that identifies them as DM system
variables rather than local variables defined by the API program.
When used in application code, DM tokens perform one of three
functions:
•
Tokens set values either in the SQL database or in other variables.
For example, the %CHECKOUT_COMMENTS token can be used
to identify a string that the program stores in the COMMENTS
column of the CHECKOUT table.
•
Tokens identify data items that API applications are to return
when the application executes. For example, the %DATA token
returns the data and metadata associated when an application
program executes the PDCSQL operation.
•
Tokens manipulate column values in SQL database tables. For
example, the %CONTENTS_MOVE_TO_TOP adjusts the items
in a DM Folder so that the specified object is shown at the top of
the presentation list and the other items in the folder are adjusted
to lower positions in the list if necessary.
, lists the most commonly
used DM tokens.