System Variables Reference Guide

7/23/2019 System Variables Reference Guide

http://slidepdf.com/reader/full/system-variables-reference-guide 1/129

PROCESS DIRECTORSYSTEM VARIABLES REFERENCE

Last revision: May 11, 2012



BP Logix Inc. Process Director

System Variables Referenceii

Contents ii

© 2012 BP Logix Inc. All rights reserved.



BP Logix Inc. Process DirectorSystem Variables Reference

ii

Contents iii

ContentsSYSTEM VARIABLE PARAMETERS ..................................................................................................................................................... 2

USER SYSTEM VARIABLES ............................................................................................................................................................................. 2 FORM FIELD SYSTEM VARIABLES .................................................................................................................................................................... 2 DATETIME SYSTEM VARIABLES: ..................................................................................................................................................................... 3 ALL SYSTEM VARIABLES ............................................................................................................................................................................... 5

Group Parameter ............................................................................................................................................................................. 5 Encode Types .................................................................................................................................................................................... 5 Pre, Post, and Null ............................................................................................................................................................................ 6

FORM SYSTEM VARIABLES ............................................................................................................................................................... 7

FORM FIELD .......................................................................................................................................................................................... 7 NEW FORM INSTANCE .......................................................................................................................................................................... 8 FORM SUBMITTER ................................................................................................................................................................................ 9 SUBMIT DATE...................................................................................................................................................................................... 10 NUM FORM ATTACHMENTS ............................................................................................................................................................... 11 FORM PRINTING ................................................................................................................................................................................. 12 CONVERTING TO PDF .......................................................................................................................................................................... 13 FORM EVENT TYPE .............................................................................................................................................................................. 14 FORM EVENT NAME............................................................................................................................................................................ 15 IS ON MOBILE DEVICE? ....................................................................................................................................................................... 16 FORM ATTACHMENTS ........................................................................................................................................................................ 16 FORM INSTANCE ID ............................................................................................................................................................................. 16 FORM ATTACHMENT GROUP .............................................................................................................................................................. 17

META DATA SYSTEM VARIABLES ................................................................................................................................................... 19

CATEGORY .......................................................................................................................................................................................... 19 ATTRIBUTE .......................................................................................................................................................................................... 20

OBJECT INFORMATION SYSTEM VARIABLES................................................................................................................................... 21

NAME ................................................................................................................................................................................................. 21 DESCRIPTION ...................................................................................................................................................................................... 22 SIZE ..................................................................................................................................................................................................... 23 CREATE USER ...................................................................................................................................................................................... 24 UPDATE USER ..................................................................................................................................................................................... 25 CREATE DATE ...................................................................................................................................................................................... 26 UPDATE DATE ..................................................................................................................................................................................... 27 VERSION ............................................................................................................................................................................................. 28 DOCUMENT TEXT ................................................................................................................................................................................ 29 FOLDER PATH ...................................................................................................................................................................................... 29 OBJECT ID ........................................................................................................................................................................................... 29 OBJECT TYPE ....................................................................................................................................................................................... 30

WORKFLOW SYSTEM VARIABLES ................................................................................................................................................... 31

PRIORITY ............................................................................................................................................................................................. 31 NUM WORKFLOW ATTACHMENTS ..................................................................................................................................................... 32 WORKFLOW INITIATOR....................................................................................................................................................................... 33 WORKFLOW INSTANCE NAME ............................................................................................................................................................ 34 WORKFLOW STATUS ........................................................................................................................................................................... 35 WORKFLOW START DATE .................................................................................................................................................................... 36




iv

Contents iv

WORKFLOW STOP DATE ..................................................................................................................................................................... 37 TERMINATION REASON ...................................................................................................................................................................... 38 ALL USERS ........................................................................................................................................................................................... 39 WORKFLOW ATTACHMENTS .............................................................................................................................................................. 39 WORKFLOW ATTACHMENT GROUP .................................................................................................................................................... 39 WORKFLOW DEFINITION NAME ......................................................................................................................................................... 40

WORKFLOW NAME ............................................................................................................................................................................. 40 WORKFLOW RUN TIME ....................................................................................................................................................................... 40

TASK SYSTEM VARIABLES .............................................................................................................................................................. 41

TASK NAME ......................................................................................................................................................................................... 41 TASK ASSIGN DATE .............................................................................................................................................................................. 42 TASK INSTRUCTIONS ........................................................................................................................................................................... 43 TASK DUE DATE ................................................................................................................................................................................... 44 TASK PRIORITY .................................................................................................................................................................................... 45 TASK ON BEHALF OF............................................................................................................................................................................ 46 SUB TASK NAME ................................................................................................................................................................................. 47 IN RUNNING TASK? ............................................................................................................................................................................. 48

WORKFLOW STEP SYSTEM VARIABLES ........................................................................................................................................... 49

STEP USERS ......................................................................................................................................................................................... 49 STEP DUE DATE ................................................................................................................................................................................... 50 RUNNING STEP ................................................................................................................................................................................... 51 ACTIVE STEP USERS ............................................................................................................................................................................. 52 STEP START DATE ................................................................................................................................................................................ 53 STEP STOP DATE.................................................................................................................................................................................. 54 NUM TIMES STEP RUN ........................................................................................................................................................................ 55 IS STEP PAST DUE? .............................................................................................................................................................................. 56 BRANCH TAKEN .................................................................................................................................................................................. 57 STEP REACHED .................................................................................................................................................................................... 58 COMPLETED STEP USERS .................................................................................................................................................................... 59 STEP DESCRIPTION .............................................................................................................................................................................. 59 STEP IN ERROR .................................................................................................................................................................................... 60 STEP INSTANCE ID ............................................................................................................................................................................... 60 STEP MESSAGE.................................................................................................................................................................................... 60 STEP RESULT ....................................................................................................................................................................................... 60 STEP RESULT COUNT ........................................................................................................................................................................... 60 STEP RUN TIME ................................................................................................................................................................................... 61 STEP STATUS ....................................................................................................................................................................................... 61 STEP TERMINATION REASON .............................................................................................................................................................. 61

USER SYSTEM VARIABLES .............................................................................................................................................................. 63

CURRENT USER ................................................................................................................................................................................... 63 USER ................................................................................................................................................................................................... 63 GROUP ................................................................................................................................................................................................ 64

BUSINESS RULE SYSTEM VARIABLES .............................................................................................................................................. 65

BUSINESS RULES ................................................................................................................................................................................. 65 TIMELINE SYSTEM VARIABLES ....................................................................................................................................................... 67

TIMELINE INITIATOR ........................................................................................................................................................................... 67 TIMELINE STATUS ............................................................................................................................................................................... 68 NUM TIMELINE ATTACHMENTS .......................................................................................................................................................... 69 TIMELINE INSTANCE NAME ................................................................................................................................................................. 70 PRIORITY ............................................................................................................................................................................................. 71 TIMELINE START DATE ........................................................................................................................................................................ 72 TIMELINE STOP DATE .......................................................................................................................................................................... 73 TERMINATION REASON ...................................................................................................................................................................... 74 TIMELINE AVERAGE RUN TIME ........................................................................................................................................................... 74 TIMELINE STOP DATE – PREDICTED ..................................................................................................................................................... 75




v

Contents v

TIMELINE ATTACHMENTS ................................................................................................................................................................... 75 TIMELINE ATTACHMENT GROUP ........................................................................................................................................................ 76 TIMELINE CONFIGURED STOP DATE .................................................................................................................................................... 76 TIMELINE DEFINITION NAME .............................................................................................................................................................. 76

TIMELINE ACTIVITY SYSTEM VARIABLES ........................................................................................................................................ 77

