CorporateTime for the Web 3.0 Administrator's Guide

timing is everything

CorporateTime for the Web 3.0 Administrator's Guide

Appearance configuration

Colours

Display

Banners

Overview

CorporateTime for the Web contains a number of configurable parameters used to modify and customize the appearance of the product. These parameters are set in the file <fcgi-bin>/lexacal-private/ini/webcal.ini. In this section each parameter is followed by the name of the relevant section in the webcal.ini.

Colours

The values accepted for the following parameters must be part of the hexadecimal codes used for colour definition in HTML. The colour code uses the following pattern: RRGGBB, where each character is hex (base 16, 0 through f). This gives 256 levels each for Red, Green, and Blue. The section to modify in the webcal.ini is [attributes].

[attributes]

Parameter Description Accepted values Default

app_col controls the general background colour of all views Any hex code for colour definition #ffffff

left_ban_col controls the background colour of the left banner container; takes effect if a left banner is provided and ban_left under the section [banners] is not commented out Any hex code for colour definition #ffffff

top_ban_col controls the background colour of the top banner container; applied only if a left banner is provided and ban_top under the section [banners] is not commented out Any hex code for colour definition #ffffff

bot_ban_col controls the background colour of the bottom banner container; applied only if a bottom banner is provided and ban_bot under the section [banners] is not commented out Any hex code for colour definition #ffffff

cal_toolbar_col controls the background colour of the toolbar holding the action icons in the Agenda View; applied under all conditions Any hex code for colour definition #c6c6c6

cal_weekend_col controls the background colour of the day cell holding the day's Meetings; day cells affected by this parameter are the weekend day cells; takes effect when the user enables the viewing of weekend days in the Agenda View Any hex code for colour definition #e5e5e5

cal_weekday_col controls the background colour of the day cell holding the day's Meetings; day cells affected by this parameter are the week day cells; applied at all times Any hex code for colour definition #ffffff

cal_titlebar_inmonth_col controls the background colour of the day title cell holding the weekday's name and the date; takes effect in all types of Agenda Views; in a month view, the day title cells affected by this parameter are for dates that belong to the month being viewed Any hex code for colour definition #f4faac

cal_titlebar_outmonth_col controls the background colour of the day title cell holding the weekday's name and the date; takes effect only in the Monthly Agenda; in a Month View, the day title cells affected by this parameter are for dates that do not belong to the month being viewed Any hex code for colour definition #c9d3f9

minical_bg_col Sets a background colour for the mini-calendar Any hex code for colour definition Commented out

minical_border_col defines a border colour for the mini-calendar if the minical_border parameter is enabled Any hex code for colour definition Commented out

minical_border sets border thickness for the mini-calendar Any positive integer representing the thickness of the border No border

page_header_color set a page header colour for layer-based pages (Edit Entry, preferences) Any hex code for colour definition #c6c6c6

active_layer_color set a colour for the active layer in layer-based pages (Edit Entry, preferences) Any hex code for colour definition #e5e5e5

popupmenu_bgcolor defines a background colour for the Preferences pop-up menu Any hex code for colour definitions #e5e5e5

popupmenu_bdcolor defines a border colour for the Preferences pop-up menu Any hex code for colour definitions #64618f

popupmenu_width defines a width for the Preferences pop-up menu Any positive integer representing the width of the menu 150

popupmenu_fontsize defines a font size for the Preferences pop-up menu Any positive integer representing the font size to be used in the menu 12

norm_font_col sets a font colour for Entries with an Access level of Normal Any hex code for colour definitions #000000

conf_font_col sets a font colour for Entries with an Access level of Confidential Any hex code for colour definitions #ef4a4a

pers_font_col sets a font colour for Entries with an Access level of Personal Any hex code for colour definitions #487aa8

pub_font_col sets a font colour for Entries with an Access level of Public Any hex code for colour definitions #569a63

norm_font_attr sets a font attribute for Entries with an Access level of Normal Any valid HTML style normal

conf_font_attr sets a font attribute for Entries with an Access level of Confidential Any valid HTML style italic

pers_font_col sets a font attribute for Entries with an Access level of Personal Any valid HTML style italic

pub_font_col sets a font attribute for Entries with an Access level of Public Any valid HTML style bold

grpViewSelTimeRowBG sets a background colour for the selected time row in the Group View Any hex code for colour definitions #e5e5e5

taskview_header_col sets a colour for the Task View header Any hex code for colour definitions
#c6c6c6

