Skip to main content
Mitratech Success Center

Permissions

Permissions control who has access to different objects (document, eForm, folder, etc.) in the Process Director database. Sometimes referred to as Access Control Lists (ACLs), permissions provide the foundation for the securing of objects in the database.

They control who can perform what functions on which objects.

Permissions can also be used to provide a simpler interface to end-users, hiding the more advanced functionality from them.

For folders in the Content List, you will find the link to the permissions configuration window near the top of the content list, once you’ve clicked on the folder you want to set permissions for.

image

In addition, permissions can also be accessed from inside any Content List object by selecting "Permissions" from the dropdown menu associated with the menu arrow icon ( image ) located in the upper right portion of the Process Director screen, as shown below.

image

Permission List

Any object in the Process Director database may contain a list of permission rules that determine who can access the object and what function they can perform against it. A permission rule can either grant or deny a user or group of users' access. The lack of a matching permission rule granting a user access, will deny access to the object. If there are conflicting rules which either grant or deny a user access, the user will be denied. When the server attempts to determine whether a user has access to an object in the database, it will search through the objects entire permission list until it finds a permission rule that grants the user the requested access, or until the end of the list. A user is granted the highest level of permission found for them in the permission list.

Different object types in the database have different permissions and options available to them. Objects that can be run (e.g. workflow definition, eForm definition) will have more permissions options available to them, as will objects that can have children objects (e.g. folders, eForm definitions, etc.).

image

User Permission Types

Permissions are granted to a user. A permission record gives permission to something for a specific object in the Process Director database. Different types of user permissions can be granted.

Authenticated Users

An authenticated user is anyone who performs a login to access the system. Authenticated users have an identity (i.e. User ID) and exist in the Process Director database. They may be authenticated by Process Director, your Windows Domain, an LDAP server, or an external application.

Specific User

This identifies a specific authenticated user by name. All users known to Process Director have a User ID that is used to login. They may also have an optional display name or Alias. If an Alias exists for a user, that name is used to identify the user on all Process Director screens. If a user appears multiple times in a permission list, they will be granted access according to the highest level of permission listed.

Specific Group

A group is a collection of users in the Process Director database. A user can belong to multiple groups. Only authenticated users can belong to a group. When access to an object is being determined by the server, it will give the user the highest level of permission found in any specific user record or any group the user is a member of.

Anonymous Users

Anonymous users are not authenticated. They do not perform a login and they have no identity in the Process Director database. Only certain functions and objects are available to anonymous users. If an “anonymous” permission is given to an object, authenticated users will automatically be given that same permission.

Object Creator

This is a special permission type only available to objects that can have children (i.e. folders, workflow definitions, eForm definitions). This will automatically give the permissions specified to the author/creator of any child objects that are created. For example, if a user starts a workflow definition that gives the Object Creator a permission of Modify; that will automatically be converted to the initiator users ID with Modify permission for that specific workflow instance the user is creating (starting).

Object Permission Types

Setting the permissions for a folder does not automatically set the permissions for the objects contained within it. You have the ability to replicate all permissions of the parent folder to all of the child objects in the folder.

You have two options for doing so.

First, you can Replicate permissions to all child objects, which will not only overwrite the existing permissions on definition objects, it will also overwrite permissions on all of the form and process instances—including those instances that are active and in-progress. This may completely change the ability of users to complete active workflow or form instances, so you should exercise caution in using this option in the production environment.

You also have the option, though, to replicate the permissions to child all child objects except for form, workflow, and timeline instances. This is probably the preferred option for replicating folder permissions in the production environment where there are active processes running. Future process and form instances will be created under the new permissions regime, but existing instances will still run under the permissions regime that was valid when they were created.

image

View

This permission gives a user read access to the folder. This does not grant the ability to modify the folder name or description. If a user only has View permission to a folder they will not be able to create any new objects below this folder.

Modify

This permission gives a user the ability to modify a folder, but not delete. A user with this permission to a folder can create new objects beneath this folder. A user must have Modify permission to view or set the permissions for the folder.

Delete

This permission allows a user to delete a folder. However, to delete a folder, the user must have Delete permission to all objects and sub-folders under this folder. If any object exists below this folder that the user does not have Delete permission to, the delete operation will be cancelled and none of the objects will be deleted. A user must have Delete permission to be able to grant Delete permission to another user.

Document Permission Types

View

This permission gives a user the ability to view, read or download a document. This permission does not grant the ability to modify the document.

Modify

This permission gives a user the ability to modify the document. The document modifications will appear in the document history. A user must have Modify permission to view or set the permissions for a document.

Delete

This permission gives a user full control over a document. A user with this permission can delete the document. Delete permission is required for a user to perform a rollback to an older version of a document, or to delete any portion of the document history. A user must have Delete permission to be able to grant Delete permission to another user.

Workflow Permission Types

Permissions are defined for a workflow definition. When the workflow definition is run, a child is created as an instantiation of the workflow definition. This “running” workflow is located beneath the workflow definition in the content list. This instantiated, running workflow will inherit the Child Permission settings from the workflow definition.

View

This permission gives a user the ability to view a workflow definition in the content list. It does not grant the ability to run or modify the workflow definition, and does not grant any permission to the running workflows instantiated from this definition.

Modify

This permission gives a user the ability to modify a workflow definition in the content list. It does not grant the ability to run a workflow definition, and does not grant any permission to the running workflows instantiated from this definition. A user must have Modify permission to view or set the permissions for a workflow definition.

Delete

This permission gives a user the ability to delete a workflow definition. This will also delete all running and completed workflows beneath this workflow definition in the content list. A user must have Delete permission to be able to grant Delete permission to another user.

Run

This permission allows a user to run or start this workflow definition. If a user does not have Run permission to a workflow definition, it will not be displayed on their home page or when they select the Start Workflow hotlink in the content list after selecting an object.

View Children

This permission gives a user the ability to view the children of a workflow definition (e.g. running workflows). When a workflow is started, the running workflow will copy all of the View Children permission rules as View permissions. If a user is granted View Children permission on the workflow definition, they will be able to see all running and completed workflows instantiated from the workflow definition. They will also be able to see the workflow definition in the content list to enable the navigation to the running and completed workflow children. Users will not be view the actual workflow definition properties without View permission.

Modify Children

This permission gives a user the ability to modify the children of a workflow definition (e.g. running workflows). When a workflow is started, the running workflow will copy all of the Modify Children permission rules as Modify permissions. If a user is granted Modify Children permission on the workflow definition, they will be able to modify running workflows instantiated from the workflow definition. This gives the user administrative control over the running workflow (e.g. add user, remove user, skip step, restart step, etc.).

Delete Children

