Rules Guide

CHAPTER 7

Installed Actions

This chapter describes the actions installed with your exteNd Director project. It has these sections:

For more information    For background information, see Rule and Macro Editors.

 
Top of page

Accessing condition and action sources

Condition and action class files, sources, and supporting files are contained in JAR files that are added to your project when you create it. The default location for the JARs in your project is ResourceSet/Web-INF/lib. These are the JARs that are added, depending on the subsystem(s) you select in the wizard:

Subsystem(s) selected

JAR file added

Rule

RuleCA.jar

Rule and Portal

PortalCA.jar

Rule and Workflow

WorkflowRE.jar

Rule, Portal, and Content Management

CQA.jar

 
Top of page

Properties that support string templates

 
Top of section

!valueOf template

Some of the condition and action properties support the !valueOf template. Properties that support this feature have the ^ character.

You can either enter the actual value you want to use or specify a whiteboard key that holds the value you want. Use this format:

  !valueOf.keyname

You can also specify a key that holds the name of another key. To get a value from another key, specify !valueOf.anotherkey.

For more information    For more information about the !valueOf construct, see Using whiteboard values.

 
Top of section

Scoped path support

The ^ template fields also support the substitution syntax for scoped paths. You can specify a scoped path using this format:

  ${spath}

For more information    For more information, see the section on working with scoped paths in Developing exteNd Director Applications.

 
Top of page

Properties that support database drivers and URLs

Some of the conditions and actions have properties for accessing a database. These properties include JDBC Driver and Database Name. These values vary with the database and server vendors. For details, see your database and application server documentation.

Here is a list of database drivers and URL patterns for some of the databases supported in exteNd Director:

Database/server

Driver class name

Database name

Sybase ASA (exteNdTM application server)

com.sssw.jdbc.mss.odbc.AgOdbcDriverDefault

jdbc:sssw:odbc:DatabaseNameDefault

Microsoft SQL Server(exteNd application server)

com.sssw.jdbc.mss.odbc.AgOdbcDriver

jdbc:sssw:odbc:DatabaseName

Microsoft SQL Server(WebLogic)

weblogic.jdbc.mssqlserver4.Driver

jdbc:weblogic:mssqlserver4:DatabaseName@server:port

NOTE:   You can specify either the IP address or the server host name

DB2

COM.ibm.db2.jdbc.app.DB2Driver

jdbc:db2:DatabaseName

Oracle Thin

oracle.jdbc.driver.OracleDriver

jdbc:oracle:thin:@server:port:SID

NOTE:   You can specify either the IP address or the server host name

Oracle (exteNd application server)

com.sssw.jdbc.oracle8.Driver

jdbc:sssw:oracle:DatabaseName

Oracle (WebLogic)

weblogic.jdbc.oci.Driver

jdbc:weblogic:oracle:DatabaseName

Sybase ASE

com.sybase.jdbc2.jdbc.SybDriver

jdbc:sybase:Tds:server:port/DatabaseName

NOTE:   You can specify either the IP address or the server host name

 
Top of page

Alphabetical list of actions

 
Top of section

Add

Description

Performs addition. The value you specify is added to a value stored in a whiteboard key. The whiteboard key then contains the new, incremented value. No response status or response phrase is set.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Whiteboard Key ^

The keyname of a numeric value stored on the whiteboard. If the key doesn't exist, this action adds it. If its value is not numeric, it is treated as zero for the arithmetic operation.

Value

The numeric value you want to add to the value of the whiteboard key.

 
Top of section

Add Eraser

Description

Specifies that a whiteboard key will be removed at some future time: either after a number of seconds or after a number of times accessed.

Properties

Property

Description

Activation Counter

The number of times the whiteboard key's value can be accessed before it is deleted. Setting the key and getting the key's value both increment the activation counter.

Eraser Name

The name of the whiteboard key you want to have erased.

Seconds

The number of seconds the key will stay on the whiteboard.

Usage

To use the activation counter, set seconds to zero. To use seconds, set the activation counter to zero.

 
Top of section

Calculate Age

Description

Calculates the difference in years between a date on the whiteboard and the current date and stores the difference in another whiteboard key. The value is saved as an integer.

Properties

Property

Description

Detail Key

The key in which you want to store the difference between the two dates.

Date Key

The key containing the date you want to compare to the current date. (The current date is the date the rule is run.)

