5 Managing Oracle Beehive Services

This module introduces the Oracle Beehive services, and the tasks and procedures for managing them. It contains the following sections:

• Introduction to Managing Oracle Beehive Services

• Managing Oracle Beehive Core Services

• Managing Collaborative Services

• Managing Enterprise Services

• Managing Platform Services

Introduction to Managing Oracle Beehive Services

Many of the services which underlie all Oracle Beehive deployments have associated management tasks for system and business administrators. These tasks revolve around changing configuration settings, establishing and managing business rules for how the system should operate, and performing routine maintenance procedures. In this module, tasks are broken down by service. You can look up any Oracle Beehive service, and review the associated management tasks at a high level.

To manage Oracle Beehive services, you make use of the beectl command-line interface. You must have valid login credentials with an account having sufficient administration privileges, to make use of the beectl commands.

See also:

For a reference on using the beectl command-line interface, see Module 2, "Oracle Beehive Command-Line Utility" in Oracle Beehive Administrator's Reference Guide.

This section contains the following topics:

• About Oracle Beehive Services

• Managing Oracle Beehive Services

About Oracle Beehive Services

Oracle Beehive provides a set of tightly integrated collaborative services built using J2EE and the Oracle Database. All system functions are performed by services, which interact with each other and a common database to produce the various functions of the product.

In Oracle Beehive, there may be one or more server instances, each of which contains one each of all Oracle Beehive services. Therefore, a deployment containing several Application tiers will contain multiple instances of each service: one of each on each Application tier. In such a deployment, whenever you work with a service from the command line console of a given Application tier, you are working with the local instances of those services.

When you make decisions about all instances of a given service, you are said to be "managing the service". When you make decisions about a specific service instance, you are said to be "managing the service instance". This distinction is important because some management tasks may be performed at either level. For example, you may configure the log level of any service instance, but you may also set the log level for a service (affecting all service instances automatically).

You can stop, start, and restart Oracle Beehive services at both levels (all instances of a service, or only one particular service instance) as well. However, in many cases, stopping individual services or service instances may cause the Oracle Beehive deployment to become unstable or fail in various ways. As a general rule, you should not stop or restart individual service instances or services unless advised to do so in the documentation, or by an Oracle support representative.

Instead, start, restart, or stop individual components, or entire Application tiers, as described in "Starting and Stopping Oracle Beehive".

Services and service instances are created during installation. You should always use the installer software when creating new service instances (by creating new Application tiers).

Managing Oracle Beehive Services

This section describes beectl commands that are common across all services. These commands are not included in each service section: they are instead summarized here.

Note:

For detailed syntax, see Module 2, "Oracle Beehive Command-Line Utility" in " Oracle Beehive Administrator's Reference Guide.

This section contains the following topics:

• Modifying Oracle Beehive Service Properties

• Common Oracle Beehive Service Management Commands

Modifying Oracle Beehive Service Properties

Many Oracle Beehive services have lists of associated properties which are not directly exposed in an beectl command. Instead, you can set them by using the following common commands.

Each of the Oracle Beehive services has a system defined alias. The system defined alias is a unique name that you can use with most commands to identify a service for the purposes of configuration. All of the system defined aliases for Oracle Beehive services begin with an underscore character (_). For example, the E-Mail Service has a system defined alias of _EmailService.

In some cases, you may see a property which is itself used to contain properties (sub-properties). You can use the beectl list_properties command with the alias of the service and the name of such a property, with a colon character between them, to list the sub-properties.

For example, the E-mail Service has a property called "SMTPProperties". You can list its properties by using the beectl list_properties command:

beectl> list_properties --component _EmailService:SMTPProperties

You can review the names of all Oracle Beehive services by using the beectl list_components command:

beectl> list_components

All of the Oracle Beehive services are listed (along with many other Oracle Beehive components).

For each service, prepend an underscore to the Component Type to get the service system alias. For example, the Component Type "EmailService" has a system alias of _EmailService.

Notes:

The list_properties command works on any Oracle Beehive system object. The --component value is case-insensitive, and will take as valid any identifier of a system object, any system object alias, or any user-defined alias.

User-defined aliases are modifiable properties of any system object, with the property name of Alias. Throughout this module, the system defined alias or subcomponent ID is used in examples, but you may always substitute a user defined alias in the --component of a beectl command

To set a property, use the following procedure:

1. Use the beectl list_properties command to get the list of all properties for the component you want to configure. Each property is listed by name, along with its current value:

   beectl> list_properties --component _EmailService:SMTPProperties
   

   In this example, the name of the E-Mail Service SMTP component is entered, with the E-mail Service system alias, to get properties for the SMTP Server component.

2. Use the beectl modify_property or delete_property commands to make the desired change to the property you specify:

   beectl> modify_property --component _EmailService:SMTPProperties --name <property_name> --value <new value>
   

   In this example, the value of an SMTP Server property is modified to a new value.

   Caution:

   If you are changing any port number to a privileged port (a port number below 1024) on a UNIX or Linux installation, you must first perform a special procedure, and then change the port. First follow the special procedure in "Modifying Oracle Beehive Ports using Privileged Port Numbers", and then follow the procedure below to change the port.

3. Whenever you change a property in Oracle Beehive, you are making an alteration to the proposed configuration. You must activate a proposed configuration before changes you have made are actually applied to the running Oracle Beehive deployment. When you are done making configuration changes, activate the proposed configuration using the beectl activate_configuration command:

   beectl> activate_configuration
   

   This command saves your proposed configuration, performs a background validation of the configuration, and then activates it.

   Note:

   You can also append the --activate_configuration option to any beectl command, causing the system to perform these steps automatically on command completion.

4. If you modify any of the following properties, you must also run the beectl modify_local_configuration_files command:

   • Changing the Authentication Service's AuthStoreType between db and ldap

   • Changing the Site's LdapServer

5. In the following cases, you must also restart a service, component, or the entire deployment, using the beectl restart command:

   • Changing the database connection pool requires a full restart of Oracle Beehive

   • Changing the Instant Message Service's XmppPort or XmppSslPort requires that you restart the affected component

   • Changing the DeliveryPoolSize parameter of the Message Delivery Service requires you to restart all affected Message Delivery Service instances

Modifying Oracle Beehive Ports using Privileged Port Numbers

You have the option of configuring various Oracle Beehive components to use privileged ports (ports below 1024) on UNIX and Linux based deployments. For example, the standard port for the IMAP service is port 143.

Any time you modify a port, and the new port number is a privileged port, you must perform the following procedure. Perform this procedure first, and then make the port change. You must perform this procedure when you change from a non-privileged port to a privileged port, and when you change from one privileged port to another privileged port.

If you have previously performed this procedure, you can skip to step 4:

1. From the command line, navigate to the following file:

   $ORACLE_HOME/beehive/bin/hasbind
   

2. Using the sudo command, set the owner of the file to root, and modify the permsissions on the file:

   sudo chown root hasbind
   sudo chmod a+sx hasbind 
   

   The file should have the following permissions (the file date and group will be different):

   -rws--s--x   1 root    g900   31395 Jun 18 14:01 hasbind
   

3. Then create a file /etc/cap.ora. It must be owned by root and be read-only for everybody except root:

   -rw----r--  1 root root 34 Jun 18 14:05 /etc/cap.ora
   

4. Edit the /etc/cap.ora file, so that it contains a single line, like the following:

   cat /etc/cap.ora
   +user <user>: bind port 25,143
   

   Replace <user> with the software owner (the user used to install Oracle Beehive). List each privileged port you will configure an Oracle Beehive service to use, separated by commas. If you are changing from one privileged port to another privileged port, you can delete the port number that will become unused, to release it.

5. You may now configure Oracle Beehive components to use the privileged ports you have designated in the cap.ora file. Follow the procedure for changing ports as normal.

Common Oracle Beehive Service Management Commands

Table 5-1, "Common Service Management beectl Commands" lists beectl commands you are likely to use when managing Oracle Beehive services.

Table 5-1 Common Service Management beectl Commands

Command	Description
list_components	Lists the components in the configuration repository
list_connection_pools	Lists available connection pools in the system
list_properties	Fetches the value of the given property name for the given component ID. If property name is not specified then all the properties are listed
list_ports	Lists all ports in use (by the current Applications tier), including which component and property is using the port, and the protocol in use by that port
modify_port	Changes the port through which a service communicates. You must specify the protocol. If your port change affects a privileged port, you must take the additional steps in "Modifying Oracle Beehive Ports using Privileged Port Numbers" when using this command
list_property_metadata	Lists the metadata about all the properties of a system model object
modify_property	Updates the value(s) for the named property for the component identified by --component. Multiple values can be set for one property
modify_secure_property	Updates the sensitive property of the system model object identified by the --component
list_statistics	Lists collected statistical information about the functioning of a given type of component
delete_property	Clears the value of specified property in the config object identified by specified ID

Managing Oracle Beehive Core Services

Core services perform fundamental system functions, such as user management and authentication. This section describes management tasks and commands for the following services:

• Managing the Access Control Service

• Managing the Audit Service

• Managing the Authentication Services

• Managing the Client Management Service

• Managing the Device Management Service

• Managing the Event Services

• Managing the Management Service

• Managing the Policy Service

• Managing the Presence Service

• Managing the User Directory Service

• Managing the Workflow Service

Managing the Access Control Service

The Access Control Service manages how users are permitted to access (see, use, and manipulate) entities in Oracle Beehive, such as files, workspaces, client services, and shared resources.

See Also:

"Managing Oracle Beehive Access Control"

Configuring the Access Control Service

There are no configuration settings for this service.

Related beectl Commands

The following beectl commands are related to the Access Control Service:

• add_assigned_role: Creates an AssignedRole entity

• add_local_ace: Adds an Access Control Entry (ACE) to an entity's Local Access Control List (LACL)

• add_role_definition: Creates a RoleDefinition entity

• add_sensitivity: Creates a Sensitivity entity

• add_sensitivity_ace: Adds an Access Control Entry (ACE) to a Sensitivity entity's Sensitivity ACL (SACL)

• delete_assigned_role: Deletes an AssignedRole entity

• delete_local_ace: Deletes an Access Control Entry (ACE) from the Local Access Control List (LACL) of an entity

• delete_role_definition: Deletes a RoleDefinition entity

• delete_sensitivity: Deletes a Sensitivity entity

