oracle.bi.management.adminservices.mbeans
Interface ServerConfigurationMBean

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.description",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
public interface ServerConfigurationMBean

Defines an MBean interface for managing settings related to the BI Server. To ensure that exceptions are correctly reported in clients such as JConsole, which typically do not have BIEE jars, only standard exceptions are surfaced here.

Method Summary

java.util.Date	getFileUploadTime(java.lang.String fileName) Returns the date the file specified was uploaded.
java.lang.String	getRepositoryDataSourceName() get the data source name for the default repository
java.lang.String	getRepositoryName() gets the name for the default repository (without the .rpd file extension).
java.lang.String	getRepositorySharedLocation() get the shared location to be used when OBIS is clustered.
java.lang.String	getSummaryAdvisorTableName() Gets the Physical Summary Advisor Statistics table in RPD.
java.lang.String	getSummaryStatisticsLogging() Enable Summary Statistics Logging.
java.lang.String	getUsageTrackingConnectionPool() Gets the Connection Pool for the Usage Tracking table.
java.lang.String	getUsageTrackingPhysicalTableName() Gets the Physical Usage Tracking table in RPD.
boolean	isRepositoryShared() get whether a shared directory is used to find repository files when OBIS is clustered
boolean	isRepositorySharedLocationAccessible() Gets whether the shared location for the repository is accessible from the Enterprise Manager server.
boolean	isUsageTrackingCentrallyManaged() Gets the flag which controls whether the Usage Tracking parameters are centrally managed.
boolean	isUsageTrackingDirectInsert() Gets the flag which controls whether Direct Inserts are enabled within Usage Tracking in BI Server.
boolean	isUsageTrackingEnabled() Gets the flag which controls whether Usage Tracking is enabled in BI Server.
void	resyncRepository() Re-synchronises the repository file which has previously been uploaded, to take any local (on-line) changes into account.
void	setRepositoryDataSourceName(java.lang.String repositoryDataSourceName) set the data source name for the default repository
void	setRepositoryName(java.lang.String repositoryName) sets the name for the default repository (without the .rpd file extension).
void	setRepositoryShared(boolean repositoryShared) set whether a shared location is used to find repository files when OBIS is clustered.
void	setRepositorySharedLocation(java.lang.String repositorySharedLocation) set the shared location to be used when OBIS is clustered.
void	setSummaryAdvisorTableName(java.lang.String summaryAdvisorTableName) Sets the Physical Summary Advisor Statistics table in RPD.
void	setSummaryStatisticsLogging(java.lang.String summaryStatisticsLogging) Enable the Summary Advisor feature in BI Server.
void	setUsageTrackingCentrallyManaged(boolean usageTrackingCentrallyManaged) Sets the flag which controls whether the Usage Tracking parameters are centrally managed.
void	setUsageTrackingConnectionPool(java.lang.String usageTrackingConnectionPool) Sets the Connection Pool for the Usage Tracking table.
void	setUsageTrackingDirectInsert(boolean usageTrackingDirectInsert) Sets the flag which controls whether Direct Inserts are enabled within Usage Tracking in BI Server.
void	setUsageTrackingEnabled(boolean usageTrackingEnabled) Sets the flag which controls whether Usage Tracking is enabled in BI Server.
void	setUsageTrackingPhysicalTableName(java.lang.String usageTrackingPhysicalTableName) Sets the Physical Usage Tracking table in RPD.
void	uploadRepository(java.lang.String rpdFilePath, java.lang.String password) Uploads the repository file whose full path is represented by rpdFilePath.

Method Detail

getRepositoryName

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.RepositoryName",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getRepositoryName()

gets the name for the default repository (without the .rpd file extension).

setRepositoryName

void setRepositoryName(java.lang.String repositoryName)

sets the name for the default repository (without the .rpd file extension).

Parameters:

repositoryName -

getRepositoryDataSourceName

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.RepositoryDataSourceName",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getRepositoryDataSourceName()

get the data source name for the default repository

setRepositoryDataSourceName

