Skip Headers
Oracle® Beehive Administrator's Reference Guide
Release 1 (1.5)

Part Number E14837-02
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
View PDF

4 Oracle Beehive Property Reference

This module contains the following topics:

Introduction to Oracle Beehive Properties

This section contains the following topics:

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

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.

Notes:

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

User-defined aliases are modifiable properties of any system object, with the property name of Alias. 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.

    Caution:

    If you are changing any port number to a privileged port (a port number below 1024) on a UNIX or Linux installation, you must first perform a special procedure, and then change the port. First follow the special procedure in "Modifying Oracle Beehive Ports using Privileged Port Numbers", and then follow the procedure below to change the port.
  3. Whenever you change a property in Oracle Beehive, you are making an alteration to the proposed configuration. You must activate a proposed configuration before changes you have made are actually applied to the running Oracle Beehive deployment. When you are done making configuration changes, activate the proposed configuration using the beectl activate_configuration command:

    beectl> activate_configuration
    

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

    Notes:

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

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

  4. If you modify any of the 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

BpelCluster

TaskAdministratorPassword

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

No other unique properties exist

AlarmService

DefaultExpiryTime

ApplicationImage

EarFileName, ServiceInterface

AuditService

LogonRecordDuration

AuthenticationService

AuthStoreType, AuthenticationRealm, IdMap, LockoutTime, LoginAttempts, OssoConfigFile, SAMLRegistrationMap, SsoLogoutUrl, SsoType, TokenTimeout, UseJazn, UseSecureCookie, UseSecureHash, WnaEnabled, WnaKeytab, WnaPrincipal, WsSecurityExpiry, WsSecuritySamlEnabled, WsSecuritySigKeyAlias, WsSecuritySigKeyPwd

BeeCentralService

No other unique properties exist

BeehiveControlService

No other unique properties exist

BeehiveInstance

AvailableNumberOfProcessors, AvailablePhysicalMemoryInMB, BeehiveInstanceName, Bti, DiagnosabilitySettings, HttpServer, KeystoreFile, KeystoreFilePassword, LogBaseDir, Oc4jInstances, Opmn, OracleHome, Server, WalletDir, WalletPassword

BeehiveJ2eeApplication

No other unique properties exist

BeekeeperService

No other unique properties exist

BpelCluster

DomainId, DomainPassword, ProcessManagers, TaskAdministrator, TaskAdministratorPassword

BpelProcessManager

BpelCluster

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, DefaultFutureTimePeriodInDay, DefaultPastTimePeriodInDay

ClientManagementService

DebugMode, NotificationQueueResumeThreshold, NotificationQueueSuspendThreshold, OutputFrameSize, SessionTimeout, StreamReadBufferSize, StreamWriteBufferSize, TraceEnabled

CoexistenceService

CoexistenceEnabled, ContactProperties, ExchangeConnectorProperties, FreeBusyProperties, MeetingProperties, MessageProperties, RequestSenderEnabled, TaskProperties

CoexistenceService.ContactProperties

AttachmentMaxSizeInKiloByte

CoexistenceService.ContainerSpecificProperties

AttachmentMaxSizeInKiloByte

CoexistenceService.ExchangeProperties

SmtpServerHostName, SmtpServerPort

CoexistenceService.FreeBusyProperties

FutureTimePeriodInDay, PastTimePeriodInDay

CoexistenceService.MeetingProperties

AttachmentMaxSizeInKiloByte, ImportDataFutureTimePeriodInDay, ImportDataPastTimePeriodInDay

CoexistenceService.MessageProperties

AttachmentMaxSizeInKiloByte, ImportDataFutureTimePeriodInDay, ImportDataPastTimePeriodInDay

CoexistenceService.TaskProperties

AttachmentMaxSizeInKiloByte, ImportDataFutureTimePeriodInDay, ImportDataPastTimePeriodInDay

ConferenceService

DefaultDialoutCallTimeout, DefaultParticipantCodec, DefaultSIPParticipantCodec, DefaultSipRegistrationExpiresInterval, DefaultVoiceParticipantMode, OwcHostWaitSessionTimeout, OwcLogFlushPeriod, OwcMediaHostServiceBusAddressPrefix, OwcMediaHostServiceLoadBalanceBusAddressSuffix, OwcRosterServiceBusAddressPrefix, OwcRosterServiceLoadBalanceBusAddressSuffix, OwcUseRemoteMediaSessions, SIPPSTNGatewayIPAddres, SIPPSTNGatewayPort, SipRegistrationEnabled

ConferenceSessionService

No other unique properties exist

Database

AccessSchemas, AffinityPool, AffinityServiceNames, BusinessDataServiceName, ConfigServiceName, ConnectDescriptor, DefaultAccessSchema, DefaultNonXaPool, DefaultXaPool, DiagnosabilityServiceName, EventListenerServiceName, OnsNodeConfiguration, Password, SchemaName, SearchServiceName, XaServiceNames

Database.AccessSchema

BusinessDataSupported, ConfigDataSupported, DiagnosticDataSupported, EventListenerDataSupported, Password, SearchDataSupported, UserDataSupported, UserName

Database.ConnectionPool

AbandonedConnectionTimeout, ConnectTimeout, ConnectionProperties, ConnectionWaitTimeout, InactivityTimeout, InitialConnections, LowerThresholdLimit, MaxConnections, MaxRetryAttemptLimit, MaxRetryTimeLimit, MaxStatementsLimit, MinConnections, PropertyCheckInterval, ReadTimeout, TimeToLiveTimeout, ValidateConnection

DeviceManagementService

BlockedDevices, UncertifiedDeviceAllowed

DeviceManagementService.BlockedDevice

Description, DeviceId

DiagnosabilitySettings

BaseErrorCodeProperties, ContextProperties, ErrorCodeDBPersistenceEnabled, ErrorCodeDBProperties, ErrorCodeLoggingProperties, ProbeEnabled

DiagnosabilitySettings.ContextProperties

IncludeCallerStacks, PropagationEnabled

DiagnosabilitySettings.ErrorCodeProperties

ExcludedErrorCodes, IncludeStackTraces, IncludedErrorCodes, LoggingSeverity, ReportingSeverityThreshold

DiscussionsService

No other unique properties exist

EmailService

CSIProperties, CoexUserLocal, DirectoryCacheTTL, GlobalDomainName, IMAPEnabled, IMAPProperties, LocalEmailPatterns, MaxDirectoryCacheEntries, MaxMailSz, NonLocalEmailPatterns, PersistenceProperties, SMTPEnabled, SMTPProperties, SaveParseErrorEmails, SubjectSortingGroupingRules, SubjectSortingReplacementRules, TimeoutCheckingInterval, TransportProperties, WebRedirectUrl

EmailService.CSIProperties

StreamBufferSize, StreamMaxReadChunkSize, StreamMaxWriteChunkSize, StreamPreFetchSize, StreamTimeout

EmailService.EndpointProperties

EndpointName, EndpointScheme

EmailService.IMAPProperties

AssumeSingleEndpoint, CacheMessageSize, ClientKeepAliveInterval, EndpointPropertiesList, FolderCacheDirectory, FolderOpenBatchSize, FolderPollingInterval, FolderSyncBatchSize, LoginErrorThreshold, MaxFolderCacheSize, MaxSessions, MessageLoadBatchSize, ParseErrorThreshold, Port, ServerSessionConcurrency, SessionTimeout, ShowInstanceNameInBanner, StreamReadBufferSize, SurrogateAuth, TlsMandatory, UseTls