• delete_sensitivity_ace: Deletes an Access Control Entry (ACE) from the Sensitivity Access Control List (SACL) of a Sensitivity entity

• list_access_control_fields: Lists the AccessControlFields of an entity

• list_access_types: Lists available access type names and identifiers

• list_assigned_roles: Lists AssignedRole entities

• list_local_acl: Lists the Local Access Control List (LACL) of an entity

• list_privileges: Lists available Privilege names

• list_role_definitions: Lists RoleDefinition entities

• list_sensitivities: Lists Sensitivity entities

• list_sensitivity_acl: Lists the Sensitivity Access Control List (SACL) of a Sensitivity

• modify_access_control_fields: Modifies the AccessControlFields of an existing entity

• modify_assigned_role: Modifies an existing AssignedRole entity

• modify_local_ace: Replaces an Access Control Entry (ACE) in the Local Access Control List (LACL) of an entity

• modify_role_definition: Modifies an existing RoleDefinition entity

• modify_sensitivity: Modifies an existing Sensitivity entity

• modify_sensitivity_ace: Replaces an Access Control Entry (ACE) in the Sensitivity Access Control List (SACL) of a Sensitivity entity

Managing the Audit Service

The Audit Service is the service interface to the Oracle Beehive Audit Framework, which supports and manages all aspects of auditing for system events.

When Oracle Beehive is installed, auditing functions are disabled by default. You can enable auditing by modifying the auditing policy. For instructions on how to enable auditing using the auditing policy, see Module (UNKNOWN STEP NUMBER) , "Managing Oracle Beehive Events, Policies, and Workflows".

Once auditing is enabled, you can use the various beectl commands to create audit trails.

See Also:

"Managing Auditing Policies".

Configuring the Audit Service

Table 5-2, "Audit Service Configuration Parameters" lists the available configuration parameters for this service.

Table 5-2 Audit Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
LogonRecordCleanupInterval	60	10 - 6000	The logon record cleanup interval, in minutes
LogonRecordDuration	480	30 - 6000	Session expiration time, in minutes

Related beectl Commands

The following beectl commands are available for you to use for managing Auditing.

• list_audit_policies: Lists all audit policies, returning each policy's name and identifier

• add_audit_policy: Creates a new audit policy by importing from an XML file

• modify_audit_policy: Modifies an existing audit policy by importing changes from an XML file

• delete_audit_policy: Deletes a specified audit policy

  See Also:

  For more information about managing policies, including audit policies, see Module (UNKNOWN STEP NUMBER) , "Managing Oracle Beehive Events, Policies, and Workflows".

• list_audit_templates: Lists audit policy templates and their identifiers

• add_audit_template: Adds a new audit template

• delete_audit_template: Deletes an audit template

• list_audit_trails: Lists all audit trails, returning each audit trail's name and CollabID

• add_audit_trail: Creates a new audit trail by importing from an XML file

• modify_audit_trail: Modifies an existing audit trail by importing changes from an XML file

• delete_audit_trail: Deletes a specified audit trail

• export_audit_trail: Exports an audit trail definition into an XML file

Managing the Authentication Services

The Authentication Services manage all aspects of user authentication for Oracle Beehive, including single sign-on (SSO), user repository authentication, authentication policies, and encryption. The Authentication Services leverage the components and protocols that support Java Authentication and Authorization Service (JAAS) and Simple Authentication and Security Layer (SASL). Client-specific authentication libraries can be supported as well.

There are two services responsible for authentication functionality:

• Authentication Service

• Identity Provider Service

Managing the Authentication Service

The Authentication Service manages and supports a variety of authentication providers, including local authentication providers, existing LDAP servers, native Windows authentication providers, and Web-based SSO providers.

Configuring the Authentication Service

Table 5-3, "Authentication Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _AuthenticationService

Table 5-3 Authentication Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
AuthenticationRealm	"Authorized_Users"	String	Sets the authentication realm
AuthStoreType	db	db, ldap	The authentication store type the system is configured against
HashAccessorPlugin	{"DB:oracle.ocs.csi.authentication.handlers.impl.jaas.callback.impl.OcsDbHashAccessor","ORACLE_INTERNET_DIRECTORY:oracle.ocs.csi.authentication.handlers.impl.jaas.callback.impl.OcsLdapHashAccessor","MICROSOFT_ACTIVE_DIRECTORY:oracle.ocs.csi.authentication.handlers.impl.jaas.callback.impl.OcsLdapHashAccessor","SUN_ONE_DIRECTORY:oracle.ocs.csi.authentication.handlers.impl.jaas.callback.impl.OcsLdapHashAccessor","IBM_TIVOLI_DIRECTORY:oracle.ocs.csi.authentication.handlers.impl.jaas.callback.impl.OcsLdapHashAccessor"}	Configuration entry format is \"PluginName:PluginClass\". Config plugin name must be the type of the directory (DB, ORACLE_INTERNET_DIRECTORY, MICROSOFT_ACTIVE_DIRECTORY, SUN_ONE_DIRECTORY, IBM_TIVOLI_DIRECTORY)."	The list of configured accessor plugins
IdMap			Map of ID format to ID mapping attribute
IdMapPlugin	"oracle.ocs.csi.authentication.login.modules.impl.OcsIdMap"	String	IdMap plugin class name
LockoutTime	7200	Integer	Lockout time in seconds
LoginAttempts	1	Integer	Maximum allowed number of contiguous failed login attempts before the principal/credential account gets locked. Disable by setting to -1
OssoConfigFile		string	The location of the OSSO configuration file
PwdAccessorPlugin	{"DB:oracle.ocs.csi.authentication.handlers.impl.jaas.callback.impl.OcsDbPasswordAccessor","ORACLE_INTERNET_DIRECTORY:oracle.ocs.csi.authentication.handlers.impl.jaas.callback.impl.OcsLdapPasswordAccessor","MICROSOFT_ACTIVE_DIRECTORY:oracle.ocs.csi.authentication.handlers.impl.jaas.callback.impl.OcsLdapPasswordAccessor","SUN_ONE_DIRECTORY:oracle.ocs.csi.authentication.handlers.impl.jaas.callback.impl.OcsLdapPasswordAccessor","IBM_TIVOLI_DIRECTORY:oracle.ocs.csi.authentication.handlers.impl.jaas.callback.impl.OcsLdapPasswordAccessor"}	Configuration entry format is \"PluginName:PluginClass\". Config plugin name must be the type of the directory (DB, ORACLE_INTERNET_DIRECTORY, MICROSOFT_ACTIVE_DIRECTORY, SUN_ONE_DIRECTORY, IBM_TIVOLI_DIRECTORY).")	The list of configured accessor plugins
SAMLRegistrationMap		String	A map of saml identities. The key of the map is the identity name and the value is its registered @see SAMLIdentity
SsoLogoutUrl		String	The URL to be redirected to after SSO logout
SsoType	jsso	coreid, jsso, osso	The SSO Server Type that the system is configured to use
TokenTimeout	300	Integer	Token timeout in seconds. Value of 0 indicates indefinite timeout
UseJazn	false	true, false	Determines whether JAZN LDAP mode should be used for Oracle Internet Directory
UseSecureCookie	false	true, false	Indicates whether the SSO cookie must only be sent over a secure connection (i.e. SSL)
UseSecureHash	false	true, false	Indicates whether the secure hash should be used for authentication (for LDAP only)
WnaEnabled	false	true, false	Determines whether Windows Native Authentication is enabled
WnaKeytab			The location of the Windows Native Authentication key tab file
WnaPrincipal			The Windows Native Authentication principal
WsSecurityExpiry	3600	Integer	The Web Service inbound and outbound message expiry, in seconds. For the outbound messages, expiry refers to the expiry of the message from the time it was created. For the inbound messages, expiry refers to the expiry of the signature attached in the message
WsSecuritySamlEnabled	false	true, false	Indicates whether SAML authentication should be enabled for the Web Service authentication
WsSecuritySigKeyAlias		String	The signature key alias for signing the ws outbound messages
WsSecuritySigKeyPwd		SecureString	The signature key password for signing the ws outbound messages

Related beectl Commands

There are no beectl commands related to the Authentication Service.

Managing the Identity Provider Service

The Identity Provider Service provides certificate authority features for Oracle Beehive, enabling the system to manage digital certificates and other related security credentials.

See Also:

For information on how to set up Oracle Beehive with a digital certificate to enable secure communications, see "Configuring TLS with Oracle Wallet" in the Oracle Beehive Installation Guide for your platform.

Configuring the Identity Provider Service

Table 5-4, "Identity Provider Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _IdentityProviderService

Table 5-4 Identity Provider Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
IdpSAMLIdentity		String
IdpCert		String	This property is only available in Oracle Beehive versions 1.2 and earlier
IdpKey		String	This property is only available in Oracle Beehive versions 1.2 and earlier
IdpUrl		String
SpCert		String	This property is only available in Oracle Beehive versions 1.2 and earlier
SpKey		String	This property is only available in Oracle Beehive versions 1.2 and earlier
SpUrl		String

Related beectl Commands

There are no beectl commands related to the Identity Provider Service.

Managing the Client Management Service

The Client Management Service enables administrators to manage client software settings related to client connections, notification thresholds, and debugging.

Configuring the Client Management Service

Table 5-5, "Client Management Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _ClientManagementService

Table 5-5 Client Management Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
DebugMode	false	true, false	If set to true, the Client Management Service will send exception stack traces to the client in debug mode ADVANCED
NotificationQueueResumeThreshold	50	Integer	ADVANCED
NotificationQueueSuspendThreshold	100	Integer	Maximum number of pending notifications that can be held by the Client Management Service for the client. After the queue reaches that size, a special marker is set in the notifications queue, and further notifications will not be queued ADVANCED
OutputFrameSize	32768	1 - 65535	Amount of data CMS will output in a single frame of stream protocol ADVANCED
SessionTimeout	3000		The amount of time in milliseconds that the Client Management Service will wait for a broken client session to reconnect before timing out
StreamReadBufferSize	131072	Integer	Amount of data CMS will try to read in a single call when working with streams ADVANCED
StreamWriteBufferSize	131072	Integer	Amount of data CMS will write in a single call when working with streams ADVANCED
TraceEnabled	false	true, false	The Client Management Service will log all requests and responses when this property is enabled ADVANCED

Related beectl Commands