void setRepositoryDataSourceName(java.lang.String repositoryDataSourceName)

set the data source name for the default repository

Parameters:

repositoryDataSourceName -

isRepositoryShared

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.RepositoryShared",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
boolean isRepositoryShared()

get whether a shared directory is used to find repository files when OBIS is clustered

setRepositoryShared

void setRepositoryShared(boolean repositoryShared)

set whether a shared location is used to find repository files when OBIS is clustered.
if true, then a repository shared location should be set. if false, then the repository shared location is ignored (and OBIS instances will use the local directory).

Parameters:

repositoryShared -

getRepositorySharedLocation

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.RepositorySharedLocation",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getRepositorySharedLocation()

get the shared location to be used when OBIS is clustered.

Returns:

the shared location - not meaningful if isRepositoryShared is false

setRepositorySharedLocation

void setRepositorySharedLocation(java.lang.String repositorySharedLocation)

set the shared location to be used when OBIS is clustered.

Parameters:

repositorySharedLocation - - the location, required if isRepositoryShared is true but ignored if isRepositoryShared is false. Thus setRepositoryShared(true) must be called before this method will persist the required location.

isRepositorySharedLocationAccessible

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.RepositorySharedLocationAccessible",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
boolean isRepositorySharedLocationAccessible()

Gets whether the shared location for the repository is accessible from the Enterprise Manager server. If the shared location is not accessible then any shared RPD file will not be written to that location. It will have to be copied there as part of a manual task. If there is not a shared location specified then this method will return false.

Returns:

True only if the shared location can be accessed. In all other cases false is returned.

uploadRepository

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.uploadRepository.ByName",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
void uploadRepository(@Name(value="rpdFilePath")
                                  java.lang.String rpdFilePath,
                                  @Name(value="password")
                                  java.lang.String password)
                      throws java.io.IOException

Uploads the repository file whose full path is represented by rpdFilePath.

Parameters:

rpdFilePath - the full path of the repository file.

password - the password for the RPD file.

Throws:

java.io.IOException

getFileUploadTime

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.getFileUploadTime",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.util.Date getFileUploadTime(@Name(value="rpdFilePath")
                                             java.lang.String fileName)
                                 throws java.io.IOException

Returns the date the file specified was uploaded. Note: Only a single file of each type can be uploaded. Asking for the upload time of a previous uploaded file will result in an null return.

Parameters:

fileName - The name of the target file.

Returns:

The date the file was uploaded, or null if the file is not in the current upload bundle. Must not be null.

Throws:

java.io.IOException

resyncRepository

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.uploadRepository.ByName",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
void resyncRepository()
                      throws java.io.IOException

Re-synchronises the repository file which has previously been uploaded, to take any local (on-line) changes into account.

Throws:

java.io.IOException

isUsageTrackingCentrallyManaged

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.UsageTrackingCentrallyManaged",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
boolean isUsageTrackingCentrallyManaged()

Gets the flag which controls whether the Usage Tracking parameters are centrally managed.

Since:

11.1.1.5.61

setUsageTrackingCentrallyManaged

void setUsageTrackingCentrallyManaged(boolean usageTrackingCentrallyManaged)

Sets the flag which controls whether the Usage Tracking parameters are centrally managed.

Select true to propagate Usage Tracking attributes to NQSConfig. Please ensure that Usage Tracking attributes - ENABLE, DIRECT_INSERT, PHYSICAL_TABLE_NAME, CONNECTION_POOL, SUMMARY_STATISTICS_LOGGING, SUMMARY_ADVISOR_TABLE_NAME - are correct and up to date before selecting true.

Select false to manually manage Usage Tracking attributes within NQSConfig.

Parameters:

usageTrackingCentrallyManaged -

Since:

11.1.1.5.61

isUsageTrackingEnabled

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.UsageTrackingEnabled",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
boolean isUsageTrackingEnabled()

Gets the flag which controls whether Usage Tracking is enabled in BI Server.

Since:

11.1.1.5.61

setUsageTrackingEnabled

void setUsageTrackingEnabled(boolean usageTrackingEnabled)

