Arguments Library

Help Page > Workflow Designer > Arguments Library

About the DocStar Arguments

DocStar’s Workflow Designer uses arguments to create input and output tasks and branches. Arguments define how you want the system to behave during a specific decision point. For example, if a payable is over the accepted maximum value, you can indicate who is allowed to approve it.

Use these arguments to address a wide range of functions relating to branching, approvals, and advanced workflow requirements. You can determine if you want the properties to have read and write functionality. In addition, you can limit the input to be strictly numeric, such as an amount or price, or allow different data types, such as dates, text, user names, groups, and document or package properties.

Argument Types

DocStar uses several argument types for the workflow designer:

Argument Type Description
Parameters Values created by the workflow designer to store the results of one or more tasks or to use as a subsequent task. These named parameters can be read or written and be multi-valued, if needed. This means a single parameter can represent a single value or a collection of values.

Note: Parameter names must being with a letter or an underscore, but can be alphanumeric and contain a slash (/) or dash (-).

Document/Package Properties Used to inherit properties of a document or package. These properties must begin with a dollar sign ($) and can be read-only or read/write values.
Fields User-defined fields which may be part of a field group. These must begin with a dollar sign.field ($Field) and can be multi-valued.
Numeric Literals Integer or decimal numbers. These are read-only values.
String Literals Text enclosed in matching single quotes or double quotes. These are read-only values.
System Properties Arguments for the system level. This means that they do not have a user acting upon them, but the value determined by the task or subtask assigned.

Currently, these properties only include $CurrentUser, $Today, $Tomorrow, and $Now. These are read-only values.

Folder Used to determine which folder or folders documents are in. This parameter must begin with $Folder and are read-only values.

About the Arguments Library

DocStar provides an arguments library that displays for any workflow task. The library houses all system or document-level parameters, as well as any custom field or parameters you define during the workflow design.

Note: When you create a custom argument, it is only available for that particular workflow. If you want the parameter available for other workflows or documents, create a field instead.

Arguments Library

The following tables list each available, standard argument in DocStar ECM indicating its properties, listing the description, and the associated modules to which they can be applied.

Arguments are listing in alphabetical order and are the standard arguments that can be used. However, the following cases may apply:

  1. Certain arguments only apply to document type entities while other only function on Form or Document packages. Use the Entity Used In column to determine which arguments apply to Document, Form, and/or Package entities.
  2. Arguments that require a specific module are noted. They do not display in the Workflow Designer unless you have purchased those companion products. Contact your DocStar representative for more information.

Note: Forms, ReportWorks and PackageWorks are add-on modules for DocStar ECM. Talk to your DocStar representative for more information about these options.

Argument Name Description / Conditions Read Write Data Type Module Requirements Entity Used In
$AccessedOn Provides the date and time when the document was last opened. X   Date/Time None Any
$ApprovalCount The number of approvals currently on the document. X   Numeric None Any
$ApprovalsRequired The number of approvals required for the document to be considered approved.
The number of required approvals can be varied based on other conditions, such as a dollar amount. You can use this output on a math or Replace task instead of using the “Approval Required” check box in the Request Approval task.
X X Numeric None Any
$AssignedOn The date and time when the document was last assigned to a user or group. X   Date/Time None Any
$Assignee The user or group to whom the document is currently assigned to do work. This value changes as the workflow moves through each task by a required action or step. X X Username or Group Name None Any
$Barcodes Retrieves barcode data during document capture, regardless of capture process: scan, import, or batch import.
This argument can be multi-valued.
X   Any None Document
$ContentType The document’s categorization defined as its content type, such as Invoice or Work Ticket.
You cannot create new content types from the workflow designer. Use Content Type Builder in the Admin tab to create new content types.
X X Content Type (text) None Document, Form
$CreatedOn The date and time when the document was scanned, imported, uploaded, or created in DocStar. X   Date/Time None Any
$CurrentUser The user name for the person interacting with the workflow when the workflow action is completed. X   Username None Any
This option helps when items are assigned to groups. When a specific user takes action on an item, you can use a Replace task to set the new assignee.
For example, set the Input to  $CurrentUser and the output to $Assignee to remove the task from the group’s queue and keep the original user focused on the task.
Custom Parameter Create custom parameters in your workflow library that you want available for all workflow designers. X X Any None Any
We recommend having a common prefix for all custom parameters so you can quickly identify them. You can use user initials to keep custom options together or prefix with Z to keep all custom options at the bottom of the library for easy reference.
For example, you can use zFolderPath if combining multiple inputs in and Advanced Format task to create a dynamic folder path to use as a singular input in an Add to Folder task.

