Skip Headers
Oracle® Calendar Reference Manual
10g Release 1 (10.1.2)

Part Number B25486-03
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

1 Calendar User and Resource Parameters

This chapter details the parameters available to configure default user and resource profiles in the $ORACLE_HOME/ocal/misc/user.ini and $ORACLE_HOME/ocal/misc/resource.ini files respectively. For details on how to implement user and resource profiles, see the Oracle Calendar Administrator's Guide.

Each parameter's stated default value is used if that parameter is omitted from its configuration file. These defaults are not necessarily the optimal settings for your installation. The initialization files supplied with the software contain settings that provide a good starting point for further configuration. It is strongly recommended that for reference purposes you keep a copy, in either printed or electronic format, of these files before modification.

Overview

The information that can be specified includes:

The following table lists some of the values that can be set for users and resources. To display the complete list, use the uniuser utility with the -info parameter and the -user or -resource parameter. See the uniuser documentation in Chapter 6, "Calendar Server Utilities".

Table 1-1 User and resource profile

Parameter Possible values Default value Description

ENABLE

TRUE, FALSE

TRUE

Enable the calendar account

ShowSunday

TRUE, FALSE

TRUE

Shows Sundays

ShowSaturday

TRUE, FALSE

TRUE

Shows Saturdays

TimeFormat

1 (24 hour),

2 (AM/PM)

2 (AM/PM)

Sets time display format

StartDay

00h00 to 24h00

08h00

Sets agenda start time for display

EndDay

00h00 to 24h00

18h00

Sets agenda stop time for display

TimeInc

5, 10, 15, 20, 30, 60 (minutes)

30 minutes

Defines time increment for day and week views

RefreshFrequency

0 ... 65536 (minutes)

15

Sets refresh frequency of client

MailNotification

TRUE, FALSE

FALSE

Specifies if the user can receive mail notification

PUBLISHEDTYPE

PUBLISHED, NOTPUBLISHED

NOTPUBLISHED

Specifies if the user's agenda can be published

GLOBALREADACCESS

TRUE, FALSE

FALSE

Specifies if the user can share their agendas with any other Internet user

Language

en (English)

fr (French)

it (Italian)

es (Spanish)

fi (Finnish)

de (German)

pt (Portuguese)

ja (Japanese)

zh-CN (Chinese)

ko (Korean)

sv (Swedish)

pt-BR (Brazilian Portuguese)

nl (Dutch)

en

Determines the language used for notification and reminder messages.

DefaultReminder

0 (disabled),

1 (pop-up)

2 (pop-up and audible)

2 (users)

0 (resources)

Controls use of Pop-up Reminders

TimeBeforeReminder

0, 2, 5, 10, 60, 120, 240 (minutes)

12, 24, 48, 96 (hours)

7, 14, 31 (days)

0

Sets reminder time for Default Reminder

ALERT-ENABLE

SMSServiceEnable

TRUE, FALSE

FALSE

Enable all alerts (server side reminders and notifications). For users only.

ALERT-NOTIFMEETING

TRUE, FALSE

TRUE

Enable alerts for normal events. For users only.

ALERT-NOTIFDAYEVENT

TRUE, FALSE

FALSE

Enable alerts for day events. For users only.

ALERT-NOTIFDAILYNOTE

TRUE, FALSE

FALSE

Enable alerts for daily notes. For users only.

ALERT-NOTIFENABLE

TRUE, FALSE

TRUE

Enable notification alerts. When set to FALSE, notification alerts are not sent.

ALERT-NOTIFJOURNAL

TRUE, FALSE

FALSE

Enable alerts for journals. For users only.

ALERT-NOTIFOWNER

TRUE, FALSE

TRUE

Enable alerts for entries the user owns also. For users only.

ALERT-NOTIFDECLINED

TRUE, FALSE

TRUE

Enable alerts for entries the user has declined also. For users only.

ALERT-SUSPENDRANGE

HH:MM-HH:MM

(none)

Define the suspension period. For users only.

ALERT-SUSPENDRANGEACTION