Usage

Code in the application must add a key to the whiteboard using the name you specified in Date Key, or you could use the Save To Whiteboard action. The data type of its value must be Date.

 
Top of section

Clear Request Data From Whiteboard

Description

Removes a key and its value from the whiteboard. If the key doesn't exist, nothing happens.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates

Property

Description

Detail Key ^

The name of the whiteboard key to be removed.

.

Usage

If you use a template for Detail Key, you need to add the key to the whiteboard either in your application or through another action (see the Save To Whiteboard action).

 
Top of section

Create Collection Of Objects From SQL

Description

Creates a Vector of objects from a specified database column and makes the Vector available from the whiteboard through a specified detail key.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Key Column ^

The name of the column for the SQL WHERE clause.

User ID ^

The user ID expected by the database.

Detail Key ^

The name of the key that holds the object Vector name.

Password ^

The password expected by the database.

Object Name ^

The name of the object or objects to retrieve for the SQL WHERE clause.

SQL String ^

The SQL statement you want to execute.

NOTE:   If you are using a template key for this value, place the expression in quotes—for example:

  "!valueOf.mySQL"

JDBC Driver ^

The Java class name for the JDBC driver.

For more information    For more information, see Properties that support database drivers and URLs.

Database Name ^

The URL for the database. The format for the URL depends on the DBMS.

For more information    For more information, see Properties that support database drivers and URLs.

 
Top of section

Default

Description

Does nothing. Use this action when you want nothing to happen if the conditions are met.

Usage

You can use the Default action as a placeholder as you work on a rule.

To set a success status code, you can use the Set Response Status action instead of the Default action. Portal code that uses the rule can check the status code to confirm that the rule ran correctly.

See also

Set Response Status action

 
Top of section

Delete Cookie

Description

Deletes a cookie from the user's Web browser or other client. If the cookie exists, this action sets the cookie's age to zero, and that signals the browser to delete it. No status code is set. If the cookie does not exist, nothing happens.

Properties

Property

Description

Cookie Name

The name of the cookie you want to delete.

 
Top of section

Deny Access

Description

Sets the response status and response phrase. Application code can check the response status and act accordingly. The response status is set to 403 and the response phrase is set to the specified message. (Neither the console nor the log displays the response status.)

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Message ^

The text to store in the response phrase.

Usage

Application code can display this text to the user to explain what this action is doing.

 
Top of section

Display Component

Description

Displays the contents of a component.

Properties

Property

Description

CID

The component ID

 
Top of section

Display Cookies

Description

Displays the cookies and their values in the Rule subsystem log. By default, the log output displays on the server console.

Usage

Use this action when debugging a rule.

See also

For information on configuring logs, see the chapter on logging information in Developing exteNd Director Applications.

 
Top of section

Display Request Headers

Description

Displays the parameters in the request header and their values in the Rule subsystem log. By default, the log output displays on the server console.

Usage

Use this action when debugging a rule.

See also

For information on configuring logs, see the chapter on error handling in Developing exteNd Director Applications.

 
Top of section

Display Whiteboard

Description

Displays the whiteboard keys and their values in the Rule subsystem log. By default, the log output displays on the server console.

Usage

Use this action when debugging a rule.

See also

For information on configuring logs, see the chapter on logging information in Developing exteNd Director Applications.

 
Top of section

Divide

Description

Performs division. The value you specify is divided into a value stored in a whiteboard key. The whiteboard key then contains the quotient of the division. If the divisor value is zero, the whiteboard key's value is set to the text Infinity. No response status or response phrase is set.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates

Property

Description

Whiteboard Key ^

The keyname of a numeric value stored on the whiteboard. If the key doesn't exist, this action creates it. If its value is not numeric, it is treated as zero for the division operation.

Value

The numeric value you want to divide into the value of the whiteboard key.

.

 
Top of section

Drop Cookie User ID

Description

Drops a cookie named userID into the browser with a value of the portal user's ID. No response status or response phrase is set. If the user has disabled cookies, nothing happens. Success or failure is reported in the log; the default log output is displayed on the server console.

Properties

Property

Description

Maximum Number of Days

The number of days before the cookie expires.

 
Top of section

Fire Rule

Description

Executes a rule.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Rule ID ^

The ID of the rule you want to fire. Specify the ID (it is displayed in the Rule Editor).

 
Top of section

