1. Configuring Oracle Analytics Cloud
  2. Advanced Configuration
  3. Customize and Configure Advanced Options
  4. Configure Advanced Options

Configure Advanced Options

Administrators can set several advanced options using the System Settings page.

Topics:

About System Settings

Administrators can set a range of advanced, service-level options through the System Settings page. For example, you might want to change the default currency and time zone for analyses and dashboards to values that better suit your organization.

Analytic Content Options

You use these options to set defaults and customizations for dashboards, analyses, and reports. For example, you can configure the analysis editor to open by default to the Criteria tab or the Results tab.

Note:

If you change an analytic content setting, you must apply the change for the new value to take effect.
System Setting More Information
Analytics Publisher Reporting Toolbar Mode

Configures an alternate toolbar for pixel-perfect reports that are included in a dashboard.

  • 1 — Doesn't display a toolbar for pixel-perfect reports.
  • 2 — Displays the URL to the report without the logo, toolbar, tabs, or navigation path.
  • 3 — Displays the URL to the report without the header or any parameter selections. Controls such as Template Selection, View, Export, and Send are still available.
  • 4 — Displays the URL to the report only. No other page information or options are displayed.
  • 6 — Displays parameter prompts for the report in a toolbar.

Valid Values: 1,2,3,4,6

Default: 1

API Key: AnalyticsPublisherReportingToolbarMode

Edition: Enterprise only

Answers Editor Start Tab

Specifies whether the analysis editor opens by default to the Criteria tab or the Results tab.

This setting applies when users click an Edit link for an analysis from a dashboard, the Home page, or the Catalog page.

Users can override this default setting by specifying the Full Editor option in the My Account dialog.

  • answerResults — Opens the analysis editor by default to the Results tab.

  • answerCriteria — Opens the analysis editor by default to the Criteria tab.

Valid Values: answerResults, answerCriteria

Default: answerResults

API Key: AnswersEditorStartTab

Edition: Enterprise only

Answers Subject Area Sorting Order

Sets the default sort order for subject area content trees. Users can override this default setting in the My Account: Subject Area Sort Order dialog.

  • asc — Sorts A to Z.

  • desc — Sorts Z to A.

  • rpd — Uses the subject area sort order specified in the original analyses.

Valid Values: asc, desc, rpd

Default: rpd

API Key: AnalysisSubjectAreaSortingOrder

Edition: Enterprise only

Custom Links XML

Specifies the XML code containing Classic Home page header customizations.

You can use this XML code to customize the global header section of the Home page to better meet the needs of your users. For example, you can disable certain links or add custom ones. See Customize Links on the Classic Home Page.

API Key: CustomLinksXml

Edition: Enterprise only

URL for Blocking Queries in Analyses

Specifies the URL for the JavaScript file to validate query criteria and block queries. See Validate and Block Queries in Analyses Using Custom JavaScript.

API Key: QueryBlockingScriptURL

Edition: Enterprise only

Writeback Template XML

Defines the XML configuration for performing writeback on data elements.

For example, you can use an XML template to enable users of a dashboard page or an analysis with the ability to modify, or write back, the data that they see in a table view.

API Key: WriteBackTemplateXML

Edition: Enterprise only

Connection Options

You use these options to configure connection-related defaults.

Note:

If you change a connection setting, you must apply the change for the new value to take effect.
System Setting More Information
Connection Externalization Enabled

Specifies whether to externalize any database connections that administrators configured for semantic models in Oracle Analytics Cloud, using Console.

When you externalize the connection information, anyone who uses Model Administration Tool to edit semantic models can refer to the database connections “by name” rather than re-entering the connection details in full (connection pool settings). See Connect to a Data Source using a Connection Defined Through Console.

  • On — Externalizes the database connections that administrators define for semantic models through Console.

  • Off — Doesn't externalize database connections details. Anyone using Model Administration Tool to edit semantic models must enter the database connection information in the Connection Pool dialog.

Default: On

API Key: EnableConnectionExternalization

Edition: Enterprise only

Email Delivered by Agents Options

You can use these options to customize the way agents deliver email.

System Setting More Information
Maximum Email Size (KB)

Specifies the maximum size (KB) of a single email.

If you set a maximum email size, you can avoid situations when SMTP servers reject emails that are too large, and in the event that an email exceeds the set limit, the email recipients receive an error message instead of the agent failing and just alerting the email author.

Valid Values: 0-20480

Default: 0 (unlimited email size)

API Key: EmailMaxEmailSizeKB

Edition: Enterprise only

Maximum Number of Recipients per Email

Specifies the maximum number of recipients allowed in the To: or Bcc: line for a single email.

You can set the maximum number of email recipients to avoid some SMTP servers from filtering out these emails as spam. If the recipient list exceeds the set limit, the list is split into smaller lists with the maximum number of allowed recipients in each list.

Valid Values: 0-1024

Default: 0 (unlimited number of email recipients)

API Key: EmailMaxRecipients

Edition: Enterprise only

Safe Domains

If you want to restrict the email domain that Oracle Analytics can send emails to, enter the name of the domain. For example, examplemaildomain.com.

Use a comma to separate multiple domain names. For example, exampledomain1.com,exampledomain2.com. By default, there are no restrictions.

API Key: EmailSafeDomains

Edition: Enterprise only

Use BCC

Specifies whether to include the names of email recipients in the To: or Bcc: line. By default, email recipients are added to the Bcc: line.

  • On — Add email recipients to the Bcc: line. Names of email recipients are hidden.

  • Off — Add email recipients to the To: line. Everyone who receives the email sees the recipient list.

Default: On

API Key: EmailUseBcc

Edition: Enterprise only

Use RFC 2231 Encoding

Specifies how to encode MIME email parameters. By default, RFC 2047 is used.

  • On — Use RFC 2231 to encode MIME email parameter values. RFC 2231 supports multi-byte languages. Select On if you deliver emails that contain multi-byte characters and use an email server that supports RFC 2231, such as Microsoft Outlook for Office 365 or Google Gmail.

  • Off — Use RFC 2047 to encode MIME email parameter values.

Default: Off

API Key: EmailUseRFC2231

Edition: Enterprise only

Format Options

