|
|
Registering Custom Events
This topic contains basic information about registering custom events. This information includes background information about custom events, how to register events using the Events Editor in the BEA E-Business Control Center, and what you need to do when you make changes to custom events.
This topic contains the following sections:
Note: You cannot change any of the standard events supplied with BEA Campaign Manager for WebLogic, BEA WebLogic Commerce Server, or BEA WebLogic Personalization Server.
Overview of Creating a Custom Event
The creation of a custom event is a multiple-step process. The following list provides an overview of the process:
Note: For information about defining an event and defining a trigger, see Creating Custom Events. For information about modifying the weblogiccommerce.properties file, and creating an entry in the EVENT_TYPE table, see Persisting Behavioral Tracking Data.
Why Register an Event?
When you create a custom event, you must register the event. Registering a custom event lets the E-Business Control Center know that the custom event exists. Registering permits campaign developers using the E-Business Control Center to create scenario actions that refer to the event. Registering also identifies the event's properties.
Whenever you change the event code, you must update the event registration. Conversely, whenever you change the event registration, you must also update the event code. A possible ramification of event modification is that the scenario actions that refer to the event's properties may need to be modified.
Registering a Custom Event
The Event Editor in the E-Business Control Center allows you to easily register a custom event. For the purpose of registering an event, you can consider an event property as a name-value pair. During the registration of a custom event, you specify the event's name, description, and one or more properties. Each property has a range, type of permissible value, and default value. The information you need to register for an event should be available from your Commerce Business Engineer (CBE) or Java developer.
The properties for a custom event includes the following information:
Note: When you set property values, you are not guaranteed that the property will adhere to these restrictions at run time. Events are not checked by the SchemaManager for adherence to a property schema. Therefore, you need to keep the event type definition and the event registration synchronized.
As the previous list suggests, a combination of property values are possible. The possible combinations of properties are listed here:
Instructions for Registering a Custom Event
To register a custom event, complete the following steps:
Note: For more information on connecting the E-Business Control Center to a server, see "Connecting the BEA E-Business Control Center to a Server" in the Using the E-Business Control Center documentation.
Figure 3-1 E-Business Control Center Window
Note: You cannot edit the standard events.
Figure 3-2 Event Editor Window
Figure 3-3 Edit Event Property Window
Note: If you select Boolean as the data type, the Selection mode and Value range are no longer available. The default for Boolean is Single, Restricted.
The type of window that appears depends on the values selected.
Entering Property Values and Setting the Default Value
Depending on the data type, different steps are required for entering values and setting default values. The following property categories are available:
Entering Properties with Boolean or a Single Value and Single Default
To enter the default value for Boolean property or a property with a single value and a single default (unrestricted), complete the following steps:
Figure 3-4 Enter Property Values Window—Boolean or Single Value, Single Default
Entering Properties with Multiple Values and Single, Multiple, or All Defaults
To enter multiple property values and set one or more defaults (unrestricted), complete the following steps:
Figure 3-5 Enter Property Values—Multiple Values, Single Default
Figure 3-6 Enter Property Values—Multiple Values, Multiple Restricted Defaults
Figure 3-7 Enter Property Values—Multiple Values, Multiple Unrestricted Defaults
Note: To remove the default value for a property with multiple values and a single default, click the Deselect All button.
Note: For multiple values without restrictions (that is, the Value range is Unrestricted), you do not need to select any defaults.
Entering Properties with Date and Time Values
Properties with date and time values can use all Selection mode and Value range settings. For more information about these settings, see Entering Properties with Boolean or a Single Value and Single Default and Entering Properties with Multiple Values and Single, Multiple, or All Defaults.
To enter date and time values and set one or more defaults, complete the following steps:
Figure 3-8 Enter Date/Time Values
Updating a Registered Custom Event
Whenever you make changes to a custom event's code, you should update that event's registration. Updating the registration lets the E-Business Control Center know about the changes in the custom event and aids campaign developers using the E-Business Control Center to modify any scenario actions that refer to the event.
To update a custom event, complete the following steps.
Note: For more information on connecting the E-Business Control Center to a server, see "Connecting the BEA E-Business Control Center to a Server" in the Using the E-Business Control Center documentation.
Note: You cannot edit standard events.
Figure 3-9 Explorer Window
Figure 3-10 Event Editor Window
Note: For more information about setting custom event properties, see Entering Property Values and Setting the Default Value. Figure 3-11 Edit Event Property Window
Note: If you change the property setting Data type, Selection mode, or Value range, the associated values will be erased. Figure 3-12 Enter Property Value Window
|
Copyright © 2001 BEA Systems, Inc. All rights reserved.
|