Bookshelf Home | Contents | Index | PDF     

Configuring Siebel Open UI > Customizing Calendars and Schedulers > Customizing Resource Schedulers >

Customizing a Resource Scheduler

This topic describes how to customize a resource scheduler.

To customize a resource scheduler

  1. Configure the applet that Siebel Open UI uses to display the resource scheduler:
    1. Open Siebel Tools.

      For more information, see Using Siebel Tools.

    2. In the Object Explorer, click Applet.

      This example includes the minimum set of objects that you must add. To view predefined applets that Siebel Open UI uses for a resource scheduler, you can query the name property for TNT Function Bookings Gantt Applet or FS DB Planned GanttChart AX Applet. To simplify creating your resource scheduler, you can make a copy of one of these applets, and then modify the copy.

    3. In the Applets list, add a new applet, or copy one of the applets mentioned in Step b.
    4. Set the following property for the applet that you added in Step c.
      Property
      Value

      Class

      CSSSWEFrameGantt
    5. In the Object Explorer, expand the Applet tree, and then click Applet User Prop.
    6. In the Applet User Props list, add the following applet user properties. Each value in the Value property supports this example. You can use values that your deployment requires. You must include all of these user properties.
      Name
      Value
      Description

      Gantt Open UI Service

      TNT Gantt UI Service

      Specify the business service name that Siebel Open UI uses to save system preferences and user preferences.

      Physical_Renderer

      GanttTNTRenderer

      Specify the name of the class that Siebel Open UI uses for the physical renderer.

      Presentation_Model

      GanttTNTPresentationModel

      Specify the name of the class that Siebel Open UI uses for the presentation model.

      ClientPMUserProp

      EnableTooltip,Date Padding for TimeScale LIC,DateBar Navigation TS

      Specify the user properties that Siebel Open UI makes available to JavaScript files that reside on the client. You must use a comma to separate each user property name.

      Date Padding for TimeScale LIC

      time_scale_identifier:number_of_pages

      Specify the number of pages that Siebel Open UI uses in the cache for the time scale. For more information, see Customizing the Cache That Siebel Open UI Uses for Time Scales.

      DateBar Navigation TS

      time_scale_identifier:small_date_change, big_date_change

      Specify the date navigation buttons. For more information, see Customizing the Date Navigation Buttons.

      Duration for TimeScale LIC

      time_scale_identifier:number_of_days

      For example:

      1:7;2:1;4:1;32:36;64:31;128:7;256:35;512:1;1024:1

      Specify the number of days that Siebel Open UI sends to the cache for each time scale. For example, the following value specifies to send seven days of data to the cache for the Week/Day time scale:

      1:7

      You can use a semicolon to specify days for more than one time scale.

      Siebel Open UI uses a number to identify each time scale. For more information, see Determining the Number That Siebel Open UI Uses to Identify Time Scales.

      No. Of Panes

      3

      This applet user property specifies the number of panes that Siebel Open UI displays. A resource scheduler always displays the Resource pane, Time Scale pane, and the Scheduler pane, so you must not modify this applet user property.

      Custom Control Name

      s_Diary

      Specify the name of the custom control.

      Custom Control

      "Legend Control Name,s_Legend"

      Specify the tag that Siebel Open UI uses to render each custom control. Siebel Open UI uses this information to parse the input property set when it renders a custom control. Use the following format for each value:

      control_name,tag_name

      where:

      • control_name specifies the name of the custom control.
      • tag_name specifies the tag name that you define in the Tag Name control user property in Step c.

      For example, the following value specifies to use the s_Legend tag for the Legend Control Name control:

      Legend Control Name,s_Legend

      You can use Custom Control 1 and Custom Control 2 to specify more controls, as required.

      Custom Control 1

      "DateBar Control Name,s_DateBar"

      Custom Control 2

      "GanttChart,s_Diary"
    7. Configure system preferences and user preferences.

      In the Applet User Props list, add the following applet user properties. Each value in the Value property supports this example. You can use values that your deployment requires. You must include all of these user properties.

      Name
      Value
      Description

      Support System Preferences

      Y

      If the value is N or empty, then Siebel Open UI does not support system preference usage with a resource scheduler.

      Support User Preferences

      Y

      System_Pref Field number

      For example, System_Pref Field 1, System_Pref Field 2, and so on.

      "GntAXCtrl:Time Scale", "TST", "TNT_SHM_GNTAX_TIME_SCALE"

      Specify the default values that Siebel Open UI uses in a resource scheduler. You can use the following abbreviations:

      • TST. Specifies the Time Scale.
      • ST. Specifies the start time of the schedule.
      • ET. Specifies the End time of the schedule.

      If a field is a LOV field, then you must specify the LOV name so that the code gets the language-dependent value.

      For more information about the abbreviations that the Value property contains, see Using Abbreviations When Customizing the Resource Scheduler.

      System_Pref_Prefix

      GntAXCtrl:

      Specify the prefix that Siebel Open UI uses for every system preference that it uses with a resource scheduler. You must use this prefix. Siebel Open UI only queries system preferences that include this prefix. It does this query in the System Preferences business component.

      User_Pref Field number

      For example, User_Pref Field 1, User_Pref Field 2, and so on.

      "Display Toggle - Query", "Display Toggle"

      Specify the user preference name. Siebel Open UI sends an abbreviation of this user preference to the client.

      User_Pref_Prefix

      Diary

      Specify the prefix that Siebel Open UI uses for every user preference that it uses with a resource scheduler. You must use this prefix. Siebel Open UI queries only the user preferences that include this prefix. It does this query in the User Preferences business component.

      You can use these system preferences and user preferences to configure Siebel Open UI to do decision making in your custom JavaScript code that resides on the client. For example, you can set a user preference for the default time scale to Month and Day, and then use this default in your custom JavaScript code to set the default time scale. User preferences take precedence over system preferences. If a user preference exists, then Siebel Open UI uses it instead of the corresponding system preference.

    8. Specify the methods that Siebel Open UI uses with the Siebel Server.

      In the Applet User Props list, add the following applet user properties. These applet user properties specify the methods that Siebel Open UI uses with the Siebel Server. You must add them so that Siebel Open UI can call the methods that reside on the Siebel Server. You must not modify these methods. You must also add a CanInvokeMethod applet user property for every method that your custom JavaScript calls on the Siebel Server. Make sure you set the Value property for each of these applet user properties to True.

      Property
      Description

      CanInvokeMethod: DoInvokeDrilldown

      A resource scheduler supports drilldowns through the Resource, Schedule, and Timescale panes. If the user clicks a label in one of these panes, then Siebel Open UI calls the DoInvokeDrilldown method.

      CanInvokeMethod: DoOperation

      Calls the DoOperation method. Siebel Open UI calls this method for various events, such as drag and drop, extend, shrink, create task, and so on.

      CanInvokeMethod: FilterDisplayOptions

      Specifies how Siebel Open UI displays bookings when the user clicks Set to set criteria in the Filter pane. You must configure Siebel Open UI to call the FilterDisplayOptions method, typically through the Set button. This configuration enables Siebel Open UI to filter events according to the attributes that it defines for each control.

      CanInvokeMethod: FilterGantt

      Specifies how Siebel Open UI displays bookings when the user sets a criteria in the Filter pane.

      CanInvokeMethod: InitPopup

      Calls the popup dialog box for some operations, such as drag and drop, create task, and so. You cannot customize this behavior.

      CanInvokeMethod: InvokeOperation

      Specifies the method that Siebel Open UI calls when the user clicks a button in the popup applet. You cannot customize this behavior. This popup applet is the TNT Gantt Popup Applet that Siebel Open UI configures for the applet user property.

      CanInvokeMethod: ReSetFilterGantt

      Resets the resource filter options to default values. Siebel Open UI displays these options in the Filter pane.

      CanInvokeMethod: RefreshGantt

      Calls the Refreshgantt method. Siebel Open UI uses this method to refresh a resource scheduler.

      CanInvokeMethod: ResetDisplayOptions

      Resets the display filter options to default values. Siebel Open UI displays these options in the Filter pane.

      CanInvokeMethod: SaveControlValues

      Stores the user preference values that the Filter pane fields contain. You cannot customize this behavior.
  2. Configure optional applet user properties.

    You use applet user properties for most of the optional customization that you can configure in a resource scheduler. For more information about how to do this customization, see the following topics:

  3. Add controls:
    1. In the Object Explorer, click Control.
    2. In the Controls list, add the following controls.
      Name
      Caption - String Reference

      1

      SBL_TNT_TS_WEEK_DAY

      2

      SBL_TNT_TS_DAY_DAYPART

      4

      SBL_TNT_TS_DAY_HOUR

      64

      SBL_TNT_TS_MONTH_DAY

      128

      SBL_TNT_TS_WEEKDAY_DAYPART

      256

      SBL_TNT_TS_MONTH_DAY_OF_WEEK

      Note the following:

      • A resource scheduler requires each of these controls for the time scale.
      • You must add a control for each time scale.
      • Set the Name property of each control to the time_scale_identifier, such as 1, 2, 4, and so on. Siebel Open UI uses a number to identify each time scale, such as 128 or 256. It does not use values 8, 16, or 32 for time scales with Siebel Hospitality. It might use different values for a different Siebel application. For more information, see Determining the Number That Siebel Open UI Uses to Identify Time Scales.
      • Set the HTML Type property of each control to MiniButton.
      • Set the Method Invoked property of each control to RefreshGantt.
    3. In the Controls list, add the following controls.
      Name
      HTML Type
      Class
      Description

      GanttChart

      CustomControl

      CSSSWEFrameGantt

      Specifies the main resource scheduler control.

      GanttDateBar

      CustomControl

      CSSSWEFrameGantt

      Specifies the Date bar that contains the date controls. Allows the user to modify the date in a resource scheduler.

      Legend

      CustomControl

      CSSSWEFrameGantt

      Specifies the legend that Siebel Open UI displays in a resource scheduler.

      GoToResource

      Field

      Leave empty.

      Specifies the optional input text control that searches for resources that reside in the Resource pane.

      Siebel Open UI binds the event to this control in the JavaScript that resides on the client, so you must use GoToResource as the name.

      Make sure you set the Caption - String Reference property of the GoToResource control to SBL_GO_TO-1004233041-4MM. Do not set this property for the other controls.

    4. In the Object Explorer, expand the Control tree, click Control User Prop, and then use the Control User Props list to add the following control user properties to each of the controls that you added in Step c.
      Parent Control
      Value Property

      GanttChart

      s_Diary

      GanttDateBar

      s_DateBar

      Legend

      s_Legend

      Set the Name property for each control user property to Tag Name. Each of these control user properties specifies a tag name for the control. This configuration allows the JavaScript code to access the tag.

  4. Edit the web template:
    1. In the Object Explorer, click Applet Web Template.
    2. In the Applet Web Templates list, create the following applet web template.
      Property
      Value

      Name

      Edit

      Type

      Edit

      Web Template

      Applet OUI Gantt

      Upgrade Behavior

      Admin
    3. In the Object Explorer, click Applet.
    4. In the Applets list, right-click the applet that you are modifying, and then click Edit Web Template.
    5. In the Web Template Editor, add each of the controls that you added in Step 3 and Step c to the layout.

      It is recommended that you position each of these controls on the right side of the layout.

    6. Set the Item Identifier property of the GanttDateBar control to 3000.
    7. Close the Web Layout Editor.
  5. Configure the application:
    1. In the Object Explorer, click Application.
    2. In the Applications list, query the Name property for the application that you are modifying.
    3. In the Object Explorer, expand the Application tree, and then click Application User Prop.
    4. In the Application User Props list, add the following application user property.
      Property
      Value

      Name

      ClientBusinessServicenumber

      For example, ClientBusinessService1.

      Value

      Gantt UI Service

      You must add a new application user property for each business service that your customization calls in the client. In this example, you specify the Gantt UI Service business service. You must increment the Name for each application user property that you add. For example, ClientBusinessService1, ClientBusinessService2, and so on.

  6. Compile your modifications.
  7. Test your modifications:
    1. Log in to the client.
    2. Navigate to the resource scheduler, and then test your modifications.

