Siebel eEvents Management Guide for Financial Services > Configuring and Managing the Events Calendar >

Configuring the Events Calendar

There are two required tasks and one optional task for configuring the events calendar:

Enabling High-Interactivity Browser Functionality

The following procedure describes how to modify the Siebel configuration file to enable high-interactivity browser functionality.

To modify the Siebel configuration file to enable high interactivity

  1. Navigate to the configuration file, and open the file.
  2. Set HighInteractivity = TRUE. If HighInteractivity = FALSE, the browser cannot display the events calendar.

Configuring the Calendar Display with Siebel Tools

In order to display the events calendar, Event High Interactivity (HI) Calendar Applet settings must be modified using Siebel Tools.

As described in the following procedure, Event HI Calendar Applet settings are configured through the client side of the application.

To configure the calendar display with Siebel Tools

  1. In Siebel Tools, locate Event HI Calendar Applet. The underlying business component for Event HI Calendar Applet is eEvents Event.
  2. Customize behavior in the calendar's interface and display properties through the Applet User Prop, which defines the user properties that define the input settings for the calendar. The following table describes some values you can use for customization purposes. The table also lists internal user properties, which should not be modified during configuration. For more information, see Siebel Tools Reference.

    3. Field
    Comments
    Field[1...x] = VALUE
    Where VALUE is any field on the applet's business component to be returned in the property set on the client side in JavaScript.
    HIC_DAY_VIEW = VALUE
    HIC_MONTH_VIEW = VALUE
    HIC_WEEK_VIEW = VALUE
    Where if VALUE = "ENABLED", these tabs will appear for the calendar.
    HIC_OVERFLOW_CELL = VALUE
    Where if VALUE = "Enabled", the cells of the calendar expand to fit the data.
    Sdate = VALUE
    Where VALUE is the name of the field corresponding to the start date interval being used for searching in the applet's business component.
    Ddate = VALUE
    Where VALUE is the name of the field corresponding to the end date interval being used for searching in the applet's business component.
    HIC_7DAY_SCHED_PARAMS.cols
    HIC_7DAY_SCHED_PARAMS.rows
    HIC_7DAY_SCHED_PARAMS.split
    HIC_7DAY_SCHED_PARAMS.timeslots
    HIC_STARTTIME
    HIC_ENDTIME
    UserID
    UID
    SkipInitialQuery
    These are internal user properties that configurators do not use.

Configuring the Calendar Display with JavaScript

In addition to using Siebel Tools to configure the calendar display, you can configure the calendar display directly by modifying JavaScript code in the script file applet_event_hi_calendar_applet.js. This is an optional approach to configuring the events calendar.

NOTE:  Client settings can override the JavaScript in the applet_event_hi_calendar_applet.js file.

The main function in the script is:

Event_HI_Calendar_Applet_Applet_PreInvokeMethod (name, inputPropset)

This function accesses the HTML that is used to format the events calendar display. Thus, by modifying this function, you can modify formatting of the events calendar. Moreover, this function's name parameter takes a value that determines whether the weekly and monthly calendar format is invoked or whether the daily calendar format is invoked, as described in Table 7. Depending on which lines of code are invoked, different HTML is accessed. As a result, you can modify the HTML to reformat the weekly and monthly calendar display without affecting the daily display, and vice versa.

Table 7. Parameter Values for Displaying the Events Calendar
Value
Comments
RenderCalendar_Week_Month
If this value is passed in, code for displaying the weekly and monthly calendar format is invoked. The code for displaying the weekly and monthly calendar can be modified.
RenderCalendar_Daily_Today
If this value is passed in, code for displaying the daily calendar format is invoked. The code for displaying the daily calendar can be modified.

Other useful JavaScript code for configuring the events calendar is described in Table 8.

Table 8. JavaScript Code for Configuring the Events Calendar
JavaScript Code
Comments
oPropset
This object contains a collection of event records. The fields in these records are defined in the user properties of Event HI Calendar Applet and can be accessed by an administrator. To access the Event Type value of an event record, do the following:
  1. Define a user property in Event HI Calendar Applet as Field1 - Event Type.
  2. Reference the Event Type property oDoc.GetProperty("4") in applet_event_hi_calendar_applet.js.
while((oDoc=oPropset.EnumChildren(bt))!=null)
This code loops through each item. oDoc contains a record from the eEvents Event business component. All of the records of oPropset are returned, enumerated, and bucketed into the correct date slot.
Event Type = oDoc.GetProperty("4")
Event Name = oDoc.GetProperty ("5")
Status = oDoc.GetProperty ("6")
Created = oDoc.GetProperty ("7")
Updated = oDoc.GetProperty ("8")
These business component fields are accessible from the client side of the application.
Sched_Params
The global calendar JavaScript object that contains the HTML for each cell in the calendar. The HTML for each cell can be accessed via SCHED_PARAMS.dateRangeData[y] where y represents the cell date ordinal. In weekly mode, y is 0 through 6. In monthly mode, y is 0-number of days in the month.
Note that a date comparison is done as follows:
(SCHED_PARAMS.dateRange[x].toDateString("mm/dd/yyyy"))
This toDateString comparison must be kept in this format (mm/dd/yy) because it is internal to the core calendar class and how dates are stored. To determine in which cell to place a record, perform a date comparison with each record enumerated.
GetBannerColor()
This function highlights the different event types and places banner colors behind them. To change the colors, change the values assigned to each event type with this function.


 Siebel eEvents Management Guide for Financial Services 
 Published: 18 April 2003