List of Event Handler Rule Actions

When creating an event handler using the com.brickstreet.connect.appevents.RuleActionHandler action classname, a rule action needs to be defined when using the Edit RuleSet action for the event handler. In the Define Rules screen, the New Rule command provides a list of rule actions divided into categories by type. For more information on editing rulesets for event handlers using the com.brickstreet.connect.appevents.RuleActionHandler action classname, please see Editing Event Handler RuleSets for the Rule Action Handler.

images/download/attachments/56624382/event_handlers_define_rules_new_rule_select_rule_action.PNG

To select a rule action, select the desired category type to view the available rule actions.
Note: The All Rule Action category is the concatenated list of all of the rule actions listed in alphabetical order.

The following tables describe the available rule actions for the com.brickstreet.connect.appevents.RuleActionHandler action classname event handler.

Table 1. Customer Rule Actions

Rule Action	Description
Create Customer	Creates a new customer record
Fetch Conversation by Name	Fetches the associate conversation by the name of the conversation
Fetch Customer by Alternate ID	Fetches the customer record using the associated Alternate ID value
Fetch Customer by Email Address	Fetches the customer record using the associated email address value
Fetch Customer by ID	Fetches the customer record using the associated Customer ID value
Fetch Customer by SMS	Fetches the customer record using the associated SMS value
Match Customer	Matches the customer record using the entered customer value
Subscribe Customer	Subscribes the customer to the associated conversation
Unsubscribe Customer	Unsubscribes the customer from a conversation using the customer ID and the conversation ID
Unsubscribe Customer 2	Unsubscribes the customer from a conversation using the customer email and the conversation name
Unsubscribe Customer 3	Unsubscribes the customer from a conversation using the customer SMS value and the conversation name
Unsubscribe Customer All	Unsubscribes the customer from all conversations using the customer ID
Unsubscribe Customer All 2	Unsubscribes the customer from all conversations using the customer SMS number
Unsubscribe Customer All 3	Unsubscribes the customer from all conversations using the customer email
Update Customer	Updates the customer value

Table 2. Event Rule Actions

Rule Action	Description
Create EventQueue Object	Creates an EventQueue object
Fetch Event	Fetches the associated event associated to the campaign configured in the rule properties
Fetch Event Campaign	Fetches the information for the campaign associated with the rule as configured in the rule properties
Save Event	Saves the EventQueue object to the database
Set Event Queue Parameter	Sets the event queue parameter that is configured in the rule properties

Table 3. Session Rule Actions

Rule Action	Description
Exit Survey Rules	Exits the survey rules disregarding all the rules that follow from the point of the exit
Set Next URL	Displays the URL that is configured in the rule properties

Table 4. User Rule Actions

Rule Action	Description
Fetch Group by Name	Fetches the user group name as configured in the rule properties
Fetch User by Login	Fetch the user by the user's login name
Send Email to Group	Sends a specific email message to a group configured in the rule properties. The email subject and email content are configured in the rule properties.
Send Email to User	Sends a specific email message to a user configured in the rule properties. The email subject and email content are configured in the rule properties.

Table 5. Utility Rule Actions

Rule Action	Description
Evaluate Expression	Returns the value of a mathematical argument that is configured in the properties of the rule
Fetch Field	Fetches a field from a data object that is configured in the properties of the rule
Generate Unique String	Generates a unique string based on a base value configured in the rule properties
Identity	Returns a data object configured in the rule properties that will in turn be assigned to another returned object name
Set Field	Sets a data field value based on a configured object and field name. The value is configured in the rule properties.