There are no beectl commands related to the Client Management Service.

Managing the Device Management Service

The Device Management Service is responsible for device and application program management. The Device Management Services consists of two areas of functionality:

• Device Management: The service manages user devices, including creating, deleting, updating, and retrieving devices. It allows administrators to manage device types and device profiles.

• Application Management: The service hosts application programs in the Oracle Beehive repository and makes it possible for users to install and configure applications on various devices (including PCs and mobile devices) with minimum user interaction.

Configuring the Device Management Service

Table 5-6, "Device Management Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _DeviceManagementService

Table 5-6 Device Management Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
BlockedDevices			The list of blocked devices. Manage items in this list using the appropriate beectl commands
UncertifiedDeviceAllowed	false	true, false	Whether an uncertified device is allowed access for mobile services or not

Related beectl Commands

The following beectl commands are available for you to use for managing this service:

• list_client_applications: Lists all the client applications

• upload_client_application: Uploads the device management client binaries into the repository

• delete_client_application: Deletes a client application

• list_client_application_configuration: Lists all the client application configurations

• add_client_application_configuration: Creates a client application configuration object from a supplied input file. The resulting object will be used for client application provisioning

• delete_client_application_configuration: Deletes the client application configuration with the given identifier

• export_client_application_configuration: Exports a client application configuration to a local file

• add_client_application_provisioning: Provisions client applications to a community

• list_client_application_versions: Lists all the versions for a given client application

• delete_client_application_version: Deletes a client application version

• list_client_application_patchsets: Lists the patchsets for a given client application version

• delete_client_application_patchset: Deletes a client application patchset

• list_client_application_modules: Lists the modules for a given client application patchset

• list_devices: Lists the devices for a user

• list_device_types: Lists all the device types

• list_device_profiles: Lists all the device profiles

• upload_device_profiles: Uploads device profiles to the repository. An XML file is used as the source for the device profiles. The file can also contain device types and device profile schema

• delete_device_profile: Deletes the device profile with the given identifier. The command can also optionally delete all the device types associated with this device profile

• list_device_commands: Lists the device commands for a given device. The list can be further filtered by specifying the status of the device command

• add_device_command: Creates a device command for a given device

• add_blocked_device: Creates a blocked device. The system object identifier of the resulting object needs to be added to the 'DeviceManagementService' system object, using modify_property command, to block this device from accessing Beehive Mobile Services

• delete_device_type: Deletes the device type with the given identifier

• download_syncml_messages: Downloads SyncML messages

See Also:

For detailed information about managing mobile devices and mobile device software, see Module (UNKNOWN STEP NUMBER) , "Managing Oracle Beehive Mobility Services".

Managing the Event Services

There are two services responsible for providing events functionality:

• Event Service

• Object Event Publisher Service

Managing the Event Service

The Event Service exposes business events for use by other services, including policies, workflows, notifications, logging, and auditing functions.

Configuring the Event Service

Table 5-7, "Event Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _EventService

Table 5-7 Event Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
AsyncActionRetryCount	5		The number of times failed actions will be retried
AsyncLogLevel	WARNING		The Async Events Processing Log Level. This log level is different from user Log level. Asynchronous Events processing happens in the database and in a different session from the user session
EventsDisabled	false	true, false	The Events Disabled Flag. If this flag is true all the business events are turned off and none of the events are processed. This is just to debug deployment issues
MaxThreadPoolSize	10	Integer	The Max Thread Pool size used to process java actions. This value determines the maximum number of simultanious processes can get executed to deliver the messages to the services
PreEvaluateThresholdRuleCount	1000		The threshold rules count value to evaluate the rules before the asynchronous event is put into Event queue. If the number of subscriptions for a given event is more than this threshold value, pre evaluation is skipped. This parameter is used to improve the overall performance. If the pre evaluation is run, and there are no matched rules, the event can be discarded safely

Related beectl Commands

The following beectl commands are available for you to use for managing this service:

• list_events: Lists all business object events

• add_event_subscription: Fully Qualified Location of the XML file that holds data to create Event Subscription

• delete_event_subscription: Removes event subscription from Beehive Repository

Managing the Object Event Publisher Service

The Object Event Publisher Service handles the notification logic for object-level events in Oracle Beehive

Configuring the Object Event Publisher Service

There are no configuration parameters for this service.

Related beectl Commands

There are no beectl commands related to this service.

Managing the Management Service

The Management Service supports various aspects of system administration for Oracle Beehive.

Configuring the Management Service

Table 5-7, "Event Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _ManagementService­

Table 5-8 Management Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
AutoSyncSaveListenerSleepIntervalInSeconds	25		This determines the behavior of management service with regard to the synchronization of configuration file(s). This is the sleep interval for the save listener after which auto sync will be attempted ADVANCED
AutoSyncSaveListenerTimeoutInSeconds	20		This determines the behavior of management service w.r.t the synchronization of configuration file(s). This is the timeout interval for the save listener ADVANCED
LocalFileSyncEnabled	false	true, false	This determines the behavior of management service with regard to synchronization of configuration file(s) on the Oracle Beehive Instance where management service instance is running. If this property is set to "true", management service will detect changes to the system model and automatically update local configuration file(s) to be in sync ADVANCED
LogSearchMaximumResults		integer	Maximum number of results to be returned from a log search This property is only available in Oracle Beehive versions 1.3 and later ADVANCED
LogSyncEnabled	true	true, false	Determines whether Log Sync is enabled This property is only available in Oracle Beehive versions 13 and later ADVANCED
LogSyncFlag	0	0, 1	Determines whether Log Sync is enabled This property is only available in Oracle Beehive versions 1.2 and earlier ADVANCED
LogUploadFilter		string	This property is only available in Oracle Beehive versions 1.3 and later ADVANCED
LogUploadInterval	6		The Log Manager Upload Interval (in minutes) property for a ManagementService object ADVANCED
UploadLevel	"OFF"		The Log Manager Upload Level property for a ManagementService object ADVANCED

Related beectl Commands

There are no beectl commands related to managing this service.

Managing the Policy Service

The Policy Service enables organizations to centrally apply, manage, and store business logic for Oracle Beehive events.

See Also:

For information and instructions on managing policies, see Module (UNKNOWN STEP NUMBER) , "Managing Oracle Beehive Events, Policies, and Workflows".

Configuring the Policy Service

There are no configuration parameters for this service.

Related beectl Commands

The following beectl commands are available for you to use for managing this service:

• list_events: Provide the name of an event to view its description

• list_policies: lists the names and CollabIDs of all policies deployed in a given container. If a policy name is specified, the details of that policy are listed.

• add_policy: Create a policy by importing from an XML file

• export_policy: Exports a policy definition into an XML file

• modify_policy: Updates an existing policy by importing changes from an XML file

• delete_policy: Deletes a specified policy

• list_policy_actions: Lists all policy actions

• list_policy_schemas: Lists existing policies in a container. Details returned include policy names and identifiers

• add_policy_schema: Creates a new policy schema by importing from an XML file

• modify_policy_schema: Updates an existing policy schema by importing changes from an XML file

• delete_policy_schema: Deletes a specified policy schema

• list_policy_templates: Lists the names and CollabIDs of all policy templates (within a specified scope)

• add_policy_template: Creates a new policy template by importing from an XML file

• modify_policy_template: Updates an existing policy template by importing changes from an XML file

• delete_policy_template: Deletes a specified policy template

• list_audit_policies: lists the names and CollabIDs of all audit policies (within a specified scope)

• add_audit_policy: Creates a new audit policy by importing from an XML file

• modify_audit_policy: Updates an existing audit policy by importing changes from an XML file

• delete_audit_policy: Deletes a specified audit policy

Managing the Presence Service

The Presence Service supports and manages all aspects of user and resource presence for Oracle Beehive

Configuring the Presence Service

Table 5-9, "Presence Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _PresenceService

Table 5-9 Presence Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
ActivityStartTimeThreshold	300000	Integer	Presence service accepts only current activities and those activities with start times up to this value (in milliseconds) into the future
DbCheckpointInterval	300000	Integer	The interval at which data will be persisted to the database, in milliseconds This property is only available in Oracle Beehive versions 1.2 and earlier
GroupPresenceHandlerThreadCount	10	Integer	The number of threads running to handle group presence calculation on user presence change This property is only available in Oracle Beehive versions 1.2 and earlier
OefCallBackTimeOut	10000	Integer	The time for which the service will wait for OEF to complete the CallBack, in milliseconds This property is only available in Oracle Beehive versions 1.2 and earlier
OefPresenceDomainName	"presence"	String	The domain name to be used by the presence service when using OEF This property is only available in Oracle Beehive versions 1.2 and earlier
OrgAutoSubscription	false	true, false	No authorization is needed for the presence subscription if the value is true This property is only available in Oracle Beehive versions 1.2 and earlier
PublicPresenceEnabled	true	true, false	With public presence enabled, users' contact methods may be made "public" (visible to everyone, including un-authenticated users). When public presence is enabled, an individual may disable his public presence. If false, public presence is disabled for all users regardless of any user preferences. This property is only available in Oracle Beehive versions 1.3 and later

Related beectl Commands

There are no beectl commands related to managing this service.

Managing the User Directory Service

The User Directory Service (UDS) stores and retrieves information about all Oracle Beehive users. You can manage users, groups, and address books using UDS.

See Also:

• For more information about managing users and groups, see "Managing and Provisioning Oracle Beehive Users".

• For more information about managing coexistence users, see "Configuring and Managing Oracle Collaboration Coexistence Gateway".

• For more information about setting up and managing an external LDAP-based user directory, see "Integrating and Synchronizing LDAP with Oracle Beehive" in the Oracle Beehive Installation Guide for your platform.

Configuring the User Directory Service

Although there are dozens of parameters stored by the User Directory Service, most of them are exposed via beectl commands and should not be modified directly. The only exception are the parameters found in the ConfigurationParameters subcomponent.

Table 5-10, "User Directory Service Configuration Parameters" shows the parameters stored by the UserDirectoryService$ConfigurationParameters component.

Use the beectl list_properties command to get the list of all properties stored by the component. Each property is listed by name, along with its current value:

beectl> list_properties --component _UserDirectoryService:ConfigurationParameters

Table 5-10 User Directory Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
AttributeList		<comma-delimited list of identifiers>	The publicly shown user attributes
MaxEntityAddressCount	3
SuperMaxEntityAddressCount	5