$CutoffDate The manual date set by users for Records Management purposes. X X Date/Time None Document, Form
$DispositionDate The date on which the document is moved to the Recycle Bin or moved to a specified Record Categories folder. Used for Records Management. X   Date/Time None Document, Form
$DocumentFileExtention The original file extension of the uploaded file or the first file uploaded if there are more than one.
This is useful when determining branch conditions on a document. For example, if a document was sourced from a .docx (MS Word) document, then the workflow can go to Step A, but if the document was originally a .PDF, then the workflow goes to Step B.
X   File Extension None Document, Form
$DocumentID A system-assigned number for the document. This number is unique to the overall document regardless of the number of versions. The system tracks version numbers within this document ID. X   Numeric None Document, Form
$DocumentStatus Lets you create a message in a dialogue box that displays over the document viewer. You should clear this message when setting defaults on a workflow and after the message displayed has been addressed.
X X Any None Document, Form
$DocumentVersionID The system-assigned, unique identifier for the current version of the item or document. X   Numeric None Document, Form
$DueDate The date on which the task or action is due.

This date can be set manually by a user from the Actions menu, or through a workflow task. When the due date is reached, DocStar notifies the trigger/exception assignee specified in the Edit Workflow settings or an additional user specified using a Set Trigger task.

You can also display items in a workflow grid or color code items and tasks past their due dates.

X X Date/Time None Any
$Field.<FieldName> Use this $Field prefix when creating custom fields for your workflows. For example, you need a field for InvoiceNumber and one for InvoiceTotal. Format these as $Field.InvoiceNumber and $Field.InvoiceTotal. X X Any None Any
$Folder.<FolderName> Use the $Folder prefix when creating a single folder name or path in which documents are houses. When a document meets specific requirements during a workflow lifecycle, the system retrieves or houses the document in the specified folder. X   Folder Path None Document, Form
You may indicate a single folder name or a path separated with back slashes (\), ending with an asterisk (*) indicating a wildcard, or an asterisk only.
Examples include:

  • $Folder.* – Equals the path of all folder that contain this document.
  • $Folder.MyFavorite – MyFavorite is the document in the top-level folder or null if not.
  • $Folder.Customer\* – The path to all folders within the Customers folder that contain the document.
$Inbox Contains and can be used to set the Inbox of a document. X X Folder Path None Document, Form
$IsApproved Checks if the required number of approvals for the document is present. If there is at least one approval, even if none are required, and there are no denials, this option is set to true.
This option is helpful when specifying branch conditions.
X   True/False None Any
$IsArchived Checks if the document has already been archived. X   True/False PackageWorks Package
$IsDenied Checks if the document has been denied at any point in the workflow process.
This option is helpful when determining branch conditions.
X   True/False None Any
$IsDraft Checks if the current version of the document has not been published and therefore is considered a draft. X   True/False None Document, Form
$IsFormCompleted Checks form documents for a completed status and if the document has been archived as a .pdf through user action or the Complete Form task.
This option is helpful when specifying branch conditions.
X   True/False Forms Form
$IsUnsubmittedPublicForm Checks if the form document has been submitted. Useful at the beginning of a workflow for a public-facing form document.
You can use this as a branch condition, if a form has not been submitted.
X   True/False Forms Form
$Keywords Allows access to the Keywords field with a 64,000 character limit. X X Text None Any
$ModifiedOn The date and time when the item or its fields were modified last.X     Date/Time None Any
$Now The current date and time.
Useful in conjunction with $DueDate with a Math task and an Add Days operation.
X   Date/Time None Any
$PackageCount The number of packages in which the document is included. X   Numeric PackageWorks Document, Form
$PackageID The unique identifier (UID) of the package entity. X   Unique Identifier PackageWorks Package
$PackageIDs The unique identifier (UID) of the package in which the workflow item is included. X   Unique Identifier PackageWorks Document, Form
$PackageTitles The title of the package in which the workflow item is included. X   Text PackageWorks Document
$PackageTypeID The unique identifier (UID) for the package type. X   Unique Identifier PackageWorks Package
$PackageTypeIDs The unique identifier (UID) for the package types for all packages in which the document is included. X   Unique Identifier PackageWorks Document
$PackageTypeName The name of the package type for the workflow item included in the package. X   Text PackageWorks Package
$PackageTypeNames The name of the package types for all packages in which the document is included. This can be multi-valued. X   Text PackageWorks Document
$Priority Lets you set the priority of the workflow item.