You use these options to configure default currency and time zone settings for analyses and dashboards.

These options apply only to analyses and dashboards. They don't apply to data visualizations.

Note:

If you change a format setting, you must apply the change for the new value to take effect.
System Setting More Information
Currencies XML

Defines the default currency that's displayed for currency data in analyses and dashboards. For example, you can change from American dollars ($) to Euros (E).

API Key: AnalysisCurrenciesXml

Edition: Enterprise only

Default Data Offset Time Zone

Specifies a time zone offset of the original data that users see in analyses and dashboards. Enter an offset value that indicates the number of hours away from Greenwich Mean Time (GMT) time.

For example, to display values in United States Eastern Standard Time (EST), which is Greenwich Mean Time (GMT) - 5 hours, enter the value GMT-05:00 or the equivalent value in minutes -300.

If you don't set this option, no time zone conversion occurs because the value is "unknown".

Specifying a different offset value for each user

If you want to specify a different offset value where session variables can be used (for example, expressions, calculations), don't use the Default Data Offset Time Zone setting. Instead, set the system session variable DATA_TZ in the semantic model. See About Session Variables.

API Key: DefaultDataOffsetTimeZone

Edition: Enterprise only

Default Time Zone for Date Calculations

Specifies the time zone used for evaluating date calculations such as getting the current date/time, truncating datetime values to a date, and extracting time fields from date/time expressions.

If you leave this field blank, Oracle Analytics uses the Coordinated Universal Time (UTC) time zone when evaluating date calculations.

API Key: DefaultTimeZoneforDateCalculations

Edition: Professional and Enterprise

Default User Preferred Time Zone

Specifies a default preferred time zone that users see in analyses and dashboards before they select their own in the My Account Preferences dialog.

If you don't set this option, Oracle Analytics uses the local time zone.

Specifying a different time zone for each user

If you want to specify a different offset value where session variables can be used (for example, expressions, calculations), don't use the Default User Preferred Time Zone setting. Instead, set the system session variable TIMEZONE in the semantic model. See About Session Variables.

API Key: DefaultUserPreferredTimeZone

Edition: Enterprise only

User Currency Preferences XML

Determines whether users see a Currency option in their My Account preferences dialog and the list of currencies available to them. If you provide the Currency option, users can select in which currency they prefer to view columns of currency data in analyses and dashboards.

API Key: UserCurrencyPreferencesXml

Edition: Enterprise only

Other Options

These system setting options in the Console enable you to set the behavior for a variety of actions such as database queries, default URLs, display defaults, and sorting.

Note:

If you change one of these settings, you must apply the change for the new value to take effect unless we note it otherwise.
System Setting More Information
Disable Right Trim for VARCHAR Data

Specifies whether the automatic removal of trailing spaces from varchar columns is enabled (Off) or disabled (On). For example, when this property is enabled (Off), when a user starts entering values in a field, the filter dialog automatically trims any trailing spaces.

  • On — Preserves trailing whitespaces in varchar columns. If you primarily use Oracle Database sources, you might want to keep the default Oracle Database behavior of preserving trailing whitespaces rather than removing them. When you toggle this property on, you avoid the overhead of trimming spaces, and this can improve performance.

    If you disable this property (set it to On) and you construct a filter such as PRODUCT_DESCRIPTION = 'My Product '), you must make sure the amount of trailing whitespace used exactly matches the varchar column value. If you don't, the filter won't correctly match the data values.

  • Off — Trims trailing whitespaces in varchar columns when processing queries. This is the default for Oracle Analytics. For example, if a user enters the text 'My Product ', it trims it to 'My Product'.

Default: Off

API Key: DataQueryDisableRightTrimVARCHARData

Edition: Professional and Enterprise

Enable Subrequest Shipping

Specifies if sub-requests to source databases are executed separately as standalone queries or executed together. By default, sub-requests are shipped separately which can improve performance if you execute complex reports with a large group of sub-requests, that is, you prefer to ship the sub-requests separately in multiple simplified queries rather than ship a large single complicated query all at once.

In Oracle BI Enterprise Edition, the default is set to NO. If you used Oracle BI Enterprise Edition and want to retain the previous default behavior, set this property to NO to continue executing database sub-requests together.

  • Default — Database sub-requests are shipped separately. This is the same as the value YES.
  • YES — Database sub-requests are shipped separately.
  • NO — Database sub-requests are shipped together, all at once.

Default: Default

API Key: EnableSubrequestShipping

Edition: Professional and Enterprise

Enforce Safe Domains in Actons

Determines whether action links that users add to analyses and dashboards can invoke any URL or only URLs that administrators specify in the safe domains list.

  • On — Don't allow actions to invoke any URL that's not in the safe domain list.
  • Off — Allow actions to invoke any URL, even if the URL isn't listed as a safe domain.

Default: On for a brand new service and Off for an existing service.

Apply Change Required: No

API Key: EnforceSafeDomainsActions

Edition: Enterprise only

Hide EPM Cloud Members with No Access

Specifies if users can view all EPM dimension members in a hierarchy prompt list of values or when adding the hierarchy to a canvas, even if they don't have data access to some of the members.

  • On —Show only those members of an EPM dimension that users have data access to.

    If this setting is On, users who don't have access to the root member of the dimension hierarchy won't see any EPM members in hierarchies or hierarchy prompts.

  • Off — Users can view all the members in an EPM dimension even if they don't have access to view data for some members.

Default: Off

API Key: HideEPMCloudMembersWithNoAccess

Edition: Professional and Enterprise

Hide Loading Messages

Specifies if a detailed message is displayed during data load processing.

  • On — Detailed loading messages are hidden and a simplified message Loading... is displayed instead.

  • Off — Detailed loading messages are displayed.

Default: Off

API Key: HideLoadingMessages

Edition: Professional and Enterprise

Locale

Applies to content migrated from Oracle BI Enterprise Edition.

After you migrate content from your Oracle BI Enterprise Edition environment to Oracle Analytics, you may see a different language in messages, dates, or currencies within analyses.

For example, if you look at a migrated analysis in Polish, the currencies or dates might display based on the Oracle Analytics default locale, not the original Oracle BI Enterprise Edition locale. To preserve the Oracle BI Enterprise Edition currencies and dates in Oracle Analytics, change this setting to Polish.