Note:

The ConfigurationParameters subcomponent stores a parameter called the AttributeList. This parameter controls which user attributes are public, meaning, are shown to all Oracle Beehive users.

The list contains component IDs. You can list each attribute by using the beectl list_properties command, passing the component ID as the --component.

Related beectl Commands

The following beectl commands are available for you to use for managing this service:

• add_directory_profile: Adds directory profile to configuration repository.

• add_group: Adds a group containing users

• add_preference_profile: Adds an active preference profile for a consumer (user and groups only), if it already has a active preference profile command fails.

• add_preference_property: Adds a preference property to a preference set, business_hours (multiweek), datetime and datetime_list types are not implemented

• add_preference_set: Adds a preference set to a preference profile, template identifier is not implemented.

• add_user: Creates a user in a given enterprise and organization

• delete_directory_profile: Deletes directory profile from configuration repository.

• delete_group: Deletes an existing group

• delete_preference_property: Deletes a preference property of given name from preference set.

• delete_preference_set: Deletes a preference set.

• delete_user: Deletes an existing user.

• download_external_user_data: Generates user data from an external directory in XML format

• list_coexistence_users: Lists the names and coexistence types of all the users provisioned with a coexistence connector.

• list_custom_user_properties: Lists all custom attributes

• list_directory_profiles: Prints the directory profiles to a file.

• list_groups: Lists groups and prints group information

• list_max_address_count: Lists the maximum entity address count and the supermax.

• list_preference_profiles: Lists preference profiles for a consumer.

• list_preference_properties: Lists all the effective preference properties of a preference set.

• list_preference_sets: Lists all the preference sets for a preference profile.

• list_users: Lists all users and prints user names and identifiers

• modify_coexistence_user: Provisions or deprovisions a user to a coexistence connector.

• modify_group: Modifies group

• modify_max_address_count: Sets maximum entity address count in UDS service. NOTE: should be less than Supermax. Use list_max_address_count to get Supermax

• modify_preference_set: Sets the extends from attribute of the preference set, not yet implemented.

• modify_user: Modifies an existing user

Managing the Workflow Service

The Workflow Service supports and manages for Oracle Beehive all workflow settings and other aspects that are related to integrations with Business Process Execution Language (BPEL) components.

See Also:

• For instructions on how to manage workflows, see Module (UNKNOWN STEP NUMBER) , "Managing Oracle Beehive Events, Policies, and Workflows".

• For instructions on creating custom workflows, see Oracle Beehive Application Developer's Guide.

Configuring the Workflow Service

Table 5-11, "Workflow Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _WorkflowService

Table 5-11 Workflow Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
BpelCluster			The BPEL process manager cluster used by workflow. This value is set during installation.

Related beectl Commands

The following beectl commands are available for you to use for managing this service:

• list_workflows: Lists all workflows

• list_workflow_schemas: Lists workflow schemas

• add_workflow_schema: Deploys workflow and seed workflow information

• delete_workflow_schema: Deletes a workflow schema

• list_workflow_templates: Lists workflow templates deployed in a container. The list includes workflow template names and identifiers

• add_workflow_template: Creates a new workflow template by importing from an XML file

• export_workflow_template: Downloads workflow template into an XML file

• delete_workflow_template: Deletes a specified workflow template

Managing Collaborative Services

Collaborative Services provide collaboration-specific functionality that is leveraged among teams, including e-mail, time management, and instant messaging. This section describes management tasks and commands for the following services:

• Managing the Content Management Services

• Managing the Discussions Service

• Managing the E-mail Service

• Managing the Fax Message Service

• Managing the Instant Message Services

• Managing the Meetings Services

• Managing the Time Management Services

• Managing the Voice Message Service

Managing the Content Management Services

There are two services that are primarily responsible for content management functionality:

• FTP Service

• WebDAV Service

Managing the FTP Service

The FTP Service supports and manages all content management-related features and settings that the system leverages over the File Transfer Protocol (FTP) and the Secure File Transfer Protocol (FTPS).

Caution:

If you change any port, including the FTP port, to a privileged port number (a port number below 1024) on a UNIX or Linux installation, you must first perform a special procedure, and then change the port. First follow the special procedure in "Modifying Oracle Beehive Ports using Privileged Port Numbers", and then use the beectl modify_port command to change the port.

Configuring the FTP Service

Table 5-12, "FTP Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _FtpService

Table 5-12 FTP Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
ChannelSecurity	PLAIN_AND_TLS	PLAIN_AND_TLS, TLS_ONLY	Toggles between accepting both nonsecure and secure connections, or secure connections only
DataConnectionPort	12121		The starting port number from which data connections are created in passive mode
DefaultCommandCharacterset	UTF-8		The default command characterset FTP Service uses
DefaultDataPort	2120		The default port from which outgoing data connections are made
DMSInstrumentation	false	true, false	Toggles whether DMS statistics are to be collected
FtpServerEnabled	true	true, false	Toggles the FTP Server between Enabled and Disabled. When set to true, the FTP server will serve clients. When set to false, the FTP server will throw an exception when contacted
InternalIP	DEFAULT		FTP Internal IP
ListeningPoint	DEFAULT		FTP Listening Point
MaxDCPortCount	200		The maximum number of ports the FTP service can use for passive listening
Port	2121		The port on which the FTP server listens for client requests
SessionTimeout	900000		The session timeout value for a client, in seconds
UploadBufferSize	16384		Size of buffer to be used in piecewise copies between streams during uploads

Related beectl Commands

The following beectl commands are related to this service:

• modify_port --protocol FTP: Allows you to change the FTP port without having to use the modify_property command

Managing the WebDAV Service

The WebDAV Service supports and manages all content management-related features and settings that the system leverages over the Web-based Distributed Authoring and Versioning (WebDAV) standard protocol.

Configuring the WebDAV Service

Table 5-13, "WebDAV Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _WebdavService

Table 5-13 WebDAV Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
AuthenticationScheme	BASIC		Default authentication scheme
BrowserSessionTime out	30		Length of time (in Minutes) before browser session will get expiredFoot 1
DavClientSessionTimeout	960		Length of time (in minutes) before dav client session will get expired
DefaultWelcomeDocs	"index.html","index.htm"		The array of welcome document names that are served up if a GET is done on a collection containing one of these documents.
DepthLimit	3	Integer 1-6	The depth limit is to be used for Propfind when depth of infinity is specified
DisplayLastModifiedBy	true	true, false	Use this parameter to hide last modified by information in generated HTML index pages
DisplayLastModifiedOn	true	true, false	Use this parameter to hide last modified on information in generated HTML index pages
DisplayLockStatus	false	true, false	Use this parameter to hide locking information in generated HTML index pages
DisplayVersioningStatus	false	true, false	Use this parameter to hide versioning information in generated HTML index pages
DMSInstrumentation	false	true, false	This parameter tells whether DMS statistics are to be collected or not
DownloadBufferSize	261888		Size of the buffer that holds the bytes copied between streams during file downloads
MinimumLockTimeout	4		The minimum timeout value, in minutes, that a client can request when acquiring a lock
UploadBufferSize	261888		Size of the buffer that holds the bytes copied between streams during file uploads. For example, a value of 1024 would mean that 1024 bytes are copied at a time from the stream
UserPreferenceRefreshTime	180		Length of time (in minutes) before user preferences are refreshed
WebDAVServer Enabled	true	true, false	Parameter to enable/disable WebDAV server. If the parameter is set to TRUE, webDAV server will service clients. If it is set to FALSE, webDAV server is virtually down and will throw an exception when contacted

^Footnote 1 When the browser session times out, the WebDAV session is invalidated, but if the SSO cookie is still present, SSO will not prompt the user to sign in. Thus, between the browser timeout and the SSO session timeout, the greater value will take effect.

Related beectl Commands

There are no beectl commands related to this service.

Managing the Discussions Service

The Discussions service exposes an API which developers may use to add discussions functionality to the Beehive end-user services.

Configuring the Discussions Service

There are no configuration parameters for this service.

Related beectl Commands

There are no beectl commands related to managing this service.

Managing the E-mail Service

The E-mail Service supports all aspects of e-mail creation, delivery, and management for Oracle Beehive, including by leveraging existing e-mail applications and servers.

Caution:

If you change any port, including the various e-mail ports, to a privileged port number (a port number below 1024) on a UNIX or Linux installation, you must first perform a special procedure, and then change the port. First follow the special procedure in "Modifying Oracle Beehive Ports using Privileged Port Numbers", and then use the beectl modify_port command to change the port.

See Also:

"Managing Oracle Beehive E-mail"

Configuring the E-mail Service

The following tables list the available configuration parameters for this service:

• Table 5-14, "E-mail Service Configuration Parameters"

  Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

  beectl> list_properties --component _EmailService
  

• Table 5-15, "E-mail Service IMAP Properties"

  Use the beectl list_properties command to get the list of all properties for the service subcomponent. Each property is listed by name, along with its current value:

  beectl> list_properties --component _EmailService:IMAPProperties
  

• Table 5-16, "E-mail Service Persistence Properties"

  Use the beectl list_properties command to get the list of all properties for the service subcomponent. Each property is listed by name, along with its current value:

  beectl> list_properties --component _EmailService:PersistenceProperties
  

• Table 5-17, "E-mail Service SMTP Properties"

  Use the beectl list_properties command to get the list of all properties for the service subcomponent. Each property is listed by name, along with its current value:

  beectl> list_properties --component _EmailService:SMTPProperties
  

• Table 5-18, "E-mail Service Transport Properties"

  Use the beectl list_properties command to get the list of all properties for the service subcomponent. Each property is listed by name, along with its current value:

  beectl> list_properties --component _EmailService:TransportProperties
  

• Table 5-19, "E-mail Service CSI Properties"

  Use the beectl list_properties command to get the list of all properties for the service subcomponent. Each property is listed by name, along with its current value:

  beectl> list_properties --component _EmailService:CSIProperties
  

Note:

A number of the most common configuration tasks are exposed as beectl commands. Wherever possible you should use the beectl commands, rather than setting properties directly. See "Related beectl Commands".