EmailService.PersistenceProperties

CopyBatchSize, DeleteBatchSize, DurableFileRoot, MaxDbConnRetry, MaxFileCacheSz, MoveBatchSize, PldStoreCacheLinger, PldStoreMaxMemCachedRecords, PldStoreMaxOpenFDs, PldStoreRecordCacheSz, PldStoreStreamBufSz, TempFileRoot, UndeleteBatchSize, UpdateFlagsBatchSize

EmailService.SMTPProperties

AssumeSingleEndpoint, Authentication, DSNEnabled, EndpointPropertiesList, Port, SendMailEvenIfNoTls, ServerSessionConcurrency, UseTls, VMSEvaluator, VMSPropertiesList

EmailService.SMTPProperties.VMSProperties

AuthMandatory, CustomDisplayName, CustomDomainName, CustomProductVersion, LogAllExceptions, MaxAbortedTransitionsPerSession, MaxBadTransitionsPerSession, MaxCommandLineSize, MaxRcptsPerTx, MaxRejectedAddressesPerSession, MaxSizeBeforeAttackSuspected, MaxSzAbortTx, MaxUselessCommandsPerSession, NextCommandTimeout, NextDataChunkTimeout, QuitWriteTimeout, RecipientMatcher, RejectAll, SenderMatcher, ShowInstanceNameInBanner, SupressReceivedFrom, SupressResponseText, TlsMandatory, UseDefaultDisplayName, UseDefaultDomainName, UseDefaultMaxSz, UseDefaultProductVersion, VMSName

EmailService.TransportProperties

AcceptInvalidLocalUsers, DeliveryConcurrency, DeliveryRules, InMemoryQueueSize, KeepAliveInterval, LocalDeliveryBatchSize, MaxReceivedHeaders, MaxRetryPeriod, MaximumDBMessageQueuePercentage, MinimumDBMessageQueuePercentage, MsgTerminusRules, PostDeliveryRules, PostResolutionRules, PreResolutionRules, ProcessingEnabled, QueuePollInterval, RelayServer, RetryInterval, SMTPDeliveryBatchSize, SMTPDeliveryCheckpoint, ScanOnUpload, SimpleRelayMode, ThreadPoolSize

Enterprise

CollabId, Database, ErrorCodeDBPersistenceEnabled, Name, VirusScanEngineCluster

EventService

AsyncActionRetryCount, AsyncActionRetryInterval, AsyncLogLevel, MaxThreadPoolSize, PreEvaluateThresholdRuleCount

ExternalBpelProcessManager

AdminPassword, AdminUsername, BpelCluster, Hostname, Oc4jName, OpmnRequestPort

ExternalJ2eeApplication

AdminPassword, AdminUsername, Hostname, Oc4jName, OpmnRequestPort

FaxMessageService

DebugFlags

FtpService

ActiveModeEnabled, ChannelSecurity, DMSInstrumentation, DataConnectionPort, DefaultCommandCharacterset, DefaultDataPort, FtpServerEnabled, InternalIP, ListeningPoint, MaxDCPortCount, Port, SessionTimeout, UploadBufferSize

HttpServer

BeehiveInstance, DocRootLimitExcept, HttpListenPort, HttpServerCluster, HttpSslListenPort, KeepAliveTimeout, LogLevel, MaxClients, OsGroup, OsUser, SSLLogLevel, ServerAdmin, ServerRoot, Timeout

HttpServerCluster

HttpServerSslEnabled, HttpServers, SslTerminatedByLoadBalancer

IdMap

Map

IdentityProviderService

IdpSAMLIdentity, IdpUrl, SpSAMLIdentity, SpUrl

ImService

ArchivingEnabled, DbRetryCount, DbRetryTimeout, ImBufferStageSize, ImEndPointDeathDetectionTime, ImPurgingPeriodTimer, PendingMessagesLimit

JavaExecutionArguments

AdditionalOptions, InitialHeapSizeInMB, MaximumHeapSizeInMB, MaximumPermanentGenerationSizeInMB

JcrServletService

AuthenticationScheme, JCRServerEnabled, JcrSessionTimeout, MaxDownloadBufferSize, UploadBufferSize

LdapServer

DigestAuthenticationAttribute, DirectoryType, GroupObjectClass, GroupSearchBase, LdapServerConnectionTimeout, LdapServerHostName, LdapServerPassword, LdapServerPort, LdapServerSslPort, LdapServerUser, PrimaryAuthenticationAttribute, PrimaryAuthenticationCredential, ProtocolAuthenticationAttribute, ProtocolAuthenticationCredential, SslEnabled, UserObjectClass, UserSearchBase, UserSearchBaseForSync, VoiceAuthenticationAttribute, VoiceAuthenticationCredential

LoggingConfigurable.LoggingProperties

BaseLogLevel, MaxFileSize, MaxLogSize, ModuleLogLevel, RotationFrequency

ManagedBpelProcessManager

BpelCluster

ManagedOc4j

AdminPassword, AdminUsername, AjpPortMaxValue, AjpPortMinValue, Applications, BeehiveInstance, CustomNonXaConfig, CustomXaConfig, JGroupPortMaxValue, JGroupPortMinValue, JmsPortMaxValue, JmsPortMinValue, ManagedOc4jCluster, Oc4jName, PseudoTranslationEnabled, PseudoTranslationStrategy, ResourceAdapterInstances, RmiPortMaxValue, RmiPortMinValue, RmisPortMaxValue, RmisPortMinValue, SipContainer, StartJavaExecutionArguments, StopJavaExecutionArguments

ManagedOc4jCluster

AdminPassword, AjpsEnabled, ManagedOc4js, OrmisEnabled

ManagementService

AutoSyncSaveListenerSleepIntervalInSeconds, AutoSyncSaveListenerTimeoutInSeconds, LocalFileSyncEnabled, LogSearchMaximumResults, LogSyncEnabled, LogUploadFilter, LogUploadInterval, SystemDataCollectorProperties, UploadLevel

ManagementService.SystemDataCollectorProperties

CollectionInterval, CollectorEnabled, SystemDataFileRotationInterval, SystemDataFileRotationSize

MobileDmService

MaxClientConnections, MaxInvalidAttempts, TtlAuthenticated, TtlUnauthenticated

NamedSystemObject

Name

NotificationDeliveryService

ActionAskSettings, ActionableNotificationReplyDisabled, ActionableNotificationUser, DeliveryPoolSize, MaxDeliveryStatusAge, MaxTrackingAge, SmsSettings, SystemUserName, XmsSettings

NotificationDeliveryService.SmsSettings

MaxSmsChunks, ShortCode, ShortCodeType, SmsMode

NotificationDeliveryService.WebProxySettings

Enabled, ProxyHostName, ProxyPassword, ProxyPort, ProxyUserName

NotificationDeliveryService.XmsSettings

WebProxySettings, XmsPassword, XmsServiceUrl, XmsUserName

ObjectEventPublisherService

No other unique properties exist

Oc4j

AdminPassword, AdminUsername, Applications, CustomNonXaConfig, CustomXaConfig, Oc4jName, PseudoTranslationEnabled, PseudoTranslationStrategy, ResourceAdapterInstances

OmaService