NONE, HOLD, DISCARD

NONE

Define the suspension action. For users only.

ALERT-HOLD

TRUE, FALSE

FALSE

Hold all alerts now. For users only.

ViewNormalEvent

YES, NO, TIME

NO

Default security given to other users

ViewPersonalEvent

YES, NO, TIME

NO

Same as ViewNormalEvent

ViewConfidentialEvent

YES, NO, TIME

NO

Same as ViewNormalEvent

CanBookMe

TRUE, FALSE

FALSE

Specifies if user can be invited

ViewNormalTask

YES, NO

NO

Default security given to other users

ViewPersonalTask

YES, NO

NO

Same as ViewNormalTask

ViewConfidentialTask

YES, NO

NO

Same as ViewNormalTask

CreatePublicGroups

TRUE, FALSE

FALSE

Controls ability to create Public groups

ManageAdmGroups

TRUE, FALSE

FALSE

Controls ability to create Admin groups

ManageHolidays

TRUE, FALSE

FALSE

Controls ability to manage holidays

OU1

<Organizational Unit 1>

n/a

Value for directory address field

OU2

<Organizational Unit 2>

n/a

Same as OU1

OU3

<Organizational Unit 3>

n/a

Same as OU1

OU4

<Organizational Unit 4>

n/a

Same as OU1

O

<Organization>

n/a

Same as OU1

C

<Country>

n/a

Same as OU1

A

<Administrative Domain>

n/a

Same as OU1

P

<Private Domain>

n/a

Same as OU1

TimeZone

<Time zone>

value defined in unison.ini

Defines a time zone specifically for the user or resource

Group0 ... Group9

<Admin or public group name>

n/a

Specifies groups in which to include the user or resource

Designate0 ... Designate9

<User name>

n/a

Defines users who may act as designates for the new user or resource

EMAIL

A valid e-mail address

n/a

User: The user's e-mail address

Resource: The resource's e-mail address (not the resource contact's e-mail)

Note: This parameter should be used with caution. Unless changed between every addtion, specifying a value will assign the same e-mail address to all new users and resources.


Table 1-2 resource only attributes

Parameter Possible values Default value Description

NOTIFY-APPROVER

TRUE, FALSE

FALSE

Specifies that booking this resource requires approval

APPROVER-EMAIL

A valid e-mail address

n/a

Specifies the e-mail address of the person who will approve a request for a resource

ALLOW-CONFLICT

YES, NO,

DEFAULT (all resources set to the same value)

NO

Allow double booking of the resource. Use DEFAULT to resort to the default set by server parameter (unison.ini) [ENG] allowresourceconflict

CATEGORY

A valid resource category name

n/a

Resource category


Display preferences

ShowSunday = TRUE/FALSE 
ShowSaturday = TRUE/FALSE 

These parameters determine whether or not these days will be part of the week view on the client. The default is TRUE.

TimeFormat = 1/2 

This parameter determines whether or not time is displayed in military (24h) or standard (AM/PM) time. The default is 2 -- AM/PM.

StartDay = <time of day>

This parameter determines the first time slot displayed in the user's agenda (day & week view only). Earlier time slots can still be viewed by using the vertical scroll bar. This does not affect the regular business hours of the user. The default is 08h00.

EndDay = <time of day>

This parameter is used to define the last time slot displayed in a user's agenda (day & week view only), although it has little effect given that other settings, such as StartDay, time slot increments and spacing height, also affect how little or how much of the day is displayed. Later time slots can still be viewed by using the vertical scroll bar. This does not affect the regular business hours of the user. The default is 18h00.

TimeInc = <time_in_minutes> 

This parameter defines the time slot increment for the day & week views. Adjusting the value of this parameter affects how much of your day is displayed on the screen. Only the following values can be specified: 5, 10, 15, 20, 30, 60 (minutes). The default is 15 minutes.

Refresh, notification & reminder preferences

RefreshFrequency = <time_in_minutes> 

This parameter sets the refresh frequency of the client in minutes. A value of 0 would effectively disable the refresh. The default is 15 minutes.