This permission gives a user the ability to delete the children of a workflow definition (e.g. running workflows). When a workflow is started, the running workflow will copy all of the Delete Children permission rules as Delete permissions. A user must have Delete permission to be able to grant Delete permission to another user.

EForm Permission Types

Permissions are defined for an eForm definition. When an eForm is filled out and submitted, a child object is created as an instantiation of the completed eForm. This completed form is located beneath the eForm definition in the content list. Completed forms will inherit the Child Permissions from the eForm definition.

View

This permission gives a user the ability to view an eForm definition in the content list. It does not grant the ability to run or modify the eForm definition, and does not grant any permission to the completed forms from this eForm definition.

Modify

This permission gives a user the ability to modify an eForm definition in the content list. It does not grant the ability to fill out and submit an eForm, and does not grant any permission to the completed forms. A user must have Modify permission to view or set the permissions for an eForm definition.

Delete

This permission gives a user the ability to delete an eForm definition. This will also delete all completed forms beneath this eForm definition in the content list. A user must have Delete permission to be able to grant Delete permission to another user.

Run

This permission allows a user to fill out and submit this eForm definition. If a user does not have Run permission to an eForm definition, it will not be displayed on their home page and they will not be able to open it in the content list.

View Children

This permission gives a user the ability to view the children of an eForm definition (e.g. completed forms). When an eForm is submitted, the completed form data creates an entry in the content list and copies all of the View Children permission rules as View permissions. If a user is granted View Children permission on the eForm definition, they will be able to see the completed forms for this eForm definition. They will also be able to see the eForm definition in the content list to enable the navigation to the completed form children. Users will not be able to view the actual eForm definition properties without View permission.

Modify Children

This permission gives a user the ability to modify the children of an eForm definition (e.g. completed forms). When an eForm is submitted, the completed form will copy all of the Modify Children permission rules as Modify permissions. If a user is granted Modify Children permission on the eForm definition, they will be able to modify the completed forms under this eForm definition.

Delete Children

This permission gives a user the ability to delete the children of an eForm definition (e.g. completed forms). When an eForm is submitted, the completed form will copy all of the Delete Children permission rules as Delete permissions. A user must have Delete permission to be able to grant Delete permission to another user.

Knowledge View Permission Types

Knowledge Views display objects contained in the Process Director database. Authenticated and anonymous users can be given access to the objects displayed in a knowledge view. A user must have at least View permission to an object for it to be displayed in the Knowledge View.

View

This permission gives a user the ability to see the Knowledge View definition in the content list. This permission does not grant the ability to run the Knowledge View.

Modify

This permission gives a user the ability to modify the Knowledge View definition in the content list. A user must have Modify permission to view or set the permissions for a Knowledge View.

Delete

This permission allows a user to delete a Knowledge View definition. A user must have Delete permission to be able to grant Delete permission to another user.

Run

This permission is required for a user to be able to run the Knowledge View. If a user does not have Run permission to a Knowledge View definition, it will not be displayed on the user’s home page or when they select the Knowledge navigation button.

Category Permission Types

The category permissions are set in the category schema. To view the category schema use the Administration navigation button and select Meta Data Administration.

View

This permission allows a user to view the category in the category schema. If a user does not have View permission to a category they will not see this category name in the schema definition.

Modify

This permission allows a user to view and modify the category in the category schema. It allows the user to add sub-categories below this category. A user must have Modify permission to view or set the permissions for a category.

Delete

This permission allows a user to delete the category in the category schema. It also allows the user to delete any sub-categories below this category. A user must have Delete permission to be able to grant Delete permission to another user.

Run

This permission is required for a user to be able to assign the category to an object in the database.

Default Permissions for New Objects

Any time a new object (e.g. document, Review Set, sub-folder) is added to a folder it will be given the same permissions as the parent folder. If an object is added to the top-most folder (i.e. “<top>”) it will be given the same permissions specified in the default Folder Permissions hotlink. If an object is copied or moved to a folder, it will keep its original permissions.

Administrators

Any user that is checked as the “System Administrator” is given full administrative privileges. A user that is a System Administrator has full permission (View, Modify, and Delete) to all objects in the Process Director database.

Adding/Removing Permissions

Permission records can be modified for an object by selecting the Permissions button. Each permission record has to be removed or added individually. Existing permission records cannot be modified, they must be removed and a new record added. To remove a permission record, click on the checkbox for that entry and select the Delete hotlink. To add a new permission record, select the type of user, the type of permission and click on the “Add New Permission” button. You cannot delete a permission record that would eliminate Write permission for yourself; the system will return an error message. If this occurs, add a new permission record granting your User ID Write permission, then delete the other permission record.

Meta Data

Categorization is key component to the Knowledge Management (KM) features in the Workflow Server. KM has been defined as the collection of processes or information that governs the creation, dissemination, and utilization of knowledge.

At the core of Process Director is a management system that contains documents, eForms, images, web pages and scanned image – all of your digital content. This content can be organized by Process Timeline, user, department, or any other approach. Process Director allows this content to be categorized. A classification mechanism provides a powerful, consistent way to categorize content according to how your organization wants to make information available to your community of users.

Category Tree / Schema

The first step, and the most important, in classifying your content is to define your category schema (i.e. taxonomy). This schema defines a hierarchical tree structure of categories. Each category can have any number of attributes which allow custom information to be associated with the category when it is assigned to an object in the Process Director database. This tree is the foundation for categorizing (or “tagging”) objects and defines how information is organized, processed and distributed. The category tree, or any branch within the tree, should represent how you want data organized in your enterprise.

Categories

You must have access to the Meta Data Admin button. You can add the button to your workspace if it’s not already available to you. Select the Meta Data Admin entry in the top navigation bar.

This will display the Meta Data administrative functions available to you. Ensure that you select the partition you are working on and click on the Meta Data Administration link. This displays the complete category tree. Click on the “+” (plus sign) to expand a branch of the tree. The sub-categories allow a more granular level of classification. To modify, delete or create a sub-category, select the category in the tree and choose the appropriate hotlink.

If a user assigns a sub-category to an object, the object will also inherit all of the parent categories. For example, in the image below, the category Policies contains the categories Corporate, CSR, HR, and IT. If a user assigns an object to the category Corporate, the object will also be assigned to Policies because the category Corporate is a sub-category of Policies.

image

Category Attributes

While viewing the category tree, click on a category name to display or modify the attributes. Any category or sub-category may contain attributes. Attributes allow custom user data to be associated with a category.

Attributes have a name and a type. The attribute types include Text, Number, Yes/No, Currency, and Date fields. The attribute type defines how the information is stored and is used for conditional processing inside a workflow or a Knowledge View (e.g. less than and greater than comparisons, contains certain text, etc.).

