List of Event Handler Rule Action Properties
When creating an event handler using the com.brickstreet.connect.appevents.RuleActionHandler action classname, the Select Rule Action screen is used to determine the rule action that will be used when the triggering event occurs. The rule is also able to use information about the triggering event as part of the rule that is executed. The rule action is then tailored by the information from the triggering event. The available triggering rule action categories are:
Customer: Rules performed on a customer entities
Event: Rules performed using the triggering event itself
Session: Rules based on the current event session
User: Rules based on the Connect user
Utility: Rules based on determined data entities
Once the category and rule action are selected (e.g. Create Customer), clicking the Next button displays the rule action arguments for the rule action.
Each rule has a condition and returned object name associated with them. This information is displayed in the Condition and Returned Object Name fields respectively. The rule arguments for the rule are displayed in the Rule Action Arguments section of the page. These arguments will differ for each rule.
For more information on the available event handler rule actions, please see List of Event Handler Rule Actions.
Below is a list of each of the rule actions with a list of the available rule attributes and arguments available to each rule action argument.
Table 1. Customer Rule Action Attributes
|
Rule Action |
Rule Attributes |
Available Rule Arguments |
|
Create Customer |
ID COMPANY ID ALTERNATIVE ID FIRST NAME MIDDLE NAME LAST NAME EMAIL ADDRESS SALUTATION ADDRESS LINE 1 ADDRESS LINE 2 CITY STATE POSTAL CODE COUNTRY ORGANIZATION BIRTHDATE PHONE FAX SMS NUMBER ACTIVE EMAIL ADDRESS ALTERNATE CUSTOMER ID ALTERNATE PHONE ANDROID REGISTRATION ID ATTRIBUTE1 ATTRIBUTE10 ATTRIBUTE11 ATTRIBUTE12 ATTRIBUTE2 ATTRIBUTE3 ATTRIBUTE4 ATTRIBUTE5 ATTRIBUTE6 ATTRIBUTE7 ATTRIBUTE8 ATTRIBUTE9 CHANNEL ADDRESS CONTENT TYPE CODE DATE OF ACQUISITION DEMO NET WORTH BRACKET EMAIL CLIENT TYPE FACEBOOK ID GENDER LANGUAGE MPNS CHANNEL URI OPERATING SYSTEM PROVINCE SECURE EMESSAGEID TERMINATION DATE TWITTER ID ZIP CODE IOS DEVICE TOKEN ID MUSIC NEW PREFERENCE SPORTS |
interaction_id interaction_name campaign_id message_id segment_id delivery_channel_id deployment_id |
|
Fetch Conversation by Name |
CONVERSATION NAME |
interaction_id interaction_name campaign_id message_id segment_id delivery_channel_id deployment_id |
|
Fetch Customer by Alternate ID |
CUSTOMER ALTERNATE ID |
interaction_id interaction_name campaign_id message_id segment_id delivery_channel_id deployment_id |
|
Fetch Customer by Email Address |
CUSTOMER EMAIL |
interaction_id interaction_name campaign_id message_id segment_id delivery_channel_id deployment_id |
|
Fetch Customer by ID |
CUSTOMER ID |
interaction_id interaction_name campaign_id message_id segment_id delivery_channel_id deployment_id |
|
Fetch Customer by SMS |
CUSTOMER SMS |
interaction_id interaction_name campaign_id message_id segment_id delivery_channel_id deployment_id |
|
Match Customer |
CUSTOMER ID FIRST NAME LAST NAME EMAIL ADDRESS |
interaction_id interaction_name campaign_id message_id segment_id delivery_channel_id deployment_id |
|
Subscribe Customer |
CUSTOMER ID CONVERSATION ID |
interaction_id interaction_name campaign_id message_id segment_id delivery_channel_id deployment_id |
|
Unsubscribe Customer |
CUSTOMER ID CONVERSATION ID |
interaction_id interaction_name campaign_id message_id segment_id delivery_channel_id deployment_id |
|
Unsubscribe Customer 2 |
CUSTOMER ID CONVERSATION ID |
interaction_id interaction_name campaign_id message_id segment_id delivery_channel_id deployment_id |
|
Unsubscribe Customer 3 |
CUSTOMER ID CONVERSATION ID |
interaction_id interaction_name campaign_id message_id segment_id delivery_channel_id deployment_id |
|
Unsubscribe Customer All |
CUSTOMER ID |
interaction_id interaction_name campaign_id message_id segment_id delivery_channel_id deployment_id |
|
Unsubscribe Customer All 2 |
CUSTOMER SMS |
interaction_id interaction_name campaign_id message_id segment_id delivery_channel_id deployment_id |
|
Unsubscribe Customer All 3 |
CUSTOMER EMAIL |
interaction_id interaction_name campaign_id message_id segment_id delivery_channel_id deployment_id |
|
Update Customer |
ID COMPANY ID ALTERNATIVE ID FIRST NAME MIDDLE NAME LAST NAME EMAIL ADDRESS SALUTATION ADDRESS LINE 1 ADDRESS LINE 2 CITY STATE POSTAL CODE COUNTRY ORGANIZATION BIRTHDATE PHONE FAX SMS NUMBER ACTIVE EMAIL ADDRESS ALTERNATE CUSTOMER ID ALTERNATE PHONE ANDROID REGISTRATION ID ATTRIBUTE1 ATTRIBUTE10 ATTRIBUTE11 ATTRIBUTE12 ATTRIBUTE13 ATTRIBUTE14 ATTRIBUTE15 ATTRIBUTE2 ATTRIBUTE3 ATTRIBUTE4 ATTRIBUTE5 ATTRIBUTE6 ATTRIBUTE7 ATTRIBUTE8 ATTRIBUTE9 CHANNEL ADDRESS CONTENT TYPE CODE DATE OF ACQUISITION DEMO NET WORTH BRACKET EMAIL CLIENT TYPE FACEBOOK ID GENDER LANGUAGE MPNS CHANNEL URI OPERATING SYSTEM PROVINCE SECURE EMESSAGEID TERMINATION DATE TWITTER ID ZIP CODE IOS DEVICE TOKEN ID MUSIC NEW PREFERENCE SPORTS |
interaction_id interaction_name campaign_id message_id segment_id delivery_channel_id deployment_id |
Table 2. Event Rule Action Attributes
|
Rule Action |
Rule Action Attributes |
Available Rule Arguments |
|
Create EventQueue Object |
CAMPAIGN EVENT CUSTOMER |
|
|
Fetch Event |
CAMPAIGN |
|
|
Fetch Event Campaign |
CAMPAIGN NAME |
interaction_id interaction_name campaign_id message_id segment_id delivery_channel_id deployment_id |
|
Save Event |
EVENT QUEUE OBJECT |
|
|
Set Event Queue Parameter |
EVENT EVENT QUEUE |
|
|
Set Event Queue Parameter |
PARAMETER NAME PARAMETER VALUE |
interaction_id interaction_name campaign_id message_id segment_id delivery_channel_id deployment_id |
Table 3. Session Rule Action Attributes
|
Rule Action |
Rule Attributes |
Available Rule Arguments |
|
Exit Survey Rules |
n/a |
|
|
Set Next URL |
URL |
Value entered by user |
Table 4. User Rule Action Attributes
|
Rule Action |
Rule Attributes |
Available Rule Arguments |
|
Fetch Group by Name |
GROUP NAME |
interaction_id interaction_name campaign_id message_id segment_id delivery_channel_id deployment_id |
|
Fetch User by Login |
USER LOGIN |
interaction_id interaction_name campaign_id message_id segment_id delivery_channel_id deployment_id |
|
Send Email to Group |
GROUP SUBJECT EMAIL CONTENT |
Value entered by user |
|
Send Email to User |
USER SUBJECT EMAIL CONTENT |
Value entered by user |
Table 5. Utility Rule Action Attributes
|
Rule Action |
Rule Attributes |
Available Rule Arguments |
|
Evaluate Expression |
EXPRESSION |
Value entered by user |
|
Fetch Field |
OBJECT FIELD NAME |
|
|
Generate Unique String |
BASE |
interaction_id interaction_name campaign_id message_id segment_id delivery_channel_id deployment_id |
|
Identify |
OBJECT |
|
|
Set Field |
OBJECT FIELD NAME |
|
|
Set Field |
NEW VALUE |
interaction_id interaction_name campaign_id message_id segment_id delivery_channel_id deployment_id |