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

See Also:

For a list of service parameters for every Oracle Beehive component, their default and allowed values, and descriptions, see "Oracle Beehive Parameter Reference" in the Oracle Beehive Administrator's Reference Guide.

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 Oracle Beehive servers, as described in Chapter 2, "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.

   Notes:

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

   • You can review information about various proposed and applied system configurations by using the beectl list_configuration_versions command.

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

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.

Exporting Configuration Data

You may export the entire system model configuration data into an XML file for any given configuration version with the beectl export_configuration_data command.

You may provide your Oracle support representative the output from this command. This will help your representative investigate any problems with your Oracle Beehive deployment faster. You may also use the output of from this command to compare the configuration between different Oracle Beehive deployments, such as between a test and a production deployment.

Note that secure values do not appear in the output for security reasons.

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 Oracle Beehive server), 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 configuration 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"

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 Chapter 12, "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".

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 Chapter 12, "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.

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.

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.

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.

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 Chapter 7, "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.

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

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.

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 Chapter 12, "Managing Oracle Beehive Events, Policies, and Workflows."

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

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.

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_ldap_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 Chapter 12, "Managing Oracle Beehive Events, Policies, and Workflows."

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

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 Zimbra Services

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.

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.

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.

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"

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.

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.

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.

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.

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.

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.

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.

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".

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.

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.

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 and Fax"

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

• add_attendant: Adds an auto attendant using the information from an AAML document

• 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 the Zimbra Services

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

• Zimbra Connector Service

• Zimbra UI Service

Managing the Zimbra Connector Service

The Zimbra Connector Service enables Oracle Beehive to connect to the Oracle Beehive Zimbra OC4J instance.

Related beectl Commands

There are no beectl commands related to managing this service.

Managing the Zimbra UI Service

The Zimbra UI Service is used by Oracle Beehive to provide various user interface functionality for the Zimbra client.

Related beectl Commands

There are no beectl commands related to managing this service.

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.

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.

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.

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.

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.

See Also:

For detailed instructions on installing and configuring Oracle Beehive with URM, see: "Managing Records Management".

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.

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:

• Notification Delivery Service

• Subscription Service

• SMPP Delivery Service

Managing the Notification Delivery Service

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

Note:

The SMS delivery channel cannot be used until it is configured to use an SMS aggregator (such as Verisign). See "Configuring Notifications to use SMS" for details.

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.

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 SMPP Delivery Service

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

Related beectl Commands

There are no beectl commands related to managing this service.

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".

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".

Related beectl Commands

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

• list_coexistence_systems: List all configured coexistence systems

• list_coexistence_connectors: List all configured coexistence systems

• add_coexistence_system: Configure a new coexistence system

• modify_coexistence_system: Modify a configured coexistence system

• delete_coexistence_system: Delete a coexistence system

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

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

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

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.

Related beectl Commands

There are no beectl commands related to managing this service.