ACTIVE ACTIVITY USERS ...................................................................................................................................................................... 77 ACTIVITY USERS .................................................................................................................................................................................. 78 ACTIVITY START DATE ......................................................................................................................................................................... 79 ACTIVITY STOP DATE ........................................................................................................................................................................... 80 ACTIVITY DUE DATE ............................................................................................................................................................................ 81 IS ACTIVITY PAST DUE?........................................................................................................................................................................ 82 RUNNING ACTIVITY NAME .................................................................................................................................................................. 83 ACTIVITY REACHED ............................................................................................................................................................................. 84 ACTIVITY START DATE – PREDICTED .................................................................................................................................................... 85 ACTIVITY STOP DATE - PREDICTED ...................................................................................................................................................... 86 IS PREDICTED TO START LATE? ............................................................................................................................................................ 87 IS PREDICTED TO END LATE? ............................................................................................................................................................... 88 NUM TIMES ACTIVITY RUN ................................................................................................................................................................. 89 COMPLETED ACTIVITY USERS.............................................................................................................................................................. 90

ACTIVITY AVERAGE RUN TIME ............................................................................................................................................................ 90 ACTIVITY DESCRIPTION ....................................................................................................................................................................... 91 ACTIVITY IN ERROR ............................................................................................................................................................................. 91 ACTIVITY MESSAGE ............................................................................................................................................................................. 91 ACTIVITY RESULT ................................................................................................................................................................................ 91 ACTIVITY RUN TIME ............................................................................................................................................................................ 92 ACTIVITY STATUS ................................................................................................................................................................................ 92 ACTIVITY TERMINATION REASON ....................................................................................................................................................... 92 ACTIVITY TOP RUNNING NAME ........................................................................................................................................................... 92 ACTIVITY USERS COMPLETE ................................................................................................................................................................ 93

PROCESS SYSTEM VARIABLES ........................................................................................................................................................ 95

PROCESS INSTANCE NAME ................................................................................................................................................................. 95 PROCESS INITIATOR ............................................................................................................................................................................ 96 PROCESS STATUS ................................................................................................................................................................................ 97 PROCESS PRIORITY .............................................................................................................................................................................. 98 PROCESS START DATE ......................................................................................................................................................................... 99 PROCESS STOP DATE ......................................................................................................................................................................... 100 TERMINATION REASON .................................................................................................................................................................... 101 RUNNING USERS ............................................................................................................................................................................... 102 IS SUB-PROCESS? .............................................................................................................................................................................. 102 PROCESS ATTACHMENT GROUP ....................................................................................................................................................... 103 PROCESS DEFINITION NAME ............................................................................................................................................................. 103 PROCESS IN ERROR ........................................................................................................................................................................... 103 PROCESS INSTANCE ID ...................................................................................................................................................................... 103 PROCESS MESSAGE ........................................................................................................................................................................... 103 PROCESS TASK DUE DATE.................................................................................................................................................................. 104 PROCESS TASK START DATE RETURNS: ................................................................................................................................................ 104 PROCESS TASK RUNNING .................................................................................................................................................................. 104 SUB TASK NAME ............................................................................................................................................................................... 104

DATETIME SYSTEM VARIABLES .................................................................................................................................................... 105

DATE ................................................................................................................................................................................................. 105 CURRENT DATE ................................................................................................................................................................................. 105 DAYS AGO ......................................................................................................................................................................................... 106 DAYS FROM NOW ............................................................................................................................................................................. 106

EMAIL SYSTEM VARIABLES .......................................................................................................................................................... 109

EMAIL URL ........................................................................................................................................................................................ 109 EMAIL USER ...................................................................................................................................................................................... 109




v

Contents vi

EMAIL EXTERNAL USER ..................................................................................................................................................................... 109 EMAIL FORM INSTANCE URL ............................................................................................................................................................. 109 EMAIL TASK ID .................................................................................................................................................................................. 110 EMAIL COMPLETE URL ...................................................................................................................................................................... 110 EMAIL RESULT LINKS ......................................................................................................................................................................... 110 EMAIL RESULT LIST ............................................................................................................................................................................ 110

OTHER SYSTEM VARIABLES.......................................................................................................................................................... 113

CALC ................................................................................................................................................................................................. 113 CURRENT USER GROUPS ................................................................................................................................................................... 113 CUSTOM VARIABLE ........................................................................................................................................................................... 113 DATE DIFFERENCE ............................................................................................................................................................................. 113 DEBUG_MODE .................................................................................................................................................................................. 114 INTERFACE URL ................................................................................................................................................................................. 114 KNOWLEDGE VIEW DEFINITION NAME ............................................................................................................................................. 114 KNOWLEDGE VIEW NUMBER OF ROWS ............................................................................................................................................ 114 KNOWLEDGE VIEW FILTER DATA ...................................................................................................................................................... 115 LOGO URL ......................................................................................................................................................................................... 115 ROW NEXT ........................................................................................................................................................................................ 115 ROW NUM ........................................................................................................................................................................................ 115

ROW PREV ........................................................................................................................................................................................ 115 SERVER CULTURE .............................................................................................................................................................................. 116 SERVER NAME ................................................................................................................................................................................... 116 SERVER VERSION .............................................................................................................................................................................. 116 SESSION ............................................................................................................................................................................................ 116 SEQUEL PERMISSION ........................................................................................................................................................................ 117 SEQUENCE NUMBER ......................................................................................................................................................................... 117 STRING .............................................................................................................................................................................................. 117 STRING (RIGHT-HAND SIDE MENU) ......................................................................................................................................................... 118 SUM .................................................................................................................................................................................................. 118

INDEX .......................................................................................................................................................................................... 121




System Variables Reference1

Contents 1





Contents 2

SYSTEM VARIABLE PARAMETERS

System variables will often contain Optional Parameters or other variables which control the data the system variable will return.

These are specified in SysVar tags using the following syntax:

{VARNAME, format=[format_type]}

VARNAME is the name of the system variable, and [format type] is the formatting option. [format type] can be one of any set of the

following, depending on the system variable it’s in.

System variable parameters are not case sensitive.

User System VariablesSystem variables that return information about a user or users will have the following options:

FORMAT:

{CURR_USER,format=[option]}

Name: formats the system variable into a string of a user’s name

Userid: formats the system variable into a string of the user’s ID

Id: the system variable will return the ID of an object or user.

Guid: the system variable will return the global unique ID of an object

Email: formats the system variable to return a string of a user’s email

Domain: returns the domain a user is in

Picture: returns an image of a user

Signature: returns an image of the user’s signature

Custom_String: returns the custom string stored in the User’s table entry

Custom_Number: returns the custom number stored in the User’s table entry

Custom_Date: returns the custom date stored in the User’s table entry

Culture: returns the user’s culture

Culture_String: returns the user’s culture string

The following example demonstrates how a user system variable tag can be formatted to return the User ID:

{CURR_USER, format=Userid}

Form Field System VariablesSystem variables that return numbers will have the following options:





Contents 3

FORMAT:

{FORM:someFieldName, format=Currency}

Currency: formats the system variable into a format representing currency (e.g. $22.99)

Number: ensures that a system variable returns an integer

Value: returns the value of a dropdown selection

String: returns the text in a form field

Friendly: returns the friendly field name

ClientID: returns HTML ID of the control suitable for JavaScript

ROW_NUM:

{FORM:someFieldName, ROW_NUM=2}

If this form control is part of an array, returns the value specified by the ROW_NUM parameter

SEPARATOR:

{FORM:someColumnFieldName, SEPARATOR=|}

If this form control is part of an array, this option specifies which character will be used to separate the

different values in the different elements of the array. By default, the separator is a comma.

Datetime System Variables:System variables that return a datetime will have the following options:

YEARS:

adds a specified number of years to a DateTime SysVar result

MONTHS:

adds a specified number of months to a DateTime SysVar result

DAYS:

adds a specified number of days to a DateTime SysVar result

HOURS:





Contents 4

adds a specified number of hours to a DateTime SysVar result

MINUTES:

adds a specified number of minutes to a DateTime SysVar result

SECONDS:

adds a specified number of seconds to a DateTime SysVar result

Datetime system variables can be formatted using any combination of the following parameters:

FORMAT:

{CURR_DATE, format=[option]}

d: displays the current day of the month as a number (1 – 31)

dd: displays the current day of the month as a number, padding to two digits with a zero if necessary (01 – 31)

ddd: displays the abbreviated name of the day (Sun. – Sat.)

dddd: displays the full name of the day (Sunday – Saturday)

h: displays the hour as 1-12. Without specifying AM or PM, 1:00pm is indistinguishable from 1:00am (and so

on) with this formatting option.