Customizing the Cache That Siebel Open UI Uses for Time Scales

This topic describes how to customize the cache that Siebel Open UI uses for time scales.

To customize the cache that Siebel Open UI uses for time scales

  1. Specify the number of pages to use in the cache for a time scale.

    Use the following value for the Date Padding for TimeScale LIC applet user property:

    time_scale_identifier:number_of_pages

    where:

    • time_scale_identifier specifies the time scale.
    • number_of_pages specifies the number of pages that Siebel Open UI uses for the previous operation and for the next operation. It uses these pages when it prepares the page cache for the time scale that the time_scale_identifier specifies.

      The following example specifies the Week/Day time scale LIC, and it specifies to use 2 pages for the previous operation, and 2 pages for the next operation:

    1:2

    Siebel Open UI uses a number to identify each time scale. It uses the number 1 to identify the Week/Day time scale. For more information, see Determining the Number That Siebel Open UI Uses to Identify Time Scales.

    Siebel Open UI always includes a default page, so it uses the following calculation to determine the total cache page count:

    previous pages + default page + next pages

    So, the cache size for the 1:2 example is 5:

    2 + 1 + 2 = 5

    For more examples:

    • 1:1. Use three pages (1+1+1).
    • 1:0. Use one pages (0+1+0).
    • 1:2. Use five pages (2+1+2).
  2. (Optional) Add more than one time scale.

    Use a semicolon to separate each time scale. For example:

    1:1;2:1;4:1;32:1;64:1;128:1;256:1;512:1;1024:1

