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

Properties

Example

{AddRow:ControlName,ArrayName=ArrayControlName,Text="Text to Display"}

Starting with Process Director v3.78, for better appearance in smaller viewports, especially on mobile devices, you can use the ArrayColumn form tag to indicate the columns in an array. When the form is viewed on a small viewport, tables will be displayed so that every cell is on a new line.

The ResponsiveType custom Variable must be set to true in the vars file in order to enable this feature.

Implementation

The ArrayColumn tag should be placed in the first row of an array table, outside of the Array row, as shown below:

On a wider screen, the ArrayColumn control will appear as a column header when a user runs the Form:

On smaller screens, such as phones, the responsive table will now collapse into a single column, so that users don't have to scroll horizontally, and the ArrayColumn controls will appear as Field labels:

Properties

When associating labels with an array column for accessibility purposes, use the Column Header control tag with the appropriate Text property to create the label.

Example

{ArrayColumn, Text=Column Name}

This Form 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

Example

{ArrayRemoveRow:ControlName,Text="Text to display"}

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

Properties

Example

{ArrayMoveUp:ControlName,Text="Text to Display"}

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

Properties

Example

{ArrayMoveDown:ControlName,Text="Text to display"}

This Form control places a repeating template section on a Form. To default the array to a number of rows simply go to the Form 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 Form control closes the array on a Form. Every Array control must have an ArrayEnd control to close the array.

Properties

None

Example

{Array:ControlName}<!--Table Row Contents-->{ArrayEnd}

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

Properties

Example

{Attach:ControlName, AttachType=Process, ObjectType=Document, GroupName=Group, UseMFT=1, PageTitle="Title Text"}

This Form Control Tag is a different version of the Attach tag. The AttachDrop tag will display an upload area to allow the user to attach files to the form by dragging and dropping the files into the upload area.

Properties

Example

{AttachDrop:ControlName, AttachType=Process, ObjectType=Document, GroupName=Group}

This control allows the user to attach an object to a Form 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 Form definition, and point to the appropriate Knowledge View.

Properties

Example

{AttachKVIew:ControlName, AttachType=Process, GroupName=Group, Text="Text to Display", MoveObject=0}

The AuditViewer control enables you to view a history of the controls whose values have changed on the Form, so long as the “Audit Form Changes” checkbox is checked on the Form properties tab in Process Director. Additionally, this control enables you to view Case data changes as well.

Properties

Example

{AuditViewer:ControlName, ControlName=MyControl, Text="Text to Display" , OnlyTooltip=1, CaseData=1}

This control has the Form 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 Form. 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

Example

{AttachPolling:ControlName, PollingSeconds=30}

This Form control is used to place a button on a Form. The button will typically be used when calling a Custom Task, or custom script.

Properties

Example

{Button:ControlName,Text="Text to Display"}

This Form control is used to control where the buttons for the Form are placed.  The ButtonArea includes the OK, Cancel and any task completion buttons set by the process. The actual buttons that are placed in this area are dependent on the configured results for the current process step if any. If this control isn't present on a Form, then the buttons are added to the bottom of the form, by default.

Properties

Example

{ButtonArea:ControlName, OKText="OK", CancelText="Cancel"}

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

Properties

Example

{Calculate:ControlName,Formula="{@FORM:Control1} * {@FORM:Control2}"}

This Form control will place a button on a Form which will cancel or delete the current Form or process.

Properties

Example

To cancel associated Workflow:

{Cancel:ControlName, CancelWorkflow=true, Text="Cancel Process"}

To just delete this form:

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

To delete Workflow and form:

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

To cancel parent processes when a process is canceled:

{Cancel:ControlName, CancelParentProcess=true, Text="Cancel Parent Process?"}

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

Properties

Example

This example will cause a Post-back to the server

{CheckBox:ControlName, Text="Text to Display"}