If a user assigns a category to an object, the attributes allow custom data to be associated with the object. For example, in the image below, the category HR has attributes named Compliance-Related and Policy Num. If a user assigns an object to the category of HR, they will be presented with these attributes and can input custom data according to the type of attribute (Text, Number, Yes/No, Currency, Date).

image

Adding / Removing Attributes

To add a new attribute under a category, fill in the Attribute Name, select the type from the dropdown, and press the “Add New Attribute” button. This will add the attribute to the list above. To remove an attribute click on the image icon next to the attribute name. Be careful when removing attributes because it will remove all values in the database where this category is assigned to an object.

How Objects are Categorized

Various types of content exist within Process Director and are generically referred to as objects. Business users have an easy method to categorize these objects in the Process Director database when they are created or updated. When a user adds or modifies an object in the database, content categorization data can be selected, causing the item to be automatically associated with the appropriate end-user classifications.

This categorization can occur manually, automatically, and/or programmatically.

User Assignment

Categories can be assigned by any user with Modify permission to an object. This is done through the Meta Data button on the objects property pages. As categories are assigned to an object, the associated category attributes are displayed with an input field allowing variable data to be entered.

image

Folder Categorization

Categories and attributes can be set in a folder’s properties. This will automatically categorize any new object that is created directly beneath that folder. When categories are inherited from the parent folder settings, this will not replace or overwrite the existing categories of an object or folder below, instead the categories will be added to the existing category assignments. Additionally, if an object below already has the same category attributes as the parent folder, the attributes will not be overwritten by the parent folder settings.

Folder categories can also be replicated to all children objects contained below the folder. There are two replication options available as hotlinks on the folders property page:

Add Meta Data to All Child Items – This will add the folders categories and attributes to all objects below this folder. It will not overwrite any existing categories or attributes already assigned to those objects.

Replace Meta Data for All Child Items – This will remove the categories and attributes for all objects beneath this folder and replace them with the folders settings.

Both of these replication settings will only apply to objects beneath the folder that the user has Modify permission to.

image

Workflow Definition / eForm Definition Categorization

Workflow Definitions and eForm Definitions also have the ability to apply Meta Data to the items beneath them (i.e. children). New workflow instances and eForm instances will inherit the Meta Data from their parent definition. Meta data can be applied to all child items for a workflow definition or eForm definition. When this is performed on a workflow definition, it will set the Meta Data for all workflow instances AND all items contained within those workflow packages.

Inheriting Workflow Meta Data

Objects that are added to a running workflow instance will inherit the workflow categories and attributes. This will occur only if an object is contained within the workflow, for example with an eForm Actions workflow task. If a workflow is run against an object in the Content List (e.g. document), it will not inherit the workflow Meta Data.

From A Template

Categories and attributes can be assigned to an object template (document, eForm). If that template is specified in an eForm Actions workflow task, the associated category settings for the template will be used for the new object that is created. The user participating in the eForm Actions step can optionally modify the category settings, if they have Modify permission to the object in the workflow. To allow a user that does not have Modify permission to ability to set categories, they must be assigned to a Meta Data workflow task.

Programmatically

Categories and attributes can be assigned to an object programmatically through Process Director API’s.

External Properties

Categories can be assigned to an object using information from an external source. The product can automatically set categories using information from the following external sources:

Categories and attributes can be set based on form field values on an eForm; Document imaging/scanning solutions that index scanned documents.

Document importing with associated Meta Data xml files. Refer to the section named Importing Documents from a File System in this document.

Importing / Exporting Categories & Attributes

When items in the Content List are exported, they will automatically export any category or attribute definitions that are referenced (e.g. assigned as Meta Data). When the items are imported to another server, the categories and attributes will be updated or created.

eForm control TAGs

eForm control TAGs can be placed on a form to provide additional input controls or for conditional formatting and display, or as an alternative to using the graphical eForm builder. The eForm control TAGs are optional. They are not required but can play a role in simplifying the end-user experience while filling out a form. Some of the TAGs can be used on custom email templates. If a control TAG is not being processed correctly after an eForm is uploaded to the server, ensure that no formatting is applied to the TAG in the eForm Builder. To ensure no formatting exists, select the entire tag (e.g. {SIGNATURES}), then select the MS Word menu item named “Format->Styles and Formatting” and choose the “Clear Formatting” option in the style list displayed.

TAGs are no long required since the release of the graphical eForm MS Word plugin, however they still function should you prefer to use them.

AddRow

This eForm builder control will create a button a user can click to add row(s) to an array. This is placed outside of the array.

Properties

PROPERTY NAME

DESCRIPTION

ArrayName

The name of the array this button is attached to.

Text

Sets the optional button text.

ImageURL

Sets an optional 24px height image for the button.

SmallImage

Sets an optional 16px height image for the button.

Style

To set the style (using any CSS style).

At

The location to add the new row(s).

Rows

Number of rows to add every time the button is clicked

ConfirmText

Pops up a confirmation box when a user clicks the button with the specified text, allowing a user to cancel or confirm the action which the button will take.

Example

{AddRow:AddBtn,ArrayName=Array1,Text=Add Row}

ArrayRemoveRow

This eForm control will create a button a user can click to remove a specific row from an array. You should place this control directly in an array, so that the button is displayed on each row.

Properties

PROPERTY NAME

DESCRIPTION

Text

Sets the optional button text.

ImageURL

Sets an optional 24px height image for the button.

SmallImage

Sets an optional 16px height image for the button.

Style

To set the style (using any CSS style).

ConfirmText

Pops up a confirmation box when a user clicks the button with the specified text, allowing a user to cancel or confirm the action which the button will take.

Example

{ArrayRemoveRow:RmvBtn,Text=Remove Row}

ArrayMoveUp

This eForm control will create a button a user can click to move a Row up in the array.

Properties

PROPERTY NAME

DESCRIPTION

Text

Sets the optional button text.

ImageURL

Sets an optional 24px height image for the button.

SmallImage

Sets an optional 16px height image for the button.

Style

To set the style (using any CSS style).

ConfirmText

Pops up a confirmation box when a user clicks the button with the specified text, allowing a user to cancel or confirm the action which the button will take.

Example

{ArrayMoveUp:AUpBtn,Text=Up}

ArrayMoveDown

This eForm control will create a button a user can click to move a Row down in the array.

Properties

PROPERTY NAME

DESCRIPTION

Text

Sets the optional button text.

ImageURL

Sets an optional 24px height image for the button.

SmallImage

Sets an optional 16px height image for the button.

Style

To set the style (using any CSS style).

ConfirmText

Pops up a confirmation box when a user clicks the button with the specified text, allowing a user to cancel or confirm the action which the button will take.

Example

{ArrayMoveDown:ADwnBtn,Text=Down}

Array

