1. Developer’s Reference
  2. Specifying Gantt Chart Behavior

Specifying Gantt Chart Behavior

The following table describes the applet user properties that Siebel CRM uses for the eGanttChart Busy Free Time Applet. To view the values that you can use for each of these user properties, locate the predefined eGanttChart Busy Free Time Applet in the Applets list in Siebel Tools, and then examine the Value property in the Applet User Properties list.

Applet User Property Description

Major Time Unit

Specifies the major time unit in the X-axis of the Gantt chart. You can use one of the following values:

  • Day

  • Week
  • Month
  • Year

Minor Time Unit

Specifies the minor time unit in the X-axis of the Gantt chart. You can use one of the following values:

  • Hour

  • Day

  • Week

  • Month

You can use the following combinations of major and minor time units:

  • Day, Hour

  • Week, Day

  • Month, Day

  • Month, Week

  • Year, Month

X-BC

Specifies the business component for the X-axis of the Gantt chart.

X-Color Field

Specifies the cells of the Gantt chart that Siebel CRM can color differently. This applet user property specifies the field in the X business component that determines the coloring. For the field that you choose, make sure a corresponding list of values exists. For more information, see the description for the X-Color LOV Name applet user property.

X-Color LOV Name

Specifies the list of values that defines the values of the field that you choose for the X-Color Field applet user property. From this list of values, you can specify the Language Independent Code (LIC) that Siebel CRM uses for the field value.

X-LOV Map

Specifies the Language Independent Code of the list of values that Siebel CRM can map to colors.

X-Color Map

Specifies the colors of the different values of the Language Independent Code. These values must use the same order that the values in the X-LOV Map applet user property uses. For example, 2-High maps to GanttChartBlue.

The values of the X-Color Map applet user property are the style sheet classes that the Gantt.css defines.

X-Date InvokeMethod

Specifies to map to an internal X-business component method that determines the date-time range for the X-business component data. You must not modify this applet user property.

X-Display Constraint Map

Specifies the lower and upper bounds of the time that Siebel CRM displays in the Gantt chart instead of displaying a 24-hour interval. It applies only if the minor time unit is Hour.

X-Display Duration

Specifies the number of minutes to increment each cell in the Gantt chart.

X-DrillDown Field

Specifies the field in the X business component that Siebel CRM uses as the drill down field. A corresponding Drilldown Object must exist for the applet in Siebel Tools.

X-End DateTime Field

Specifies the field in the X business component that specifies the end of the date and time range.

X-Join Field

Specifies the field in the X business component that links it to the Y business component. If you do not specify the X-Join InvokeMethod applet user property, then Siebel CRM uses the value in the X-Join Field applet user property in a search specification.

X-Join InvokeMethod

Specifies how to map to an internal X business component method to link the Y and X business components. You must not modify this applet user property.

X-Num Slots

Specifies the number of slots for a cell. For example, assume multiple activities include the same start and end times. If X-Num Slots is 3, then Siebel CRM splits the cell that contains the time range into a maximum of three slots. These cells contain the conflicting activities.

X-Num Tool Tips

Specifies the number of tooltips that the applet contains. For example, assume that the following tooltip is the last tooltip that the applet defines:

X-Tooltip 12

In this example, you set the value of the X-Num Tool Tips applet user property to 12.

If the applet does not contain an X-Tooltip n applet user property, then you set the value of the X-Num Tool Tips applet user property to 0 (zero).

X-Sort Spec

Specifies the sort specification for the X business component.

X-Start DateTime Field

Specifies the field in the X business component that contains the start for the date and time range.

X-Tooltips 1

Specifies the First control that Siebel CRM displays in the tooltip.

X-Tooltips 2

Specifies the Second control that Siebel CRM displays in the tooltip.

X-Tooltips n

You can define more applet user properties for more tooltip controls.

Y-BC

Specifies the business component that Siebel CRM uses for the Y-axis of the Gantt chart.

Y-BC ViewSet Size

Specifies the maximum number of records that the Y-axis can include.

Y-Constraint

Specifies the search specification for the Y business component in the base Gantt chart. Siebel CRM does not include any value for this user property, by default. If this user property does not include a value, then it uses a link in a parent and child relationship to constrain the Y business component.

Y-DrillDown Field

Specifies the source field that Siebel CRM uses for the Y drilldown.

Y-DrillDown View

Specifies the destination view of the Y drilldown. You can modify this user property.

Y-Join Field

Specifies the field in the Y business component that Siebel CRM uses to link this field to the X and Z business components.

Y-Label

Specifies the label for the Y-axis.

Y-Legend

Specifies a field in the Y business component that Siebel CRM displays in the Gantt chart.

Y-SortSpec

Specifies the sort specification for the Y business component.

Z-BC

Specifies the business component that determines the background that Siebel CRM draws for the Z-axis of the Gantt chart. For example, assume the working schedule of each employee is Monday through Friday, 8:00 AM to 5:00 PM. In this example, Siebel CRM uses a plain background where it displays the schedule and a colored background where it does not display the schedule.

One of the following Z business components determines the display:

  • GanttStateNone. No schedule.

  • GanttStateOff. A schedule exists.

  • GanttStateOn. Color of the cell that the X-Color Map controls.

Z-Date InvokeMethod

Specifies how to map the internal Z business component method that determines the date and time range for the Z business component data. You must not modify this user property.

Z-End DateTime Field

Specifies the field in the Z business component that specifies the end of the date and time range.

Z-Join Field

Specifies the field in the Z business component that links to the Y business component. If the Z-Join InvokeMethod property does not include a value, then Siebel CRM uses the Z-Join Field property as a search specification.

Z-Join InvokeMethod

Specifies how to map an internal Z business component method to link the Y and Z business components with each other. You must not modify this user property.

Z-Start DateTime Field

Specifies the field in the Z business component that determines the start of the date and time range.