hh: displays the hour as 01-12. Padding using a zero is applied to ensure that the value returned is two

characters long. Without specifying AM or PM, 1:00pm is indistinguishable from 1:00am (and so on) with this

formatting option.

H: displays the hour as 0-23.

HH: displays the hour as 00-23. Padding using a zero is applied to ensure that the value returned is always two

characters long.

m: displays the current minute as a number 0 – 59

mm: displays the current minute as a number 00 – 59. Left padding using a zero is added to ensure the return

value is two characters long

M: displays the month as a number 1 – 12

MM: displays the month as a number 01 – 12. Left padding using a zero is added to ensure the return value is

two characters long.

MMM: returns the abbreviated name for the month (Jan. – Dec.)

MMMM: returns the full name for the month (January – December)

s: displays the seconds as a number 0 – 59





Contents 5

ss: displays the seconds as a number 00 – 59. Padding using a zero is added to the left of the return value to

ensure it is two characters long.

t: displays an A if the time is before noon or P if it is after noon

tt: displays A.M. if the time is before noon. Otherwise displays P.M.

y: displays the year as a one or two digit number. The first two numbers of the year are always omitted. The

third digit of the year is omitted if the year is between ’00 and ’09 (e.g. 1, 17, 93)

yy: displays the last two digits of the year. (e.g. 48, 67, 73)

yyyy: displays all four digits of the year. If the year is less than four digits long, zeros are added to pad the year

value to four digits (e.g. 1982, 2009)

separators (/ : “ ‘): quotation marks, apostrophes, colons, and slashes can be added to the datetime

formatting. They will displayed literally, and can be used to separate different elements of the datetime string.

All System Variables

Group Parameter

Most system variables can be configured via the “group” parameter, which limits the results of a system variable such that it will

return only results belonging to the specified group. Use the following syntax to add a group restriction to a SysVar tag:

{SYSTEM_VARIABLE, group=[group name]}

Encode TypesEncoding types are special characters put inside system variable tags to force the tag to return a certain type. These are often used

to prevent improperly encoded values from breaking a query. The format used to specify an encode type is as follows:

{[encode-type]SysVar}

Where [encode-type] can be any one of the following symbols:

! -- encodes the result as HTML

$ -- ensures the result is a valid SQL string

* -- converts the result into a valid SQL list of strings (e.g. ‘string one’, ‘string two’, ‘string three’)

# -- ensures the result is a valid SQL number

& -- converts the result to a URL encoded value

@ -- ensures the result is valid for a calculation control or system variable tag

+ -- ensures the result is a valid SQL Server date

- -- ensures the result is a valid Oracle date

^ -- returns an LDAP encoded string which can be passed to an LDAP filter





Contents 6

Pre, Post, and NullPre, post, and null are options specifying what text a system variable will display before the result, after the result, and if there is no

result, respectively. Pre and post will display when the system variable result is not null, and the null text will display otherwise. To

specify a system variable’s pre, post, and null values in the System Variable eForm control, use the SysVar tab.

To specify the Pre, Post, and Null values in a SysVar tag, use the following format:

{VARNAME pre=[pre_text], post=[post_text], null=[null_text]}





Contents 7

FORM SYSTEM VARIABLES

FORM FIELD

Returns:

A Form Field system variable will return the value of a specified form field. The data will be drawn from the active instance of the

eForm.

SysVar Tag:

{FORM:[form_field_name]}

Optional Parameters:

The Optional Parameters available depend on what kind of data the form field contains. If the form field contains arbitrary data,

then the form field system variable Optional Parameters apply. If the form field contains data about a user, then the user system

variable Optional Parameters apply. No Optional Parameters are available when the form field contains information about an object.





Contents 8

NEW FORM INSTANCE

Returns:

This system variable returns a Boolean value (e.g. yes/no, true/false) reflecting whether or not the eForm instance has just been

created.

SysVar Tag:

{NEW_FORM_INSTANCE}


No Optional Parameters apply to this system variable: it will always return a Boolean value.





Contents 9

FORM SUBMITTER

Returns:

This system variable returns information about the user that submitted the eForm, thus creating the eForm instance.

SysVar Tag:

{FORM_SUBMITTER}


The Optional Parameters for a User system variable apply to this SysVar.





Contents 10

SUBMIT DATE

Returns:

The Submit Date system variable returns the date a form instance was submitted on.

SysVar Tag:

{SUBMIT_DATE}


This system variable can be formatted according to options available to datetime system variables.





Contents 11

NUM FORM ATTACHMENTS

Returns:

This system variable returns the number of attachments to an eForm instance.

SysVar Tag:

{FORM_ATTACHMENT_NUM}


This system variable’s results can be restricted by object type usin g the ObjectType parameter. Acceptable values are DOCUMENT

and FORM.





Contents 12

FORM PRINTING

Returns:

This system variable returns a Boolean value reflecting whether or not the eForm is being printed. Use this to change what is

displayed on printed versions of the eForm.

SysVar Tag:

{FORM_PRINTING}


This system variable does not have Optional Parameters.





Contents 13

CONVERTING TO PDF

Returns:

This system variable returns a Boolean value reflecting whether or not the eForm is being converted to a PDF. Use this system

variable to change is displayed on PDF versions of an eForm.

SysVar Tag:

{FORM_TO_PDF}







Contents 14

FORM EVENT TYPE

Returns:

This system variable returns a string reflecting the type of the most recent form event. The returned string can be any of the

following values:

User

Complete

Cancel

Save

SaveAndClose

Print

CancelClose

DocumentAttached

ClipboardAttached

RefreshEvent

SysVar Tag:

{FORM_EVENT_TYPE}






Contents 15

This system variable does not have Optional Parameters

FORM EVENT NAME

Returns:

This system variable returns a string containing the name of the most recent form event.

SysVar Tag:

{FORM_EVENT_NAME}







Contents 16

IS ON MOBILE DEVICE?

Returns:

This system variable returns a Boolean value reflecting whether or not the eForm is being displayed on a mobile device. Use this to

change what an eForm displays depending on what device is displaying an eForm. Tablets count as mobile devices.

SysVar Tag:

{FORM_IS_MOBILE}



FORM ATTACHMENTSReturns:

This system variable returns a comma-separated list of object names attached to this form instance.

SysVar Tag:

{FORM_ATTACHMENTS}


The results returned can be filtered by group using the Groupname= option.

FORM INSTANCE IDReturns:

This system variable returns the ID of the current form instance.





Contents 17

SysVar Tag:

{FORM_INSTANCE_ID}


This system variable cannot be formatted.

FORM ATTACHMENT GROUPReturns:

This system variable returns the name of a group that an attached object is in.

SysVar Tag:

{FORM_ATTACHMENT_GROUP}









Contents 19

META DATA SYSTEM VARIABLES

CATEGORY

Returns:

The Category system variable returns the name of a specified category or list of categories so long as the object containing this

system variable is assigned to that category. If the object is not assigned to a listed category, the system variable returns a null string

for that category.

SysVar Tag:

{CATEGORY:[category_name_1].[category_name_2]…}







Contents 20

ATTRIBUTE

Returns:

This system variable returns the name of an attribute if the object containing this system variable is assigned to that attribute. If the

object is not assigned to the attribute, the system variable will return a null string.

SysVar Tag:

{ATTRIBUTE:[category_name].[attribute_name], format=[currency|value|string]}


This system variable can be formatted as a currency, a numeric value, or a string using the format= option.





Contents 21

OBJECT INFORMATION SYSTEM VARIABLES

NAME

Returns:

This system variable returns a string containing the name of this object.

SysVar Tag:

{OBJ_NAME}







Contents 22

DESCRIPTION

Returns:

This system variable returns a string containing the description of the relevant object.

SysVar Tag:

{OBJ_DESC}







Contents 23

SIZE

Returns:

This system variable returns the size of the object.

SysVar Tag:

{OBJ_SIZE}







Contents 24

CREATE USER

Returns:

This system variable returns information about the user that created the object.

SysVar Tag:

{CREATE_USER}


The result of this system variable can be formatted using the user Optional Parameters.