MailNotification = TRUE/FALSE 

This parameter specifies whether or not the user wants to receive mail notification. The effect of this attribute when set to FALSE is to exclude the user's name from being automatically added to the list of recipients sent out by calendar clients. This does not apply to the Oracle Connector for Outlook client. Note, this setting has no effect on the users' own ability to send mail notification. The default is FALSE.

ALERT-ENABLE=TRUE
ALERT-HOLD=TRUE/FALSE
ALERT-SUSPENDRANGEACTION=NONE/HOLD/DISCARD
ALERT-SUSPENDRANGE=HH:MM-HH:MM

E-mail and alert reminders are not supported for resources and event calendars. The ALERT-ENABLE parameter determines whether or not alert notifications and server side reminders are enabled for this user. The default value is "TRUE".

Set ALERT-HOLD to TRUE to suspend all delivery of alert notifications and server side reminders immediately and for ever until this user attribute is reset to FALSE. Set ALERT-SUSPENDRANGEACTION parameter to HOLD to suspend delivery of alert notifications and server side reminders for a given period of time. Specify the period of time using ALERT-SUSPENDRANGE. To discard rather than holding any alerts triggered during the specified period, set ALERT-SUSPENDRANGEACTION to DISCARD. Use ALERT-SUSPENDRANGE to specify the suspension period.

ALERT-NOTIFMEETING=TRUE/FALSE
ALERT-NOTIFDAYEVENT=TRUE/FALSE
ALERT-NOTIFDAILYNOTE=TRUE/FALSE
ALERT-NOTIFJOURNAL=TRUE/FALSE
ALERT-NOTIFOWNER=TRUE/FALSE
ALERT-NOTIFDECLINED=TRUE/FALSE

These parameters specify whether or not the user wants to receive alerts notifications for meetings, day events, daily notes, journals that are updated (added, modified or deleted). Set ALERT-NOTIFOWNER to FALSE to exclude calendar entries that the user owns. Set ALERT-NOTIFDECLINED to FALSE to exclude calendar entries that the user has declined.

Language = en (English) 
           fr (French) 
           it (Italian)
           es (Spanish)
           fi (Finnish)
           de (German)
           pt (Portuguese)
           ja (Japanese)
           zh-CN (Chinese)
           ko (Korean)
           sv (Swedish)
           pt-BR (Brazilian Portuguese)
           nl (Dutch)

Determines the language used for server-side reminder messages. Consult the "Alerts" chapter of your Oracle Calendar Administrator's Guide for details on server-side reminders.

DefaultReminder = 0/1/2 

If set to 1, the Default Reminder for Agenda Entries and Day Events is set to Pop-up Reminder. If set to 2, the reminder is pop-up and will include an audible beep. For Tasks, only the Default Task Due Reminder is set to Pop-up Reminder, the Default Task Start Reminder is NOT set. Furthermore, The Daily Notes Default Reminder is also not set. The default is 0, or no reminders.

TimeBeforeReminder = <time_in_minutes> 

This parameter is used to set the default reminder time. In other words, a value of 24 would mean that default reminders would appear 24 hours before the start of the event. Only the following values can be specified: 0, 2, 5, 10, 60, 120, 240 (minutes); 12, 24, 48, 96 (hours); 7, 14, 31 (days).

REMINDER-SERVERALERT = TRUE/FALSE
REMINDER-VISUAL = TRUE/FALSE
REMINDER-AUDIBLE = TRUE/FALSE
REMINDER-SERVERMAIL = TRUE/FALSE
REMINDER-UPCOMING = TRUE/FALSE
REMINDER-LEADTIME = <time_in_minutes>

These parameters determine whether reminders are enabled for this user for normal events. The leadtime for these reminders is set using REMINDER-LEADTIME. Similar parameters exist for setting reminders for holidays, task start times, task due times, notes and day events:

REMINDERHOLIDAY-SERVERALERT = TRUE/FALSE
REMINDERHOLIDAY-VISUAL = TRUE/FALSE
REMINDERHOLIDAY-AUDIBLE = TRUE/FALSE
REMINDERHOLIDAY-SERVERMAIL = TRUE/FALSE
REMINDERHOLIDAY-UPCOMING = TRUE/FALSE
REMINDERHOLIDAY-LEADTIME = <time_in_minutes>

REMINDERTASKSTART-VISUAL = TRUE/FALSE
REMINDERTASKSTART-AUDIBLE = TRUE/FALSE
REMINDERTASKSTART-UPCOMING = TRUE/FALSE
REMINDERTASKSTART-LEADTIME = <time_in_minutes>

REMINDERTASKDUE-VISUAL = TRUE/FALSE
REMINDERTASKDUE-AUDIBLE = TRUE/FALSE
REMINDERTASKDUE-UPCOMING = TRUE/FALSE
REMINDERTASKDUE-LEADTIME = <time_in_minutes>

REMINDERDAILYNOTE-SERVERALERT = TRUE/FALSE
REMINDERDAILYNOTE-VISUAL = TRUE/FALSE
REMINDERDAILYNOTE-AUDIBLE = TRUE/FALSE
REMINDERDAILYNOTE-SERVERMAIL = TRUE/FALSE
REMINDERDAILYNOTE-UPCOMING = TRUE/FALSE
REMINDERDAILYNOTE-LEADTIME = <time_in_minutes>

REMINDERDAYEVENT-SERVERALERT = TRUE/FALSE
REMINDERDAYEVENT-VISUAL = TRUE/FALSE
REMINDERDAYEVENT-AUDIBLE = TRUE/FALSE
REMINDERDAYEVENT-SERVERMAIL = TRUE/FALSE
REMINDERDAYEVENT-UPCOMING = TRUE/FALSE
REMINDERDAYEVENT-LEADTIME = <time_in_minutes>

Default security rights granted to other users

ViewNormalEvent = YES/NO/TIME 
ViewPersonalEvent = YES/NO/TIME
ViewConfidentialEvent = YES/NO/TIME 
ViewNormalTask = YES/NO (user profiles only)
ViewPersonalTask = YES/NO (user profiles only)
ViewConfidentialTask = YES/NO (user profiles only) 

The preceding parameters determine the default security rights granted to other users when creating events or tasks of these designations. For example, if ViewNormalEvent were set to TIME, only the time slot of the event would be visible to other users, not its title, location or description. Conversely, if ViewNormalEvent were set to YES, all details of the event would be visible to other users. If ViewNormalEvent were set to NO, the event would not be visible at all to other users.

The default value for all of the preceding parameters is NO.

All details of a public event are always visible to other users. There is no way to modify this behavior using these parameters.

The ViewNormalEvent and ViewNormalTask settings map to the "Normal" Access Level on the client.

The ViewPersonalEvent and ViewPersonalTask settings map to the "Personal" Access Level on the client.

The ViewConfidentialEvent and ViewConfidentialTask settings map to the "Confidential" Access Level on the client.

CanBookMe = TRUE/FALSE 

Setting this parameter to TRUE allows any undefined user to schedule with the user. Of course, this can be overridden by the user within the client. The default setting is FALSE.

Setting the CanBookMe attribute to FALSE for a resource will make the resource restricted. When a resource is restricted, no one can reserve the resource. This setting is reflected by the RESTRICTED attribute which is a read-only attribute.

Group and administrative rights (user profiles only)

CreatePublicGroups = FALSE 

This parameter determines whether or not users have the ability to create Public groups (for example, groups available to all users in the database). When a user is deleted, any Public groups he owns will also be deleted. The default is FALSE.

ManageAdmGroups = FALSE 

This parameter determines whether or not users have the ability to create Admin groups. Like Public groups, Admin groups are available to all users in the database, except that Admin groups are not owned by the user who created them, but rather by the SYSOP. Admin groups created by that user will not be deleted if the user is deleted. The default is FALSE.

ManageHolidays = FALSE 

This parameter determines whether or not users have the ability to manage (for example, create, modify or delete) holidays on the system.