CalendarSyncEnabled, ContactsSyncEnabled, DbLogKeepDays, DeviceMetaDataCacheSize, EmailNumberLimit, EmailSyncEnabled, LogSyncmlForUsers, MaxConcurrentRequests, MaxMessageSize, MaxObjectSize, MaxSyncRangeBack, MaxSyncRangeForward, Md5Required, Md5Supported, NotesSyncEnabled, OmaDsEnabled, ResumeEnabled, SessionLogRequired, SessionTimeOut, SyncmlLogRequired

OmsResourceAdapter

ResourceAdapterImage, ResourceAdapterInstances

OmsResourceAdapterInstance

ResourceAdapter

Opmn

BeehiveInstance, LocalPort, OpmnCluster, RemotePort, RequestPort

OpmnCluster

NotificationServerSslEnabled, Opmns

OwcStreamingService

HttpTunnelingEnabled, HttpTunnelingPort, MaxHttpTunnelingClientsAllowed, MaxRtmpClientsAllowed, MaxRtspClientsAllowed, RtmpEnabled, RtmpPort, RtspEnabled, RtspPort, ServiceName

PlatformService

No other unique properties exist

PlatformWebService

No other unique properties exist

PolicyService

No other unique properties exist

PresenceService

ActivityStartTimeThreshold, PollInterval, PublicPresenceEnabled

PushMailService

HeartbeatInterval, IMAPConnLiveTime, MaxConcurrentUsers, MaxInboxMessages, MaxMessageSize, NumberDaysPast

PushService

MaxClientConnections, MaxInvalidAttempts, MaxTruePushClientConnections, TtlUnauthenticated

RecordsManagementService

Urm

ResourceAdapter

ResourceAdapterImage, ResourceAdapterInstances

ResourceAdapterImage

RarFileName, ResourceAdapterInterface

ResourceAdapterInstance

ResourceAdapter

ResourceDirectoryService

SearchSizeLimit

SAMLIdentity

KeyAlias, Service

SearchService

CachedPageMaxLength, CaseSensitive, CrawlCalendarsEnabled, CrawlDocumentsEnabled, CrawlEmailsEnabled, ExcludeRegex, MaxResults, MaxSearchDuration, Recovery, SyncFrequency, TwoDBMode, WildcardChar

Server

AlternateHostNames, BeehiveInstances, PrimaryHostName, SipListenerIPAddress

Service

No other unique properties exist

SesEndptService

Host, Port, SesEndptServiceEnabled, SesTrustedEntityMap

SipContainer

ManagedOc4j, SipEnabled, SipPortMaxValue, SipPortMinValue

SipGateway

GatewayIPAddress, GatewayPort, SipGatewayCluster

SipGatewayCluster

SipGateways

Site

BtiGlobalConfiguration, BusinessDatabase, CipherKey, ClusteringEnabled, ConfigurationDatabase, Database, DiagnosabilitySettings, DiagnosticDatabase, EnterpriseId, Enterprises, EventListenerDatabase, HttpServerCluster, LanguagePack, LdapServer, ManagedOc4jCluster, Name, OpmnCluster, RemoteSites, ResourceAdapters, SearchDatabase, Servers, Services, SipGatewayCluster, SiteId, SsoKeyAlias, UnmanagedOc4js, VirtualServer, VirusScanEngineCluster

SmppDeliveryService

SmppConnectionCount, SmppEnquireTime, SmppPassword, SmppProcessingThreadCount, SmppServiceUrl, SmppSystemID, SmppSystemType, SmppTimeOut, TlsEnabled, UseQuerySMForStatus

SubscriptionActionService

No other unique properties exist

SubscriptionService

MaxAnchorAgeInDays

TCPCommBasedScanEngine

ScanEngineAdminPassword, ScanEngineAdminURL, ScanEngineAdminUsername, ScanEngineClientCommPort, ScanEngineHostName, ScanEngineSecureAdminURL, ScanEngineSecureClientCommPort, SecureClientCommEnabled, SecureClientCommSupported, VirusScanEngineCluster

TCPCommBasedScanEngineCluster

CacheRefreshInterval, ConnectionReadWriteResponseTimeout, ConnectionRetryTimeInterval, GatherDetailedStats, MaxConnectionRetryAttempts, OverrideEngineResultEnabled, ScanEngineCommProtocol, ScanEngineCommProtocolVer, ScanEngines, ScanServiceProvider, VirusScanPolicy, VirusesToIgnore

TimeManagementService

ConsistencyTasksEnabled, EnableCleanupTask, EnableDynamicParticipants, EnableExternalParticipantNotificationDelivery, EnableGenericClassOfTMBusinessEvents, EnablePresenceIntegration, MaxOccurrencesForUnboundedRecurrence, MaxOccurrencesPerSeries, MaxSubscriptionBizEventRaisedPerOperation

TimeManagementService.PurgedItemsCleanupProperties

No other unique properties exist

TimeManagementService.ResourceCleanupProperties

No other unique properties exist

TimeZoneService

No other unique properties exist

TranscodingService

ArchiveFolderPath

UnmanagedBeehiveInstance

AvailableNumberOfProcessors, AvailablePhysicalMemoryInMB, BeehiveInstanceName, Bti, DiagnosabilitySettings, HttpServer, KeystoreFile, KeystoreFilePassword, LogBaseDir, Oc4jInstances, Opmn, OracleHome, Server, WalletDir, WalletPassword

UnmanagedOc4j

AdminPassword, AdminUsername, Applications, CustomNonXaConfig, CustomXaConfig, HostName, Oc4jName, OpmnRequestPort, PseudoTranslationEnabled, PseudoTranslationStrategy, ResourceAdapterInstances, RmiPort, WalletDir

Urm

AgentName, DispositionLoaderInterval, DispositionProcessorInterval, RMAdminPassword, RMAdminUser, RmAdminEmailId, URMAdapterURL

UserDirectoryService

ConfigurationParameters, CustomAttributes, DirectoryProfiles

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

DebugFlags, FacilityProperties, VoiceMessageProperty

VoiceMessageService.EnterpriseProperties

EnterpriseCollabId, ExclusiveAudioContentURIs, Name, RecordPlaybackURIs, RecordStreamURIs, SharedAudioContentURIs, TelephoneAnsweringAddress

VoiceMessageService.FacilityProperties

ExclusiveAudioContentURIs, FacilityCollabId, Name, RecordPlaybackURIs, RecordStreamURIs, SharedAudioContentURIs

VoiceServletService

No other unique properties exist

WebdavService

AuthenticationScheme, BrowserSessionTimeout, DMSInstrumentation, DavClientSessionTimeout, DefaultWelcomeDocs, DepthLimit, DisplayLastModifiedBy, DisplayLastModifiedOn, DisplayLockStatus, DisplayVersioningStatus, DownloadBufferSize, MinimumLockTimeout, UploadBufferSize, UserPreferenceRefreshTime, WebDAVServerEnabled

WikiService

PluginHtmlEnabled

WorkflowService

BpelCluster

WorkspacesService

DbDownloadBufferSize, DbUploadBufferSize, MembershipNotificationEnabled, QuotaNotificationEnabled, QuotaOverflowPercentage

XmppService

DomainName, DomainNames, Language, MessagesOnInvalidAction, RetryCount, RetryTimeout, SearchFields, SupportedAgents, VersionRules, XmppPort, XmppSslPort, XmppTimerKeepAliveTime

ZimbraConnectorService

No other unique properties exist

ZimbraUIService

No other unique properties exist


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:

AccessControlService

No other properties exist for AccessControlService .

AlarmService