Customizing the Date Navigation Buttons

When you specify the DateBar Navigation TS applet user property, you specify the time period that that Siebel Open UI uses to reset the current date when the user clicks one of the following buttons:

  • Left arrow. Displays the previous date, small date change.
  • Right arrow. Displays the next date, small date change.
  • Double left arrow. Displays the previous date, large date change.
  • Double right arrow. Displays the next date, large date change.

Siebel Open UI displays these buttons to the left and to the right of the date that it displays in the Date Navigation bar.

To customize the date navigation buttons

  1. Specify the DateBar Navigation TS applet user property.

    Use the following format:

    time_scale_identifier:small_date_change, big_date_change

    where:

    • time_scale_identifier identifies the time scale. Siebel Open UI uses a number to identify each time scale. For more information, see Determining the Number That Siebel Open UI Uses to Identify Time Scales.
    • small_date_change specifies the number of hours, days, weeks, or months that Siebel Open UI uses to modify the current date if the user clicks the left arrow or the right arrow.
    • big_date_change specifies the number of hours, days, weeks, or months that Siebel Open UI uses to modify the current date if the user clicks the double left arrow or the double right arrow.
  2. (Optional) Add more than one time scale.

    Use a semicolon to separate each time scale. For example:

    1:7,30;4:1,7;2:1,7;64:30,365;128:7,30;256:1,35;