API Key: DataQueryLocale

Edition: Professional and Enterprise

Portal Path

Specifies the path of the dashboard page that's displayed by default when users sign in to Oracle Analytics. For example, /shared/<folder>/_portal/<name>.

You can specify a single path for all users and multiple paths by user role, for example {"application role 1":"catalog dashboard path 1","application role 2":"catalog dashboard path 2","default":"catalog dashboard path 3"}.

This setting applies to all users, but users can override it after they've signed in.

You can enter a maximum of 5,000 characters in this field.

API Key: PortalPath

Edition: Enterprise only

Recursive Datetime Type Checking

Specifies whether to enforce strict recursive data type checking for comparisons between identical data types (for example, integer to integer) or non-compatible data types (for example, integer to short integer) on all data sources or with all datasets.

  • On — Enforces strict recursive checking for identical or non-compatible data types on all data sources or datasets.

  • Off — Relaxes strict recursive checking for date and time data types on all data sources or datasets. However, if there are too many data type inconsistencies, you may want to change the data types to be compatible or use constants of the correct data type when comparing a column to a value. For example, after you migrate content from Oracle BI Enterprise Edition to Oracle Analytics, you might start seeing this type of check error in your reports because eary versions of Oracle BI Enterprise Edition didn't enforce strict checks:

    [nQSError: 22024] A comparison is being carried out between non-compatible types <type1> and <type2>.

Default: On

API Key: RecursiveDatetimeTypeChecking

Edition: Professional and Enterprise

Repeat Rows on Excel Exports for Tables and Pivots

Specifies whether cells that span rows and cells that span columns are repeated when exporting tables and pivot tables to Excel.

  • On — If switched on, cells that span rows and cells that span columns are repeated, regardless of the Value Suppression setting in the Analysis editor.
  • Off — If switched off, the Value Suppression setting in the Analysis editor is honored and cells that span rows and cells that span columns don't repeat when exporting tables and pivot tables to Excel.

Default: Off

API Key: AnalysisRepeatRowsExcelExportsTablesPivots

Edition: Enterprise only

Sort Null Values First

Specifies whether to sort NULL values before other values (On) or after (Off). Select the value that matches your database. If this setting doesn't match your database setting, then the database setting takes precedence.

  • On — Sorts NULL values before other values.
  • Off — Sorts NULL values after other values.

Default: Off

API Key: SortNullValuesFirst

Edition: Professional and Enterprise

Sort Order Locale

Applies to content migrated from Oracle BI Enterprise Edition.

After you migrate content from your Oracle BI Enterprise Edition environment to Oracle Analytics, you may experience different sorting behaviors in analyses.

For example, if you look at a migrated analysis in Polish, the upper case and lower case letters might sort based on the Oracle Analytics default locale, not the original Oracle BI Enterprise Edition locale. To preserve the Oracle BI Enterprise Edition sort behavior in Oracle Analytics, change this setting to Polish.

API Key: DataQuerySortOrderLocale

Edition: Professional and Enterprise

Performance and Compatibility Options

You use these options to configure performance and compatibility settings between Oracle BI Enterprise Edition and Oracle Analytics. For example, you can set the maximum temporary file size.

Tutorial icon LiveLabs Sprint

Note:

If you change a performance and compatibility setting, you must apply the change for the new value to take effect unless we note it otherwise.
System Setting More Information
Brushing Enabled for Datasets

Specifies whether brushing is enabled by default for workbooks that use dataset data.

  • On — Brushing is on by default for workbooks that use dataset data.

  • Off — Brushing is off by default for workbooks that use dataset data.

Users can override this setting in the workbook and canvas properties.

Default: On

API Key: EnableBrushingDatasets

Edition: Professional and Enterprise

Brushing Enabled for Subject Areas

Specifies whether brushing is enabled by default for workbooks that use data from subject areas.

  • On — Brushing is on by default for workbooks that use subject area data.

  • Off — Brushing is off by default for workbooks that use subject area data.

Users can override this setting in the workbook and canvas properties.

Default: On

API Key: EnableBrushingSubjectAreas

Edition: Enterprise only

Cache Dashboard Listing Dropdown Menu

Specifies how often the Dashboards menu list on the Oracle Analytics Classic Home page is populated during a user session.

  • On — Dashboards menu lists are only populated once per user session. This improves performance but may result in stale lists until the user logs out and back in which refreshes the lists.

  • Off — Dashboards menu lists are populated every time they’re opened.

Default: Off

API Key: CacheDashboardListingDropdownMenu

Edition: Enterprise only

Cache Enable

Specifies whether data query caching is enabled or disabled.

  • On — Data caching is enabled.

  • Off — Caching is disabled.

Default: On

API Key: EnableDataQueryCache

Edition: Professional and Enterprise

Enable Auto Insights on Datasets

Specifies whether the Auto Insights feature is available when datasets are created or modified.

  • On — The Enable Insights option is available in the Dataset Inspect dialog and insights are automatically generated and available for workbooks that use datasets with the Enable Insights option selected.

  • Off — Auto Insights and its related features are disabled.

Default: On

Apply Change Required: No, but when you change this setting, it may take a few minutes to take effect.

API Key: EnableAutoInsightsDatasets

Edition: Professional and Enterprise

Enable Database Analytics Node in Data Flows

Specifies whether the Database Analytics node is displayed in data flows.

  • On — The Database Analytics node is available in data flows so that data flow designers can apply database analytics functions to the data.

  • Off — The Database Analytics node isn't available in data flows. This prevents data flow designers from generating a potentially high number of SQL statements and slowing database performance.

Default: On

API Key: EnableDatabaseAnalyticsNodeDataFlows

Edition: Professional and Enterprise

Enable Immediate Dashboard Rendering

Specifies whether to display available dashboard content immediately or wait until all the dashboard content is ready.

  • On — Display dashboard content immediately even if some content is unavailable.

  • Off — Wait for all the dashboard content to be ready before displaying content.

Default: Off

API Key: EnableImmediateDashboardRendering

Edition: Enterprise only

Evaluate Support Level

