Skip to main content
Mitratech Success Center

Timeline System Variables

System variables that return a Datetime value will have the universal formatting options specified in the Datetime section of the System Variable parameters topic. System variables that return a Timespan value will have the universal formatting options specified in the Timespan section of the System Variable parameters topic.

Num Timeline Attachments

image

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, ObjectType=Document|Form CSStatus=Pending|NotPending|Failed|Done|PendingOrFailed GroupName=group }

Optional Parameters

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

CSStatus: The CSStatus option is available with Concept Share integration. When a value is specified, the system variable will return only the number of documents matching that stated. If “Failed” is selected, this system variable will return the number of documents that failed to upload to Concept Share.

GroupName: The parameter limits this system variable such that it only returns the number of attachments in the specified group.

Priority

image

Returns - This system variable returns the priority of the running timeline.

SysVar Tag -{TIMELINE_PRIORITY}

Optional Parameters

This system variable does not have Optional Parameters.

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}

Optional Parameters

This system variable does not have Optional Parameters.

Timeline Attachment Group

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

SysVar Tag -{TIMELINE_ATTACHMENT_GROUP}

Optional Parameters

This system variable does not have Optional Parameters.

Timeline Attachments

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

SysVar Tag -{TIMELINE_ATTACHMENTS, ShowName = 1, ShowDesc = 0, ShowID = 0, GroupName=group}

Optional Parameters

GroupName: The results returned can be filtered by group using the Groupname= option. The GroupName parameter limits this system variable such that it only returns a list of attachments in the specified group.

ShowName: The option is set to 1 by default. When set to 1, it will display the name of the attachment.

ShowDesc: The option is set to 0 by default. If set to 1, it will display the attachment’s description.

ShowID: The option is set to 0 by default. If set t 1, it will display the object’s internal ID. If each is set to 1, each attachment will be returned in the format “name : description, name : description, name : description”…

Timeline Attachment Size

Returns - This system variable returns the cumulative size of all documents attached to this Timeline.

SysVar Tag -{TIMELINE_ATTACHMENT_SIZE}

Optional Parameters

GroupName: The parameter can be used to have this system variable return the cumulative size of documents only in the specified group.

Timeline Average Run Time

image

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

SysVar Tag -{TIMELINE_AVG_RUN_TIME}

Optional Parameters

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

Timeline Configured Stop Date

Returns - 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}

Optional Parameters

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

Timeline Definition Name

image

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

SysVar Tag -{TIMELINE_DEF_NAME}

Optional Parameters

This system variable has no optional parameters.

Timeline Initiator

image

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.

Timeline Run Time

Returns - This system variable returns the amount of time the current Timeline has been running, or the amount of time it took to run if the Timeline completed.

SysVar Tag - {TIMELINE_RUN_TIME}

Optional Parameters

This system variable is a Timespan system variable and can be formatted according to standard Timespan formatting options.

Timeline Status

image

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}

Optional Parameters

This system variable does not have Optional Parameters.

Timeline Start Date

image

Returns - This system variable returns the date this timeline instance started.

SysVar Tag -{TIMELINE_START_DATE}

Optional Parameters

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

Timeline Stop Date

image

Returns - This system variable returns the date this timeline instance stopped.

SysVar Tag -{TIMELINE_STOP_DATE}

Optional Parameters

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

Timeline Stop Date – Predicted

image

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

SysVar Tag -{TIMELINE_STOP_PREDICTED}

Optional Parameters

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

Timeline Users All

Returns - This system variable returns all users that have participated in the current Process Timeline instance.

SysVar Tag -{TIMELINE_USERS_ALL}

Optional Parameters

This system variable does not have Optional Parameters.

Timeline Users Complete

Returns - This system variable returns all users that have completed their tasks with a "normal" completion code.

SysVar Tag -{TIMELINE_USERS_COMPLETE}

Optional Parameters

There are no optional parameters for this system variable.

  • Was this article helpful?