Rules Guide

Chapter 7 Installed Conditions

This chapter describes the conditions installed with your Director project in Workbench. It has these sections:

For more information For information about how to use conditions and actions in the Rule Editor, see Rule and Macro Editors.

For more information For information about accessing sources and supporting files, see Accessing condition and action sources.

Condition definitions

Check Component Parameter

Compares portal component parameter value with a value you specify. If the comparison is true, the condition returns true

Property	Description
Key ^	The name of the component parameter. See Properties that support the !valueOf template.
Compare	The type of comparison you want to make. Select from the dropdown list. For numeric values, use the various equal to, greater than, and less than conditions. For text, use equal, begins, ends, and contains.
Value ^	The value to which you want to compare the parameter. See Properties that support the !valueOf template

Property

Description

Key ^

The name of the component parameter.

For more information See Properties that support the !valueOf template.

Compare

The type of comparison you want to make. Select from the dropdown list. For numeric values, use the various equal to, greater than, and less than conditions. For text, use equal, begins, ends, and contains.

Value ^

The value to which you want to compare the parameter.

For more information See Properties that support the !valueOf template

Check Date

Compares the current date with the date you specify and returns true if they are the same.

Property	Description
Date	The date you want to check against the current date. Click Pick Date to use a calendar tool to select a date: The << and >> buttons change the year. The < and > buttons cycle through the months of the year.

Check Date Within Range

Returns true when the current date is within the specified range. If the date is out of range or if you don't specify a date for both start and end, the condition returns false.

Property	Description
Start Date	The start date of the range. Click the button to use a calendar tool to select a date.
End Date	The end date of the range. Click the button to use a calendar tool to select a date. The << and >> buttons change the year. The < and > buttons cycle through the months of the year.
Inclusive	Whether the start and end dates are considered part of the range. If selected, the dates are included—the current date must be greater than or equal to the start and less than or equal to the end. If not selected, the current date must be greater than the start and less than the end.

Property

Description

Start Date

The start date of the range. Click the button to use a calendar tool to select a date.

End Date

The end date of the range. Click the button to use a calendar tool to select a date.

The << and >> buttons change the year.
The < and > buttons cycle through the months of the year.

Inclusive

Whether the start and end dates are considered part of the range.

If selected, the dates are included—the current date must be greater than or equal to the start and less than or equal to the end.

If not selected, the current date must be greater than the start and less than the end.

Check Day

Returns true when the current weekday is in the set of selected weekdays.

Property	Description
List of weekdays	Check one or more weekdays to select them.

Check For Cookie

Returns true if the specified cookie is defined in the user's browser.

Property	Description
Cookie Name	The name of the cookie you want to find.

Check Month

Returns true when the current month is in the set of selected months.

Property	Description
List of months	Check one or more months to select them.

Check Request Data

Checks how a parameter value in the request header matches a value you specify. If the comparison is true, the condition returns true.

Property	Description
Key	The name of a request parameter.
Value	The value to which you want to compare the parameter.
Condition	The type of comparison you want to make. For numeric values, use the various equal to, greater than, and less than conditions. For text, use equal, begins, ends, and contains.

Check Time

Returns true if the current time is between the hours you specify.

Property	Description
hours of ... and ...	Select an hour from each of the two dropdown lists to specify the start and end of the time span.

Check User

Compares the current user with the specified user based on the text of the user ID. If the comparison is true, the condition returns true.

Property	Description
User	A user ID defined in your server directory realm.
Condition	The relational operator for the comparison. The most useful comparisons are equal and not equal. Greater and less than comparisons are based on the ASCII values of the characters in the ID. Starts with, ends with, and contains are less useful, since the condition compares the whole user ID. You can't specify part of an ID for the comparison.

Property

Description

User

A user ID defined in your server directory realm.

Condition

The relational operator for the comparison. The most useful comparisons are equal and not equal.

Greater and less than comparisons are based on the ASCII values of the characters in the ID.

Starts with, ends with, and contains are less useful, since the condition compares the whole user ID. You can't specify part of an ID for the comparison.

Check User Group

Returns true if the user is a member of the specified group in the authentication directory. (Users can be assigned to groups in the PAC.)

Property	Description
Group	A group name defined in your server directory realm.

Check User Property

Compares the value of a user attribute for the current context with a value you specify in the condition property. Returns true if they are the same.

Property	Description
Key ^	The name of the user attribute. See Properties that support the !valueOf template.
Compare	The type of comparison you want to make. Select from the dropdown list. For numeric values, use the various equal to, greater than, and less than conditions. For text, use equal, begins, ends, and contains.
Value ^	The value to which you want to compare the attribute value. See Properties that support the !valueOf template.