The following properties are available for AlarmService :

Table 4-6 AlarmServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

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.


ApplicationImage

The following properties are available for ApplicationImage :

Table 4-7 ApplicationImageProperties

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-8 AuditServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

LogonRecordDuration

int

480

Min=1, Max=6000

Yes

No

Specifies the logon record expiration time in minutes.


AuthenticationService

The following properties are available for AuthenticationService :

Table 4-9 AuthenticationServiceProperties

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

AuthenticationRealm

String

Authorized_Users

All permitted values

Yes

No

Specifies the default authentication realm for Oracle Beehive.

IdMap

IdMap

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.

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.

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

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, coreid)

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

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

WnaEnabled

Boolean

false

All permitted values

Yes

No

Specifies whether or not Windows Native Authentication (WNA) authentication is enabled for JavaSSO. Valid values: true, false

WnaKeytab

String

n/a

All permitted values

Yes

No

Specifies the Windows Native Authentication (WNA) service keytab file for WNA authentication.

WnaPrincipal

String

n/a

All permitted values

Yes

No

Specifies the Windows Native Authentication (WNA) service principal name for WNA authentication.

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.


BeeCentralService

No other properties exist for BeeCentralService .

BeehiveControlService

No other properties exist for BeehiveControlService .

BeehiveInstance

The following properties are available for BeehiveInstance :

Table 4-10 BeehiveInstanceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

AvailableNumberOfProcessors

int

1

Custom, contact dev lead

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

Custom, contact dev lead

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

No other properties exist for BeekeeperService .

BpelCluster

The following properties are available for BpelCluster :

Table 4-11 BpelClusterProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

DomainId

String

default

All permitted values

Yes

No

For high availability, a set of BPEL Process Manager instances are grouped into a BPEL Cluster. A BPEL Cluster contains BPEL Process Manager instances that have the same Domain ID and password and are of the same type (External vs. Managed). By default, the Domain ID is set to "default." If the default Domain ID is chnaged, the out-of-the-box Workflows should also be deployed in the new domain.

DomainPassword

SecureString

n/a

All permitted values

Yes

No

The domain password of the BPEL Process Manager instances that are grouped into this Cluster.

ProcessManagers

Set<BpelProcessManager> (Structural property)

n/a

Custom, contact dev lead

Yes

No

Contains the BPEL Process Manager's configuration information.

TaskAdministrator

String

bpeladmin

All permitted values

Yes

No

The name of the user that has BPELTaskAdmin privilege in the BPEL Process Manager instances in this cluster. By default the this property is set to "bpeladmin." This user must be able to act on behalf of the tasks of any user in the BPEL Process Manager instance. This user account must be available in all the BPEL Process Manager instances that are grouped into this cluster.

TaskAdministratorPassword

SecureString

n/a

All permitted values

Yes

No

The password of the task admin user account password of all BPEL Process Manager instances that are grouped into this Cluster.


BpelProcessManager

The following properties are available for BpelProcessManager :

Table 4-12 BpelProcessManagerProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

BpelCluster

BpelCluster

n/a

All permitted values

No

No

The BPEL Cluster that this BPEL Process Manager belongs to.


Bti

The following properties are available for Bti :

Table 4-13 BtiProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

BeehiveInstance

BeehiveInstance

n/a

All permitted values

Yes

No

description bundle not set

BtiProcessPingTimeout

int

60

All permitted values

Yes

No

description bundle not set

ClientWorker

BtiClientWorker

n/a

All permitted values

No

No

description bundle not set

CtrlPort

int

5959

Network Port, Min=1, Max=65536

Yes

No

description bundle not set

LogDir

String

n/a

All permitted values

Yes

No

description bundle not set

Redirector

BtiRedirector

n/a

All permitted values

No

No

description bundle not set

ServerPort

int

n/a

Network Port, Min=1, Max=65536

Yes

No

description bundle not set

ServerWorker

BtiServerWorker

n/a

All permitted values

No

No

description bundle 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-14 BtiClientWorkerProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

AdditionalExecArgs

String[]

n/a

All permitted values

Yes

No

description bundle not set

Bti

Bti

n/a

All permitted values

Yes

No

description bundle not set

NumberOfWorkers

int

1

All permitted values

Yes

No

description bundle not set


BtiComponent

The following properties are available for BtiComponent :

Table 4-15 BtiComponentProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

AdditionalExecArgs

String[]

n/a

All permitted values

Yes

No

description bundle not set


BtiGlobal

The following properties are available for BtiGlobal :

Table 4-16 BtiGlobalProperties

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-17 BtiRedirectorProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

AdditionalExecArgs

String[]

n/a

All permitted values

Yes

No

description bundle not set

Bti

Bti

n/a

All permitted values

Yes

No

description bundle not set


BtiServerWorker

The following properties are available for BtiServerWorker :

Table 4-18 BtiServerWorkerProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

AdditionalExecArgs

String[]

n/a

All permitted values

Yes

No

description bundle not set

Bti

Bti

n/a

All permitted values

Yes

No

description bundle not set

NumberOfWorkers

int

1

All permitted values

Yes

No

description bundle not set


CalDAVService

The following properties are available for CalDAVService :

Table 4-19 CalDAVServiceProperties

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.

DefaultFutureTimePeriodInDay

Long

124

All permitted values

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

All permitted values

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.


ClientManagementService

The following properties are available for ClientManagementService :

Table 4-20 ClientManagementServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

DebugMode

boolean

false

All permitted values

Yes

No

description bundle not set

NotificationQueueResumeThreshold

int

50

Custom, contact dev lead

Yes

No

description bundle not set

NotificationQueueSuspendThreshold

int

100

Custom, contact dev lead

Yes

No

description bundle not set

OutputFrameSize

int

32768

Min=1, Max=65535

Yes

No

description bundle not set

SessionTimeout

int

30000

Custom, contact dev lead

Yes

No

description bundle not set

StreamReadBufferSize

int

131072

Custom, contact dev lead

Yes

No

description bundle not set

StreamWriteBufferSize

int

131072

Custom, contact dev lead

Yes

No

description bundle not set

TraceEnabled

boolean

false

All permitted values

Yes

No

description bundle not set


CoexistenceService

The following properties are available for CoexistenceService :

Table 4-21 CoexistenceServiceProperties

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.

ContactProperties

CoexistenceService.ContactProperties

n/a

All permitted values

No

No

Properties that are specific to contacts in coexistence deployments. This is a subcomponent.

ExchangeConnectorProperties

CoexistenceService.ExchangeProperties

n/a

All permitted values

No

No

Properties that are specific to the Oracle Coexistence Connector for Microsoft Exchange Server. This is a subcomponent.

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.

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.

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.


CoexistenceService.ContactProperties

The following properties are available for CoexistenceService.ContactProperties :

Table 4-22 CoexistenceService.ContactPropertiesProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

AttachmentMaxSizeInKiloByte

int

2048

Custom, contact dev lead

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.


CoexistenceService.ContainerSpecificProperties

The following properties are available for CoexistenceService.ContainerSpecificProperties :

Table 4-23 CoexistenceService.ContainerSpecificPropertiesProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

AttachmentMaxSizeInKiloByte

int

2048

Custom, contact dev lead

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.


CoexistenceService.ExchangeProperties

The following properties are available for CoexistenceService.ExchangeProperties :