Contents 25

UPDATE USER

Returns:

This system variable returns information about the last user to update the object.

SysVar Tag:

{UPDATE_USER}


This system variable can be formatted using the Optional Parameters available to user system variables.





Contents 26

CREATE DATE

Returns:

This system variable returns the date on which the object was created.

SysVar Tag:

{CREATE_DATE}


The result of this system variable can be formatted according to options available to format dates.





Contents 27

UPDATE DATE

Returns:

This system variable returns the date upon which the object was last updated.

SysVar Tag:

{UPDATE_DATE}


This system variable can be formatted using the date Optional Parameters.





Contents 28

VERSION

Returns:

This system variable returns the object’s version number

SysVar Tag:

{OBJ_VERSION}







Contents 29

DOCUMENT TEXT

Returns:

This option allows for a full-text search of a document object.

SysVar Tag:

N/A

FOLDER PATHReturns:

This system variable returns the content list folder path of an object.

SysVar Tag:

{FOLDER_PATH}



OBJECT ID

Returns:

This system variable returns the ID of an object.

SysVar Tag:

{OBJ_ID}







Contents 30

OBJECT TYPEReturns:

This system variable returns this object’s type. This system variable can return the following:

Document

Folder

Rule

Knowledge View

Workflow

Workflow Instance

TaskList

User

Group

Partition

Form

Form Instance

Category

Dropdown

Profile

DataSource Connection

Report

SysVar Tag:

{OBJ_TYPE}


This system variable has no optional parameters.





Contents 31

WORKFLOW SYSTEM VARIABLES

PRIORITY

Returns:

This system variable returns a workflow instance’s priority.

SysVar Tag:

{WORKFLOW_PRIORITY}







Contents 32

NUM WORKFLOW ATTACHMENTS

Returns:

The Num Workflow Attachments variable returns the number of objects attached to a workflow instance.

SysVar Tag:

{WORKFLOW_ATTACHMENT_NUM}


A group name can be specified, making the variable return only the number of attached objects in the specified groups.





Contents 33

WORKFLOW INITIATOR

Returns:

This system variable returns information about the user who started the current workflow instance.

SysVar Tag:

{WORKFLOW_INITIATOR}


The Workflow Initiator system variable can be formatted with any option available to a user system variable.





Contents 34

WORKFLOW INSTANCE NAME

Returns:

The Workflow Instance Name system variable returns the name of the current workflow instance.

SysVar Tag:

{WORKFLOW_INSTANCE_NAME}


This system variable does not have any Optional Parameters.





Contents 35

WORKFLOW STATUS

Returns:

This system variable returns the status of the workflow instance. The string returned can be either “Pending”, “Completed”, or

“Running”. The system variable will return “Pending” if a workflow is not available or has never been run.

SysVar Tag:

{WORKFLOW_STATUS}







Contents 36

WORKFLOW START DATE

Returns:

This system variable returns a datetime representing the date the current workflow instance started.

SysVar Tag:

{WORKFLOW_START_DATE}


The result of this system variable can be formatted using the Optional Parameters available to datetime system variables.





Contents 37

WORKFLOW STOP DATE

Returns:

This system variable returns the date the current workflow instance stopped.

SysVar Tag:

{WORKFLOW_STOP_DATE}


This system variable can be formatted using the Optional Parameters available to datetimes.





Contents 38

TERMINATION REASON

Returns:

This system variable returns the reason the current workflow instance terminated. The results of this system variable can be used to

handle workflow errors. If the workflow is still running or no value has been returned, this system variable will return “Not Set.”

SysVar Tag:

{WORKFLOW_TERM_REASON}







Contents 39

ALL USERS

Returns:

This system variable returns a comma-separated list of all users involved in a workflow.

SysVar Tag:

{WORKFLOW_ALL_USERS}


This system variable can be formatted according to the options available to a user system variable.

WORKFLOW ATTACHMENTSReturns:

This system variable returns a comma-separated list of the names of objects currently attached to this workflow.

SysVar Tag:

{WORKFLOW_ATTACHMENTS, GroupName=someGroup}Optional Parameters:

This system variable’s results can be filtered by group using the GroupName=someGroup parameter.

WORKFLOW ATTACHMENT GROUPReturns:

This system variable returns the groupname used for this workflow attachment.





Contents 40

SysVar Tag:

{WORKFLOW_ATTACHMENT_GROUP}



WORKFLOW DEFINITION NAMEReturns:

This system variable returns the name of the definition that this workflow is an instance of.

SysVar Tag:

{WORKFLOW_DEF_NAME}


This system variable does not have optional parameters.

WORKFLOW NAMEReturns:

This system variable returns the name of the current workflow instance.

SysVar Tag:

{WORKFLOW_NAME}



WORKFLOW RUN TIMEReturns:

This system variable returns the time the current workflow instance has run.

SysVar Tag:

{WORKFLOW_RUN_TIME}


This system variable can be formatted as a datetime.





Contents 41

TASK SYSTEM VARIABLES

TASK NAME

Returns:The Task Name system variable returns the name of the task that the process is currently on. A user might use this system variable

to configure an eForm specifically to what task is running.

SysVar Tag:

{TASK_NAME}







Contents 42

TASK ASSIGN DATE

Returns:

This system variable returns the date the current task was assigned.

SysVar Tag:

{TASK_ASSIGN_DATE}


This system variable can be formatted according to date Optional Parameters.





Contents 43

TASK INSTRUCTIONS

Returns:

This system variable returns a string containing the instructions for the current task. The results of this system variable can be

displayed on an eForm to instruct the end user.

SysVar Tag:

{TASK_INSTRUCTIONS}







Contents 44

TASK DUE DATE

Returns:

This system variable returns the date the current task is due.

SysVar Tag:

{TASK_DUE_DATE}


This system variable can be formatted using Optional Parameters available to dates.





Contents 45

TASK PRIORITY

Returns:

This system variable returns the priority of the current task.

SysVar Tag:

{TASK_PRIORITY}







Contents 46

TASK ON BEHALF OF

Returns:

This system variable returns information about the user who delegated this task to another user. This system variable only returns a

value when the task has been delegated.

SysVar Tag:

{TASK_ON_BEHALF_OF}


This system variable can be formatted according to options available to user results.





Contents 47

SUB TASK NAME

Returns:

This system variable returns the name of the sub task automatically created when a user is assigned a task in a sequence.

SysVar Tag:

{SUB_TASK_NAME}







Contents 48

IN RUNNING TASK?

Returns:

This system variable returns a Boolean value reflecting whether or not the currently logged in user is opening the eForm in the

context of a running task.

SysVar Tag:

{IN_RUNNING_TASK}







Contents 49

WORKFLOW STEP SYSTEM VARIABLES

STEP USERS

Returns:

This system variable returns a comma-separated list of all users involved in a workflow step.

SysVar Tag:

{STEP_USERS:[step name]}


This system variable can be formatted with Optional Parameters available to user results.





Contents 50

STEP DUE DATE

Returns:

This system variable returns the date the current step is due.

SysVar Tag:

{STEP_DUE_DATE:[step name]}


This system variable can be formatted using options available to date system variables.





Contents 51

RUNNING STEP

Returns:

This system variable returns the name of the currently running step.

SysVar Tag:

{STEP_RUNNING_NAME}







Contents 52

ACTIVE STEP USERS

Returns:

This system variable returns a comma-separated list of users actively involved in this step.

SysVar Tag:

{STEP_USERS_ACTIVE:[step name]}


This system variable can be formatted with options available to user system variables.





Contents 53

STEP START DATE

Returns:

This system variable returns the date that the specified step started.

SysVar Tag:

{STEP_START_DATE:[step name], instance=someInstance}


Datetime Optional Parameters can be used to format this system variable. There is also an optional “instance” parameter that allows

the user to specify a specific instance of a workflow step to get the start date of.





Contents 54

STEP STOP DATE

Returns:

This system variable returns the date this step stopped.

SysVar Tag:

{STEP_STOP_DATE:[step name], instance=someInstance}


This system variable can be formatted using the options available to datetime system variables. There is also an optional “instance”