Table 5-14 E-mail Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
CoexUserLocal	false	true, false	Indicates if users with the "isCoex" property should be considered local or not ADVANCED
DirectoryCacheTTL	60000	0 - 9223372036854775807	The max lifetime (in milliseconds) for an entry in the Directory Lookup cache ADVANCED
GlobalDomainName	default		The global domain name
IMAPEnabled	true	true, false	Indicates if IMAP's listening endpoints should be enabled or not. If modified from true to false, only the listening endpoints are shutdown. Existing client connections are not closed ADVANCED
LocalEmailPatterns	*@example.com	string	A list of patterns that constitute local e-mail addresses
MaxDirectoryCacheEntries	8192	0 - 2147483647	The maximum size of the cache of directory lookups ADVANCED
MaxMailSz	50000000	0 - 9223372036854775807	Max size of a mail before server aborts a send
NonLocalEmailPatterns		string	A list of patterns that constitute non-local acceptable e-mail addresses
SaveParseErrorEmails	false	true, false	ADVANCED
SMTPEnabled	true	true, false	Indicates if SMTP's listening endpoints should be enabled or not. If modified from true to false, only the listening endpoints are shutdown. Existing client connections are not closed ADVANCED
SubjectSortingGroupingRules	"(^\\[[fF][wW][dD]:( )*)((.)*)(\\]$)","3"		A list of subject grouping rules
SubjectSortingReplacementRules	"[\t\n\r]"," ","^( )+","","( )+$","","( )+"," ","^([rR][eE]|[fF][wW][dD]?):","","\\([fF][wW][dD]\\)$",""		A list of subject replacement rules
TimeoutCheckingInterval	60000	0 - 9223372036854775807	Timeout checking interval ADVANCED
WebRedirectUrl	"webui?collabid="		ADVANCED

Table 5-15 E-mail Service IMAP Properties

Parameter	Default Value	Valid Values	Description
AssumeSingleEndpoint	true	true, false	The system can either be configured in a very simple manner (listen on a single port) or complex. In simple mode, all that admins need enter is a port. If this is false, administrators can configure many endpoints.
CacheMessageSize	12	1-9223372036854775807	Property giving the approximate size in bytes of each message cached in memory. Larger values will prevent overrun memory but will impact performance. Note that this is an approximation.
ClientKeepAliveInterval	10000	0-9223372036854775807	The interval after which some unsolicited response is sent to a client to keep it active (in millseconds) ADVANCED
EndpointPropertiesList		comma-delimited list of identifiers	The list of IMAP Endpoints. Only used if AssumeSingleEndpoint is set to false
FolderCacheDirectory	../../beehive/mailspool/temp/imap	String	The IMAP folder cache directory. IMAP will store temporary files in this directory ADVANCED
FolderOpenBatchSize	1000	1-2147483647	Property controlling the batch size IMAP uses to drain the cursor while opening a folder for SELECT or EXAMINE. Setting a small number will reduce memory usage but will impact performance
FolderPollingInterval	20000	0-9223372036854775807	The interval by-which the database is polled for changes to the currently selected IMAP folder ADVANCED
FolderSyncBatchSize	50	1-2147483647	The batch size used for checking updates to folders This property is only available in Oracle Beehive versions 1.3 and later ADVANCED
LoginErrorThreshold	3	0-2147483647	The number of login errors tolerated before the connection is forcibly closed ADVANCED
MaxFolderCacheSize	52428800	0-2147483647	Property controlling the maximum amount of memory available for IMAP folder caching. Note that this is always an approximation. A small value will guarantee not to overrun memory, but will impact performance ADVANCED
MaxSessions	1024	0-2147483647
MessageLoadBatchSize	50	0-2147483647	Property controlling the batch size IMAP uses to load messages from the database. Setting a small number will reduce memory usage but will impact performance. A larger number will improve performance but will increase memory usage per selected folder
ParseErrorThreshold	3	0-2147483647	The number of consecutive parser errors tolerated before the connection is forcibly closed ADVANCED
Port	143		The port on which the IMAP server should accept connections
SearchSupportLevel	4	0-5	ADVANCED
ServerSessionConcurrency	23	1-2147483647	ADVANCED
SessionTimeout	1800000	0-9223372036854775807	The duration in milliseconds after which inactive IMAP sessions are automatically logged out and closed ADVANCED
ShowInstanceNameInBanner	false	true, false	If true, Oracle Beehive will add the instance name into a greeting banner. This is for troubleshooting purposes only ADVANCED
StreamReadBufferSize	32768	1-2147483647	ADVANCED
SurrogateAuth	false	true, false	If true, IMAP allows surrogate authentication during login.
TlsMandatory	false	true, false	If true, when UseTls is enabled IMAP makes STARTTLS mandatory This property is only available in Oracle Beehive versions 1.3 and later
UseTls	false	true, false	If true, IMAP advertises STARTTLS capability This property is only available in Oracle Beehive versions 1.3 and later

Table 5-16 E-mail Service Persistence Properties

Parameter	Default Value	Valid Values	Description
CopyBatchSize	1000	1-10000	Property controlling the batch size for copy operations.
DeleteBatchSize	1000	1-10000	Property controlling the batch size for delete operations
DurableFileRoot	"../../beehive/mailspool/perm"		The location of the durable file store
MaxDbConnRetry	2	1-2147483647	ADVANCED
MaxFileCacheSz	500000000	0-9223372036854775807	The max size of the (total) file cache, in bytes
MoveBatchSize	1000	1-10000	Property controlling the batch size for move operations
PldStoreCacheLinger	180000	0-9223372036854775807	ADVANCED
PldStoreMaxMemCachedRecords	2000	0-2147483647	ADVANCED
PldStoreMaxOpenFDs	1000	0-2147483647	ADVANCED
PldStoreRecordCacheSz	50000	0-2147483647	ADVANCED
PldStoreStreamBufSz	8192	0-2147483647	ADVANCED
TempFileRoot	"../../beehive/mailspool/temp"		The location of the temporary file store
UndeleteBatchSize	1000	1-10000	Property controlling the batch size for undelete operations
UpdateFlagsBatchSize	1000	1-10000	Property controlling the batch size for update flags operations

Table 5-17 E-mail Service SMTP Properties

Parameter	Default Value	Valid Values	Description
AssumeSingleEndpoint	true	true, false	The system can either be configured in a very simple manner (listen on a single port) or complex. In simple mode, all that admins need enter is a port. If this is false, administrators can configure many endpoints.
Authentication	false	true, false	If true, SMTP allows authentication command
DSNEnabled	true	true, false	Whether DSN is supported
EndpointPropertiesList		comma-delmited list of identifiers	The list of SMTP Endpoints ADVANCED
Port	25		The port on which the SMTP server should accept connections
SendMailEvenIfNoTls	false	true, false	If true, SMTP outbound sends mail even if no TLS is available
ServerSessionConcurrency	23	1-2147483647	ADVANCED
UseTls	false	true, false	If true, SMTP advertises starttls command
VMSEvaluator	"default"	XML document	The definition of VMS Evaluator ADVANCED
VMSPropertiesList		comma-delimited list of object identifiers	The list of VMSes ADVANCED

Table 5-18 E-mail Service Transport Properties

Parameter	Default Value	Valid Values	Description
AcceptInvalidLocalUsers	false	true, false	Indicates if non-existent local users should be accepted by the transport system and treated as remote recipients. Should be set to true when users for a single domain exist in beehive and non-beehive mail servers ADVANCED
DeliveryConcurrency	5		The delivery concurrency
DeliveryRules	"default"	XML document	The definition of Delivery rules
InMemoryQueueSize	250	1-2147483647	The In-memory queue size
KeepAliveInterval	120000	0-9223372036854775807	The duration after which a dead instance's mails are recovered for processing by other instances, in milliseconds
LocalDeliveryBatchSize	100	1-2147483647	The local delivery batch size
MaxReceivedHeaders	25		The maximum number of received headers allowed in one message. If the number of received headers exceeds this limit, the message will be dropped silently
MaxRetryPeriod	432000000	0-9223372036854775807	The maximum duration for which a message is retried, in milliseconds. (The default value is five days)
MaximumDBMessageQueuePercentage	80	0-100	The maximum percentageof the queue that will be used for processing messages from the database
MinimumDBMessageQueuePercentage	20	1-100	The minimum percentage of the queue reserved for processing messages from the database
MsgTerminusRules	"default"	XML document	The definition of Message Terminus rules
PostDeliveryRules	"default"	XML document	The definition of Post Delivery rules
PostResolutionRules	"default"	XML document	The definition of PostResolution rules
PreResolutionRules	"default"	XML document	The definition of PreResolution rules
ProcessingEnabled	true	true, false	This property controls if the processing pipeline between receive and deliver is operational. Setting this to false has the effect of preventing new e-mails from reaching inboxes.
QueuePollInterval	120000	0-9223372036854775807	The queue poll interval, in milliseconds
RelayServer	YOUR_RELAY_HOST_HERE	String	If in SimpleRelay mode, this is the name of the relay server
RetryInterval	1800	1-2147483647	The retry interval in seconds
ScanOnUpload	false	true, false	A flag to indicate if virus scanning should be performed on upload of messages or not ADVANCED
SimpleRelayMode	true	true, false	For simplicity, Administrators can shortcut DeliveryRules and declare that the system is only in relay mode. In this mode, all that need be set is the RelayServer
SMTPDeliveryBatchSize	100	1-2147483647	The SMTP delivery batch size
SMTPDeliveryCheckpoint	5	1-2147483647	The SMTP delivery checkpoint
ThreadPoolSize	10	1-2147483647	The thread pool size

Table 5-19 E-mail Service CSI Properties

Parameter	Default Value	Valid Values	Description
StreamBufferSize	8192	0-2147483647	The buffer size for input streams on the server side
StreamMaxReadChunkSize	16384	0-2147483647	The max read chunk size for an input stream ADVANCED
StreamMaxWriteChunkSize	16384	0-2147483647	the max write chunk size for an output stream ADVANCED
StreamPreFetchSize	0	1-2147483647	The prefetch size for input-streams. This is the number of bytes pre-fetched by the streaming framework and buffered on the client side ADVANCED
StreamTimeout	300000	0-9223372036854775807	The timeout for CSI Streams, in milliseconds

Related beectl Commands

Caution:

If you change any port, including the various e-mail ports, to a privileged port number (a port number below 1024) on a UNIX or Linux installation, you must first perform a special procedure, and then change the port. First follow the special procedure in "Modifying Oracle Beehive Ports using Privileged Port Numbers", and then use the beectl modify_port command to change the port.