Property

Description

Key ^

The name of the user attribute.

For more information See Properties that support the !valueOf template.

Compare

Value ^

The value to which you want to compare the attribute value.

For more information See Properties that support the !valueOf template.

Check Whiteboard

Returns true if the specified whiteboard key exists.

Property	Description
Whiteboard Key ^	The name of the whiteboard key. See Properties that support the !valueOf template.

Property

Description

Whiteboard Key ^

The name of the whiteboard key.

For more information See Properties that support the !valueOf template.

Check Whiteboard Value

Compares the value of the specified whiteboard key to a value based on the data type of the value in the whiteboard key. If the comparison is true, the condition returns true.

Property	Description
Value	The value to which you want to compare the whiteboard value. The condition will convert the value you specify to the data type of the whiteboard value. If the value can't be converted, the condition returns false.
Whiteboard Key ^	The name of the whiteboard key. See Properties that support the !valueOf template.
Condition	Select the relational operator for the comparison.

Property

Description

Value

The value to which you want to compare the whiteboard value. The condition will convert the value you specify to the data type of the whiteboard value. If the value can't be converted, the condition returns false.

Whiteboard Key ^

The name of the whiteboard key.

For more information See Properties that support the !valueOf template.

Condition

Select the relational operator for the comparison.

Check Whiteboard Value Is Empty

Returns true if the value of a whiteboard key is null or an empty string ("").

Property	Description
Whiteboard Key ^	The name of the whiteboard key. See Properties that support the !valueOf template.

Property

Description

Whiteboard Key ^

The name of the whiteboard key.

For more information See Properties that support the !valueOf template.

Check Workitem Value

Compares a value you specify to a workitem document value and returns true if the values are the same. For use with a Rule Activity, a Rule Link, or an XOR condition link in the Workflow Designer.

For more information, see the chapter on the Workflow Designer in the Workflow Guide.

Property	Description
Value	The value to use for the comparison.
Document ID ^	The Document ID containing the property to compare with. See Properties that support the !valueOf template.
Document Property ID ^	The property ID for the compare value. See Properties that support the !valueOf template.
Condition	Select the relational operator for the comparison.

Default

This condition does nothing—by returning false. If Default is the only condition in a When section, the actions for that case won't be executed.

Is Form Get Data Available

Returns true if the request header contains parameters from an HTML form.

Is New Session

Returns true if this is the first request for this user's session.

Save Cookies To Whiteboard

Puts the cookies the browser has sent onto the whiteboard. The condition returns true if successful and false if an error occurs.

For more information See the Save Cookies To Whiteboard action.

Save Form Get Data To Whiteboard

Puts the query string from the browser on the whiteboard using the specified key. The condition returns true if successful and false if an error occurs.

For more information See the Save Form Get Data To Whiteboard action.

Save Request Data To Whiteboard

Puts the parameters in the request header on the whiteboard. The names of the request parameters are used as the whiteboard keys, and the values of the request parameters are their values. The condition returns true if successful and false if an error occurs.

For more information See the Save Request Data To Whiteboard action.

Set Action Off

Returns false. If it is the only condition in a When section, the actions for that case will not be executed. If there are other conditions, the actions are executed depending on the values of the other conditions and the logical operators used.

Set Action On

Returns true. If it is the only condition in a When section, the actions for that case will be executed. If there are other conditions, the actions are executed or not depending on the values of the other conditions and the logical operators used.

Set Action On Or Off

Returns true if On? is selected and false if not. For more information, see the Set Action Off and Set Action On actions just above.

Property	Description
On?	Whether the condition returns true or false.

SQL Check For Column

Executes a SQL query with a WHERE clause and returns true if the result set contains any rows. The SQL query is built from the condition's properties and looks like this:

  SELECT fields FROM table WHERE column condition value

NOTE Several of the properties for this condition support the !valueOf template. For information, see Properties that support the !valueOf template.

Property	Description
User ID ^	The user ID expected by the database.
Column	The name of a column for the WHERE clause.
Database Name ^	The URL for the database. The format for the URL depends on the DBMS. For more information, see Properties that support database drivers and URLs.
Condition	A SQL comparison operator for the WHERE clause.
JDBC Driver ^	The Java class name for the JDBC driver. For more information, see Properties that support database drivers and URLs.
Fields	The columns to include in the result set. Use an asterisk (*) to specify all columns.
Value	The value you want to match in the WHERE clause.
Password ^	The password expected by the database. This is not necessarily the same as the portal user's password.
Table	The table for the SQL query.

SQL String

Executes a SQL query and returns true if the result set contains any rows.

For more information For a description of the properties, see the SQL String action.

Rules Guide