Oracle Beehive Administrator's Reference Guide, Release 2 (2.0.1.8)

Release 2 (2.0.1.8)

E16649-04

Contents

List of Examples

List of Tables

Title and Copyright Information

Preface

- Audience

- Documentation Accessibility

- Related Documents

- Conventions

1 Oracle Beehive XML File Reference

- Audit Templates

- Sample Audit Templates

- AuditPolicyInfo

- AuditTrailInfo

- AuditTemplateInfo

- Category Templates

- Sample Category Templates

- CategoryDefinition

- CEN (type)

- CatTemplate (type)

- AttributeDefinition (type)

- AttributeTemplate (type)

- Group Templates

- groups

- group

- query

- operator

- predicate

- attribute

- address

- property

- members

- operation (type)

- removeincluded

- removeexcluded

- addresses

- item (child element of addresses)

- properties

- item (child element of properties)

- preferenceprofiles

- memberships

- item

- Policy Definitions

- Sample Policy Definitions

- PolicyInfo

- attributes

- RuleInfo

- ConditionInfo

- logical expression (type)

- boolean expression (type)

- Simple

- ActionInfo

- ActionPreferenceInfo

- Constructing JXPaths

- Dynamic Policy Attributes

- Bulk User Provisioning XML Files

- Example Bulk User Provisioning XML File

- users

- user

- principalstype

- principaltype

- principaldefinition

- addressestype

- addresstype

- addressitemtype

- propertiestype

- propertytype

- propertyitemtype

- membershipstype

- membershiptype

- identifyabletype

- scopetype

- Workspace Templates

- Template Variables

- System Defined Template Variable

- User Defined Template Variable

- Expressions

- Sample Workspace Templates

- ace

- accessor

- address

- type

- addressBook

- personContact

- attributes (body of personalWorkspace)

- attributes (body of teamWorkspace)

- body (personalWorkspaceTemplate)

- body (teamWorkspaceTemplate)

- calendar

- occurrence

- occurrenceSeries

- contentLocation

- entities

- environment

- label

- expression

- file

- folder

- versionControlConfiguration

- forum

- topic

- announcement

- messageBody

- group

- label

- location

- participant

- identity

- role

- personalWorkspaceTemplate

- priority

- Promptable Non-Empty String (type)

- Promptable Template Time (type)

- role

- grantPrivilege

- sensitivity

- summary

- inlineSummary

- teamWorkspaceTemplate

- templateAttributes

- templateVariable

- temporalExpression

- taskList

- todo

2 Oracle Beehive Command Line Utility

- New and Removed Commands

- Summary of Commands

- Common Options

- System Object Identifiers

- Providing Secure Values

- Tabular Output

- Boolean Values

- activate_configuration

- add_assigned_role

- add_attendant

- add_audit_policy

- add_audit_trail

- add_blocked_device

- add_category

- add_category_application

- add_category_configuration

- add_client_application_configuration

- add_client_application_provisioning

- add_coexistence_system

- add_conference

- add_conference_template

- add_custom_user_property

- add_device_command

- add_directory_profile

- add_dmz_home_instance

- add_email_endpoint

- add_event_subscription

- add_expertise_user_scope

- add_external_contact

- add_feed_configuration

- add_filesystem_reference

- add_group

- add_ischedule_server

- add_local_ace

- add_organization

- add_policy

- add_policy_schema

- add_policy_template

- add_preference_profile

- add_preference_property

- add_preference_set

- add_record

- add_remote_repository

- add_remote_share

- add_resource

- add_role_definition

- add_search_recovery_scope

- add_sensitivity

- add_sensitivity_ace

- add_team_workspace

- add_team_workspace_template_application

- add_team_workspace_template_evolution

- add_trusted_identity

- add_urm

- add_user

- add_user_subscription

- add_version_configuration

- add_virus_scan_engine

- add_voice_facility

- append_value

- clear_calendar_permissions

- clear_proposed_configuration

- clear_tasklist_permissions

- clone_midtier

- clone_oc4j_instance

- clone_patching

- clone_preparation

- clone_site

- delete_assigned_role

- delete_attendant

- delete_attendant_prompt

- delete_audit_policy

- delete_audit_trail

- delete_category

- delete_category_application

- delete_category_configuration

- delete_client_application

- delete_client_application_configuration

- delete_client_application_patchset

- delete_client_application_provisioning

- delete_client_application_version

- delete_coexistence_profile

- delete_coexistence_system

- delete_conference

- delete_conference_template

- delete_custom_user_property

- delete_device

- delete_device_profile

- delete_device_type

- delete_directory_profile

- delete_dmz_home_instance

- delete_email_message

- delete_event_subscription

- delete_expertise_user_scope

- delete_failed_action_events

- delete_feed_configuration

- delete_filesystem_reference

- delete_group

- delete_ischedule_server

- delete_local_ace

- delete_oc4j_instance

- delete_organization

- delete_policy

- delete_policy_action

- delete_policy_schema

- delete_policy_template

- delete_preference_profile

- delete_preference_property

- delete_preference_set

- delete_property

- delete_record

- delete_remote_home_instance

- delete_remote_repository

- delete_remote_share

- delete_resources

- delete_role_definition

- delete_sensitivity

- delete_sensitivity_ace

- delete_trusted_identity

- delete_user

- delete_version_configuration

- delete_virus_scan_engine

- delete_virus_scan_results

- delete_voice_facility

- delete_xmpp_chat_rooms

- download_device_logs

- download_generated_team_workspace_template

- download_language_pack

- download_ldap_group_data

- download_ldap_user_data

- download_syncml_messages

- download_syncml_sessions

- download_workspace_template_schema

- export_audit_trail

- export_client_application_configuration

- export_configuration_data

- export_email_data

- export_errorcodes

- export_filesystem_logs

- export_icalendar

- export_logs

- export_policy

- export_probes

- export_workspace

- import_coexistence_data

- import_documents

- import_email_data

- import_icalendar

- import_timezones

- import_workspace

- list_access_control_fields

- list_access_types

- list_applied_workspace_templates

- list_assigned_roles

- list_attendant_aaml

- list_attendant_prompts

- list_attendants

- list_audit_policies

- list_audit_trails

- list_bootstrap_configuration

- list_calendar_enrollments

- list_calendar_permissions

- list_calendars

- list_categories

- list_category

- list_category_applications

- list_category_configuration

- list_client_application_configuration

- list_client_application_modules

- list_client_application_patchsets

- list_client_application_versions

- list_client_applications

- list_client_applications_usage

- list_clone_properties

- list_coexistence_connectors

- list_coexistence_profiles

- list_coexistence_status

- list_coexistence_systems

- list_command_metadata

- list_commands

- list_components

- list_conference_templates

- list_conferences

- list_configuration_versions

- list_connection_pools

- list_custom_user_properties

- list_deleted_organizations

- list_deleted_workspaces

- list_deployment_templates

- list_device_commands

- list_device_logs

- list_device_profiles

- list_device_types

- list_devices

- list_directory_profiles

- list_email_messages

- list_email_queues

- list_enterprises

- list_errorcode_catalog

- list_event_groups

- list_events

- list_expertise_background_jobs

- list_expertise_profiling_configuration

- list_expertise_profiling_enabled_entities

- list_expertise_profiling_status

- list_expertise_relationship_blacklist_emails

- list_expertise_stop_phrases

- list_expertise_user_scopes

- list_external_contacts

- list_failed_action_events

- list_feed_configurations

- list_file_plan

- list_filesystem_references

- list_groups

- list_ischedule_servers

- list_language_pack

- list_ldap_change_number

- list_local_acl

- list_max_address_count

- list_my_conferences

- list_operation_statuses

- list_organizations

- list_patch_informations

- list_policies

- list_policy_actions

- list_policy_schemas

- list_policy_templates

- list_ports

- list_preference_profiles

- list_preference_properties

- list_preference_sets

- list_privileges

- list_properties

- list_property_metadata

- list_remote_repositories

- list_remote_repository_definitions

- list_remote_shares

- list_resources

- list_role_definitions

- list_schema_clones

- list_schemas

- list_sensitivities

- list_sensitivity_acl

- list_statistics

- list_supported_entity_types

- list_tasklist_permissions

- list_tasklists

- list_template_evolution_target_workspaces

- list_timezones

- list_trusted_identity

- list_user_subscriptions

- list_users

- list_version_configuration

- list_virus_scan_policy

- list_virus_scan_results

- list_voice_facilities

- list_workspace_templates

- list_workspaces

- list_xmpp_chat_rooms

- modify_access_control_fields

- modify_assigned_role

- modify_attendant

- modify_audit_policy

- modify_audit_trail

- modify_calendar

- modify_calendar_enrollments

- modify_calendar_permissions

- modify_category

- modify_category_configuration

- modify_coexistence_profile

- modify_coexistence_system

- modify_connection_pool

- modify_database

- modify_deployment_structure

- modify_device

- modify_directory_entry

- modify_directory_profile

- modify_email_port

- modify_email_queue

- modify_enterprise

- modify_expertise_background_job

- modify_expertise_entity_searchability

- modify_expertise_profiling_configuration

- modify_expertise_stop_phrases

- modify_expertise_user_scope

- modify_external_contact

- modify_failed_action_events

- modify_feed_configuration

- modify_group

- modify_hostname

- modify_im_preferences

- modify_ischedule_server

- modify_ldap_change_number

- modify_local_ace

- modify_local_configuration_files

- modify_max_address_count

- modify_notification_template

- modify_oc4j_administrator_password

- modify_organization

- modify_patch_information

- modify_personal_workspace

- modify_policy

- modify_policy_schema

- modify_policy_template

- modify_port

- modify_preference_set

- modify_property

- modify_remote_repository

- modify_remote_share

- modify_resource_classifications

- modify_resources

- modify_role_definition

- modify_secure_property

- modify_sensitivity

- modify_sensitivity_ace

- modify_tasklist

- modify_tasklist_permissions

- modify_team_workspace

- modify_timezones

- modify_trusted_identity

- modify_urm_urls

- modify_user

- modify_user_subscription

- modify_version_configuration

- modify_virus_scan_policy

- modify_workspace_template

- obfuscate

- recover_search_failures

- restart

- send_broadcast_im_message

- start

- status

- stop

- upload_apns_keystore

- upload_attendant_prompt

- upload_client_application

- upload_device_profiles

- upload_language_pack

- validate_configuration

- validate_directory_entry

- validate_midtier

- validate_policy

- validate_site_key

- validate_virus_scan_engine_connectivity

- version

3 Oracle Beehive Error Codes

- Access Control Error Codes

- Address Book Error Codes

- Audit Error Codes

- Authentication Service Error Codes

- Beehive Development Kit Error Codes

- Bom Object Distinguished Naming Error Codes

- Client Management Service Error Codes

- Coexistence Service Error Codes

- Device Management Error Codes

- Diagnosability Error Codes

- Discussions Error Codes

- Email Service Error Codes

- Expertise Service Error Codes

- Foundation Services Error Codes

- Instant Messaging Service Error Codes

- Message Delivery Service Error Codes

- Mobile DM Server Error Codes

- Mobile Data Sync Server Error Codes

- Mobile Mail Server Error Codes

- Mobile Push Server Error Codes

- Notification Service Error Codes

- Oracle Beehive Conferencing Error Codes

- Oracle Beehive Conferencing Streaming Media Error Codes

- Oracle Beehive Conferencing Transcoding Error Codes

- Policy Management Error Codes

- Presence Service Error Codes

- RM Service Error Codes

- Remote Content Service Error Codes

- Search Error Codes

- Social Service Error Codes

- Subscription Service Error Codes

- System Management Error Codes

- Time Management And Coexistence With Exchange Error Codes

- User Directory Services Error Codes

- Virus Scanner Error Codes

- Workspaces Error Codes

- Workspaces Templates Error Codes

- XMPP Protocol Service Error Codes

4 Oracle Beehive Property Reference

- Introduction to Oracle Beehive Properties

- Common Oracle Beehive Component Management Commands

- Managing Oracle Beehive Component Properties

- Modifying Oracle Beehive Component Properties

- Exporting Configuration Data

- Modifying Oracle Beehive Ports using Privileged Port Numbers

- Properties Described in This Module

- Common Properties

- Common Properties for ServiceInstances

- Component Properties

- AccessControlService

- AlarmService

- ApplicationImage

- AuditService

- AuthenticationService

- AuthenticationService.AuthenticationPlugin

- BdkService

- BdkService.RestProperties

- BdkService.RestProperties.PrivateProperties

- BdkService.RestProperties.PublicProperties

- BdkService.SoapProperties

- BeeCentralService

- BeehiveConferencingService

- BeehiveInstance

- BeehiveJ2eeApplication

- BeekeeperService

- Bti

- BtiClientWorker

- BtiComponent

- BtiGlobal

- BtiRedirector

- BtiServerWorker

- CalDAVService

- CalDAVService.ISchedule

- CalDAVService.ISchedule.Server

- ClientManagementService

- CoexistenceService

- CoexistenceService.ClusteredTaskProperties

- CoexistenceService.ConnectorProperties

- CoexistenceService.ContactProperties

- CoexistenceService.ContainerSpecificProperties

- CoexistenceService.DominoProperties

- CoexistenceService.ExchangeProperties

- CoexistenceService.ExpertiseProfilingProperties

- CoexistenceService.FreeBusyProperties

- CoexistenceService.InstanceTaskProperties

- CoexistenceService.MeetingProperties

- CoexistenceService.MessageProperties

- CoexistenceService.ServiceManagerProperties

- CoexistenceService.TaskProperties

- CompositeStateManageable

- ConferenceMonitoringService

- ConferenceService

- ConferenceSessionService

- ConnectionPoolConsumer

- CustomService

- Database

- Database.AccessSchema

- Database.AffinityPool

- Database.ConnectionPool

- DeletedSystemObject

- DeviceManagementService

- DeviceManagementService.BlockedDevice

- DiagnosabilitySettings

- DiagnosabilitySettings.ContextProperties

- DiagnosabilitySettings.ErrorCodeProperties

- DiagnosabilitySettings.ProbeProperties

- DiscussionsService

- EmailService

- EmailService.CSIProperties

- EmailService.EndpointProperties

- EmailService.IMAPProperties

- EmailService.PersistenceProperties

- EmailService.SMTPProperties

- EmailService.SMTPProperties.VMSProperties

- EmailService.TransportProperties

- Enterprise

- EventService

- ExpertiseService

- ExternalJ2eeApplication

- FaxMessageService

- FtpService

- HasHelpLink

- HttpServer

- HttpServerCluster

- IdMap

- IdentityProviderService

- ImService

- IrmService

- JavaExecutionArguments

- JcrServletService

- LdapServer

- LoggingConfigurable.LoggingProperties

- ManagedOc4j

- ManagedOc4jCluster

- ManagedOc4jCluster.HealthMonitorProperties

- ManagementService

- ManagementService.StabilityMonitorProperties

- ManagementService.SystemDataCollectorProperties

- MimService

- MobileDmService

- NamedSystemObject

- NotificationDeliveryService

- NotificationDeliveryService.ActionAskSettings

- NotificationDeliveryService.SmsSettings

- NotificationDeliveryService.WebProxySettings

- NotificationDeliveryService.XmsSettings

- ObjectEventPublisherService

- Oc4j

- OmaService

- OmsResourceAdapter

- OmsResourceAdapterInstance

- Opmn

- OpmnCluster

- OwcStreamingService

- PolicyService

- PresenceService

- PushMailService

- PushService

- PushService.APNSSettings

- RecordsManagementService

- RemoteContentService

- RemoteSite

- ResourceAdapter

- ResourceAdapterImage

- ResourceAdapterInstance

- ResourceDirectoryService

- RmServletService

- SAMLIdentity

- SearchService

- Server

- Service

- SesEndptService

- SipContainer

- SipGateway

- SipGatewayCluster

- Site

- Site.DiagnosabilityProperties

- SmppDeliveryService

- SoftwareImage

- StateManageable

- StatusManageable

- SubscriptionActionService

- SubscriptionService

- SyndicationService

- SyndicationServletService

- SystemObject

- SystemObjectWithHelper

- SystemObjectWithStats

- TCPCommBasedScanEngine

- TCPCommBasedScanEngineCluster

- TeamCollaborationApisService

- TeamCollaborationService

- TimeManagementService

- TimeManagementService.AccessControlComputationTaskProperties

- TimeManagementService.ChangeLogsCleanupTaskProperties

- TimeManagementService.ContainerSyncTaskProperties

- TimeManagementService.MethodMonitoringCleanupTaskProperties

- TimeManagementService.PurgedItemsCleanupProperties

- TimeManagementService.ResourceCleanupProperties

- TimeManagementService.ResourceConsistencyProperties

- TimeManagementService.StandardContextCleanupProperties

- TimeManagementService.SystemBusyPeriod

- TimeZoneService

- TimeZoneService.DatabaseConfiguration

- TranscodingService

- UdsCache

- UdsCacheService

- UnmanagedBeehiveInstance

- UnmanagedOc4j

- UnsupportedSystemObject

- Urm

- UserDirectoryService

- UserDirectoryService.AttributeMap

- UserDirectoryService.ConfigurationParameters

- UserDirectoryService.ConfigurationParameters.Attribute

- UserDirectoryService.CustomAttribute

- UserDirectoryService.DirectoryAttributeMap

- UserDirectoryService.DirectoryCache

- UserDirectoryService.DirectoryProfile

- UserDirectoryService.FieldMap

- UserDirectoryService.FieldMap.SourceTargetValueMapping

- UserDirectoryService.GroupTypeMapEntry

- UserDirectoryService.LdapDirectoryProfile

- UserDirectoryService.MembershipMapEntry

- UserDirectoryService.ScopeMapEntry

- UserDirectoryService.UserTypeMapEntry

- VirtualServer

- VirusScanConfigurable

- VirusScanEngine

- VirusScanEngineCluster

- VoiceMessageService

- VoiceMessageService.EnterpriseProperties

- VoiceMessageService.FacilityProperties

- VoiceServletService

- WebdavService

- WikiService

- WorkspacesService

- XmppService

- ZimbraConnectorService

- ZimbraUIService

List of Examples

- 1-1 Category Template Example

- 1-2 Static Group Creation With Users

- 1-3 Password Policy

- 1-4 Bulk User Provisioning XML File

- 1-5 Basic Team Workspace Template

- 1-6 Basic Personal Workspace Template

List of Tables

- 1-1 AuditPolicyInfo Elements

- 1-2 AuditTrailInfo Elements

- 1-3 AuditTemplateInfo Elements

- 1-4 Elements of CategoryDefinition

- 1-5 Elements of CEN (type)

- 1-6 Elements of CatTemplate (type)

- 1-7 Elements of AttributeDefinition (type)

- 1-8 Elements of AttributeTemplate (type)

- 1-9 Elements of groups

- 1-10 Attributes of groups

- 1-11 Elements of group

- 1-12 Attributes of group

- 1-13 Elements of query

- 1-14 Elements of operator

- 1-15 Attributes of operator

- 1-16 Elements of predicate

- 1-17 Elements of attribute

- 1-18 Elements of address

- 1-19 Elements of property

- 1-20 Elements of members

- 1-21 Elements of operation (type)

- 1-22 Attributes of operation (type)

- 1-23 Elements of removeincluded

- 1-24 Elements of removeexcluded

- 1-25 Elements of addresses

- 1-26 Elements of item (child element of addresses)

- 1-27 Elements of properties

- 1-28 Elements of item (child element of properties)

- 1-29 Elements of preferenceprofiles

- 1-30 Elements of memberships

- 1-31 Elements of item

- 1-32 Elements of PolicyInfo

- 1-33 Elements of attributes

- 1-34 Elements of RuleInfo

- 1-35 Attributes of RuleInfo

- 1-36 Elements of ConditionInfo

- 1-37 Elements of logical expression (type)

- 1-38 Elements of boolean expression (type)

- 1-39 Elements of Simple

- 1-40 Elements of ActionInfo

- 1-41 Elements of ActionPreferenceInfo

- 1-42 Elements of users

- 1-43 Elements of user

- 1-44 Elements of principalstype

- 1-45 Elements of principaltype

- 1-46 Elements of principaldefinition

- 1-47 Elements of addressestype

- 1-48 Elements of addresstype

- 1-49 Elements of addressitemtype

- 1-50 Elements of propertiestype

- 1-51 Elements of propertytype

- 1-52 Elements of propertyitemtype

- 1-53 Elements of membershipstype

- 1-54 Elements of membershiptype

- 1-55 Elements of identifyabletype

- 1-56 Elements of scopetype

- 1-57 Elements of ace

- 1-58 Elements of accessor

- 1-59 Attributes of accessor

- 1-60 Elements of address

- 1-61 Elements of addressBook

- 1-62 Elements of personContact

- 1-63 Elements of attributes (body of personalWorkspace)

- 1-64 Elements of attributes (body of teamWorkspace)

- 1-65 Elements of body (personalWorkspaceTemplate)

- 1-66 Elements of body (teamWorkspaceTemplate)

- 1-67 Elements of calendar

- 1-68 Elements of occurrence

- 1-69 Elements of occurrenceSeries

- 1-70 Elements of contentLocation

- 1-71 Elements of entities

- 1-72 Elements of environment

- 1-73 Elements of label

- 1-74 Elements of expression

- 1-75 Elements of file

- 1-76 Elements of folder

- 1-77 Elements of versionControlConfiguration

- 1-78 Elements of forum

- 1-79 Elements of topic

- 1-80 Elements of announcement

- 1-81 Elements of messageBody

- 1-82 Elements of group

- 1-83 Elements of label

- 1-84 Elements of location

- 1-85 Elements of participant

- 1-86 Elements of identity

- 1-87 Attributes of identity

- 1-88 Elements of role

- 1-89 Elements of personalWorkspaceTemplate

- 1-90 Elements of Promptable Non-Empty String (type)

- 1-91 Elements of Promptable Template Time (type)

- 1-92 Attributes of Promptable Template Time (type)

- 1-93 Elements of role

- 1-94 Elements of sensitivity

- 1-95 Elements of summary

- 1-96 Elements of inlineSummary

- 1-97 Elements of teamWorkspaceTemplate

- 1-98 Elements of templateAttributes

- 1-99 Elements of templateVariable

- 1-100 Elements of templateVariable

- 1-101 Elements of taskList

- 1-102 Elements of todo

- 2-1 New beectl Commands in Oracle Beehive 2.0.1.1

- 2-2 New beectl Commands in Oracle Beehive 2.0.1.3

- 2-3 Removed beectl Commands in Oracle Beehive 2.0.1.3

- 2-4 New beectl Commands in Oracle Beehive 2.0.1.4

- 2-5 New beectl Commands in Oracle Beehive 2.0.1.5

- 2-6 Category: access control

- 2-7 Category: audit

- 2-8 Category: client application

- 2-9 Category: cloning

- 2-10 Category: coexistence

- 2-11 Category: configuration

- 2-12 Category: contents

- 2-13 Category: devices

- 2-14 Category: expertise

- 2-15 Category: language packs

- 2-16 Category: messaging

- 2-17 Category: organizations

- 2-18 Category: policies

- 2-19 Category: process control

- 2-20 Category: real time

- 2-21 Category: records

- 2-22 Category: resources

- 2-23 Category: security

- 2-24 Category: subscription

- 2-25 Category: templates

- 2-26 Category: timemanagement

- 2-27 Category: timezones

- 2-28 Category: users

- 2-29 Category: utilities

- 2-30 Category: workspace

- 3-1 Access Control

- 3-2 Address Book

- 3-3 Audit

- 3-4 Authentication Service

- 3-5 Beehive Development Kit

- 3-6 Bom Object Distinguished Naming

- 3-7 Client Management Service

- 3-8 Coexistence Service

- 3-9 Device Management

- 3-10 Diagnosability

- 3-11 Discussions

- 3-12 Email Service

- 3-13 Expertise Service

- 3-14 Foundation Services

- 3-15 Instant Messaging Service

- 3-16 Message Delivery Service

- 3-17 Mobile DM Server

- 3-18 Mobile Data Sync Server

- 3-19 Mobile Mail Server

- 3-20 Mobile Push Server

- 3-21 Notification Service

- 3-22 Oracle Beehive Conferencing

- 3-23 Oracle Beehive Conferencing Streaming Media

- 3-24 Oracle Beehive Conferencing Transcoding

- 3-25 Policy Management

- 3-26 Presence Service

- 3-27 RM Service

- 3-28 Remote Content Service

- 3-29 Search

- 3-30 Social Service

- 3-31 Subscription Service

- 3-32 System Management

- 3-33 Time Management And Coexistence With Exchange

- 3-34 User Directory Services

- 3-35 Virus Scanner

- 3-36 Workspaces

- 3-37 Workspaces Templates

- 3-38 XMPP Protocol Service

- 4-1 Component Management beectl Commands

- 4-2 Properties Requiring beectl modify_local_configuration_files when changed

- 4-3 Components

- 4-4 Common Properties

- 4-5 Common Properties for ServiceInstances

- 4-6 AccessControlService Properties

- 4-7 AlarmService Properties

- 4-8 ApplicationImage Properties

- 4-9 AuditService Properties

- 4-10 AuthenticationService Properties

- 4-11 AuthenticationService.AuthenticationPlugin Properties

- 4-12 BdkService Properties

- 4-13 BdkService.RestProperties Properties

- 4-14 BdkService.RestProperties.PrivateProperties Properties

- 4-15 BdkService.RestProperties.PublicProperties Properties

- 4-16 BdkService.SoapProperties Properties

- 4-17 BeeCentralService Properties

- 4-18 BeehiveConferencingService Properties

- 4-19 BeehiveInstance Properties

- 4-20 BeekeeperService Properties

- 4-21 Bti Properties

- 4-22 BtiClientWorker Properties

- 4-23 BtiComponent Properties

- 4-24 BtiGlobal Properties

- 4-25 BtiRedirector Properties

- 4-26 BtiServerWorker Properties

- 4-27 CalDAVService Properties

- 4-28 CalDAVService.ISchedule Properties

- 4-29 CalDAVService.ISchedule.Server Properties

- 4-30 ClientManagementService Properties

- 4-31 CoexistenceService Properties

- 4-32 CoexistenceService.ConnectorProperties Properties

- 4-33 CoexistenceService.ContactProperties Properties

- 4-34 CoexistenceService.ContainerSpecificProperties Properties

- 4-35 CoexistenceService.DominoProperties Properties

- 4-36 CoexistenceService.ExchangeProperties Properties

- 4-37 CoexistenceService.ExpertiseProfilingProperties Properties

- 4-38 CoexistenceService.FreeBusyProperties Properties

- 4-39 CoexistenceService.MeetingProperties Properties

- 4-40 CoexistenceService.MessageProperties Properties

- 4-41 CoexistenceService.TaskProperties Properties

- 4-42 ConferenceMonitoringService Properties

- 4-43 ConferenceService Properties

- 4-44 ConferenceSessionService Properties

- 4-45 CustomService Properties

- 4-46 Database Properties

- 4-47 Database.AccessSchema Properties

- 4-48 Database.AffinityPool Properties

- 4-49 Database.ConnectionPool Properties

- 4-50 DeviceManagementService Properties

- 4-51 DeviceManagementService.BlockedDevice Properties

- 4-52 DiagnosabilitySettings Properties

- 4-53 DiagnosabilitySettings.ContextProperties Properties

- 4-54 DiagnosabilitySettings.ErrorCodeProperties Properties

- 4-55 DiagnosabilitySettings.ProbeProperties Properties

- 4-56 DiscussionsService Properties

- 4-57 EmailService Properties

- 4-58 EmailService.CSIProperties Properties

- 4-59 EmailService.EndpointProperties Properties

- 4-60 EmailService.IMAPProperties Properties

- 4-61 EmailService.PersistenceProperties Properties

- 4-62 EmailService.SMTPProperties Properties

- 4-63 EmailService.SMTPProperties.VMSProperties Properties

- 4-64 EmailService.TransportProperties Properties

- 4-65 Enterprise Properties

- 4-66 EventService Properties

- 4-67 ExpertiseService Properties

- 4-68 ExternalJ2eeApplication Properties

- 4-69 FaxMessageService Properties

- 4-70 FtpService Properties

- 4-71 HasHelpLink Properties

- 4-72 HttpServer Properties

- 4-73 HttpServerCluster Properties

- 4-74 IdMap Properties

- 4-75 IdentityProviderService Properties

- 4-76 ImService Properties

- 4-77 IrmService Properties

- 4-78 JavaExecutionArguments Properties

- 4-79 JcrServletService Properties

- 4-80 LdapServer Properties

- 4-81 LoggingConfigurable.LoggingProperties Properties

- 4-82 ManagedOc4j Properties

- 4-83 ManagedOc4jCluster Properties

- 4-84 ManagementService Properties

- 4-85 ManagementService.StabilityMonitorProperties Properties

- 4-86 ManagementService.SystemDataCollectorProperties Properties

- 4-87 MimService Properties

- 4-88 MobileDmService Properties

- 4-89 NamedSystemObject Properties

- 4-90 NotificationDeliveryService Properties

- 4-91 NotificationDeliveryService.ActionAskSettings Properties

- 4-92 NotificationDeliveryService.SmsSettings Properties

- 4-93 NotificationDeliveryService.WebProxySettings Properties

- 4-94 NotificationDeliveryService.XmsSettings Properties

- 4-95 ObjectEventPublisherService Properties

- 4-96 Oc4j Properties

- 4-97 OmaService Properties

- 4-98 OmsResourceAdapter Properties

- 4-99 OmsResourceAdapterInstance Properties

- 4-100 Opmn Properties

- 4-101 OpmnCluster Properties

- 4-102 OwcStreamingService Properties

- 4-103 PolicyService Properties

- 4-104 PresenceService Properties

- 4-105 PushMailService Properties

- 4-106 PushService Properties

- 4-107 PushService.APNSSettings Properties

- 4-108 RecordsManagementService Properties

- 4-109 RemoteContentService Properties

- 4-110 ResourceAdapter Properties

- 4-111 ResourceAdapterImage Properties

- 4-112 ResourceAdapterInstance Properties

- 4-113 ResourceDirectoryService Properties

- 4-114 RmServletService Properties

- 4-115 SAMLIdentity Properties

- 4-116 SearchService Properties

- 4-117 Server Properties

- 4-118 Service Properties

- 4-119 SesEndptService Properties

- 4-120 SipContainer Properties

- 4-121 SipGateway Properties

- 4-122 SipGatewayCluster Properties

- 4-123 Site Properties

- 4-124 SmppDeliveryService Properties

- 4-125 SubscriptionActionService Properties

- 4-126 SubscriptionService Properties

- 4-127 SyndicationService Properties

- 4-128 SyndicationServletService Properties

- 4-129 TCPCommBasedScanEngine Properties

- 4-130 TCPCommBasedScanEngineCluster Properties

- 4-131 TeamCollaborationApisService Properties

- 4-132 TeamCollaborationService Properties

- 4-133 TimeManagementService Properties

- 4-134 TimeManagementService.ChangeLogsCleanupTaskProperties Properties

- 4-135 TimeManagementService.MethodMonitoringCleanupTaskProperties Properties

- 4-136 TimeManagementService.PurgedItemsCleanupProperties Properties

- 4-137 TimeManagementService.ResourceCleanupProperties Properties

- 4-138 TimeManagementService.ResourceConsistencyProperties Properties

- 4-139 TimeManagementService.StandardContextCleanupProperties Properties

- 4-140 TimeManagementService.SystemBusyPeriod Properties

- 4-141 TimeZoneService Properties

- 4-142 TranscodingService Properties

- 4-143 UdsCache Properties

- 4-144 UdsCacheService Properties

- 4-145 UnmanagedBeehiveInstance Properties

- 4-146 UnmanagedOc4j Properties

- 4-147 Urm Properties

- 4-148 UserDirectoryService Properties

- 4-149 UserDirectoryService.AttributeMap Properties

- 4-150 UserDirectoryService.ConfigurationParameters Properties

- 4-151 UserDirectoryService.CustomAttribute Properties

- 4-152 UserDirectoryService.DirectoryAttributeMap Properties

- 4-153 UserDirectoryService.DirectoryCache Properties

- 4-154 UserDirectoryService.DirectoryProfile Properties

- 4-155 UserDirectoryService.FieldMap Properties

- 4-156 UserDirectoryService.FieldMap.SourceTargetValueMapping Properties

- 4-157 UserDirectoryService.GroupTypeMapEntry Properties

- 4-158 UserDirectoryService.LdapDirectoryProfile Properties

- 4-159 UserDirectoryService.MembershipMapEntry Properties

- 4-160 UserDirectoryService.ScopeMapEntry Properties

- 4-161 UserDirectoryService.UserTypeMapEntry Properties

- 4-162 VirtualServer Properties

- 4-163 VirusScanConfigurable Properties

- 4-164 VirusScanEngine Properties

- 4-165 VirusScanEngineCluster Properties

- 4-166 VoiceMessageService Properties

- 4-167 VoiceMessageService.EnterpriseProperties Properties

- 4-168 VoiceMessageService.FacilityProperties Properties

- 4-169 VoiceServletService Properties

- 4-170 WebdavService Properties

- 4-171 WikiService Properties

- 4-172 WorkspacesService Properties

- 4-173 XmppService Properties

- 4-174 ZimbraConnectorService Properties

- 4-175 ZimbraUIService Properties

Oracle® Beehive

Administrator's Reference Guide

Release 2 (2.0.1.8)

E16649-04

August 2013

This book is a reference volume containing specific information on Oracle Beehive templates, command-line utilities, error codes, and component properties.

Oracle Beehive Administrator's Reference Guide, Release 2 (2.0.1.8)

E16649-04

Copyright © 2008, 2013, Oracle and/or its affiliates. All rights reserved.

Primary Author: Jean Rao

Contributing Authors: Sylvia Perez, Jennifer Waywell

Contributors: Matthew Carrier, Jia-Der Day, Manon Delilse, Richard Hall, Lenny Karpel, Joe Paradise, Rajesh Parakkal, Dan Rabe

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Preface

The Oracle Beehive Administrator's Reference Guide describes administration tasks associated with Oracle Beehive.

Audience

This document is intended for administrators whose task is the installation, deployment, configuration, administration, and maintenance of Oracle Beehive.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Related Documents

For more information, see the following documents in the Oracle Beehive Release 2 (2.0) documentation library:

Administration Guides

- Oracle® Beehive Administrator's Guide

- Oracle® Beehive Beekeeper Online Help (Integrated UA)

- Oracle® Beehive Integration Guide

Application Development

- Oracle® Beehive Application Developer's Guide

- Oracle® Beehive Business Views

- Oracle® Beehive Java Content Repository Java API Reference

- Oracle® Beehive RESTful Web Services API Reference

- Oracle® Beehive SOAP Web Services API Reference

Installation Guides

- Oracle® Beehive Installation Guide for Linux

- Oracle® Beehive Installation Guide for Microsoft Windows

- Oracle® Beehive Installation Guide for Oracle Solaris on SPARC (64-Bit)

- Oracle® Beehive Installation Help (Integrated UA)

Online Helps

- Oracle® Beehive Central

- Oracle® Beehive Webmail

- Oracle® Beehive Standards-based Clients

- Oracle® Beehive Team Collaboration

- Oracle® Beehive Conferencing

- Oracle® Beehive Extensions for Outlook Supplemental Help and Release Notes

- Oracle® Beehive Extensions for Explorer Supplemental Help and Release Notes

- Oracle® Beehive Extensions for Explorer (OBEE) (Integrated UA)

- Oracle® Beehive Extensions for Outlook (OBEO) (Integrated UA)

Mobile Devices

- Oracle® Beehive Using Windows Mobile Device

- Oracle® Beehive Using iPhone or iPad

- Oracle® Beehive Using BlackBerry

- Oracle® Beehive Registering and Configuring Mobile Devices

Planning Guides

- Oracle® Beehive Concepts

- Oracle® Beehive Deployment Guide

- Oracle® Beehive Licensing Information

Release Notes

- Oracle® Beehive Release Notes

Conventions

The following text conventions are used in this document:

Convention

Meaning

boldface

Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.

italic

Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.

monospace

Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

1 Oracle Beehive XML File Reference

This module describes the structure of the following XML files:

- Audit Templates

- Bulk User Provisioning XML Files

- Category Templates

- Group Templates

- Policy Definitions

- Workspace Templates

Note:
The tables in this module describe all the permitted elements for each XML element. The Min. column is the minimum number of elements required. The Max. column is the maximum number of elements allowed.

Audit Templates

An audit policy is a definition of rules and actions that determine which events should be recorded in the auditing logs, and the context (user or content) in which you want to do so.

To create an audit policy, you need an audit policy template and an audit policy definition.

An audit policy template is an XML file that has AuditTemplateInfo as its root element. It specifies which auditable events should be recorded in the auditing logs. To activate an audit policy template, you associate it with an audit policy definition.

An audit policy definition is an XML file that has AuditPolicyInfo as its root element. It specifies which audit policy template to activate, and which level of scope (user, organization, or enterprise) or level of the content hierarchy (such as an individual entity, folder, or workspace) to apply the audit policy template.

As a result, the audit service will record the events specified in the audit policy template in the auditing logs in the scope you specified in the audit policy definition.

You may also create an audit trail. An audit trail is a collection of audit records that have common characteristics such as the user or group who performed or triggered the event, the date and time that the event occurred, and the type of event. You create an audit trail with an audit trail template. This is an XML file that has AuditTrailInfo as its root element. It specifies which characteristics each audit record in the audit trail must have.

Sample Audit Templates

The directory <Oracle home>/beehive/audit contains the following sample audit templates:

- policy_ex.xml: Sample audit policy definition

- template_ex.xml: Sample audit policy template

- trail_ex.xml: Sample audit trail template

The policy directory also contain the file audit.xsd that defines the structure of audit policy definitions, audit policy templates, and audit trail templates.

AuditPolicyInfo

Root element of audit policy definitions.

Table 1-1 AuditPolicyInfo Elements

Element Name

Min.

Max.

Description

createdOn

1

1

DateTime

name

1

1

String, name of the audit policy

description

1

1

String, description of the audit policy

template

1

1

String, audit template's identifier. It can either be the collabID or the template's name.

container

0

1

String, identifier of the container or audit scope. Default value is the identifier of the enterprise.

Note: You may not change this value with the beectl modify_audit_policy command.

actor

0

unbounded

Complex type that contains two attributes:

- add: Boolean, if false, and the XML template is used to update an existing audit policy, then this actor/group will be removed from the filter list.

- id: String

List of audit filter identifiers. Each identifier can either be the organization user's identifier or the group's identifier.

Default value is for all users if this element is not specified or empty.

AuditTrailInfo

Root element of audit trail templates.

Table 1-2 AuditTrailInfo Elements

Element Name

Min.

Max.

Description

createdOn

1

1

DateTime

name

1

1

String, name of the audit trail

description

1

1

String, description of the audit trail

actor

0

unbounded

String, list of identifiers of the users to be used as a predicate when searching for audit records. Default is to use all users

entity

0

unbounded

String, list of identifiers of the entities that generated the audit records

startTime

0

1

DateTime, audit record start time

endTime

0

1

DateTime, audit record end time

eventType

1

1

String

serviceName

1

1

String

userName

1

1

String

activity

1

1

String

predicate

1

1

String

limit

1

1

Unsigned integer

AuditTemplateInfo

Root element of audit policy templates.

Table 1-3 AuditTemplateInfo Elements

Element Name

Min.

Max.

Description

createdOn

1

1

DateTime

name

1

1

String

description

1

1

String

event

1

unbounded

String

Category Templates

With category templates, you may perform the following tasks:

- Create categories with the beectl add_category command

- Delete categories with the beectl delete_category command

- Apply them to objects in a workspace with the beectl add_category_application command

- Remove them from objects in a workspace with the beectl delete_category_application command

The following example creates a subcategory named My subcategory that has two attributes.

Example 1-1 Category Template Example

<CategoryDefinition xmlns="http://xmlns.oracle.com/beehive/category">
<name>My subcategory</name>
<description>My subcategory description</description>
<abstract>F</abstract>
<parentCEN>
<enterpriseId>521D</enterpriseId>
<siteId>7D48</siteId>
<objectType>catg</objectType>
<eid>395E4535BD17BB82E040578CB50964750000000007F3</eid>
</parentCEN>
<attributes>
<attribute>
<name>First attribute</name>
<description>Description of first attribute</description>
<propertyType>String</propertyType>
<searchable>T</searchable>
<defaultValue>Hello</defaultValue>
</attribute>
<attribute>
<name>Second attribute</name>
<description>Description of second attribute</description>
<propertyType>String</propertyType>
<searchable>T</searchable>
<defaultValue>World!</defaultValue>
</attribute>
</attributes>
</CategoryDefinition>

Sample Category Templates

The directory <Oracle home>/beehive/templates/workspaces contains the following sample category templates:

- add_category_template1.xml

- add_category_template2.xml

- add_subcategory_template.xml

The workspaces directory also contains the file category.xsd that defines the structure of category templates.

CategoryDefinition

Root element of category templates.

Table 1-4 Elements of CategoryDefinition

Element Name

Min.

Max.

Description

categoryCEN

0

1

CEN (type)

name

1

1

String

description

0

1

String

ownerCEN

0

1

CEN (type)

parentCEN

0

1

CEN (type)

subcategoryCEN

0

unbounded

CEN (type)

visibility

0

1

Either a value of V (the category is visible) or N (the category is not visible).

abstract

0

1

Boolean, either a value of T (true) or F (false)

creatorCEN

0

1

CEN (type)

modifiedByCEN

0

1

CEN (type)

defaultTemplate

0

1

CatTemplate (type)

attributes

0

1

Contains zero to any amount of elements named attribute of type AttributeDefinition (type)

deletedAttributes

0

1

Contains zero to any amount of elements named cens of type CEN (type).

CEN (type)

Represents the collaboration entity name, which uniquely identifies an entity in the system.

Table 1-5 Elements of CEN (type)

Element Name

Min.

Max.

Description

enterpriseId

0

1

String

siteId

0

1

String

objectType

0

1

String

eid

0

1

String

CatTemplate (type)

Table 1-6 Elements of CatTemplate (type)

Element Name

Min.

Max.

Description

categoryTemplateCEN

0

1

CEN (type)

categoryCEN

1

1

CEN (type)

copyOnVersion

0

1

Boolean, either a value of T (true) or F (false)

mandatory

0

1

Boolean, either a value of T (true) or F (false)

finalInd

0

1

Boolean, either a value of T (true) or F (false)

isMissing

0

1

Boolean, either a value of T (true) or F (false)

attributeTemplates

0

1

Contains zero to any number of elements named attributeTemplate of type AttributeTemplate (type)

deletedAttrTemplates

0

1

Contains zero to any amount of elements named cens of type CEN (type).

AttributeDefinition (type)

Table 1-7 Elements of AttributeDefinition (type)

Element Name

Min.

Max.

Description

attributeDefCEN

0

1

CEN (type)

name

1

1

String

description

0

1

String

propertyType

1

1

String, one of INTEGER, STRING, DATE, CHAR, BOOLEAN, FLOAT, DOUBLE, LONG, BYTE, TIME, RAW, or DATETIME

searchable

0

1

Boolean, either a value of T (true) or F (false)

minValue

0

1

String

minValueInc

0

1

Boolean, either a value of T (true) or F (false)

maxValue

0

1

String

maxValueInc

0

1

Boolean, either a value of T (true) or F (false)

allowedValues

0

1

Contains zero to any number of elements named allowedVal of string type.

defaultValue

0

1

String

<attribute>
<name>tasktitle</name>
<prompted>true</prompted>
<required>false</required>
</attribute>

AttributeTemplate (type)

Table 1-8 Elements of AttributeTemplate (type)

Element Name

Min.

Max.

Description

attributeTempCEN

0

1

CEN (type)

attributeDef

1

1

AttributeDefinition (type)

mandatory

0

1

Boolean, either a value of T (true) or F (false)

prompted

1

1

Boolean, either a value of T (true) or F (false)

finalized

0

1

Boolean, either a value of T (true) or F (false)

forceDefault

0

1

Boolean, either a value of T (true) or F (false)

minValue

0

1

String

minValueInc

0

1

Boolean, either a value of T (true) or F (false)

maxValue

0

1

String

maxValueInc

0

1

Boolean, either a value of T (true) or F (false)

allowedValues

0

1

Contains zero to any number of elements named allowedVal of string type.

defaultValue

String

Group Templates

Use group templates to create or modify groups.

The following example modifies a static group. In this example, the following changes are made:

- Two users are added to the group

- An external contact is added to the group (using its CollabID in an <agent> element)

- An existing group MySubGroup is added as a member of this group

- An e-mail address MyGroup@example.com is set for this group

- An IM address MyGroup@example.com is removed from this group

- A custom property My_Custom_Property is added to the group

- A custom property Another_Custom_Property is removed from the group

Example 1-2 Static Group Creation With Users

<?xml version="1.0" encoding="utf-8"?>
<groups>
<group type="grup">
<name>beehive_test_group</name>
<description>My first static group</description>
<scope>
<cen>enpr=MyEnterprise</cen>
</scope>
<guid/>
<query/>
<members>
<add>
<actor>
<item>
<cen>user=user1</cen>
</item>
<item>
<cen>user=user2</cen>
</item>
</actor>
<agent>
<item>
<cen>2ACE:6047:extp:3AC0E3FA73872328E040578C939A44FF0000000F4496</cen>
</item>
</agent>
<subgroup>
<item>
<cen>grup=MySubGroup,enpr=MyEnterprise</cen>
</item>
</subgroup>
<principal/>
</add>
</members>
<addresses>
<add>
<item>
<address>mailto:MyGroup@example.com</address>
<addresstype>NONE</addresstype>
</item>
</add>
<remove>
<item>
<address>im:MyGroup@example.com</address>
<addresstype>NONE</addresstype>
</item>
</remove>
</addresses>
<properties>
<add>
<item>
<name>My_Custom_Property</name>
<value>true</value>
<description>xxx</description>
</item>
</add>
<remove>
<item>
<name>Another_Custom_Property</name>
</item>
</remove>
</properties>
</group>
</groups>

groups

Table 1-9 Elements of groups

Element Name

Min.

Max.

Description

group

1

unbounded

Table 1-10 Attributes of groups

Attribute Name

Description

directoryid

String

group

Table 1-11 Elements of group

Element Name

Min.

Max.

Description

name

0

1

String

description

0

1

String

scope

0

1

Contains zero to any number of cen elements. The cen element contains a collabID (no other child elements).

ismembershipgroup

0

1

String

guid

0

1

String

query

0

1

members

0

1

addresses

0

1

properties

0

1

preferenceprofiles

0

1

memberships

0

1

Table 1-12 Attributes of group

Attribute Name

Description

cen

String, Identifier of the group, This is required if you are modifying the group.

type

Required attribute, enumerated type, one of the following:

- grup

- dgrp

query

Table 1-13 Elements of query

Element Name

Min.

Max.

Description

operator

0

1

operator

Table 1-14 Elements of operator

Element Name

Min.

Max.

Description

operator

0

1

operator

0

1

predicate

0

1

predicate

0

1

Table 1-15 Attributes of operator

Attribute Name

Description

type

Required attribute, enumerated value, one of NONE, AND, or OR

predicate

Table 1-16 Elements of predicate

Element Name

Min.

Max.

Description

attribute

1

1

address

1

1

property

1

1

attribute

Table 1-17 Elements of attribute

Element Name

Min.

Max.

Description

name

1

1

Enumerated value, one of the following:

- BUSINESS_1

- BUSINESS_2

- BUSINESS_3

- BUSINESS_4

- BUSINESS_5

- OTHER_1

- OTHER_2

- OTHER_3

- OTHER_4

- OTHER_5

- PERSONAL_1

- PERSONAL_2

- PERSONAL_3

- PERSONAL_4

- PERSONAL_5

value

1

1

String

address

Table 1-18 Elements of address

Element Name

Min.

Max.

Description

uri

1

1

anyURI

type

1

1

Enumerated value, one of the following:

- ASSISTANT

- BUSINESS

- NONE

- PERSONAL

- SPOUSE

property

Table 1-19 Elements of property

Element Name

Min.

Max.

Description

name

1

1

value

1

1

attribute predicate value (type)

members

Table 1-20 Elements of members

Element Name

Min.

Max.

Description

add

0

1

operation (type)

remove

0

1

operation (type)

removeincluded

0

1

removeexcluded

0

1

operation (type)

Table 1-21 Elements of operation (type)

Element Name

Min.

Max.

Description

actor

0

1

Contains zero to any number of item elements

agent

0

1

Contains zero to any number of item elements

subgroup

0

1

Contains zero to any number of item elements

principal

0

1

Contains zero to any number of item elements

Table 1-22 Attributes of operation (type)

Attribute Name

Description

type

Enumerated type, either NONE, AND, or OR.

removeincluded

Table 1-23 Elements of removeincluded

Element Name

Min.

Max.

Description

actor

0

1

Contains zero to any number of item elements

agent

0

1

Contains zero to any number of item elements

subgroup

0

1

Contains zero to any number of item elements

principal

0

1

Contains zero to any number of item elements

removeexcluded

Table 1-24 Elements of removeexcluded

Element Name

Min.

Max.

Description

actor

0

1

Contains zero to any number of item elements

addresses

Table 1-25 Elements of addresses

Element Name

Min.

Max.

Description

add

0

1

Contains zero to any number of item (child element of addresses) elements

remove

0

1

Contains zero to any number of item (child element of addresses) elements

defaultaddressbytype

0

1

Contains zero to any number of item (child element of addresses) elements

defaultaddressbyscheme

0

1

Contains zero to any number of item (child element of addresses) elements

primaryaddress

0

1

Contains zero to any number of item (child element of addresses) elements

item (child element of addresses)

Table 1-26 Elements of item (child element of addresses)

Element Name

Min.

Max.

Description

address

0

1

anyURI

addressType

0

1

Enumerated value, one of the following:

- ASSISTANT

- BUSINESS

- NONE

- PERSONAL

- SPOUSE

properties

Table 1-27 Elements of properties

Element Name

Min.

Max.

Description

add

0

1

Contains zero to any number of item (child element of properties) elements

remove

0

1

Contains zero to any number of item (child element of properties) elements

item (child element of properties)

Table 1-28 Elements of item (child element of properties)

Element Name

Min.

Max.

Description

name

0

1

String

value

0

1

String

description

0

1

String

preferenceprofiles

Table 1-29 Elements of preferenceprofiles

Element Name

Min.

Max.

Description

add

0

1

Contains zero to any number of item elements

remove

0

1

Contains zero to any number of item elements

active

0

1

Contains zero to any number of item elements

memberships

Table 1-30 Elements of memberships

Element Name

Min.

Max.

Description

add

0

1

Contains zero to any number of item elements

remove

0

1

Contains zero to any number of item elements

item

Table 1-31 Elements of item

Element Name

Min.

Max.

Description

cen

0

1

String

Policy Definitions

A policy definition defines a set of rules containing conditions and an action to perform if those conditions are satisfied.

The following is a policy definition that validates user passwords. It checks if the user's password matches one of the following criteria:

- Less than 8 characters long

- Greater than 128 characters long

- Contains the user name as a substring

- Does not contain both upper and lower case characters

- Matches a password previously used by the user

If any of these criteria are true, then the password is rejected.

Example 1-3 Password Policy

<?xml version = '1.0' encoding = 'UTF-8'?>
<PolicyInfo isExtensible="true">
<policy>plcy=PasswordPolicy,enpr=Acme</policy>
<scope>enpr=Acme</scope>
<template></template>
<name>PasswordPolicy</name>
<description>Password policy desc</description>
<RuleInfos>
<RuleInfo priority="1">
<name>Password Auth PLSQL Rule</name>
<description>Password Auth rule description</description>
<eventTypeName>ON_AUTH_USER_PASSWD_MODIFICATION</eventTypeName>
<ruleId>
2ACE:6047:rule:3AC0E3FA73872328E040578C939A44FF0000000F4496
</ruleId>
<toRemove>false</toRemove>
<templateRuleId/>
<ConditionInfo>
<DisjunctionInfo>
<LeftBooleanExpression>
<DisjunctionInfo>
<LeftBooleanExpression>
<DisjunctionInfo>
<LeftBooleanExpression>
<DisjunctionInfo>
<LeftBooleanExpression>
<DisjunctionInfo>
<LeftBooleanExpression>
<Simple>
<!-- This expression checks if the user's password
is less than 8 characters long -->
<leftSide>
<!-- Returns the length of the string -->
LENGTH(
CUSTOM_ATTRIBUTES.USER_PASSWD)
</leftSide>
<operator>&lt;</operator>
<rightSide>8</rightSide>
</Simple>
</LeftBooleanExpression>
<RightBooleanExpression>
<Simple>
<!-- This expression checks if the user's password
is greater than 128 characters long -->
<leftSide>
LENGTH(
CUSTOM_ATTRIBUTES.USER_PASSWD)
</leftSide>
<operator>></operator>
<rightSide>128</rightSide>
</Simple>
</RightBooleanExpression>
</DisjunctionInfo>
</LeftBooleanExpression>
<RightBooleanExpression>
<Simple>
<!-- This expression checks if the user's password
contains both alphabetic and numeric
characters -->
<leftSide>
AUTH_POLICY_FUNC_PKG.
VERIFY_ALPHANUM(
CUSTOM_ATTRIBUTES.USER_PASSWD)
</leftSide>
<operator>=</operator>
<rightSide>0</rightSide>
</Simple>
</RightBooleanExpression>
</DisjunctionInfo>
</LeftBooleanExpression>
<RightBooleanExpression>
<Simple>
<!-- This expression checks if the user name is contained
in the password -->
<leftSide>
AUTH_POLICY_FUNC_PKG.CONTAINS_USERNAME(
CUSTOM_ATTRIBUTES.USER_NAME,
CUSTOM_ATTRIBUTES.USER_PASSWD)
</leftSide>
<operator>=</operator>
<rightSide>0</rightSide>
</Simple>
</RightBooleanExpression>
</DisjunctionInfo>
</LeftBooleanExpression>
<RightBooleanExpression>
<Simple>
<!-- This expression checks if the password contains both
upper and lower case characters -->
<leftSide>
AUTH_POLICY_FUNC_PKG.VERIFY_CASE(
CUSTOM_ATTRIBUTES.USER_PASSWD)
</leftSide>
<operator>=</operator>
<rightSide>0</rightSide>
</Simple>
</RightBooleanExpression>
</DisjunctionInfo>
</LeftBooleanExpression>
<RightBooleanExpression>
<Simple>
<leftSide>
<!-- This expression checks if the password matches a password
previously used by the user -->
AUTH_POLICY_FUNC_PKG.IN_HISTORY(
CUSTOM_ATTRIBUTES.USER_NAME,
CUSTOM_ATTRIBUTES.ENCRYPTED_PASSWD)
</leftSide>
<operator>=</operator>
<rightSide>0</rightSide>
</Simple>
</RightBooleanExpression>
</DisjunctionInfo>
</ConditionInfo>
<ActionInfo>
<name>Password modification action</name>
</ActionInfo>
<ActionPreferenceInfos/>
</RuleInfo>
</RuleInfos>
</PolicyInfo>

Sample Policy Definitions

The directory <Oracle home>/beehive/templates/policy contains the following sample policy definitions:

- AddPolicyTest_conjunction.xml

- AddPolicyTest_disjunction.xml

- AddPolicyTest_simple.xml

- ModifyPolicyTest.xml

The policy directory also contains XSD files that define the structure of policy definitions.

PolicyInfo

Root element of policy definitions.

Table 1-32 Elements of PolicyInfo

Element Name

Min.

Max.

Description

collabId

0

1

String

scope

0

1

String. The identifier of a scope (enterprise, organization, or workspace).

templateId

0

1

String

policy

0

1

String

scope

0

1

String

template

0

1

String

name

1

1

String

description

1

1

String

attributes

1

unbounded

RuleInfos

1

1

Contains at least one to any number of RuleInfo elements

ActionPreferenceInfos

1

1

Contains at least one to any number of ActionPreferenceInfo elements. These are key/value pairs that are sent to the action

isExtensible

1

1

Boolean

attributes

Table 1-33 Elements of attributes

Element Name

Min.

Max.

Description

attributeDefId

1

1

String

name

1

1

String

value

1

1

String

RuleInfo

Contains one or more conditions defined by the ConditionInfo element. These conditions are evaluated as true or false. Depending on the results of these conditions, the rule may activate an action. The ActionInfo element defines these actions.

Table 1-34 Elements of RuleInfo

Element Name

Min.

Max.

Description

name

1

1

String

description

1

1

String

eventTypeName

1

1

String, name of an Oracle Beehive event

ruleId

1

1

String

toRemove

1

1

Boolean, if true, the rule specified by ruleId will be removed from the policy

templateRuleId

1

1

String

ConditionInfo

1

1

Defines the conditions that must be true in order to activate the actions(s) specifies in ActionInfo

ActionInfo

1

unbounded

Defines the action(s) this rule will activate.

Table 1-35 Attributes of RuleInfo

Attribute Name

Description

priority

Integer, specifies the order in which rules are evaluated. A rule with a lower priority will be evaluated before one with a higher priority.

ConditionInfo

Contains logical expressions.

The ConditionInfo element may contain either one ConjunctionInfo element or one DisjunctionInfo element.

Table 1-36 Elements of ConditionInfo

Element Name

Min.

Max.

Description

ConjunctionInfo

0

1

logical expression (type), evaluates to true if both of its boolean expressions evaluate to true. This is like a logical AND operator.

DisjunctionInfo

1

1

logical expression (type), evaluates to true if one or both of its boolean expressions evaluate to true. This is like the logical OR operator.

Simple

0

1

Simple

logical expression (type)

Represents the elements ConjunctionInfo and DisjunctionInfo. Contains two boolean expressions.

Table 1-37 Elements of logical expression (type)

Element Name

Min.

Max.

Description

LeftBooleanExpression

1

1

boolean expression (type)

RightBooleanExpression

1

1

boolean expression (type)

boolean expression (type)

Represents the elements LeftBoooleanExpression and RightBooleanExpression.

May contain only one of the elements listed in the following table. The ConjunctionInfo and DisjunctionInfo elements allow you to nest boolean expressions.

Table 1-38 Elements of boolean expression (type)

Element Name

Min.

Max.

Description

ConjunctionInfo

0

1

logical expression (type)

DisjunctionInfo

0

1

logical expression (type)

Simple

0

1

Simple

Defines a boolean expression that consists of two operands (the leftSide and rightSide elements) and an operator (the element operator).

Table 1-39 Elements of Simple

Element Name

Min.

Max.

Description

leftSide

1

1

String

operator

1

1

One of the following operators:

- = (equals)

- != (not equal)

- &lt; (less than)

- > (greater than)

- &lt;= (less than or equal to)

- >= (greater than or equal to)

rightSide

1

1

String

ActionInfo

Specifies the action to be performed if the expressions in ConditionInfo evaluate to true. The command beectl list_actions lists all available actions.

Table 1-40 Elements of ActionInfo

Element Name

Min.

Max.

Description

name

1

1

Name of the action to be performed if the expressions in ConditionInfo evaluate to true.

ActionPreferenceInfo

Table 1-41 Elements of ActionPreferenceInfo

Element Name

Min.

Max.

Description

key

1

1

value

1

1

String. If the value of key is JXPATHS, then this element contains one or more JXPath. Refer to "Constructing JXPaths" for more information.

Constructing JXPaths

Each JXPath has the following structure:

<method>#<method>#...@<XML element name>

For example, the following is the first JXPath in this policy, which retrieves the identifier of the newly added document, then maps this value to the <entityId> element in the generated XML:

getCommonAttributes#getEntityId#toCollabId@entityId

To get the list of available attributes for a particular event, use the command beectl list_events --name <event name>. For <event name>, use the value in the <eventTypeName> element in the policy.

For example, the following is a description of the DOCUMENT_CREATED event and its attributes:

beectl list_events --name DOCUMENT_CREATED
Event Name: DOCUMENT_CREATED
Event Description: Raised when a new document is created in a heterogeneous folder. This event is also raised when an existing document is copied to a new heterogeneous folder.
Is Synchronous: N
------------------------------------
Event Subscriptions:
------------------------------------
Name: HelloWorldDocCreated
Event Subscription Id: 26C9:2946:evts:37275AA4FF80934DE040578C201A154B0000000493F5
Is PLSQL Action: N
------------------------------------
Event Attributes:
------------------------------------
Name: COMMON_ATTRIBUTES              Type: OCS_CODE.ECA_COMMON_EVENT_ATTRIBS_T
Name: ENTITY_ID                      Type: OCS_CODE.OCS_COLLAB_ID_T
Name: CONTAINER                      Type: OCS_CODE.OCS_COLLAB_ID_T
Name: ACTOR_ID                       Type: OCS_CODE.OCS_COLLAB_ID_T
Name: OPERATION                      Type: STRING
Name: STATUS                         Type: STRING
Name: MESSAGE                        Type: STRING
Name: EVENT_NAME                     Type: STRING
Name: LOGON_RECORD_ID                Type: INTEGER
Name: EVENT_ID                       Type: INTEGER
Name: CUSTOM_ATTRIBUTES              Type: OCS_CODE.WS_DOCUMENT_EVENT_ATTRIBS_T
Name: ARTIFACT_ATTRIBUTES            Type: OCS_CODE.AM_COMMON_EVENT_ATTRIBS_T
Name: SIZE_CHANGE                    Type: INTEGER
Name: NEW_CONTAINER                  Type: OCS_CODE.OCS_COLLAB_ID_T

To retrieve the value of an attribute, perform the following steps to the attribute's name:

1. Convert the attribute name to lower case

2. Capitalize the first letter of the attribute name. and the letter after each underscore

3. Remove all underscores

4. Append get to the beginning of the name

Attributes are stored in a tree structure. For example, to retrieve the value of ENTITY_ID, you will have to retrieve COMMON_ATTRIBUTES first.

You may use the following methods in your JXPath:

- toCollabID: Retrieves the identifier of the specified entity

- ASENTITY: Converts the identifier back into an entity so that you can retrieve other attributes and entities from it, such as its name with getName.

- iterator: Use this with next to retrieve all entities in a list.

Dynamic Policy Attributes

Dynamic policy attributes represent the most commonly used Oracle Beehive event attributes. Use dynamic policy attributes instead of the equivalent JXPath when possible.

The following is a list of available dynamic policy attributes:

- ACTOR_NAME

- CONTAINER_NAME

- ENTITY_CREATED_BY_COLLABID

- ENTITY_CREATED_BY_NAME

- ENTITY_CREATED_ON

- ENTITY_MODIFIED_BY_COLLABID

- ENTITY_MODIFIED_BY_NAME

- ENTITY_MODIFIED_ON

- ENTITY_NAME

- ENTITY_OWNER_NAME

- LOGIN_ID

Bulk User Provisioning XML Files

You can most easily create and manage individual user accounts in Oracle Beehive by using the Oracle Beekeeper administrator interface. However, when you need to create a large number of user accounts at once, the most efficient method is by creating and uploading a bulk user provisioning XML file.

Caution:
Do not create user accounts directly in Oracle Beehive if you are using an LDAP-based external directory synchronization. In that scenario, all user account creation and management should be performed using the external directory.

See Also:
For complete instructions on managing and provisioning user accounts, see Chapter 3, "Managing and Provisioning Oracle Beehive Users," in the Oracle Beehive Administrator's Guide.

Example Bulk User Provisioning XML File

This is an example XML-formatted file for bulk user provisioning. This particular example contains three users. Refer to the XSD file for a complete definition. The XSD may be found at $ORACLE_HOME/beehive/templates/uds/user.xsd

Note:

- You must change the identifiers used in all <scope> and <membership> elements to match those of your enterprise or organization

- Values for password elements must meet the default password policy requirements

- If you include a password element for a given principal, you must order the elements as shown in the first user in the example: first the <name> element, then the <password> element, then the <type> element

- In the XML file, specify all extended enterprise users first, and then enterprise users

Example 1-4 Bulk User Provisioning XML File

<?xml version = '1.0' encoding = 'UTF-8'?>
<users xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<user>
<scope>
<cen>enpr=MyEnterprise</cen>
</scope>
<user_type>EXTENDED_ENTERPRISE_USER</user_type>
<familyname>Holmes</familyname>
<givenname>Robert</givenname>
<name>Robert</name>
<principals>
<add>
<principal>
<name>+16505551234</name>
<password>8675309</password>
<type>VOICE</type>
</principal>
</add>
<add>
<principal>
<name>rholmes</name>
<password>password</password>
<type>PRIMARY</type>
</principal>
</add>
</principals>
<addresses>
<add>
<item>
<address>TEL:+16505551234</address>
<addresstype>BUSINESS_1</addresstype>
</item>
</add>
<add>
<item>
<address>IM:rholmes@example.com</address>
<addresstype>BUSINESS_1</addresstype>
</item>
</add>
<add>
<item>
<address>MAILTO:rholmes@example.com</address>
<addresstype>BUSINESS_1</addresstype>
</item>
</add>
<add>
<item>
<address>TEL:+16505551444</address>
<addresstype>PERSONAL_1</addresstype>
</item>
</add>
</addresses>
</user>
<user>
<scope>
<cen>enpr=MyEnterprise</cen>
</scope>
<memberships>
<add>
<item>
<cen>orgn=Accounting,enpr=MyEnterprise</cen>
</item>
</add>
</memberships>
<user_type>ENTERPRISE_USER</user_type>
<familyname>Langdown</familyname>
<givenname>Mary</givenname>
<name>Mary</name>
<principals>
<add>
<principal>
<name>+15145554321</name>
<type>VOICE</type>
</principal>
</add>
<add>
<principal>
<name>mary.langdown</name>
<type>PRIMARY</type>
</principal>
</add>
</principals>
<addresses>
<add>
<item>
<address>TEL:+15145554321</address>
<addresstype>BUSINESS_1</addresstype>
</item>
</add>
<add>
<item>
<address>IM:mary.langdown@example.com</address>
<addresstype>BUSINESS1</addresstype>
</item>
</add>
<add>
<item>
<address>MAILTO:mary.langdown@example.com</address>
<addresstype>BUSINESS_1</addresstype>
</item>
</add>
<add>
<item>
<address>TEL:+16505559876</address>
<addresstype>PERSONAL_1</addresstype>
</item>
</add>
</addresses>
</user>
<user>
<scope>
<cen>enpr=MyEnterprise</cen>
</scope>
<memberships>
<add>
<item>
<cen>orgn=Accounting,enpr=MyEnterprise</cen>
</item>
</add>
</memberships>
<user_type>ENTERPRISE_USER</user_type>
<familyname>Tran</familyname>
<givenname>Thanh</givenname>
<name>mark</name>
<principals>
<add>
<principal>
<name>+16505556300</name>
<type>VOICE</type>
</principal>
</add>
<add>
<principal>
<name>thanh.tran</name>
<password>Password2</password>
<type>PRIMARY</type>
</principal>
</add>
</principals>
<addresses>
<add>
<item>
<address>TEL:+16505556300</address>
<addresstype>BUSINESS_1</addresstype>
</item>
</add>
<add>
<item>
<address>IM:thanh.tran@example.com</address>
<addresstype>BUSINESS1</addresstype>
</item>
</add>
<add>
<item>
<address>MAILTO:thanh.tran@example.com</address>
<addresstype>BUSINESS_1</addresstype>
</item>
</add>
<add>
<item>
<address>TEL:+16505551454</address>
<addresstype>PERSONAL_1</addresstype>
</item>
</add>
</addresses>
</user>
</users>

users

Table 1-42 Elements of users

Element Name

Min.

Max.

Description

user

1

unbounded

user

user

Table 1-43 Elements of user

Element Name

Min.

Max.

Description

userDN

0

1

String

uid

0

1

String

locale

0

1

String

department

0

1

String

officelocation

0

1

String

profession

0

1

String

company

0

1

String

suffix

0

1

String

prefix

0

1

String

directory_id

0

1

String

directory_locator

0

1

String

givenname

0

1

String

familyname

0

1

String

middlename

0

1

String

name

0

1

String

jobtitle

0

1

String

manager

0

1

String

assistant

0

1

String

timezone

0

1

String

addresses

0

1

addressestype

properties

0

1

propertiestype

memberships

0

1

membershipstype

principals

0

1

principalstype

scope

1

1

scopetype

user_type

0

1

String

principalstype

Table 1-44 Elements of principalstype

Element Name

Min.

Max.

Description

add

0

1

principaltype

remove

0

1

principaltype

principaltype

Table 1-45 Elements of principaltype

Element Name

Min.

Max.

Description

principal

0

unbounded

principaldefinition

principaldefinition

Table 1-46 Elements of principaldefinition

Element Name

Min.

Max.

Description

name

1

1

String

password

0

1

String

type

1

1

String, one of PRIMARY, PROTOCOL, or VOICE.

addressestype

Table 1-47 Elements of addressestype

Element Name

Min.

Max.

Description

add

0

unbounded

addresstype

remove

0

unbounded

addresstype

defaultaddresstype

0

unbounded

addresstype

defaultaddressbyscheme

0

unbounded

addresstype

addresstype

Table 1-48 Elements of addresstype

Element Name

Min.

Max.

Description

item

1

unbounded

addressitemtype

addressitemtype

Table 1-49 Elements of addressitemtype

Element Name

Min.

Max.

Description

address

0

1

String

addresstype

0

1

String (length at least 1)

propertiestype

Table 1-50 Elements of propertiestype

Element Name

Min.

Max.

Description

add

0

1

propertytype

remove

0

1

propertytype

propertytype

Table 1-51 Elements of propertytype

Element Name

Min.

Max.

Description

item

1

unbounded

propertyitemtype

propertyitemtype

Table 1-52 Elements of propertyitemtype

Element Name

Min.

Max.

Description

name

0

1

String

value

0

1

String

description

0

1

String

membershipstype

Table 1-53 Elements of membershipstype

Element Name

Min.

Max.

Description

add

1

1

String

remove

1

1

String

membershiptype

Table 1-54 Elements of membershiptype

Element Name

Min.

Max.

Description

item

1

1

identifyabletype

identifyabletype

Table 1-55 Elements of identifyabletype

Element Name

Min.

Max.

Description

cen

1

1

String

scopetype

Table 1-56 Elements of scopetype

Element Name

Min.

Max.

Description

cen

1

1

String

Workspace Templates

Workspace templates populate new workspaces with a specified folder hierarchy and set up workspace properties. Oracle Beehive comes with four workspace templates:

- Basic Personal Workspace Template

- Basic Team Workspace Template

- Community of Practice Workspace Template

- Project Workspace Template

The following is a basic team workspace template:

Example 1-5 Basic Team Workspace Template

<teamWorkspaceTemplate
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://xmlns.oracle.com/beehive/transportabletemplate"
xsi:schemaLocation="http://xmlns.oracle.com/beehive/transportabletemplate
http://xmlns.oracle.com/beehive/transportabletemplate.xsd">

<templateAttributes>
<author>Oracle</author>
<authorCreationTime>2004-08-12</authorCreationTime>
<contactInfo>Oracle Corporation</contactInfo>
<copyrightInfo>
Copyright (c) 2007 Oracle Corporation. All rights reserved.
</copyrightInfo>
<description>Basic team workspace template</description>
<name>Basic Team Workspace Template</name>
<templateId>oracle.com.basic-team-workspace-template</templateId>
<domain>general</domain>
</templateAttributes>

<body>
<publicSensitivityTemplateBodyId>
public_sensitivity
</publicSensitivityTemplateBodyId>
<defaultSensitivityTemplateBodyId>
default_sensitivity
</defaultSensitivityTemplateBodyId>

<attributes>
<name prompt="true">teamWorkspace</name>
<description>workspace for managing team information</description>
<participationMode>INVITE_ONLY</participationMode>
</attributes>

<sensitivity id="default_sensitivity">
<name>Normal</name>
<description>normal sensitivity</description>
<sensitivityOnly>false</sensitivityOnly>
<delegatable>true</delegatable>
<ace>
<grantAccessType>DISCOVER</grantAccessType>
<accessor type="GROUP">
<systemDefinedGroupName>
ALL_USERS
</systemDefinedGroupName>
</accessor>
</ace>
</sensitivity>

<sensitivity id="public_sensitivity">
<name>Public</name>
<description>public sensitivity</description>
<sensitivityOnly>false</sensitivityOnly>
<delegatable>true</delegatable>
<ace>
<grantAccessType>DISCOVER</grantAccessType>
<grantAccessType>READ</grantAccessType>
<accessor type="GROUP">
<systemDefinedGroupName>
ALL_USERS
</systemDefinedGroupName>
</accessor>
</ace>
</sensitivity>

<defaultAnnouncementsForum id="default_ann_forum">
<name>Announcements</name>
<description>forum for workspace announcements</description>
</defaultAnnouncementsForum>

<defaultAddressBook id="default_address_book">
<name>Contacts</name>
<description>team address book</description>
</defaultAddressBook>

<defaultCalendar id="default_calendar">
<name>Calendar</name>
<description>team calendar</description>
</defaultCalendar>

<defaultInbox id="inbox_folder">
<name>INBOX</name>
<description>inbox for email messages</description>
</defaultEmailInbox>

<defaultTaskList id="default_task_list">
<name>Tasks</name>
<description>team tasks</description>
</defaultTaskList>

<entities>
<folder id="documents_folder">
<name>Documents</name>
<description>folder for team documents</description>
</folder>
</entities>

<summary>
<inlineSummary>
<fileName>summary.html</fileName>
<mediaType>text/html</mediaType>
<body>
&lt;title&gt; Workspace Summary for Members &lt;/title&gt;
&lt;b&gt; ${sys.workspace.name} &lt;/b&gt;
&lt;p&gt;The Workspace Coordinator should edit this text to share
private information about this project with the team. For example,
add a little text here describing the project goals, milestones and
progress. &lt;/p&gt;
</body>
</inlineSummary>
</summary>

<publicSummary>
<inlineSummary>
<fileName>publicSummary.html</fileName>
<mediaType>text/html</mediaType>
<body> &lt;title&gt; Workspace Public Summary &lt;/title&gt;
&lt;b&gt; ${sys.workspace.name} &lt;/b&gt;
&lt;p&gt; The Workspace Coordinator should edit this text to share
public information about this project with others in your company.
For example, add a little text here describing the project goals,
milestones and progress. &lt;/p&gt;
</body>
</inlineSummary>
</publicSummary>

</body>

</teamWorkspaceTemplate>

The following is a basic personal workspace template

Example 1-6 Basic Personal Workspace Template

<personalWorkspaceTemplate
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://xmlns.oracle.com/beehive/transportabletemplate"
xsi:schemaLocation="http://xmlns.oracle.com/beehive/transportabletemplate
http://xmlns.oracle.com/beehive/transportabletemplate.xsd">

<templateAttributes>
<author>Oracle</author>
<authorCreationTime>2004-08-12</authorCreationTime>
<contactInfo>Oracle Corporation</contactInfo>
<copyrightInfo>
Copyright (c) 2007 Oracle Corporation. All rights reserved.
</copyrightInfo>
<description>Basic personal workspace template</description>
<name>Basic Personal Workspace Template</name>
<templateId>oracle.com.basic-personal-workspace-template</templateId>
<domain>general</domain>

</templateAttributes>

<environment>

<label>
<name>Personal</name>
<description>marker for personal items</description>
</label>

<label>
<name>Business</name>
<description>marker for business items</description>
</label>

</environment>

<body>
<publicSensitivityTemplateBodyId>
public_sensitivity
</publicSensitivityTemplateBodyId>
<defaultSensitivityTemplateBodyId>
default_sensitivity
</defaultSensitivityTemplateBodyId>

<attributes>
<name prompt="true">personalWorkspace</name>
<description>workspace for managing personal information</description>
</attributes>

<sensitivity>
<name>Confidential</name>
<description>confidential sensitivity</description>
<sensitivityOnly>false</sensitivityOnly>
<delegatable>true</delegatable>
<ace>
<grantAccessType>DISCOVER</grantAccessType>
<accessor type="GROUP">
<systemDefinedGroupName>
ALL_USERS
</systemDefinedGroupName>
</accessor>
</ace>
</sensitivity>

<sensitivity id="default_sensitivity">
<name>Normal</name>
<description>normal sensitivity</description>
<sensitivityOnly>false</sensitivityOnly>
<delegatable>true</delegatable>
<ace>
<grantAccessType>DISCOVER</grantAccessType>
<accessor type="GROUP">
<systemDefinedGroupName>ALL_USERS</systemDefinedGroupName>
</accessor>
</ace>
</sensitivity>

<sensitivity>
<name>Private</name>
<description>private sensitivity</description>
<sensitivityOnly>true</sensitivityOnly>
<delegatable>false</delegatable>
<ace>
<grantAccessType>DISCOVER</grantAccessType>
<accessor type="GROUP">
<systemDefinedGroupName>
ALL_USERS
</systemDefinedGroupName>
</accessor>
</ace>
</sensitivity>

<sensitivity id="public_sensitivity">
<name>Public</name>
<description>public sensitivity</description>
<sensitivityOnly>false</sensitivityOnly>
<delegatable>true</delegatable>
<ace>
<grantAccessType>DISCOVER</grantAccessType>
<grantAccessType>READ</grantAccessType>
<accessor type="GROUP">
<systemDefinedGroupName>
ALL_USERS
</systemDefinedGroupName>
</accessor>
</ace>
</sensitivity>

<defaultAddressBook id="default_address_book">
<name>Address Book</name>
<description>contacts</description>
</defaultAddressBook>

<defaultEmailInbox id="inbox_folder">
<name>INBOX</name>
<description>inbox for email messages</description>
</defaultEmailInbox>

<defaultNotificationList id="default_notification_list">
<name>Notifications</name>
<description>folder for notification messages</description>
</defaultNotificationList>

<defaultSubscriptionList id="default_subscription_list">
<name>Subscriptions</name>
<description>folder for subscriptions</description>
</defaultSubscriptionList>

<entities>
<folder id="documents_folder">
<name>Documents</name>
<description>folder for documents</description>
</folder>
</entities>

<summary>
<inlineSummary>
<fileName>summary.html</fileName>
<mediaType>text/html</mediaType>
<body>
&lt;title&gt;Personal Summary&lt;/title&gt;
&lt;b&gt; Your Name Here &lt;/b&gt;
&lt;p&gt; Edit this text to share information about yourself that you
want others in your company to see. For example, you can place a little
text here describing your current job role and projects that you are
working on. &lt;/p&gt;
&lt;p&gt; NOTE: You must apply Public sensitivity to this document in
order for it to be viewed by other members of your company. &lt;/p&gt;
</body>
</inlineSummary>
</summary>

</body>

</personalWorkspaceTemplate>

Template Variables

You may specify parametric information with two kinds of template variables: system defined and user defined.

System Defined Template Variable

Oracle Beehive Release 1 supports the following system defined template variables:

- sys.workspace.name: Value of the name element in the templateAttributes element

- sys.workspace.description: Value of the description element in the templateAttributes element

- sys.workspace.owner.collabid: The CEN of the workspace owner

User Defined Template Variable

Use the templateVariable element to define your own variables. The following is an example of how to define a user defined template variable:

<templateVariable>
<name>default-announcement-body</name>
<description>Welcome new workspace memeber!</description>
</templateVariable>

The following is an example of how to use a system defined template variable (sys.workspace.name) and a user defined template variable (default-announcement-body):

<announcement>
<subject>Welcome to workspace ${sys.workspace.name}</subject>
<messageBody>
<mediaType>text/plain</mediaType>
<body>${default-announcement-body}</body>
</messageBody>
</announcement>

Expressions

Expressions allow you to create variables that have references to other template variables and perform arithmetic operations on them. Two types of expressions are available: arithmetic expressions and temporal expressions.

Arithmetic Expressions

An arithmetic expression consists of two operands and an arithmetic operator. The operands may be a template variable, a constant, or another arithmetic expression. The operator may be plus, minus, or product.

Temporal Expressions

A temporal expression evaluates to a specific time or instant. It consists of a template variable, an operator, and an offset:

- The template variable refers to a specific time or instant.

- The operator may be either plus or minus.

- The offset is a constant or an arithmetic expression that specifies a duration of time to add or subtract (depending on the operator) from the template variable. It supports the time units hour, minute, second, or millisecond. The default time unit is millisecond.

The following is an example of a temporal expression that sets the due time of a task named One Day Later:

<templateVariable>
<name>task_reference_start_time_variable</name>
</templateVariable>

<todo>

<name>One Day Later</name>
...
<dueTime>
<temporalExpression>
<templateVariableRef>
${task_reference_start_time_variable}
</templateVariableRef>
<operator>PLUS</operator>
<offset timeUnit=”HOUR”>24</offset>
</temporalExpression>
</dueTime>
...
</todo>

The following is an example of a temporal expression that sets the start time of a task named End of Vacation:

<templateVariable>
<name>beginning_of_vacation</name>
</templateVariable>

<templateVariable>
<name>vacation_days</name>
</templateVariable>
...
<todo>
<name>End of Vacation</name>
...
<startTime>
<temporalExpression>
<templateVariableRef>${total_vacation_hours}</templateVariableRef>
<operator>PLUS</operator>
<offset timeUnit="HOUR">
<expression>
<leftOperand>
<value>${vacation_days}</value>
</leftOperand>
<operator>PRODUCT</operator>
<rightOperand>
<value>24</value>
</rightOperand>
</expression>
</offset>
</temporalExpression>
</startTime>
...
</todo>

Sample Workspace Templates

The directory <Oracle home>/beehive/templates/workspaces contains the following sample workspace templates:

- add_category_template1.xml: Adds a category at the root level with no attributes

- add_category_template2.xml: Creates a category with attributes

- add_subcategory_template.xml: Creates a subcategory

The workspaces directory also contains the XSD file category.xsd that defines the structure of workspace templates.

ace

Access Control Entity, grants or restricts the access type specified by the grantAccessType and denyAccessType elements, respectively.

Table 1-57 Elements of ace

Element Name

Min.

Max.

Description

grantAccessType

1

1

Enumerated type, grants one of the following access types:

- READ: Permission to open or read the object

- WRITE: Permission to add, alter, or make changes to the object. Note that version control preserves previous versions, so WRITE access does not itself provide DELETE access.

- DELETE: Permission to delete the object

- EXECUTE: Permission to invoke or assign the object or cause it to perform its function

- DISCOVER: Permission to see the object in lists, look it up in directories, find it in searches, and so forth. When DISCOVER privileges are revoked, a user cannot detect the existence of that object using any Oracle Beehive client process

denyAccessType

1

1

Same as grantAccessType, except denies one of the five access types

accessor

0

unbounded

accessor

Specifies for whom the ACE applies (such as a user, or members of a specified group).

One, and only one, of the elements in the following table must appear:

Table 1-58 Elements of accessor

Element Name

Min.

Max.

Description

systemDefinedGroupName

0

1

Enumerated type, ALL_USERS

cen

0

1

String, reference to an existing accessor

subgroupTemplateBodyId

0

1

IDREF, ID of a template defined in the template itself

Table 1-59 Attributes of accessor

Attribute Name

Description

type

Enumerated value, one of the following:

- GROUP

- USER

address

Table 1-60 Elements of address

Element Name

Min.

Max.

Description

uri

1

1

String

type

0

1

Enumerated value

defaultForScheme

0

1

Boolean

defaultForType

0

1

Boolean

primary

0

1

Boolean

type

Enumerated value, one of the following:

- BUSINESS_1

- BUSINESS_2

- BUSINESS_3

- BUSINESS_4

- BUSINESS_5

- OTHER_1

- OTHER_2

- OTHER_3

- OTHER_4

- OTHER_5

- PERSONAL_1

- PERSONAL_2

- PERSONAL_3

- PERSONAL_4

- PERSONAL_5

addressBook

Table 1-61 Elements of addressBook

Element Name

Min.

Max.

Description

name

1

1

String

description

0

1

String

personContact

0

unbounded

subAddressBook

0

unbounded

addressBook

ace

0

unbounded

personContact

Table 1-62 Elements of personContact

Element Name

Min.

Max.

Description

givenName

1

1

String

middleName

0

1

String

familyName

0

1

String

nickname

0

1

String

profession

0

1

String

company

0

1

String

peopleListEntry

0

1

Boolean

priority

0

1

address

0

unbounded

ace

0

unbounded

attributes (body of personalWorkspace)

Table 1-63 Elements of attributes (body of personalWorkspace)

Element Name

Min.

Max.

Description

name

1

1

Promptable Non-Empty String (type)

description

0

1

String

attributes (body of teamWorkspace)

In Oracle Beehive Release 1, you cannot specify workspace contact with workspace templates.

Table 1-64 Elements of attributes (body of teamWorkspace)

Element Name

Min.

Max.

Description

name

1

1

Promptable Non-Empty String (type)

description

0

1

String

publiclyListed

0

1

Boolean

participationMode

Enumerated value, either INVITE_ONLY or OPEN

body (personalWorkspaceTemplate)

Table 1-65 Elements of body (personalWorkspaceTemplate)

Element Name

Min.

Max.

Description

publicSensitivityTemplateBodyId

0

1

IDREF, ID of a public sensitivity template defined in the workspace template

defaultSensitivityTemplateBodyId

0

1

IDREF, ID of a sensitivity template defined in the workspace template

attributes

0

1

attributes (body of personalWorkspace)

sensitivity

0

unbounded

defaultAddressBook

0

1

addressBook

defaultCalendar

0

1

calendar

defaultEmailInbox

0

1

folder

defaultNotificationList

0

1

folder

defaultTaskList

0

1

taskList

defaultSubscriptionList

0

1

folder

entities

0

1

summary

0

1

ace

0

unbounded

body (teamWorkspaceTemplate)

Table 1-66 Elements of body (teamWorkspaceTemplate)

Element Name

Min.

Max.

Description

publicSensitivityTemplateBodyId

0

1

IDREF, ID of a public sensitivity template defined in the workspace template

defaultSensitivityTemplateBodyId

0

1

IDREF, ID of a sensitivity template defined in the workspace template

defaultRoleTemplateBodyId

0

1

IDREF

attributes

0

1

attributes (body of teamWorkspace)

address

0

unbounded

role

0

unbounded

sensitivity

0

unbounded

group

0

unbounded

participant

0

unbounded

defaultAnnouncementsForum

0

1

forum

defaultAddressBook

0

1

addressBook

defaultCalendar

0

1

calendar

defaultInbox

0

1

folder

defaultTaskList

0

1

taskList

entities

0

1

summary

0

1

publicSummary

0

1

summary

ace

0

unbounded

calendar

In Oracle Beehive Release 1, you cannot specify time zone and available hours with workspace templates.

Table 1-67 Elements of calendar

Element Name

Min.

Max.

Description

name

1

1

String

description

0

1

String

defaultPriority

0

1

priority

inheritTimeZoneFromOwner

0

1

allowDoubleBooking

0

unbounded

Boolean

includeInFreeBusy

0

1

Boolean

deriveAvailableHoursFromOwnerWorkingHours

0

1

Boolean

enrollmentType

0

1

Enumerated value, may be either PUBLC or PRIVATE.

occurrence

0

unbounded

occurrenceSeries

0

unbounded

ace

0

unbounded

occurrence

Table 1-68 Elements of occurrence

Element Name

Min.

Max.

Description

name

1

1

String

description

0

1

String

priority

0

1

location

0

1

startTime

0

unbounded

Boolean

endTime

0

1

Boolean

occurenceType

0

1

Enumerated value, either DAY_EVENT, HOLIDAY, or MEETING

dialInInfo

0

1

String

organizer

0

1

accessor

participant

0

unbounded

accessor

ace

0

unbounded

occurrenceSeries

In Oracle Beehive Release 1, you cannot specify time zone and available hours with workspace templates.

Table 1-69 Elements of occurrenceSeries

Element Name

Min.

Max.

Description

name

1

1

String

description

0

1

String

priority

0

1

location

0

1

occurrenceType

0

unbounded

Enumerated value, either DAY_EVENT, HOLIDAY, or MEETING

dialInInfo

0

1

String

updateMode

0

1

Enumerated value, one of the following

- SERIES_AND_ALL_OCCURRENCES

- SERIES_AND_NON_DIRECTLY_MODIFIED_EXCEPTIONS

- SERIES_ONLY

frequency

1

1

Contains one element with the following structure:

<enumeratedFrequency>
<startEndTime>
<startTime/>
<endTime/>
</startEndTime>
</enumeratedFrequency>

The enumeratedFrequency element must contain one to any number of startEndTime elements.

The startEndTime element must contain one startTime and one endTime element.

The elements startTime and endTime are of type Promptable Template Time (type).

duration

1

1

Must have one of the following elements:

- templateVariableRef: String

- length: Integer

May contain one of the following attributes:

- prompt: Boolean

- promptMessage: String

organizer

0

unbounded

accessor

participant

0

unbounded

accessor

ace

0

unbounded

contentLocation

Table 1-70 Elements of contentLocation

Element Name

Min.

Max.

Description

contentID

1

1

String

location

1

1

String

entities

Table 1-71 Elements of entities

Element Name

Min.

Max.

Description

folder

0

unbounded

calendar

0

unbounded

taskList

0

unbounded

forum

0

unbounded

file

0

unbounded

environment

Specifies entities that should be available in the ancestor scopes of the workspace. If no matching entity is available for any specified entity at the time of workspace creation, a new entity will be created in the parent scope, provided the current user has the required privileges.

Table 1-72 Elements of environment

Element Name

Min.

Max.

Description

label

0

unbounded

label

Table 1-73 Elements of label

Element Name

Min.

Max.

Description

name

1

1

String

description

1

1

String

expression

Table 1-74 Elements of expression

Element Name

Min.

Max.

Description

leftOperand

1

1

Contains one element named value.

The value element may be a constant (a numerical value), a template variable or another expression. Refer to "Template Variables".

operator

1

1

PLUS, MINUS, or PRODUCT.

rightOperand

1

1

Contains one element named value.

The value element may be a constant (a numerical value) a template variable, or another expression. Refer to "Template Variables".

file

Table 1-75 Elements of file

Element Name

Min.

Max.

Description

name

1

1

String

description

0

1

String

content

0

1

Contains one element, contentID, a string.

The element contentID is a reference to content ID in contentID-file-path map defined at the beginning of the template.

ace

0

unbounded

folder

Also represents defaultEmailInbox, defaultNotificationList, and defaultSubscriptionList.

Table 1-76 Elements of folder

Element Name

Min.

Max.

Description

name

1

1

String

description

0

1

String

versionControlConfiguration

0

1

entities

0

1

ace

0

unbounded

versionControlConfiguration

Table 1-77 Elements of versionControlConfiguration

Element Name

Min.

Max.

Description

versionControlModel

1

1

String

maxVersionsToKeep

0

1

Unsigned integer

autoLabel

0

1

Boolean

labelFormat

0

1

Enumerated type, one of the following values:

- DECIMAL_FORMAT

- INTEGER_FORMAT

- LOWER_CASE_FORMAT

- ROMAN_NUMERAL_FORMAT

- UPPERCASE_FORMAT

isFinal

0

1

Boolean

forum

Table 1-78 Elements of forum

Element Name

Min.

Max.

Description

name

1

1

String

description

0

1

String

incrementViewCount

0

1

Boolean

subForum

0

unbounded

Same as forum

topic

0

unbounded

announcement

0

unbounded

ace

0

unbounded

topic

Table 1-79 Elements of topic

Element Name

Min.

Max.

Description

subject

1

1

String

messageBody

1

1

String

ace

0

unbounded

announcement

Table 1-80 Elements of announcement

Element Name

Min.

Max.

Description

subject

1

1

String

messageBody

0

1

String

activatesOn

0

1

Promptable Template Time (type)

expiresOn

0

1

Promptable Template Time (type)

ace

0

unbounded

messageBody

Table 1-81 Elements of messageBody

Element Name

Min.

Max.

Description

mediaType

1

1

String

body

1

1

String

group

Table 1-82 Elements of group

Element Name

Min.

Max.

Description

name

1

1

String

description

1

1

String

label

Table 1-83 Elements of label

Element Name

Min.

Max.

Description

name

1

1

String

description

1

1

String

location

Table 1-84 Elements of location

Element Name

Min.

Max.

Description

name

1

1

String

description

0

1

String

participant

Table 1-85 Elements of participant

Element Name

Min.

Max.

Description

identity

1

1

role

0

unbounded

identity

Table 1-86 Elements of identity

Element Name

Min.

Max.

Description

systemDefinedGroupName

0

1

Either this element or cen must appear

Enumerated value: ALL_USERS

cen

0

1

String, either this element or systemDefined GroupName must appear

Table 1-87 Attributes of identity

Attribute Name

Description

type

Required attribute, enumerated value, may have a value of GROUP or USER.

role

Table 1-88 Elements of role

Element Name

Min.

Max.

Description

cen

1

1

String, reference to an existing role

entityTemplateBodyId

1

1

IDREF, reference to a role ID specified in the template itself

personalWorkspaceTemplate

Table 1-89 Elements of personalWorkspaceTemplate

Element Name

Min.

Max.

Description

templateAttributes

1

1

contentLocation

0

unbounded

templateVariable

0

unbounded

environment

0

1

body

1

1

body (personalWorkspaceTemplate)

priority

Enumerated value, one of the following:

- HIGH

- MEDIUM

- LOW

- NONE

Promptable Non-Empty String (type)

The attributes prompt and promptMessage can be used for providing hints to GUI tools for template exploration. In Oracle Beehive Release 1, these attributes have no other semantic effect.

Table 1-90 Elements of Promptable Non-Empty String (type)

Attribute Name

Description

prompt

Boolean, optional.

promptMessage

String, optional

Promptable Template Time (type)

Table 1-91 Elements of Promptable Template Time (type)

Element Name

Min.

Max.

Description

templateVariableRef

0

1

String, either this element or offset may appear

offset

0

1

Integer, offset in milliseconds with respect to entity creation time

Either this element or templateVariableRef may appear

Table 1-92 Attributes of Promptable Template Time (type)

Attribute Name

Description

prompt

Boolean, optional

promptMessage

String, optional

role

Table 1-93 Elements of role

Element Name

Min.

Max.

Description

name

1

1

String

description

0

1

String

grantPrivilege

0

unbounded

Enumerated type

grantAccessType

0

unbounded

Enumerated type, one of the following:

- READ

- WRITE

- DELETE

- EXECUTE

- DISCOVER

denyAccessType

0

unbounded

Same as grantAccessType

grantPrivilege

Enumerated value, one of the following

- ARCHIVE_MGR

- AUDIT_ADMIN

- AUDITOR

- BYPASS

- CALENDAR_MGR

- CALENDAR_USER

- CONF_MGR

- CONF_USER

- DIAGNOSE

- DM_MGR

- EMAIL_MGR

- EMAIL_USER

- EXCEED_QUOTA

- FORUM_MGR

- FORUM_USER

- IM_MGR

- IM_USER

- LOGIN

- MARKER_MGR

- MODIFY_ACL

- NOTIFICATION_MGR

- NOTIFICATION_USER

- ORGANIZATION_MGR

- POLICY_MGR

- PROTOCOL_USER

- QUOTA_MGR

- READALL

- RESOURCE_MGR

- ROLE_MGR

- SECURITY

- SUBSCRIPTION_MGR

- SUBSCRIPTION_USER

- SYSTEM_OPER

- TASK_MGR

- TASK_USER

- TIMEZONE_MGR

- USER_MGR

- VERSION_MGR

- VOICE_USER

- WORKSPACE_ADD

- WORKSPACE_MGR

sensitivity

Table 1-94 Elements of sensitivity

Element Name

Min.

Max.

Description

name

1

1

String

description

1

1

String

sensitivityOnly

1

1

Boolean

delegatable

1

1

Boolean

ace

0

unbounded

summary

Also represents the publicSummary element.

Table 1-95 Elements of summary

Element Name

Min.

Max.

Description

uri

0

1

String, either this element or inlineSummary must exist. Use this element for template variables.

inlineSummary

0

1

Either this element or uri must exist

inlineSummary

Table 1-96 Elements of inlineSummary

Element Name

Min.

Max.

Description

filename

1

1

String

mediaType

1

1

String

body

1

1

String

teamWorkspaceTemplate

Table 1-97 Elements of teamWorkspaceTemplate

Element Name

Min.

Max.

Description

templateAttributes

1

1

contentLocation

0

unbounded

templateVariable

0

unbounded

body

1

1

body (teamWorkspaceTemplate)

templateAttributes

Table 1-98 Elements of templateAttributes

Element Name

Min.

Max.

Description

author

1

1

String, this could be different than the creator attribute of the template entity if, for example, the template is created by a third-party vendor

authorCreationTime

1

1

String, this could be different than the createdOn attribute of the template entity if, for example, the template is created by a third-party vendor

contactInfo

0

1

String, more specifically, how to contact the vendor who created this template

copyrightInfo

0

1

String

description

1

1

String

name

1

1

String

templateId

1

1

String

domain

0

1

String

templateVariable

Table 1-99 Elements of templateVariable

Element Name

Min.

Max.

Description

name

1

1

String, name of the user defined template variable

type

0

1

String

description

0

1

String, value assigned to the user defined template variable

defaultValue

0

1

String, integer, or dateTime

This value is assigned to the user defined template variable unless the user explicitly chooses a different value at the time of template instantiation. Note: defaultValue is not honored in Oracle Beehive Release 1.

temporalExpression

Refer to "Expressions" for more information.

Table 1-100 Elements of templateVariable

Element Name

Min.

Max.

Description

templateVariableRef

1

1

String, name of the user defined template variable

operator

1

1

One of PLUS or MINUS.

offset

1

1

A constant (a numerical value) or an value of type expression.

You may optionally specify the attribute timeUnit. It may have the value HOUR, MINUTE, SECOND, or MILLISECOND. The default value is MILLISECOND.

taskList

In Oracle Beehive Release 1, you cannot specify time zone with workspace templates.

Table 1-101 Elements of taskList

Element Name

Min.

Max.

Description

name

1

1

String

description

0

1

String

defaultPriority

0

1

priority

inheritTimeZoneFromOwner

0

1

Boolean

todo

0

unbounded

todo

ace

0

1

todo

In Oracle Beehive Release 1, you cannot specify iCalPriority, status, url, or iCalUid with workspace templates.

Table 1-102 Elements of todo

Element Name

Min.

Max.

Description

name

1

1

String

description

0

1

String

priority

0

1

location

0

1

startTime

0

unbounded

Promptable Template Time (type) or temporalExpression

dueTime

0

1

Promptable Template Time (type) or temporalExpression

organizer

0

1

accessor

participant

0

unbounded

accessor

ace

0

unbounded

2 Oracle Beehive Command Line Utility

This module contains instructions on the usage and syntax for all commands shipped with the Oracle Beehive beectl utility. The utility is installed in the $ORACLE_HOME/beehive/bin directory.

The Oracle Beehive beectl utility is always used in conjunction with a qualifying command. This module contains instructions about each command, and its available options. When running a beectl command, the following syntax should be used:

beectl command --option <argument>

Where command represents the beectl command, --option represents an available option(s) to use with the command, and <argument> represents a valid argument passed with an option.

Using beectl Commands in Shell Mode Without Authentication

The beectl commands can also be used in shell mode. To invoke the shell, run the beectl utility without any qualifying commands. The following shell prompt will be returned on the command-line:

beectl>

Once this prompt appears on the command-line, there is no need to specify beectl when using a command.

Note:
The beectl shell expires if inactive for more than 30 minutes.

Using beectl Commands in Shell Mode with Authentication

Many beectl commands require authentication using the --authuser and --authpassword options. To invoke the beectl shell with authenticated user credentials, use the following command in the beectl shell mode:

beectl> login --authuser <authuser> --authpassword <authpassword> -obfuscated

Where <authuser> represents the user with which to authenticate, and <authpassword> represents the obfuscated user password. For information about obfuscating a password, see the obfuscate command.

Execution Permissions of beectl

The following applies only to Linux and UNIX-based operating systems.

Operating system users with the same primary membership as the owner of the Oracle Beehive application tier file system may call beectl commands. The following are the exceptions to this:

- If the root user does not own the files of the Oracle Beehive application tier, root may not call any beectl commands.

- Commands that change the structure of the Oracle Beehive application tier (such as adding or deleting OC4J instances, services, and service instances; cloning; and synchronizing system configuration information in the Oracle Beehive application tier's configuration files) and perform process control commands (such as starting and stopping components) cannot be called by any user other than the owner of the Oracle Beehive application tier file system.

New and Removed Commands

The following tables list new and removed commands in the Oracle Beehive 2.0.1.x patch releases, compared to Oracle Beehive 2.0.

Table 2-1 New beectl Commands in Oracle Beehive 2.0.1.1

Utility

Function

list_template_evolution_target_workspaces

Lists the workspaces to which the latest version of the given workspace template needs to be applied to make the workspaces conform to the latest version of the template.

list_applied_workspace_templates

Lists the workspace templates that have been applied to this workspace. For each applied template it indicates whether this workspace is a template evolution target.

Table 2-2 New beectl Commands in Oracle Beehive 2.0.1.3

Utility

Function

validate_midtier

It validates midtier for various conditions. For example, it reports the issues of database connectivity with each individual rac node.

add_search_recovery_scope

Recover the search index for entities of the specified types, in the specified Scope, and which were last modified between the specified dates.

list_operation_statuses

Lists the Operation Statuses.

export_workspace

Exports workspace contents into an external directory.

import_workspace

Imports contents of an external directory into a new team workspace.

Table 2-3 Removed beectl Commands in Oracle Beehive 2.0.1.3

Utility

Function

modify_search

Create system model objects for Search and configure them.

modify_search_engine

Starts or stops the search crawl process for a specific source type.

list_search_recovery_status

Lists the status and reports on how many containers need to be recovered.

add_search_recovery_container

Adds/updates the recovery_id for the specified container.

Table 2-4 New beectl Commands in Oracle Beehive 2.0.1.4

Utility

Function

recover_search_failures

Recover search failures. If scope is not specified, recover search failures from all scopes.

Table 2-5 New beectl Commands in Oracle Beehive 2.0.1.5

Utility

Function

upload_apns_keystore

Uploads the provider file for Apple Push Notification Service.

Summary of Commands

The following tables list all the available beectl commands.

Table 2-6 Category: access control

Utility

Function

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.

Table 2-7 Category: audit

Utility

Function

add_audit_policy

Creates an audit policy from the XML file information

add_audit_trail

Creates an audit trail from the search result generated using the XML file

delete_audit_policy

Deletes an existing audit

delete_audit_trail

Deletes an existing audit trail

export_audit_trail

Exports an existing audit trail by the given identifier

list_audit_policies

Lists audit policies and prints policy information

list_audit_trails

Lists audit trails and prints trail information

modify_audit_policy

Modifies an existing audit policy

modify_audit_trail

Modifies an existing audit trail

Table 2-8 Category: client application

Utility

Function

add_attendant

Adds an auto attendant or copies an existing one under a new name. When copying any prompts will also be copied.

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.

add_client_application_provisioning

Provisions client applications to a community.

add_voice_facility

Creates a voice facility by associating phone rules with an already created group. The command may be run multiple times and each new execution will append new rules to existing rules for a given group collabid.

delete_attendant

Deletes an auto attendant by name.

delete_attendant_prompt

Deletes a prompt.

delete_client_application

Deletes a client application.

delete_client_application_configuration

Deletes the client application configuration with the given identifier.

delete_client_application_patchset

Deletes a client application patchset.

delete_client_application_provisioning

De-provisions client applications from a community.

delete_client_application_version

Deletes a client application version.

delete_voice_facility

Removes specific rules or all rules for a given group collabid. To remove specific rules, then the list the rules to remove in the parameter options. To remove all rules only specify the collabid

export_client_application_configuration

Exports a client application configuration to a local file.

list_attendant_aaml

Prints the Auto Attendant Markup Language for an auto attendant.

list_attendant_prompts

Lists all prompts that have been uploaded for an attendant.

list_attendants

Lists all attendants in the system.

list_client_application_configuration

Lists the client application configurations.

list_client_application_modules

Lists the modules for a given client application patchset.

list_client_application_patchsets

Lists the patchsets for a given client application version.

list_client_application_versions

Lists all the versions for a given client application.

list_client_applications

Lists all the client applications.

list_client_applications_usage

Lists the client applications usage report. The command displays the number of devices that have installed a client application.

list_voice_facilities

The list command shows all of the facilities, their collab ids and phone number matching rules. The command accepts three optional parameters to help refine the search, if no parameters are specified, then all facilities are presented.

modify_attendant

Update an existing attendant with a new markup file or rename it.

upload_attendant_prompt

Upload a prompt to the database.

upload_client_application

Uploads client application binaries to the repository. Either a binary file path or path to a directory containing binary files should be specified.

Table 2-9 Category: cloning

Utility

Function

clone_midtier

Top level clone command that clones a mid-tier.

clone_oc4j_instance

Creates a new oc4j instance by cloning the given oc4j instance.

clone_patching

Upgrades the midtier by cloning.

clone_preparation

Prepares the existing oracle home for cloning.

clone_site

Top level clone command that clones a mid-tier in a new deployment (i.e., site). This command is part of the Deployment Cloning solution. Please see the administrator guide for details.

list_clone_properties

Lists the set of system model properties required for ias cloning scripts.

Table 2-10 Category: coexistence

Utility

Function

add_coexistence_system

Creates a new coexisting remote system.

delete_coexistence_profile

Deletes the coexistence profile of user.

delete_coexistence_system

Deletes a coexisting remote system. WARNING: This command will purge the coexisting remote system and clean all related data.

import_coexistence_data

Import data from the coexisting remote system for a given user.

list_coexistence_connectors

Lists all coexistence connectors for a coexisting remote system.

list_coexistence_profiles

Lists the profile of coexisting users.

list_coexistence_status

Reports the status of the coexisting containers and coexistence profiles.

list_coexistence_systems

Lists all coexisting remote systems.

modify_coexistence_profile

Create or modify the coexistence profile of a user.

modify_coexistence_system

Modifies a coexisting remote system.

Table 2-11 Category: configuration

Utility

Function

activate_configuration

Saves proposed configuration and activate it.

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.

add_coexistence_system

Creates a new coexisting remote system.

add_dmz_home_instance

Creates configuration for a Beehive installation in the DMZ that is, outside the firewall.

add_search_recovery_scope

Recovers the search index for Entities of the specified types, in the specified Scope, and which were last modified between the specified dates.

add_urm

Configures an agent for a URM instance.

add_virus_scan_engine

Adds a new virus scan engine to the collection of engines configured for the Site. If this is the first scan engine being added, this command will create a new collection for the Site and add the virus scan engine to it.

append_value

Appends the specified value to the existing value of the named property. If the named property value is cleared before executing this command, then after executing this command it will contain the new value.

clear_proposed_configuration

Clears proposed configuration of the Beehive system object model

clone_midtier

Top level clone command that clones a mid-tier.

clone_oc4j_instance

Creates a new oc4j instance by cloning the given oc4j instance.

clone_patching

Upgrades the midtier by cloning.

clone_preparation

Prepares the existing oracle home for cloning.

clone_site

Top level clone command that clones a mid-tier in a new deployment (i.e., site). This command is part of the Deployment Cloning solution. Please see the administrator guide for details.

delete_coexistence_system

Deletes a coexisting remote system. WARNING: This command will purge the coexisting remote system and clean all related data.

delete_dmz_home_instance

Removes configuration for a Beehive installation in the DMZ that is, outside the firewall.

delete_oc4j_instance

Deletes the specified oc4j.

delete_property

Clears the value of specified property in the configuration object identified by specified id.

delete_remote_home_instance

Deletes the specified beehive home from central configuration repository.

delete_virus_scan_engine

Deletes specified virus scan engine from the collection of engines configured for the Site. If this is the last scan engine being deleted, this command will also delete the virus scan engine collection and update the Site to remove the virus scan engine collection from it. Either the scan_engine option or the hostname and port options will need to be specified.

download_language_pack

Exports language pack resources managed by the Beehive deployment. The exact resources exported and the output destination details are controlled by command options.

export_configuration_data

Exports configuration data for given configuration version.

list_bootstrap_configuration

Displays bootstrap configuration for local midtier.

list_clone_properties

Lists the set of system model properties required for ias cloning scripts.

list_components

Lists components in the configuration repository.

list_configuration_versions

Lists all available configuration versions and activation time information

list_connection_pools

Lists available connection pools in the system.

list_deployment_templates

Lists the available deployment templates in central configuration repository

list_language_pack

Displays summarized informations for the resources in language pack. The search criteria can include a combination of string contained in the resource name, locale of the resource, type of resource (built-in or custom). Note that only resources matching ALL (as compared to ANY) specified search criteria are displayed.

list_patch_informations

Lists the patch information for given archives.

list_ports

Lists various available ports.

list_properties

Prints property value of a component given a component identifier and property name. If property name is not specified then all the properties will be listed.

list_property_metadata

Lists the metadata about all the properties of a system model object.

list_virus_scan_policy

Lists the virus scan policy configured for the Site. Valid values for the scan policy are: NO_SCAN_OR_REPAIR, SCAN_ONLY, SCAN_AND_REPAIR. Default is NO_SCAN_OR_REPAIR.

modify_coexistence_system

Modifies a coexisting remote system.

modify_connection_pool

Modifies the connection pool configuration.

modify_database

Modifies given database configuration.

modify_deployment_structure

This command applies the specified template(s) to the local BeehiveInstance. Execute beectl list_deployment_templates command to view the available templates.

modify_hostname

Modifies the configuration repository for hostname of the system and updates required configuration files.

modify_local_configuration_files

This command updates configuration files local to current midtier with activated changes to centralized configuration. It can restart one or more components on current midtier if needed to make the changes take effect. Some updates to local configuration files require this command to restart all midtier components.

modify_oc4j_administrator_password

Modifies oc4j administrator password in central configuration.

modify_patch_information

Add, append or removes the patch information from the given archives.

modify_port

Modifies various ports.

modify_property

Modifies the value(s) of a named property of the component identified by --component. Multiple values can be set for one property.

modify_secure_property

This command updates the sensitive property of the system model object identified by the --component.

modify_urm_urls

update urm urls

modify_virus_scan_policy

Modifies the virus scan policy configured for the Site. Valid values for the scan policy are: NO_SCAN_OR_REPAIR, SCAN_ONLY, SCAN_AND_REPAIR. Default is NO_SCAN_OR_REPAIR.

recover_search_failures

Recover search failures. If scope is not specified, Recover search failures from all scopes.

upload_language_pack

Loads language pack resources into the system.

validate_configuration

Validates the configuration for given component id or for the whole system model tree.

validate_midtier

It validates midtier for various conditions. For example, it reports the issues of database connectivity with each individual rac node.

validate_site_key

Validates the given site key.

validate_virus_scan_engine_connectivity

Tests the connectivity to the virus scan engine running at the specified host and port.

Table 2-12 Category: contents

Utility

Function

add_filesystem_reference

Creates a reference in Beehive to a directory on the filesystem.

add_remote_repository

Adds a remote repository.

add_remote_share

Adds a remote repository share.

delete_filesystem_reference

Removes a filesystem reference from Beehive.

delete_remote_repository

Deletes a remote repository.

delete_remote_share

Deletes a remote share.

import_documents

Imports documents into Beehive from files on the server without copying the file content. Data on the server files will be treated as read-only; should an imported document be edited in Beehive, a copy of the content will be made at that time.

list_filesystem_references

Lists the filesystem path, read-only status, and identifier of all available filesystem references.

list_remote_repositories

Lists remote repositories.

list_remote_repository_definitions

Lists seeded remote repository definitions.

list_remote_shares

Lists remote shares.

modify_remote_repository

Modifies the name and/or the description of a Remote Repository.

modify_remote_share

Modifies the name and/or the description of a Remote Share.

Table 2-13 Category: devices

Utility

Function

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.

add_device_command

Creates a device command for a given device.

delete_device

Deletes the device with the given identifier.

delete_device_profile

Deletes the device profile or device profiles. The command can delete the device profile with the given identifier or with the given device profile name or delete the device profiles specified from the given file containing names of the device profiles. The command can also optionally delete all the device types associated with this device profile.

delete_device_type

Deletes the device type with the given identifier.

download_device_logs

Downloads the logs for a device. This command can either download all log files for a device or all log files for a given application on the device or a particular log file.

download_syncml_messages

Downloads SyncML messages.

download_syncml_sessions

Downloads SyncML messages.

list_client_applications_usage

Lists the client applications usage report. The command displays the number of devices that have installed a client application.

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.

list_device_logs

Lists the device logs for a given device.

list_device_profiles

Lists all the device profiles.

list_device_types

Lists all the device types.

list_devices

Lists the devices either belonging to a user or with the specified device status.

modify_device

Modifies the device with the given identifier.

upload_apns_keystore

Uploads the provider file for Apple Push Notification Service.

upload_device_profiles

Uploads device profiles to the repository. An XML file or a directory containing XML files can be used as the source for the device profiles. The file can also contain device types and device profile schema.

Table 2-14 Category: expertise

Utility

Function

add_expertise_user_scope

The add_expertise_user_scope command adds new expertise user scope. The expertise user scope information is supplied in a XML file.

delete_expertise_user_scope

The delete_expertise_user_scope command deletes expertise user scope. The expertise user scope CollabId/BODN is supplied with --expertise_user_scope option.

list_expertise_background_jobs

Displays the status of all expertise background jobs.

list_expertise_profiling_configuration

The list_expertise_profiling_configuration command lists the profiling configuration.

list_expertise_profiling_enabled_entities

The list_expertise_profiling_enabled_entities command lists all the entities for whom expertise profiling is enabled.

list_expertise_profiling_status

The list_expertise_profiling_status command lists the expertise profiling status of the user specified. The profiling status information comprises Enability, Bootstrap, Searchability statuses.

list_expertise_relationship_blacklist_emails

The list_expertise_relationship_blacklist_emails command lists all the email addresses that have been blacklisted for expertise relationship profiling.

list_expertise_stop_phrases

Lists the stop phrases for expertise service.

list_expertise_user_scopes

The list_expertise_user_scopes command lists all expertise user scope or detailed version of supplied expertise user scope CollabId/BODN with --expertise_user_scope option.

modify_expertise_background_job

Modifies the expertise background jobs.

modify_expertise_entity_searchability

The modify_expertise_entity_searchability command controls whether the specified entity will be searchable or not.

modify_expertise_profiling_configuration

The modify_expertise_profiling_configuration command modifies the expertise profiling configuration. The profiling configuration information is supplied in an XML file.

modify_expertise_stop_phrases

The modify_expertise_stop_phrases command modifies (add/remove) stop phrases for Expertise service. The phrases are supplied in a XML file

modify_expertise_user_scope

The modify_expertise_user_scope command modifies expertise user scope. The expertise user scope information is supplied in a XML file.

Table 2-15 Category: language packs

Utility

Function

download_language_pack

Exports language pack resources managed by the Beehive deployment. The exact resources exported and the output destination details are controlled by command options.

list_language_pack

Displays summarized informations for the resources in language pack. The search criteria can include a combination of string contained in the resource name, locale of the resource, type of resource (built-in or custom). Note that only resources matching ALL (as compared to ANY) specified search criteria are displayed.

upload_language_pack

Loads language pack resources into the system.

Table 2-16 Category: messaging

Utility

Function

add_email_endpoint

Add an email endpoint

delete_email_message

Moves an email message to a target folder or removes it outright

delete_xmpp_chat_rooms

This command is used to delete an xmpp chat room by name (if it exists, else it is a NOOP) specified by the --roomname option. Room-names are case insensitive. This command can also be used to delete those xmpp chat rooms which have not been accessed for a period of days specified by the --olderthan option.

export_email_data

Export all email data to a file

import_email_data

Import email data from a file created by export command into a given folder

list_email_messages

List the email messages in a transport queue

list_email_queues

List the email transport queues information

list_xmpp_chat_rooms

Used to list all currently existing XMPP chat rooms.

modify_email_port

Modifies Email service' SMTP or IMAP port number

modify_email_queue

Enables or disables Email asynchronous queue processing

modify_im_preferences

Modifies existing instant message preferences of a user.

send_broadcast_im_message

Sends Instant Message to all online users.

Table 2-17 Category: organizations

Utility

Function

add_organization

Creates an organization in the given scope

delete_organization

Deletes an existing organization, and sub-organizations and workspaces under it (with --force_cascade option). And/or purges deleted organization manually (with --purge option). Use list_deleted_organizations to get the CENs of deleted organizations.

list_deleted_organizations

Lists deleted organizations

list_enterprises

Lists all enterprises and prints names and identifiers

list_organizations

Lists organizations in the given scope

modify_enterprise

Modifies an existing enterprise

modify_organization

Modifies an existing organization

Table 2-18 Category: policies

Utility

Function

add_event_subscription

Creates an event subscription using data in an XML file.

add_policy

Creates a policy using data in an XML file.

add_policy_schema

Creates a policy schema using data in an XML file.

add_policy_template

Creates a policy template using data in an XML file.

delete_event_subscription

Deletes an event subscription from the Oracle Beehive repository.

delete_failed_action_events

Purge actions that have not completed successfully.

delete_policy

Deletes a policy.

delete_policy_action

Deletes a policy action.

delete_policy_schema

Deletes a policy schema.

delete_policy_template

Deletes a policy template.

export_policy

Exports policy data into an XML file.

list_event_groups

Lists all business object events.

list_events

Lists all business object events.

list_failed_action_events

List actions that have not completed successfully.

list_policies

Lists policies in an specific container. Details returned include policy names and identifiers.

list_policy_actions

Lists all policy actions.

list_policy_schemas

Lists policy schemas in the current enterprise. Details returned include policy schema names and identifiers.

list_policy_templates

Lists policy templates in a specified container. Details returned include policy template names and identifiers.

modify_failed_action_events

Retry actions that have not completed successfully.

modify_policy

Modifies an existing policy using data in an XML file.

modify_policy_schema

Modifies an existing policy schema using data in an XML file.

modify_policy_template

Modifies an existing policy template using data in an XML file.

validate_policy

Evaluates or executes a policy based on an event payload file.

Table 2-19 Category: process control

Utility

Function

restart

Manages OC4J Instances, Beehive Transport Infrastructure Monitors and Oracle HTTP servers components. The command "beectl status" displays the component id and the status of these manageable components.

start

Manages OC4J Instances, Beehive Transport Infrastructure Monitors and Oracle HTTP servers components. The command "beectl status" displays the component id and the status of these manageable components.

status

Displays the status of all managed components.

stop

Manages OC4J Instances, Beehive Transport Infrastructure Monitors and Oracle HTTP servers components. The command "beectl status" displays the component id and the status of these manageable components.

Table 2-20 Category: real time

Utility

Function

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

Table 2-21 Category: records

Utility

Function

add_record

Adds a record or non-record.

delete_record

Deletes a record or non-record.

list_file_plan

Lists the file plan.

Table 2-22 Category: resources

Utility

Function

add_resource

Creates a new resource.

delete_resources

Deletes a resource.

list_resources

Lists resources.

modify_resource_classifications

This command set the given category as resource root classification.

modify_resources

Modifies an existing resource.

Table 2-23 Category: security

Utility

Function

add_trusted_identity

This command registers a trusted identity. There are two types of trusted identities: WSSEC and SES. Default type is WSSEC. For WSSEC type, please make sure that the service has a valid certificate registered in the wallet and the correct associated key alias is passed into this command. This command also creates the principal(s) associated with this trusted identity in the Beehive system. On the other hand, for SES type, this command stores the given trusted identity name and password information.

delete_trusted_identity

This command unregisters a trusted identity. If the type of identity is not specified, it is defaulted to WSSEC.

list_trusted_identity

This command lists the trusted identities. The type has to be specified. For type SES, it lists the names of the trusted entities.

modify_trusted_identity

This command modifies the details of the trusted identity. At least one of the options new_service_name or new_key_alias need to be specified for this modification if the type is WSSEC. If the type of identity is not specified, it is defaulted to WSSEC.

Table 2-24 Category: subscription

Utility

Function

add_user_subscription

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

list_user_subscriptions

List user subscriptions

modify_user_subscription

Enables or disables an existing subscription

Table 2-25 Category: templates

Utility

Function

modify_notification_template

Modifies a specified notification template for the Notification service.

Table 2-26 Category: timemanagement

Utility

Function

add_ischedule_server

Add a remote iSchedule Server configuration.

clear_calendar_permissions

Modify access permissions for grantee (user or group) on the specified calendar.

clear_tasklist_permissions

Reset the access permissions of a tasklist to their out-of-box defaults.

delete_ischedule_server

Delete a remote iSchedule Server configuration.

export_icalendar

Export invitations and assignments from a calendar and/or tasklist to an iCalendar file.

import_icalendar

Import an iCalendar file to an existing calendar and/or tasklist. If an iCalendarObject has a UID that already exists in the destination calendar and/or tasklist it will be re-created. VCALENDAR components can have many VEVENT and VTODO sub-components with different UIDs but sub-components of the same UID must be consecutive. A VCALENDAR component imported with a METHOD:X-ORACLE-DELETE or METHOD:CANCEL will cause all sub-components to be deleted.

list_calendar_enrollments

List the directly enrolled and directly unenrolled members of the specified team workspace calendar.

list_calendar_permissions

List the access control permissions of a user, resource or workspace's calendar. When multiple calendars match the selection criteria for the user, resource or workspace, the default calendar will be used.

list_calendars

Lists the existing calendars of a user, resource or workspace.

list_ischedule_servers

List remote iSchedule Server configurations.

list_tasklist_permissions

List the access control permissions of a user, resource or workspace's tasklist. When multiple tasklists match the selection criteria for the user, resource or workspace, the default tasklist will be used.

list_tasklists

Lists existing tasklists of a user, resource or workspace.

modify_calendar

Modify various attributes of the selected calendar.

modify_calendar_enrollments

Modify the enrollment list of the specified team workspace calendar.

modify_calendar_permissions

Modify access permissions for grantee (user or group) on the specified calendar.

modify_ischedule_server

Modify a remote iSchedule Server configuration.

modify_tasklist

Modify various attributes of the selected tasklist.

modify_tasklist_permissions

Modify access permissions for grantee (user or group) on the specified tasklist.

Table 2-27 Category: timezones

Utility

Function

import_timezones

Imports time zone definitions to the database.

list_timezones

Lists time zones in the database.

modify_timezones

Modify a time zone.

Table 2-28 Category: users

Utility

Function

add_custom_user_property

The add_custom_user_property command adds custom user properties.

add_directory_profile

The add_directory_profile command adds a new directory profile.

add_external_contact

The add_external_contact command adds new external contact.

add_feed_configuration

The add_feed_configuration command adds new feed configurations.

add_group

The add_group command adds new groups. The group information is supplied in an XML file.

add_preference_profile

The add_preference_profile command adds a new preference profile and associates it with a consumer. There can be only one preference profile for a consumer.

add_preference_property

The add_preference_property command adds a new preference property to a preference set.

add_preference_set

The add_preference_set command adds a preference set to a preference profile.

add_user

The add_user command adds new users. The user information is supplied either on command line or in an XML file.

delete_coexistence_profile

Deletes the coexistence profile of user.

delete_custom_user_property

The delete_custom_user_property command deletes a custom property. If there are multiple custom properties with same name, then only the first occurrence of the attribute with specified name is deleted. Any values of the property being deleted will also be deleted.

delete_directory_profile

The delete_directory_profile command deletes a directory profile.

delete_feed_configuration

The delete_feed_configuration command deletes feed configuration.

delete_group

The delete_group command deletes a group with an option to purge.

delete_preference_profile

The delete_preference_profile command deletes a preference profile.

delete_preference_property

The delete_preference_property command deletes a preference property from a preference set.

delete_preference_set

The delete_preference_set command deletes a preference set.

delete_user

The delete_user command deletes a user with an option to purge.

download_ldap_group_data

The download_ldap_group_data command downloads groups information for an external directory into an XML file. The generated XML file can be used with add_group command to create the groups.

download_ldap_user_data

The download_ldap_user_data command downloads user information for an external directory into an XML file. The generated XML file can be used with add_users command to create the users.

list_coexistence_profiles

Lists the profile of coexisting users.

list_custom_user_properties

The list_custom_user_properties command lists all custom properties of users.

list_directory_profiles

The list_directory_profiles command lists directory profiles in an XML file.

list_external_contacts

The list_external_contacts command lists contacts that match specified search criteria. If search criteria are not specified, then all contacts are listed. It also lists the details of the contact(s) whose identifier is specified.

list_feed_configurations

The list_feed_configurations command lists the feed configurations in the given scope.

list_groups

The list_groups command lists groups that match specified search criteria. If search criteria are not specified, then all groups are listed.

list_ldap_change_number

Lists the last change-log number processed by beehive for specified profile.

list_max_address_count

The list_max_address_count command lists the maximum number of addresses of an address type that can be set for a given person-contact, group-contact or resource-contact in an address-book. The address types determine the type of address like BUSINESS, PERSONAL and OTHER. This command also lists the system defined maximum limit, which cannot be exceeded.

list_preference_profiles

The list_preference_profiles command lists preference profiles for a consumer.

list_preference_properties

The list_preference_properties command lists all effective preference properties of a preference set.

list_preference_sets

The list_preference_sets command lists all preference sets for a preference profile.

list_users

The list_users command lists users that match specified search criteria. If search criteria are not specified, then all users are listed.

modify_coexistence_profile

Create or modify the coexistence profile of a user.

modify_directory_entry

Modifies the directory entry and locator for a given directory entry. This command can be used to convert a directory user to an external directory user and vice versa.

modify_directory_profile

The modify_directory_profile command modifies an existing directory profile. Modification to the profile name cannot be done.

modify_external_contact

The modify_external_contact command modifies existing external contact.

modify_feed_configuration

The modify_feed_configuration command modifies existing feed configurations.

modify_group

The modify_group command modifies a group. The group information is supplied in an XML file.

modify_ldap_change_number

Modifies the changelog number of a profile.

modify_max_address_count

The modify_max_address_count command modifies maximum number of addresses of an address type that can be set for a given person-contact, group-contact or resource-contact in an address-book. The address types determine the type of address like BUSINESS, PERSONAL & OTHER. The maximum count specified in this command must be less than the system defined maximum limit, which can be determined by running list_max_address_count command.

modify_preference_set

The modify_preference_set command modifies the preference set by setting the extends from attribute.

modify_user

The modify_user command modifies exisiting users.

validate_directory_entry

e> <s the directory entry in ldap with corresponding entry in beehive. The directory entry can be of type user, group or external person. The command provides an option to correct any data inconsistencies by applying necessary changes in beehive. The state of the profile specified in this command can either be ENABLE or DISABLE.

Table 2-29 Category: utilities

Utility

Function

delete_virus_scan_results

Deletes virus scan results from the system that match the specified criteria. Option scandate cannot be specified with options scandate_from or scandate_to.

export_errorcodes

Search for occurrences of error codes

export_filesystem_logs

Search log files stored on host machines.

export_logs

With an option of refreshing the repository first, query the repository to get relevant log records from log files stored on host machines.

export_probes

Lists all probe information in beehive.

list_command_metadata

Lists all the metadata about given command.

list_commands

Lists the command names based on the given criteria.

list_errorcode_catalog

List all error code definitions in beehive.

list_operation_statuses

List the Operation Statuses

list_schema_clones

Search the ocs_clone_registry table based on the specified options and display the matched clone records.

list_schemas

Search the ocs_schema_registry table based on the specified options and display the matched schema records.

list_statistics

Lists the statistics for a given type or component or for the entire site.

list_supported_entity_types

Prints the supported entity types which can be used in business object distinguished naming pattern instead of system generated identifier and their description.

list_virus_scan_results

Lists the virus scan results that match the specified criteria. Only a count of the matches found will be displayed if the option to list only the counts is specified. Option count_only cannot be specified with options maximum_results or display_columns. Option scandate cannot be specified with options scandate_from or scandate_to.

obfuscate

Obfuscates the prompted string.

version

This command shows the version information of the Beehive products.

Table 2-30 Category: workspace

Utility

Function

add_category

Creates a category at the enterprise scope

add_category_application

Applies a category on a given entity

add_category_configuration

Creates a category configuration on the given scope or heterogenous folder.

add_team_workspace

Creates a team workspace from a template

add_team_workspace_template_application

Transforms the given team workspace to conform to the given team workspace template

add_team_workspace_template_evolution

Applies the latest snapshot of the given team workspace template to all the team workspaces to which the template was applied earlier

add_version_configuration

Creates a version configuration on the given scope or heterogenous folder.

delete_category

Deletes a category and all category applications.

delete_category_application

Removes a category from an entity

delete_category_configuration

Deletes a given category configuration.

delete_version_configuration

Deletes a given version configuration.

download_generated_team_workspace_template

Generates a team workspace template from the given team workspace

download_workspace_template_schema

Downloads workspace template XML schema to a file

export_workspace

Exports workspace contents into an external directory.

import_workspace

Imports contents of an external directory into a new team workspace.

list_applied_workspace_templates

Lists the workspace templates that have been applied to this workspace. For each applied template it indicates whether this workspace is a template evolution target.

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

list_category_applications

List all the categories (and associated attributes) applied to a specific entity. Lists the application of a specific category to the entity if the [category] parameter is provided.

list_category_configuration

Lists the category configuration on the given scope or heterogenous folder.

list_deleted_workspaces

Lists deleted workspaces

list_template_evolution_target_workspaces

Lists the workspaces to which the latest version of the given workspace template needs to be applied to make the workspaces conform to the latest version of the template

list_version_configuration

Lists the version configuration on the given scope or heterogenous folder.

list_workspace_templates

Lists all workspace templates

list_workspaces

Lists workspaces in an organization or enterprise

modify_category

Modifies an existing category

modify_category_configuration

Updates a given category configuration.

modify_personal_workspace

Modifies an existing personal workspace

modify_team_workspace

Modifies an existing team workspace

modify_version_configuration

Updates a given version configuration.

modify_workspace_template

Modifies an existing workspace template

Common Options

The beectl command options can be broken down into two types: common options, and command specific options. This section describes common options that can be used with any beectl command.

The following is a complete list of common options for all beectl commands:

--format

Specify the output format type. Valid options are multiline, xml, table, and tiled. The default format is multiline.

--separator

Specify the separator to use when formatting an output type of tiled with the --format option. Any character may be used as a separator. The default separator is "|".

--entity_format

Specify display format of the entity. Valid entity format options are name, id, and name_and_id. Default format is name.

--timezone_id

Specify the time zone to use if any date and time information is returned by the command. To determine a time zone ID, use the list_timezones command.

--no_confirmation

Allow the command to be executed without prompting for any confirmation. This option applies only to remove and delete commands.

--version

Print the version information of a beectl command. This option does not require an argument.

--help

Print a usage message.

--log_level

Specify the logging level. Valid arguments for this option are: FINEST, FINER, FINE, CONFIG, INFO, WARNING, SEVERE, ERROR, INTERNAL_ERROR, NOTIFICATION, and TRACE. If no log level is specified, the default, INFO, will be used. This option cannot be used while in shell mode or batch mode. Specify the option when invoking either mode.

--logdir

Specify the full path to the log directory. The default value is ORACLE_HOME/beehive/logs/beectl/. This option cannot be used while in shell mode or batch mode. Specify the option when invoking either mode.

--batchfile

Specify the full path and file name of a batch file. Commands and options can be specified in a file and passed with this option for batch processing.

--continue

Force Oracle Beehive to continue with the next command when using the --batchfile option. The next command will be executed regardless of the exit code of the previous command.

--activate_configuration

Commands that deal with updating the system object model make use of this option to determine if they need to save their modification to the configuration system.

--no_wrap

If specified, the cell values in the tabular format output of a command will not be wrapped.

--no_stagger

If specified, the columns of the tabular format output of a command will not be staggered.

--column_format

Specify customized column format string. For example, 10%10%20%. This option is applicable only to commands that have tabular output. If not specified or an incorrect value is specified, it will be ignored, and the maximum content length for each column will be used to set column width.

--terminal_width

Modify the default terminal width. By default, the terminal width is 80 characters.

--obfuscated

Specify this option when all passwords passed with the command are obfuscated.

--authuser

Specify the user name for beectl commands requiring authentication.

--authpassword

Specify the user password for the user specified with the --authuser option. The argument for this option must be obfuscated using the --obfuscated if passed on the command line.

Note:
Option arguments should not start with a hyphen (-). If an option argument needs to start with hyphen, use one of the following options:

- Use the <option name> = <option value> format; this is the preferred way to specify option values starting with hyphens.

- Prefix the option value with string ESCAPE:.

- Prefix the option value with an escaped backslash (\\). This is the least preferred way. This may not work in some operating systems; it does not work in Microsoft Windows.

Option values should not contain the any special characters (such as *, $, and %). If an option value contains a special character, then enclose the option value in double quotes (").

System Object Identifiers

System model objects in the system model can be uniquely identified with the following mechanisms:

System Object Identifier

A unique identifier assigned to each system model object at the time of creation. The system object identifier is read-only and it cannot be changed. For example, 8ae5c0e8-02c8-429e-9773-186e6a79997b.

Built-In Alias

A unique, built-in alias is assigned to certain system model objects at the time of creation. Built-in alias names are read-only and it cannot be changed. For example, _CURRENT_SITE refers to the current site system model object and _CURRENT_ENTERPRISE refers to the current enterprise system model object.

User Defined Alias

You can assign a unique user defined name to each system model object. Oracle Beehive ensures that all user defined aliases are unique. The user defined alias are mutable and can be modified at any point of time. For example, oracle_smtp_service can refer to an SMTP service system model object.

Encoded System Object Identifier

To refer to a system model objects that lies deep in the system model hierarchy, use the following syntax:

<unique ID>[:<property name>][:<property name>][:<property name>]

<unique ID> is a system object identifier, built-in alias, or user defined alias of a system model object, and <property name> is a valid property name of the preceding model object. The type of property should be a system model object.

For example, the following command list the properties of the logging properties of the database of the current site:

beectl list_properties --component _CURRENT_SITE:Database:LoggingProperties

Providing Secure Values

The following are the available methods to provide secure values, such as passwords, to a command:

Prompt

Only provide the option (without providing the secure value). The beectl tool will prompt you for the secure value. Some commands may ask you to reconfirm the secure value.

Obfuscate

Obfuscate the secure value with the obfuscate command. Use the obfuscated value for the option that requires the secured value along with the common option --obfuscated.

Clear Text

To provide secure values in clear text, run commands in beectl shell mode.

Tabular Output

The following options allow you to control the display of tabular output:

--no_wrap

Specify that content wrapping will not be applied to cell values.

--no_stagger

Specify that columns will not be staggered. By default, columns will not be staggered if there are three or less columns.

--column_format

Specify the column widths (in chars) for each column. This value will be ignored if number of columns given in this option do not match the number of columns in the resultant table. The following is an example of this option:

beectl list_property_metadata
--type ManagementService
--full_report
--column_format 10%10%10%10%10%

-----------+------------+------------+------------+-----------------------------
Property n | Property T | Metadata   | Short desc | Long descr
ame        | ype        |            | ription    | iption
-----------+------------+------------+------------+-----------------------------
AutoSyncSa | int        | Not ReadOn | [Short des | [Long desc
veListener |            | ly-Mutable | cription k | ription ke
SleepInter |            | -Mandatory | ey not set | y not set.
valInSecon |            |            | .]         | ]
ds         |            |            |            |
-----------+------------+------------+------------+-----------------------------
...

You may not specify this option with --no_stagger or --no_wrap.

--terminal_width

Specify the terminal width of the terminal in which you are running the beectl tool. Specify this option if you have resized your terminal to more than 80 character widths and you want the command output to fit the entire width of your terminal. The Default (minimum) value for terminal width is 80.

Boolean Values

If an option requires a boolean value (either true or false), and you specify the option without specifying a value, the command assumes a value of true for the option.

activate_configuration

Saves proposed configuration and activate it.

SYNTAX

beectl activate_configuration

OPTIONS

This command has no options

EXAMPLES

beectl activate_configuration

add_assigned_role

Creates an AssignedRole entity.

SYNTAX

beectl add_assigned_role [--scope <unique identifier of the Scope>] --name <name of AssignedRole> [--description <description>] --assigned_scope <assigned_unique identifier of the Scope> --role_definition <unique identifier of the RoleDefinition> [[--accessor <unique identifier of an Accessor>]...]

OPTIONS

--scope

Specify the unique identifier of the Scope in which the AssignedRole should be created.

--name

Specify the name of the AssignedRole.

--description

Specify a description for the AssignedRole.

--assigned_scope

Specify the unique identifier of an assigned Scope for the AssignedRole.

--role_definition

Specify the unique identifier of an assigned RoleDefinition for the AssignedRole.

--accessor

Specify the unique identifier of an Accessor to add to the AssignedRole. This option can be specified more than once.

EXAMPLES

beectl add_assigned_role --scope wksp=MyWorkspace,enpr=MyEnterprise --name MyAssignedRole --assigned_scope wksp=MyWorkspace,enpr=MyEnterprise --role_definition acrd=MyRoleDefinition,wksp=MyWorkspace,enpr=MyEnterprise

add_attendant

Adds an auto attendant or copies an existing one under a new name. When copying any prompts will also be copied.

SYNTAX

beectl add_attendant { --file <AAML file> | --name <new name> --copy_from <existing attendant> }

OPTIONS

--file

An auto-attendant markup language file describing the attendant to be added. When specified, name and copy_from must be specified.

--name

Name to be given to copied attendant. When specified, copy_from must also be specified and file must not be specified

--copy_from

Name of attedant to copy. When specified, copy_from must also be specified and file must not be specified

EXAMPLES

beectl add_attendant --file example.aaml

beectl add_attendant --name copiedAttendant --copy_from someAttendant

add_audit_policy

Creates an audit policy from the XML file information

SYNTAX

beectl add_audit_policy --file <Full path of the input file>

OPTIONS

--file

Full path name of the input XML file

EXAMPLES

beectl add_audit_policy --file /tmp/policy_ex.xml

add_audit_trail

Creates an audit trail from the search result generated using the XML file

SYNTAX

beectl add_audit_trail --file <Full path of the input file>

OPTIONS

--file

Full path name of the input XML file

EXAMPLES

beectl add_audit_trail --file /tmp/trail_ex.xml

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.

SYNTAX

beectl add_blocked_device --device <deviceid> [--description <description>]

OPTIONS

--device

Specify the local device identifier.

--description

Describe why the device is being blocked.

EXAMPLES

beectl add_blocked_device --device 981214

add_category

Creates a category at the enterprise scope

SYNTAX

beectl add_category --file <Full path of the category XML file>

OPTIONS

--file

Full path name of the XML file. The file must contain the properly formatted data to create the category

EXAMPLES

beectl add_category --file /tmp/category.xml

add_category_application

Applies a category on a given entity

SYNTAX

beectl add_category_application --category <Identifier of the category to be applied>  -- entity <Identifier of the entity to which the category needs to be applied>

OPTIONS

--category

Specify the identifier of the category.

--entity

Specify the identifier of an Oracle Beehive entity to which the category needs to be applied.

EXAMPLES

beectl add_category_application --category catg=MyCategory,enpr=MyEnterprise --entity adoc=MyDocument,fldr=MyFolder,wksp=MyWorkspace,enpr=MyEnterprise

add_category_configuration

Creates a category configuration on the given scope or heterogenous folder.

SYNTAX

beectl add_category_configuration --container <Configuration scope or heterogenous folder> --file <Full path of the configuration XML file>

OPTIONS

--container

Scope or heterogenous folder on which the category configuration should be defined.

--file

Full path of the category configuration XML file. The file must contain properly formatted data.

EXAMPLES

beectl add_category_configuration --container orgn=MyOrganization,enpr=MyEnterprise --file /tmp/configuration.xml

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.

SYNTAX

beectl add_client_application_configuration --file <path to the XML file>

OPTIONS

--file

Specify the full path and name of the XML input file. The file should contain information about how to create a client application configuration.

EXAMPLES

beectl add_client_application_configuration --file /tmp/app-config.xml

add_client_application_provisioning

Provisions client applications to a community.

SYNTAX

beectl add_client_application_provisioning --community <community identifier> {--configuration <client application configuration identifier>... | --all | --application <Identifier of the client application> | --application_version <Identifier of the client application version>}

OPTIONS

--community

Specify the identifier of the community.

--configuration

Specify the identifier of the client application configuration. This option can be specified more than once.

--all

Specify this option to provision the latest binaries (latest version and latest patchset) of all client applications to this community.

--application

Specify this option to provision the specified application to this community. This would make the latest binaries (latest version and latest patchset) to be available to the members of the provisioned community.

--application_version

Specify this option to provision the specified version to this community. This would make the latest patchset in the specified version to be available to the members of the provisioned community.

EXAMPLES

beectl add_client_application_provisioning --community enpr=myEnterprise --configuration 1234:5678:capc:2E0329B0705F0E40E040578C92160957000000000434 --configuration 1234:5678:capc:2E0329B0705F0E40E040578C92160957000000000434

beectl add_client_application_provisioning --community enpr=myEnterprise --all

beectl add_client_application_provisioning --community enpr=myEnterprise --application 21EC:0AE5:capn:406E6CD925A8F087E040578C921636E5000000000979

beectl add_client_application_provisioning --community enpr=myEnterprise --application_version 21EC:0AE5:capv:406E6CD925A8F087E040578C921636E5000000000979

add_coexistence_system

Creates a new coexisting remote system.

SYNTAX

beectl add_coexistence_system --name <name> --product_name <product_name> {--url <url>|--host_name <host_name> --port <port_number> {--use_http|--use_https}} --partnership_key [--timezone_alias_namespace <timezone_alias_namespace>]

OPTIONS

--name

Specify the name of the coexisting remote system.

--product_name

Specify the product name of the coexisting remote system. Supported product are EXCHANGE and DOMINO.

--url

Specify the URL of the coexisting remote system.

--use_http

Specify that "HTTP" MUST be used for the coexisting remote system.

--use_https

Specify that "HTTPS" MUST be used for the coexisting remote system.

--host_name

Specify the host name of the coexisting remote system.

--port

Specify the port number used by the coexisting remote system.

--partnership_key

Specify the partnership key of the coexisting remote system.

--timezone_alias_namespace

Specify the timezone alias namespace used by the coexisting remote system.

EXAMPLES

beectl add_coexistence_system --name ex-101 --product_name exchange --url https://example.com:7777 --partnership_key

beectl add_coexistence_system --name do-202 --product_name domino --use_https --host_name example.com --port 7777 --partnership_key

add_conference

Creates conference artifact under workspace

SYNTAX

beectl add_conference --parent <Workspace identifier> --name <Conference name> --template <Conference identifier>

OPTIONS

--parent

Workspace identifier

--name

Conference name

--template

Conference identifier

EXAMPLES

beectl add_conference --parent wksp=MyWorkspace,enpr=MyEnterprise --name MyConference --template owct=MyTemplate,wksp=MyWorkspace,enpr=MyEnterprise

add_conference_template

Creates conference-template artifact under workspace

SYNTAX

beectl add_conference_template --parent <Workspace identifier> --name <Conference name> --model <Conference or conference template identifier> --settings-xml-file <Conference settings XML file>

OPTIONS

--parent

Workspace identifier

--name

Conference name

--model

Conference identifier

--settings-xml-file

Conference settings XML file

EXAMPLES

beectl add_conference_template --parent wksp=MyWorkspace,enpr=MyEnterprise --name Template_from_template --model owct=MyTemplate,wksp=MyWorkspace,enpr=MyEnterprise

beectl add_conference_template --parent wksp=MyWorkspace,enpr=MyEnterprise --name Template_from_xmlfile --settings-xml-file /tmp/default_settings.xml sample settings file: <settings> <roles> <role> <name>Guests</name> <accessors> <accessor_id>2FD3:6B7D:user:42B3D7467840404AA8ABF34BAE421CC5000000000000</accessor_id> </accessors> <properties> <property> <name>chat.can_enable</name> <value> <permission>GRANTED</permission> </value> </property> </properties> </role> </roles> </settings>

add_custom_user_property

The add_custom_user_property command adds custom user properties.

SYNTAX

beectl add_custom_user_property --name <property_name> --type <property_type> [ --description <description> ]

OPTIONS

--name

Name of the custom property

--type

Type of the property. Supported types are BOOLEAN, COLLABID, DATETIME, DOUBLE, STRING.

--description

Description of the custom property.

EXAMPLES

beectl add_custom_user_property --name employeenumber --type DOUBLE

add_device_command

Creates a device command for a given device.

SYNTAX

beectl add_device_command --device <identifier of the device> --action <device command action>

OPTIONS

--device

Specify the identifier of the device. Use list_devices command to determine the identifier of the device.

--action

Specify the action of the device command. The following are the valid command actions: UPLOADLOG UPLOADCONFIG CHECKUPDATE WIPEOUT .

EXAMPLES

beectl add_device_command --device 1234:5678:devi:2E0329B0705F0E40E040578C92160957000000000434 --action CHECKUPDATE

add_directory_profile

The add_directory_profile command adds a new directory profile.

SYNTAX

beectl add_directory_profile --file <filename> [ --no_validate ]

OPTIONS

--file

XML file containing directory profile.

--no_validate

Skips the validation of profile against the directory server.

EXAMPLES

beectl add_directory_profile --file MyDirectoryProfile.xml

beectl add_directory_profile --file MyDirectoryProfile.xml --no_validate

add_dmz_home_instance

Creates configuration for a Beehive installation in the DMZ that is, outside the firewall.

SYNTAX

beectl add_dmz_home_instance --hostname <hostname> --bti_unique_id <unique id for BTI on this oracle home> --no_of_client_workers <number of client workers> [--oracle_home <oracle home path>] [--opmn_request_port <OPMN request port>] [--opmn_remote_port <OPMN remote port>] [--bti_server_port <BTI server port>] [--instance_name <instance name>]

OPTIONS

--hostname

Host name of the machine.

--oracle_home

oracle home path.

--bti_unique_id

The site-wide unique identifier of BTI installed on the DMZ host. Please specify the value which is present in the oracle_home/beehive/conf/bti.properties file on the DMZ host.

--no_of_client_workers

This is the number of MX processes in the DMZ midtier. The value of this parameter should be the value of "NumberOfClientWorkers" in $OH/beehive/conf/bti.properties in DMZ midtier.

--opmn_request_port

OPMN request port

--opmn_remote_port

OPMN remote port

--bti_server_port

The server port.

--instance_name

instance name of DMZ midtier

EXAMPLES

beectl add_dmz_home_instance --hostname dmzhost.example.com --bti_unique_id 813130873 --no_of_client_workers 4

add_email_endpoint

Add an email endpoint

SYNTAX

beectl add_email_endpoint --ep_name <endpoint name> --ep_protocol <IMAP|SMTP> --type <MX|MXS|TCP|BUS> --ep_address <port number|bus address>

OPTIONS

--ep_name

The email endpoint name

--ep_protocol

The email protocol (SMTP|IMAP)

--type

The email endpoint type (MX|MXS|TCP|BUS)

--ep_address

The endpoint address (port number|bus address)

EXAMPLES

beectl add_email_endpoint --ep_name IMAP SSL Endpoint --ep_protocol IMAP --type MXS --ep_address 5993

add_event_subscription

Creates an event subscription using data in an XML file.

SYNTAX

beectl add_event_subscription --file <full path to the event subscription xml file>

OPTIONS

--file

Specify the absolute path of the XML file that contains data to create the event subscription.

EXAMPLES

beectl add_event_subscription --file /private/xml/MyEventSubscription.xml

add_expertise_user_scope

The add_expertise_user_scope command adds new expertise user scope. The expertise user scope information is supplied in a XML file.

SYNTAX

beectl add_expertise_user_scope --file <filename>

OPTIONS

--file

Filename of the XML file containing name, description, include_list and exclude_list.

EXAMPLES

beectl add_expertise_user_scope --file MyUserScope.xml

add_external_contact

The add_external_contact command adds new external contact.

SYNTAX

beectl add_external_contact     --family_name <[locale:]family name>     [ --family_name <[locale:]family name> ... ]     [ --scope <identifier of contacts parent> ]     [ --given_name <[locale:]given name> ... ]    [ --display_name <[locale:]display name> ... ]    [ --middle_name <[locale:]middle name> ... ]     [ --job_title <[locale:]job title> ... ]    [ --prefix <[locale:]prefix> ... ]    [ --suffix <[locale:]suffix> ... ]    [ --nick_name <[locale:]nick name> ... ]     [ --office_location <office location of the contact> ]     [ --company <company of the contact> ]     [ --profession <profession of the contact> ]     [ --timezone <timezone of the contact> ]     [ --locale <locale of the contact> ]     [ --department <department of the contact> ]     [ --organization <organization identifier> ... ]     [ --property <name(assistant|certificate|notes)=value=description> ... ]     [ --address <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ]     [ --default_address_for_type <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ]     [ --default_address_for_scheme <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ]     [ --primary_address <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ]

OPTIONS

--family_name

Family name of the contact in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--scope

Identifier of the enterprise under which this contact will be created.

--given_name

Given name of the contact in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--display_name

Display name of the contact in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--middle_name

Middle name of the contact in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--job_title

Job title of the contact in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--prefix

Prefix of the contact in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--suffix

Suffix of the contact in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--nick_name

Nick name of the contact in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--office_location

Office location of the contact.

--company

Company of the contact.

--profession

Profession of the contact.

--timezone

Timezone of the contact. list_timezones lists the valid timezones

--locale

Locale details of the contact. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--department

Department of the contact.

--organization

Identifiers of the organizations the contact belongs to.

--property

Details of the property in the format name=value=description. Supported names are certificate, assistant and notes. Note, no equals to symbol(=) should be present in the name or value or description.

--address

Address of the contact in the format type:scheme:value. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.

--default_address_for_type

Address of the contact in the format type:scheme:value. Sets the specified address as the default for the specified type. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.

--default_address_for_scheme

Address of the contact in the format type:scheme:value. Sets the specified address as the default for the specified scheme. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.

--primary_address

Primary address of the contact in the format type:scheme:value. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.

EXAMPLES

beectl add_external_contact --family_name Contact1FamilyName --scope enpr=example

beectl add_external_contact --family_name Contact1FamilyName --given_name Contact1GivenName --display_name "Contact1 GivenName" --organization orgn=contact1orgn,enpr=contact1enpr

beectl add_external_contact --family_name Contact1FamilyName --scope enpr=example --address BUSINESS_1:mailto:contact1@example.com --address BUSINESS_2:fax:121345222

beectl add_external_contact --family_name Contact1FamilyName --scope enpr=example --property prop1:prop1Value

add_feed_configuration

The add_feed_configuration command adds new feed configurations.

SYNTAX

beectl add_feed_configuration    {        --name <name >        --scope <scope identifier>        --feedtype <feed type >        --title <title >         --description <description >         [--image <image >]         [--language <language >]         [--copyright <copyright>]         [--webmaster <webmaster>]     }

OPTIONS

--name

Name of the feed configuration.

--scope

Scope in which the feed configuration will be created

--feedtype

Feed type of the feed configuration. Permitted values are ANNOUNCEMENT, FORUM, FOLDER, LABEL, RECENT, TOPIC and VERSION.

--title

Title associated the feed configuration

--description

Description associated the feed configuration

--image

Image associated with this feed configuration

--language

Language associated with the feed configuration

--copyright

Copyright associated with the feed configuration

--webmaster

Webmaster associated with the feed configuration

EXAMPLES

beectl add_feed_configuration --name FeedConfigName --scope enpr=example --feedtype RECENT --title MyFeedConfiguration --description This is my feed configuration.

beectl add_feed_configuration --name MyWorkspaces --scope enpr=example --feedtype RECENT --title WorkspaceFeedConfiguration --description This is a recent workpsace feed. --image WorkspaceLogo.gif --language en

add_filesystem_reference

Creates a reference in Beehive to a directory on the filesystem.

SYNTAX

beectl add_filesystem_reference --name <Filesystem reference name> --filesystem_path <Server path> --read_only <true or false>

OPTIONS

--name

Name to give to this filesystem reference.

--filesystem_path

Fully-qualified path on the filesystem to which this reference should point.

--read_only

Whether the referenced filesystem directory should be treated as read-only by Beehive.

EXAMPLES

beectl add_filesystem_reference --name MyFilesystemReference --filesystem_path /usr/local/bin --read_only true

add_group

The add_group command adds new groups. The group information is supplied in an XML file.

SYNTAX

beectl add_group --file <filename> [ --ldapbootstrap ]

OPTIONS

--file

Filename of the XML file containing group definition.

--ldapbootstrap

LDAP bootstrap flag. If this flag is specified, then uds groups will be created with directory locator and directory id. This is relevant only when --file option is used.

EXAMPLES

beectl add_group --file MyGroup.xml

beectl add_group --file MyGroup.xml --ldapbootstrap

add_ischedule_server

Add a remote iSchedule Server configuration.

SYNTAX

beectl add_ischedule_server --name <name> --domain_regexp <regexp> --outgoing_url <remote_url> [--outgoing_auth_id <auth_id>] [--outgoing_auth_key <auth_key>] [--incoming_auth_id <auth_id>] [--incoming_auth_key <auth_key>] [--incoming_allow_ip_regexp <regexp>] [--incoming_allow_host_regexp <regexp>]

OPTIONS

--name

Name of the remote server configuration, can contain only alpha numerical characters, underscores and dashes.

--domain_regexp

Regular expression that must match the remote user's email address.

--outgoing_url

Address of the remote iSchedule server.

--outgoing_auth_id

Authentication ID that must be used when connecting to the remote server.

--outgoing_auth_key

Key that must be used when connecting to the remote server.

--incoming_auth_id

Authentication ID that the remote server must use when connecting to the Oracle Beehive server.

--incoming_auth_key

Key that the remote server must use when connecting to the Oracle Beehive server.

--incoming_allow_ip_regexp

IP Addresses connecting to the Oracle Beehive server must match this regular expression

--incoming_allow_host_regexp

Host names connecting to the Oracle Beehive server must match this regular expression

EXAMPLES

beectl add_ischedule_server --name remoteserver --domain_regexp ".*@example.com" --outgoing_url http://remoteserver@example.com/ischedule

add_local_ace

Adds an Access Control Entry (ACE) to an entity's Local Access Control List (LACL).

SYNTAX

beectl add_local_ace --entity <unique identifier of the entity> --accessor <unique identifier of the Accessor> [--access_types <access types string>]

OPTIONS

--entity

Specify the unique identifier of the entity to which the ACE will be added.

--accessor

Specify the Accessor to whom the access types will apply.

--access_types

Specify the access types string for the Accessor.

EXAMPLES

beectl add_local_ace --entity adoc=MyDocument,wksp=MyWorkspace,enpr=MyEnterprise --accessor user=MyUser --access_types +RW-D

add_organization

Creates an organization in the given scope

SYNTAX

beectl add_organization --name <Organization name> --scope <Identifier of enterprise or organization>

OPTIONS

--name

Name of the organization

--scope

Identifier of the parent scope (enterprise or organization)

EXAMPLES

beectl add_organization --name Sample_organization --scope enpr=test_org

add_policy

Creates a policy using data in an XML file.

SYNTAX

beectl add_policy --file <full path to the policy xml file>

OPTIONS

--file

Specify the absolute path of the XML file that contains the policy data.

EXAMPLES

beectl add_policy --file /private/xml/MyPolicy.xml

add_policy_schema

Creates a policy schema using data in an XML file.

SYNTAX

beectl add_policy_schema --file <full path to the policy schema xml file>

OPTIONS

--file

Specify the absolute path of the XML file that contains the policy schema data.

EXAMPLES

beectl add_policy_schema --file /private/xml/MyPolicySchema.xml

add_policy_template

Creates a policy template using data in an XML file.

SYNTAX

beectl add_policy_template --file <full path to the policy template xml file>

OPTIONS

--file

Specify the absolute path of the XML file that contains the policy template data.

EXAMPLES

beectl add_policy_template --file /private/xml/MyPolicyTemplate.xml

add_preference_profile

The add_preference_profile command adds a new preference profile and associates it with a consumer. There can be only one preference profile for a consumer.

SYNTAX

beectl add_preference_profile --consumer <identifier> --name <profile-name> [ --description <description> ]

OPTIONS

--consumer

Identifier of the consumer

--name

Name of the preference profile to be created.

--description

Description of preference profile.

EXAMPLES

beectl add_preference_profile --consumer user=user1 --name MyProfile

add_preference_property

The add_preference_property command adds a new preference property to a preference set.

Supported types are :

IDENTIFIABLE

IDENTIFIABLE_LIST

STRING

STRING_LIST

INTEGER

INTEGER_LIST

BOOLEAN

BOOLEAN_LIST

DATE

DATE_LIST

URI

URI_LIST

FLOAT

FLOAT_LIST

SYNTAX

beectl add_preference_property --set <identifier> --name <property-name> --type <string | date | ... | identifiable> [ --value <property-value> ] [ --file <file-name> ] [ --final ]

OPTIONS

--set

Identifier of the preference set specified in id format, which can be determined by running list_preference_sets command with "--entity_format id" option.

--name

Name of the preference property.

--type

Type of preference property.

--value

Value of preference property.

--file

File name for business hours type preference property.

--final

Whether the preference property be overriden in extended property.

EXAMPLES

beectl add_preference_property --set prfs=set1,user=user1 --name MyProperty --type integer --value 100 --final

beectl add_preference_property --set prfs=set1,user=user1 --name MyProperty --type integer_list --value 100 --value 200 --value 300 --final

add_preference_set

The add_preference_set command adds a preference set to a preference profile.

SYNTAX

beectl add_preference_set --parent <preference-profile-identifier> --name <preference-set-name> [ --extends <preference-set-identifier> ]

OPTIONS

--parent

Identifier of the preference profile to which the preference set is added.

--name

Name of the preference set.

--extends

Identifier of the preference set from which the new preference set is extended.

EXAMPLES

beectl add_preference_set --parent prfp=MyProfile,user=user1 --name MyPreferenceSet

add_record

Adds a record or non-record.

SYNTAX

beectl add_record --artifact <identifier of the artifact to be filed as a record or non-record> { --retention_category <identifier of the URM retention category> | --record_folder <identifier of the URM record folder> } [ --no_retention <boolean specifying a record or non-record> ]

OPTIONS

--artifact

identifier of the artifact to be filed as a record or non-record

--retention_category

identifier of the URM retention category

--record_folder

identifier of the URM record folder

--no_retention

boolean specifying a record or non-record

EXAMPLES

beectl add_record --artifact myArtifact --retention_category myRetentionCategory --no_retention

add_remote_repository

Adds a remote repository.

SYNTAX

beectl add_remote_repository --file <Pathname to the remote repository file.>

OPTIONS

--file

Pathname to the remote repository file.

EXAMPLES

beectl add_remote_repository --file myRemoteRepositoryFile

add_remote_share

Adds a remote repository share.

SYNTAX

beectl add_remote_share --file <Pathname to the remote share file.>

OPTIONS

--file

Pathname to the remote share file.

EXAMPLES

beectl add_remote_share --file myRemoteShareFile

add_resource

Creates a new resource.

SYNTAX

beectl add_resource --name <name> --email_address <email address> --resource_type <type>         [--scope <organization>] [--capacity <capacity>] [--identifier <identifier>]         [--phone_number <phone_number>] [--website <website>] [--postal_address <postal address>]         [--timezone <timezone name>] [--location <location>]  [--add_approver <approverid>]          [--description <description>]  [--booking_info <booking info>]         [--booking_characteristics <[O]pen>|<[F]CFS>] [--custom_processing <[T]rue>|<[F]alse>]         [--accessible_by <everyone | nobody | groupid | userid> ]    beectl add_resource --external --name <name> --email_address <email address> --resource_type <type>         [--scope <organization>] [--capacity <capacity>]         [--phone_number <phone_number>] [--website <website>] [--postal_address <postal address>]         [--timezone <timezone name>] [--location <location>] [--booking_info <booking info>]         [--description <description>]

OPTIONS

--name

Define the unique name of the resource.

--enterprise

Deprecated option. Use --scope instead.

--resource_type

Specify the type of the resource. Specify "E", "Equipment", "O", "Other", "R" or "Room", case insensitive.

--bookableresource_type

Deprecated option. Use --resource_type instead.

--email_address

Specify the BUSINESS_1 e-mail address of the resource.

--phone_number

Specify the BUSINESS_1 phone number of the resource.

--website

Specify the BUSINESS_1 web site of the resource.

--postal_address

Specify the BUSINESS_1 postal address of the resource. The required format is: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country>. All fields are optional but at least one field must appear in a valid address of this type. For example, orapostal:l1=1, Main Street is a valid address. The ? character must not be encoded when used as a separator; it must be encoded in all other cases. For example orapostal:l1=1?l2=Which Street%3F?code=12345 is a valid address; but orapostal:l1=1?l2=Which Street??code=12345 is not a valid address because the question mark appearing as part of the address "Which Street?" is not encoded.

--identifier

Specify the identifier of the resource. The identifier can be used as an alternative to the name: such as a room or serial number.

--capacity

Specify the capacity of the resource.

--external

Create the resource as an external resource. If this option is not specified, a BookableResource will be created.

--add_approver

Resource approver to add.

--booking_characteristics

Specify resource default calendar booking characteristic. Specify [O] for Open or [F] for First Come First Serve, case insensitive.

--booking_info

Specify resource booking information. It must be a xHTML string.

--description

Specify the description of the resource. It must be a xHTML string.

--timezone

Specify the timezone of the resource.

--location

Specify the location description of the resource. It must be a xHTML string.

--scope

Specify the enterprise or organization under which this resource will be created. Will default to the current enterprise.

--custom_processing

Specify if this resource requires custom processing. Specify "T", "True", "F" or "False", case insensitive.

--accessible_by

Specify who can access this resource. It must be one of "everyone", "nobody", a group id or finally a user id, case insensitive. Use "everyone" to reset the accessibility to the default for the resource.

EXAMPLES

beectl add_resource --name "Resource1" --email_address resource1@example.com --resource_type "room" --identifier "us:OP200:20P74" --capacity 8 --timezone "America/Los_Angeles"

add_role_definition

Creates a RoleDefinition entity.

SYNTAX

beectl add_role_definition [--scope <unique identifier of the Scope>] --name <name of RoleDefinition> [--description <description>] [[--privilege <privilege name>]...] [--access_types <access types string>] [--always_enabled <boolean value>]

OPTIONS

--scope

Specify the unique identifier of the Scope in which the RoleDefinition should be created.

--name

Specify the name of the RoleDefinition.

--description

Specify a description for the RoleDefinition.

--privilege

G">Workspace name</optich will be granted by the RoleDefinition. This option can be specified more than once.

--access_types

Specify the access types string for the RoleDefinition.

--always_enabled

Specify this option to mark the RoleDefinition as always enabled.

EXAMPLES

beectl add_role_definition --scope wksp=MyWorkspace,enpr=MyEnterprise --name MyRoleDefinition

add_search_recovery_scope

Recovers the search index for Entities of the specified types, in the specified Scope, and which were last modified between the specified dates.

SYNTAX

beectl add_search_recovery_scope --scope <Recover the search index for this scope.> [--entity_type <Recover search index for this entities of this type.>] [--start_date <Recover search index for entities modified on or after this date.  If not specified, 30 days before the present will be used as the start date.>] [--end_date <Recover search index for entities modified before or on this date.  If not specified, the present will be used as the end date.>]

OPTIONS

--scope

Recover the search index for this scope.

--entity_type

Recover search index for this entities of this type.

--start_date

Recover search index for entities modified on or after this date. If not specified, 30 days before the present will be used as the start date.

--end_date

Recover search index for entities modified before or on this date. If not specified, the present will be used as the end date.

EXAMPLES

beectl add_search_recovery_scope --scope 1CF3:35AF:orgn:6828B43CD3944E06A5CD425F0225CF2500000000004C --entity_type adoc --entity_type emsg --start_date 2008-07-10T00:00:00 --end_date 2010-04-21T00:00:00

add_sensitivity

Creates a Sensitivity entity.

SYNTAX

beectl add_sensitivity --workspace <unique identifier of the Workspace> --name <name of Sensitivity> [--description <description>] [--sensitivity_only <boolean value>] [--delegatable <boolean value>]

OPTIONS

--workspace

Specify the unique identifier of the Workspace in which the Sensitivity should be created.

--name

Specify the name of the Sensitivity.

--description

Specify a description for the Sensitivity.

--sensitivity_only

Specify the SensitivityOnly option for the Sensitivity.

--delegatable

Specify the Delegatable option for the Sensitivity.

EXAMPLES

beectl add_sensitivity --workspace wksp=MyWorkspace,enpr=MyEnterprise --name MySensitivity

add_sensitivity_ace

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

SYNTAX

beectl add_sensitivity_ace --sensitivity <unique identifier of the entity> --accessor <unique identifier of the Accessor> [--access_types <access types string>]

OPTIONS

--sensitivity

Specify the unique identifier of the Sensitivity to which the ACE will be added.

--accessor

Specify the unique identifier of an Accessor to whom the access types will apply.

--access_types

Specify the access types string for the Accessor.

EXAMPLES

beectl add_sensitivity_ace --sensitivity acsn=MySensitivity,wksp=MyWorkspace,enpr=MyEnterprise --accessor user=MyUser --access_types +RW-D

add_team_workspace

Creates a team workspace from a template

SYNTAX

beectl add_team_workspace --name <Workspace name> --scope <Identifier of enterprise or organization> [--template <Workspace template identifier>] [--file <Full path of the input file>]  [--email_address <Team workspace email address>] [--description <Description>][--participation_mode <Team workspace participation mode. Value can be INVITE_ONLY, OPEN, or APPROVE_REQUIRED>] [--directory_listed <TRUE|FALSE. Default value is FALSE>] [--hard_quota <Hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota> --soft_quota <Soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>] [--public_access_role <Role definition identifier for public access>]

OPTIONS

--name

Workspace name

--scope

Identifier of enterprise or organization

--template

Workspace template identifier

--file

Full path of the input file

--email_address

Team workspace email address

--description

Description

--participation_mode

Team workspace participation mode. Value can be INVITE_ONLY, OPEN, or APPROVE_REQUIRED

--directory_listed

TRUE|FALSE. Default value is FALSE

--hard_quota

Hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota

--soft_quota

Soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota

--public_access_role

Role definition identifier for public access. If not specified, the team workspace to create is not for public access

EXAMPLES

beectl add_team_workspace --scope enpr=test_enterprise --name My_Team_worksapce --hard_quota UNLIMITED --soft_quota 100

beectl add_team_workspace --scope orgn=test_org,enpr=test_enterprise --template wstp=test_team_ws_template,enpr=test_enterprise --file /tmp/input.xml --hard_quota 1000 --soft_quota 100 --email_address teamworkspace@company.com

add_team_workspace_template_application

Transforms the given team workspace to conform to the given team workspace template

SYNTAX

beectl add_team_workspace_template_application --template <Workspace template identifier> --workspace <Workspace identifier> --file <Full path of the template file>

OPTIONS

--template

Workspace template identifier

--workspace

Workspace identifier

--file

Full path of the input file

EXAMPLES

beectl add_team_workspace_template_application --template wstp=test_team_ws_template,enpr=test_enterprise --workspace wksp=test_team_ws,enpr=test_enterprise --file /tmp/template_variable_values.xml

add_team_workspace_template_evolution

Applies the latest snapshot of the given team workspace template to all the team workspaces to which the template was applied earlier

SYNTAX

beectl add_team_workspace_template_evolution --template <Workspace template identifier> --limit <Maximum number of workspaces to upgrade> --file <Full path of the template file>

OPTIONS

--template

Workspace template identifier

--limit

Maximum number of workspaces to upgrade

--file

Full path of the input file

EXAMPLES

beectl add_team_workspace_template_evolution --template wstp=test_team_ws_template,enpr=test_enterprise --limit 100 --file /tmp/template_variable_values_and_update_options.xml

add_trusted_identity

This command registers a trusted identity. There are two types of trusted identities: WSSEC and SES. Default type is WSSEC. For WSSEC type, please make sure that the service has a valid certificate registered in the wallet and the correct associated key alias is passed into this command. This command also creates the principal(s) associated with this trusted identity in the Beehive system. On the other hand, for SES type, this command stores the given trusted identity name and password information.

SYNTAX

beectl add_trusted_identity  [--type WSSEC --is_service <boolean> [--key_alias <Key Alias>] --service_name <Trusted Identity Name>] [--type S2S --password <Trusted Identity Password> --service_name <Trusted Identity Name>] [--type SES --name <Trusted Entity Name> --password <Trusted Entity Password>]

OPTIONS

--key_alias

The alias of the service which is used to register the certificate in the wallet. This option is mandatory if registering a web service, i.e. if is_service is true and type is WSSEC. For all other cases, this is not a mandatory option.

--is_service

Boolean value, true if this is a service. This option is mandatory if type is WSSEC.

--service_name

String value of the service principal name with which it will be identified in Beehive. This option is mandatory if type is WSSEC.

--type

String value indicating the type of trusted identity: SES or WSSEC.SES refers to Secure Enterprise Search. WSSEC refers to Web services security.

--name

String value representing the name of the SES trusted entity.

--password

Secure string value representing the password of the SES trusted entity.

EXAMPLES

add_urm

Configures an agent for a URM instance.

SYNTAX

beectl add_urm --rm_admin_name <RM Admin Name for the URM instance.>  --rm_admin_password <RM Admin Pass for the URM instance.>  --urm_url <The URL for the URM instance.> --rm_email_admin <Email Id of the RM administrator.> [ --disposition_loader_interval <The Disposition Loader Interval for the URM instance.> ] [ --disposition_processor_interval <The Disposition Processor Interval for the URM instance.> ] [ --agent_name <The Agent Name for the URM instance.> ]

OPTIONS

--rm_admin_name

RM Admin Name for the URM instance.

--rm_admin_password

RM Admin Pass for the URM instance.

--urm_url

The URL for the URM instance.

--disposition_loader_interval

The Disposition Loader Interval for the URM instance.

--disposition_processor_interval

The Disposition Processor Interval for the URM instance.

--agent_name

The Agent Name for the URM instance.

--rm_email_admin

Email Id of the RM administrator.

EXAMPLES

beectl add_urm --rm_admin_name myRmAdminName --rm_admin_password myRmAdminObfuscatedPassword --urm_url myUrmUrl --disposition_loader_interval myDispositionLoaderInterval --disposition_processor_interval myDispositionProcessorInterval --agent_name myAgentName --rm_email_admin 2312:2525:user:25252AB25215515155

add_user

The add_user command adds new users. The user information is supplied either on command line or in an XML file.

SYNTAX

beectl add_user    {        --family_name <[locale:]family name>        [ --family_name <[locale:]family name> ... ]        --scope <identifier of users parent>        --login_id <login_id>        --login_password <password>        [ --given_name <[locale:]given name> ... ]        [ --display_name <[locale:]display name> ... ]       [ --middle_name <[locale:]middle name> ... ]       [ --job_title <[locale:]job title> ... ]       [ --prefix <[locale:]prefix> ... ]        [ --suffix <[locale:]suffix> ... ]        [ --nick_name <[locale:]nick name> ... ]        [ --office_location <office location of the user> ]        [ --company <company of the user> ]        [ --profession <profession of the user> ]        [ --timezone <timezone of the user> ]        [ --locale <locale of the user> ]        [ --department <department of the user> ]        [ --assistant <assistant identifier> ]        [ --manager <manager identifier> ]        [ --organization <organization identifier> ... ]        [ --voice_principal <voice devicenumber> ]        [ --voice_pin <pin> ]        [ --property <name=value=description> ... ]        [ --protocol_principal <protocol principal> ]        [ --protocol_password <protocol password> ]        [ --address <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ]        [ --default_address_for_type <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ]        [ --default_address_for_scheme <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ]        [ --primary_address <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ]        [ --external_inbox <true|false> ]        [ --extended_enterprise_user <true|false> ]      |         --file <filename>   }

OPTIONS

--family_name

Family name of the user in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--scope

Identifier of the enterprise or organization under which this user will be created.

--given_name

Given name of the user in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--display_name

Display name of the user in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--middle_name

Middle name of the user in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--job_title

Job title of the user in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--prefix

Prefix of the user in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--suffix

Suffix of the user in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--nick_name

Nick name of the user in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--office_location

Office location of the user.

--company

Company of the user.

--profession

Profession of the user.

--timezone

Timezone of the user. list_timezones lists the valid timezones

--locale

Locale details of the user. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--department

Department of the user.

--assistant

Identifier of the assistant.

--manager

Identifier of the manager.

--organization

Identifiers of the organizations the user belongs to.

--property

Details of the property in the format name=value=description. Any custom property can be used. Note, no equals to symbol(=) should be present in the name or value or description.

--address

Address of the user in the format type:scheme:value. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.

--default_address_for_type

Address of the user in the format type:scheme:value. Sets the specified address as the default for the specified type. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.

--default_address_for_scheme

Address of the user in the format type:scheme:value. Sets the specified address as the default for the specified scheme. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.

--primary_address

Primary address of the user in the format type:scheme:value. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.

--login_id

The login credentials of the user.

--login_password

Login password.

--voice_principal

Voice principal of the user.

--voice_pin

Pin number for the voice device.

--protocol_principal

Protocol principal of the user.

--protocol_password

Protocol password.

--file

Name of the file, which contains user information in XML format.

--external_inbox

Boolean if user's inbox is external or not.

--extended_enterprise_user

Boolean if user is an external user or not.

EXAMPLES

beectl add_user --family_name User1FamilyName --login_id user@example.com --login_password hioquery731419== --scope enpr=example --obfuscated

beectl add_user --family_name User1FamilyName --login_id user@example.com --login_password hioquery731419== --scope enpr=example --given_name User1GivenName --display_name "User1 Name" --organization orgn=beehive1,enpr=oracle1 --obfuscated

beectl add_user --family_name User1FamilyName --login_id user@example.com --login_password hioquery731419== --scope enpr=example --address BUSINESS_1:mailto:example@example.com --address BUSINESS_2:fax:121345222 --obfuscated

beectl add_user --family_name User1FamilyName --login_id user@example.com --login_password hioquery731419== --scope enpr=example --property notes=xxx --obfuscated

beectl add_user --family_name User1FamilyName --login_id user@example.com --login_password hioquery731419== --scope enpr=example --extended_enterprise_user true --obfuscated

beectl add_user --file Users.xml

add_user_subscription

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

SYNTAX

beectl add_user_subscription --source_entity_class <sourceEntityClass of template> --rule <rule name> --attach <identifier of attached entity> --subscriber <identifier of subscriber>

OPTIONS

--source_entity_class

Specify the name of the source entity Class that is defined in subscription template.

--rule

"multiline"> <message fined rule or the rule statement. The format of rule statement is: RULE_STATEMENT:CONDITION:attribute1=value1,attribute2=value2, ...attribute=value,ACTION:attribute1=value1,attribute2=value2, ...attribute=value

--attach

Specify the Identifier of the entity to which the subscription is attached.

--subscriber

Specify the identifier of the subscriber who owns the subscription.

--name

Specify the name of the subscription to be created.

EXAMPLES

beectl add_user_subscription --source_entity_class Invitation --attach 5457:7954:clnd:5B5DB5E3F6652295E040578C92165D03000000006740 --subscriber user=user1 --rule NOTIFY_ON_ANY_UPDATED_INVITATION

beectl add_user_subscription --source_entity_class Message --attach 5457:7954:wspr:5B5DB5E3F6652295E040578C92165D03000000000456 --subscriber user=user1 --name MyServerSideRule_1 --rule RULE_STATEMENT:CONDITION:created_any_from_contains=beehive,created_any_subject_contains=build,ACTION:move_to=5457:7954:afrh:5B5DB5E3F6652295E040578C92165D03000000000440,forward_to=test.user@oracle.com

add_version_configuration

Creates a version configuration on the given scope or heterogenous folder.

SYNTAX

beectl add_version_configuration --container <Configuration scope or heterogenous folder> --file <Full path of the configuration XML file>

OPTIONS

--container

Scope or heterogenous folder on which the version configuration should be defined.

--file

Full path of the version configuration XML file. The file must contain properly formatted data.

EXAMPLES

beectl add_version_configuration --container orgn=MyOrganization,enpr=MyEnterprise --file /tmp/configuration.xml

add_virus_scan_engine

Adds a new virus scan engine to the collection of engines configured for the Site. If this is the first scan engine being added, this command will create a new collection for the Site and add the virus scan engine to it.

SYNTAX

beectl add_virus_scan_engine [ --hostname <scanengine_hostname> ] [ --port <scanengine_port> ] [ --validate_connection <true/false> ]

OPTIONS

--hostname

Name of the host where the virus scan engine is installed. Default is localhost.

--port

Port number used by the virus scan engine for communication with its clients. Default is 1344.

--validate_connection

Indicates if the connection to the virus scan engine needs to be validated.

EXAMPLES

<beectl add_virus_scan_engine --hostname scanenginehost.example.com --port 1344 --validate_connection true>

add_voice_facility

Creates a voice facility by associating phone rules with an already created group. The command may be run multiple times and each new execution will append new rules to existing rules for a given group collabid.

SYNTAX

beectl add_voice_facility --group_collabid <collabid> [--include <phone rules>] [--exclude <phone rules>]

OPTIONS

--group_collabid

The collabid of the group to associate with the given phone number rules.

--include

The collection of phone number rules to describe what phone numbers to include in the given facility. The rules are delimited by pipes.

--exclude

The collection of phone number rules to describe what phone numbers to EXCLUDE in the given facility. The rules are delimited by pipes.

EXAMPLES

beectl add_voice_facility --group_collabid grup=GroupName,enpr=MyEnterprise --include 1312???????|1713??????? --exclude 13129??????|17139??????

append_value

Appends the specified value to the existing value of the named property. If the named property value is cleared before executing this command, then after executing this command it will contain the new value.

Note :- Option value should not start with hyphen(-). If an option value starts with hyphen, use any one of the following syntaxes. 1. Use <option-name>=<option value> format. This is the preferred way to specify the option values starting with hypens. 2. Prepend the option value with string "ESCAPE:". 3. Prepend the option value with backslash "\\". This is the least preferred way. This may not work in some platforms, esp in windows platforms it will not work.

SYNTAX

beectl append_value --component <system object identifier or alias> --name <name> --value <value>...

OPTIONS

--component

component id.

--name

Name of the property.

--value

Value of the property.

EXAMPLES

The command execution below would modify the log level for code in module oracle.ocs.commandline to FINEST and code in module oracle.ocs.management to FINE. These new settings are appended to existing list of package names in the ModuleLogLevel property of the LoggingProperties config object in current site. If the ModuleLogLevel property was cleared before executing this command, then it will contain the new values now.

beectl append_value --component _CURRENT_SITE:LoggingProperties --name "ModuleLogLevel" --value "oracle.ocs.commandline:FINEST" --value "oracle.ocs.management:FINE"

clear_calendar_permissions

Modify access permissions for grantee (user or group) on the specified calendar.

SYNTAX

beectl clear_calendar_permissions  { --calendar <calendarid> | --calendarowner <unique_identifier> | --select_by_address <uri> | --select_by_authuser <authuser> | --select_by_user_name <user_name> | --select_by_resource_name <resource_name> | --select_by_workspace_name <workspace_name> } [--user <userid> | --group <groupid>]

OPTIONS

--calendar

Specify the unique identifier of a calendar.

--calendarowner

Specify the unique identifier of a user, resource or workspace.

--select_by_address

Specify the Uniform Resource Identifier (URI) of a user, resource or team workspace using the format '[scheme:]value'. If 'scheme:' is not supplied, mailto will be used.

--select_by_authuser

Specify the login name of a user.

--select_by_user_name

Specify the name of a user.

--select_by_resource_name

Specify the name of a resource.

--select_by_workspace_name

Specify the name of a team workspace.

--user

Specify the unique identifier of the user (grantee).

--group

Specify the unique identifier of the group (grantee).

EXAMPLES

beectl clear_calendar_permissions --calendarowner user1@example.com --user user=user2

clear_proposed_configuration

Clears proposed configuration of the Beehive system object model

SYNTAX

beectl clear_proposed_configuration

OPTIONS

This command has no options

EXAMPLES

beectl clear_proposed_configuration

clear_tasklist_permissions

Reset the access permissions of a tasklist to their out-of-box defaults.

SYNTAX

beectl clear_tasklist_permissions  { --tasklist <tasklistid> | --tasklistowner <unique_identifier> | --select_by_address <uri> | --select_by_authuser <authuser> | --select_by_user_name <user_name> | --select_by_resource_name <resource_name> | --select_by_workspace_name <workspace_name> } [--user <userid> | --group <groupid>]

OPTIONS

--tasklist

Specify the unique identifier of a tasklist.

--tasklistowner

Specify the unique identifier of a user, resource or team workspace.

--select_by_address

Specify the Uniform Resource Identifier (URI) of a user, resource or team workspace using the format 'scheme:value'. If scheme is not supplied, mailto is assumed.

--select_by_authuser

Specify the login name of a user.

--select_by_user_name

Specify the name of a user.

--select_by_resource_name

Specify the name of a resource.

--select_by_workspace_name

Specify the name of a team workspace.

--user

Specify the unique identifier of the target user.

--group

Specify the unique identifier of the target group.

EXAMPLES

beectl clear_tasklist_permissions --tasklistowner user1@example.com --user user=user2

clone_midtier

Top level clone command that clones a mid-tier.

SYNTAX

beectl clone_midtier --ias_instance_name <ias instance name > --host_name <host name> --db_schema_password <db schema password> [--oui_inv_ptr_loc <oui data>]  [--oracle_home_name <oracle home name>] [--do_not_start_at_end] --site_key <Site key> [--ignore_validation_warnings]

OPTIONS

--ias_instance_name

Ias instance name with out appending host name. For example "myinstance"

--host_name

Fully qualified host name of the new midtier.

--db_schema_password

Beehive database schema password.

--oui_inv_ptr_loc

Oracle inventory pointer location file. Location of Oracle inventory is present in this file. If not specified, a platform default value (/etc/oraInst.loc on Linux) is checked. If the platform default value does not exists, then Oracle Inventory is created in user's home directory.

--oracle_home_name

Oracle home name. The default value is the value for --ias_instance_name option.

--do_not_start_at_end

If specified, beehive components will not be started at the end.

--site_key

Site key value.

--ignore_validation_warnings

If specified, commands using validation framework will ignore the warnings and continue.

EXAMPLES

beectl clone_midtier --ias_instance_name MyIASInstance --host_name machine1.example.com --db_schema_password dbbeehiveschemapassword --site_key <Site key>

If --ignore_validation_warnings is also specified, warnings from validation framework will be ignored and command execution will continue.

clone_oc4j_instance

Creates a new oc4j instance by cloning the given oc4j instance.

Most of properties of the newly created oc4j instance is similar to that of the source oc4j instance.

All the service instance present in the source oc4j instance system model is deployed into the newly cloned oc4j instance.

Further, after deploying all the service instances, newly cloned oc4j instance is bouned once.

Only Beehive oc4j instances should be cloned using this command. Non Beehive oc4j instances can't be cloned using this command

Beehive Management oc4j instance should not be cloned. This command will error out when management oc4j instance is cloned.

When a template is associated with the Beehive instance, then target oc4j name can't be specified and disable_sizing option should be specified.

SYNTAX

beectl clone_oc4j_instance [--source_oc4j_instance_id <source oc4j instance system model id> | --source_oc4j_instance_name <source oc4j instance name>] [--target_oc4j_instance_name <target oc4j instance name>] [--disable_sizing] [--cold_mode]

OPTIONS

--source_oc4j_instance_id

Source oc4j instance system model id.

--source_oc4j_instance_name

Source oc4j instance name.

--target_oc4j_instance_name

Target oc4j instance name.

--disable_sizing

Disable sizing.

--cold_mode

Clone the target oc4j instance in cold mode. Target oc4j instance will be started only at the end of flow.

EXAMPLES

beectl clone_oc4j_instance --source_oc4j_instance_name BEEAPP --target_oc4j_instance_name BEEAPP_CLONE

beectl clone_oc4j_instance --source_oc4j_instance_name BEEAPP --disable_sizing

clone_patching

Upgrades the midtier by cloning.

SYNTAX

beectl clone_patching ([--old_oracle_home <old oracle home>] |[--local_beehive_instance_id <local beehive instance id > --db_schema_password <schema password > --site_key <Site key > ])[--oui_inv_ptr_loc <oui data >] [--start_at_end] [--ignore_validation_warnings]

OPTIONS

--old_oracle_home

Specify the old oracle home.

--local_beehive_instance_id

Local beehive instance system object id.

--db_schema_password

Password to connect to config database.

--site_key

Site key value.

--oui_inv_ptr_loc

Oracle inventory pointer location file. Location of Oracle inventory is present in this file. If not specified, a platform default value (/etc/oraInst.loc on Linux) is checked. If the platform default value does not exists, then Oracle Inventory is created in user's home directory.

--start_at_end

If specified, beehive components will be started at the end.

--ignore_validation_warnings

If specified, commands using validation framework will ignore the warnings and continue.

EXAMPLES

beectl clone_patching local_beehive_instance_iddb_schema_password instance1.machibe-b.example.com local_beehive_instance_idsite_key <secure value> local_beehive_instance_id{5} <secure value>

If --ignore_validation_warnings is also specified, warnings from validation framework will be ignored and command execution will continue.

clone_preparation

Prepares the existing oracle home for cloning.

SYNTAX

beectl clone_preparation --file <output file name> [--ignore_validation_warnings]

OPTIONS

--file

Fully qualified name of the file which will store the list of files to be cloned. This files has to be outside the oracle home.

--ignore_validation_warnings

If specified, commands using validation framework will ignore the warnings and continue.

EXAMPLES

beectl clone_preparation --file /tmp/clone-list.txt

If --ignore_validation_warnings is also specified, warnings from validation framework will be ignored and command execution will continue.

clone_site

Top level clone command that clones a mid-tier in a new deployment (i.e., site). This command is part of the Deployment Cloning solution. Please see the administrator guide for details.

SYNTAX

beectl clone_site --ias_instance_name <ias instance name > --host_name <host name> --db_schema_password <db schema password> --db_connect_string <db connect String>  [--oui_inv_ptr_loc <oui data>] [--db_schema_name <db schema name>]  [(--db_rac_node_information <XA Service name>) ...] [(--db_xa_service_name <rac node information>) ...] [--retain_rac_node_information] [--oracle_home_name <oracle home name>]  [--do_not_start_at_end] [--site_name <New site name>] --site_key <Site key> [--ignore_validation_warnings]

OPTIONS

--ias_instance_name

Ias instance name with out appending host name. For example "myinstance"

--host_name

Fully qualified host name of the new midtier.

--db_connect_string

Beehive database connect string.

--db_schema_password

Beehive database schema password.

--db_schema_name

Beehive database schema name.

--db_rac_node_information

Beehive database RAC node information. It should be of the format hostname:port. For eg sample.com:1521

--db_xa_service_name

Beehive database XA service name.

--retain_rac_node_information

Retains the old rac node and ons information. By default old rac node information is removed.

--oracle_home_name

Oracle home name. The default value is the value provided for --ias_instance_name option.

--oui_inv_ptr_loc

Oracle inventory pointer location file. Location of Oracle inventory is present in this file. If not specified, a platform default value (/etc/oraInst.loc on Linux) is checked. If the platform default value does not exists, then Oracle Inventory is created in user's home directory.

--do_not_start_at_end

If specified, beehive components will not be started at the end.

--site_name

New site name

--site_key

Site key value.

--ignore_validation_warnings

If specified, commands using validation framework will ignore the warnings and continue.

EXAMPLES

beectl clone_site --ias_instance_name MyIASInstance --host_name machine1.example.com --db_schema_password dbbeehiveschemapassword --db_connect_string "(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=machine2.example.com)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=oracle))" --db_schema_name MySchema --retain_rac_node_information --site_key <site key>

If --ignore_validation_warnings is also specified, warnings from validation framework will be ignored and command execution will continue.

delete_assigned_role

Deletes an AssignedRole entity.

SYNTAX

beectl delete_assigned_role --assigned_role <unique identifier of the AssignedRole>

OPTIONS

--assigned_role

Specify the unique identifier of the AssignedRole to be deleted.

EXAMPLES

beectl delete_assigned_role --assigned_role acar=MyAssignedRole,wksp=MyWorkspace,enpr=MyEnterprise

delete_attendant

Deletes an auto attendant by name.

SYNTAX

beectl delete_attendant --name <name of attendant>

OPTIONS

--name

Name of the attendant to delete.

EXAMPLES

beectl delete_attendant --name my_attendant

delete_attendant_prompt

Deletes a prompt.

SYNTAX

beectl delete_attendant_prompt --name <attendant name> --type <prompt type> --language <prompt language>

OPTIONS

--name

Name of the attendant to which the prompt belongs.

--type

The type of the prompt. Can be one of language, menu, greeting, extension-prompt, extension-nomatch, option1, option2, option3, option4, option4, option5, option6, option7, option8, option9, noinput, noinput-term, nomatch, nomatch-term.

--language

The language of the prompt.

EXAMPLES

beectl delete_attendant_prompt --name myAttendant --type greeting --language en_US

beectl delete_attendant_prompt --name myAttendant --type language

delete_audit_policy

Deletes an existing audit

SYNTAX

beectl delete_audit_policy --policy <Audit policy identifier>

OPTIONS

--policy

Audit policy identifier

EXAMPLES

beectl delete_audit_policy --policy plcy=MyAuditPolicy

delete_audit_trail

Deletes an existing audit trail

SYNTAX

beectl delete_audit_trail --trail <Audit trail identifier>

OPTIONS

--trail

Audit trail identifier

EXAMPLES

beectl delete_audit_trail --trail autr=MyAuditTrail

delete_category

Deletes a category and all category applications.

SYNTAX

beectl delete_category --category <Identifier of the category to be deleted>

OPTIONS

--category

Specify the identifier of the category.

EXAMPLES

beectl delete_category --category catg=Resource_US,catg=Resource_ROOT,enpr=bee_ent

delete_category_application

Removes a category from an entity

SYNTAX

beectl delete_category_application --category <Identifier of the category to be removed>  --entity <Identifier of the entity from which the category needs to be removed>

OPTIONS

--category

Specify the identifier of the category to be removed.

--entity

Specify the identifier of an Oracle Beehive entity from which the category needs to be removed.

EXAMPLES

beectl delete_category_application --category catg=MyCategory,enpr=MyEnterprise --entity adoc=MyDocument,fldr=MyFolder,wksp=MyWorkspace,enpr=MyEnterprise

delete_category_configuration

Deletes a given category configuration.

SYNTAX

beectl delete_category_configuration --configuration <Configuration identifier>

OPTIONS

--configuration

Category configuration to be deleted.

EXAMPLES

beectl delete_category_configuration --configuration 9941:2345:ctcf:58D193D162CE4ED89FF66AB4E55745B6345464545453

delete_client_application

Deletes a client application.

SYNTAX

beectl delete_client_application --application <identifier of the client application>

OPTIONS

--application

Specify the identifier of the client application. Use list_client_applications command to determine the identifier of the client application.

EXAMPLES

beectl delete_client_application --application 1234:5678:capn:2E0329B0705F0E40E040578C92160957000000000434

delete_client_application_configuration

Deletes the client application configuration with the given identifier.

SYNTAX

beectl delete_client_application_configuration --configuration <identifier of the client application configuration>

OPTIONS

--configuration

Specify the identifier of the client application configuration.

EXAMPLES

beectl delete_client_application_configuration --configuration 1234:5678:capc:2E0329B0705F0E40E040578C92160957000000000434

delete_client_application_patchset

Deletes a client application patchset.

SYNTAX

beectl delete_client_application_patchset --patchset <identifier of the client application patchset>

OPTIONS

--patchset

Specify the identifier of the client application patchset. Use list_client_application_patchsets command to determine the identifier of a client application patchset.

EXAMPLES

beectl delete_client_application_patchset --patchset 1234:5678:capp:2E0329B0705F0E40E040578C92160957000000000434

delete_client_application_provisioning

De-provisions client applications from a community.

SYNTAX

beectl delete_client_application_provisioning --community <community identifier> {--configuration <client application configuration identifier>... | --all}

OPTIONS

--community

Specify the identifier of the community.

--configuration

Specify the identifier of the client application configuration. This option can be specified more than once.

--all

Specify this option to deprovision any client applications provisioned earlier. The users belonging to this community would get the applications provisioned at the parent community level.

EXAMPLES

beectl delete_client_application_provisioning --community enpr=myEnterprise --configuration 1234:5678:capc:2E0329B0705F0E40E040578C92160957000000000434 --configuration 1234:5678:capc:2E0329B0705F0E40E040578C92160957000000000434

beectl delete_client_application_provisioning --community enpr=myEnterprise --all

delete_client_application_version

Deletes a client application version.

SYNTAX

beectl delete_client_application_version --application_version <identifier of the client application version>

OPTIONS

--application_version

Specify the identifier of the client application version. Use list_client_application_versions command to determine the identifier of a client application version.

EXAMPLES

beectl delete_client_application_version --application_version 1234:5678:capv:2E0329B0705F0E40E040578C92160957000000000434

delete_coexistence_profile

Deletes the coexistence profile of user.

SYNTAX

beectl delete_coexistence_profile {--user <user_identifier>|--email <user_email>|--file <file_name>}

OPTIONS

--user

Specify the identifier of the user.

--email

Specify the email address of the user.

--file

Specify the xml input file. File encoding MUST be UTF-8.

EXAMPLES

beectl delete_coexistence_profile --user user=userid

beectl delete_coexistence_profile --file users.xml

delete_coexistence_system

Deletes a coexisting remote system. WARNING: This command will purge the coexisting remote system and clean all related data.

SYNTAX

beectl delete_coexistence_system --select_by_name <connector_name>

OPTIONS

--select_by_name

Specify the name of the coexisting remote system.

EXAMPLES

beectl delete_coexistence_system --select_by_name ex-101

delete_conference

Deletes conference artifact under workspace

SYNTAX

beectl delete_conference --conference_id <Conference identifier>

OPTIONS

--conference_id

Conference identifier

EXAMPLES

beectl delete_conference --conference_id owch=MyConference,wksp=MyWorkspace,enpr=MyEnterprise

delete_conference_template

Deletes conference template artifact under workspace

SYNTAX

beectl delete_conference_template --template_id <Conference identifier>

OPTIONS

--template_id

Conference identifier

EXAMPLES

beectl delete_conference_template --template_id owct=MyTemplate,wksp=MyWorkspace,enpr=MyEnterprise

delete_custom_user_property

The delete_custom_user_property command deletes a custom property. If there are multiple custom properties with same name, then only the first occurrence of the attribute with specified name is deleted. Any values of the property being deleted will also be deleted.

SYNTAX

beectl delete_custom_user_property --name <name>

OPTIONS

--name

Property name. Example: employeenumber.

EXAMPLES

beectl delete_custom_user_property --name employeenumber

delete_device

Deletes the device with the given identifier.

SYNTAX

beectl delete_device --device <identifier of the device>

OPTIONS

--device

Specify the identifier of the device. Use list_devices command to determine the identifier of the device.

EXAMPLES

beectl delete_device --device 1234:5678:devi:2E0329B0705F0E40E040578C92160957000000000434

delete_device_profile

Deletes the device profile or device profiles. The command can delete the device profile with the given identifier or with the given device profile name or delete the device profiles specified from the given file containing names of the device profiles. The command can also optionally delete all the device types associated with this device profile.

SYNTAX

beectl delete_device_profile {--profile <identifier of the device profile>|--profile_name <name of the device profile>|--file <file containing device profiles>} [--delete_device_types]

OPTIONS

--profile

Identifier of the device profile.

--profile_name

Name of the device profile.

--file

File containing the names of the device profiles. Specify the full path and file name.

--delete_device_types

Deletes all the device types associated with this device profile.

EXAMPLES

beectl delete_device_profile --profile 1234:5678:devp:2E0329B0705F0E40E040578C92160957000000000434

beectl delete_device_profile --profile 1234:5678:devp:2E0329B0705F0E40E040578C92160957000000000434 --delete_device_types

beectl delete_device_profile --profile_name "Device Profile Name" --delete_device_types

beectl delete_device_profile --file /tmp/deleted_profiles.txt --delete_device_types

delete_device_type

Deletes the device type with the given identifier.

SYNTAX

beectl delete_device_type --type <identifier of the device type>

OPTIONS

--type

Identifier of the device type.

EXAMPLES

beectl delete_device_type --type 1234:5678:devt:2E0329B0705F0E40E040578C92160957000000000434

delete_directory_profile

The delete_directory_profile command deletes a directory profile.

Changelog number for the directory profile is not deleted from beehive, unless the activate_configuration option is used. To delete the changelog number from beehive, run this command by specifying the common option activate_configuration with value as true.

The command deletes a directory profile if no users or groups are associated with the profile in beehive.

SYNTAX

beectl delete_directory_profile --profile <profile-name>

OPTIONS

--profile

Profile name to be deleted.

EXAMPLES

beectl delete_directory_profile --profile MyDirectoryProfile

delete_dmz_home_instance

Removes configuration for a Beehive installation in the DMZ that is, outside the firewall.

SYNTAX

beectl delete_dmz_home_instance --id <dmz beehive instance id>

OPTIONS

--id

Identifier for DMZ beehive instance.

EXAMPLES

beectl delete_dmz_home_instance --id dmz_on_server1

delete_email_message

Moves an email message to a target folder or removes it outright

SYNTAX

beectl delete_email_message --internet_message_id <The Message-ID header in  the MIME source of the message> [--email_address <The email address of the admin user account that the deleted message  should be moved to>] [--folder <The folder name of the admin user account that the deleted message should be moved to>]

OPTIONS

--internet_message_id

The Message-ID header in the MIME source of the message

--email_address

The email address of the admin user account that the deleted message should be moved to

--folder

The folder name of the admin user account that the deleted message should be moved to

EXAMPLES

beectl delete_email_message --internet_message_id 200602221113.k1MBDZDr020197@rgminet03.oracle.com --email_address user1@example.com --folder Recalled

delete_event_subscription

Deletes an event subscription from the Oracle Beehive repository.

SYNTAX

beectl delete_event_subscription --subscription <identifier of the event subscription to be deleted>

OPTIONS

--subscription

Specify the identifier of the event subscription to be deleted.

EXAMPLES

beectl delete_event_subscription --subscription 9941:2345:enpr:58D193D162CE4ED89FF66AB4E55745B6345464545453

delete_expertise_user_scope

The delete_expertise_user_scope command deletes expertise user scope. The expertise user scope CollabId/BODN is supplied with --expertise_user_scope option.

SYNTAX

beectl delete_expertise_user_scope --expertise_user_scope <BODN or CollabId>

OPTIONS

--expertise_user_scope

CollabId or BODN format of the expertise user scope to be deleted.

EXAMPLES

beectl delete_expertise_user_scope --expertise_user_scope exus=ExpertiseUserScopeName,enpr=Oracle

beectl delete_expertise_user_scope --expertise_user_scope 416E:25BF:exus:6A9CBED7822AA32EE040578C5C8453AB000000018705

delete_failed_action_events

Purge actions that have not completed successfully.

SYNTAX

beectl delete_failed_action_events --bucket <Partition number> --sequence <Sequence number>

OPTIONS

--bucket

Partition number

--sequence

Sequence number

EXAMPLES

beectl delete_failed_action_events --bucket MyBucketNumber --sequence MySequenceNumber

delete_feed_configuration

The delete_feed_configuration command deletes feed configuration.

SYNTAX

beectl delete_feed_configuration    {        --feed_configuration <feed configuration>      | --scope <scope identifier>       --feedtype <feed type >    }

OPTIONS

--feed_configuration

Collabid of the feed configuration to be modified

--scope

Scope in which the feed configuration will be created

--feedtype

Feed type of the feed configuration. Permitted values are ANNOUNCEMENT, FORUM, FOLDER, LABEL, RECENT, TOPIC and VERSION.

EXAMPLES

beectl delete_feed_configuration --scope enpr=example --feedtype RECENT

beectl delete_feed_configuration --feed_configuration 6790:39AC:afrf:52921E226193384EE040578C5C84269C0000000ABB75

delete_filesystem_reference

Removes a filesystem reference from Beehive.

SYNTAX

beectl delete_filesystem_reference --filesystem_reference_id <Identifier of the filesystem reference>

OPTIONS

--filesystem_reference_id

Identifier of the filesystem reference to delete.

EXAMPLES

beectl delete_filesystem_reference --filesystem_reference_id fsref=MyFilesystemReference,enpr=MyEnterprise

delete_group

The delete_group command deletes a group with an option to purge.

SYNTAX

beectl delete_group { --group <group_identifier> | --email <group_email> } [ --purge ]

OPTIONS

--group

Identifier of the group.

--email

EmailID of the group.

--purge

Purges the group after deletion.

EXAMPLES

beectl delete_group --group grup=MyGroup,enpr=Example

beectl delete_group --group grup=MyGroup,enpr=Example --purge

delete_ischedule_server

Delete a remote iSchedule Server configuration.

SYNTAX

beectl delete_ischedule_server --name <name>

OPTIONS

--name

Name of the remote server configuration, can contain only alpha numerical characters, underscores and dashes.

EXAMPLES

beectl delete_ischedule_server --name remoteserver

delete_local_ace

Deletes an Access Control Entry (ACE) from the Local Access Control List (LACL) of an entity.

SYNTAX

beectl delete_local_ace --entity <unique identifier of the entity> --accessor <unique identifier of the Accessor>

OPTIONS

--entity

Specify the unique identifier of the entity from which the ACE will be deleted.

--accessor

Specify the unique identifier of the accessor to whom the access types were applied.

EXAMPLES

beectl delete_local_ace --entity adoc=MyDocument,wksp=MyWorkspace,enpr=MyEnterprise --accessor user=MyUser

delete_oc4j_instance

Deletes the specified oc4j.

The command can delete an oc4j only if there are other oc4j instances of the same type. For example any of the oc4j instances BEEAPP, BEEAPP_1, BEEAPP_2 can be deleted however the last remaining oc4j instance of a type cannot be deleted otherwise the active deployment template is violated.

This command can be executed to delete either a local oc4j or a beekeeper home.

SYNTAX

beectl delete_oc4j_instance --component <system object id of oc4j>

OPTIONS

--component

Deletes the specified oc4j.

EXAMPLES

beectl delete_oc4j_instance --component 946189a0-bd98-4033-b342-7d51087ccc81

delete_organization

Deletes an existing organization, and sub-organizations and workspaces under it (with --force_cascade option). And/or purges deleted organization manually (with --purge option). Use list_deleted_organizations to get the CENs of deleted organizations.

SYNTAX

beectl delete_organization --organization <Organization identifier> [--purge] [--force_cascade]

OPTIONS

--organization

Organization identifier

--purge

Purge deleted organization manually

--force_cascade

Force deleting sub-organizations and workspaces under this workspace

EXAMPLES

beectl delete_organization --organization orgn=test_org,enpr=test_enterprise

delete_policy

Deletes a policy.

SYNTAX

beectl delete_policy --policy <identifier of the policy to be deleted>

OPTIONS

--policy

Specify the identifier of the policy to be deleted. Use the list_policies command to obtain the policy identifier.

EXAMPLES

beectl delete_policy --policy plcy=MyPolicy,enpr=MyEnterprise

delete_policy_action

Deletes a policy action.

SYNTAX

beectl delete_policy_action --action_name <name of action to be deleted>

OPTIONS

--action_name

Specify the name of the policy action to be deleted.

EXAMPLES

beectl delete_policy_action --action_name MyActionName

delete_policy_schema

Deletes a policy schema.

SYNTAX

beectl delete_policy_schema --policy_schema <identifier of the policy schema to be deleted>

OPTIONS

--policy_schema

Specify the identifier of the policy schema to be deleted.

EXAMPLES

beectl delete_policy_schema --policy_schema plsh=PolicySchemaName

delete_policy_template

Deletes a policy template.

SYNTAX

beectl delete_policy_template --policy_template <identifier of the policy template to be deleted>

OPTIONS

--policy_template

Specify the identifier of the policy template to be deleted.

EXAMPLES

beectl delete_policy_template --policy_template plct=PolicyTemplateName,enpr=oracle

delete_preference_profile

The delete_preference_profile command deletes a preference profile.

SYNTAX

beectl delete_preference_profile --profile <Preference profile identifier>

OPTIONS

--profile

Identifier of the preference profile to be deleted.

EXAMPLES

beectl delete_preference_profile --profile prfp=MyProfile,user=user1

delete_preference_property

The delete_preference_property command deletes a preference property from a preference set.

SYNTAX

beectl delete_preference_property --set <set-identifier> --name <property-name>

OPTIONS

--set

Identifier of the preference set specified in id format, which can be determined by running list_preference_sets command with "--entity_format id" option.

--name

Name of the preference property.

EXAMPLES

beectl delete_preference_property --set prfs=set1,user=user1 --name MyProperty

delete_preference_set

The delete_preference_set command deletes a preference set.

SYNTAX

beectl delete_preference_set --set <set-identifier>

OPTIONS

--set

Identifier of the preference set specified in id format, which can be determined by running list_preference_sets command with "--entity_format id" option.

EXAMPLES

beectl delete_preference_set --set prfs=set1,user=user1

delete_property

Clears the value of specified property in the configuration object identified by specified id.

SYNTAX

beectl delete_property --component <system object identifier or alias> --name <property name>

OPTIONS

--component

Identifier of a configuration object. The list_components command can be used to lookup the identifier

--name

The property to be cleared.

EXAMPLES

The command execution shown below would clear the value of Alias property of the current site.

beectl delete_property --component _CURRENT_SITE --name Alias

delete_record

"user-info">Command:non-record.

SYNTAX

beectl delete_record --artifact <identifier of the artifact to be deleted as a record/non-record>

OPTIONS

--artifact

identifier of the artifact to be deleted as a record/non-record

EXAMPLES

beectl delete_record --artifact myArtifact

delete_remote_home_instance

Deletes the specified beehive home from central configuration repository.

This command is a safeguard that will allow a beehive instance to be removed from the repository when no other uninstall options are available.

The command can only delete a remote home instance, ie, not the instance the command is being run from.

The command only cleans up the central configuration repository. It neither cleans up the disk/file system for the deleted beehive instance nor updates the oracle inventory on the remote host.

This command can be executed to delete either a non-local beehive home or a beekeeper home. To delete a dmz home please execute the command delete_dmz_home_instance

SYNTAX

beectl delete_remote_home_instance --component <system object id of remote home>

OPTIONS

--component

Deletes the specified beehive home from central configuration repository.

EXAMPLES

beectl delete_remote_home_instance --component 946189a0-bd98-4033-b342-7d51087ccc81

delete_remote_repository

Deletes a remote repository.

SYNTAX

beectl delete_remote_repository --scope <Remote Repository Container.> --name <Remote Repository Name.>

OPTIONS

--scope

Remote Repository Container.

--name

Remote Repository Name.

EXAMPLES

beectl delete_remote_repository --scope myRemoteRepositoryScope --name myRemoteRepositoryName

delete_remote_share

Deletes a remote share.

SYNTAX

beectl delete_remote_share --scope <Remote Share Container.> --name <Remote Share Name.>

OPTIONS

--scope

Remote Share Container.

--name

Remote Share Name.

EXAMPLES

beectl delete_remote_share --scope myRemoteShareScope --name myRemoteShareName

delete_resources

Deletes a resource.

SYNTAX

beectl delete_resources {--resource <resourceid> | --select_by_name <name>} [--external]

OPTIONS

--resource

Specify the identifier of the resource. Use list_resources command to obtain the identifier of the resource.

--select_by_name

Specify the name criteria of the resource.

--external

Delete an external resource. If this option is not specified, bookable resources will be deleted.

EXAMPLES

beectl delete_resources --resource 395A:346B:bkrs:2C5F7E98E076D382E040578CA60B0D0E000000062327

delete_role_definition

Deletes a RoleDefinition entity.

SYNTAX

beectl delete_role_definition --role_definition <unique identifier of the RoleDefinition>

OPTIONS

--role_definition

Specify the unique identifier of the RoleDefinition to be deleted.

EXAMPLES

beectl delete_role_definition --role_definition acrd=MyRoleDefinition,wksp=MyWorkspace,enpr=MyEnterprise

delete_sensitivity

Deletes a Sensitivity entity.

SYNTAX

beectl delete_sensitivity --sensitivity <unique identifier of the Sensitivity>

OPTIONS

--sensitivity

Specify the unique identifier of the Sensitivity to be deleted.

EXAMPLES

beectl delete_sensitivity --sensitivity acsn=MySensitivity,wksp=MyWorkspace,enpr=MyEnterprise

delete_sensitivity_ace

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

SYNTAX

beectl delete_sensitivity_ace --sensitivity <unique identifier of the Sensitivity> --accessor <unique identifier of the Accessor>

OPTIONS

--sensitivity

Specify the unique identifier of the Sensitivity from which the ACE will be deleted.

--accessor

Specify the unique identifier of the accessor to whom the access types were applied.

EXAMPLES

beectl delete_sensitivity_ace --sensitivity acsn=MySensitivity,wksp=MyWorkspace,enpr=MyEnterprise --accessor user=MyUser

delete_trusted_identity

This command unregisters a trusted identity. If the type of identity is not specified, it is defaulted to WSSEC.

SYNTAX

beectl delete_trusted_identity [--type WSSEC --service_name <Trusted Identity Name>] [--type S2S --service_name <Trusted Identity Name>] [--type SES --name <Trusted Entity Name>]

OPTIONS

--service_name

String value of the service principal name with which it will be identified in Beehive. This option is mandatory if type is WSSEC.

--type

String value indicating the type of trusted identity: SES or WSSEC.SES refers to Secure Enterprise Search. WSSEC refers to Web services security.

--name

String value representing the name of the SES trusted entity.

EXAMPLES

delete_user

The delete_user command deletes a user with an option to purge.

SYNTAX

beectl delete_user { --user <user_identifier> | --email <user_email> } [ --purge ]

OPTIONS

--user

Identifier of the user. When purging an already deleted user, the user must be specified in id format. The value in id format can be determined by running list_users command as: list_users --attribute_name STATUS --attribute_type ATTRIBUTE --attribute_value DELETED --entity_format id.

--email

EmailID of the user.

--purge

Purges the user after deletion.

EXAMPLES

beectl delete_user --user user=user1

beectl delete_user --user user=user1 --purge

delete_version_configuration

Deletes a given version configuration.

SYNTAX

beectl delete_version_configuration --configuration <Configuration identifier>

OPTIONS

--configuration

Version configuration to be deleted.

EXAMPLES

beectl delete_version_configuration --configuration 9941:2345:avcg:58D193D162CE4ED89FF66AB4E55745B6345464545453

delete_virus_scan_engine

Deletes specified virus scan engine from the collection of engines configured for the Site. If this is the last scan engine being deleted, this command will also delete the virus scan engine collection and update the Site to remove the virus scan engine collection from it. Either the scan_engine option or the hostname and port options will need to be specified.

SYNTAX

beectl delete_virus_scan_engine { --scan_engine <scanengine_systemid> | { --hostname <scanengine_hostname> --port <scanengine_port> }}

OPTIONS

--scan_engine

Identifier of the scan engine to be deleted.

--hostname

Name of the host where the virus scan engine is installed.

--port

Port number used by the virus scan engine for communication with its clients.

EXAMPLES

<beectl delete_virus_scan_engine --scan_engine 12345>

<beectl delete_virus_scan_engine --hostname scanenginehost.example.com --port 1344>

delete_virus_scan_results

Deletes virus scan results from the system that match the specified criteria. Option scandate cannot be specified with options scandate_from or scandate_to.

SYNTAX

beectl delete_virus_scan_results [ [ --scandate <scandate> ] | [ --scandate_from <scandate_from> ] [ --scandate_to <scandate_to> ] ] [ --virus_name <virus_name> ] [ --virus_id <virus_id> ] [ --entity_type <entity_type> ] [ --obsolete_only <true/false> ]

OPTIONS

--scandate

Value specified will be used to do an exact match with the scan date attribute of the scan results.

--scandate_from

Value specified will be used as the lower inclusive bound for matching with the scan date.

--scandate_to

Value specified will be used as the upper inclusive bound for matching with the scan date.

--virus_name

Value specified will be used to do an exact match with the virus name attribute of the scan results.

--virus_id

Value specified will be used to do an exact match with the virus id attribute of the scan results.

--entity_type

Value specified will be used to pick up only the scan results for the entered entity type.

--obsolete_only

This option returns matches found for the specified criteria only for those entities that are obsolete, i.e. these entities no longer exists in the system.

EXAMPLES

<beectl delete_virus_scan_results --scandate_from 2008-07-10T00:00:00 --scandate_to 2008-07-10T23:59:59>

delete_voice_facility

Removes specific rules or all rules for a given group collabid. To remove specific rules, then the list the rules to remove in the parameter options. To remove all rules only specify the collabid

SYNTAX

beectl delete_voice_facility --group_collabid <group_collabid> [--include <phone rules>] [--exclude <phone rules>]

OPTIONS

--group_collabid

The collabid of the Group to have all of its rules deleted.

--include

The collection of inclusion phone number rules to remove from the given facility. The rules are delimited by pipes.

--exclude

The collection of exclusion phone number rules to remove from the given facility. The rules are delimited by pipes.

EXAMPLES

beectl delete_voice_facility --group_collabid grup=GroupName,enpr=MyEnterprise --include 1312???????|1713??????? --exclude 13129??????|17139??????

delete_xmpp_chat_rooms

This command is used to delete an xmpp chat room by name (if it exists, else it is a NOOP) specified by the --roomname option. Room-names are case insensitive. This command can also be used to delete those xmpp chat rooms which have not been accessed for a period of days specified by the --olderthan option.

SYNTAX

beectl delete_xmpp_chat_rooms [--olderthan|--roomname] <Number of days/Room Name>

OPTIONS

--olderthan

Number of days/Room Name

--roomname

Number of days/Room Name

EXAMPLES

beectl delete_xmpp_chat_rooms --olderthan 60 OR beectl delete_xmpp_chat_rooms --roomname "Oracle Beehive Rocks"

download_device_logs

Downloads the logs for a device. This command can either download all log files for a device or all log files for a given application on the device or a particular log file.

SYNTAX

beectl download_device_logs --dest_dir <destination directory> {--device_log <identifier of the device log> | --device <identifier of the device> {--all|--application_name <name of the application> [--log_file_name <name of the log file>]}}

OPTIONS

--dest_dir

Specify the full path of the destination directory. The directory must already exist.

--device_log

Specify the identifier of the device log. Use list_device_logs command to determine the identifier of the device log.

--device

Specify the identifier of the device. Use list_devices command to determine the identifier of the device.

--all

Specify this option to download all the log files for this device.

--application_name

Application Name

--log_file_name

Log File Name

EXAMPLES

beectl download_device_logs --dest_dir /tmp --device 1234:5678:devi:2E0329B0705F0E40E040578C92160957000000000434 --application_name MobileMail --log_file_name log.txt

download_generated_team_workspace_template

Generates a team workspace template from the given team workspace

SYNTAX

beectl download_generated_team_workspace_template --workspace <Workspace identifier> --file <Full path of the template file>

OPTIONS

--workspace

Workspace identifier

--file

Full path of the input file

EXAMPLES

beectl download_generated_team_workspace_template --workspace wksp=test_team_ws,enpr=test_enterprise --file /tmp/template_attributes_and_selective_generation_options.xml

download_language_pack

Exports language pack resources managed by the Beehive deployment. The exact resources exported and the output destination details are controlled by command options.

SYNTAX

beectl download_language_pack [ --full ] [ --only_built_in ] [ --only_custom ] [ --include_class_files ] [ --destination_file <dest_file> ] [ --destination_directory <dest_dir> ] [ --base_name <base_name> ] [ --locale <locale> ]

OPTIONS

--full

include everything; other options are silently ignored.

--only_built_in

include built-in xliff file versions.

--only_custom

include custom xliff file versions.

--include_class_files

include jar of internal classes used by runtime.

--destination_file

output destination file; directory extension should be provided, zip/jar recommended; the file must not exist.

--destination_directory

output destination directory; may exist; must not be used with --dest-file.

--base_name

include xliff with this base name; may be repeated; if omitted all base names are implicitly included.

--locale

include this locale for all base names; if omitted all locales are implicitly included.

EXAMPLES

beectl download_language_pack --full --destination_directory "/tmp" --base_name "oracle.beehive.core.util" --locale "en_us"

download_ldap_group_data

The download_ldap_group_data command downloads groups information for an external directory into an XML file. The generated XML file can be used with add_group command to create the groups.

SYNTAX

beectl download_ldap_group_data --file <filename> --profile <profile-name>

OPTIONS

--file

Name of the file to be created with group information in xml format.

--profile

Name of the directory profile.

EXAMPLES

beectl download_ldap_group_data --file Groups.xml --profile MyDirectoryProfile

download_ldap_user_data

The download_ldap_user_data command downloads user information for an external directory into an XML file. The generated XML file can be used with add_users command to create the users.

SYNTAX

beectl download_ldap_user_data --file <filename> --profile <profile-name>

OPTIONS

--file

Name of the file to be created with user information in xml format.

--profile

Name of the directory profile.

EXAMPLES

beectl download_ldap_user_data --file Users.xml --profile MyDirectoryProfile

download_syncml_messages

Downloads SyncML messages.

SYNTAX

beectl download_syncml_messages --directory <directory> --date <yyyy-MM-DD> [ --id <id> | --user_id <user_id>]

OPTIONS

--directory

Specify the full path of the output destination directory. The directory must exist within the same server environment used by the Management Service.

--date

Specify the date of data to download. Use the YYYY-MM-DD format.

--id

Specify the server side synchronization session ID of data to download.

--user_id

Specify the server side synchronization session ID of data to download.

EXAMPLES

beectl download_syncml_messages --directory /syncml_messages --date 2006-10-12 --id 105

download_syncml_sessions

Downloads SyncML messages.

SYNTAX

beectl download_syncml_sessions --file <file> --date <yyyy-MM-DD> [ --id <id> | --user_id <user_id>]

OPTIONS

--file

Specify output destination file. The file will be created within the same server environment used by the Management Service.

--date

Specify the date of data to download. Use the YYYY-MM-DD format.

--id

Specify the server side synchronization session ID of data to download.

--user_id

Specify the server side synchronization session ID of data to download.

EXAMPLES

beectl download_syncml_sessions --file /syncml_sessions.log --date 2006-10-12 --id 105

download_workspace_template_schema

Downloads workspace template XML schema to a file

SYNTAX

beectl download_workspace_template_schema [--file <Full path of the output file>]

OPTIONS

--file

Full path of the output file

EXAMPLES

beectl download_workspace_template_schema --file /tmp/schema.xsd

export_audit_trail

Exports an existing audit trail by the given identifier

SYNTAX

beectl export_audit_trail --trail <Audit trail identifier> --file <Full path of the output file>

OPTIONS

--trail

Audit trail identifier

--file

Full path name of the export file

EXAMPLES

beectl export_audit_trail --trail autr=MyAuditTrail --file /tmp/trail.xml

export_client_application_configuration

Exports a client application configuration to a local file.

SYNTAX

beectl export_client_application_configuration --configuration <client application configuration identifier> --file <destination file>

OPTIONS

--configuration

Specify the identifier of the client application configuration.

--file

Specify the full path and file name. Oracle recommends using a .xml extension. If the file already exists, it will be overwritten.

EXAMPLES

beectl export_client_application_configuration --configuration 1234:5678:capc:1234567890123456789012 --file /tmp/client-app-config.xml

export_configuration_data

Exports configuration data for given configuration version.

SYNTAX

beectl export_configuration_data --file <output dir> [--configuration_version <required version>] [--verbose] [--no_null_values] [--no_large_values] [--no_binary_values] [--validate_output] [--only_custom_values]

OPTIONS

--configuration_version

Specifies configuration version. Valid values are proposed, active or any number equivalent to creation time of the configuration snapshot. Refer to the first column from the output of command list_configuration_versions for valid snapshot identifiers.

--file

Xml output file in which data will be dumped.

--verbose

If specified, all metadata information about the property will be printed.

--no_null_values

If specified, null or empty values will not be printed.

--no_large_values

If specified, large string data will not be printed.

--no_binary_values

If specified, binary data will not be printed.

--only_custom_values

If specified, properties which do not have same value as their initial/default values,will be printed.

--validate_output

Validates the generated output file.

EXAMPLES

beectl export_configuration_data --verbose --no_large_values --no_binary_values --no_null_values --validate_output

It transforms the generated xml into html output file avaialable at the same location as of the xml.

Specifying Configuration Version: Any of the following can be specified for accessing specific snapshot. If not specified, latest active snapshot will be accessed.

--configuration_version 89098787 can be passed to use snapshot having specific creation time as 89098787.

--configuration_version active can be passed for active snapshot.

--configuration_version proposed can be passed for latest proposed snapshot.

export_email_data

Export all email data to a file

SYNTAX

beectl export_email_data --user_name <user name> --file <file name>

OPTIONS

--user_name

The authentication ID of the user to be exported/imported.

--file

The file name of the file that holds the exported email data.

EXAMPLES

beectl export_email_data --user_name user1 --file user1.dat

export_errorcodes

Search for occurrences of error codes

SYNTAX

beectl export_errorcodes [--start <DATE_TIME>] [--end <DATE_TIME>] [--errorcode <STRING> ... |--exclude_errorcode <STRING> ... ] [--severity <string>] [--text <string>] [--max_results <INTEGER>] [--display_exception_stack] [--attribute <key>:<value> ... ] [--display_columns <STRING_LIST>] [--from_logs]    beectl export_errorcodes --get_count_service_by_ec <STRING>   beectl export_errorcodes --get_count_ec_by_service <STRING>

OPTIONS

--start

Start of time range

--end

End time range

--errorcode

Specific error codes to query for

--exclude_errorcode

Specific error codes to not search for

--severity

Minimum severity to restrict to

--text

Text in Exception stack or metadata parameters to search for

--max_results

Maximum number of results to return

--display_exception_stack

Should the Exception stack be printed

--display_columns

Comma separated list of columns to be displayed. Valid values are [service, messageid, displayname, severity, cause, effect, action, timestamp, exception_stack, ecid, service_inst_id, ctx_map]

--ecid

Execution Context ID

--service_inst_id

System object identifier or alias of either Service Instance or Oc4j.

--get_count_service_by_ec

Service instance ID to get error code counts from, or all to aggregate over all service instances.

--get_count_ec_by_service

Error code to get counts from, or all to aggregate over all error codes.

--from_logs

Query the logs instead of the database.

--attrib

Search for one of the following attributes: bee_compid, bee_compname, bee_vthreadid, bee_principalid, bee_logonrecid.

EXAMPLES

beectl export_errorcodes --start 2007-10-10T06:00:00 --end 2007-10-10T08:00:00 --errorcode BEEU-10364

Search for all instances of BEEU-10364 between 6AM and 8AM on October 10, 2007.

beectl export_errorcodes --start 2007-10-10T06:00:00 --severity WARNING --text 'QuotaException' --exclude_errorcode BEES-37968

Search for all all error codes reported since 6AM on October 10, 2007

with severity at least warning and 'QuotaException' in any parameters passed to the error codes except for BEES-37968.

beectl export_errorcodes --errorcode BEES-38216 --display_columns timestamp,cause,action,exception_stack

Search for all instances of error code BEES-38216, and display the timestamp, cause, action, and exception stack.

beectl export_errorcodes --get_count_service_by_ec b94885f7-2876-4d95-90aa-76a060875ac6

Get counts of error code occurrences in service instance b94885f7-2876-4d95-90aa-76a060875ac6, by error code.

beectl export_errorcodes --get_count_ec_by_service BEEU-00822

Get counts of error code occurrences of type BEEU-00822, by service.

export_filesystem_logs

Search log files stored on host machines.

SYNTAX

beectl export_filesystem_logs --search_string <string> [--maximum_results <int>] [--file_name_filter <string>] [--host_name_filter <string>] [--beehive_home_filter <string>] [--output_target <string>] [--output_format <string>] [--display_source <true|false>] [--display_original_copy <true|false>] [--columns <string_list>] [--log_analysis <true|false>] [--report_time_range <string>] [--report_message_type <string>] [--analysis_field <string_list>] [--get_latest <true|false>] [--local_search <true|false>] [--log_root <string>] [--order_by <string>] [--sort <string>] [--search_string_file_name <string>] [--display_ignored_summary_only <true|false>]

OPTIONS

--search_string

A search string is composed of a single or a combination of search conditions. A search condition has a field name (e.g. user_id='janedoe'), an operation type (e.g. op='contains') and condition oprands (!, &&, ||). The brackets "()" are used to group search conditions together. Valid search field names are: <ORG_ID | COMPONENT_ID | INSTANCE_ID | MSG_ID | HOSTING_CLIENT_ID | MSG_TYPE | MSG_GROUP | MSG_LEVEL | MODULE_ID | PROCESS_ID | THREAD_ID | USER_ID | SUPPL_ATTRS | SUPPL_ATTR.NAME | SUPPL_ATTR.VALUE | UPSTREAM_COMPONENT_ID | DOWNSTREAM_COMPONENT_ID | EXEC_CONTEXT_UNIQUE_ID | EXEC_CONTEXT_SEQ | ERROR_UNIQUE_ID | ERROR_SEQ | MSG_TEXT | MSG_ARGS | NAME | VALUE | DETAIL_PATH | SUPPL_DETAIL | TSTZ_ORIGINATING | TSTZ_NORMALIZED | HOST_ID | HOST_NWADDR | PROB_KEY | BEE_COMPID | BEE_COMPNAME | BEE_PRINCIPALID | BEE_LOGONRECID | BEE_VTHREADID | ATTRIBUTE_VALUE_TO_PRINCIPAL_ID | LOGIN_ID_TO_PRINCIPAL_ID>. Valid operation types are: <EQUALS | CONTAINS | STARTS_WITH | EQUALS_IGNORE_CASE | CONTAINS_IGNORE_CASE | STARTS_WITH_IGNORE_CASE | MATCHES | MATCHES_IGNORE_CASE>. Note: The search string must be enclosed in a pair of double-quotes and \ must be used to escape ! operand. Time stamp query condition can contain two values separated by a comma. Query fields ATTRIBUTE_VALUE_TO_PRINCIPAL_ID and LOGIN_ID_TO_PRINCIPAL_ID are special cases. Field ATTRIBUTE_VALUE_TO_PRINCIPAL_ID works with four operation types: <equals | contains | beginsWith | endsWith> and the search operation is always case-insensitive. But the operation type is not applicable to field LOGIN_ID_TO_PRINCIPAL_ID and any operation type specified for it will be ignored. Those fields are used to match corresponding BEE_PRINCIPAL_ID. Then the matched BEE_PRINCIPAL_ID will be used for the subsequent search with operation type <EQUALS_IGNORE_CASE> only.

--maximum_results

Maximum number of returned records. It tops out at 1,000, if the output_target is screen, otherwise there is no limit.

--file_name_filter

A file name filter is used to speed up searches. Use a comma to separate multiple values and a prefix # to specify excluding. Note: the prefix # is applied to all the values following it.

--host_name_filter

A host name filter is used to speed up searches. Use a comma to separate multiple values and a prefix # to specify excluding. Note: the prefix # is applied to all the values following it.

--beehive_home_filter

A beehive home filter is used to speed up searches. Use a comma to separate multiple values and a prefix # to specify excluding. Note: the prefix # is applied to all the values following it.

--output_target

Specify if direct the output to the screen or to a file.

--output_format

Specify output format. Supported formats are ODL-Text and XML.

--display_source

Default to false. Specify if display the name of the log file source for the returned record.

--display_original_copy

Default to false. Specify if display the original copy for the returned record.

--columns

Default is to display all the log record fields. Restrict to display only specified fields. Valid field names are: <ORG_ID | COMPONENT_ID | INSTANCE_ID | MSG_ID | HOSTING_CLIENT_ID | MSG_TYPE | MSG_GROUP | MODULE_ID | PROCESS_ID | THREAD_ID | USER_ID | SUPPL_ATTRS | UPSTREAM_COMPONENT_ID | DOWNSTREAM_COMPONENT_ID | EXEC_CONTEXT_UNIQUE_ID | ERROR_UNIQUE_ID | MSG_TEXT | MSG_ARGS | DETAIL_PATH | SUPPL_DETAIL | TSTZ_ORIGINATING | TSTZ_NORMALIZED | HOST_ID | HOST_NWADDR | PROB_KEY | BEE_COMPID | BEE_PRINCIPALID | BEE_COMPNAME | BEE_LOGONRECID | BEE_VTHREADID>. Note: field TSTZ_ORIGINATING will always be displayed.

--log_analysis

Default to false. Specify if choose to do the log analysis.

--report_time_range

Specify the desired time range for log analysis report. Only apply when option log_analysis is true.

--report_message_type

Specify the desired message type of the unique message count for log analysis report. Only apply when option log_analysis is true.

--analysis_field

Specify the desired unique count analysis field. Valid field names are: <ORG_ID | COMPONENT_ID | INSTANCE_ID | MSG_ID | HOSTING_CLIENT_ID | MSG_GROUP | MODULE_ID | PROCESS_ID | THREAD_ID | USER_ID | UPSTREAM_COMPONENT_ID | DOWNSTREAM_COMPONENT_ID | EXEC_CONTEXT_UNIQUE_ID | ERROR_UNIQUE_ID | MSG_TEXT | DETAIL_PATH | SUPPL_DETAIL | HOST_ID | HOST_NWADDR | PROB_KEY | BEE_COMPID | BEE_COMPNAME | BEE_PRINCIPALID | BEE_LOGONRECID | BEE_VTHREADID>

--get_latest

Default to false. Specify if choose to get the latest log record.

--order_by

Valid order-by column names are: <TSTZ_ORIGINATING | TSTZ_NORMALIZED | ORG_ID | COMPONENT_ID | MSG_ID | HOSTING_CLIENT_ID | MSG_TYPE | MSG_GROUP | HOST_ID | HOST_NWADDR | MODULE_ID | PROCESS_ID | USER_ID | UPSTREAM_COMPONENT_ID | DOWNSTREAM_COMPONENT_ID | EXEC_CONTEXT_UNIQUE_ID | ERROR_UNIQUE_ID | THREAD_ID | INSTANCE_ID | MSG_TEXT | BEE_COMPID | BEE_PRINCIPALID | BEE_COMPNAME | BEE_LOGONRECID | BEE_VTHREADID>.

--sort

The query result set can be sorted in ascending or descending order.

--local_search

Default to false. Specify if choose to search log files on the local machine only. Only work when the log_root option is also specified.

--log_root

Specify the log file root for local_search option.

--search_string_file_name

Specify the search string file name, a convenient way to enter multiple search strings. The format is one string per line. Valid only when the log_analysis option is true.

--display_ignored_summary_only

_PRINCIPAL_ID and LOGIN_IDif choose to display ignored summary only. Valid only when the log_analysis option is true.

EXAMPLES

beectl export_filesystem_logs --search_string "((user_id='janedoe'||user_id='johndoe')&&\!component_id='j2ee')&&(msg_text='esb_console' op='contains')"

beectl export_filesystem_logs --search_string "(TSTZ_ORIGINATING='2007-05-31T17:06:45.620-07:00,2007-05-31T17:08:15.639-07:00')"

beectl export_filesystem_logs --search_string "(TSTZ_ORIGINATING='2007-05-31T17:06:45.620-07:00')" --maximum_results 10

beectl export_filesystem_logs --search_string "(user_id='janedoe'&&module_id='security.oc4j')" --file_name_filter beeapp/log.txt,beemgmt --host_name_filter #some-host-name,some-other-host-name --beehive_home_filter /root/dir/product/1.0.6.1.0/beehive_119 --output_target /tmp/temp.log --output_format xml --maximum_results 16

beectl export_filesystem_logs --log_analysis --report_time_range 2880 --local_search --log_root log_root/some_log_directory

export_icalendar

Export invitations and assignments from a calendar and/or tasklist to an iCalendar file.

SYNTAX

beectl export_icalendar --file <file> [--overwrite] [--charset <charset>] { --do_as <unique_identifier> | --do_as_address <uri> | --do_as_authuser <authuser> } [{ --calendar <unique_identifier> | --nocalendar }] [{ --tasklist <unique_identifier> | --notasklist }] [--filter_uid <icalendar_uid>] [--filter_organizer <uri>] [--filter_timerange_start <date-time>] [--filter_timerange_end <date-time>] [--removeicalname <canonical_ical_name>]  [--authuser <authuser> --authpassword <password>] [--obfuscated]

OPTIONS

--file

Specify the full path and name of the iCalendar file to export.

--overwrite

Specify this option to overwrite the iCalendar export file if it already exists.

--charset

Specify the charset that is to be used in the iCalendar file that is being exported (http://www.iana.org/assignments/character-sets).

--do_as

Specify the unique identifier of the user or resource performing the action.

--do_as_address

Specify the Uniform Resource Identifie (URI) of the user or resource performing the action.

--do_as_authuser

Specify the login name of the user performing the action.

--calendar

Specify the unique identifier of the source calendar, the default calendar of the "do_as" entity will be used if nothing is specified.

--tasklist

Specify the unique identifier of the source tasklist, the default tasklist of the "do_as" entity will be used if nothing is specified.

--filter_uid

Specify a iCalendar UID. This will filter the export to include only invitations and assignments matching the iCalendar UID.

--filter_organizer

Specify an organizer URI. This will filter the export to include only invitations and assignments matching the organizer.

--filter_timerange_start

Specify a start date. This will filter the export to include only invitations and assignments after the specified date.

--filter_timerange_end

Specify an end date. This will filter the export to include only invitations and assignments before the specified date.

--nocalendar

Do not export from a calendar (VEVENT components will not be exported).

--notasklist

Do not export from a tasklist (VTODO components will not be exported).

--removeicalname

Remove canonical ical names such as VCALENDAR.VEVENT.VALARM, VCALENDAR.VEVENT.ORGANIZER.

EXAMPLES

beectl export_icalendar --file file.ics --do_as_address user@example.com --filter_timerange_start 2007-01-01T01:01:01Z --filter_timerange_end 2007-02-01T01:01:01Z

export_logs

With an option of refreshing the repository first, query the repository to get relevant log records from log files stored on host machines.

SYNTAX

beectl export_logs {{ --query_string <string> [ --refresh_repository <true> ]} | --refresh_repository <true> } [--order_by <string>] [--sort <string>] [--columns <string_list>] [--output_target <string>] [--output_format <string>] [--display_source <true|false>] [--maximum_results <int>]

OPTIONS

--query_string

Mandatory if option "refresh_repository" is not specified. A query string is composed of a single or a combination of query conditions. A query condition has a field name (e.g. user_id='janedoe'), an operation type (e.g. op='contains') and condition oprands (!, &&, ||). The brackets "()" are used to group query conditions together. Valid query field names are: <TSTZ_ORIGINATING | TSTZ_NORMALIZED | ORG_ID | COMPONENT_ID | MSG_ID | HOSTING_CLIENT_ID | MSG_TYPE | MSG_GROUP | MSG_LEVEL | HOST_ID | HOST_NWADDR | MODULE_ID | PROCESS_ID | USER_ID | UPSTREAM_COMPONENT_ID | DOWNSTREAM_COMPONENT_ID | EXEC_CONTEXT_UNIQUE_ID | ERROR_UNIQUE_ID | THREAD_ID | INSTANCE_ID | MSG_TEXT | BEE_COMPID | BEE_PRINCIPALID | BEE_COMPNAME | BEE_LOGONRECID | BEE_VTHREADID | ATTRIBUTE_VALUE_TO_PRINCIPAL_ID | LOGIN_ID_TO_PRINCIPAL_ID>. Valid operation types are: <EQUALS | CONTAINS | STARTS_WITH | EQUALS_IGNORE_CASE | CONTAINS_IGNORE_CASE | STARTS_WITH_IGNORE_CASE | MATCHES | MATCHES_IGNORE_CASE>Note: The query string must be enclosed in a pair of double-quotes and \ must be used to escape ! operand. Time stamp query condition can contain two values separated by a comma. Query fields ATTRIBUTE_VALUE_TO_ PRINCIPAL_ID and LOGIN_ID_TO_PRINCIPAL_ID are special cases. Field ATTRIBUTE_VALUE_TO_PRINCIPAL_ID works with four operation types: <equals | contains | beginsWith | endsWith> and the search operation is always case-insensitive. But the operation type is not applicable to field LOGIN_ID_TO_PRINCIPAL_ID and any operation type specified for it will be ignored. Those fields are used to match corresponding BEE_PRINCIPAL_ID. Then the matched BEE_PRINCIPAL_ID will be used for the subsequent query with operation type <EQUALS> only.

--refresh_repository

Mandatory if option "query_string" is not specified. Force an upload of all the log files to refresh the repository.

--order_by

Valid order-by column names are: <TSTZ_ORIGINATING | TSTZ_NORMALIZED | ORG_ID | COMPONENT_ID | MSG_ID | HOSTING_CLIENT_ID | MSG_TYPE | MSG_GROUP | MSG_LEVEL | HOST_ID | HOST_NWADDR | MODULE_ID | PROCESS_ID | USER_ID | UPSTREAM_COMPONENT_ID | DOWNSTREAM_COMPONENT_ID | EXEC_CONTEXT_UNIQUE_ID | ERROR_UNIQUE_ID | THREAD_ID | INSTANCE_ID | MSG_TEXT | BEE_COMPID | BEE_PRINCIPALID | BEE_COMPNAME | BEE_LOGONRECID | BEE_VTHREADID>.

--sort

The query result set can be sorted in ascending or descending order.

--columns

Default is to display all the log record fields. Restrict to display only specified fields. Valid field names are: <ORG_ID | COMPONENT_ID | INSTANCE_ID | MSG_ID | HOSTING_CLIENT_ID | MSG_TYPE | MSG_GROUP | MODULE_ID | PROCESS_ID | THREAD_ID | USER_ID | SUPPL_ATTRS | UPSTREAM_COMPONENT_ID | DOWNSTREAM_COMPONENT_ID | EXEC_CONTEXT_UNIQUE_ID | ERROR_UNIQUE_ID | MSG_TEXT | MSG_ARGS | DETAIL_PATH | SUPPL_DETAIL | TSTZ_ORIGINATING | TSTZ_NORMALIZED | HOST_ID | HOST_NWADDR | PROB_KEY | BEE_COMPID | BEE_PRINCIPALID | BEE_COMPNAME | BEE_LOGONRECID | BEE_VTHREADID>. Note: field TSTZ_ORIGINATING will always be displayed.

--output_target

Specify if direct the output to the screen or to a file.

--output_format

Specify output format. Supported formats are ODL-Text and XML.

--display_source

Default to false. Specify if display the name of the log file source for the returned record.

--maximum_results

Maximum number of returned records.

EXAMPLES

beectl export_logs --refresh_repository true

beectl export_logs --query_string "((user_id='janedoe'||user_id='johndoe')&&\!component_id='j2ee')&&(msg_text='esb_console' op='contains')"

beectl export_logs --query_string "(TSTZ_ORIGINATING='2007-05-31T17:06:45.620-07:00,2007-05-31T17:08:15.639-07:00')"

beectl export_logs --query_string "(TSTZ_ORIGINATING='2007-05-31T17:06:45.620-07:00')" --maximum_results 10

beectl export_logs --query_string "(user_id='janedoe'&&module_id='security.oc4j')" --order_by THREAD_ID --sort descending --columns MODULE_ID --columns USER_ID --columns USER_ID --columns MSG_TEXT --columns THREAD_ID --output_target /tmp/temp.log --output_format xml --display_source true --maximum_results 10

export_policy

Exports policy data into an XML file.

SYNTAX

beectl export_policy --policy_name <name of the policy to export> --scope <identifier of the container where the policy is defined> --destination <destination directory where the XML file will be exported>

OPTIONS

--policy_name

Specify the name of the policy to export.

--scope

Specify the policy container identifier.

--destination

Specify the destination directory for the XML file.

EXAMPLES

beectl export_policy --policy_name MyPolicy --scope enpr=MyEnterprise --destination /private

export_probes

Lists all probe information in beehive.

SYNTAX

beectl export_probes

OPTIONS

--id

ID of a Probe to get detailed information about

--summary

Get Summary

--start

Start time to search for probes

--end

End time to search for probes

--service_instance

Service instance names to search for

--calling_class

Calling class

--threadID

Thread ID

--thread_rep

Thread Rep

--txn_ctx

Transaction Context

--user_ctx

User context

--arg_type

--arg_value

--msgid

--throwable_text

EXAMPLES

beectl export_probes

Lists all probe information in beehive.

export_workspace

Exports workspace contents into an external directory.

SYNTAX

beectl export_workspace --workspace <Workspace identifier> --output_dir <Output directory> [--log_file <The log file where the results will be printed. If none is specified, the log file will be located in the output directory, and will be called export-log-(timestamp). This option can be either the path to a logfile or the path to a directory. If the latter, the log file will be created under the directory with the default name export-log-(timestamp).>]

OPTIONS

--workspace

Workspace identifier

--output_dir

Output directory

--log_file

The log file where the results will be printed. If none is specified, the log file will be located in the output directory, and will be called export-log-(timestamp). This option can be either the path to a logfile or the path to a directory. If the latter, the log file will be created under the directory with the default name export-log-(timestamp).

EXAMPLES

beectl export_workspace --workspace wksp=test_team_ws,orgn=test_org,enpr=test_enterprise --output_dir /scratch/export/wspc --log_file /tmp/export.log

import_coexistence_data

Import data from the coexisting remote system for a given user.

SYNTAX

beectl import_coexistence_data {--user <user_cen> | --email <user_email> } --data_type <type> [--data_type <type> ...] [--timerange_start <start>] [--relative_timerange_start <relative_start>] [--timerange_end <end>] [--relative_timerange_end <relative_end>] [--modified_since <modified_since>]   beectl import_coexistence_data --generate_refresh_import_commands --generated_file <file> [--system_affinity <system_name>]

OPTIONS

--user

Specify the identifier of the user.

--email

Specify the email address of the user.

--data_type

Type of data to import. Must be one of: MEETING, TASK.

--timerange_start

Start date time of import time range.

--relative_timerange_start

Start time of import time range specified by number of days relative to current time (eg. -30)

--timerange_end

End date time of import time range.

--relative_timerange_end

End time of import time range specified by number of days relative to current time (eg. 90)

--modified_since

Import only entries that have been modified since the specified date.

--generate_refresh_import_commands

Generate the import commands to import all newer entries of coexisting remote users using a [-14 days, INFINITY] date range. This is required after converting profiles to accessible_by beehive. The generated command file can be used with beectl --batchfile.

--generated_file

Specify the generated output file. This file is generated only when generate_refresh_import_commands option is selected and will hold the newly generated coexistence_data_import commands.

--system_affinity

Specify the name of the coexisting remote system.

EXAMPLES

beectl import_coexistence_data --user user=user_loginid --data_type TASK --data_type MEETING --relative_timerange_start=-90 --relative_timerange_end 90

beectl import_coexistence_data --email user@example.com --data_type MEETING --timerange_start 2007-10-01T12:00:00Z --timerange_end NOW

beectl import_coexistence_data --user user=user_loginid --data_type MEETING --timerange_start=-INFINITY --timerange_end INFINITY

beectl import_coexistence_data --generate_refresh_import_commands --generated_file outfile.beectl

import_documents

Imports documents into Beehive from files on the server without copying the file content. Data on the server files will be treated as read-only; should an imported document be edited in Beehive, a copy of the content will be made at that time.

SYNTAX

beectl import_documents --filesystem_reference <Identifier of the filesystem reference> --folder_path <Folder path> [ --name_filter <Name filter> ] [ --conflict_resolution_mode <ABORT, OVERWRITE, or CREATE_UNIQUE> ]

OPTIONS

--filesystem_reference

Identifier of the filesystem reference to import from.

--folder_path

Full path of the Beehive folder to import to. E.g. /MyEnterprise/MyOrganization/MyWorkspace/Documents/MyFolder would import to MyFolder.

--name_filter

(Optional) Filter to use for choosing which documents to import. Syntax is equivalent to SQL LIKE. E.g. 'file%' would import file1, file2.txt, but not my_file. If not specified, defaults to '%', which includes all documents.

--conflict_resolution_mode

(Optional) How to handle naming conflicts between existing Beehive documents and new documents being imported. ABORT will avoid creating the conflicting document, OVERWRITE will overwrite the conflicting document, and CREATE_UNIQUE will create a unique name for the imported document. If not specified, defaults to CREATE_UNIQUE.

EXAMPLES

beectl import_documents --filesystem_reference fsref=MyFilesystemReference,enpr=MyEnterprise --folder_path /MyEnterprise/MyOrganization/MyWorkspace/Documents/MyFolder --name_filter %.txt --conflict_resolution_mode CREATE_UNIQUE

import_email_data

Import email data from a file created by export command into a given folder

SYNTAX

beectl import_email_data --user_name <user name> --folder <folder name> --file <file name>

OPTIONS

--user_name

The authentication ID of the user to be exported/imported.

--folder

The relative folder path (from the workspace level) of the folder to hold all the imported data.

--file

The file name of the file that holds the exported email data.

EXAMPLES

beectl import_email_data --user_name user1 --folder Archive/backup1 --file user1.dat

import_icalendar

Import an iCalendar file to an existing calendar and/or tasklist. If an iCalendarObject has a UID that already exists in the destination calendar and/or tasklist it will be re-created. VCALENDAR components can have many VEVENT and VTODO sub-components with different UIDs but sub-components of the same UID must be consecutive. A VCALENDAR component imported with a METHOD:X-ORACLE-DELETE or METHOD:CANCEL will cause all sub-components to be deleted.

SYNTAX

beectl import_icalendar --file <file> [--charset <charset>] { --do_as <unique_identifier> | --do_as_address <uri> | --do_as_authuser <authuser> } [--continue_on_error] [{ --calendar <unique_identifier> | --nocalendar }] [{ --tasklist <unique_identifier> | --notasklist }] [--authuser <authuser> --authpassword <password>] [--obfuscated] [--holiday] [--migration [--reconciliation]] [--removeicalname <canonical_ical_name>]

OPTIONS

--file

Specify the full path and name of the iCalendar file to import.

--charset

Specify the charset that is used in the iCalendar file that is being imported (http://www.iana.org/assignments/character-sets).

--do_as

Specify the unique identifier of the user or resource performing the action.

--do_as_address

Specify the Uniform Resource Identifie (URI) of the user or resource performing the action.

--do_as_authuser

Specify the login name of the user performing the action.

--continue_on_error

Force the tool to continue the import even if some of the iCalendar objects fail to be imported.

--calendar

Specify the unique identifier of the destination calendar, the default calendar of the "do_as" entity will be used if nothing is specified.

--tasklist

Specify the unique identifier of the destination tasklist, the default tasklist of the "do_as" entity will be used if nothing is specified.

--nocalendar

Do not import to a calendar (Discard VEVENT components).

--notasklist

Do not import to a tasklist (Discard VTODO components).

--holiday

All events imported in a team workspace will be imported as Holiday events.

--migration

Specify that all the iCalendar file will be imported in the context of a migration. The participation status of all users can be set by the importer and a limited number of beehive events will be raised.

--reconciliation

Specify that a reconciliation should be done for existing meetings attended by the user before he was created in the system, this option can only be used if --migration is used.

--removeicalname

Remove canonical ical names such as VCALENDAR.VEVENT.VALARM, VCALENDAR.VEVENT.ORGANIZER.

EXAMPLES

beectl import_icalendar --file file.ics --do_as_address user@example.com

import_timezones

Imports time zone definitions to the database.

SYNTAX

beectl import_timezones --file <absolute path of tzInfoPkg.xml>

OPTIONS

--file

Spcify the full path and file name of the time zone definition file (tzInfoPkg.xml).

EXAMPLES

beectl import_timezones --file $ORACLE_HOME/beehive/seed/tm/tzInfoPkg.xml

import_workspace

Imports contents of an external directory into a new team workspace.

SYNTAX

beectl import_workspace --input_dir <Input directory> --scope <The scope under which the workspace will be created.> [--log_file <The log file where the results will be printed. If none is specified, the log file will be located in the input directory, and will be called import-log-(timestamp). This option can be either the path to a logfile or the path to a directory. If the latter, the log file will be created under the directory with the default name import-log-(timestamp).>] [--auto_name_resolution <Automatic workspace name conflict resolution.>] [--keep_original_owner <Whether to keep the workspace's original owner.>] [--import_members <Whether to import members.>] [--add_connected_user <Whether to add the connected user to the new workspace.>] [--new_owner <New owner>]

OPTIONS

--input_dir

Input directory

--scope

The scope under which the workspace will be created.

--log_file

The log file where the results will be printed. If none is specified, the log file will be located in the input directory, and will be called import-log-(timestamp). This option can be either the path to a logfile or the path to a directory. If the latter, the log file will be created under the directory with the default name import-log-(timestamp).

--auto_name_resolution

Automatic workspace name conflict resolution.

--keep_original_owner

Whether to keep the workspace's original owner.

--import_members

Whether to import members.

--add_connected_user

Whether to add the connected user to the new workspace.

--new_owner

New owner

EXAMPLES

beectl import_workspace --input_dir /scratch/import/wspc --scope orgn=test_org,enpr=test_enterprise --log_file /tmp/import.log --auto_name_resolution false --keep_original_owner false --import_members false --add_connected_user true --new_owner user=beeadmin

list_access_control_fields

Lists the AccessControlFields of an entity.

SYNTAX

beectl list_access_control_fields --entity <unique identifier of the entity>

OPTIONS

--entity

Specify the unique identifier of the entity for which the AccessControlFields should be listed.

EXAMPLES

beectl list_access_control_fields --entity adoc=MyDocument,wksp=MyWorkspace,enpr=MyEnterprise

list_access_types

Lists available access type names and identifiers.

SYNTAX

beectl list_access_types

OPTIONS

This command has no options

EXAMPLES

beectl list_access_types

list_applied_workspace_templates

Lists the workspace templates that have been applied to this workspace. For each applied template it indicates whether this workspace is a template evolution target.

SYNTAX

beectl list_applied_workspace_templates --workspace <Workspace identifier>

OPTIONS

--workspace

Workspace identifier

EXAMPLES

beectl list_applied_workspace_templates --workspace wksp=test_team_ws,enpr=test_enterprise

list_assigned_roles

Lists AssignedRole entities.

SYNTAX

beectl list_assigned_roles [--scope <unique identifier of the Scope>] [--name <like string>] [--role_definition <like string>]

OPTIONS

--scope

Specify the unique identifier of the Scope of the AssignedRoles to be listed. If not specified the Scope will be the Enterprise.

--name

Specify the name pattern for the AssignedRoles to be listed. If not specified all accessible AssignedRoles will be returned.

--role_definition

Specify the name pattern for the RoleDefinitions of the AssignedRoles to be listed. If not specified any corresponding RoleDefinition is allowed for the returned AssignedRoles.

EXAMPLES

beectl list_assigned_roles --scope wksp=MyWorkspace,enpr=MyEnterprise --name MyAssignedRole

list_attendant_aaml

Prints the Auto Attendant Markup Language for an auto attendant.

SYNTAX

beectl list_attendant_aaml --name <attendant name>

OPTIONS

--name

Name of the attendant to be displayed.

EXAMPLES

beectl list_attendant_aaml --name myAttendant

list_attendant_prompts

Lists all prompts that have been uploaded for an attendant.

SYNTAX

beectl list_attendant_prompts --name <attendant name>

OPTIONS

--name

Name of the attendant for which to display prompts.

EXAMPLES

beectl list_attendant_prompts --name my_attendant

list_attendants

Lists all attendants in the system.

SYNTAX

beectl list_attendants

OPTIONS

This command has no options

EXAMPLES

beectl list_attendants

list_audit_policies

Lists audit policies and prints policy information

SYNTAX

beectl list_audit_policies [--name <Name of the audit policy>] [--policy <Audit policy identifier>] [--detail]

OPTIONS

--name

Name of the audit policy

--policy

Audit policy identifier

--detail

Detail toggle

EXAMPLES

beectl list_audit_policies --name MyPolicy

beectl list_audit_policies --name MyPolicy --detail

beectl list_audit_policies --policy MyPolicy

beectl list_audit_policies --policy plcy=MyPolicy --detail

list_audit_trails

Lists audit trails and prints trail information

SYNTAX

beectl list_audit_trails [--name <Name of the audit trail>] [--4} <Name of the audit trail>]

OPTIONS

--name

Name of the audit trail

--trail

Audit trail identifier

EXAMPLES

beectl list_audit_trails --name MyAuditTrail

beectl list_audit_trails --trail audt=MyAuditTrail

list_bootstrap_configuration

Displays bootstrap configuration for local midtier.

SYNTAX

beectl list_bootstrap_configuration

OPTIONS

This command has no options

EXAMPLES

beectl list_bootstrap_configuration

list_calendar_enrollments

List the directly enrolled and directly unenrolled members of the specified team workspace calendar.

SYNTAX

beectl list_calendar_enrollments { --calendar <calendarid> | --calendarowner <unique_identifier> | --select_by_address <uri> | --select_by_workspace_name <workspace_name> }

OPTIONS

--calendar

Specify the unique identifier of a calendar.

--calendarowner

Specify the unique identifier of a team workspace.

--select_by_address

Specify the Uniform Resource Identifier (URI) of a team workspace using the format '[scheme:]value'. If scheme is not supplied, mailto will be used.

--select_by_workspace_name

Specify the name of a team workspace.

EXAMPLES

beectl list_calendar_enrollments --select_by_address teamworkspace@example.com

list_calendar_permissions

List the access control permissions of a user, resource or workspace's calendar. When multiple calendars match the selection criteria for the user, resource or workspace, the default calendar will be used.

SYNTAX

beectl list_calendar_permissions { --calendar <calendarid> | --calendarowner <unique_identifier> | --select_by_address <uri> | --select_by_authuser <authuser> --select_by_user_name <user_name> | --select_by_resource_name <resource_name> | --select_by_workspace_name <workspace_name> }

OPTIONS

--calendar

Specify the unique identifier of a calendar.

--calendarowner

Specify the unique identifier of a user, resource or workspace.

--select_by_address

Specify the Uniform Resource Identifier (URI) of a user, resource or team workspace using the format '[scheme:]value'. If 'scheme:' is not supplied, mailto will be used.

--select_by_authuser

Specify the login name of a user.

--select_by_user_name

Specify the name of a user.

--select_by_resource_name

Specify the name of a resource.

--select_by_workspace_name

Specify the name of a team workspace.

EXAMPLES

beectl list_calendar_permissions --select_by_address user@example.com

list_calendars

Lists the existing calendars of a user, resource or workspace.

SYNTAX

beectl list_calendars { --calendar <calendarid> | --calendarowner <unique_identifier> | --select_by_address <uri> | --select_by_authuser <authuser> --select_by_user_name <user_name> | --select_by_resource_name <resource_name> | --select_by_workspace_name <workspace_name> } [ --show <DEFAULT | ALL | MORE>]

OPTIONS

--calendar

Specify the unique identifier of a calendar.

--calendarowner

Specify the unique identifier of a user, resource or workspace.

--select_by_address

Specify the Uniform Resource Identifier (URI) of a user, resource or team workspace using the format '[scheme:]value'. If 'scheme:' is not supplied, mailto will be used.

--select_by_authuser

Specify the login name of a user.

--select_by_user_name

Specify the name of a user.

--select_by_resource_name

Specify the name of a resource.

--select_by_workspace_name

Specify the name of a team workspace.

--show

Lists some or all of the attributes of the calendar. Valid values are DEFAULT, ALL or MORE. If nothing (or DEFAULT) is specified the default important attributes are listed.

EXAMPLES

beectl list_calendars --select_by_address user@example.com

list_categories

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

SYNTAX

beectl list_categories --recurse <Y/N> --parent_category <Identifier of the parent category> --output_format <XML>

OPTIONS

--recurse

Control the categories that are returned. Use the Y argument with this option to return all categories in an enterprise. Use the N argument with this option to return only root level categories.

--parent_category

Unique Identifier for Parent Category.

--output_format

If 'XML' the output is sent as xml to standard out else its printed as table on standard output.

EXAMPLES

beectl list_categories --recurse Y --parent_category catg=Resource_US,catg=Resource_ROOT,enpr=bee_ent

beectl list_categories --recurse Y --parent_category catg=Resource_US,catg=Resource_ROOT,enpr=bee_ent --output_format XML

list_category

Prints information about a category given a category identifier

SYNTAX

beectl list_category --category <Identifier of the category to be listed>

OPTIONS

--category

Specify the identifier of the category.

EXAMPLES

beectl list_category --category catg=Resource_US,catg=Resource_ROOT,enpr=bee_ent

list_category_applications

List all the categories (and associated attributes) applied to a specific entity. Lists the application of a specific category to the entity if the [category] parameter is provided.

SYNTAX

beectl list_category_applications --entity <entity id> --category <category id>

OPTIONS

--entity

Identifier of the entity for which applied categories should be listed.

--category

Identifier of a specific category whose application should be listed.

EXAMPLES

beectl list_category_applications --entity wksp=Example_Team_Workspace,enpr=Oracle

beectl list_category_applications --entity wksp=Example_Team_Workspace,enpr=Oracle --category catg=TechnicalDocuments,enpr=Oracle

list_category_configuration

Lists the category configuration on the given scope or heterogenous folder.

SYNTAX

beectl list_category_configuration --container <Configuration scope or heterogenous folder>

OPTIONS

--container

Scope or heterogenous folder on which the category configuration should be listed.

EXAMPLES

beectl list_category_configuration --container orgn=MyOrganization,enpr=MyEnterprise

list_client_application_configuration

Lists the client application configurations.

SYNTAX

beectl list_client_application_configuration {--configuration <client application configuration identifier >|--community <community identifier>}

OPTIONS

--community

Specify the identifier of the community.

--configuration

Specify the identifier of the client application configuration.

EXAMPLES

beectl list_client_application_configuration --configuration 1234:5678:capc:2E0329B0705F0E40E040578C92160957000000000434

beectl list_client_application_configuration --community orgn=myOrg,enpr=myEnterprise

list_client_application_modules

Lists the modules for a given client application patchset.

SYNTAX

beectl list_client_application_modules --patchset <identifier of the client application patchset>

OPTIONS

--patchset

Specify the identifier of the client application patchset. {--select_users_without_profile|-ion_patchsets command to determine the identifier of a client application patchset.

EXAMPLES

beectl list_client_application_modules --patchset 1234:5678:capp:2E0329B0705F0E40E040578C92160957000000000434

list_client_application_patchsets

Lists the patchsets for a given client application version.

SYNTAX

beectl list_client_application_patchsets --application_version <identifier of the client application version>

OPTIONS

--application_version

Specify the identifier of the client application version. Use list_client_application_versions command to determine the identifier of a client application version.

EXAMPLES

beectl list_client_application_patchsets --application_version 1234:5678:capv:2E0329B0705F0E40E040578C92160957000000000434

list_client_application_versions

Lists all the versions for a given client application.

SYNTAX

beectl list_client_application_versions --application <identifier of the client application>

OPTIONS

--application

Specify the identifier of the client application. Use list_client_applications command to determine the identifier of the client application.

EXAMPLES

beectl list_client_application_versions --application 1234:5678:capn:2E0329B0705F0E40E040578C92160957000000000434

list_client_applications

Lists all the client applications.

SYNTAX

beectl list_client_applications

OPTIONS

This command has no options

EXAMPLES

beectl list_client_applications

list_client_applications_usage

Lists the client applications usage report. The command displays the number of devices that have installed a client application.

SYNTAX

beectl list_client_applications_usage

OPTIONS

This command has no options

EXAMPLES

beectl list_client_applications_usage

list_clone_properties

Lists the set of system model properties required for ias cloning scripts.

SYNTAX

beectl list_clone_properties

OPTIONS

This command has no options

EXAMPLES

beectl list_clone_properties

list_coexistence_connectors

Lists all coexistence connectors for a coexisting remote system.

SYNTAX

beectl list_coexistence_connectors

OPTIONS

--show

Show extra connector details.

--name

Specify the name of the coexisting remote system.

EXAMPLES

beectl list_coexistence_connectors

list_coexistence_profiles

Lists the profile of coexisting users.

SYNTAX

beectl list_coexistence_profiles [{--user <user_identifier>|--email <user_email>      <example_message>beectl list-select_users_with_profile} --file <file_name> }] [--show] [--sort]

OPTIONS

--user

Specify the identifier of the user.

--email

Specify the email address of the user.

--select_users_without_profile

List users without a coexistence profile in a XML document.

--select_users_with_profile

List users with a coexistence profile in a XML document.

--file

Specify the name of the file in which the list should be outputed.

--show

Specify the details level. Supported values: MORE, ALL.

--sort

List coexiting users ordered by their name.

EXAMPLES

beectl list_coexistence_profiles

beectl list_coexistence_profiles --select_users_without_profile --file users.xml

beectl list_coexistence_profiles --user user=user_loginid --show ALL

list_coexistence_status

Reports the status of the coexisting containers and coexistence profiles.

SYNTAX

beectl list_coexistence_status [--calendar] [--tasklist] [--addressbook] [--message_inbox] [--profile]

OPTIONS

--calendar

Lists calendar coexistence status.

--tasklist

Lists task list coexistence status.

--addressbook

Lists address book coexistence status.

--message_inbox

Lists message inbox coexistence status.

--profile

Lists coexistence profile registration status.

EXAMPLES

beectl list_coexistence_status

beectl list_coexistence_status --profile

beectl list_coexistence_status --calendar

list_coexistence_systems

Lists all coexisting remote systems.

SYNTAX

beectl list_coexistence_systems

OPTIONS

EXAMPLES

beectl list_coexistence_systems

list_command_metadata

Lists all the metadata about given command.

SYNTAX

beectl list_command_metadata --command_name <command name>

OPTIONS

--command_name

Command name.

EXAMPLES

beectl list_command_metadata --command_name list_command_metadata

list_commands

Lists the command names based on the given criteria.

It also lists all the available categories and actions for easy access. If the command is executed with various options then the result would be command names qualifying for ALL specified criteria rather than ONE OR MORE of the criteria.

SYNTAX

beectl list_commands (--display_actions | --display_categories | ( [--action <action name>] [--category <category name> ] [--name <substring of desired command list> ] [--advanced] [--all_visibilities])

OPTIONS

--display_actions

Displays all available actions.

--display_categories

Displays all available categories.

--action

Search will be based on given action.

--category

Search will be based on given category. This option can be supplied multiple times.

--name

Command name substring, a regular expression using * or ? can be used as option value. Blank search using * or ? meta characters only is not supported. Though these characters can be used at the end of the pattern. For example, list* is a valid pattern, but *list is not.

--advanced

Lists advanced visibility data.

--all_visibilities

Lists general and advanced visibility data.

EXAMPLES

beectl list_commands --display_actions

ectl-output_commands --display_categories

beectl list_commands --advanced

beectl list_commands --category "users" --category "coexistence" --action LIST

Above example will return all command names having general visibility, categories users, coexistence and action LIST.

beectl list_commands --category "users" --name oc4j

Above example will list all the commands which have "oc4j" in their name.

Specifying Visibility Options: Any of the following options can be used for specific visibility data.

--advanced can be passed to include advanced visibility data.

--all_visibilities can be passed to include general and advanced visibility data.

list_components

Lists components in the configuration repository.

If no option is specified, then all the components in the configuration repository will be listed.

When --type <type name> is specified all the components of that type are listed.

When --use_local_home flag is specified, only managed system components from the current ORACLE HOME is returned.

All the property values are assumed to be strings and with that assumption search is performed.

SYNTAX

beectl list_components (--display_types |[--type <type name>)] [--use_local_home] [--configuration_version <required version>])

OPTIONS

--display_types

Displays all the valid component types.

--type

Lists all components of given type.

--use_local_home

Searches only in the current ORACLE HOME.

--configuration_version

Specifies configuration version. Valid values are proposed, active or any number equivalent to creation time of the configuration snapshot. Refer to the first column from the output of command list_configuration_versions for valid snapshot identifiers.

--advanced

Lists advanced visibility data.

--all_visibilities

Lists general and advanced visibility data.

EXAMPLES

beectl list_components

beectl list_components --type ServiceInstance

Lists all the components of type ServiceInstance.

beectl list_components --display_types

Above example lists all valid component type names.

Specifying Configuration Version: Any of the following can be specified for accessing specific snapshot. If not specified, latest active snapshot will be accessed.

--configuration_version 89098787 can be passed to use snapshot having specific creation time as 89098787.

--configuration_version active can be passed for active snapshot.

--configuration_version proposed can be passed for latest proposed snapshot.

Specifying Visibility Options: Any of the following options can be used for specific visibility data.

--advanced can be passed to include advanced visibility data.

--all_visibilities can be passed to include general and advanced visibility data.

list_conference_templates

Lists conference-template artifacts under workspace

SYNTAX

beectl list_conference_templates --parent <Workspace identifier> --count-limit <A count limit for a list of conference templates>

OPTIONS

--parent

Workspace identifier

--count-limit

A count limit for a list of conference templates

EXAMPLES

beectl list_conference_templates --parent wksp=MyWorkspace,enpr=MyEnterprise

list_conferences

Lists conference artifacts under workspace

SYNTAX

beectl list_conferences --parent <Workspace identifier> --count-limit <A count limit for a list of conferences>

OPTIONS

--parent

Workspace identifier

--count-limit

A count limit for a list of conferences

EXAMPLES

beectl list_conferences --parent wksp=MyWorkspace,enpr=MyEnterprise

list_configuration_versions

Lists all available configuration versions and activation time information

SYNTAX

beectl list_configuration_versions [--configuration_version <required version>]

OPTIONS

--configuration_version

Specifies configuration version. Valid values are proposed, active or any number equivalent to creation time of the configuration snapshot. Refer to the first column from the output of command list_configuration_versions for valid snapshot identifiers.

EXAMPLES

beectl list_configuration_versions

Specifying Configuration Version: Any of the following can be specified for accessing specific snapshot. If not specified, latest active snapshot will be accessed.

--configuration_version 89098787 can be passed to use snapshot having specific creation time as 89098787.

--configuration_version active can be passed for active snapshot.

--configuration_version proposed can be passed for latest proposed snapshot.

list_connection_pools

Lists available connection pools in the system.

SYNTAX

beectl list_connection_pools [--configuration_version <required version>]

OPTIONS

--configuration_version

Specifies configuration version. Valid values are proposed, active or any number equivalent to creation time of the configuration snapshot. Refer to the first column from the output of command list_configuration_versions for valid snapshot identifiers.

EXAMPLES

beectl list_connection_pools

Specifying Configuration Version: Any of the following can be specified for accessing specific snapshot. If not specified, latest active snapshot will be accessed.

--configuration_version 89098787 can be passed to use snapshot having specific creation time as 89098787.

--configuration_version active can be passed for active snapshot.

--configuration_version proposed can be passed for latest proposed snapshot.

list_custom_user_properties

The list_custom_user_properties command lists all custom properties of users.

SYNTAX

beectl list_custom_user_properties

OPTIONS

This command has no options

EXAMPLES

beectl list_custom_user_properties

list_deleted_organizations

Lists deleted organizations

SYNTAX

beectl list_deleted_organizations

OPTIONS

This command has no options

EXAMPLES

beectl list_deleted_organizations

list_deleted_workspaces

Lists deleted workspaces

SYNTAX

beectl list_deleted_workspaces

OPTIONS

This command has no options

EXAMPLES

beectl list_deleted_workspaces

list_deployment_templates

Lists the available deployment templates in central configuration repository

SYNTAX

beectl list_deployment_templates [ --component <component id> ] [--configuration_version <required version>] [--advanced] [--all_visibilities]

OPTIONS

--component

Alias or identifier of deployment template configuration object.

--configuration_version

Specifies configuration version. Valid values are proposed, active or any number equivalent to creation time of the configuration snapshot. Refer to the first column from the output of command list_configuration_versions for valid snapshot identifiers.

--advanced

Lists advanced visibility data.

--all_visibilities

Lists general and advanced visibility data.

EXAMPLES

beectl list_deployment_templates

Specifying Configuration Version: Any of the following can be specified for accessing specific snapshot. If not specified, latest active snapshot will be accessed.

--configuration_version 89098787 can be passed to use snapshot having specific creation time as 89098787.

--configuration_version active can be passed for active snapshot.

--configuration_version proposed can be passed for latest proposed snapshot.

Specifying Visibility Options: Any of the following options can be used for specific visibility data.

--advanced can be passed to include advanced visibility data.

--all_visibilities can be passed to include general and advanced visibility data.

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.

SYNTAX

beectl list_device_commands --device <identifier of the device> [--status <device command status>]

OPTIONS

--device

Specify the identifier of the device. Use list_devices command to determine the identifier of the device.

--status

Specify the status of the device command. The following are the valid command statuses: PENDING SUCCESS ERROR WARNING

EXAMPLES

beectl list_device_commands --device 1234:5678:devi:1234567890123456789012 --status PENDING

list_device_logs

Lists the device logs for a given device.

SYNTAX

beectl list_device_logs --device <identifier of the device>

OPTIONS

--device

Specify the identifier of the device. Use list_devices command to determine the identifier of the device.

EXAMPLES

beectl list_device_logs --device 1234:5678:devi:1234567890123456789012

list_device_profiles

Lists all the device profiles.

SYNTAX

beectl list_device_profiles

OPTIONS

This command has no options

EXAMPLES

beectl list_device_profiles

list_device_types

Lists all the device types.

SYNTAX

beectl list_device_types

OPTIONS

This command has no options

EXAMPLES

beectl list_device_types

list_devices

Lists the devices either belonging to a user or with the specified device status.

SYNTAX

beectl list_devices {--user <identifier of the user>|--status <device status>} [--count_limit <count limit>]

OPTIONS

--user

Specify the identifier of the user owning the device. Use list_users command to determine the identifier of a user.

--status

Specify the status of the device. The following are the valid device statuses: ACTIVE PROVISIONED BLACKLISTED LOCKDOWN .

--count_limit

Specify the maximum number of rows to be returned.

EXAMPLES

beectl list_devices --user user=john.doe

beectl list_devices --status BLACKLISTED

list_directory_profiles

The list_directory_profiles command lists directory profiles in an XML file.

SYNTAX

beectl list_directory_profiles --file <filename>

OPTIONS

--file

XML file to be created.

EXAMPLES

beectl list_directory_profiles --file MyDirectoryProfile.xml

list_email_messages

List the email messages in a transport queue

SYNTAX

beectl list_email_messages --queue_id <queue_id> --max_count <max_count>

OPTIONS

--queue_id

The email transport queue id

--max_count

The maximum count of rows to be displayed

EXAMPLES

beectl list_email_messages --queue_id 1234 --max_count 100

list_email_queues

List the email transport queues information

SYNTAX

beectl list_email_queues

OPTIONS

This command has no options

EXAMPLES

beectl list_email_queues

list_enterprises

Lists all enterprises and prints names and identifiers

SYNTAX

beectl list_enterprises

OPTIONS

This command has no options

EXAMPLES

beectl list_enterprises

list_errorcode_catalog

List all error code definitions in beehive.

SYNTAX

beectl list_errorcode_catalog [--display_columns <STRING_LIST>] [--errorcode_range <xxxxx-yyyyy>] [--errorcode <BEEX-12345> ... ]

OPTIONS

--display_columns

Comma separated list of columns to be displayed. Valid arguments are [service, messageid, displayname, severity, cause, effect, action]

--errorcode_range

Dash-separated range of error codes to list from the catalog, without the prefix. Default: 00000-99999

--errorcode

An individual error code to display information about, including prefix.

EXAMPLES

beectl list_errorcode_catalog

Lists all error code definitions in beehive.

beectl list_errorcode_catalog --display_columns messageid,displayname,cause --errorcode_range 00400-00499

Lists the messageid, display name, and cause of all errorcodes between 00400 and 00499

beectl list_errorcode_catalog --errorcode 'BEEU-00822'

Lists all catalog information on the error BEEU-00822

list_event_groups

Lists all business object events.

SYNTAX

beectl list_event_groups [ --name <name of event group to be listed> ]

OPTIONS

--name

Specify the name of the event to be listed.

EXAMPLES

beectl list_event_groups --name MyEventGroup

list_events

Lists all business object events.

SYNTAX

beectl list_events [ --internal_name <event name to be listed> ]

OPTIONS

--internal_name

Specify the name of the event to be listed.

EXAMPLES

beectl list_events --internal_name MyEvent

list_expertise_background_jobs

Displays the status of all expertise background jobs.

SYNTAX

beectl list_expertise_background_jobs    {       [ --job <job>]       [--detail]    }

OPTIONS

--job

Job type of the expertise background job. Allowed values are CONFIDENCE_UPDATER, PROFILING_HANDLER, PROFILE_OPTIMIZER, PROFILE_TRANSFER, RELATIONSHIP_HANDLER and WHOIS_HANDLER.

--detail

A detailed view of all the specified jobs is shown.

EXAMPLES

beectl list_expertise_background_jobs --job PROFILE_TRANSFER

beectl list_expertise_background_jobs --job CONFIDENCE_UPDATER --detail true

beectl list_expertise_background_jobs --detail true

list_expertise_profiling_configuration

The list_expertise_profiling_configuration command lists the profiling configuration.

SYNTAX

beectl list_expertise_profiling_configuration

OPTIONS

This command has no options

EXAMPLES

beectl list_expertise_profiling_configuration

list_expertise_profiling_enabled_entities

The list_expertise_profiling_enabled_entities command lists all the entities for whom expertise profiling is enabled.

SYNTAX

beectl list_expertise_profiling_enabled_entities

OPTIONS

This command has no options

EXAMPLES

beectl list_expertise_profiling_enabled_entities

list_expertise_profiling_status

The list_expertise_profiling_status command lists the expertise profiling status of the user specified. The profiling status information comprises Enability, Bootstrap, Searchability statuses.

SYNTAX

beectl list_expertise_profiling_status --entity <identifier>

OPTIONS

--entity

Identifier of the entity whose expertise profiling status is to be determined. Permitted value is a valid collab id or BODN id of the entity. This option is mandatory.

EXAMPLES

beectl list_expertise_profiling_status --entity 3F5B:23D3:user:40EA125BD4941FBEE040578CA8027E89000000030E6F

beectl list_expertise_profiling_status --entity user=user1,enpr=oracle

list_expertise_relationship_blacklist_emails

The list_expertise_relationship_blacklist_emails command lists all the email addresses that have been blacklisted for expertise relationship profiling.

SYNTAX

beectl list_expertise_relationship_blacklist_emails

OPTIONS

This command has no options

EXAMPLES

beectl list_expertise_relationship_blacklist_emails

list_expertise_stop_phrases

Lists the stop phrases for expertise service.

SYNTAX

beectl list_expertise_stop_phrases    {        --enterprise <enterprise identifier>        --output_format <output_format>    }

OPTIONS

--enterprise

Identifier of the enterprise for which the stop phrases will be added.

--output_format

The output format for stop phrases. Only XML format is supported.

EXAMPLES

beectl list_expertise_stop_phrases --enterprise enpr=Example

beectl list_expertise_stop_phrases --enterprise enpr=Example --output_format XML

list_expertise_user_scopes

The list_expertise_user_scopes command lists all expertise user scope or detailed version of supplied expertise user scope CollabId/BODN with --expertise_user_scope option.

SYNTAX

beectl list_expertise_user_scopes [--output_format <XML>] [--expertise_user_scope <BODN or CollabId>]

OPTIONS

--output_format

Output format

--expertise_user_scope

CollabId or BODN format of the expertise user scope to be detailed.

EXAMPLES

beectl list_expertise_user_scopes --output_format XML

beectl list_expertise_user_scopes --expertise_user_scope exus=ExpertiseUserScopeName,enpr=Oracle

beectl list_expertise_user_scopes --expertise_user_scope 416E:25BF:exus:6A9CBED7822AA32EE040578C5C8453AB000000018705

list_external_contacts

The list_external_contacts command lists contacts that match specified search criteria. If search criteria are not specified, then all contacts are listed. It also lists the details of the contact(s) whose identifier is specified.

SYNTAX

beectl list_external_contacts    {        --count <true|false>      |        --contact <identifier of external contact >        [ --show <show attributes(ALL|MORE)> ]       |        --email_id <Email address of the user>       [ --show <show attributes(ALL|MORE)>  ]      |        [ --family_name <family name of the contact> ... ]       [ --given_name <given name of the contact> ... ]        [ --display_name <display name of the contact> ... ]       [ --middle_name <middle name of the contact> ... ]        [ --job_title <job title of the contact> ... ]       [ --prefix <prefix of the contact> ... ]        [ --suffix <suffix of the contact> ... ]        [ --nick_name <nick name of the contact> ... ]        [ --office_location <office location of the contact> ... ]        [ --company <company of the contact> ... ]        [ --profession <profession of the contact> ... ]        [ --department <department of the contact> ... ]        [ --organization <organization identifier> ... ]        [ --property <name(assistant|certificate|notes)=value=description> ... ]        [ --address <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ]        [ --status <status of user(enabled|disabled|locked|marked_for_delete)> ... ]        [ --is_deleted <true|false>  ]        [ --created_by <identifier of creator> ... ]        [ --modified_by <identifier of modifier> ... ]        [ --match <match attributes(ANY|ALL)> ]        [ --show <show attributes(ALL|MORE)> ]     }

OPTIONS

--contact

The identifier of the external contact

--email_id

Email id of the external contact

--family_name

Family name of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--given_name

Given name of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--display_name

Display name of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--middle_name

Middle name of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--job_title

Job title of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--prefix

Prefix of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--suffix

Suffix of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--nick_name

ta_type="STRING">Feed type of the feed configuration. Permitted vaed. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--office_location

Office location of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--company

Company of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--profession

Profession of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--department

Department of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--organization

Identifiers of the organizations the contact belongs to.

--property

Details of the property in the format name=value. Supported names are certificate, assistant and notes. Note, no equals to symbol(=) should be present in the name or value.

--address

Address of the contact in the format type:scheme:value. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.

--status

Sets the provisioning status of the external contact. Sets the provisioning status of the user. Supported values are ENABLED, DISABLED, LOCKED.

--is_deleted

Contacts whose provisioning status is deleted.

--created_by

Identifier of the entity who created the contact.

--modified_by

Identifier of the entity who modified the contact.

--count

Lists the number of contacts. When this option is used, no other information about the contacts is listed.

--show

Lists some or all the attributes of the contact. Valid values are ALL or MORE. If nothing is specified the default important attributes are listed.

--match

Lists all contacts whose attributes match either one or more or all the predicates passed. Permitted values are ALL or ANY. Default is ALL.

EXAMPLES

beectl list_external_contacts

beectl list_external_contacts --count

beectl list_external_contacts --contact 6A95:21EB:extp:D9E9FC8134544BCE9D60559F9B997CCD000000000000 --show ALL

beectl list_external_contacts --email_id person1@example.com --show MORE

beectl list_external_contacts --given_name User1GivenName --show ALL

beectl list_external_contacts --given_name User1% --office_location 4A0% --match ALL --show MORE

list_failed_action_events

List actions that have not completed successfully.

SYNTAX

beectl list_failed_action_events [ --bucket <Partition number> --sequence <Sequence number> ]

OPTIONS

--bucket

Partition number

--sequence

Sequence number

EXAMPLES

beectl list_failed_action_events --bucket MyBucketNumber --sequence MySequenceNumber

list_feed_configurations

The list_feed_configurations command lists the feed configurations in the given scope.

SYNTAX

beectl list_feed_configurations    {        --scope <scope identifier>       [--feedtype <feed type >]       | [--feedtype <feed type > --effective_feed_configuration]    }

OPTIONS

--scope

Scope in which the feed configuration will be created

--feedtype

st_groups --count </example_message> <examplues are ANNOUNCEMENT, FORUM, FOLDER, LABEL, RECENT, TOPIC and VERSION.

--effective_feed_configuration

Get the effective feed configuration associated with the given scope. Default is true.

EXAMPLES

beectl list_feed_configurations --scope enpr=example

beectl list_feed_configurations --scope enpr=example --feedtype RECENT --effective_feed_configuration True

list_file_plan

Lists the file plan.

SYNTAX

beectl list_file_plan

OPTIONS

This command has no options

EXAMPLES

beectl list_file_plan

list_filesystem_references

Lists the filesystem path, read-only status, and identifier of all available filesystem references.

SYNTAX

beectl list_filesystem_references

OPTIONS

This command has no options

EXAMPLES

beectl list_filesystem_references

list_groups

The list_groups command lists groups that match specified search criteria. If search criteria are not specified, then all groups are listed.

SYNTAX

beectl list_groups    {        --count <true|false>     |        --group <Identifier of the group>        [ --show <show attributes(ALL|MORE|MEMBERS)> ]       |        --email <Email address of the group>       [ --show <show attributes(ALL|MORE|MEMBERS)>  ]      |        [ --name <name of the group> ... ]       [ --description <description of the group> ... ]        [ --scope <scope of the group> ... ]       [ --organization <organization identifier> ... ]        [ --property <name(is_auto_confirm_on|moderator)=value=description> ... ]       [ --address <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value>  ]        [ --is_deleted <true|false> ... ]        [ --created_by <identifier of creator> ... ]        [ --modified_by <identifier of modifier> ... ]        [ --match <match attributes(ANY|ALL)> ]        [ --show <show attributes(ALL|MORE|MEMBERS)> ]     }

OPTIONS

--group

Identifier of the group

--email

Email id of the group

--name

Name of the group. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--description

Description of the group. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--scope

Scope or parent identifier of the group.

--organization

Identifiers of the organizations the group belongs to.

--property

Details of the property in the format name=value. Supported names are is_auto_confirm_on, moderator. Note, no equals to symbol(=) should be present in the name or value.

--address

Address of the group in the format type:scheme:value. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.

--is_deleted

Groups whose status is deleted.

--created_by

Identifier of the entity who created the group.

--modified_by

Identifier of the entity who modified the group.

--count

Lists the number of groups. When this option is used, no other information about the groups is listed.

--show

Lists some or all attribute or the members of the group. Valid values are ALL or MORE OR MEMBERS. If nothing is specified the default important attributes are listed.

--match

Lists groups whose attributes match either one or more or all the predicates passed. Permitted values are ALL or ANY. Default is ALL.

EXAMPLES

beectl list_groups

beectl list_groups --count

beectl list_groups --group grup=group1,enpr=example --show all

beectl list_groups --email group1@example.com --show more

beectl list_groups --group grup=group1,enpr=example --show MEMBERS

beectl list_groups --name Group1Name --show all

beectl list_groups --name Group1% --scope enpr=enpr1 --match all --show more

list_ischedule_servers

List remote iSchedule Server configurations.

SYNTAX

beectl list_ischedule_servers [--name <name>]

OPTIONS

--name

Name of the remote server configuration, can contain only alpha numerical characters, underscores and dashes.

EXAMPLES

beectl list_ischedule_servers --name remoteserver

list_language_pack

Displays summarized informations for the resources in language pack. The search criteria can include a combination of string contained in the resource name, locale of the resource, type of resource (built-in or custom). Note that only resources matching ALL (as compared to ANY) specified search criteria are displayed.

SYNTAX

beectl list_language_pack [--full | --base_name --locale --only_built_in --only_custom]

OPTIONS

--full

List all resources in the language pack.

--base_name

List resources containing the specified name.

--locale

List resources with the specified locale.

--only_built_in

List only built-in resources.

--only_custom

List only custom resources.

EXAMPLES

Below command will display summarized information for resources which have been localized for English locale with names containing the string CommandImplRB, irrespective of whether they are built-in or custom.

beectl list_language_pack --base_name CommandImplRB --locale en

list_ldap_change_number

Lists the last change-log number processed by beehive for specified profile.

SYNTAX

beectl list_ldap_change_number --profile <profile>

OPTIONS

--profile

Name of the profile.

EXAMPLES

beectl list_ldap_change_number --profile MyDirectoryProfileName

list_local_acl

Lists the Local Access Control List (LACL) of an entity.

SYNTAX

beectl list_local_acl --entity <unique identifier of the entity>

OPTIONS

--entity

Specify the unique identifier of the entity for which the Local Access Control List (LACL) should be listed.

EXAMPLES

beectl list_local_acl --entity adoc=MyDocument,wksp=MyWorkspace,enpr=MyEnterprise

list_max_address_count

The list_max_address_count command lists the maximum number of addresses of an address type that can be set for a given person-contact, group-contact or resource-contact in an address-book. The address types determine the type of address like BUSINESS, PERSONAL and OTHER. This command also lists the system defined maximum limit, which cannot be exceeded.

SYNTAX

beectl list_max_address_count

OPTIONS

This command has no options

EXAMPLES

beectl list_max_address_count

list_my_conferences

Lists conference artifacts under workspace

SYNTAX

beectl list_my_conferences --count-limit <A count limit for a list of conferences>

OPTIONS

--count-limit

A count limit for a list of conferences

EXAMPLES

beectl list_my_conferences --count-limit 1000

list_operation_statuses

List the Operation Statuses

SYNTAX

beectl list_operation_statuses [--operation_status <CollabId of the Operation Status you would like to display.>] [--name <List Operation Statuses with this name.>] [--status_code <COMPLETED | EXECUTING | FAILED | TIMED_OUT.  List Operation Statuses with this status code.>] [--operation <List Operation Statuses with this Operation.>] [--sort_by <name | modified_on. The sort order of the Operation Statuses.  Sorting by name will be ascending and sorting by modified_on will be descending.  Default is sorting by name.>]

OPTIONS

--operation_status

CollabId of the Operation Status you would like to display.

--name

List Operation Statuses with this name.

--status_code

COMPLETED | EXECUTING | FAILED | TIMED_OUT. List Operation Statuses with this status code.

--operation

List Operation Statuses with this Operation.

--sort_by

name | modified_on. The sort order of the Operation Statuses. Sorting by name will be ascending and sorting by modified_on will be descending. Default is sorting by name.

--countLimit

The maximum number of Operation Statuses that will be returned. If not specified, 200 will be returned.

EXAMPLES

beectl list_operation_statuses --operation_status 1CF3:35AF:opst:6828B43CD3944E06A5CD425F0225CF2500000000004C

beectl list_operation_statuses --status_code EXECUTING --sort_by modified_on

list_organizations

Lists organizations in the given scope

SYNTAX

beectl list_organizations --scope <Identifier of enterprise or organization> [--recurse <TRUE|FALSE. Default value is FALSE. Recursively list organizations>] [--name <Organization name>]

OPTIONS

--scope

Identifier of the parent scope (enterprise or organization)

--recurse

TRUE|FALSE. Default value is FALSE. Recursively list organizations

--name

Organization name

EXAMPLES

beectl list_organizations --scope enpr=test_enterprise --recurse TRUE

beectl list_organizations --scope enpr=test_enterprise --name MyOrg

list_patch_informations

Lists the patch information for given archives.

SYNTAX

beectl list_patch_informations (--archive_directory <directory containing archives> | --archive_file <archive file> )

OPTIONS

--archive_directory

Directory in which archives will be searched.

--archive_file

Enterprise archive file for listing the patch information.

EXAMPLES

beectl list_patch_informations --archive_file /tmp/some_service.ear --archive_file /tmp/some_service2.ear

Above command will list private and public patch numbers for given archive files.

beectl list_patch_informations --archive_directory /seed/archive/

Above command will list private and public patch numbers for all the files available in the given directory.

list_policies

Lists policies in an specific container. Details returned include policy names and identifiers.

SYNTAX

beectl list_policies [ --policy_name <name of the policy to be listed> ] [ --scope <container where the policy is deployed> ] [ --children <boolean specifying whether to include policies defined at child containers> ] [ --enforced <boolean specifying whether to include enforced policies> ][ --policy_type <name of the policy classification to be listed> ]

OPTIONS

--policy_name

Specify the name of the policy.

--scope

Specify the identifier of the container where policy is deployed.

--children

Specify whether to include policies defined at child containers.

--enforced

Specify whether to include enforced policies.

--policy_type

Specify the type of policy to list [general|audit|record]. Default is [general].

EXAMPLES

beectl list_policies --policy_name MyPolicy --scope enpr=MyEnterprise --children true --enforced false--policy_type policyType

list_policy_actions

Lists all policy actions.

SYNTAX

beectl list_policy_actions

OPTIONS

This command has no options

EXAMPLES

beectl list_policy_actions

list_policy_schemas

Lists policy schemas in the current enterprise. Details returned include policy schema names and identifiers.

SYNTAX

beectl list_policy_schemas --name <name of the policy schema> --policy_type <name of the policy classification to be listed>

OPTIONS

--name

Specify the name of the policy schema.

--policy_type

Specify the type of policy to list [general|audit|record]. Default is [general].

EXAMPLES

beectl list_policy_schemas --name ExamplePolicySchema --name policyType

list_policy_templates

Lists policy templates in a specified container. Details returned include policy template names and identifiers.

SYNTAX

beectl list_policy_templates --name <name of the policy template to be listed> --scope <container where the policy template is defined>--policy_type <name of the policy classification to be listed>

OPTIONS

--name

Specify the name of the policy template.

--scope

Specify the identifier of the container where policy template is deployed.

--policy_type

Specify the type of policy to list [general|audit|record]. Default is [general].

EXAMPLES

beectl list_policy_templates --name ExamplePolicyTemplate --scope enpr=oracle --policy_type policyType

list_ports

Lists various available ports.

By default it shows ports used by current midtier only.

Valid protocols are

SMTP

IMAP

XMPP

XMPPS

FTP

HTTP

HTTPS

BTP

BTPS

OC4J-JGROUP-RANGE

OC4J-AJP-RANGE

OC4J-RMI-RANGE

OC4J-RMIS-RANGE

OC4J-JMS-RANGE

OC4J-SIP-RANGE

OC4J-AJP-RANGE identifies the range of ports in current site for either AJP or secure AJP protocol whichever is enabled.

Description of command output:-

ists general and advanced visibility data.</option> </options> <descr

2- Listen Port:- The value of the port on which listening component is listenning. This is the value which will be seen in operating system port management utilities like netstat.

3- Virtual Port:- Port to which the clients will connect. This value is for entire site.

4- Defining Component:- Identifier of the component, port property is modeled.

5- Property Name:- Name of the property for port on the defining configuration object.

6- Listen Component:- Identifier of the configuration object which listens on the listen port.

SYNTAX

beectl list_ports [--instance <beehive instance system identifier or alias>] [--all] [--configuration_version <required version>]

OPTIONS

--instance

System object identifier of Beehive Instance for which ports should be shown.

--all

Flag indicating if all the ports in the system should be listed.

--configuration_version

Specifies configuration version. Valid values are proposed, active or any number equivalent to creation time of the configuration snapshot. Refer to the first column from the output of command list_configuration_versions for valid snapshot identifiers.

EXAMPLES

beectl list_ports --all

Above example lists ports used by all the midtiers.

Specifying Configuration Version: Any of the following can be specified for accessing specific snapshot. If not specified, latest active snapshot will be accessed.

--configuration_version 89098787 can be passed to use snapshot having specific creation time as 89098787.

--configuration_version active can be passed for active snapshot.

--configuration_version proposed can be passed for latest proposed snapshot.

list_preference_profiles

The list_preference_profiles command lists preference profiles for a consumer.

SYNTAX

beectl list_preference_profiles --consumer <Identifier of the consumer>

OPTIONS

--consumer

Identifier of the consumer

EXAMPLES

beectl list_preference_profiles --consumer user=user1

list_preference_properties

The list_preference_properties command lists all effective preference properties of a preference set.

SYNTAX

beectl list_preference_properties --set <Identifier of the preference set specified in id format, which can be determined by running list_preference_sets command with "--entity_format id" option.>

OPTIONS

--set

Identifier of the preference set specified in id format, which can be determined by running list_preference_sets command with "--entity_format id" option.

EXAMPLES

beectl list_preference_properties --set prfs=set1,user=user1

list_preference_sets

The list_preference_sets command lists all preference sets for a preference profile.

SYNTAX

beectl list_preference_sets --profile <Preference profile identifier>

OPTIONS

--profile

Identifier of the preference profile.

EXAMPLES

beectl list_preference_sets --profile prfp=MyProfile,user=user1

list_privileges

Lists available Privilege names.

SYNTAX

beectl list_privileges

OPTIONS

This command has no options

EXAMPLES

beectl list_privileges

list_properties

Prints property value of a component given a component identifier and property name. If property name is not specified then all the properties will be listed.

SYNTAX

beectl list_properties --component <system object identifier or alias of the component> [--name <name>] [--configuration_version <required version>] [--advanced] [--all_visibilities]

OPTIONS

--component

Component identifier

--name

Name of the property

--configuration_version

Specifies configuration version. Valid values are proposed, active or any number equivalent to creation time of the configuration snapshot. Refer to the first column from the output of command list_configuration_versions for valid snapshot identifiers.

--advanced

Lists advanced visibility data.

--all_visibilities

Lists general and advanced visibility data.

EXAMPLES

beectl list_properties --component 288d5051-2632-4800-b796-b3e16ca58f2d

Specifying Configuration Version: Any of the following can be specified for accessing specific snapshot. If not specified, latest active snapshot will be accessed.

--configuration_version 89098787 can be passed to use snapshot having specific creation time as 89098787.

--configuration_version active can be passed for active snapshot.

--configuration_version proposed can be passed for latest proposed snapshot.

Specifying Visibility Options: Any of the following options can be used for specific visibility data.

--advanced can be passed to include advanced visibility data.

--all_visibilities can be passed to include general and advanced visibility data.

list_property_metadata

Lists the metadata about all the properties of a system model object.

SYNTAX

beectl list_property_metadata --type <System model object type> [--full_report]

OPTIONS

--type

Type of the component for which property metadata to be listed.

--full_report

Flag indicating if full report should be displayed. It contains description about properties also.

EXAMPLES

beectl list_property_metadata --type WorkspacesService

list_remote_repositories

Lists remote repositories.

SYNTAX

beectl list_remote_repositories --scope <Remote Repository Container.> [ --name <Remote Repository Name.>]

OPTIONS

--scope

Remote Repository Container.

--name

Remote Repository Name.

EXAMPLES

beectl list_remote_repositories --scope myRemoteRepositoryScope --name myRemoteRepositoryName

list_remote_repository_definitions

Lists seeded remote repository definitions.

SYNTAX

beectl list_remote_repository_definitions [ --name <Remote Repository Definition Name.>]

OPTIONS

--name

Remote Repository Definition Name.

EXAMPLES

beectl list_remote_repository_definitions --name myRemoteRepositoryDefinitionName

list_remote_shares

Lists remote shares.

SYNTAX

beectl list_remote_shares --scope <Remote Share Container.> [ --name <Remote Share Name.>]

OPTIONS

--scope

Remote Share Container.

--name

Remote Share Name.

EXAMPLES

beectl list_remote_shares --scope myRemoteShareScope --name myRemoteShareName

list_resources

Lists resources.

SYNTAX

beectl list_resources {[--select_by_name <name_regex>] | [--select_by_identifier <identifier_regex>] | [--select_by_capacity <capacity>]} [--external] [--show <DEFAULT | ALL | MORE>]

OPTIONS

--select_by_name

Specify the resource name criteria. This option accepts a regular expression match.

--select_by_identifier

Specify the resource identifier criteria. This option accepts a regular expression match.

--select_by_capacity

Specify the resource capacity.

--external

List external resources. If this option is not specified, only bookableresources will be listed.

--show

t; ] ]<ome or all the attributes of the resource. Valid values are DEFAULT, ALL or MORE. If nothing (or DEFAULT) is specified the default important attributes are listed.

EXAMPLES

beectl list_resources --select_by_name "Resource"

list_role_definitions

Lists RoleDefinition entities.

SYNTAX

beectl list_role_definitions [--scope <unique identifier of the Scope>] [--name <like string>]

OPTIONS

--scope

Specify the unique identifier of the Scope of the RoleDefinitions to be listed. If not specified the Scope will be the Enterprise.

--name

Specify the name pattern of the RoleDefinitions to be listed. If not specified all accessible RoleDefinitions will be returned.

EXAMPLES

beectl list_role_definitions --scope wksp=MyWorkspace,enpr=MyEnterprise --name MyRoleDefinition

list_schema_clones

Search the ocs_clone_registry table based on the specified options and display the matched clone records.

SYNTAX

beectl list_schema_clones [ --orig_schema_id <from_schema_id> ] [ --cloned_schema_id <to_schema_id> ] [ --phase <clone_phase> ] [ --status <clone_status> ] [ [ --start_time <clone_start_time> ] | [ --start_time_from <from_time> ] [ --start_time_to <to_time> ] ] [ [ --end_time <clone_end_time> ] | [ --end_time_from <from_time> ] [ --end_time_to <to_time> ] ] [ --description <schema_description> ] [ [ --maximum_results <max_results> ] [ --sort_by <sort_colum_name> ] [ --display_column <display_column> ] | [ --count_only <true/false> ] ]

OPTIONS

--orig_schema_id

Option used to match the original schema id from which the new schema is cloned.

--cloned_schema_id

Option used to match the new schema id which is being cloned.

--phase

Option used to match the clone phase.

--status

Option used to match the clone status.

--start_time

The time stamp option specified to match the clone start time.

--start_time_from

The time stamp option specified as the lower inclusive bound to match the clone start time.

--start_time_to

The time stamp option specified as the upper inclusive bound to match the clone start time.

--end_time

The time stamp option specified to match the clone end time.

--end_time_from

The time stamp option specified as the lower inclusive bound to match the clone end time.

--end_time_to

The time stamp option specified as the upper inclusive bound to match the clone end time.

--description

Option used to match the description.

--maximum_results

Option specified to limit the returned results. This option will be ignored, if the count_only option is true.

--sort_by

Option specified the column name by which the returned result will be sorted. Valid column names are: <CLONENO | ORIG_SCHEMA_ID | CLONED_SCHEMA_ID | PHASE | STATUS | START_TIME | END_TIME | DESCRIPTION>.

--display_column

Option specify which column to display. Valid column names are: <CLONENO | ORIG_SCHEMA_ID | CLONED_SCHEMA_ID | PHASE | STATUS | START_TIME | END_TIME | DESCRIPTION>.

--count_only

Option specified to only return only the total count of records matching the criteria.

EXAMPLES

beectl list_schema_clones --start_time_from 2008-07-10T00:00:00 --start_time_to 2008-07-10T23:59:59 --orig_schema_id 56 --display_column ORIG_SCHEMA_ID --display_column CLONED_SCHEMA_ID --display_column STATUS --maximum_results 200

beectl list_schema_clones --count_only true

list_schemas

Search the ocs_schema_registry table based on the specified options and display the matched schema records.

SYNTAX

beectl list_schemas [ --schema_name <name> ] [ --schema_id <id> ] [ --version_id <id> ] [ --schema_type <type> ] [ --status <status> ] [ --description <description> ] [ [ --creation_time <time> ] | [ --creation_time_from <from_time> ] [ --creation_time_to <to_time> ] ] [ [ --activationready_time <time> ] | [ --activationready_time_from <from_time> ] [ --activationready_time_to <to_time> ] ] [ [ --upgradeready_time <time> ] | [ --upgradeready_time_from <from_time> ] [ --upgradeready_time_to <to_time> ] ] [ [ --activation_time <time> ] | [ --activation_time_from <from_time> ] [ --activation_time_to <to_time> ] ] [ [ --legacy_time <time> ] | [ --legacy_time_from <from_time> ] [ --legacy_time_to <to_time> ] ] [ [ --24} <time> ] | [ --deacitvation_time_from <from_time> ] [ --deacitvation_time_to <to_time> ] ] [ [ --deinstall_time <time> ] | [ --deinstall_time_from <from_time> ] [ --deinstall_time_to <to_time> ] ] [ [ --maximum_results <max_results> ] [ --sort_by <sort_colum_name> ] [ --sort_by <display_column> ] | [ --count_only <true/false> ] ]

OPTIONS

--schema_name

Option used to match the schema name.

--schema_id

Option used to match the schema id.

--version_id

Option used to match the version id.

--schema_type

Option used to match the schema type.

--status

Option used to match the schema status.

--creation_time

The time stamp option specified to match the creation time.

--creation_time_from

The time stamp option specified as the lower inclusive bound to match the creation time.

--creation_time_to

The time stamp option specified as the upper inclusive bound to match the creation time.

--activationready_time

The time stamp option specified to match the activation ready time.

--activationready_time_from

The time stamp option specified as the lower inclusive bound to match the activation ready time.

--activationready_time_to

The time stamp option specified as the upper inclusive bound to match the activation ready time.

--upgradeready_time

The time stamp option specified to match the upgrade ready time.

--upgradeready_time_from

The time stamp option specified as the lower inclusive bound to match the upgrade ready time.

--upgradeready_time_to

The time stamp option specified as the upper inclusive bound to match the upgrade ready time.

--activation_time

The time stamp option specified to match the activation time.

--activation_time_from

The time stamp option specified as the lower inclusive bound to match the activation time.

--activation_time_to

The time stamp option specified as the upper inclusive bound to match the activation time.

--legacy_time

The time stamp option specified to match the legacy time.

--legacy_time_from

The time stamp option specified as the lower inclusive bound to match the legacy time.

--legacy_time_to

The time stamp option specified as the upper inclusive bound to match the legacy time.

--deacitvation_time

The time stamp option specified to match the deactivation time.

--deacitvation_time_from

The time stamp option specified as the lower inclusive bound to match the deactivation time.

--deacitvation_time_to

The time stamp option specified as the upper inclusive bound to match the deactivation time.

--deinstall_time

The time stamp option specified to match the deinstall time.

--deinstall_time_from

The time stamp option specified as the lower inclusive bound to match the deinstall time.

--deinstall_time_to

The time stamp option specified as the upper inclusive bound to match the deinstall time.

--description

Option used to match the description.

--maximum_results

Option specified to limit the returned results. This option will be ignored, if the count_only option is true.

--sort_by

Option specified the column name by which the returned result will be sorted. Valid column names are: <SCHEMA_NAME | SCHEMA_ID | VERSION_ID | SCHEMA_TYPE | STATUS | CREATION_TIME | ACTIVATIONREADY_TIME | UPGRADEREADY_TIME | ACTIVATION_TIME | LEGACY_TIME | DEACTIVATION_TIME | DEINSTALL_TIME | DESCRIPTION>.

--display_column

Option specify which column to display. Valid column names are: <SCHEMA_NAME | SCHEMA_ID | VERSION_ID | SCHEMA_TYPE | STATUS | CREATION_TIME | ACTIVATIONREADY_TIME | UPGRADEREADY_TIME | ACTIVATION_TIME | LEGACY_TIME | DEACTIVATION_TIME | DEINSTALL_TIME | DESCRIPTION>.

--count_only

Option specified to only return only the total count of records matching the criteria.

EXAMPLES

beectl list_schemas --creation_time_from 2008-07-10T00:00:00 --creation_time_to 2008-07-10T23:59:59 --schema_name BEE_CODE --display_column schema_name --display_column schema_id --display_column creation_time --maximum_results 200

beectl list_schemas --count_only true

list_sensitivities

Lists Sensitivity entities.

SYNTAX

beectl list_sensitivities --workspace <unique identifier of the Workspace> [--name <like string>]

OPTIONS

--workspace

Specify the unique identifier of the Workspace of the Sensitivities to be listed.

--name

Specify the name pattern for the Sensitivities to be listed. If not specified all accessible Sensitivities will be returned.

EXAMPLES

beectl list_sensitivities --workspace wksp=MyWorkspace,enpr=MyEnterprise --name MySensitivity

list_sensitivity_acl

Lists the Sensitivity Access Control List (SACL) of a Sensitivity.

SYNTAX

ecify the uniqnsitivity_acl --sensitivity <unique identifier of the Sensitivity>

OPTIONS

--sensitivity

Specify the unique identifier of the Sensitivity whose Sensitivity Access Control List (SACL) should be listed.

EXAMPLES

beectl list_sensitivity_acl --sensitivity acsn=MySensitivity,wksp=MyWorkspace,enpr=MyEnterprise

list_statistics

Lists the statistics for a given type or component or for the entire site.

SYNTAX

beectl list_statistics ([--type <System model object type>] [--component <stat provider system model object identifier or alias>] | [--all_components]) [--advanced] [--all_visibilities]

OPTIONS

--type

Type of the component for which statistics to be listed.

--component

System object identifier of the component for which statistics to be listed.

--all_components

If specified, statistics for all components will be listed.

--advanced

Lists advanced visibility data.

--all_visibilities

Lists general and advanced visibility data.

EXAMPLES

beectl list_statistics --type WorkspacesServiceInstance

Above example will list statistics for WorkspacesServiceInstance with GENERAL visibility.

Specifying Visibility Options: Any of the following options can be used for specific visibility data.

--advanced can be passed to include advanced visibility data.

--all_visibilities can be passed to include general and advanced visibility data.

list_supported_entity_types

Prints the supported entity types which can be used in business object distinguished naming pattern instead of system generated identifier and their description.

If a value contains \ (back slash) or a , (comma), then it has to be escaped using back slash. For example, "wksp=Personal workspace\, Admin,orgn=HR,enpr=oracle" refers to Workspace of name "Personal workspace, Admin" that exists in Organization "HR" that exists directly in Enterprise "Oracle".

SYNTAX

beectl list_supported_entity_types

OPTIONS

This command has no options

EXAMPLES

beectl list_supported_entity_types

list_tasklist_permissions

List the access control permissions of a user, resource or workspace's tasklist. When multiple tasklists match the selection criteria for the user, resource or workspace, the default tasklist will be used.

SYNTAX

beectl list_tasklist_permissions { --tasklist <tasklistid> | --tasklistowner <unique_identifier> | --select_by_address <uri> | --select_by_authuser <authuser> --select_by_user_name <user_name> | --select_by_resource_name <resource_name> | --select_by_workspace_name <workspace_name> }

OPTIONS

--tasklist

Specify the unique identifier of a tasklist.

--tasklistowner

Specify the unique identifier of a user, resource or team workspace.

--select_by_address

Specify the Uniform Resource Identifier (URI) of a user, resource or team workspace using the format 'scheme:value'. If scheme is not supplied, mailto is assumed.

--select_by_authuser

Specify the login name of a user.

--select_by_user_name

Specify the name of a user.

--select_by_resource_name

Specify the name of a resource.

--select_by_workspace_name

Specify the name of a team workspace.

EXAMPLES

beectl list_tasklist_permissions --select_by_address user@example.com

list_tasklists

Lists existing tasklists of a user, resource or workspace.

SYNTAX

beectl list_tasklists { --tasklist <tasklistid> --tasklistowner <unique_identifier> | --select_by_address <uri> | --select_by_authuser <authuser> --select_by_user_name <user_name> | --select_by_resource_name <resource_name> | --select_by_workspace_name <workspace_name> }[--show <DEFAULT | ALL | MORE>]

OPTIONS

--tasklist

<usage>beecue identifier of a tasklist.

--tasklistowner

Specify the unique identifier of a user, resource or team workspace.

--select_by_address

Specify the Uniform Resource Identifier (URI) of a user, resource or team workspace using the format 'scheme:value'. If scheme is not supplied, mailto is assumed.

--select_by_authuser

Specify the login name of a user.

--select_by_user_name

Specify the name of a user.

--select_by_resource_name

Specify the name of a resource.

--select_by_workspace_name

Specify the name of a team workspace.

--show

Lists some or all the attributes of the tasklist. Valid values are DEFAULT, ALL or MORE. If nothing (or DEFAULT) is specified the default important attributes are listed.

EXAMPLES

beectl list_tasklists --select_by_address user@example.com

list_template_evolution_target_workspaces

Lists the workspaces to which the latest version of the given workspace template needs to be applied to make the workspaces conform to the latest version of the template

SYNTAX

beectl list_template_evolution_target_workspaces --template <Workspace template identifier> --limit <Maximum number of workspaces to upgrade>

OPTIONS

--template

Workspace template identifier

--limit

Maximum number of workspaces to upgrade

EXAMPLES

beectl list_template_evolution_target_workspaces --template wstp=test_team_ws_template,enpr=test_enterprise --limit 100

list_timezones

Lists time zones in the database.

SYNTAX

beectl list_timezones [--all] | [--select_by_common] [--select_by_name <TimezoneName>]

OPTIONS

--all

Lists all time zones. This option cannot be used with the --select_by_name or --select_by_common option.

--select_by_common

Lists common time zones. This is the default when no options are specified.

--select_by_name

Specifies a time zone name. To list all time zones, use an asterisk(*) as the options value.

EXAMPLES

beectl list_timezones --all

beectl list_timezones --select_by_common

beectl list_timezones --select_by_name Asia/Shanghai

beectl list_timezones --select_by_common --select_by_name Asia/Shanghai

list_trusted_identity

This command lists the trusted identities. The type has to be specified. For type SES, it lists the names of the trusted entities.

SYNTAX

beectl list_trusted_identity --type <(WSSEC|S2S|SES)>

OPTIONS

--type

Type of the trusted identity. Permitted values are SES or WSSEC. SES refers to Secure Enterprise Search. WSSEC refers to Web services security.

EXAMPLES

list_user_subscriptions

List user subscriptions

SYNTAX

beectl list_user_subscriptions --subscriber <identifier of subscriber> [ --attach <identifier of attached entity> --source_entity_class <sourceEntityClass of template> ]

OPTIONS

--subscriber

Specify the identifier of the subscriber who owns the subscription.

--attach

Specify the Identifier of the entity to which the subscription is attached.

--source_entity_class

Specify the name of the source entity Class that is defined in subscription template.

EXAMPLES

beectl list_user_subscriptions --subscriber user=user1

list_users

The list_users command lists users that match specified search criteria. If search criteria are not specified, then all users are listed.

SYNTAX

oratl list_users    {        --count <true|false>     |        --user <User Identifier>        [ --show <show attributes(ALL|MORE)> ]       |        --email <Email address of the user>       [ --show <show attributes(ALL|MORE)>  ]      |        [ --family_name <family name of the user> ... ]       [ --given_name <given name of the user> ... ]        [ --display_name <display name of the user> ... ]       [ --middle_name <middle name of the user> ... ]        [ --job_title <job title of the user> ... ]       [ --prefix <prefix of the user> ... ]        [ --suffix <suffix of the user> ... ]        [ --nick_name <nick name of the user> ... ]        [ --office_location <office location of the user> ... ]        [ --company <company of the user> ... ]        [ --profession <profession of the user> ... ]        [ --department <department of the user> ... ]        [ --organization <organization identifier> ... ]        [ --property <name=value=description> ... ]        [ --address <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ]        [ --status <status of user(enabled|disabled|locked|marked_for_delete)> ... ]        [ --is_deleted <true|false>  ]        [ --created_by <identifier of creator> ... ]        [ --modified_by <identifier of modifier> ... ]        [ --match <match attributes(ANY|ALL)> ]        [ --show <show attributes(ALL|MORE)> ]        [ --manager <manager identifier> ]        [ --extended_enterprise_user <true|false> ]        [ --is_locked <locked status(user)> ]        [ --external_inbox <true|false> ]     }

OPTIONS

--user

Identifier of the user.

--email

Exact email id of the user whose details have to be retrieved. It should be in the format user1@example.com

--family_name

Family name of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--given_name

Given name of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--display_name

Display name of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--middle_name

Middle name of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--job_title

Job title of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--prefix

Prefix of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--suffix

Suffix of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--nick_name

Nickname of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--office_location

Office location of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--company

Company of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--profession

Profession of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--department

Department of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.

--manager

Identifier of the manager.

--organization

Identifiers of the organizations the user belongs to.

--property

Details of the property in the format name=value. All custom properties are supported. Note, no equals to symbol(=) should be present in the name or value.

--address

ive bound for matching with the scan date.</option> <option name="scandate_to" mandatory="false" data_type="DATE_TIME">Value specified will be used as the upper inclusive bound for matching with the scan date. </option> <option name="virus_name" mandatory="false" data_type="STRING">Value specified wradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.

--status

Sets the provisioning status of the user. Supported values are ENABLED, DISABLED.

--is_deleted

Users whose provisioning status is deleted.

--extended_enterprise_user

Lists all extended enterprise user.

--external_inbox

Lists all users whose external inbox is set.

--created_by

Identifier of the entity who created the user.

--modified_by

Identifier of the entity who modified the user.

--count

Lists the number of users. When this option is used, no other information about the users is listed.

--show

Lists some or all the attributes of the user. Valid values are ALL or MORE. If nothing is specified the default important attributes are listed.

--match

Lists users whose attributes match either one or more or all the predicates passed. Permitted values are ALL or ANY. Default is ALL.

--is_locked

locked status of user, valid value is (user).

EXAMPLES

beectl list_users

beectl list_users --count

beectl list_users --user user=user1@example.com --show ALL

beectl list_users --email user1@example.com --show MORE

beectl list_users --given_name User1GivenName --show ALL

beectl list_users --given_name User1% --office_location 4A0% --match ALL --show MORE

beectl list_users --manager user=user2@example.com --extended_enterprise_user --match ALL --show MORE

beectl list_users --address BUSINESS_1:mailto:%@example.com --address BUSINESS_1:mailto:user1@example.com --match ANY --show ALL

list_version_configuration

Lists the version configuration on the given scope or heterogenous folder.

SYNTAX

beectl list_version_configuration --container <Configuration scope or heterogenous folder> --effective <TRUE|FALSE. Default value is FALSE>

OPTIONS

--container

Scope or heterogenous folder on which the version configuration should be listed.

--effective

Whether the effective version configuration should be returned or the one directly defined.

EXAMPLES

beectl list_version_configuration --container orgn=MyOrganization,enpr=MyEnterprise

list_virus_scan_policy

Lists the virus scan policy configured for the Site. Valid values for the scan policy are: NO_SCAN_OR_REPAIR, SCAN_ONLY, SCAN_AND_REPAIR. Default is NO_SCAN_OR_REPAIR.

SYNTAX

beectl list_virus_scan_policy

OPTIONS

This command has no options

EXAMPLES

<beectl list_virus_scan_policy>

list_virus_scan_results

Lists the virus scan results that match the specified criteria. Only a count of the matches found will be displayed if the option to list only the counts is specified. Option count_only cannot be specified with options maximum_results or display_columns. Option scandate cannot be specified with options scandate_from or scandate_to.

SYNTAX

beectl list_virus_scan_results [ [ --scandate <scandate> ] | [ --scandate_from <scandate_from> ] [ --scandate_to <scandate_to> ] ] [ --virus_name <virus_name> ] [ --virus_id <virus_id> ] [ --entity_type <entity_type> ] [ --obsolete_only <true/false> ] [ [ --maximum_results <max_results> ] [ --display_columns <display_colummns> ] | [ --count_only <true/false> ] ]

OPTIONS

--display_columns

Comma separated list of columns to display. Valid arguments are [virus_id, virus_name, component_name, scan_date, repair_attempts, entity_id, entity_type, repaired, aux_data, collab_id]. If this option is not specified all columns will be displayed.

--scandate

Value specified will be used to do an exact match with the scan date attribute of the scan results.

--scandate_from

Value specified will be used as the lower inclusive bound for matching with the scan date.

--scandate_to

Value specified will be used as the upper inclusive bound for matching with the scan date.

--virus_name

TUSINITIATED">Speill be used to do an exact match with the virus name attribute of the scan results.

--virus_id

Value specified will be used to do an exact match with the virus id attribute of the scan results.

--entity_type

Value specified will be used to pick up only the scan results for the entered entity type.

--obsolete_only

This option returns matches found for the specified criteria only for those entities that are obsolete, i.e. these entities no longer exists in the system.

--maximum_results

Value specified limits the number of results returned.

--count_only

This option returns only a total count of matches found for the specified criteria.

EXAMPLES

<beectl list_virus_scan_results --scandate_from 2008-07-10T00:00:00 --scandate_to 2008-07-10T23:59:59 --entity_type emsg --maximum_results 10 --display_columns entity_id,entity_type,virus_id,virus_name>

<beectl list_virus_scan_results --count_only true>

list_voice_facilities

The list command shows all of the facilities, their collab ids and phone number matching rules. The command accepts three optional parameters to help refine the search, if no parameters are specified, then all facilities are presented.

SYNTAX

beectl list_voice_facilities [--group_collabid <collabid>] [--includes <phone rule>] [--excludes <phone rule>] [--phone <phone number>]

OPTIONS

--group_collabid

The group collabid to search for. The list will show the facility the group collabid belongs to.

--includes

The inclusion rule to search for. For example: 1312???????. The list will show the facility that has the given inclusion rule.

--excludes

The exclusion rule to search for. For example: 1312???????. The list will show the facility that has the given exclusion rule.

--phone

The phone number to match against all known facilities. For example, specifying 13125551212 will result in a list of all facilities that match ordered such that the top of the list is the first match.

EXAMPLES

beectl list_voice_facilities --group_collabid grup=GroupName,enpr=MyEnterprise

beectl list_voice_facilities --includes 1312???????

beectl list_voice_facilities --excludes 1312???????

beectl list_voice_facilities --phone 13125551212

list_workspace_templates

Lists all workspace templates

SYNTAX

beectl list_workspace_templates --scope <Identifier of enterprise or organization> [--name <Workspace template name>] [--domain <Workspace template domain>] [--file <Full path of the output file>]

OPTIONS

--scope

Identifier of enterprise or organization

--name

Workspace template name

--domain

Workspace template domain

--file

Full path of the output file

EXAMPLES

beectl list_workspace_templates --scope orgn=test_org,enpr=test_enterprise

beectl list_workspace_templates --scope orgn=test_org,enpr=test_enterprise --name Test_template --domain Test_domain --file /tmp/template.xml

list_workspaces

Lists workspaces in an organization or enterprise

SYNTAX

beectl list_workspaces --scope <Identifier of enterprise or organization> [--type <p (Personal) | t (Team) | a (All)>] [--name <Workspace name>] [--recurse] [--countLimit <count>]

OPTIONS

--scope

Identifier of enterprise or organization

--type

p (Personal) | t (Team) | a (All)

--name

Workspace name

--recurse

Recursively list workspaces in all organizations

--countLimit

The maxium number of workspaces that can be returned. If not specified, a default value of 200 will be assumed

EXAMPLES

beectl list_workspaces --scope orgn=test_org,enpr=test_enterprise --type t

beectl list_workspaces --scope enpr=test_enterprise --name My_Workspace

list_xmpp_chat_rooms

Used to list all currently existing XMPP chat rooms.

SYNTAX

beectl list_xmpp_chat_rooms

OPTIONS

This command has no options

EXAMPLES

beectl list_xmpp_chat_rooms

modify_access_control_fields

Modifies the AccessControlFields of an existing entity.

This command alters sensitive data in the system. Oracle recommends using this command with caution.

SYNTAX

beectl modify_access_control_fields --entity <unique identifier of the entity> [--owner <unique identifier of the owner Accessor>] [--owner_access_types <owner access types string>] [--sensitivity <unique identifier of the Sensitivity>] [--{7} <unique identifier of the Scope>]

OPTIONS

--entity

Specify the unique identifier of the entity to be modified.

--owner

Modify the owner of the entity. Specify the unique identifier of the new owner.

--owner_access_types

Modify the access types string for the entity's owner.

--sensitivity

Modify the Sensitivity of the entity. Specify the unique identifier of the new Sensitivity.

EXAMPLES

beectl modify_access_control_fields --entity adoc=MyDocument,wksp=MyWorkspace,enpr=MyEnterprise --owner user=MyUser

modify_assigned_role

Modifies an existing AssignedRole entity.

SYNTAX

beectl modify_assigned_role --assigned_role <unique identifier of the AssignedRole> [--name <name of AssignedRole>] [--description <description>] [--assigned_scope <unique identifier of the assigned Scope>] [--role_definition <unique identifier of the assigned RoleDefinition>] [[--accessor <unique identifier of an Accessor>]...] [[--add_accessor <unique identifier of an Accessor>]...] [[--remove_accessor <unique identifier of an Accessor>]...]

OPTIONS

--assigned_role

Specify the unique identifier of the AssignedRole to be modified.

--name

Modify the name of the AssignedRole.

--description

Modify the description of the AssignedRole.

--assigned_scope

Modify the assigned Scope of the AssignedRole. Specify the unique identifier of the new assigned Scope.

--role_definition

Modify the assigned RoleDefinition of the AssignedRole. Specify the unique identifier of the new RoleDefinition.

--accessor

Modify the set of Accessors. Specify the unique identifier of an Accessor. This option can be specified more than once.

--add_accessor

Adds an Accessor. Specify the unique identifier of an Accessor to add. This option can be specified more than once.

--remove_accessor

Removes an Accessor. Specify the unique identifier of an Accessor to remove. This option can be specified more than once.

EXAMPLES

beectl modify_assigned_role --assigned_role acar=MyAssignedRole,wksp=MyWorkspace,enpr=MyEnterprise --name MyAssignedRole2

modify_attendant

Update an existing attendant with a new markup file or rename it.

SYNTAX

beectl modify_attendant { --file <aaml file> | --name <attendant name> --new_name <new name> }

OPTIONS

--file

An auto-attendant markup language file describing the attendant to be added. When specified, name and new_name must be specified.

--name

Name of an existing attendant. Must be specified when 'new_name' is specified. Must not be specified when 'file' is specified

--new_name

The name to which the attendant should be changed. Must be specified when 'name' is specified. Must not be specified when 'file' is specified

EXAMPLES

beectl modify_attendant --file /var/attendant.aaml

beectl modify_attendant --name myattendant --new_name myattendant2

modify_audit_policy

Modifies an existing audit policy

SYNTAX

beectl modify_audit_policy --policy <Audit policy identifier> [--file <Full path of the input file>] [--enable <true|false>]

OPTIONS

--policy

Audit policy identifier

--file

Full path of the input file

--enable

true: Enable audit policy

--enable

false: Disable audit policy

EXAMPLES

beectl modify_audit_policy --policy plcy=MyAuditPolicy --file /tmp/policy_ex.xml

beectl modify_audit_policy --policy plcy=MyAuditPolicy --enable false

modify_audit_trail

Modifies an existing audit trail

SYNTAX

beectl modify_audit_trail --trail <Audit trail identifier> --file <Full path of the input file>

OPTIONS

--trail

Audit trail identifier

--file

Full path name of the input XML file

EXAMPLES

beectl modify_audit_trail --trail autr=MyAuditTrail --file /tmp/trail_ex.xml

modify_calendar

Modify various attributes of the selected calendar.

SYNTAX

beectl modify_calendar { --calendar <calendarid> | --calendarowner <unique_identifier> | --select_by_address <uri> | --select_by_authuser <authuser> --select_by_user_name <user_name> | --select_by_resource_name <resource_name> | --select_by_workspace_name <workspace_name> } [--name <name>] [--booking_characteristics <booking_characteristices>] [--allow_double_booking <allow_double_booking> ] [--include_in_freebusy <include_in_freebusy>] [--priority <priority>] [--sensitivity <sensitivity>] [--enrollment_type <enrollment_type>] [--self_enrollment <self_enrollment>] [--caldav_resource_name <caldav_resource_name>] [--derive_timezone <derive_timezone>] [--timezone <timezone>] [--derive_available_hours <derive_available_hours>] [--available_hours <available_hours>] [--enable_presence <enable_presence>] [--enroll_members <enroll_members>]

OPTIONS

--calendar

Specify the unique identifier of a calendar.

--calendarowner

Specify the unique identifier of a user, resource or workspace.

--select_by_address

Specify the Uniform Resource Identifier (URI) of a user, resource or team workspace using the format '[scheme:]value'. If 'scheme:' is not supplied, mailto will be used.

--select_by_authuser

Specify the login name of a user.

--select_by_user_name

Specify the name of a user.

--select_by_resource_name

Specify the name of a resource.

--select_by_workspace_name

Specify the name of a team workspace.

--name

Modify the calendar name.

--booking_characteristics

Modify the calendar booking behavior. Permitted values are O for Open, F for FirstComeFirstServed, case insensitive.

--allow_double_booking

Modify the calendar double booking behavior. Permitted values are Y for Yes (allow double booking), N for No (deny double booking), case insensitive.

--include_in_freebusy

Modify if this calendar is included in free busy. Permitted values are Y for Yes, N for No, case insensitive.

--priority

Modify the default priority of the calendar. Permitted values are HIGH, MEDIUM, LOW and NONE, case insensitive.

--sensitivity

Modify the default sensitivity of the calendar. Permitted values are PUBLIC, NORMAL, CONFIDENTIAL, PERSONAL and PRIVATE, case insensitive.

--enrollment_type

Modify the enrollment type of the calendar. Permitted values are PUBLIC, PRIVATE, case insensitive.

--self_enrollment

Modify the self enrollment status for the calendar. Permitted values are OPEN, CLOSED, case insensitive. This option applies to Team Workspace only.

--caldav_resource_name

Modify the caldav resource name of the calendar.

--derive_timezone

Modify the calendar's 'derives timezone from the owner' configuration. Permitted values are Y (derive the calendar timezone from its owner's timezone) or N.

--timezone

Modify the timezone of the calendar.

--derive_available_hours

Modify the calendar's 'derives available hours from the owner' configuration. Permitted values are Y (derive the calendar available hours from its owner's timezone) or N.

--available_hours

Modify the available hours of the calendar.

--enable_presence

Modify the calendar presence integration configuration. Permitted values are Y (enable presence integration) or N. This option does not apply to Team Workspace.

--enroll_members

Modify the calendar's team workspace members enrollment configuration. Permitted values are Y (automatically enroll workspace members) or N . This option applies to Team Workspace only.

EXAMPLES

beectl modify_calendar --select_by_address user@example.com

modify_calendar_enrollments

Modify the enrollment list of the specified team workspace calendar.

SYNTAX

beectl modify_calendar_enrollments { --calendar <calendarid> | --calendarowner <unique_identifier> | --select_by_address <uri> | --select_by_workspace_name <workspace_name> } { --enroll <loginid> | --unenroll <loginid>}

OPTIONS

--calendar

Specify the unique identifier of a calendar.

--calendarowner

Specify the unique identifier of a user, resource or workspace.

--select_by_address

Specify the Uniform Resource Identifier (URI) of a user, resource or team workspace using the format '[scheme:]value'. If 'scheme:' is not supplied, mailto will be used.

--select_by_workspace_name

Specify the name of a team workspace.

--enroll

Explicitly enroll the specified user to the team workspace calendar.

--unenroll

Explicitly unenroll the specified user from the team workspace calendar.

EXAMPLES

beectl modify_calendar_enrollments --select_by_address user@example.com --enroll user=user1

modify_calendar_permissions

Modify access permissions for grantee (user or group) on the specified calendar.

SYNTAX

beectl modify_calendar_permissions  { --calendar <calendarid> | --calendarowner <unique_identifier> | --select_by_address <uri> | --select_by_authuser <authuser> | --select_by_user_name <user_name> | --select_by_resource_name <resource_name>} --user <userid> | --group <groupid> [--user_principal | --delegated_principal]  [--can_invite | --cannot_invite] [--manage <sensitivity> ...] [--read <sensitivity> ...] [--discover <sensitivity> ...] [--deny <sensitivity> ...]

OPTIONS

--calendar

Specify the unique identifier of a calendar.

--calendarowner

Specify the unique identifier of a user, resource.

--select_by_address

Specify the Uniform Resource Identifier (URI) of a user, resource using the format '[scheme:]value'. If 'scheme:' is not supplied, mailto will be used.

--select_by_authuser

Specify the login name of a user.

--select_by_user_name

Specify the name of a user.

--select_by_resource_name

Specify the name of a resource.

--user

Specify the unique identifier of the user (grantee).

--group

Specify the unique identifier of the group (grantee).

--user_principal

Set permissions to user only (do not modify any access given to this user as delegate).

--delegated_principal

Set permissions to delegated principal only (do not modify any access given to this user directly).

--can_invite

Specify the grantee (user or group) can invite this calendar.

--cannot_invite

Specify the grantee (user or group) cannot invite this calendar.

--manage

Grant manage access (delegate) to the grantee (user) on specified sensitivities of this calendar. Permitted values are: PUBLIC, NORMAL, CONFIDENTIAL, PERSONAL AND PRIVATE, case insensitive.

--read

Grant read access to the grantee (user or group) on specified sensitivities of this calendar. Permitted values are: PUBLIC, NORMAL, CONFIDENTIAL, PERSONAL AND PRIVATE, case insensitive.

--discover

Grant discover access to the grantee (user or group) on specified sensitivities of this calendar. Permitted values are: PUBLIC, NORMAL, CONFIDENTIAL, PERSONAL AND PRIVATE, case insensitive.

--deny

Deny the grantee (user or group) access to contents in this calendar on the specified sensitivities. Permitted values are: PUBLIC, NORMAL, CONFIDENTIAL, PERSONAL AND PRIVATE, case insensitive.

EXAMPLES

beectl modify_calendar_permissions --calendarowner user=user1 --user user=user2 --can_invte --manage PUBLIC --read NORMAL --read PRIVATE

modify_category

Modifies an existing category

SYNTAX

beectl modify_category --category <Category identifier> --file <Full path of the category XML file>

OPTIONS

--category

Category to be updated.

--file

Full path name of the XML file. The file must contain properly formatted data to update the category

EXAMPLES

beectl modify_category --category catg=MyCategory,enpr=MyEnterprise --file /tmp/category.xml

modify_category_configuration

Updates a given category configuration.

SYNTAX

beectl modify_category_configuration --configuration <Configuration identifier> --file <Full path of the configuration XML file>

OPTIONS

--configuration

Category configuration to be updated.

--file

Full path of the category configuration XML file. The file must contain properly formatted data.

EXAMPLES

beectl modify_category_configuration --configuration 9941:2345:ctcf:58D193D162CE4ED89FF66AB4E55745B6345464545453 --file /tmp/configuration.xml

modify_coexistence_profile

Create or modify the coexistence profile of a user.

SYNTAX

beectl modify_coexistence_profile {--user <user_identifier>|--email <user_email>|{--file <file_name>|--select_users_without_profile|--select_users_with_profile} --errors_file <file_name>} --system_affinity <system_name> [--accessible_system <system_name> ...] [--no_data_import] [--force_retry]

OPTIONS

--user

Specify the identifier of the user.

--email

Specify the email address of the user.

--select_users_without_profile

Specify all beehive users without a coexistence profile.

--select_users_with_profile

Specify all beehive users with a coexistence profile.

--file

Specify the xml input file. File encoding MUST be UTF-8.

--errors_file

Specify the output file. This file will only be generated if errors occurs.

--system_affinity

Specify the system affinity of the user.

--accessible_system

Specify the collaboration system which can be access by the user.

--no_data_import

Specify to disable default data import.

--force_retry

Specify to reset the NextAttempt time to current time. Only applies to coexistence profile that are not completed.

EXAMPLES

beectl modify_coexistence_profile --user user=userid --accessible_system beehive --system_affinity sys_name

beectl modify_coexistence_profile --file users.xml --accessible_system sys_name --errors_file errors.xml

beectl modify_coexistence_profile --select_users_without_profile --accessible_system sys_name

beectl modify_coexistence_profile --user user=userid --force_retry

modify_coexistence_system

Modifies a coexisting remote system.

SYNTAX

beectl modify_coexistence_system --select_by_name <old_name> [--name <name>] [--product_name <product_name>] [{--url <url>|--host_name <host_name> --port <port_number> {--use_http|--use_https}}] [--partnership_key] [--query_capabilities] [--timezone_alias_namespace <timezone_alias_namespace>]

OPTIONS

--select_by_name

Specify the actual name of the coexisting remote system.

--name

Specify the name of the coexisting remote system.

--product_name

Specify the new name of the coexisting remote system.

--url

Specify the URL of the coexisting remote system.

--use_http

Specify that "HTTP" MUST be used for the coexisting remote system.

--use_https

Specify that "HTTPS" MUST be used for the coexisting remote system.

--host_name

Specify the host name of the coexisting remote system.

--port

Specify the port number used by the coexisting remote system.

--partnership_key

Specify the partnership key of the coexisting remote system.

--timezone_alias_namespace

Specify the timezone alias namespace used by the coexisting remote system.

--query_capabilities

Force the coexistence service to query the remote system for its capabilities.

EXAMPLES

beectl modify_coexistence_system --select_by_name ex-101 --url http://example.com:7777

modify_connection_pool

Modifies the connection pool configuration.

SYNTAX

beectl modify_connection_pool [--connection_pool <connection pool system model identifier or alias>] [--max_connections <maximum connections>] [--min_connections <minimun connections>] [--max_statement_limit <maximum cached statements>] [--initial_connections <initial connections>] [--connection_wait_timeout <connection wait timeout>] [--inactivity_timeout <inactivity timeout>] [--time_to_live_timeout <time to live timeout>] [--abandoned_connection_timeout <abandon connection timeout>] [--lower_threshold_limit <lower threshold limit>] [--property_check_interval <property check interval>] [--validate_connection <true/false>]

OPTIONS

--connection_pool

Connection pool system object identifier.

--max_connections

Maximun number of connections in connection pool.

--min_connections

Number of minimum connections in connection pool.

--max_statement_limit

Maximum number of cached statements in connection pool.

--initial_connections

Number of initial connections in connection pool.

--connection_wait_timeout

Connection wait timeout.

--inactivity_timeout

Inactivity timeout.

--time_to_live_timeout

Time to live timeout.

--abandoned_connection_timeout

Abandoned connection timeout.

--lower_threshold_limit

Lower threshold limit.

--property_check_interval

Property check interval.

--validate_connection

Should connection be validated or not.

EXAMPLES

beectl modify_connection_pool --connection_pool 232323-der344-455-3455ded --max_connections 40

modify_database

Modifies given database configuration.

SYNTAX

beectl modify_database --database <database instance id or alias> [--schema_name <schema name>] [--connect_string <connect string>] [--schema_password <schema password>] [--xa_service_names <xa schema name> [--xa_service_names < xa schema name>] .. ] [--ons_entry <ons name host:port> [--ons_entry < ons entry host:port>] .. ] [--parent_database <system object identifier of the parent database>

OPTIONS

--database

Database system object identifier.

--schema_name

Schema name.

--connect_string

Connection descriptor.

--schema_password

Schema password.

--xa_service_names

Multiple values of xa service names can be given. See the usage.

--ons_entry

Notification server details in form of host:port.

--parent_database

System object identifier of the parent database. When '--parent_database' option presents, all the options other than '--database' will be ignored.

EXAMPLES

beectl modify_database --database ab222-aa4-eee333-ddede5 --schema_name schema1

modify_deployment_structure

This command applies the specified template(s) to the local BeehiveInstance. Execute beectl list_deployment_templates command to view the available templates.

SYNTAX

beectl modify_deployment_structure --primary_template <primary template name>  [(--supplementary_template <supplementary template name>) ...] [--physical_memory_available <physical memory>] [--number_of_processors_available <no of processors>] [--bti_control_port <bti control port>] [--bti_server_port <bti server port>] [--disable_sizing] [--cold_add_delete] [--do_not_restart_at_end] [--update_oc4j_soa] [--console_output_verbosity <verbosity level>] [--no_extraction_after_cold_upgrade]

OPTIONS

--primary_template

Identifier of the primary template to be applied. The command beectl list_deployment_templates displays the identifiers of available templates.

--supplementary_template

Identifier(s) of the supplementary template(s) to be applied. The command beectl list_deployment_templates displays the identifiers of available templates. A Supplementary Template represents the deployment structure of an oc4j with auxiliary services which augment the structure of the local midtier without changing the primary template.

--physical_memory_available

Amount of physical memory in MB or GB allocated to this BeehiveInstance. For eg 600MB or 10GB. This option updates the property AvailablePhysicalMemoryInMB of the local BeehiveInstance and is used in sizing. This option need not be provided if the value of this property is already set as needed.

--number_of_processors_available

No of processors allocated to this BeehiveInstance. This option updates the property AvailableNumberOfProcessors of the local BeehiveInstance. This option need not be provided if the value of this property is already set as needed.

--bti_control_port

BTI control port. This port is used to get BTI heartbeat by the OPMN daemon. This option is useful to configure or re-configure BTI control port and it need not be specified if BTI is already correctly configured on this midtier.

--bti_server_port

BTI server port. This option is useful to configure or re-configure BTI server port on this midtier and it need not be specified when BTI is already correctly configured on this midtier.

--disable_sizing

Disable automatic sizing. Create only the minimum number of oc4j instances per oc4j template.

--cold_add_delete

If specified, addition and deletion of j2ee components happens in cold mode. By default this happens in hot mode.

--do_not_restart_at_end

If specified, the components are not restarted after deployment. By default components are restarted after deployment.

--update_oc4j_soa

If specified, the oc4j_soa will also be updated. By default, oc4j_soa will not be updated.

--console_output_verbosity

Specifies verbosity level of the console output from the command. Valid values are FINE, INFO, MINIMAL .

EXAMPLES

Below command will apply the mentioned primary and supplementary templates to current midtier. This command "may" wipe off existing deployment structure of the midtier.

beectl modify_deployment_structure --primary_template SERVER_ONLY --supplementary_template EXAMPLE_SUPPLEMENTARY_TEMPLATE --supplementary_template ANOTHER_EXAMPLE_SUPPLEMENTARY_TEMPLATE

Below command will apply the mentioned supplementary template to current midtier without changing any other deployment structure. Configured minimum number of oc4j instances for the specified supplementary template are created.

beectl modify_deployment_structure --supplementary_template EXAMPLE_SUPPLEMENTARY_TEMPLATE --disable_sizing

If --console_output_verbosity <verbosity level> is also provided on command line, console output will be controlled by specified verbosity level.

modify_device

Modifies the device with the given identifier.

SYNTAX

beectl modify_device --device <identifier of the device> --status <status of the device>

OPTIONS

--device

Specify the identifier of the device. Use list_devices command to determine the identifier of the device.

--status

Specify the status of the device. The following are the valid device statuses: ACTIVE PROVISIONED BLACKLISTED LOCKDOWN .

EXAMPLES

beectl modify_device --device 1234:5678:devi:2E0329B0705F0E40E040578C92160957000000000434 --status BLACKLISTED

modify_directory_entry

Modifies the directory id and locator for a given directory entry. This command can be used to convert a directory user to an external directory user and vice versa. This command must be executed before a deleted user in the directory gets synced with the Oracle Beehive server, otherwise this change deletes the Oracle Beehive user (user marked for deletion).

SYNTAX

beectl modify_directory_entry --identifier <identifier> --directory_profile <+/-profilename> --directory_identifier <+/-directory-locator> [-- no_validate]

OPTIONS

--identifier

Object identifier. This command supports user and group identifiers. Permitted value is String. This option is mandatory.

--directory_profile

Profile name. Use this option to change the directory profile with which the user is currently syncing. Permitted value is String. This option is mandatory.

--directory_identifier

Directory Locator of the user. Use this option to modify the directory locator of the user, so that a current Oracle Beehive user can be synced with another directory entry present in LDAP. Permitted value is String. This option is mandatory.

--no_validate

Skips the validation of directory profile name and directory identifier.

USAGE

This command can be used in the following scenarios:

- If you want to sync an Oracle Beehive user with different GUID present in the current LDAP or new LDAP without deleting the user in Oracle Beehive.

- If you want to sync an Oracle Beehive user with new LDAP by changing directory profile without deleting the user in Oracle Beehive.

EXAMPLES

beectl modify_directory_entry --identifier user=user1 --directory_profile MyDirectoryProfileName --directory_identifier A12345

modify_directory_profile

The modify_directory_profile command modifies an existing directory profile. Modification to the profile name cannot be done.

SYNTAX

beectl modify_directory_profile --file <filename> [ --no_validate ]

OPTIONS

--file

XML file containing directory profile.

--no_validate

Skips the validation of profile against the directory server.

EXAMPLES

beectl modify_directory_profile --file MyDirectoryProfile.xml

beectl modify_directory_profile --file MyDirectoryProfile.xml --no_validate

modify_email_port

Modifies Email service' SMTP or IMAP port number

SYNTAX

beectl modify_email_port --type <smtp|imap> --port <port_number>

OPTIONS

--type

Specifies type of the port to be modified. Valid values are imap and smtp.

--port

Port number for the specified port type.

EXAMPLES

beectl modify_email_port --type smtp --port 1234

modify_email_queue

Enables or disables Email asynchronous queue processing

SYNTAX

beectl modify_email_queue --type <enable|disable|process|status>

OPTIONS

--type

Acceptable options are enable,disable,process,status

EXAMPLES

beectl modify_email_queue --type enable

Resume or enable queue processing.

beectl modify_email_queue --type disable

Disable queue processing.

beectl modify_email_queue --type process

Process all the messages in the email asynchronous queue immediately.

beectl modify_email_queue --type status

Show current status.

modify_enterprise

Modifies an existing enterprise

SYNTAX

beectl modify_enterprise --enterprise <Enterprise identifier> [--name <Enterprise name>] [--description <Description>] [--hard_quota <Hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>] [--sub_organization_quota <Default sub-organization quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>] [--team_workspace_hard_quota <Default team workspace hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota> --team_workspace_soft_quota <Default team workspace soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>] [--personal_workspace_hard_quota <Default personal workspace hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota> --personal_workspace_soft_quota <Default personal workspace soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>] [--personal_template <Personal workspace default template identifier>] [--team_template <Team workspace default template identifier>]

OPTIONS

--enterprise

Enterprise identifier

--name

Enterprise name

--description

Description

--hard_quota

Hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota

--sub_organization_quota

Default sub-organization quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota

--team_workspace_hard_quota

Default team workspace hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota

--team_workspace_soft_quota

Default team workspace soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota

--personal_workspace_hard_quota

Default personal workspace hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota

--personal_workspace_soft_quota

Default personal workspace soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota

--personal_template

Personal workspace default template identifier

--team_template

Team workspace default template identifier

EXAMPLES

beectl modify_enterprise --enterprise enpr=test_enterprise --name New_Name --description New_description

beectl modify_enterprise --enterprise enpr=test_enterprise --hard_quota 10000 --sub_organization_quota 1500 --team_workspace_hard_quota 1000 --team_workspace_soft_quota 1000 --personal_workspace_hard_quota 1000 --personal_workspace_soft_quota 1000 --team_template wstp=team_wksp_template,enpr=test_enterprise --personal_template wstp=personal_wksp_template,enpr=test_enterprise

modify_expertise_background_job

Modifies the expertise background jobs.

SYNTAX

beectl modify_expertise_background_job    {        --job <job>        [--start_hour <start hour>]        [--start_minute <start minute>]        [--frequency_minute <frequency minute>]         [--enable <enable>]         [--stop <stop>]     }

OPTIONS

--job

Job type of the expertise background job. Allowed values are CONFIDENCE_UPDATER, PROFILING_HANDLER, PROFILE_OPTIMIZER, PROFILE_TRANSFER, RELATIONSHIP_HANDLER and WHOIS_HANDLER.

--start_hour

The scheduled start hour of the job, 0 to 23 inclusive.

--start_minute

The scheduled start minute of the job, 0 to 59 inclusive.

--frequency_minute

The scheduled frequency of the job, in minutes.

--enable

; | --email &lt;Email address of the disables it.

--stop

Flag to stop the job. True stops the job, false has no effect.

EXAMPLES

beectl modify_expertise_background_job --job PROFILE_TRANSFER --start_hour 16 --frequency_minute 240

beectl modify_expertise_background_job --job PROFILE_TRANSFER --enable False

beectl modify_expertise_background_job --job RELATIONSHIP_HANDLER --stop True

modify_expertise_entity_searchability

The modify_expertise_entity_searchability command controls whether the specified entity will be searchable or not.

SYNTAX

beectl modify_expertise_entity_searchability  {    --entity <identifier>    --terms_searchable <true/false> | --relationships_searchable <true/false>  }

OPTIONS

--entity

Identifier of the entity whose searchability is to be modified.

--terms_searchable

Whether the entity should be searchable for terms after expertise profiling.

--relationships_searchable

Whether the entity should be searchable for relationships after expertise profiling.

EXAMPLES

beectl modify_expertise_entity_searchability --entity 3F5B:23D3:user:40EA125BD4941FBEE040578CA8027E89000000030E6F --terms_searchable true

beectl modify_expertise_entity_searchability --entity user=user1,enpr=oracle --terms_searchable false --relationships_searchable true

modify_expertise_profiling_configuration

The modify_expertise_profiling_configuration command modifies the expertise profiling configuration. The profiling configuration information is supplied in an XML file.

SYNTAX

beectl modify_expertise_profiling_configuration --file <filename>

OPTIONS

--file

Filename of the XML file containing expertise profiling configuration definition.

EXAMPLES

beectl modify_expertise_profiling_configuration --file MyProfilingConfig.xml

modify_expertise_stop_phrases

The modify_expertise_stop_phrases command modifies (add/remove) stop phrases for Expertise service. The phrases are supplied in a XML file

SYNTAX

beectl modify_expertise_stop_phrases --enterprise <enterpise> --action [add|remove] --file <filename> --phrase <phrase>

OPTIONS

--enterprise

Identifier of the enterprise for which the stop phrases will be modified.

--action

Action add or remove to be performed.

--file

XML file containing stop phrases.

--phrase

Stop phrase.

EXAMPLES

beectl modify_expertise_stop_phrases --enterprise <enterpise> --action add --file AddESP.xml

beectl modify_expertise_stop_phrases --enterprise <enterpise> --action add --phrase phrase1 --phrase phrase2 --file AddESP.xml

modify_expertise_user_scope

The modify_expertise_user_scope command modifies expertise user scope. The expertise user scope information is supplied in a XML file.

SYNTAX

beectl modify_expertise_user_scope --file <filename>

OPTIONS

--file

Filename of the XML file containing bodn, description, include_list and exclude_list for the extertise user scope to be modified.

EXAMPLES

beectl modify_expertise_user_scope --file MyUserScope.xml

modify_external_contact

The modify_external_contact command modifies existing external contact.

SYNTAX

beectl modify_external_contact    {        --contact <identifier of external contact >      |        --email <ostal-code&gt;?c=&lt;contact>  }    [ --family_name <+/-[locale:]family name> ... ]      [ --given_name <+/-[locale:]given name> ... ]    [ --display_name <+/-[locale:]display name> ... ]     [ --middle_name <+/-[locale:]middle name> ... ]    [ --job_title <+/-[locale:]job title> ... ]     [ --prefix <+/-[locale:]prefix> ... ]    [ --suffix <+/-[locale:]suffix> ... ]     [ --nick_name <+/-[locale:]nick name> ... ]    [ --scope <identifier of contacts parent> ]     [ --office_location <office location of the contact> ]     [ --company <company of the contact> ]     [ --profession <profession of the contact> ]     [ --timezone <timezone of the contact> ]     [ --locale <locale of the contact> ]     [ --department <department of the contact> ]     [ --organization <organization identifier> ... ]     [ --remove_organization <organization identifier> ... ]     [ --property <+/-name(assistant|certificate|notes)=value=description> ... ]     [ --address <+/-type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ]     [ --default_address_for_type <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ]     [ --default_address_for_scheme <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ]     [ --primary_address <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ]     [ --status <status of contact(enabled|disabled|locked)> ]

OPTIONS

--contact

The identifier of the external contact

--email

Email id of the external contact

--family_name

Family name of the contact in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.

--given_name

Given name of the contact in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.

--display_name

Display name of the contact in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.

--middle_name

Middle name of the contact in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.

--job_title

Job title of the contact in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--prefix

Prefix of the contact in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.

--suffix

Suffix of the contact in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.

--nick_name

Nick name of the contact in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.

--scope

Identifier of the enterprise under which this contact will be created.

--office_location

Office location of the contact.

--company

Company of the contact.

--profession

Profession of the contact.

--timezone

Timezone of the contact. list_timezones lists the valid timezones

--locale

Locale details of the contact. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--department

Department of the contact.

--organization

Identifiers of the organizations the contact must be part of.

--remove_organization

Identifiers of the organizations the contact must be removed from.

--property

Details of the property in the format [+/-]name=value=description. Supported names are certificate, assistant and notes. Note, no equals to symbol(=) should be present in the name or value or description. + or no symbol means the property should be added. If - is specified that means the property should be removed. Default action is addition.

--address

Address of the contact in the format [+/-]type:scheme:value. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25. + or - in the start of the string tells whether the address should be added or removed. + or no symbol means the address should be added. If - is specified that means the address should be removed. Default action is addition.

--default_address_for_type

Address of the contact in the format type:scheme:value. Sets the specified address as the default for the specified type. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.

--default_address_for_scheme

Address of the contact in the format type:scheme:value. Sets the specified address as the default for the specified scheme. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.

--primary_address

Primary address of the contact in the format type:scheme:value. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.

--status

Sets the provisioning status of the external contact. Sets the provisioning status of the user. Supported values are ENABLED, DISABLED, LOCKED.

EXAMPLES

beectl modify_external_contact --contact 6A95:21EB:extp:D9E9FC8134544BCE9D60559F9B997CCD000000000000 --given_name User1GivenName --family_name -en_CA:User1FamilyName --office_location 4A037

beectl modify_external_contact --email contact1@example.com --property +prop1:prop1value

beectl modify_external_contact --email contact1@example.com --address +BUSINESS_1:mailto:contact1@example.com --address -BUSINESS_2:im:contact2@example.com

beectl modify_external_contact --email contact1@example.com --status disabled

modify_failed_action_events

Retry actions that have not completed successfully.

SYNTAX

beectl modify_failed_action_events --retry --bucket <Partition number> --sequence <Sequence number>

OPTIONS

--retry

Retry the failed action event.

--bucket

Partition number

--sequence

Sequence number

EXAMPLES

beectl modify_failed_action_events --retry --bucket MyBucketNumber --sequence MySequenceNumber

modify_feed_configuration

The modify_feed_configuration command modifies existing feed configurations.

SYNTAX

beectl modify_feed_configuration    {        --feed_configuration <feed configuration>      | --scope <scope identifier>       --feedtype <feed type >        [--name <name >]        [--title <title >]        [--description <description >]         [--image <image >]         [--language <language >]         [--copyright <copyright>]         [--webmaster <webmaster>]         [--managing_editor <managing editor>]     }

OPTIONS

--feed_configuration

Collabid of the feed configuration to be modified

--scope

Scope in which the feed configuration will be created

--feedtype

Feed type of the feed configuration. Permitted values are ANNOUNCEMENT, FORUM, FOLDER, LABEL, RECENT, TOPIC and VERSION.

--name

Name of the feed configuration.

--title

Title associated the feed configuration

--description

Description associated the feed configuration

--image

Image associated with this feed configuration

--language

Language associated with the feed configuration

--copyright

Copyright associated with the feed configuration

--webmaster

Webmaster associated with the feed configuration

--managing_editor

Managing Editor associated with the feed configuration

EXAMPLES

beectl modify_feed_configuration --scope enpr=example --feedtype RECENT --name MyFeedConfiguration --title BeehiveFeedConfiguration --description This is my beehive feed configuration.

beectl modify_feed_configuration --feed_configuration 6790:39AC:afrf:52921E226193384EE040578C5C84269C0000000ABB75 --name ForumFeedConfiguration --description This is a forum feed. --image ForumLogo.gif --language en

modify_group

The modify_group command modifies a group. The group information is supplied in an XML file.

SYNTAX

beectl modify_group --file <filename> [ --ldapbootstrap ]

OPTIONS

--file

Filename of the XML file containing group definition.

--ldapbootstrap

LDAP bootstrap flag. If this flag is specified, then uds groups will be created with directory locator and directory id. This is relevant only when --file option is used.

EXAMPLES

beectl modify_group --file MyGroups.xml

beectl modify_group --file MyGroups.xml --ldapbootstrap

modify_hostname

Modifies the configuration repository for hostname of the system and updates required configuration files.

SYNTAX

beectl modify_hostname [--start_at_end] [--no_dns_validation] [(--sync | --new_host_name <new host name> [--old_host_name <old host name>]... )] [--ignore_validation_warnings]

OPTIONS

--sync

If specified, command will read values from configuration repository and sync it to the system configuration files.

--new_host_name

New host name of the local server.

--old_host_name

Old host names of the local server. This value will be used to replace any of the old host name pattern available in local files.

--start_at_end

If specified, components on current beehive instance will be started after modification to configuration files.

--no_dns_validation

If specified, DNS lookup validation of the new host name will not be performed.

--ignore_validation_warnings

If specified, commands using validation framework will ignore the warnings and continue.

EXAMPLES

beectl modify_hostname

Above command will read the values from file system and updates configuration files and configuration repository with it.

beectl modify_hostname --sync --old_host_name oldhost1.example.com --old_host_name oldhost2.example.com

Above command will read the values from configuration repository and update it to all configuration files. There will be no configuration repository updates when this option is used.

beectl modify_hostname --new_host_name demo.example.com --old_host_name oldhost1.example.com --old_host_name oldhost2.example.com

Above example will update configuration repository as well as all other configuration files with new hostname.

Note: Shutdown the midtier before running this command.

This command does not modify iAS instance name.

If --ignore_validation_warnings is also specified, warnings from validation framework will be ignored and command execution will continue.

modify_im_preferences

Modifies existing instant message preferences of a user.

SYNTAX

beectl modify_im_preferences --user <user identifier or alias> [--archive <true|false>] [--archive_folder <folder identifier or alias>] [--offline_delivery_channel <mailto|pull>]

OPTIONS

--user

The user whose instant message preferences are to be modified.

--archive

Knob to turn user archiving on/off. Set it to true to turn it on or false otherwise.

--archive_folder

Folder to keep the instant message archive for this user.

--offline_delivery_channel

Effects the mode of offline message delivery. A value of "pull" refers to the semantics wherein the messages are kept with the server and are explicitly fetched by a client facing service on behalf of the user upon his next login. A value of "mailto" on other hand refers to the semantics wherein the offline message will be right away sent as an email to the user.

EXAMPLES

beectl modify_im_preferences --user user=beehive_test1 --offline_delivery_channel mailto

beectl modify_im_preferences --user 6C3E:0532:user:88E1F9EA3DD341A6B2E18768F17AC838000000000000 --archive true

modify_ischedule_server

Modify a remote iSchedule Server configuration.

SYNTAX

beectl modify_ischedule_server --name <name> [--domain_regexp <regexp>] [--outgoing_url <remote_url>] [--outgoing_auth_id <auth_id>] [--outgoing_auth_key <auth_key>] [--incoming_auth_id <auth_id>] [--incoming_auth_key <auth_key>] [--incoming_allow_ip_regexp <regexp>] [--incoming_allow_host_regexp <regexp>]

OPTIONS

--name

Name of the remote server configuration, can contain only alpha numerical characters, underscores and dashes.

--domain_regexp

Regular expression that must match the remote user's email address.

--outgoing_url

Address of the remote iSchedule server.

--outgoing_auth_id

Authentication ID that must be used when connecting to the remote server.

--outgoing_auth_key

Key that must be used when connecting to the remote server.

--incoming_auth_id

Authentication ID that the remote server must use when connecting to the Oracle Beehive server.

--incoming_auth_key

Key that the remote server must use when connecting to the Oracle Beehive server.

--incoming_allow_ip_regexp

IP Addresses connecting to the Oracle Beehive server must match this regular expression

--incoming_allow_host_regexp

Host names connecting to the Oracle Beehive server must match this regular expression

EXAMPLES

beectl modify_ischedule_server --name remoteserver --domain_regexp ".*@example.com" --outgoing_url http://remoteserver@example.com/ischedule

modify_ldap_change_number

Modifies the changelog number of a profile.

SYNTAX

beectl modify_ldap_change_number --profile <profilename> --changelog_number <changelognumber>

OPTIONS

--profile

Name of the profile.

--changelog_number

Changelog number of the profile.

EXAMPLES

beectl modify_ldap_change_number --profile MyDirectoryProfileName --changelog_number 100

modify_local_ace

Replaces an Access Control Entry (ACE) in the Local Access Control List (LACL) of an entity.

SYNTAX

beectl modify_local_ace --entity <unique identifier of the entity> --accessor <unique identifier of the Accessor> [--access_types <access types string>]

OPTIONS

--entity

Specify the unique identifier of the entity in which the ACE will be replaced.

--accessor

Specify the unique identifier of the Accessor to whom the access types will be applied.

--access_types

Specify the access types string for the Accessor.

EXAMPLES

beectl modify_local_ace --entity adoc=MyDocument,wksp=MyWorkspace,enpr=MyEnterprise --accessor user=MyUser --access_types +RW-D

modify_local_configuration_files

This command updates configuration files local to current midtier with activated changes to centralized configuration. It can restart one or more components on current midtier if needed to make the changes take effect. Some updates to local configuration files require this command to restart all midtier components.

SYNTAX

beectl modify_local_configuration_files [--restart_needed] force_apply

OPTIONS

--restart_needed

Indicates if components should be restarted or not. If this option is specified with value false then no component will be stopped/restarted even though changes to local configuration files require a restart of one or more components for taking effect. If this option is specified with value true, and if the changes to local configuration files require a restart of one or more already running components then they will be restarted. The components which were NOT running will NOT be restarted.

--ignore_validation_warnings

If specified, commands using validation framework will ignore the warnings and continue.

EXAMPLES

beectl modify_local_configuration_files

Above command will update local configuration files with changes if any and restart one or more midtier components if needed.

beectl modify_local_configuration_files --restart_needed false

Above command will not restart any component but it will display warnings about components which need to be restarted due to changes to local configuration files.

If --ignore_validation_warnings is also specified, warnings from validation framework will be ignored and command execution will continue.

modify_max_address_count

The modify_max_address_count command modifies maximum number of addresses of an address type that can be set for a given person-contact, group-contact or resource-contact in an address-book. The address types determine the type of address like BUSINESS, PERSONAL & OTHER. The maximum count specified in this command must be less than the system defined maximum limit, which can be determined by running list_max_address_count command.

SYNTAX

beectl modify_max_address_count --max_address_count <integer value>

OPTIONS

--max_address_count

Maximum number of addresses of an address-type.

EXAMPLES

beectl modify_max_address_count --max_address_count 5

modify_notification_template

Modifies a specified notification template for the Notification service.

SYNTAX

beectl modify_notification_template --file <path to the xml instruction file>

OPTIONS

--file

Specify the full path and file name of the notification XML file.

EXAMPLES

beectl modify_notification_template --file /tmp/nms/UpdateNewInvitationTemplate.xml

modify_oc4j_administrator_password

Modifies oc4j administrator password in central configuration.

SYNTAX

beectl modify_oc4j_administrator_password --admin_password <oc4j adminisrator password>

OPTIONS

--admin_password

New password of the oc4j administrator for Beehive.

EXAMPLES

beectl modify_oc4j_administrator_password --admin_password <secure string>

modify_organization

Modifies an existing organization

SYNTAX

beectl modify_organization --organization <Organization identifier> [--name <Organization name>] [--description <Description>] [--hard_quota <Hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>] [--sub_organization_quota <Default sub-organization quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>] [--team_workspace_hard_quota <Default team workspace hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota> --team_workspace_soft_quota <Default team workspace soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>] [--personal_workspace_hard_quota <Default personal workspace hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota> --personal_workspace_soft_quota <Default personal workspace soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>] [--personal_template <Personal workspace default template identifier>] [--team_template <Team workspace default template identifier>]

OPTIONS

--organization

Organization identifier

--name

Organization name

--description

Description

--hard_quota

Hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota

--sub_organization_quota

Default sub-organization quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota

--team_workspace_hard_quota

Default team workspace hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota

--team_workspace_soft_quota

Default team workspace soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota

--personal_workspace_hard_quota

Default personal workspace hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota

--personal_workspace_soft_quota

Default personal workspace soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota

--personal_template

Personal workspace default template identifier

--team_template

Team workspace default template identifier

EXAMPLES

beectl modify_organization --organization orgn=test_org,enpr=test_enterprise --name New_Name --description New_description

beectl modify_organization --organization orgn=test_org,enpr=test_enterprise --hard_quota 10000 --sub_organization_quota 1500 --team_workspace_hard_quota 1000 --team_workspace_soft_quota 1000 --personal_workspace_hard_quota 1000 --personal_workspace_soft_quota 1000 --personal_template wstp=personal_wksp_template,enpr=test_enterprise --team_template wstp=team_wksp_template,enpr=test_enterprise

modify_patch_information

Add, append or removes the patch information from the given archives.

SYNTAX

beectl modify_patch_information (--archive_file_list  <file containing list of archives> | --archive_directory  <directory containing archives> |  --archive_file <archive name> [--archive_file <archive name> ...])  (--upgrade_conf <patch of upgrade.conf> |  --add_patch <patch id > [--private_patch] [--constituent_patch <constituent patch id> ...] | --delete_patch <patch id to delete> [--delete_patch <patch id to delete> ...])

OPTIONS

--archive_file_list

A simple text file containing list of archive files which needs to be acted upon. Every line in the file will be taken as one archive file entry relative to current oracle home. Non-archive files will be ignored.

--archive_directory

Directory in which archives will be searched.

--archive_file

Archive file which should be acted upon.

--upgrade_conf

Full path of upgrade.conf which has the upgrade information.

--add_patch

The specified patch will be added in all archives.

--private_patch

The patch specified above is a private patch.

--constituent_patch

Set of constituent patches to the above main patch.

--delete_patch

The specified patch will be removed from all archives.

EXAMPLES

beectl modify_patch_information --upgrade_conf --archive_file_list /tmp/upgrade.conf --upgrade_conf /tmp/file_list.txt

Above command will update the archives specified in file list according to the patch information in upgrade.conf.

modify_personal_workspace

Modifies an existing personal workspace

SYNTAX

beectl modify_personal_workspace --workspace <Workspace identifier> [--name <Workspace name>] [--description <Description>] [--hard_quota <Hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota> --soft_quota <Soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>]

OPTIONS

--workspace

Workspace identifier

--name

Workspace name

--description

Description

--hard_quota

Hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota

--soft_quota

Soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota

EXAMPLES

beectl modify_personal_workspace --workspace wksp=test_workspace,enpr=Oracle --name New_Name --description New_description

ssage>beectl modify_port --protocol HTTP --port 80 </example_message> <exrd_quota 1000 --soft_quota 1000

modify_policy

Modifies an existing policy using data in an XML file.

SYNTAX

beectl modify_policy --file <full path to the policy xml file>

OPTIONS

--file

Specify the absolute path of the XML file that contains the policy data.

EXAMPLES

beectl modify_policy --file /private/xml/MyPolicy.xml

modify_policy_schema

Modifies an existing policy schema using data in an XML file.

SYNTAX

beectl modify_policy_schema --file <full path to the xml file>

OPTIONS

--file

Specify the absolute path of the XML file that contains the policy schema data.

EXAMPLES

beectl modify_policy_schema --file /private/xml/MyPolicySchema.xml

modify_policy_template

Modifies an existing policy template using data in an XML file.

SYNTAX

beectl modify_policy_template --file <full path to the xml file>

OPTIONS

--file

Specify the absolute path of the XML file that contains the policy template data.

EXAMPLES

beectl modify_policy_template --file /private/xml/MyPolicyTemplate.xml

modify_port

Modifies various ports.

Valid protocols are

SMTP

IMAP

XMPP

XMPPS

FTP

HTTP

HTTPS

BTP

BTPS

OC4J-JGROUP-RANGE

OC4J-AJP-RANGE

OC4J-RMI-RANGE

OC4J-RMIS-RANGE

OC4J-JMS-RANGE

OC4J-SIP-RANGE

OC4J-AJP-RANGE identifies the range of ports in current site for either AJP or secure AJP protocol whichever is enabled.

SYNTAX

beectl modify_port [--protocol <protocol name> [([--virtual_port <virtual port for the site>][--listen_port <listen port for protocol>] |[--port <common port value>])] [--maximum_port <maximum value in the range> --minimum_port <minimum value in the range>]] |[--component <system object identifier or alias> --name <name of the port property> --port <value of the port> ]

OPTIONS

--protocol

Name of the protocol for which port needs to be modified.

--virtual_port

Port to which the clients will connect. This value will be modified for the entire site.

--listen_port

The actual port which will be opened on each midtier. Typically a listening port.

--port

Convenience option to set both --virtual_port and --listen_port together with same value.

--component

Identifier of the configuration component to be modified. Combined with --name, this option can be used to modify internal ports. For example control port of the Bti or request port of opmn.

--name

Name of the internal port property on the configuration object identified by --component option.

--maximum_port

Some components allocate free port dynamically during process start. For such processes, only the permitted port range is managed. This option can be used to modify the maximum value of the range for the given protocol.

--minimum_port

Some components allocate free port dynamically during process start. For such processes, only the permitted port range is managed. This option can be used to modify the maximum value of the range for the given protocol.

EXAMPLES

beectl modify_port --protocol HTTP --virtual_port 80 --listen_port 7774

Above example modifies virtual and listen port values for HTTP protocol for all midtiers.

beectl modify_port --protocol HTTP --port 80

Above example modifies virtual and listen port values to same given port value for HTTP protocol for all midtiers.

beectl modify_port --protocol HTTPS --port 7445 --component c093d4cc-d9cc-42ae-bc45-4b31fab07190

Above example modifies listen port value for HTTPS protocol for given HttpServer configuration component. This can also be achieved using the beectl modify_property command.

beectl modify_port --component c093d4cc-d9cc-42ae-bc45-4b31fab07190 --name RequestPort --port 2003

Above example modifies port value identified by name RequestPort for given configuration component specified by option --component. This can also be achieved using the beectl modify_property command.

beectl modify_port --protocol OC4J-AJP-RANGE --maximum_port 20601 --minimum_port 20700

Above example modifies port range values for given protocol for all OC4Js in all midtiers. Use option --component to specify the identifier of the OC4J to be modified.

modify_preference_set

The modify_preference_set command modifies the preference set by setting the extends from attribute.

SYNTAX

beectl modify_preference_set --set <Preference set identifier> --extends <Preference set identifier>

OPTIONS

--set

Identifier of the preference set specified in id format, which can be determined by running list_preference_sets command with "--entity_format id" option.

--extends

Identifier of the preference set from which the new preference set is extended.

EXAMPLES

beectl modify_preference_set --set prfs=set1,user=user1 --extends prfs=set2,user=user2

modify_property

Modifies the value(s) of a named property of the component identified by --component. Multiple values can be set for one property.

Note :- Option value should not start with hyphen(-). If an option value starts with hyphen, use any one of the following syntaxes. 1. Use <option-name>=<option value> format. This is the preferred way to specify the option values starting with hypens. 2. Prepend the option value with string "ESCAPE:". 3. Prepend the option value with backslash "\\". This is the least preferred way. This may not work in some platforms, esp in windows platforms it will not work.

SYNTAX

beectl modify_property --component <system object identifier or alias> --name <name> [ --file <filename> | --revert_to_default | --value <value>... ]

OPTIONS

--component

component id.

--name

Name of the property.

--value

Value of the property.

--file

The contents of this file would be assigned as the value of the specified property. The property MUST be of type String.

--revert_to_default

flag indicating, if values need to be reverted back as original.

EXAMPLES

The command execution shown below would set the BaseLogLevel property of the config object to FINE.

beectl modify_property --component 486318ac-f162-477b-814f-140836c257af --name BaseLogLevel --value FINE

The command execution shown below would revert back the BaseLogLevel property of the config object to the initial default value, if any. If there is no initial default value configured for this property on this config object then the value would be cleared.

beectl modify_property --component 486318ac-f162-477b-814f-140836c257af --name BaseLogLevel --revert_to_default

The command execution shown below would set the contents of the specified file as the value of the PostResolutionRules property of the config object. The property PostResolutionRules must be of type String.

beectl modify_property --component 520118ac-f162-477b-814f-452106c257cb --name PostResolutionRules --file /tmp/post_resolution_rules.xml

The command execution shown below would set the values starting '-' to the StartParameter property of the config object. The property StartParameter must be of type String.

beectl modify_property --component 520118ac-f162-477b-814f-452106c257cb --name StartParameter --value="-Dhttp.maxFileInfoCacheEntries=-1 -ms128M -mx512M"

modify_remote_repository

Modifies the name and/or the description of a Remote Repository.

SYNTAX

beectl modify_remote_repository --scope <Remote Repository Container.> --name <Remote Repository Name.> [ --new_name <The new name for the Remote Repository.> ] [ --new_description <The new description for the Remote Repository.> ] [ { --online <Turn the repository online.> | --offline <Turn the repository offline.> } ]

OPTIONS

--scope

Remote Repository Container.

--name

Remote Repository Name.

--new_name

The new name for the Remote Repository.

--new_description

The new description for the Remote Repository.

--online

Turn the repository online.

--offline

Turn the repository offline.

EXAMPLES

beectl modify_remote_repository --scope myRemoteRepositoryScope --name myRemoteRepositoryName --new_name myNewRemoteRepositoryName --new_description myNewRemoteRepositoryDescription --offline

modify_remote_share

Modifies the name and/or the description of a Remote Share.

SYNTAX

beectl modify_remote_share --scope <Remote Share Container.> --name <Remote Share Name.> [ --new_name <The new name for the Remote Share.> ] [ --new_description <The new description for the Remote Share.> ] [ { --online <Turn the share online.> | --offline <Turn the share offline.> } ]

OPTIONS

--scope

Remote Share Container.

--name

Remote Share Name.

--new_name

The new name for the Remote Share.

--new_description

The new description for the Remote Share.

--online

Turn the share online.

--offline

Turn the share offline.

EXAMPLES

beectl modify_remote_share --scope myRemoteShareScope --name myRemoteShareName --new_name myNewRemoteShareName --new_description myNewRemoteShareDescription --offline

modify_resource_classifications

This command set the given category as resource root classification.

SYNTAX

beectl modify_resource_classifications [--enterprise <enterpriseid>] --category <categoryid>

OPTIONS

--enterprise

Deprecated option. Use --scope instead.

--category

Category identifier to set as root classification.

EXAMPLES

beectl modify_resource_classifications --category 395A:346B:catg:2C5F7E98E076D382E040578CA60B0D0E000000062022

modify_resources

Modifies an existing resource.

SYNTAX

beectl modify_resources {--resource resourceid | --select_by_name name } [--name <name>]         [--email_address <email address>] [--phone_number <phone_number>] [--website <website>] [--postal_address <postal address>]         [--identifier <identifier>] [--booking_info <booking info>] [--description <description>]         [--timezone <timezoneid>] [--location <location>] [--capacity <capacity>]         [--add_approver <approverid>][--delete_approver <approverid>]         [--booking_characteristics <[O]pen>|<[F]CFS>] [--scope <organization>] [--custom_processing <[T]rue>|<[F]alse>]         [--accessible_by <everyone | nobody | groupid | userid> ]   beectl modify_resources {--resource resourceid | --select_by_name name } --external [--name <name>]         [--email_address <email address>] [--phone_number <phone_number>] [--website <website>] [--postal_address <postal address>]         [--capacity <capacity>] [--timezone <timezone name>] [--location <location>]         [--booking_info <booking info>] [--description <description>] [--scope <organization>]

OPTIONS

--resource

Resource ID.

--select_by_name

modify a resource by name

--name

Modify the name of the resource.

--email_address

Modify the BUSINESS_1 e-mail address of the resource.

--phone_number

Modify the BUSINESS_1 phone number of the resource.

--website

Modify the BUSINESS_1 web site of the resource.

--postal_address

Specify the BUSINESS_1 postal address of the resource. The required format is: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country>. All fields are optional but at least one field must appear in a valid address of this type. For example, orapostal:l1=1, Main Street is a valid address. The ? character must not be encoded when used as a separator; it must be encoded in all other cases. For example orapostal:l1=1?l2=Which Street%3F?code=12345 is a valid address; but orapostal:l1=1?l2=Which Street??code=12345 is not a valid address because the question mark appearing as part of the address "Which Street?" is not encoded.

--timezone

Modify the timezone of the resource.

--location

e="sensitivity" mandatory="true" data_type="BOMe. It must be a xHTML string.

--identifier

Modify the identifier of the resource.

--capacity

Modify the capacity of the resource.

--external

Modify an external resource. If this option is not specified, the command modifies bookable resources.

--add_approver

Resource approver to add.

--delete_approver

Resource approver to delete.

--booking_characteristics

Specify resource default calendar booking characteristic. Specify [O] for Open or [F] for First Come First Serve, case insensitive.

--booking_info

Specify resource booking information. It must be a xHTML string.

--description

Specify the description of the resource. It must be a xHTML string.

--scope

Specify the new enterprise/organization the resource will be attached to.

--custom_processing

Specify if this resource requires custom processing. Specify "T", "True", "F" or "False", case insensitive.

--accessible_by

Specify who can access this resource. It must be one of "everyone", "nobody", a group id or finally a user id, case insensitive. Use "everyone" to reset the accessibility to the default for the resource.

EXAMPLES

beectl modify_resources --resource 395A:346B:bkrs:2C5F7E98E076D382E040578CA60B0D0E000000062327 --name "Resource2" --capacity 3

modify_role_definition

Modifies an existing RoleDefinition entity.

SYNTAX

beectl modify_role_definition --role_definition <unique identifier of the RoleDefinition> [--name <name of RoleDefinition>] [--description <description>] [[--privilege <privilege name>]...] [[--add_privilege <privilege name>]...] [[--remove_privilege <privilege name>]...] [--access_types <access types string>] [--always_enabled <boolean value>]

OPTIONS

--role_definition

Specify the unique identifier of the RoleDefinition to be modified.

--name

Modify the name of the RoleDefinition.

--description

Modify the description of the RoleDefinition.

--privilege

Modify the privileges of the RoleDefinition. To determine a list of valid privilege arguments, use the list_privileges command. This option can be specified more than once.

--add_privilege

Add privileges to the RoleDefinition. To determine a list of valid privilege arguments, use the list_privileges command. This option can be specified more than once.

--remove_privilege

Remove privileges from the RoleDefinition. To determine a list of valid privilege arguments, use the list_privileges command. This option can be specified more than once.

--access_types

Modify the access types for the RoleDefinition.

--always_enabled

Modify the AlwaysEnabled option of the RoleDefinition. Specify the TRUE argument to enable, and FALSE to disable.

EXAMPLES

beectl modify_role_definition --role_definition acrd=MyRoleDefinition,wksp=MyWorkspace,enpr=MyEnterprise --name MyRoleDefinition2

modify_secure_property

This command updates the sensitive property of the system model object identified by the --component.

Note :- Option value should not start with hyphen(-). If an option value starts with hyphen, use any one of the following syntaxes. 1. Use <option-name>=<option value> format. This is the preferred way to specify the option values starting with hypens. 2. Prepend the option value with string "ESCAPE:". 3. Prepend the option value with backslash "\\". This is the least preferred way. This may not work in some platforms, esp in windows platforms it will not work.

SYNTAX

beectl modify_secure_property --component <system object identifier or alias> --name <name> --value <obfuscated value> --obfuscated

OPTIONS

--component

component id.

--name

Name of the property.

--value

Value of the property.

EXAMPLES

beectl modify_secure_property --component d4261c24-e917-4e37-9777-41799ef9abe8 --obfuscated --name AdminPassword --value

modify_sensitivity

Modifies an existing Sensitivity entity.

SYNTAX

beectl modify_sensitivity --sensitivity <unique identifier of the Sensitivity> [--name <name of Sensitivity>] [--description <description>] [--sensitivity_only <boolean value>] [--delegatable <boolean value>]

OPTIONS

--sensitivity

Specify the unique identifier of the Sensitivity to be modified.

--name

Modify the name of the Sensitivity.

--description

Modify the description of the Sensitivity.

--sensitivity_only

Modify the SensitivityOnly option for the Sensitivity. Specify the TRUE argument to enable, and FALSE to disable.

--delegatable

Modify the Delegatable option for the Sensitivity. Specify the TRUE argument to enable, and FALSE to disable.

EXAMPLES

beectl modify_sensitivity --sensitivity acsn=MySensitivity,wksp=MyWorkspace,enpr=MyEnterprise --name MySensitivity2

modify_sensitivity_ace

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

SYNTAX

beectl modify_sensitivity_ace --sensitivity <unique identifier of the entity> --accessor <unique identifier of the Accessor> [--access_types <access types string>]

OPTIONS

--sensitivity

Specify the unique identifier of the Sensitivity in which the ACE will be replaced.

--accessor

Specify the unique identifier of the accessor to whom the access types were applied.

--access_types

Specify the access types string for the Accessor.

EXAMPLES

beectl modify_sensitivity_ace --sensitivity acsn=MySensitivity,wksp=MyWorkspace,enpr=MyEnterprise --accessor user=MyUser --access_types +RW-D

modify_tasklist

Modify various attributes of the selected tasklist.

SYNTAX

beectl modify_tasklist { --tasklist <tasklistid> | --tasklistowner <unique_identifier> | --select_by_address <uri> | --select_by_authuser <authuser> --select_by_user_name <user_name> | --select_by_resource_name <resource_name> | --select_by_workspace_name <workspace_name> } [--name <name>] [--priority <priority>] [--sensitivity <sensitivity>] [--caldav_resource_name <caldav_resource_name> [--derive_timezone <derive_timezone>] [--timezone <timezone>]

OPTIONS

--tasklist

Specify the unique identifier of a tasklist.

--tasklistowner

Specify the unique identifier of a user, resource or team workspace.

--select_by_address

Specify the Uniform Resource Identifier (URI) of a user, resource or team workspace using the format 'scheme:value'. If scheme is not supplied, mailto is assumed.

--select_by_authuser

Specify the login name of a user.

--select_by_user_name

Specify the name of a user.

--select_by_resource_name

Specify the name of a resource.

--select_by_workspace_name

Specify the name of a team workspace.

--name

Modify the tasklist name.

--priority

Modify the default priority of the tasklist. Permitted values are HIGH, MEDIUM, LOW and NONE, case insensitive.

--sensitivity

Modify the default sensitivity of the tasklist. Permitted values are PUBLIC, NORMAL, CONFIDENTIAL, PERSONAL and PRIVATE, case insensitive.

--caldav_resource_name

Modify the caldav resource name of the tasklist.

--derive_timezone

Modify the tasklist's 'derives timezone from the owner' configuration. Permitted values are Y (derive the tasklist timezone from its owner's timezone) or N.

--timezone

Modify the timezone of the tasklist.

EXAMPLES

beectl modify_tasklist --select_by_address user@example.com --name newName

modify_tasklist_permissions

Modify access permissions for grantee (user or group) on the specified tasklist.

SYNTAX

beectl modify_tasklist_permissions  { --tasklist <tasklistid> | --tasklistowner <unique_identifier> | --select_by_address <uri> | --select_by_authuser <authuser> | --select_by_user_name <user_name> } --user <userid> | --group <groupid> [--user_principal | --delegated_principal] [--can_assign | --cannot_assign] [--manage <sensitivity> ...] [--read <sensitivity> ...] [--deny <sensitivity> ...]

OPTIONS

--tasklist

Specify the unique identifier of a tasklist.

--tasklistowner

Specify the unique identifier of a user.

--select_by_address

Specify the Uniform Resource Identifier (URI) of a user using the format 'scheme:value'. If scheme is not supplied, mailto is assumed.

--select_by_authuser

Specify the login name of a user.

--select_by_user_name

Specify the name of a user.

--user

Specify the unique identifier of the target user.

--group

Specify the unique identifier of the target group.

--user_principal

Set permissions to user only.

--delegated_principal

Set permissions to delegated principal only.

--can_assign

Specify the grantee (user or group) can assign this tasklist.

--cannot_assign

Specify the grantee (user or group) cannot assign this tasklist.

--manage

Grant manage access (delegate) to the grantee (user) on specified sensitivities of this tasklist. Permitted values are: PUBLIC, NORMAL, CONFIDENTIAL, PERSONAL AND PRIVATE, case insensitive.

--read

Grant read access to the grantee (user or group) on specified sensitivities of this tasklist. Permitted values are: PUBLIC, NORMAL, CONFIDENTIAL, PERSONAL AND PRIVATE, case insensitive.

--deny

Deny the grantee (user or group) access to contents in this tasklist on the specified sensitivities. Permitted values are: PUBLIC, NORMAL, CONFIDENTIAL, PERSONAL AND PRIVATE, case insensitive.

EXAMPLES

beectl modify_tasklist_permissions --tasklistowner user=user1 --user user=user2 --can_assign --manage PUBLIC --read NORMAL --read PRIVATE

modify_team_workspace

Modifies an existing team workspace

SYNTAX

beectl modify_team_workspace --workspace <Workspace identifier> [--name <Workspace name>] [--description <Description>] [--add_participant <User or group identifier> [--role <Role definition identifier>]] [--remove_participant <User or group identifier>] [--email_address <Team workspace email address>] [--participation_mode <Team workspace participation mode. Value can be INVITE_ONLY, OPEN, or APPROVE_REQUIRED>] [--directory_listed <TRUE|FALSE. Default value is FALSE>] [--hard_quota <Hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota> --soft_quota <Soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>] [--workspace_owner <Workspace owner identifier>] [--enable_public_access <true | false>] [--public_access_role <Role definition identifier for public access>]

OPTIONS

--workspace

Workspace identifier

--add_participant

Add a user or group to the team workspace

--role

Workspace role definition identifier for the participants to be added

--remove_participant

Remove a user or group from the team workspace

--email_address

Team workspace email address

--participation_mode

Team workspace participation mode. Value can be INVITE_ONLY, OPEN, or APPROVE_REQUIRED

--directory_listed

TRUE|FALSE. Default value is FALSE

--workspace_owner

Workspace owner identifier

--enable_public_access

Whether to enable public access. If true is specified, option public_access_role must be specified

--public_access_role

Role definition identifier for public access

--name

Workspace name

--description

Description

--hard_quota

Hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota

--soft_quota

Soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota

EXAMPLES

beectl modify_team_workspace --workspace wksp=myWorkspace,enpr=Oracle --add_participant user=userId --role acrd=workspace-coordinator,enpr=Oracle --email_address teamworkspace@company.com --participation_mode OPEN --directory_listed TRUE

modify_timezones

Modify a time zone.

SYNTAX

beectl modify_timezones {--select_by_name <TimeZoneName> [--common] | --timezone <TimeZoneCollabId> [--common] | --reset_to_default}

OPTIONS

--timezone

Time zone ID. This option is optional and can be entered only once.

--select_by_name

Select time zone by name. This option is optional and can be entered only once.

--common

Set the specified time zone as common. This option is optional and can be entered only once.

--reset_to_default

Reset time zones to factory default. This option is optional and can be entered only once.

EXAMPLES

beectl modify_timezones --select_by_name America/New_York

beectl modify_timezones --reset_to_default

modify_trusted_identity

This command modifies the details of the trusted identity. At least one of the options new_service_name or new_key_alias need to be specified for this modification if the type is WSSEC. If the type of identity is not specified, it is defaulted to WSSEC.

SYNTAX

beectl modify_trusted_identity  [--type WSSEC --service_name <Trusted Identity Name> [--new_service_name <New Trusted Identity Name>] [--new_key_alias <new key alias>]]  [--type S2S --service_name <Trusted Identity Name> [--new_service_name <New Trusted Identity Name>] [--new_password <New Trusted Identity Password>]]  [--type SES --name <Trusted Entity Name> --new_name <New Trusted Entity Name> --new_password <New Trusted Entity Password>]

OPTIONS

--service_name

String value of the service principal name with which it will be identified in Beehive. This option is mandatory if type is WSSEC.

--new_service_name

String value of the new service principal name with which it will be identified in Beehive. This option is mandatory if type is WSSEC.

--new_key_alias

The new alias of the service which is used to register the certificate in the wallet. This option is mandatory if type is WSSEC.

--type

String value indicating the type of trusted identity: SES or WSSEC.SES refers to Secure Enterprise Search. WSSEC refers to Web services security.

--name

String value representing the name of the SES trusted entity.

--new_name

String value representing the new name of the SES trusted entity.

--new_password

String value representing the new password of the SES trusted entity.

EXAMPLES

modify_urm_urls

update urm urls

SYNTAX

beectl modify_urm_urls

OPTIONS

This command has no options

EXAMPLES

beectl modify_urm_urls

modify_user

The modify_user command modifies exisiting users.

SYNTAX

beectl modify_user    {        --user <User Identifier>      |        --email <Email address of the user>    }    [ --family_name <+/-[locale:]family name> ]      [ --given_name <+/-[locale:]given name> ... ]    [ --display_name <+/-[locale:]display name> ... ]     [ --middle_name <+/-[locale:]middle name> ... ]    [ --job_title <+/-[locale:]job title> ... ]     [ --prefix <+/-[locale:]prefix> ... ]    [ --suffix <+/-[locale:]suffix> ... ]     [ --nick_name <+/-[locale:]nick name> ... ]    [ --scope <identifier of users parent> ]    [ --office_location <office location of the user> ]     [ --company <company of the user> ]    [ --profession <profession of the user> ]     [ --timezone <timezone of the user> ]     [ --locale <locale of the user> ]     [ --department <department of the user> ]     [ --assistant <assistant identifier> ]     [ --manager <manager identifier> ]     [ --organization <organization identifier> ... ]     [ --remove_organization <organization identifier> ... ]     [ --login_id <+/-login_id>  ]     [ --login_password <password> ]     [ --voice_principal <+/-voice devicenumber> ]     [ --voice_pin <pin> ]     [ --property <+/-name=value=description> ... ]     [ --protocol_principal <+/-protocol principal> ]     [ --protocol_password <protocol password> ]     [ --address <+/-type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ]     [ --default_address_for_type <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ]     [ --default_address_for_scheme <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ]     [ --primary_address <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ]     [ --status <status of user(enabled|disabled|locked)> ]    [ --external_inbox <true|false> ]     [ --delegate <[+][delegated_principal_name]:identifier_of_delegator or -delegated_principal_identifier> ]    [ --lock <principal/account to be locked(PRIMARY|PROTOCOL|VOICE|USER)> ]     [ --unlock <principal/account to be unlocked(PRIMARY|PROTOCOL|VOICE|USER)> ]    [ --public_presence <ENABLE|DISABLE> ]     [ --extended_enterprise_user <true|false> ]

OPTIONS

--user

Identifier of the user.

--email

Exact email id of the user whose details have to be retrieved. It should be in the format user1@example.com

--family_name

Family name of the user in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.

--given_name

Given name of the user in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.

--display_name

Display name of the user in the format: [+/-]value or [+/-]address-line-1&gt;?l2=&lt;address-line-2&gt;?box=&lt;post-box-number&gt;?cy=&lt;city&gt;?st=&lt;state&gt;?code=&lt;postal-code&gt;?c=&lt;country&gt; where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESSeter should be added. If - is specified that means the parameter should be removed. Default action is addition.

--middle_name

Middle name of the user in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.

--job_title

Job title of the user in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--prefix

Prefix of the user in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.

--suffix

Suffix of the user in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.

--nick_name

Nick name of the user in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.

--scope

Identifier of the enterprise or organization under which this user will be created.

--office_location

Office location of the user. To unset the previously defined value pass either of the following strings: NULL or null.

--company

Company of the user. To unset the previously defined value pass either of the following strings: NULL or null.

--profession

Profession of the user. To unset the previously defined value pass either of the following strings: NULL or null.

--timezone

Timezone of the user. list_timezones lists the valid timezones

--locale

Locale details of the user. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.

--department

Department of the user. To unset the previously defined value pass either of the following strings: NULL or null.

--assistant

Identifier of the assistant.

--manager

Identifier of the manager.

--organization

Identifiers of the organizations the user must be part of.

--remove_organization

Identifiers of the organizations the user must be removed from.

--property

Details of the property in the format [+/-]name=value=description. All custom properties are supported. Note, no equals to symbol(=) should be present in the name or value or description. + or no symbol means the property should be added. If - is specified that means the property should be removed. Default action is addition.

--address

Address of the user in the format [+/-]type:scheme:value. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25. + or - in the start of the string tells whether the address should be added or removed. + or no symbol means the address should be added. If - is specified that means the address should be removed. Default action is addition.

--default_address_for_type

Address of the user in the format type:scheme:value. Sets the specified address as the default for the specified type. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.

--default_address_for_scheme

Address of the user in the format type:scheme:value. Sets the specified address as the default for the specified scheme. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.

--primary_address

Primary address of the user in the format type:scheme:value. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country>s> <option name="configuration" mandatory="true" data_type="BOM_OBJECT_ID">Version configuration to be updated.<_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.

--login_id

The login credentials of the user. A user can have only one login id. Hence if a user already has a login id then the old value will be replaced with the new value.

--login_password

Login password.

--voice_principal

Voice principal of the user. A user can have only one voice principal. Hence if a user already has a voice principal then the old value will be replaced with the new value.

--voice_pin

Pin number for the voice device.

--protocol_principal

Protocol principal of the user. A user can have only one protocol principal. Hence if a user already has a protocol principal then the old value will be replaced with the new value.

--protocol_password

Protocol password.

--status

Sets the provisioning status of the user. Supported values are ENABLED, DISABLED.

--external_inbox

Boolean values which indicates if user's inbox is external or not. Supported values are TRUE, FALSE.

--delegate

Details of the delegated principal in the format principal_name:delegated_identifier or -delegated_principal_identifer. principal_name is the name of the delegated principal that will be created and delegated_identifier is the identifier of the actor who is being delegated. + or - in the start of the string tells whether the principal should be added or removed. + or no symbol means the delegated principal should be added. If the principal name contains a colon(:) it should be properly escaped. If - is specified that means the delegated principal should be removed. In this case only the identifier of the delegated principal has to be specified. Default action is addition. While removing the principal the minus sign (-) has to be escaped. Example: use a s ESCAPE:-. For more details on escaping please refer to beectl help.

--lock

Locks the principal sepcified. Valid values are PRIMARY, PROTOCOL, VOICE, USER. USER will lock account of the user.

--unlock

Unlocks the principal sepcified. Valid values are PRIMARY, PROTOCOL, VOICE, USER. USER will unlock account as well as all the principals of the user.

--public_presence

Enables or disables the public presence of the users (ability of unauthorized users to see someone's presence). Supported values are ENABLED, DISABLED.

--extended_enterprise_user

Boolean if user is an external user or not.

EXAMPLES

beectl modify_user --user user=user1 --given_name User1GivenName --family_name -en_CA:User1FamilyName --office_location 4A037

beectl modify_user --email user1@example.com --property +employee_number=1234

beectl modify_user --email user1@example.com --address BUSINESS_1:mailto:user1@example.com --address ESCAPE:-BUSINESS_2:im:user1@example.com

beectl modify_user --user user=user1 --voice_principal 1234567 --voice_pin 123423 --protocol_principal ESCAPE:-protocolPrincipal

beectl modify_user --user user=user1 --lock PROTOCOL

beectl modify_user --user user=user1 --unlock PRIMARY

beectl modify_user --user user=user1 --unlock USER

beectl modify_user --user user=user1 --nick_name +en:User1NickName --assistant user=user3 --manager user=user2

beectl modify_user --email user1@example.com --status disabled

beectl modify_user --user user=user1 --delegate DelegatedPrincipalName:user=user2

beectl modify_user --user user=user1 --delegate ESCAPE:-pcpd=CalendarDelegation2,user=rafiul2

modify_user_subscription

Enables or disables an existing subscription

SYNTAX

beectl modify_user_subscription {--enable {true|false} --subscription <Subscription identifier> | --disable_all_subscriptions_for_user <identifier of subscriber>}

OPTIONS

--enable

Enable or disable the subscription. Permitted values are 'true' (enable subscription) or 'false' (disable subscription)

--subscription

Specify the identifier of the subscription.

--disable_all_subscriptions_for_user

Specify the identifier of the subscriber who owns the subscription.

EXAMPLES

beectl modify_user_subscription --enable true --subscription 5457:7954:subs:337F34E37E8E81F1E040578C921630B700000000B864

beectl modify_user_subscription --disable_all_subscriptions_for_user user=john.smith

modify_version_configuration

Updates a given version configuration.

SYNTAX

beectl modify_version_configuration --configuration <Configuration identifier> --file <Full path of the configuration XML file>

OPTIONS

--configuration

-component 5792bd5f-3b46-42de-a15d-8

--file

Full path of the version configuration XML file. The file must contain properly formatted data.

EXAMPLES

beectl modify_version_configuration --configuration 9941:2345:avcg:58D193D162CE4ED89FF66AB4E55745B6345464545453 --file /tmp/configuration.xml

modify_virus_scan_policy

Modifies the virus scan policy configured for the Site. Valid values for the scan policy are: NO_SCAN_OR_REPAIR, SCAN_ONLY, SCAN_AND_REPAIR. Default is NO_SCAN_OR_REPAIR.

SYNTAX

beectl modify_virus_scan_policy [ --scanpolicy <virusscanpolicy> ]

OPTIONS

--scanpolicy

Virus scan policy. Default is NO_SCAN_OR_REPAIR.

EXAMPLES

<beectl modify_virus_scan_policy --scanpolicy SCAN_AND_REPAIR>

modify_workspace_template

Modifies an existing workspace template

SYNTAX

beectl modify_workspace_template --template <Full path of the template file> --file <{7}>

OPTIONS

--template

Workspace template identifier

--file

Full path of the template file

EXAMPLES

beectl modify_workspace_template --template wstp=test_team_ws_template,enpr=test_enterprise --file /tmp/template.xml

obfuscate

Obfuscates the prompted string.

SYNTAX

beectl obfuscate [--expiration_time_in_minutes 30]

OPTIONS

--expiration_time_in_minutes

Indicates the time in minutes for which obfuscated string should be valid for the use in this Beehive instance. If "0" is passed, obfuscated string will never expire.

EXAMPLES

beectl obfuscate

(Prompted)Enter the password : [User types in the password which is not echoed on the standard output].

recover_search_failures

Recover search failures. If scope is not specified, Recover search failures from all scopes.

SYNTAX

beectl recover_search_failures [--crawl <Recover crawl failures>] [--scope <Recover failures for this personal or team workspace scope>] [--start_date <Recover failures of entities modified on or after this date>] [--end_date <Recover failures of entities modified on or before this date>]

OPTIONS

--crawl

Recover crawl failures

--scope

Recover failures for this personal or team workspace scope

--start_date

Recover failures of entities modified on or after this date

--end_date

Recover failures of entities modified on or before this date

EXAMPLES

beectl recover_search_failures --crawl true --scope 4731:36F4:wspr:B886F81BB37C40708B773C94BF30B063000000000001 --start_date 2010-06-01T00:00:01 --end_date 2010-06-30T00:00:01

restart

Manages OC4J Instances, Beehive Transport Infrastructure Monitors and Oracle HTTP servers components. The command "beectl status" displays the component id and the status of these manageable components.

SYNTAX

beectl restart [ --component <component id> | --all | --serially]

OPTIONS

--component

Identifier of component to restart. To restart more than one component at a time, specify this option multiple times.

--all

restart all managed components.

--serially

It specified, restarts all the components one by one.

EXAMPLES

beectl restart --all

<option name="all" mandatory="false" data_type="BOOLEe4b86fd46f

send_broadcast_im_message

Sends Instant Message to all online users.

SYNTAX

beectl send_broadcast_im_message --from <IM address of user sending the message> [--subject Subject of the Instant Message to be sent to all online users] --message <Instant Message to be sent to all online users>

OPTIONS

--from

IM address of user sending the message

--subject

Subject of the Instant Message to be sent to all online users

--message

Instant Message to be sent to all online users

EXAMPLES

beectl send_broadcast_im_message --from im:user1@example.com --subject announcement --message Hello

beectl send_broadcast_im_message --from im:user1@example.com --message Hello

start

Manages OC4J Instances, Beehive Transport Infrastructure Monitors and Oracle HTTP servers components. The command "beectl status" displays the component id and the status of these manageable components.

SYNTAX

beectl start [ --component <component id> | --all | --serially]

OPTIONS

--component

Identifier of component to start. To start more than one component at a time, specify this option multiple times.

--all

start all managed components.

--serially

It specified, starts all the components one by one.

EXAMPLES

beectl start --all

beectl start --component 5792bd5f-3b46-42de-a15d-8fe4b86fd46f

status

Displays the status of all managed components.

SYNTAX

beectl status [--dashboard | --detail] [--all_home_instances | --all_services | (--component <State manageable component>) ...  --all_disabled_components | [--disabled_beehive_instances] [--disabled_oc4js] [--disabled_service_instances] [--disabled_services] ]

OPTIONS

--dashboard

A dashboard view of all the specified components is shown.

--detail

A detailed view of all the specified components is shown.

--all_home_instances

Status of all Beehive instances is shown.

--all_services

Status of all Services is shown.

--component

Status of the specified components is shown.

--all_disabled_components

Lists all the disabled components in the system is shown.

--disabled_beehive_instances

Lists all the disabled beehive instances in the system is shown.

--disabled_oc4js

Lists all the disabled managed oc4js in the system is shown.

--disabled_service_instances

Lists all the disabled service instances in the system is shown.

--disabled_services

Lists all the disabled services in the system is shown.

EXAMPLES

beectl status

stop

Manages OC4J Instances, Beehive Transport Infrastructure Monitors and Oracle HTTP servers components. The command "beectl status" displays the component id and the status of these manageable components.

SYNTAX

beectl stop [ --component <component id> | --all | --serially]

OPTIONS

--component

Identifier of component to stop. To stop more than one component at a time, specify this option multiple times.

--all

stop all managed components.

--serially

It specified, stops all the components one by one.

EXAMPLES

beectl stop --all

beectl stop --component 5792bd5f-3b46-42de-a15d-8fe4b86fd46f

upload_apns_keystore

Uploads the provider file for Apple Push Notification Service.

SYNTAX

beectl upload_apns_keystore --file <path to the apns provider file>

OPTIONS

--file

Specify the full path and file name of the .p12 file.

EXAMPLES

beectl upload_apns_keystore --file $BH/beehive/seed/push/anps.p12

upload_attendant_prompt

Upload a prompt to the database.

SYNTAX

beectl upload_attendant_prompt --name <name of attendant> --type <type of prompt> [--language <language of prompt>] --file <prompt file>

OPTIONS

--name

Name of the attendant.

--type

Type of the prompt. Can be one of language, menu, greeting, extension-prompt, extension-nomatch, option1, option2, option3, option4, option4, option5, option6, option7, option8, option9, noinput, noinput-term, nomatch, nomatch-term.

--language

Language of the prompt.

--file

Path to the prompt file.

EXAMPLES

beectl upload_attendant_prompt --name myAttendant --type menu --language en_US --file menu.wav

upload_client_application

Uploads client application binaries to the repository. Either a binary file path or path to a directory containing binary files should be specified.

SYNTAX

beectl upload_client_application { --file <path to the client binary> | --dir <full path to the directory containing the client binaries>}]

OPTIONS

--file

Specify the full path and file name of the client ZIP file.

--dir

Specify the full path of the directory containing the client ZIP files.

EXAMPLES

beectl upload_client_application --file $BH/beehive/seed/dm/pushmail_debug.PPC5.0_ARM.element.zip

beectl upload_client_application --dir $BH/beehive/seed/dm/

upload_device_profiles

Uploads device profiles to the repository. An XML file or a directory containing XML files can be used as the source for the device profiles. The file can also contain device types and device profile schema.

SYNTAX

beectl upload_device_profiles { --file <Full file path of the device profiles XML file> | --dir <Full path of the directory containing device profiles XML files>}

OPTIONS

--file

Specify the full path and file name of the device profiles XML file.

--dir

Specify the full path of the directory containing the device profiles XML files.

EXAMPLES

beectl upload_device_profiles --file /tmp/device-profiles.xml

beectl upload_device_profiles --dir /tmp/device-profiles/

upload_language_pack

Loads language pack resources into the system.

SYNTAX

beectl upload_language_pack --source <source> [--ignore_version] [--suppress_warning] [--accept_builtin]

OPTIONS

--source

Source jar file containing one or more xliff files or one or more helpsets. Only a jar file is permitted as source value.

--ignore_version

Ignore version information in the xliff files; use with caution.

--suppress_warning

Suppress warnings about potential xliff problems; only report fatal errors.

--accept_builtin

Accept xliff files or helpsets marked as built-in. This option must be used only when necessary because uploading built-in xliff files or helpsets is typically a maintenance activity. In absence of this option the command will fail if a built-in xliff file or helpset is being uploaded - this behaviour has been designed to guard against accidentally uploading built-in xliff files or helpsets.

EXAMPLES

beectl upload_language_pack --source abc.jar

Add/modify the xliff file(s) or helpset(s) packaged in abc.jar to existing language pack. Command will fail if any .xlf or helpset is of filetype builtin. abc.jar is expected to package helpset(s) in the directory structure helpsets/<library_name>/custom/<locale>/<helpset.jar>. .xlf files (and associated .class files) must be packaged in langpack/xliff/custom/x.xlf and langpack/<java-package-tree>/x.class directories respectively. Command will fail if any .xlf does not contain version. The command will fail if the version of an .xlf file is prior to the version of corresponding .xlf file in existing language pack. Helpsets are not versioned hence all custom helpsets from abc.jar MUST overwrite custom helpsets of same name and same locale in same library in existing language pack.

beectl upload_language_pack --source abc.jar --accept_builtin

Add/modify the xliff file(s) or helpset(s) packaged in abc.jar to existing language pack. Command will process helpsets or xliff files of both filetypes - built-in and custom. abc.jar is expected to package helpset(s) in the directory structure helpsets/<library_name>/<filetype>/<locale>/<helpset.jar>. .xlf files (and associated .class files) must be packaged in langpack/xliff/<filetype>/x.xlf and langpack/<java-package-tree>/x.class directories respectively. Command will fail if any .xlf does not contain version. The command will fail if the version of an .xlf file is prior to the version of corresponding .xlf file in existing language pack.

beectl upload_language_pack --source abc.jar --ignore_version

Add/modify the xliff file(s) or helpset(s) packaged in abc.jar to existing language pack. Command will fail if any .xlf or helpset is of filetype builtin. abc.jar is expected to package helpset(s) in the directory structure helpsets/<library_name>/custom/<locale>/<helpset.jar>. .xlf files (and associated .class files) must be packaged in langpack/xliff/custom/x.xlf and langpack/<java-package-tree>/x.class directories respectively. Version info in xliff files is completely ignored i.e. all custom .xlf files from abc.jar WILL overwrite custom files of same name in existing language pack.

beectl upload_language_pack --source abc.jar --accept_builtin --ignore_version

Add/modify the xliff file(s) or helpset(s) packaged in abc.jar to existing language pack. Command will process helpsets or xliff files of both filetypes - built-in and custom. abc.jar is expected to package helpset(s) in the directory structure helpsets/<library_name>/<filetype>/<locale>/<helpset.jar>. .xlf files (and associated .class files) must be packaged in langpack/xliff/<filetype>/x.xlf and langpack/<java-package-tree>/x.class directories respectively. Version info in xliff files is completely ignored i.e. all custom .xlf files from abc.jar WILL overwrite custom files of same name in existing language pack.

validate_configuration

Validates the configuration for given component id or for the whole system model tree.

SYNTAX

beectl validate_configuration [ --id <system object id or alias of system object>]

OPTIONS

--id

component id.

EXAMPLES

beectl validate_configuration

Validates the whole configuration system model.

beectl validate_configuration --id a1d290a8-f8a7-46ea-ae3d-0696c0bde331

Validates the system model object identified by given id or alias.

validate_directory_entry

e> <s the directory entry in ldap with corresponding entry in beehive. The directory entry can be of type user, group or external person. The command provides an option to correct any data inconsistencies by applying necessary changes in beehive. The state of the profile specified in this command can either be ENABLE or DISABLE.

SYNTAX

beectl validate_directory_entry (  ([ --email <email>] | [ --identifier <bodn> ] | [ --dn <dn> ]    [ --verbose ] [ --timezone_update ])   | --all_users [ --timezone_update ] | --all_groups | --all | --delete |   --profile <Profile_name> [--commit]

OPTIONS

--identifier

Identifier of the user, group or external-person in beehive

--email

Email-ID of the user, group or external-person.

--dn

DN(distinguished name) of the user, group or external-person in ldap directory

--commit

When Command is run with this option, it makes the changes in beehive database. The default is set to non-commit mode or no database changes.

--verbose

This option is used display the detailed information.

--profile

Name of the profile

--all_users

To reconcile all users.

--all_groups

To reconcile all groups.

--all

To reconcile all users and group.

--delete

To reconcile all deleted entries.

--timezone_update

To reconcile timezone.

EXAMPLES

beectl validate_directory_entry --email user1@example.com --profile exampleProfile --commit --verbose

beectl validate_directory_entry --dn cn=user2,cn=users,dc=example,dc=com --profile exampleProfile --commit --verbose

beectl validate_directory_entry --identifier user=user3@example.com --profile exampleProfile --verbose

beectl validate_directory_entry --all --profile exampleProfile

beectl validate_directory_entry --all_users --profile exampleProfile

beectl validate_directory_entry --all_groups --profile exampleProfile

validate_midtier

It validates midtier for various conditions. For example, it reports the issues of database connectivity with each individual rac node.

SYNTAX

beectl validate_midtier [--connection_string <connection string to validate>] [--schema_user <user having sysdba privilege>] [--schema_password <Password for user having sysdba privilege>]

OPTIONS

--connection_string

Configuration repository connect string.

--schema_user

Name of the user having sysdba privilege.

--schema_password

Password for user having sysdba privilege.

EXAMPLES

beectl validate_midtier

Above command will use the connection string and credentials available with boot strap configuration and validate the connectivity.

beectl validate_midtier --connection_string (DESCRIPTION=(ENABLE=BROKEN)(ADDRESS_LIST=(LOAD_BALANCE=on)(FAILOVER=on)(ADDRESS=(PROTOCOL=TCP)(HOST=1234.example.com)(PORT=1234)))(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=mydb.example.com))) --schema_user system --schema_password 1234dedrf2wddgeyeheteeddy

Above command will use the given connection string, credential for sys user and validate the connectivity

validate_policy

Evaluates or executes a policy based on an event payload file.

SYNTAX

beectl validate_policy --event_name <Event name.> --event_payload_file <Path to the event payload xml file.> --policy <The policy identifier.> { --evaluate <Evaluate this policy.> | --execute <Execute this policy.> }

OPTIONS

--event_name

Event name.

--event_payload_file

Path to the event payload xml file.

--policy

The policy identifier.

--evaluate

Evaluate this policy.

--execute

Execute this policy.

EXAMPLES

beectl validate_policy --event_name MyEventTypeName --event_payload_file MyEventPayloadFile.xml --policy MyPolicy --policy

validate_site_key

Validates the given site key.

SYNTAX

beectl validate_site_key --site_key <new site key>

OPTIONS

--site_key

Site key to be validated.

EXAMPLES

beectl validate_site_key --site_key 87hyhuh78e=122nddn356763yhd34bnh

validate_virus_scan_engine_connectivity

Tests the connectivity to the virus scan engine running at the specified host and port.

SYNTAX

beectl validate_virus_scan_engine_connectivity [ --hostname <scanengine_hostname> ] [ --port <scanengine_port> ]

OPTIONS

--hostname

Name of the host where the virus scan engine is installed. Default is localhost.

--port

Port number used by the virus scan engine for communication with its clients. Default is 1344.

EXAMPLES

<beectl validate_virus_scan_engine_connectivity --hostname scanenginehost.example.com --port 1344>

version

This command shows the version information of the Beehive products.

List of valid Beehive products is shown below. Use them as a value for the "product" option.

accesschecks

accesscontrol

admin

alarm

artifacts

audit

authn

beectl

beehivemail

bio

btimon

caldav

cms

collabcoex

common-framework

content

core

csi_r1

csi_r1-impl

cspi

discussions

dms

event

event-definitions

framework

ftp

im

jcr

management

mds

mgmtsvc

mobileclient

mobiledm

nms

oma

omb

owc

owc-stdmedia

platform

policy

presence

push

pushmail

rds

search

smpp

teamcollaboration

tms

tzs

uds

uss

version

virusscanner

voice

voip

webdav

wiki

workspaces

xbom

xmpp

xms

List of valid field names is shown below. Use them as a value for "field" option.

name

build_version

internal_version

internal_version_name

public_version

public_version_name

product_description

product_suite_association_ids

beectl version command output is fully customizable. The multi-valued "product" option can be used to get version information for a specified set of products. Similarly the multi-valued "field" option can be used to get the information about the specified set of fields only.

When multi-valued product and field options are used, beectl version command display order is same as the order specified for product and field options in command line.

SYNTAX

beectl version [--all | [[--product <Product Name>] ...]] [[--field <Field Name>]...]

OPTIONS

--all

Shows version information for all products.

--product

Shows version information for the specified products. This option is multi-valued.

--field

Shows the value of the specified fields. This option is multi-valued.

EXAMPLES

beectl version --all

The above command will list the version information about all the products.

beectl version --product uds --field internal_version --field internal_version_name --field product_suite_association_ids

The above command will list internal_version, internal_version_name and product_suite information for the user directory service component.

3 Oracle Beehive Error Codes

This module contains Oracle Beehive error codes.

Access Control Error Codes

The following table lists error codes for Access Control.

Table 3-1 Access Control

Message ID

Display Name

Severity

Cause

Effect

Action

BEEU-00500

A problem occurred executing an AccessControl CSI method.

FINE

See the associated exception for details.

The AccessControl CSI method failed.

Please contact Oracle Support for more information.

BEES-00501

PL/SQL returned an exception.

FINE

See the associated exception for details.

The PL/SQL failed to execute.

Please contact Oracle Support for more information.

BEES-00502

A problem occurred trying to access the database.

WARNING

See the associated exception for details.

A problem occurred trying to access the database.

Please contact Oracle Support for more information.

BEEU-00503

An illegal or invalid argument was specified.

WARNING

See the associated exception for details.

The affected CSI method failed to execute.

Correct the argument and try again. Please contact Oracle Support for more information if the problem persists.

BEEC-00504

An AccessControl service related exception occurred.

SEVERE

See the associated exception for details.

See the associated exception for details.

Please contact Oracle Support for more information

BEER-00505

A PL/SQL exception occurred.

WARNING

A PL/SQL exception occurred.

PL/SQL execution failed.

Please contact Oracle Support for more information.

BEEZ-00506

You do not have the required access.

FINE

You do not have the required access.

You do not have the required access.

Please contact Oracle Support for more information.

BEEU-00507

There already is an Entity with similar attributes at the same Scope.

FINE

There already is an Entity with similar attributes at the same Scope.

There already is an Entity with similar attributes at the same Scope.

Please contact Oracle Support for more information.

BEEU-00508

The specified Entity does not exist.

FINE

The specified Entity does not exist.

The specified Entity does not exist.

Please contact Oracle Support for more information.

BEEU-00509

The specified Entity does not exist or has not been registered with AccessControl.

WARNING

The specified Entity does not exist or has not been registered with AccessControl.

The specified Entity does not exist or has not been registered with AccessControl.

Please contact Oracle Support for more information.

BEEU-00510

A PL/SQL integrity constraint violation occurred.

FINE

A PL/SQL integrity constraint violation occurred.

PL/SQL execution failed.

Please contact Oracle Support for more information.

BEEU-00511

A PL/SQL unique constraint violation occurred.

FINE

A PL/SQL unique constraint violation occurred.

PL/SQL unique failed.

Please contact Oracle Support for more information.

BEEU-00512

The specified Entity snapshot is outdated.

FINE

The specified Entity snapshot is outdated.

The specified Entity snapshot is outdated.

Please contact Oracle Support for more information.

Address Book Error Codes

The following table lists error codes for Address Book.

Table 3-2 Address Book

Message ID

Display Name

Severity

Cause

Effect

Action

BEEU-03101

An error occurred during address book creation

WARNING

Duplicate entity No such entity The specified parent does not exist or cannot be used The name was not specified or cannot be used The specified name is already in use Root address book already exists for the specified parent Quota/lock check failed The user does not have the required access rights Failed to set the change status of the entity Failed to register the container with workspace Failed to register the element with workspace Failed to register the entity with access control service Failed to set access on the entity Failed to load the entity Failed to raise event for the operation The specified value for one or more parameters is too large Failed to perform a workspace operation The entity is locked The quota limit for this scope has exceeded Failed to register the default address book with workspace Failed to find the parent workspace Failed to create the automatically created contacts Failed to create the senstivity for the container Failed to create the guard for the container Failed to fetch the sensitivities for the container Failed to fetch the local access control entries for the container Failed to copy the local access control entries for the container Failed to copy the sensitivity access control entries for the container Failed to get the default sensitivity for the parent container

The specified address book was not created

Specify a valid value Specify another value See the log file for more details

BEEU-03102

An error occurred during address book update

INFO

A newer version of the specified entity exists in the system The specified address book is invalid No such entity The specified name is already in use The user does not have the required access rights Quota/lock check failed Failed to perform a workspace operation Failed to raise event for the operation Failed to set the change status of the entity The specified value for one or more parameters is too large Failed to load the entity The entity is locked The quota limit for this scope has exceeded Failed to find the parent workspace Failed to create the senstivity for the container Failed to get the default sensitivity for the parent container The default sensitivity cannot be nullified The specified sensitivity is invalid

The specified address book was not updated

Specify a valid value Specify another value Refresh the entity and retry the operation See the log file for more details

BEEU-03103

An error occurred during address book deletion

WARNING

No such entity The specified address book is invalid A newer version of the specified entity exists in the system The user does not have the required access rights Quota/lock check failed Failed to perform a workspace operation Failed to raise event for the operation This operation is not allowed on a default address book This operation is not allowed on an address book containing automatically created contacts The entity is locked The quota limit for this scope has exceeded Failed to get the trash item

The specified address book was not deleted

Specify a valid value Refresh the entity and retry the operation See the log file for more details

BEEU-03104

An error occurred during address book load

INFO

No such entity The user does not have the required access rights The specified address book is invalid

The specified address book was not loaded

Specify a valid value

BEEU-03105

An error occurred during address book move

INFO

A newer version of the specified entity exists in the system The specified address book is invalid No such entity The source address book does not exist The destination address book/workspace does not exist The specified name is already in use The specified parent does not exist or cannot be used The user does not have the required access rights Quota/lock check failed Failed to perform a workspace operation Failed to raise event for the operation Failed to set access on the entity This operation is not allowed on a default address book This operation is not allowed on an address book containing automatically created contacts The address book cannot be moved to one of its sub address books The entity is locked The quota limit for this scope has exceeded Failed to create the senstivity for the container Failed to create the guard for the container Failed to fetch the sensitivities for the container Failed to fetch the local access control entries for the container Failed to copy the local access control entries for the container Failed to copy the sensitivity access control entries for the container Failed to delete the senstivities for the container Failed to find the parent workspace

The specified address book was not moved

Specify a valid value Specify another value Refresh the entity and retry the operation See the log file for more details

BEEU-03106

An error occurred during address book copy

INFO

A newer version of the specified entity exists in the system The specified address book is invalid No such entity The source address book does not exist The destination address book/workspace does not exist The specified name is already in use Duplicate entity The specified parent does not exist or cannot be used The user does not have the required access rights Root address book already exists for the specified parent Quota/lock check failed Failed to set the change status of the entity Failed to register the container with workspace Failed to register the element with workspace Failed to register the entity with access control service Failed to set access on the entity Failed to load the entity Failed to raise event for the operation Failed to apply labels to the specified entity Failed to perform a workspace operation The entity is locked The quota limit for this scope has exceeded Failed to find the parent workspace

The specified address book was not copied

Specify a valid value Specify another value Refresh the entity and retry the operation See the log file for more details

BEEU-03107

An error occurred during address book undelete

WARNING

A newer version of the specified entity exists in the system The specified address book is invalid No such entity The specified name is already in use Duplicate entity The destination address book/workspace does not exist The specified parent does not exist or cannot be used The user does not have the required access rights Quota/lock check failed Failed to set access on the entity Failed to raise event for the operation Failed to perform a workspace operation The entity is locked The quota limit for this scope has exceeded

The specified address book was not undeleted

Specify a valid value Specify another value Refresh the entity and retry the operation See the log file for more details

BEEU-03108

An error occurred during address book get

INFO

No such entity Failed to load the entity The user was not specified or cannot be used The specified workspace is invalid The specified parent does not exist or cannot be used

The address book for the specified entity could not be retrieved

Specify a valid value

BEEU-03109

An error occurred during get element modifications for the address book

WARNING

No such entity The specified address book is invalid The specified anchor is too old

The modified elements could not be fetched for the address book

Specify a valid value Specify another value

BEEU-03110

An error occurred during address book purge

WARNING

Failed to purge the contacts in the address book Failed to unregister the entity with access control service This operation is not allowed on an address book containing automatically created contacts Failed to delete the senstivities for the container Failed to fetch the sensitivities for the container Failed to perform a workspace operation

The specified address book was not purged

See the log file for more details

BEEU-03111

An error occurred during address book archiving

WARNING

Failed to archive the contacts in the address book Failed to unregister the entity with access control service Failed to perform a workspace operation

The specified address book was not archived

See the log file for more details

BEEU-03112

An error occurred while listing address books

WARNING

The specified address book is invalid The specified list filter is invalid A projection was not specified or cannot be used

The address books could not be listed

Specify a valid value

BEEU-03113

An error occurred during address book element bulk load

WARNING

A projection was not specified or cannot be used The specified address book element is invalid

The specified address book elements were not loaded

Specify a valid value

BEEU-03116

An error occurred during person contact creation

WARNING

The user does not have the required access rights The specified address is invalid An entity with the specified address already exists No such address The type of address has a suffix beyond the configured range of the system The type of the address is invalid The scheme of the address is invalid The specified property is invalid; Name = {0}, Value = {1} The specified value for the parameter {0} is too large (Limit is {1}) The specified value for one or more parameters is too large The specified parent does not exist or cannot be used The specified bookmark value is invalid The speeddial specified is not correct or unique Failed to register the entity with access control service Failed to set access on the entity Quota/lock check failed Failed to perform a workspace operation Failed to perform the required attachment operation. Check the logs for more details. The specified roster entry exists Failed to raise event for the operation The entity is locked The quota limit for this scope has exceeded Failed to get the default sensitivity for the parent container The default sensitivity cannot be nullified The specified sensitivity is invalid Failed to create the guard for the container Failed to find the parent workspace

The specified person contact was not created

Specify a valid value Specify another value Maximum count for the addresses exceeded, check the maximum addresses allowed See the log file for more details Quota exceeded, check the allowed quota

BEEU-03117

An error occurred during person contact load

WARNING

No such entity The user does not have the required access rights The specified person contact is invalid

The specified person contact was not loaded

Specify a valid value

BEEU-03118

An error occurred during person contact update

WARNING

No such entity The specified person contact is invalid A newer version of the specified entity exists in the system Failed to perform a workspace operation The specified parent does not exist or cannot be used The user does not have the required access rights Quota/lock check failed The specified address is invalid An entity with the specified address already exists No such address The type of address has a suffix beyond the configured range of the system The type of the address is invalid The scheme of the address is invalid The specified property is invalid; Name = {0}, Value = {1} The specified value for the parameter {0} is too large (Limit is {1}) The specified value for one or more parameters is too large The speeddial specified is not correct or unique The quota for the contacts has exceeded Failed to perform the required attachment operation. Check the logs for more details. Failed to raise event for the operation The specified roster entry exists This operation is not allowed on automatically created contacts The entity is locked The quota limit for this scope has exceeded Failed to find the parent workspace The default sensitivity cannot be nullified Failed to create the guard for the container The specified sensitivity is invalid

The specified person contact was not updated

Specify a valid value Specify another value Refresh the entity and retry the operation Maximum count for the addresses exceeded, check the maximum addresses allowed See the log file for more details Quota exceeded, check the allowed quota

BEEU-03119

An error occurred during person contact delete

WARNING

No such entity The specified person contact is invalid A newer version of the specified entity exists in the system The user does not have the required access rights Quota/lock check failed Failed to perform a workspace operation Failed to delete reminders of a contact Failed to raise event for the operation This operation is not allowed on automatically created contacts The entity is locked The quota limit for this scope has exceeded Failed to get the trash item Failed to find the parent workspace

The specified person contact was not deleted

Specify a valid value Refresh the entity and retry the operation Specify another value

BEEU-03120

An error occurred during person contact undelete

WARNING

No such entity The specified person contact is invalid The specified parent does not exist or cannot be used The user does not have the required access rights Quota/lock check failed Failed to perform a workspace operation The destination address book does not exist The speeddial specified is not correct or unique Failed to set access on the entity The quota for the contacts has exceeded The specified roster entry exists Failed to raise event for the operation The entity is locked The quota limit for this scope has exceeded Failed to find the parent workspace

The specified person contact was not undeleted

Specify a valid value Specify another value See the log file for more details Quota exceeded, check the allowed quota

BEEU-03121

An error occurred during person contact move

WARNING

No such entity The user does not have the required access rights Quota/lock check failed Failed to set access on the entity The specified person contact is invalid The specified parent does not exist or cannot be used The destination address book does not exist The quota for the contacts has exceeded Failed to raise event for the operation This operation is not allowed on automatically created contacts The entity is locked The quota limit for this scope has exceeded Failed to create the guard for the container Failed to find the parent workspace

The specified person contact was not moved

Specify a valid value Specify another value Quota exceeded, check the allowed quota

BEEU-03122

An error occurred during person contact copy

WARNING

No such entity The user does not have the required access rights The specified person contact is invalid The specified parent does not exist or cannot be used The destination address book does not exist The quota for the contacts has exceeded Failed to raise event for the operation Failed to apply labels to the specified entity Failed to copy attachments to the specified contact Failed to perform a workspace operation Failed to set access on the entity Failed to find the parent workspace

The specified person contact was not copied

Specify a valid value Specify another value Quota exceeded, check the allowed quota

BEEU-03123

An error occurred during person contact purge

WARNING

Failed to unregister the entity with access control service This operation is not allowed on automatically created contacts Failed to perform a workspace operation

The specified person contact was not purged

See the log file for more details

BEEU-03124

An error occurred during person contact archiving

WARNING

Failed to unregister the entity with access control service

The specified person contact was not archived

See the log file for more details

BEEU-03125

An error occurred while listing person contacts

WARNING

The specified address book is invalid The specified list filter is invalid A projection was not specified or cannot be used

The person contacts could not be listed

Specify a valid value

BEEU-03126

An error occurred while listing duplicate person contacts

WARNING

The specified address book is invalid No attributes specified for duplicate check

The person contacts could not be listed

Specify a valid value

BEEU-03131

An error occurred during group contact creation

WARNING

The specified address is invalid An entity with the specified address already exists No such address The type of address has a suffix beyond the configured range of the system The type of the address is invalid The scheme of the address is invalid The user does not have the required access rights Failed to register the entity with access control service Failed to set access on the entity Quota/lock check failed The specified property is invalid; Name = {0}, Value = {1} The specified value for the parameter {0} is too large (Limit is {1}) The specified value for one or more parameters is too large The specified parent does not exist or cannot be used The specified bookmark value is invalid The speeddial specified is not correct or unique The quota for the contacts has exceeded Adding or removing members to bookmarked group contacts is not allowed Failed to perform the required attachment operation. Check the logs for more details. The specified roster entry exists A bookmarked group contact cannot be a buddy list entry A buddy list group contact must have a group name Failed to raise event for the operation The specified given name is used by auto created Manager and Peers/Direct Reports group contact The entity is locked The quota limit for this scope has exceeded Failed to get the default sensitivity for the parent container The default sensitivity cannot be nullified The specified sensitivity is invalid Failed to create the guard for the container Failed to find the parent workspace

The specified group contact was not created

Specify a valid value Specify another value Maximum count for the addresses exceeded, check the maximum addresses allowed See the log file for more details Quota exceeded, check the allowed quota

BEEU-03132

An error occurred during group contact load

WARNING

No such entity The user does not have the required access rights The specified group contact is invalid

The specified group contact was not loaded

Specify a valid value

BEEU-03133

An error occurred during group contact update

WARNING

No such entity The specified group contact is invalid A newer version of the specified entity exists in the system Failed to perform a workspace operation The specified parent does not exist or cannot be used The user does not have the required access rights Quota/lock check failed The specified address is invalid An entity with the specified address already exists No such address The type of address has a suffix beyond the configured range of the system The type of the address is invalid The scheme of the address is invalid The specified property is invalid; Name = {0}, Value = {1} The specified value for the parameter {0} is too large (Limit is {1}) The specified value for one or more parameters is too large The speeddial specified is not correct or unique The quota for the contacts has exceeded Adding or removing members to bookmarked group contacts is not allowed Failed to perform the required attachment operation. Check the logs for more details. Failed to raise event for the operation The specified roster entry exists A bookmarked group contact cannot be a buddy list entry A buddy list group contact must have a group name This operation is not allowed on automatically created contacts The entity is locked The quota limit for this scope has exceeded Failed to find the parent workspace The default sensitivity cannot be nullified Failed to create the guard for the container The specified sensitivity is invalid

The specified group contact was not updated

Specify a valid value Refresh the entity and retry the operation Specify another value Maximum count for the addresses exceeded, check the maximum addresses allowed See the log file for more details Quota exceeded, check the allowed quota

BEEU-03134

An error occurred during group contact delete

WARNING

No such entity The specified group contact is invalid A newer version of the specified entity exists in the system The user does not have the required access rights Quota/lock check failed Failed to delete reminders of a contact Failed to raise event for the operation This operation is not allowed on automatically created contacts The entity is locked The quota limit for this scope has exceeded Failed to get the trash item Failed to find the parent workspace

The specified group contact was not deleted

Specify a valid value Refresh the entity and retry the operation Specify another value

BEEU-03135

An error occurred during group contact undelete

WARNING

No such entity The specified group contact is invalid The specified parent does not exist or cannot be used The user does not have the required access rights Quota/lock check failed Failed to perform a workspace operation Failed to set access on the entity The destination address book does not exist The speeddial specified is not correct or unique The quota for the contacts has exceeded The specified roster entry exists Failed to raise event for the operation The entity is locked The quota limit for this scope has exceeded Failed to find the parent workspace

The specified group contact was not undeleted

Specify a valid value See the log file for more details Specify another value Quota exceeded, check the allowed quota

BEEU-03136

An error occurred during group contact move

WARNING

No such entity The user does not have the required access rights Quota/lock check failed Failed to set access on the entity The specified group contact is invalid The specified parent does not exist or cannot be used The destination address book does not exist The quota for the contacts has exceeded Failed to raise event for the operation This operation is not allowed on automatically created contacts The entity is locked The quota limit for this scope has exceeded Failed to create the guard for the container Failed to find the parent workspace

The specified group contact was not moved

Specify a valid value Specify another value Quota exceeded, check the allowed quota

BEEU-03137

An error occurred during group contact copy

WARNING

No such entity The user does not have the required access rights The specified group contact is invalid The specified parent does not exist or cannot be used The destination address book does not exist The quota for the contacts has exceeded Failed to raise event for the operation Failed to apply labels to the specified entity Failed to copy attachments to the specified contact Failed to perform a workspace operation Failed to set access on the entity Failed to find the parent workspace

The specified group contact was not copied

Specify a valid value Specify another value Quota exceeded, check the allowed quota

BEEU-03138

An error occurred during group contact purge

WARNING

Failed to unregister the entity with access control service This operation is not allowed on automatically created contacts Failed to perform a workspace operation

The specified group contact was not purged

See the log file for more details

BEEU-03139

An error occurred during group contact archiving

WARNING

Failed to unregister the entity with access control service

The specified group contact was not archived

See the log file for more details

BEEU-03140

An error occurred while listing group contacts

WARNING

The specified address book is invalid The specified list filter is invalid A projection was not specified or cannot be used

The group contacts could not be listed

Specify a valid value

BEEU-03141

An error occurred while listing duplicate group contacts

WARNING

The specified address book is invalid No attributes specified for duplicate check

The group contacts could not be listed

Specify a valid value

BEEU-03146

An error occurred during resource contact creation

WARNING

The specified address is invalid An entity with the specified address already exists No such address The type of address has a suffix beyond the configured range of the system The type of the address is invalid The scheme of the address is invalid The specified property is invalid; Name = {0}, Value = {1} The specified value for the parameter {0} is too large (Limit is {1}) The specified value for one or more parameters is too large The user does not have the required access rights Failed to register the entity with access control service Failed to set access on the entity Quota/lock check failed The specified parent does not exist or cannot be used The specified bookmark value is invalid The speeddial specified is not correct or unique The quota for the contacts has exceeded Failed to perform the required attachment operation. Check the logs for more details. Failed to raise event for the operation The entity is locked The quota limit for this scope has exceeded Failed to get the default sensitivity for the parent container The default sensitivity cannot be nullified The specified sensitivity is invalid Failed to create the guard for the container Failed to find the parent workspace

The specified resource contact was not created

Specify a valid value Specify another value Maximum count for the addresses exceeded, check the maximum addresses allowed See the log file for more details Quota exceeded, check the allowed quota

BEEU-03147

An error occurred during resource contact load

WARNING

No such entity The user does not have the required access rights The specified resource contact is invalid

The specified resource contact was not loaded

Specify a valid value

BEEU-03148

An error occurred during resource contact update

WARNING

No such entity The specified resource contact is invalid A newer version of the specified entity exists in the system Failed to perform a workspace operation The specified parent does not exist or cannot be used The user does not have the required access rights Quota/lock check failed The specified address is invalid An entity with the specified address already exists No such address The type of address has a suffix beyond the configured range of the system The type of the address is invalid The scheme of the address is invalid The specified property is invalid; Name = {0}, Value = {1} The specified value for the parameter {0} is too large (Limit is {1}) The specified value for one or more parameters is too large The speeddial specified is not correct or unique The quota for the contacts has exceeded Failed to perform the required attachment operation. Check the logs for more details. Failed to raise event for the operation This operation is not allowed on automatically created contacts The entity is locked The quota limit for this scope has exceeded Failed to find the parent workspace The default sensitivity cannot be nullified Failed to create the guard for the container The specified sensitivity is invalid

The specified resource contact was not updated

Specify a valid value Refresh the entity and retry the operation Specify another value Maximum count for the addresses exceeded, check the maximum addresses allowed See the log file for more details Quota exceeded, check the allowed quota

BEEU-03149

An error occurred during resource contact delete

WARNING

No such entity The specified resource contact is invalid A newer version of the specified entity exists in the system The user does not have the required access rights Quota/lock check failed Failed to perform a workspace operation Failed to delete reminders of a contact Failed to raise event for the operation This operation is not allowed on automatically created contacts The entity is locked The quota limit for this scope has exceeded Failed to get the trash item Failed to find the parent workspace

The specified resource contact was not deleted

Specify a valid value Refresh the entity and retry the operation Specify another value

BEEU-03150

An error occurred during resource contact undelete

WARNING

No such entity The specified resource contact is invalid The specified parent does not exist or cannot be used The user does not have the required access rights Quota/lock check failed Failed to perform a workspace operation Failed to set access on the entity The destination address book does not exist The speeddial specified is not correct or unique The quota for the contacts has exceeded Failed to raise event for the operation The entity is locked The quota limit for this scope has exceeded Failed to find the parent workspace

The specified resource contact was not undeleted

Specify a valid value See the log file for more details Specify another value Quota exceeded, check the allowed quota

BEEU-03151

An error occurred during resource contact move

WARNING

No such entity Quota/lock check failed The user does not have the required access rights Failed to set access on the entity The specified resource contact is invalid The specified parent does not exist or cannot be used The destination address book does not exist The quota for the contacts has exceeded Failed to raise event for the operation This operation is not allowed on automatically created contacts The entity is locked The quota limit for this scope has exceeded Failed to create the guard for the container Failed to find the parent workspace

The specified resource contact was not moved

Specify a valid value Specify another value Quota exceeded, check the allowed quota

BEEU-03152

An error occurred during resource contact copy

WARNING

No such entity The user does not have the required access rights The specified resource contact is invalid The specified parent does not exist or cannot be used The destination address book does not exist The quota for the contacts has exceeded Failed to raise event for the operation Failed to apply labels to the specified entity Failed to copy attachments to the specified contact Failed to perform a workspace operation Failed to set access on the entity Failed to find the parent workspace

The specified resource contact was not copied

Specify a valid value Specify another value Quota exceeded, check the allowed quota

BEEU-03153

An error occurred during resource contact purge

WARNING

Failed to unregister the entity with access control service This operation is not allowed on automatically created contacts Failed to perform a workspace operation

The specified resource contact was not purged

See the log file for more details

BEEU-03154

An error occurred during resource contact archiving

WARNING

Failed to unregister the entity with access control service

The specified resource contact was not archived

See the log file for more details

BEEU-03155

An error occurred while listing resource contacts

WARNING

The specified address book is invalid The specified list filter is invalid A projection was not specified or cannot be used

The resource contacts could not be listed

Specify a valid value

BEEU-03156

An error occurred while listing duplicate resource contacts

WARNING

The specified address book is invalid No attributes specified for duplicate check

The resource contacts could not be listed

Specify a valid value

BEEU-03161

An error occurred during cancel operation

WARNING

Failed to perform the required attachment operation. Check the logs for more details.

The operation was not canceled

Try again later. If the problem persists, contact your system administrator

Audit Error Codes

The following table lists error codes for Audit.

Table 3-3 Audit

Message ID

Display Name

Severity

Cause

Effect

Action

BEEU-03201

NULL value passed in as method parameter

WARNING

One or more parameters are invalid or null

BEEU-03202

Audit artifact matching given name or container already exists

WARNING

Check the name, container's identifier etc before invoking the method

BEEU-03203

Audit artifact with the given identifier not found

WARNING

Invalid identifier specified or search criteria may not be valid

BEEU-03204

Invalid parameter value supplied to service method

WARNING

Supplied parameter value or length of the value is invalid

Provide correct value for the service method parameter

BEEU-03205

User's logon record or session identifier not found

WARNING

User session may have expired

BEEU-03207

Audit policy not found

INFO

Identifier is either invalid or an audit artifact for the given identifier does not exist

BEEU-03208

Audit trail not found

INFO

Identifier is either invalid or an audit artifact for the given identifier does not exist

BEEU-03209

Audit record not found

INFO

No audit records matching the search criteria

BEEU-03211

Audit artifact snapshot is not valid

WARNING

Audit artifact has been modified by another application

Retrive the modified audit artifact and retry the operation

BEEU-03212

Failed to create audit trail

WARNING

Duplicate identifier or trail name

BEEU-03213

Audit artifact constraint is violated

WARNING

A dependent audit artifact exists or this artifact can not be modified

The dependent audit artifact must be modified (e.g. enable) or removed (e.g. template), then retry the operation

Authentication Service Error Codes

The following table lists error codes for Authentication Service.

Table 3-4 Authentication Service

Message ID

Display Name

Severity

Cause

Effect

Action

BEEU-00800

AUTH: Method not supported.

WARNING

AUTH: Method not supported.

BEEU-00801

AUTH: User Already Exists.

WARNING

AUTH: User Already Exists.

BEEU-00802

AUTH: User does not exist.

WARNING

AUTH: User does not exist.

BEEU-00803

AUTH: Non-conformant username.

WARNING

AUTH: Non-conformant username.

BEEU-00804

AUTH: Non-conformant password.

WARNING

AUTH: Non-conformant password. {0}

BEEU-00805

AUTH: Non-conformant pin.

WARNING

AUTH: Non-conformant pin.

BEEU-00806

AUTH: Non-conformant device.

WARNING

AUTH: Non-conformant device.

BEEU-00807

AUTH: Invalid username/password.

WARNING

AUTH: Invalid username/password.

BEEU-00808

AUTH: Device already registered.

WARNING

AUTH: Device already registered.

BEEU-00809

AUTH: Device not registered.

WARNING

AUTH: Device not registered.

BEEU-00810

AUTH: Invalid username/pin.

WARNING

AUTH: Invalid username/pin.

BEEU-00811

AUTH: Password modification failiure.

WARNING

AUTH: Password modification failiure.

BEEU-00812

AUTH: Illegal argument.

WARNING

AUTH: Illegal argument.

BEEU-00820

AUTH: Invalid AuthenticationToken.

WARNING

AUTH: Invalid AuthenticationToken.

BEEU-00821

AUTH: UserContext Creation Failed.

WARNING

AUTH: UserContext Creation Failed.

BEEU-00822

AUTH: Invalid UserContext.

FINE

AUTH: Invalid UserContext.

BEEU-00823

AUTH: Invalid Credentials.

WARNING

AUTH: Invalid Credentials.

BEEU-00824

AUTH: Authentication Failed.

WARNING

AUTH: Authentication Failed.

BEEU-00825

AUTH: UDS Resolve Failed.

WARNING

AUTH: UDS Resolve Failed.

BEEU-00826

AUTH: Authorization Error.

WARNING

AUTH: Authorization Error.

BEEU-00850

AUTH: Authentication store exception.

WARNING

AUTH: Authentication store exception.

Beehive Development Kit Error Codes

The following table lists error codes for Beehive Development Kit.

Table 3-5 Beehive Development Kit

Message ID

Display Name

Severity

Cause

Effect

Action

BEEU-04500

Invalid URI in request

WARNING

The specified URI - {0} - does not exist.

Requested operation was not performed.

Retry with a valid URI.

BEEU-04501

Missing Query Parameter

WARNING

No value specified for query parameter - {0}.

Requested operation was not performed.

Retry the operation with a value for the missing query parameter.

BEEU-04502

Missing Header

WARNING

No value specified for header - {0}.

Requested operation was not performed.

Retry the operation with a value for the missing header.

BEEU-04503

Invalid Query Parameter Value

WARNING

Invalid value - {0} - specified for query parameter - {1}.

Requested operation was not performed.

Retry the operation with a valid value for the query parameter.

BEEU-04504

Missing Payload

WARNING

No payload specified where one was expected.

Requested operation was not performed.

Retry the operation with a payload.

BEEU-04505

Invalid Payload Type

WARNING

Type of payload specified is invalid.

Requested operation was not performed.

Retry the operation with a payload of type - {0}.

BEEU-04506

Invalid Payload

WARNING

The payload is invalid or has invalid content.

Requested operation was not performed.

Retry the operation with a valid payload.

BEEU-04507

Batch Size Exceeded

WARNING

The number of ids specified exceeds the maximum number of ids allowed per batch - {0}.

Requested operation was not performed.

Retry the operation with fewer ids.

BEEU-04508

Invalid Id Format

WARNING

Specified id - {0} - is not in the correct format.

Requested operation was not performed.

Retry the operation with a valid id.

BEEU-04509

Invalid Id Type

WARNING

The specified id - {0} - is invalid and does not match the resource.

Requested operation not performed.

Retry the operation with a valid id.

BEEU-04510

Upload Failure

WARNING

Upload failed - {0}

Requested operation was not performed.

Retry the operation.

BEER-04511

Presence Connection Limit Reached

WARNING

Maximum number of presence connections supported per session has been reached.

Requested operation was not performed.

Retry the operation after closing one or more existing presence connections.

BEEU-04512

Duplicate Presence Connection Id

WARNING

Specified connection id already exists.

Requested operation was not performed.

Retry the operation with a different id.

BEEU-04513

JSON Type-Value Mismatch

WARNING

For member {0}, expected type is {1}, but specified type is {2}

Requested operation was not performed.

Retry the operation with a value of the correct type.

BEEU-04514

Unsupported Accept Header

WARNING

Unsupported valued in Accept header.

Requested operation was not performed.

Retry the operation with a valid value for the Accept header.

BEEU-04515

Impersonation Failure

WARNING

Error occurred during impersonation.

Requested operation was not performed.

Check that impersonation has been setup correctly and retry the operation.

BEEU-04516

Unsupported HTTP Method

WARNING

HTTP method - {0} - not supported on resource at URI - {1}

Requested operation not performed.

Retry the operation with a valid HTTP method.

BEEU-04517

Invalid Header

WARNING

Invalid value - {0} - specified for header {1}

Requested operation was not performed.

Retry the operation with a valid value.

BEEU-04518

No File Uploaded

WARNING

No file was uploaded.

Requested operation was not performed.

Retry the operation with at least one file upload.

BEES-04519

Internal Error

SEVERE

An internal error occurred.

Required operation was not performed.

Please contact Oracle Support for more information.

BEEU-04520

Duplicate Name

WARNING

The specified name is already in use by another IM client in this session.

Requested operation was not performed.

Retry the operation with a different name.

Bom Object Distinguished Naming Error Codes

The following table lists error codes for Bom Object Distinguished Naming.

Table 3-6 Bom Object Distinguished Naming

Message ID

Display Name

Severity

Cause

Effect

Action

BEEU-03700

Bodn parsing failed.

SEVERE

Reason: {0}. Invalid bodn format provided. Invalid type "{0}" is provided. Invalid BOM type is used. Invalid BOM type is used. Reason: {0}.

Could not parse value "{0}".

Please use correct format of identifier. Please use correct bodn format (type=name). For example, orgn=yyy,enpr=xxx Please provide correct value. Please provide correct value using bom type as "{0}".

BEEU-03701

Could not find the given entity.

SEVERE

Could not resolve the given bodn into unique entity. No entity found for the given bodn. Given scope is not supported for "{0}" type. No identifiable name is found for given identifier "{0}".

Bodn parsing failed for value "{0}".

Please use collab id format for the value. Please use correct value. Please use correct scope or parent while specifying the bodn. Only collab id format can be used to refer this entity.

BEES-03702

Internal error occurred.

SEVERE

Given entity type "{0}" is not yet supported. Naming on given Id type "{0}" is not yet supported.

Entity could not be found for "{0}".

Please use system generated identifier as the value. Naming on given Id type "{0}" is not yet supported.

Client Management Service Error Codes

The following table lists error codes for Client Management Service.

Table 3-7 Client Management Service

Message ID

Display Name

Severity

Cause

Effect

Action

BEEZ-03901

Session identity mismatch.

SEVERE

New channel identity doesn't match session identity.

Session is terminated for security reasons.

Please contact your administrator.

BEEU-03902

Some of the data or parameter you supplied was invalid or out of range.

WARNING

One of the entity handles/CollabIds was of incorrect BOM type Number of specified EIDs doesn't match the number of entities Specified control class {0} was not found. No exact method match found. Projection {0} is undefined for snapshot {1}. Request was not recognized because it doesn't conform to specification. Request doesn't have a body. Request is empty. Request can't be parsed because it either malformed or refers to unregistered XBOM class. Specified delegate principal can't be activated.

Your request wasn't executed.

Correct and resubmit your request.

BEEU-03903

Batch request execution interrupted.

INFO

One of the services thrown an exception while processing one of the batch items.

Some of the items in the batch were not processed.

Correct the problem and resubmit your request.

Coexistence Service Error Codes

The following table lists error codes for Coexistence Service.

Table 3-8 Coexistence Service

Message ID

Display Name

Severity

Cause

Effect

Action

BEEU-04201

Coexisting remote system could not be found.

FINE

The coexisting remote system identifier does not exists.

The coexisting remote system cannot be accessed.

Specify a valid identifier.

BEEU-04202

Coexistence profile could not be found.

FINE

The coexistence profile identifier does not exists.

The coexistence profile cannot be accessed.

Specify a valid identifier.

BEEU-04203

Coexistence import request does not exists.

FINE

The coexistence import request identifier does not exists.

The coexistence import request cannot be accessed.

Specify a valid identifier.

BEEU-04204

Beehive user does not exists.

FINE

The Beehive user identifier does not exists.

This Beehive user can not be accessed.

Specify a valid identifier.

BEEU-04205

Beehive entity does not exists.

FINE

The Beehive entity identifier does not exists.

This Beehive entity can not be accessed.

Specify a valid identifier.

BEEU-04206

Duplicate Partnership Key.

FINE

The specified Partnership Key is already used.

The coexisting remote system could not be created or modified.

Specify a different Partnership Key.

BEEU-04207

Illegal null value

FINE

An illegal null value was specified.

The operation could not be completed.

Specify a valid value.

BEEU-04208

Illegal value

FINE

An illegal value was specified.

The operation could not be completed.

Specify a valid value.

BEEU-04209

Precondition failed.

FINE

A precondition failed.

The operation could not be completed.

Fulfil the precondition.

BEEU-04210

Stored data inconsistency.

FINE

The stored data is inconsistent.

The operation could not be completed.

Please notify your system administrator.

BEEU-04211

Internal illegal null value.

FINE

An illegal null value was specified for input parameter.

The operation could not be completed.

Please notify your system administrator.

BEEU-04212

Internal illegal value..

FINE

An illegal value was specified for input parameter.

The operation could not be completed.

Please notify your system administrator.

BEEU-04213

Operation skipped.

FINE

Another instance is doing the same operation.

The operation was skipped.

Nothing to do.

BEEU-04214

Team collaboration coexistence is not supported in this Oracle Beehive release.

FINE

Team collaboration coexistence is not supported in this Oracle Beehive release.

Coexistence profile was not modified.

Specify a maximum of one accessible system for a coexistence profile.

BEEU-04215

Coexistence profile is missing an accessible system.

FINE

No accessible system specified for the coexistence profile.

The operation was skipped.

Specify exactly one accessible system.

BEEU-04216

This error code is not assigned.

FINE

This error code is not assigned.

This error code is not assigned.

This error code is not assigned.

BEEU-04217

This error code is not assigned.

FINE

This error code is not assigned.

This error code is not assigned.

This error code is not assigned.

BEEU-04218

This error code is not assigned.

FINE

This error code is not assigned.

This error code is not assigned.

This error code is not assigned.

BEEU-04219

This error code is not assigned.

FINE

This error code is not assigned.

This error code is not assigned.

This error code is not assigned.

BEEU-04220

This error code is not assigned.

FINE

This error code is not assigned.

This error code is not assigned.

This error code is not assigned.

BEEU-04221

This error code is not assigned.

FINE

This error code is not assigned.

This error code is not assigned.

This error code is not assigned.

BEEU-04222

This error code is not assigned.

FINE

This error code is not assigned.

This error code is not assigned.

This error code is not assigned.

BEEU-04223

This error code is not assigned.

FINE

This error code is not assigned.

This error code is not assigned.

This error code is not assigned.

BEEU-04224

This error code is not assigned.

FINE

This error code is not assigned.

This error code is not assigned.

This error code is not assigned.

BEEU-04225

This error code is not assigned.

FINE

This error code is not assigned.

This error code is not assigned.

This error code is not assigned.

Device Management Error Codes

The following table lists error codes for Device Management.

Table 3-9 Device Management

Message ID

Display Name

Severity

Cause

Effect

Action

BEES-00600

Device Management Service Operation aborted

WARNING

Null data recieved when not null value is expected

Device Management Service Operation aborted

Make sure all the null value constraints are followed as mentioned in the documentation and try again

BEEU-00601

Create Client Application failed

INFO

Client Application cannot be created in the repository due to internal error Client Application with same details exists in the repository Client Application with same Eid already exists in the repository

Client Application will not be created

Please contact Oracle Support for more information Create Client Application with a different name or vendor or language or os or processor or language Create Client Application with a different name or vendor or language or os or processor or language

BEEU-00602

Update Client Application failed

INFO

ClientApplication cannot be updated due to internal error Client Application is not found in the repository

Client Application will not be updated

Please contact Oracle Support for more information Try the operation with a valid Eid

BEEU-00603

Delete Client Application failed

INFO

Delete Client Application failed due to internal error Client Application is not found in the repository Installable Client Application exists in this Application hierarchy

Client Application will not be deleted

Please contact Oracle Support for more information Try the operation with a valid Eid Please delete the Installable Client Application in this Application hierarchy

BEEU-00604

Load Client Application failed

INFO

Load Client Application failed due to internal error Client Application is not found in the repository

Client Application will not be loaded

Make sure that the application is uploaded. If it is uploaded contact the System Administrator to resolve the issue. Try the operation with a valid Eid

BEES-00605

Resolve Client Application Failed

INFO

Client Application is not found in the repository

Client Application will not be loaded

Please retry with different values

BEEU-00606

The upload of the client application failed.

WARNING

An error ocurred while uploading the client application. The metadata.xml included in the client application zip file does not conform to the XML Schema expected by the Device Management Service.

The client application could not be uploaded.

Please correct the error encountered during the upload of the client application. If the error cannot be corrected contact the System Administrator to resolve the issue. Please correct the metadata.xml to conform to the XML Schema and retry.

BEEU-00611

Client Application Version cannot be created

INFO

Client Application Version cannot be created in the repository due to internal error Client Application Version with same versionnumber for this Client Application exists in the repository Client Application Version with same Eid already exists in the repository Client Application with Eid passed is not found in the repository

Client Application Version will not be created

Please contact Oracle Support for more information Create Client Application Version with a different Eid Create Client Application Version with a different versionnumber Provide a valid Client Application reference Please delete the Installable Client Application in this Application hierarchy

BEEU-00612

Delete Client Application Version failed

INFO

Delete Client Application Version failed due to internal error Client Application Version is not found in the repository Installable Client Application exists in this Application hierarchy You cannot delete the only Client Application Version in the containing Client Application

Client Application Version will not be deleted

Please contact Oracle Support for more information Provide a valid Client Application Version Eid Please delete the Installable Client Application in this Application hierarchy Delete the containing Client Application to which this Client Application Version belongs

BEEU-00613

Load Client Application Version failed

INFO

Load Client Application Version failed due to internal error Client Application Version is not found in the repository

Client Application Patchset will not be loaded

Make sure that the Client Application Version is uploaded. If it is uploaded contact the System Administrator to resolve the issue. Provide a valid Client Application Version Eid

BEEU-00621

Client Application Patchset cannot be created

INFO

Client Application Patchset cannot be created in the repository due to internal error Client Application Patchset with same patchsetnumber for this Client Application Version exists in the repository Client Application Patchset with same Eid already exists in the repository Client Application Version with Eid passed is not found in the repository

Client Application Patchset will not be created

Please contact Oracle Support for more information Create Client Application Patchset with a different Eid Create Client Application Patchset with a different patchsetnumber Provide a valid Client Application Version reference

BEEU-00622

Delete Client Application Patchset failed

INFO

Delete Client Application Patchset failed due to internal error Client Application Patchset is not found in the repository Installable Client Application exists in this Application hierarchy You cannot delete the only Client Application Patchset in the containing Client Application Version

Client Application Patchset will not be deleted

Please contact Oracle Support for more information Provide a valid Client Application Patchset Eid Please delete the Installable Client Application in this Application hierarchy Delete the containing Client Application Version to which this Client Application Patchset belongs

BEEU-00623

Load Client Application Patchset failed

INFO

Load Client Application Patchset failed due to internal error Client Application Patchset is not found in the repository

Client Application Patchset will not be loaded

Make sure that the Client Application Patchset is uploaded. If it is uploaded contact the System Administrator to resolve the issue. Provide a valid Client Application Patchset Eid

BEEU-00631

Client Application Module cannot be created

INFO

Client Application Module cannot be created in the repository due to internal error Client Application Module with same name and destination folder for this Client Application Patchset exists in the repository Client Application Module with same Eid already exists in the repository Client Application Patchset with Eid passed is not found in the repository New ClientApplicationModules cannot be introduced between patchsets

Client Application Module will not be created

Please contact Oracle Support for more information Create Client Application Module with a different Eid Create Client Application Patchset with a different patchsetnumber Provide a valid Client Application Patchset reference Introduce a new Version or remove the new module

BEEU-00632

Delete Client Application Module failed

INFO

Delete Client Application Module failed due to internal error Client Application Module is not found in the repository

Client Application Module will not be deleted

Please contact Oracle Support for more information Provide a valid Client Application Module Eid

BEEU-00633

Load Client Application Module failed

INFO

Load Client Application Module failed due to internal error Client Application Module is not found in the repository

Client Application Module will not be loaded

Make sure that the Client Application Module is uploaded. If it is uploaded contact the System Administrator to resolve the issue. Provide a valid Client Application Module Eid

BEEU-00641

Create Device failed

INFO

Create Device failed due to internal error Device with same device id already exists in the repository Device with same device Eid already exists in the repository

Device will not be created in the repository

Please contact Oracle Support for more information Assign a different device id and try again Assign a different Eid and try again.

BEEU-00642

Update Device failed

INFO

Update device failed due to internal errors State of the device is outdated Device does not exist in the repository

Device will not be updated with the new values

Contact the system administrator Retry the operation with always update/delete option or reload the state of the device. Verify the Device identifier and try again

BEEU-00643

Delete device failed

INFO

Delete device failed due to internal errors State of the device is outdated Device does not exist in the repository Device Command exists for this device.

Device will not be deleted

Contact the system admin Retry the operation with always update/delete option or reload the state of the device. Verify the Device identifier and try again Delete all DeviceCommands for this device and try deleting this device.

BEEU-00644

Load device failed

INFO

Load device failed due to internal errors Device does not exist in the repository

Device will not be loaded

Check the device details and try again. If the problem still persist contact the system administrator Verify the Device identifier and try again

BEEU-00651

Create Device Type failed

INFO

Create Device Type failed due to internal error Device Type with same name already exists in the repository Device Type with same os, processor and device class already exists in the repository Device Type with same manufacturer, model, software version and devinfdtd version already exists in the repository Device Type with same Eid already exists in the repository Device Profile passed in with the Device Type is invalid

Device Type will not be created in the repository

Please contact Oracle Support for more information Assign a different name for the Device Type and try again Enter a different value for either or all of os, processor, device class and try again. Enter a different value for either or all of manufacturer, model, software version, devinfdtd version and try again. Assign a different Eid and try again. Try again with a valid Device Profile

BEEU-00652

Update Device Type failed

INFO

Update Device Type failed due to internal errors State of the Device Type is outdated Device Type Eid passed is not found in the repository Device Type with same os, processor and device class already exists in the repository Device Type with same manufacturer, model, software version and devinfdtd version already exists in the repository

Device Type will not be updated with the new values

Contact the system administrator Either try with always update/delete option or reload the state of the Device Type and try updating Check the Eid of the Device Type and try again Enter a different value for either or all of os, processor, device class and try again. Enter a different value for either or all of manufacturer, model, software version, devinfdtd version and try again.

BEEU-00653

Delete Device Type failed

INFO

Delete Device Type failed due to internal errors State of the Device Type is outdated Device Type Eid passed is not found in the repository

Device Type will not be deleted

Contact the system admin Either try with always update/delete option or reload the state of the Device Type and try updating Check the Eid of the Device Type and try again

BEEU-00654

Load Device Type failed

INFO

Load Device Type failed due to internal errors Device Type Eid passed is not found in the repository

Device Type will not be loaded

Check the Device Type details and try again. If the problem still persist contact the system administrator Check the Eid of the Device Type and try again

BEEU-00661

Create Device Profile failed

INFO

Create Device Profile failed due to internal error Device Profile with same name already exists in the repository Device Profile with same Eid already exists in the repository

Device Profile will not be created in the repository

Please contact Oracle Support for more information Assign a different name for the Device Profile and try again Assign a different Eid and try again.

BEEU-00662

Update Device Profile failed

INFO

Update Device Profile failed due to internal errors State of the Device Profile is outdated Device Profile Eid passed is not found in the repository Preference Profile passed in with the Device Profile is invalid

Device Profile will not be updated with the new values

Contact the system administrator Either try with always update/delete option or reload the state of the Device Profile and try updating Check the Eid of the Device Profile and try again Try again with a valid Preference Profile

BEEU-00663

Delete Device Profile failed

INFO

Delete Device Profile failed due to internal errors State of the Device Profile is outdated Device Profile Eid passed is not found in the repository Device Type refering to this device profile exists

Device Type will not be deleted

Contact the system admin Either try with always update/delete option or reload the state of the Device Profile and try updating Check the Eid of the Device Profile and try again Delete the Device Type refering to this Device Profile and try deleting this Device Profile

BEEU-00664

Load Device Profile failed

INFO

Load Device Profile failed due to internal errors Device Profile Eid passed is not found in the repository

Device Profile will not be loaded

Check the Device Profile details and try again. If the problem still persist contact the system administrator Check the Eid of the Device Profile and try again

BEEU-00665

The upload of the device profile failed.

WARNING

An error ocurred while uploading the device profile. The device profile xml file supplied does not conform to the XML Schema expected by the Device Management Service.

The device profile could not be uploaded.

Please correct the error encountered during the upload of the device profile. If the error cannot be corrected contact the System Administrator to resolve the issue. Please correct the device profile xml file to conform to the XML Schema and retry.

BEEU-00671

Create Installable Client Application failed

INFO

Installable Client Application cannot be created in the repository due to internal error Installable Client Application with same Eid already exists in the repository Client Application to which this Installable Client Application belongs to is invalid

Installable Client Application will not be created

Please contact Oracle Support for more information Create Installable Client Application with a different Eid Create Installable Client Application with a valid ClientApplication

BEEU-00672

Update Installable Client Application failed

INFO

Update Installable Client Application failed due to internal errors State of the Installable Client Application is outdated Installable Client Application Eid passed is not found in the repository

Installable Client Application will not be updated with the new values

Contact the system administrator Either try with always update/delete option or reload the state of the Installable Client Application and try updating Check the Eid of the Installable Client Application and try again

BEEU-00673

Delete Installable Client Application failed

INFO

Delete Installable Client Application failed due to internal errors State of the Installable Client Application is outdated Installable Client Application Eid passed is not found in the repository

Installable Client Application will not be loaded

Check the Installable Client Application details and try again. If the problem still persist contact the system administrator Either try with always update/delete option or reload the state of the Installable Client Application and try updating Check the Eid of the Installable Client Application and try again

BEEU-00674

Load Installable Client Application failed

INFO

Load Installable Client Application failed due to internal errors Installable Client Application Eid passed is not found in the repository

Installable Client Application will not be loaded

Check the Installable Client Application details and try again. If the problem still persist contact the system administrator Check the Eid of the Installable Client Application and try again

BEEU-00681

Create Device Command Failed

INFO

Create Device Command Failed due to internal errors Device does not exist in the repository Device Command with the same Eid already exists in the repository The action of the device command you are creating is the same as the most recent device command that is to be executed. Cannot create any device command if the most recent device command is a WIPEOUT command.

Device Command will not be created!

Please contact system administrator Verify the Device identifier and try again Create Device Command with different Eid Please retry the operation with a different device command action. Either the WIPEOUT command needs to be deleted or needs to be executed by the device.

BEEZ-00691

The user is not authorized to perform this operation.

SEVERE

The current user doesn't have enough privileges and/or access types.

This operation cannot be performed.

Please retry this operation with a user who has more privileges and/or access types.

BEES-00692

Internal service error.

SEVERE

Could not process action due to unexpected server error.

Operation cannot be completed.

Please contact Oracle support.

Diagnosability Error Codes

The following table lists error codes for Diagnosability.

Table 3-10 Diagnosability

Message ID

Display Name

Severity

Cause

Effect

Action

BEEU-03601

Get log record error.

WARNING

Log viewer client unable to connect to the server.

Unable to get the log record from the server.

Contact Oracle Support for more information.

BEEU-03602

Query log record error.

WARNING

LogQueryException caught. Exception message: {0}, host: {1}, oracle-home: {2}. IOException caught. Exception message: {0}. host: {1} oracle home: {2} request port: {3} MalformedURLException caught. Exception message: {0}. host: {1} oracle home: {2} request port: {3}

Unable to query the log record.

Contact Oracle Support for more information.

BEEZ-03610

DIAGNOSE privilege unavailable.

INFO

The current user does not have the DIAGNOSE privilege User not authenticated.

Unable to access resource requiring DIAGNOSE privilege

Logout and log back in as a user with DIAGNOSE privilege. Please retry later. If you still receive this same error, contact Oracle Support for more information.

BEES-03611

DIAGNOSE privilege unavailable.

WARNING

Exception while attempting to check DIAGNOSE privilege for user {1}: {0}.

Unable to access resource requiring DIAGNOSE privilege

Please retry later. If you still receive this same error, contact Oracle Support for more information.

BEES-03620

Diagnosable call failed with an invalid return value

SEVERE

Unexpected datatype returned from backend

The underlying business method being executed failed

Ensure that service is deployed correctly

BEES-03621

Diagnosable query failed

SEVERE

Null argument passed The stored probe is malformed

The diagnosable probe query failed

Ensure that no empty or null argument is passed in Contact Oracle Support for more information

Discussions Error Codes

The following table lists error codes for Discussions.

Table 3-11 Discussions

Message ID

Display Name

Severity

Cause

Effect

Action

BEEU-06500

Invalid parameter.

WARNING

Parent discussion form is invalid. Topic cannot be clipped at the discussions message specified. Topic cannot merge with itself. Specified updater is of the wrong type. Specified activation date is after the expiration date.

The operation will not be performed.

Choose a valid parent discussion forum. Specify a message to clip that is not the first message in the topic and re-try the operation. Choose a source that is different than the target for the merge and re-try the operation. Check the type of the draft and use the updater corresponding to that type. Specify an activation date that is before the expiration date.

BEEU-06501

Unsupported operation for DiscussThisForums.

WARNING

The specified operation is not supported by DiscussThisForums.

The operation cannot be performed.

The specified operation cannot be performed on a DiscussThisForum.

BEEU-06502

Invalid message body content type.

WARNING

The specified message body content type is not supported for a Discussions Message.

The operation cannot be performed.

Discussions Messages only support message bodies of type simple or multipart-related.

Email Service Error Codes

The following table lists error codes for Email Service.

Table 3-12 Email Service

Message ID

Display Name

Severity

Cause

Effect

Action

BEEU-01201

Virtual Mail Server not present

INFO

No valid Virtual Mail Servers matched for the current client address.

Client connection will be rejected.

Server has incorrect Virtual Mail Server Evaluator configuration. Contact a system administrator to report this problem.

BEEU-01202

Invalid SMTP transaction state

WARNING

Transaction not closed while attempt is made to open a new transaction Transaction not open while attempt is made to close a transaction

Mail reception will fail

This is an unlikely error that may attribute to an SMTP client defect. Contact a system administrator to report this problem.

BEEU-01203

Mail address parsing error

INFO

In SMTP session (ID={0}), Error happened when parsing {1} command "{2}"

SMTP Mail command will be rejected

This is an unlikely error that may attribute to an SMTP client defect. Check syntax of sender's email address. If this error cannot be corrected with user action, contact a system administrator to report this problem.

BEEU-01204

Unable to submit mail

INFO

Failed to commit mail to the database or file system due to possible I/O, network or parsing problems

Mail will not be accepted

Contact a system administrator to report this problem.

BEEU-01205

Failed to commit SMTP transaction

INFO

Failed to commit SMTP transaction due to denied access

Mail will not be accepted

Contact a system administrator to report this problem.

BEEU-01206

SMTP Authentication error

WARNING

Processing error during SMTP authentication

SMTP command will fail

Contact a system administrator to report this problem.

BEEU-01207

Failure to write email body to remote SMTP server

WARNING

Remote SMTP server unexpectedly closed the connection during outbound email transfer (session id: {0})

Mail could not be relayed to the remote SMTP server

If the remote server is an internal server, check the configuration and health of the remote server. Otherwise contact the vendor of the remote relay server if the problem persists.

BEEU-01208

Connection to remote SMTP server refused

WARNING

Connection to SMTP server {1} refused, session id: {0}

The list of outbound relay servers {0} is exhausted, the message cannot be relayed at this time

If the remote server is an internal server, check the configuration and health of the remote server. Otherwise contact the vendor of the remote relay server if the problem persists

BEEU-01209

Failed to resolve MX address

SEVERE

Unable to resolve MX Address {1} into relay address (session id: {0}).

The list of outbound relay servers {0} is exhausted, the message cannot be relayed at this time

Check the health of the local DNS server and fix possible problems

BEEU-01210

End-of-file from remote SMTP server

WARNING

Unexpected end-of-file from remote SMTP server

Mail could not be relayed

If the remote server is an internal server, check the configuration and health of the remote server. Otherwise contact the vendor of the remote relay server if the problem persists

BEEU-01211

Connection to remote SMTP server refused

WARNING

Unable to connect to remote SMTP server {0}

The list of outbound relay servers is exhausted, the message cannot be relayed at this time

If the remote server is an internal server, check the configuration and health of the remote server. Otherwise contact the vendor of the remote relay server if the problem persists

BEEU-01212

Failed to resolve remote SMTP server

WARNING

Unable to resolve remote SMTP server {0}

May fail to relay mail

Check server configuration to correct problems in delivery routing rules

BEEU-01213

Remote SMTP server timed out

WARNING

Rmote SMTP server timed out, session id: {0}

Could not open connection. Could not send mail

If the remote server is an internal server, check the configuration and health of the remote server. Otherwise contact the vendor of the remote relay server if the problem persists

BEEU-01214

Failed to initialize Virtual Mail Server evaluation rules

WARNING

Exception occurred during initialization of Virtual Mail Server evaluation rules

This will cause the server to reject all the incoming connections

Check SMTP server configuration and correct possible issues with virtual mail server evaluation rules

BEEU-01215

Failed to evaluate recipient against recipient matching rule

SEVERE

Exception encountered when evaluating recipient address {0} for Virtual Mail Server {1}

Mail command will be rejected

Check SMTP server configuration and correct possible issues with recipient matcher rule

BEEU-01216

Failed to evaluate sender against sender matching rule

SEVERE

Exception encountered when evaluating sender address {0} for Virtual Mail Server {1}

Mail command will be rejected

Check SMTP server configuration and correct possible issues with sender matching rule

BEEU-01217

Failed to initialize rule for recipient matching

INFO

Exception Caught during initialization of recipient matching rule

All recipients will be rejected

Check SMTP server configuration and correct possible issues with recipient matching rule

BEEU-01218

Failed to initialize rule for sender matching

INFO

Exception Caught during initialization of sender matching rule

All senders will be rejected

Check SMTP server configuration and correct possible issues with sender matching rule

BEEU-01219

STARTTLS not supported on the remote mail server

WARNING

STARTTLS not supported on the remote mail server {0}

Could not send mail using TLS

If the remote SMTP server is an internal server, check to make sure the server supports STARTTLS, otherwise contact the vendor of the remote SMTP server to resolve the issue. Alternatively, enable the SMTP property to force relay even when remote server does not support STARTTLS

BEEU-01220

STARTTLS command to the remote mail server fails

WARNING

STARTTLS command fails with error {0}

Could not send mail using TLS

If the remote SMTP server is an internal server, check and fix possible issues with STARTTLS, otherwise contact the vendor of the remote SMTP server to resolve the issue.

BEEU-01231

Email service background task failed

SEVERE

Email service background tasks including heartbeat, retry or recovery failed due to a database error

Retry or Recovery of messages will be delayed

Investigate the database error from the logs and fix the database issue. Contact Oracle support if the issue cannot be easily determined

BEEU-01232

Unable to initialize rule engine

SEVERE

This happens due to error in loading rule engine stored in server parameters

Blank rule engine will cause all mail to be parked until the rules are fixed

Check all server parameters containing rules to make sure they are well formed and semantically correct

BEEU-01233

Unable to process retry or recovered message

INFO

Failed to process retry or recovered message {0}. This happens due to a database error

Retry or recovered message will not be delivered

Investigate and fix the database error from the logs. Contact Oracle Support if the database error cannot be easily determined

BEEU-01234

Unable to send draft message

WARNING

Unable to send draft message {0}. This happens due to a database error

The draft message could not be sent

Investigate and fix the database error from the logs. Contact Oracle Support if the database error cannot be easily determined

BEEU-01235

Failed to update message state in the database

INFO

This happens due to a database error

Message state and recipient delivery status will not be updated and will appear incorrect

Investigate and fix the database error from the logs. Contact Oracle Support if the database error cannot be easily determined

BEEU-01236

Failed to resolve recipients of a message

SEVERE

This happens due to database error

Message delivery will be delayed and retried

Investigate and fix the database error from the logs. Contact Oracle Support if the database error cannot be easily determined

BEEU-01237

Local delivery of a message failed

WARNING

This happens due to a database error

Message local delivery will be delayed and retried

Investigate and fix the database error from the logs. Contact Oracle Support if the database error cannot be easily determined

BEEU-01238

Checkpointing remote recipients failed

WARNING

This happens due to failure to update information about recipients in the database

Status of recipients in the database will be incorrect

Investigate and fix the database error from the logs. Contact Oracle Support if the database error cannot be easily determined

BEEU-01239

Submission processing of message fails

WARNING

Submission processing of message {0} rasied throwable

Message processing fails

Investigate and fix the database error from the logs. Contact Oracle Support if the database error cannot be easily determined

BEEU-01240

Connecting to DNS server fails

WARNING

Connecting to DNS server fails due to unknown host

Remote mail delivery of a message will be impacted. If none of the DNS servers are correct, and if some relay messages depend on DNS complete remote delivery, these messages will fail to get delivered.

Check the delivery rule server parameter and make sure the DNS servers are correctly specified

BEEU-01241

Resolving domain fails

WARNING

Resolving domain fails due to invalid host name

Remote mail delivery that triggered this failure will fail

Some emails will not get relayed because of invalid relay domain specified. If the sender of this message is an internal user, check with the user for more information and make sure the user is able to use valid domain name. If the sender is from an outside domain, do nothing as the failure will propagate back to the sender automatically via notifications.

BEEU-01242

Error during resolution

WARNING

Error during domain resolution due to an illegal argument exception

Remote mail delivery may be impacted

Check the exception for more information. Contact Oracle Support if the the cause cannot be easily determined

BEEU-01289

Submitted message is too big.

WARNING

The submitted message has exceeded the allowed limit on content size.

The request is rejected.

Re-submit the message with smaller message content

BEEU-01290

Submitted message has too many recipients.

WARNING

The submitted message has exceeded the allowed limit on number of recipients.

The request is rejected.

Re-submit the message with fewer recipients

BEEU-01291

You do not have the required access.

INFO

You do not have the required access to the folder that contains the email in question.

You will not be able to access the email in question.

Contact a system administrator to resolve the access retriction.

BEEU-01292

The specified email does not exist.

INFO

The specified email does not exist.

You will not be able to access the email in question.

You are using a client that contains stale data. Refresh the client to correct the situation.

BEEU-01293

Quota overflow error occurred.

INFO

Quota overflow error occurred.

The current operation cannot be carried out because you are over quota.

Remove and purge some data from your account to free up quota space, then retry the operation. Contact a system administrator if you need to have higher quota allocated

BEEU-01294

Database error occurred.

SEVERE

Database error occurred.

The current operation cannot be performed.

Contact a system administrator to report this problem.

BEEU-01295

Operation timeout error occurred.

WARNING

An operation is taking excessive amount of time to complete.

The operation is not successfully performed.

Try the operation at a later time. If the problem persists, contact administrator to report the problem.

BEEU-01296

An anchor passed to the request to poll changes is too old.

INFO

A request to poll changes has supplied an anchor that has expired.

The changed are not returned.

The client caller needs to re-synchronize the folder in full instead of polling changes.

BEEU-01297

An EID supplied by caller already exists.

INFO

An EID supplied by caller already exists, the ID is rejected

The ID is rejected because the ID is supposed to be unique.

The client caller needs to gracefully handle this by either using a new ID or abandon the request if the error means a previous attempt was successful.

BEEU-01298

The request is rejected because the system is busy.

WARNING

The request is rejected because it cannot acquire required access to the system resources.

The request is rejected.

The client caller needs to retry the operation at a later time. If this problem persists, contact system administrator to identify the issue.

BEEU-01299

Load operation is rejected because the number of items to load has exceeded the systme limit.

SEVERE

The load request exceeded the limit on how many items can be loaded in the same request.

The request is rejected.

The client caller needs to lower the number of items to load in the same request.

Expertise Service Error Codes

The following table lists error codes for Expertise Service.

Table 3-13 Expertise Service

Message ID

Display Name

Severity

Cause

Effect

Action

BEES-04400

Unexpected error

SEVERE

An unexpected internal error occurred

The requested operation cannot be performed

Contact system administrator

BEES-04401

Pre-seeded system workspace for Expertise requests not found

SEVERE

Pre-seeded system workspace for Expertise requests not found

The requested operation cannot be performed

Contact system administrator

BEEU-04401

Cannot change existing response state to provided value

WARNING

An invalid response state value was provided

Response state will not updated

Provide appropriate value for the response state

BEEU-04402

Cannot change request state to provided value

WARNING

An invalid request state value was provided

Request state will not updated

Provide appropriate value for the request state

BEEU-04403

Duplicate user scope name.

WARNING

Duplicate user scope name.

The requested operation cannot be performed.

Specify a different user scope name and re-try the operation.

BEEU-04404

User scope not found.

WARNING

User scope not found.

The requested operation cannot be performed.

Specify a different user scope name and re-try the operation.

BEEU-04405

Expertise request not found.

WARNING

Expertise request not found.

The requested operation cannot be performed.

Specify a different request value and re-try the operation.

BEEU-04406

Insufficient privileges to perform operation.

WARNING

Access denied. Insufficient privileges.

The requested operation cannot be performed.

User does not have privileges to perform the operation.

BEEU-04407

An invalid null value was specified for parameter.

WARNING

An invalid null value was specified for parameter: {0}.

The requested operation will not be performed.

Specify a valid value for the offending parameter and re-try the operation.

BEEU-04408

An invalid empty value was specified for parameter.

WARNING

An invalid empty value was specified for parameter: {0}.

The requested operation will not be performed.

Specify a valid value for the offending parameter and re-try the operation.

BEEU-04409

Invalid parameter.

WARNING

An invalid value was specified for parameter: {0}. The specified start date is later than the end date. Max percent for {0} is invalid (must be greater than 0.001 and less than 100.0) Clause enforcement for {0} invalid. Must be one of: ENFORCE_ACROSS_TERMS, ENFORCE_EXACT_WITHIN_TERMS, ENFORCE_EXPR_WITHIN_TERMS. Match type for {0} is invalid. Must be one of: MATCH_TYPE_NEGATED, MATCH_TYPE_OPTIONAL, MATCH_TYPE_REQUIRED. Expression {0} is too long. The only supported values for TermVisibility are {ExpertiseTerm.Visibility.PUBLIC} when searching for topics or {ExpertiseTerm.Visibility.PUBLIC, ExpertiseTerm.Visibility.PROTECTED} when creating an ExpertiseSearchRequest One of SearchClauseList, TextClauseGenParam, or SearchExpression must be set to a non-null value in the supplied ExpertiseTopicSearchParameters object. When creating an ExpertiseSearchRequest only a SearchExpression based ExpertiseSearchParameters is supported. Invalid response value, valid values are ACCEPT, DECLINE, IGNORE Maximum requests exceed the maximum system allowed value. ExpertiseSearchParameters not supported for this call. ExpertiseTopics not supported for this call. Specify either ExpertiseTopics or ExpertiseSearchParameters but not both. There are too many results for the wildcard search

The requested operation will not be performed.

Specify a valid value for the offending parameter and re-try the operation. Specify a valid value for the offending parameter and re-try the operation. Specify a valid value for the offending parameter and re-try the operation. Specify a valid value for the offending parameter and re-try the operation. Specify a valid value for the offending parameter and re-try the operation. Specify a valid value for the offending parameter and re-try the operation. Specify a valid value for the offending parameter and re-try the operation. Specify a valid value for the offending parameter and re-try the operation. Specify a valid value for the offending parameter and re-try the operation. Specify a valid value for the offending parameter and re-try the operation. Specify a valid value for the offending parameter and re-try the operation. Specify a valid value for the offending parameter and re-try the operation. Specify a valid value for the offending parameter and re-try the operation. Refine search terms.

BEEU-04410

Invalid Collection.

WARNING

The collection {0} is null or empty. Or one of the values in collection is null

The requested operation cannot be performed.

Specify a non-null, non-empty collection.

BEEU-04411

Updation of profiling configuration failed.

WARNING

Updation of profiling configuration partially succeeded. e.g. Failure could be during updation of Bootstrap status

The requested operation cannot be performed.

Retry the operation

BEEU-04412

Bootstrap Init failed.

WARNING

Either some profiles have already been initialized for bootstrap or some profiles are not being bootstapped.

The requested operation cannot be performed.

Check bootstrap status for profile.

BEEU-04413

Cannot finalize bootstrap process without first initializing.

WARNING

Cannot finalize bootstrap process without first initializing.

The requested operation cannot be performed

Initialize the bootstrap process before finalizing

BEEU-04414

No terms are extracted.

WARNING

No terms are extracted from the search expression.

The requested operation cannot be performed.

Please refine the search expression and try again.

Foundation Services Error Codes

The following table lists error codes for Foundation Services.

Table 3-14 Foundation Services

Message ID

Display Name

Severity

Cause

Effect

Action

BEES-00300

An error has occurred retrieving the error code from the database.

SEVERE

The error code repository refers to an invalid or non-existent error code.

This error code cannot be properly displayed.

Please contact your administrator.

BEES-00302

Service is not available.

SEVERE

See the associated exception for details.

Cannot access the service.

Please contact Oracle Support for more information.

BEES-00304

Service instance failed to init.

SEVERE

See the associated exception for details.

Cannot access the service instance.

Please contact Oracle Support for more information.

BEES-00306

Batch delete partially succeeded.

WARNING

Service side failed to delete some entities.

Some entities in the batch is not deleted.

Retry for those failed entities.

BEES-00308

Batch purge partially succeeded.

WARNING

Service side failed to purge some entities.

Some entities in the batch is not purged.

Retry for those failed entities.

BEES-00309

Cannot process TrashItemHandle(s).

WARNING

TrashItemHandle(s) is passed in.

Operation failed.

Please contact Oracle Support for more information.

BEES-00310

JTA(XA) transaction are not supported.

SEVERE

Service try to fetch a connection in JTA tx context.

Unable to provide a XA connection.

Disable JTA transaction.

BEES-00312

Exception from the RMI call.

SEVERE

See the associated exception for details.

The RMI call is probably failed.

Retry.

BEES-00314

Unable to get a DB Connection.

SEVERE

SQLException from JDBC.

Unable to provide a DB connection.

Retry after some time.

BEES-00316

Connection Closed.

SEVERE

Connection closed due to Abandoned Connection timeout.

This Connection is not usable any more.

Avoid retry the operation with new db connection.

BEES-00318

Physical Connection is closed with fatal exception.

SEVERE

Physical connection closed due to connection timeout.

This Connection is not usable any more.

Avoid repeting the same DB operation with new DB Connection.

BEES-00320

Connection closed.

INFO

JDBC connection is closed.

This Connection is not usable any more.

Retry the operation with new DB Connection.

BEES-00322

Unknown SQLException.

INFO

Unknown cause.

Unknown effect.

Unknown action.

BEES-00324

Connection leak.

SEVERE

Service didn't close the DB Connection

Reduce the capacity of the system.

File a bug.

BEEU-00325

Connection to database failed with current settings for user, password, and connect string.

SEVERE

Attempt to connect to the database failed with the current settings. The settings may be wrong, or the database may be down.

If the database settings are not correct, Beehive cannot connect to the database.

Review the settings to make sure they are correct.

Instant Messaging Service Error Codes

The following table lists error codes for Instant Messaging Service.

Table 3-15 Instant Messaging Service

Message ID

Display Name

Severity

Cause

Effect

Action

BEES-01301

IM service encountered an internal error.

WARNING

See stack trace for details.

Instant Messaging could fail.

Contact system administrator or see stack trace for further action.

BEEZ-01302

Login failure

SEVERE

User doesn't have sufficient privileges to login to Instant Messaging.

Login failed.

Contact your system administrator.

BEEZ-01303

Access is denied.

SEVERE

The client does not have appropriate privileges.

Listing of conversation transcript failed.

Please contact an administrator if you still have this problem.

BEEZ-01304

Access is denied.

SEVERE

The client does not have appropriate privileges.

Failed to delete conversation transcript.

Please contact an administrator if you still have this problem.

BEEZ-01305

Access is denied.

SEVERE

The client does not have appropriate privileges.

Listing of offline messages failed.

Please contact an administrator if you still have this problem.

BEEZ-01306

Access is denied.

SEVERE

The client does not have appropriate privileges.

Failed to delete offline message.

Please contact an administrator if you still have this problem.

BEEZ-01307

User is not provisioned to use Instant Messaging.

SEVERE

User is not provisioned to use Instant Messaging.

BEES-01311

Cannot store offline message.

SEVERE

See stack trace for details.

Unable to handle this offline message, it will be lost.

Contact system administrator or see stack trace for further action.

BEES-01312

Fetching offline messages for the user failed.

SEVERE

See stack trace for details.

You will not be able to see offline messages.

Contact system administrator or see stack trace for further action.

BEES-01313

Fetching conversation transcripts for the user failed.

SEVERE

See stack trace for details.

You will not be able to see conversation transcripts.

Contact system administrator or see stack trace for further action.

BEES-01314

Error loading OnlineInstantMessageSet.

SEVERE

Requested entity does not exist.

User will not be able to see instant messages.

Contact Oracle Support.

BEES-01315

Could not send message to the destination.

SEVERE

Bus connection might be down.

InstantMessaging will not work.

Restart Beehive/Omb.

BEES-01316

Error updating the InstantMessageReceptacle.

SEVERE

Some problem accessing the DB.

User may not be able to login and use instant messaging.

Retry. Contact Oracle Support if the problem persists.

BEES-01317

Error updating the InstantMessageReceptacle.

WARNING

Bus connection might be down.

Other service instances may not come to know of this logout or if the user was coming online with same resource again, the earlier instance may not get logged out.

Restart Beehive/Omb.

BEES-01318

Error updating the InstantMessageReceptacle.

SEVERE

Some problem accessing the DB.

User may not be able to login and use instant messaging.

Retry. Contact Oracle Support if the problem persists.

BEES-01319

Error updating the InstantMessageReceptacle.

SEVERE

Some problem accessing the DB.

User may not be able to login and use instant messaging.

Retry. Contact Oracle Support if the problem persists.

BEES-01320

Error loading InstantMessageReceptacle.

SEVERE

Some problem accessing the DB.

InstantMEssaging may not work properly.

Retry. Contact Oracle Support if the problem persists.

BEES-01321

Error loading InstantMessageReceptacle.

SEVERE

Requested entity does not exist.

InstantMEssaging may not work properly.

Contact system administrator or see stack trace for further action.

BEES-01322

Error deleting instant message transcript.

SEVERE

Some problem accessing the DB.

User will not be able to dlete his instant message transcript.

Contact system administrator or see stack trace for further action.

BEES-01323

Error deleting offline instant message.

SEVERE

Some problem accessing the DB.

User will not be able to delete his offline instant message.

Contact system administrator or see stack trace for further action.

BEES-01324

Could not fetch archive folder.

SEVERE

Some problem accessing the DB.

Server side archiving may not work.

Contact system administrator or see stack trace for further action.

BEES-01325

Error loading offline instant message.

SEVERE

Some problem accessing the DB.

InstantMEssaging may not work properly.

Retry. Contact Oracle Support if the problem persists.

BEES-01326

Error loading offline instant message.

SEVERE

Requested entity does not exist.

InstantMEssaging may not work properly.

Contact system administrator or see stack trace for further action.

BEES-01327

IMService could not get initialized properly.

SEVERE

Could not atcivate service command channel.

IMService will not work properly.

Restart IMService.

BEES-01341

Error updating the InstantMessageReceptacle.

SEVERE

User is not provisioned to use Instant Messaging.

User may not be able to login and use instant messaging.

Contact system administrator or see stack trace for further action.

BEES-01342

Error updating the InstantMessageReceptacle.

SEVERE

Resource value is null. User can't login with empty resource.

User may not be able to login and use instant messaging.

Provide a non null resource value.

Message Delivery Service Error Codes

The following table lists error codes for Message Delivery Service.

Table 3-16 Message Delivery Service

Message ID

Display Name

Severity

Cause

Effect

Action

BEES-02000

Message Delivery Service failed to initialize.

INTERNAL_ERROR

Unexpected failure during initialization. Unexpected failure during initialization of {0} delivery handler.

Message Delivery may not be fully available.

Please contact Oracle Support.

BEES-02001

Unable to login to remote service.

WARNING

Invalid username/password credentials.

Message Delivery can not proceed without valid credentials.

Define correct username/password credentials and try again.

BEEP-02070

SMPP ENQUIRE_LINK PDU time longer than expected.

WARNING

SMPP ENQUIRE_LINK PDU time longer than expected.

SMPP Performance could be degraded due to network latency.

Administrator check network settings and correct as required.

BEEP-02071

XMS delivery time longer than expected.

WARNING

XMS delivery time longer than expected.

XMS Performance could be degraded due to network latency.

Administrator check network settings and correct as required.

BEER-02080

SMPP connection closed unexpectedly.

WARNING

SMPP connection closed unexpectedly.

SMPP connection should auto-reconnect.

Administrator check network settings and correct as required.

BEEP-02081

There are no active/pending SMPP connections.

INTERNAL_ERROR

SMPP connection failures typically occur from the following: 1) Incorrect SMPP configuration details. 2) Incorrect Firewall/Network configuration.

SMS deliveries via SMPP will fail.

Administrator check SMPP configuration and/or network settings and correct as required.

BEEP-02082

There were no responses from the SmppDeliveryService instances.

INTERNAL_ERROR

This occurs when the SmppDeliveryService instances are restarting or have disconnected from the MessageBus.

SMS deliveries via SMPP may fail.

Administrator check SMPP configuration and/or network settings and correct as required.

BEEP-02083

The SmppDeliveryService was unable to connect to the specified SMPP provider.

INTERNAL_ERROR

SMPP connection failures typically occur from the following: 1) Incorrect SMPP configuration details. 2) Incorrect Firewall/Network configuration.

SMS deliveries via SMPP will fail.

Administrator check SMPP configuration and/or network settings and correct as required.

BEED-02097

The SmppDeliveryService encountered corrupt data.

INTERNAL_ERROR

Network related errors can cause the data to become corrupted.

SMS deliveries via SMPP may fail.

Administrator check SMPP configuration and/or network settings and correct as required.

BEER-02098

The SmppDeliveryService encountered a database error.

INTERNAL_ERROR

This instance of the SmppDeliveryService encountered an error while communicating with the configured Beehive database.

SMS deliveries via SMPP for this instance may fail.

Administrator check SMPP configuration and/or network settings and correct as required.

BEES-02099

Internal server error.

INTERNAL_ERROR

Unable to process delivery request.

Delivery request can not be completed.

Please contact Oracle Support.

Mobile DM Server Error Codes

The following table lists error codes for Mobile DM Server.

Table 3-17 Mobile DM Server

Message ID

Display Name

Severity

Cause

Effect

Action

BEES-02500

Mobile DM Server failed to initialize.

SEVERE

Service Instance is not initialized yet.

Mobile DM Server is not available.

Try again in a few minutes. If still fails, contact Oracle Support.

BEEZ-02501

Could not login to MobileDM Server.

WARNING

Invalid username/password combination.

Client cannot access the Mobile DM Server.

Type correct username/password combination and try again.

BEEZ-02502

Cannot proceed, as user is not authenticated.

WARNING

User cannot execute this command unless authenticated.

Command cannot be executed unless user is authenticated.

User must authenticate first before proceeding.

BEEZ-02503

Cannot proceed, as device is invalid.

WARNING

User cannot execute this command as device is invalid.

Command cannot be executed unless user re-authenticate with valid deviceID.

User must authenticate first before proceeding.

BEEZ-02504

Cannot proceed, as user context failed to initialize.

SEVERE

User context failed to be copied. User context failed to be re-attached.

Command cannot be executed unless user is authenticated.

Please contact system administrator.

BEED-02510

MobileDM Server cannot process this request.

WARNING

Invalid syntax for command {0}.

Command cannot be processed.

Correct the syntax and try again.

BEED-02511

Module not found.

WARNING

Invalid module ID sent on this command.

Module cannot be downloaded.

Check the module ID and re-send the download command.

BEED-02512

Too many invalid attempts from this client.

WARNING

Client send too many invalid command attempts.

Session is being closed and invalidated.

System administrator should verify server logs and potentially block offending client.

BEES-02591

Cannot fulfill Client request at this time.

SEVERE

Server capacity reached.

No new clients can be served at this time.

Administrator must increase the Mobile DM Server's capacity to allow new clients to be served.

BEES-02599

Internal server error.

SEVERE

Could not process command due to unexpected server error.

Operation cannot be completed.

Please contact Oracle Support for more information.

Mobile Data Sync Server Error Codes

The following table lists error codes for Mobile Data Sync Server.

Table 3-18 Mobile Data Sync Server

Message ID

Display Name

Severity

Cause

Effect

Action

BEES-02200

Oracle Mobile Data Sync Service failed to initialize.

INTERNAL_ERROR

This could be a deployment issue.

Oracle Mobile Data Sync Service will not be available.

Correct any error in the stacktrace and restart Oracle Mobile Data Sync Service. Contact Oracle Support if error persists.

BEEZ-02201

Could not log in to Oracle Mobile Data Sync Service.

WARNING

Invalid username/password combination.

The synchronization between the client and server would fail.

Type correct username/password combination and try again.

BEEZ-02202

Cannot proceed, because user is not authenticated.

WARNING

User cannot execute this command unless authenticated.

Command cannot be executed unless user is authenticated.

User must authenticate first before proceeding.

BEED-02210

Oracle Mobile Data Sync Service failed to parse or render the SYNCML message.

SEVERE

The client SYNCML message could be corrupted or the server could have a bug.

The synchronization between the client and server would fail.

Turn the SYNCML message log on and inspect the incoming message.

BEED-02211

Oracle Mobile Data Sync Service failed to parse or render the SYNCML messages in WBXML format.

SEVERE

The client WBXML message could be corrupted or the server could have a bug.

The synchronization between the client and server would fail.

Turn the SYNCML message log on and inspect the incoming message.

BEER-02280

Metadata persistence error.

WARNING

Oracle Mobile Data Sync Service has failed when saving or accessing metadata. The database could be down or the database access layer could have an issue.

Oracle Mobile Data Sync Service will not be available.

Contact your database administrator. If the database is up and normal, contact Oracle Support

BEER-02281

An error occurred at the Oracle Mobile Data Sync Service transport layer.

WARNING

The network connection between the client and the server could be broken. This could be a temporary network error.

The synchronization between the client and server would fail.

Correct the network error and retry the sync.

BEES-02290

Cannot fulfill client request at this time.

SEVERE

Server capacity reached.

No new clients can be served at this time.

Administrator must increase the Oracle Mobile Data Sync Service's capacity to allow new clients to be served.

BEES-02291

The data synchronization protocol handler experienced an error.

WARNING

The data synchronization protocol handler has failed when processing the client request.

The synchronization between the client and server would fail.

Contact Oracle Support for more information.

BEES-02292

Oracle Mobile Data Sync Service has failed when interacting with a back-end service.

WARNING

The back-end service could be down. See stack trace for details.

The synchronization of the affected data store would fail.

Make sure the back-end is up and retry the sync.

BEES-02299

Oracle Mobile Data Sync Service encountered an internal error.

INTERNAL_ERROR

Can not proceed due to unexpected error.

Sync could fail.

Contact Oracle Support for more information.

Mobile Mail Server Error Codes

The following table lists error codes for Mobile Mail Server.

Table 3-19 Mobile Mail Server

Message ID

Display Name

Severity

Cause

Effect

Action

BEES-02300

Mobile Mail Server failed to initialize.

INTERNAL_ERROR

Unexpected error.

Mobile Mail Server will not be available.

Please, contact Oracle support.

BEEZ-02301

Could not login to Mobile Mail Server.

WARNING

Invalid username/password combination.

Client cannot access Mobile Mail Server.

Verify username and password, and try again.

BEEZ-02302

Invalid state.

WARNING

User is in invalid state to do the operation.

Command is not executed.

Try again with the valid state {0}.

BEEZ-02303

User authorization process failure.

WARNING

Failed to associate user {0} to device {1}.

User will be unable to use Mobile Mail.

Try to logout and login back. If problem persists, please contact your system administrator.

BEED-02310

Invalid Mobile Mail request.

WARNING

Client has sent an invalid request.

Mobile Mail Server will not process the request.

Please, verify your Mobile Mail Client.

BEED-02311

Mobile Mail Server cannot process the command.

WARNING

Invalid syntax for command {0} from device {1}.

Command cannot be processed.

Mobile Mail client must correct the syntax and try again.

BEER-02380

Data streaming error.

WARNING

Data streaming error for device {0}.

Device end-to-end connection will be closed.

Device {0} needs to reconnect and reauthenticate.

BEER-02381

Unable to connect to Beehive Mail server.

SEVERE

Unexpected error.

Device end-to-end connection will be closed.

Check Beehive Mail server status, if the problem persists talk to your system administrator.

BEES-02390

Cannot fulfill Client request at this time.

WARNING

Server capacity reached.

No new clients can be served at this time.

Administrator must increase the "Service Name" Server's capacity to allow new clients to be served.

BEES-02399

Internal server error.

INTERNAL_ERROR

Could not process command due to an internal server error.

Command cannot be processed.

Please, contact the administrator for more details.

Mobile Push Server Error Codes

The following table lists error codes for Mobile Push Server.

Table 3-20 Mobile Push Server

Message ID

Display Name

Severity

Cause

Effect

Action

BEES-02400

Mobile Push Server failed to initialize.

INTERNAL_ERROR

Unexpected error.

Mobile Push Server will not be available.

Please, contact Oracle support.

BEEZ-02401

Could not login to Mobile Push Server.

WARNING

Invalid username/password combination.

Client cannot access Mobile Push Server.

Verify username and password, and try again.

BEEZ-02402

The operation requires the user to be authenticated.

WARNING

User cannot execute this command unless is authenticated.

Command is not executed.

User must authenticate first and try again.

BEEZ-02403

User authorization process failure.

WARNING

Failed to associate user {0} to device {1}.

User might not receive any notification.

Try to logout and login back. If problem persists, please contact your system administrator.

BEED-02410

Invalid Push request.

WARNING

Client has sent an invalid request.

Mobile Push Server will not respond to the request.

Please, verify your Push Client.

BEED-02411

Mobile Push Server cannot process this command.

WARNING

Invalid syntax for command {0}.

Command cannot be processed.

Push client must correct the syntax and try again.

BEEU-02430

Too many invalid commands.

WARNING

User {0} has sent many invalid commands through device {1}.

User connection is dropped.

Please, verify your data and try again.

BEER-02480

Communication channel is closed.

WARNING

You have a network problem or BTI service has failed to start.

Communication will not be established.

Retry, if problem persists, contact Oracle Support.

BEER-02481

Could not connect to Push Client.

WARNING

Communication channel to Push Client on device {0} is not available.

Push Client will not receive any data.

Please check your device, if the problem persists talk to your system administrator.

BEES-02491

Subscription failure.

SEVERE

Could not find event producer to application {0}.

User {0} will not receive any events on device {1}.

Try again, if problem persists contact your system administrator.

BEES-02492

Failed to initialize subscription manager.

SEVERE

Failed to associate an event listener to the user {0} and device {1}.

Push Server will not notify client about events.

Please, logout and try to login again. If problem persists, please contact your system administrator.

BEES-02499

Internal server error.

INTERNAL_ERROR

Could not process command due to an internal server error.

Command cannot be processed.

Please, contact the administrator for more details.

Notification Service Error Codes

The following table lists error codes for Notification Service.

Table 3-21 Notification Service

Message ID

Display Name

Severity

Cause

Effect

Action

BEES-01900

Notification service failed to initialize.

SEVERE

See stack trace for details.

Notification service will not be available.

Please contact Oracle Support.

BEED-01910

Notification schema xml parsing failed.

WARNING

Schema xml parsing caused an exception.

Schema will not be created.

Recreate Xml and try again.

BEED-01911

Notification properties xml parsing failed.

WARNING

Exception was thrown while converting to xml

Notification will not be created.

Recreate notification properties and try again.

BEED-01912

Invalid notification content error

WARNING

Notification content argument is incorrect

Notification will not be created.

Recreate notification content using SimpleContent and try again.

BEEU-01930

Notification schema creation failed.

WARNING

Schema by this name already exists.

Schema will not be created.

Change the name of the schema or update existing schema.

BEEU-01931

Schema attributes creation failed.

WARNING

Exception was thrown while creating attribute definitions

Schema will not be created.

Recreate schema attributes and try again.

BEEU-01932

An error occurred in the DB.

WARNING

See stack trace for details.

BEEU-01933

Entity was not found in the system.

WARNING

See stack trace for details.

BEEU-01934

Access control check failed.

WARNING

Insufficient privileges or access type.

Operation was not completed.

User needs more privileges.

BEEU-01935

Operation to update/delete entity failed.

WARNING

Invalid state of the object.

Operation was not completed.

Reload entity and then retry.

BEEU-01936

Notification schema create failed.

WARNING

See stack trace for details.

Schema will not be {0}.

Correct the error and retry.

BEEU-01937

Notification schema load failed.

WARNING

See stack trace for details.

Schema will not be {0}.

Correct the error and retry.

BEEU-01938

Notification schema update failed.

WARNING

See stack trace for details.

Schema will not be {0}.

Correct the error and retry.

BEEU-01939

Notification schema delete failed.

WARNING

See stack trace for details.

Schema will not be {0}.

Correct the error and retry.

BEEU-01940

Notification schema list failed.

WARNING

See stack trace for details.

Schema will not be {0}.

Correct the error and retry.

BEEU-01941

Notification create failed.

WARNING

See stack trace for details.

Notification will not be {0}.

Correct the error and retry.

BEEU-01942

Notification load failed.

WARNING

See stack trace for details.

Notification will not be {0}.

Correct the error and retry.

BEEU-01943

Notification update failed.

WARNING

See stack trace for details.

Notification will not be {0}.

Correct the error and retry.

BEEU-01944

Notification delete failed.

WARNING

See stack trace for details.

Notification will not be {0}.

Correct the error and retry.

BEEU-01945

Notification list failed.

WARNING

See stack trace for details.

Notification will not be {0}.

Correct the error and retry.

BEEU-01946

Notification create failed.

WARNING

Unable to overwrite delivery channel preference.

Notification will not be {0}.

Remove delivery channels try again.

BEEU-01950

Notification service encountered an error while processing Notification Template Binding.

WARNING

Failed to process binding: {0} Source Entity: {1} Notification Template:{2}/{3}

Notification will not be delivered to the user.

Correct the error and retry.

BEER-01980

An error occurred in the DB.

WARNING

An Exception occurred in the DB.

Operation was not completed.

BEES-01999

Internal service error.

SEVERE

Could not process action due to unexpected server error.

Operation cannot be completed.

Please contact Oracle Support.

Oracle Beehive Conferencing Error Codes

The following table lists error codes for Oracle Beehive Conferencing.

Table 3-22 Oracle Beehive Conferencing

Message ID

Display Name

Severity

Cause

Effect

Action

BEEU-00400

Failed to create Conference artifact.

SEVERE

Invalid parameters specified. Invalid Conference Property name or value specified. Invalid Conference Role name. Invalid Conference Role accessor specified.

BEEU-00401

Failed to create Conference Templat artifacte.

SEVERE

Invalid parameters specified. Invalid Conference Property name or value specified. Invalid Conference Role name. Invalid Conference Role accessor specified.

BEEU-00402

Failed to update Conference artifact.

SEVERE

Invalid parameters specified. Invalid Conference Property name or value specified. Invalid Conference Role name. Invalid Conference Role accessor specified. Failed to update entity bacause it was modified by another user.

BEEU-00403

Failed to update Conference Template artifact.

SEVERE

Invalid parameters specified. Invalid Conference Property name or value specified. Invalid Conference Role name. Invalid Conference Role accessor specified. Failed to update entity bacause it was modified by another user.

BEEU-00404

Failed to load Conference artifact.

SEVERE

Invalid parameters specified.

Verify the parameters.

BEES-00405

Failed to join to the Conference.

SEVERE

Invalid parameters specified. All servers are busy or system malfunction occurred. Request to join the Conference didn't complete within a given timeframe and was canceled by the server.

User failed to join the Conference session.

Verify the parameters. Retry to join to the Conference or contact your system administrator. Contact your system administrator.

BEEU-00406

Failed to join the Conference due to insufficient privileges to start the new Conference session.

WARNING

User is not granted with the privilige to start the Conference session.

User failed to join the Conference session.

Wait for host or other authorized user to start the Conference session.

Oracle Beehive Conferencing Streaming Media Error Codes

The following table lists error codes for Oracle Beehive Conferencing Streaming Media.

Table 3-23 Oracle Beehive Conferencing Streaming Media

Message ID

Display Name

Severity

Cause

Effect

Action

BEEC-03301

Failed to listen on the configured port.

SEVERE

Configured listen port was already in use or the user did not have permission to listen on this port.

Service is down.

Configure the listen port to a different value and restart the service.

BEEZ-03302

Failed to authenticate the user.

INFO

User provided invalid username/password.

User cannot access the requested conference

User must use proper username and password to access the conference

BEEZ-03303

Failed to authorize the user

WARNING

User not authorized to access this conference

User cannot access the requested conference

User must be a valid user in the system authorized to access the conference. Contact system administrator for authorization.

BEEU-03304

Conference does not exist.

WARNING

Either user requested a wrong conference id or the requested conference has been invalidated in the system.

User cannot access the requested conference.

User must use a valid conference identifier which is either running on the system or request the system administrator for authorization approval.

BEER-03305

Client abruptly got disconnected.

WARNING

Network error occurred resulting in a low bandwidth.

User was interrupted while connected to the service.

Player will retry to connect to the same conference without user intervention. User might need to seek to a particular position in the timeline in case of recorded conference or (s)he might see no frills after reconnection in case of live conference.

BEES-03306

Connection to MediaSession was lost.

SEVERE

An internal error occurred in WebConferencing service.

User will be disconnected from the service.

User needs to reconnect for the same conference.

BEEP-03307

The server is busy.

SEVERE

The server has already reached the maximum limit on number of clients it can serve at this moment.

User was not served.

User should try after sometime.

Oracle Beehive Conferencing Transcoding Error Codes

The following table lists error codes for Oracle Beehive Conferencing Transcoding.

Table 3-24 Oracle Beehive Conferencing Transcoding

Message ID

Display Name

Severity

Cause

Effect

Action

BEES-03401

Transcoding failed.

SEVERE

An error occurred while transcoding a conference.

Transcoding for a particular conference did not complete.

None. The service will pick up this task again in sometime.

BEEC-03402

Transcoding for a conference timed out.

SEVERE

Transcoding failed because of time-out.

Transcoding for a particular conference could not be completed in the timeout duration.

None. Contact system administrator for increasing the timeout duration if these failure are coming more often.

Policy Management Error Codes

The following table lists error codes for Policy Management.

Table 3-25 Policy Management

Message ID

Display Name

Severity

Cause

Effect

Action

BEEU-00901

Failed to create the policy schema

INFO

Policy schema with the same name already exists Unknown internal error has occured Cannot include rule definition actions of different type of classification in policy schema Policy schema and rule definition action classification cannot be different

Failed to create the policy schema {0}

Give a different name for creating a new policy schema Check the logs for further details Only include rule definition actions of same classification in policy schema Make sure Policy schema and rule definition action classification are same

BEEU-00902

Failed to update the policy schema

INFO

A rule definition refers to this attribute definition {0} Unknown internal error has occured Policy schema with the same name already exists Attribute definition {0} is not present in the schema Rule definition {0} does not exist Policy schema does not exist Cannot include rule definition actions of different type of classification in policy schema Policy schema and rule definition action classification cannot be different Policy object is immutable.

Failed to update the policy schema {0}

Delete all rule definitions refering to this attribute definition {0} Check the logs for further details Give a different name for creating a new policy schema Use different attribute definition to delete/update or to use in rule condition Give a different rule definition to update/delete Give a different policy schema for update/load/delete Only include rule definition actions of same classification in policy schema Make sure Policy schema and rule definition action classification are same Immutable policy objects are not allowed to update/delete.

BEEU-00903

Failed to delete the policy schema

INFO

Policy schema does not exist Unknown internal error has occured Cannot delete policy schema as some policy template refers to this schema Policy object is immutable.

Failed to delete the policy schema {0}

Give a different policy schema for update/load/delete Check the logs for further details Delete all the policy templates first before updating the schema Immutable policy objects are not allowed to update/delete.

BEEU-00904

Failed to load the policy schema

INFO

Policy schema does not exist Unknown internal error has occured

Failed to load the policy schema {0}

Give a different policy schema for update/load/delete Check the logs for further details

BEEU-00911

Failed to create the policy template

INFO

Rule definition is already imported into the template. Unknown internal error has occured A Policy template refering to same policy schema already exists at the current scope Policy template cannot be created other at this scope

Failed to create the policy template {0}

Cannot choose the same rule definition to import again. Choose a different rule definition. Check the logs for further details Cannot create more than one policy template refering to same policy schema at the current scope Choose either Enterprise, Organisation or Workspace as parent to create policy templates

BEEU-00912

Failed to update the policy template

INFO

Rule definition is already imported into the template. Unknown internal error has occured Policy template does not exist A Policy template refering to same policy schema already exists at the current scope Cannot delete template as some policy refers to this template A policy has rule instance for this template rule definition {0} Rule {0} is not present in policy template A policy template at the lower scope also refers to the same rule definition {0} Policy template exists at sub-container Policy object is immutable.

Failed to update the policy template {0}

Cannot choose the same rule definition to import again. Choose a different rule definition. Check the logs for further details Give different policy template for update/delete/load Cannot create more than one policy template refering to same policy schema at the current scope Delete policies first before updating/deleting the policy template Delete the instances of this rule from all policies which refers to this rule and then update/delete the rule Give a different rule Delete the rule of policy templates at the lower scope Delete the policy template at the sub-container which refers to the same policy schema Immutable policy objects are not allowed to update/delete.

BEEU-00913

Failed to delete the policy template

INFO

Policy template does not exist Unknown internal error has occured Cannot delete template as some policy refers to this template Policy object is immutable.

Failed to delete the policy template {0}

Give different policy template for update/delete/load Check the logs for further details Delete policies first before updating/deleting the policy template Immutable policy objects are not allowed to update/delete.

BEEU-00914

Failed to load the policy template

INFO

Policy template does not exist Unknown internal error has occured

Failed to load the policy template {0}

Give different policy template for update/delete/load Check the logs for further details

BEEU-00921

Failed to create the policy

INFO

Rule is already imported from the template to the policy Unknown internal error has occured A policy with the same name already exists in the container Policy cannot be created other than at scope levels Another policy also refers to the same policy template at the given container Rule modification failed {0} Cannot include rule actions of different type of classification in policy Policy and rule action classification cannot be different Attribute value is not provided

Failed to create the policy {0}

Cannot import the same rule from the template to the policy Check the logs for further details Give a different name for the policy Give either enterprise, organization or workspace as parent of a policy Cannot create a policy as another policy refers to the same policy template at the given container Verify the attributes and functions used in the condition Include rule actions of same classification in policy Make sure Policy and rule action classification are same Provide the attribute value while creating the policy or update policy schema attribution definition with default value

BEEU-00922

Failed to update the policy

INFO

Rule is already imported from the template to the policy Unknown internal error has occured A policy with the same name already exists in the container Policy does not exist Rule {0} does not exist Rule {0} is not present in policy template Attribute application value is not present for attribute definition {0} Cannot import the rule {0} since there is no template for the policy Cannot update the rule {0} that is imported Rule modification failed {0} Cannot include rule actions of different type of classification in policy Policy and rule action classification cannot be different Policy object is immutable. Attribute value is not provided

Failed to update the policy {0}

Cannot import the same rule from the template to the policy Check the logs for further details Give a different name for the policy Give a valid policy for update,load,delete Give a valid rule for update or delete Give a valid policy template to create a policy Give a value for the attribute definition {0} Policy is not created from template so cannot inherit any rule Cannot update the rule {0} that is imported Verify the attributes and functions used in the condition Include rule actions of same classification in policy Make sure Policy and rule action classification are same Immutable policy objects are not allowed to update/delete. Provide the attribute value while creating the policy or update policy schema attribution definition with default value

BEEU-00923

Failed to delete the policy

INFO

Policy does not exist Unknown internal error has occured Delete rule failed Policy object is immutable.

Failed to delete the policy {0}

Give a valid policy for update,load,delete Check the logs for further details Delete rule failed Immutable policy objects are not allowed to update/delete.

BEEU-00924

Failed to load the policy

INFO

Policy does not exist Unknown internal error has occured

Failed to load the policy {0}

Give a valid policy for update,load,delete Check the logs for further details

BEEU-00925

Failed to evaluate the policy

INFO

Unknown internal error has occured

Failed to evaluate the policy {0}

Check the logs for further details

BEEU-00926

Failed to execute the policy

INFO

Unknown internal error has occured

Failed to execute the policy {0}

Check the logs for further details

BEEU-00941

Failed to create the event group

INFO

Event group with the same name already exists Event group member {0} does not exist Event group parent{0} does not exist Create a group with either synchronous or asynchronous events as members Unknown internal error has occured

Failed to create the event group {0}

Give a different name for creating a new event group Give a different event group member to update/delete/load Give a different event group as parent Create a group with either synchronous or asynchronous events as members Check the logs for further details

BEEU-00942

Failed to update the event group

INFO

Event group {0} does not exist Event group with the same name already exists Event group member {0} does not exist Event group parent{0} does not exist Parent of the event group cannot be updated Event group can not contain members from both asynchronous and synchronous events Unknown internal error has occured

Failed to update the event group {0}

Give a different event group to update/delete/load Give a different name for creating a new event group Give a different event group member to update/delete/load Give a different event group as parent Do not change the parent of a event group Create a group with either synchronous or asynchronous events as members Check the logs for further details

BEEU-00943

Failed to delete the event group

INFO

Event group {0} does not exist Cannot delete event group as some subscriptions refers to this group Unknown internal error has occured

Failed to delete the event group {0}

Give a different event group to update/delete/load delete the subscriptions which refers to this group Check the logs for further details

BEEU-00944

Failed to load the event group

INFO

Event group {0} does not exist Unknown internal error has occured

Failed to load the event group {0}

Give a different event group to update/delete/load Check the logs for further details

BEEU-00981

Access denied. Insufficient privileges

INFO

Insufficient privileges

User does not have privileges to perform the operation

BEEU-00982

Unknown internal error has occured

INFO

Unknown internal error has occured

Check the logs for further details

Presence Service Error Codes

The following table lists error codes for Presence Service.

Table 3-26 Presence Service

Message ID

Display Name

Severity

Cause

Effect

Action

BEES-01801

Internal server error

SEVERE

Internal server error

Cannot service the request

Contact system administrator

BEEU-01802

The entity handle passed in is not supported

WARNING

The given Entity handle is not understood by the Presence service

Cannot service the request

Please use a valid entity handle

BEES-01803

Database is not up or unreachable

SEVERE

Database is not up or unreachable

Cannot service the request

Check database connectivity and connection parameters

BEEU-01804

The presence handle received is not valid

WARNING

The presence handle received is not valid

Cannot service the request

Check the presence handle being passed

BEEU-01805

The updater implementation passed is not supported by presence service

WARNING

The updater implementation passed is not supported by presence

Cannot service the request

Please use the updater instantiated from PresenceFactory

BEEU-01806

The requested operation is not supported by presence service

SEVERE

The requested operation is not supported by presence service

Cannot service the request

Please use valid methods from PresenceControl

BEES-01807

Timed out waiting for reply from presence service backend

WARNING

Presence service is down or bus connectivity is lost

Cannot service the request

Check presence service status and/or bus connectivity

BEEU-01808

The requested class is not supported by presence service

WARNING

The requested class is not supported by presence service

Cannot service the request

Please check the parameter passed

BEEZ-01809

User is not authorized for the operation

SEVERE

The user doesn't have enough privileges for the operation

Cannot service the request

Please authenticate with appropraite credentials

BEEU-01810

Activity start time or end time or both exceed limits

WARNING

Activity start time or end time or both exceed limit

Cannot service the request

Please have start time that is not too ahead in the future and end time that is in the future

BEEU-01811

Presence object is not loaded for the requested attribute

WARNING

Object has not been loaded with the proper Projection

Cannot service the request

Please use right Projection that covers the requested attribute

RM Service Error Codes

The following table lists error codes for RM Service.

Table 3-27 RM Service

Message ID

Display Name

Severity

Cause

Effect

Action

BEEU-04011

Cannot file artifact with collabid {0} as a Record

WARNING

Artifact is already a Record Cannot file artifact of type {0} as a Record Invalid Retention Category / Folder id {0}

Cannot file artifact with collabid {0} as a Record

BEEU-04012

Cannot unfile artifact with collabid {0} as a Record

WARNING

Artifact is already a Non-Record Cannot unfile artifact of type {0} as a Record

Cannot unfile artifact with collabid {0} as a Record

BEER-04031

Cannot file artifact with collabid {0} as a Record

SEVERE

Cannot file artifact as a Record since URM is not accessible Cannot file as a Record since URM returned an unknown error

Cannot file artifact with collabid {0} as a Record

Please re-try filing the artifact as a Record later

BEER-04032

Cannot unfile artifact with collabid {0} as a Record

SEVERE

Cannot unfile artifact as a Record since URM is not accessible Cannot unfile artifact as a Record since URM returned an unknown error.

Cannot unfile artifact with collabid {0} as a Record

Please re-try unfiling the artifact as a Record later.

BEER-04033

Cannot retrieve file plan information

SEVERE

Cannot get file plan as URM is not accessible Cannot get file plan as URM returned an unknown error.

Cannot retrieve file plan information

Please re-try retrieving file plan information later.

BEER-04034

Failed to configure URM.

SEVERE

Failed to configure URM. Failed to configure URM.

Failed to configure URM.

Failed to configure URM. Please try it again.

Remote Content Service Error Codes

The following table lists error codes for Remote Content Service.

Table 3-28 Remote Content Service

Message ID

Display Name

Severity

Cause

Effect

Action

BEEU-04101

Failed to copy document

INFO

Remote document doesnot exists Remote destination folder doesnot exists Remote share for both the elements are not same There is a folder conflicting with the action.

Failed to copy document

Give a valid remote document Give a valid remote folder as destination Give a common remote share Rename the document or delete/move the conflicting folder.

BEEU-04102

Failed to create document

INFO

Parent remote folder doesnot exists There is a folder conflicting with the action.

Failed to create document

Give a valid parent remote folder Rename the document or delete/move the conflicting folder.

BEEU-04103

Failed to delete document

INFO

Remote document doesnot exists

Failed to delete document

Give a valid remote document

BEEU-04104

Failed to load document

INFO

Remote document doesnot exists

Failed to load document

Give a valid remote document

BEEU-04105

Failed to move document

INFO

Remote document doesnot exists Remote destination folder doesnot exists Remote share for both the elements are not same There is a folder conflicting with the action.

Failed to move document

Give a valid remote document Give a valid remote folder as destination Give a common remote share Rename the document or delete/move the conflicting folder.

BEEU-04106

Failed to update document

INFO

Remote document doesnot exists

Failed to update document

Give a valid remote document

BEEU-04121

Failed to move folder

INFO

Remote folder doesnot exists Remote destination folder doesnot exists Remote share for both the elements are not same

Failed to move folder

Give a valid remote folder Give a valid remote folder as destination Give a common remote share

BEEU-04122

Failed to update folder

INFO

Remote folder doesnot exists

Failed to update folder

Give a valid remote folder

BEEU-04123

Failed to delete folder

INFO

Remote folder doesnot exists

Failed to delete folder

Give a valid remote folder

BEEU-04124

Failed to load folder

INFO

Remote folder doesnot exists

Failed to load folder

Give a valid remote folder

BEEU-04125

Failed to create folder

INFO

Parent remote folder doesnot exists

Failed to create folder

Give a valid parent remote folder

BEEU-04126

Failed to copy folder

INFO

Remote folder doesnot exists Remote destination folder doesnot exists Remote share for both the elements are not same

Failed to copy folder

Give a valid remote folder Give a valid remote folder as destination Give a common remote share

BEEU-04127

Failed to list folder

INFO

Remote folder doesnot exists

Failed to list folder

Give a valid remote folder

BEEU-04150

Connector configuration is incomplete.

INFO

The host information in the Remote Share is not set. The port information in the Remote Share is not set. The root ID information in the Remote Share is not set. The adapter name information in the Remote Share is not set. The default security group information in the Remote Share is not set. The default document type information in the Remote Share is not set.

The connector session has not been created.

Please set the host information in the Remote Share. Please set the port information in the Remote Share. Please set the root ID information in the Remote Share. Please set the adapter name information in the Remote Share. Please set the default security group information in the Remote Share. Please set the default document type information in the Remote Share.

BEEU-04151

Internal credential configuration is incomplete.

INFO

The realm information in the credentials is not set. The password or token information in the credentials is not set. The password information in the credentials is not set. The RemoteCredentials object is null.

The connector session has not been created.

Notify administrator of this internal error.

BEEU-04152

Internal credential configuration is incorrect.

INFO

The authentication type of the credentials is incorrect.

The connector session has not been created.

Notify administrator of this internal error.

BEEU-04153

Webdav connection manager is not configured.

INFO

The webdav connection manager is not configured.

The connector session has not been created.

Notify the administrator to configure the webdav connection manager.

BEEU-04154

The state and host configuration failed for the session.

INFO

The configuration information is incorrect in the Remote Share.

The connector session has not been created.

Check the configuration information in the Remote Share.

BEEU-04155

The configuration object was not built correctly.

INFO

Either the Root ID or Authentication Scheme is unrecognized.

The configuration object has not been created.

Notify administrator of this internal error.

BEEU-04156

The session is disconnected.

INFO

The session was disconnected.

The operation was not completed.

Notify administrator of this internal error.

BEEU-04157

The UCM session initialization failed.

INFO

The configuration information is incorrect in the Remote Share.

The connector session has not been created.

Check the configuration information in the Remote Share.

BEEU-04158

The UCM Adapter Manager ran into an internal error.

INFO

Message -- {0}. Temporary adapter config file was not created.

The ucm session was either not created or retrieved.

Notify administrator of this internal error.

BEEU-04159

A necessary parameter for the connector API was null.

INFO

The RemoteItemId parameter was passed in null. The parent RemoteItemId parameter was passed in null. The projection parameter was passed in null. The input stream parameter was passed in null. The updater parameter was passed in null. The name parameter was passed in null.

The operation was not completed.

Please check the aforementioned parameter.

BEEU-04160

This method is not supported by this connector.

INFO

The connector does not support this method.

The process has not completed.

Depending on what is unsupported, please check with other connectors for a connector that will support this method.

BEEU-04170

A resource is an incorrect type.

INFO

The root ID in the remote share is pointing to an incorrect resource.

Resource was not retrieved.

Check the root ID in the remote share.

BEEU-04171

Access is denied to resource.

INFO

Credentials are incorrect, or the incorrect ID is being supplied.

The operation was not completed.

Check the credentials and the ID.

BEEU-04172

Resource was not found.

INFO

The incorrect ID is being supplied.

The operation was not completed.

Check the ID.

BEEU-04173

General error for resource.

INFO

Unknown cause. Cause - HTTP Status was {0}. Cause - Message was {0}.

The operation was not completed.

Check remote share information or try recreating the remote repository template and remote share.

BEEU-04174

The Webdav connector received a non webdav resource.

INFO

The RCS CSI layer has used a non Webdav Resource with the Webdav Connector.

The operation was not completed.

Notify administrator of this internal error.

BEEU-04175

The Webdav Input Stream was unable to be created.

INFO

Either the stream or the get method was not given to the webdav input stream.

The operation was not completed.

Notify administrator of this internal error.

BEEU-04176

Stream error during the copy or move.

INFO

Error reading from Beehive or writing to Remote.

The operation was not completed.

Check both paths/IDs to items in beehive and remote.

BEEU-04177

Duplicate resource was found.

INFO

Duplicate resource was found and overwrite was set to false.

The operation was not completed.

Delete duplicate resource or set overwrite to true.

BEEU-04178

The Repository Type in the Remote Share is unsupported.

INFO

The Repository Type in the Remote Share is unsupported.

The Remote Content Session was not retrieved or created.

Please check the Repository Type in the Remote Share.

BEEU-04179

A general error has occurred in the Repository Factory.

INFO

The configuration information is incorrect in the remote share.

The Remote Content Session was not retrieved or created.

Notify administrator of this error.

BEEU-04180

No spool space available for write.

INFO

The spool was not configured to have enough space.

Failed to update document

Increase the max size of the RCS spooling components.

BEEU-04181

There is not enough available space in the RCS Spool to allocate enough memory.

INFO

Trying to write more data than was allocated in the spool.

Failed to update document

Check the predetermined size from the remote repository.

BEEU-04182

Unable to access remote share

INFO

Remote share is currently offline

Unable to access remote share

Contact the workspace manager

Search Error Codes

The following table lists error codes for Search.

Table 3-29 Search

Message ID

Display Name

Severity

Cause

Effect

Action

BEEC-03500

This type of search query is not supported

SEVERE

This type of search query is not supported

This search query cannot be executed

Modify the search query

BEER-03550

Search SQL error

WARNING

Search SQL error

Failed to perform operation

Please contact support

BEER-03551

Search Text error

WARNING

Search Text error

Failed to perform text query

Please contact support

BEER-03552

Search query resulted in SQL error

WARNING

Search query resulted in SQL error

Search query could not return results

Please contact support

BEER-03553

Search query resulted in Text error

WARNING

Search query resulted in Text error

Search query could not return results

Please contact support

BEER-03554

Wildcard Search resulted in too many expansions

WARNING

Wildcard Search resulted in too many expansions

Search query could not return results

Please refine your query using a prefix or suffix to the wildcard to get meaningful results

Social Service Error Codes

The following table lists error codes for Social Service.

Table 3-30 Social Service

Message ID

Display Name

Severity

Cause

Effect

Action

BEES-04300

Unexpected error.

SEVERE

An unexpected internal error occurred.

The requested operation cannot be performed

Contact system administrator.

BEES-04301

Internal error raising a connection event.

SEVERE

Internal error occurred.

A connection event is raised.

Contact system administrator.

BEEU-04302

NetworkType not Supported.

WARNING

The NetworkType value provided is invalid.

The requested operation will not be performed.

Provide appropriate value for the NetworkType.

BEEU-04303

Workspace Id not specified/invalid.

WARNING

Workspace Id not specified/invalid.

The requested operation will not be performed.

Provide appropriate value for the Workspace Id.

BEEU-04304

Invalid GROUP NetworkType - Group Id not specified/invalid.

WARNING

Invalid GROUP NetworkType - Group Id not specified/invalid.

The requested operation will not be performed.

Provide appropriate value for the Group Id.

BEEU-04305

Invalid CUSTOM NetworkType - User Ids not specified/invalid.

WARNING

Invalid CUSTOM NetworkType - User Ids not specified/invalid.

The requested operation will not be performed.

Provide appropriate value for the User Ids.

BEEU-04306

Invalid Anchor value - Cutoff Time cannot be greater then Anchor Time.

WARNING

Invalid Anchor value - Cutoff Time cannot be greater then Anchor Time.

The requested operation will not be performed.

Provide appropriate value for the Anchor time.

BEEU-04307

User cannot be connected to himself.

INFO

User is trying to connect to himself.

The requested operation will not be performed.

Provide appropriate value for the connection.

BEEU-04308

User cannot follow himself.

INFO

User is trying to follow himself.

The requested operation will not be performed.

Provide appropriate value for Following Id.

BEEU-04309

Duplicate connection error.

INFO

User is trying to connect to a connection.

The requested operation will not be performed.

Provide appropriate value for the connection.

BEEU-04310

Connection not found.

WARNING

The specified connection does not exist.

The requested operation will not be performed.

Provide appropriate value for the connection.

BEEU-04311

Insufficient privileges to perform operation.

INFO

Access denied. Insufficient privileges.

The requested operation will not be performed.

User does not have privileges to perform the operation.

BEEU-04312

Insufficient privileges to perform operation.

INFO

Access denied. Insufficient privileges.

The requested operation will not be performed.

User does not have privileges to perform the operation.

BEEU-04313

An invalid empty value was specified for parameter.

WARNING

An invalid empty value was specified for parameter : {0}

The requested operation will not be performed.

Specify a valid value for the offending parameter and re-try the operation.

BEEU-04314

An invalid null value was specified for parameter.

WARNING

An invalid null value was specified for parameter: {0}

The requested operation will not be performed.

Specify a valid value for the offending parameter and re-try the operation.

BEEU-04315

Invalid parameter.

WARNING

An invalid value was specified for parameter: {0}

The requested operation will not be performed.

Specify a valid value for the offending parameter and re-try the operation.

BEEU-04316

Invalid Collection.

WARNING

The collection {0} is null or empty. Or one of the values in collection is null

The requested operation cannot be performed.

Specify a non-null, non-empty collection.

Subscription Service Error Codes

The following table lists error codes for Subscription Service.

Table 3-31 Subscription Service

Message ID

Display Name

Severity

Cause

Effect

Action

BEEU-02101

Subscription service encountered an internal error.

INFO

See stack trace for details.

Operation on subscription was not completed.

Correct the error and retry.

BEEU-02102

Access control check failed.

INFO

Insufficient privileges or access type.

Operation was not completed.

User needs proper privileges for the operation.

BEEU-02111

Subscription template exists.

INFO

Subscription template with the same value already exist.

Operation was not completed.

Fix the failure and try again.

BEEU-02112

Subscription template not found.

INFO

Subscription template with the specified value cannot be found.

Subscription template was not loaded.

Fix the failure and try again.

BEEU-02113

Subscription template xml parsing failed.

INFO

Exception was thrown while parsing xml.

Subscription template is not created.

Fix error and try again.

BEEU-02114

Subscription template creation encountered an error.

INFO

See stack trace for details.

Create on subscription template was not completed.

Correct the error and retry.

BEEU-02115

Subscription template retrieval encountered an error.

INFO

See stack trace for details.

Load on subscription template was not completed.

Correct the error and retry.

BEEU-02116

Subscription templates retrieval encountered an error.

INFO

See stack trace for details.

Loading Subscription template list was not completed.

Correct the error and retry.

BEES-02117

Internal error while processing the upload.

INFO

See stack trace for details.

Load on subscription template was not completed.

Correct the error and retry.

BEES-02118

Unable to use jaxb for unmarshalling.

INFO

See stack trace for details.

Load on subscription template was not completed.

Correct the error and retry.

BEEU-02119

Invalid XML content is encountered.

INFO

See stack trace for details.

Load on subscription template was not completed.

Correct the error and retry.

BEEU-02120

Failed to update subscription template.

INFO

See stack trace for details.

Operation on subscription was not completed.

Correct the error and retry.

BEEU-02121

Subscription creation encountered an error.

INFO

See stack trace for details.

Creation on Subscription was not completed.

Correct the error and retry.

BEEU-02122

Subscription update encountered an error.

INFO

See stack trace for details.

Update on subscription was not completed.

Correct the error and retry.

BEEU-02123

Subscription deletion encountered an error.

INFO

See stack trace for details.

Delete on subscription was not completed.

Correct the error and retry.

BEEU-02124

Subscription retrieval encountered an error.

INFO

See stack trace for details.

Load on subscription was not completed.

Correct the error and retry.

BEEU-02125

Subscriptions retrieval encountered an error.

INFO

See stack trace for details.

Loading subscription list was not completed.

Correct the error and retry.

BEEU-02126

Failed to load source.

INFO

See stack trace for details.

Operation on subscription was not completed.

Correct the error and retry.

BEEU-02127

Failed to create subscription schema.

INFO

See stack trace for details.

Creation on Subscription was not completed.

Correct the error and retry.

BEEU-02128

could not load subscription schema by collab id.

INFO

See stack trace for details.

Load on subscription was not completed.

Correct the error and retry.

BEEU-02129

could not load subscription rule definition by collab id.

INFO

See stack trace for details.

Load on subscription was not completed.

Correct the error and retry.

BEEU-02130

could not check write access.

INFO

See stack trace for details.

Creation on Subscription was not completed.

Correct the error and retry.

BEEU-02131

could not load subscription by collab id.

INFO

See stack trace for details.

Load on subscription was not completed.

Correct the error and retry.

BEEU-02132

could not enable/disable subscription by collab id.

INFO

See stack trace for details.

Load on subscription was not completed.

Correct the error and retry.

BEEU-02133

could not delete subscription by collab id.

INFO

See stack trace for details.

Delete on subscription was not completed.

Correct the error and retry.

BEEU-02134

could not undelete subscription by collab id.

INFO

See stack trace for details.

Operation on subscription was not completed.

Correct the error and retry.

BEEU-02151

User Context returned null cen, throwing CsiException.

INFO

See stack trace for details.

Operation on subscription was not completed.

Correct the error and retry.

BEEU-02152

PLSQL status is not success.

INFO

See stack trace for details.

Operation on subscription was not completed.

Correct the error and retry.

BEEU-02153

Operation is not allowed during ZDU process

SEVERE

ZDU patching process is running

Subscriptions are not allowed to be created, updated, or deleted

Try again after ZDU patching process is done

System Management Error Codes

The following table lists error codes for System Management.

Table 3-32 System Management

Message ID

Display Name

Severity

Cause

Effect

Action

BEEZ-03800

System Management Access Denied.

SEVERE

The User does not have the required Privilege to do system management.

The User will not be allowed to do system management.

Grant the required Privilege to the User.

BEES-03801

Error encountered when manipulating/querying configuration data.

WARNING

Execution of {0} failed due to {1} at {2}.

Unable to service request to manipulate/query data in {0}.

Check the error and take appropriate action, including and not limited to verification of request.

BEES-03802

Failed to save system configuration changes.

WARNING

The proposed changes are not relative to the latest version of the system configuration.

The proposed changes to the system configuration were not saved.

Make changes starting with a snapshot of the latest version of the system configuration.

BEES-03803

Failed to save system configuration changes.

WARNING

The write lock expired.

The proposed changes to the system configuration were not saved.

Aqcuire a new WritableConfiguration, make the proposed changes, and save them before the write lock expires.

BEES-03804

Failed to save system configuration changes.

WARNING

The WritableConfiguration does not have a write lock anymore.

The proposed changes to the system configuration were not saved.

Do not attempt to save changes using a WritableConfiguration that no longer has a write lock.

BEEU-03805

Incompatible software detected, therefore configuration updates are not allowed using the current client.

WARNING

You already modified the Beehive configuration with a newer version of the software. The version of the current client is {0} but the version of the configuration is {1}. You already modified the Beehive configuration with a patched version of the software. The patches applied to the current client are {0} but patches applied to the configuration are {1}.

You will not be able to view or update the Beehive proposed configuration using the current client.

Use a compatible client to view and update the Beehive proposed configuration.

BEEU-03806

The property {0} is a network port and must be in the range 1 to 65535.

WARNING

Attempt to set a network port value outside the range 1 to 65535.

The configuration property {0} was not changed.

Specify a port value in the range 1 to 65535.

BEEU-03807

Negative values are not allowed in the list of database retry intervals.

WARNING

A negative value was found in the list of database retry intervals.

The configuration property was not modified.

Specify only non-negative values in the list of database retry intervals.

BEEU-03808

The property {0} must be in the range {1} to {2}.

WARNING

Attempt to set {0} outside the range {1} to {2}.

The configuration property {0} was not changed.

Specify a value in the range {1} to {2}.

Time Management And Coexistence With Exchange Error Codes

The following table lists error codes for Time Management And Coexistence With Exchange.

Table 3-33 Time Management And Coexistence With Exchange

Message ID

Display Name

Severity

Cause

Effect

Action

BEEU-01101

The entity could not be found.

FINE

The entity could not be found.

The entity cannot be accessed.

Specify a valid entity.

BEEU-01102

You do not have the required access.

FINE

You do not have the required access.

You do not have the required access.

Contact the owner of the entity to be granted access.

BEEU-01103

The user is not enabled for Time Management.

FINE

The user is not enabled for Time Management.

The user cannot perform Time Management operations.

Contact your administrator to enable the user for Time Management.

BEEU-01104

Optimistic locking failed.

FINE

The entity was modified.

The modifications cannot be applied.

Reload the entity and reapply the modification.

BEEU-01105

An invalid argument was provided.

WARNING

An invalid argument was provided.

The requested operation cannot be performed.

Please notify your system administrator.

BEEU-01106

A configuration parameter is missing.

SEVERE

A configuration parameter cannot be accessed from the Time Management Service's pl/sql.

The requested operation cannot be performed.

Please notify your system administrator.

BEEU-01107

This Time Management entity is locked.

FINE

This Time Management entity is locked.

The entity cannot be updated is this moment.

Retry the operation later, or contact the owner to unlock the workspace.

BEEU-01108

There already is an Entity with similar attributes at the same Scope.

FINE

There already is an Entity with similar attributes at the same Scope.

The operation cannot be performed.

Retry the operation with unique values, or update the conflicting entity.

BEEU-01109

Unable to exceed a limit defined by the Time Management Service.

FINE

The requested operation would cause a Time Management limit to be exceeded. The name of the entity exceeds the Time Management limit. The number of calendars per workspace exceeds the Time Management limit. The number of task lists per workspace exceeds the Time Management limit. The number of default reminders per container exceeds the Time Management limit. The number of reminders on this entity exceeds the Time Management limit. The number of participants exceeds the Time Management limit. The number of invitations per meeting exceeds the Time Management limit. The number of occurrences exceeds the Time Management limit. The number of occurrences in the calendar exceeds the Time Management limit. The number of todos in the task list exceeds the Time Management limit.

The requested operation cannot be performed.

Contact the administrator to increase the limit. Shorten the name of the entity. Delete a calendar from the workspace. Delete a task list from the workspace. Delete a default reminder associated with the same container. Delete a reminder associated with the entity. Remove some participants. Remove some participants or reduce the number of occurrences. Reduce the number of occurrences in the meeting. Delete some occurrences from the calendar. Delete some todos from the task list.

BEEU-01110

A scheduling conflict occurred.

FINE

A participant that does not allow double booking is already scheduled at this time.

The calendar event cannot be scheduled at this time.

Remove the conflicting participant, or reschedule the calendar event at another time.

BEEU-01111

A data constraint occurred.

WARNING

Inconsistent data was provided.

The requested operation cannot be performed.

Verify the values and retry the operation.

BEEU-01112

The operation cannot be completed in a timely fashion.

FINE

The resources required for this operation are currently busy.

The requested operation cannot be performed at this time.

Please retry the operation.

BEEU-01113

Unexpected error.

SEVERE

An unexpected internal error occurred.

The requested operation cannot be performed.

Please notify your system administrator.

BEEU-01115

A resources can not be invited to a day event.

FINE

A resource was invited to a day event.

The requested operation cannot be performed.

Please notify your system administrator.

BEEU-01116

The anchor is too old.

FINE

The last synchronization was too long ago.

Can not retreive the modifications since the last synchronization.

Please list all the elements of the container.

User Directory Services Error Codes

The following table lists error codes for User Directory Services.

Table 3-34 User Directory Services

Message ID

Display Name

Severity

Cause

Effect

Action

BEER-00700

A database operation failed due to a transient or permanent error

SEVERE

A database operation failed due to a transient or permanent error Failed to read data from database object

The attempted operation could not be completed

Try again later. If the problem persists, contact your system administrator

BEED-00701

External directory user creation error

WARNING

Duplicate entity The specified principal type is not valid The specified principal was not created Failed to process the external directory synchronization event Invalid enterprise {0} found for synchronization event Invalid organization {0} found for synchronization event The specified property is invalid; Name = {0}, Value = {1} The specified value for the parameter {0} is too large (Limit is {1}) The specified value for one or more parameters is too large The specified address is invalid An entity with the specified address already exists No such address The type of address has a suffix beyond the configured range of the system The type of the address is invalid The scheme of the address is invalid Null guid found for change number {0} Null profile name found for change number {0} Both profile name and guid are null for change number {0} An error occurred during user creation

External directory user not created

Specify a valid value

BEER-00701

An external directory operation failed due to a transient or permanent error

SEVERE

Unable to establish a connection to the external directory External directory authentication failed Check the plugin {0} name or path

Failed to start sync for {0}

Try again later. If the problem persists, contact your system administrator Check external directory is available and changelog enabled. Make sure that profile has correct user and group search base, with correct user credentials. Check the plugin name or path Check directory user credentials.

BEEU-00701

An error occurred during preference set creation

WARNING

Duplicate entity The specified parent does not exist or cannot be used No such entity The preference set cannot extend from another set with a different name The preference set cannot extend from another set with a different template schema The preference set cannot extend from the one specified because it would cause a cyclic dependency The preference set contains a preference property that cannot be overridden from its super set The preference property cannot be added to the preference set because it is not specified in the template The preference property cannot be added to the preference set because the value is not invalid as per the template The specified value for one or more parameters is too large The specified preference profile does not exist or cannot be used

The specified preference set was not created

Specify a valid value Specify another value

BEED-00702

User modification error during external directory synchronization

WARNING

No such entity Failed to resolve user {0}. User may not exist in target directory. The specified principal type is not valid The specified principal was not created The specified principal was not updated The specified principal was not deleted The specified property is invalid; Name = {0}, Value = {1} The specified value for the parameter {0} is too large (Limit is {1}) The specified value for one or more parameters is too large The specified address is invalid An entity with the specified address already exists No such address The type of address has a suffix beyond the configured range of the system The type of the address is invalid The scheme of the address is invalid Null guid found for change number {0} Null profile name found for change number {0} Both profile name and guid are null for change number {0} An error occurred during user update Failed to process the external directory synchronization event

External directory user not updated

Specify a valid value in the external directory Try again later. If the problem persists, contact your system administrator

BEEU-00702

An error occurred during preference set update

INFO

The specified parent does not exist or cannot be used A newer version of the specified entity exists in the system No such entity The preference set cannot extend from another set with a different name The preference set cannot extend from another set with a different template schema The preference set cannot extend from the one specified because it would cause a cyclic dependency The specified value for one or more parameters is too large The preference set contains a preference property that cannot be overridden from its super set

The specified preference set was not updated

Specify a valid value Specify another value Refresh the entity and retry the operation

BEED-00703

User deletion error during external directory synchronization

WARNING

No such entity An error occurred during user deletion Failed to process the external directory synchronization event

External directory user not deleted

Specify a valid value in the external directory

BEEU-00703

An error occurred during preference set deletion

WARNING

No such entity A newer version of the specified entity exists in the system The preference set can be deleted only when its parent is deleted

The specified preference set was not deleted

Specify a valid value Specify another value Refresh the entity and retry the operation

BEEU-00704

An error occurred during preference set loading

INFO

No such entity

The specified preference set was not loaded

Specify a valid value

BEEU-00705

An error occurred during preference profile creation

WARNING

No such entity Duplicate entity The specified parent does not exist or cannot be used The preference profile already contains the specified preference set The specified value for one or more parameters is too large A preference profile already exists for the specified entity

The specified preference profile was not created

Specify a valid value Specify another value

BEED-00706

Group creation error during external directory synchronization

WARNING

Duplicate entity Failed to process the external directory synchronization event Invalid enterprise {0} found for synchronization event Invalid organization {0} found for synchronization event The specified property is invalid; Name = {0}, Value = {1} The specified value for the parameter {0} is too large (Limit is {1}) The specified value for one or more parameters is too large The specified address is invalid An entity with the specified address already exists No such address The type of address has a suffix beyond the configured range of the system The type of the address is invalid The scheme of the address is invalid Null guid found for change number {0} Null profile name found for change number {0} Both profile name and guid are null for change number {0} An error occurred during group creation

External directory group not created

Specify a valid value in the external directory

BEEU-00706

An error occurred during preference profile update

INFO

The specified parent does not exist or cannot be used A newer version of the specified entity exists in the system No such entity The specified value for one or more parameters is too large The preference profile already contains the specified preference set

The specified preference profile was not updated

Specify a valid value Specify another value Refresh the entity and retry the operation

BEED-00707

Group modification error during external directory synchronization

WARNING

No such entity The specified property is invalid; Name = {0}, Value = {1} The specified value for the parameter {0} is too large (Limit is {1}) The specified value for one or more parameters is too large The specified address is invalid An entity with the specified address already exists No such address The type of address has a suffix beyond the configured range of the system The type of the address is invalid The scheme of the address is invalid An error occurred during group update Null guid found for change number {0} Null profile name found for change number {0} Both profile name and guid are null for change number {0} Failed to process the external directory synchronization event

External directory group not updated

Specify a valid value in the external directory

BEEU-00707

An error occurred during preference profile deletion

WARNING

No such entity The preference profile is currently active A newer version of the specified entity exists in the system

The specified preference profile was not deleted

Specify a valid value Specify another value Refresh the entity and retry the operation

BEED-00708

Group deletion error during external directory synchronization

WARNING

No such entity An error occurred during group deletion Failed to process the external directory synchronization event

External directory group not deleted

Specify a valid value in the external directory

BEEU-00708

An error occurred during preference profile loading

INFO

No such entity

The specified preference profile was not loaded

Specify a valid value

BEEC-00711

Error during initialization of external directory synchronization

SEVERE

Failed to created the directory object Failed to get default directory object Failed to connect to external directory Failed to get ldap server Invalid Directory type Failed to get the changelog DN from external directory Enterprise not found in directory object User type not found in directory object Group type not found in directory object Invalid group dn {0} found for the external directory Invalid user dn {0} found for the external directory Could not find the default user DN for the external directory Could not find the default group DN for the external directory Could not find the DN {0} in the external directory Invalid user name or password of the external directory user Invalid external directory host or port Invalid external directory host or port User configured in the profile doesnot have permission to access the hierarchy {0} in the external directory Invalid external directory credentials found, correct it and retry Invalid target attribute sub type {0} Invalid target attribute type {0} Invalid source attribute type {0} Invalid target attribute name {0} Target attribute type not found Target attribute type not found Source attribute type not found Target attribute name not found Invalid attribute map for {0} Invalid attribute name {0} in source attribute {1} Failed to find directory profile

External directory synchronization not initialized. Profile validation failed.

Specify a valid value Check external directory is available and changelog enabled. Make sure that profile has correct user and group search base, with correct user credentials. Specify another value Valid principal types are PRIMARY, PROTOCOL and VOICE Provide primary principal mapping Provide group name mapping Provide family name mapping For {0} valid source attribute format is {1} For {0} valid target attribute names are {1}

BEED-00711

Error in processing the external directory synchronization event

WARNING

Failed to initialize external directory synchronization plugin Failed to connect to external directory Failed to get the changelog DN from external directory Failed to get the unique global identifier from external directory Failed to search the external directory Failed to get the directory events from the external directory Failed to get the current change log number from the external directory

Failed to process the external directory synchronization event

Specify a valid value Check external directory is available and changelog enabled. Make sure that profile has correct user and group search base, with correct user credentials. Specify another value

BEEU-00711

An error occurred during principal creation

WARNING

The specified identifier is already in use The specified name is already in use The name was not specified or cannot be used The specified parent does not exist or cannot be used A specified sufficient principal does not exist or cannot be used The specified delegate does not exist or cannot be used The specified property is invalid; Name = {0}, Value = {1} The specified value for the parameter {0} is too large (Limit is {1}) The specified value for one or more parameters is too large The specified principal type is not valid Failed to raise event for the operation The user's personal workspace could not be renamed Protocol Principal name has characters which are not 7-bit encoded. The specified delegate already exists for the specified user

The specified principal was not created

Specify a valid value Specify another value Try again later. If the problem persists, contact your system administrator

BEEC-00712

Validate directory entry operation failed.

SEVERE

Failed to get Directory for given profile Profile {0} does not exist. Failed to get service locator. Entry type not supported Entry type is undefined Failed to get entry type Failed to get directory locator of entry Unsupported attribute Invalid Format A database operation failed due to a transient or permanent error Ldap or external directory type is not supported Entry not Created By sync or by current profile Manager or assistant not present in the system, DN:{0} Group member not present in the system, DN:{0} Group not of type static group Error in getting directory locator by collabId The entry cannot be found either in the system or in the external directory Entry absent in ldap server Cannot reconcile deleted entry. Failed to get data from Ldap server. Error in getting entry data by directory locator Error in terminating Ldap connection Entity doesn't satisfy rule map Validate directory entry operation not supported for {0}. Validate directory entry operation not supported for null type. No profile associated with entity {0}. Entity not mastered in external directory

Validation operation failed

Specify a valid value Provide correct profile name. Try again later. If the problem persists, contact your system administrator Purge entry and retry Use emailId or any valid Atrribute Define entry type In external directory Check external directory is available and changelog enabled. Make sure that profile has correct user and group search base, with correct user credentials. Use valid value Check database Reconcile works only for Static groups Value in external directory not proper Create manager or assistant Check external directory connections. Check the fetching of beehive mapped ldap attributes using ldap credentials specified in the profile and the same search criteria specified in rule maps. The log files may have more details. Check if the Ldap entry has valid object class, expected object class for this directory is ''{0}'' for user type, ''{1}'' for group type.

BEEU-00712

An error occurred during principal update

INFO

The specified name is already in use The specified parent does not exist or cannot be used A specified sufficient principal does not exist or cannot be used The specified delegate does not exist or cannot be used The specified property is invalid; Name = {0}, Value = {1} The specified value for the parameter {0} is too large (Limit is {1}) The specified value for one or more parameters is too large The specified principal type is not valid A newer version of the specified entity exists in the system The specified property does not exist. Failed to raise event for the operation

The specified principal was not updated

Specify a valid value Specify another value Refresh the entity and retry the operation Try again later. If the problem persists, contact your system administrator

BEEU-00713

An error occurred during principal deletion

WARNING

No such entity A newer version of the specified entity exists in the system Failed to unregister the entity with access control service Failed to raise event for the operation Group memberships could not be removed

The specified principal was not deleted

Specify a valid value Refresh the entity and retry the operation Try again later. If the problem persists, contact your system administrator

BEEU-00714

An error occurred during principal loading

INFO

No such entity

The specified principal was not loaded

Specify a valid value

BEEU-00715

An error occurred during principal resolution

INFO

No such entity The user for the specified principal is disabled, deleted or locked

The specified name was not resolved to a principal

Specify a valid value Enable the user and retry

BEED-00721

Failed to generate user data.

WARNING

User does not have a valid manager. Profile {0} does not exist. Failed to get service locator. Principal or unique identifier not found. Invalid file {0} name or location. Invalid ldap credentials. Invalid scope identifier. Invalid membership identifier. Attributes not found for user generation. Family name not found. Failed to find user type for {0}. Failed to find principal for {0}. Invalid attribute. Invalid property. Invalid address. Failed to generate user xml data. Failed to transform xml user data. Failed to generate user data.

Failed to download user data.

Provide correct manager or assistant value. Provide correct profile name. Provide family name for user {0}. Provide valid principal value. Try again later. If the problem persists, contact your system administrator Provide attribute map for profile {0}. Provide valid file location. Correct user type mapping and retry user generation. Provide valid ldap credentials. Provide valid scope identifier for {0}. Provide valid membership identifier for {0}. Provide valid user type. Check if user has required unique identifier or principal.

BEEU-00721

An error occurred during user creation

WARNING

The specified identifier is already in use The specified parent does not exist or cannot be used The owner was not specified or doesnot exist The operation cannot be performed while running in external directory mode The operation is valid only in external directory mode The family name was not specified The specified community does not exist or cannot be used The specified assistant does not exist or cannot be used The specified manager does not exist or cannot be used The specified preference profile does not exist or cannot be used The specified timezone does not exist or cannot be used The specified address is invalid An entity with the specified address already exists No such address The type of address has a suffix beyond the configured range of the system The type of the address is invalid The scheme of the address is invalid The specified personal workspace does not exist or cannot be used A provisioning policy could not be applied during user creation The specified locale does not exist or cannot be used. The specified value for the parameter {0} is too large (Limit is {1}) The specified value for one or more parameters is too large The specified property is invalid; Name = {0}, Value = {1} The specified property does not exist. The specified group is being modified.

The specified user was not created

Specify a valid value Specify another value See the log file for more details Either the operation cannot be performed with the current configuration, or the mode of directory service has to be changed Try again later. If the problem persists, contact your system administrator

The user context is null or invalid during personal workspace creation. The automatic address book contacts could not be created for the user

BEED-00722

Failed to add users.

WARNING

Unable to find users {0} manager Unable to find users {0} assistant Failed to get service locator. Failed to find profilename {0}. Invalid filename {0} or location. Invalid ldap credentials. Invalid enterprise identifier. Invalid organization identifier. Invalid user type. Invalid user attribute. Invalid user property. Invalid user address {0}. Invalid format of identifier {0}. Invalid user principal. Failed to parse user xml file Missing family name Failed to add groups. Failed to modify groups. Failed to add users.

Add user failed.

Provide valid manager value. Provide assistant principal name. Provide correct profile name. Try again later. If the problem persists, contact your system administrator Provide valid file name or location. Provide valid ldap user credentials. Provide valid enterprise identifier. Provide valid organization identifier. Provide valid user type. Provide valid principal identifier. Provide valid unique identifier. Provide valid address. Provide valid identifier. Provide valid value. Provide valid xml file Provide family name

BEEU-00722

An error occurred during user update

WARNING

The specified parent does not exist or cannot be used The user was not specified or cannot be used The owner was not specified or doesnot exist The operation cannot be performed while running in external directory mode The operation is valid only in external directory mode The family name was not specified The specified community does not exist or cannot be used The specified locale does not exist or cannot be used. The specified assistant does not exist or cannot be used The specified manager does not exist or cannot be used The specified preference profile does not exist or cannot be used The specified timezone does not exist or cannot be used The specified address is invalid An entity with the specified address already exists No such address The type of address has a suffix beyond the configured range of the system The type of the address is invalid The scheme of the address is invalid The specified personal workspace does not exist or cannot be used The specified property is invalid; Name = {0}, Value = {1} The specified property does not exist. The specified value for the parameter {0} is too large (Limit is {1}) The specified value for one or more parameters is too large A newer version of the specified entity exists in the system The specified group is being modified. (cont.)

The specified user was not updated

Specify a valid value Specify another value Either the operation cannot be performed with the current configuration, or the mode of directory service has to be changed Perform the operation/changes in external directory. Try again later. If the problem persists, contact your system administrator

The values {0} are mastered in the external directory. These are read only entries. The automatic address book contacts could not be updated for the user Access denied while trying to update scope. Scope change is not allowed to provided value.

BEED-00723

Failed to generate group data.

WARNING

Profile {0} does not exist.

Failed to download group data.

Provide correct profile name.

BEEU-00723

An error occurred during user deletion

WARNING

No such entity The user was not specified or cannot be used A user mastered in an external directory must be deleted in the external directory A newer version of the specified entity exists in the system A de-provisioning policy could not be applied during user deletion The operation cannot be performed while running in external directory mode The operation is valid only in external directory mode The automatic address book contacts could not be deleted for the user

The specified user was not deleted

Specify a valid value Specify another value Refresh the entity and retry the operation See the log file for more details Either the operation cannot be performed with the current configuration, or the mode of directory service has to be changed

BEEU-00724

An error occurred during user load

WARNING

No such entity The user was not specified or cannot be used

The specified user was not loaded

Specify a valid value

BEEU-00725

An error occurred during user purge

WARNING

No such entity The specified user has not been deleted and cannot be purged The user was not specified or cannot be used Failed to unregister the entity with access control service The user context is null or invalid during personal workspace creation.

The specified user was not purged

Specify a valid value Try again later. If the problem persists, contact your system administrator Try again later. If the problem persists, contact your system administrator

BEEU-00726

An error occurred while listing users

WARNING

A projection was not specified or cannot be used

The users could not be listed

Specify a valid value

BEEU-00731

An error occurred during group creation

WARNING

Duplicate entity The specified address is invalid No such address The type of address has a suffix beyond the configured range of the system The type of the address is invalid The scheme of the address is invalid The query was not specified or cannot be used The scope was not specified or cannot be used An entity with the specified address already exists The specified property is invalid; Name = {0}, Value = {1} The specified property does not exist. The specified value for the parameter {0} is too large (Limit is {1}) The specified value for one or more parameters is too large The scope was not specified or cannot be used An invalid predicate is specified The name was not specified or cannot be used The specified parent is not a team workspace The query was not specified or cannot be used The specified name is already in use An error occurred when raising events The operation cannot be performed while running in external directory mode The operation is valid only in external directory mode The specified group is being modified.

The specified group was not created

Specify a valid value Specify another value Either the operation cannot be performed with the current configuration, or the mode of directory service has to be changed Try again later. If the problem persists, contact your system administrator

BEEU-00732

An error occurred during group update

WARNING

The specified parent does not exist or cannot be used The specified group is invalid A newer version of the specified entity exists in the system No such entity The query was not specified or cannot be used The specified address is invalid An entity with the specified address already exists No such address The type of address has a suffix beyond the configured range of the system The type of the address is invalid The scheme of the address is invalid The specified property is invalid; Name = {0}, Value = {1} The specified property does not exist. The specified value for the parameter {0} is too large (Limit is {1}) The specified value for one or more parameters is too large The specified name is already in use Cannot convert a workspace group to enterprise group The specified preference profile does not exist or cannot be used An error occurred when raising events The operation cannot be performed while running in external directory mode The operation is valid only in external directory mode The specified group is being modified. The name was not specified or cannot be used The owner was not specified or doesnot exist The values {0} are mastered in the external directory. These are read only entries. The user does not have the required access rights (cont.)

The specified group was not updated

Specify a valid value Specify another value Either the operation cannot be performed with the current configuration, or the mode of directory service has to be changed Perform the operation/changes in external directory. Try again later. If the problem persists, contact your system administrator Login with the right permissions to access the entity.

Access denied while trying to update scope. Scope change is not allowed to provided value.

BEEU-00733

An error occurred during group deletion

WARNING

No such entity The specified group is invalid A newer version of the specified entity exists in the system This operation cannot be performed on the ALL_USERS group This operation cannot be performed on team workspace group A group mastered in an external directory must be deleted in the external directory An error occurred when raising events The operation cannot be performed while running in external directory mode The operation is valid only in external directory mode The user does not have the required access rights The specified group is being modified.

The specified group was not deleted

Specify a valid value Specify another value Either the operation cannot be performed with the current configuration, or the mode of directory service has to be changed Try again later. If the problem persists, contact your system administrator Login with the right permissions to access the entity.

BEEU-00734

An error occurred during group load

WARNING

No such entity The user does not have the required access rights The specified group is invalid

The specified group was not loaded

Specify a valid value Login with the right permissions to access the entity.

BEEU-00735

An error occurred during addition or removal of group member

WARNING

The specified member is invalid The member could not be added to the group The member could not be deleted from the group The member was not added to the group as it would create cyclic loop The specified entity is already part of the group The member exists in a scope which is not visible to the group The specified entity is already excluded from the group Removal of excluded member failed

The members could not be added or removed

Specify a valid value Check the group member details and remove the duplicate entity Check the group member details and remove the already excluded member from the list

BEEU-00736

An error occurred during group purge

WARNING

No such entity The specified group is invalid This operation cannot be performed on the ALL_USERS group This operation cannot be performed on the group with this status This operation cannot be performed on team workspace group An error occurred when raising events Failed to unregister the entity with access control service The user does not have the required access rights

The specified group was not purged

Specify a valid value Specify another value The group should be in a different status to perform this operation Login with the right permissions to access the entity.

BEEU-00737

An error occurred while getting the element modifications

WARNING

The scope was not specified or cannot be used The specified scope does not exist

Could not get the element modifications for the specified container

Specify a valid value Specify another value

BEEU-00738

An error occurred during group undelete

WARNING

No such entity The specified group is invalid This operation cannot be performed on the ALL_USERS group This operation cannot be performed on the group with this status This operation cannot be performed on team workspace group The user does not have the required access rights An error occurred when raising events

The specified group could not be undeleted

Specify a valid value Specify another value The group should be in a different status to perform this operation Login with the right permissions to access the entity.

BEEU-00739

An error occurred while listing groups

WARNING

A projection was not specified or cannot be used

The groups could not be listed

Specify a valid value

BEEU-00751

An error occurred during external contact creation

WARNING

The specified identifier is already in use The specified parent does not exist or cannot be used The owner was not specified or doesnot exist The operation cannot be performed while running in external directory mode The operation is valid only in external directory mode The family name was not specified The specified community does not exist or cannot be used The specified locale does not exist or cannot be used. The specified property is invalid; Name = {0}, Value = {1} The specified property does not exist. The specified value for the parameter {0} is too large (Limit is {1}) The specified value for one or more parameters is too large The specified timezone does not exist or cannot be used The specified address is invalid An entity with the specified address already exists No such address The type of address has a suffix beyond the configured range of the system The type of the address is invalid The scheme of the address is invalid

The specified external contact was not created

Specify a valid value Specify another value Either the operation cannot be performed with the current configuration, or the mode of directory service has to be changed

BEEU-00752

An error occurred during external contact update

WARNING

The specified parent does not exist or cannot be used The external contact was not specified or cannot be used The owner was not specified or doesnot exist The operation cannot be performed while running in external directory mode The operation is valid only in external directory mode The family name was not specified The specified community does not exist or cannot be used The specified property is invalid; Name = {0}, Value = {1} The specified value for the parameter {0} is too large (Limit is {1}) The specified value for one or more parameters is too large The specified timezone does not exist or cannot be used The specified locale does not exist or cannot be used. The specified address is invalid An entity with the specified address already exists No such address The specified property does not exist. The type of address has a suffix beyond the configured range of the system The type of the address is invalid The scheme of the address is invalid The values {0} are mastered in the external directory. These are read only entries.

The specified external contact was not updated

Specify a valid value Specify another value Either the operation cannot be performed with the current configuration, or the mode of directory service has to be changed Perform the operation/changes in external directory.

BEEU-00753

An error occurred during external contact deletion

WARNING

No such entity The external contact was not specified or cannot be used A external contact mastered in an external directory must be deleted in the external directory A newer version of the specified entity exists in the system The operation cannot be performed while running in external directory mode The operation is valid only in external directory mode

The specified external contact was not deleted

Specify a valid value Specify another value Refresh the entity and retry the operation Either the operation cannot be performed with the current configuration, or the mode of directory service has to be changed

BEEU-00754

An error occurred during external contact loading

WARNING

No such entity The external contact was not specified or cannot be used

The specified external contact was not loaded

Specify a valid value

BEEU-00755

An error occurred during external contact purge

WARNING

No such entity The external contact was not specified or cannot be used The specified external contact has not been deleted and cannot be purged The entity cannot be purged

The specified external contact was not purged

Specify a valid value Try again later. If the problem persists, contact your system administrator

BEEU-00756

An error occurred while listing external contacts

WARNING

A projection was not specified or cannot be used

The external contacts could not be listed

Specify a valid value

Virus Scanner Error Codes

The following table lists error codes for Virus Scanner.

Table 3-35 Virus Scanner

Message ID

Display Name

Severity

Cause

Effect

Action

BEES-03001

Request sent to the virus scan engine is not a valid one.

WARNING

Error parsing request sent to the scan engine running at {0}:{1} due to syntax or other errors. The operation requested is not a valid one. The service requested does not correspond to an available service on the scan engine running at {0}:{1}. ICAP version, {0}, used to communicate with the virus scan engine running at {1}:{2} is not a supported one.

Unable to service request made to the virus scan engine at {0}:{1}.

Verify the configuration settings on the virus scan engine, {0}:{1}. Verify the request being sent to the scan engine. Verify the Beehive configuration settings for the virus scan engine, {0}:{1}. Verify that the file {0} exists and is readable by the virus scan engine at {1}:{2}

BEEC-03002

Unable to scan for viruses due to a configuration error on the virus scan engine.

WARNING

License on virus scan engine running at {0}:{1} is not valid.

Unable to service any requests made to the virus scan engine at {0}:{1}.

Verify that the license on the virus scan engine, {0}:{1}, is valid.

BEES-03003

Unable to scan for viruses due to an I/O error.

WARNING

IO error encountered during scan of {0}. Request was made to engine, {1}:{2}. IO error encountered during communication with the virus scan engine running at {0}:{1}. Generic IO error. Unable to read input to be scanned {0} .

Unable to service scan request made to the virus scan engine at {0}:{1}.

Verify that the virus scan engine configured to be running at {1}:{2} is up and that there are no network connectivity issues between the Beehive middle tier and the scan engine. Additionally, verify that the input {0} exists and is readable by the virus scan engine. Check the system permissions on the file or directory {0}.

BEES-03004

Unable to remove viruses due to an I/O error.

WARNING

IO error encountered during repair of {0}. Request was made to engine, {1}:{2}. Unable to read input to be scanned {0} . Output file {0} not writeable. Generic IO error. IO error encountered during communication with the virus scan engine running at {0}:{1}.

Unable to service repair request made to the virus scan engine at {0}:{1}.

Verify that the virus scan engine configured to be running at {1}:{2} is up and that there are no network connectivity issues between the Beehive middle tier and the scan engine. Additionally, verify that the input {0} exists and is readable by the virus scan engine. If the request type specifies that the repairs need to be written to a file on disk, ensure that the scan engine has permission to write to disk. Check the system permissions on the file or directory {0}.

BEEC-03005

Unable to repair content of viruses due to a configuration error on the virus scan engine.

WARNING

License on virus scan engine running at {0}:{1} is not valid.

Unable to service any requests made to the virus scan engine at {0}:{1}.

Verify that the license on the virus scan engine, {0}:{1}, is valid.

BEES-03006

Response returned by the virus scan engine is not a valid/expected one.

WARNING

Response returned by the virus scan engine running at {0}:{1} is not a valid/expected one. Response returned by the virus scan engine running at {0}:{1} cannot be parsed.

Unable to service request made to the virus scan engine at {0}:{1}.

Verify the configuration settings on the virus scan engine, {0}:{1}.

BEES-03007

Unable to contact virus scan engine.

WARNING

IO error encountered during communication with the virus scan engine running at {0}:{1}. Unable to contact virus scan engine running on host: {0}. Unable to resolve the hostname, {0}, for the virus scan engine. Generic IO error.

Unable to service request made to the virus scan engine at {0}:{1}.

Verify that the virus scan engine configured to be running at {0}:{1} is up and that there are no network connectivity issues between the Beehive middle tier and the scan engine. Verify that the virus scan engine host and port configuration values in Beehive, which are currently set to {0} and {1} respectively, are correct. VIR_CHECK_SERVER_NETWORKING_ACTION Check to see if the virus scan engine on host {0} has been started.

BEES-03008

Unable to retrieve virus definition information from the virus scan engine.

WARNING

Error parsing virus definition information, {0}, returned by the scan engine running at {1}:{2}. Virus definition information is missing from response, {0}, returned by the scan engine running at {1}:{2}.

Unable to service request made to the virus scan engine at {0}:{1}.

Verify the configuration settings on the virus scan engine, {0}:{1}.

BEES-03009

Unable to retrieve capabilities information from the virus scan engine.

WARNING

IO error encountered during communication with the virus scan engine running at {0}:{1}.

Unable to service request made to the virus scan engine at {0}:{1}.

Verify the configuration settings on the virus scan engine, {0}:{1}.

BEES-03010

Virus scan engine cannot process request due to errors on the server where the engine is running.

WARNING

Scan engine at {0}:{1} has a memory or disk error. Scan engine at {0}:{1} has a encountered an internal error.

Unable to service request made to the virus scan engine at {0}:{1}.

Check the logs for the scan engine at {0}:{1} to determine the error. Ensure that there is sufficient disk and memory available on the scan engine server, {0}:{1}, to process requests.

BEES-03011

Virus scan engine has encountered an error processing request.

WARNING

Virus scan engine, {0}:{1}, is unable to process request.

Unable to service request made to the virus scan engine at {0}:{1}.

Verify connectivity, configuration, and resource availability on the virus scan engine server, {0}:{1}.

BEES-03012

Error encountered when manipulating/querying virus scan related data.

WARNING

Data manipulation/query of {0} failed due to {1}.

Unable to service request to manipulate/query data in {0}.

Check the error and take appropriate action, including and not limited to verification of request.

BEEC-03013

Beehive configuration settings disallow this request.

WARNING

Beehive configuration setting for the VirusScanPolicy is set to {0}. This disallows the request to {1}.

Unable to service request made to the virus scan engine at {0}:{1}.

Beehive configuration for the VirusScanPolicy needs to be set to either SCAN_ONLY or SCAN_AND_REPAIR in order to proceed with your request.

BEEC-03014

No virus scan engine found in the Beehive configuration system.

WARNING

Beehive configuration does not have any virus scan engines configured for use.

Unable to service your scan/repair request.

Verify the Beehive configuration settings and ensure that there is at least one virus scan engine configured. Also verify that the VirusScanPolicy is set to either SCAN_ONLY or SCAN_AND_REPAIR.

BEES-03015

None of the virus scan engines are available at this time.

WARNING

Unable to connect to any of the virus scan engines configured in the Beehive configuration system.

Unable to service your scan/repair request.

Verify that at least one of the virus scan engines configured for use is up and that there are no network connectivity issues between the Beehive middle tier and the scan engine.

Workspaces Error Codes

The following table lists error codes for Workspaces.

Table 3-36 Workspaces

Message ID

Display Name

Severity

Cause

Effect

Action

BEES-06000

Unexpected error.

SEVERE

An unexpected internal error occurred.

The requested operation cannot be performed

Contact system administrator.

BEEU-06001

Entity not found.

WARNING

The specified entity was not found. The specified parent entity not found. The specified target entity not found. No common parent entity exists for the specified entities.

Verify the Entity specified.

Retry the operation with a valid entity. Retry the operation with a valid entity. Retry the operation with a valid entity. Retry the operation with a set of entities that have a common parent.

BEEU-06002

Failed to perform the operation.

WARNING

Optimistic locking verification failed as the specified snapshot id does not match the server snapshot id.

The requested operation cannot be performed on the entity.

Reload the entity to be updated and then re-try.

BEEU-06003

Entity not checked out.

WARNING

The requested operation is not allowed on a entity that is not checked out.

The requested operation cannot be performed.

Checkout the entity and re-try the operation.

BEEU-06004

Deleted entity.

WARNING

The requested operation is not allowed on a deleted entity.

The requested operation cannot be performed.

Undelete the entity and re-try the operation.

BEEU-06005

Locked entity.

WARNING

The requested operation is not allowed on a locked entity.

The requested operation cannot be performed.

Unlock the entity and re-try the operation.

BEEU-06006

Duplicate entity.

WARNING

The specified entity identifier already exists.

The requested operation cannot be performed.

Specify a different entity identifier and re-try the operation.

BEEU-06007

Duplicate entity name.

WARNING

the specified entity name already exists.

The requested operation cannot be performed.

Specify a different entity name and re-try the operation.

BEEU-06008

Quota overflow.

WARNING

The hard quota limit for this scope has been exceeded.

The requested operation cannot be performed.

Get your quota increased!

BEEU-06009

Invalid Quota configuration.

WARNING

Invalid Quota configuration. Zero or negative quta values were specified. Soft quota value provided is greater than hard quota value. Specified quota configuration violates parent quota configuration. Specified quota configuration invalidates current children quota configuration.

Quota configuration update cannot be performed.

Review the specified quota configuration to make it comply with the quota configuration and status of the parent Scope. Review the specified quota configuration to make it comply with the quota configuration and status of the parent Scope. Review the specified quota configuration to make it comply with the quota configuration and status of the parent Scope. Review the specified quota configuration to make it comply with the quota configuration and status of the parent Scope. Review the specified quota configuration to make it comply with the quota configuration and status of the parent Scope.

BEEU-06010

INBOX update failed.

WARNING

The name of this folder is invalid.

INBOX will not be updated.

Folder name must be INBOX.

BEEU-06011

Cannot delete workspace default folder.

WARNING

Folder being deleted is a default workspace folder required by other services.

The specified folder will not be deleted.

Change the default workspace folder for that service to another folder and then re-try the delete operation.

BEEU-06012

Cannot move workspace default folder across scopes.

WARNING

Folder being moved is a default workspace folder required by other services.

The specified folder will not be moved.

Change the default workspace folder for that service to another folder and then re-try the move operation.

BEEU-06013

getElementModifications failed.

WARNING

The container snapshot id specified is too old to compute the list of modified elements.

Container modifications will not be retrieved.

Reload the whole container.

BEEU-06014

Copy was not complete.

WARNING

One or more of the contained items could not be copied because an error occurred.

Some of the items of the specified container will not be copied into the destination.

Manually copy the failed items after having reviewed and fixed the reason of their failure.

BEEU-06015

Update of team workspace participants failed.

WARNING

Team workspace participant list could not be updated because an error occurred. Team workspace participation mode does not allow for self-joining. Team workspace participant list could not be updated because a null participant was provided. Team workspace indirect participant (belong to a group which is a participant) cannot leave the workspace. Team workspace owner cannot be removed from the participant list. Team workspace owner's role cannot be changed. Cannot update the role of accessor who is not a team workspace participant. Cannot remove all accessors granted Workspace Coordinator role.

Team workspace participant list will not be updated.

Re-try the update of team workspace participants after having removed the problem encountered. Re-try the update of team workspace participants after having removed the problem encountered. Re-try the update of team workspace participants after having removed the problem encountered. Re-try the update of team workspace participants after having removed the problem encountered. Re-try the update of team workspace participants after having removed the problem encountered. Re-try the update of team workspace participants after having removed the problem encountered. Re-try the update of team workspace participants after having removed the problem encountered. Re-try the update of team workspace participants after having removed the problem encountered.

BEEU-06016

Non deleted entity.

WARNING

Cannot undelete an entity which is not deleted.

The requested operation cannot be performed.

Move the entity to the new destination.

BEEU-06017

Entity is checked out.

WARNING

The requested operation is not allowed on a entity that is checked out.

The requested operation cannot be performed.

Re-try the operation once the entity is not checked out.

BEEU-06018

Operation could not be performed.

WARNING

Another operation is being performed on the resource.

The result of this operation will not be available.

Please try again later.

BEEU-06019

Operation could not be performed.

WARNING

The resource has moved.

The result of this operation will not be available.

Please try again later.

BEEU-06050

Invalid parameter.

WARNING

An invalid value was specified for parameter {0}. An invalid null value was specified for parameter {0}. An invalid empty value was specified for parameter {0}. String parameter {0} is not allowed to contain any of these characters: {1}. The length of string parameter {0} is too long. Only Workspace.DIRECTORY projection is allowed when finding workspaces. Workspace default sensitivity cannot be specified in workspace create calls. The default sensitivity specified belongs to a different workspace. Unsupported ConflictResolutionMode for this operation. Transfer delay must be >= 0. Need to set defaultProjection or all of the individual projections. Both FolderListFilter and DocumentListFilter cannot be null. ContentUpdater within DocumentUpdater must be of type IdentifiableSimpleContentUpdater. Expected handle to either a PersonalWorkspace or TeamWorkspace. Unsupported ListFilter type specified in the ArtifactListProjection. {0}: The specified start date is later than the end date. {0}: Missing or illegal character following the escape character, expecting only "%" or "_" Entity cannot be undeleted because name or location is invalid. Entity cannot be undeleted to the parent type specified.

The operation will not be performed.

Specify a valid value for the offending parameter and re-try the operation. Either do not specify a new parent or specify a valid parent type for the undelete operation and re-try. Choose a destination that is neither the entity itself nor in the subtree of the entity. Choose a destinationthat is within the same scope.

Entity cannot be moved to the destination specified. Entity cannot be copied to the destination specified. Entity cannot be moved outside of scope. Invalid predicate specified in list filter. Invalid DbStatus code. Invalid PagingOptions specified for parameter {0}: Count value must be a positive number or -1. Invalid PagingOptions specified for parameter {0}: Start-Position value must be a positive number. Invalid GroupByOptions specified for parameter {0}: Group-size must be a positive number. Recent activity listfilter cannot accept two or more predicates of the same type. Predicate is invalid in this recent activity query scope. Some filtering options cannot co-exist in the same recent activity list filter. Popular entity list filter cannot accept two or more predicates of the same type.

BEEU-06051

Invalid operation on a hierarchical configuration.

WARNING

Versioning operations are prohibited in this container. The {0} configuration does not exist. A {0} configuration is already defined on this container. An existing ancestor {0} configuration is marked as final. Cannot mark as final when subcontainer has a {0} configuration defined. Cannot remove the default {0} configuration from an enterprise. Configuration update with these values would leave it in an invalid state. Container move failed because it would modify a {0} configuration marked as final.

The operation has failed due to a {0} configuration error.

Versioning operations are prohibited in this container. Specify a valid {0} configuration. Either update the existing {0} configuration or delete it and then create a new one. Mark the final {0} configuration as non-final and retry, or abort creation of the new configuration. Create or update the {0} configuration as non-final, or delete all {0} configurations on subcontainers. Update the enterprise {0} configuration instead of removing it. Ensure that the updated values of the {0} configuration are all valid. Remove the {0} configuration from the container to move, or mark the configuration in the destination as non-final.

BEEU-06052

The operation caused a naming conflict with another entity.

WARNING

A document already exists in this folder with the specified name; aborting due to the chosen conflict resolution mode.

The operation has not completed due to the conflict.

Choose a different name or a different conflict resolution mode.

BEEU-06053

A pending change conflict has occurred.

WARNING

The operation is in conflict with another pending change to this entity.

The operation has not completed due to the conflict.

Retry the operation or change the name of the document.

BEEU-06054

A error has occurred with the OperationContext.

WARNING

The OperationContext either does not exist or is not valid for this operation type. The OperationContext exists but is outdated since a conflicting operation has committed.

The operation has not completed due to the error.

Retry the operation with a valid OperationContext. Cancel the operation and try again.

BEEU-06055

Mandatory categories cannot be removed from an entity.

WARNING

The specified category was defined as a mandatory category in the effective category configuration for the parent container of the entity.

The specified category will not be removed from the specified entity.

Ensure that the category to be removed from the entity is not specified as being required in the effective category configuration for the parent contaienr of the entity.

BEEU-06056

The specified category is not in the list of available categories of the effective category configuration of the entity.

WARNING

The specified category was not in the list of available categories as configured in the effective category configuration of the entity being categorized.

The specified category will not be applied to the specified entity.

Ensure that the category to be applied to the entity is in the list of available categories of the effective category configuration of the entity being categorized.

BEEU-06057

The delete of the directory failed.

WARNING

The directory cannot be deleted because document(s) imported from it to Beehive still remain.

The directory will continue to exist in Beehive.

Refrain from deleting the directory unless all documents imported from it in Beehive are first purged.

BEEU-06058

The update of the version failed.

WARNING

A version cannot be updated if it represents the working copy.

The version will not be updated.

Check the working copy in, and then update the version.

BEEU-06059

Invalid lock type specified

WARNING

Locking an entity with the given lock type is not allowed.

The requested operation cannot be performed.

Re-try with a different lock type.

BEEU-06061

Recordized entity.

WARNING

Entity is recordized.

The requested operation cannot be performed.

Operation permitted only once entity is un-recordized.

BEEU-06062

Delete organization with users.

WARNING

There are users under the organization or its sub-organizations.

The requested operation cannot be performed.

Please delete the users before deleting the organization.

BEEU-06063

Delete organization with sub-organizations.

WARNING

There are sub-organizations under the organization.

The requested operation cannot be performed.

Please delete the sub-organizations before deleting the organization, or use option "forceCascade" to force cascade deleting sub-organizations and workspaces if desired.

BEEU-06064

Delete organization with workspaces.

WARNING

There are workspaces under the organization.

The requested operation cannot be performed.

Please delete the workspaces before deleting the organization, or use option "forceCascade" to force cascade deleting sub-organizations and workspaces if desired.

BEEU-06065

Link copy/move error.

WARNING

The reference to the link is purged.

The copy/move operation on link failed.

Refrain from copying/moving this link.

BEEU-06066

Delete personal workspace before workspace owner.

WARNING

The personal workspace owner is not deleted yet.

The requested operation cannot be performed.

Please double check if this is a mis-operation. Otherwise, please delete the personal workspace owner first.

BEEU-06070

Cannot delete workspace default wikipage.

WARNING

Wiki being deleted is a default workspace wikipage required by other services.

The specified wikipage will not be deleted.

Change the default workspace wikipage for that service to another wikipage and then re-try the delete operation.

BEEU-06071

Cannot move workspace default wikipage across scopes.

WARNING

Wikipage being moved is a default workspace wikipage required by other services.

The specified wikipage will not be moved.

Change the default workspace wikipage for that service to another wikipage and then re-try the move operation.

Workspaces Templates Error Codes

The following table lists error codes for Workspaces Templates.

Table 3-37 Workspaces Templates

Message ID

Display Name

Severity

Cause

Effect

Action

BEEU-06200

Invalid workspace sub-group reference in template

WARNING

The specified template body id does not refer to a workspace sub-group template body ID.

The dependent entity will not be created. For example, if the reference is for a task participant, the task will not be created.

Specify a valid workspace sub-group template body ID.

BEEU-06201

Unsupported file parent in template

WARNING

A container other than a heterogeneous folder is specified as the parent of the file.

The file will not be created.

Specify a hetegrogeneous folder as the parent of the file.

BEEU-06202

Unsupported calendar parent in template

WARNING

A container other than a workspace is specified as the parent of the calendar.

The calendar will not be created.

Specify a workspace as the parent of the calendar.

BEEU-06203

Unsupported task list parent in template

WARNING

A container other than a workspace is specified as the parent of the task list.

The task list will not be created.

Specify a workspace as the parent of the task list.

BEEU-06204

failed to store workspace-to-default folder mapping

WARNING

Attempt to store mapping between a workspace and a default folder (e.g., INBOX) in database failed with the following error : {0}

The default folder will not be functional, e.g., emails may not be delivered to INBOX folder.

Contact system administrator. Additional information may be available in log files.

BEEU-06205

Current actor's identifier is null

WARNING

Attempt to retrieve current actor for user context failed.

Current operation was terminated.

Contact Oracle support.

BEEU-06206

template creation failed

WARNING

The following error was encountered during template creation: {0}

The template was not created.

Retry after correcting the error.Ask system adiministrator to check additional information about the underlying error printed out in log file.

BEEU-06207

template deletion failed

WARNING

The following error was encountered during template deletion: {0}

The template was not deleted.

Retry after correcting the error.Ask system adiministrator to check additional information about the underlying error printed out in log file.

BEEU-06208

template retrieval failed

WARNING

The following error was encountered during template retrieval: {0}

The template was not retrieved.

Retry after correcting the error.Ask system adiministrator to check additional information about the underlying error printed out in log file.

BEEU-06209

template update failed

WARNING

The following error was encountered while updating template: {0}

The template was not updated.

Retry after correcting the error.Ask system adiministrator to check additional information about the underlying error printed out in log file.

BEEU-06210

syntax error encountered in template

WARNING

Syntax error at line {0}, column {1} : {2}

The template was not created.

Retry after correcting the syntax error.

BEEU-06211

syntax error in workspace summary URI specified in workspace template

WARNING

The following syntax error was encountered in summary URI: {0}

The workspace was not created

Retry after correcting the syntax error.Ask system adiministrator to check additional information about the error printed out in log file.

BEEU-06212

failed to store template-to-entity mapping

WARNING

Attempt to store mapping between a template and a an entity created from it failed with the following error : {0}

The entity was not created.

Contact system administrator. Additional information may be available in log files.

BEEU-06213

failed to unmarshall template

WARNING

Attempt to unmarshall template failed with the following exception: {0}

The template was not unmarshalled.

Contact system administrator. Additional information may be available in log files.

BEEU-06214

failed to retrieve advanced template XML schema

WARNING

Attempt to retrieve advanced template XML schema failed with the following exception: {0}

The advanced template XML schema was not retrieved.

Contact system administrator. Additional information may be available in log files.

BEEU-06215

the operation was partially successful

WARNING

Some of the steps executed during the operation failed.

Not all intended results of the operation will be available. For example, if the intended result of the operation was to create an entity, the entity may not be fully functional.

Contact system administrator. The details of exceptions encountered during the operation are printed out in log files.

BEEU-06216

a sub-operation failed causing partial success of the overall operation

WARNING

The following sub-operation failed causing partial success of the overall operation: {0}

The result of this sub-operation will not be available after the completion of the overall operation.

See nested exception for the cause of failure of this sub-operation.

BEEU-06217

Duplicate name

WARNING

An entity with the give name is reserved by some other user.

Cannot create the document/folder with the given name.

Please choose a different name.

BEEU-06219

The specified category parent predicate is invalid. Allowed values for the parent predicate are enterprise or other categories.

WARNING

The specified category parent predicate is invalid. Allowed values for the parent predicate are enterprise or other categories.

The category listing cannot be filtered based on the invalid parent predicate.

Ensure category parent predicate is valid.

BEEU-06220

The update of the label failed.

WARNING

Changing label type of this label is not allowed.

The label would not be updated.

Refrain from updating the label type of the label.

BEEU-06221

The update of the seeded label failed.

WARNING

Changing a seeded label is not allowed.

The label would not be updated.

Refrain from updating the label.

BEEU-06222

The update of the label application failed.

WARNING

Changing application type of this label application is not allowed.

The label application would not be updated.

Refrain from updating the application type of the label application.

BEEU-06223

The delete of the seeded label failed.

WARNING

Deleting a seeded label is not allowed.

The label would not be deleted.

Refrain from deleting the label.

BEEU-06224

attempt to delete or update a system-defined default workspace template

WARNING

An attempt was made to delete or update a system-defined default workspace template.

The workspace template was not modified.

A system-defined default workspace template cannot be deleted or updated.

BEEU-06225

Cannot create a container that is more than 90 levels deep.

WARNING

The requested operation would create a container that is more than 90 levels deep.

The requested operation cannot be performed.

Please create the container in a hierarchy that is less than 90 levels deep.

XMPP Protocol Service Error Codes

The following table lists error codes for XMPP Protocol Service.

Table 3-38 XMPP Protocol Service

Message ID

Display Name

Severity

Cause

Effect

Action

BEEU-02801

XMPP: Error in stream sent by client

SEVERE

XMPP: Error in stream, Invalid XML

XMPP: You have been disconnected

XMPP: Please Log-in again.

BEES-02804

XMPP: Error caused by other services

WARNING

XMPP: Exception thrown by other services e.g UDS, AUTH

XMPP: Requested operation couldn't be performed

XMPP: Contact Administrator for this error.

BEES-02805

XMPP: Internal server error

SEVERE

XMPP: internal server error, caused by some unexpected exception

XMPP: You have been disconnected.

XMPP: Please Log-in again.

BEEU-02806

XMPP: Recoverable error caused by erroneous xmpp MESSAGE packet sent by client

WARNING

XMPP: Some harmless erroneous tags/data in MESSAGE packet or packet is not RFC compliant

XMPP: Recieved MESSAGE packet had some erroneous data , ignoring the packet.

XMPP: To send the ignored packet again , correct it first and then repeat the operation.

BEEU-02807

XMPP: Recoverable error caused by erroneous xmpp IQ packet sent by client

WARNING

XMPP: Some harmless erroneous tags/data in IQ packet or packet is not RFC compliant

XMPP: Recieved IQ packet had some erroneous data , ignoring the packet.

XMPP: To send the ignored packet again , correct it first and then repeat the operation.

BEEU-02808

XMPP: Recoverable error caused by erroneous xmpp PRESENCE packet sent by client

WARNING

XMPP: Some harmless erroneous tags/data in PRESENCE packet or packet is not RFC compliant

XMPP: Recieved PRESENCE packet had some erroneous data , ignoring the packet.

XMPP: To send the ignored packet again , correct it first and then repeat the operation.

4 Oracle Beehive Property Reference

This module contains the following topics:

- Introduction to Oracle Beehive Properties

- Component Properties

Introduction to Oracle Beehive Properties

This section contains the following topics:

- Common Oracle Beehive Component Management Commands

- Managing Oracle Beehive Component Properties

- Properties Described in This Module

- Common Properties

- Common Properties for ServiceInstances

Common Oracle Beehive Component Management Commands

Table 4-1, "Component Management beectl Commands" lists beectl commands you are likely to use when managing Oracle Beehive components.

Note:
For complete descriptions and syntax for these beectl commands, see Chapter 2, "Oracle Beehive Command Line Utility".

Table 4-1 Component 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 component

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 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 Component Properties

This section describes beectl commands that are used for managing component parameters.

This section contains the following topics:

- Modifying Oracle Beehive Component Properties

- Exporting Configuration Data

- Modifying Oracle Beehive Ports using Privileged Port Numbers

Modifying Oracle Beehive Component Properties

Many Oracle Beehive components 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.

A subset of components are services. 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 or the name of the component 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 components by using the beectl list_components command:

beectl> list_components

All of the Oracle Beehive components are listed.

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.

Note:

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. Generally in Oracle Beehive documentation the system defined alias or component 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 using beectl, 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. It is an absolute replacement of the property value.

However, if it is a list of values that is to be changed, the syntax should be:

beectl modify_property --component <oc4j>:StartJavaExecutionArguments --name  AdditionalOptions --value=<value1> --value=<value2> --value=<value3>  --value=<valueNNN> --activate_configuration

Note:
Line breaks have been inserted in the following example for better readability.

beectl modify_property
--component _CURRENT_SITE:Database
--name AffinityServiceNames
--value "(DESCRIPTION=
(ADDRESS_LIST=
(ADDRESS=(PROTOCOL=TCP)(HOST=host1.example.com)(PORT=1521)))
(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=afserv1.example.com)))"
--value "(DESCRIPTION=
(ADDRESS_LIST=
(ADDRESS=(PROTOCOL=TCP)(HOST=host2.example.com)(PORT=1521)))
(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=afserv2.example.com)))"
--value "(DESCRIPTION=
(ADDRESS_LIST=
(ADDRESS=(PROTOCOL=TCP)(HOST=host3.example.com)(PORT=1521)))
(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=afserv3.example.com)))"
--value "(DESCRIPTION=
(ADDRESS_LIST=
(ADDRESS=(PROTOCOL=TCP)(HOST=host4.example.com)(PORT=1521)))
(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=afserv4.example.com)))"

Note:
Running the following command will clear all existing values for the additional options, including the XX:CompileCommand=exclude,oracle/ocs/cspi/OcsExceptionMetadata.bind type values
beectl modify_property –component <oc4j>:StartJavaExecutionArguments --name AdditionalOptions -revert_to_default

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.

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

beectl append_value --component <component> --name <property name> --value=<value1> --activate_configuration

Above command will add on to the existing property value. 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 properties in Table 4-2, "Properties Requiring beectl modify_local_configuration_files when changed" , you must also run the beectl modify_local_configuration_files command.

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 (bug 6335906)

- Changing the Instant Message Service's XmppPort or XmppSslPort properties 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 Chapter 2, "Oracle Beehive Command Line Utility".

Table 4-2 Properties Requiring beectl modify_local_configuration_files when changed

Component

Property

AuthenticationService

SsoType

SsoLogoutUrl

UseJazn

WnaEnabled

WnaKeytab

WnaPrincipal

OssoConfigFile

AuthStoreType

SsoType

LoginAttempts

LockoutTime

UseSecureCookie

WsSecuritySamlEnabled

WsSecuritySigKeyAlias

WsSecuritySigKeyPwd

WsSecurityExpiry

BeehiveInstance

LogBaseDir

WalletDir

WalletPassword

KeystoreFile

KeyStoreFilePassword

Bti

ControlPort (CtrlPort)

Status

StartJavaExecutionArguments

StopJavaExecutionArguments

Database

ConnectDescriptor

XaServiceNames

OnsNodeConfiguration

Database.AccessSchema

UserName

Password

Database.ConnectionPool

ConnectionProperties

MaxConnections

MinConnections

InitialConnections

MaxStatementsLimit

ConnectTimeout

InactivityTimeout

TimeToLiveTimeout

AbandonedConnectionTimeout

PropertyCheckInterval

ConnectionWaitTimeout

LowerThresholdLimit

HttpServer

HttpSslListenPort

HttpListenPort

OsUser

OsGroup

Timeout

ServerAdmin

MaxClients

ServerRoot

DocRootLimitExcept

KeepAliveTimeout

SSLLogLevel

LogLevel

Status

HttpServerCluster

HttpServerSslEnabled

SslTerminatedByLoadBalancer

LdapServer

LdapServerHostName

LdapServerPort

LdapServerSslPort

SslEnabled

LdapServerUser

LdapServerPassword

UserSearchBase

GroupSearchBase

UserObjectClass

GroupObjectClass

PrimaryAuthenticationAttribute

DirectoryType

ManagedOc4j

AdminPassword

Status

AjpPortMaxValue

AjpPortMinValue

RmiPortMaxValue

RmiPortMinValue

RmisPortMaxValue

RmisPortMinValue

JmsPortMaxValue

JmsPortMinValue

JGroupPortMaxValue

JgroupPortMinValue

StartJavaExecutionArguments

StopJavaExecutionArguments

ManagedOc4jCluster

AjpsEnabled

AdminPassword

OrmisEnabled

Opmn

RequestPort

RemotePort

LocalPort

OpmnCluster

NotificationServerSslEnabled

Opmns

Server

PrimaryHostName

SipListenerIPAddress

SipContainer

SipPortMaxValue

SipPortMinValue

SipEnabled

Site

LanguagePack

ClusteringEnabled

SsoKeyAlias

VirtualServer

HttpPort

HttpSslPort

ServerName

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:
For security reasons, secure values do not appear in the output of the beectl export_configuration_data command.

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

Properties Described in This Module

This module describes the properties for the following components:

Table 4-3 Components

Component

Properties

Common Properties: These properties are common to all components

Alias, LightweightThreadCount, LoggingProperties, ServiceApplication, ServiceInstances, Site, Status

Common Properties for ServiceInstances: These properties are common to all ServiceInstances

J2eeApplicationName, LightweightThreadPriority, Oc4j

AccessControlService

Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

AlarmService

Database, DatabaseRetryIntervalList, DefaultExpiryTime, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

ApplicationImage

EarFileName, ServiceInterface

AuditService

Database, DatabaseRetryIntervalList, LogLevel, LogonRecordDuration, ReadOnlyDBAccessEnabled, RecordsPurgeEnabled, RecordsRetentionPeriod, UdsCacheDisabled

AuthenticationService

AuthStoreType, AuthenticationPlugins, AuthenticationRealm, Database, DatabaseRetryIntervalList, JssoSessionTimeout, LockoutTime, LogLevel, LoginAttempts, OssoConfigFile, PostAuthClientInfoUpdatesDisabled, ReadOnlyDBAccessEnabled, S2SIdentities, SAMLRegistrationMap, SsoLogoutUrl, SsoType, TokenTimeout, UdsCacheDisabled, UseJazn, UseSecureCookie, UseSecureHash, WsSecurityExpiry, WsSecuritySamlEnabled, WsSecuritySigKeyAlias, WsSecuritySigKeyPwd

AuthenticationService.AuthenticationPlugin

AuthenticationType, Enabled, PluginProperties, QualifiedClassName

BdkService

Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, RestProperties, SoapProperties, UdsCacheDisabled

BdkService.RestProperties

PrivateProperties, PublicProperties

BdkService.RestProperties.PrivateProperties

NotificationQueuePollConcurrencyLimit, StreamBufferSize, TempFileStore

BdkService.RestProperties.PublicProperties

DebugModeEnabled, MaxBatchSize, NotificationQueuePollTimeout, NotificationQueueSuspendThreshold, NotificationSessionTTL, PresenceConnectionsLimit

BdkService.SoapProperties

DebugMode, MaxRequestSize

BeeCentralService

Database, DatabaseRetryIntervalList, Dial8HintLocaleStrings, EnableDownloadCenter, HelpLink, LogLevel, ReadOnlyDBAccessEnabled, SmsOptInHintLocaleStrings, UdsCacheDisabled

BeehiveConferencingService

ConfJavaDeployJavaURL, ConfJavaJNLP, ConferenceClientDownloadLocationMac, ConferenceClientDownloadLocationWin, Database, DatabaseRetryIntervalList, EnableDownloadCenter, HelpLink, JREDownloadURL, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

BeehiveInstance

AvailableNumberOfProcessors, AvailablePhysicalMemoryInMB, BeehiveInstanceName, Bti, DiagnosabilitySettings, HttpServer, KeystoreFile, KeystoreFilePassword, LogBaseDir, Oc4jInstances, Opmn, OracleHome, Server, WalletDir, WalletPassword

BeehiveJ2eeApplication

No other unique properties exist

BeekeeperService

Database, DatabaseRetryIntervalLis, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

Bti

BeehiveInstance, BtiProcessPingTimeout, ClientWorker, CtrlPort, LogDir, Redirector, ServerPort, ServerWorker, StartJavaExecutionArguments, StopJavaExecutionArguments

BtiClientWorker

AdditionalExecArgs, Bti, NumberOfWorkers

BtiComponent

AdditionalExecArgs

BtiGlobal

BackendSecurityMode, ClientPort, SecureClientPort

BtiRedirector

AdditionalExecArgs, Bti

BtiServerWorker

AdditionalExecArgs, Bti, NumberOfWorkers

CalDAVService

CollectionBrowsingEnabled, Database, DatabaseRetryIntervalList, DefaultFutureTimePeriodInDay, DefaultPastTimePeriodInDay, ISchedule, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

CalDAVService.ISchedule

Enabled, NoProxyFor, ProxyAuthId, ProxyAuthKey, ProxyHost, ProxyPort, ProxyType, Servers

CalDAVService.ISchedule.Server

DomainRegexp, IncomingAllowHostRegexp, ncomingAllowIPRegexp, IncomingAuthId, IncomingAuthKey, IncomingAuthMethod, Name, OutgoingAuthId, OutgoingAuthKey, OutgoingUrl

ClientManagementService

Database, DatabaseRetryIntervalList, DebugMode, LogLevel, NotificationQueueResumeThreshold, NotificationQueueSuspendThreshold, OutputFrameSize, ReadOnlyDBAccessEnabled, SessionTimeout, StreamReadBufferSize, StreamWriteBufferSize, TraceEnabled, UdsCacheDisabled

CoexistenceService

CoexistenceEnabled, ConnectorProperties, ContactProperties, Database, DatabaseRetryIntervalList, FreeBusyProperties, LogLevel, MeetingProperties, MessageProperties, ReadOnlyDBAccessEnabled, RequestSenderEnabled, TaskProperties, UdsCacheDisabled

CoexistenceService.ClusteredTaskProperties

No other unique properties exist

CoexistenceService.ConnectorProperties

SmtpServerHostName, SmtpServerPort

CoexistenceService.ContactProperties

AttachmentMaxSizeInKiloByte

CoexistenceService.ContainerSpecificProperties

AttachmentMaxSizeInKiloByte

CoexistenceService.DominoProperties

SmtpServerHostName, SmtpServerPort

CoexistenceService.ExchangeProperties

SmtpServerHostName, SmtpServerPort

CoexistenceService.ExpertiseProfilingProperties

AttachmentMaxSizeInKiloByte

CoexistenceService.FreeBusyProperties

FutureTimePeriodInDay, PastTimePeriodInDay

CoexistenceService.InstanceTaskProperties

No other unique properties exist

CoexistenceService.MeetingProperties

AttachmentMaxSizeInKiloByte, ImportDataFutureTimePeriodInDay, ImportDataPastTimePeriodInDay

CoexistenceService.MessageProperties

AttachmentMaxSizeInKiloByte, ImportDataFutureTimePeriodInDay, ImportDataPastTimePeriodInDay

CoexistenceService.ServiceManagerProperties

No other unique properties exist

CoexistenceService.TaskProperties

AttachmentMaxSizeInKiloByte, ImportDataFutureTimePeriodInDay, ImportDataPastTimePeriodInDay

CompositeStateManageable

No other unique properties exist

ConferenceMonitoringService

ClientConnectInfo, Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

ConferenceService

Database, DatabaseRetryIntervalList, DefaultDialoutCallTimeout, DefaultParticipantCodec, DefaultSipRegistrationExpiresInterval, LogLevel, OwcHostWaitSessionTimeout, OwcLogFlushPeriod, OwcMediaHostServiceBusAddressPrefix, OwcMediaHostServiceLoadBalanceBusAddressSuffix, OwcRosterServiceBusAddressPrefix, OwcRosterServiceLoadBalanceBusAddressSuffix, OwcUseRemoteMediaSessions, ReadOnlyDBAccessEnabled, SIPPSTNGatewayIPAddres, SIPPSTNGatewayPort, SipRegistrationEnabled, UdsCacheDisabled

ConferenceSessionService

Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

ConnectionPoolConsumer

No other unique properties exist

CustomService

Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

Database

AccessSchemas, AffinityPool, AffinityServiceNames, BusinessDataServiceName, ConfigServiceName, ConnectDescriptor, DefaultAccessSchema, DefaultNonXaPool, DefaultXaPool, DiagnosabilityServiceName, EventListenerServiceName, OnsNodeConfiguration, ParentDatabase, ReadOnlyBusinessDataServiceName, SearchServiceName

Database.AccessSchema

BusinessDataSupported, ConfigDataSupported, DiagnosticDataSupported, EventListenerDataSupported, Password, ReadOnlyBusinessDataBaseSupported, SearchDataSupported, UserDataSupported, UserName

Database.AffinityPool

AbandonedConnectionTimeout, ConnectTimeout, ConnectionProperties, ConnectionWaitTimeout, InactivityTimeout, InitialConnections, LowerThresholdLimit, MaxConnections, MaxRetryAttemptLimit, MaxRetryTimeLimit, MaxStatementsLimit, MinConnections, PropertyCheckInterval, ReadTimeout, ServiceStatusCheckInterval, StatusChangeErrorThreshold, TimeToLiveTimeout, ValidateConnection

Database.ConnectionPool

AbandonedConnectionTimeout, ConnectTimeout, ConnectionProperties, ConnectionWaitTimeout, InactivityTimeout, InitialConnections, LowerThresholdLimit, MaxConnections, MaxRetryAttemptLimit, MaxRetryTimeLimit, MaxStatementsLimit, MinConnections, PropertyCheckInterval, ReadTimeout, TimeToLiveTimeout, ValidateConnection

DeletedSystemObject

No other unique properties exist

DeviceManagementService

BlockedDevices, Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled, UncertifiedDeviceAllowed

DeviceManagementService.BlockedDevice

Description, DeviceId

DiagnosabilitySettings

BaseErrorCodeProperties, ContextProperties, ErrorCodeDBPersistenceEnabled, ErrorCodeDBProperties, ErrorCodeLoggingProperties, ProbeEnabled, ProbeProperties

DiagnosabilitySettings.ContextProperties

IncludeCallerStacks, PropagationEnabled

DiagnosabilitySettings.ErrorCodeProperties

ExcludedErrorCodes, IncludeStackTraces, IncludedErrorCodes, LoggingSeverity, ReportingSeverityThreshold, UploadInterval

DiagnosabilitySettings.ProbeProperties

LightWeightEnabled, MaxSize, PersistenceInterval, StorageLocation

DiscussionsService

Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

EmailService

CSIProperties, CoexUserLocal, Database, DatabaseRetryIntervalList, DirectoryCacheTTL, GlobalDomainName, IMAPEnabled, IMAPProperties, LocalEmailPatterns, LogLevel, MaxDirectoryCacheEntries, MaxMailSz, NonLocalEmailPatterns, PersistenceProperties, ReadOnlyDBAccessEnabled, SMTPEnabled, SMTPProperties, SaveParseErrorEmails, SortByAddressOnly, SubjectSortingGroupingRules, SubjectSortingReplacementRules, TimeoutCheckingInterval, TransportProperties, UdsCacheDisabled

EmailService.CSIProperties

MaxLoadCount, StreamBufferSize, StreamMaxReadChunkSize, StreamMaxWriteChunkSize, StreamPreFetchSize, StreamTimeout, VMSProperties

EmailService.EndpointProperties

EndpointName, EndpointScheme

EmailService.IMAPProperties

AssumeSingleEndpoint, CacheMessageSize, ClientKeepAliveInterval, EndpointPropertiesList, FolderCacheDirectory, FolderOpenBatchSize, FolderPollingInterval, FolderSyncBatchSize, LoginErrorThreshold, MaxFolderCacheSize, MaxSessions, MessageLoadBatchSize, ParseErrorThreshold, Port, ProtocolLoggingEnabled, ServerSessionConcurrency, SessionTimeout, ShowInstanceNameInBanner, StreamReadBufferSize, SurrogateAuth, TlsMandatory, UseTls

EmailService.PersistenceProperties

CopyBatchSize, DbConnRetry, DeleteBatchSize, DurableFileRoot, MoveBatchSize, PldStoreCacheLinger, PldStoreCleanupInterval, PldStoreMaxMemCachedRecords, PldStoreMaxOpenFDs, PldStoreRecordCacheSz, PldStoreStreamBufSz, TempFileRoot, UndeleteBatchSize, UpdateFlagsBatchSize

EmailService.SMTPProperties

AssumeSingleEndpoint, Authentication, DSNEnabled, EndpointPropertiesList, Port, ProtocolLoggingEnabled, RelayProtocolLoggingEnabled, SendMailEvenIfNoTls, ServerSessionConcurrency, UseTls, VMSEvaluatorTopLevel, VMSPropertiesList

EmailService.SMTPProperties.VMSProperties

AuthMandatory, CustomDisplayName, CustomDomainName, CustomProductVersion, LogAllExceptions, MaxAbortedTransitionsPerSession, MaxBadTransitionsPerSession, MaxCommandLineSize, MaxRcptsPerTx, MaxRejectedAddressesPerSession, MaxSizeBeforeAttackSuspected, MaxSzAbortTx, MaxUselessCommandsPerSession, NextCommandTimeout, NextDataChunkTimeout, QuitWriteTimeout, RecipientMatcherTopLevel, RejectAll, SenderMatcherTopLevel, ShowInstanceNameInBanner, SupressReceivedFrom, SupressResponseText, TlsMandatory, UseDefaultDisplayName, UseDefaultDomainName, UseDefaultMaxSz, UseDefaultProductVersion, VMSName

EmailService.TransportProperties

AcceptInvalidLocalUsers, DeliveryConcurrency, DeliveryTopLevel, InMemoryQueueSize, KeepAliveInterval, LocalDeliveryBatchSize, MaxReceivedHeaders, MaxRetryPeriod, MaximumDBMessageQueuePercentage, MinimumDBMessageQueuePercentage, MsgTerminusTopLevel, PreResolutionTopLevel, ProcessingEnabled, QueuePollInterval, RelayServer, ResolutionTopLevel, RetryInterval, SMTPDeliveryBatchSize, SMTPDeliveryCheckpoint, ScanOnUpload, SentEmailPluginEnabled, SimpleRelayMode, ThreadPoolSize

Enterprise

CollabId, Name

EventService

AsyncActionRetryCount, AsyncActionRetryInterval, AsyncLogLevel, Database, DatabaseRetryIntervalList, LogLevel, MaxThreadPoolSize, PreEvaluateThresholdRuleCount, ReadOnlyDBAccessEnabled, UdsCacheDisabled

ExpertiseService

ActiveLanguages, Database, DatabaseRetryIntervalList, EnableExpertiseRequestExpiration, ExpertiseRequestExpirationInterval, LogLevel, MaxArtifactSize, MaxNumPublicTermsPerProfile, MaxNumTermsPerProfile, MaxNumUsersForBrokeredRequest, NumDaysFetchContent, NumProfilerParallelRuns, ReadOnlyDBAccessEnabled, UdsCacheDisabled

ExternalJ2eeApplication

AdminPassword, AdminUsername, Hostname, Oc4jName, OpmnRequestPort

FaxMessageService

Database, DatabaseRetryIntervalList, DebugFlags, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

FtpService

ActiveModeEnabled, ChannelSecurity, DMSInstrumentation, DataConnectionPort, Database, DatabaseRetryIntervalList, DefaultCommandCharacterset, DefaultDataPort, FtpServerEnabled, InternalIP, ListeningPoint, LogLevel, MaxDCPortCount, Port, ReadOnlyDBAccessEnabled, SessionTimeout, UdsCacheDisabled, UploadBufferSize

HasHelpLink

HelpLink

HttpServer

BeehiveInstance, DocRootLimitExcept, HttpListenPort, HttpServerCluster, HttpSslListenPort, KeepAliveTimeout, LockFile, LogLevel, MaxClients, OsGroup, OsUser, SSLLogLevel, ServerAdmin, ServerRoot, Timeout

HttpServerCluster

HttpServerSslEnabled, HttpServers, ModOc4jMaxErrors, SslTerminatedByLoadBalancer

IdMap

Map

IdentityProviderService

Database, DatabaseRetryIntervalList, IdpSAMLIdentity, IdpUrl, LogLevel, ReadOnlyDBAccessEnabled, SpSAMLIdentity, SpUrl, UdsCacheDisabled

ImService

ArchivingEnabled, ChatRoomTranscriptsOn, ChatRoomXhtmlFormattingOn, Database, DatabaseRetryIntervalList, ImBufferStageSize, ImEndPointDeathDetectionTime, ImOfflinePurgingPeriodTimer, ImPurgingPeriodTimer, LogLevel, MaxRoomCount, MaxUsersInRoom, OnlyPasswordProtectedRooms, PendingMessagesLimit, ReadOnlyDBAccessEnabled, ReplayMessageHistoryOnJoin, UdsCacheDisabled

IrmService

ClassificationId, ClassificationLabelDescription, ClassificationLabelName, ClassificationLocale, ClassificationSystemId, ContentLabelDescription, ContentLabelLocale, ContentLabelName, Database, DatabaseRetryIntervalList, DesktopSyncURI, DesktopURI, IrmDesktopServiceEndPoint, IrmSealingServiceEndPoint, IrmUserName, IrmUserPassword, KeySetUUID, LicenseExpirationTime, LogLevel, ReadOnlyDBAccessEnabled, RequiresHttpAuth, RequiresHttps, SystemLabelDescription, SystemLabelLocale, SystemLabelName, UdsCacheDisabled

JavaExecutionArguments

AdditionalOptions, InitialHeapSizeInMB, InitialPermanentGenerationSizeInMB, MaximumHeapSizeInMB, MaximumPermanentGenerationSizeInMB

JcrServletService

AuthenticationScheme, Database, DatabaseRetryIntervalList, JCRServerEnabled, JcrSessionTimeout, LogLevel, MaxDownloadBufferSize, ReadOnlyDBAccessEnabled, UdsCacheDisabled, UploadBufferSize

LdapServer

DigestAuthenticationAttribute, DirectoryType, GroupObjectClass, GroupSearchBase, LdapServerConnectionPoolMaxSize, LdapServerConnectionTimeout, LdapServerHostName, LdapServerPassword, LdapServerPort, LdapServerSslPort, LdapServerUser, PrimaryAuthenticationAttribute, PrimaryAuthenticationCredential, ProtocolAuthenticationAttribute, ProtocolAuthenticationCredential, SslEnabled, UserObjectClass, UserSearchBase, VoiceAuthenticationAttribute, VoiceAuthenticationCredential

LoggingConfigurable.LoggingProperties

BaseLogLevel, MaxFileSize, MaxLogSize, ModuleLogLevel, RotationFrequency

ManagedOc4j

AdminPassword, AdminUsername, AjpPortMaxValue, AjpPortMinValue, Applications, BeehiveInstance, Database, HttpThreadPoolConfiguration, JGroupPortMaxValue, JGroupPortMinValue, JcaThreadPoolConfiguration, JmsPortMaxValue, JmsPortMinValue, ManagedOc4jCluster, Oc4jName, PseudoTranslationEnabled, PseudoTranslationStrategy, ResourceAdapterInstances, RmiClientTimeout, RmiConnectionThreadPoolConfiguration, RmiLookupTimeout, RmiPortMaxValue, RmiPortMinValue, RmiRequestThreadPoolConfiguration, RmisPortMaxValue, RmisPortMinValue, SipContainer, StartJavaExecutionArguments, StopJavaExecutionArguments, SystemThreadPoolConfiguration

ManagedOc4jCluster

AdminPassword, AjpsEnabled, ManagedOc4js, OrmisEnabled

ManagedOc4jCluster.HealthMonitorProperties

No other unique properties exist

ManagementService

AutoSyncSaveListenerSleepIntervalInSeconds, AutoSyncSaveListenerTimeoutInSeconds, Database, DatabaseRetryIntervalList, ExportConfigurationEnabled, LocalFileSyncEnabled, LogLevel, LogSearchMaximumResults, LogSyncEnabled, LogUploadFilter, LogUploadInterval, ReadOnlyDBAccessEnabled, StabilityMonitorProperties, SystemDataCollectorProperties, UdsCacheDisabled, UploadLevel

ManagementService.StabilityMonitorProperties

StabilityMonitorEnabled

ManagementService.SystemDataCollectorProperties

CollectionInterval, CollectorEnabled, SystemDataFileRotationInterval, SystemDataFileRotationSize

MimService

AutoOfflineTimeAfterClientDisconnect, Database, DatabaseRetryIntervalList, LogLevel, MaxInvalidLoginAttempt, ReadOnlyDBAccessEnabled, UdsCacheDisabled, UnauthConnectionLiveTime

MobileDmService

Database, DatabaseRetryIntervalList, LogLevel, MaxClientConnections, MaxInvalidAttempts, ReadOnlyDBAccessEnabled, TtlAuthenticated, TtlUnauthenticated, UdsCacheDisabled

NamedSystemObject

Name

NotificationDeliveryService

ActionAskSettings, Database, DatabaseRetryIntervalList, DeliveryPoolSize, LogLevel, MaxDeliveryStatusAge, MaxTrackingAge, ReadOnlyDBAccessEnabled, SmsSettings, SystemUserName, UdsCacheDisabled, XmsSettings

NotificationDeliveryService.ActionAskSettings

ActionableEmailsNotificationDisabled, ActionableIMsNotificationDisabled, ActionableNotificationReplyDisabled, ActionableNotificationUser, ActionableSMSNotificationDisabled, ProcessingPoolSize, UserCacheSize

NotificationDeliveryService.SmsSettings

MaxSmsChunks, ShortCode, ShortCodeType, SmartMessageCharacterCount, SmsMode

NotificationDeliveryService.WebProxySettings

Enabled, ProxyHostName, ProxyPassword, ProxyPort, ProxyUserName

NotificationDeliveryService.XmsSettings

WebProxySettings, XmsPassword, XmsServiceUrl, XmsUserName

ObjectEventPublisherService

Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

Oc4j

AdminPassword, AdminUsername, Applications, Database, Oc4jName, PseudoTranslationEnabled, PseudoTranslationStrategy, ResourceAdapterInstances, RmiClientTimeout, RmiLookupTimeout

OmaService

CalendarSyncEnabled, ContactsSyncEnabled, Database, DatabaseRetryIntervalList, DbLogKeepDays, DeviceMetaDataCacheSize, DsSessionCacheSize, EmailNumberLimit, EmailSyncEnabled, EntitiesPerBulkLoad, EntitiesPerContactBulkLoad, EntitiesPerEmailBulkLoad, EntitiesPerEventBulkLoad, EntitiesPerNoteBulkLoad, EntitiesPerTaskBulkLoad, EventSyncRangeValidationThreshold, LogLevel, LogSyncmlForUsers, MaxConcurrentRequests, MaxConcurrentSessions, MaxConcurrentSlowSyncs, MaxMessageSize, MaxObjectSize, MaxSyncRangeBack, MaxSyncRangeForward, Md5Required, Md5Supported, NotesSyncEnabled, OmaDsEnabled, ReadOnlyDBAccessEnabled, ResumeEnabled, RetriesWhenDbUnavailableDelayInMilliSec, SessionLogRequired, SessionTimeOut, SyncmlLogRequired, TaskSyncRangeValidationThreshold, UdsCacheDisabled

OmsResourceAdapter

ResourceAdapterImage, ResourceAdapterInstances

OmsResourceAdapterInstance

ResourceAdapter

Opmn

BeehiveInstance, LocalPort, OpmnCluster, RemotePort, RequestPort

OpmnCluster

NotificationServerSslEnabled, Opmns

OwcStreamingService

Database, DatabaseRetryIntervalList, HttpTunnelingEnabled, HttpTunnelingPort, LogLevel, MaxHttpTunnelingClientsAllowed, MaxRtmpClientsAllowed, MaxRtspClientsAllowed, ReadOnlyDBAccessEnabled, RtmpEnabled, RtmpPort, RtspEnabled, RtspPort, ServiceName, UdsCacheDisabled

PolicyService

Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

PresenceService

ActivityStartTimeThreshold, CacheSize, Database, DatabaseRetryIntervalList, LogLevel, PollInterval, PublicPresenceEnabled, ReadOnlyDBAccessEnabled, UdsCacheDisabled

PushMailService

Database, DatabaseRetryIntervalList, HeartbeatInterval, IMAPConnLiveTime, LogLevel, MaxConcurrentUsers, MaxInboxMessages, MaxMessageSize, NumberDaysPast, ReadOnlyDBAccessEnabled, UdsCacheDisabled

PushService

APNSSettings, Database, DatabaseRetryIntervalList, LogLevel, MaxClientConnections, MaxInvalidAttempts, MaxTruePushClientConnections, ReadOnlyDBAccessEnabled, TtlUnauthenticated, UdsCacheDisabled

PushService.APNSSettings

APNSEnabled, APNSHostName, APNSKeyStoreContents, APNSPort, ProxyEnabled, ProxyHostName, ProxyPassword, ProxyPort, ProxyUserName

RecordsManagementService

Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled, Urm

RemoteContentService

Database, DatabaseRetryIntervalList, DiskSpoolDirectory, KeystoreAlias, KeystoreAliasPassword, KeystoreFile, KeystorePassword, LogLevel, MaxDiskSpoolSpace, ReadOnlyDBAccessEnabled, UCMConnectionTimeout, UCMDefaultSearchMaxResults, UCMMaxConnections, UdsCacheDisabled, WebDAVMaxConnPerHost, WebDAVMaxTotalConns

RemoteSite

No other unique properties exist

ResourceAdapter

ResourceAdapterImage, ResourceAdapterInstances

ResourceAdapterImage

RarFileName, ResourceAdapterInterface

ResourceAdapterInstance

ResourceAdapter

ResourceDirectoryService

AllResourcesReadableByAll, Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, SearchSizeLimit, UdsCacheDisabled

RmServletService

Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

SAMLIdentity

KeyAlias, Service

SearchService

AttachmentMimetypeBlackList, CaptureChanges, ChangeCaptureUserList, CrawlJobMaxNapTime, CrawlJobThreshold, Database, DatabaseRetryIntervalList, IndexFragmentationThreshold, IndexJobMaxNapTime, IndexJobThreshold, IndexOptimizationInterval, IndexOptimizationMaxTime, IndexOptimizationStartDate, LogLevel, MaxResults, MaxSnippetEntitySize, MdataOptimizationInterval, ParallelQueryDegree, ParallelQueryPoolSize, ReadOnlyDBAccessEnabled, SearchDisclaimerText, UdsCacheDisabled, WildcardChar

Server

AlternateHostNames, BeehiveInstances, PrimaryHostName, SipListenerIPAddress

Service

Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

SesEndptService

Database, DatabaseRetryIntervalList, Host, LogLevel, MaxNoUsersContainsOper, Port, ReadOnlyDBAccessEnabled, SesEndptServiceEnabled, SesTrustedEntityMap, UdsCacheDisabled

SipContainer

ManagedOc4j, SipEnabled, SipPortMaxValue, SipPortMinValue

SipGateway

GatewayIPAddress, GatewayPort, SipGatewayCluster

SipGatewayCluster

SipGateways

Site

BeehiveRootLogger, BtiGlobalConfiguration, BusinessDatabase, CipherKey, ClusteringEnabled, ConfigurationDatabase, Database, DatabaseRetryIntervalList, DiagnosabilitySettings, DiagnosticDatabase, EnterpriseId, Enterprises, EventListenerDatabase, HttpServerCluster, LanguagePack, LdapServer, ManagedOc4jCluster, Name, OpmnCluster, ReadOnlyBusinessDatabase, RemoteSites, ResourceAdapters, SearchDatabase, Servers, Services, SipGatewayCluster, SiteId, SsoKeyAlias, UnmanagedOc4js, VirtualServer, VirusScanEngineCluster

Site.DiagnosabilityProperties

No other unique properties exist

SmppDeliveryService

Database, DatabaseRetryIntervalList, LogLevel, MoSMSEnabled, ReadOnlyDBAccessEnabled, ShortCodeNumberPlanIndicator, SmppConnectionCount, SmppEnquireTime, SmppPassword, SmppProcessingThreadCount, SmppServiceUrl, SmppSystemID, SmppSystemType, SmppTimeOut, TlsEnabled, UdsCacheDisabled, UseQuerySMForStatus, VersionNumber

SoftwareImage

No other unique properties exist

StateManageable

No other unique properties exist

StatusManageable

No other unique properties exist

SubscriptionActionService

Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

SubscriptionService

Database, DatabaseRetryIntervalList, LogLevel, MaxAnchorAgeInDays, ReadOnlyDBAccessEnabled, UdsCacheDisabled

SyndicationService

Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

SyndicationServletService

AuthenticationScheme, Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

SystemObject

No other unique properties exist

SystemObjectWithHelper

No other unique properties exist

SystemObjectWithStats

No other unique properties exist

TCPCommBasedScanEngine

ScanEngineClientCommPort, ScanEngineHostName, VirusScanEngineCluster

TCPCommBasedScanEngineCluster

CacheRefreshInterval, GatherDetailedStats, OverrideEngineResultEnabled, ScanEngineCommProtocol, ScanEngineCommProtocolVer, ScanEngines, ScanServiceProvider, VirusScanPolicy, VirusesToIgnore

TeamCollaborationApisService

Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

TeamCollaborationService

AsyncThreadPoolSize, CSRFSecurityEnabled, Database, DatabaseRetryIntervalList, ExecutorServiceThreadPoolSize, HelpLink, LogLevel, MaxWkspLogoSize, MultiTypeListingBatchSize, ReadOnlyDBAccessEnabled, RichTextAntiSamyEnabled, RichTextAntiSamyPolicyFilePath, SearchResultsBatchSize, TacitEnabled, UdsCacheDisabled

TimeManagementService

ConsistencyTasksEnabled, Database, DatabaseRetryIntervalList, EnableCleanupTask, EnableDynamicParticipants, EnableExternalParticipantNotificationDelivery, EnableExternalParticipantNotificationsWithIMIP, EnableGenericClassOfTMBusinessEvents, EnablePresenceIntegration, LogLevel, MaxOccurrencesForUnboundedRecurrence, MaxOccurrencesPerSeries, MaxSubscriptionBizEventRaisedPerOperation, ReadOnlyDBAccessEnabled, SystemBusyPeriod, UdsCacheDisabled

TimeManagementService.AccessControlComputationTaskProperties

No other unique properties exist

TimeManagementService.ChangeLogsCleanupTaskProperties

CanRunDuringSystemBusyPeriod

TimeManagementService.ContainerSyncTaskProperties

No other unique properties exist

TimeManagementService.MethodMonitoringCleanupTaskProperties

CanRunDuringSystemBusyPeriod

TimeManagementService.PurgedItemsCleanupProperties

CanRunDuringSystemBusyPeriod

TimeManagementService.ResourceCleanupProperties

CanRunDuringSystemBusyPeriod

TimeManagementService.ResourceConsistencyProperties

CanRunDuringSystemBusyPeriod

TimeManagementService.StandardContextCleanupProperties

CanRunDuringSystemBusyPeriod

TimeManagementService.SystemBusyPeriod

Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday

TimeZoneService

Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

TimeZoneService.DatabaseConfiguration

No other unique properties exist

TranscodingService

ArchiveFolderPath, Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

UdsCache

UdsCacheDisabled

UdsCacheService

BatchInterval, BatchLoadSize, CacheEnabled, CacheInitEnabled, CacheUpdateEnabled, Database, DatabaseRetryIntervalList, LogLevel, MaxHeapPercent, MaxResultCount, PollingInterval, PollingLoopThreshold, ReadOnlyDBAccessEnabled, RetryPollingInterval, UdsCacheDisabled

UnmanagedBeehiveInstance

AvailableNumberOfProcessors, AvailablePhysicalMemoryInMB, BeehiveInstanceName, Bti, DiagnosabilitySettings, HttpServer, KeystoreFile, KeystoreFilePassword, LogBaseDir, Oc4jInstances, Opmn, OracleHome, Server, WalletDir, WalletPassword

UnmanagedOc4j

AdminPassword, AdminUsername, Applications, Database, HostName, Oc4jName, OpmnRequestPort, PseudoTranslationEnabled, PseudoTranslationStrategy, ResourceAdapterInstances, RmiClientTimeout, RmiLookupTimeout, RmiPort, WalletDir, WalletPassword

UnsupportedSystemObject

No other unique properties exist

Urm

AgentName, DispositionLoaderInterval, DispositionProcessorInterval, RMAdminPassword, RMAdminUser, RmAdminEmailId, URMAdapterURL

UserDirectoryService

ConfigurationParameters, CustomAttributes, Database, DatabaseRetryIntervalList, DirectoryProfiles, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

UserDirectoryService.AttributeMap

Fields

UserDirectoryService.ConfigurationParameters

DbRetryCount, DbRetryIntervalMilliSeconds, GalEntryAccessChecked, MaxEntityAddressCount, SuperMaxEntityAddressCount

UserDirectoryService.ConfigurationParameters.Attribute

No other unique properties exist

UserDirectoryService.CustomAttribute

Description, Name, Type

UserDirectoryService.DirectoryAttributeMap

DirectoryAttributeMap

UserDirectoryService.DirectoryCache

Enabled, MaxCachedEntities, RefreshIntervalMinutes

UserDirectoryService.DirectoryProfile

DefaultFlag, DirectoryAttributeMap, GroupTypeMap, ProfileState, ScopeMap, UserTypeMap

UserDirectoryService.FieldMap

BeehiveFieldName, BeehiveFieldSubType, BeehiveFieldType, SourceAttribute, SourceSpecialHandling, SourceToTargetFieldValueMapping

UserDirectoryService.FieldMap.SourceTargetValueMapping

SourceFieldValue, TargetFieldValue

UserDirectoryService.GroupTypeMapEntry

GroupType, SourceFieldName, SourceFieldType, SourceFieldValue

UserDirectoryService.LdapDirectoryProfile

DefaultFlag, DirectoryAttributeMap, GroupTypeMap, LdapServer, PollInterval, ProfileState, ScopeMap, UserTypeMap

UserDirectoryService.MembershipMapEntry

MembershipCollabId, Name, SourceFieldName, SourceFieldType, SourceFieldValue

UserDirectoryService.ScopeMapEntry

MembershipMap, Name, ScopeCollabId, SourceFieldName, SourceFieldType, SourceFieldValue

UserDirectoryService.UserTypeMapEntry

SourceFieldName, SourceFieldType, SourceFieldValue, UserType

VirtualServer

BtiClientPort, BtiSecureClientPort, FtpPort, HttpPort, HttpSslEnabled, HttpSslPort, IPAddress, ImapPort, ImapSslEnabled, ImapSslPort, MxTunnelHostname, MxTunnelPort, ServerName, SmtpAuthRequired, SmtpPort, SmtpSslEnabled, SmtpSslPort, XmppPort, XmppSslEnabled, XmppSslPort

VirusScanConfigurable

OverrideEngineResultEnabled, VirusScanPolicy, VirusesToIgnore

VirusScanEngine

VirusScanEngineCluster

VirusScanEngineCluster

CacheRefreshInterval, GatherDetailedStats, OverrideEngineResultEnabled, ScanEngineCommProtocol, ScanEngineCommProtocolVer, ScanEngines, ScanServiceProvider, VirusScanPolicy, VirusesToIgnore

VoiceMessageService

Database, DatabaseRetryIntervalList, DebugFlags, EmailResendingEnabled, FacilityProperties, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled, VoiceMessageProperty

VoiceMessageService.EnterpriseProperties

EnterpriseCollabId, ExclusiveAudioContentURIs, Name, RecordPlaybackURIs, RecordStreamURIs, SharedAudioContentURIs, TelephoneAnsweringAddress

VoiceMessageService.FacilityProperties

ExclusiveAudioContentURIs, FacilityCollabId, Name, RecordPlaybackURIs, RecordStreamURIs, SharedAudioContentURIs

VoiceServletService

Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

WebdavService

AuthenticationScheme, BrowserSessionTimeout, DMSInstrumentation, Database, DatabaseRetryIntervalList, DavClientSessionTimeout, DefaultWelcomeDocs, DepthLimit, DisplayLastModifiedBy, DisplayLastModifiedOn, DisplayLockStatus, DisplayVersioningStatus, DownloadBufferSize, LogLevel, MinimumLockTimeout, ReadOnlyDBAccessEnabled, UdsCacheDisabled, UploadBufferSize, UserPreferenceRefreshTime, WebDAVServerEnabled

WikiService

Database, DatabaseRetryIntervalList, LogLevel, PluginHtmlAntiSamyEnabled, PluginHtmlAntiSamyPolicyFilePath, PluginHtmlEnabled, ReadOnlyDBAccessEnabled, UdsCacheDisabled, WikiTextReplace

WorkspacesService

AllowContentHtmlScripts, BlockedFileExtensions, Database, DatabaseRetryIntervalList, DbDownloadBufferSize, DbUploadBufferSize, LogLevel, MaxRecentActivitiesPerGroup, MembershipNotificationEnabled, MinRecentActivitiesPerGroup, QuotaNotificationEnabled, QuotaOverflowPercentage, ReadOnlyDBAccessEnabled, RecentActivityDaysToLive, RecentActivityInPersonalWorkspaceEnabled, RecentActivityPurgeType, UdsCacheDisabled

XmppService

Database, DatabaseRetryIntervalList, DomainNames, Language, LogLevel, MessagesOnInvalidAction, ReadOnlyDBAccessEnabled, SearchFields, SupportedAgents, UdsCacheDisabled, VersionRules, XmppPort, XmppSslPort, XmppTimerKeepAliveTime

ZimbraConnectorService

Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

ZimbraUIService

Database, DatabaseRetryIntervalList, LogLevel, ReadOnlyDBAccessEnabled, UdsCacheDisabled

Common Properties

The following properties are common to all components:

Table 4-4 Common Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Alias

String

not applicable

May not start with an underscore ( _ )

Yes

No

Each SystemObject in the configuration has a Universally Unique Identifier (UUID) assigned by the system. An example UUID is f477dfe5-400d-41a2-b2a5-394ebba67293. You can assign an easier to remember Alias to a SystemObject and use the Alias in place of the UUID, for example, as the component identifier in beectl commands. Aliases must be unique, so you may not assign the same Alias to multiple SystemObjects. The validation performed on the proposed configuration at activation time ensures that no two SystemObjects have been assigned the same Alias. If duplicate Aliases are detected, the activation will fail and you must correct the situation before retrying the activation operation.

LightweightThreadCount

Integer

not applicable

Minimum = 0, maximum = 9223372036854775807

yes

No

Lightweight thread count for the service. A lightweight thread provides no guarantees on the thread context being used.

LoggingProperties

LoggingConfigurable.LoggingProperties (Structural property)

not applicable

No

No

Yes

A reference to a SystemObject that holds the property settings that configure logging behavior. You do not directly modify the value of this property. You configure logging behavior by modifying the properties of the referenced LoggingProperties object.

ServiceApplication

ApplicationImage (Structural property)

not applicable

No

No

Yes

The application image for the service. The application image models the EAR file that gets deployed to create service instances for the service.

ServiceInstances

Set<ServiceInstance> (Structural property)

not applicable

No

Yes

No

The list of ServicesInstances associated with the service.

Site

Site (Structural property)

not applicable

No

No

No

The site with which this service is associated.

Status

StatusManageable.Status (Legal values: ENABLED , DISABLED )

ENABLED

No

Yes

No

The Status, either ENABLED or DISABLED , of the current SystemObject. You do not directly modify the value of this property. The system manages the value of this property when you use an administration client such as beectl to enable and disable components of the deployment.

Common Properties for ServiceInstances

The following properties are common to all ServiceInstances:

Table 4-5 Common Properties for ServiceInstances

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

J2eeApplicationName

String

not applicable

No

No

No

J2EE application name.

LightweightThreadPriority

Integer

5

Minimum=1, Maximum=10

Yes

No

Priority of lightweight threads for the service.

Oc4j

String

not applicable

No

No

No

The Oc4j instance associated with the BeehiveJ2eeApplication.

Component Properties

This section lists the properties for each Oracle Beehive component. If a component has only common properties, the table of properties is omitted. Refer to "Common Properties", and "Common Properties for ServiceInstances", for details about common properties.

The tables listing properties for components have the following columns:

- Name: The property name

- Data Type: One of the following types:

- Integer: A whole number

- Int: A whole number

- String: Alphanumeric characters

- Boolean: True or false, used to enable or disable a feature

- Long: A whole number (allows larger values than Int or Integer)

- Structural Property: A special type, usually unique to the component, that can contain a string in a specified format

- SecureString: Alphanumeric characters, stored as an encrypted value

- File: A logical path to a file or directory

- List: A comma-delimited list of text values

- Map: A set of key:value pairs

- Level: Used for setting log levels; accepts one of a listed set of keywords

- <Component>.<Property> Legal Values (): A unique property which accepts one from a list of legal values. For example: AuthenticationService.AuthStoreType (Legal values: db, ldap)

- CollabID: An Oracle Beehive CollabID

- Default Value: If the property is seeded with a default value during installation of Oracle Beehive, that value is listed

- Accepted Values: If the range or set of values is constrained (beyond that allowed by its type), the constraint is shown

- Mutable: Mutable properties can change over time from one version of the configuration to the next. When Mutable is set to No, the value can only be changed when it belongs to a new configuration object created in the proposed configuration. Once the proposed configuration is activated, all immutable properties will never change again.

- Read Only: You can only use the beectl modify_property command to change the value of properties with Read Only set to No. You cannot use this command to modify properties with Read Only set to Yes.
Internal Oracle Beehive code can still modify Read Only properties.

- Description: A brief description of the property's function

AccessControlService

The following properties are available for AccessControlService:

Table 4-6 AccessControlService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

AlarmService

The following properties are available for AlarmService:

Table 4-7 AlarmService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

DefaultExpiryTime

Long

259200

All permitted values

Yes

No

The amount of time (in seconds) that will elapse by default before an alarm expires. Applies in cases where no expiry value is explicitly set when the alarm is created. Alarms are used internally by some Oracle Beehive services, which can explicitly set an expiry that will override this default value.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

ApplicationImage

The following properties are available for ApplicationImage:

Table 4-8 ApplicationImage Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

EarFileName

String

n/a

All permitted values

No

Yes

The file name of the enterprise archive (.ear) for a service or application image.

ServiceInterface

String

n/a

All permitted values

No

Yes

The name of the service's interface, which is used by the management model to cull service properties and statistics.

AuditService

The following properties are available for AuditService:

Table 4-9 AuditService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

LogonRecordDuration

int

480

Min=1, Max=6000

Yes

No

Specifies the logon record life time in minutes. Stale logon records are purged periodically by the purge process.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

RecordsPurgeEnabled

boolean

false

All permitted values

Yes

No

Specifies the whether the audit record purging enabled or disabled. If the purging is enabled , records get purged if they are older than retention period.

RecordsRetentionPeriod

int

60

Min=1, Max=2147483647

Yes

No

Specifies the audit record retention period in days. Audit record is guaranteed to stay in the system until the retention period. Audit records get purged after the retention period.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

AuthenticationService

The following properties are available for AuthenticationService:

Table 4-10 AuthenticationService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AuthStoreType

AuthenticationService.AuthStoreType (Legal values: db, ldap)

db

All permitted values

Yes

No

Specifies the authentication repository type. Valid values: db, ldap

AuthenticationPlugins

List<AuthenticationPlugin> (Structural property)

n/a

All permitted values

Yes

No

Authentication plugins for the external authentication, only one such plugin can be in enabled state.

AuthenticationRealm

String

Authorized_Users

All permitted values

Yes

No

Specifies the default authentication realm for Oracle Beehive.

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

JssoSessionTimeout

Integer

7200

All permitted values

Yes

No

SSO session timeout (in seconds) when the SSO Provider is JavaSSO. Note that this is a hard timeout, not an inactivity timeout. The session will timeout after this amount of time no matter what.

LockoutTime

Integer

7200

All permitted values

Yes

No

Specifies the duration (in seconds) that a user account will be locked out of the system if the maximum allowable login attempts is reached.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

LoginAttempts

Integer

-1

All permitted values

Yes

No

Specifies the number of failed login attempts allowed before a user account gets locked out of the system. -1 = No limit

OssoConfigFile

String

n/a

All permitted values

Yes

No

Specifies the configuration file for Oracle Single Sign-On (OSSO).

PostAuthClientInfoUpdatesDisabled

Boolean

false

All permitted values

Yes

No

Specifies whether updates to Client Session Information should be disabled or not after authentication. Valid values: true, false

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

S2SIdentities

String[]

n/a

All permitted values

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.AuthenticationServiceBundle, key DESC_LONG_S2S_IDENTITIES

SAMLRegistrationMap

Map<String,SAMLIdentity> (Structural property)

n/a

All permitted values

Yes

No

Specifies the SAML registration map, which contains trusted assertion issuers and service providers.

SsoLogoutUrl

String

n/a

All permitted values

Yes

No

Specifies the logout URL for single sign-on deployments. This is the URL to which users will be redirected after logging out of the system.

SsoType

AuthenticationService.SsoType (Legal values: jsso, osso)

jsso

All permitted values

Yes

No

Specifies the single sign-on type. Valid values: jsso, osso

TokenTimeout

Integer

300

All permitted values

Yes

No

Specifies the amount of time (in seconds) that an authentication token will remained timed out. 0 = Indefinitely

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

UseJazn

Boolean

false

All permitted values

Yes

No

Specifies whether or not Oracle Internet Directory should be configured natively with Oracle Application Server using Java Authorization (JAZN). If disabled, Oracle Internet Directory is configured as an external LDAP server (recommended). Valid values: true, false

UseSecureCookie

Boolean

false

All permitted values

Yes

No

Specifies whether or not the JavaSSO cookie should be sent over a Secure Socket Layer (SSL) connection. If enabled, JavaSSO is not supported over non-SSL connnections. Valid values: true, false

UseSecureHash

Boolean

false

All permitted values

Yes

No

Specifies whether or not the configured secure hash value (in the LDAP server) should be used for the digest authentication when the authentication repository is an LDAP server. If disabled, the password value is used to calculate the digest. Valid values: true, false

WsSecurityExpiry

Integer

3600

All permitted values

Yes

No

Specifies the amount of time (in seconds) that will elapse before inbound and outbound message signatures expire for Security Assertions Markup Language (SAML) Web services ports.

WsSecuritySamlEnabled

Boolean

false

All permitted values

Yes

No

Specifies whether or not Security Assertions Markup Language (SAML) authentication is enabled for Oracle Beehive Web services. Valid values: true, false

WsSecuritySigKeyAlias

String

n/a

All permitted values

Yes

No

Specifies the key alias of outbound message signatures for Security Assertions Markup Language (SAML) Web services ports.

WsSecuritySigKeyPwd

SecureString

n/a

All permitted values

Yes

No

Specifies the key password of outbound message signatures for Security Assertions Markup Language (SAML) Web services ports.

AuthenticationService.AuthenticationPlugin

The following properties are available for AuthenticationService.AuthenticationPlugin:

Table 4-11 AuthenticationService.AuthenticationPlugin Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AuthenticationType

AuthenticationService.AuthenticationPlugin.AuthenticationType (Legal values: FORM)

n/a

All permitted values

Yes

No

Authentication type of the plugin.

Enabled

Boolean

false

All permitted values

Yes

No

Status of the authentication plugin, specifies whether the plugin is enabled for authentication.

PluginProperties

Map<String,String>

n/a

All permitted values

Yes

No

Map of properties required by the authentication plugin.

QualifiedClassName

String

n/a

All permitted values

Yes

No

Package qualified class name of the authentication plugin implementation.

BdkService

The following properties are available for BdkService:

Table 4-12 BdkService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

RestProperties

BdkService.RestProperties

n/a

All permitted values

No

Yes

description bundle not set

SoapProperties

BdkService.SoapProperties

n/a

All permitted values

No

Yes

description bundle not set

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

BdkService.RestProperties

The following properties are available for BdkService.RestProperties:

Table 4-13 BdkService.RestProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

PrivateProperties

BdkService.RestProperties.PrivateProperties

n/a

All permitted values

No

Yes

description bundle not set

PublicProperties

BdkService.RestProperties.PublicProperties

n/a

All permitted values

No

Yes

description bundle not set

BdkService.RestProperties.PrivateProperties

The following properties are available for BdkService.RestProperties.PrivateProperties:

Table 4-14 BdkService.RestProperties.PrivateProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

NotificationQueuePollConcurrencyLimit

int

100

Min=1, Max=1000

Yes

No

description bundle not set

StreamBufferSize

int

8192

Min=1, Max=2147483647

Yes

No

description bundle not set

TempFileStore

String

../../beehive/restspool/temp

All permitted values

Yes

No

description bundle not set

BdkService.RestProperties.PublicProperties

The following properties are available for BdkService.RestProperties.PublicProperties:

Table 4-15 BdkService.RestProperties.PublicProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

DebugModeEnabled

boolean

true

All permitted values

Yes

No

description bundle not set

MaxBatchSize

int

100

Min=1, Max=2147483647

Yes

No

description bundle not set

NotificationQueuePollTimeout

int

2000

Min=10, Max=10000

Yes

No

description bundle not set

NotificationQueueSuspendThreshold

int

100

Min=10, Max=1000

Yes

No

description bundle not set

NotificationSessionTTL

int

60

Min=10, Max=1800

Yes

No

description bundle not set

PresenceConnectionsLimit

int

2

Min=0, Max=10

Yes

No

description bundle not set

BdkService.SoapProperties

The following properties are available for BdkService.SoapProperties:

Table 4-16 BdkService.SoapProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

DebugMode

boolean

false

All permitted values

Yes

No

description bundle not set

MaxRequestSize

int

102400

This property has a customized constraint.

Yes

No

description bundle not set

BeeCentralService

The following properties are available for BeeCentralService:

Table 4-17 BeeCentralService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

Dial8HintLocaleStrings

Map<String,String>

n/a

All permitted values

Yes

No

Customizable explanation that describes the correct phone number format for the voice mail transfer option.

EnableDownloadCenter

boolean

true

All permitted values

Yes

No

When set to TRUE, the Download Center is rendered in BeeCentral UI. When set to FALSE, the Download Center is hidden.

HelpLink

String

http://www.oracle.com/technology/products/beehive/beehive_users/2_0/central.htm

All permitted values

Yes

No

A configurable link to help text for Beehive clients.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

SmsOptInHintLocaleStrings

Map<String,String>

n/a

All permitted values

Yes

No

Customizable explanation about the delivery of SMS notifications to mobile devices.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

BeehiveConferencingService

The following properties are available for BeehiveConferencingService:

Table 4-18 BeehiveConferencingService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

ConfJavaDeployJavaURL

String

//www.java.com/js/deployJava.js

All permitted values

Yes

No

Parameter to set the deployJava.js URL to be used for launching javafx client. The default value for this parameter will be "//www.java.com/js/deployJava.js", which is fetched from the external java site. For intranet deplopyment of confctr, the value must be "DMS://deployJava.js", which will fetch the deployjava.js file from the internal package in DMS.

ConfJavaJNLP

String

confjavafx.jnlp.template

All permitted values

Yes

No

Parameter to set the jnlp template to be used for javafx. The default value for this parameter will be "confjavafx.jnlp.template". which has javafx runtime jars fetched from external java site. For intranet deplopyment of confctr, the value must be "confjavafx.intranet.jnlp.template", which will fetch the required runtime files from the internal package in DMS.

ConferenceClientDownloadLocationMac

String

n/a

All permitted values

Yes

No

Set the Conference Client download location for Macintosh. The default value for this parameter will be null. If it is null, then the URL for conference client will be fetched through Beehive Central.

ConferenceClientDownloadLocationWin

String

n/a

All permitted values

Yes

No

Set the Conference Client download location for Windows. The default value for this parameter will be null. If it is null, then the URL for conference client will be fetched through Beehive Central.

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

EnableDownloadCenter

boolean

true

All permitted values

Yes

No

When set to TRUE, the Download Center is rendered in WebConference UI. When set to FALSE, the Download Center is hidden.

HelpLink

String

http://www.oracle.com/technology/products/beehive/beehive_users/2_0/conferencing.htm

All permitted values

Yes

No

A configurable link to help text for Beehive clients.

JREDownloadURL

String

http://www.java.com

All permitted values

Yes

No

URL for downloading the Java Runtime Environment (JRE) required to launch the JavaFX client. Default URL http://www.java.com downloads the latest JRE.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

BeehiveInstance

The following properties are available for BeehiveInstance:

Table 4-19 BeehiveInstance Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AvailableNumberOfProcessors

int

1

This property has a customized constraint.

Yes

No

The number of processors committed for the current Oracle Beehive instance. This figure is used by the sizing algorithm to calculate the number of server and client Beehive Transport Infrastructure (BTI) workers, as well as the Oracle Containers for Java (OC4J) instances, required to support the current Oracle Beehive instance.

AvailablePhysicalMemoryInMB

Integer

n/a

This property has a customized constraint.

Yes

No

The amount of physical memory in megabytes (MBs) committed for the current Oracle Beehive instance. This figure is used by the sizing algorithm to calculate the number of Oracle Containers for Java (OC4J) instances required for the current Oracle Beehive instance.

BeehiveInstanceName

String

n/a

All permitted values

Yes

Yes

The name of the current Oracle Beehive instance.

Bti

Bti

n/a

All permitted values

Yes

No

The Oracle Beehive Transport Infrastructure (BTI) associated with the current Oracle Beehive instance.

DiagnosabilitySettings

DiagnosabilitySettings

n/a

All permitted values

Yes

No

A reference to a SystemObject that holds the properties used to configure diagnosability functionality. You do not directly modify the value of this property. You modify the properties of the referenced DiagnosabilitySettings object.

HttpServer

HttpServer

n/a

All permitted values

Yes

No

A reference to the HttpServer SystemObject for the current Oracle Beehive instance. You do not directly modify the value of this property. You configure the HTTP Server by modifying the properties of the referenced HttpServer object.

KeystoreFile

File

n/a

All permitted values

Yes

No

Path of the keystore file associated with the current Oracle Beehive instance.

KeystoreFilePassword

SecureString

n/a

All permitted values

Yes

No

Password for the keystore file associated with the current Oracle Beehive Instance.

LogBaseDir

File

beehive/logs

All permitted values

Yes

No

The base directory where Oracle Beehive will store its log files.

Oc4jInstances

Set<ManagedOc4j> (Structural property)

n/a

All permitted values

Yes

No

The set of references to the SystemObjects that configure the OC4J instances deployed in the current Oracle Beehive instance. The system automatically manages the value of this property. You must never directly modify the value.

Opmn

Opmn

n/a

All permitted values

No

No

This is a reference to the SystemObject that configures OPMN for the current Oracle Beehive instance. The system automatically manages the value of this property. You must never directly modify the value.

OracleHome

String

n/a

All permitted values

No

Yes

The Oracle home for the current Oracle Beehive instance.

Server

Server

n/a

All permitted values

No

No

This is a reference to the SystemObject that represents the Server associated with the current Oracle Beehive instance. The system automatically manages the value of this property.

WalletDir

String

n/a

All permitted values

Yes

No

Directory path of the Oracle Wallet associated with the current Oracle Beehive instance.

WalletPassword

SecureString

n/a

All permitted values

Yes

No

The password for the Oracle Wallet associated with the current Oracle Beehive instance.

BeehiveJ2eeApplication

No other properties exist for BeehiveJ2eeApplication .

BeekeeperService

The following properties are available for BeekeeperService:

Table 4-20 BeekeeperService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalLis

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

Bti

The following properties are available for Bti:

Table 4-21 Bti Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

BeehiveInstance

BeehiveInstance

n/a

All permitted values

Yes

No

long description key not set

BtiProcessPingTimeout

int

60

All permitted values

Yes

No

Timeout for pings between btimon and BTI native processes. When this timeout is exceeded the native BTI processes is restarted.

ClientWorker

BtiClientWorker

n/a

All permitted values

No

No

long description key not set

CtrlPort

int

5959

Network Port, Min=1, Max=65536

Yes

No

TCP port for internal communications between components of BTI. This port is also used by opmn for pinging BTI.

LogDir

String

n/a

All permitted values

Yes

No

Log directory for all BTI components

Redirector

BtiRedirector

n/a

All permitted values

No

No

long description key not set

ServerPort

int

n/a

Network Port, Min=1, Max=65536

Yes

No

TCP port for communications between midtiers via OMB.

ServerWorker

BtiServerWorker

n/a

All permitted values

No

No

long description key not set

StartJavaExecutionArguments

JavaExecutionArguments

n/a

All permitted values

Yes

No

Arguments for the Java Virtual Machine when starting this component

StopJavaExecutionArguments

JavaExecutionArguments

n/a

All permitted values

Yes

No

Arguments for the Java Virtual Machine when starting this component

BtiClientWorker

The following properties are available for BtiClientWorker:

Table 4-22 BtiClientWorker Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AdditionalExecArgs

String[]

n/a

All permitted values

Yes

No

Additional command line arguments to be passed to the BTI native process.

Bti

Bti

n/a

All permitted values

Yes

No

long description key not set

NumberOfWorkers

int

1

All permitted values

Yes

No

Number of MX processes in each BTI instance (midtier or DMZ).

BtiComponent

The following properties are available for BtiComponent:

Table 4-23 BtiComponent Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AdditionalExecArgs

String[]

n/a

All permitted values

Yes

No

Additional command line arguments to be passed to the BTI native process.

BtiGlobal

The following properties are available for BtiGlobal:

Table 4-24 BtiGlobal Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

BackendSecurityMode

BtiGlobal.SecurityMode (Legal values: NONE, AUTH_ONLY, AUTH_AND_ENCRYPT)

NONE

All permitted values

Yes

No

description bundle not set

ClientPort

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

description bundle not set

SecureClientPort

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

description bundle not set

BtiRedirector

The following properties are available for BtiRedirector:

Table 4-25 BtiRedirector Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AdditionalExecArgs

String[]

n/a

All permitted values

Yes

No

Additional command line arguments to be passed to the BTI native process.

Bti

Bti

n/a

All permitted values

Yes

No

description bundle not set

BtiServerWorker

The following properties are available for BtiServerWorker:

Table 4-26 BtiServerWorker Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AdditionalExecArgs

String[]

n/a

All permitted values

Yes

No

Additional command line arguments to be passed to the BTI native process.

Bti

Bti

n/a

All permitted values

Yes

No

long description key not set

NumberOfWorkers

int

1

All permitted values

Yes

No

Number of BP processes in each midtier.

CalDAVService

The following properties are available for CalDAVService:

Table 4-27 CalDAVService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

CollectionBrowsingEnabled

Boolean

true

All permitted values

Yes

No

Enables or disables the Oracle Beehive CalDAV Companion Web Access interface. If disabled, trying to access a CalDAV URL in a Web browser will return an error.

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

DefaultFutureTimePeriodInDay

Long

124

Min=0, Max=10950

Yes

No

The upper limit (in days) of the range for which date-based entities will be returned by Oracle Beehive if no range is explicitly provided by a CalDAV client. This value is represented as a positive integer. Oracle Beehive uses this value to determine whether or not to return certain date-based entities. For example, if this value is set to 30 and no time range is supplied by a CalDAV client, Oracle Beehive will return all date-based entities, such as meetings and tasks, that occur between today and the next 30 days. In this example, entities that occur on the 31st day from today and beyond will not be returned.

DefaultPastTimePeriodInDay

Long

31

Min=0, Max=10950

Yes

No

The lower limit (in days) of the range for which date-based entities will be returned by Oracle Beehive if no range is explicitly provided by a CalDAV client. This value is represented as a negative integer. Oracle Beehive uses this value to determine whether or not to return certain date-based entities. For example, if this value is set to -30 and no time range is supplied by a CalDAV client, Oracle Beehive will return all date-based entities, such as meetings and tasks, that occurred in the the previous 30 days only. In this example, entities that occurred on the 31st day prior to today and earlier will not be returned.

ISchedule

CalDAVService.ISchedule

n/a

All permitted values

No

No

The iSchedule service can be confifured using all the properties defined in this system object.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

CalDAVService.ISchedule

The following properties are available for CalDAVService.ISchedule:

Table 4-28 CalDAVService.ISchedule Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Enabled

Boolean

true

All permitted values

Yes

No

Enables or disables the Oracle Beehive iSchedule service.

NoProxyFor

List<String>

n/a

All permitted values

Yes

No

Specifies the list of hosts and ip addresses for which the proxy should not be used. Each entry can be either a complete host name (e.g. "www.oracle.com"), a domain name beginning with a dot (e.g. ".oracle.com"), an IP address (e.g. "12.34.56.78"), an IP subnet, specified as an IP address and a netmask separated by a "/" (e.g. "34.56.78/255.255.255.192").

ProxyAuthId

String

n/a

All permitted values

Yes

No

Specifies the authentication name to use if the proxy requires authentication.

ProxyAuthKey

SecureString

n/a

All permitted values

Yes

No

Specifies the key to use if the proxy requires authentication.

ProxyHost

String

n/a

All permitted values

Yes

No

Specifies a proxy hostname to use when the iSchedule service connects to remote iSchedule receivers.

ProxyPort

Integer

80

All permitted values

Yes

No

Specifies a proxy port to use when the iSchedule service connects to remote iSchedule receivers.

ProxyType

CalDAVService.ISchedule.IScheduleProxyType (Legal values: HTTP, SOCKS4, SOCKS5)

HTTP

All permitted values

Yes

No

Specifies the iSchedule proxy type, can be either HTTP, SOCKS4 or SOCKS5.

Servers

List<Server> (Structural property)

n/a

This property has a customized constraint.

Yes

No

Specifies the list of configured remote iSchedule servers

CalDAVService.ISchedule.Server

The following properties are available for CalDAVService.ISchedule.Server:

Table 4-29 CalDAVService.ISchedule.Server Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

DomainRegexp

String

n/a

This property has a customized constraint.

Yes

No

The iSchedule server domain regular expression is used for associating external email addresses to this iSchedule server configuration.

IncomingAllowHostRegexp

String

n/a

This property has a customized constraint.

Yes

No

Regular expression of allowed host names. Remote servers not matching this regular expression will not be able to send requests to the local server.

ncomingAllowIPRegexp

String

n/a

This property has a customized constraint.

Yes

No

Regular expression of allowed IP addresses. Remote servers not matching this regular expression will not be able to send requests to the local server.

IncomingAuthId

String

n/a

This property has a customized constraint.

Yes

No

Specifies the name the remote server should use. If the remote server does not specify the good name, all requests sent from this remote server will be denied

IncomingAuthKey

SecureString

n/a

All permitted values

Yes

No

Specifies the key the remote server should use. If the remote server does not specify the good key, all requests sent from this remote server will be denied

IncomingAuthMethod

CalDAVService.ISchedule.Server.AuthMethod (Legal values: HTTP_BASIC)

HTTP_BASIC

All permitted values

Yes

No

Authentication method to use for incoming remote server requests.

Name

String

n/a

This property has a customized constraint.

No

No

The iSchedule server name is used to uniquely identify an iSchedule server configuration.

OutgoingAuthId

String

n/a

This property has a customized constraint.

Yes

No

Specifies the name to use when authenticating to the remote server.

OutgoingAuthKey

SecureString

n/a

All permitted values

Yes

No

Specifies key to use when authenticating to the remote server.

OutgoingUrl

String

n/a

This property has a customized constraint.

Yes

No

The iSchedule server outgoing URL is used to specify the remote iSchedule receiver URL for this iSchedule server configuration.

ClientManagementService

The following properties are available for ClientManagementService:

Table 4-30 ClientManagementService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

DebugMode

boolean

false

All permitted values

Yes

No

description bundle not set

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

NotificationQueueResumeThreshold

int

50

This property has a customized constraint.

Yes

No

description bundle not set

NotificationQueueSuspendThreshold

int

100

This property has a customized constraint.

Yes

No

description bundle not set

OutputFrameSize

int

32768

Min=1, Max=65535

Yes

No

description bundle not set

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

SessionTimeout

int

30000

This property has a customized constraint.

Yes

No

description bundle not set

StreamReadBufferSize

int

131072

This property has a customized constraint.

Yes

No

description bundle not set

StreamWriteBufferSize

int

131072

This property has a customized constraint.

Yes

No

description bundle not set

TraceEnabled

boolean

false

All permitted values

Yes

No

description bundle not set

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

CoexistenceService

The following properties are available for CoexistenceService:

Table 4-31 CoexistenceService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

CoexistenceEnabled

boolean

true

All permitted values

Yes

No

Enables or disables the Coexistence Service. If enabled and a coexistence connector is configured, the Coexistence Service will send and receive requests to and from the coexistence connector.

ConnectorProperties

CoexistenceService.ConnectorProperties

n/a

All permitted values

No

No

Properties that are specific to the Oracle Coexistence Connector. This is a subcomponent.

ContactProperties

CoexistenceService.ContactProperties

n/a

All permitted values

No

No

Properties that are specific to contacts in coexistence deployments. This is a subcomponent.

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

FreeBusyProperties

CoexistenceService.FreeBusyProperties

n/a

All permitted values

No

No

Properties that are specific to free/busy time in coexistence deployments. This is a subcomponent.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MeetingProperties

CoexistenceService.MeetingProperties

n/a

All permitted values

No

No

Properties that are specific to meetings in coexistence deployments. This is a subcomponent.

MessageProperties

CoexistenceService.MessageProperties

n/a

All permitted values

No

No

Properties that are specific to e-mail messages in coexistence deployments. This is a subcomponent.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

RequestSenderEnabled

boolean

true

All permitted values

Yes

No

Enables or disables the request sender. If disabled, the Coexistence Service will not send any requests to the connector but will still process incoming requests. Propagation of changes also requires the CoexistenceEnabled property to be enabled. When disabled, the Coexistence Service will only process requests sent by the coexistence connector.

TaskProperties

CoexistenceService.TaskProperties

n/a

All permitted values

No

No

Properties that are specific to tasks in coexistence deployments. This is a subcomponent.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

CoexistenceService.ClusteredTaskProperties

No other properties exist for CoexistenceService.ClusteredTaskProperties .

CoexistenceService.ConnectorProperties

The following properties are available for CoexistenceService.ConnectorProperties:

Table 4-32 CoexistenceService.ConnectorProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

SmtpServerHostName

String

n/a

All permitted values

Yes

No

Specifies the SMTP server host name used by the Oracle Coexistence Connector. If this property is not set, the virtual server name will be used.

SmtpServerPort

int

25

This property has a customized constraint.

Yes

No

Specifies the SMTP server port used by the Oracle Coexistence Connector. If this property is not set, the virtual server port will be used.

CoexistenceService.ContactProperties

The following properties are available for CoexistenceService.ContactProperties:

Table 4-33 CoexistenceService.ContactProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AttachmentMaxSizeInKiloByte

int

2048

This property has a customized constraint.

Yes

No

The maximum size allowed (in kilobytes) of an attachment. If an attachment is larger than this size, the attachment is ignored by the coexistence solution. Increasing this value can cause scalability issues in some flows. It is not recommended to increase this value above 10240. The recommended value is 2048.

CoexistenceService.ContainerSpecificProperties

The following properties are available for CoexistenceService.ContainerSpecificProperties:

Table 4-34 CoexistenceService.ContainerSpecificProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AttachmentMaxSizeInKiloByte

int

2048

This property has a customized constraint.

Yes

No

The maximum size allowed (in kilobytes) of an attachment. If an attachment is larger than this size, the attachment is ignored by the coexistence solution. Increasing this value can cause scalability issues in some flows. It is not recommended to increase this value above 10240. The recommended value is 2048.

CoexistenceService.DominoProperties

The following properties are available for CoexistenceService.DominoProperties:

Table 4-35 CoexistenceService.DominoProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

SmtpServerHostName

String

n/a

All permitted values

Yes

No

Specifies the SMTP server host name used by the Oracle Coexistence Connector. If this property is not set, the virtual server name will be used.

SmtpServerPort

int

25

This property has a customized constraint.

Yes

No

Specifies the SMTP server port used by the Oracle Coexistence Connector. If this property is not set, the virtual server port will be used.

CoexistenceService.ExchangeProperties

The following properties are available for CoexistenceService.ExchangeProperties:

Table 4-36 CoexistenceService.ExchangeProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

SmtpServerHostName

String

n/a

All permitted values

Yes

No

Specifies the SMTP server host name used by the Oracle Coexistence Connector. If this property is not set, the virtual server name will be used.

SmtpServerPort

int

25

This property has a customized constraint.

Yes

No

Specifies the SMTP server port used by the Oracle Coexistence Connector. If this property is not set, the virtual server port will be used.

CoexistenceService.ExpertiseProfilingProperties

The following properties are available for CoexistenceService.ExpertiseProfilingProperties:

Table 4-37 CoexistenceService.ExpertiseProfilingProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AttachmentMaxSizeInKiloByte

int

2048

This property has a customized constraint.

Yes

No

The maximum size allowed (in kilobytes) of an attachment for expertise profiling. If an attachment is larger than this size, the attachment is ignored by the coexistence solution.

CoexistenceService.FreeBusyProperties

The following properties are available for CoexistenceService.FreeBusyProperties:

Table 4-38 CoexistenceService.FreeBusyProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

FutureTimePeriodInDay

int

120

This property has a customized constraint.

Yes

No

Specifies the upper limit (in days from today) of the range Oracle Beehive will use to publish free/busy information of coexisting users. This value can be any positive integer. For example, if this value is set to 60, Oracle Beehive will publish all free/busy information that occurs from the time of the request and for the following 60 days. This property is used in conjunction with PastTimePeriodInDay, which specifies the lower limit (in days) of the range for publishing free/busy information.

PastTimePeriodInDay

int

7

This property has a customized constraint.

Yes

No

Specifies the lower limit (in days from today) of the range Oracle Beehive will use to publish free/busy information of coexisting Oracle Beehive users. This value can be any positive integer. For example, if this value is set to 30, Oracle Beehive will publish all free/busy information that occurs from the time of the request and for the previous 30 days. This property is used in conjunction with FutureTimePeriodInDay, which specifies the upper limit (in days) of the range for publishing free/busy information.

CoexistenceService.InstanceTaskProperties

No other properties exist for CoexistenceService.InstanceTaskProperties .

CoexistenceService.MeetingProperties

The following properties are available for CoexistenceService.MeetingProperties:

Table 4-39 CoexistenceService.MeetingProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AttachmentMaxSizeInKiloByte

int

2048

This property has a customized constraint.

Yes

No

The maximum size allowed (in kilobytes) of an attachment. If an attachment is larger than this size, the attachment is ignored by the coexistence solution. Increasing this value can cause scalability issues in some flows. It is not recommended to increase this value above 10240. The recommended value is 2048.

ImportDataFutureTimePeriodInDay

int

-1

All permitted values

Yes

No

Specifies the upper limit (in days from today) of the range Oracle Beehive will use to request an initial import of meeting data from the Oracle Coexistence Connector. This value can be any positive integer or -1, which is used to specify that there is no upper limit. For example, if this value is set to 60, Oracle Beehive will import all meeting data that occurs from the time of the import and for the following 60 days. This property is used in conjunction with ImportDataPastTimePeriodInDay, which specifies the lower limit (in days) of the range for importing meeting data.

ImportDataPastTimePeriodInDay

int

30

All permitted values

Yes

No

Specifies the lower limit (in days from today) of the range Oracle Beehive will use to request an initial import of meeting data from the Oracle Coexistence Connector. This value can be any positive integer or -1, which is used to specify that there is no lower limit. For example, if this value is set to 30, Oracle Beehive will import all meeting data that occurs from the time of the request and for the previous 30 days. This property is used in conjunction with ImportDataFutureTimePeriodInDay, which specifies the upper limit (in days) of the range for importing meeting data.

CoexistenceService.MessageProperties

The following properties are available for CoexistenceService.MessageProperties:

Table 4-40 CoexistenceService.MessageProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AttachmentMaxSizeInKiloByte

int

2048

This property has a customized constraint.

Yes

No

The maximum size allowed (in kilobytes) of an attachment. If an attachment is larger than this size, the attachment is ignored by the coexistence solution. Increasing this value can cause scalability issues in some flows. It is not recommended to increase this value above 10240. The recommended value is 2048.

ImportDataFutureTimePeriodInDay

int

-1

All permitted values

Yes

No

Specifies the upper limit (in days from today) of the range Oracle Beehive will use to request an initial import of e-mail data from the Oracle Coexistence Connector. This value can be any positive integer or -1, which is used to specify that there is no upper limit. For example, if this value is set to 60, Oracle Beehive will import all e-mail data that occurs from the time of the import and for the following 60 days. This property is used in conjunction with ImportDataPastTimePeriodInDay, which specifies the lower limit (in days) of the range for importing e-mail data.

ImportDataPastTimePeriodInDay

int

30

All permitted values

Yes

No

Specifies the lower limit (in days from today) of the range Oracle Beehive will use to request an initial import of e-mail data from the Oracle Coexistence Connector. This value can be any positive integer or -1, which is used to specify that there is no lower limit. For example, if this value is set to 30, Oracle Beehive will import all e-mail data that occurs from the time of the request and for the previous 30 days. This property is used in conjunction with ImportDataFutureTimePeriodInDay, which specifies the upper limit (in days) of the range for importing e-mail data.

CoexistenceService.ServiceManagerProperties

No other properties exist for CoexistenceService.ServiceManagerProperties .

CoexistenceService.TaskProperties

The following properties are available for CoexistenceService.TaskProperties:

Table 4-41 CoexistenceService.TaskProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AttachmentMaxSizeInKiloByte

int

2048

This property has a customized constraint.

Yes

No

The maximum size allowed (in kilobytes) of an attachment. If an attachment is larger than this size, the attachment is ignored by the coexistence solution. Increasing this value can cause scalability issues in some flows. It is not recommended to increase this value above 10240. The recommended value is 2048.

ImportDataFutureTimePeriodInDay

int

-1

All permitted values

Yes

No

Specifies the upper limit (in days from today) of the range Oracle Beehive will use to request an initial import of task data from the Oracle Coexistence Connector. This value can be any positive integer or -1, which is used to specify that there is no upper limit. For example, if this value is set to 60, Oracle Beehive will import all active task data from the time of the import and for the following 60 days. This property is used in conjunction with ImportDataPastTimePeriodInDay, which specifies the lower limit (in days) of the range for importing task data.

ImportDataPastTimePeriodInDay

int

30

All permitted values

Yes

No

Specifies the lower limit (in days from today) of the range Oracle Beehive will use to request an initial import of task data from the Oracle Coexistence Connector. This value can be any positive integer or -1, which is used to specify that there is no lower limit. For example, if this value is set to 30, Oracle Beehive will import all active task data from the time of the request and for the previous 30 days. This property is used in conjunction with ImportDataFutureTimePeriodInDay, which specifies the upper limit (in days) of the range for importing task data.

CompositeStateManageable

No other properties exist for CompositeStateManageable .

ConferenceMonitoringService

The following properties are available for ConferenceMonitoringService:

Table 4-42 ConferenceMonitoringService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

ClientConnectInfo

String

n/a

All permitted values

Yes

Yes

description bundle not set

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

ConferenceService

The following properties are available for ConferenceService:

Table 4-43 ConferenceService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

DefaultDialoutCallTimeout

Integer

3600000

All permitted values

No

No

description bundle not set

DefaultParticipantCodec

String

audio/IP-MR-VBR

All permitted values

Yes

No

description bundle not set

DefaultSipRegistrationExpiresInterval

Integer

3600

All permitted values

No

No

description bundle not set

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

OwcHostWaitSessionTimeout

Integer

1800000

All permitted values

No

No

description bundle not set

OwcLogFlushPeriod

Integer

30000

All permitted values

Yes

No

description bundle not set

OwcMediaHostServiceBusAddressPrefix

String

owc-ms-host-service

All permitted values

Yes

No

description bundle not set

OwcMediaHostServiceLoadBalanceBusAddressSuffix

String

balance

All permitted values

Yes

No

description bundle not set

OwcRosterServiceBusAddressPrefix

String

owc-roster-service

All permitted values

Yes

No

description bundle not set

OwcRosterServiceLoadBalanceBusAddressSuffix

String

balance

All permitted values

Yes

No

description bundle not set

OwcUseRemoteMediaSessions

Boolean

false

All permitted values

Yes

No

description bundle not set

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

SIPPSTNGatewayIPAddres

String

n/a

All permitted values

Yes

No

description bundle not set

SIPPSTNGatewayPort

Integer

5060

Network Port, Min=1, Max=65536

Yes

No

description bundle not set

SipRegistrationEnabled

Boolean

false

All permitted values

Yes

No

description bundle not set

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

ConferenceSessionService

The following properties are available for ConferenceSessionService:

Table 4-44 ConferenceSessionService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

ConnectionPoolConsumer

No other properties exist for ConnectionPoolConsumer .

CustomService

The following properties are available for CustomService:

Table 4-45 CustomService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

Database

The following properties are available for Database:

Table 4-46 Database Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AccessSchemas

List<AccessSchema> (Structural property)

n/a

All permitted values

Yes

No

The database access Schemas.

AffinityPool

Database.AffinityPool

n/a

All permitted values

Yes

Yes

The affinity ConnectionPool.

AffinityServiceNames

List<String>

n/a

All permitted values

Yes

No

The list of services that require database affinity.

BusinessDataServiceName

String

n/a

All permitted values

Yes

No

The database name for business data service.

ConfigServiceName

String

n/a

All permitted values

Yes

No

The database name for configuration store.

ConnectDescriptor

String

n/a

All permitted values

Yes

No

The connect descriptor for the database.

DefaultAccessSchema

Database.AccessSchema

n/a

All permitted values

Yes

Yes

The database access Schema.

DefaultNonXaPool

Database.ConnectionPool

n/a

All permitted values

Yes

Yes

The default non-XA connectionPool.

DefaultXaPool

Database.ConnectionPool

n/a

All permitted values

Yes

Yes

The default XA connectionPool.

DiagnosabilityServiceName

String

n/a

All permitted values

Yes

No

The database name for diagnosibility service.

EventListenerServiceName

String

n/a

All permitted values

Yes

No

The database name for event listener service.

OnsNodeConfiguration

List<String>

n/a

All permitted values

Yes

No

The list of ONS node configuration.

ParentDatabase

Database

n/a

All permitted values

No

Yes

long description key not set

ReadOnlyBusinessDataServiceName

String

n/a

All permitted values

Yes

No

The database name for read-only business data service.

SearchServiceName

String

n/a

All permitted values

Yes

No

The database name for search service.

Database.AccessSchema

The following properties are available for Database.AccessSchema:

Table 4-47 Database.AccessSchema Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

BusinessDataSupported

boolean

false

All permitted values

Yes

No

If business data is supported.

ConfigDataSupported

boolean

false

All permitted values

Yes

No

If configuration data is supported.

DiagnosticDataSupported

boolean

false

All permitted values

Yes

No

If Diagnostic data is supported.

EventListenerDataSupported

boolean

false

All permitted values

Yes

No

If event data is supported.

Password

SecureString

n/a

All permitted values

Yes

No

The password of the access schema.

ReadOnlyBusinessDataBaseSupported

boolean

false

All permitted values

Yes

No

If read only DB is supported.

SearchDataSupported

boolean

false

All permitted values

Yes

No

If search data is supported.

UserDataSupported

boolean

false

All permitted values

Yes

No

If user data is supported.

UserName

String

BEE_CODE

All permitted values

Yes

No

The username of the access schema.

Database.AffinityPool

The following properties are available for Database.AffinityPool:

Table 4-48 Database.AffinityPool Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AbandonedConnectionTimeout

int

0

Min=0, Max=2147483647

Yes

No

The timeout for abandoned connection.

ConnectTimeout

int

10000

Min=1, Max=2147483647

Yes

No

The limit of the maximum retry attempt.

ConnectionProperties

Map<String,String>

n/a

All permitted values

Yes

No

Time out for establishing a DB Connection.

ConnectionWaitTimeout

int

300

Min=0, Max=2147483647

Yes

No

The timeout for connection wait.

InactivityTimeout

int

0

Min=0, Max=2147483647

Yes

No

The timeout for inactive connection.

InitialConnections

int

0

Min=0, Max=2147483647

Yes

No

The initial connection count of this connection pool.

LowerThresholdLimit

int

20

Min=0, Max=100

Yes

No

The limit of LowerThreshold.

MaxConnections

int

20

Min=0, Max=2147483647

Yes

No

The maximum connection count of this connection pool.

MaxRetryAttemptLimit

int

3

Min=0, Max=2147483647

Yes

No

The limit of the maximum retry attempt.

MaxRetryTimeLimit

int

30000

Min=0, Max=2147483647

Yes

No

The limit of the maximum retry time.

MaxStatementsLimit

int

0

Min=0, Max=2147483647

Yes

No

The maxium statement count of this connection pool.

MinConnections

int

0

Min=0, Max=2147483647

Yes

No

The minimum connection count of this connection pool.

PropertyCheckInterval

int

900

Min=1, Max=2147483647

Yes

No

The interval to check property.

ReadTimeout

int

300000

Min=1, Max=2147483647

Yes

No

Time out for Read operation.

ServiceStatusCheckInterval

int

60

Min=1, Max=2147483647

Yes

No

Time interval (in seconds) between two consecutive affinity service status checks.

StatusChangeErrorThreshold

int

30

Min=1, Max=2147483647

Yes

No

While fetching the DB Connections, Number of consecutive SQLException exception tolerate before updating the affinity service status as down.

TimeToLiveTimeout

int

0

Min=0, Max=2147483647

Yes

No

The timeout for timeToLive.

ValidateConnection

boolean

false

All permitted values

Yes

No

If the connectionPool needs to validate a connection.

Database.ConnectionPool

The following properties are available for Database.ConnectionPool:

Table 4-49 Database.ConnectionPool Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AbandonedConnectionTimeout

int

0

Min=0, Max=2147483647

Yes

No

The timeout for abandoned connection.

ConnectTimeout

int

10000

Min=1, Max=2147483647

Yes

No

The limit of the maximum retry attempt.

ConnectionProperties

Map<String,String>

n/a

All permitted values

Yes

No

Time out for establishing a DB Connection.

ConnectionWaitTimeout

int

300

Min=0, Max=2147483647

Yes

No

The timeout for connection wait.

InactivityTimeout

int

0

Min=0, Max=2147483647

Yes

No

The timeout for inactive connection.

InitialConnections

int

0

Min=0, Max=2147483647

Yes

No

The initial connection count of this connection pool.

LowerThresholdLimit

int

20

Min=0, Max=100

Yes

No

The limit of LowerThreshold.

MaxConnections

int

20

Min=0, Max=2147483647

Yes

No

The maximum connection count of this connection pool.

MaxRetryAttemptLimit

int

3

Min=0, Max=2147483647

Yes

No

The limit of the maximum retry attempt.

MaxRetryTimeLimit

int

30000

Min=0, Max=2147483647

Yes

No

The limit of the maximum retry time.

MaxStatementsLimit

int

0

Min=0, Max=2147483647

Yes

No

The maxium statement count of this connection pool.

MinConnections

int

0

Min=0, Max=2147483647

Yes

No

The minimum connection count of this connection pool.

PropertyCheckInterval

int

900

Min=1, Max=2147483647

Yes

No

The interval to check property.

ReadTimeout

int

300000

Min=1, Max=2147483647

Yes

No

Time out for Read operation.

TimeToLiveTimeout

int

0

Min=0, Max=2147483647

Yes

No

The timeout for timeToLive.

ValidateConnection

boolean

false

All permitted values

Yes

No

If the connectionPool needs to validate a connection.

DeletedSystemObject

No other properties exist for DeletedSystemObject .

DeviceManagementService

The following properties are available for DeviceManagementService:

Table 4-50 DeviceManagementService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

BlockedDevices

Collection<BlockedDevice> (Structural property)

n/a

All permitted values

Yes

No

The list of devices that will not be allowed to access Oracle Beehive services.

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

UncertifiedDeviceAllowed

Boolean

false

All permitted values

Yes

No

Whether or not Oracle Beehive will allow uncertified devices to access the system.

DeviceManagementService.BlockedDevice

The following properties are available for DeviceManagementService.BlockedDevice:

Table 4-51 DeviceManagementService.BlockedDevice Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Description

String

n/a

All permitted values

Yes

No

Description as to why this device is blocked.

DeviceId

String

n/a

All permitted values

Yes

No

A unique identifier of the device.

DiagnosabilitySettings

The following properties are available for DiagnosabilitySettings:

Table 4-52 DiagnosabilitySettings Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

BaseErrorCodeProperties

DiagnosabilitySettings.ErrorCodeProperties

n/a

All permitted values

Yes

Yes

The default properties used by Error Code DB Persistence and Error Code log records

ContextProperties

DiagnosabilitySettings.ContextProperties

n/a

All permitted values

Yes

Yes

Subobject with properties for the Diagnosability Context

ErrorCodeDBPersistenceEnabled

Boolean

false

All permitted values

Yes

No

When enabled, some error code occurrences will be persisted to the database, based on the the values of the sub-objects BaseErrorCodeProperties and ErrorCodeDBProperties.

ErrorCodeDBProperties

DiagnosabilitySettings.ErrorCodeProperties

n/a

All permitted values

Yes

No

If exists, this object overrides the values in BaseErrorCodeProperties for Error Code Database persistence.

ErrorCodeLoggingProperties

DiagnosabilitySettings.ErrorCodeProperties

n/a

All permitted values

Yes

No

If exists, this object overrides the values in BaseErrorCodeProperties for Error Code log records.

ProbeEnabled

Boolean

false

All permitted values

Yes

No

Enable the instrumentation of requests with the diagnosability probe.

ProbeProperties

DiagnosabilitySettings.ProbeProperties

n/a

All permitted values

Yes

Yes

description not found Can't find resource for bundle oracle.ocs.management.model.SystemModelBundle, key DIA_CFG_PROBE_PROPS_LONG

DiagnosabilitySettings.ContextProperties

The following properties are available for DiagnosabilitySettings.ContextProperties:

Table 4-53 DiagnosabilitySettings.ContextProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

IncludeCallerStacks

Boolean

false

All permitted values

Yes

No

If enabled, Stack traces within each service will be propagated to any callee services

PropagationEnabled

Boolean

true

All permitted values

Yes

No

Enable Diagnosability Context propagation. If disabled, ECID, service instance stacks, and caller stacks will not be propagated over CSI calls or to the Database.

DiagnosabilitySettings.ErrorCodeProperties

The following properties are available for DiagnosabilitySettings.ErrorCodeProperties:

Table 4-54 DiagnosabilitySettings.ErrorCodeProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

ExcludedErrorCodes

List<String>

n/a

All permitted values

Yes

No

If set, none of these error codes listed will be reported, in conjunction with ReportingSeverityThreshold. This property and IncludedErrorCodes cannot be set at the same time.

IncludeStackTraces

Boolean

false

All permitted values

Yes

No

If enabled, stack traces will be included with each reported Error Code occurrence.

IncludedErrorCodes

List<String>

n/a

All permitted values

Yes

No

If set, only the list of error codes here will be persisted. It is not recommended that this property be set. This property and ExcludedErrorCodes cannot be used at the same time.

LoggingSeverity

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

FINER

All permitted values

Yes

No

All error codes reported to log files, will be written at this severity level. This property is ignored by Error Code database persistence.

ReportingSeverityThreshold

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

INFO

All permitted values

Yes

No

Minimum Error Code severity required to report an Error Code occurrence, to the applicable persistence type

UploadInterval

int

30

This property has a customized constraint.

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.SystemModelBundle, key DIA_CFG_EC_UPLOAD_INTERVAL_LONG

DiagnosabilitySettings.ProbeProperties

The following properties are available for DiagnosabilitySettings.ProbeProperties:

Table 4-55 DiagnosabilitySettings.ProbeProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

LightWeightEnabled

boolean

true

All permitted values

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.SystemModelBundle, key DIA_PROBE_LW_LONG

MaxSize

int

10485760

This property has a customized constraint.

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.SystemModelBundle, key DIA_PROBE_MAX_SIZE_LONG

PersistenceInterval

int

60

This property has a customized constraint.

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.SystemModelBundle, key DIA_PROBE_PERSISTENCE_INTERVAL_LONG

StorageLocation

String

n/a

All permitted values

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.SystemModelBundle, key DIA_PROBE_STORAGE_LOC_LONG

DiscussionsService

The following properties are available for DiscussionsService:

Table 4-56 DiscussionsService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

EmailService

The following properties are available for EmailService:

Table 4-57 EmailService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

CSIProperties

EmailService.CSIProperties

n/a

All permitted values

No

Yes

A group of properties associated with Email CSI interface implementation behavior. Email CSI performance and memory footprint can be tuned via these properties.

CoexUserLocal

boolean

false

All permitted values

Yes

No

If true, Coexisting users (sometimes referred to as users with a remote Inbox) will have their email forwarded to another server via the routing rules of the system. If false, the property indicating that the Inbox is remote is ignored.

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

DirectoryCacheTTL

long

60000

Min=0, Max=9223372036854775807

Yes

No

Maximum time (in milliseconds) that an address will remain cached within the server. Note that this becomes the maximum time for a change to a users information (email address) or a group membership before changes are seen.

GlobalDomainName

String

default

All permitted values

Yes

No

The domain name used throughout the system. Note: This value may be overridden in certain parts of the system.

IMAPEnabled

boolean

true

All permitted values

Yes

No

Specifies whether or not Oracle Beehive's native Internet Message Access Protocol (IMAP) services are enabled. Valid values: true, false

IMAPProperties

EmailService.IMAPProperties

n/a

All permitted values

No

Yes

A group of properties associated with the IMAP server component. IMAP server is responsible for serving user requests to read and manage emails in their mailboxes.

LocalEmailPatterns

List<String>

n/a

All permitted values

Yes

No

The list of valid e-mail address patterns for users of the system

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MaxDirectoryCacheEntries

int

8192

Min=0, Max=2147483647

Yes

No

The maximum number of resolved e-mail addresses that the system will cache in memory

MaxMailSz

long

50000000

Min=0, Max=9223372036854775807

Yes

No

The maximum size of an e-mail allowed by the system. The system will reject e-mail messages that exceed this threshold. Note this value is invlusive of the entire message (headers, attachments, etc).

NonLocalEmailPatterns

List<String>

n/a

All permitted values

Yes

No

The list of valid e-mail address patterns to which the system will forward e-mail messages. Typically, this property is used to specify patterns for e-mail addresses that are hosted on other systems.

PersistenceProperties

EmailService.PersistenceProperties

n/a

All permitted values

No

Yes

A group of properties associated with email service persistence cache. Persistence cache is responsible for managing email message content cache in the middle tier.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

SMTPEnabled

boolean

true

All permitted values

Yes

No

Specifies whether or not Oracle Beehive's native Simple Mail Transport Protocol (SMTP) service is enabled. Valid values: true, false

SMTPProperties

EmailService.SMTPProperties

n/a

All permitted values

No

Yes

A group of properties associated with SMTP server component. SMTP server is responsible for accepting email traffic from remote hosts and commit delivering responsibility for email messages.

SaveParseErrorEmails

boolean

false

All permitted values

Yes

No

Specifies whether or not the system will save e-mail messages that it cannot parse. The system will save unparsed e-mail messages in a local directory under the persistent storage root. Valid values: true, false

SortByAddressOnly

boolean

false

All permitted values

Yes

No

Whether senders should be sorted by email address without the displayed name portion in the web client. With this value set to false, senders will be sorted by the displayed name instead

SubjectSortingGroupingRules

List<String>

[(^\[[fF][wW][dD]:( )*)((.)*)(\]$), 3]

All permitted values

Yes

No

List of regular expressions and group numbers, interleaved so item i+1 denotes group to be returned for matched expression i where i = sequence 0, 2, 4,... etc.

SubjectSortingReplacementRules

List<String>

[[\t\n\r], , ^( )+, , ( )+$, , ( )+, , ^([rR][eE]|[fF][wW][dD]?):, , \([fF][wW][dD]\)$, ]

All permitted values

Yes

No

List of regular expressions and replacement strings, interleaved so item i+1 denotes replacement string for matched expression i where i = sequence 0, 2, 4,... etc.

TimeoutCheckingInterval

long

60000

Min=0, Max=9223372036854775807

Yes

No

The best resolution (precision) for any timeout in the email system. Applies to several protocols and facilities. This is the tolerance band for any email-related timeout.

TransportProperties

EmailService.TransportProperties

n/a

All permitted values

No

Yes

A group of properties associated with email service transport component. Transport component is responsible for processing and delivering email messages to their detinations.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

EmailService.CSIProperties

The following properties are available for EmailService.CSIProperties:

Table 4-58 EmailService.CSIProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

MaxLoadCount

int

20000

Min=0, Max=500000

Yes

No

Max number of items to load in a single CSI load request if the load is requested with any projection other than EMPTY. Otherwise the number is unlimited. This prevents client requests to cause out of memory errors on the server side. It is recommended that this parameter to be tuned assuming each item takes approximately 10KB of memory footprint.

StreamBufferSize

int

8192

Min=0, Max=2147483647

Yes

No

The size (in bytes) of the buffered streams used for CSI based streaming

StreamMaxReadChunkSize

int

16384

Min=0, Max=2147483647

Yes

No

CSI based stream max read chunk size in bytes

StreamMaxWriteChunkSize

int

16384

Min=0, Max=2147483647

Yes

No

CSI based stream max write chunk size in bytes

StreamPreFetchSize

int

0

Min=-1, Max=2147483647

Yes

No

CSI based stream pre-fetch buffer size in bytes

StreamTimeout

long

300000

Min=0, Max=9223372036854775807

Yes

No

Timeout (in relative milliseconds) until an inactive stream of mail data is abandoned, under the assumption the client has lost connectivity with the server or has crashed.

VMSProperties

String

OutboundVMS

All permitted values

Yes

No

Use this VMS Properties object as a policy to enforce upon all CSI email requests. In particular all CSI Email request will be subject to the limit placed by the VMS Properties MaxRcptsPerTx and MaxSzAbortTxn.

EmailService.EndpointProperties

The following properties are available for EmailService.EndpointProperties:

Table 4-59 EmailService.EndpointProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

EndpointName

String

default

All permitted values

Yes

No

Name of the endpoint, it can be any arbitrary descriptive string identifying the endpoint

EndpointScheme

String

default

All permitted values

Yes

No

Scheme for this endpoint. It is a colon-delimited string containing protocol of the endpoint and port number. The format of the scheme is PROTOCOL:*:PORT, for example, MX:*:25 represent a beehive MX endpoint connection on port 25. Available protocols are MX, MXS (MX over SSL), TCP and BUS.

EmailService.IMAPProperties

The following properties are available for EmailService.IMAPProperties:

Table 4-60 EmailService.IMAPProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AssumeSingleEndpoint

boolean

true

All permitted values

Yes

No

If this property is true, the Port property will be used as the listening port. This is a simplification over the more complex list of Endpoints which permit multiple ports for a single instance.

CacheMessageSize

long

12

Min=1, Max=9223372036854775807

Yes

No

Property giving the approximate size in bytes of each message cached in memory

ClientKeepAliveInterval

long

10000

Min=0, Max=9223372036854775807

Yes

No

Get the interval after which some unsolicited response is sent to a client to keep it active (in millseconds)

EndpointPropertiesList

List<EndpointProperties> (Structural property)

n/a

All permitted values

Yes

No

If Assume Single Endpoint is false, this property defines a list of listening endpoints.

FolderCacheDirectory

String

../../beehive/mailspool/temp/imap

All permitted values

Yes

No

The IMAP folder cache directory. IMAP will store temporary files in this directory

FolderOpenBatchSize

int

1000

Min=1, Max=2147483647

Yes

No

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

long

20000

Min=0, Max=9223372036854775807

Yes

No

The interval by-which the database is polled for changes to the currently selected IMAP folder

FolderSyncBatchSize

int

50

Min=1, Max=2147483647

Yes

No

Get the batch size used for checking updates to folders

LoginErrorThreshold

int

3

Min=0, Max=2147483647

Yes

No

Get the number of login errors tolerated before the connection is forcibly closed.

MaxFolderCacheSize

long

52428800

Min=0, Max=2147483647

Yes

No

Property controlling the maximum amount of memory available for IMAP folder caching

MaxSessions

int

1024

Min=0, Max=2147483647

Yes

No

Maximum number of IMAP sessions server will permit per service instance

MessageLoadBatchSize

int

50

Min=0, Max=100

Yes

No

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

int

3

Min=0, Max=2147483647

Yes

No

The number of consecutive parser errors tolerated before the connection is forcibly closed.

Port

int

143

Network Port, Min=1, Max=65536

Yes

No

If the property Assume Single Endpoint is enabled (true), then this is the port which the IMAP server will use to accept new connections. If Assume Single Endpoint is false, this property is ignored.

ProtocolLoggingEnabled

boolean

false

All permitted values

Yes

No

Whether IMAP protocol logging is enabled. If enabled, IMAP protocol exchange will be captured and logged under logger oracle.ocs.mail.IMAPLogger with log level INFO.

ServerSessionConcurrency

int

23

Min=1, Max=2147483647

Yes

No

Max number of concurrent sessions which can be serviced as a given moment

SessionTimeout

long

1800000

Min=0, Max=9223372036854775807

Yes

No

The duration in millseconds after which inactive IMAP sessions are automatically logged out and closed.

ShowInstanceNameInBanner

boolean

false

All permitted values

Yes

No

Show IMAP server instance ID in protocol banner display, it identifies a specific application server process that hosts the IMAP server. This can be enabled to help diagnostics when problem arises.

StreamReadBufferSize

int

32768

Min=1, Max=2147483647

Yes

No

Size of temp buffer used when reading from a client stream

SurrogateAuth

boolean

false

All permitted values

Yes

No

If true, IMAP allows surrogate authentication during login

TlsMandatory

boolean

false

All permitted values

Yes

No

If true, when UseTls is enabled IMAP makes STARTTLS mandatory.

UseTls

boolean

false

All permitted values

Yes

No

If true, IMAP advertises STARTTLS capability.

EmailService.PersistenceProperties

The following properties are available for EmailService.PersistenceProperties:

Table 4-61 EmailService.PersistenceProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

CopyBatchSize

int

1000

Min=1, Max=1000

Yes

No

Batch size for copy operation. This parameter controls how many messages to copy at a time when the request is huge. Breaking the operation in chunks put less strain on the database

DbConnRetry

String

1000,5000,9000

All permitted values

Yes

No

Attempts to retry a database operation on connection failure. This is employed to support automatic fail-over on clustered database systems. The value is a comma delimited list of successive retry intervals in miliseconds.

DeleteBatchSize

int

100

Min=1, Max=100

Yes

No

Batch size for delete operation. This parameter controls how many messages to delete at a time when the request is huge. Breaking the operation in chunks put less strain on the database

DurableFileRoot

String

../../beehive/mailspool/perm

All permitted values

Yes

No

Root directory under which problematic emails will be saved. This directory should be visible only to the operating system user of the instance, as it contains sensitive data (emails). If a relative path is used rather than absolute, it will be relative to the home directory of the instance

MoveBatchSize

int

1000

Min=1, Max=1000

Yes

No

Batch size for move operation. This parameter controls how many messages to move at a time when the request is huge. Breaking the operation in chunks put less strain on the database

PldStoreCacheLinger

long

180000

Min=0, Max=9223372036854775807

Yes

No

Time (in milliseconds) for an unreferenced record to linger in the cache

PldStoreCleanupInterval

int

86400

Min=0, Max=2147483647

Yes

No

Interval (in seconds) for performing payload store cleanup

PldStoreMaxMemCachedRecords

int

2000

Min=0, Max=2147483647

Yes

No

Maximum number of memory cached records for payload store

PldStoreMaxOpenFDs

int

1000

Min=0, Max=2147483647

Yes

No

Maximum number of open file descriptors used as cache of files being read/written by payload store

PldStoreRecordCacheSz

int

50000

Min=0, Max=2147483647

Yes

No

Size of a cached payload record (in bytes).

PldStoreStreamBufSz

int

8192

Min=0, Max=2147483647

Yes

No

The size (in bytes) of the buffered streams used for file-cached records

TempFileRoot

String

../../beehive/mailspool/temp

All permitted values

Yes

No

Root directory under which temporary emails will be written to disk. This directory should be visible only to the operating system user of the instance, as it contains sensitive data (emails). If a relative path is used rather than absolute, it will be relative to the home directory of the instance.

UndeleteBatchSize

int

1000

Min=1, Max=1000

Yes

No

Batch size for undelete operation. This parameter controls how many messages to undelete at a time when the request is huge. Breaking the operation in chunks put less strain on the database

UpdateFlagsBatchSize

int

1000

Min=1, Max=1000

Yes

No

Batch size for update operation. This parameter controls how many messages to update at a time when the request is huge. Breaking the operation in chunks put less strain on the database

EmailService.SMTPProperties

The following properties are available for EmailService.SMTPProperties:

Table 4-62 EmailService.SMTPProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AssumeSingleEndpoint

boolean

true

All permitted values

Yes

No

If this property is true, the Port property will be used as the listening port. This is a simplification over the more complex list of Endpoints which permit multiple ports for a single instance.

Authentication

boolean

false

All permitted values

Yes

No

If true, the system will advertise the SMTP AUTH extension.

DSNEnabled

boolean

true

All permitted values

Yes

No

If true Delivery Status Notifications are sent when requested by client or by protocol convention

EndpointPropertiesList

List<EndpointProperties> (Structural property)

n/a

All permitted values

Yes

No

If Assume Single Endpoint is false, this property defines a list of listening endpoints.

Port

int

25

Network Port, Min=1, Max=65536

Yes

No

If the property Assume Single Endpoint is enabled (true), then this is the port which the SMTP server will use to accept new connections. If Assume Single Endpoint is false, this property is ignored.

ProtocolLoggingEnabled

boolean

false

All permitted values

Yes

No

Whether SMTP protcol exchange is logged. If enabled, SMTP protocol exchange will be captured and logged under logger oracle.ocs.mail.SMTPLogger with log level INFO

RelayProtocolLoggingEnabled

boolean

false

All permitted values

Yes

No

Whether SMTP outbound protcol exchange is logged. If enabled, SMTP outbound exchange will be captured and logged under logger oracle.ocs.mail.SMTPRelayLogger with log level INFO

SendMailEvenIfNoTls

boolean

false

All permitted values

Yes

No

If true, SMTP outbound sends mail even if remote server doesn't support TLS or STARTTLS command fails.

ServerSessionConcurrency

int

23

Min=1, Max=2147483647

Yes

No

SMTP server thread pool size

UseTls

boolean

false

All permitted values

Yes

No

If true, the system will advertise the SMTP STARTTLS extension.

VMSEvaluatorTopLevel

String

default

All permitted values

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.EmailServiceBundle, key SMTP_VMS_EVALUATOR_TOPLEVEL_LONG_DESC

VMSPropertiesList

List<VMSProperties> (Structural property)

n/a

All permitted values

Yes

No

The list of virtual mail servers for this instance.

EmailService.SMTPProperties.VMSProperties

The following properties are available for EmailService.SMTPProperties.VMSProperties:

Table 4-63 EmailService.SMTPProperties.VMSProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AuthMandatory

boolean

false

All permitted values

Yes

No

If true and Authentication is enabled, SMTP requires authentication before accepting mail.

CustomDisplayName

String

server

All permitted values

Yes

No

The custom name of the server, as will be seen on the initial salutation of the SMTP protocol. Note that this property is not read unless Use Default Display Name is set to false.

CustomDomainName

String

default

All permitted values

Yes

No

A domain name for this virtual mail server which differs from the system-wide domain name. This property is not used unless Use Default Domain Name is set to false.

CustomProductVersion

String

default

All permitted values

Yes

No

A custom version of the product, different than that which shipped from Oracle. This property is not used unless Use Custom Default Product Version is set to false.

LogAllExceptions

boolean

false

All permitted values

Yes

No

Should all exceptions be logged. Setting to false prevents reporting of the (many types of) problems that can occur with remote clients (esp in the Internet).

MaxAbortedTransitionsPerSession

int

100

Min=1, Max=2147483647

Yes

No

Maximum number of aborted transactions per session before the client is assumed to be engaging in some form of denial-of-service attack and is terminated.

MaxBadTransitionsPerSession

int

20

Min=1, Max=2147483647

Yes

No

Maximum number of illegal (out of sequence) SMTP commands before the session is assumed to be an attacker and is closed.

MaxCommandLineSize

int

2048

Min=1, Max=2147483647

Yes

No

Maximum size (in bytes) of a single SMTP line. Note that this value should not be set to the minimum defined in the SMTP specification, as some legitimate mail servers violate that specification. Rather, this value is intended to be large enough to accept mails from poor-conforming mail servers yet reject attempts at denial of service or buffer overflow attacks.

MaxRcptsPerTx

int

101

Min=1, Max=2147483647

Yes

No

Maximum number of recipients per transaction. It is advised to set this number above 100 as per the SMTP specification. When this number is exceeded, subsequent RCPT TO commands will receive an error.

MaxRejectedAddressesPerSession

int

1000

Min=0, Max=2147483647

Yes

No

Maximum number of rejected recipients before a given session is assumed to be illegitimate, and it terminated. This is useful to prevent address-harvesting by senders of unwanted email.

MaxSizeBeforeAttackSuspected

long

1000000000

Min=0, Max=9223372036854775807

Yes

No

Maximum email size received before the client is assumed to be engaged in a denial of service attack. Once this threshold is crossed, the client session is abruptly terminated. Note that this differs from Max Mail Size in that mails exceeding that value do not result in termination of the entire session.

MaxSzAbortTx

long

10000000

Min=0, Max=9223372036854775807

Yes

No

Maximum size for an email on this virtual mail server. Note that Use Default Max Size must be set to false for this property to be read.

MaxUselessCommandsPerSession

int

5000

Min=0, Max=2147483647

Yes

No

Maximum number of commands with no effect (e.g. NOOP) per session before we assume that the client is engaged in some form of denial of service attack.

NextCommandTimeout

int

301000

Min=1, Max=2147483647

Yes

No

Inactivity timeout (in milliseconds) for clients between issuing commands. Note that this does not include the SMTP DATA command.

NextDataChunkTimeout

int

301000

Min=1, Max=2147483647

Yes

No

Timeout (in milliseconds) waiting for next packet during the receive portion of the DATA command.

QuitWriteTimeout

int

60000

Min=1, Max=2147483647

Yes

No

Timeout (in milliseconds) waiting for remote client to consume the ACK of the QUIT command

RecipientMatcherTopLevel

String

default

All permitted values

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.EmailServiceBundle, key VMS_RECIPIENT_MATCHER_TOPLEVEL_LONG_DESC

RejectAll

boolean

false

All permitted values

Yes

No

If true, this virtual mail server will reject all connections.

SenderMatcherTopLevel

String

default

All permitted values

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.EmailServiceBundle, key VMS_SENDER_MATCHER_TOPLEVEL_LONG_DESC

ShowInstanceNameInBanner

boolean

false

All permitted values

Yes

No

Show SMTP server instance ID in protocol banner display, it identifies a specific application server process that hosts the SMTP server. This can be enabled to help diagnostics when problem arises.

SupressReceivedFrom

boolean

false

All permitted values

Yes

No

If true, the client IP/hostname will not be embedded in the RECEIVED header added to email headers.

SupressResponseText

boolean

false

All permitted values

Yes

No

If true, SMTP responses to not carry the debugging information in addition to the SMTP codes.

TlsMandatory

boolean

false

All permitted values

Yes

No

If true and UseTls is enabled, SMTP requires TLS.

UseDefaultDisplayName

boolean

false

All permitted values

Yes

No

If false, the Custom Display Name is used. Otherwise, the original product name is used.

UseDefaultDomainName

boolean

true

All permitted values

Yes

No

If false, this virtual mail server will advertise a domain different than the rest of the system.

UseDefaultMaxSz

boolean

true

All permitted values

Yes

No

If false, the global maximum email size will not be used and instead the Max Email Size defined for this virtual mail server will be used.

UseDefaultProductVersion

boolean

false

All permitted values

Yes

No

If false, the Custom Product Version is returned as part of the SMTP salutation

VMSName

String

default

All permitted values

Yes

No

The administrator-assigned name of this virtual mail server.

EmailService.TransportProperties

The following properties are available for EmailService.TransportProperties:

Table 4-64 EmailService.TransportProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AcceptInvalidLocalUsers

boolean

false

All permitted values

Yes

No

Indicates if non-existant local users should be accepted by the system and treated as remote recipients. Should be set to true when users for a single domain exist in this and another email system.

DeliveryConcurrency

int

5

Min=1, Max=2147483647

Yes

No

The maximum number of concurrent threads which will be dedicated to delivering a given email. This is employed when a single email is destined for a large number of recipients, and serves to prevent high-recipient emails from consuming excessive system resources.

DeliveryTopLevel

String

default

All permitted values

Yes

No

XML encoded delivery routing rules. This includes both properties settable from beekeeper and possible freelance groovy scripts. These rules are applied to determine the next stop for any given mail being relayed.

InMemoryQueueSize

int

250

Min=0, Max=2147483647

Yes

No

Maximum number of emails received at a given instance which have yet to be processed. This can be thought of as a backlog of emails. Should this value be exceeded, emails will be received but not processed at the current instance.

KeepAliveInterval

long

300000

Min=60000, Max=9223372036854775807

Yes

No

Time (in milliseconds) between server registration to signal its alive status by the email service instance.

LocalDeliveryBatchSize

int

100

Min=1, Max=2147483647

Yes

No

Number of recipients in a batch of local recipients. Local recipients are those who maintain an inbox within the current system.

MaxReceivedHeaders

int

25

All permitted values

Yes

No

Max number of "Received:" allowed in a message before it is discarded. A high number of this header present in a message signals a possible routing loop.

MaxRetryPeriod

long

432000000

Min=0, Max=9223372036854775807

Yes

No

Time (in milliseconds) after receipt of an email that delivery is no longer attempted.

MaximumDBMessageQueuePercentage

int

80

Min=0, Max=100

Yes

No

Maximum percentage of queue size reserved for retry and recovery. An idle system with relatively high server restart requirements or relatively high temporary delivery failure (such as due to quota overflow) can increase this value to improve efficiency of the system.

MinimumDBMessageQueuePercentage

int

20

Min=0, Max=100

Yes

No

Minimum percentage of queue size reserved for retry and recovery. An idle system with relatively high server restart requirements or relatively high temporary delivery failure (such as due to quota overflow) can increase this value to improve efficiency of the system.

MsgTerminusTopLevel

String

default

All permitted values

Yes

No

XML encoded message terminus rules. This includes both properties settable from beekeeper and possible freelance groovy scripts. These rules are applied when a given message ends its lifecycle in the email transport system, including successful delivery or permanent failure of all its recipients.

PreResolutionTopLevel

String

default

All permitted values

Yes

No

XML encoded pre-resolution rules including both properties settable from beekeeper and possible freelance groovy scripts. These rules are to be applied during message processing before any of the recipients are resolved

ProcessingEnabled

boolean

true

All permitted values

Yes

No

If this value is false, it has the effect of preventing any received/delayed emails from being delivered.

QueuePollInterval

long

120000

Min=0, Max=9223372036854775807

Yes

No

Time (in milliseconds) between retry and recovery queue polling by the transport system.

RelayServer

String

default

All permitted values

Yes

No

If the property Simple Relay Mode is true, then this is the name of the relay server to be used.

ResolutionTopLevel

String

default

All permitted values

Yes

No

XML encoded post-resolution rules including both properties settable from beekeeper and possible freelance groovy scripts. These rules are to be applied during message processing after all the recipients are resolved.

RetryInterval

int

1800000

Min=-1, Max=2147483647

Yes

No

Time (in milliseconds) between delivery attempts for an email which has at least one undeliverable recepient.

SMTPDeliveryBatchSize

int

100

Min=1, Max=2147483647

Yes

No

The maximum number of recipients within a given SMTP transaction. As per the specifications for SMTP, this value should not exceed 100.

SMTPDeliveryCheckpoint

int

5

Min=1, Max=2147483647

Yes

No

This value controls how often the status of recipients is recorded during delivery of messages to large number of recipients/domains. If this value is small, there is less of a chance of duplicate mail in the event of a system crash. However, smaller settings for this value result in more system load.

ScanOnUpload

boolean

false

All permitted values

Yes

No

If true, emails are scanned as they are uploaded to the system. Upload includes IMAP APPEND as well as API calls which insert, rather than send, emails. Scanning on send is controlled by the pre/post resolution rules.

SentEmailPluginEnabled

boolean

false

All permitted values

Yes

No

Whether plug-ins are enabled to be executed after a mail is received. These are internal bookkeeping plugins designed for record management or auditing.

SimpleRelayMode

boolean

true

All permitted values

Yes

No

If true, the XML-based Delivery Rules are not used. Instead, a simpler configuration is assumed where the administrator need only supply a relay host (via the Relay Server property). If this value is true yet the Relay Server is unset, an error will be issued and email delivery will be prevented.

ThreadPoolSize

int

10

Min=1, Max=2147483647

Yes

No

Number of threads within the processing thread pool

Enterprise

The following properties are available for Enterprise:

Table 4-65 Enterprise Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

CollabId

CollabId

n/a

All permitted values

No

Yes

The Collabid of this Enterprise

Name

String

n/a

All permitted values

Yes

No

the name of the system object.

EventService

The following properties are available for EventService:

Table 4-66 EventService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AsyncActionRetryCount

int

5

All permitted values

Yes

No

The Event Service will retry the specified number of times when the action handler fails to process the event. The Event Service moves the event to the failed queue after it has retried the specified number of times. Also see AsyncActionRetryInterval parameter.

AsyncActionRetryInterval

int

5

All permitted values

Yes

No

Time interval in minutes between retries of failed action. Also see AsyncActionRetryCount parameter.

AsyncLogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

WARNING

All permitted values

Yes

No

The log level is used by the Business Event processing engine to determine the detail of the logs written. The log level of FINEST will write the most detailed log messages, and SEVERE will log the least.

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MaxThreadPoolSize

int

10

All permitted values

Yes

No

A correctly sized thread pool will be able to keep up with the load of the java action queue. If the action queue keeps growing, and the Event Service is not able to keep up with the load, then this value should be increased. Be aware a larger pool size may require more database and mid-tier resources to keep up with the load.

PreEvaluateThresholdRuleCount

int

1000

All permitted values

Yes

No

The purpose of this parameter is to tune the overall system performance in regards to event processing. The threshold number is in relationship to the total number of subscription conditions (or rules) per event type (such as DOCUMENT, EMAIL, CALENDAR, etc.). If this number is smaller than the total number of rules, and the total number of rules is very large, it is possible that pre-evaluating the rules can take more time. If this number is larger than the total number of rules, the Event Service will not pre-evaluate any rules. It will automatically queue all events which may not have any matching subscriptions, and therefore not be very efficient.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

ExpertiseService

The following properties are available for ExpertiseService:

Table 4-67 ExpertiseService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

ActiveLanguages

List<String>

[English]

This property has a customized constraint.

Yes

No

This property specifies the list of languages which are active. Currently, the supported languages are English, French and German

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

EnableExpertiseRequestExpiration

Boolean

true

All permitted values

Yes

No

Flag to enable periodic expiration of ExpertiseRequests. A request is said to expire if there has been no activity (posts to dicsussion forum) prior to the expiration interval. Expired requests will be periodically purged from the system. The allowed values are true or false.

ExpertiseRequestExpirationInterval

int

90

This property has a customized constraint.

Yes

No

Interval in days after which an Expertise Request is said to expire, if there has been no activity (posts to dicsussion forum) for it. The interval must be somewhere between 30 days and 180 days.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MaxArtifactSize

int

15728640

This property has a customized constraint.

Yes

No

This property specifies the maximum size of an artifact that would be profiled. The default value is 15728640 bytes which is equivalent to 15 megabytes.

MaxNumPublicTermsPerProfile

int

100

This property has a customized constraint.

Yes

No

This property specifies the maximum number of public terms a user can have in her profile. This is a global setting applicable to all users. The default value is 100

MaxNumTermsPerProfile

int

10000

This property has a customized constraint.

Yes

No

This property specifies the maximum number of terms a user can have in her profile. This is a global setting applicable to all users. A valid value is anything between 500 and 10000. The default value is 10000

MaxNumUsersForBrokeredRequest

int

50

This property has a customized constraint.

Yes

No

This property specifies the maximum number of size to whom brokered requests would be sent. The default value is set at 50. Any positive value upto 100 is acceptable.

NumDaysFetchContent

int

90

This property has a customized constraint.

Yes

No

This property specifies the number of days to go back in time to fetch content (messages) for profiling for bootstrapped users. The default value is set at 90 days. Any value upto 365 days is acceptable.

NumProfilerParallelRuns

int

10

This property has a customized constraint.

Yes

No

This property specifies the number of threads of the profiler that could run.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

ExternalJ2eeApplication

The following properties are available for ExternalJ2eeApplication:

Table 4-68 ExternalJ2eeApplication Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AdminPassword

SecureString

n/a

All permitted values

Yes

No

the password of the oc4j admin user

AdminUsername

String

oc4jadmin

All permitted values

Yes

No

the name of the oc4j admin user

Hostname

String

n/a

All permitted values

Yes

No

the hostname used for generating urls to access the application.

Oc4jName

String

n/a

All permitted values

No

No

the name of the oc4j

OpmnRequestPort

int

n/a

All permitted values

Yes

No

the opmn request port for generating urls to access the application.

FaxMessageService

The following properties are available for FaxMessageService:

Table 4-69 FaxMessageService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

DebugFlags

Integer

n/a

All permitted values

Yes

No

description bundle not set

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

FtpService

The following properties are available for FtpService:

Table 4-70 FtpService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

ActiveModeEnabled

boolean

false

All permitted values

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.FtpBundle, key FTP_ENABLE_ACTIVE_LONG_DESC

ChannelSecurity

String

PLAIN_AND_TLS

All permitted values

Yes

No

Specifies the types of connections the system will accept.Valid values are TLS, PLAIN and PLAIN_TLS.

DMSInstrumentation

boolean

false

All permitted values

Yes

No

Collects DMS statistics if the value is set to TRUE.

DataConnectionPort

int

21000

Network Port, Min=1, Max=65536

Yes

No

Starting port number from which FTP data connections are created in passive mode.

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

DefaultCommandCharacterset

String

UTF-8

All permitted values

Yes

No

Default command character set used to interpret FTP commands and arguments.

DefaultDataPort

int

2120

Network Port, Min=1, Max=65536

Yes

No

The default data port number from which the FTP server will make outbound connections in PORT mode..

FtpServerEnabled

boolean

true

All permitted values

Yes

No

Specifies whether or not the BEEHIVE FTP server is enabled. If enabled (true), the FTP server accepts client requests. Valid values: true, false.

InternalIP

String

DEFAULT

All permitted values

Yes

No

This parameter gives the IP address that needs to be returned as response to PASV command for DMZ deployments.

ListeningPoint

String

DEFAULT

All permitted values

Yes

No

Listening points (network interface groups) that the system's FTP server will support. Valid values are : INTERNAL, EXTERNAL, DEFAULT and INTERNAL_EXTERNAL.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MaxDCPortCount

int

1000

All permitted values

Yes

No

The maximum number of ports the FTP service can use for passive listening.

Port

int

2121

Network Port, Min=1, Max=65536

Yes

No

The port at which the FTP server listens for client requests.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

SessionTimeout

int

900000

All permitted values

Yes

No

The amount of time (in milliseconds) that the FTP server will wait for a request from a connected client before terminating the session..

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

UploadBufferSize

int

260096

Min=16384, Max=1048576

Yes

No

The buffer size, in bytes, used while uploading stream data. Deployments that typically stream small files, as well as those with limited midtier memory, may improve performance by setting this value below the default. Deployments with a large amount of midtier memory may likewise improve performance by setting this value above the default.

HasHelpLink

The following properties are available for HasHelpLink:

Table 4-71 HasHelpLink Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

HelpLink

String

n/a

All permitted values

Yes

No

A configurable link to help text for Beehive clients.

HttpServer

The following properties are available for HttpServer:

Table 4-72 HttpServer Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

BeehiveInstance

BeehiveInstance

n/a

All permitted values

No

No

The BeehiveInstance with which this HttpServer is associated.

DocRootLimitExcept

String

GET POST

All permitted values

Yes

No

Restrict access controls to all HTTP methods except the named ones.

HttpListenPort

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The port to which the http server listens. This port is used when starting without SSL

HttpServerCluster

HttpServerCluster

n/a

All permitted values

Yes

No

Each httpserver is associated with a cluster and each site typically has atleast one and only cluster. A HttpServerCluster has properties common to all httpserver's in the cluster.

HttpSslListenPort

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The port to which the http server listens when ssl is enabled. This port is used when starting with SSL

KeepAliveTimeout

Integer

15

All permitted values

Yes

No

Idle connection to the server will be alive until this timeout limit

LockFile

File

apache/httpd.lock

All permitted values

Yes

No

The lockfile is used when the server needs to lock the accept call. It must be stored on a local disk.

LogLevel

HttpServer.HttpServerLogLevel (Legal values: emerg, alert, crit, error, warn, notice, info, debug)

notice

All permitted values

Yes

No

Controls the verbosity of the ErrorLog. The following levels are available, in order of decreasing significance:emerg, alert, crit, error, warn, notice, info and debug.

MaxClients

Integer

150

All permitted values

Yes

No

Limit on the number of clients who can simultaneously connect. if this limit is ever reached, clients will be LOCKED OUT, so it should NOT BE SET TOO LOW. It is intended mainly as a brake to keep a runaway server from taking the system with it as it spirals down.

OsGroup

String

n/a

All permitted values

No

Yes

The group to run httpd as.

OsUser

String

n/a

All permitted values

No

Yes

The user to run httpd as.

SSLLogLevel

HttpServer.HttpServerSSLLogLevel (Legal values: none, error, warn, info, trace, debug)

warn

All permitted values

Yes

No

Controls the verbosity of the SSL ErrorLog. The following levels are available, in order of decreasing significance:none, error, warn, info, trace, and debug.

ServerAdmin

String

" "

All permitted values

Yes

No

Your address, where problems with the server should be e-mailed. This address appears on some server-generated pages, such as error documents.

ServerRoot

String

n/a

All permitted values

No

Yes

The top of the directory tree under which the server's configuration, error, and log files are kept.

Timeout

Integer

60

All permitted values

Yes

No

The number of seconds before receives and sends time out.

HttpServerCluster

The following properties are available for HttpServerCluster:

Table 4-73 HttpServerCluster Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

HttpServerSslEnabled

Boolean

true

All permitted values

Yes

No

If Http ssl is enabled in this HttpServer Cluster.

HttpServers

Set<HttpServer> (Structural property)

n/a

All permitted values

Yes

No

The set of HttpServer's associated with this cluster.

ModOc4jMaxErrors

Integer

1

All permitted values

Yes

No

Oc4jSet MaxErrors in mod_oc4j.conf.

SslTerminatedByLoadBalancer

Boolean

false

All permitted values

Yes

No

If Http ssl is terminated by the load balancer.

IdMap

The following properties are available for IdMap:

Table 4-74 IdMap Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Map

Map<String,String>

n/a

All permitted values

Yes

No

Specifies the map of identity format to identity mapping attribute. Valid identity format values include: unspecified; email_addr; x509_subject; windows_dqn. Valid identity mapping attribute could be any User Directory Service address attribute.

IdentityProviderService

The following properties are available for IdentityProviderService:

Table 4-75 IdentityProviderService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

IdpSAMLIdentity

SAMLIdentity

n/a

All permitted values

Yes

No

Specifies the alias to the key and/or certificate of the Oracle Beehive SAML identity provider listed in the Oracle Wallet.

IdpUrl

String

n/a

All permitted values

Yes

No

Specifies the URL of the SAML identity provider for system.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

SpSAMLIdentity

SAMLIdentity

n/a

All permitted values

Yes

No

Specifies the alias to the key and/or certificate of the Oracle Beehive SAML service provider listed in the Oracle Wallet.

SpUrl

String

n/a

All permitted values

Yes

No

Specifies the URL of the SAML service provider.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

ImService

The following properties are available for ImService:

Table 4-76 ImService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

ArchivingEnabled

boolean

false

All permitted values

Yes

No

Set this parameter to true to enable organisation level archiving. If this is set to false, user level archiving preference has no effect.

ChatRoomTranscriptsOn

boolean

false

All permitted values

Yes

No

Set this to true if chatroom conversations need to be archived. False otherwise(default).

ChatRoomXhtmlFormattingOn

boolean

true

All permitted values

Yes

No

Set this to true if XHMTL formatting needs to be enabled in chat rooms(default). Set to false otherwise.

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

ImBufferStageSize

int

500000

Min=100000, Max=3000000

Yes

No

This value defines the maximum size of the buffer to keep instant messages in memory before they are written into database as transcripts. The default value is 500Kb. Please note that the instant messages can be written to db before this maximum is reached. This is possible on account of expiration of im_purging_period_timer.

ImEndPointDeathDetectionTime

int

5

Min=5, Max=300

Yes

No

This property allows the admin to set the time interval at which the ImServiceInstance should send KEEP_ALIVE packets to the IPAs. This enables the IPAs to detect any ImService instance going down. The value is in seconds with a default of 5 s.

ImOfflinePurgingPeriodTimer

int

5

Min=2, Max=120

Yes

No

This value allows the admin to set the maximum time for which offline instant messages can be buffered in memory before they are written to DB in chunks. The default is 5 secs. Please note that the instant messages can be written to db even before this timer expires. This is possible on account of 100 offline buffered messages.

ImPurgingPeriodTimer

int

300

Min=60, Max=600

Yes

No

This value allows the admin to set the maximum time for which instant messages can be buffered in memory before they are written to DB in chunks. The default is 300 secs. Please note that the instant messages can be written to db even before this timer expires. This is possible on account of the buffer reaching its maximum size limit as defined by the im_buffer_stage_size property.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MaxRoomCount

int

10000

Min=0, Max=100000

Yes

No

This is the maximum number of rooms that are allowed by the server. Initial value is set to 10000

MaxUsersInRoom

int

100

Min=2, Max=500

Yes

No

This is the maximum number of users allowed in any room on the server. Initial value is set to 100.

OnlyPasswordProtectedRooms

boolean

false

All permitted values

Yes

No

Set this parameter to true if only password protected rooms are to be allowed in the server. If set to false (default) non password protected rooms are also allowed.

PendingMessagesLimit

int

1100

Min=11, Max=2147483647

Yes

No

This value sets the limit on the number of pending messages on the bus session before the send operation blocks. This is used for flow control of messages. The default value is of 1100. A larger value allows for more concurrency and lower value allows for less concurrency. This value also effects the memory usage determined by the pending messages in the session buffer.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

ReplayMessageHistoryOnJoin

boolean

false

All permitted values

Yes

No

Set this to true if all messages exchanged in the room since the first user joined the room are to be replayed, Set to false otherwise (default).

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

IrmService

The following properties are available for IrmService:

Table 4-77 IrmService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

ClassificationId

String

n/a

All permitted values

Yes

No

IRM_CID_L_DESC

ClassificationLabelDescription

String

n/a

All permitted values

Yes

No

IRM_CLD_L_DESC

ClassificationLabelName

String

n/a

All permitted values

Yes

No

IRM_CLNM_L_DESC

ClassificationLocale

String

n/a

All permitted values

Yes

No

IRM_CLL_L_DESC

ClassificationSystemId

String

n/a

All permitted values

Yes

No

IRM_CSID_L_DESC

ContentLabelDescription

String

n/a

All permitted values

Yes

No

IRM_CCLD_L_DESC

ContentLabelLocale

String

n/a

All permitted values

Yes

No

IRM_CCLL_L_DESC

ContentLabelName

String

n/a

All permitted values

Yes

No

IRM_CCLN_L_DESC

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

DesktopSyncURI

String

n/a

All permitted values

Yes

No

IRM_DURI_L_DESC

DesktopURI

String

n/a

All permitted values

Yes

No

IRM_DURI_L_DESC

IrmDesktopServiceEndPoint

String

n/a

All permitted values

Yes

No

IRM_ENDPT_L_DESC

IrmSealingServiceEndPoint

String

n/a

All permitted values

Yes

No

IRM_ENDPT_L_DESC

IrmUserName

String

n/a

All permitted values

Yes

No

IRM_UNAME_L_DESC

IrmUserPassword

SecureString

n/a

All permitted values

Yes

No

IRM_UPWD_L_DESC

KeySetUUID

String

n/a

All permitted values

Yes

No

IRM_KEYSETID_L_DESC

LicenseExpirationTime

int

30

All permitted values

Yes

No

IRM_LIC_EXP_L_DESC

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

RequiresHttpAuth

boolean

false

All permitted values

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.IrmServiceBundle, key IRM_AUTH_L_DESC

RequiresHttps

boolean

false

All permitted values

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.IrmServiceBundle, key IRM_HTTPS_L_DESC

SystemLabelDescription

String

n/a

All permitted values

Yes

No

IRM_CCLD_L_DESC

SystemLabelLocale

String

n/a

All permitted values

Yes

No

IRM_CCLL_L_DESC

SystemLabelName

String

n/a

All permitted values

Yes

No

IRM_CCLN_L_DESC

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

JavaExecutionArguments

The following properties are available for JavaExecutionArguments:

Table 4-78 JavaExecutionArguments Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AdditionalOptions

List<String>

n/a

All permitted values

Yes

No

The set of additional options for the system's Java Virtual Machine (JVM). Each option must be a legal option supported by the JVM, for example -Dproperty=value to set a system property value. This an ADVANCED property which you do not typically need to modify.

InitialHeapSizeInMB

Integer

n/a

This property has a customized constraint.

Yes

No

The initial heap size in megabytes (MBs) of the Java Virtual Machine (JVM).

InitialPermanentGenerationSizeInMB

Integer

n/a

This property has a customized constraint.

Yes

No

The initial permanent generation size in megabytes (MBs) of the Java Virtual Machine (JVM).

MaximumHeapSizeInMB

Integer

n/a

This property has a customized constraint.

Yes

No

The maximum heap size in megabytes (MBs) of the Java Virtual Machine (JVM).

MaximumPermanentGenerationSizeInMB

Integer

n/a

This property has a customized constraint.

Yes

No

The maximum permanent generation size in megabytes (MBs) of the Java Virtual Machine (JVM).

JcrServletService

The following properties are available for JcrServletService:

Table 4-79 JcrServletService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AuthenticationScheme

String

BASIC

This property has a customized constraint.

Yes

No

Specifies the JCR server's authentication scheme. Valid values: basic, digest.

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

JCRServerEnabled

boolean

true

All permitted values

Yes

No

Specifies whether or not the BEEHIVE Java Content Repository (JCR) server is enabled. If enabled (true), the JCR server accepts client requests else it throws an appropriate exception. Valid values: true, false

JcrSessionTimeout

int

960

This property has a customized constraint.

Yes

No

The amount of time (in minutes) that the JCR server will wait for a request from a connected client before terminating the session.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MaxDownloadBufferSize

int

261888

Min=16384, Max=1048576

Yes

No

The buffer size, in bytes, used while downloading stream data. Deployments that typically stream small files, as well as those with limited midtier memory, may improve performance by setting this value below the default. Deployments with a large amount of midtier memory may likewise improve performance by setting this value above the default.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

UploadBufferSize

int

260096

Min=16384, Max=1048576

Yes

No

The buffer size, in bytes, used while uploading stream data. Deployments that typically stream small files, as well as those with limited midtier memory, may improve performance by setting this value below the default. Deployments with a large amount of midtier memory may likewise improve performance by setting this value above the default.

LdapServer

The following properties are available for LdapServer:

Table 4-80 LdapServer Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

DigestAuthenticationAttribute

String[]

n/a

All permitted values

Yes

No

Specifies the LDAP attributes to be used for the various digest authentication protocols. The attribute entry format is [attribute type]:[attribute name]'. The valid attribute types are DEFAULT, SASL.DIGEST_MD5, and HTTP.DIGEST. e.g. DEFAULT:userPassword;SASL.DIGEST_MDS:mySaslDigestAttribute

DirectoryType

LdapServer.DirectoryType (Legal values: ORACLE_INTERNET_DIRECTORY, MICROSOFT_ACTIVE_DIRECTORY, SUN_ONE_DIRECTORY, IBM_TIVOLI_DIRECTORY, OPENLDAP_DIRECTORY, OTHER)

n/a

All permitted values

Yes

No

Specifies the LDAP directory type. The valid values are ORACLE_INTERNET_DIRECTORY, MICROSOFT_ACTIVE_DIRECTORY, SUN_ONE_DIRECTORY, IBM_TIVOLI_DIRECTORY, and OTHER.

GroupObjectClass

String

n/a

All permitted values

Yes

No

Specifies the LDAP group object class. e.g. groupOfUniqueNames

GroupSearchBase

String

n/a

All permitted values

Yes

No

Specifies the LDAP group search base DN.

LdapServerConnectionPoolMaxSize

int

25

All permitted values

Yes

No

long description key not set

LdapServerConnectionTimeout

int

120

All permitted values

Yes

No

long description key not set

LdapServerHostName

String

n/a

All permitted values

Yes

No

Specifies the LDAP server hostname.

LdapServerPassword

SecureString

n/a

All permitted values

Yes

No

Specifies the password of the user that is used to bind to the LDAP server.

LdapServerPort

int

389

Network Port, Min=1, Max=65536

Yes

No

Specifies the LDAP server port.

LdapServerSslPort

int

636

Network Port, Min=1, Max=65536

Yes

No

Specifies the LDAP server secure port.

LdapServerUser

String

n/a

All permitted values

Yes

No

Specifies the user that should be used to bind to the LDAP server. The user must have read access to the attributes of all Beehive users.

PrimaryAuthenticationAttribute

String

All permitted values

Yes

No

Specifies the LDAP attribute that stores the primary principal in LDAP. e.g. uid

PrimaryAuthenticationCredential

String

not applicable

All permitted values

No

No

Specifies the LDAP attribute that stores the secret for the primary authentication attribute.

ProtocolAuthenticationAttribute

String

not applicable

All permitted values

No

No

Specifies the LDAP attribute that stores the ASCII (7-bit) principal for the clients that do not support multi-byte string.

ProtocolAuthenticationCredential

String

not applicable

All permitted values

No

No

Specifies the LDAP attribute that stores the secret for the ASCII (7-bit) principal used for the authentication of clients that do not support multi-byte string.

SslEnabled

boolean

false

All permitted values

Yes

No

Specifies whether or not SSL should be used to connect to the LDAP server.

UserObjectClass

String

n/a

All permitted values

Yes

No

Specifies the LDAP user object class. e.g. inetOrgPerson

UserSearchBase

String

n/a

All permitted values

Yes

No

Specifies the LDAP user search base DN.

VoiceAuthenticationAttribute

String

not applicable

All permitted values

No

No

Specifies the LDAP attribute that stores the voice principal in LDAP (used by voice clients).

VoiceAuthenticationCredential

String

not applicable

All permitted values

No

No

Specifies the LDAP attribute that stores the secret for the authentication of voice clients.

LoggingConfigurable.LoggingProperties

The following properties are available for LoggingConfigurable.LoggingProperties:

Table 4-81 LoggingConfigurable.LoggingProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

BaseLogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

WARNING

All permitted values

Yes

No

Base Log Level is the default when the log level is not configured through Module Log Level. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MaxFileSize

Long

10485760

All permitted values

Yes

No

Maximum log file size in bytes. A new log file is opened when the current file exceeds this size.

MaxLogSize

Long

104857600

All permitted values

Yes

No

Maximum log size in bytes. It is the maximum total size of all log files combined.

ModuleLogLevel

Map<String,Level>

n/a

All permitted values

Yes

No

Module Log Level. You will use this advanced property under the guidance of a trained consultant who will explain the correct usage details. Each Logger can have it's log level configured through Module Log Level. It is a map from logger name to log level.

RotationFrequency

LoggingConfigurable.RotationFrequency (Legal values: HOURLY, DAILY, WEEKLY)

DAILY

All permitted values

Yes

No

The log file rotation frequency. Log files are rotated when they exceed the maximum log size and they are also rotated periodically according to the rotation frequency. Valid values are HOURLY, DAILY, and WEEKLY.

ManagedOc4j

The following properties are available for ManagedOc4j:

Table 4-82 ManagedOc4j Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AdminPassword

SecureString

n/a

All permitted values

Yes

No

the password of the oc4j admin user

AdminUsername

String

oc4jadmin

All permitted values

Yes

No

the name of the oc4j admin user

AjpPortMaxValue

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The maximum value for ajp port range

AjpPortMinValue

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The minimum value for ajp port range.

Applications

Set<BeehiveJ2eeApplication> (Structural property)

n/a

All permitted values

Yes

No

The list of BeehiveJ2eeApplications associated with the Oc4j instance.

BeehiveInstance

BeehiveInstance

n/a

All permitted values

No

No

The BeehiveInstance with which this ManagedOc4j is associated.

Database

Database

n/a

All permitted values

Yes

No

This database holds the configuration data and holds business data for any Enterprise that does not have its own dedicated storage.

HttpThreadPoolConfiguration

Oc4jThreadPool (Structural property)

n/a

All permitted values

No

No

The HTTP Oc4jThreadPool with which this ManagedOc4j is associated.

JGroupPortMaxValue

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The maximum value for jgroup port range

JGroupPortMinValue

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The minimum value for jgroup port range

JcaThreadPoolConfiguration

Oc4jThreadPool (Structural property)

n/a

All permitted values

No

No

The JCA Oc4jThreadPool with which this ManagedOc4j is associated.

JmsPortMaxValue

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The maximum value for jms port range

JmsPortMinValue

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The minimum value for jms port range

ManagedOc4jCluster

ManagedOc4jCluster

n/a

All permitted values

Yes

No

The Oc4jCluster which this ManagedOc4j belongs to. Each managedOc4j is associated with a cluster. An ManagedOc4jCluster has properties common to all oc4j's in the cluster.

Oc4jName

String

n/a

All permitted values

No

No

the name of the oc4j

PseudoTranslationEnabled

boolean

false

All permitted values

Yes

No

A Boolean flag that is used to enable/disable the pseudo-translation in Beehive Resource Bundle.

PseudoTranslationStrategy

String

n/a

All permitted values

Yes

No

The class name of pseudo translation algorithm that will be used for translation process by Beehive Resource Bundle.

ResourceAdapterInstances

Set<ResourceAdapterInstance> (Structural property)

n/a

All permitted values

Yes

No

The list of ResourceAdapterInstances associated with the Oc4j instance.

RmiClientTimeout

int

1200

Min=1, Max=2147483647

Yes

No

RMI client timeout value (in seconds) for this Oc4j.

RmiConnectionThreadPoolConfiguration

Oc4jThreadPool (Structural property)

n/a

All permitted values

No

No

The RMI-Connection Oc4jThreadPool with which this ManagedOc4j is associated.

RmiLookupTimeout

int

5000

Min=1, Max=10000

Yes

No

RMI lookup timeout value (in milliseconds) for this Oc4j.

RmiPortMaxValue

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The maximum value for rmi port range

RmiPortMinValue

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The minimum value for rmi port range

RmiRequestThreadPoolConfiguration

Oc4jThreadPool (Structural property)

n/a

All permitted values

No

No

The RMI-Request Oc4jThreadPool with which this ManagedOc4j is associated.

RmisPortMaxValue

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The maximum value for rmis port range

RmisPortMinValue

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The minimum value for rmis port range

SipContainer

SipContainer

n/a

All permitted values

Yes

No

The SipContainer with which this ManagedOc4j is associated.

StartJavaExecutionArguments

JavaExecutionArguments

n/a

All permitted values

Yes

No

Arguments for the Java Virtual Machine when starting this component

StopJavaExecutionArguments

JavaExecutionArguments

n/a

All permitted values

Yes

No

Arguments for the Java Virtual Machine when starting this component

SystemThreadPoolConfiguration

Oc4jThreadPool (Structural property)

n/a

All permitted values

No

No

The System Oc4jThreadPool with which this ManagedOc4j is associated.

ManagedOc4jCluster

The following properties are available for ManagedOc4jCluster:

Table 4-83 ManagedOc4jCluster Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AdminPassword

SecureString

n/a

All permitted values

Yes

No

the password of the oc4j admin user

AjpsEnabled

boolean

false

All permitted values

Yes

No

If Ajps is enabled for this Oc4j cluster.

ManagedOc4js

Set<ManagedOc4j> (Structural property)

n/a

All permitted values

Yes

No

The set of Oc4j associated with this cluster.

OrmisEnabled

boolean

true

All permitted values

Yes

No

If ormis is enabled for this Oc4j Cluster.

ManagedOc4jCluster.HealthMonitorProperties

No other properties exist for ManagedOc4jCluster.HealthMonitorProperties .

ManagementService

The following properties are available for ManagementService:

Table 4-84 ManagementService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AutoSyncSaveListenerSleepIntervalInSeconds

int

25

All permitted values

Yes

No

The interval (in seconds) after which the background task to synchronize any pending configuration changes to local configuration files will be invoked.

AutoSyncSaveListenerTimeoutInSeconds

int

20

All permitted values

Yes

No

The interval (in seconds) after which batched local configuration file changes will be saved and necessary actions like restarting processes initiated to effect the changes.

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

ExportConfigurationEnabled

boolean

true

All permitted values

Yes

No

Enables or disables the configuration export background task.

LocalFileSyncEnabled

boolean

false

All permitted values

Yes

No

When set to true, the management service detects changes to the system model and automatically updates local configuration files to be in sync.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

LogSearchMaximumResults

Integer

n/a

All permitted values

Yes

No

Maximum number of records returned when searching for logs.

LogSyncEnabled

boolean

true

All permitted values

Yes

No

Sets whether the background task for log synchronization is enabled.

LogUploadFilter

String

n/a

All permitted values

Yes

No

Filter for selecting the log files or directories to upload to the central repository so that they can be viewed or searched in the log viewer user interface.

LogUploadInterval

int

6

All permitted values

Yes

No

Frequency (in minutes) of the background log upload task.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

StabilityMonitorProperties

ManagementService.StabilityMonitorProperties

n/a

All permitted values

No

Yes

long description key not set

SystemDataCollectorProperties

ManagementService.SystemDataCollectorProperties

n/a

All permitted values

Yes

No

long description key not set

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

UploadLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

Log records of this or higher level are uploaded to the configuration database.

ManagementService.StabilityMonitorProperties

The following properties are available for ManagementService.StabilityMonitorProperties:

Table 4-85 ManagementService.StabilityMonitorProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

StabilityMonitorEnabled

boolean

false

All permitted values

Yes

No

Is the Beehive Cluster Stability Monitor enabled

ManagementService.SystemDataCollectorProperties

The following properties are available for ManagementService.SystemDataCollectorProperties:

Table 4-86 ManagementService.SystemDataCollectorProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

CollectionInterval

int

300

Min=1, Max=2147483647

Yes

No

Time interval between executions of system data collector background task

CollectorEnabled

boolean

false

All permitted values

Yes

No

Enables or disables the system data collector background task.

SystemDataFileRotationInterval

int

180

Min=1, Max=525600

Yes

No

System data collector will rotate file after this interval

SystemDataFileRotationSize

int

100

Min=1, Max=1024

Yes

No

Rotation size for the file generated by system data collector

MimService

The following properties are available for MimService:

Table 4-87 MimService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AutoOfflineTimeAfterClientDisconnect

int

86400

Min=600, Max=86400

Yes

No

When client is in disconnected mode and in 'away' state, this time would specify in sec when server would set 'offline' and cleanup everything including backend Instant Messaging sessions.

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MaxInvalidLoginAttempt

int

3

Min=1, Max=5

Yes

No

Maximum number of LOGIN attempts before server closes the client connection. After opening a new connection, client can make only a certain maximum number of attempt to successfully LOGIN. If the maximum attempt reached and client fails then server closes the connection.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

UnauthConnectionLiveTime

int

60

Min=30, Max=120

Yes

No

After client connects it has to finish authentication with in a specified amount time, otherwise server will cleanup the connection. This property would specify in second. how much time it would wait before closing the connection.

MobileDmService

The following properties are available for MobileDmService:

Table 4-88 MobileDmService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MaxClientConnections

int

1000

Min=100, Max=5000

Yes

No

Maximum number of concurrent mobile clients connections per Mobile DM Server instance.

MaxInvalidAttempts

int

3

Min=3, Max=10

Yes

No

Maximum number of invalid command attempts before the server closes the connection.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

TtlAuthenticated

int

30

Min=15, Max=60

Yes

No

Timeout for authenticated sessions in minutes.

TtlUnauthenticated

int

1

Min=1, Max=10

Yes

No

Timeout for non-authenticated sessions in minutes.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

NamedSystemObject

The following properties are available for NamedSystemObject:

Table 4-89 NamedSystemObject Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Name

String

n/a

All permitted values

Yes

No

the name of the system object.

NotificationDeliveryService

The following properties are available for NotificationDeliveryService:

Table 4-90 NotificationDeliveryService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

ActionAskSettings

NotificationDeliveryService.ActionAskSettings

n/a

All permitted values

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.NotificationDeliveryServiceBundle, key ACTION_ASK_SETTINGS_LONG_DESCRIPTION

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

DeliveryPoolSize

int

20

Min=1, Max=100

Yes

No

This value defines how many threads will be used for the delivery processing thread pool. The default value is 20.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MaxDeliveryStatusAge

int

15

Min=1, Max=365

Yes

No

This value defines how long delivery records will be retained in the system. The default value is 15 days.

MaxTrackingAge

int

15

Min=1, Max=365

Yes

No

Age to keep notification history to avoid duplicate notifications.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

SmsSettings

NotificationDeliveryService.SmsSettings

n/a

All permitted values

Yes

No

Defines SMS settings.

SystemUserName

String

SYSTEM

All permitted values

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.NotificationDeliveryServiceBundle, key SYSTEM_USER_NAME_LONG_DESCRIPTION

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

XmsSettings

NotificationDeliveryService.XmsSettings

n/a

All permitted values

Yes

No

Defines the XMS credential settings used for SMS delivery when SmsMode is set to XMS.

NotificationDeliveryService.ActionAskSettings

The following properties are available for NotificationDeliveryService.ActionAskSettings:

Table 4-91 NotificationDeliveryService.ActionAskSettings Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

ActionableEmailsNotificationDisabled

boolean

false

All permitted values

Yes

No

Disables actionable notification E-Mails.

ActionableIMsNotificationDisabled

boolean

false

All permitted values

Yes

No

Disables actionable notification Instant Messages.

ActionableNotificationReplyDisabled

boolean

false

All permitted values

Yes

No

Disables actionable notification responses.

ActionableNotificationUser

CollabId

n/a

All permitted values

Yes

No

Defines the actionable notification user identifier.

ActionableSMSNotificationDisabled

boolean

false

All permitted values

Yes

No

Disables actionable notification SMS.

ProcessingPoolSize

int

20

Min=1, Max=100

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.NotificationDeliveryServiceBundle, key ASK_PROCESSINGPOOL_SIZE_LONG_DESCRIPTION

UserCacheSize

int

512

Min=1, Max=2147483647

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.NotificationDeliveryServiceBundle, key ASK_USER_CACHE_LONG_DESCRIPTION

NotificationDeliveryService.SmsSettings

The following properties are available for NotificationDeliveryService.SmsSettings:

Table 4-92 NotificationDeliveryService.SmsSettings Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

MaxSmsChunks

int

5

Min=1, Max=255

Yes

No

This value defines the maximum number of chunks a single SMS can be broken into before it is truncated. The default value is 5.

ShortCode

String

All permitted values

Yes

No

Defines the SMS shortcode used for outbound SMS deliveries.

ShortCodeType

NotificationDeliveryService.SmsSettings.ShortCodeType (Legal values: INTERNATIONAL, NATIONAL, NETWORK, SUBSCRIBER, ALPHANUMERIC, ABBREVIATED)

INTERNATIONAL

All permitted values

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.NotificationDeliveryServiceBundle, key SMS_SHORT_CODE_TYPE_LONG_DESCRIPTION

SmartMessageCharacterCount

int

1000

Min=500, Max=10000

Yes

No

This value defines the maximum number of chunks a single SMS can be broken into before it is truncated. The default value is 5.

SmsMode

NotificationDeliveryService.SmsSettings.SmsMode (Legal values: XMS, SMPP)

SMPP

All permitted values

Yes

No

This value defines how the built-in SMS delivery handler will process SMS delivery requests. Possible values: XMS, SMPP. The default value is XMS.

NotificationDeliveryService.WebProxySettings

The following properties are available for NotificationDeliveryService.WebProxySettings:

Table 4-93 NotificationDeliveryService.WebProxySettings Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Enabled

boolean

false

All permitted values

Yes

No

Enables the usage of the web proxy settings for http/https requests.

ProxyHostName

String

n/a

All permitted values

Yes

No

Defines a hostname to be used as a proxy for all HTTP/HTTPS communication.

ProxyPassword

SecureString

n/a

All permitted values

Yes

No

Defines a password to be used for the web proxy.

ProxyPort

int

8080

All permitted values

Yes

No

Defines a port number to be used for all proxied HTTP/HTTPS communication. Default value: 8080

ProxyUserName

String

n/a

All permitted values

Yes

No

Defines a username to be used for the web proxy.

NotificationDeliveryService.XmsSettings

The following properties are available for NotificationDeliveryService.XmsSettings:

Table 4-94 NotificationDeliveryService.XmsSettings Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

WebProxySettings

NotificationDeliveryService.WebProxySettings

n/a

All permitted values

Yes

No

Defines the HTTP proxy which is used for SOAP based communications.

XmsPassword

SecureString

n/a

All permitted values

Yes

No

Password for XMS communication.

XmsServiceUrl

String

All permitted values

Yes

No

XMS service URL.

XmsUserName

String

n/a

All permitted values

Yes

No

Username for XMS communication.

ObjectEventPublisherService

The following properties are available for ObjectEventPublisherService:

Table 4-95 ObjectEventPublisherService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

Oc4j

The following properties are available for Oc4j:

Table 4-96 Oc4j Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AdminPassword

SecureString

n/a

All permitted values

Yes

No

the password of the oc4j admin user

AdminUsername

String

oc4jadmin

All permitted values

Yes

No

the name of the oc4j admin user

Applications

Set<BeehiveJ2eeApplication> (Structural property)

n/a

All permitted values

Yes

No

The list of BeehiveJ2eeApplications associated with the Oc4j instance.

Database

Database

n/a

All permitted values

Yes

No

This database holds the configuration data and holds business data for any Enterprise that does not have its own dedicated storage.

Oc4jName

String

n/a

All permitted values

No

No

the name of the oc4j

PseudoTranslationEnabled

boolean

false

All permitted values

Yes

No

A Boolean flag that is used to enable/disable the pseudo-translation in Beehive Resource Bundle.

PseudoTranslationStrategy

String

n/a

All permitted values

Yes

No

The class name of pseudo translation algorithm that will be used for translation process by Beehive Resource Bundle.

ResourceAdapterInstances

Set<ResourceAdapterInstance> (Structural property)

n/a

All permitted values

Yes

No

The list of ResourceAdapterInstances associated with the Oc4j instance.

RmiClientTimeout

int

1200

Min=1, Max=2147483647

Yes

No

RMI client timeout value (in seconds) for this Oc4j.

RmiLookupTimeout

int

5000

Min=1, Max=10000

Yes

No

RMI lookup timeout value (in milliseconds) for this Oc4j.

OmaService

The following properties are available for OmaService:

Table 4-97 OmaService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

CalendarSyncEnabled

boolean

true

All permitted values

Yes

No

Enables or disables calendar synchronization.

ContactsSyncEnabled

boolean

true

All permitted values

Yes

No

Enables or disables contacts synchronization.

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

DbLogKeepDays

int

7

Min=1, Max=2147483647

Yes

No

Number of days to keep the session log and SyncML message log in the database. Log entries older than this will be purged automatically.

DeviceMetaDataCacheSize

int

10000

Min=1, Max=2147483647

Yes

No

Maximum devices to cache.

DsSessionCacheSize

int

1000

Min=1, Max=2147483647

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.OmaServiceResourceBundle, key DSSESSION_CACHE_SIZE_LONG_DESCRIPTION

EmailNumberLimit

int

200

Min=1, Max=2147483647

Yes

No

The maximum number of e-mails that may be downloaded to a device. Together with the MaxSyncRangeBack property, the number of e-mails to download is restricted.

EmailSyncEnabled

boolean

true

All permitted values

Yes

No

Enables or disables e-mail synchronization.

EntitiesPerBulkLoad

int

25

Min=1, Max=1000

Yes

No

Maximum entities per bulk load.

EntitiesPerContactBulkLoad

int

25

Min=1, Max=1000

Yes

No

Maximum entities per contact bulk load.

EntitiesPerEmailBulkLoad

int

25

Min=1, Max=1000

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.OmaServiceResourceBundle, key ENTITIES_PER_EMAIL_BULK_LOAD_LONG_DESCRIPTION

EntitiesPerEventBulkLoad

int

25

Min=1, Max=1000

Yes

No

Maximum entities per event bulk load.

EntitiesPerNoteBulkLoad

int

25

Min=1, Max=1000

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.OmaServiceResourceBundle, key ENTITIES_PER_TASK_NOTE_LOAD_LONG_DESCRIPTION

EntitiesPerTaskBulkLoad

int

25

Min=1, Max=1000

Yes

No

Maximum entities per task bulk load.

EventSyncRangeValidationThreshold

int

51

All permitted values

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.OmaServiceResourceBundle, key THRESHOLD_WHERE_SYNC_RANGE_VALIDATION_STARTS_TO_OCCUR_FOR_EVENTS

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

LogSyncmlForUsers

String

All permitted values

Yes

No

Log SyncML for the these users. Specify a comma delimited list of user identifiers.

MaxConcurrentRequests

int

100

Min=1, Max=2147483647

Yes

No

The maximum number of concurrent requests that can be supported by a Oracle Mobile Data Sync Service instance. When this number is reached, subsequent synchronization requests will be refused until the number of concurrent requests drops below this number.

MaxConcurrentSessions

int

400

Min=1, Max=2147483647

Yes

No

The maximum number of concurrent Sync sessions that can be supported by a Oracle Mobile Data Sync Service instance. When this number is reached, subsequent requests to start a Sync will be refused until the number of ongoing Syncs drops below this number.

MaxConcurrentSlowSyncs

int

20

Min=1, Max=2147483647

Yes

No

The maximum number of concurrent slow syncs that can be supported by a Oracle Mobile Data Sync Service instance. When this number is reached, subsequent synchronization requests for a slow sync will be refused until the number of all ongoing slow Syncs becomes less than number.

MaxMessageSize

int

60000

Min=1000, Max=2147483647

Yes

No

Upper limit of the size of the messages exchanged between client and server in bytes. This value will be used if the MaxMessageSize value in a device profile exceeds this limit. Otherwise, the value in the device profile will be used.

MaxObjectSize

int

5000000

Min=1000, Max=2147483647

Yes

No

Upper limit of the size of the large objects exchanged between client and server in bytes. This value will be used if the MaxObjectSize value in a device profile exceeds this limit. Otherwise, the value in the device profile will be used.

MaxSyncRangeBack

int

365

Min=1, Max=2147483647

Yes

No

The number of days previous to the current date to synchronize.

MaxSyncRangeForward

int

365

Min=1, Max=2147483647

Yes

No

The number of days from the current date to synchronize.

Md5Required

boolean

false

All permitted values

Yes

No

Determines whether MD5 authentication is required (true) or if BASIC authentication is also allowed (false).

Md5Supported

boolean

false

All permitted values

Yes

No

Enables or disables support for MD5 authentication.

NotesSyncEnabled

boolean

true

All permitted values

Yes

No

Enables or disables Outlook Notes synchronization.

OmaDsEnabled

boolean

true

All permitted values

Yes

No

Enables or disables the Oracle Mobile Data Sync Service.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

ResumeEnabled

boolean

true

All permitted values

Yes

No

Enables or disables support for "Suspend and Resume" synchronization after incomplete or failed syncs. Improves performance with clients who support Resume for syncs.

RetriesWhenDbUnavailableDelayInMilliSec

String

1000,5000,9000

All permitted values

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.OmaServiceResourceBundle, key RETRIES_WHEN_DB_UNAVAILABLE_DELAY_IN_MILLISEC

SessionLogRequired

boolean

true

All permitted values

Yes

No

Enables or disables the logging of synchronization sessions in the database.

SessionTimeOut

int

6000

Min=1, Max=2147483647

Yes

No

A synchronization session will timeout if it does not receive a client request after this number of minutes.

SyncmlLogRequired

boolean

false

All permitted values

Yes

No

Enables or disables logging of SyncML messages in the database.

TaskSyncRangeValidationThreshold

int

51

All permitted values

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.OmaServiceResourceBundle, key THRESHOLD_WHERE_SYNC_RANGE_VALIDATION_STARTS_TO_OCCUR_FOR_TASKS

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

OmsResourceAdapter

The following properties are available for OmsResourceAdapter:

Table 4-98 OmsResourceAdapter Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

ResourceAdapterImage

ResourceAdapterImage

n/a

All permitted values

No

Yes

ResourceAdapterImage associated with the ResourceAdapter

ResourceAdapterInstances

Set<ResourceAdapterInstance> (Structural property)

n/a

All permitted values

Yes

No

Set of instances of ResourceAdapter

OmsResourceAdapterInstance

The following properties are available for OmsResourceAdapterInstance:

Table 4-99 OmsResourceAdapterInstance Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

ResourceAdapter

ResourceAdapter

n/a

All permitted values

No

No

ResourceAdapter associated with the instance

Opmn

The following properties are available for Opmn:

Table 4-100 Opmn Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

BeehiveInstance

BeehiveInstance

n/a

All permitted values

Yes

No

BeehiveInstance associated with the OPMN

LocalPort

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

OPMN local port

OpmnCluster

OpmnCluster

n/a

All permitted values

Yes

No

OpmnCluster associated with the OPMN

RemotePort

int

n/a

Network Port, Min=1, Max=65536

Yes

No

OPMN remote port

RequestPort

int

n/a

Network Port, Min=1, Max=65536

Yes

No

OPMN request port

OpmnCluster

The following properties are available for OpmnCluster:

Table 4-101 OpmnCluster Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

NotificationServerSslEnabled

boolean

false

All permitted values

Yes

No

Enables or disables Secure Socket Layers (SSL) for the notification server.

Opmns

Set<Opmn> (Structural property)

n/a

All permitted values

Yes

No

OPMNs associated with the OpmnCluster

OwcStreamingService

The following properties are available for OwcStreamingService:

Table 4-102 OwcStreamingService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

HttpTunnelingEnabled

Boolean

true

All permitted values

Yes

No

description bundle not set

HttpTunnelingPort

Integer

1954

Network Port, Min=1, Max=65536

Yes

No

description bundle not set

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MaxHttpTunnelingClientsAllowed

Integer

100

All permitted values

Yes

No

description bundle not set

MaxRtmpClientsAllowed

Integer

100

All permitted values

Yes

No

description bundle not set

MaxRtspClientsAllowed

Integer

100

All permitted values

Yes

No

description bundle not set

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

RtmpEnabled

Boolean

true

All permitted values

Yes

No

description bundle not set

RtmpPort

Integer

1935

Network Port, Min=1, Max=65536

Yes

No

description bundle not set

RtspEnabled

Boolean

true

All permitted values

Yes

No

description bundle not set

RtspPort

Integer

1554

Network Port, Min=1, Max=65536

Yes

No

description bundle not set

ServiceName

String

DANGSServer/2.0.1

All permitted values

Yes

Yes

description bundle not set

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

PolicyService

The following properties are available for PolicyService:

Table 4-103 PolicyService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

PresenceService

The following properties are available for PresenceService:

Table 4-104 PresenceService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

ActivityStartTimeThreshold

int

300000

All permitted values

Yes

No

description bundle not set

CacheSize

int

1024

All permitted values

Yes

No

description bundle not set

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

PollInterval

int

5

All permitted values

Yes

No

description bundle not set

PublicPresenceEnabled

boolean

true

All permitted values

Yes

No

description bundle not set

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

PushMailService

The following properties are available for PushMailService:

Table 4-105 PushMailService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

HeartbeatInterval

int

300

Min=60, Max=600

Yes

No

Interval in seconds to send a keep-alive command to the IMAP Mail Server to keep the IMAP connection alive.

IMAPConnLiveTime

int

720

Min=5, Max=1440

Yes

No

Backend IMAP connection live time, in minutes after a device connection dies.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MaxConcurrentUsers

int

2000

Min=2, Max=5000

Yes

No

Maximum number of concurrent mobile clients connections per Mobile Mail Server instance.

MaxInboxMessages

int

200

Min=200, Max=1000

Yes

No

Maximum number of inbox messages allowed to sync to device. This is the absolute maximum view filter size, no matter what value the Mobile Client specifies.

MaxMessageSize

int

50

Min=50, Max=200

Yes

No

Maximum message size, in KB, which a user may sync to a device. This is the absolute maximum size, no matter what value the Mobile Client specifies.

NumberDaysPast

int

7

Min=7, Max=14

Yes

No

Maximum number of days past user can fetch messages to sync to their device. This is the absolute maximum days view filter size, no matter what value the Mobile Client specifies.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

PushService

The following properties are available for PushService:

Table 4-106 PushService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

APNSSettings

PushService.APNSSettings

n/a

All permitted values

Yes

No

Defines the Apple Push Nofication Service settings.

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MaxClientConnections

int

1000

Min=100, Max=5000

Yes

No

Maximum number of concurrent mx-based clients connections per Mobile Push Server instance.

MaxInvalidAttempts

int

3

Min=3, Max=10

Yes

No

Maximum number of invalid command attempts before the server closes the connection.

MaxTruePushClientConnections

int

100

Min=1, Max=1000

Yes

No

Maximum number of concurrent HTTP true push-based clients connections per Mobile Push Server instance.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

TtlUnauthenticated

int

1

Min=1, Max=10

Yes

No

Timeout for non-authenticated sessions in minutes.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

PushService.APNSSettings

The following properties are available for PushService.APNSSettings:

Table 4-107 PushService.APNSSettings Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

APNSEnabled

boolean

false

All permitted values

Yes

No

Indicates if APNS is enabled as an outbound channel.

APNSHostName

String

gateway.push.apple.com

All permitted values

Yes

No

Defines the hostname of the APNS gateway.

APNSKeyStoreContents

byte[]

n/a

All permitted values

Yes

No

Contents of the .p12 file that contains the APNS certificate and private key.

APNSPort

int

2195

All permitted values

Yes

No

Defines the port of the APNS gateway. Default value is: 2195

ProxyEnabled

boolean

false

All permitted values

Yes

No

Enables the usage of the web proxy settings for http/https requests.

ProxyHostName

String

n/a

All permitted values

Yes

No

Defines a hostname to be used as a proxy for all HTTP/HTTPS communication.

ProxyPassword

SecureString

n/a

All permitted values

Yes

No

Defines a password to be used for the web proxy.

ProxyPort

int

8080

All permitted values

Yes

No

Defines a port number to be used for all proxied HTTP/HTTPS communication. Default value: 8080

ProxyUserName

String

n/a

All permitted values

Yes

No

Defines a username to be used for the web proxy.

RecordsManagementService

The following properties are available for RecordsManagementService:

Table 4-108 RecordsManagementService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

Urm

Urm

n/a

All permitted values

Yes

No

Records Management Service uses Oracle Universal Records Manager for records management. The URM configuration includes host, port, admin user account details, and agent name of the URM deployment. There can be at most one URM configured in the system.

RemoteContentService

The following properties are available for RemoteContentService:

Table 4-109 RemoteContentService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

DiskSpoolDirectory

String

beehive/rcsspool

All permitted values

Yes

No

description bundle not set

KeystoreAlias

String

n/a

All permitted values

Yes

No

description bundle not set

KeystoreAliasPassword

SecureString

n/a

All permitted values

Yes

No

description bundle not set

KeystoreFile

String

n/a

All permitted values

Yes

No

description bundle not set

KeystorePassword

SecureString

n/a

All permitted values

Yes

No

description bundle not set

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MaxDiskSpoolSpace

int

209715200

All permitted values

Yes

No

description bundle not set

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UCMConnectionTimeout

int

30000

All permitted values

Yes

No

description bundle not set

UCMDefaultSearchMaxResults

int

250

All permitted values

Yes

No

description bundle not set

UCMMaxConnections

int

45

All permitted values

Yes

No

description bundle not set

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

WebDAVMaxConnPerHost

int

15

All permitted values

Yes

No

description bundle not set

WebDAVMaxTotalConns

int

45

All permitted values

Yes

No

description bundle not set

RemoteSite

No other properties exist for RemoteSite .

ResourceAdapter

The following properties are available for ResourceAdapter:

Table 4-110 ResourceAdapter Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

ResourceAdapterImage

ResourceAdapterImage

n/a

All permitted values

No

Yes

ResourceAdapterImage associated with the ResourceAdapter

ResourceAdapterInstances

Set<ResourceAdapterInstance> (Structural property)

n/a

All permitted values

Yes

No

Set of instances of ResourceAdapter

ResourceAdapterImage

The following properties are available for ResourceAdapterImage:

Table 4-111 ResourceAdapterImage Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

RarFileName

String

n/a

All permitted values

No

Yes

Resource Adapter Filename

ResourceAdapterInterface

String

n/a

All permitted values

No

Yes

Management model interface name for Resource Adapter

ResourceAdapterInstance

The following properties are available for ResourceAdapterInstance:

Table 4-112 ResourceAdapterInstance Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

ResourceAdapter

ResourceAdapter

n/a

All permitted values

No

No

ResourceAdapter associated with the instance

ResourceDirectoryService

The following properties are available for ResourceDirectoryService:

Table 4-113 ResourceDirectoryService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AllResourcesReadableByAll

Boolean

false

All permitted values

Yes

No

When true, all resources are considered readable by everyone. When false, explcit access control checks are made to determine the access.

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

SearchSizeLimit

Integer

20000

All permitted values

Yes

No

The maximum number of resource entries to be returned on a list operation. This setting can affect the results of some system administration commands.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

RmServletService

The following properties are available for RmServletService:

Table 4-114 RmServletService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

SAMLIdentity

The following properties are available for SAMLIdentity:

Table 4-115 SAMLIdentity Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

KeyAlias

String

n/a

All permitted values

Yes

No

Specifies the alias for the certificate of the SAML issuer.

Service

boolean

false

All permitted values

Yes

No

Specifies whether the SAML issuer is a trusted service or not. (It is a SAML IdP if it is not a service.)

SearchService

The following properties are available for SearchService:

Table 4-116 SearchService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AttachmentMimetypeBlackList

String

image/,application/ics

All permitted values

Yes

No

This parameter specifies a comma-separated list of attachment mime-types to be discarded from indexing. When processing attachments, for example email attachments, if the mime-type of the attachment starts with one of the specified mime-types, it will be discarded and, as such, its content will not be indexed.

CaptureChanges

String

true

All permitted values

Yes

No

Start or stop the change capture for the search service

ChangeCaptureUserList

String

All permitted values

Yes

No

List of Collab Ids of users or groups for which change capture is allowed. The entries in the list can be seprated by whitespaces (space or tab), comma or a new line. Empty list signifies no restriction.

CrawlJobMaxNapTime

Integer

120

This property has a customized constraint.

Yes

No

The maximal nap time for crawl job. This is the same as long nap time, and short nap time is 50% of the maximal nap time.

CrawlJobThreshold

Integer

5000

This property has a customized constraint.

Yes

No

The threshold of crawl job processing amount. If current run processed more than threshold amount of feeds, crawl job will not nap. If less than threshold, crawl job will take a short nap. If no feeds, crawl job will take a long nap.

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

IndexFragmentationThreshold

Integer

10

This property has a customized constraint.

Yes

No

The index fragmentation threshold. If current fragmentation level is lower than the threshold, index optimization will not happen. Default to 10.

IndexJobMaxNapTime

Integer

120

This property has a customized constraint.

Yes

No

The maximal nap time for index job. This is the same as long nap time, and short nap time is 50% of the maximal nap time.

IndexJobThreshold

Integer

5000

This property has a customized constraint.

Yes

No

The threshold of index job processing amount. If current run processed more than threshold amount of feeds, index job will not nap. If less than threshold, index job will take a short nap. If no feeds, index job will take a long nap.

IndexOptimizationInterval

Integer

0

This property has a customized constraint.

Yes

No

The interval in days between index optimizations with FULL mode. 0 means disabled.

IndexOptimizationMaxTime

Integer

480

This property has a customized constraint.

Yes

No

The maximal time in minutes that can be spent on each index optimization with FULL mode. Default to 480 minutes.

IndexOptimizationStartDate

String

2010-08-01,00:00:00

This property has a customized constraint.

Yes

No

Start date of index optimization in DB time, format is 'YYYY-MM-DD,HH24:MI:SS'. Default to next Sunday 00:00:00.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MaxResults

Integer

1000

This property has a customized constraint.

Yes

No

Maximum number of search results returned by the search service

MaxSnippetEntitySize

Integer

4096

This property has a customized constraint.

Yes

No

The maximum entity size for snippet computation. Value is specified in Bytes. The range is between 0 and 32767Bytes. 0 indicates no snippet computation. Any nonzero value will compute snippets for entities whose size is upto the value specified in the property.Default is 4096

MdataOptimizationInterval

Integer

0

This property has a customized constraint.

Yes

No

The interval in days between mdata optimizations. 0 means disabled.

ParallelQueryDegree

Integer

0

Min=0, Max=15

Yes

No

This parameter is used for improving multi-workspace query performance. It determines how many threads a search query can use per database RAC node dedicated for search (as configured in the search Data-Source). Parallel query is NOT used if one of the following conditions is true: (1) the QueryWithSearchDataSource property is set to false, (2) this parameter is set to 0 (default), or (3) the query is in a single workspace or a set of workspaces in the same partition. When the value of this parameter is 1 and the workspaces correspond to partitions on different RAC nodes, search service spawns one thread per RAC node, each of which executes the query for the set of partitions that is affinitized to the given RAC node, and the results are combined in mid-tier. Currently 0 and 1 are the only supported values. In future release we may allow a value N that is greater than one, when search service can use up to N threads for each RAC node, if the workspaces to query in a RAC node fall in multiple partitions.

ParallelQueryPoolSize

Integer

100

This property has a customized constraint.

Yes

No

This parameter determines the size of the thread-pool from which all parallel search queries will be spawned. This sets the maximum total number of concurrently running threads for search queries.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

SearchDisclaimerText

Map<String,String>

n/a

All permitted values

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.SearchBundle, key SEARCH_DISCLAIMER_LONG_DESC

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

WildcardChar

String

*

All permitted values

Yes

No

Specify the wildcard character for search (Default is *)

Server

The following properties are available for Server:

Table 4-117 Server Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AlternateHostNames

Collection<String>

n/a

All permitted values

Yes

No

A list of alternate host names for the Server. A Server may have multiple host names, for example if there are multiple network interface cards installed.

BeehiveInstances

Set<BeehiveInstance> (Structural property)

n/a

All permitted values

Yes

No

The list of BeehiveInstances associated with the Server.

PrimaryHostName

String

n/a

All permitted values

Yes

No

The primary host name of this Server.

SipListenerIPAddress

String

127.0.0.1

IP Address

Yes

No

The IP address of the Sip listener. Required for Sip integration

Service

The following properties are available for Service:

Table 4-118 Service Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

SesEndptService

The following properties are available for SesEndptService:

Table 4-119 SesEndptService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

Host

String

changethis

All permitted values

Yes

No

The host portion of the url to access the SES endpoint web service.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MaxNoUsersContainsOper

int

5

All permitted values

Yes

No

When SES users do advanced search with Contains operator for creator name, modifier name, participants, the SES Endpoint searches in the directory for usernames containing the user given string. This parameter restricts the number of such matches.

Port

int

0

All permitted values

Yes

No

The port portion of the url to access the SES endpoint web service.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

SesEndptServiceEnabled

boolean

false

All permitted values

Yes

No

Enables or disables the SES endpoint service.

SesTrustedEntityMap

Map<String,SecureString>

n/a

All permitted values

Yes

No

The trusted entity name and password of the SES brokers are stored in this map.The BEECTL command add_trusted_identity is used to add trusted entity credentials which are stored in this map.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

SipContainer

The following properties are available for SipContainer:

Table 4-120 SipContainer Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

ManagedOc4j

ManagedOc4j

n/a

All permitted values

Yes

No

Oc4j associated with the SipContainer

SipEnabled

boolean

true

All permitted values

Yes

No

long description key not set

SipPortMaxValue

int

5080

Network Port, Min=1, Max=65536

Yes

No

Maximum permitted value for SIP protocol port

SipPortMinValue

int

5060

Network Port, Min=1, Max=65536

Yes

No

Minimum permitted value for SIP protocol port

SipGateway

The following properties are available for SipGateway:

Table 4-121 SipGateway Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

GatewayIPAddress

String

n/a

IP Address

Yes

No

IP address of the SIP Gateway

GatewayPort

int

n/a

Network Port, Min=1, Max=65536

Yes

No

Port used to establish outbound connections from site to SIP Gateway

SipGatewayCluster

SipGatewayCluster

n/a

All permitted values

No

No

SipGatewayCluster associated with the SipGateway

SipGatewayCluster

The following properties are available for SipGatewayCluster:

Table 4-122 SipGatewayCluster Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

SipGateways

Set<SipGateway> (Structural property)

n/a

All permitted values

Yes

No

Set of SIP gateways associated with the SipGatewayCluster

Site

The following properties are available for Site:

Table 4-123 Site Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

BeehiveRootLogger

String[]

[oracle.beehive., oracle.csi.]

All permitted values

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.SystemModelBundle, key SITE_BEEHIVE_ROOT_LOGGER_LONG_DESC

BtiGlobalConfiguration

BtiGlobal

n/a

All permitted values

Yes

No

The global Bti configuration

BusinessDatabase

Database

n/a

All permitted values

Yes

No

A database where business data is stored. An Enterprise may be configured with its own business database. If an Enterprise does not have its own database configured, then the business data for that Enterprise gets stored in the Site level BusinessDatabase

CipherKey

SecureString

n/a

All permitted values

Yes

No

description bundle not set

ClusteringEnabled

Boolean

true

All permitted values

Yes

No

If application clustering is enabled for the site

ConfigurationDatabase

Database

n/a

All permitted values

Yes

No

The database where system configuration is stored

Database

Database

n/a

All permitted values

Yes

Yes

This database holds the configuration data and holds business data for any Enterprise that does not have its own dedicated storage.

DatabaseRetryIntervalList

List<Integer>

[1000, 5000, 9000]

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

DiagnosabilitySettings

DiagnosabilitySettings

n/a

All permitted values

Yes

No

The Diagnosability settings

DiagnosticDatabase

Database

n/a

All permitted values

Yes

No

The database where diagnostic data is stored

EnterpriseId

int

54321

All permitted values

Yes

Yes

The enterprise id

Enterprises

Set<Enterprise> (Structural property)

n/a

All permitted values

Yes

No

The set of Enterprise associated with the Site.

EventListenerDatabase

Database

n/a

All permitted values

Yes

No

The database where Event Listener data is stored

HttpServerCluster

HttpServerCluster

n/a

All permitted values

Yes

Yes

The HttpServerCluster associated with this Site.

LanguagePack

byte[]

n/a

All permitted values

Yes

No

The Beehive language pack

LdapServer

LdapServer

n/a

All permitted values

Yes

No

An external LDAP server which can be a source of information that gets synchronized into Beehive and can be used by the Authentication Service to authenticate users.

ManagedOc4jCluster

ManagedOc4jCluster

n/a

All permitted values

Yes

Yes

The ManagedOc4jCluster associated with this Site.

Name

String

n/a

All permitted values

Yes

No

the name of the system object.

OpmnCluster

OpmnCluster

n/a

All permitted values

Yes

Yes

The OpmnCluster associated with the Site.

ReadOnlyBusinessDatabase

Database

n/a

All permitted values

Yes

No

A database where read-only business data is stored. An Enterprise may be configured standby database read-only database access. If an Enterprise does not have read-only database configured, then the read-only data for that Enterprise accesses using BusinessDatabase

RemoteSites

Set<RemoteSite> (Structural property)

n/a

All permitted values

Yes

No

The set of RemotesSite associated with the Site.

ResourceAdapters

Set<ResourceAdapter> (Structural property)

n/a

All permitted values

Yes

No

The set of ResourceAdapters associated with the Site.

SearchDatabase

Database

n/a

All permitted values

Yes

No

The database where Search data is stored

Servers

Set<Server> (Structural property)

n/a

All permitted values

Yes

No

The set of Servers associated with the Site.

Services

Set<Service> (Structural property)

n/a

This property has a customized constraint.

Yes

No

The set of Services associated with the Site.

SipGatewayCluster

SipGatewayCluster

n/a

All permitted values

Yes

Yes

The SipGatewayCluster associated with this Site.

SiteId

int

54321

All permitted values

Yes

Yes

The site id.

SsoKeyAlias

String

n/a

All permitted values

Yes

No

description bundle not set

UnmanagedOc4js

Set<UnmanagedOc4j> (Structural property)

n/a

All permitted values

Yes

No

The set of UnmanagedOc4js associated with the Site.

VirtualServer

VirtualServer

n/a

All permitted values

Yes

No

The VirtualServer associated with the Site.

VirusScanEngineCluster

VirusScanEngineCluster

n/a

All permitted values

Yes

Yes

The cluster of virus scan engines associated with this Site. All engines in the cluster are of the same type, i.e. provided by the same vendor.

Site.DiagnosabilityProperties

No other properties exist for Site.DiagnosabilityProperties .

SmppDeliveryService

The following properties are available for SmppDeliveryService:

Table 4-124 SmppDeliveryService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MoSMSEnabled

boolean

true

All permitted values

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.SmppDeliveryServiceBundle, key SMPP_ENABLE_MO_LONG_DESCRIPTION

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

ShortCodeNumberPlanIndicator

int

-1

Min=-1, Max=255

Yes

No

Defines the Numbering Plan Indicator used by the shortcode for the outbound SMS deliveries.

SmppConnectionCount

int

1

All permitted values

Yes

No

The maximum number of active SMPP connections. This may be more or less than the number of SMPP Delivery Service instances.

SmppEnquireTime

int

45

Min=1, Max=59

Yes

No

The interval in seconds between sending Enquire Link Protocol Data Units to Short Message Service Center.

SmppPassword

SecureString

n/a

All permitted values

Yes

No

The SMPP system password assigned by the Short Message Service Center.

SmppProcessingThreadCount

int

25

All permitted values

Yes

No

Controls the number of threads allocated for background processing of incoming SMS delivery requests.

SmppServiceUrl

String

All permitted values

Yes

No

Defines a hostname/port URL for the SMPP server. Format: host:port Example: smpp.somehost.com:2775 Default port: 2775 (smpp), 3550 (ssmpp)

SmppSystemID

String

All permitted values

Yes

No

The SMPP system ID assigned by the Short Message Service Center.

SmppSystemType

String

All permitted values

Yes

No

The SMPP system sype assigned by the Short Message Service Center.

SmppTimeOut

int

15

Min=1, Max=59

Yes

No

The time in seconds the SMPP client will wait for a response from the Short Message Service Center before closing the connection.

TlsEnabled

boolean

false

All permitted values

Yes

No

Enables or disables TLS support for SMPP connections. Enable if required by the Short Message Service Center.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

UseQuerySMForStatus

boolean

false

All permitted values

Yes

No

Enables or disables the use of QUERY_SM PDU for delivery status reporting.

VersionNumber

SmppDeliveryService.VersionNumber (Legal values: VERSION_33, VERSION_34, VERSION_5)

VERSION_5

All permitted values

Yes

No

Defines which SMPP protocol version will be advertised in the BIND requests. Some providers will reject the BIND request if the protocol version is not one of their supported versions..

SoftwareImage

No other properties exist for SoftwareImage .

StateManageable

No other properties exist for StateManageable .

StatusManageable

No other properties exist for StatusManageable .

SubscriptionActionService

The following properties are available for SubscriptionActionService:

Table 4-125 SubscriptionActionService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

SubscriptionService

The following properties are available for SubscriptionService:

Table 4-126 SubscriptionService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MaxAnchorAgeInDays

int

30

Min=1, Max=30

Yes

No

Maximum allowed anchor age in days when querying "getElementModifications". AnchorToooldException will be thrown if the anchor passed in getElementModifications is older than the maximum allowed anchor age (in days) in configuration.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

SyndicationService

The following properties are available for SyndicationService:

Table 4-127 SyndicationService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

SyndicationServletService

The following properties are available for SyndicationServletService:

Table 4-128 SyndicationServletService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AuthenticationScheme

String

BASIC

This property has a customized constraint.

Yes

No

Default authentication scheme for Syndication Servlet. Accepted values are: BASIC, DIGEST, SSO

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

SystemObject

No other properties exist for SystemObject .

SystemObjectWithHelper

No other properties exist for SystemObjectWithHelper .

SystemObjectWithStats

No other properties exist for SystemObjectWithStats .

TCPCommBasedScanEngine

The following properties are available for TCPCommBasedScanEngine:

Table 4-129 TCPCommBasedScanEngine Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

ScanEngineClientCommPort

Integer

1344

Network Port, Min=1, Max=65536

Yes

No

Communication port used by Beehive for sending client requests to the third-party scan engine.

ScanEngineHostName

String

localhost

All permitted values

Yes

No

Hostname of the server where the third-party scan engine is installed.

VirusScanEngineCluster

VirusScanEngineCluster

n/a

All permitted values

No

No

A VirusScanEngineCluster is made up of scan engines of the same type, i.e by the same provider, configured for the Site or Enterprise. This property shows the VirusScanEngineCluster that this engine belongs to.

TCPCommBasedScanEngineCluster

The following properties are available for TCPCommBasedScanEngineCluster:

Table 4-130 TCPCommBasedScanEngineCluster Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

CacheRefreshInterval

Long

600000

This property has a customized constraint.

Yes

No

The interval at which Beehive VirusScanner process refreshes its in-memory cache with data from the virus defnitions storage.

GatherDetailedStats

Boolean

true

All permitted values

Yes

No

Indicator to determine if detailed stats related to virusscanner needs to be captured. These stats include method stats.

OverrideEngineResultEnabled

Boolean

false

All permitted values

Yes

No

Indicates if Beehive should over-ride certain return scan statuses. This will allow Beehive to treat what the scan engine considers as INFECTED as CLEAN.

ScanEngineCommProtocol

VirusScanEngineCluster.ScanEngineCommProtocol (Legal values: ICAP, CUSTOM)

ICAP

All permitted values

Yes

Yes

The protocol used by Beehive to communicate with the third-party scan service engine.

ScanEngineCommProtocolVer

String

1.0

All permitted values

Yes

Yes

The version of the protocol used to communicate with the third-party scan service.

ScanEngines

Set<VirusScanEngine> (Structural property)

n/a

All permitted values

Yes

No

The set of virus scan engines, of the same type, that are part of this cluster.

ScanServiceProvider

VirusScanEngineCluster.ScanServiceProvider (Legal values: Symantec, TrendMicro, McAfee)

Symantec

All permitted values

Yes

Yes

Engines in a cluster are of the same type and are supplied by this third-party virus scan service provider.

VirusScanPolicy

VirusScanConfigurable.VirusScanPolicy (Legal values: NO_SCAN_OR_REPAIR, SCAN_ONLY, SCAN_AND_REPAIR)

NO_SCAN_OR_REPAIR

All permitted values

Yes

No

Scan policy configured for Beehive. If the policy is set to SCAN_ONLY is set and a request to scan and repair is received, caller will receive an exception.

VirusesToIgnore

List<String>

n/a

All permitted values

Yes

No

List of viruses that Beehive can choose to ignore and treat as un-infected. This list will only be evaluated if the the OverrideEngineResultEnabled is also set to true.

TeamCollaborationApisService

The following properties are available for TeamCollaborationApisService:

Table 4-131 TeamCollaborationApisService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

TeamCollaborationService

The following properties are available for TeamCollaborationService:

Table 4-132 TeamCollaborationService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AsyncThreadPoolSize

int

10

This property has a customized constraint.

Yes

No

The number of threads in the thread pool, used while updating non time-critical data such as page view count and discussions forum change status. Deployments that typically find that the page view count and discussions change status take too long to be updated may improve this behavior by increasing this number above the default. On the other hand, those deployments that anticipate very low concurrent access to the application may benefit by decreasing this value below the default.

CSRFSecurityEnabled

boolean

true

All permitted values

Yes

No

This parameter determines whether the server checks if the CSRF token supplied in the request by the client is valid. If true, it compares the server-side token with the client's; if false, just bypass the validation.

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

ExecutorServiceThreadPoolSize

int

50

Min=1, Max=1023

Yes

No

The number of threads in the thread pool for ExecutorService, used for parallel loading of contents in pages such as home, overview, and profile. Those pages contain mixed contents and typically require multiple CSI/database calls to generate the response. Thus they are designed to spawn several threads in the ExecutorService thread pool to load the contents concurrently.

HelpLink

String

http://www.oracle.com/technology/products/beehive/beehive_users/2_0/teamcollab.htm

All permitted values

Yes

No

A configurable link to help text for Beehive clients.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MaxWkspLogoSize

int

1024

This property has a customized constraint.

Yes

No

Specifies the maximum logo size in KB for workspaces. This value is used when uploading new logos. Only logo images of size smaller than this value is allowed.

MultiTypeListingBatchSize

int

100

This property has a customized constraint.

Yes

No

This number applies to table listings such as recent activity or tagged entities, which includes many types in one table. Default value is set as 100, but is recommended to be increased (always in multiples of 25) on deployments where the primary usage comes from workspaces client.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

RichTextAntiSamyEnabled

boolean

true

All permitted values

Yes

No

Specifies whether or not Rich Text descriptions will be filtered by AntiSamy prior to display in the Team Collaboration Client to remove potentially malicious xhtml and javascript. Valid values: true, false

RichTextAntiSamyPolicyFilePath

String

oracle/ocs/amshare/util/antisamy-strict.xml

All permitted values

Yes

No

Path to the AntiSamy policy xml file, used to configure the AntiSamy XHTML filtering of Rich Text descriptions. The path may be absolute or relative to the Beehive home directory.

SearchResultsBatchSize

int

10

This property has a customized constraint.

Yes

No

This number is similar to MultiTypeListingBatchSize but only applies to search results. Default value is set as 10, and the value should always be in multiples of 10.

TacitEnabled

boolean

false

All permitted values

Yes

No

This parameter determines whether the tacit related UI modules are displayed. By default, it is true. If set to false, all the tacit related UI modules like Connection Requests, Search Interests and Expertise, Interests and Expertise modules are hidden.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

TimeManagementService

The following properties are available for TimeManagementService:

Table 4-133 TimeManagementService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

ConsistencyTasksEnabled

Boolean

true

All permitted values

Yes

No

Enables or disables Time Management consistency background tasks. When enabled, the system will automatically perform various verifications and adjustments to ensure consistency.

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

EnableCleanupTask

Boolean

true

All permitted values

Yes

No

Enables or disables some Oracle Beehive housekeeping cleanup processes. These cleanup tasks include the physical removal of purged resources, meetings and tasks, and typically occur about one month after the system purges such entities.

EnableDynamicParticipants

Boolean

true

All permitted values

Yes

No

Enables or disables the dynamic aspect of composite participants, such as groups and team workspaces. When enabled, future instances of meetings and tasks that include groups or team workspaces as participants will be adjusted automatically to reflect any membership changes.

EnableExternalParticipantNotificationDelivery

Boolean

true

All permitted values

Yes

No

Enables or disables the delivery of notifications to external participants. When enabled, external participants of meetings and tasks will receive e-mail notifications to inform them of new or updated invitations and assignments. Notification e-mails can include iCalendar attachments.

EnableExternalParticipantNotificationsWithIMIP

Boolean

true

All permitted values

Yes

No

Send external mail notifications for meetings that are formatted with iMIP information so that the external recipients can easily import them into their own calendar when using a client that is iMIP capable. This option offers better interoperability with MS Outlook and Google Calendar but the default option (false) is more widely supported.

EnableGenericClassOfTMBusinessEvents

Boolean

false

All permitted values

Yes

No

Enables or disables the generic Time Management business event integration. Does not apply to business events prefixed by TM_, which are raised independently of this property's setting. Enabling generic business events has performance implications.

EnablePresenceIntegration

Boolean

true

All permitted values

Yes

No

Enables or disables presence integration. When enabled, the system will automatically set users' presence settings to "In a meeting" during the periods they are scheduled to attend meetings created in Oracle Beehive.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MaxOccurrencesForUnboundedRecurrence

int

75

All permitted values

Yes

No

Maximum number of occurrences allowed for recurring meetings where the number of occurrences is unspecified. When a recurrence rule is defined during the creation of a new meeting, if the rule does not explicitly specify an end date or a number of occurrences, the number of occurrences created is limited to no more than this value. It is not recommended to increase it to a value above 100 as many Calendar interfaces will create recurring meetings without explicitly specifying a limit and this value will be used. This could cause scalability issues in some calendaring flows. Users that need recurring meetings with more occurrences can explicitly request up to MaxOccurrencesPerSeries occurrences. The recommended value is 75.

MaxOccurrencesPerSeries

Integer

150

All permitted values

Yes

No

Maximum number of occurrences allowed for any recurring meeting. This value must be greater or equal to MaxOccurrencesForUnboundedRecurrence. Increasing this value can cause scalability issues in some server flows or client flows. It is not recommended to increase this value above 250 as loading such large meetings will cause side effects or delays in some calendar interfaces. The recommended value is 150.

MaxSubscriptionBizEventRaisedPerOperation

int

500

All permitted values

Yes

No

No subscription business events are raised for any TM operation that tries to raise more than this limit. This is to reduce the potential load caused by having to raise too many business events for large operations. It is currently only supported for operations relating to meetings and calendars.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

SystemBusyPeriod

TimeManagementService.SystemBusyPeriod

n/a

All permitted values

Yes

No

Defines time periods during which certain non-essential background tasks should not be run. You can define periods for each day, set an entire day to busy, and use the property 'CanRunDuringSystemBusyPeriod' to allow certain tasks to be run during defined busy periods.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

TimeManagementService.AccessControlComputationTaskProperties

No other properties exist for TimeManagementService.AccessControlComputationTaskProperties .

TimeManagementService.ChangeLogsCleanupTaskProperties

The following properties are available for TimeManagementService.ChangeLogsCleanupTaskProperties:

Table 4-134 TimeManagementService.ChangeLogsCleanupTaskProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

CanRunDuringSystemBusyPeriod

Boolean

false

All permitted values

Yes

No

Enables or disbales running the task during the configured system busy period (see property SystemBusyPeriod). When disabled (false), the task will not be allowed to run during the defined SystemBusyPeriod; it will only be run outside that period.

TimeManagementService.ContainerSyncTaskProperties

No other properties exist for TimeManagementService.ContainerSyncTaskProperties .

TimeManagementService.MethodMonitoringCleanupTaskProperties

The following properties are available for TimeManagementService.MethodMonitoringCleanupTaskProperties:

Table 4-135 TimeManagementService.MethodMonitoringCleanupTaskProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

CanRunDuringSystemBusyPeriod

Boolean

false

All permitted values

Yes

No

Enables or disbales running the task during the configured system busy period (see property SystemBusyPeriod). When disabled (false), the task will not be allowed to run during the defined SystemBusyPeriod; it will only be run outside that period.

TimeManagementService.PurgedItemsCleanupProperties

The following properties are available for TimeManagementService.PurgedItemsCleanupProperties:

Table 4-136 TimeManagementService.PurgedItemsCleanupProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

CanRunDuringSystemBusyPeriod

Boolean

false

All permitted values

Yes

No

Enables or disbales running the task during the configured system busy period (see property SystemBusyPeriod). When disabled (false), the task will not be allowed to run during the defined SystemBusyPeriod; it will only be run outside that period.

TimeManagementService.ResourceCleanupProperties

The following properties are available for TimeManagementService.ResourceCleanupProperties:

Table 4-137 TimeManagementService.ResourceCleanupProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

CanRunDuringSystemBusyPeriod

Boolean

false

All permitted values

Yes

No

Enables or disbales running the task during the configured system busy period (see property SystemBusyPeriod). When disabled (false), the task will not be allowed to run during the defined SystemBusyPeriod; it will only be run outside that period.

TimeManagementService.ResourceConsistencyProperties

The following properties are available for TimeManagementService.ResourceConsistencyProperties:

Table 4-138 TimeManagementService.ResourceConsistencyProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

CanRunDuringSystemBusyPeriod

Boolean

false

All permitted values

Yes

No

Enables or disbales running the task during the configured system busy period (see property SystemBusyPeriod). When disabled (false), the task will not be allowed to run during the defined SystemBusyPeriod; it will only be run outside that period.

TimeManagementService.StandardContextCleanupProperties

The following properties are available for TimeManagementService.StandardContextCleanupProperties:

Table 4-139 TimeManagementService.StandardContextCleanupProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

CanRunDuringSystemBusyPeriod

Boolean

false

All permitted values

Yes

No

Enables or disbales running the task during the configured system busy period (see property SystemBusyPeriod). When disabled (false), the task will not be allowed to run during the defined SystemBusyPeriod; it will only be run outside that period.

TimeManagementService.SystemBusyPeriod

The following properties are available for TimeManagementService.SystemBusyPeriod:

Table 4-140 TimeManagementService.SystemBusyPeriod Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Friday

String

7:00-24:00

This property has a customized constraint.

Yes

No

Defines, for this day, the period(s) during which certain non-essential background tasks should not be run. You can set 'XX:XX-YY:YY' to represent a 24h time range, 'BusyAllDay' to block the whole day, or 'NotBusy' to make the whole day available for such tasks.

Monday

String

7:00-24:00

This property has a customized constraint.

Yes

No

Defines, for this day, the period(s) during which certain non-essential background tasks should not be run. You can set 'XX:XX-YY:YY' to represent a 24h time range, 'BusyAllDay' to block the whole day, or 'NotBusy' to make the whole day available for such tasks.

Saturday

String

NotBusy

This property has a customized constraint.

Yes

No

Defines, for this day, the period(s) during which certain non-essential background tasks should not be run. You can set 'XX:XX-YY:YY' to represent a 24h time range, 'BusyAllDay' to block the whole day, or 'NotBusy' to make the whole day available for such tasks.

Sunday

String

NotBusy

This property has a customized constraint.

Yes

No

Defines, for this day, the period(s) during which certain non-essential background tasks should not be run. You can set 'XX:XX-YY:YY' to represent a 24h time range, 'BusyAllDay' to block the whole day, or 'NotBusy' to make the whole day available for such tasks.

Thursday

String

7:00-24:00

This property has a customized constraint.

Yes

No

Defines, for this day, the period(s) during which certain non-essential background tasks should not be run. You can set 'XX:XX-YY:YY' to represent a 24h time range, 'BusyAllDay' to block the whole day, or 'NotBusy' to make the whole day available for such tasks.

Tuesday

String

7:00-24:00

This property has a customized constraint.

Yes

No

Defines, for this day, the period(s) during which certain non-essential background tasks should not be run. You can set 'XX:XX-YY:YY' to represent a 24h time range, 'BusyAllDay' to block the whole day, or 'NotBusy' to make the whole day available for such tasks.

Wednesday

String

7:00-24:00

This property has a customized constraint.

Yes

No

Defines, for this day, the period(s) during which certain non-essential background tasks should not be run. You can set 'XX:XX-YY:YY' to represent a 24h time range, 'BusyAllDay' to block the whole day, or 'NotBusy' to make the whole day available for such tasks.

TimeZoneService

The following properties are available for TimeZoneService:

Table 4-141 TimeZoneService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

TimeZoneService.DatabaseConfiguration

No other properties exist for TimeZoneService.DatabaseConfiguration .

TranscodingService

The following properties are available for TranscodingService:

Table 4-142 TranscodingService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

ArchiveFolderPath

String

/INBOX

All permitted values

Yes

No

description bundle not set

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

UdsCache

The following properties are available for UdsCache:

Table 4-143 UdsCache Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

UdsCacheService

The following properties are available for UdsCacheService:

Table 4-144 UdsCacheService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

BatchInterval

int

5

All permitted values

Yes

No

description bundle not set

BatchLoadSize

int

1000

Min=100, Max=10000

Yes

No

description bundle not set

CacheEnabled

boolean

false

All permitted values

Yes

No

description bundle not set

CacheInitEnabled

boolean

false

All permitted values

Yes

No

description bundle not set

CacheUpdateEnabled

boolean

false

All permitted values

Yes

No

description bundle not set

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MaxHeapPercent

int

50

Min=10, Max=100

Yes

No

description bundle not set

MaxResultCount

int

10000

Min=100, Max=2147483647

Yes

No

description bundle not set

PollingInterval

int

3600

Min=60, Max=2147483647

Yes

No

description bundle not set

PollingLoopThreshold

int

100

Min=1, Max=9999

Yes

No

description bundle not set

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

RetryPollingInterval

int

60

Min=5, Max=1003600

Yes

No

description bundle not set

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

UnmanagedBeehiveInstance

The following properties are available for UnmanagedBeehiveInstance:

Table 4-145 UnmanagedBeehiveInstance Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AvailableNumberOfProcessors

int

1

This property has a customized constraint.

Yes

No

The number of processors committed for the current Oracle Beehive instance. This figure is used by the sizing algorithm to calculate the number of server and client Beehive Transport Infrastructure (BTI) workers, as well as the Oracle Containers for Java (OC4J) instances, required to support the current Oracle Beehive instance.

AvailablePhysicalMemoryInMB

Integer

n/a

This property has a customized constraint.

Yes

No

The amount of physical memory in megabytes (MBs) committed for the current Oracle Beehive instance. This figure is used by the sizing algorithm to calculate the number of Oracle Containers for Java (OC4J) instances required for the current Oracle Beehive instance.

BeehiveInstanceName

String

n/a

All permitted values

Yes

Yes

The name of the current Oracle Beehive instance.

Bti

Bti

n/a

All permitted values

Yes

No

The Oracle Beehive Transport Infrastructure (BTI) associated with the current Oracle Beehive instance.

DiagnosabilitySettings

DiagnosabilitySettings

n/a

All permitted values

Yes

No

A reference to a SystemObject that holds the properties used to configure diagnosability functionality. You do not directly modify the value of this property. You modify the properties of the referenced DiagnosabilitySettings object.

HttpServer

HttpServer

n/a

All permitted values

Yes

No

A reference to the HttpServer SystemObject for the current Oracle Beehive instance. You do not directly modify the value of this property. You configure the HTTP Server by modifying the properties of the referenced HttpServer object.

KeystoreFile

File

n/a

All permitted values

Yes

No

Path of the keystore file associated with the current Oracle Beehive instance.

KeystoreFilePassword

SecureString

n/a

All permitted values

Yes

No

Password for the keystore file associated with the current Oracle Beehive Instance.

LogBaseDir

File

beehive/logs

All permitted values

Yes

No

The base directory where Oracle Beehive will store its log files.

Oc4jInstances

Set<ManagedOc4j> (Structural property)

n/a

All permitted values

Yes

No

The set of references to the SystemObjects that configure the OC4J instances deployed in the current Oracle Beehive instance. The system automatically manages the value of this property. You must never directly modify the value.

Opmn

Opmn

n/a

All permitted values

No

No

This is a reference to the SystemObject that configures OPMN for the current Oracle Beehive instance. The system automatically manages the value of this property. You must never directly modify the value.

OracleHome

String

n/a

All permitted values

No

Yes

The Oracle home for the current Oracle Beehive instance.

Server

Server

n/a

All permitted values

No

No

This is a reference to the SystemObject that represents the Server associated with the current Oracle Beehive instance. The system automatically manages the value of this property.

WalletDir

String

n/a

All permitted values

Yes

No

Directory path of the Oracle Wallet associated with the current Oracle Beehive instance.

WalletPassword

SecureString

n/a

All permitted values

Yes

No

The password for the Oracle Wallet associated with the current Oracle Beehive instance.

UnmanagedOc4j

The following properties are available for UnmanagedOc4j:

Table 4-146 UnmanagedOc4j Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AdminPassword

SecureString

n/a

All permitted values

Yes

No

the password of the oc4j admin user

AdminUsername

String

oc4jadmin

All permitted values

Yes

No

the name of the oc4j admin user

Applications

Set<BeehiveJ2eeApplication> (Structural property)

n/a

All permitted values

Yes

No

The list of BeehiveJ2eeApplications associated with the Oc4j instance.

Database

Database

n/a

All permitted values

Yes

No

This database holds the configuration data and holds business data for any Enterprise that does not have its own dedicated storage.

HostName

String

n/a

All permitted values

No

No

The host name of the server the UnmanagedOc4j belongs to.

Oc4jName

String

n/a

All permitted values

No

No

the name of the oc4j

OpmnRequestPort

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The opmn request port used to contact the UnmanagedOc4j. If null, the RMI port must be set.

PseudoTranslationEnabled

boolean

false

All permitted values

Yes

No

A Boolean flag that is used to enable/disable the pseudo-translation in Beehive Resource Bundle.

PseudoTranslationStrategy

String

n/a

All permitted values

Yes

No

The class name of pseudo translation algorithm that will be used for translation process by Beehive Resource Bundle.

ResourceAdapterInstances

Set<ResourceAdapterInstance> (Structural property)

n/a

All permitted values

Yes

No

The list of ResourceAdapterInstances associated with the Oc4j instance.

RmiClientTimeout

int

1200

Min=1, Max=2147483647

Yes

No

RMI client timeout value (in seconds) for this Oc4j.

RmiLookupTimeout

int

5000

Min=1, Max=10000

Yes

No

RMI lookup timeout value (in milliseconds) for this Oc4j.

RmiPort

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The RMI port used to contact the UnmanagedOc4j

WalletDir

String

n/a

All permitted values

Yes

No

The wallet directory of this UnmanagedOc4j.

WalletPassword

SecureString

n/a

All permitted values

Yes

No

The wallet password of this UnmanagedOc4j.

UnsupportedSystemObject

No other properties exist for UnsupportedSystemObject .

Urm

The following properties are available for Urm:

Table 4-147 Urm Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AgentName

String

BeeAdapter

All permitted values

No

Yes

Records Management Service registers itself as an external agent with URM. This property represents the external agent name that is used by RM Service during registration with URM.

DispositionLoaderInterval

long

1

Min=1, Max=10000

Yes

No

Records Management Service Agent periodically loads disposition instructions from URM. This number specifies in hours the time interval between two successive loads of disposition instructions from URM. Default is one hour.

DispositionProcessorInterval

long

1

Min=1, Max=10000

Yes

No

Records Management Service Agent periodically processes disposition instructions from URM in batches. This indicates the time interval in hours between two successive runs to process and acknowledge the dispositions received from URM. Default is one hour.

RMAdminPassword

SecureString

n/a

All permitted values

No

Yes

The password of the Records Management Administrator in URM. This is used by Records Management Adapter to connect and file records in the URM Deployment.

RMAdminUser

String

rmadmin

All permitted values

No

Yes

The user name of the Records Management Administrator in URM. The Records Management Adapter connects to URM as this user to file records in the URM deployment.

RmAdminEmailId

String

n/a

All permitted values

No

Yes

The Beehive user account used to store outgoing emails to be filed as records.

URMAdapterURL

String

n/a

All permitted values

No

Yes

Records Management Service interacts with URM through Web Services. This URL indicates the service end point URL of the URM deployment for accessing URM Web Services. Typically, the URL is of the form http://host:port/{yoursitename}/{yoursitename}plg.

UserDirectoryService

The following properties are available for UserDirectoryService:

Table 4-148 UserDirectoryService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

ConfigurationParameters

UserDirectoryService.ConfigurationParameters

n/a

All permitted values

Yes

No

Configuration parameter for UDS service.

CustomAttributes

List<CustomAttribute> (Structural property)

n/a

All permitted values

Yes

No

Framework to register the custom properties with UDS service.

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

DirectoryProfiles

List<DirectoryProfile> (Structural property)

n/a

All permitted values

Yes

No

User Directory Service can have many directory profiles. Each of them will point to an external directory server

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

UserDirectoryService.AttributeMap

The following properties are available for UserDirectoryService.AttributeMap:

Table 4-149 UserDirectoryService.AttributeMap Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Fields

List<FieldMap> (Structural property)

n/a

All permitted values

Yes

No

Field map list contains the attribute map between source and target directories.

UserDirectoryService.ConfigurationParameters

The following properties are available for UserDirectoryService.ConfigurationParameters:

Table 4-150 UserDirectoryService.ConfigurationParameters Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

DbRetryCount

int

6

All permitted values

Yes

No

Database retry count.

DbRetryIntervalMilliSeconds

int

30000

All permitted values

Yes

No

Database retry in milli seconds.

GalEntryAccessChecked

boolean

true

All permitted values

Yes

No

Whether global address list entries are access checked when loading the global address list. It may be useful to set this to false if the global address list is fully public.

MaxEntityAddressCount

int

3

All permitted values

Yes

No

Count should not exceed super max count.

SuperMaxEntityAddressCount

int

5

All permitted values

No

No

Super max count is the upper limit. And this is applicable to contacts only

UserDirectoryService.ConfigurationParameters.Attribute

No other properties exist for UserDirectoryService.ConfigurationParameters.Attribute .

UserDirectoryService.CustomAttribute

The following properties are available for UserDirectoryService.CustomAttribute:

Table 4-151 UserDirectoryService.CustomAttribute Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Description

String

n/a

All permitted values

Yes

No

Text describing the property. This is an optional field

Name

String

n/a

All permitted values

Yes

No

Custom property name being registered.

Type

UserDirectoryService.CustomAttribute.CustomPropertyType (Legal values: STRING, BOOLEAN, DOUBLE, DATETIME, COLLABID)

STRING

All permitted values

Yes

No

Property types supported are STRING, BOOLEAN, DOUBLE, DATETIME and IDENTIFIER.

UserDirectoryService.DirectoryAttributeMap

The following properties are available for UserDirectoryService.DirectoryAttributeMap:

Table 4-152 UserDirectoryService.DirectoryAttributeMap Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

DirectoryAttributeMap

Map<String,UserDirectoryService.AttributeMap> (Structural property)

n/a

All permitted values

Yes

No

Each object type can have its own Attribute mapping. Allowed object types are ENTERPRISE_USER, EXTENDED_ENTERPRISE_USER, EXTERNAL_PERSON and STATIC_GROUP

UserDirectoryService.DirectoryCache

The following properties are available for UserDirectoryService.DirectoryCache:

Table 4-153 UserDirectoryService.DirectoryCache Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Enabled

boolean

false

All permitted values

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.UserDirectoryServiceResourceBundle, key UDS_DIR_CACHE_ENABLED_LONG_DESC

MaxCachedEntities

int

0

All permitted values

Yes

No

Maximum number of cached entites; a value of zero will disable snapshot caching. This parameter influences the variable size of the cache.

RefreshIntervalMinutes

int

0

All permitted values

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.UserDirectoryServiceResourceBundle, key UDS_DIR_CACHE_RIM_PROJ_LONG_DESC

UserDirectoryService.DirectoryProfile

The following properties are available for UserDirectoryService.DirectoryProfile:

Table 4-154 UserDirectoryService.DirectoryProfile Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

DefaultFlag

UserDirectoryService.DirectoryProfile.ProfileType (Legal values: DEFAULT, NON_DEFAULT)

n/a

All permitted values

Yes

No

Profiles can have flags like DEFAULT or NON_DEFAULT. If a profile is set as default, then the ldap server object is set on the Site. If it is NON_DEFAULT then, the ldapserver is available with the directory profile

DirectoryAttributeMap

UserDirectoryService.DirectoryAttributeMap

n/a

All permitted values

Yes

No

Attribute map of a directory profile will map source attributes to that of target. A profile can contain mappings for different types of objects like ENTERPRISE_USER, EXTENDED_ENTERPRISE_USER, EXTERNAL_PERSON and STATIC_GROUP

GroupTypeMap

List<GroupTypeMapEntry> (Structural property)

n/a

All permitted values

Yes

No

Group type map of a directory profile will help in synchronizing a group from external directory to target directory. The mapping could be based on the attribute or a DN of the group

ProfileState

UserDirectoryService.DirectoryProfile.ProfileState (Legal values: ENABLE, DISABLE)

DISABLE

All permitted values

Yes

No

Profiles can have state like ENABLE or DISABLE. If the profile is in enabled state, then synchronization will happen from external directory. If it is in disabled state, then synchronization will be turned off. By default the directory profile is disabled

ScopeMap

List<ScopeMapEntry> (Structural property)

n/a

All permitted values

Yes

No

Scope type map of a directory profile will help in synchronizing a user or group from external directory to target directory. The mapping could be based on the attribute or a DN of the user or group

UserTypeMap

List<UserTypeMapEntry> (Structural property)

n/a

All permitted values

Yes

No

User type map of a directory profile will help in synchronizing a user from external directory to target directory. The mapping could be based on the attribute or a DN of the user

UserDirectoryService.FieldMap

The following properties are available for UserDirectoryService.FieldMap:

Table 4-155 UserDirectoryService.FieldMap Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

BeehiveFieldName

String

n/a

All permitted values

Yes

No

Field name can be mapped to an ATTRIBUTE or an ADDRESS or a PROPERTY. Givenname and familyname are some of the examples

BeehiveFieldSubType

String

n/a

All permitted values

Yes

No

Field sub type is mapped to the address schemes. MAILTO and TEL are some of the examples

BeehiveFieldType

UserDirectoryService.FieldMap.BeehiveFieldType (Legal values: ATTRIBUTE, PROPERTY, ADDRESS, PRINCIPAL)

n/a

All permitted values

Yes

No

Target directory fields can be of type ATTRIBUTE or an ADDRESS or a PROPERTY.

SourceAttribute

String

n/a

All permitted values

Yes

No

Source attribute will have the name of the attribute, which will be mapped to the target attribute. Givenname and sn are some of the examples of the source attribute

SourceSpecialHandling

UserDirectoryService.FieldMap.SourceSpecialHandlingType (Legal values: PROXY)

n/a

All permitted values

Yes

No

Source special handling is relevant to Activate Directory. Valid value is PROXY

SourceToTargetFieldValueMapping

List<SourceTargetValueMapping> (Structural property)

n/a

All permitted values

Yes

No

Contains the value mapping between source and target.Used mainly for external inbox feature

UserDirectoryService.FieldMap.SourceTargetValueMapping

The following properties are available for UserDirectoryService.FieldMap.SourceTargetValueMapping:

Table 4-156 UserDirectoryService.FieldMap.SourceTargetValueMapping Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

SourceFieldValue

String

n/a

All permitted values

Yes

No

Attribute value at the external directory.

TargetFieldValue

String

n/a

All permitted values

Yes

No

Attribute value in the target directory.

UserDirectoryService.GroupTypeMapEntry

The following properties are available for UserDirectoryService.GroupTypeMapEntry:

Table 4-157 UserDirectoryService.GroupTypeMapEntry Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

GroupType

UserDirectoryService.DirectoryProfile.GroupType (Legal values: STATIC_GROUP)

n/a

All permitted values

Yes

No

Allowed value is STATIC_GROUP.

SourceFieldName

String

n/a

All permitted values

Yes

No

Name of the external directory attribute. Givenname and sn are some of the examples

SourceFieldType

UserDirectoryService.DirectoryProfile.FieldType (Legal values: DN, ATTRIBUTE)

n/a

All permitted values

Yes

No

Source field type can be an ATTRIBUTE or a DN.

SourceFieldValue

String

n/a

All permitted values

Yes

No

Value associated with external directory attribute.

UserDirectoryService.LdapDirectoryProfile

The following properties are available for UserDirectoryService.LdapDirectoryProfile:

Table 4-158 UserDirectoryService.LdapDirectoryProfile Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

DefaultFlag

UserDirectoryService.DirectoryProfile.ProfileType (Legal values: DEFAULT, NON_DEFAULT)

n/a

All permitted values

Yes

No

Profiles can have flags like DEFAULT or NON_DEFAULT. If a profile is set as default, then the ldap server object is set on the Site. If it is NON_DEFAULT then, the ldapserver is available with the directory profile

DirectoryAttributeMap

UserDirectoryService.DirectoryAttributeMap

n/a

All permitted values

Yes

No

Attribute map of a directory profile will map source attributes to that of target. A profile can contain mappings for different types of objects like ENTERPRISE_USER, EXTENDED_ENTERPRISE_USER, EXTERNAL_PERSON and STATIC_GROUP

GroupTypeMap

List<GroupTypeMapEntry> (Structural property)

n/a

All permitted values

Yes

No

Group type map of a directory profile will help in synchronizing a group from external directory to target directory. The mapping could be based on the attribute or a DN of the group

LdapServer

LdapServer

n/a

All permitted values

Yes

No

Ldap server has the details of the external directory, using which the User Directory Service would connect and get the user and group data.

PollInterval

int

30

This property has a customized constraint.

Yes

No

Time interval at which the external directory will be polled by the synchronization engine. The poll interval is in seconds

ProfileState

UserDirectoryService.DirectoryProfile.ProfileState (Legal values: ENABLE, DISABLE)

DISABLE

All permitted values

Yes

No

Profiles can have state like ENABLE or DISABLE. If the profile is in enabled state, then synchronization will happen from external directory. If it is in disabled state, then synchronization will be turned off. By default the directory profile is disabled

ScopeMap

List<ScopeMapEntry> (Structural property)

n/a

All permitted values

Yes

No

Scope type map of a directory profile will help in synchronizing a user or group from external directory to target directory. The mapping could be based on the attribute or a DN of the user or group

UserTypeMap

List<UserTypeMapEntry> (Structural property)

n/a

All permitted values

Yes

No

User type map of a directory profile will help in synchronizing a user from external directory to target directory. The mapping could be based on the attribute or a DN of the user

UserDirectoryService.MembershipMapEntry

The following properties are available for UserDirectoryService.MembershipMapEntry:

Table 4-159 UserDirectoryService.MembershipMapEntry Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

MembershipCollabId

CollabId

n/a

All permitted values

Yes

No

Identifier of the organization into which the users or groups will be synchronized.

Name

String

n/a

All permitted values

Yes

No

Organization name can be specified and this field is optional.

SourceFieldName

String

n/a

All permitted values

Yes

No

Name of the external directory attribute. Givenname and sn are some of the examples

SourceFieldType

UserDirectoryService.DirectoryProfile.FieldType (Legal values: DN, ATTRIBUTE)

n/a

All permitted values

Yes

No

Source field type can be an ATTRIBUTE or a DN.

SourceFieldValue

String

n/a

All permitted values

Yes

No

Value associated with external directory attribute.

UserDirectoryService.ScopeMapEntry

The following properties are available for UserDirectoryService.ScopeMapEntry:

Table 4-160 UserDirectoryService.ScopeMapEntry Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

MembershipMap

List<MembershipMapEntry> (Structural property)

n/a

All permitted values

Yes

No

Member type map of a directory profile will help in synchronizing a user or group from external directory to target directory. The mapping could be based on the attribute or a DN of the user or group

Name

String

n/a

All permitted values

Yes

No

Enterprise or organization name can be specified and this field is optional.

ScopeCollabId

CollabId

n/a

All permitted values

Yes

No

Enterprise or organization identifier should be specified.

SourceFieldName

String

n/a

All permitted values

Yes

No

Name of the external directory attribute. Givenname and sn are some of the examples

SourceFieldType

UserDirectoryService.DirectoryProfile.FieldType (Legal values: DN, ATTRIBUTE)

n/a

All permitted values

Yes

No

Source field type can be an ATTRIBUTE or a DN.

SourceFieldValue

String

n/a

All permitted values

Yes

No

Value associated with external directory attribute.

UserDirectoryService.UserTypeMapEntry

The following properties are available for UserDirectoryService.UserTypeMapEntry:

Table 4-161 UserDirectoryService.UserTypeMapEntry Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

SourceFieldName

String

n/a

All permitted values

Yes

No

Name of the external directory attribute. Givenname and sn are some of the examples

SourceFieldType

UserDirectoryService.DirectoryProfile.FieldType (Legal values: DN, ATTRIBUTE)

n/a

All permitted values

Yes

No

Source field type can be an ATTRIBUTE or a DN.

SourceFieldValue

String

n/a

All permitted values

Yes

No

Value associated with external directory attribute.

UserType

UserDirectoryService.DirectoryProfile.UserType (Legal values: ENTERPRISE_USER, EXTENDED_ENTERPRISE_USER, EXTERNAL_PERSON)

n/a

All permitted values

Yes

No

Can have 3 different types of users. They are ENTERPRISE_USER, EXTENDED_ENTERPRISE_USER and EXTERNAL_PERSON

VirtualServer

The following properties are available for VirtualServer:

Table 4-162 VirtualServer Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

BtiClientPort

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The virtual port for MX client

BtiSecureClientPort

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The secure virtual port for MX client

FtpPort

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The FTP virtual port.

HttpPort

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The Http virtual Port.

HttpSslEnabled

Boolean

true

All permitted values

Yes

No

If Http SSL is enabled for this VirtualServer.

HttpSslPort

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The secure Http virtual Port.

IPAddress

String

n/a

All permitted values

Yes

No

The VirtualServer Ip Address.

ImapPort

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The IMAP virtual port.

ImapSslEnabled

boolean

false

All permitted values

Yes

No

If IMAP SSL is enabled.

ImapSslPort

Integer

993

Network Port, Min=1, Max=65536

Yes

No

The secure IMAP port.

MxTunnelHostname

String

n/a

All permitted values

Yes

No

The ServerName of the VirtualServer.

MxTunnelPort

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The secure Http virtual Port.

ServerName

String

n/a

All permitted values

Yes

No

The ServerName of the VirtualServer.

SmtpAuthRequired

boolean

false

All permitted values

Yes

No

If SMTP authentication is required.

SmtpPort

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The SMTP virtual port.

SmtpSslEnabled

boolean

false

All permitted values

Yes

No

If SMTP SSL is enabled.

SmtpSslPort

Integer

465

Network Port, Min=1, Max=65536

Yes

No

The secure SMTP virtual port.

XmppPort

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The XMPP virtual port.

XmppSslEnabled

Boolean

false

All permitted values

Yes

No

If XMPP SSL is enabled.

XmppSslPort

Integer

n/a

Network Port, Min=1, Max=65536

Yes

No

The secure XMPP port.

VirusScanConfigurable

The following properties are available for VirusScanConfigurable:

Table 4-163 VirusScanConfigurable Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

OverrideEngineResultEnabled

Boolean

false

All permitted values

Yes

No

Indicates if Beehive should over-ride certain return scan statuses. This will allow Beehive to treat what the scan engine considers as INFECTED as CLEAN.

VirusScanPolicy

VirusScanConfigurable.VirusScanPolicy (Legal values: NO_SCAN_OR_REPAIR, SCAN_ONLY, SCAN_AND_REPAIR)

NO_SCAN_OR_REPAIR

All permitted values

Yes

No

Scan policy configured for Beehive. If the policy is set to SCAN_ONLY is set and a request to scan and repair is received, caller will receive an exception.

VirusesToIgnore

List<String>

n/a

All permitted values

Yes

No

List of viruses that Beehive can choose to ignore and treat as un-infected. This list will only be evaluated if the the OverrideEngineResultEnabled is also set to true.

VirusScanEngine

The following properties are available for VirusScanEngine:

Table 4-164 VirusScanEngine Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

VirusScanEngineCluster

VirusScanEngineCluster

n/a

All permitted values

No

No

A VirusScanEngineCluster is made up of scan engines of the same type, i.e by the same provider, configured for the Site or Enterprise. This property shows the VirusScanEngineCluster that this engine belongs to.

VirusScanEngineCluster

The following properties are available for VirusScanEngineCluster:

Table 4-165 VirusScanEngineCluster Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

CacheRefreshInterval

Long

600000

This property has a customized constraint.

Yes

No

The interval at which Beehive VirusScanner process refreshes its in-memory cache with data from the virus defnitions storage.

GatherDetailedStats

Boolean

true

All permitted values

Yes

No

Indicator to determine if detailed stats related to virusscanner needs to be captured. These stats include method stats.

OverrideEngineResultEnabled

Boolean

false

All permitted values

Yes

No

Indicates if Beehive should over-ride certain return scan statuses. This will allow Beehive to treat what the scan engine considers as INFECTED as CLEAN.

ScanEngineCommProtocol

VirusScanEngineCluster.ScanEngineCommProtocol (Legal values: ICAP, CUSTOM)

ICAP

All permitted values

Yes

Yes

The protocol used by Beehive to communicate with the third-party scan service engine.

ScanEngineCommProtocolVer

String

1.0

All permitted values

Yes

Yes

The version of the protocol used to communicate with the third-party scan service.

ScanEngines

Set<VirusScanEngine> (Structural property)

n/a

All permitted values

Yes

No

The set of virus scan engines, of the same type, that are part of this cluster.

ScanServiceProvider

VirusScanEngineCluster.ScanServiceProvider (Legal values: Symantec, TrendMicro, McAfee)

Symantec

All permitted values

Yes

Yes

Engines in a cluster are of the same type and are supplied by this third-party virus scan service provider.

VirusScanPolicy

VirusScanConfigurable.VirusScanPolicy (Legal values: NO_SCAN_OR_REPAIR, SCAN_ONLY, SCAN_AND_REPAIR)

NO_SCAN_OR_REPAIR

All permitted values

Yes

No

Scan policy configured for Beehive. If the policy is set to SCAN_ONLY is set and a request to scan and repair is received, caller will receive an exception.

VirusesToIgnore

List<String>

n/a

All permitted values

Yes

No

List of viruses that Beehive can choose to ignore and treat as un-infected. This list will only be evaluated if the the OverrideEngineResultEnabled is also set to true.

VoiceMessageService

The following properties are available for VoiceMessageService:

Table 4-166 VoiceMessageService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

DebugFlags

Integer

0

All permitted values

Yes

No

long description key not set

EmailResendingEnabled

boolean

true

All permitted values

Yes

No

long description key not set

FacilityProperties

VoiceMessageService.FacilityProperties

n/a

All permitted values

Yes

No

long description key not set

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

VoiceMessageProperty

String

n/a

All permitted values

Yes

No

long description key not set

VoiceMessageService.EnterpriseProperties

The following properties are available for VoiceMessageService.EnterpriseProperties:

Table 4-167 VoiceMessageService.EnterpriseProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

EnterpriseCollabId

String

n/a

All permitted values

Yes

No

long description key not set

ExclusiveAudioContentURIs

List<String>

n/a

All permitted values

Yes

No

URI to where exclusive (application specific) audio content can be found by a VoiceXML router. This is optional.

Name

String

n/a

All permitted values

Yes

No

The name of the Enterprise. For example, "Oracle" or "General Motors".

RecordPlaybackURIs

List<String>

n/a

All permitted values

Yes

No

The URI where audio, spoken by a caller, is received by the server and stored in the database. This is optional. Reasons for setting it is if an environment is configured with a load balancer or different security settings. For example, the server may always require SSL, but streaming by not. By default the value is http://[host]:[port]/voice-servlet/vmail/crs. However, if the server is behind a load balancer with multiple midtiers, then the URI of the load balancer should be specified: http://beehive.example.com/voice-servlet/vmail/crs. NOTE: The scheme (http/https), host and port are the only things that are configurable. The remaining parts of the path are note. If NOT set at the Facility level, then the Enterprise value is used.

RecordStreamURIs

List<String>

n/a

All permitted values

Yes

No

The URI where audio, spoken by a caller, is received by the server and stored in the database. This is optional. Reasons for setting it is if an environment is configured with a load balancer or different security settings. For example, the server may always require SSL, but streaming by not. By default the value is http://[host]:[port]/voice-servlet/vmail/crs. However, if the server is behind a load balancer with multiple midtiers, then the URI of the load balancer should be specified: http://beehive.example.com/voice-servlet/vmail/crs. NOTE: The scheme (http/https), host and port are the only things that are configurable. The remaining parts of the path are note. If NOT set at the Facility level, then the Enterprise value is used.

SharedAudioContentURIs

List<String>

n/a

All permitted values

Yes

No

Shared audio refers to audio that is generic across all voice services: integers, digits, phone numbers, dates, times, etc. Setting this is optional. Reasons for setting it is if an environment is configured such that these audio resources are on a separate server from the one currently deployed. By default the value will be relative to the application: ../shared-audio. If NOT set at the Facility level, then the Enterprise value is used.

TelephoneAnsweringAddress

String

n/a

All permitted values

Yes

No

The email address that appears in the 'from' field of an email when a voice mail is received from an unknown caller. This email address must exist in Beehive. When the sender is known, then his or her email address is used. But, this email address is only when the caller is unknown and is required to exist, but not monitored to receive email responses.

VoiceMessageService.FacilityProperties

The following properties are available for VoiceMessageService.FacilityProperties:

Table 4-168 VoiceMessageService.FacilityProperties Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

ExclusiveAudioContentURIs

List<String>

n/a

All permitted values

Yes

No

URI to where exclusive (application specific) audio content can be found by a VoiceXML router. This is optional.

FacilityCollabId

String

n/a

All permitted values

Yes

No

long description key not set

Name

String

n/a

All permitted values

Yes

No

"Facility" is a well-defined technical notion for voice mail. It referes to a group of people and associated telephone equipment and other information, such as the local number to dial in to hear voice messages. Historically, Facilities have been identified with geographical locations, such as corporate headquarters, or the Chicago field office, but this is not strictly necessary. Example of Facility names are "Headquarters" and "Chicago Sears Tower Office".

RecordPlaybackURIs

List<String>

n/a

All permitted values

Yes

No

The URI where audio, spoken by a caller, is received by the server and stored in the database. This is optional. Reasons for setting it is if an environment is configured with a load balancer or different security settings. For example, the server may always require SSL, but streaming by not. By default the value is http://[host]:[port]/voice-servlet/vmail/crs. However, if the server is behind a load balancer with multiple midtiers, then the URI of the load balancer should be specified: http://beehive.example.com/voice-servlet/vmail/crs. NOTE: The scheme (http/https), host and port are the only things that are configurable. The remaining parts of the path are note.

RecordStreamURIs

List<String>

n/a

All permitted values

Yes

No

The URI where audio, spoken by a caller, is received by the server and stored in the database. This is optional. Reasons for setting it is if an environment is configured with a load balancer or different security settings. For example, the server may always require SSL, but streaming by not. By default the value is http://[host]:[port]/voice-servlet/vmail/crs. However, if the server is behind a load balancer with multiple midtiers, then the URI of the load balancer should be specified: http://beehive.example.com/voice-servlet/vmail/crs. NOTE: The scheme (http/https), host and port are the only things that are configurable. The remaining parts of the path are note.

SharedAudioContentURIs

List<String>

n/a

All permitted values

Yes

No

Shared audio refers to audio that is generic across all voice services: integers, digits, phone numbers, dates, times, etc. Setting this is optional. Reasons for setting it is if an environment is configured such that these audio resources are on a separate server from the one currently deployed. By default the value will be relative to the application: ../shared-audio

VoiceServletService

The following properties are available for VoiceServletService:

Table 4-169 VoiceServletService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

WebdavService

The following properties are available for WebdavService:

Table 4-170 WebdavService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AuthenticationScheme

String

BASIC

This property has a customized constraint.

Yes

No

Default authentication scheme for WebDAV server. Accepted values are: BASIC, DIGEST, DIGEST-BASIC.

BrowserSessionTimeout

int

30

This property has a customized constraint.

Yes

No

Length of idle time (in minutes) after which browser session will expire.

DMSInstrumentation

boolean

false

All permitted values

Yes

No

Enables or disables collection of Dynamic Monotoring System statistics.

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

DavClientSessionTimeout

int

960

This property has a customized constraint.

Yes

No

Idle time (in minutes) until the Pure WebDAV client session is timed out.

DefaultWelcomeDocs

String[]

[index.html, index.htm]

All permitted values

Yes

No

The array (comma-delimited list) of welcome document names that are served up if a GET is done on a collection containing one of these documents.

DepthLimit

int

3

Min=1, Max=6

Yes

No

The depth limit to be used for PROPFIND when depth of infinity is specified by the WebDAV client.

DisplayLastModifiedBy

boolean

true

All permitted values

Yes

No

Enables or disables display of the last-modified user in generated HTML index pages.

DisplayLastModifiedOn

boolean

true

All permitted values

Yes

No

Enables or disables display of the last-modified time (date and time) in generated HTML index pages.

DisplayLockStatus

boolean

false

All permitted values

Yes

No

Enables or disables display of locked status in generated HTML index pages.

DisplayVersioningStatus

boolean

false

All permitted values

Yes

No

Enables or disables display of versioning information in generated HTML index pages.

DownloadBufferSize

int

261888

Min=16384, Max=1048576

Yes

No

The buffer size, in bytes, used while downloading stream data. Deployments that typically stream small files, as well as those with limited midtier memory, may improve performance by setting this value below the default. Deployments with a large amount of midtier memory may likewise improve performance by setting this value above the default.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MinimumLockTimeout

int

4

This property has a customized constraint.

Yes

No

The minimum timeout value (in minutes) that a client can request while acquiring a lock.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

UploadBufferSize

int

260096

Min=16384, Max=1048576

Yes

No

The buffer size, in bytes, used while uploading stream data. Deployments that typically stream small files, as well as those with limited midtier memory, may improve performance by setting this value below the default. Deployments with a large amount of midtier memory may likewise improve performance by setting this value above the default.

UserPreferenceRefreshTime

int

180

This property has a customized constraint.

Yes

No

Length of time (in minutes) before user preferences are refreshed.

WebDAVServerEnabled

boolean

true

All permitted values

Yes

No

Enables or disables the WebDAV server. When set to false, the WebDAV server will return an exception.

WikiService

The following properties are available for WikiService:

Table 4-171 WikiService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

PluginHtmlAntiSamyEnabled

boolean

true

All permitted values

Yes

No

Specifies whether or not Rich Text descriptions will be filtered by AntiSamy prior to display in the Team Collaboration Client to remove potentially malicious xhtml and javascript. Valid values: true, false

PluginHtmlAntiSamyPolicyFilePath

String

oracle/ocs/amshare/util/antisamy-strict.xml

All permitted values

Yes

No

Path to the AntiSamy policy xml file, used to configure the AntiSamy XHTML filtering of Rich Text descriptions. The path may be absolute or relative to the Beehive home directory.

PluginHtmlEnabled

boolean

false

All permitted values

Yes

No

Specifies whether or not users can insert raw html into wiki pages using the html plugin. Valid values: true, false

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

WikiTextReplace

List<String>

n/a

All permitted values

Yes

No

This service property allows administrators to specify a list of regular expressions that will be applied to rendered WikiPages for display purposes. The regular expressions should follow the standard Perl regular expression syntax, for example: s/match/replace/g. Please see Perl documentation for more information on regular expressions. The regular expressions are applied to each text node in the HTML after all XHTML related escaping is done so it is the responsibility of the administrator to write regular expressions that are safe for insert directly into HTML pages. This also means that when attempting to match characters <, >, &, ", ', the administrator should use &lt;, &gt;, &amp;,&quot;, &#39; instead, respectively. The regular expressions will be applied to the WikiPage text nodes in the order that they are provided in beectl. Please note that the administrator must re-specify all regular expressions if they want to add another one. Similarly, if the administrator wants to remove one, then all of the existing regular expressions need to be specified except for the one to be removed. For these reasons, administrators are strongly encouraged to keep a file containing the last command that was used to modify this property. If a user enters a set of regular expressions, and observes that the intended text is not being replaced in the wiki pages, the user can set the log level of BEECLIENT to INFO and search for MalformedPerl5PatternException to determine what the syntax error(s) may be in the regular expressions. To remove all regular expressions, please run modify_property with the --revert_to_default flag.

WorkspacesService

The following properties are available for WorkspacesService:

Table 4-172 WorkspacesService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

AllowContentHtmlScripts

boolean

true

All permitted values

Yes

No

Allows or disallows uploads of HTML files with client-side scripting. This is enabled by default, but administrators may wish to disable this in order to prevent malicious JavaScript code from executing on the server.

BlockedFileExtensions

String

This property has a customized constraint.

Yes

No

Specifies a comma-separated list of file extensions that are disallowed from being uploaded to the Beehive server, without the periods and with no spaces after the commas. This is intended to be used so administrators can block potential security vulnerabilities from entering the system. For example, a list might look like: xls,doc,swf

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

DbDownloadBufferSize

int

261888

Min=16384, Max=1048576

Yes

No

The buffer size, in bytes, used while downloading stream data from the database layer. Deployments that typically stream small files, as well as those with limited memory, may improve performance by setting this value below the default. Deployments with larger memory may likewise improve performance by setting this value above the default.

DbUploadBufferSize

int

260096

Min=16384, Max=1048576

Yes

No

The buffer size, in bytes, used while uploading stream data to the database layer. Deployments that typically stream small files, as well as those with limited memory, may improve performance by setting this value below the default. Deployments with a larger memory may likewise improve performance by setting this value above the default.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MaxRecentActivitiesPerGroup

int

5000

This property has a customized constraint.

Yes

No

The group-max property specifies the maximum number of entries to retain for each group (defined by RecentActivityPurgeType property) during a scheduled-purge of the recent activities table. The scheduled-purge keeps, for each group (defined by RecentActivityPurgeType property), at most N entries, if the number of entries specified in this property equals N.

MembershipNotificationEnabled

boolean

true

All permitted values

Yes

No

Enables or disables e-mail notification to a user when joining or leaving a workspace.

MinRecentActivitiesPerGroup

int

5

This property has a customized constraint.

Yes

No

The group-min property specifies the minimum number of entries to retain for each group (defined by RecentActivityPurgeType property) during a scheduled-purge of the recent activities table. The scheduled-purge ensures that the most recent activities of each group are kept for up to the number of entries specified in this property, preventing them from being purged even if they are older than RecentActivityDaysToLive.

QuotaNotificationEnabled

boolean

true

All permitted values

Yes

No

Enables or disables e-mail notification to workspace coordinators when workspace quota is reached.

QuotaOverflowPercentage

int

5

This property has a customized constraint.

Yes

No

Percentage of quota, expressed as an integer, that may be exceeded the first time prior to automatic rejection of further data additions to a workspace. For example, if 1 GB of quota is allocated to the workspace, and the quota overflow percentage is 5, and hard quota has not been reached, then data additions will succeed if workspace size will be below 1.05 GB after this. Once hard quota is reached, data addition will be rejected even if workspace size is below 1.05 GB.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

RecentActivityDaysToLive

int

90

This property has a customized constraint.

Yes

No

The Days-To-Live property specifies the maximum days a recent activity entry will be kept during a scheduled purge of the recent activities table. The recent activities table is expected to be huge, and therefore a scheduled job is used regularly to automatically clean up old entries that are deemed less relevant. The purge ensures that each group (indicated by RecentActivityPurgeType property) will have a minimum number of rows (see MinRecentActivitiesPerGroup property), and then keep only recent activities within Days-To-Live days as long as the total number of rows per group does not exceed the maximum (see MaxRecentActivitiesPerGroup property).

RecentActivityInPersonalWorkspaceEnabled

boolean

false

All permitted values

Yes

No

When this property is set to true, recent activities in personal workspaces are tracked. Out of box, the value is false

RecentActivityPurgeType

int

1

Min=0, Max=2147483647

Yes

No

The purge-type property specifies how the scheduled-purge for recent activities table is performed. Currently it can be set to 0 (no purging), 1 (purge-by-workspace) or 2 (purge-by-user). Purge-by-workspace indicates the ranking of recent activity is done per workspace, which means it will keep at least MinRecentActivitiesPerGroup (and at most MaxRecentActivitiesPerGroup) the most recent entries captured in each workspace. Purge-by-user indicates the ranking of recent activity is done per user.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

XmppService

The following properties are available for XmppService:

Table 4-173 XmppService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

DomainNames

List<String>

[example.com]

This property has a customized constraint.

Yes

No

All domains for which xmpp allows login. For example oracle.com, sales.idc.com, org.company.com

Language

String

en

This property has a customized constraint.

Yes

No

Language used by server.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

MessagesOnInvalidAction

List<String>

[]

This property has a customized constraint.

Yes

No

purpose of this property is to send relevant messages to users when they perform operation which are either not allowed of carried out with wrong inputs.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

SearchFields

List<SearchField>

[first, last, email]

All permitted values

Yes

No

Fields on which a user can search User Directory.

SupportedAgents

List<AgentType>

[uds]

All permitted values

Yes

No

List of all agents supported by xmpp server

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

VersionRules

List<String>

[]

This property has a customized constraint.

Yes

No

specify the rules for different xmpp messenger clients, sending message to user and whether disconnect the user or let him/her continue on using a particular client

XmppPort

int

5222

Network Port, Min=1, Max=65536

Yes

No

Xmpp Server accepts connection on this port

XmppSslPort

int

5223

Network Port, Min=1, Max=65536

Yes

No

Port for SSL communication

XmppTimerKeepAliveTime

int

5

Min=0, Max=10

Yes

No

keep-alive time, in minutes, used for detecting the stale connections. Negative or zero value disables the stale connection detection timer

ZimbraConnectorService

The following properties are available for ZimbraConnectorService:

Table 4-174 ZimbraConnectorService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

ZimbraUIService

The following properties are available for ZimbraUIService:

Table 4-175 ZimbraUIService Properties

Name

Data Type

Default Values

Accepted Values

Mutable

Read Only

Description

Database

Database

n/a

All permitted values

Yes

No

Service specific database storage information.

DatabaseRetryIntervalList

List<Integer>

n/a

This property has a customized constraint.

Yes

No

The database retry interval list is a list of non-negative integer values used to configure the desired retry behavior when database operations fail. Beehive components that interact with the database will retry failed operations as many times as the number of values in the list. The values of the integers in the list configure the length of the interval guaranteed to elapse before each successive retry is attempted. The units are in milliseconds. If the list is empty, failed operations will not be retried. There is no limit on the number of values in the list, so there is no limit on how many retry attempts may be configured. A value of 0 causes immediate retry.

LogLevel

Level (Legal values: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST)

OFF

All permitted values

Yes

No

The standard logging level that can be used to control logging output. The levels are ordered. Enabling logging at a given level also enables logging at all higher levels. The levels in descending order are: SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value). In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

ReadOnlyDBAccessEnabled

Boolean

true

All permitted values

Yes

No

Priority for enabling read-only access for the serice.

UdsCacheDisabled

boolean

false

All permitted values

Yes

No

long description key not set

Copyright © 2008, 2013, Oracle and/or its affiliates. All rights reserved.