Specifies who can issue database functions: EVALUATE, EVALUATE_ANALYTIC, EVALUATE_AGGR, and EVALUATE_PREDICATE.

By default (0), the EVALUATE database functions are disabled.

  • 1 — Service administrators only. Users with the BI Service Administrator application role can invoke EVALUATE database functions.

  • 2 — Anyone. Any user who signs in to Oracle Analytics can invoke EVALUATE database functions.

  • 0 (or any other value) — No one. All EVALUATE database functions are disabled in Oracle Analytics.

Valid Values: 0, 1, 2

Default: 0

API Key: EvaluateSupportLevel

Edition: Professional and Enterprise

Load Semantic Models Using Multiple Threads

Specifies if semantic models load using multiple threads. If you find that your large datasets load slowly and impact system processing times, enabling this option may improve performance.

  • On — Semantic models load in parallel.

  • Off — Semantic models don't load in parallel.

Default: Off

API Key: LoadSemanticModelsWithMultipleThreads

Edition: Enterprise only

Maximum Working File Percent Size

Specifies that the temporary file doesn't exceed a specified percentage of the global work directory size limit.

The size limit defaults for temporary files is 5% (of 100 GB), equivalent to 5 GB. The file limit applies individually to each temporary file, while the size specified for the total global work directory applies collectively to all temporary files created.

You can increase or decrease this value within the range of 5% to 50%. This enables temporary file sizes between 5GB and 50GB. Raising this setting above 50% limits concurrency for large operations.

Valid Values: 5-50

Default: 5

API Key: MaximumWorkingFilePercentSize

Edition: Enterprise only

Mobile Watch Service Enabled

Specifies if the Data Watch service is active.

  • On — The Data Watch service is active and all mobile users can specify the threshold value for bring backs.

  • Off — The Data Watch service is inactive.

Default: On

API Key: EnableMobileDataWatchService

Edition: Professional and Enterprise

Mobile Watch Service Frequency

Specifies the frequency at which the Data Watch service must scan the server for changes based on the frequency of changes in your data sources.

The default is 240 (4 hours). You can disable this service by changing this setting frequency to 0 or by toggling the Mobile Watch Service Enabled setting to off.

Valid Values: 0-10139

Default: 240

API Key: MobileDataWatchServiceFrequency

Edition: Professional and Enterprise

OBIEE Compatibility Release

Specifies the on-premise Oracle BI Enterprise Edition version number for feature compatibility. This only applies if you upgrade from Oracle BI Enterprise Edition to Oracle Analytics, and you want to use a feature from a specific on-premises release in Oracle Analytics.

Valid Values: 11.1.1.9, 11.1.1.10, 11.1.1.11, 12.2.1.0, 12.2.1.1, 12.2.1.3, 12.2.1.4, 12.2.2.0, 12.2.3.0, 12.2.4.0, 12.2.5.0

API Key: OBIEECompatibilityRelease

Edition: Professional and Enterprise

Override Database Features

Specifies if users can use request variables to override database features.

  • 1 — Only administrators can override database features.

  • 2 — Any user can override database features.

  • 0 — No user can override database features.

Valid Values: 0, 1 , 2

Default: 0

API Key: OverrideDatabaseFeatures

Edition: Enterprise only

Restrict Data Export and Delivery

Restricts the maximum number of rows users can export or deliver by email in formatted and unformatted content. Data export and delivery limits depend on the size of your Oracle Analytics service. See Data Export and Delivery Limits by Compute Size.

Valid Values: No Throttle, 90% of Maximum, 80% of Maximum, 70% of Maximum, 60% of Maximum, 50% of Maximum, 40% of Maximum, 30% of Maximum, 20% of Maximum, 10% of Maximum, Minimum - 1000 rows

Default: No Throttle

API Key: RestrictDataExportAndDelivery

Edition: Professional and Enterprise

Strong Datetime Type Checking

Specifies whether to enforce strict checking for date and time data types and whether to reject queries that contain incompatibilities in date and time data types.

  • On — Enforces strict checking for date and time data types.

  • Off — Relaxes strict checking for date and time data types. However, invalid queries or queries with severe date and time incompatibilities may still be still rejected. For example, date and time incompatibilities might be rejected if your relational database uses strict checking for those data types.

Default: On

API Key: StrongDatetimeTypeChecking

Edition: Professional and Enterprise

Preview Options

Administrators can turn some preview features on and off. This way, your organization can evaluate and learn how to use new features before they roll out by default.

System Setting More Information
Preview Workbook Email Scheduler

Enable this option so that administrators can set up a schedule to regularly share their workbooks with one or more email recipients in PDF or PNG format. See Share Visualizations Using Workbook Email Schedules (Preview).

  • On — Displays the Schedule option in the Actions menu of a workbook to users with the BI Service Administrator application role with Read-Write access and the Edit share permission on the workbook.

  • Off — Disables and hides the Schedule option in the Actions menu of a workbook.

Default: Off

Apply Change Required: No

API Key: PreviewWorkbookEmailScheduler

Edition: Enterprise only

Preview Workbook Email Scheduling with Bursting

Enable this option to allow administrators to set bursting options when emailing workbooks saved in Shared Folders. This option requires Preview Workbook Email Scheduler to be enabled. See Share Visualizations Using Workbook Email Schedules (Preview) and Create a Bursting Workbook Email Schedule (Preview).

  • On — Enables users with a BI Service Administrator application role with Read-Write access and the Edit share permission for the workbook to enable the Bursting option in the Email tab of a workbook schedule if the workbook is saved in Shared Folders.

  • Off — Disables the Bursting option in the Email tab of a workbook schedule.

Default: Off

Apply Change Required: No

API Key: PreviewWorkbookEmailBursting

Edition: Enterprise only

Prompt Options

You use these options to configure prompt behavior in analyses and dashboards. For example, you can enable search results to automatically display as highlighted when users enter search parameters, without the need to click Search.

These options apply only to analyses and dashboards. They don't apply to data visualizations.

Note:

If you change a prompt setting, you must apply the change for the new value to take effect.
System Setting More Information
Auto Apply Dashboard Prompt Values

Enables the option to hide the Apply button so that prompt values can be applied without clicking any button.