Sets the flag which controls whether Usage Tracking is enabled in BI Server.

Note: Only processed if #UsageTrackingCentrallyManaged is true.

Parameters:

usageTrackingEnabled -

Since:

11.1.1.5.61

isUsageTrackingDirectInsert

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.UsageTrackingDirectInsert",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
boolean isUsageTrackingDirectInsert()

Gets the flag which controls whether Direct Inserts are enabled within Usage Tracking in BI Server.

Since:

11.1.1.5.61

setUsageTrackingDirectInsert

void setUsageTrackingDirectInsert(boolean usageTrackingDirectInsert)

Sets the flag which controls whether Direct Inserts are enabled within Usage Tracking in BI Server.

Set true to directly insert Usage Tracking rows in the Usage Tracking table. Set false if you wish to write Usage Tracking entries to a file, and load this into Usage Tracking manually with a database bulk loader.

Note: Only processed if #UsageTrackingCentrallyManaged is true.

Parameters:

usageTrackingDirectInsert -

Since:

11.1.1.5.61

getUsageTrackingPhysicalTableName

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.UsageTrackingPhysicalTableName",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getUsageTrackingPhysicalTableName()

Gets the Physical Usage Tracking table in RPD.

Since:

11.1.1.5.61

setUsageTrackingPhysicalTableName

void setUsageTrackingPhysicalTableName(java.lang.String usageTrackingPhysicalTableName)

Sets the Physical Usage Tracking table in RPD.

The fully qualified path to the physical Usage Tracking table in your RPD.

Note: Only processed if #UsageTrackingCentrallyManaged is true.

Parameters:

usageTrackingPhysicalTableName -

Since:

11.1.1.5.61

getUsageTrackingConnectionPool

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.UsageTrackingConnectionPool",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getUsageTrackingConnectionPool()

Gets the Connection Pool for the Usage Tracking table.

Since:

11.1.1.5.61

setUsageTrackingConnectionPool

void setUsageTrackingConnectionPool(java.lang.String usageTrackingConnectionPool)

Sets the Connection Pool for the Usage Tracking table.

The fully qualified path to the Connection Pool of the Usage Tracking table in your RPD.

Note: Only processed if #UsageTrackingCentrallyManaged is true.

Parameters:

usageTrackingConnectionPool -

Since:

11.1.1.5.61

getSummaryStatisticsLogging

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.SummaryStatisticsLogging",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getSummaryStatisticsLogging()

Enable Summary Statistics Logging. Select NO to manually manage Usage Tracking attributes within NQSConfig.

Returns:

Allowable values: "NO", "YES", and "LOG_OUTER_JOINT_QUERIES_ONLY".

Since:

11.1.1.5.61

setSummaryStatisticsLogging

void setSummaryStatisticsLogging(java.lang.String summaryStatisticsLogging)

Enable the Summary Advisor feature in BI Server.

Allowable values: "NO", "YES", and "LOG_OUTER_JOINT_QUERIES_ONLY".

BI Server will log Summary Advisor statistics to the table specified in #SummaryAdvisorTableName. Please note that general #UsageTrackingEnabled must be true and #UsageTrackingDirectInserts set true, and the attributes #UsageTrackingPhysicalTableName and #UsageTrackingConnectionPool specified.

Note: Only processed if #UsageTrackingCentrallyManaged is true.

Parameters:

summaryStatisticsLogging -

Since:

11.1.1.5.61

getSummaryAdvisorTableName

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.SummaryAdvisorTableName",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getSummaryAdvisorTableName()

Gets the Physical Summary Advisor Statistics table in RPD.

Since:

11.1.1.5.61

setSummaryAdvisorTableName

void setSummaryAdvisorTableName(java.lang.String summaryAdvisorTableName)

Sets the Physical Summary Advisor Statistics table in RPD.

The fully qualified path to the physical Summary Advisor statistics table in your RPD.

Note: Only processed if #UsageTrackingCentrallyManaged is true.

Parameters:

summaryAdvisorTableName -

Since:

11.1.1.5.61