The following beectl commands are available for you to use for managing this service:

• modify_port --protocol SMTP --port <port_number>

  modify_port --protocol IMAP --port <port_number>

  Allow you to change the SMTP and IMAP port numbers

  Note:

  After changing SMTP or IMAP ports, you must run activate_configuration, just as though you modified these properties using the modify_property command. Additionally, you must restart the BEEAPP component using the beectl> restart --component command.

• modify_email_queue: Enable or disable e-mail asynchronous queue processing, or process all the messages in the e-mail asynchronous queue immediately

Managing the Fax Message Service

The Fax Message Service supports and manages the delivery of fax messages to and from Oracle Beehive users.

Configuring the Fax Message Service

There are no configuration parameters for this service.

Related beectl Commands

There are no beectl commands related to managing this service.

Managing the Instant Message Services

There are two services responsible for providing instant messaging functionality:

• Instant Message Service

• XMPP Service

Managing the Instant Message Service

The Instant Message Service provides core instant messaging features.

Configuring the Instant Message Service

Table 5-20, "Instant Message Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _ImService

Table 5-20 Instant Message Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
ImBufferStageSize	500000		The stage size for IM service, in bytes. This stage size represents the size of message buffer before they get archived into database ADVANCED
ImEndPointDeathDetectionTime	5	5-300	The timer value for detecting dead end points, in seconds ADVANCED
ImPurgingPeriodTimer	300		the timer value for purging period in sec. IM service keeps purging Archived messages into database at an interval of purging period ADVANCED
PendingMessagesLimit	1100	11-2147483647	The pending messages limit for the ImService. Pending messages are the messages that are waiting to be processed. Messages sent after this limit is reached will be blocked ADVANCED

Related beectl Commands

There are no beectl commands related to managing this service.

Managing the XMPP Service

The XMPP Service supports and manages all the features and settings that the system leverages over the Extensible Messaging and Presence Protocol (XMPP) v 0.9 and 1.0.

Caution:

If you change any port, including the XMPP ports, to a privileged port number (a port number below 1024) on a UNIX or Linux installation, you must first perform a special procedure, and then change the port. First follow the special procedure in "Modifying Oracle Beehive Ports using Privileged Port Numbers", and then use the beectl modify_port command to change the port.

Configuring the XMPP Service

Table 5-21, "XMPP Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _XmppService

Table 5-21 XMPP Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
AuthMethods	"plain_text, digest_md5, cram_md5"	String (list)	list of all Supported authentication methods
DomainNamesFoot 1	"example.com"	String (list)	list of all supported domains for example "oracle.com" , "example.com"
FederationEnabled	false	true, false	set to true if login ID contains domain, otherwise set to false This property is only available in Oracle Beehive versions 1.3 and later
Language	en	any RFC 3066 compliant string	the language being used
LoginIdContainsDomain	false	true, false	if loginId contains domain or not
SearchFields	"first","last","email"	String (list)	list of all possible search fields
SupportedAgents	"uds"	String (list)	list of names of agents being supported
XmppInterServerPort	5269	Integer	the port on which XMPP servers are communicating with each other
XmppInterServerSslPort	5270	Integer	the port on which SSL is used for encryption of messages between servers
XmppPort	5222	Integer	the current XmppPort used for communication between client and server
XmppSslPort	5223	Integer	the value of port on which SSL is used for encryption for communication between client and server
XmppTimerKeepAliveTime	6	Integer	The keep-alive timer used for detecting stale connections, in minutes

^Footnote 1 After changing the XMPP Server domain name, you must restart the BEEAPP component for the change to take affect.

Related beectl Commands

Caution:

If you change any port, including the various e-mail ports, to a privileged port number (a port number below 1024) on a UNIX or Linux installation, you must first perform a special procedure, and then change the port. First follow the special procedure in "Modifying Oracle Beehive Ports using Privileged Port Numbers", and then use the beectl modify_port command to change the port.

The following beectl commands are available for you to use for managing this service:

• modify_port: Allows you to change the XMPP port number

  modify_port --protocol XMPP --port <port_number>

  Note:

  After changing XMPP ports, you must run activate_configuration, just as though you modified these properties using the modify_property command. Additionally, you must restart the XMPP Service Instance component (BEEAPP).

Managing the Meetings Services

The Meeting Services support and manage all aspects of voice and Web-based meetings and conferences for Oracle Beehive, enabling meeting organizers and participants to conduct collaborative sessions online through Oracle Beehive workspaces.

There are several services that are primarily responsible for meetings functionality:

• Conference Artifact Service

• Transcoding Service

Managing the Conference Artifact Service

The Conference Artifact Service provides web conference functionality.

Configuring the Conference Service

Table 5-22, "Conference Artifact Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _ConferenceService

Table 5-22 Conference Artifact Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
DefaultDialoutCallTimeout	3600000	Integer	The default time after which an external pstn-sip call in the voice conference will be timed out
DefaultParticipantCodec	audio/IP-MR-VBR	String	The default codec that would be used by the owc voice participant
DefaultSIPParticipantCodec	audio/PCMU	String	The default codec that would be used for a SIP participant
DefaultSipRegistrationExpiresInterval	3600	Integer	Indicates the default time interval in seconds after which sip registration should be refreshed if registration is enabled This property is only available in Oracle Beehive versions 1.3 and later
DefaultVoiceParticipantMode	1	Integer	The default mode of a voice participant: speaker or listener
OwcHostWaitSessionTimeout	1800000	Integer	The default time after which the conference will stop if the host doesn't join the conference
OwcLogFlushPeriod	30000	Integer	The period between two subsequent flushes of the server log. Server periodically flushes log records into the persistent storage; these log records are used for the session restoration in case of server crash; so less flush period guarantees more up-to-date restoration state, but may affect server and storage performance
OwcMediaHostServiceBusAddressPrefix	owc-ms-host-service	String	Prefix to be used in the media host service bus addresses.
OwcMediaHostServiceLoadBalanceBusAddressSuffix	balance	String	Suffix to be used in the load balancing media host service bus addresses
OwcRosterServiceBusAddressPrefix	owc-roster-service	String	Prefix to be used in the roster service bus addresses
OwcRosterServiceLoadBalanceBusAddressSuffix	balance	String	Suffix to be used in the load balancing roster service bus addresses
OwcUseRemoteMediaSessions	false	true, false	Create media sessions on the remote media hosts instead of in-proc media host
SIPPSTNGatewayIPAddres		String	Specifies the SIP PSTN gateway IP address used for routing sip and PSTN calls
SIPPSTNGatewayPort	5060	Integer	Specifies the SIP port number on which the SIP PSTN gateway is listening
SipRegistrationEnabled	false	true, false	Specifies if SIP-based registration is enabled or disbaled This property is only available in Oracle Beehive versions 1.3 and later

Related beectl commands

The following beectl commands are related to this service:

• add_conference: Creates conference artifact under workspace

• add_conference_template: Creates conference-template artifact under workspace

• delete_conference: Deletes conference artifact under workspace

• delete_conference_template: Deletes conference template artifact under workspace

• list_conference_templates: Lists conference-template artifacts under workspace

• list_conferences: Lists conference artifacts under workspace

• list_my_conferences: Lists conference artifacts under workspace

Managing the Transcoding Service

The Transcoding Service supports and manages all the data- and audio-conversions for Oracle Beehive voice and Web conferences.

Configuring the Transcoding Service

Table 5-23, "Transcoding Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _TranscodingService

Table 5-23 Transcoding Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
MaxSimultaneousTranscodings	30	Integer	Defines maximum number of transcoding that a single tanscoding service instance can work on
ProgressiveTranscodingSpanInSeconds	300	Integer	Duration of conference recording that is transcoded in a single iteration while doing progressive transcoding. A progressive transcoding consists of multiple such iterations

Related beectl Commands

There are no beectl commands related to managing this service.

Managing the Time Management Services

There are several services that are primarily responsible for calendar and time management functionality:

• Alarm Service

• CalDAV Service

• Resource Directory Service

• Time Management Service

• Time Zone Service

Managing the Alarm Service

The Alarm Service handles all time management-related alerts for the system.

Configuring the Alarm Service

Table 5-24, "Alarm Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _AlarmService

Table 5-24 Alarm Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
DefaultExpiryTime	259200	Long Integer	Default expiration time for alarms created without an expiration time

Related beectl Commands

There are no beectl commands related to managing this service.

Managing the CalDAV Service

The CalDAV Service supports and manages all time management-related features and settings that the system leverages over the Calendaring Extensions to WebDAV (CalDAV) standard protocol.

Configuring the CalDAV Service

Table 5-25, "CalDAV Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _CalDAVService

Table 5-25 CalDAV Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
CollectionBrowsingEnabled	true	true, false	Enable body on collection, if true a body will be returned when a HTTP GET request is issued on a collection
DefaultFutureTimePeriodInDay	124	Long Integer	Specifies the relative time range used to determine the upper bound of the time interval of any request that doesn't specify a time range.
DefaultPastTimePeriodInDay	31	Long Integer	Specifies the relative time range used to determine the lower bound of the time interval of any request that doesn't specify a time range

Related beectl Commands

There are no beectl commands related to managing this service.

Managing the Resource Directory Service

The Resource Directory Service manages all aspects of the resources provided in Oracle Beehive directories, enabling users to view and schedule resources through supported time management features.

See Also:

"Managing Oracle Beehive Resources".

Configuring the Resource Directory Service

Table 5-26, "Resource Directory Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _ResourceDirectoryService

Table 5-26 Resource Directory Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
SearchSizeLimit	50000	Integer	Maximum number of resource entries to be returned on a search operation. When set to 0, no limit is imposed

Related beectl Commands

The following beectl commands are related to this service:

• add_resource: Creates a new resource

• delete_resources: Deletes a resource

• list_resources: Lists all resources matching a given criteria (or all resources)

• modify_resource: Modifies an existing resource

• modify_resource_classifications: Sets the given category as resource root classification

Managing the Time Management Service

The Time Management Service provides the coordination services for people, teams and resources in Oracle Beehive. It supports all aspects of calendaring and scheduling, task management, resource scheduling and reminders.

Configuring the Time Management Service

Table 5-27, "Time Management Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _TimeManagementService