This eForm control places a repeating template section on an eForm. To default the array to a number of rows simply go to the eForm properties page and click on the edit link next to the array control that is in the list of controls. Select Value>> Number from the Default Value dropdown and enter the number to default the number of rows to.

ArrayEnd

This eForm control closes the array on an eForm. Every Array control must have an ArrayEnd control to close the array.

Properties

None

Example

{Array:Array1}This is a test{ArrayEnd}

Attach

This eForm control will display a button to allow the user to attach files to the form.

Properties

PROPERTY NAME

DESCRIPTION

AttachType

eForm – attach object(s) directly to eForm

Workflow - attach object(s) to the current workflow instance as a Workflow reference

Process Timeline - attach object(s) to the current Process Timeline instance as an Process Timeline reference

Process - attach object(s) to the current workflow or Process Timeline instance

ObjectType

Document – Allow user to upload document

Clipboard – Allow the user to use an item from the clipboard. Plug-in Required

GroupName

Optional name of the group to place the attachment(s) into. You can optionally use system variables in this property

ClipboardImageName

You can optionally set ClipboardImageName to the name you want the uploaded file to be. You can optionally use system variables in this property. If the items on the clipboard are files, the actual file name will be used as the new attachment name.

ImageURL

Sets an optional 24px height image for the button.

SmallImage

Sets an optional 16px height image for the button.

ConfirmText

Pops up a confirmation box when a user clicks the button with the specified text, allowing a user to cancel or confirm the action which the button will take.

HTMLDesc

Sets the content in the pop-up box after attachment. Can be plain-text or well-formed HTML. Can also include SysVar tags.

Example

{Attach:Doc1, AttachType=eForm, ObjectType=Document, GroupName=Test1}

AttachKView

This control allows the user to attach an object to an eForm instance by browsing for the object using a knowledge view. To configure the knowledge view, set the “Default Value” of the control to a “Content Item” in the control's properties in the eForm definition, and point to the appropriate knowledge view.

image

Properties

PROPERTY NAME

DESCRIPTION

AttachType

eForm – attach object(s) directly to eForm

Workflow - attach object(s) to the current workflow instance as a Workflow reference

Process Timeline - attach object(s) to the current Process Timeline instance as an Process Timeline reference

Process - attach object(s) to the current workflow or Process Timeline instance

GroupName

Only display objects from the specified group

Text

Text displayed on the eForm button

QS

A querystring to send data to the knowledge view

AttachToParent=[1|0]

If set to 1, this object will be attached to the parent of this eForm instance

MoveObject=[1|0]

If set to 1, this object will be moved to a new location (removing the object in its old location)

CopyObject=[1|0]

If set to 1, this object will be copied to the new location (leaving the old object alone)

Example

{AttachKVIew:controlName, AttachType=eForm, GroupName=exampleGroup, Text=attach KView, MoveObject=0}

AttachPolling

This control has the eForm repeatedly check to see if any new attachments have been added to the form by some external process. This control is only necessary if external API calls or web services are able to add attachments to the eForm. This control can also be used with ConceptShare integration by updating the status of documents imported into ConceptShare.

Hiding this control will disable polling. If there are multiple AttachPolling controls, the most recent poll result will be used.

Properties

PROPERTY NAME

DESCRIPTION

PollingSeconds

The number of seconds between each poll taken. If set to 0, polling will be disabled.

Example

{AttachPolling:pollid,PollingSeconds=30}

Button

This eForm control is used to place a button on a Form. The button will typically be used when hooking up to a Custom Task, or when writing custom C#.

Properties

PROPERTY NAME

DESCRIPTION

Text

Sets the optional button text.

ImageURL

Sets an optional 24px height image for the button.

SmallImage

Sets an optional 16px height image for the button.

Style

To set the style (using any CSS style).

ConfirmText

Pops up a confirmation box when a user clicks the button with the specified text, allowing a user to cancel or confirm the action which the button will take.

OnClientClick

Used to execute client-side JavaScript or call client JavaScript functions. To prevent the button from causing a Post-back, place a return false; at the end of the JavaScript string.

Example

{Button:Btn,Text=Test Button}

ButtonArea

This eForm control is used to control where the buttons for the eForm are placed. The ButtonArea includes the OK, Cancel and any conditional buttons set by the workflow. The actual buttons that are placed in this area are dependent on the current workflow step if any. If this control is not present on an eForm, then the buttons are added to the bottom of the form.

Properties

PROPERTY NAME

PROPERTY ATTRIBUTES

DESCRIPTION

DEFAULT VALUE

AcceptText

 

Sets the text of the button the user clicks to accept the task

 

AcceptConfirmText

 

Sets the text of the confirmation dialog the user must click to accept the task

 

OKText

 

Sets the text for the OK button

 

OKConfirmText

 

Pops up a confirmation box when a user clicks the OK button with the specified text, allowing a user to cancel the OK or continue submitting the form.

 

OKShow

True False

Allows the form to show or hide the OK button.

True

CancelText

 

Sets the text for the Cancel button

 

CancelConfirmText

 

Pops up a confirmation box when a user clicks the Cancel button with the specified text, allowing a user to return to the form or cancelling out of the form.

 

CancelShow

True False

Allows the form to show or hide the Cancel button.

True

CompleteConfirmText

 

Pops up a confirmation box when a user clicks the Complete button with the specified text, allowing a user to cancel the Complete or continue to submit the form.

 

CompleteShow

True False

Allows the form to show or hide (all of) the Complete buttons.

True

Example

{ButtonArea:AllBtn,OKText=OK,CancelText=Cancel}

Calculate

This eForm control calculates an expression and places the result as text on an eForm.

Properties

PROPERTY NAME

DESCRIPTION

Formula

Expression to calculate a numerical value (can accept System Variables)

FormatString

(optional) The format in which to display the result of the Formula (Defaults to "{0:0.00}") - See documentation on ASP/C# string formatting

Example

{Calculate:Calc,Formula="{@FORM:ItemQty} * {@FORM:ItemPrice}"}

Cancel

This eForm control will place a button on an eForm which will cancel or delete the current form or workflow.

Properties

PROPERTY NAME

DESCRIPTION

ID

Optional ID of control.

Text

Sets the optional button text.

CancelWorkflow

This allows you to cancel the associated workflow.

DeleteForm

This allows you to delete the form.

DeleteWorkflow

This allows you to delete the workflow.

ImageURL

Sets an optional 24px height image for the button.

SmallImage

Sets an optional 16px height image for the button.

ConfirmText

Pops up a confirmation box when a user clicks the button with the specified text, allowing a user to cancel or confirm the action which the button will take.

CancelParentProcess

Determines whether parent processes of the process to which this eForm belongs should be canceled. If true, then if this form is part of a process running within another process, both processes will be canceled.