parameter that allows the user to specify a specific instance of a workflow step to get the start date of.





Contents 55

NUM TIMES STEP RUN

Returns:

This system variable returns the number of times a step has run. You can use this to break out of loops in a workflow.

SysVar Tag:

{STEP_NUM_TIMES_RUN:[step name]}







Contents 56

IS STEP PAST DUE?

Returns:

This system variable returns a Boolean value based on whether the specified step is past its due date. You can use this to

conditionally change the process flow if the step is late.

SysVar Tag:

{STEP_PAST_DUE:[step name]}







Contents 57

BRANCH TAKEN

Returns:

This system variable returns a Boolean value based on whether the specified branch has been taken.

SysVar Tag:

{BRANCH_TAKEN:[branch name], instance=[workflow instance]}







Contents 58

STEP REACHED

Returns:

This system variable returns a Boolean value based on whether the specified step has been reached.

SysVar Tag:

{STEP_REACHED}







Contents 59

COMPLETED STEP USERS

Returns:

This system variable returns a comma-separated list of users who have completed the specified step.

SysVar Tag:

{STEP_USERS_COMPLETE}


The result of this system variable can be formatted using the options available to user results.

STEP DESCRIPTIONReturns:

This system variable returns a string containing the description of this workflow step.

SysVar Tag:

{STEP_DESCRIPTION:step}


You can use the step parameter to specify the name of the step whose description you want. If no step name is specified, this

system variable will return the start date of the current step.





Contents 60

STEP IN ERRORReturns:

This system variable returns the name of the step currently in an error state.

SysVar Tag:

{STEP_IN_ERROR}



STEP INSTANCE IDReturns:

This system variable returns the Instance ID of the running instance of a given workflow step.

SysVar Tag:

{STEP_INSTANCE_ID:[step name]}



STEP MESSAGEReturns:

This system variable returns the message for the specified step.

SysVar Tag:

{STEP_MESSAGE:step}


You can specify which step you want the message of using the “step” parameter. If left unspecified, this system variable will return

the start date for the current step.

STEP RESULTReturns:

This system variable returns the result of a specified step instance.

SysVar Tag:

{STEP_RESULT:[step name], instance=[instance id]}


This system variable must specify a particular step instance by using the instance= parameter.

STEP RESULT COUNTReturns:

This system variable returns the number of times the specified step has returned this result.

SysVar Tag:





Contents 61

{STEP_RESULT_COUNT:[step name], result=[result to test for]}


This system variable must specify the result being tested for using the result= parameter.

STEP RUN TIMEReturns:

This system variable returns the amount of time the specified step has run.]

SysVar Tag:

{STEP_RUN_TIME:step}


This system variable must specify a particular step using the “step” parameter. If no step is specified, this system variable returns the

start date of the current step.

STEP STATUSReturns:

This system variable returns a step’s status. It will return either “Running”, “Completed”, or “Pending.” The system variable will only

return “Pending” if the specified step isn’t available or hasn’t been run.

SysVar Tag:

{STEP_STATUS:[step name]}



STEP TERMINATION REASONReturns:

This system variable returns the reason the specified step terminated. If the step has not terminated, this system variable will return

“Not Set”.

SysVar Tag:

{STEP_TERM_REASON}


This system variable must specify a step name using the step parameter. Should this name not be specified, the system variable will

return the start date of the current step.







Contents 63

USER SYSTEM VARIABLES

CURRENT USER

Returns:

This system variable returns information about the user currently viewing the eForm.

SysVar Tag:

{CURR_USER}


The result of this system variable can be formatted using the user Optional Parameters.

USER





Contents 64

Returns:

This option allows the user to specify a user to be used for comparisons. This is technically not a system variable, but information

about a user can be gathered via SysVar tags by referencing a user picker.

SysVar Tag:

{FORM:someUserPicker}


The result of this SysVar tag can be formatted according to what options are available to form field system variables.

GROUP

Returns:

This system variable allows the user to specify a group to be used in comparisons. Information about a group can be gathered via

SysVar tags by referencing a group picker form field.

SysVar Tag:

{FORM:someGroupPicker}


The result of a group picker reference can be formatted according to the options available to form field system variables.





Contents 65

BUSINESS RULE SYSTEM VARIABLES

BUSINESS RULES

Returns:

This system variable returns the result of a selected Business Rule.SysVar Tag:

{RULE:[business rule name]}


The result of this system variable can be formatted according to the options available to the type of data the business rule returns.







Contents 67

TIMELINE SYSTEM VARIABLES

TIMELINE INITIATOR

Returns:

This system variable returns information about the user that initiated the running timeline.

SysVar Tag:

{TIMELINE_INITIATOR}

Optional Parameters:This system variable can be formatted according to the options available to user system variables.





Contents 68

TIMELINE STATUS

Returns:

This system variable returns a string representing the status of the current timeline. The result of this system variable will be either

“Completed”, “Running” or “Pending.” This system variable will return “Pending” when the timeline is unavailable or has never been

run.

SysVar Tag:

{TIMELINE_STATUS}







Contents 69

NUM TIMELINE ATTACHMENTS

Returns:

This system variable returns the number of items attached to a timeline. You can tell the system variable only to count items within

a certain group.

SysVar Tag:

{TIMELINE_ATTACHMENT_NUM, GroupName=[group name]}







Contents 70

TIMELINE INSTANCE NAME

Returns:

This system variable returns the name of the running timeline instance.

SysVar Tag:

{TIMELINE_NAME}







Contents 71

PRIORITY

Returns:

This system variable returns the priority of the running timeline.

SysVar Tag:

{TIMELINE_PRIORITY}







Contents 72

TIMELINE START DATE

Returns:

This system variable returns the date this timeline instance started.

SysVar Tag:

{TIMELINE_START_DATE}


This system variable can be formatted using the date Optional Parameters.





Contents 73

TIMELINE STOP DATE

Returns:

This system variable returns the date this timeline instance stopped.

SysVar Tag:

{TIMELINE_STOP_DATE}


This system variable can be formatted using the options available to date system variables.





Contents 74

TERMINATION REASON

Returns:

This system variable returns a string containing the reason this timeline instance terminated. If a timeline is not running or has not

been completed, this system variable returns “Not Set”.

SysVar Tag:

{TIMELINE_TERM_REASON}



TIMELINE AVERAGE RUN TIMEReturns:

This system variable returns the average time this timeline takes to run.

SysVar Tag:

{TIMELINE_AVG_RUN_TIME, format=[Days|Hours|Minutes|Seconds]}


This system variable can be formatted to return the average run time in days, hours, minutes or seconds. By default, the average run

time is returned in days.





Contents 75

TIMELINE STOP DATE – PREDICTED

Returns:

This system variable returns the predicted date that the running timeline instance will complete.

SysVar Tag:

{TIMELINE_STOP_PREDICTED}


This system variable can be formatted using Optional Parameters available to date results.

TIMELINE ATTACHMENTSReturns:

This system variable returns a comma-separated list of object names attached to this timeline instance.

SysVar Tag:

{TIMELINE_ATTACHMENTS}


The results returned can be filtered by group using the Groupname= option.





Contents 76

TIMELINE ATTACHMENT GROUPReturns:

This system variable returns the name of a group that an attached object is in.

SysVar Tag:

{TIMELINE_ATTACHMENT_GROUP}



TIMELINE CONFIGURED STOP DATEReturns:

This system variable returns a datetime variable containing the value of the date that this Timeline has been configured to stop.

SysVar Tag:

{TIMELINE_STOP_CONFIG}


This system variable can be formatted according to the options available to DateTime system variables.

TIMELINE DEFINITION NAMEReturns:

This system variable returns the name of the timeline definition this timeline is an instance of.

SysVar Tag:

{TIMELINE_DEF_NAME}







Contents 77

TIMELINE ACTIVITY SYSTEM VARIABLES

ACTIVE ACTIVITY USERS

Returns:

This system variable returns a comma-separated list of the users currently actively involved in the specified activity.

SysVar Tag:

{ACTIVITY_USERS_ACTIVE:[activity name]}






Contents 78

This system variable can be formatted according to user Optional Parameters.

ACTIVITY USERS

Returns:

This system variable returns a comma-separated list of all users involved in the specified activity.

SysVar Tag:

{ACTIVITY_USERS:[activity name]}


This system variable can be formatted according to Optional Parameters available to user system variables.





Contents 79

ACTIVITY START DATE

Returns:

This system variable returns the date the specified activity started.

SysVar Tag:

{ACTIVITY_START_DATE:[activity name], instance=someInstance}


This system variable can be formatted using the options available to a date system variable. There is also an optional “instance”

parameter that allows the user to specify a specific instance of a timeline activity to get the start date of.





Contents 80

ACTIVITY STOP DATE

Returns:

This system variable returns the date the specified activity stopped.

SysVar Tag:

{ACTIVITY_STOP_DATE:[activity name], instance=someInstance}


This system variable can be formatted according to the options available for date results. There is also an optional “instance”

parameter that allows the user to specify a specific instance of a timeline activity to get the stop date of.





Contents 81

ACTIVITY DUE DATE

Returns:

This system variable returns the date the specified activity is due.

SysVar Tag:

{ACTIVITY_DUE_DATE:[activity name]}


The result of this system variable can be formatted as a date.





Contents 82

IS ACTIVITY PAST DUE?

Returns:

This system variable returns a Boolean value based on whether the specified activity has passed its due date.

SysVar Tag:

{ACIVITY_PAST_DUE}


This system variable has no available Optional Parameters.





Contents 83

RUNNING ACTIVITY NAME

Returns:

This system variable returns the name of the currently running activity.

SysVar Tag:

{ACTIVITY_RUNNING_NAME}







Contents 84

ACTIVITY REACHED

Returns:

This system variable returns a Boolean value based on whether the specified activity has been reached.

SysVar Tag:

{ACTIVITY REACHED:[activity name]}







Contents 85

ACTIVITY START DATE – PREDICTED

Returns:

This system variable returns the date the specified activity is predicted to start.

SysVar Tag:

{ACTIVITY_START_PREDICTED:[activity name]}


The result of this system variable can be formatted as a date.





Contents 86

ACTIVITY STOP DATE - PREDICTED

Returns:

This system variable returns the date the specified activity is predicted to stop.

SysVar Tag:

{ACTIVITY_STOP_PREDICTED:[activity name]}


This system variable’s results can be formatted as a date.





Contents 87

IS PREDICTED TO START LATE?

Returns:

This system variable returns a Boolean value based on whether the specified activity is predicted to start late.

SysVar Tag:

{ACTIVITY_PREDICT_START_LATE:[activity name]}







Contents 88

IS PREDICTED TO END LATE?

Returns:

This system variable returns a Boolean value based on whether the specified activity is predicted to end late.

SysVar Tag:

{ACTIVITY_PREDICT_END_LATE:[activity name]}







Contents 89

NUM TIMES ACTIVITY RUN

Returns:

This system variable returns the number of times a specified activity has been run in the current timeline instance.

SysVar Tag:

{ACTIVITY_NUM_TIMES_RUN:[activity name]}







Contents 90

COMPLETED ACTIVITY USERS

Returns:

This system variable returns a comma-separated list of the users involved in the specified activity who have completed their

assigned task.

SysVar Tag:{ACTIVITY_USERS_COMPLETE:[activity name]}


This system variable can be formatted according to the user Optional Parameters.

ACTIVITY AVERAGE RUN TIMEReturns:





Contents 91

This system variable returns the average amount of time a specified activity usually takes to run.

SysVar Tag:

{ACTIVITY_AVG_RUN_TIME:[activity name], format=[Days|Hours|Minutes|Seconds]}


This system variable can be formatted to return its result in days, hours, minutes, or seconds. By default, this system variable returns

its result in days.

ACTIVITY DESCRIPTIONReturns:

This system variable returns the specified activity’s description.

SysVar Tag:

{ACTIVITY_DESCRIPTION:activity}


This system variable must specify an activity name using the activity parameter. If no activity name is specified, this system variable

will return the start date of the current activity.

ACTIVITY IN ERRORReturns:

This system variable returns the name of an activity that is in error.

SysVar Tag:

{ACTIVITY_IN_ERROR}



ACTIVITY MESSAGEReturns:

This system variable returns a message for a specified activity.

SysVar Tag:

{ACTIVITY_MESSAGE:[activity name]}



ACTIVITY RESULTReturns:

This system variable returns the result of a specified activity instance.

SysVar Tag:

{STEP_RESULT:[activity name], instance=[instance id]}






Contents 92

This system variable must specify a particular activity instance by using the instance= parameter.

ACTIVITY RUN TIMEReturns:

This system variable returns the amount of time this activity has been running.

SysVar Tag:

{ACTIVITY_RUN_TIME:activity}


This system variable must specify an activity name. If none is specified, it will return the start date of the current activity. This system

variable can be formatted as a datetime.

ACTIVITY STATUSReturns:

This system variable returns an activity’s status. It will return either “Running”, “Completed”, or “Pending.” The system variable willonly return “Pending” if the activity isn’t available or hasn’t been run.

SysVar Tag:

{ACTIVITY_STATUS:[activity name]}



ACTIVITY TERMINATION REASONReturns:

This system variable returns the reason the specified activity terminated. If it has not yet terminated, this system variable returns“Not Set”.

SysVar Tag:

{ACTIVITY_TERM_REASON}


This system variable must specify an activity using the activity parameter. Should one not be specified, this system variable will

return the start date of the current activity.

ACTIVITY TOP RUNNING NAMEReturns:

This system variable returns the specified activity’s highest level parent activity.

SysVar Tag:

{ACTIVITY_TOP_RUNNING_NAME}







Contents 93

ACTIVITY USERS COMPLETEReturns:

This system variable returns a list of users that have completed the specified activity.

SysVar Tag:

{ACTIVITY_USERS_COMPLETE}


This system variable must specify an activity using the activity parameter. It can be formatted according to the options available to

user system variables.







Contents 95

PROCESS SYSTEM VARIABLES

PROCESS INSTANCE NAME

Returns:

This system variable returns the name of the current process instance.

SysVar Tag:

{PROCESS_NAME}







Contents 96

PROCESS INITIATOR

Returns:

This system variable returns information about the user that initiated this instance of a process.

SysVar Tag:

{PROCESS_INITIATOR}


This system variable can be formatted according to Optional Parameters available to user results.





Contents 97

PROCESS STATUS

Returns:

This system variable returns the status of the current process. This system variable can return “Completed”, “Running”, or

“Pending”. This system variable will return “Pending” when the process is unavailable or has never been run.

SysVar Tag:

{PROCESS_STATUS}







Contents 98

PROCESS PRIORITY

Returns:

This system variable returns the priority of the current process.

SysVar Tag:

{PROCESS_PRIORITY}







Contents 99

PROCESS START DATE

Returns:

This system variable returns the date this process instance started.

SysVar Tag:

{PROCESS_START_DATE}


This system variable’s result can be formatted as a date.





Contents 100

PROCESS STOP DATE

Returns:

This system variable returns the date the process instance ended.

SysVar Tag:

{PROCESS_STOP_DATE}


This system variable’s results can be formatted as a date.





Contents 101

TERMINATION REASON

Returns:

This system variable returns the reason a process instance terminated. You can use this system variable to handle unexpected

process errors.

SysVar Tag:

{PROCESS_TERM_REASON}







Contents 102

RUNNING USERS

Returns:

This system variable returns a comma-separated list of all users actively involved in the current process instance.

SysVar Tag:

{PROCESS_TASK_USERS_ACTIVE}


This system variable can be formatted using Optional Parameters available to user results.

IS SUB-PROCESS?Returns:

This system variable returns a Boolean (yes/no) value reflecting whether this process is a sub-process of another process.

SysVar Tag:

{IS_SUBPROCESS}







Contents 103

PROCESS ATTACHMENT GROUPReturns:

This system variable returns the name of the group used for an object attachment.

SysVar Tag:

{PROCESS_ATTACHMENT_GROUP}


This system variable has no Optional Parameters.

PROCESS DEFINITION NAMEReturns:

This system variable returns the name of the current process’ definition.