Table 5-27 Time Management Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
EnableDynamicParticipants	true	true, false	Enables or disables the dynamic aspect of composite participants
EnableExternalParticipantNotificationDelivery	true	true, false	Enable or disable notification delivery for external participants
EnableGenericClassOfTMBusinessEvents	true	true, false	Enable or disable generic business event integration
EnablePresenceIntegration	true	true, false	Enables or disables presence integration
MaxOccurrencesForUnboundedRecurrence	75	Integer	When an unbounded recurrence rule is specified for creating a new meeting, the number of occurrences created will be limited to this value
MaxOccurrencesPerSeries	150	Integer	Maximum number of occurences in an occurence series

Related beectl Commands

The following beectl commands are related to managing this service:

• import_icalendar: Imports an iCalendar file to an existing calendar and/or task list

• export_icalendar: Exports invitations and assignments from a calendar and/or task list to an iCalendar file

• list_calendars: Lists the existing calendars of a user, resource or workspace

• list_tasklists: Lists existing task lists of a user, resource or workspace

Managing the Time Zone Service

The Time Zone Service supports and manages all aspects of synchronizing user schedules and calendar entries across global time zones. It acts as the central and only time zone authority for an entire Oracle Beehive deployment.

Configuring the Time Zone Service

There are no configuration parameters for this service.

Related beectl Commands

The following beectl commands are related to managing this service:

• import_timezones: Imports time zone definitions to the database

• list_timezones: Lists time zones in the database. The list can be limited by common time zones or by time zone names

• modify_timezones: Identifies time zones as common or non-common

Managing the Voice Message Service

The Voice Message Service supports all aspects of voicemail management for Oracle Beehive.

See Also:

For instructions on managing the voice messaging functionality in Oracle Beehive, see "Managing Oracle Beehive Voicemail"

Related beectl Commands

The following beectl commands are available for you to use for managing this service:

• list_attendants: Lists all attendants in the system

• delete_attendant: Deletes an auto attendant by name

• delete_attendant_prompt: Deletes a prompt.

• modify_attendant: Updates an existing auto attendant with a new AAML file

• list_attendant_prompts: List all prompts that have been uploaded for an attendant

• upload_attendant_prompt: Upload a sound file to serve as an auto attendant prompt

• list_attendant_aaml: Prints the Auto Attendant Markup Language for an auto attendant

• modify_ip_phone_password_seed: Resets the seed of the password generator for IP phones. To send commands to an IP phone the requestor must be authenticated. The password is generated based on information in the phone but must be seeded to ensure security

Managing Enterprise Services

Enterprise services provide functionality that is leveraged across the enterprise such as search, mobile connectivity, and event subscription and notification. This section describes management tasks and commands for the following services:

• Managing the Mobility Services

• Managing the Records Management Service

• Managing the Search Service

• Managing the Subscription and Notification Services

• Managing the Workspaces Service

Managing the Mobility Services

The Mobility Services provide Oracle Beehive users with access to their e-mail, voicemail, calendar data, and contacts through supported mobile devices, and the Oracle Beehive API. The Mobility Services also support standard protocol clients based on Open Mobile Alliance Data Synchronization (OMA-DS), and Push-IMAP (PIMAP).

There are several services responsible for providing mobility functionality:

• Managing the Mobile Device Management Service

• Managing the Mobile Data Synchronization Service

• Managing the Mobile Mail Service

• Managing the Mobile Push Service

See Also:

"Managing Oracle Beehive Mobility Services"

Managing the Mobile Device Management Service

The Mobile Device Management Service manages the configuration settings for the Mobile Device Management Server, which enables connections between Oracle Beehive and the Mobile Device Management Client installed on supported mobile and wireless devices.

Caution:

If you change any port, including the MX ports, to a privileged port number (a port number below 1024) on a UNIX or Linux installation, you must first perform a special procedure, and then change the port. First follow the special procedure in "Modifying Oracle Beehive Ports using Privileged Port Numbers", and then use the beectl modify_port command to change the port.

Configuring the Mobile Device Management Service

Table 5-28, "Mobile Device Management Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _MobileDmService

Table 5-28 Mobile Device Management Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
MaxClientConnections	1000	100-5000	How many concurrent CLIENT MX connections allowed on a single instance
MaxInvalidAttempts	3	3-10	Defines how many attempts a client can send invalid commands to the MobileDM Server before its connection gets closed
TtlAuthenticated	30	15-60	Defines the timeout for authenticated sessions in minutes
TtlUnauthenticated	1	1-10	Defines the timeout for non-authenticated sessions in minutes

Related beectl Commands

Caution:

If you change any port, including the MX ports, to a privileged port number (a port number below 1024) on a UNIX or Linux installation, you must first perform a special procedure, and then change the port. First follow the special procedure in "Modifying Oracle Beehive Ports using Privileged Port Numbers", and then use the beectl modify_port command to change the port.

The following beectl commands are related to managing this service:

• modify_port --protocol BTP

• modify_port --protocol BTPS

Note:

These ports and protocol are also used by the Oracle Beehive Integration for Outlook client.

Managing the Mobile Data Synchronization Service

The Mobile Data Synchronization Service manages all mobile-related features and settings that the system leverages through the Open Mobile Alliance (OMA) standard.

Configuring the Mobile Data Synchronization Service

Table 5-29, "Mobile Data Synchronization Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _OmaService

Table 5-29 Mobile Data Synchronization Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
CalendarSyncEnabled	true	true, false	This property is used to turn on/off the calendar sync
ContactsSyncEnabled	true	true, false	This property is used to turn on/off the contacts sync
DbLogKeepDays	7	1-2147483647	Days
EmailNumberLimit	1000	1-2147483647
EmailSyncEnabled	true	true, false	This property is used to turn on/off the e-mail sync
LogSyncmlForUsers		String
MaxConcurrentRequests	100	1-2147483647
MaxMessageSize	60000	1000-2147483647	ADVANCED
MaxObjectSize	5000000	1000-2147483647	ADVANCED
MaxSyncRangeBack	365	1-2147483647	Days
Md5Required	false	true, false	This property is used to turn on/off the requirement of MD5 authentication
Md5Supported	false	true, false	This property is used to turn on/off the support of MD5 authentication
NotesSyncEnabled	true	true, false	This property is used to turn on/off the notes sync This property is only available in Oracle Beehive versions 1.3 and later
OmaDsEnabled	true	true, false	This property is used to turn on/off the mobile data sync service
RequestTimeout	60		This property is only available in Oracle Beehive versions 12 and earlier
ResumeEnabled	true	true, false	This property is used to turn on/off suspend and resume feature This property is only available in Oracle Beehive versions 1.3 and later
SessionLogRequired	true	true, false	This property is used to turn on/off the Oma session log ADVANCED
SessionTimeOut	600	1-2147483647	Seconds
SyncmlLogRequired	true	true, false	This property is used to turn on/off the Oma SyncML message log ADVANCED

Related beectl Commands

There are no beectl commands related to managing this service.

Managing the Mobile Mail Service

The Mobile Mail Service manages the features and settings related to push mail for supported mobile and wireless devices.

Configuring the Mobile Mail Service

Table 5-30, "Mobile Mail Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _PushMailService

Table 5-30 Mobile Mail Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
HeartbeatInterval	300	60-600	Interval in seconds to send the BOGUS command to IMAP Mail Server
IMAPConnLiveTime	720	5-1440	Backend IMAP Connection live time in minutes after PIMAP connection dies, in minutes
MaxConcurrentUsers	2000	2-5000	Maximum number of concurrent users on this instance
MaxInboxMessages	200	200-1000	Maximum number of message in the device inbox
MaxMessageSize	50	50-200	Maximum message size allowed in kilobytes
NumberDaysPast	7	7-14	Number of days

Related beectl Commands

There are no beectl commands related to managing this service.

Managing the Mobile Push Service

The Mobile Push Service manages the features and settings that are related to the delivery of notifications to supported mobile and wireless devices.

Configuring the Mobile Push Service

Table 5-31, "Mobile Push Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _PushService

Table 5-31 Mobile Push Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
MaxClientConnections	1000	100-5000	How many concurrent CLIENT MX connections allowed on a single instance
MaxInvalidAttempts	3	3-10	Define how many attempts a client can send invalid commands to the Push Server before it's connection gets closed
MaxTruePushClientConnections	100	1-1000	How many concurrent True Push client connections allowed on a single instance
TtlUnauthenticated	1	1-10	Defines the timeout for non-authenticated sessions in minutes

Related beectl Commands

There are no beectl commands related to managing this service.

Managing the Records Management Service

The Records Management Service is a special component only enabled if you choose to configure Oracle Beehive with Oracle Universal Records Management (URM). Unless you configure and enable records management, the Records Management Service is disabled, and if you attempt to start it, it will shut down automatically.

For detailed instructions on installing and configuring Oracle Beehive with URM, see:

Configuring the Records Management Service

There are no configuration parameters for this service.

Related beectl Commands

The following beectl commands are related to Records Management functionality:

• add_record: Adds a record or non-record

• delete_record: Deletes a record or non-record

• list_file_plan: Lists the file plan

Managing the Search Service

The Search Service supports and manages all aspects of user-initiated, text-based searches for Oracle Beehive.

Configuring the Search Service

Table 5-32, "Search Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _SearchService

Table 5-32 Search Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
CachedPageMaxLength	1000	Integer
CaseSensitive	false	true, false
CrawlCalendarsEnabled	true	true, false
CrawlDocumentsEnabled	true	true, false
CrawlEmailsEnabled	true	true, false
ExcludeRegex	false	true, false
MaxResults	1000	Integer
MaxSearchDuration	30	Integer
Recovery	false	true, false
SyncFrequency	60	Integer
TwoDBMode	false	true, false
WildcardChar	*	String

Related beectl Commands

There are no beectl commands related to managing this service.

Managing the Subscription and Notification Services

The Subscription and Notification Services support and manage all aspects of user- and service-based subscriptions to business events and the resulting notifications. The following services are included in this category:

• Message Delivery Service

• Notification Service

• Subscription Service

Managing the Message Delivery Service

The Message Delivery Service handles all aspects of routing and channel support for notifications. It provides built-in e-mail, instant messaging, SMS, and voice delivery channels.

Note:

The SMS delivery channel cannot be used until it is configured to use an SMS aggregator (such as Verisign).

Configuring the Message Delivery Service

The following tables list the available configuration parameters for this service.

