Skip Headers
Siebel CRM Configuring Siebel Open UI
Siebel Innovation Pack 2015
E52417-01
  Go to Documentation Home
Home
Go To Table Of Contents
Contents
Go To Index
Index

Previous
Previous
 
Next
Next
    View PDF

Customizing Calendars

This topic includes examples of customizing the calendar that Siebel Open UI displays. It includes the following information:

Deploying Calendars According to Your Calendar Deployment Requirements

Table 7-1 describes different deployment requirements and the work you must do to meet each requirement. To deploy calendars according to your calendar deployment requirements, locate the requirement in the Deployment Requirement column, and then do the work that the Work You Must Do column describes.

Table 7-1 Deployment Requirements and the Work You Must Do to Meet Each Requirement

Deployment Requirement Work You Must Do

Your deployment requires the following items:

  • Requires standard interactivity calendars

  • Does not require new calendar features that the 2012 Innovation Pack introduces

Do not modify the repository.

Siebel Open UI adds no new calendar features that the 2012 Innovation Pack introduces, such as the Event Style or Workweek features. All calendars work correctly:

  • High interactivity calendars work in Siebel Open UI the same way that they work in the high-interactivity client while in high-interactivity mode.

  • Standard interactivity calendars do not work in Siebel Open UI. They will continue to work in the same way that they previously worked in the high and standard interactivity clients.

  • Siebel Open UI calendars work in Open UI mode.

Your deployment requires the following items:

  • Requires Siebel Open UI Calendars

  • Requires new features that the 2012 Innovation Pack introduces

  • Does not require standard interactivity calendars

Import your Siebel Open UI modifications and a separate SIF file.

This SIF file imports Siebel Open UI modifications and a separate file that updates standard interactivity calendars to use the new Open UI control. If the user runs the Siebel application in high interactivity or standard-interactivity mode, then Siebel Open UI does not render any standard interactivity calendar and it might create an error.

Oracle includes this SIF file in a ZIP file in the Tools\RepPatch folder. For more information, see Siebel Maintenance Release Guide on My Oracle Support.


Using Fields to Customize Event Styles for the Calendar

Siebel Open UI comes predefined to use the Status field in the Action business component to supply the event style, by default. You can modify it to use any bounded, single-value field that resides in the Action business component.

To use fields to customize event styles for the calendar 

  1. Identify the applet that you must modify:

    1. In the client, navigate to the calendar page that displays the style that you must modify.

    2. Click the Help menu, and then click About View.

    3. Copy the applet name that the dialog box displays to the clipboard.

  2. Identify the field that must supply the event style:

    1. Open Siebel Tools.

      For more information, see Using Siebel Tools.

    2. In the Object Explorer, click Business Component.

    3. In the Business Components list, locate the Action business component.

    4. In the Object Explorer, expand the Business Component tree, and then click Field.

    5. In the Fields list, identify a bounded, single-value field.

      Siebel Open UI will use this field to supply the values that it displays in the Legend in the calendar in the client.

  3. Modify the applet:

    1. In the Object Explorer, click Applet.

    2. Click in the Applets list, click the Query menu, and then click New Query.

    3. Paste the applet name that you copied in Step 1 into the Name property, and then press the Enter key.

      To modify styles for:

      • All calendar applets. You can add user properties to the HI Calendar Base Applet. Siebel Open UI uses this applet to set styles for all applets.

      • One specific applet. You can add user properties to an individual applet. User properties that you define on an individual applet override the styles that the HI Calendar Base Applet specifies.

    4. In the Object Explorer, expand the Applet tree, and then click Applet User Prop.

    5. In the Applet User Props list, add the following applet user property.

      Property Value
      Name CSS Event Style
      Value Enter the name of the field that you identified in Step 2.

    6. In the Applet User Props list, add the following applet user property.

      Property Value
      Name CSS Event Style LOV
      Value Enter the LOV type that the field that you identified in Step 2 uses.

      Siebel Open UI will use the values that this list of values contains to populate the CSS Class tags in the HTML, and then to render the event and legend styles. It uses the EventStyle property that contains the language independent code. It uses the set of language independent codes that this field contains to define the range of possible values. The CSS Event Style LOV user property allows you to define a single set of styles that Siebel Open UI can use for all languages in a multilingual environment.

      If the CSS Event Style user property does not exist, or if the CSS Event Style LOV user property does not exist, then Siebel Open UI uses the following default values:

      • Status for the field.

      • EVENT_STATUS for the list of values.

  4. Compile your modifications.

  5. Restart the Siebel application.

  6. In the client, navigate to the Administration - Data screen, and then click List of Values.

  7. Query the List of Values list for all of the unique language independent codes that exist for this list of values type.

    For example, query the Type field for TODO_TYPE.

  8. Use a style sheet editor to open the theme-calendar.css file.

  9. For each value that you find in Step 7, create the following two styles.

    Style Description
    .fc-event-skin.calendar-EventStyle-LOVName Siebel Open UI uses this style for the event.
    #color_square_LOVName Siebel Open UI uses this style for the square that it displays on the legend.

    When Siebel Open UI creates the HTML to render the Calendar, it specifies these styles in the CLASS tag for the event and for the legend. It specifies the strings for the language independent code for the field with spaces removed. For example:

    ? .fc-event-skin.calendar-EventStyle-Completed and #color_square_Completed
    ? .fc-event-skin.calendar-EventStyle-NotStarted and #color_square_NotStarted
    ? .fc-event-skin.calendar-EventStyle-InProgress and #color_square_InProgress
    

    For an example of customizing a style sheet, see "Customizing Event Styles for the Calendar".

  10. Save the theme-calendar.css file.

  11. Clear the browser cache.

  12. Navigate to the Calendar view.

  13. Make sure Siebel Open UI displays the correct styles.