This Form control creates a section on the Form. Client sections can be used to visually separate a portion of the Form. Unlike the Section control, the 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 can't give a client section an ID/Name.-->

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

Example

{ClientSection, Text="Text to Display"}

This text is within a section.

{ClientSectionEnd}

This Form control allows a user to place a Comment Log on a Form.

Properties

Example

Simple Comment Log syntax:

{CommentLog:ControlName}

A Comment Log that displays at a specified percentage of the display page width:

{CommentLog:ControlName, Width=50%}

This Form control allows a user to choose an object in the Content List.

Properties

Example

{ContentPicker:ControlName,Type=ContentObject}{ContentPicker:InstructionsDoc, Type=Document, DocExtension=pdf}

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

Properties

Example

{ControlPicker:ControlName, DropdownPrompt="User Prompt to Display"}

This Form control is a date picker control.

Properties

Example

{Date:ControlName}

This Form control is a date/time combination picker control. Unlike the standard UI control, this tag enables you to customize both:

• The intervals displayed as the time element of a DateTime control. The UI control only displays 1-hour increments.
• The start and end times displayed. The UI control displays 24 hourly increments.

Properties

Example

{DateTime:ControlName, Interval=15, StartTime="09:00 AM", EndTime="05:00 PM"}

{DateTime:ControlName, Interval=15, StartTime="09:00", EndTime="17:00"}

Using the above example, the DateTime control will display to the end user as shown below.

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

Properties

Example

{DateDiff:ControlName, Date1={form:my_date1}, Date2={form:my_date2}, Type=Days, IncludeEndDate=true}

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

Properties

Example

{DBConnectorPicker:ControlName}

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

Properties

Example

{DropDown:ControlName, Item="Desired PromptText", Item=DisplayText1:Value1, Item=DisplayText2:Value2}

This Form control is used to identify the area(s) where error messages are displayed on the Form. If this control isn't present on a Form, then the error messages are placed at the top and bottom of the form.

Properties

None

Example

{FormErrorStrings:ControlName}

This Form control is used to identify the area(s) where informational messages are displayed on the Form. If this control isn't present on a Form, then the informational messages are placed at the top and bottom of the form.

Properties

None

Example

{FormInfoStrings:ControlName}

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

Properties

Example

{Group Picker:ControlName, DropdownPrompt="Prompt Text", PickerType="Popup", Multiple="false"}

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

Properties

Example

Plain text URL Hotlink:

{HotLink, URL="https://servername.com/page.htm", Text="Text to display"}

System Variable Hotlink:

{HotLink, URL="{URL_SYSTEM_VARIABLE}", Text="Text to display"}

This control will display a specified icon on a Form page.

Properties

Example