Example

To cancel associated workflow:

{Cancel:myid, CancelWorkflow=true, Text="Cancel Request"}

To just delete this form:

{Cancel:myid, DeleteForm=true,Text="Delete This Form"}

To delete workflow and form:

{Cancel:myid, DeleteWorkflow=true, DeleteForm=true,Text="Delete Form and Workflow"}

To cancel parent processes when a process is cancelled:

{Cancel:myid, CancelParentProcess=true, Text=”Cancel Parent Process?”}

CheckBox

This eForm control places a two-state (checked - true/unchecked - false) checkbox on the eForm. Useful for yes/no data and enabling/disabling sections on an eForm. For more information, see the ASP CheckBox documentation.

Properties

PROPERTY NAME

DESCRIPTION

DEFAULT VALUE

Text

(optional) Accompanying label text for the check box

 

CssClass

To set the CSS class name for this control.

 

Example

This example will cause a Post-back to the server

{CheckBox:EnableSection, Text="Section Enabled"}

ClientSection

This eForm control creates a section on the eForm. Client sections can be used to visually separate a portion of the eForm. Unlike the {Section} control, {ClientSection} operates entirely within the browser. There are no postbacks when the section is expanded or collapsed. The only option available is the Text option.

{ClientSection} does not support an ID option. You cannot give a client section an ID.

To define the end of a client section, use the TAG {ClientSectionEnd}.

The section can optionally be enclosed with an HTML element such as a div or span. A div uses “block” formatting in HTML (so that the section appears on the next line), where the span uses “inline” formatting.

Properties

WRAPPERTAG

DESCRIPTION

DIV

Text

The text for the “header” of the CollapseSection

 

Example

{ClientSection, Text=”This is a Section”} This text is within a section.

{ClientSectionEnd}

CommentLog

This eForm control allows a user to place a Comment Log on an eForm.

Properties

PROPERTY NAME

DESCRIPTION

DEFAULT VALUE

Rows

(Optional) The number of rows to display while prompting for a comment

4

Columns

(Optional) The number of columns to display while prompting for a comment

70

Width

(Optional) Width of the displayed comments

100%

Text

(Optional) The text for the button used to add a comment

Add Comment

ControlName

(Optional) The name of the comment log section. Use this property if you have multiple comment logs on an eForm

 

Example

Simple Comment Log

{CommentLog}

The second comment log at 50% width

{CommentLog:myid, Width=50%}

ContentPicker

This eForm control allows a user to choose an object in the content list.

Properties

PROPERTY NAME

PROPERTY ATTRIBUTES

DESCRIPTION

DEFAULT VALUE

StartingFolder

 

(Optional) The path to a folder, limiting a user to choose only objects in that folder and its subfolders

 

DocExtension

 

(Optional) Limits the user to choose only documents of the specified extension (Type of "Document" only)

 

Type

Type={Document, ContentObject, Workflow, Process Timeline, Process}

(Optional) The type of object (Folder, ContentObject, Script, etc.) to pick.

Folder

Example

{ContentPicker:ReferenceObject,Type=ContentObject}{ContentPicker:Instruct ionsDoc, Type=Document, DocExtension=pdf}

ControlPicker

This eForm control will display a dropdown of all controls on this page.

Properties

PROPERTY NAME

PROPERTY ATTRIBUTES

DESCRIPTION

DEFAULT VALUE

ControlType

Input, Textarea, Date, Button, Dropdown, Password, Array, Section, Radio, CheckBox, Custom, CustomTaskConfigSection, CustomTaskRunSection, UserPicker, GroupPicker, Attach, ShowAttach, Label.

Limits the type of control to show in the dropdown.

 

DropdownPrompt

 

Optional text to show on the dropdown if no user is selected

 

Style

To set the style (using any CSS style).

   

Example

{ControlPicker:SelectedControl, DropdownPrompt="[Pick a Control]"}

Date

This eForm control is a date picker control.

Properties

PROPERTY NAME

DESCRIPTION

DEFAULT VALUE

Style

To set the style (using any CSS style).

 

BlockControl

If set to true, will surround the control within an HTML block element.

true

Example

{Date:HireDate}

DateTime

This eForm control is a date/time combination picker control.

Properties

PROPERTY NAME

DESCRIPTION

DEFAULT VALUE

StartTime

(Optional) Sets the beginning time (of day) for the pre-selected values available for the picker.

 

EndTime

(Optional) Sets the maximum time (of day) for the pre-selected picker values. Must exceed the StartTime value.

 

Interval

(Optional) The amount of time (in minutes) between pre-selected picker values. For example, if the interval is set to 30, the control will allow users to select times such as 1:30, 2:00, 3:30, etc., but not times like 1:15, 2:45, 3:27, etc.

 

Example

{DateTime:WhenDue}

DateDiff

This eForm control is used to calculate the difference between 2 dates.

Properties

PROPERTY NAME

DESCRIPTION

DEFAULT VALUE

Date1

The first date or date / time

 

Date2

The second date or date / time

 

Type

(Optional) The type of the difference

Years

Months

Days

BusinessDays

Hours

BusinessHours

Minutes

Seconds

Days

Example

{DateDiff:MyDate, Date1={form:my_date1}, Date2={form:my_date2}, Type=Days }

DBConnectorPicker

This eForm control will display a Database Connector Picker on the form.

Properties

PROPERTY NAME

PROPERTY ATTRIBUTES

DESCRIPTION

DEFAULT VALUE

DropdownPrompt

 

Optional text to show on the dropdown if no connector is selected

 

Example

{DBConnectorPicker:PickDB}

DropDown

This eForm control puts a dropdown control on the form. For more information, see the ASP DropDownList control documentation.

Properties

PROPERTY NAME

PROPERTY ATTRIBUTES

DESCRIPTION

DEFAULT VALUE

Item

 

Displays an item in the dropdown.

 

CssClass

 

To set the CSS class name for this control.

 

Example

{DropDown:dd1,Item=Please Choose, Item=Test1:1, Item=Test2:2}

FormErrorStrings

This eForm control is used to identify the area(s) where error messages are displayed on the eForm. If this control is not present on an eForm, then the error messages are placed at the top and bottom of the form.

Properties

None

Example

{FormErrorStrings:errorID}

FormInfoStrings

This eForm control is used to identify the area(s) where informational messages are displayed on the eForm. If this control is not present on an eForm, then the informational messages are placed at the top and bottom of the form.

Properties

None

Example

{FormInfoStrings:infoID}

GroupPicker

This eForm control will display a Group Picker on the form.

Properties

PROPERTY NAME

PROPERTY ATTRIBUTES

DESCRIPTION

DEFAULT VALUE