You can use this sortable column when using the workflow queue to manage your work. Valid values: Low, Normal, High

X X Text: Low, Normal, High None Any
$Received Checks if the minimum number of required documents are present in all slots. X   True/False PackageWorks Package
$RecordCategory Use to set an item’s record category. A record category determines how the system to manage or handle to document, such as deletion or filing to a specific folder, after a set period of time. X X Text None Document, Form
$SecurityClass Use to set an item’s security class. A security class restricts the item to a specific set of users, such as sensitive documents for HR personnel or accounts payable groups. X X Text None Any
$Slot Used in conjunction with $Slot[SlotName], this reports on various properties of the package slot.

A slot is a container in which one or more documents that are held for action within an entire package. You can place minimum requirements on the documents. For example, you have a new employee for which you need to check references. You must have at least 3 of the 5 references called by a specific date. You add the document with the references to this slot with the requirements.

X   Any PackageWorks Package
$SlotDoc Used in conjunction with $Slot[SlotName], this reports on properties of a document in a package slot. This can be multi-valued because there can be multiple documents in a slot. X   Any PackageWorks Package
$SlotNames The name of all the package slots contained in the document. This can be multi-valued and return multiple names. X X Text PackageWorks Document, Form
$SlotsOverdue Checks if any slots are overdue. X   True/False PackageWorks Package
$SlotsReady Checks all slots in a package to make sure all items are ready. Useful when used as an input for the Wait For task. X   True/False PackageWorks Package
$StartPage Indicate if another document should be used as a start page when someone opens the document. This is useful when you need to insert a title page, legal disclaimer, or a table of contents for the material. X X Numeric None Document, Form
$StartedOn The date and time when the document was started in a workflow. The system considers any document that has been assigned to the workflow as started. This means, this date could be the same as the capture date or when the workflow has been explicitly assigned by a user; the date is not dependent on a user opening the document in the workflow. X   Date/Time None Any
$Text Commonly used for text (.txt) data created using optical character recognition (OCR), but may be used for text extracted from a PDF or other sources. When using $Text as an input, use square brackets to reference a particular page’s text such as $Text[1].  When used without brackets, it is multi-valued. X X Text None Document, Form
$Title Title of the item. X X Text None Any
$Today The current date.
Useful in conjunction with $DueDate with a Math task and an Add Days operation.
X   Date None Any
$Tomorrow The current date plus one day.
Useful in conjunction with $DueDate with a Math task and an Add Days operation.
X   Date None Any
$WFDocumentID A unique identifier for the workflow document version’s workflow state information. X   Unique Identifier None Any
$WorkflowID The identifier for the workflow. This is not unique to the document or package that undergoes this workflow. Use $WFDocumentID for a unique ID. X   Unique Identifier None Any
$WorkflowName Name of the workflow. X   Text None Any

$DefaultSite

The following argument is used only in instances where a DocStar ECM system is integrated with an Epicor ERP system:

Argument Name Description / Conditions Read Write Data Type Module Requirements Entity Used In
“<Use Default Site>” Implementations using an Epicor ERP integration use this argument to refer to multiple Epicor ERP sites.

This option should only be used with the @Site parameter for Epicor ERP DataLinks.

We recommend using a Site field for the best flexibility on your system.

X   Text None Document, Form, Package
 
DocStar ECM Help Center
© 2021 Epicor Software Corporation. All Rights Reserved.