Table 4-24 CoexistenceService.ExchangePropertiesProperties

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 for Microsoft Exchange Server. If this property is not set, the virtual server name will be used.

SmtpServerPort

int

25

Custom, contact dev lead

Yes

No

Specifies the SMTP server port used by the Oracle Coexistence Connector for Microsoft Exchange Server. If this property is not set, the virtual server port will be used.


CoexistenceService.FreeBusyProperties

The following properties are available for CoexistenceService.FreeBusyProperties :

Table 4-25 CoexistenceService.FreeBusyPropertiesProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

FutureTimePeriodInDay

int

120

Custom, contact dev lead

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

Custom, contact dev lead

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

The following properties are available for CoexistenceService.MeetingProperties :

Table 4-26 CoexistenceService.MeetingPropertiesProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

AttachmentMaxSizeInKiloByte

int

2048

Custom, contact dev lead

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.

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 for Microsoft Exchange Server. 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

Custom, contact dev lead

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 for Microsoft Exchange Server. 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-27 CoexistenceService.MessagePropertiesProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

AttachmentMaxSizeInKiloByte

int

2048

Custom, contact dev lead

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.

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 for Microsoft Exchange Server. 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

Custom, contact dev lead

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 for Microsoft Exchange Server. 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.TaskProperties

The following properties are available for CoexistenceService.TaskProperties :

Table 4-28 CoexistenceService.TaskPropertiesProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

AttachmentMaxSizeInKiloByte

int

2048

Custom, contact dev lead

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.

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 for Microsoft Exchange Server. 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

Custom, contact dev lead

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 for Microsoft Exchange Server. 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.


ConferenceService

The following properties are available for ConferenceService :

Table 4-29 ConferenceServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

DefaultDialoutCallTimeout

Integer

3600000

All permitted values

No

Yes

description bundle not set

DefaultParticipantCodec

String

audio/IP-MR-VBR

All permitted values

Yes

Yes

description bundle not set

DefaultSIPParticipantCodec

String

audio/PCMU

All permitted values

Yes

Yes

description bundle not set

DefaultSipRegistrationExpiresInterval

Integer

3600

All permitted values

No

Yes

description bundle not set

DefaultVoiceParticipantMode

Integer

1

All permitted values

No

Yes

description bundle not set

OwcHostWaitSessionTimeout

Integer

1800000

All permitted values

No

Yes

description bundle not set

OwcLogFlushPeriod

Integer

30000

All permitted values

Yes

Yes

description bundle not set

OwcMediaHostServiceBusAddressPrefix

String

owc-ms-host-service

All permitted values

Yes

Yes

description bundle not set

OwcMediaHostServiceLoadBalanceBusAddressSuffix

String

balance

All permitted values

Yes

Yes

description bundle not set

OwcRosterServiceBusAddressPrefix

String

owc-roster-service

All permitted values

Yes

Yes

description bundle not set

OwcRosterServiceLoadBalanceBusAddressSuffix

String

balance

All permitted values

Yes

Yes

description bundle not set

OwcUseRemoteMediaSessions

Boolean

false

All permitted values

Yes

Yes

description bundle not set

SIPPSTNGatewayIPAddres

String

n/a

All permitted values

Yes

Yes

description bundle not set

SIPPSTNGatewayPort

Integer

5060

Network Port, Min=1, Max=65536

Yes

Yes

description bundle not set

SipRegistrationEnabled

Boolean

false

All permitted values

Yes

Yes

description bundle not set


ConferenceSessionService

No other properties exist for ConferenceSessionService .

Database

The following properties are available for Database :

Table 4-30 DatabaseProperties

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

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.

Password

SecureString

n/a

All permitted values

Yes

No

The database password

SchemaName

String

bee_code

All permitted values

Yes

No

The name of the database schema

SearchServiceName

String

n/a

All permitted values

Yes

No

The database name for search service.

XaServiceNames

List<String>

n/a

All permitted values

Yes

No

The list of XA service.


Database.AccessSchema

The following properties are available for Database.AccessSchema :

Table 4-31 Database.AccessSchemaProperties

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.

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

The following properties are available for Database.ConnectionPool :

Table 4-32 Database.ConnectionPoolProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

AbandonedConnectionTimeout

int

0

All permitted values

Yes

No

The timeout for abandoned connection.

ConnectTimeout

int

10000

All permitted values

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

All permitted values

Yes

No

The timeout for connection wait.

InactivityTimeout

int

0

All permitted values

Yes

No

The timeout for inactive connection.

InitialConnections

int

0

All permitted values

Yes

No

The initial connection count of this connection pool.

LowerThresholdLimit

int

20

All permitted values

Yes

No

The limit of LowerThreshold.

MaxConnections

int

20

All permitted values

Yes

No

The maximum connection count of this connection pool.

MaxRetryAttemptLimit

int

3

All permitted values

Yes

No

The limit of the maximum retry attempt.

MaxRetryTimeLimit

int

30000

All permitted values

Yes

No

The limit of the maximum retry time.

MaxStatementsLimit

int

0

All permitted values

Yes

No

The maxium statement count of this connection pool.

MinConnections

int

0

All permitted values

Yes

No

The minimum connection count of this connection pool.

PropertyCheckInterval

int

900

All permitted values

Yes

No

The interval to check property.

ReadTimeout

int

300000

All permitted values

Yes

No

Time out for Read operation.

TimeToLiveTimeout

int

0

All permitted values

Yes

No

The timeout for timeToLive.

ValidateConnection

boolean

false

All permitted values

Yes

No

If the connectionPool needs to validate a connection.


DeviceManagementService

The following properties are available for DeviceManagementService :

Table 4-33 DeviceManagementServiceProperties

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.

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-34 DeviceManagementService.BlockedDeviceProperties

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-35 DiagnosabilitySettingsProperties

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.


DiagnosabilitySettings.ContextProperties

The following properties are available for DiagnosabilitySettings.ContextProperties :

Table 4-36 DiagnosabilitySettings.ContextPropertiesProperties

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-37 DiagnosabilitySettings.ErrorCodePropertiesProperties

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


DiscussionsService

No other properties exist for DiscussionsService .

EmailService

The following properties are available for EmailService :

Table 4-38 EmailServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

CSIProperties

EmailService.CSIProperties

n/a

All permitted values

No

Yes

long description key not set

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.

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

long description key not set

LocalEmailPatterns

List<String>

n/a

All permitted values

Yes

No

The list of valid e-mail address patterns for users of the system

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

long description key not set

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

long description key not set

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

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

long description key not set

WebRedirectUrl

String

webui?collabid=

All permitted values

Yes

No

URL prefix used for assembling valid Web addresses for artifact IDs. Used to generate MIME representations of online attachment addresses. When a user clicks a resulting URL, the Oracle Beehive Web client page will open with the attached artifact.


EmailService.CSIProperties

The following properties are available for EmailService.CSIProperties :

Table 4-39 EmailService.CSIPropertiesProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

StreamBufferSize

int

8192

Min=0, Max=2147483647

Yes

No

long description key not set

StreamMaxReadChunkSize

int

16384

Min=0, Max=2147483647

Yes

No

long description key not set

StreamMaxWriteChunkSize

int

16384

Min=0, Max=2147483647

Yes

No

long description key not set

StreamPreFetchSize

int

0

Min=-1, Max=2147483647

Yes

No

long description key not set

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.


EmailService.EndpointProperties

The following properties are available for EmailService.EndpointProperties :