Multiple

True

Allow multiple groups to be selected.

 

PickerType

Dropdown Popup ListBox

Dropdown – use a dropdown control Popup – use a popup control.

ListBox – use a ListBox control.

 

DropdownPrompt

 

Optional text to show on the dropdown if no group is selected

 

Height

 

For ListBox PickerType only; sets the height of the ListBox control

 

Width

 

For ListBox PickerType only; sets the width of the ListBox control

 

Example

{GroupPicker:AssignGroup, DropdownPrompt="[Pick a Group]", PickerType="Popup", Multiple="false"}

HTML

This eForm control will display an HTML string. This is useful when you need to place arbitrary HTML markup in an eForm.

Just as with the HTML Code control, you can wrap an ASP.NET control inside the HTML control by leaving the name of the HTML control blank.

Properties

PROPERTY NAME

PROPERTY ATTRIBUTES

DESCRIPTION

DEFAULT VALUE

HTMLString

 

Allows you to use HTML on an eForm. You can use multiple sysvars in this control.

 

Example

{HTML:test1, HTMLString="<a href=' {EMAIL_URL}'/>click here</a>"}

Using an ASP.NET Control

{HTML:test1, HTMLString="<asp:TextBox runat=”server” ID=”bpLogixTextBox”/>"}

Image

This eForm control will allow you insert an image on the form from a URL address. Please note that system variables can be used in these properties.

Properties

PROPERTY NAME

PROPERTY ATTRIBUTES

DESCRIPTION

DEFAULT VALUE

ImageURL

 

URL path to image.

 

Height

 

(optional) Height of image.

 

Width

 

(optional) Width of image.

 

URL

 

(optional) URL to make image a hotlink.

 

Target

 

(optional) HTML target parameter

 

Style

 

To set the style for this control.

 

Example

{Image:myid, ImageURL="http://localhost/image.jpg", Height="20", Width="30",URL="http://bplogix.com", Target="_blank"}

Include

This eForm control will allow you to include a file into the eForm. This can be used to place common eForm logic, controls, or script into shared libraries. We recommend placing custom shared files into the \Program Files\BP Logix\Process Director\website\custom folder, and using the application relative syntax (with the ~ character).

If you add/remove eForm controls in the included file, you must Check Out / Check In any eForm that included it to have it “see” the updated controls.

Properties

PROPERTY NAME

PROPERTY ATTRIBUTES

DESCRIPTION

DEFAULT VALUE

file

 

Local URL to include file.

 

Example

{INCLUDE, file="~/Custom/SharedForms/MyForm.ascx"}

Input

This eForm control place an input field on the form.

Properties

PROPERTY NAME

PROPERTY ATTRIBUTES

DESCRIPTION

DEFAULT VALUE

Columns

 

This will determine the width of the field.

 

Rows

 

This will determine the height of the field. Please note using a height of 1 will create a single-line input field. Using more than 1 will create a multi-line input box.

 

Example

{INPUT:myid, rows="4", columns="60"}

HotLink

This eForm control will allow you to create a hot link on the form. Please note that system variables can be used in these properties.

Properties

PROPERTY NAME

PROPERTY ATTRIBUTES

DESCRIPTION

DEFAULT VALUE

Text

 

The text that is displayed as a link. This can include System Variables enclosed in { } .

 

URL

 

The URL address to link to. This can include System Variables enclosed in { } .

 

Target

 

HTML target parameter.

 

Style

 

To set the style for this control.

 

Example

{HotLink, URL="{EMAIL_URL}",Text="Click me to perform task"}

KView

This eForm control is used to place a Knowledge View on the eForm. You can use a button to open a Knowledge View or you can view a Knowledge View inline on the form. To configure the knowledge view, set the “Default Value” of the control to a “Content Item” in the control's properties in the eForm definition, and point to the appropriate knowledge view.

image

Properties

PROPERTY NAME

DESCRIPTION

DEFAULT VALUE

Text

Only for Popup – The text on the button.

View Knowledge View

Height

Only for iframe – The height of the iframe.

300px

Width

Only for iframe – The width of the iframe

100%

Type

Iframe – Displays the KView in an inline IFRAME on the form.

Popup – A button will be shown on the form. When clicked, a pop window showing the KView will be launched

Iframe

QS

Optional list of QueryString parameters to pass to the KView. The KView can, for example, use these QueryString parameters in its filters.

Ensure that you have created a filter in the Knowledge View corresponding to each QS filter. You must use the QueryString type on the right side in the Knowledge View filter.

 

Example

In this example, we will use a Knowledge View that has two filter variables, VendorName and VendorContact.

image

The syntax for the eForm tag, including query strings, would be:

{KView:kv1, Text="Click Here To View", Type=Popup, QS="VendorName={FORM: VendorName}", QS=" VendorContact={form:VendorContact}"}

The syntax for using the same query strings in the QueryString Parms field of the properties box for the Knowledge View control in the eForm Builder is:

VendorName={FORM:VendorName}

VendorContact={FORM: VendorContact}

ListBox

This eForm control is used to place a List Box control on an eForm, allowing a user to select more than one entry in the list. This ListBox control can be populated via Custom Tasks, scripts, or with the asp:ListItem tag. Note that commas in a ListBox item value are not valid. For any ListBox item with a comma in the value, the comma will become a semi-colon upon ListBox creation (this does not apply when programmatically adding items).

Properties

PROPERTY NAME

DESCRIPTION

DEFAULT VALUE

Items

The collection of items in the ListBox - See ASP ListControl Items property for usage examples.

 

SelectedValues

A list of selected values in the Items collection

 

SelectedValuesString

A comma-separated string representation of the list of selected values in the Items collection

 

Height

(optional) The height of the ListBox control (e.g., 100px, 15ex, 25%, etc.)

 

Width

(optional) The width of the ListBox control (e.g., 200px, 20em, 30%, etc.)

 

Multiple

Allow multiple users to be selected.

True

Example

{ListBox:Departments, Multiple=true, item=California:CA, item=Arizona:AZ}

Print

This eForm control puts a single print button control on the form.

Properties

PROPERTY NAME

PROPERTY ATTRIBUTES

DESCRIPTION

DEFAULT VALUE

Text

 

Displays the label of the button.

 

Style

 

To set the style for this control.

 

ImageURL

 

Sets an optional 24px height image for the button.

 

SmallImage

 

Sets an optional 16px height image for the button.

 

ConfirmText

 

Pops up a confirmation box when a user clicks the button with the specified text, allowing a user to cancel or confirm the action which the button will take.

 

Example

{Print:PRINTBtn, Text="Print this form"}

Radio

This eForm control puts single Radio button control on the form.

Properties

PROPERTY NAME

PROPERTY ATTRIBUTES