If this is property is On:

  • Displays the Show Apply Button and Show Reset Button fields in the Edit Page Settings dialog.

  • Displays the Prompts Apply Buttons and Prompts Reset Buttons fields in the Dashboard Properties dialog.

  • Displays the Prompt Buttons on Current Page option on the dashboard builder's Tools menu.

Default: On

API Key: AutoApplyDashboardPromptValues

Edition: Enterprise only

Auto Search on Prompt Value Search Dialog

Enables search results to automatically display and highlight when users enter search parameters, without the need to click Search.

Default: On

API Key: EnableAnalysisAutoSearchPromptDialog

Edition: Enterprise only

Case Insensitive Auto Complete

Specifies whether, when a user enters a prompt value in analyses and dashboards, the auto-complete functionality is case-insensitive.

  • On — Case isn't considered when a user enters a prompt value such as "Oracle" or "oracle."

  • Off — Case is considered when a user enters a prompt value, so the user must enter "Oracle" and not "oracle" to find the Oracle record.

Default: On

API Key: AutoCompletePromptDropDownsCaseInsensitive

Edition: Enterprise only

Show Null Value When Column Is Nullable

Specifies whether to show the term "NULL" at runtime in the column prompt above the column separator in the drop-down list when the database allows null values.

  • always — Always shows the term "NULL" above the column separator in the drop-down list.

  • never — Never shows the term "NULL" in the drop-down list.

  • asDataValue — Displays the data value in the drop-down list, not the term "NULL" above the separator in the drop-down list.

Valid Values: always, never, asDataValue

Default: always

API Key: AnalysisPromptsShowNullValueWhenColumnIsNullable

Edition: Enterprise only

Support Auto Complete

Enables or disables the auto-complete functionality available in prompts.

  • On — Enables auto-complete, which means that the Prompts Auto-Complete field is displayed and set to On in the My Account dialog and in the Dashboard Properties dialog.

  • Off — Disables auto-complete, which means that the auto-complete fields in the My Account and Dashboard Properties dialogs aren't available.

Default: Off

API Key: EnableAnalysisAutoCompletePrompt

Edition: Enterprise only

Security Options

Use Security options to control how users can perform specific actions in analyses and dashboards.

These options apply only to analyses and dashboards. They don't apply to data visualizations.

Note:

If you change a security setting, you must apply the change for the new value to take effect.
System Setting More Information
Allow HTML/JavaScript/CSS Content

Determines whether users can apply and save HTML, JavaScript, and CSS markup in various text fields for analyses and dashboards, and how any previously saved markup is used.

  • Always — Enables users to apply markup. Displays the Contains HTML/JavaScript/CSS Markup option in dialogs where additional formatting might be useful. For example:

    • For analyses: Various dialogs in the analysis editor, Analysis Properties dialog, Column Properties (Column Format) dialog, Edit Column Formula dialog, Narrative dialog, Ticker dialog, Static Text dialog, and New Calculated Measure dialog.
    • For dashboards: Various dialogs in the dashboard editor, Text Properties dialog, and Edit Header and Edit Footer dialogs (under Print and Export Options).

  • Never — Prevents users from applying markup. Hides the Contains HTML/JavaScript/CSS Markup option. Users can only enter plain text. Oracle Analytics ignores any markup that users previously entered and saved for their analyses and dashboards.

  • HTML Only — Enables users to apply HTML markup. Displays the Contains HTML/JavaScript/CSS Markup option in dialogs where additional formatting might be useful but only safe HTML is allowed (no JavaScript or CSS). When an analysis or dashboard opens, Oracle Analytics sanitizes any markup that users have entered and applies only the HTML markup.
  • On Open — Prevents users from applying additional markup (existing markup is retained). Hides the Contains HTML/JavaScript/CSS Markup option so users can enter only plain text. Any previously saved markup for analyses and dashboards continues to be applied.

    Note: The On Open option was previously named "Off".

API Key: AllowHTMLJavaScriptCSSContent

Edition: Enterprise only

Enable Push Notifications

Specifies if mobile application push notifications are enabled (on) or disabled (off).

  • On — Enables mobile application push notifications to receive alerts and messages.

  • Off — Disables mobile application push notifications to stop receiving alerts and messages.

Default: On

API Key: EnableMobilePushNotifications

Edition: Professional and Enterprise

Export Data to CSV and Tab-Delimited Files as Text

Specifies if leading apostrophes are added when data is exported to CSV or tab-delimited files, so all fields are treated as text.

  • On — Leading apostrophes are automatically added to CSV and tab-delimited files during exports.

  • Off — Data is exported to CSV files as-is.

    Caution:

    When Off, opening exported CSV files may invoke unwanted formulas.
See Export the Results of Analyses.

Note:

This setting applies only to visualizations and analyses. It doesn't apply to pixel-perfect reports.

Default: Off

API Key: ExportDataToCSVFilesAsText

Edition: Professional and Enterprise

Post Logout Redirect URL

Specifies the URL users are redirected to when they sign out of Oracle Analytics. For example, you might want to redirect users to a company web page, or display sign in details that open the Classic Home page.

Note:

This setting works for Oracle Analytics Cloud instances created after January 23rd 2023. If you want to configure a post logout URL for an Oracle Analytics Cloud instance that was created before January 23rd 2023, raise a service request with Oracle Support.

API Key: PostLogoutRedirectURL

Edition: Enterprise only

Save Workbook Thumbnails

To help people identify workbook content, Oracle Analytics can display thumbnail images for workbooks on the Home page. The information that’s shown in these thumbnails is blurred to protect sensitive data from being exposed to users that don't have the same access as data authors.

This setting overrides any Save thumbnails value set in the Workbook Properties dialog at the individual workbook level.

Note:

This setting doesn't apply to watchlists because they don't use thumbnails. Instead, watchlists display miniaturized visualizations that reload whenever you refresh the Home page.

  • On — Display blurred workbook thumbnails on the Home page. If this setting enabled (on), workbook owners can hide the thumbnail for individual workbooks if they need to. See Set Workbook Thumbnails.

  • Off — Don’t display any workbook thumbnails on the Home page. Instead, show the standard icon for all workbooks.

Default: On

API Key: SaveWorkbookThumbnail

Edition: Professional and Enterprise