taskview_create_col sets a colour for the Quick Create row in the Task View Any hex code for colour definitions
#e5e5e5

taskview_oddrow_col sets a colour for odd-numbered rows in the Task View Any hex code for colour definitions
#c9d3f9

taskview_evenrow_col sets a colour for even-numbered rows in the Task View Any hex code for colour definitions
#ffffff

Display

Section Parameter Description Accepted values Default

[display] fix_width This parameter lets you choose whether to enable a fixed width for any view in CorporateTime for the Web. TRUE (enables fixed width) FALSE (disables fixed width) FALSE

[display] app_width app_width1 app_width2 app_width3 These parameters let you set a list of preferences a user can select in the application for the fixed width in the Agenda View. The numeric value of each parameter corresponds to the value set in the text.nls. For each parameter, any value between 680 and 1200 pixels. app_width = 680 app_width1 = 800 app_width2 = 1000 app_width3 = 1200

[display] left_ban_width Lets you specify a banner width in the Agenda Views and on the secondary pages of the Web Calendar. (parameter sec_left_banner in [banners]) Any positive integer. 100 (commented out by default in webcal.ini)

[display] global_width Lets you specify a fixed width for Global Agenda Viewing Any integer from 680 to 1200 pixels 1000

[display] top_ban_height Lets you specify a height for the top banner in the Entry edit or Preferences pages Any positive integer. 100

[image_button] img_enable This parameter lets you replace the default HTML buttons in CorporateTime for the Web with GIFs. To enable this option, set the value to TRUE and uncomment the values for the the GIFs that appear below the parameter (e.g. ok = /buttons/ok.gif). TRUE (lets you replace HTML buttons with GIFs) FALSE (disables this option) TRUE

Banners

Static banner templates

The banner template files contain partial HTML mark-up that includes the banner's contents. There are no <BODY> or <HTML> tags in the banner templates. HTML balance-checking is not performed by any of the FCGIs on the content of these banner files. The HTML mark-up in the banner templates must be balanced so that all tags are closed off properly. If not, the view can be lost.

The path where the banner template files are located is set to <fcgi-bin>/swc-private/banners.

If the banner template files cannot be accessed, the corresponding banner will not appear. No error will be reported on the user view.

Dynamic banner templates

If you have a script that dynamically generates your banner following the guidelines below, set the script's file extension to .scr . For example, if the file that produces the top banner templates is top.sh, rename the script to top.scr and make the appropriate mapping to top.scr in the webcal.ini file so that ban_top=top.scr .

The location of the banner producing scripts is set to <fcgi-bin>/swc-private/banners. Ensure that the permissions are set so that your script and the path leading to this directory are executable by others.

As with the static banner templates, if for some reason the banner script cannot be accessed or executed, the corresponding banner will not appear. No error will be reported on the user view.

Sample banner template

The banner template files as well the banner scripts should produce HTML mark-up that has no <BODY> or <HTML>. Here is an example of how the banner mark-up should look.

<TABLE BORDER="0" WIDTH="548" CELLSPACING="0" CELLPADDING="0" ALIGN="CENTER"> <TR> <TD ALIGN=center> <A HREF="http://www.steltor.com/" target="_top"> <IMG src="/swc/images/english/banners/banner_top.gif" height=78 width=548 border=1 alt="Steltor"></A> </TD> </TR></TABLE>

Parameter Description Position in Agenda View Accepted values File

ban_left Enables the left-hand banner. The value of the parameter is the name of the file where the left banner is defined. The left-hand banner appears only in the Daily, Weekly and Monthly Agendas. The most dominant view in CorporateTime for the Web is the Agenda View. The template file where the banner is defined (in this case left.temp), contains partial HTML code without <BODY> or <HTML> tags. To obtain a consistent view you should set the dimensions of all banners . The following are the guidelines for the dimensions of the left side banner: Maximum Width: 125 Maximum Height: 400 or as desired left.temp

ban_top Enables the top banner. The value of this parameter maps to the name of the file where the top banner is defined. The top banner appears in all the main views when enabled, as well as the Change Password page, E-mail Agenda page and Sign-in. The main views include the following: Daily, Weekly and Monthly Agendas; Create, edit and view Entry pages; View Agendas page; and Preferences page The template file where the top banner is defined (in this case top.temp), contains partial HTML mark-up. To obtain a consistent view you should set the dimensions of all banners. The following are the guidelines for the dimensions of the top side banner: Maximum Width: 600 Maximum Height: 60 top.temp