DESCRIPTION

DEFAULT VALUE

Text

 

Displays the label of the button.

 

CssClass

 

To set the CSS class name for this control.

 

Example

{Radio:States, Text="California"}

RadioList

This eForm control puts a Radio Group control on the form.

Properties

PROPERTY NAME

PROPERTY ATTRIBUTES

DESCRIPTION

DEFAULT VALUE

RepeatDirection

Horizontal Vertical

Displays the direction the list will go.

 

Item

 

Displays an item in the Radio Group

 

Example

{RadioList:States, RepeatDirection=Horizontal, Item=California:CA, Item=Arizona:AZ}

Reauth

In a workflow task, when the "Re-Authenticate when a user completes the task" option is checked, Process Director will add a user login to the eForm. The Reauth tag enables you to choose the location where you'd like the login box to appear on the eForm, rather than allowing Process Director to insert it into the default location.

Example

{Reauth:id}

RemoveRow

This eForm control will create a button a user can click to remove row(s) to an array.

Properties

PROPERTY NAME

DESCRIPTION

DEFAULT VALUE

ArrayName

The name of the array this button is attached to.

 

Rows

The number of Rows to remove.

1

At

The location to remove the new row(s).

0 (end of array)

Text

Sets the optional button text.

 

ImageURL

Sets an optional 24px height image for the button.

 

SmallImage

Sets an optional 16px height image for the button.

 

ConfirmText

Pops up a confirmation box when a user clicks the button with the specified text, allowing a user to cancel or confirm the action which the button will take.

 

OnClientClick

Used to execute client-side JavaScript or call client JavaScript functions. To prevent the button from causing a Post-back, place a return false; at the end of the JavaScript string.

 

Example

{RemoveRow:removeBTN,ArrayName="MyArray"}

RichText

This eForm control places a rich text editor on an eForm. This allows a user to enter text as well as format it and place links and other rich text controls within the eForm control.

Properties

PROPERTY NAME

DESCRIPTION

DEFAULT VALUE

SpellCheck

(optional) Enables spell check for text box.

False

Height

(optional) The height of the ListBox control (e.g., 100px)

 

Width

(optional) The width of the ListBox control (e.g., 200px)

 

Example

This example will cause a Post-back to the server

{RichText:CoverPage, SpellCheck=True, Height="250px", Width="550px"}

RoutingSlip

Display the routing slip for the workflow package on the form.

Properties

PROPERTY NAME

DESCRIPTION

PROPERTY ATTRIBUTES

DEFAULT VALUE

ActiveStepOnly

Should the routing slip only display the active step?

True / False

False

ActiveActivityOnly

Should the routing slip only display the active activity?

True/False

False

MostRecentInstance

Should the routing slip display only the most recent step instance? If this is false, then the routing slip will show the users every time a step ran.

True / False

False

ShowSignatures

Should routing slip display user’s signatures?

True / False

True

ShowRunning

Should routing slip display users currently running?

True / False

True

ShowCompleted

Should routing slip display users that have completed the step?

True / False

True

ShowCompletedOn

Shows the date the task was completed for each participant in the routing slip.

True / False

False

ShowComments

Should Routing Slip display the comments?

True / False

True

ShowStatus

Shows the Status column in the routing slip.

True / False

True

ShowResult

Shows the Result column in the routing slip.

True / False

True

ShowStep

Groups the users in the routing slip according to the step they ran in.

True / False

True

ShowPending

Should routing slip display users that have not began?

True / False

False

ShowParticipants

Shows the name of each participant. You can use this, for example, to hide the names of the participants, and only show the signature image.

True / False

True

ShowCancelled

Should routing slip display users that have been cancelled?

True / False

True

ShowReassigned

Should routing slip display users that have been reassigned?

True / False

True

ShowTimedOut

Should routing slip display users that have timed out?

True / False

True

StepName

An optional comma-separated list of steps to show the routing slip in.

   

ActivityName

An optional comma-separated list of activity names to show the routing slip in.

   

Process TimelineName

A partial match for a Process Timeline definition name, restricting the routing slip to display only in the matching Process Timelines.

   

WorkflowName

A partial match for a workflow definition name, restricting the routing slip to display on in the matching workflows.

   

UseDateTime

Optionally shows Date and Time if true

True / False

False

ShowHeader

Should Routing Slip display the header?

True / False

True

ShowInitiator

Should the Process initiator be shown on the routing slip?

True / False

False

ShowChildren

Show sub-workflows in the routing slip

True/False

False

ShowParents

Show the Parent Workflow in the routing slip

True/False

False

ReverseOrder

Displays the routing slip in reverse chronological order, with the most recent item at the top.

   

ShowNotNeeded

When set to true, hides all users that had a workflow completion status of “not-needed” or did not finish.

True/False

True

ShowNotifyTasks

When set to true, this shows notify-only tasks on the routing slip.

True/False

True

Example

This example will show the routing slip for a single step

{RoutingSlip:RTSlip, StepName="Approve Step"}

This example will show the routing slip for the active step and only show the active users.

{RoutingSlip:RTSlip, ActiveStepOnly="true", ShowRunning="true", ShowCompleted="false", ShowCancelled="false", ShowTimedOut="false"}

Save

The “save” (close=false) will only appear when the user is viewing the form in a workflow task. The “save and close” (close=true) will always appear. The “save and close” will add an entry to the users task list (unless they are in a workflow, in that case an entry already exists).

Properties

PROPERTY NAME

DESCRIPTION

DEFAULT VALUE

Text

Sets the optional button text.

 

Close

The Close parameter can be set to true or false.

True

Style

To set the style for this control.

 

ImageURL

Sets an optional 24px height image for the button.

 

SmallImage

Sets an optional 16px height image for the button.

 

ConfirmText

Pops up a confirmation box when a user clicks the button with the specified text, allowing a user to cancel or confirm the action which the button will take.

 

Example

This example will cause a Post-back to the server

{Save:SaveBTN, Text="Save and Close", Close="True"}

Section

This eForm control is used to create a group or section of controls and text on an eForm. This section can be used to apply formatting, required setting, enablement, or visibility rules to all elements in a section.

Properties

PROPERTY NAME

DESCRIPTION

DEFAULT VALUE

WrapperTag

The section can optionally be enclosed with an HTML element such as a div or span. A div uses “block” formatting in HTML (so that the section appears on the next line), where the span uses “inline” formatting.

Div

CanCollapse

Set this property to “true” males this section a collapsible section.

False

Expanded

Set to true to have the control viewed in the Expanded state initially. Set to false to have the control viewed collapsed initially.

True

Text

The text for the “header” of the CollapseSection

 

HeaderStyle

To set the style (using any CSS style) for the header.

 

HeaderCssClass