Sign Out Inactive Users Automatically

Specifies whether to automatically sign out users after the inactivity timeout is reached.

  • On — Users are automatically signed out when the inactivity timeout is reached.

  • Off — Users remain signed in even if the inactivity timeout is reached.

Default: Off

API Key: SignOutInactiveUsersAutomatically

Edition: Professional and Enterprise

URL for Browser Script Actions

Specifies the URL for the JavaScript file containing custom Browser Script Actions.

API Key: URLBrowserScriptActions

Edition: Enterprise only

User Inactivity Timeout (minutes)

Specifies the number of minutes users are inactive before their browser or mobile connection must be re-authenticated.

Valid Values: 5 - 480

Default: 60

API Key: UserInactivityTimeout

Edition: Professional and Enterprise

Usage Tracking Options

You use these options to specify how you want to monitor system usage. For example, you can set the number of rows that you want stored in the usage tracking tables.

Note:

If you change an usage tracking setting, you must apply the change for the new value to take effect.
System Setting More Information
Enable Usage Tracking

Specifies whether usage tracking is enabled. You must enable this setting to activate all other settings in the Usage Tracking section of this page.

  • On — Any enabled settings in the Usage Tracking section of this page are activated.

  • Off — No settings in the Usage Tracking section of this page are activated, even if they are enabled.

Default: On

API Key: EnableUsageTracking

Edition: Enterprise only

Usage Tracking Connection Pool

Specifies the name of the connection pool you created for your usage tracking statistics database. For example, <database name>.<connection pool name>.

API Key: UsageTrackingConnectionPool

Edition: Enterprise only

Usage Tracking Init Block Table

Specifies the name of the fully-qualified database table you use for inserting records that correspond to the initialization block statistics, as it appears in the physical layer of your semantic model. For example, <database name>.<catalog name >.<schema name >.<table name> or <database name>.<schema name >.<table name>.

API Key: UsageTrackingInitBlockTable

Edition: Enterprise only

Usage Tracking Logical Query Logging Table

Specifies the name of the database table you want to use to store logical query details. For example, <database name>.<catalog name >.<schema name >.<table name> or <database name>.<schema name >.<table name>.

API Key: UsageTrackingLogicalQueryLoggingTable

Edition: Enterprise only

Usage Tracking Maximum Rows

Indicates the number of rows allowed in usage tracking tables, with a value of 0 indicating an unlimited number of rows.

Valid Values: Any positive number (up to 64-bit integer)

Default: 0

API Key: UsageTrackingMaximumRows

Edition: Enterprise only

Usage Tracking Physical Query Logging Table

Specifies the name of the database table you want to use to store physical query details. For example, <database name>.<catalog name >.<schema name >.<table name> or <database name>.<schema name >.<table name>.

API Key: UsageTrackingPhysicalQueryLoggingTable

Edition: Enterprise only

User Names as the User Identifier in Service Logs

Specifies whether to identify users by their user name in service logs. When this setting is disabled (off), users are identified by their user GUID in service logs. User names are logged if this setting is enabled (on), and this might make user identification easier for administrators who are monitoring logs.

  • On — Record the names of users performing actions in service logs.

  • Off — Record the GUIDs of users performing actions in service logs.

Default: Off

API Key: UserNamesInServiceLogs

Edition: Professional and Enterprise

View Options

You use these options to configure default search and viewing settings for users working with analyses and dashboards.

These options apply only to analyses and dashboards. They don't apply to data visualizations.

Note:

If you change a view setting, you must apply the change for the new value to take effect.
System Setting More Information
Default Scrolling Enabled

Specifies how data scrolls in tables, pivots, heat matrix, and simple and advanced trellis visualizations.

  • On — Data displays with a fixed header and content scrolling controls for users to browse the data.

  • Off — Data displays with content paging controls for users to browse the data.

Default: On

API Key: AnalysisDefaultScrollingEnabled

Edition: Enterprise only

Enable Enrichments in Workbooks

Specifies whether workbook editors can add dataset enrichments to a visualization directly from the Data Panel. This setting enables enrichments in workbooks for all users. Workbook editors who own a dataset or have editing privileges for it can enable or disable knowledge enrichments for that dataset using the Enable Knowledge Enrichments option. See Enable Knowledge Enrichments in the Workbook Editor.

  • On — Workbook editors can drag and drop enrichment based data elements to visualization canvases.

  • Off — Knowledge enrichments are not available for datasets.

Default: Off

API Key: EnableEnrichmentsInWorkbook

Edition: Professional and Enterprise

Prompt Auto Complete Matching Level

Specifies whether the auto-complete functionality uses matching to find the prompt value that the user enters into the prompt field. This setting doesn’t apply if the user accesses the Search dialog to locate and specify a prompt value.

  • StartsWith — Searches for a match that begins with the text that the user types. For example, the user types M and the following stored values are displayed: MicroPod and MP3 Speakers System.

  • WordStartsWith — Searches for a match at the beginning of a word or group of words. For example, the user types C and the following values are displayed: ComCell, MPEG Camcorder, and 7 Megapixel Digital Camera.

  • MatchAll — Searches for any match within the word or words.

Valid Values: StartsWith, WordStartsWith, MatchAll

Default: MatchAll

API Key: AnalysisPromptAutoCompleteMatchingLevel

Edition: Enterprise only

Table/Pivot View: Maximum Visible Rows

Specifies the maximum number of rows you want displayed for content paging in table and pivot table views in analyses and dashboards.

The minimum number of rows you can specify to display is 100.

Valid Values: 100-5000

Default: 5000

API Key: TablePivotViewMaximumVisibleRows

Edition: Enterprise only

View Interactions: Add/Remove Values

Specifies whether the Add/Remove Values option is selected by default in the Analysis Properties dialog: Interactions tab.

  • On — The Add/Remove Values option is selected by default in the Analysis Properties dialog: Interactions tab.

  • Off — The Add/Remove Values option isn't selected by default in the Analysis Properties dialog: Interactions tab.

Default: Off

API Key: AnalysisViewInteractionsAddRemoveValues

Edition: Enterprise only

View Interactions: Create/Edit/Remove Calculated Items