Table 4-40 EmailService.EndpointPropertiesProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

EndpointName

String

default

All permitted values

Yes

No

Name of the endpoint

EndpointScheme

String

default

All permitted values

Yes

No

Scheme for this endpoint.


EmailService.IMAPProperties

The following properties are available for EmailService.IMAPProperties :

Table 4-41 EmailService.IMAPPropertiesProperties

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=2147483647

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.

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-42 EmailService.PersistencePropertiesProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

CopyBatchSize

int

1000

Min=1, Max=1000

Yes

No

long description key not set

DeleteBatchSize

int

1000

Min=1, Max=1000

Yes

No

long description key not set

DurableFileRoot

String

../../beehive/mailspool/perm

All permitted values

Yes

No

Root directory under which a cache of emails will be maintained. 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

MaxDbConnRetry

int

2

Min=1, Max=2147483647

Yes

No

Maximum number of attempts to retry a database operation on connection failure. This is employed to support automatic fail-over on clustered database systems.

MaxFileCacheSz

long

500000000

Min=0, Max=9223372036854775807

Yes

No

Maximum size (in bytes) of the total Durable File cache.

MoveBatchSize

int

1000

Min=1, Max=1000

Yes

No

long description key not set

PldStoreCacheLinger

long

180000

Min=0, Max=9223372036854775807

Yes

No

Time (in milliseconds) for an unreferenced record to linger in the cache

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

long description key not set

UpdateFlagsBatchSize

int

1000

Min=1, Max=1000

Yes

No

long description key not set


EmailService.SMTPProperties

The following properties are available for EmailService.SMTPProperties :

Table 4-43 EmailService.SMTPPropertiesProperties

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.

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

long description key not set

UseTls

boolean

false

All permitted values

Yes

No

If true, the system will advertise the SMTP STARTTLS extension.

VMSEvaluator

String

default

All permitted values

Yes

No

This property controls how connections received on the different endpoints are mapped to the different virtual mail servers.

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-44 EmailService.SMTPProperties.VMSPropertiesProperties

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

10000

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

RecipientMatcher

String

default

All permitted values

Yes

No

XML definition for the rule which determines whether to accept/reject the mailbox conveyed on the RCPT TO command of SMTP

RejectAll

boolean

false

All permitted values

Yes

No

If true, this virtual mail server will reject all connections.

SenderMatcher

String

default

All permitted values

Yes

No

XML definition for the rules which determine whether to accept/reject the mailbox conveyed on the MAIL FROM command of SMTP

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 true, the global maximum email size will not be used an 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-45 EmailService.TransportPropertiesProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

AcceptInvalidLocalUsers

boolean

false

All permitted values

Yes

No

If true, if a message recipient is not found locally yet matches the pattern for local users, it is treated as a remote recipient and routed to the relay server. This is useful if there are multiple mail servers serving the same email domain.

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.

DeliveryRules

String

default

All permitted values

Yes

No

XML Definition for the rules which determine, on a per recipient basis, how email should be delivered

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

long description key not set

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

long description key not set

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

long description key not set

MinimumDBMessageQueuePercentage

int

20

Min=0, Max=100

Yes

No

long description key not set

MsgTerminusRules

String

default

All permitted values

Yes

No

XML definition of rules invoked as message is leaving the transport-portion of its lifecycle. This rule is invoked if the message is existing due to success (delivery) or failure (delivery failure, filter rule prevented transmission, etc)

PostDeliveryRules

String

default

All permitted values

Yes

No

XML Definition for the rules which determine, on a per recipient basis, how email should be delivered

PostResolutionRules

String

default

All permitted values

Yes

No

XML Definition for rules applied to emails after aliases are expanded

PreResolutionRules

String

default

All permitted values

Yes

No

XML Definition for rules applied to emails before aliases are expanded

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

long description key not set

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.

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.

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-46 EnterpriseProperties

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

Database

Database

n/a

All permitted values

Yes

Yes

tenant-specific storage if defined, otherwise if this is null then business data for the tenant is stored in the common database referenced by Site.

ErrorCodeDBPersistenceEnabled

Boolean

n/a

All permitted values

Yes

Yes

whether java error code persistence is enabled.

Name

String

n/a

All permitted values

Yes

No

the name of the system object.

VirusScanEngineCluster

VirusScanEngineCluster

n/a

All permitted values

Yes

Yes

tenant-specific virus scan engine cluster if defined, otherwise if this is null then use the one defined at the Site or assume that no scan engine is configured.


EventService

The following properties are available for EventService :

Table 4-47 EventServiceProperties

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.

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.


ExternalBpelProcessManager

The following properties are available for ExternalBpelProcessManager :

Table 4-48 ExternalBpelProcessManagerProperties

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

BpelCluster

BpelCluster

n/a

All permitted values

No

No

The BPEL Cluster that this BPEL Process Manager belongs to.

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.


ExternalJ2eeApplication

The following properties are available for ExternalJ2eeApplication :

Table 4-49 ExternalJ2eeApplicationProperties

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-50 FaxMessageServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

DebugFlags

Integer

n/a

All permitted values

Yes

No

description bundle not set


FtpService

The following properties are available for FtpService :

Table 4-51 FtpServiceProperties

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.

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.

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.

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

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.


HttpServer

The following properties are available for HttpServer :

Table 4-52 HttpServerProperties

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

description not found Can't find resource for bundle oracle.ocs.management.model.SystemModelBundle, key OHS_KEEP_ALIVE_TIME_OUT_LONG_DESC

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-53 HttpServerClusterProperties

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.

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-54 IdMapProperties

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-55 IdentityProviderServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

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.

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.


ImService

The following properties are available for ImService :

Table 4-56 ImServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

ArchivingEnabled

boolean

false

All permitted values

Yes

No

long description key not set

DbRetryCount

int

6

Min=0, Max=12

Yes

No

The maximum number of times a pl/sql procedure will be re-tried in occurence of any retryable exception. Initial value is set to 6. Minimum allowed value is 0 and maximum allowed value is 12.

DbRetryTimeout

int

5

Min=2, Max=30

Yes

No

The amount of time in secs ImService shall wait before retrying a pl/sql procedure call in case the previous invocation led to a retryable exception. Initial value is set to 5 secs. Minimum allowed value is 2 secs and maximum allowed value is 30 secs.

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.

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.

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.


JavaExecutionArguments

The following properties are available for JavaExecutionArguments :

Table 4-57 JavaExecutionArgumentsProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

AdditionalOptions

Set<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

Custom, contact dev lead

Yes

No

The initial heap size in megabytes (MBs) of the Java Virtual Machine (JVM).

MaximumHeapSizeInMB

Integer

n/a

Custom, contact dev lead

Yes

No

The maximum heap size in megabytes (MBs) of the Java Virtual Machine (JVM).

MaximumPermanentGenerationSizeInMB

Integer

n/a

Custom, contact dev lead

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-58 JcrServletServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

AuthenticationScheme

String

BASIC

Custom, contact dev lead

Yes

No

Specifies the JCR server's authentication scheme. Valid values: basic, digest.

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

Custom, contact dev lead

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.

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.

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-59 LdapServerProperties

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.

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.

UserSearchBaseForSync

String

n/a

All permitted values

Yes

No

Specifies the LDAP user search base DN for UDS sync.

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-60 LoggingConfigurable.LoggingPropertiesProperties

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. It is the default when the log level is not configured through Module Log Level.

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.


ManagedBpelProcessManager