Allowing Users to Drag Items from List Applets to Create Calendar Events

You can configure Siebel Open UI so that the user can drag an item from a list applet, and then drop it on a calendar to create an event.

Allowing users to drag items from list applets to create calendar events 

  1. Do Step1.

  2. Test your work:

    1. Log in to the client, and then navigate to the list applet that you modified in Step1.

    2. Confirm that you can drag a record from the list applet, and then drop it on the calendar to create an event.

Customizing Event Styles for the Calendar

Style sheet attributes determine the color, transparency, font, and other styles for each status. You can modify these styles. You can use any single value field that resides in the Action business component to determine the style that Siebel Open UI uses to render events in the calendar. Siebel Open UI uses the value that the Status field contains to determine how the client displays an event in the calendar, by default. For example:

  • Done

  • Not Started

  • Planned

  • Success

To customize event styles for the calendar 

  1. Use an editor to open the theme-calendar.css file.

  2. Locate the code that specifies the style that you must modify.

    For example, locate the following code:

    #color_square_LOV_name {color: custom_attributes important;}
    .fc-event-skin.calendar-EventStyle-LOV_name{
    {custom_attributes}
    

    where:

    • LOV_name identifies the event status that you must modify, such as Done or NotStarted.


      Note:

      The LOV name specified in the code should not include spaces.

    • custom_attributes specify the style properties you can modify, such as the background color or font type.

  3. Modify the code that you located in Step 2, as necessary.

    For example:

    #color_square_Done {color: #d3ffd7!important;}
    .fc-event-skin.calendar-EventStyle-Done {
      background: #d3ffd7;
      border-color:#A8FFAF;
    }
    

    In this example, Siebel Open UI modifies the style for each Done appointment. It also modifies the style for the Done entry in the legend that it displays in the upper-left corner of the calendar.

    If Siebel Open UI cannot find a matching style for a LOVName, then it displays events in the default text color, which is typically black on white.

  4. Save your modifications, clear the browser cache, and then verify that Siebel Open UI displays the style you defined for the Done status.

Customizing Calendar Work Days

Siebel Open UI allows the user to specify values for the Workdays field and the Week Start field. It uses the user preferences that reference the Locale values, by default. It stores the following items:

  • Stores locale preferences in the Locale table (S_LOCALE).

  • Stores user preferences as predefault values from Locale values.

  • Stores user preferences in the user preferences file.

Specifying Work Days

If the user sets the user preference for the Weekly Calendar View to Work Week, then Siebel Open UI displays only the days that are specified as workdays. This preference can be specified at several levels, so Siebel Open UI uses the following priority:

  1. Personal user preference.

  2. Locale preference for the current user locale.

  3. Applet user property. This property provides high interactivity support.

  4. If none of these items are set, then Siebel Open UI displays the Monday through Friday, five day workweek.

Specifying the First Day of the Week

If the set of visible days does not include the First Day of Week preference, then Siebel Open UI displays the next visible day. For example, if the user uses a Monday through Friday, five-day workweek, and if the First Day of Week is Saturday, then Siebel Open UI displays Monday as the first day of the week in the Work Week calendar. It does this because Monday is the first visible day that occurs after Saturday.

Specifying Work Days and the First Day of the Week

You can define a default value for all users according to the locale, but a user can override this value. For example, assume the following:

  • The existing Work Week setting for all users is Monday through Friday, as determined by the Locale settings that the Siebel administrator sets.

  • A set of users work Monday through Friday.

  • Another set of users who provide weekend support work Wednesday through Sunday.

  • Each weekend user logs into the Siebel client and uses the User Preferences Calendar view to set their Wednesday through Sunday schedule. Siebel Open UI stores this modification in the user preferences file.

In this situation, Siebel Open UI does the following:

  • Displays Monday through Friday for each user who does not use the User Preferences Calendar view to modify their preference

  • Displays Wednesday through Sunday for each user who uses the User Preferences Calendar view to modify their preference

Customizing How Calendars Display Timestamps

You specify an applet user property to customize how the calendar displays timestamps.


Note:

If you have customized calendar to display timestamps, but still cannot see a timestamp, it might be hidden because the browser window is too small. In this case, modifications can be made to be made to the CSS.

To customize how calendars display timestamps 

  1. Open Siebel Tools.

    For more information, see Using Siebel Tools.

  2. In the Object Explorer, click Applet.

  3. In the Applets list, locate any calendar applet.

  4. In the Object Explorer, expand the Applet tree, and then click Applet User Prop.

  5. In the Applet User Props list, query the Name property for the following value:

    Enable Daily Time Display
    
  6. Set the Value property to one of the following values:

    • Always. Always display the timestamp immediately before the meeting subject. For example, 8:00 AM - 9:00 AM My Meeting.

    • Never. Do not display the timestamp.

    • Off-interval. Display the timestamp immediately before the meeting subject only if the meeting starts or ends at a time that is not consistent with the user preference that specifies how to display time intervals. For example, if the user preference includes intervals of 8:00, 8:30, 9:00, and so on, and if a meeting occurs from:

      • 8:00 to 8:30. Do not display the timestamp.

      • 8:03 to 8:14. Display the timestamp.

      • 8:00 to 8:15. Display the timestamp.

      An off-interval meeting is a meeting that does not start and end on a calendar increment. For example, if the calendar displays 30 minute increments, and if the user creates a meeting that does not start and end on the half-hour, then this meeting is an off-interval meeting. A 15 minute meeting that starts at 9:05 AM is an example of an off-interval meeting.

    If you do not specify an applet user property for a:

    • Daily view or weekly view. Siebel Open UI uses an off-interval value.

    • Monthly view. Siebel Open UI always displays the timestamp.

  7. Repeat Step 5 and Step 6 for the following applet user property:

    Enable 5Day Time Display
    
  8. Repeat Step 5 and Step 6 for the following applet user property:

    Enable Monthly Time Display
    

Replacing Standard Interactivity Calendars

Some standard interactivity calendars do not work properly in Siebel Open UI. This topic describes how to replace the calendars that standard-interactivity uses with the calendars that Siebel Open UI uses.

To replace standard interactivity calendars 

  1. Modify the applet:

    1. Open Siebel Tools.

      For more information, see Using Siebel Tools.

    2. In the Object Explorer, click Applet.

    3. In the Applets list, query the Name property for the following value:

      LS CIM eCalendar Weekly Applet
      

      Note:

      This step describes how to search for specific standard interactivity calendar. If you want to replace a different standard interactivity calendar, query for it in this step.

    4. Modify the Class property from CSSSWEFrameCalGridLS to the following value:

      CSSSWEFrameActHICalGrid
      

      This modification replaces standard-interactivity applets.

      .

    5. Compile your modifications.

  2. Test your modifications:

    1. Log in to the client.

    2. Make sure Siebel Open UI displays the correct applets.

      For example, make sure the Fullcalendar applet replaces the LS CIM eCalendar Weekly Applet.

Customizing How Users View Calendar Availability

Calendar availability is the amount of free time in a user's agenda for a specific day. Available time is calculated by taking the number of working hours defined by the user, and subtracting any events already scheduled for that day within the working hours. You can configure Siebel Open UI to display the number of free hours available for a user in the monthly view. If you choose to show calendar availability, you will no longer see scheduled events in the monthly view. Instead, each day will have the available free hours displayed. This topic describes how to show and hide the calendar availability.

To show and hide calendar availability 

  1. Open Siebel Tools.

    For more information, see Using Siebel Tools.

  2. In the Object Explorer, click Applet.

  3. In the Applets list, locate any calendar applet.

  4. In the Object Explorer, expand the Applet tree, and then click Applet User Prop.

  5. In the Applet User Props list, query the Name property for the following value:

    Enable BusyFreeTime
    
  6. Set the Value property to one of the following values:

    • Y. Show calendar availability.

    • N. Hide calendar availability.

Customizing the Calendar All Day Slot

The calendar all day slot is an area in calendar above the workday hours that lists all day events. All day events are calendar appointments that start and end at 00:00:00 in the user's time zone. By default, the all day slot is hidden. This topic describes how to show and hide the calendar all day slot.

To show or hide the calendar all day slot 

  1. Open Siebel Tools.

    For more information, see Using Siebel Tools.

  2. In the Object Explorer, click Applet.

  3. In the Applets list, locate any calendar applet.

  4. In the Object Explorer, expand the Applet tree, and then click Applet User Prop.

  5. In the Applet User Props list, query the Name property for the following value:

    Enable AllDay Slot
    
  6. Set the Value property to one of the following values:

    • Y. Show the calendar all day slot.

    • N. Hide the calendar all day slot.