Examples of Customizing Date Navigation Buttons

The following value customizes the date navigation buttons:

1:7,30

where:

  • 1. Specifies the time_scale_identifier. For example, 1 specifies the Week/Day time scale.
  • 7. Specifies the number of days. For example, if the current date is August 15, 2013, and if the user clicks:
    • The left arrow, then Siebel Open UI displays August 8, 2013 as the current date.
    • The right arrow, then Siebel Open UI displays August 22, 2013 as the current date.
  • 30. Specifies the number of days for the record set. For example, if the current date is August 15, 2013, and if the user clicks:
    • The double left arrow, then Siebel Open UI displays July 15, 2013 as the current date.
    • The double right arrow, then Siebel Open UI displays September 15, 2013 as the current date.

For another example:

4:1,7

where:

  • 4. Specifies the time_scale_identifier. For example, 4 specifies the Day/Hour time scale.
  • 1. Specifies the number of days. For example, if the current date is August 15, 2013, and if the user clicks:
    • The left arrow, then Siebel Open UI displays August 14, 2013 as the current date.
    • The right arrow, then Siebel Open UI displays August 16, 2013 as the current date.
  • 7. Specifies the number of days for the record set. For example, if the current date is August 15, 2013, and if the user clicks:
    • The double left arrow button, then Siebel Open UI displays August 8, 2013 as the current date.
    • The double right arrow, then Siebel Open UI displays August 22, 2013 as the current date.

Determining the Number That Siebel Open UI Uses to Identify Time Scales

This topic describes how to determine the number that Siebel Open UI uses to identify a time scale.

To determine the number that Siebel Open UI uses to identify time scales

  1. Log in to the Siebel client with administrative privileges.
  2. Navigate to the Administration - Data screen, and then the List of Values view.
  3. Query the Type field for the following value:

    TNT_SHM_GNTAX_TIME_SCALE

  4. In the Display Value field, locate the time scale that you must modify.
  5. In the Language-Independent Code field, make a note of the value.

    Siebel Open UI uses the number that it displays in the Language-Independent Code field to identify the time scale that it displays in the Display Value field.

    
Configuring Siebel Open UI Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.