The following properties are available for ManagedBpelProcessManager :

Table 4-61 ManagedBpelProcessManagerProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

BpelCluster

BpelCluster

n/a

All permitted values

No

No

The BPEL Cluster that this BPEL Process Manager belongs to.


ManagedOc4j

The following properties are available for ManagedOc4j :

Table 4-62 ManagedOc4jProperties

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.

CustomNonXaConfig

Map<String,Database.ConnectionPool> (Structural property)

n/a

All permitted values

Yes

No

Custom connection pool settings for non-XA keyed by service name.

CustomXaConfig

Map<String,Database.ConnectionPool> (Structural property)

n/a

All permitted values

Yes

No

Custom connection pool settings for XA keyed by service name.

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

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.

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

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


ManagedOc4jCluster

The following properties are available for ManagedOc4jCluster :

Table 4-63 ManagedOc4jClusterProperties

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.


ManagementService

The following properties are available for ManagementService :

Table 4-64 ManagementServiceProperties

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.

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.

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.

SystemDataCollectorProperties

ManagementService.SystemDataCollectorProperties

n/a

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

The following properties are available for ManagementService.SystemDataCollectorProperties :

Table 4-65 ManagementService.SystemDataCollectorPropertiesProperties

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


MobileDmService

The following properties are available for MobileDmService :

Table 4-66 MobileDmServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

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.

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.


NamedSystemObject

The following properties are available for NamedSystemObject :

Table 4-67 NamedSystemObjectProperties

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-68 NotificationDeliveryServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

ActionAskSettings

NotificationDeliveryService.ActionAskSettings (Structural property)

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

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.

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.

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.

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

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

The following properties are available for NotificationDeliveryService.SmsSettings :

Table 4-69 NotificationDeliveryService.SmsSettingsProperties

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

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, VERISIGN. The default value is XMS.


NotificationDeliveryService.WebProxySettings

The following properties are available for NotificationDeliveryService.WebProxySettings :

Table 4-70 NotificationDeliveryService.WebProxySettingsProperties

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-71 NotificationDeliveryService.XmsSettingsProperties

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

https://notify.multimodeinc.com/xms/webservices

All permitted values

Yes

No

XMS service URL. Default: http://messenger.oracle.com/xms/webservice.

XmsUserName

String

n/a

All permitted values

Yes

No

Username for XMS communication.


ObjectEventPublisherService

No other properties exist for ObjectEventPublisherService .

Oc4j

The following properties are available for Oc4j :

Table 4-72 Oc4jProperties

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.

CustomNonXaConfig

Map<String,Database.ConnectionPool> (Structural property)

n/a

All permitted values

Yes

No

Custom connection pool settings for non-XA keyed by service name.

CustomXaConfig

Map<String,Database.ConnectionPool> (Structural property)

n/a

All permitted values

Yes

No

Custom connection pool settings for XA keyed by service name.

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.


OmaService

The following properties are available for OmaService :

Table 4-73 OmaServiceProperties

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.

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

100

Min=1, Max=2147483647

Yes

No

Maximum devices to cache.

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.

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.

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.

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.

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

SyncmlLogRequired

boolean

false

All permitted values

Yes

No

Enables or disables logging of SyncML messages in the database.


OmsResourceAdapter

The following properties are available for OmsResourceAdapter :

Table 4-74 OmsResourceAdapterProperties

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-75 OmsResourceAdapterInstanceProperties

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-76 OpmnProperties

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-77 OpmnClusterProperties

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-78 OwcStreamingServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

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

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

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


PlatformService

No other properties exist for PlatformService .

PlatformWebService

No other properties exist for PlatformWebService .

PolicyService

No other properties exist for PolicyService .

PresenceService

The following properties are available for PresenceService :

Table 4-79 PresenceServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

ActivityStartTimeThreshold

int

300000

All permitted values

Yes

No

description bundle not set

PollInterval

int

5

All permitted values

Yes

No

description bundle not set

PublicPresenceEnabled

boolean

true

All permitted values

Yes

No

description bundle not set


PushMailService

The following properties are available for PushMailService :

Table 4-80 PushMailServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

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.

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.


PushService

The following properties are available for PushService :

Table 4-81 PushServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

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.

TtlUnauthenticated

int

1

Min=1, Max=10

Yes

No

Timeout for non-authenticated sessions in minutes.


RecordsManagementService

The following properties are available for RecordsManagementService :

Table 4-82 RecordsManagementServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

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.


ResourceAdapter

The following properties are available for ResourceAdapter :

Table 4-83 ResourceAdapterProperties

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-84 ResourceAdapterImageProperties

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-85 ResourceAdapterInstanceProperties

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-86 ResourceDirectoryServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

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.


SAMLIdentity

The following properties are available for SAMLIdentity :

Table 4-87 SAMLIdentityProperties

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-88 SearchServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

CachedPageMaxLength

Integer

1000

All permitted values

Yes

No

description bundle not set

CaseSensitive

Boolean

false

All permitted values

Yes

No

description bundle not set

CrawlCalendarsEnabled

Boolean

true

All permitted values

Yes

No

description bundle not set

CrawlDocumentsEnabled

Boolean

true

All permitted values

Yes

No

description bundle not set

CrawlEmailsEnabled

Boolean

true

All permitted values

Yes

No

description bundle not set

ExcludeRegex

Boolean

false

All permitted values

Yes

No

description bundle not set

MaxResults

Integer

1000

All permitted values

Yes

No

description bundle not set

MaxSearchDuration

Integer

30

All permitted values

Yes

No

description bundle not set

Recovery

Boolean

false

All permitted values

Yes

No

description bundle not set

SyncFrequency

Integer

60

All permitted values

Yes

No

description bundle not set

TwoDBMode

Boolean

false

All permitted values

Yes

No

description bundle not set

WildcardChar

String

*

All permitted values

Yes

No

description bundle not set


Server

The following properties are available for Server :

Table 4-89 ServerProperties

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

No other properties exist for Service .

SesEndptService

The following properties are available for SesEndptService :

Table 4-90 SesEndptServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

Host

String

changethis

All permitted values

Yes

No

The host portion of the url to access the SES endpoint web service.

Port

int

0

All permitted values

Yes

No

The port portion of the url to access the SES endpoint web service.

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.


SipContainer

The following properties are available for SipContainer :

Table 4-91 SipContainerProperties

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-92 SipGatewayProperties

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-93 SipGatewayClusterProperties

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-94 SiteProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

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.

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.

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

Custom, contact dev lead

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.


SmppDeliveryService

The following properties are available for SmppDeliveryService :

Table 4-95 SmppDeliveryServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

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.

UseQuerySMForStatus

boolean

false

All permitted values

Yes

No

Enables or disables the use of QUERY_SM PDU for delivery status reporting.


SubscriptionActionService

No other properties exist for SubscriptionActionService .

SubscriptionService

The following properties are available for SubscriptionService :

Table 4-96 SubscriptionServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

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.


TCPCommBasedScanEngine

The following properties are available for TCPCommBasedScanEngine :

Table 4-97 TCPCommBasedScanEngineProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

ScanEngineAdminPassword

SecureString

n/a

All permitted values

Yes

No

Password for the third-party scan engine administrative console.

ScanEngineAdminURL

String

n/a

All permitted values

Yes

No

URL for the third-party scan engine administrative console.

ScanEngineAdminUsername

String

n/a

