Home → Using LincDoc 3.1+ → eForm Administration → Using Document Refinement Annotation Transformer (DRAT)

7.19. Using Document Refinement Annotation Transformer (DRAT)

Document Refinement Annotation Transformer (commonly referred to within the scope of LincDoc as DRAT) can replace LincDoc tags in strings.

Proceed to one of the following sections for more information:

About Tags, Content, and Syntax

DRAT tags use the following format:

<<:type:parameter1:parameter2:...>>

The content is rendered according to the type of tag used, each of which accepts different parameters. Many parameters are optional and trailing parameter separators ( : ) may be omitted.

For example:

<<:doc-link:edit:Click Me::>>

Which is the same as the following:

<<:doc-link:edit:Click Me>>

Note: In this example, there is no :: at the end of the second entry.

For example:

<<fieldName>>

is considered the same as

<<:field:fieldName>>

Note: In this example, there is no : after << in the first entry.

Within DRAT tags, the \ (backslash) character is an escape character; meaning that the following character is taken literally. To use <, >, or : in a parameter, escape it with \.

For example:

<<:escape:\<\<\:\>\>>>

produces

<<:>>

About Usage

DRAT expressions can be used in the following places:

Word source documents
Advanced JDBC lookups
JDBC Advanced codelists
Inside any of the parameters of an email action
In the show a message action
In user registration email
In a token filename
In messages for form validation conditions
In the "path" setting for export to Windows share action
In the show html action
In the JdbcSelect DANG function
In the Drat DANG function
In dynamic section headers

About Types

The following types are using with DRAT:

About the doc-link Type

This type creates links to LincDoc documents.

Parameters

method
link text
scheme
event ID
type
fieldname containing document ID
providerID to use if login is required (only available with LincDoc 3.3.0 and above)
authentication token types, comma separated (only available with LincDoc 3.3.0 and above)

Method

view. Opens the document in the Document Viewer.
edit. Edits the document.
edit-copy. Edits a copy of the document.
sign. Opens the document in the Document Viewer with the sign prompt displayed.

Scheme

Used to set the scheme for the URL to something other than the default (which is "https"). Currently the only other available scheme is "lincdoc". When the "lincdoc" scheme is used, iPads are forced to open the LincDoc Mobile app instead of the Safari web browser. Note the "lincdoc" scheme is ONLY valid on an iPad with the LincDoc Mobile app installed. It is meaningless when running LincDoc on a PC.

Event ID

If the event ID is not empty, the event will be fired after the form is loaded.

Note: This parameter only works with the edit and edit-copy methods (listed above).

Type

html. Renders an HTML link. This type is the default.
plain. Renders the URL with no HTML tags (link text is ignored).
pre. Renders the URL inside HTML <pre> tags (link text is ignored).

Document ID Field

Used to define the field value that should be used as the document ID instead of the current document ID.

Example 1: doc-link

<<:doc-link:edit:link text:lincdoc::plain>>

produces

lincdoc://server.lincware.com/lincdoc/doc/edit/a6a0e89c-7bcd-4e82-87f1-7628e3e179ad

where a6a0e89c-7bcd-4e82-87f1-7628e3e179ad is an example UUID generated from a submitted form.

Example 2: doc-link

<<:doc-link:edit::::pre>>

produces something similar to this (note again the sample UUID, which will be unique for each newly submitted form)

<pre>https://server.lincware.com/lincdoc/doc/edit/a6a0e89c-7bcd-4e82-87f1-7628e3e179ad</pre>

Example 3: doc-link

<<:doc-link:edit:link text:::html>>

produces

Example 4: doc-link

<<:doc-link:edit:link text:::html:i9DocId>>

produces

where a6a0e89c-7bcd-4e82-87f1-7628e3e179ad is pulled from the "i9DocId" field (i9DocId being a field name from the currently running form).

About the escape Type

This type denotes escape content.

For example:

`<<:escape:<<>>`

produces

About the field Type

This type prints field values.

Parameters

field name
multi-value index

About the user Type

This type prints user information for the currently logged in user.

Parameters

attribute

Attributes

name. full name
username. username
provider. authentication provider ID (only available with LincDoc 3.1 and above)
uid. user ID (only available with LincDoc 3.1 and above)
mail. email address

Example 1: user's name

<<:user:name>>

produces the user's full name.

This page was: Helpful | Not Helpful

← 27.3. Creating an Email Template