SysVar Tag:

{PROCESS_DEFINITION_NAME}



PROCESS IN ERRORReturns:

This system variable returns the name of a process’ task that’s in an error state.

SysVar Tag:

{PROCESS_IN_ERROR}



PROCESS INSTANCE IDReturns:

This system variable returns the ID of the current process.

SysVar Tag:

{PROCESS_INSTANCE_ID}



PROCESS MESSAGEReturns:

This system variable returns a process’ task’s message. If there is none, it returns the date the process started.

SysVar Tag:





Contents 104

{PROCESS_MESSAGE}



PROCESS TASK DUE DATEReturns:

This system variable returns the due date of the current task on this process.

SysVar Tag:

{PROCESS_TASK_DUE_DATE}


This system variable can be formatted as a datetime system variable.

PROCESS TASK START DATE

Returns:

This system variable returns the start date of the current task on this process.

SysVar Tag:

{PROCESS_TASK_START_DATE}


This system variable can be formatted according to the options available to datetime system variables.

PROCESS TASK RUNNING

Returns:

This system variable returns the name of the task that’s currently running.

SysVar Tag:

{PROCESS_TASK_RUNNING}



SUB TASK NAMEReturns:

This system variable returns the name of the sub task this process is running in.

SysVar Tag:

{SUB_TASK_NAME}







Contents 105

DATETIME SYSTEM VARIABLES

DATE

Returns:

This option allows the user to specify a datetime from a datetime picker. While not technically a system variable, information about

a date can be gathered via SysVar tags by referencing a date picker.

SysVar Tag:

{FORM:someDateTimePicker}


The result of this form field SysVar tag can be formatted according to the options available for form field SysVar tags.

CURRENT DATE

Returns:

This system variable returns the date at the moment this system variable is being referenced.

SysVar Tag:

{CURR_DATE}

{CURR_DATETIME} (for the time as well)





Contents 106

{CURR_TIME} (for just the time)

{CURR_[YEAR|MONTH|DAY|HOUR|MINUTE]} (for just that component)



DAYS AGO

Returns:

This system variable returns a date a specific number of days before the date that this system variable is referenced.

SysVar Tag:

{CURR_DATE, days=-[number of days ago]}



DAYS FROM NOW

Returns:

This system variable returns a date a specific number of days after the date that this system variable is referenced.

SysVar Tag:

{CURR_DATE, days=-[number of days from now]}


This system variable can be formatted as a datetime system variable.





Contents 107







Contents 109

EMAIL SYSTEM VARIABLES

EMAIL URLReturns:

This system variable returns the URL of the task the email links to. This system variable can be put in link HTML tags.

SysVar Tag:

{EMAIL_URL}


CompletePage: the full URL of the page to navigate to after the task is completed.

CompletePagePrompt: set to 0 to prevent a confirmation prompt from displaying

CompleteText: text to display after the task is completed

NoHome: set to 1 to prevent the home page from displaying when the task link is clicked.

EMAIL USERReturns:

This system variable returns the user the task is assigned to.

SysVar Tag:

{EMAIL_USER}


This system variable can be formatted as a user system variable.

EMAIL EXTERNAL USERReturns:

This system variable returns a Boolean value reflecting whether the user being emailed is an external user or not.

SysVar Tag:

{EMAIL_EXT_USER}


This system variable doesn’t have optional parameters.

EMAIL FORM INSTANCE URLReturns:

This system variable returns the URL to the form instance or process activity that sent this email.

SysVar Tag:

{EMAIL_FORM_INSTANCE_URL}





Contents 110


CompletePage: the full URL of the page to navigate to after the task is completed.

CompletePagePrompt: set to 0 to prevent a confirmation prompt from displaying

CompleteText: text to display after the task is completed

NoHome: set to 1 to prevent the home page from displaying when the task link is clicked.

EMAIL TASK IDReturns:

Replaced with a tag indicating the task list used to send this email.

SysVar Tag:

{EMAIL_TASK_ID}


There are no optional parameters for this system variable.

EMAIL COMPLETE URLReturns:

This system variable returns the URL of the page to automatically complete the task.

SysVar Tag:

{EMAIL_COMPLETE_URL}


Action: the name of the task to complete. If unspecified, the user will be given a dropdown of the tasks to complete.

Confirm: if set to 1, a web page will be shown prompting the user to confirm that he wants to complete the task.

Comments: if set to 1, a text box will appear allowing the user to enter comments

EMAIL RESULT LINKSReturns:

This system variable returns a list of the URLs of the branches or activity results from the task that sent this email.

SysVar Tag:

{EMAIL_RESULT_LINKS}


Separator: specifies a character to separate each link

Confirm: if set to 1, prompts a user to confirm that he wants to take this branch.

Comments: if set to 1, a text box appears allowing the user to enter comments.

Icon: determines if the link returned links to an icon (if set to 1) or the branch or activity result (if set to 0)

EMAIL RESULT LISTReturns:





Contents 111

This variable returns a list of the potential branches or activity results from this task.

SysVar Tag:

{EMAIL_RESULT_LIST}


The user can specify a character to separate each result in the list.







Contents 113

OTHER SYSTEM VARIABLES

CALCReturns:

This system variable returns the numerical result of a mathematical formula. Both constants and system variables can be used in the

formula.

SysVar Tag:

{CALC Formula=[some formula]}



CURRENT USER GROUPSReturns:

This system variable returns a comma-separated list of the groups the current user belongs to.

SysVar Tag:

{CURR_USER_GROUPS, format=[ID|String]}


This system variable can be formatted as either an ID or String.

CUSTOM VARIABLEReturns:

This system variable returns the value of a specified variable defined in the vars.cs.ascx file.

SysVar Tag:

{CustomVar:someVariableName}



DATE DIFFERENCEReturns:

This system variable returns the difference between two datetimes.

SysVar Tag:

{DATEDIFF DATE1=[first date] DATE2=[second date]TYPE=[YEARS|MONTHS|DAYS|MINUTES|SECONDS|BUSINESS_DAYS|BUSINESS_HOURS}






Contents 114

Using the Type= parameter, this system variable can return the difference in years, months, days, minutes, seconds business days, or

business hours.

DEBUG_MODEReturns:

This system variable returns a Boolean (yes/no) value reflecting whether debug mode is current on or off.

SysVar Tag:

{DEBUG_MODE}



INTERFACE URLReturns:

This system variable returns the URL of the interface of the system configurations.SysVar Tag:

{INTERFACE_URL}



KNOWLEDGE VIEW DEFINITION NAMEReturns:

This system variable returns the name of a knowledge view definition.SysVar Tag:

{KV_DEF_NAME}



KNOWLEDGE VIEW NUMBER OF ROWSReturns:

This system variable returns the number of rows in a knowledge view instance.

SysVar Tag:

{KV_NUM_ROWS}







Contents 115

KNOWLEDGE VIEW FILTER DATAReturns:

This system variable returns a string representing the filters used in the knowledge view.

SysVar Tag:

{KV_FILTER_DATA}



LOGO URLReturns:

This system variable returns the URL of the system logo image.

SysVar Tag:

{LOGO_URL}


There are no Optional Parameters for this system variable.

ROW NEXTReturns:

The Row Next system variable returns the number of the next row in an array.

SysVar Tag:

{ROW_NEXT}


This system variable does not have Optional Parameters

ROW NUMReturns:

The Row Num system variable returns the number of the array row containing this system variable.

SysVar Tag:

{ROW_NUM}

Optional Parameters:This system variable does not have Optional Parameters.

ROW PREVReturns:

The Row Prev system variable returns the number of the previous row in an array.





Contents 116

SysVar Tag:

{ROW_PREV}



SERVER CULTUREReturns:

This system variable returns the server’s configured culture.

SysVar Tag:

{SERVER_CULTURE, format=[name]}


If the format=name option is used, this system variable returns the culture name. Otherwise, it returns the culture code.

SERVER NAMEReturns:

This system variable returns the name of the server.

SysVar Tag:

{SERVER_NAME}



SERVER VERSIONThis system variable returns the server’s version.

SysVar Tag:

{SERVER_VERSION, format=[string]}


Using the format=String Optional Parameters returns a string containing the server’s version. Otherwise, this system variable returns

the version number.

SESSIONReturns:

The session system variable returns the session variable for the current user.

SysVar Tag:

{SESSION}







Contents 117

SEQUEL PERMISSIONReturns:

This system variable returns information about a permission. It can be used to verify that a user has a certain permission for a

certain object. The ID of the relevant object is passed via the ID parameter, the User ID of the user is passed through the UserID

parameter, and the type of permission being queried is passed through the PermType parameter.

SysVar Tag:

{SQL_PERM, ID=[object ID], UserID=[User’s User ID], PermType=[VIEW|MODIFY|DELETE|RUN]}



SEQUENCE NUMBERReturns:

This system variable returns a value that increments every time the system variable is referenced.

SysVar Tag:{SEQ_NUM}


This system variable can be formatted using the Digits= parameter. You can specify the number of digits that this number should

display with.

STRINGReturns:

The String system variable returns the value of a localized string in the relevant resource file. The localized string is referenced by its

name in the resource file.

SysVar Tag:

{STRING:string_name, type=[Internal|Custom]}


This system variable has a formatting option called “type”. This can be set either to “internal” or “custom”. If set to “internal”, the

string will reference a Process Director-defined string, whereas when type is set to “custom”, it will reference a string defined by the

user in a resource file.





Contents 118

STRING (Right-Hand Side Menu)

Returns:

This option will allow the user to specify a string to be used in a comparison. It is not technically a system variable.

SUMReturns:

This system variable returns the numerical sum of all the fields in a column of an array.

SysVar Tag:

{SUM, Columns=[name of field in an array]}






1

Contents 119






1

Contents 121

INDEX

A

ACTIVE ACTIVITY USERS 77

ACTIVE STEP USERS 52

ACTIVITY AVERAGE RUN TIME 90

ACTIVITY DESCRIPTION 91

ACTIVITY DUE DATE 81

ACTIVITY IN ERROR 91

ACTIVITY MESSAGE 91

ACTIVITY REACHED 84

ACTIVITY RESULT 91

ACTIVITY RUN TIME 92

ACTIVITY START DATE 79

ACTIVITY START DATE – PREDICTED 85ACTIVITY STATUS 92

ACTIVITY STOP DATE 80

ACTIVITY STOP DATE - PREDICTED 86

ACTIVITY TERMINATION REASON 92

ACTIVITY TOP RUNNING NAME 92

ACTIVITY USERS 78

ACTIVITY USERS COMPLETE 93

All System Variables 5

ALL USERS 39

ATTRIBUTE 20

B

BRANCH TAKEN 57Business Rule System Variables 65

BUSINESS RULES 65

C

CALC 113

CATEGORY 19

COMPLETED ACTIVITY USERS 90

COMPLETED STEP USERS 59

CONVERTING TO PDF 13

CREATE DATE 26

CREATE USER 24

CURRENT DATE 105

CURRENT USER 63CURRENT USER GROUPS 113

CUSTOM VARIABLE 113

D

DATE 105

DATE DIFFERENCE 113

DateTime System Variables 105

Datetime System Variables: 3

DAYS AGO 106

DAYS FROM NOW 106

DEBUG_MODE 114

DESCRIPTION 22

DOCUMENT TEXT 29

E EMAIL COMPLETE URL 110

EMAIL EXTERNAL USER 109

EMAIL FORM INSTANCE URL 109

EMAIL RESULT LINKS 110

EMAIL RESULT LIST 110

Email System Variables 109

EMAIL TASK ID 110

EMAIL URL 109

EMAIL USER 109

Encode Types 5

F

FOLDER PATH 29

FORM ATTACHMENT GROUP 17

FORM ATTACHMENTS 16

FORM EVENT NAME 15

FORM EVENT TYPE 14

FORM FIELD 7

Form Field System Variables 2

FORM INSTANCE ID 16

FORM PRINTING 12

FORM SUBMITTER 9

Form System Variables 7

G

GROUP 64

Group Parameter 5

I

IN RUNNING TASK? 48

INTERFACE URL 114

IS ACTIVITY PAST DUE? 82

IS ON MOBILE DEVICE? 16

IS PREDICTED TO END LATE? 88

IS PREDICTED TO START LATE? 87

IS STEP PAST DUE? 56

IS SUB-PROCESS? 102

K

KNOWLEDGE VIEW DEFINITION NAME 114

KNOWLEDGE VIEW FILTER DATA 115

KNOWLEDGE VIEW NUMBER OF ROWS 114

L

LOGO URL 115




1

Contents 122

M

Meta Data System Variables 19

N

NAME 21

NEW FORM INSTANCE 8NUM FORM ATTACHMENTS 11

NUM TIMELINE ATTACHMENTS 69

NUM TIMES ACTIVITY RUN 89

NUM TIMES STEP RUN 55

NUM WORKFLOW ATTACHMENTS 32

O

OBJECT ID 29

Object Information System Variables 21

OBJECT TYPE 30

Other System Variables 113

P

Pre, Post, and Null 6

PRIORITY 31, 71

PROCESS ATTACHMENT GROUP 103

PROCESS DEFINITION NAME 103

PROCESS IN ERROR 103

PROCESS INITIATOR 96

PROCESS INSTANCE ID 103

PROCESS INSTANCE NAME 95

PROCESS MESSAGE 103

PROCESS PRIORITY 98

PROCESS START DATE 99

PROCESS STATUS 97

PROCESS STOP DATE 100Process System Variables 95

PROCESS TASK DUE DATE 104

PROCESS TASK RUNNING 104

PROCESS TASK START DATE Returns: 104

R

ROW NEXT 115

ROW NUM 115

ROW PREV 115

RUNNING ACTIVITY NAME 83

RUNNING STEP 51

RUNNING USERS 102

S

SEQUEL PERMISSION 117

SEQUENCE NUMBER 117

SERVER CULTURE 116

SERVER NAME 116

SERVER VERSION 116

SESSION 116

SIZE 23

STEP DESCRIPTION 59

STEP DUE DATE 50

STEP IN ERROR 60

STEP INSTANCE ID 60

STEP MESSAGE 60

STEP REACHED 58

STEP RESULT 60STEP RESULT COUNT 60

STEP RUN TIME 61

STEP START DATE 53

STEP STATUS 61

STEP STOP DATE 54

STEP TERMINATION REASON 61

STEP USERS 49

STRING 117

STRING (Right-Hand Side Menu) 118

SUB TASK NAME 47, 104

SUBMIT DATE 10

SUM 118

System Variable Parameters 2

T

TASK ASSIGN DATE 42

TASK DUE DATE 44

TASK INSTRUCTIONS 43

TASK NAME 41

TASK ON BEHALF OF 46

TASK PRIORITY 45

Task System Variables 41

TERMINATION REASON 38, 74, 101

Timeline Activity System Variables 77

TIMELINE ATTACHMENT GROUP 76

TIMELINE ATTACHMENTS 75

TIMELINE AVERAGE RUN TIME 74

TIMELINE CONFIGURED STOP DATE 76

TIMELINE DEFINITION NAME 76

TIMELINE INITIATOR 67

TIMELINE INSTANCE NAME 70

TIMELINE START DATE 72

TIMELINE STATUS 68

TIMELINE STOP DATE 73

TIMELINE STOP DATE – PREDICTED 75

Timeline System Variables 67

U

UPDATE DATE 27UPDATE USER 25

USER 63

User System Variables 2, 63

V

VERSION 28




1

W

WORKFLOW ATTACHMENT GROUP 39

WORKFLOW ATTACHMENTS 39

WORKFLOW DEFINITION NAME 40

WORKFLOW INITIATOR 33

WORKFLOW INSTANCE NAME 34

WORKFLOW NAME 40WORKFLOW RUN TIME 40

WORKFLOW START DATE 36

WORKFLOW STATUS 35

Workflow Step System Variables 49

WORKFLOW STOP DATE 37

Workflow System Variables 31

Date post:	17-Feb-2018
Category:	Documents
Upload:	maahiijain
View:	216 times
Download:	0 times

System Variables Reference Guide

Documents