To set the CSS class name for the header.

 

BodyStyle

To set the style (using any CSS style) for the body of the section.

 

BodyCssClass

To set the CSS class name for the body of the section.

 

CollapseImageURL

Optional URL to image to use for Collapse

 

ExpandImageURL

Optional URL to image to use for Expand

 

Example

This sample will create a section on a form to collect addresses. The section will be surrounded with an HTML DIV block.

{Section:AddressSection, CanCollapse=True]Some eForm controls

…{SectionEnd}

This sample will create a section that flows “inline” with the surround HTML.

Some HTML content {Section:InlineSection, WrapperTag="span"}Some more eForm controls and HTML …{SectionEnd} Some content after the inline section

ShowAttach

This eForm control will display a table showing the attachments that match the desired criteria.

Properties

PROPERTY NAME

PROPERTY ATTRIBUTES

DESCRIPTION

DEFAULT VALUE

AttachType

eForm Workflow Process Timeline Process

show object(s) attached to eForm

show object(s) attached to the current workflow instance as a Workflow reference

show object(s) attached to the current Process Timeline instance as a Process Timeline reference

show object(s) attached to the current workflow or Process Timeline instance

Process

GroupName

 

Optional name of the group to filter the shown objects

 

NameAsView

True False

Allows the attachment name to be a hot link. Same functionality as the ShowView property.

False

ObjectType

Document Form NotSet

Only shows documents Only shows form instances Shows all types of objects

NotSet

ShowDate

True False

Show the date for each attachment?

True

ShowDownload

True False

Show the Download link for each document attachment?

True

ShowEdit

True False

Show the Edit link for each document attachment?

False

ShowModifyDate

True False

Show the last update date for each attachment?

False

ShowModifyUser

True False

Show the last user that modified for each attachment?

False

ShowRemove

True False

Show the Remove link for each attachment?

True

ShowUser

True False

Show the user for each attachment?

True

ShowView

True False

Show the View link for each attachment?

True

SortBy

Name UpdateTime CreateTime

Enables attached items to be sorted when shown on the eForm.

Name

SortType

Ascending Descending

Determines the sort order to be applied to the list of attached items.

Ascending

Text

 

Optional text to display before the list of attachments

 

ViewInline

True False

Allows the user to select a document to view inline on the eForm in an IFRAME

False

ViewInlineHeight

 

Optional parameter to set the height of the IFRAME for the selected document. Use any HTML compatible string such as 300px.

200px

Example

{ShowAttach:AttachDoc, GroupName=Review Documents, ShowEdit=True}

ShowAttachKView

This eForm control will add an Iframe to the eForm showing a knowledge view of attached objects. To configure the knowledge view, set the “Default Value” of the control to a “Content Item” in the control's properties in the eForm definition, and point to the appropriate knowledge view.

image

Properties

PROPERTY NAME

PROPERTY ATTRIBUTES

DESCRIPTION

DEFAULT VALUE

AttachType

eForm Workflow Process Timeline Process

show object(s) attached to eForm

show object(s) attached to the current workflow instance as a Workflow reference

show object(s) attached to the current Process Timeline instance as a Process Timeline reference

show object(s) attached to the current workflow or Process Timeline instance

Process

Height

 

Height of the Iframe

 

Width

 

Width of the Iframe

 

GroupName

 

Specifies to which group objects shown on the knowledge view should be restricted.

 

ShowParents

 

If set the 1, the knowledge view will show the parents of the object.

Null (parent is not shown)

Example

{ShowAttachKView:AttachedView, Height=480, Width=640}

SignatureComments

This eForm control will display a textbox on the form to enter workflow comments.

Properties

PROPERTY NAME

DESCRIPTION

DEFAULT VALUE

Rows

Sets the height of the textbox.

4

Columns

Sets the width of the textbox.

70

Style

To set the style for this control.

 

Text

Sets the optional default text in the textbox.

 

Example

{SignatureComments:sigBox, Text="Please enter your comments here"}

Sum

This eForm control sums all items of a column in an array. Please note the ID is optional as it can be a system variable.

Properties

PROPERTY NAME

DESCRIPTION

Column

The column in an array that you would like to sum up.

Example

{Sum:Sum1, Column=Expenses}

TabStrip

This eForm control is a TabStrip for items. The TabStrip must have an id. The tabstrip will be listed in the eForm controls. Set the default value to the tab ID to display first.

Properties

PROPERTY NAME

DESCRIPTION

Tab

A list of names of the tabs in this TabStrip. This is typically a list of Tabs. These names correspond to the TabContent id. To create an id and a different tab name see the following example.

Example

{TabStrip:MyTabStrip, Tab=tab1:Tab Name 1, Tab=tab2:Tab Name 2}

{TabContent:tab1}tab1 form data here ...{TabContentEnd}

{TabContent:tab2}tab2 form data here ...{TabContentEnd}

{TabStripEnd}

TabContent

This eForm control is one tab of the TabStrip. The TabContent must have an id. This id must match the “Tab” parameter of the TabStrip eForm control.

Example

{TabStrip:MyTabStrip, Tab=tab1, Tab=tab2}

{TabContent:tab1}Content of Tab 1 ...{TabContentEnd}

{TabContent:tab2}Content of Tab 2 ...{TabContentEnd}

{TabStripEnd}

Time

This eForm control places a picker for selecting time values on an eForm.

Properties

PROPERTY NAME

DESCRIPTION

DEFAULT VALUE

StartTime

(Optional) Sets the beginning time (of day) for the pre-selected values available for the picker.

 

EndTime

(Optional) Sets the maximum time (of day) for the pre-selected picker values. Must exceed the StartTime value.

 

Interval

(Optional) The amount of time (in minutes) between pre-selected picker values.

 

Example

{Time:BreakTime, StartTime="11AM", EndTime="3:45pm", Interval="15"}

UserPicker

This eForm control will display a User Picker on the form.

Properties

PROPERTY NAME

PROPERTY ATTRIBUTES

DESCRIPTION

DEFAULT VALUE

Multiple

True

Allow multiple users to be selected.

 

InGroup

 

Optional filter to only show users that are members of the specified group. You can optionally use system variables in this property

 

PickerType

Dropdown Popup ListBox

Dropdown – use a dropdown control Popup – use a popup control.

ListBox – use a ListBox control.

 

DropdownPrompt

 

Optional text to show on the dropdown if no user is selected

 

Height

 

For ListBox PickerType only; sets the height of the ListBox control

 

Width

 

For ListBox PickerType only; sets the width of the ListBox control

 

Example

{UserPicker:AssignUser, DropdownPrompt="[Pick a User]", PickerType="Popup", Multiple="true", InGroup="AdminUsers"}

  • Was this article helpful?