Oracle® Calendar Application Developer's Guide 10g Release 1 (10.1.2) Part Number B25489-01 |
|
|
View PDF |
This chapter contains detailed information on Oracle Calendar SDK configuration settings and Oracle Calendar server parameters that affect applications that use the Oracle Calendar SDK.
These settings may be placed in a text file, the name of which must be passed to the function CSDK_SetConfigFile. The structure of the file is:
[<section>] <keyword>=<value> ...
The following is a sample configuration file suitable for debugging:
Example 7-1 calendar_config.ini
[SDK] client_name = My Sample Client client_version = 10.1.2 [LOG] log_trace = true log_debug = true log_activity = true log_state = false log_modulesinclude = {CAPI, VATTR, SAPPI, ICAL}
This configuration file configures the Calendar SDK to do the following:
Activate the logging mechanism
Log the activity of the Calendar C API module
The following tables describe the valid configuration settings for each section.
Table 7-1 SDK Section
Setting | Values | Default Value | Description |
---|---|---|---|
client_name |
Any string |
"" |
Sets the application name that be visible in the server stats. |
client_version |
Any string |
"" |
Sets the application version that be visible in the server stats. |
tmpDirectoryPath |
String (a valid path to a directory on the local filesystem) |
"" |
Specifies a path to a directory on the local filesystem that will be used by the SDK to store temporary files. It is the user's responsibility to empty that directory. Currently, that directory is only used for attachments. Attachment files from meetings will be stored in subdirectories of the form The vale of this setting should not be in quotation marks. For example, the following is valid in the configuration file: tmpDirectoryPath = /tmp However, the following might not be valid on certain platforms: tmpDirectoryPath = "/tmp" Graham: Can you get JP to verify this? |
Table 7-2 CACHE Section
Setting | Values | Default Value | Description |
---|---|---|---|
cncachesize |
[0..U32MAX] |
512 |
Sets the maximum number of entries to hold in common name cache. |
direntrycachesize |
[0..U32MAX] |
512 |
Sets the maximum number of entries to hold in the directory entry cache. |
emailcachesize |
[0..U32MAX] |
512 |
Sets the maximum number of entries to hold in the email address cache. |
itemcachesize |
[0..U32MAX] |
512 |
Sets the maximum number of entries to hold in the item cache. |
securitycachesize |
[0..U32MAX] |
512 |
Sets the maximum number of entries to hold in the security record cache. |
tzcachesize |
[0..U32MAX] |
256 |
Sets the maximum number of entries to hold in the timezone record cache. |
Table 7-3 STATS Section
Setting | Values | Default Value | Description |
---|---|---|---|
apitime |
true/false |
false |
When enabled, logs transaction times for each API function call. |
server |
true/false |
false |
When enabled, logs server stats for each API function call. |
Table 7-4 LOG Section
Setting | Values | Default Value | Description |
---|---|---|---|
log_activity |
true/false |
false |
Enables "activity" (high-level) logging. |
log_debug |
true/false |
false |
Enables "debug" logging. |
log_filename |
filename |
No default value |
Specifies the file to which logging information will be written. |
log_modulenames |
true/false |
false |
Controls whether module names are printed with each message. |
log_modulesinclude |
"" or "{CAPI, VATTR, SAPPI, ICAL}", each of the values in the braces are optional. |
"" |
Controls which modules have logging enabled. This should be set, at minimum, to "{CAPI}", otherwise no logging will be performed even if it is enabled (by setting log_activity = true). |
log_state |
true/false |
false |
Enables "state" logging. |
log_trace |
true/false |
false |
Enables "trace" logging. Warning: This setting can result in a large amount of logging, as well as a significant performance hit, depending on the modules included. |
The following settings may be placed in the following sections:
[CONNPOOL]
[CONNPOOL:alias]
If a setting is specified in [CONNPOOL], it sets the value to be used with any host not specifically configured in the connection pool. If a setting is specified in [CONNPOOL:alias], it will only apply to the host specified by alias.
Table 7-5 CONNPOOL Section
Setting | Values | Default Value | Description |
---|---|---|---|
blocking |
true/false |
true |
Indicates whether a connection request will block or return an error if there are no available connections. |
connect_on_startup |
true/false |
true |
Indicates whether the pool will open the minimum number of connections immediately on startup, or instead wait for connections to be requested before opening them. |
host |
host,node |
"" |
Sets the host and node for a connection pool entry. This keyword may only be placed inside the section for a specific host and node (a section named [CONNPOOL:alias]. |
max_caldomain |
[0..S32MAX] |
0 |
Sets the maximum number of caldomain connections for the given server name/node ID in the connection pool. |
max_masternode |
[0..S32MAX] |
0 |
Sets the maximum number of masternode connections for the given server name/node ID in the connection pool. |
max_sysop |
[0..S32MAX] |
0 |
Sets the maximum number of SYSOP connections for the given server name/node ID in the connection pool. |
max_user |
[0..S32MAX] |
none, value required to use connection pooling |
Sets the maximum number of user connections for the given server name/node ID in the connection pool. |
min_caldomain |
[0..?] |
0 |
Sets the minimum number of caldomain connections for the given server name/node ID in the connection pool. |
min_masternode |
[0..?] |
0 |
Sets the minimum number of masternode connections for the given server name/node ID in the connection pool. |
min_sysop |
[0..?] |
0 |
Sets the minimum number of SYSOP connections for the given server name/node ID in the connection pool. |
min_user |
[0..?] |
0 |
Sets the minimum number of user connections for the given server name/node ID in the connection pool. |
The following table describes Oracle Calendar server parameters that affect applications that use the Oracle Calendar SDK:
Table 7-6 ENG Section
Setting | Values | Default Value | Description |
---|---|---|---|
allowsysoplogon_capi |
true/false |
false |
If Oracle Calendar SDK users want to log in as Sysop, they need to set this setting to "true" for each host or installation they wish to log in. |
sessionexpiry_csdk |
Any positive integer or 0 |
0 |
Specifies the amount of time, in minutes, before the connection between the Oracle Calendar SDK and the Oracle Calendar server is terminated. The actual expiry is set within plus or minus 30% of this value. This implies that with a setting of 2160 minutes (36 hours), the actual expiry will be within one or two days of the connection being established. A value of 0 indicates that no limit should be enforced by the server. |