ban_bot Enables the bottom-side banner. The value of this parameter maps to the name of the file where the bottom banner is defined. The bottom side banner appears in all the main views when enabled, as well as the Change Password page, E-mail Agenda page and Sign-in. The template file where the bottom banner is defined (in this case bottom.temp), contains partial HTML mark-up. To obtain a consistent view you should set the dimensions of all banners. The following are the guidelines for the dimensions of the bottom side banner: Maximum Width: 600 Maximum Height: 60 bot.temp

sec_left_banner Enables display of left-hand banners in the secondary pages of the Web Calendar Left-hand column in all secondary pages (Entry edit, Preferences, etc.) TRUE or FALSE. The default value is FALSE. N/A

To disable any of these banners in the Agenda View, comment out the corresponding parameter in the webcal.ini file.

Parameter	Description	Accepted values	Default
`app_col`	controls the general background colour of all views	Any hex code for colour definition	`#ffffff`
`left_ban_col`	controls the background colour of the left banner container; takes effect if a left banner is provided and `ban_left` under the section [banners] is not commented out	Any hex code for colour definition	`#ffffff`
`top_ban_col`	controls the background colour of the top banner container; applied only if a left banner is provided and `ban_top` under the section [banners] is not commented out	Any hex code for colour definition	`#ffffff`
`bot_ban_col`	controls the background colour of the bottom banner container; applied only if a bottom banner is provided and `ban_bot` under the section [banners] is not commented out	Any hex code for colour definition	`#ffffff`
`cal_toolbar_col`	controls the background colour of the toolbar holding the action icons in the Agenda View; applied under all conditions	Any hex code for colour definition	`#c6c6c6`
`cal_weekend_col`	controls the background colour of the day cell holding the day's Meetings; day cells affected by this parameter are the weekend day cells; takes effect when the user enables the viewing of weekend days in the Agenda View	Any hex code for colour definition	`#e5e5e5`
`cal_weekday_col`	controls the background colour of the day cell holding the day's Meetings; day cells affected by this parameter are the week day cells; applied at all times	Any hex code for colour definition	`#ffffff`
`cal_titlebar_inmonth_col`	controls the background colour of the day title cell holding the weekday's name and the date; takes effect in all types of Agenda Views; in a month view, the day title cells affected by this parameter are for dates that belong to the month being viewed	Any hex code for colour definition	`#f4faac`
`cal_titlebar_outmonth_col`	controls the background colour of the day title cell holding the weekday's name and the date; takes effect only in the Monthly Agenda; in a Month View, the day title cells affected by this parameter are for dates that do not belong to the month being viewed	Any hex code for colour definition	`#c9d3f9`
`minical_bg_col`	Sets a background colour for the mini-calendar	Any hex code for colour definition	Commented out
`minical_border_col`	defines a border colour for the mini-calendar if the `minical_border` parameter is enabled	Any hex code for colour definition	Commented out
`minical_border`	sets border thickness for the mini-calendar	Any positive integer representing the thickness of the border	No border
`page_header_color`	set a page header colour for layer-based pages (Edit Entry, preferences)	Any hex code for colour definition	`#c6c6c6`
`active_layer_color`	set a colour for the active layer in layer-based pages (Edit Entry, preferences)	Any hex code for colour definition	`#e5e5e5`
`popupmenu_bgcolor`	defines a background colour for the Preferences pop-up menu	Any hex code for colour definitions	`#e5e5e5`
`popupmenu_bdcolor`	defines a border colour for the Preferences pop-up menu	Any hex code for colour definitions	`#64618f`
`popupmenu_width`	defines a width for the Preferences pop-up menu	Any positive integer representing the width of the menu	`150`
`popupmenu_fontsize`	defines a font size for the Preferences pop-up menu	Any positive integer representing the font size to be used in the menu	`12`
`norm_font_col`	sets a font colour for Entries with an Access level of Normal	Any hex code for colour definitions	`#000000`
`conf_font_col`	sets a font colour for Entries with an Access level of Confidential	Any hex code for colour definitions	`#ef4a4a`
`pers_font_col`	sets a font colour for Entries with an Access level of Personal	Any hex code for colour definitions	`#487aa8`
`pub_font_col`	sets a font colour for Entries with an Access level of Public	Any hex code for colour definitions	`#569a63`
`norm_font_attr`	sets a font attribute for Entries with an Access level of Normal	Any valid HTML style	`normal`
`conf_font_attr`	sets a font attribute for Entries with an Access level of Confidential	Any valid HTML style	`italic`
`pers_font_col`	sets a font attribute for Entries with an Access level of Personal	Any valid HTML style	`italic`
`pub_font_col`	sets a font attribute for Entries with an Access level of Public	Any valid HTML style	`bold`
`grpViewSelTimeRowBG`	sets a background colour for the selected time row in the Group View	Any hex code for colour definitions	`#e5e5e5`
`taskview_header_col`	sets a colour for the Task View header	Any hex code for colour definitions	`#c6c6c6`
`taskview_create_col`	sets a colour for the Quick Create row in the Task View	Any hex code for colour definitions	`#e5e5e5`
`taskview_oddrow_col`	sets a colour for odd-numbered rows in the Task View	Any hex code for colour definitions	`#c9d3f9`
`taskview_evenrow_col`	sets a colour for even-numbered rows in the Task View	Any hex code for colour definitions	`#ffffff`

