Loading...

RECOMMENDATION: If you are using a version of The Portal Connector higher than 4.0, we strongly recommend utilizing the MVC based widgets and components to create your site. This documentation is for legacy purposes only and will soon be deprecated.

Rules Manager

Properties API Related
Widget Type:
Form Widgets
TPC Version:
  • 3.3 +
rules-manager-logo
The Rules Manager widget allows you to add additional logic functionality to your form. The widget itself is able to detect when a specified action has occurred, such as a text field containing a certain phrase or if a widget is focused. Some of the options that the widget can do when it is triggered include running Javascript, toggling the visibility of a widget, and even setting a widget to a specified value.

rules-manager

Configuration

  1. From the Portal Connector widget list, click and drag the Rules Manager widget into the body of your form.

  2. There are a variety of options to be configured in order for the widget to function properly. Click on the edit button to display the prompt. It should look like this: 

    RulesManager Properties

  3. In order for you to link widgets to the Rules Manager, you need to add a widgets' logical name to the 'Field' text fields. The logical name for every widget can typically be found in its properties tab and is located under the Advanced: Name for Developerscollapsible. For the Then field, you will use the drop down list to select a field that is present on the current form. 

  4. Logical widget names are usually formatted as the widgets' name followed by an ID (For example: RulesManager_C019). Please note that you cannot change a widgets' logical name once the widget has already been saved once.

  5. Once the correct widgets are hooked up to the Rules Manager, you can select an option. When options will typically look for a condition to be filled (When Field TextBox_C001 Is Equal To Monday...) before executing the Then option. (Then Set Field TextBox_C002 With 'They Suck!'). Each and every option can be combined to control and affect your form with the desired actions. For more information on When/Then options and how they can affect your forms, please see the How to Use the Rules Manager How-To.

  6. Once the desired options are set and the appropriate widgets are hooked up to the Rules Manager, you can click on the save button to save it.

Widget Properties

Basic Properties

When

The When option is similar to a listener. When a field is found to satisfy the chosen condition, you can alter existing controls in many ways. Applicable options include: Is Equal To, Changes, Key Up, Is Focused, Contains, Window Load, and Document Ready.

Then

The Then option allows you to choose what will happen when your defined When condition is satisfied. Applicable options include: Set, Show, Hide, Toggle, Enable, Disable, and Run Script.

Advanced Properties

Advanced properties provide additional functionality. They can be accessed by clicking on the "Advanced" Button in the bottom right corner of the widget designer.

When

The When option is similar to a listener. When a field is found to satisfy the chosen condition, you can alter existing controls in many ways. Applicable options include: Is Equal To, Changes, Key Up, Is Focused, Contains, Window Load, and Document Ready.

Then

The Then option allows you to choose what will happen when your defined When condition is satisfied. Applicable options include: Set, Show, Hide, Toggle, Enable, Disable, and Run Script.

API

get_dataFieldName()

Returns the developer name for the control. 

Returns

String

Full API With Examples

How to's

Related examples of Rules Manager Configuration