Flush

Description

Tells the system to empty the caches that hold rules.

 
Top of section

Format Date

Description

Gets a whiteboard Timestamp value stored in a specified Date key, formats it for the current locale, and saves the result to the whiteboard in the specified Detail key. If the value for Date Key is not a valid Timestamp object, the Detail Key is set to an empty string.

Properties

Property

Description

Detail Key

The name of the key used to save the formatted date text.

Date Key

The name of the key containing a Timestamp object. The Timestamp specifies the date you want to format.

See also

Set Date On Whiteboard action

 
Top of section

Get Cookie Value

Description

Gets the value of the specified cookie. Sets the response phrase to the cookie value.

Properties

Property

Description

Stop Processing

When checked, this action terminates the rule after getting the cookie value, regardless of the continue setting for the case.

Cookie Name

The name of the cookie whose value you want.

 
Top of section

Get User Property

Description

Gets the value of a user attribute for the current portal context. The attribute must be set on the whiteboard in the specified key.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Key ^

The name of the attribute.

See also

Set User Property action

Check User Property condition

 
Top of section

Log User Off

Description

Resets the user to Anonymous and removes all key/value pairs from the whiteboard. No response status or response phrase is set.

 
Top of section

Multiply

Description

Performs multiplication. The value you specify is multiplied by a value stored in a whiteboard key. The whiteboard key then contains the result of the multiplication. No response status or response phrase is set.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Whiteboard Key ^

The keyname of a numeric value stored on the whiteboard. If the key doesn't exist, this action creates it. If the key's value is not numeric, it is treated as zero for the multiplication operation.

Value

The numeric value you want to multiply by the value of Whiteboard Key.

 
Top of section

Query

Description

Returns the result of a query to the Content Management subsystem as an XML string.

Usage

This action is used by the Content Query sample application.

See also

Section on using the Content Query action in the Content Management Guide.

 
Top of section

Remove From Whiteboard

Description

Removes a value and its key from the whiteboard. No response status or response phrase is set.

Properties

Property

Description

Whiteboard Key

The name of the key you want to remove.

 
Top of section

Return As Decimal Format

Description

Formats a decimal value as text using the specified formatting. The formatted number is stored as text in the key specified by Detail Key. The response type is set to TEXT and the response status is set to 302.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Max. Number of Integers

The maximum number of digits in the formatted number. If there are more digits in the actual number, digits on the left are dropped.

Min. Number of Integers

The minimum number of digits in the formatted number. If the number has fewer digits, extra zeros are added on the left.

Detail Key ^

The name of a key that holds the number you want to format. If the key doesn't exist, this action creates it. If the key's value is not numeric, the number is set to zero.

Min. Decimal Places

The minimum number of decimal places. Zeros are added on the right if necessary.

Max. Decimal Places

The maximum number of decimal places. Digits are truncated on the right if necessary.

Grouping

Select this to include a separator character every so many digits, specified by the grouping size and counting left from the decimal point. In an American locale, the separator is a comma.

Grouping Size

The number of digits between separators.

Mask

Specifies special characters to add to the formatted number, such as currency or percent. Other formatting you might put in a mask (such as commas, periods, or dashes) is ignored.

Usage

You can add special characters such as currency and percent signs. This action does not support formatting as phone numbers and other nonarithmetic formats.

 
Top of section

Return As Html Body

Description

Returns the opening of an HTML BODY tag with a color attribute. This action:

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Background Color ^