X.400 address information (user profiles only)

The following parameters, when defined, can be useful for populating the database with a large number of users who share the same X.400 address information.

OU1 = <Org_unit_1> 
OU2 = <Org_unit_2> 
OU3 = <Org_unit_3> 
OU4 = <Org_unit_4> 
O = <Organization> 
C = <Country> 
A = <Administrative_Domain> 
P = <Private_Member_Domain> 

Administrative and public groups

This section allows you to define groups that users and resources will be placed in as they are added to the system. Note that the groups must be created beforehand, and that there is a maximum of 10 groups in each section.

Group0 = <group_name> 
Group1 = <group_name> 
Group2 = <group_name> 
... 
Group9 = <group_name> 

Designates

A designate is a user assigned the right to modify the agenda of another user or resource.

This section allows you to define designates for users and resources. Note that designates must exist in the database beforehand, and that there is a maximum of 10 designates in each section.

Designate0 = <designate_name> 
Designate1 = <designate_name> 
Designate2 = <designate_name> 
...
Designate9 = <designate_name> 

The <designate_name> argument is a string of the form "key=value/key=value/...", where "key" is one of those listed subsequent table, and "value" is any string. Both "key" and "value" are case insensitive. The "value" string may be terminated by a wild card symbol (*). If a forward slash "/" is to be included in a string, it should be escaped with the character "\" to prevent it from being interpreted as a key-value pair delimiter - for example "S=Hoopla/OU1=R\/D".

If, in a UNIX environment, a shell will be processing the string (for example, the string is provided on the command line or is passed as an argument to the utility), the string should be enclosed in quotation marks. Furthermore, if characters meaningful to the shell are included in the string, they may need to be escaped (for example, preceded by the escape character "\") to prevent the shell from interpreting them.


Note:

If the ID key-value pair is specified in the user argument, all other key-value pairs specified along with it are ignored.

Some example specifications are: "S=Kilpi/G=Eeva", "S=B*/G=Nicole/O=Acme", "O=Acme/ID=1111/OU1=authors", "S=Austen/G=Jane/EMAIL=mr_darcy@freemail.org"

Table 1-3 Accepted keys

Key Field

S

Surname

G

Given name

I

Initials

ID

Identifier

EMAIL

E-mail address

UID

Unique Identifier

X

Generation

OU1

Organizational Unit 1

OU2

Organizational Unit 2

OU3

Organizational Unit 3

OU4

Organizational Unit 4

O

Organization

C

Country

A

Administration domain

P

Private domain


Miscellaneous

TimeZone = <time zone> 

This parameter is used to define a different time zone for the user.

Resource attributes

ALLOW-CONFLICT=YES  

Use this parameter to determine if this resource can be double-booked. Set it to DEFAULT to set the attribute for all resources on the Oracle Calendar server to use the server configuration value. Use the server parameter [ENG] allowresourceconflict to specify the default value. For more information about this parameter, see Chapter 3, "Calendar Server Parameters".

NOTIFY-APPROVER=TRUE

This parameter specifies that booking this resource requires approval by a resource manager. When a resource has this attribute turned on (using uniaccessrights), the resource will be reserved once it is approved by the manager. Use the APPROVER-EMAIL attribute to specify the e-mail address of the manager for this resource. To enable the resource approval mechanism for this resource, the ALLOW-CONFLICT attribute must also be set to YES.

CATEGORY=<category>

This parameter is used to assign a category to a resource. Categories are used to facilitate searching for resources. The category name should be one of the categories defined in the category file $ORACLE_HOME/ocal/misc/category.ini. For more information about categories, see "About Calendar Resource Categories" in Chapter Chapter 8 of Oracle Calendar Administrator's Guide.

APPROVER-EMAIL=<approveremailaddress>

This parameter is used to assign an e-mail address for a resource approver. This facilitates notification of resource bookings by alerting the approver of a resource, by e-mail, that a resourse has been book. The resource approver can then accept or decline the meeting request on behalf of the resourse. See also, the NOTIFY-APPROVER resource attribute parameter.