All permitted values

Yes

No

Username for the third-party scan engine administrative console.

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.

ScanEngineSecureAdminURL

String

n/a

All permitted values

Yes

No

URL for the secure version of the third-party scan engine administrative console.

ScanEngineSecureClientCommPort

Integer

1344

Network Port, Min=1, Max=65536

Yes

No

Secure communication port used by Beehive for sending client requests to the third-party scan engine.

SecureClientCommEnabled

Boolean

false

All permitted values

Yes

No

Indicates if secure communication is enabled for communications with the third-party scan engine.

SecureClientCommSupported

Boolean

false

All permitted values

Yes

No

Indicates if secure communication is supported for communications with the third-party scan engine.

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-98 TCPCommBasedScanEngineClusterProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

CacheRefreshInterval

Long

600000

Custom, contact dev lead

Yes

No

The interval at which Beehive VirusScanner process refreshes its in-memory cache with data from the virus defnitions storage.

ConnectionReadWriteResponseTimeout

Integer

180

Custom, contact dev lead

Yes

No

Time interval to wait, that will be used by VirusScanner, for receiving responses from the scan engine.

ConnectionRetryTimeInterval

Integer

60

Custom, contact dev lead

Yes

No

Time interval to wait, that will be used by VirusScanner, before re-attempting a connection to the same scan-engine.

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.

MaxConnectionRetryAttempts

Integer

n/a

All permitted values

Yes

No

Maximum number of attempts that will be made to retry connections to the same scan engine.

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

No

The protocol used by Beehive to communicate with the third-party scan service engine.

ScanEngineCommProtocolVer

String

1.0

All permitted values

Yes

No

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

No

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.


TimeManagementService

The following properties are available for TimeManagementService :

Table 4-99 TimeManagementServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

ConsistencyTasksEnabled

Boolean

true

All permitted values

Yes

No

description not found Can't find resource for bundle oracle.ocs.management.model.TimeManagementServiceBundle, key ENABLE_CONSISTENCY_LONG

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.

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. This should only be enabled if required by custom workflows.

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.

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. See also MaxOccurrencesPerSeries.

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.

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.


TimeManagementService.PurgedItemsCleanupProperties

No other properties exist for TimeManagementService.PurgedItemsCleanupProperties .

TimeManagementService.ResourceCleanupProperties

No other properties exist for TimeManagementService.ResourceCleanupProperties .

TimeZoneService

No other properties exist for TimeZoneService .

TranscodingService

The following properties are available for TranscodingService :

Table 4-100 TranscodingServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

ArchiveFolderPath

String

/INBOX

All permitted values

Yes

No

description bundle not set


UnmanagedBeehiveInstance

The following properties are available for UnmanagedBeehiveInstance :

Table 4-101 UnmanagedBeehiveInstanceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

AvailableNumberOfProcessors

int

1

Custom, contact dev lead

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

Custom, contact dev lead

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-102 UnmanagedOc4jProperties

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.

CustomNonXaConfig

Map<String,Database.ConnectionPool> (Structural property)

n/a

All permitted values

Yes

No

Custom connection pool settings for non-XA keyed by service name.

CustomXaConfig

Map<String,Database.ConnectionPool> (Structural property)

n/a

All permitted values

Yes

No

Custom connection pool settings for XA keyed by service name.

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.

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.


Urm

The following properties are available for Urm :

Table 4-103 UrmProperties

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-104 UserDirectoryServiceProperties

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.

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


UserDirectoryService.AttributeMap

The following properties are available for UserDirectoryService.AttributeMap :

Table 4-105 UserDirectoryService.AttributeMapProperties

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-106 UserDirectoryService.ConfigurationParametersProperties

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-107 UserDirectoryService.CustomAttributeProperties

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-108 UserDirectoryService.DirectoryAttributeMapProperties

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

The following properties are available for UserDirectoryService.DirectoryProfile :

Table 4-109 UserDirectoryService.DirectoryProfileProperties

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-110 UserDirectoryService.FieldMapProperties

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-111 UserDirectoryService.FieldMap.SourceTargetValueMappingProperties

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-112 UserDirectoryService.GroupTypeMapEntryProperties

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-113 UserDirectoryService.LdapDirectoryProfileProperties

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

Custom, contact dev lead

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-114 UserDirectoryService.MembershipMapEntryProperties

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-115 UserDirectoryService.ScopeMapEntryProperties

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-116 UserDirectoryService.UserTypeMapEntryProperties

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-117 VirtualServerProperties

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.

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-118 VirusScanConfigurableProperties

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-119 VirusScanEngineProperties

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-120 VirusScanEngineClusterProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

CacheRefreshInterval

Long

600000

Custom, contact dev lead

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

No

The protocol used by Beehive to communicate with the third-party scan service engine.

ScanEngineCommProtocolVer

String

1.0

All permitted values

Yes

No

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

No

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-121 VoiceMessageServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

DebugFlags

Integer

0

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

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-122 VoiceMessageService.EnterprisePropertiesProperties

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-123 VoiceMessageService.FacilityPropertiesProperties

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

No other properties exist for VoiceServletService .

WebdavService

The following properties are available for WebdavService :

Table 4-124 WebdavServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

AuthenticationScheme

String

BASIC

Custom, contact dev lead

Yes

No

Default authentication scheme for WebDAV server. Accepted values are: BASIC, DIGEST, DIGEST-BASIC.

BrowserSessionTimeout

int

30

Custom, contact dev lead

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.

DavClientSessionTimeout

int

960

Custom, contact dev lead

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.

MinimumLockTimeout

int

4

Custom, contact dev lead

Yes

No

The minimum timeout value (in minutes) that a client can request while acquiring a lock.

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

Custom, contact dev lead

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-125 WikiServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

PluginHtmlEnabled

boolean

true

All permitted values

Yes

No

description bundle not set


WorkflowService

The following properties are available for WorkflowService :

Table 4-126 WorkflowServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

BpelCluster

BpelCluster

n/a

All permitted values

Yes

No

The BPEL Cluster that this BPEL Process Manager belongs to.


WorkspacesService

The following properties are available for WorkspacesService :

Table 4-127 WorkspacesServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

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.

MembershipNotificationEnabled

boolean

true

All permitted values

Yes

No

Enables or disables e-mail notification to a user when joining or leaving a workspace.

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

Custom, contact dev lead

Yes

No

Percentage of quota, expressed as an integer, that may be exceeded 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 20, then data additions will begin failing once the workspace size reaches 1.2 GB.


XmppService

The following properties are available for XmppService :

Table 4-128 XmppServiceProperties

Name Data Type Default Values Accepted Values Mutable Read Only Description

DomainName

String

example.com

All permitted values

Yes

No

All domains supported by xmpp service.

DomainNames

List<String>

[example.com]

All permitted values

Yes

No

All domains supported by xmpp service.

Language

String

en

All permitted values

Yes

No

Language used by server.

MessagesOnInvalidAction

List<String>

[]

Custom, contact dev lead

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.

RetryCount

int

6

All permitted values

Yes

No

plsql execution attempts on getting retriable exception

RetryTimeout

int

5

All permitted values

Yes

No

time difference between two plsql execution attempts, when first attempt fails with a retriable exception

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

VersionRules

List<String>

[]

Custom, contact dev lead

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=-2147483648, 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

No other properties exist for ZimbraConnectorService .

ZimbraUIService

No other properties exist for ZimbraUIService .