• Table 5-33, "Message Delivery Service Configuration Parameters"

  Use the beectl list_properties command to get the list of main properties for the service. Each property is listed by name, along with its current value:

  beectl> list_properties --component _MessageDeliveryService
  

• Table 5-34, "Message Delivery Service SMPP Settings Configuration Parameters"

  Use the beectl list_properties command to get the list of all properties for the service subcomponent. Each property is listed by name, along with its current value:

  beectl> list_properties --component _MessageDeliveryService:SmppSettings
  

• Table 5-35, "Message Delivery Service XMS Settings Configuration Parameters"

  Use the beectl list_properties command to get the list of all properties for the service subcomponent. Each property is listed by name, along with its current value:

  beectl> list_properties --component _MessageDeliveryService:XmsSettings
  

• Table 5-36, "Message Delivery Service SMTP Settings Configuration Parameters"

  Use the beectl list_properties command to get the list of all properties for the service subcomponent. Each property is listed by name, along with its current value:

  beectl> list_properties --component _MessageDeliveryService:SmtpSettings
  

• Table 5-37, "Message Delivery Service Web Proxy Settings Configuration Parameters"

  Use the beectl list_properties command to get the list of all properties for the service subcomponent. Each property is listed by name, along with its current value:

  beectl> list_properties --component _MessageDeliveryService:WebProxySettings
  

Table 5-33 Message Delivery Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
BuiltInEmailEnabled	true	true, false	Enable or disable built-in e-mail handler ADVANCED
BuiltInImEnabled	true	true, false	Enable or disable built-in IM handler ADVANCED
BuiltInSmsEnabled	false	true, false	Enable or disable built-in SMS handler Advanced
BuiltInVoiceEnabled	false	true, false	Enable or disable built-in voice handler ADVANCED
DefaultAddresses	"sms:0000000000 , fax:[phone] , tel:[phone] , email:[e-mail] , mailto:[e-mail]"		The default addresses used for reply-to when none are found through the delivery request
DeliveryPoolSize	20	Integer	Number of threads in delivery pool. Optional ADVANCED
EmailMode	INTERNAL		Default delivery mode used by e-mail handlers This property is only available in Oracle Beehive versions 1.2 and earlier ADVANCED
MaxDeliveryStatusAge	15	Integer	ADVANCED
MaxSmsChunks	5	Integer	Maximum number of SMS message chunks ADVANCED
MaxSmsLength	160	Integer	Maximum length of an SMS message ADVANCED
SmsMode	SMPP		Default delivery mode used by SMS handlers

Note:

After changing the DeliveryPoolSize parameter, you must restart all affected instances of the mds-instance component.

Table 5-34 Message Delivery Service SMPP Settings Configuration Parameters

Parameter	Default Value	Valid Values	Description
SmppEnquireTime	45	1-59	ADVANCED
SmppPassword		String
SmppServiceUrl		String
SmppSystemID		String
SmppSystemType		String	ADVANCED
SmppTimeOut	15	Integer	ADVANCED
TlsEnabled	false	true, false	ADVANCED
UseQuerySMForStatus	false	true, false	ADVANCED This property is only available in Oracle Beehive versions 1.3 and later

Table 5-35 Message Delivery Service XMS Settings Configuration Parameters

Parameter	Default Value	Valid Values	Description
XmsPassword		SecureString	If not set, empty password is used by message handlers
XmsServiceUrl	"https://messenger.oracle.com/xms/webservice"	String
XmsUserName		String	If not set, empty user name is used by message handlers

Table 5-36 Message Delivery Service SMTP Settings Configuration Parameters

Parameter	Default Value	Valid Values	Description
SmtpPassword		String	If not set, empty password is used by message handlers
SmtpServiceUrl		String
SmtpUserName		String	If not set, empty user name is used by message handlers

Table 5-37 Message Delivery Service Web Proxy Settings Configuration Parameters

Parameter	Default Value	Valid Values	Description
ProxyHostName		String	The host name for the Web proxy
ProxyPassword		SecureString	The password for the Web proxy
ProxyPort	8080	Integer	The port number for the Web proxy
ProxyUserName		String	The user name for the Web proxy

Related beectl Commands

There are no beectl commands related to managing this service.

Managing the Notification Service

The Notification Service handles all aspects of notification logic for Oracle Beehive notifications.

Configuring the Notification Service

There are no configuration parameters for this service.

Related beectl Commands

There are no beectl commands related to managing this service.

Managing the Subscription Service

The Subscription Service handles all aspects of subscription logic for Oracle Beehive subscriptions.

Configuring the Subscription Service

There are no configuration parameters for this service.

Related beectl Commands

The following beectl commands are related to managing this service:

• add_user_subscription: Creates a user subscription from a pre-defined rule in a subscription template.

• modify_user_subscription: Enables or disables an existing subscription

Managing the Workspaces Service

The Workspaces Service supports all the features and functionality provided by Oracle Beehive personal and team workspaces. Workspaces are the core of the user experience with Oracle Beehive, especially in regard to the collaborative activities of teams. Therefore, the Workspaces Service is responsible for consolidating and exposing, in a single location, the collaborative functionality provided by the other Oracle Beehive services.

See Also:

For instructions on how to manage workspaces, see "Managing Oracle Beehive Workspaces".

Configuring the Workspaces Service

Table 5-38, "Workspaces Service Configuration Parameters" lists the available configuration parameters for this service.

Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

beectl> list_properties --component _WorkspacesService

Table 5-38 Workspaces Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
DbDownloadBufferSize	261888	Integer	Size of buffer to transfer streaming download data to database
DbUploadBufferSize	261888	Integer	Size of buffer to transfer streaming upload data to database

Related beectl Commands

The following beectl commands are available for you to use for managing this service:

• list_categories: Lists the categories in the enterprise. If the recurse option is used then sub-categories are also listed.

• list_category: Prints information about a category given a category identifier

• add_category: Creates a category at the enterprise scope

• add_category_application: Applies a category on a given entity

• delete_category: Deletes a category and all category applications

• delete_category_application: Removes a category from an entity

• download_workspace_template_schema: Downloads workspace template XML schema to a file

• list_workspace_templates: Lists all workspace templates

• add_workspace_template: Creates a workspace template in an organization or enterprise

• modify_workspace_template: Modifies an existing workspace template

• delete_workspace_template: Deletes an existing workspace template

• list_workspaces: Lists workspaces in an organization or enterprise

• add_team_workspace: Creates a team workspace from a template

• modify_team_workspace: Modifies an existing team workspace

• delete_team_workspace: Deletes an existing team workspace

• modify_personal_workspace: Modifies an existing personal workspace

• add_sensitivity: Creates a Sensitivity entity

• list_sensitivities: Lists Sensitivity entities

• modify_sensitivity: Modifies an existing Sensitivity entity

• delete_sensitivity: Deletes a Sensitivity entity

Managing Platform Services

Platform services enable organizations to integrate Oracle Beehive with existing environments and third-party components, and customize the platform to suit their needs. This section describes management tasks and commands for the following services:

• Managing the Coexistence Service

• Managing the Platform Services

Managing the Coexistence Service

The Coexistence Service enables organizations to integrate and leverage existing, third-party systems and components, such as Microsoft Exchange 2003, with Oracle Beehive for maximum interoperability.

See Also:

For complete information on setting up and managing coexistence in Oracle Beehive, see "Configuring and Managing Oracle Collaboration Coexistence Gateway".

Configuring the Coexistence Service

The following tables list the available configuration parameters for this service:

• Table 5-39, "Coexistence Service Configuration Parameters"

  Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

  beectl> list_properties --component _CoexistenceService
  

• Table 5-40, "Coexistence Service Container Specific Properties" lists the properties that are common for all of the various containers.

  The Coexistence Container Specific Properties are instantiated once for each of the four containers:

  • Contact

  • Calendar

  • Message

  • Task List

  Use the beectl list_properties command to get the list of all properties for the service. Each property is listed by name, along with its current value:

  beectl> list_properties --component _CoexistenceService
  

  The Container Specific Properties for each container are shown in the list of Coexistence Service properties. Use the beectl list_properties command to list the properties for any container. For example:

  beectl> list_properties --component _CoexistenceService:ContactSpecificProperties
  

• Table 5-41, "Coexistence Service Free Busy Properties"

  Use the beectl list_properties command to get the list of all properties for the service subcomponent. Each property is listed by name, along with its current value:

  beectl> list_properties --component _CoexistenceService:FreeBusyProperties
  

Table 5-39 Coexistence Service Configuration Parameters

Parameter	Default Value	Valid Values	Description
CoexistenceEnabled	true	true, false	Specifies if coexistence service is enabled
RequestSenderEnabled	true	true, false	Specifies if the request sender task is enabled

Table 5-40 Coexistence Service Container Specific Properties

Parameter	Default Value	Valid Values	Description
AttachmentMaxSizeInKiloByte	2048		Specifies the maximum allowed size for an attachment

Table 5-41 Coexistence Service Free Busy Properties

Parameter	Default Value	Valid Values	Description
FutureTimePeriodInDay	120		Specifies the relative time range used to determine the upper bound of the time interval to use for free busy updates
PastTimePeriodInDay	7		Specifies the relative time range used to determine the lower bound of the time interval to use for free busy updates

Related beectl Commands

The following beectl commands are available for you to use for managing this service:

• list_coexistence_connectors: List all configured coexistence connectors

• add_coexistence_connector: Configure a new coexistence connector

• modify_coexistence_connector: Modify a configured coexistence connector

• delete_coexistence_connector: Delete a coexistence connector

• list_coexistence_users: List the names and coexistence types of all the users provisioned with coexistence connectors

• modify_coexistence_user: Provisions or deprovisions a user to a coexistence connector

Managing the Platform Services

These services provide APIs for working with the Oracle Beehive platform:

• Platform Service

• Platform Web Service

Managing the Platform Service

The Platform API enables organizations to build and integrate custom solutions with Oracle Beehive through the Oracle Beehive API

Configuring the Platform Service

There are no configuration parameters for this service.

Related beectl Commands

There are no beectl commands related to managing this service:

Managing the Platform Web Service

The Platform Web Service is a Web-based API that enables organizations to build and integrate custom solutions with Oracle Beehive through Web Services.

Configuring the Platform Web Service

There are no configuration parameters for this service.

Related beectl Commands

There are no beectl commands related to managing this service.