Section	Parameter	Description	Accepted values	Default
`[display]`	`fix_width`	This parameter lets you choose whether to enable a fixed width for any view in CorporateTime for the Web.	`TRUE` (enables fixed width) `FALSE` (disables fixed width)	`FALSE`
`[display]`	`app_width` `app_width1` `app_width2` `app_width3`	These parameters let you set a list of preferences a user can select in the application for the fixed width in the Agenda View. The numeric value of each parameter corresponds to the value set in the text.nls.	For each parameter, any value between 680 and 1200 pixels.	app_width = `680` app_width1 = `800` app_width2 = `1000` app_width3 = `1200`
`[display]`	`left_ban_width`	Lets you specify a banner width in the Agenda Views and on the secondary pages of the Web Calendar. (parameter `sec_left_banner` in [banners])	Any positive integer.	`100` (commented out by default in webcal.ini)
`[display]`	`global_width`	Lets you specify a fixed width for Global Agenda Viewing	Any integer from `680` to `1200` pixels	`1000`
`[display]`	`top_ban_height`	Lets you specify a height for the top banner in the Entry edit or Preferences pages	Any positive integer.	`100`
`[image_button]`	`img_enable`	This parameter lets you replace the default HTML buttons in CorporateTime for the Web with GIFs. To enable this option, set the value to `TRUE` and uncomment the values for the the GIFs that appear below the parameter (e.g. ok = /buttons/ok.gif).	`TRUE` (lets you replace HTML buttons with GIFs) `FALSE` (disables this option)	`TRUE`

Parameter	Description	Position in Agenda View	Accepted values	File
`ban_left`	Enables the left-hand banner. The value of the parameter is the name of the file where the left banner is defined.	The left-hand banner appears only in the Daily, Weekly and Monthly Agendas. The most dominant view in CorporateTime for the Web is the Agenda View.	The template file where the banner is defined (in this case left.temp), contains partial HTML code without <BODY> or <HTML> tags. To obtain a consistent view you should set the dimensions of all banners . The following are the guidelines for the dimensions of the left side banner: Maximum Width: `125` Maximum Height: `400` or as desired	`left.temp`
`ban_top`	Enables the top banner. The value of this parameter maps to the name of the file where the top banner is defined.	The top banner appears in all the main views when enabled, as well as the Change Password page, E-mail Agenda page and Sign-in. The main views include the following: Daily, Weekly and Monthly Agendas; Create, edit and view Entry pages; View Agendas page; and Preferences page	The template file where the top banner is defined (in this case top.temp), contains partial HTML mark-up. To obtain a consistent view you should set the dimensions of all banners. The following are the guidelines for the dimensions of the top side banner: Maximum Width: `600` Maximum Height: `60`	`top.temp`
`ban_bot`	Enables the bottom-side banner. The value of this parameter maps to the name of the file where the bottom banner is defined.	The bottom side banner appears in all the main views when enabled, as well as the Change Password page, E-mail Agenda page and Sign-in.	The template file where the bottom banner is defined (in this case bottom.temp), contains partial HTML mark-up. To obtain a consistent view you should set the dimensions of all banners. The following are the guidelines for the dimensions of the bottom side banner: Maximum Width: `600` Maximum Height: `60`	`bot.temp`
`sec_left_banner`	Enables display of left-hand banners in the secondary pages of the Web Calendar	Left-hand column in all secondary pages (Entry edit, Preferences, etc.)	`TRUE` or `FALSE`. The default value is `FALSE`.	N/A