{ICON:ControlName, IconNumber=0000, IconSize=00, IconColor=#000000, Backcolor=#000000, CSSClass=Classname, tooltip="Tooltip text"}

This Form 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

Example

{Image:ControlName, ImageURL="https://servername/image.jpg", Height="20", Width="30",URL="https://www.bplogix.com", Target="_blank"}

This Form control will allow you to include a file into the Form.  This can be used to place common Form 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 Form controls in the included file, you must Check Out / Check In any Form that included it to have it “see” the updated controls.

Properties

Example

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

This Form control place an input field on the form.

Properties

Example

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

This Form control places an Label field on the form.

Properties

Example

{LABEL:ControlName, AssociatedControlId="Control Name”, Text="Label Display Text"}

This Form control is used to place a Knowledge View on the Form. 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 Form definition, and point to the appropriate Knowledge View.

Properties

Example

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

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

{KView:ControlName, Text="Text to display", Type=Popup, QS="QueryAttribute1=Value1", QS="QueryAttribute2>{SYSTEM_VARIABLE}"}

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

QueryAttribute1=Value1
QueryAttribute2>{SYSTEM_VARIABLE}

Process Director v3.76 and higher encodes QueryString parameters as "URL encoded" by default when using System Variables.

This Form control is used to place a List Box control on a Form, 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 aren't valid.  For any ListBox item with a comma in the value, the comma will become a semi-colon upon ListBox creation (this doesn't apply when programmatically adding items).

Properties

Example

{ListBox:ControlName, Multiple=true, item=DisplayText1:Value1, item=DisplayText2:Value2}

This Form control is used to place a Manage Users button on a Form. When the Process is running, the Manage Process Users button will appear when the form is opened in the context of a task. Otherwise, the control won't display.

Properties

Example

{ManageUsers:ControlName, Text="Button Text", Reassign=true}

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

Properties

Example

{Print:ControlName, Text="Button text"}

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

Properties

Example

{Radio:ControlName, Text="DisplayText"}

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

Properties

Example

{RadioList:ControlName, RepeatDirection=Horizontal, item=DisplayText1:Value1, item=DisplayText2:Value2, RadioBox=true}

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

Example

{Reauth:ControlName}

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

Properties

Example

{RemoveRow:ControlName,ArrayName="ArrayName"}

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

Properties

Example

This example will cause a Post-back to the server

{RichText:ControlName, SpellCheck=True, Height="000px", Width="000px"}

Display the Routing Slip for the process on the form.

Properties

Example

This example will show the Routing Slip for a single step:

{RoutingSlip:ControlName, StepName="Step Name"}

This example will show the Routing Slip for the active step and only show the active users:

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

The “save” (close=false) will only appear when the user is viewing the form in a process task. The “save and close” (close=true) will always appear. The “save and close” will add an entry to the users Task List.

Properties

Example

This example will cause a Post-back to the server

{Save:ControlName, Text="Button Text", Close="True"}

This Form control is used to create a group or section of controls and text on a Form. This section can be used to apply formatting, required settings, or enabling/visibility rules to all elements in a section.

Properties

Example

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

{Section:ControlName, CanCollapse=True}

<!--Some Form controls...-->

{SectionEnd}

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

<!--Some HTML content--> {Section:ControlName, WrapperTag="span"} <!--Some more Form controls and HTML...--> {SectionEnd} <!--Some content after the inline section-->

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

Properties

Example

{ShowAttach:ControlName, GroupName="Group", ShowEdit=True, UseMFT=1, PageTitle="Title Text"}

This Form control will add an Iframe to the Form 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 Form definition, and point to the appropriate Knowledge View.

Properties

Example

{ShowAttachKView:ControlName, Height=000, Width=000}

This Form control will display a textbox on the form to enter task comments.

Properties

All properties are optional.

Example

{SignatureComments:ControlName, Rows=00, Columns=00, Style="CSS style directives", Text="Text to display", InitiatorComments=1}

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

Properties

Example

{Sum:ControlName, Column=ColumnNameToSum}

This Form control is a true/false control that operates much like a check box, though with a configurable appearance.

Properties

Example

{Switch:ControlName, SwitchType=Flip, TagOff="OffText", TagOn="OnText"}

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

Properties

Example

{TabStrip:ControlName, Tab=Tab1:Tab Name 1, Tab=Tab2:Tab Name 2, UseVertical=1}

{TabContent:Tab1}<!--tab1 form data here-->{TabContentEnd}

{TabContent:Tab2}<!--tab2 form data here-->{TabContentEnd}

{TabStripEnd}

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

Example

{TabStrip:ControlName, Tab=Tab1:Tab Name 1, Tab=Tab2:Tab Name 2, UseVertical=1}

{TabContent:Tab1}<!--tab1 form data here-->{TabContentEnd}

{TabContent:Tab2}<!--tab2 form data here-->{TabContentEnd}

{TabStripEnd}

This Form control places a picker for selecting time values on a Form.

Properties

Example

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

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

Properties

Example

{UserPicker:ControlName, DropdownPrompt="Prompt Text", PickerType="PopupForce", Multiple="true", InGroup="Group"}