Specifies whether the Create/Edit/Remove Calculated Items option is selected by default in the Analysis Properties dialog: Interactions tab.

  • On — The Create/Edit/Remove Calculated Items option is selected by default in the Analysis Properties dialog: Interactions tab.

  • Off — The Create/Edit/Remove Calculated Items option isn't selected by default in the Analysis Properties dialog: Interactions tab.

Default: Off

API Key: AnalysisViewInteractionsCreateEditRemoveCalculatedItems

Edition: Enterprise only

View Interactions: Create/Edit/Remove Groups

Specifies whether the Create/Edit/Remove Groups option is selected by default in the Analysis Properties dialog: Interactions tab.

  • On — The Create/Edit/Remove Groups option is selected by default in the Analysis Properties dialog: Interactions tab.

  • Off — The Create/Edit/Remove Groups option isn't selected by default in the Analysis Properties dialog: Interactions tab.

Default: Off

API Key: AnalysisViewInteractionsCreateEditRemoveGroups

Edition: Enterprise only

View Interactions: Display/Hide Running Sum

Specifies whether the Display/Hide Running Sum option is selected by default in the Analysis Properties dialog: Interactions tab.

  • On — The Display/Hide Running Sum option is selected by default in the Analysis Properties dialog: Interactions tab.

  • Off — The Display/Hide Running Sum option isn't selected by default in the Analysis Properties dialog: Interactions tab.

Default: Off

API Key: AnalysisViewInteractionsDisplayHideRunningSum

Edition: Enterprise only

View Interactions: Display/Hide Sub-totals

Specifies whether the Display/Hide Sub-totals option is selected by default in the Analysis Properties dialog: Interactions tab.

  • On — The Display/Hide Sub-totals option is selected by default in the Analysis Properties dialog: Interactions tab.

  • Off — The Display/Hide Sub-totals option isn't selected by default in the Analysis Properties dialog: Interactions tab.

Default: Off

API Key: AnalysisViewInteractionsDisplayHideSubtotals

Edition: Enterprise only

View Interactions: Drill

Specifies whether the Drill (when not a primary interaction) option is selected by default in the Analysis Properties dialog: Interactions tab.

  • On — The Drill (when not a primary interaction) option is selected by default in the Analysis Properties dialog: Interactions tab.

  • Off — The Drill (when not a primary interaction) option isn't selected by default in the Analysis Properties dialog: Interactions tab.

Default: Off

API Key: AnalysisViewInteractionsDrill

Edition: Enterprise only

View Interactions: Include/Exclude Columns

Specifies whether the Include/Exclude Columns option is selected by default in the Analysis Properties dialog: Interactions tab.

  • On — The Include/Exclude Columns option is selected by default in the Analysis Properties dialog: Interactions tab.

  • Off — The Include/Exclude Columns option isn't selected by default in the Analysis Properties dialog: Interactions tab.

Default: On

API Key: AnalysisViewInteractionsIncludeExcludeColumns

Edition: Enterprise only

View Interactions: Move Columns

Specifies whether the Move Columns option is selected by default in the Analysis Properties dialog: Interactions tab.

  • On — The Move Columns option is selected by default in the Analysis Properties dialog: Interactions tab.

  • Off — The Move Columns option isn't selected by default in the Analysis Properties dialog: Interactions tab.

Default: On

API Key: AnalysisViewInteractionsMoveColumns

Edition: Enterprise only

View Interactions: Sort Columns

Specifies whether the Sort Columns option is selected by default in the Analysis Properties dialog: Interactions tab.

  • On — The Sort Columns option is selected by default in the Analysis Properties dialog: Interactions tab.

  • Off — The Sort Columns option isn't selected by default in the Analysis Properties dialog: Interactions tab.

Default: On

API Key: AnalysisViewInteractionsSortColumns

Edition: Enterprise only

Enable Personalization in Workbooks

Specifies whether users can personalize workbooks.

  • On — Content designers can enable or disable personalization options (Filter and Parameter) in their workbooks.

  • Off — Personalization options aren't available for workbooks.

Default: On

API Key: EnableUserPersonalizationInWorkbooks

Edition: Professional and Enterprise

Configure System Settings Using Console

Use Console to configure and customize system settings to suit your Analytics Cloud environment.

  1. In the Oracle Analytics Home page, click the Navigator, and then click Console.
  2. Click System Settings.
  3. Update the property value.
  4. Click Apply to save you changes and then click OK to confirm.
    Wait a few moments for the changes to refresh through the system.

Manage System Settings Using REST APIs

You can use Oracle Analytics Cloud REST APIs to programmatically view and manage system settings. For example, you might create a script to update usage tracking options.

Typical Workflow for Using System Setting REST APIs

Here are the common tasks to start using Oracle Analytics Cloud REST APIs to programmatically view and manage system settings. If you’re using system setting REST APIs for the first time, follow these tasks as a guide.

Task Description REST API Documentation
Understand prerequisites

Understand and complete several prerequisite tasks.

You must have administrator permissions in Oracle Analytics Cloud to manage system settings using REST APIs (BI Service Administrator).

Prerequisites
Understand OAuth 2.0 token authentication Authentication and authorization in Oracle Analytics Cloud is managed by Oracle Identity Cloud Service. To access the Oracle Analytics Cloud REST APIs, you need an OAuth 2.0 access token to use for authorization. OAuth 2.0 Token Authentication
Understand API keys for system settings Each system setting has a public API key name that you can use in REST API operations. REST API Key Values for System Settings
Get system setting details Get details about specific system settings, all system settings, or system settings that haven't been applied yet. Get system settings
Update system settings Update one or more system setting. Update system settings
REST API Key Values for System Settings

Each system setting has its own REST API key name. For example, the REST API key for the system setting Cache Enable is EnableDataQueryCache. You use this REST API key to identify the system setting in a REST API operation.

For example, if you want to disable the Cache Enable setting, you specify the name of the key (EnableDataQueryCache) with the value false. 
{
     "items":[               
       {                   
         "key": "EnableDataQueryCache",                   
         "value": "false"               
       }           
      ]
 }