A color value specified as text that would be recognized by a browser. You can specify a hexadecimal value (such as #FFFFFF) or a browser-supported color name.

 
Top of section

Return As Html Bold

Description

Returns the specified text enclosed in HTML bold tags (sets the response phrase to <b>value</b>). No response status or response type is set.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Value ^

The text you want to format with bold tags.

 
Top of section

Return As Html Break

Description

Returns the specified text preceded or followed by HTML break tags, setting the response phrase to one of the following:

This action does not set the response status or response type.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Value ^

The text to which you want to add break tags.

After

When selected, a break tag is added after the text.

Before

When selected, a break tag is added before the text.

 
Top of section

Return As Html Checkbox

Description

Returns HTML for a check box. Sets the response phrase to HTML that looks something like this:

  <INPUT TYPE="CHECKBOX" VALUE="important" NAME="cb1" CHECKED>

This action sets the response type to TEXT and the response status to 302. If Stop Processing is checked, rule processing ends.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Name ^

A name for the check box, which becomes the value of the NAME attribute.

Stop Processing

When selected, the rule ends after this action.

Value ^

The value assigned to the VALUE attribute of the check box. This value is returned to the server when the check box is selected.

Checked

When selected, adds the CHECKED attribute to the HTML.

Append Response?

When selected, adds the HTML to the response phrase after any other text that is already there.

Disabled

When selected, adds the DISABLED attribute to the HTML.

 
Top of section

Return As Html File Upload

Description

Returns HTML for a file upload field. Sets the response phrase to HTML that looks something like this:

  <INPUT TYPE="FILE" VALUE="Select a file" NAME="fileupload" ACCEPT="image/*, text/html">

This action sets the response type to TEXT and the response status to 302. If Stop Processing is checked, rule processing ends.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Name ^

A name for the field, which becomes the value of the NAME attribute.

Stop Processing

When selected, the rule ends after this action.

Accept ^

A comma-separated list of MIME types for the ACCEPT attribute. These are the file types the user can select in the field. The attribute is not supported by all browsers.

Value ^

The value assigned to the VALUE attribute of the field. In an HTML page, the value is displayed in the field and replaced by the value the user enters.

Append Response?

When selected, adds the HTML to the response phrase after any other text that is already there.

Disabled

When selected, adds the DISABLED attribute to the HTML.

 
Top of section

Return As Html Hidden Field

Description

Returns HTML for a hidden field. Sets the response phrase to HTML that looks something like this:

  <INPUT TYPE="HIDDEN" VALUE="important" NAME="hfld1">

This action sets the response type to TEXT and the response status to 302. If Stop Processing is checked, rule processing ends.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Name ^

A name for the hidden field, which becomes the value of the NAME attribute.

Stop Processing

When selected, the rule ends after this action.

Value ^

The value assigned to the VALUE attribute of the field. In an HTML page, the value is returned to the server when the user submits the enclosing form.

Append Response?

When selected, adds the HTML to the response phrase after any other text that is already there.

Disabled

When selected, adds the DISABLED attribute to the HTML.

 
Top of section

Return As Html JavaScript

Description

Returns the JavaScript code you specify enclosed in HTML SCRIPT tags. Sets the response phrase to HTML that looks something like this:

  <SCRIPT LANGUAGE=JavaScript> [your code here] </SCRIPT>

This action sets the response type to TEXT and the response status to 302.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

JavaScript ^

The JavaScript code to be returned.

 
Top of section

Return As Html Option List

Description

Performs a SQL query and creates an HTML SELECT element from the result set. Sets the response phrase to HTML that looks something like this:

  <SELECT id=opt1 name=opt1 size=1 width= 100">
  <OPTION value="portalcorpid">Official
  <OPTION value="anonymous">Anonymous
  <OPTION value="administrator">User0
  <OPTION value="contentadmin">User1
  <OPTION value="default">null
  <OPTION value="sample">Sample
  <OPTION value="testID">Smith
  </SELECT>

This action sets the response type to TEXT and the response status to 302. The result set and SQL statement are stored on the whiteboard (see the Detail Key property in the table below). If you specify a Detail Key, the rule ends after this action.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

HTML Tag

The name of the SELECT element. The value is used for the NAME attribute.

User ID ^

The user ID expected by the database. This is not usually the same as the portal user ID.

SQL String ^

A SQL statement whose result set contains the values for the list.

NOTE:   If you are using a template key for this value, place the expression in quotes—for example:

  "!valueOf.mySQL"

Key Column

The column whose values will be used for the VALUE attribute of each OPTION element.

Size ^

The value for the SIZE attribute, which specifies the number of items to display in the list. Specify 1 for a dropdown list.

Database Name ^

The URL for the database. The format for the URL depends on the DBMS.

For more information    For more information, see Properties that support database drivers and URLs.

JDBC Driver ^

The Java class name for the JDBC driver.

For more information    For more information, see Properties that support database drivers and URLs.

Password ^

The password expected by the database. This is not usually the same as the portal user's password.

Detail Key

A name used to create whiteboard keys for the result set and SQL statement. The name is used for the result set, and name.sql is used for the SQL statement.

Children Column

The column containing related information. Generally this is left blank; it requires the database to be organized with parent/child relationships.

Width (%) ^

The value for the WIDTH attribute, which specifies the width of the list. This attribute is ignored by some browsers.

Description Column

The column whose values will be used as the text of each OPTION element.

 
Top of section

Return As Html Password

Description

Returns HTML for a password input field. Sets the response phrase to HTML that looks something like this:

  <INPUT TYPE="PASSWORD" VALUE="PASSWORD" NAME="default" SIZE="25" MAXLENGTH="50" READONLY>

This action sets the response type to TEXT and the response status to 302. If Stop Processing is checked, rule processing ends.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Read-only

Whether the user is allowed to enter a value.

Name ^

A name for the password field, which becomes the value of the NAME attribute.

Stop Processing

When selected, the rule ends after this action.

Maximum Length ^

The maximum number of characters allowed for the password.

Size ^

The value for the SIZE attribute, which is the width of the field.

Value ^

The value assigned to the VALUE attribute of the field. In an HTML page, this is the default value for the password field. Leave it blank if you don't want a default.

Append Response?

When selected, adds the HTML to the response phrase after any other text that is already there.

Disabled

When selected, adds the DISABLED attribute to the HTML.

 
Top of section

Return As Html Radio Button

Description

Returns HTML for a radio button. Sets the response phrase to HTML that looks something like this:

  <INPUT TYPE="RADIO" VALUE="One" NAME="radio1" CLASS="INPUT">

This action sets the response type to TEXT and the response status to 302. If Stop Processing is checked, rule processing ends.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Name ^

A name for the radio button, which becomes the value of the NAME attribute.

In HTML, to create a group of radio buttons that work together, give them all the same name.

Stop Processing

When selected, the rule ends after this action.

Value ^

The value for the VALUE attribute. In an HTML page, the value is returned to the server when the radio button is selected and its enclosing form is submitted.

Checked

When selected, adds the CHECKED attribute to the HTML.

Append Response?

When selected, adds the HTML to the response phrase after any other text that is already there.

Disabled

When selected, adds the DISABLED attribute to the HTML.

 
Top of section

Return As Html Reset Button

Description

Returns HTML for a reset button. Sets the response phrase to HTML that looks something like this:

  <INPUT TYPE="RESET" VALUE="Reset">

This action sets the response type to TEXT and the response status to 302. If Stop Processing is checked, rule processing ends.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Stop Processing

When selected, the rule ends after this action.

Value ^

The value for the VALUE attribute, which is the text displayed on the button.

Append Response?

When selected, adds the HTML to the response phrase after any other text already there.

Disabled

When selected, adds the DISABLED attribute to the HTML.

 
Top of section

Return As Html Scripted Button

Description

Returns HTML for a reset button. Sets the response phrase to HTML that looks something like this:

  <INPUT TYPE="BUTTON" VALUE="Cancel" onclick="JavaScript code here">

This action sets the response type to TEXT and the response status to 302. If Stop Processing is checked, rule processing ends.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Stop Processing

When selected, the rule ends after this action.

Value ^

The value for the VALUE attribute, which is the text displayed on the button.

Append Response?

When selected, adds the HTML to the response phrase after any other text already there.

Disabled

When selected, adds the DISABLED attribute to the HTML.

OnClick ^

JavaScript code to be run when the button is clicked.

 
Top of section

Return As Html Submit Button

Description

Returns HTML for a submit button. Sets the response phrase to HTML that looks something like this:

  <INPUT TYPE="SUBMIT" VALUE="Submit">

This action sets the response type to TEXT and the response status to 302. If Stop Processing is checked, rule processing ends.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Stop Processing

When selected, the rule ends after this action.

Value ^

The value for the VALUE attribute, which is the text displayed on the button.

Append Response?

When selected, adds the HTML to the response phrase after any other text already there.

Disabled

When selected, adds the DISABLED attribute to the HTML.

 
Top of section

Return As Html Table

Description

Constructs an HTML table tag, using the result set from the SQL query specified to create associated HTML table row and table data tags, and sets the result in the specified detail key.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

HTML Tag

Appends a NAME or ID attribute to the TABLE tag element.

User ID ^

The user ID expected by the database.

SQL String ^

The SQL statement you want to execute.

Border ^

The value for the HTML table BORDER attribute.

Database Name ^

The URL for the database. The format for the URL depends on the DBMS.

For more information    For more information, see Properties that support database drivers and URLs.

JDBC Driver ^

The Java class name for the JDBC driver.

For more information    For more information, see Properties that support database drivers and URLs.

Query String ^

The value for the HTML hyperlink query string.

Cell Spacing ^

The value for the HTML table CELLSPACING attribute.

Display Headings

When selected, appends the HTML table row for the table headings to the output buffer.

Password ^

The password expected by the database. This is not necessarily the same as the application user's password.

Cell Padding ^

The value for the HTML table CELLPADDING attribute.

Detail Key

A name used to create a whiteboard key for the result set and SQL statement. The name is used for the result set, and name.sql is used for the SQL statement.

Width ^

The value for the HTML table WIDTH attribute.

Description Column

The value for the column name in the result set whose data is used for the HTML OPTION tag DESCRIPTION.

 
Top of section

Return As Html Text Area

Description

Returns HTML for a multiline text field. Sets the response phrase to HTML that looks something like this:

  <TEXTAREA NAME="txt1" ROWS="25" COLS="50">This is where to enter text</TEXTAREA>

This action sets the response type to TEXT and the response status to 302. If Stop Processing is checked, rule processing ends.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Name ^

The name for the field, assigned to the NAME attribute.

Stop Processing

When selected, the rule ends after this action.

Columns ^

The width of the text field (specified as a number of characters) assigned to the COLS attribute.

Value ^

The default text to be displayed in the text field.

Rows ^

The length of the text field (specified as a number of characters) assigned to the ROWS attribute.

Append Response?

When selected, adds the HTML to the response phrase after any other text that is already there.

Disabled

When selected, adds the DISABLED attribute to the HTML.

 
Top of section

Return As Html Text Field

Description

Returns HTML for a single-line text field. Sets the response phrase to HTML that looks something like this:

  <INPUT TYPE="TEXT" VALUE="TEXT" NAME="default" SIZE="25" MAXLENGTH="50" READONLY>

This action sets the response type to TEXT and the response status to 302. If Stop Processing is checked, rule processing ends.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Read Only

When selected, the text cannot be edited.

Name ^

The name for the input field, assigned to the NAME attribute.

Stop Processing

When selected, the rule ends after this action.

Maximum Length ^

The maximum number of characters allowed, assigned to the MAXLENGTH attribute.

Size ^

The width of the text field (specified as a number of characters) assigned to the COLS attribute.

Value ^

The default text displayed in the text field.

Append Response?

When selected, adds the HTML to the response phrase after any other text already there.

Disabled

When selected, adds the DISABLED attribute to the HTML.

 
Top of section

Return As XML

Description

Submits a SQL query and formats the result set as XML. The root element is table, and its subelements are columns and tuples:

Subelement

Description

columns

Contains column elements that identify the column names.

tuples

Are the rows of data.

Each tuples element contains a tuple element for each row. Each tuple element contains a subelement for each column in the result set. The order of these match the column elements. The order of the elements must be preserved.

Sets the response phrase to XML that looks something like this:

  <table description="test user list" key="test" sqlString="select * from FWUSERS">
      <columns count="3">
          <column value="USERID"/>
          <column value="FIRSTNAME"/>
          <column value="LASTNAME"/>
      </columns>
      <tuples count="2">
          <tuple number="1">
              <tuple value="portalcorpid"/>
              <tuple value="Portal Corporate Administrator"/>
              <tuple value="unknown"/>
          </tuple>
          <tuple number="2">
              <tuple value="anonymous"/>
              <tuple value="Portal Anonymous User"/>
              <tuple value="unknown"/>
          </tuple>
      </tuples>
  </table>

This action sets the response type to TEXT and the response status to 302. The result set and SQL statement are stored on the whiteboard (see the Detail Key property in the table below). If you specify a Detail Key, the rule ends after this action.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

User ID ^

The user ID expected by the database. This is not usually the same as the portal user ID.

Detail Key

A name used to create whiteboard keys for the result set and the SQL statement. The name is used for the result set, and name.sql is used for the SQL statement.

Password ^

The password expected by the database. This is not usually the same as the portal user's password.

Description

Text that will be the value of a description attribute assigned to the root element, which is called table.

SQL String ^

A SQL statement whose result set contains the data to be formatted as XML elements.

NOTE:   If you are using a template key for this value, place the expression in quotes—for example:

  "!valueOf.mySQL"

JDBC Driver ^

The Java class name for the JDBC driver.

For more information    For more information, see Properties that support database drivers and URLs.

Database Name ^

The URL for the database. The format for the URL depends on the DBMS.

For more information    For more information, see Properties that support database drivers and URLs.

 
Top of section

Return Authentication Required

Description

Sets the context response status to 401, forcing the browser to ask for authentication.

 
Top of section

Return False

Description

Sets the response status to 412, which signifies the boolean value false.

 
Top of section

Return Response

Description

Sets the response phrase to the specified text. You can use !valueOf templates to build a text value from phrases stored on the whiteboard. Sets the response type to TEXT and the response status to 302. If Stop Processing is checked, rule processing ends.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Stop Processing

When selected, the rule ends after this action.

Response ^

The response phrase.

Append Response?

When selected, adds the HTML to the response phrase after any other text already there.

 
Top of section

Return Response With Default

Description

Returns text associated with a whiteboard key or uses a default message. Sets the response phrase to the message, stores the message on the whiteboard, sets the response type to TEXT, sets the response status to 302, and stops rule processing.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Default ^

A message to use if the Response key doesn't exist. If the Response key doesn't exist or has a null value, a new key is created whose name is the Response keyname and whose value is the Default message.

Response ^

A whiteboard key containing the message you want.

 
Top of section

Return True

Description

Sets the response status to 200, which signifies the boolean value true.

 
Top of section

Save Cookies To Whiteboard

Description

Puts the cookies the browser has sent onto the whiteboard. The whiteboard keys are created using the cookie name as the keyname and the cookie's value as the value for the key.

See also

Save Cookies To Whiteboard condition

 
Top of section

Save Form Get Data To Whiteboard

Description

Puts the query string from the browser on the whiteboard using the specified key.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Whiteboard Key ^

The name of the whiteboard key.

For more information    See Properties that support string templates.

See also

Save Form Get Data To Whiteboard condition

 
Top of section

Save Request Data To Whiteboard

Description

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.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

AutoClear

If this action has run before and the Detail Key includes a set of previously created keys, those keys are removed from the whiteboard before new keys are created from the current request data.

Detail Key ^

A whiteboard key in which to store the names of the keys being created.

NOTE:   The keys are stored in a Vector.

See also

Save Request Data To Whiteboard condition

 
Top of section

Save To Whiteboard

Description

Saves a value on the whiteboard using the specified keyname. The value is set on the whiteboard. No response phrase or status is set.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Whiteboard Key ^

The name to use for the whiteboard key where you want to save the value.

Data ^

The value you want to save on the whiteboard.

Resolve

When selected, !valueOf templates in the Data property are processed and the stored value contains the result. When not selected, the text is not evaluated and the whiteboard contains the text as entered.

 
Top of section

Send Mailer SMTP

Description

Sends an e-mail message to a specified e-mail address. No response phrase or status is set.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Subject

The subject line for the e-mail.

To

A valid e-mail address, in the form recipient@yourcompany.com.

SMTP Host

An SMTP mail host. These usually have the form smtp.yourcompany.com or mail.yourcompany.com.

Message ^

The text of the e-mail.

From

The sender's e-mail address, which is an e-mail address associated with your portal application.

Usage

Use this action to send alerts or logging information to an administrator.

 
Top of section

Set Component Parameter

Description

Sets the value of a component parameter for the current portal context. The component parameter must already exist.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Key ^

The name of the parameter.

Value ^

The value for the parameter.

 
Top of section

Set Cookie Value

Description

Creates a cookie or changes its value and expiration date. No response phrase or status is set.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Maximum Number of Days

The number of days the cookie will exist before the user's browser deletes it.

Cookie Value ^

The text value assigned to the cookie.

Cookie Name

The cookie's identifier.

 
Top of section

Set Date On Whiteboard

Description

Sets the current date on the whiteboard with a specified key and format. The default format is a timestamp, and the default time is the runtime value. You can specify other formats and time values.

Properties

Property

Description

Key

The key for the date value.

Format

The date format. For example:

  yyyy-MM-dd k:mm:ss.S

Default time is current (runtime). You can also specify a time value. For example, the following indicates today at 12 p.m.:

  yyyy-MM-dd 00:00:00.000 

For more information    For information:

  • About date formats, see the API documentation for java.text.SimpleDateFormat

  • About date values, see the API documentation for java.util.Date

 
Top of section

Set Expired

Description

Sets the context response headers in the browser to be expired. No response phrase or status is set.

 
Top of section

Set Next Activity

Description

Sets the destination link in a workflow process.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Addressee ^

User activities only: the user, group, or role defined for the activity. For nonuser activities, use the default.

NOTE:   if you are accessing an LDAP realm, specify the distinguished name—for example:

  cn=sample,ou=users

isRole

Check this if the Addressee field is a role.

Activity Name ^

The name of the activity, as defined in the workflow process.

Usage

This action is for use with a Rule link in the Workflow Editor.

 
Top of section

Set Pipeline Status

Description

Sets the active pipeline's canProcessRequests flag to On/Off for this action.

NOTE:   The active status is changed for this action only.

Properties

Property

Description

On

When selected, the pipeline is active for this action.

 
Top of section

Set Response Header

Description

Sets a named parameter value in the HTTP response header (EbiResponse) using the keyname and value you specify. No response phrase or status is set.

Properties

Property

Description

Key

The name of the parameter being added to the response header.

Value

The text value associated with the parameter name.

 
Top of section

Set Response Status

Description

Sets the response status to the value you specify. If your rule performs several actions, the response status will be the last status set.

Properties

Property

Description

Status

A status value. You must use one of the numeric values identified in EbiResponse.

For more information    For more information, see the API Reference.

Usage

To control the status value, make the Set Response Status action the last one in the rule.

 
Top of section

Set User Property

Description

Sets the value of a user attribute for the current portal context. The user attribute must exist.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Key ^

The name of the user attribute.

Value ^

The value for the user attribute.

 
Top of section

Set Workitem Priority

Description

Sets the specified value as an Integer associated with the current workitem.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Priority ^

A string value.

Usage

This action is for use with a Rule activity or a Rule link in a workflow process.

If you use this action with a Rule link, be sure the action section also sets the next destination. See Set Next Activity action.

 
Top of section

Set Workitem Value

Description

Sets the property value for the document associated with a workitem in a workflow process. The document and property must exist and already have been added to the workitem. This action handles locking and unlocking of the document to set the property.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Document Property ID ^

The ID for the property

Document ID ^

The document ID

Property Value ^

The property value to set

Usage

This action is for use with a Rule activity or a Rule link in a workflow process.

If you use this action with a Rule link, be sure the action section also sets the next destination. See Set Next Activity action.

 
Top of section

SQL Hierarchy

Description

Does the same as the SQL String action (next). There is no corresponding condition.

 
Top of section

SQL String

Description

Executes a SQL statement and stores the result on the whiteboard. If more than one row is returned, only the last row in the result set is saved to the whiteboard.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

User ID ^

The user ID expected by the database.

Password ^

The password expected by the database. This is not necessarily the same as the portal user's password.

SQL String ^

The SQL statement you want to execute.

NOTE:   If you are using a template key for this value, place the expression in quotes—for example:

  "!valueOf.mySQL"

JDBC Driver ^

The Java class name for the JDBC driver.

For more information    For more information, see Properties that support database drivers and URLs.

Database Name ^

The URL for the database. The format for the URL depends on the DBMS.

For more information    For more information, see Properties that support database drivers and URLs.

See also

SQL String condition

 
Top of section

Stop Rule Processing

Description

Ends processing of the current rule by throwing EboActionException. If the rule has been invoked as part of a rules pipeline, it ends the pipeline too.

 
Top of section

Subtract

Description

Performs subtraction. The value you specify is subtracted from a value stored in a whiteboard key. The whiteboard key then contains the result of the subtraction. No response status or response phrase is set.

Properties

Any property with the ^ character supports the !valueOf template construct. For more information, see Properties that support string templates.

Property

Description

Whiteboard Key ^

The keyname of a numeric value stored on the whiteboard. If the key doesn't exist, this action creates it. If the key's value is not numeric, it is treated as zero for the arithmetic operation.

Value

The numeric value you want to subtract from the value of the whiteboard key.




Copyright © 2004 Novell, Inc. All rights reserved. Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003 SilverStream Software, LLC. All rights reserved.  more ...