DocMgt

Variable

Action or Value

Example

[DEL]

Deletes variable from the Record

Not valid on Filters

[SERVERURL]

Full URL of the server

https://yoursite.docmgt.com

[SERVERVER]

Returns the version of DocMgt that is running on the server

3.35.0000.00000

[GUID]

Unique GUID number

ABCDEF-87HJ-ABFECD-43343

Branding Colors:

[Color_Toolbar_Text]

[Color_Panel_Header_BG]

[Color_Panel_Header_Text]

[Color_Panel_Body_BG]

[Color_Panel_Body_Text]

[Color_Panel_Heading_Header_BG]

[Color_Panel_Heading_Header_Text

[Color_Button_BG]

[Color_Button_Text]

[Color_Modal_Header_BG]

[Color_Modal_Header_Text]

[Color_Modal_Footer_BG]

[Color_Modal_Footer_Text]

You can use the color options from the Branding system for variables. This is most useful in E-Forms where you can set a table header color equal to the [Color_Panel_Header_BG] color code to keep form colors in sync with the branding colors.

The return value is a HEX color code

[Color_Toolbar_Text] = #ff0000

Branding URLs:

[Brand_BannerURL]

[Brand_ToolbarIconURL]

[Brand_ToolbarBGImageURL]

Images in the Branding section are also available for use as variables:

[Brand_BannerURL] = the URL to the image on the login page above the login panel

[Brand_ToolbarIconURL] = The ICON in the upper left of the tool bar

[Brand_ToolbarBGImageURL] = The image used as a background image for the tool bar (not commonly used)

[PG]

Page Number

Bates Stamping Only

[PGS]

Page Count

Bates Stamping Only

[REQUESTOR]

ID of user requesting Asset

[REQUESTOR] = 123

[REQUESTORNAME]

User name of user requesting Asset

[REQUESTORNAME] = admin

[REQUESTOREMAIL]

Email address of user requesting Asset

[REQUESTOREMAIL] = admin@email.com

[SERVERDATA(name)]

Returns the data value from the SERVER based on the data name (var) supplied.

The Server has its own data collection just like Records. This variable allows you to retrieve the value of data elements stored in the Server.

[SERVERDATA(test)] = cat

[URLENCODE(str)]

Encodes a string to adhere to web URL standards for sending data in a query string. 

URL Encoding reference: https://www.w3schools.com/tags/ref_urlencode.ASP

[URLENCODE(abc 123)] = abc+123

[URLENCODE(2:30 PM)] = 2%3A30+PM

[URLDECODE(str)]

Decodes a previously encoded string into its original value

[URLDECODE(abc+123)] = abc 123

[URLDECODE(2%3A30+PM)] = 2:30 PM

[PACKAGEURL]

The URL of the Collaboration Package. This is helpful if you wish to add a link to the package other than in the standard placement which is the bottom of the notification email. 

ONLY APPLICABLE IN WORKFLOW DURING PORTAL CREATION!

* If you need to generate a link outside of workflow, use the PACKAGELINK variable!

Use this link [PackageURL] to open your portal

   will turn into 

Use this link https://serverurl/Portal/Pkg/ABC123 to open your portal

[PACKAGEGUID]

The unique GUID of the Collaboration Package. 

This is very rarely used directly as it is mostly valid only as part of the URL above.

Your package GUID is [PackageGUID].

   will turn into 

Your package GUID is ABC123.

[PACKAGEPASSWORD]

The PASSWORD of the Collaboration Package. This is helpful if you wish to add the password to the package other than in the standard placement which is the bottom of the notification email. 

ONLY APPLICABLE IN WORKFLOW DURING PORTAL CREATION!

[PACKAGEPASSWORD] = password

[PACKAGELINK(GUID)]

The URL of the Collaboration Package. This is helpful if you wish to add a link to the package other than in the standard placement which is the bottom of the notification email. 

GUID = The unique GUID of the portal. To retrieve this you need to store it in a Record variable during its creation.

This is especially useful for sending SMS messages with links to a create portal.

[PACKAGELINK(123-456-789)] = https://demo.docmgt.com/portal/pkg/123-456-789

[FIELDOPTIONS(RecordType|FieldName|del)]

Returns delimited list of options defined for a field.

RecordType = The ID or Name of the Record Type in which to look for the matching field.

FieldName = The Name of the field that has the options defined.

del = The delimiter to use for the list. Defaults to , (comma)

[FIELDOPTIONS(Invoices|Status|^)] = Active^Approved^Paid

[FIELDOPTIONS(1|Status|:)] = Active:Approved:Paid

FILENAME

Returns file name from file name/path

[FILENAME(c:\test.tif)] = test.tif

FILENAMEONLY

Returns file name without extension from file name/path

[FILENAMEONLY(c:\test.tif)] = test

FILEEXTENSION

Returns extension from file name/path

[FILEEXTENSION(c:\test.tif)] = tif

[OCRPAGECOUNT(From|To|Type)]

Returns the number of OCR pages processed in the given time frame

From = The first date to start counting pages. Defaults to first of current month.

To = The last date to count pages. Defaults to today.

Type = The type of OCR job. Defaults to 0 (OCR and Barcodes Only).

Possible Type Values

  -1 = All

  -2 = All Machine Learning Only

   0 = OCR and Barcodes Only (No ML)

   1 = OCR Only

   2 = Barcodes Only

  10 = Machine Learning - Receipts

  12 = Machine Learning - Invoices

  13 = Machine Learning - IDs

  14 = Machine Learning - Business Cards

  15 = Machine Learning - W2s

  16 = Machine Learning - General Forms