System Setting Display Name REST API Key Value
Allow HTML/JavaScript/CSS Content AllowHTMLJavaScriptCSSContent
Analytics Publisher Reporting Toolbar Mode AnalyticsPublisherReportingToolbarMode
Answers Editor Start Tab AnswersEditorStartTab
Answers Subject Area Sorting Order AnalysisSubjectAreaSortingOrder
Auto Apply Dashboard Prompt Values AutoApplyDashboardPromptValues
Auto Search on Prompt Value Search Dialog EnableAnalysisAutoSearchPromptDialog
Brushing Enabled for Data Sets EnableBrushingDatasets
Brushing Enabled for Subject Areas EnableBrushingSubjectAreas
Cache Dashboard Listing Dropdown Menu CacheDashboardListingDropdownMenu
Cache Enable EnableDataQueryCache
Case Insensitive Auto Complete AutoCompletePromptDropDownsCaseInsensitive
Connection Externalization Enabled EnableConnectionExternalization
Currencies XML AnalysisCurrenciesXml
Custom Links XML CustomLinksXml
Default Data Offset Time Zone DefaultDataOffsetTimeZone
Default Scrolling Enabled AnalysisDefaultScrollingEnabled
Default Time Zone for Date Calculations DefaultTimeZoneforDateCalculations
Default User Preferred Time Zone DefaultUserPreferredTimeZone
Disable Right Trim for VARCHAR Data DataQueryDisableRightTrimVARCHARData
Enable Auto Insights on Datasets EnableAutoInsightsDatasets
Enable Database Analytics Node in Data Flows EnableDatabaseAnalyticsNodeDataFlows
Enable Enrichments in Workbooks EnableEnrichmentsInWorkbook
Enable Immediate Dashboard Rendering EnableImmediateDashboardRendering
Enable Personalization in Workbooks EnablePersonalizationInWorkbooks
Enable Push Notifications EnableMobilePushNotifications
Enable Subrequest Shipping EnableSubrequestShipping
Enable Usage Tracking EnableUsageTracking
Enforce Safe Domains in Actions EnforceSafeDomainsActions
Evaluate Support Level EvaluateSupportLevel
Export Data to CSV and Tab-Delimited Files as Text ExportDataToCSVFilesAsText
Hide EPM Cloud Members with No Access HideEPMCloudMembersWithNoAccess
Hide loading messages HideLoadingMessages
Load Semantic Models Using Multiple Threads LoadSemanticModelsWithMultipleThreads
Locale DataQueryLocale
Maximum Email Size (KB) EmailMaxEmailSizeKB
Maximum Number of Recipients per Email EmailMaxRecipients
Maximum Working File Percent Size MaximumWorkingFilePercentSize
Mobile Data Watch Service Enabled EnableMobileDataWatchService
Mobile Data Watch Service Frequency MobileDataWatchServiceFrequency
OBIEE Compatibility Release OBIEECompatibilityRelease
Override Database Features OverrideDatabaseFeatures
Portal Path PortalPath
Post Logout Redirect URL PostLogoutRedirectURL
Preview Workbook Email Scheduler PreviewWorkbookEmailScheduler
Preview Workbook Email Scheduling with Bursting PreviewWorkbookEmailBursting
Prompt Auto Complete Matching Level AnalysisPromptAutoCompleteMatchingLevel
Recursive Datetime Type Checking RecursiveDatetimeTypeChecking
Repeat Rows on Excel Exports for Tables and Pivots AnalysisRepeatRowsExcelExportsTablesPivots
Restrict Data Export and Delivery RestrictDataExportAndDelivery
Safe Domains EmailSafeDomains
Save Workbook Thumbnail SaveWorkbookThumbnail
Show Null Value when Column is Nullable AnalysisPromptsShowNullValueWhenColumnIsNullable
Sign Out Inactive Users Automatically SignOutInactiveUsersAutomatically
Sort Null Values First SortNullValuesFirst
Sort Order Locale DataQuerySortOrderLocale
Strong Datetime Type Checking StrongDatetimeTypeChecking
Support Auto Complete EnableAnalysisAutoCompletePrompt
Table/Pivot View: Maximum Visible Rows TablePivotViewMaximumVisibleRows
URL for Blocking Queries in Analyses QueryBlockingScriptURL
URL for Browser Script Actions URLBrowserScriptActions
Usage Tracking Connection Pool UsageTrackingConnectionPool
Usage Tracking Init Block Table UsageTrackingInitBlockTable
Usage Tracking Logical Query Logging Table UsageTrackingLogicalQueryLoggingTable
Usage Tracking Maximum Rows UsageTrackingMaximumRows
Usage Tracking Physical Query Logging Table UsageTrackingPhysicalQueryLoggingTable
Use BCC EmailUseBcc
Use RFC 2231 Encoding EmailUseRFC2231
User Currency Preferences XML UserCurrencyPreferencesXml
User Inactivity Timeout (minutes) UserInactivityTimeout
User Names as the User Identifier in Service Logs UserNamesInServiceLogs
View Interactions: Add/Remove Values AnalysisViewInteractionsAddRemoveValues
View Interactions: Create/Edit/Remove Calculated Items AnalysisViewInteractionsCreateEditRemoveCalculatedItems
View Interactions: Create/Edit/Remove Groups AnalysisViewInteractionsCreateEditRemoveGroups
View Interactions: Display/Hide Running Sum AnalysisViewInteractionsDisplayHideRunningSum
View Interactions: Display/Hide Sub-totals AnalysisViewInteractionsDisplayHideSubtotals
View Interactions: Drill AnalysisViewInteractionsDrill
View Interactions: Include/Exclude Columns AnalysisViewInteractionsIncludeExcludeColumns
View Interactions: Move Columns AnalysisViewInteractionsMoveColumns
View Interactions: Sort Columns AnalysisViewInteractionsSortColumns
WriteBack Template XML WriteBackTemplateXML
Examples for System Setting REST APIs

REST API for Oracle Analytics Cloud includes several examples that explain how to use the System Setting REST APIs.

Get system settings - Examples

  • Example 1 - Get a list of all the system settings and their current values

  • Example 2 - Get current values for a specific set of system settings

  • Example 3 - Get a list of system settings that aren't applied yet

Update system settings - Examples

  • Example 1 - Update system settings using a JSON file

  • Example 2 - Update system settings directly