Application Settings

Settings on the Application Caches page configure the size and contents of the Data Values Cache on the Application Server. This cache contains values assigned to parameters used in Autoprompt Reports, Embedded BI Applications, or any procedure that includes the FIND parameter syntax to limit the range of available search parameter values.

These settings establish the default configuration for Data Values Cache operations in your environment. Administrators and users who have the privilege to work with the Session Viewer can temporarily override these default settings using options in the Caching list.

The Application Caches page also includes the Report Output Cache setting that establishes the use of a separate cache for report output.

Data Values Cache Paths to Exclude (IBI_DATAVALUES_CACHE_EXCLUDEPATHS)

Identifies the IBFS Paths to those folders or Master Files within the paths defined in the Data Values Global Cache Paths or the Data Values User Cache Paths settings whose values should be not be included in these caches.

If no IBFS Paths are defined in this setting, no data values are excluded from the individual resources or folders defined within the paths in the Data Values Global Cache Paths (IBI_DATAVALUES_CACHE_GLOBALPATHS) or the Data Values User Cache Paths (IBI_DATAVALUES_CACHE_INCLUDEPATHS) settings. This is the default value.

If one or more IBFS Paths are defined in this setting, data values from the individual resources or folders defined within these paths are excluded from the Global Data Values Cache and from individual User Session Caches even though the folder or directory in which they are contained is subject to caching.

Paths defined in this setting use the IBFS Path format. At a minimum, they must include the /EDA IBFS subsystem component, followed by the name of the WebFOCUS Server Node. Shorter, higher-level paths define a broad range of folders and the Master Files they contain. Longer paths that extend to a lower level define a narrower range of application folders and Master Files. Paths can extend down to the level of an individual application folder or a single Master File. Typically, this setting requires longer and more specific paths in order to identify the individual folders or Master Files that must be excluded from the paths defined in the other data cache settings.

When this setting includes multiple paths, each one must be separated by a semicolon (;) with no space following, as shown in the following example: /EDA/EDASERVE/retail_samples;/EDA/EDASERVE/ibisamp.

IBFS Paths in this setting use the following structure. Only the first two components of the path are required. You can use the remaining components to narrow the focus of the path.

/EDA/Node/ApplicationFolder/SubFolder1 ... SubFolderN/ResourceFolder/Resource 

where:

EDA

Is the EDA IBFS subsystem. This component is required for all paths. The initial slash (/) before this component is required.

Node

Is the name of the WebFOCUS Server node. This component is required for all paths.

ApplicationFolder

Is the name of the application folder that contains the resources whose data will be excluded from the data values cache.

SubFolder1 ... SubFolderN

Are the names of any folders underneath the application folder that connect to the end point of the path. Include as many folders as are necessary.

Resource

Is the end point of the path. If this is the name of a folder that contains one or more Master File resources, then data from all Master Files in the folder is excluded from the cache. If this is the name of a Master File without the .mas extension, then only data from this specific Master File is excluded from the cache.

Data Values Global Cache Paths (IBI_DATAVALUES_CACHE_GLOBALPATHS)

Identifies the IBFS Paths to those resources whose data source values can be made available to all users without restriction in the Global Data Values Cache.

The paths defined in this setting should only identify resources that contain data that is not subject to DBA or row-level security restrictions. For calls to cache resources that contain data that is subject to these restrictions, the paths defined in the Data Values User Cache Paths (IBI_DATAVALUES_CACHE_INCLUDEPATHS) setting are used.

If no IBFS Paths are defined in this setting, then no data source values are included in the Data Values Global Cache. This is the default value.

If one or more IBFS Paths are defined in this setting, then data values retrieved from the resources identified in those paths are included in the Data Values Global Cache.

Paths defined in this setting use the IBFS Path format. At a minimum, they must include the /EDA IBFS subsystem component, followed by the name of the WebFOCUS Server Node. Shorter, higher-level paths define a broad range of folders and the Master Files they contain. Longer paths that extend to a lower level define a narrower range of application folders and Master Files. Paths can extend down to the level of an individual application folder or a single Master File.

To include multiple folders or Master Files in this setting, you can use a short, higher-level path that includes a range of folders, or a series of longer and more detailed paths that identify a very specific group of folders and Master Files. If this setting must include multiple paths, each one must be separated by a semicolon (;) with no space following, as shown in the following example: /EDA/EDASERVE/retail_samples;/EDA/EDASERVE/ibisamp.

IBFS Paths in this setting use the following structure. Only the first two components of the path are required. You can use as many of the remaining path components as you wish to narrow the focus of the path.

/EDA/Node/ApplicationFolder/SubFolder1 ... SubFolderN/Resource 

where:

EDA

Is the EDA IBFS subsystem. This component is required for all paths. The initial slash (/) before this component is required.

Node

Is the name of the WebFOCUS Server node. This component is required for all paths.

ApplicationFolder

Is the name of the application folder that contains the resources from which data will be added to the data values cache.

SubFolder1 ... SubFolderN

Are the names of any folders in the path underneath the application folder that connect to the end point of the path. Include as many folders as are necessary.

Resource

Is the end point of the path. If this is the name of a folder that contains one or more Master File resources, then data from all Master Files in the folder is included in the cache. If this is the name of a Master File without the .mas extension, then only data from this specific Master File is included in the cache.

Data Values User Cache Paths (IBI_DATAVALUES_CACHE_INCLUDEPATHS)

Identifies the IBFS Paths to those resources whose data source values should only be made available to the individual user who retrieved the data.

The paths defined in this setting should only identify resources that contain data that is subject to DBA or row level security restrictions. For calls to cache resources that are not subject to these restrictions, the paths defined in the Data Values Global Cache Paths (IBI_DATAVALUES_CACHE_GLOBALPATHS) setting are used.

If no IBFS Paths are defined in this setting, then no data source values are cached. This is the default value.

If one or more IBFS Paths are defined in this setting, then data values retrieved from all of the resources identified in those paths can be included in the Data Values User Cache for an individual user. If this setting must include multiple paths, they must be separated by a semicolon (;) with no space following, as shown in the following example: /EDA/EDASERVE/retail_samples;/EDA/EDASERVE/ibisamp.

Paths defined in this setting use the IBFS Path format. At a minimum, they must include the /EDA IBFS subsystem component, followed by the name of the WebFOCUS Server Node. Shorter, higher-level paths define a broad range of folders and the Master Files they contain. Longer paths that extend to a lower level define a narrower range of application folders and Master Files. Paths can extend down to the level of an individual application folder or a single Master File.

To include multiple folders or Master Files in this setting, you can use a short, higher-level path that includes a range of folders, or a series of longer and more detailed paths that identify a very specific group of folders and Master Files. If this setting must include multiple paths, each one must be separated by a semicolon (;) with no space following, as shown in the following example: /EDA/EDASERVE/retail_samples;/EDA/EDASERVE/ibisamp.

IBFS Paths in this setting use the following structure. Only the first two components of the path are required. You can use as many of the remaining path components as you wish to narrow the focus of the path.

/EDA/Node/ApplicationFolder/SubFolder1 ... SubFolderN/Resource 

where:

EDA

Is the EDA IBFS subsystem. This component is required for all paths. The initial slash (/) before this component is required.

Node

Is the name of the WebFOCUS Server node. This component is required for all paths.

ApplicationFolder

Is the name of the application folder that contains the resources from which data will be added to the data values cache.

SubFolder1 ... SubFolderN

Are the names of any folders in the path underneath the application folder that connect to the end point of the path. Include as many folders as are necessary.

Resource

Is the end point of the path. If this is the name of a folder that contains one or more Master File resources, then data from all Master Files in the folder is included in the cache. If this is the name of a Master File without the .mas extension, then only data from this specific Master File is included in the cache.

Note: Paths to any folders or Master Files identified in the Data Values User Cache Paths setting take precedence over those identified in the Data Values Global Cache Paths setting. This means that if the same path appears in the Global Cache Path setting and the User Session Class Path setting, then data retrieved from the Master Files in that path moves into the User Session Cache, instead of the Global Cache.

Data Values Max Cache Memory (MB) (IBI_DATAVALUES_CACHE_MAXMEG)

Defines the maximum amount of memory allocated to the Data Values Cache. This cache holds the data source values retrieved from queries to the WebFOCUS Server issued by procedures that identify their Master File sources with a two-part name in the FIND parameter syntax. These values are typically assigned to parameters used in Autoprompt Reports, Embedded BI Applications, or to any procedure that includes the FIND parameter syntax to limit the range of available search parameter values. This cache also contains the IBFS path to the Master File and the ID of the user that ran the procedure. The Data Values Cache uses memory on the machine that hosts the WebFOCUS Application Server.

This setting is assigned a value of zero (0), by default, meaning that no memory is allocated to the data values cache, and no data values are cached.

To activate the use of the data values cache, an administrator must assign a number from one (1) to five hundred (500) to this setting. A value of ten (10) megabytes can accommodate the caching requirements for most organizations.

Report Output Cache (IBI_REPORT_CACHE_ENABLE)

Indicates whether or not report output is cached. The following values are available:

• Off. Report output is not cached. This is the default value.
• On. Report output can be cached, and the Properties dialog box on the Legacy home page displays the Report Output Cache Rule Name field.
• Hidden. Report output can be cached, but the Properties dialog box on the Legacy home page does not display the Report Output Cache Rule Name field.

Report output is information retrieved from the WebFOCUS Server in response to report or chart procedure queries and includes data values, column titles, and formatting features.

Note: The Report Output Cache Rule Name field displays a text string that identifies the rule that governs the way in which report output data is cached. These rules determine if a cache is available to everyone, available only to the user that requested the data, or if it can be shared by the members of the group to which that user is assigned.

Application Contexts settings define the context root locations of various WebFOCUS components.

Note: Values assigned to the Application Context settings are adjusted automatically when your installation is configured to use a reverse proxy server. In order for this change to take effect, the URL for WebFOCUS must be assigned to the WFproxyURL setting in the configuration of your proxy server.

Help (IBI_HELP_CONTEXT)

Specifies the context root for the local online Help web application.

The default value is /ibi_help. It is established during the product installation, and identifies the context root to which the local online Help web application is assigned, by default.

To assign the local online Help web application to the WebFOCUS context root, replace the default value with a new value that begins with the WebFOCUS Context, and is followed by the Help Context. For example, /ibi_apps/ibi_help.

To assign the online Help web application to any other context root, replace the default value with a new value that identifies the context root in use in your organization.

The context root defined in this setting only applies to the local host. If the Help Proxy Host and Port (IBI_HELP_PROXY_HOST) setting identifies an external sever name and port, you must also identify the context root for that external server in the Help Proxy Context (IBI_HELP_PROXY_CONTEXT) setting.

Help Proxy Context (IBI_HELP_PROXY_CONTEXT)

Specifies the context root of the remote online Help web application in the target environment identified in the Help Proxy Host and Port (IBI_HELP_PROXY_HOST) setting.

This setting must remain blank if no remote online Help web application is identified in the Help Proxy Host and Port (IBI_HELP_PROXY_HOST) setting. When this setting is blank, no context root is identified for the remote online Help web application. This is the default value.

This setting must identify a context root if a remote online Help web application is identified in the Help Proxy Host and Port (IBI_HELP_PROXY_HOST) setting.

Help Proxy Host and Port (IBI_HELP_PROXY_HOST)

Specifies the name and port number of the external server where a remote online Help web application is installed.

If this setting is blank, no remote online Help web application is available. This is the default value.

If this setting contains a server name and port number, a remote online Help web application is available on the server name and port specified. The remote application does not need to be on the same server as the WebFOCUS web application.

When you specify a value in this setting, you must also specify a value in the Help Proxy Context (IBI_HELP_PROXY_CONTEXT) setting. It cannot remain blank.

When you identify a remote online Help web application by assigning values to these two settings, the Help Servlet acts as a proxy, and directs Help system calls to the host identified in this setting. The term Help Proxy indicates that the values in the settings that include it apply to a remote online Help web application.

Help Proxy Secure (IBI_HELP_PROXY_SECURE)

If selected, this check box activates the use of Secure Sockets Layer (SSL) security on all calls directed from the WebFOCUS Client to the remote online Help web application located on the remote host identified in the Help Proxy Host and Port (IBI_HELP_PROXY_HOST) setting.

If cleared, calls to the remote online Help web application, do not use SSL security or encryption. This is the default value.

Note: This setting does not affect calls from WebFOCUS or any other application to Help systems located on a local server. All customer-facing applications are SSL-enabled, by default, in compliance with security policy. However, if the WebFOCUS Client is configured to access a Help system on a local intranet server, this setting should be selected if the Help system on that intranet server is also configured to use SSL.

ReportCaster Application (IBI_REPORTCASTER_CONTEXT)

Specifies the context root for ReportCaster content, previously /rcaster, by default. The current default value is /ibi_apps.

TIBCO WebFOCUS Application (IBI_WEBAPP_CONTEXT_DEFAULT)

Specifies the context root for WebFOCUS web applications. The default value is /ibi_apps.

Default host and port for product features (IBI_WEBAPP_DEFAULT_URL)

Identifies the default URL for an installation of WebFOCUS.

This value uses the format:

http(s)://host:port

where:

host

Is the name or IP address of the host used to access WebFOCUS.

port

Is the number of the port on which the Web Server or Application Server listens.

This value is optional, and it should be excluded if the URL uses the default port for the protocol it uses in the scheme, which is port 80 for URLs using the http protocol or port 443 for URLs using the https protocol.

The host name and the port number are assigned to this value automatically during the product installation, and they identify the host name or IP address and port number used by your organization. Product components use the URL defined in this setting to access WebFOCUS.

TIBCO WebFOCUS Servlet (IBI_WEBFOCUS_CONTEXT)

Specifies the context root for the WebFOCUS servlet, previously /ibi_apps, by default. The current default value is /ibi_apps/WFServlet.ibfs.

Application Directories settings define the directories in which various files are located.

APPROOT (IBI_APPROOT_DIRECTORY)

Specifies the location of the Application Namespace root directory used by the WebFOCUS installation. The default location is drive D:/455/ibi/apps, unless a different directory was specified during installation.

Change Management Export (IBI_EXPORT_DIRECTORY)

Specifies the location of the directory where the Change Management Export Package will be placed. The default location is drive:/ibi/WebFOCUS82/cm/export, unless a different directory was specified during installation.

Change Management Import (IBI_IMPORT_DIRECTORY)

Specifies the location of the directory from which the Change Management Import Package will imported. The default location is drive:/ibi/WebFOCUS82/cm/import, unless a different directory was specified during installation.

Days Until Logs Are Deleted (IBI_LOG_RETAIN_DAYS)

Specifies the number of days the files in the logs directory will be retained. The default value is 10 days.

Directory of Source Code Staging Area (IBI_SCM_STAGING_DIRECTORY)

Specifies the location of the directory where files will be transferred during source control operations, such as adding files to source control, checking files in, or checking files out of the source control repository. The default location is drive:/ibi/WebFOCUS82/scm.

This location can be customized. The directory path needs to be on the same machine where WebFOCUS is installed and a UNC path is currently not supported.

Temporary Files (IBI_TEMPORARY_DIRECTORY)

Specifies the location of temporary files when running a request. For example, redirected requests are written to this location. The default location is drive:/ibi/WebFOCUS82/temp, unless a different directory was specified during installation.

Traces (IBI_TRACE_DIRECTORY)

Specifies the location of the directory used for WebFOCUS Client traces displayed in the Session Monitor and the Session Viewer. The default location is drive:/ibi/WebFOCUS82/traces, unless a different directory was specified during installation.

WebFOCUS directs all diagnostic output to the logs directory. The default location is drive:/ibi/WebFOCUS82/logs, specified with the log4j2.xml file during installation.

Days Until Traces Are Deleted (IBI_TRACE_RETAIN_DAYS)

Specifies the number of days the files in the traces directory will be retained. The default value is 10 days.

BI Portal settings configure the display and behavior of the BI Portal.

Redirect /ibi_apps to

Identifies the default home page.

In this setting, /ibi_apps is the main alias or context under which all WebFOCUS webpages are located. This is the typical context in most installations, but your local installation may use a different context. If that is the case, the name you use in your installation will appear in the label for this setting instead.

Note: Don't use the term /bi as the main alias or context. This is a reserved term, and its use as an alias or context prevents the proper display of the Administration Console and Security Center.

The options in this setting direct users to one of the following locations, by default.

• New Start Page. When this option is selected, the Hub, that connects you directly to WebFOCUS Client and WebFOCUS Server views from a Navigation Bar and related menus, is the default entry page. This is the default value for this setting, as of release 8207.28.
• WebFOCUS Home Page. When this option is selected, the WebFOCUS Home Page, first developed for Release 8.2 Version 02 is the default home page.
  • Show Legacy Home Page option in Banner Links. Controls the display of the Legacy Home Page command in the User menu, which opens when you click your user name on the WebFOCUS Home Page. The Legacy home page was first developed in Release 8.2 Version 01. Administrators may continue to need access to this page in order to work with Resource Templates.
    • When this check box is selected, the Legacy Home Page command appears in the User menu. This is the default setting.
    • When this check box is cleared, the Legacy Home Page command does not appear in the User menu. Even if this check box is cleared, users can open the Legacy home page by typing /ibi_apps/legacyhome in their browser address bar.
• Legacy Home Page. When this option is selected, the Legacy home page that was developed in Release 8.2 Version 01 is the default home page. It provides access to Global Resources, Resource Templates, and Change Management features that do not appear on the WebFOCUS Home Page.
• Custom Welcome Page. When this option is selected, the page that is identified in the /ibi_apps/ field underneath this option is the default home page. Typically, a portal serves as a custom welcome page, but this setting can also contain a URL, a report, or a focexec-generated HTML page.

  When you select this option, the browser address bar displays only the basic context when the custom welcome page opens. It does not display the full URL of the custom welcome page.

  • /ibi_apps/. Identifies the URL of the content that serves as the custom welcome page within the main alias or context.

    This field contains only that portion of the URL for the custom welcome page that comes after the main alias or context. The main context is automatically added to the value in this field to create a full URL when redirecting users to the custom welcome page identified in this field.

    For example, if you use a basic portal for the custom welcome page, and the full URL is:

    Server01.ibi.com:8080/ibi_apps/bip/portal/Sales_Performance.

    The value in the /ibi_apps/ field would be:

    bip/portal/Sales_Performance.

    Note: You can use basic portals only if your product version supports them, and the Basic Portal option is enabled.

    If you use a collaborative portal for the custom welcome page and the full URL is:

    Server01.ibi.com:8080/ibi_apps/portal/sales_october/sales_october.

    The value in the /ibi_apps/ field would be:

    portal/sales_october/sales_october.

    Note: You can use collaborative portals only if your product version supports them, and the Collaborative Portal option is enabled.

    If you chose to use the Portals Home Page as the custom welcome page, the value in the /ibi_apps/ field must be:

    portals.

    Note: The Portals Home Page will be populated with basic or collaborative portals only if your product version supports these portal types, and the Basic Portal option and the Collaborative Portal option are enabled.

Regardless of the values you assign to this setting, users can open any home page by typing one of the following values in the browser address bar:

• To open the default home page that is defined by this setting, type /ibi_apps.
• To open the New Start Page, type /ibia_apps/start.
• To open the WebFOCUS Home Page, type /ibi_apps/home.
• To open the Legacy home page, type /ibi_apps/legacyhome.
• To open the Portals Home Page, type /ibi_apps/portals.
• To open a Custom Welcome Page, type /ibi_apps/, followed by the remaining path to the custom welcome page.

In the webfocus.cfg file, the Redirect /ibi_apps to setting maps to the IBI_HOME_PAGE_CONFIGURATION setting.

• When the WebFOCUS Home Page option is selected, IBI_HOME_PAGE_CONFIGURATION=HOME.
• When the Legacy Home Page option is selected, IBI_HOME_PAGE_CONFIGURATION=LEGACY.
• When the Custom Welcome Page option is selected, IBI_HOME_PAGE_CONFIGURATION=CUSTOM.
• When the New Start Page option is selected, IBI_HOME_PAGE_CONFIGURATION=DEFAULT, but because this is the default value, the webfocus.cfg file does not display the IBI_HOME_PAGE_CONFIGURATION setting.

In the webfocus.cfg file, the Show Legacy Home Page option in Banner Links check box maps to the IBI_HOME_PAGE_LEGACY_LINKS setting.

• When the Show Legacy Home Page check box is selected, IBI_HOME_PAGE_LEGACY_LINKS=TRUE.
• When this check box is cleared, IBI_HOME_PAGE_LEGACY_LINKS=FALSE.

In the webfocus.cfg file, the /ibi_apps/ field maps to the IBI_DEFAULT_WELCOME_PAGE setting.

Ajax Timeout (IBI_AJAX_TIMEOUT)

This information is not yet available.

Enable Automatic Sign-out (IBI_AUTO_SIGNOFF)

Activates the display of a warning message advising users that their session will expire due to inactivity, and that any unsaved work will be lost. When this check box is selected, a warning message appears on the Home Page, the Security Center, and on portals. When it is cleared, no warning message appears. This check box is selected, by default.

Idle Timeout Message Duration (minutes) (IBI_AUTO_SIGNOFF_MESSAGE_DURATION)

Defines the number of minutes that a timeout warning message is displayed. This value is relevant only if the Enable Auto Sign-out (IBI_AUTO_SIGNOFF) check box is selected. A value of two minutes is assigned to this setting, by default.

When displayed from the Home Page or the Security Center, the warning message also identifies the time remaining until the session will end. When displayed from a portal, the warning message does not identify the remaining time.

Open First Workspace (IBI_BIP_OPEN_FIRST_DOMAIN)

Determines whether the first workspace listed in the Resources tree opens automatically when you open the BI Portal. If this check box is selected (True), the first workspace opens automatically when you open the BI Portal. If this check box is cleared (False), the first workspace remains closed when you open the BI Portal. This check box is cleared, by default.

Concurrent Public Session Limit (IBI_CONCURRENT_PUBLIC_SESSION_LIMIT)

Identifies the maximum number of public users that can open a session at any one time. Public users start a session without presenting credentials and are granted access privileges defined in the Anonymous group.

When the value in this setting is zero (0), there is no limit on the number of public users. This setting is assigned a value of zero (0), by default.

When a value is defined in this setting, any public user that attempts to open a session after this limit is reached receives a warning message and is unable to complete the request.

Note: This setting is only relevant to the Enterprise Edition, which is the only edition that supports anonymous user access.

Concurrent Visualization Limit (IBI_CONCURRENT_VISUALIZATION_LIMIT)

Identifies the maximum number of WebFOCUS Designer or InfoAssist visualizations generated from procedures or from Auto Drill, Drill Anywhere, InfoMini, or Insight requests that a single user can keep open simultaneously. When the number of open visualizations equals this limit, the next request to open a new visualization is not completed, and an error message is logged.

This value of this setting is zero (0), by default, indicating that there is no limit on the number of simultaneous visualizations a user can open. To impose this limit, an administrator must enter a value that defines the maximum number of open visualizations.

Customized Sign-in Page (IBI_CUSTOMIZED_SIGNIN_PAGE)

Enables the display of a custom sign-in page for users. The default value is False.

Default Workspace Repository Path (IBI_DEFAULT_WORKSPACE_PATH)

Defines the IBFS path to the workspace that serves as the default location for connections to data, visualizations, or other resources created by individual users from the Home Page, the My Workspace view, the Getting Started carousel, or any other location outside of a defined workspace.

When a user working outside of a defined workspace selects the Get Data button, the Visualize Data button, or one of the Plus [+] button menu options, the workspace identified in this setting serves as the start location for the selected operation within the Repository, and it is presented, by default, in the Save dialog box as the location to use when first saving new content.

By default, the value in this setting is blank, and My Workspace, located at IBFS:/WFC/Repository/MyWorkspace/, serves as the default workspace repository path. This path is automatically assigned to the URL that launches the operation, and it causes the Workspaces > My Workspace > My Content path to appear in the Save dialog box as the path to the folder where new content created outside of a defined workspace can be saved.

You can replace this default location with a valid IBFS path to a different workspace or to a top-level folder in the Repository. This path is automatically assigned to the URL that launches the operation, and unless the content draws on a data connection assigned to a defined workspace, it causes the Workspaces > My Workspace > My Content path to appear in the Save dialog box as the path to the folder where new content created outside of a defined workspace can be saved.

If you enter an invalid IBFS path or a path to a workspace that does not exist, you receive an error message. The path can only point to a workspace or top-level folder, it cannot point to a lower level location.

For more information about how to configure this setting, see How to Configure a Default Workspace Repository Path.

Notes:

• When Users working in a defined folder or workspace select the Get Data button, the Visualize Data button, or one of the Plus [+] button menu options, the path to the workspace or folder in which they are located becomes the default workspace repository path.
• Regardless of the location in which you are working when you select the Get Data button, the Visualize Data button, or one of the Plus [+] button menu options, if you select a Data Source from a defined workspace, the path to the workspace that contains your selected Data Source automatically becomes the Default Workspace Repository Path, and you are prompted to save the new resource in the workspace containing that Data Source, by default.

Default List Repository Path (IBI_DYNAMIC_LIST_PATH)

Defines the IBFS path to the workspace whose title and contents are displayed in the carousel that appears at the top of the Home view of the WebFOCUS Home Page.

A workspace whose name matches that of the final folder in the path must be present in the IBFS file system. If there is no corresponding workspace, or if the name of the workspace does not match the name of the final folder in this path, there is no connection and the carousel does not appear.

The IBFS:/WFC/Repository/Getting_Started path is the default value for this setting. This path points to the Getting Started workspace and assigns the Getting Started title to the carousel. This default value ensures that new users see orientation resources as soon as they open the application.

The integrated installation loads the Getting Started workspace automatically. It is also present, by default, in Cloud instances. Other installations and instances of WebFOCUS do not load this workspace, even though they do assign the default path to this setting. Because there is no Getting_Started workspace in these installations, the Getting Started carousel does not appear, even though the path to it is defined in this setting.

If a single blank space appears in the field for this setting, no path is defined, and the Getting Started carousel does not appear in the Home View even if a Getting_Started workspace is available.

Therefore, by clearing the default value, typing a single blank space in this field, and saving your changes, you can hide the Getting Started carousel. When you sign out and sign in again after making this change, the Recents carousel appears in place of the Getting Started carousel. The blank space prevents the Administration Console from overriding the otherwise empty field with the default path when you save your changes and close the Administration Console if you opened it from the WebFOCUS Home Page.

If a path to an alternative workspace appears in the field for this setting, the carousel displays the title of that alternative workspace and the resources contained in the top-level folder of that workspace.

You can substitute an alternative workspace for the Getting Started workspace by typing the IBFS path to the alternative workspace in this field and saving your changes. When you sign out and sign in again, a carousel with the Title and resources of the alternative workspace appears in place of the Getting Started carousel.

The IBFS path must begin with the term, IBFS:/WFC/Repository. You can then type a slash (/) followed by the name of the new workspace that contains the resources you wish to display in the Getting Started carousel. You must separate workspaces and folders in the path with a slash (/) and not a backslash (\). The Title linked to the Name of the alternative workspace appears as the new title of the carousel. The name of the final folder in the IBFS path must match the case and spelling of the Name assigned to the workspace, not the Title. The name of the final folder must also include any underscores or other special characters automatically added to the Name of the workspace in order to ensure that it conforms to IBFS format rules.

You can restore the default value to this setting at any time by removing all characters and blank spaces from this field and saving the page. When you sign out and sign in again, the default path to the Getting Started workspace is reassigned to this setting automatically.

Enable Inlined Resource Bundles (IBI_ENABLE_INLINED_RESOURCE_BUNDLES)

This feature is optional. When selected (True), data from the JavaScript and cascading style sheet resource files, required by the WebFOCUS Home Page and WebFOCUS Designer tools, is combined into XML inline resource bundle files in order to improve system performance on slow networks. When cleared (False), this feature is not activated. This check box is cleared, by default.

Message Detail (IBI_MESSAGE_DETAIL)

Determines when users receive simplified error messages. In simplified error messages, error details can be suppressed to avoid disclosing sensitive or technical information to end users. When a simplified error message is delivered to a user, the fully detailed error message appears in the event.log to support administrator troubleshooting. Error messages in the event.log are preceded by an identifier in the form IBFS-YYMMDD_hhmmss-n, where n is the sequence number for multiple messages generated during the same second.

The simplified error message displayed to the user contains the event.log entry identifier.

Each option in the Message Detail list specifies the highest error level for which end users will receive detailed messages. The options are:

• Severe. Users receive detailed messages for errors at the Severe level and below. The Severe level is the highest error level. Under this setting, users never receive simplified messages. This is the default value.
• Error. Users receive simplified messages for Severe-level errors, and detailed messages for errors at the Error level and below.
• Expected. Users receive detailed messages for Severe-level and Error-level errors, and detailed messages for errors at the Expected level and below.
• None. Users always receive simplified error messages.

Administrators can customize the styling of a simplified error message by creating and editing the custom template on which it is based. To create a custom error message template, copy the webfocus_ibfs_error.xml file from the prod directory to the custom directory. Both the prod and the custom directories are found in the drive:\ibi\WebFOCUS82\client\wfc\etc\ directory. Make all edits to the copy of the webfocus_ibfs_error.xml file found in the custom directory.

Note: Users with the Display Administration Console (opWFAdminConsole) or Desktop Connect (opDTConnect) privilege always receive the detailed error messages.

Mobile Favorites Proxy URL (IBI_MOBILE_FAVORITES_PROXY_URL)

Specifies the URL used to access Mobile Favorites. If left blank, the default Mobile Favorites is used.

Move Confirmation Message (IBI_MOVE_CONFIRMATION_MESSAGE)

Specifies whether confirmation will be requested when a user moves a folder by drag and drop. This check box is selected (True), by default.

Public Session Timeout (minutes) (IBI_PUBLIC_SESSION_TIMEOUT)

Controls the public session timeout value, which limits the amount of time that public users can remain idle before a session timeout takes place.

This setting is defined in minutes, and is assigned a value of 120 minutes, by default.

This setting applies to public users only. The timeout limit for all other users is defined in the Session Timeout (minutes) setting. Public users start a session without presenting credentials and are granted access privileges defined in the Anonymous group.

Note: This setting is only relevant to the Enterprise Edition, which is the only edition that supports anonymous user access.

Session Privilege Search Depth (IBI_SESSION_PRIVILEGE_SEARCH_DEPTH)

Defines how deeply searches for session privileges reach into the IBFS:/WFC/Repository subsystem during user the sign-in process. If you wish to check for session privileges only on the workspace folder, for example, IBFS:/WFC/Repository/Sales, use the default search depth, 1. To search for session privileges on subfolders directly beneath the workspace folder, use a search depth of 2.

Note: Search depth may be set to any level, but increasing the depth may cause performance issues. It is strongly advised that you make the search depth value as low as possible.

For more information about session privileges, see Session Privileges.

Session Timeout (minutes) (IBI_SESSION_TIMEOUT)

Controls the session timeout value, which limits the amount of time that users who signed in with valid credentials can remain idle before a session timeout takes place.

This setting is defined in minutes, and is assigned a value of 120 minutes, by default.

This setting applies to all users except public users. The timeout limit for all public users is defined in the Public Session Timeout (minutes) setting.

Sign-in Message (IBI_SIGNIN_MESSAGE)

Specifies a custom message that displays in the Messages dialog box when a user signs in. You can enter plain text or HTML tags for text, links, and images, into this field. If you leave this field blank, which is the default value, the Messages dialog box does not display.

The following HTML tags may be used in the sign-in message:

<l>, <br>, <b>, <u>, <a href>, </a>, <img>.

Sign-in Page Links (IBI_SIGNIN_PAGE_LINKS)

This information is not yet available.

Allowed File Extensions to Upload (IBI_UPLOAD_EXTENSIONS)

Specifies the type of files that you can upload to the BI Portal. Files that do not use one of the extensions listed in this setting cannot be uploaded to the BI Portal. The list includes the following file extensions, by default:

.acx, .bmp, .css, .doc, .docx, .fex, .gif, .htm, .html, .ico, .jpe, .jpeg, .jpg, .js, .mas, .pdf,

.png, .ppt, .pptx, .sty, .svg, .txt, .xls, .xlsx, .xml, .zip, .ely

Basic Default Portal Page Layout (IBI_V3_DEFAULT_LAYOUT)

Establishes the default layout for new pages in the BI Portal.

This setting is relevant only if your product version supports collaborative portals, and the Collaborative Portal option is enabled.

The default layout defined in this setting determines the way in which items, such as reports or charts, are organized on the page. Fluid Canvas, the default value, automatically arranges content evenly and redistributes space as you add more items. The other option, Single Area, does not establish a grid, and allows you to place items where necessary.

This setting is relevant only to basic portals. It is not relevant to collaborative portals.

Basic Portal (IBI_V3_PORTAL)

Determines whether basic portals are supported.

Basic portals deliver the full range of reporting, charting, and other features, and are managed from the Portals node.

When this check box is cleared (False), the Portals node does not appear under the Resources tree, and users are unable to create or edit basic portals. However, because data from previously-created basic portals remains in the Repository, users can run a previously-created portal by typing the URL for it directly into the browser address bar. Users can also continue to import change management packages that contain basic portals. This is the default setting.

When this check box is selected (True), the Portals node appears under the Resources tree, and users can create, edit, and run basic portals.

Collaborative Portal (IBI_V4_PORTAL)

Determines whether collaborative portals, which are also identified as V4 portals, are supported.

Collaborative portals deliver the full range of features offered by a basic portal, such as reporting and charting. They also include responsive-design page templates, the ability to create and maintain independent pages, and the ability to create and maintain blogs, which are interactive messaging components that can be assigned to portals and pages.

The check box in this setting is cleared (False), by default.

When this check box is cleared (False), the Collaborative Portal, Portal Page, and Blog action buttons in the Other tab Action Bar of the Workspaces area on the WebFOCUS Home Page, and the Collaborative Portal, Portal Page, and Blog commands in the workspace shortcut menu on the Legacy home page are not visible to any user.

Collaborative portals created while this check box was selected remain visible and available to administrators, workspace developers, and to any other user whose role in the workspace that contains them includes the Delete Resource (opDelete) privilege. The ability to view, run, edit, and delete previously-created collaborative portals supports administrators and developers in their efforts to create Designer portals, which are also identified as V5 portals, based on previously-created collaborative portals after this setting has been cleared.

When this check box is cleared, users have the following privileges as determined by the group to which they are assigned:

• Basic Users and Advanced Users cannot view or run collaborative portals.
• Developers cannot create collaborative portals. However, because the WorkspaceDeveloper role includes the Delete Resources (opDelete) privilege, they can view, run, edit, and delete previously-created collaborative portals within the workspaces to which they are assigned by clicking shortcut menu commands, or by typing the URL for these features directly into the browser address bar.
• Administrators cannot create collaborative portals. However because the SystemFullControl role includes the Delete Resources (opDelete) privilege, they can view, run, edit, and delete previously-created collaborative portals, portal pages, and blogs in any workspace by clicking shortcut menu commands, or by typing the URL for these features directly into the browser address bar. They can also export and import change management packages that contain previously-created collaborative portals, portal pages, and blogs, and can view, run, edit, or delete them after the import.
• Note: Previously-created portal pages and blogs also remain visible, but users with the Delete Resources (opDelete) privilege can no longer run or edit them.

When this check box is selected (True), the Collaborative Portal, Portal Page, and Blog action buttons in the Other tab Action Bar of the Workspaces area on the WebFOCUS Home Page, and the Collaborative Portal, Portal Page, and Blog commands in the workspace shortcut menu on the Legacy home page, are visible to administrators when working in any workspace, and to developers when working in the workspaces to which they are assigned.

When this check box is selected, users have the following privileges, as determined by the group to which they are assigned:

• Basic Users and Advanced Users can view and run collaborative portals made available to them.
• Developers can view and run collaborative portals, and they can create, edit, and delete existing collaborative portals in the workspaces to which they are assigned.
• Administrators can view, run, create, edit, and delete collaborative portals in any workspace. They can also export and import collaborative portals contained in Change Management packages, and they can view, run, edit, or delete them after the import.

Change Management settings determine which file types can be exported during the change management process, the format of the exported file, and whether some legacy functionality is preserved.

Note: The locations of change management export and import packages are determined by the Application Directories Settings. For more information, see Application Directories Settings.

File Types Included in Export Package (IBI_CM_EXPORT_WFRS_FILE_EXTENSIONS)

Determines, by file extension, which files from the WebFOCUS Server or the web will be included in exports created by the change management feature. The values included, by default, are acx, bmp, css, fex, gif, htm, html, ico, jpe, jpeg, jpg, js, mas, mnt, png, sty, and svg.

Preserve Created, Modified and Last Access Information (IBI_CM_PRESERVE_SOURCE_INFO)

When this check box is selected (True), the default value for this setting, the following information is preserved for all items imported to an installation of WebFOCUS through the Change Management utility:

• Created. The date and time that the item was originally created, and the ID of the user who created it.
• Modified. The date and time that the item was most recently modified before it was added to the change management export file, and the ID of the user who made the modification.
• Access. The date and time that the content item was most recently used before it was added to the change management export file, and the ID of the user who used it.

These values appear on the General tab of the Properties dialog box.

When this check box is cleared (False), the date and time of the change management import and the ID of the user who ran it override these original values and are assigned to all three properties of items imported through the Change Management facility.

Retain Handles (IBI_CM_RETAIN_HANDLES)

When selected (True), the export package contains the original hrefs. The original hrefs are needed when using change management to move content that has been migrated from WebFOCUS 7, or ReportCaster schedules, from one WebFOCUS 8 environment to another WebFOCUS 8 environment. This setting ensures that the -INCLUDEs and drill downs in code migrated from WebFOCUS 7 continue to work, and ReportCaster schedules, which reference FOCEXECs by handle, continue to work. This check box is cleared (False), by default.

Zip Change Management Package (IBI_CM_ZIP)

When this check box is selected (True), the export package is compressed and delivered in a zip file.

Name format of Zip export files (IBI_CM_ZIP_FILE_FORMAT)

Select an option from the drop-down menu to specify the name format of the zip file.

Client settings configure miscellaneous WebFOCUS Client options.

Active Technologies external JavaScript (IBIF_ACTIVE_EXTJS)

Enables the use of external JavaScript files, instead of embedding the JavaScript within the HTML output file, in order to improve performance at runtime. If set to NO, enables the use of an active report or document (format AHTML) in a fully disconnected mode that supports the browser Save As option. The default value is NO.

Note: For more information on the use of external JavaScript files in the HTML output, see the Active Technologies User's Guide.

DBA Source (IBIF_DBAPASS_SRC)

Controls whether to pass a DBA password to the WebFOCUS Server on each request.

Permitted values are:

• Off. This option sets the DBA Source (IBF_DBAPASS_SRC) setting to blank and does not pass a DBA password with each request. This is the default option.
• IBIMR_user. This option sets the DBA Source (IBF_DBAPASS_SRC) setting to the value of the Managed Reporting User ID.

For more information, see DBA Password Settings.

Excel Server URL (IBIF_EXCELSERVURL)

Identifies the location of the resource used to render output in the Excel 2007 file (.xlsx) format.

The Excel Server URL drop-down list contains two options:

• DEFAULT. Directs output to the IBIExcel Servlet on the mid tier, which will then render the output in the Excel file format. The URL used by this setting is the Default URL for the WebFOCUS mid-tier. Use this option if you do not need to support SSL or any type of authentication other than the default internal security. This is the default option.
• Reporting Server JSCOM. Directs output to the JSCOM3 listener on the WebFOCUS Server, which will then render the output in the Excel file format. The URL used by this setting is the URL of the JSCOM3 listener. Use this option if you need to support SSL or any type of authentication other than the default internal security.

Graph Agents (IBIF_GRAPHAGENTS)

Specifies the number of prestarted agents available for graph processing. The default value is 10 agents.

Graph Server URL (IBIF_GRAPHSERVURL)

Identifies the location of the resource used to render output in graph image file format.

The Graph Server URL drop-down list contains two options:

• DEFAULT. Directs output to the IBIGraph Servlet on the mid tier, which will then render the output in graph image file format. The URL used by this setting is the Default URL for the WebFOCUS mid-tier. Use this option if you do not need to support SSL or any type of authentication other than the default internal security. This is the default option.

  This option is required on z/OS. In all other environments, JSCOM3 is the recommended configuration option.

• Reporting Server JSCOM. Directs output to the JSCOM3 listener on the WebFOCUS Server, which will then render the output in graph image file format. The URL used by this setting is the URL of the JSCOM3 listener. Use this option if you need to support SSL or any type of authentication other than the default internal security.

Note: If your configuration must use a different resource, contact the Customer Support Service Team to obtain assistance.

Persistent Amper Variable (IBIF_PERSISTENTAMP)

Turns on the persistent ampersand (&&) feature. By default, this check box is selected, (True). To disable this feature, clear this check box (False). The persistent ampersand feature allows you to persist && variables for the duration of the browser session.

Do Not Add Timestamp to a Redirected Report Name (IBIWF_AS_NAME_REPORT)

Determines whether a date and time are automatically removed from the end of the file name of all redirected reports using the Microsoft Excel spreadsheet format, regardless of the values assigned to the related Redirection setting and Save Report setting.

If this check box is cleared (False), the Date and Time are automatically added to the file names of redirected Excel reports. This is the default setting.

If this check box is selected (True), the Date and Time are not added to the file names of redirected Excel reports. Select this option when you must override the default system behavior and suppress the addition of a unique date and time to Excel report file names.

For information on the role of this setting in configuration with other report output redirection settings, please see Redirecting and Saving File Output.

Default Language (IBIWF_LANGUAGE)

With the Dynamic Language Switch feature, the default user interface language for a session is based on the language of the browser, or by setting the IBIWF_language=nn parameter in the URL (where nn is the ISO language abbreviation).

The WebFOCUS Client uses this default setting to control the display language when the browser language of the user is not one of the available options from the Select Language drop-down list during sign-in, or if no parameter is set in the URL call.

For possible values for the ISO language abbreviations, see the WebFOCUS National Language Support for International Computing manual.

Maximum Messages (IBIWF_MAX_MESSAGES)

Controls how many WebFOCUS Server message lines will be accumulated before WFServlet stops processing the request and displays error message 32100:

Reporting Server messages exceeded IBIF_max_messages, report retrieval aborted.

Messages include -TYPE commands, &ECHO=ALL variables, and errors or warnings from a data adapter. The setting protects against the situation where the Java VM executing WFServlet runs out of memory. The default value is 20000 lines. The IBIF_max_messages setting can be passed with the request, in which case it overrides the value set in the Console. When debug mode is enabled in App Studio, a value of 50000 is passed with each request. A value of 0 indicates that no limit exists.

Redirection (IBIWF_REDIRECT)

Globally sets redirection on or off. Possible values are:

• Mime. Respects the values set in the mime table. This is the default value.
• Never. Never redirects. The report output displays in the browser immediately after the request is executed. The report content is streamed to the browser without writing anything to the report cache when the content exceeds the value stored in the IBIWF_sendbufsize setting.
• Always. Always redirects. The report content is saved in the temporary report cache directory. Content is moved from memory to the report cache when it exceeds the value of the IBIWF_sendbufsize setting. Then, a second HTTP call is made from the browser to retrieve the report content for display.
• Length. Does not redirect. If the size of the report content exceeds the value stored in the IBIWF_sendbufsize setting, the report output is moved from memory to the report cache. Once the report output is completely accumulated in the report cache, it is sent to the browser without an additional HTTP call.

Maximum Response Window Size (IBIWF_REDIRNEWWINDOWSIZE)

Defines the maximum size, in bytes, allowed for responses in the original window when using Internet Explorer.

Responses larger than the size identified in this setting will be launched in a new window, to ensure that it will open without errors. If this setting is blank, no maximum limit is applied. The default value is 400,000 bytes.

Sharing cascades to (IBI_CASCADE_SHARING)

Identifies the range of objects that are included when you share an unpublished procedure or object with other users. You can select one of the following options.

• Server. All objects referenced in a procedure or object are shared, including objects on the WebFOCUS Server. This is the default value.
• Includes. Only those objects referenced by -INCLUDE statements within a procedure or object are shared.

Referenced objects are shared in Run mode only.

When you stop sharing an unpublished procedure or object, you also stop sharing its referenced objects. However, any referenced objects shared independently of the procedure or object, remain available to their originally shared users and groups. Referenced objects assigned to multiple shared procedures or objects continue to be shared in Run mode until all of the procedures or objects in which they appear are no longer shared.

Google Maps API Key (IBI_GOOGLE_MAPS_API_KEY)

Google API v3 does not require an API key. Therefore, this field must remain blank.

Google Maps API Version (IBI_GOOGLE_MAPS_API_VERSION)

Determines the version number of the Google Maps™ API. Can be an integer or decimal value. An integer value represents a stable version. Currently, only Google Maps API v3 is supported.

TIBCO Language (IBI_LANG)

This setting is only applicable on UNIX. In order to display NLS characters on a report with server-side graphics, you must set this parameter to the appropriate UNIX locale encoding (for example, en_US).

Master Full Information (IBI_MAS_FULLINFO)

Determines if Master Files retrieved from the WebFOCUS Server include the Master File title and suffix, or not. From the drop-down menu select:

• Default. To conform to the setting specified in the Global Profile of the WebFOCUS Server (edasprof.prf). This is the default option.
• Yes. To include title and suffix from retrieved Master Files. If there are a large number of Master Files, this retrieval may be slow.
• No. To omit title and suffix from retrieved Master Files.

Resource Governor Advise Messages (IBI_RES_GOV_ADVISE)

Enables the display of Resource Governor advise messages for the servers you select from the list in this setting. When enabled, redirection is turned on for all report formats when the WebFOCUS Server returns any Resource Governor advise messages to display to the user. You can access the redirection settings by selecting Redirection Settings under the Configuration menu of the Administration Console. By default, the setting is disabled.

Site Profile (IBI_SITE_PROFILE)

The following syntax enables you to include code to be executed on the WebFOCUS Server by the WebFOCUS Client.

_site_profile=command

where:

command

Is any valid WebFOCUS Server syntax. The site profile is not processed during a WebFOCUS Server sign-in, or when a procedure scheduled in ReportCaster is run. It is only processed when procedures are run on the WebFOCUS Server.

The site profile can also be added directly to the drive:\ibi\WebFOCUS82\client\wfc\etc\site.wfs file.

Temporary File Timeout (IBI_TEMPFILETIMEOUT)

Deletes files from the temporary directory. Files are deleted if they are older than the number of seconds specified. The default value is 900 seconds.

Universal Profile  (IBI_UNIVERSAL_PROFILE)

The following syntax enables you to include code to be executed by the WebFOCUS Client and the ReportCaster Distribution Server. This differs from the _site_profile, which is only executed by a WebFOCUS Client request.

_universal_profile=command

where:

command

Is any valid WebFOCUS Server syntax.

A _universal_profile should not include any logic or constructs that will execute only on the WebFOCUS Client. For example, http header variables should not be included, because they are available to the WebFOCUS Client, but not to the ReportCaster Distribution Server.

The universal profile can also be added directly to the drive:\ibi\WebFOCUS82\client\wfc\etc\site.wfs file.

Plugin Class (IBI_WFEXT)

Specifies the qualified name of a plug-in class to be invoked by the WebFOCUS Servlet. By default, this variable is set to ibi.webfoc.WFEXTDefault, which is the default plug-in supplied with WebFOCUS that contains several useful functions.

x

Transin-Transout (IBI_WFTRANSINOUT)

Is a fully qualified Java class that does the transin and transout processing (processing of a request to and output returned by the WebFOCUS Server) for a plug-in for the Servlet version of the WebFOCUS Client. This class must implement the WFTransInOutInterface Java class. For example, one use of this class can be to enable data that is passed between the WebFOCUS Server and the Servlet to be parsed for bi-directionality (left/right versus right/left strings). This setting is blank, by default.

Deferred Reporting settings determine how deferred reports are processed.

Prompt for Custom Deferred Report Description (IBI_DEFERRED_CUSTOM_DESCRIPTION)

When this check box is selected, the default setting, users are prompted to optionally customize the description for the deferred report, which defaults to the title of the report being run deferred. This occurs whenever the description defined in the parameter (IBIMR_defer_description) has not been submitted with the run deferred report request.

When this check box is cleared, the title of the report being submitted to run deferred is assigned to the deferred report description automatically, and no prompt appears.

Display Deferred Request Submitted Notification (IBI_DEFERRED_NOTIFY_SUBMITTED)

When this check box is selected, the default setting, the Deferred Request Submitted window displays to confirm a successful deferred request. The user clicks OK to close the window.

When this check box is cleared, the Deferred Request Submitted window does not display.

Display Deferred Ticket Delete Confirmation (IBI_DEFERRED_TICKET_DELETE_CONFIRM)

Activates an automated message that prompts the user to confirm the deletion of a deferred report. When this check box is selected, which is the default, a message prompts the user to confirm the deletion, so a deletion requires two clicks. When this check box is cleared, the user is not prompted to confirm the deletion, so a deletion requires only one click. Making a large number of deletions is faster when suppressing the confirmation message.

Diagnostics/Tracing Settings determine specific features about system tracing and logging operations for your product installation.

Default options for FEX tracing (IBI_AUTO_FEXOPTIONS)

Establishes the default level of echo traces and SQL Traces captured from the execution of FEX file commands. In a FEX file, the &ECHO variable displays command lines as they execute, in order to test and debug procedures. The level of traces captured from all SQL request and response events. This value is set to Echo On, SQL On, by default, activating both Echo and SQL tracing for an FEX file. Administrators can override this value with any of the other setting combinations identified in the list.

Automatic session trace level (IBI_AUTO_TRACE)

Establishes the default trace level for WebFOCUS Sessions. The session trace level assigned to this setting appears, by default, in the Tracing Level list fields on the main page of the Session Viewer. Trace levels identify the level of events captured in a trace file. They range from Basic, which only captures traces of high level events, to Server, which captures traces of all events. Administrators can override this default value for individual sessions. By default, this value is set to Off, meaning that no traces are captured. For more information, see Reviewing the Session Viewer Main Page.

Test Pages (IBI_ENABLE_TEST_PAGE)

Enables a page for testing HTTP requests and for testing RESTful web services. This check box is selected, by default. You may wish to disable this page in a production environment.

The URLs for the HTTP request test page are:

http://host:port/context_root/WFServlet?IBFS1_action=TEST

and

http://host:port/context_root/WFServlet?IBFS1_action=TEST1

Enable javascript error reporting (IBI_JS_TRACE)

Activates the display of JavaScript error messages in the event.log file and the Session Viewer. Values in this setting are:

• On. Adds entries recording JavaScript errors to the event.log file and captures them in the Session Viewer and in the Session Monitor. This is the default setting.
• Off. Disables the logging feature. However, when using the Session Viewer, JavaScript errors are still added to traces in the Session Viewer and as entries in the event.log file.
• Never. Disables this feature entirely.

As a best practice, we recommend the inclusion of JavaScript errors in the event.log file and in Session Viewer traces.

Log all URLS when completed (IBI_REQUEST_LOGGING)

Establishes the default level of URL request message logging for all sessions. All URL request log entries are posted to the requests log file, located on the Log Files page of the Diagnostic tab in the Administration Console. Administrators can override this default value for individual sessions, by selecting a different log level in the requests entry of the Log Files page. Values in this setting are:

• Off. Does not log URL request events.
• On. Logs all URL request events. Log entries for HTTP Post messages do not include data.
• Full. Logs all URL request events. Log entries for HTTP Post messages include data delivered with the Post request. This is the default setting.

Web Services SOAP Detail (IBI_SOAP_DETAIL)

Displays detailed error messages in the SOAP XML response. This check box is selected, by default. If cleared, this setting suppresses details that administrators may not want to disclose to the end user.

Encryption settings determine the encryption provider and encryption and token key locations.

Provider (IBI_ENCRYPTION_PROVIDER)

Specifies the encryption provider used to encrypt passwords stored in WebFOCUS files. All options are based on the Advanced Encryption Standard.

The following options are supported:

• AES 128 Encryption with Internal Key

  This is the default value.

• AES 192 Encryption with Internal Key

• AES 256 Encryption with Internal Key

• AES 128 Encryption with External Key

• AES 192 Encryption with External Key

• AES 256 Encryption with External Key

If you select an option that specifies an internal key, encryption is based on a key that is embedded within WebFOCUS.

If you select an option that specifies an external key, you must create that key, assign it to a file named key.cfg, and save that file in the following directory:

drive:\ibi\WebFOCUS82\config

For more information about creating an external encryption key, see Default TIBCO WebFOCUS Encryption and AES Encryption.

ESRI settings define the connection to the local application that supports Esri-based maps.

ESRI On Premise (IBI_ESRI_ON_PREMISE)

Identifies the path to the internal ArcGIS JavaScript API Source used to develop Esri-based maps. This setting is blank, by default, meaning that the use of an internal source is not activated. To activate the use of an internal ArcGIS JavaScript API to develop Esri maps, type the path to it in this setting, typically, /web_resource/arcgis_api.

The default API that should be referenced by this setting is the ArcGIS API for JavaScript, version 3.28, which can be found at https://js.arcgis.com/3.28/. The ArcGIS JavaScript API zip file is available for download from https://developers.arcgis.com/downloads/#javascript. Access to this file requires a valid user ID and password which you must establish with ArcGIS.

For more information about the Esri ArcGIS Javascript API, see https://developers.arcgis.com.

For more information about how to configure Esri On Premise for InfoAssist, see the Configuring an Esri On Premise Environment topic in the TIBCO WebFOCUS ® InfoAssist User’s Manual.

For more information about how to configure Esri On Premise for App Studio, see the Installing and Configuring Esri on Premise topic in the TIBCO WebFOCUS® App Studio User's Manual.

Filters settings enable protections against common web security vulnerabilities.

Allow Legacy WFServlet Requests, without CSRF Token (IBI_CSRF_ALLOW_LEGACY)

When selected (True). the default setting, this check box allows legacy WFServlet requests to run without requiring or using a cross-site request forgery (CSRF) security token.

Cross Site Request Forgery Protection (IBI_CSRF_ENFORCE)

Requires all POST requests to provide a cross-site request forgery (CSRF) security token to be validated, except for legacy requests, if the exception is allowed by the IBI_CSRF_Allow_Legacy setting. This check box is selected (True), by default.

Cross Site Request Forgery Security Token (IBI_CSRF_TOKEN_NAME)

Specifies the name of the cross-site request forgery (CSRF) security token. The default value is IBIWF_SES_AUTH_TOKEN.

Cache Control Header (IBI_HTTP_RESPONSE_HEADER_CACHE_CONTROL)

Specifies the default cache control response for static content accessed by the web application. The default value is public, max-age=2592000 (30 days). Consult Customer Support Services for assistance before altering this setting.

Static Content Header (IBI_HTTP_RESPONSE_HEADER_ENABLED)

When this check box is selected (True), the default value, this setting adds the cache-control response header and the expires response header to static files that use the *.htm, *.html, bindowsBundle.jsp, *.css, *.gif, *.png, *.jpeg, *.jpg, *.txt, *.htc, and CombineImageServlet format.

You can modify the cache-control response header with the Cache Control Header (IBI_HTTP_Response_Header_Cache_Control) setting. You can modify the expires response header with the Expires Header (IBI_HTTP_Response_Header_Expires) setting. However, you must consult Customer Support Services for assistance before altering this setting or either of these other settings.

Expires Header (IBI_HTTP_RESPONSE_HEADER_EXPIRES)

Specifies the default expiration response header for static content served by the web application. The default value is 2592000 (30 days). Consult Customer Support Services for assistance before altering this setting.

Maximum content size of multipart requests (IBI_MAX_CONTENT_SIZE)

Defines the maximum size for data files uploaded to the Repository or the EDA Server. Data files that are larger than the value in this setting cannot be uploaded. The default value is 2048 megabytes. The maximum allowable value is 10240 megabytes. A value of -1 deactivates this setting.

RESTful Webservices Method Enforcement (IBI_REST_METHOD_ENFORCE)

When selected (True), this check box specifies that RESTful Web Services functions which create, update, or delete can only be run with the HTTP POST method.

This check box is selected, by default.

Note: If the Cross Site Request Forgery Protection (IBI_CSRF_ENFORCE) setting is set to True, then RESTful Web Services also require a CSRF token. The token name is specified with the Cross Site Request Security Forgery Token (IBI_CSRF_Token_Name) setting.

Maximum memory size of uploads, before cached (IBI_UPLOAD_MAX_MEMORY)

Defines the maximum amount of memory that data from files uploaded to the Repository or the EDA Server can occupy. During the upload process, data moves into memory until it reaches the limit defined in this setting. Any additional data is temporarily cached to disk. The default value is 256 megabytes. A value of -1 deactivates caching.

X-Content-Type-Options Header (IBI_XCONTENT_TYPE_OPTIONS)

When this check box is selected, an XCONTENT TYPE header is included in HTTP Response messages issued from the WebFOCUS Server. This is the default value.

By including an XCONTENT TYPE header, a server instructs the browser receiving an HTTP Response message to accept the content type assigned to the message instead of mime sniffing the data it contains and overriding the previously-assigned content type. The server asserts that the content type assigned to the message is reliable, and that the data in the message can be displayed using the content type assigned to it.

The XCONTENT TYPE header also protects the browser that receives it from cross-site scripting attacks in which mime sniffing an HTTP Response message causes a browser to execute unintended programs based on executable code hidden within its data.

When this check box is cleared, HTTP Response messages issued from the WebFOCUS server do not include the XCONTENT TYPE header, and browsers receiving it are vulnerable to cross-site scripting or other attacks. Because changing the default value assigned to this setting leaves users open to this vulnerability, we recommend that you consult Customer Support Services before doing so.

Cross Site Scripting Protection Block Mode (IBI_XSS_MODE_BLOCK)

If the Microsoft Internet Explorer cross-site scripting filter is enabled in the Cross Site Scripting Protection (IBI_XSS_PROTECTION) setting, the value assigned to this check box specifies the response the browser makes to a cross-site scripting attack. Permitted values are:

• False

  If the Cross Site Scripting Protection Block Mode (IBI_XSS_MODE_BLOCK) check box is clear, (False), the following value is returned:

  X-XSS-Protection: 1

  Internet Explorer will attempt to make minor corrections to the webpage if it detects a cross-site scripting attack. This is the default value.

• True

  If the Cross Site Scripting Protection Block Mode (IBI_XSS_MODE_BLOCK) check box is selected, (True), the following value is returned:

  X-XSS-Protection: 1; mode=block

  Internet Explorer will not render the webpage at all if it detects a cross-site scripting attack.

Cross Site Scripting Protection (IBI_XSS_PROTECTION)

Specifies whether the Microsoft Internet Explorer cross-site scripting (XSS) filter is enabled or disabled. Valid options are:

• True

  Enables the browser XSS filter by returning an HTTP response header of:

  X-XSS-Protection: 1

• False

  Disables the browser XSS filter by returning an HTTP response header of:

  X-XSS-Protection: 0

  This is the default value.

• Off

  Does not return an HTTP response header to the browser. The browser relies on its default XSS filter settings for the browser security zone.

The Cross Site Scripting Protection (IBI_XSS_PROTECTION) setting works in conjunction with the Cross Site Scripting Protection Block Mode (IBI_XSS_MODE_BLOCK) setting.

Note: Because application development requires HTTP requests to use characters that can be misinterpreted as a cross-site scripting attack, this filter must be disabled in a development environment. You can set Cross Site Scripting Protection (IBI_XSS_PROTECTION) to False (the default value) or Off. If Cross Site Scripting Protection (IBI_XSS_PROTECTION) is off, the browser security settings will determine if Internet Explorer invokes its cross-site scripting protection. This is required only for development purposes. If you maintain a separate production environment, you may set Cross Site Scripting Protection (IBI_XSS_PROTECTION) to True in that installation.

Multiple Reports settings configure options for multi-frame reports.

Index (IBIWF_INDEX)

Controls whether a sequence number is appended to the end of the names on the TOC when IBIWF_mreports=INDEX. On appends a sequence number of 1 (for the first report generated) to n (for the last report generated). Off omits a sequence number. Only the text specified by the IBIWF_mprefix setting applies. The default value is On.

Frame Name (IBIWF_MFRAMENAME)

Used to name each frame in a multi-frame report. The name of each frame will be this value followed by an index number. For example, for two frames with IBWIF_mframename set to MYFRAME, the two frames will be named MYFRAME1 and MYFRAME2. The default value is MREPORT.

Reports Order (IBIWF_MORDER)

Specifies whether the report frames in a multi-frame report should appear in the order that the columns are specified in the request or the reverse order. Possible values are FORWARD and REVERSE. The default value is FORWARD.

Prefix (IBIWF_MPREFIX)

Specifies up to 50 characters of descriptive text that precedes a sequence number and identifies a report in a TOC. Used to create hyperlink names in index reports. For example, if the value is MyReport, the hyperlinks will be composed of the name MyReport followed by an index number starting with 1. The default value is REPORT.

Note: Do not use this setting if IBIWF_mreports is set to FRAME.

Maximum Columns (IBIWF_MRCOLUMNS)

Specifies the maximum number of columns per page in multi-frame reports. The default value is 1 column.

Type (IBIWF_MREPORTS)

Specifies whether to create an index report, a multi-frame report, or a standard report. Possible values are OFF, INDEX, and FRAME. The default value is Off.

Maximum Rows (IBIWF_MRROWS)

Is the number of vertically stacked reports when the IBIWF_mreports setting is FRAME. This setting is blank, by default.

On-Demand Paging settings configure On-Demand Paging options.

Enable On Demand Paging (IBIF_ODPENABLE)

Controls display of On-Demand Paging (ODP) reports.

When this check box is selected (Yes), the ODP report is displayed. This check box is selected, by default.

When this check box is cleared (No), the ODP report is not displayed. Instead, a page with a message displays. You can specify the message text in the IBIODP_disable_msg setting. If you do not, a blank line displays.

Disabled Message (IBIODP_DISABLE_MSG)

This setting contains the message that will be displayed instead of the ODP report output when IBIF_odpenable is set to No. The default value is a blank line (\n).

Search Highlight HTML Tag Value (IBI_ODP_SEARCH_HIGHLIGHT)

HTML tag for highlighting text found as a result of a search in an ODP report. The default value is <u>, to underline the text.

Target (IBI_ODP_TARGET)

Controls the action of the back button in the Web Viewer.

• When this check box is selected, (On), the Back button of the browser redisplays the first ODP page. This check box is selected, (On), by default.
• When this check box is cleared, (Off) the Back button of the browser returns the browser to the calling page of the ODP report.

OLAP settings configure OLAP options.

These settings are visible only if the Enable OLAP check box is selected. The Enable OLAP check box appears on the Other Settings page of the Administration Console Configuration tab.

Position (IBIF_OLAPPOS)

Specifies the location of the OLAP panel. Possible values are TOP and BOTTOM. The default value is BOTTOM.

x

Skin Color (IBIF_OLAPSKINCOLOR)

Enables administrators to preview and set a new color scheme for OLAP components, such as the OLAP Control Panel. The default value is BLACK.

Skin Name (IBIF_OLAPSKINNAME)

Enables administrators to create a name to preview and set a new color scheme for OLAP components, such as the OLAP Control Panel. The default value is NEUTRAL.

Docked (IBI_OLAP_DOCKED)

When the check box is selected, the OLAP Control Panel is permanently displayed while running an OLAP report. This check box is cleared, by default.

Save Excel (IBI_OLAP_SAVEEXCEL)

Specifies whether to display the OLAP Save the data in an Excel fie option. This check box is selected, by default.

Save Excel 2000 (IBI_OLAP_SAVEEXCEL2000)

Specifies whether to display the OLAP Save the data in an Excel 2000 file option. This check box is selected, by default.

Save Excel 2000 with Formulas (IBI_OLAP_SAVEEXCEL2000WITHFORMULAS)

Specifies whether to display the OLAP Save the data in an Excel 2000 file with formulas option. This check box is selected, by default.

Other settings determine miscellaneous configuration settings.

Legacy Cookies (IBI_ALLOWED_COOKIES)

Type WF_USER in this field to send this cookie back to the browser. This allows the WFSIGNON action when authenticating with the WebFOCUS Server.

Email Server (IBI_EMAIL_SERVER)

Specifies the email server used to email WebFOCUS Mobile links.

Enable CACHECOMS (IBI_ENABLE_CACHECOMS)

Activates the use of the UOA_CACHECOMS table in background operations.

The UOA_CACHECOMS table, located in the WebFOCUS Repository database, synchronizes multiple instances of WebFOCUS within a distributed environment by holding entries recording changes made in one instance of WebFOCUS until an internal polling process retrieves and distributes these changes to the other instances. A separate database operation polls the UOA_CACHECOMS table and clears the table of entries that contain the previously-distributed changes once every minute.

When this check box is selected (True), the UOA_CACHECOMS table and its related database processes are activated. This is the default value.

When this check box is cleared (False), the UOA_CACHECOMS table and its related database processes are not activated.

You can clear this check box to suspend the use of this table and its related database operations when you need to enhance performance.

Enable Infographics (IBI_ENABLE_INFOGRAPHICS)

Enables the use of infographics within your product installation.

When this check box is cleared, the use of infographics is disabled for everyone in the organization, including administrators and those users working with a role that includes the Display Easel.ly Link (opEaselly) privilege. By clearing this check box, administrators can override the assignment of the Display Easel.ly Link (opEaselly) privilege, and disable the use of infographics throughout their organization.

When this check box is selected, the use of infographics is enabled for administrators and for users working with a role that includes the Display Easel.ly Link (opEaselly) privilege. This is the default value.

When the use of infographics is disabled, the Utilities menu on the WebFOCUS Home Page, or the Quick Access menu on the Hub does not display the WebFOCUS Infographics option, eliminating the quick link to the Easel.ly website. The shortcut menu does not display the New InfoGraphic option, preventing users from creating new procedures based on Easel.ly template files, even if those files were downloaded directly from the Easel.ly website.

When the use of infographics is enabled, the Utilities menu on the WebFOCUS Home Page, or the Quick Access menu on the Hub displays the WebFOCUS Infographics option that links users directly to the Easel.ly website, where they can download Easel.ly templates that can then be uploaded to a workspace. In addition, when users right-click uploaded Easel.ly template files, the shortcut menu displays the New Infographic option, enabling users to open Easel.ly template files and create new procedures based on them.

The Display Easel.ly Link (opEaselly) privilege is typically available to administrators and to users assigned to the Advanced User or Developer groups within a workspace.

Note: The value in the Enable Legacy Features (IBI_ENABLE_LEGACY_FEATURES) setting takes priority over the value in this setting. Therefore, both the Enable Infographics check box and this check box must be selected in order to make infographics available.

Enable Legacy Features (IBI_ENABLE_LEGACY_FEATURES)

Enables the use of legacy features.

When this check box is cleared (FALSE), legacy feature privileges are not available and cannot be assigned to groups. This is the default setting for the cloud-based free trial installation.

When this check box is selected (TRUE), legacy feature privileges are available and can be assigned to groups. This is the default setting for all installations other than the cloud-based free trial.

The following legacy feature privileges are affected by this setting:

• Advanced Reporting Privilege Category
  • Create Alerts (opAlertAssistant)
  • Data Visualization From Metadata (opVisualization)
  • Display Easel.ly Link (opEaselly)
  • Express Analytics (opExpressAnalytics)
  • InfoAssist From Metadata (opInfoAssist)
  • InfoAssist From Reporting Object (opInfoAssistviaReportingObject)
• Application Development Privilege Category
  • Create Reporting Objects (opReportingObject)

When these legacy privileges are enabled, InfoAssist, the Reporting Object Tool, the WebFOCUS Infographics menu option, and other legacy tools are available to administrators and to users working in the Advanced Users group, the Developers group, and any group whose roles include these privileges.

Note: The value in this setting takes priority over the value in the Enable Infographics (IBI_ENABLE_INFOGRAPHICS) setting. Therefore, both this check box and the Enable Infographics check box must be selected in order to make infographics available.

Enable OLAP (IBI_ENABLE_OLAP)

Enables OLAP settings and functionality. When this check box is selected, OLAP functionality appears in the following locations:

• WebFOCUS.
  • In the Security Center, Basic Reporting section: Run Procedures with OLAP permission.
  • On the Administration Console, Configuration Tab: OLAP Settings page.
  • In the Properties dialog box: Run with OLAP check box.

    Note: In the Properties dialog boxes of portals and workspaces, this check box appears dimmed and is unavailable. In the Properties dialog boxes of reports, charts, and visualizations, this check box is fully visible and available.

• InfoAssist and InfoAssist Basic. On the Auto Drill and Analysis menu: All OLAP-related features including the OLAP Options panel, OLAP panel, OLAP Ribbon, and OLAP Reports.

This setting does not activate the use of OLAP within App Studio. To do so, open App Studio, and select the Enable OLAP check box on the Reporting tab of the App Studio Options dialog box. For more information, see the Setting User Preferences Using the Options Dialog Box topic in the WebFOCUS App Studio User's Manual.

This check box is cleared, by default.

User Default Roles (Used For Migration) (IBI_ENABLE_UDR)

For migrated environments, enables the Default Role tab in the Security Center. This check box is cleared, by default.

Excluded File Extensions for Reporting Server (IBI_EXCLUDE_WFRS_FILE_EXTENSIONS)

Identifies the type of files that cannot be uploaded to the WebFOCUS Server. Files types are identified by their extension. For example, PDF files that use one of the extensions listed in this setting cannot be uploaded. This setting is blank, by default, enabling you to upload any type of file.

Designer/InfoAssist record limit (IBI_TOOL_RECORDLIMIT)

Identifies the default value assigned to the maximum number of records limit.

This value is set to 5,000, by default. When you change this value, the value automatically assigned to the Designer Maximum Number of Records and InfoAssist Maximum Number of records setting will also change to reflect the value in this setting.

If you assign a value of zero (0) to this setting, no limits are imposed on the maximum number of records. We do not recommend this value because it can degrade the performance of your browser.

Convert FOCUS Errors to Warnings (IBI_FOCUS_WARNING_NUMBERS)

Contains one or more FOCUS error message numbers separated by commas. WebFOCUS and ReportCaster regard the FOCUS error messages whose numbers appear in this setting as warnings instead of error messages.

If WebFOCUS encounters one of these FOCUS error message numbers, it generates a warning message instead of an error message and does not highlight the trace that captures the FOCUS error message as an error in the Session Viewer.

If ReportCaster encounters one of these FOCUS error message numbers when executing a report schedule, it distributes the report in spite of the FOCUS error message, and does not trigger an error notification, even if the report schedule is configured to use the On Error Notification Type.

Paths to Item Descriptions to be Indexed (IBI_INDEX_DESCRIPTION)

Identifies the paths to those folders in which item descriptions are indexed for the Magnify Search engine.

When the term OFF appears in this setting, item description indexing is deactivated. This is the default value.

When one or more paths appear in this setting, item description indexing is activated for all items within the final folder identified in each path. Whenever an item within a folder identified by one of the paths in this setting is created, or the description or summary of an existing item within that folder is modified, the description and summary of that item are indexed automatically. If the final folder in a path includes multiple folders, item description indexing is activated for all of them.

Paths follow the IBFS path format. For example:

/wfirs/ibfs/WFC/Repository/Retail_Samples/Reports/

Multiple paths must be separated with a semicolon (;).

Enable InfoSearch (IBI_INFOSEARCH)

When this check box is selected, the Display Ask TIBCO WebFOCUS Menu (opInfoSearch) privilege is available in the Security Center Roles dialog box, making InfoSearch available to users. This is the default value for this setting.

When this check box is cleared, the Display Ask TIBCO WebFOCUS Menu (opInfoSearch) privilege is removed from the Security Center Edit Role dialog box, making InfoSearch unavailable to users.

After a new product installation or upgrade, this check box is selected, by default, making InfoSearch and the Display Ask TIBCO WebFOCUS Menu (opInfoSearch) privilege available automatically. However, even when this check box is selected, the text-based search capability it enables becomes available only when users have the Display Ask TIBCO WebFOCUS Menu (opInfoSearch) privilege and dimensionally-indexed Repository content is available.

Because clearing this check box also hides the Display Ask TIBCO WebFOCUS Menu (opInfoSearch) privilege, administrators should not clear this check box unless they intend to remove the ability to use InfoSearch from all users. To re-establish this setting, an administrator must select the Enable InfoSearch check box again.

Note: InfoSearch is a search tool that retrieves content items in the Repository that contain data or metadata that matches the words or expressions used in the search query. It is a superset of the Magnify Search tool, and InfoSearch is purchased separately. Customers that purchase Magnify Search, but not InfoSearch, will be able to use the InfoSearch Retail Samples demo, but they will not be able to use InfoSearch with any other data or content.

Library Item Default Action (IBI_LIBRARY_ITEM_DEFAULT_ACTION)

Determines whether double-clicking a library item opens the latest version of the report (Last) or a list of report versions (Versions). The default value is Last. The value you specify here appears first in the shortcut menu when you right-click a library item and click View.

Enable Mobile Voice (IBI_MOBILE_VOICE)

This check box is visible only if the license key for your installation includes the TIBCO WebFOCUS Mobile product component.

When this check box is selected, the Display Ask TIBCO WebFOCUS for Mobile Voice (opMobileVoice) privilege is available in the Security Center Roles dialog box, making the Mobile Voice interface available to all users. This is the default value for this setting.

When this check box is cleared, the Display Ask TIBCO WebFOCUS for Mobile Voice (opMobileVoice) privilege is removed from the Security Center Roles dialog box, making the Mobile Voice interface unavailable to all users.

After a new product installation or upgrade that includes a license for the TIBCO WebFOCUS Mobile product component, this check box is visible and selected, by default, making Mobile Voice and the Display Ask TIBCO WebFOCUS for Mobile Voice (opMobileVoice) privilege available automatically.

However, even when this check box is selected, Mobile Voice search capability becomes available only when licensed users are working with a role in which the Display Ask TIBCO WebFOCUS for Mobile Voice (opMobileVoice) privilege is selected, dimensionally-indexed Repository content is available, and at least one Intent phrase has been defined for an available resource.

Because clearing this check box also hides the Display Ask TIBCO WebFOCUS for Mobile Voice (opMobileVoice) privilege, administrators should not clear this check box unless they intend to remove the ability to use Mobile Voice from all users. To re-establish this setting, an administrator must select the Enable Mobile Voice check box again.

Prompt for Connection Credentials Option (IBI_PROMPT_FOR_CONNECTION_CREDENTIALS)

When this check box is selected (True), the Run Procedures with Different Connection Credentials (opRunAs) privilege becomes available in the Basic Reporting privilege category of the Roles dialog box.

Users who are granted this privilege can select the Run with different connection credentials option from the shortcut menu. This menu option allows users to provide credentials when running procedures against databases that require additional authentication against their internal credentials in order to provide access to an elevated data set. It extends reporting capabilities to information that would otherwise be unavailable without the ability to authenticate alternative user IDs and passwords at runtime.

When this check box is cleared (False), neither the privilege nor the menu option is available. This is the default value for this setting.

This setting only affects the configuration of the Run with different connection credentials menu option within the WebFOCUS Client. In order to complete the configuration of this functionality, the WebFOCUS Server and individual database connections must also be configured to accept the use of additional credentials. For more information about the WebFOCUS Server configuration, see the TIBCO WebFOCUS® Reporting Server Administration technical content.

For more information about the WebFOCUS Client configuration, see Configuring Run With Different Connection Credentials.

Upload Images to be Embedded in Reports (IBI_PUSH_IMAGE)

Uploads Repository images to the WebFOCUS Server for embedding in reports and HTML pages. This check box is selected, by default.

Custom Strings (IBI_RESOURCEBUNDLE_ALTERNATE_PREFIXES)

The name of the file that contains text strings used to customize labels for global items, such as menu bar options, error messages, and other features. This field is blank, by default.

Note: Consult Customer Support Services before modifying this setting.

Paths to be executed on user Sign-in (IBI_SIGNIN_PATHS)

Lists all procedures that run when users sign in to a portal or to web services. By default, this setting is blank, and no procedures run in response to user sign in. To configure a list of procedures, type the path name for each of them in this setting, and separate each path name with a comma, as shown in the following example.

IBFS:/WFC/Repository/Public/motd.fex,

The procedures you include in this setting can serve a variety of purposes. For example, you can use this setting to run a procedure that sends a message of the day to users upon sign-in, using the syntax shown in the following example of the message of the day file, motd.fex.

-IF &FOCSECUSER EQ admin GOTO ADMINMSG;
-TYPE <UserMsg>Hello normal user</UserMsg>
-GOTO DONE;
-ADMINMSG
-TYPE <UserMsg>Hello admin</UserMsg>
-DONE

You could also use this setting to run a procedure that initializes the environment and establishes a procedure within the repository that creates a single foccache ticket that can be used for all subsequent requests, as shown in the following example.

TABLE FILE IBISAMP/CAR PRINT COUNTRY
IF RECORDLIMIT EQ 1
ON TABLE HOLD AS FOCCACHE/LATCH
END

This procedure cannot produce any report output.

Technical Preview Features (IBI_TECHPREVIEW_FEATURES)

Activates the technical preview mode, which enables users to view and evaluate specific features planned for an upcoming release.

This setting is relevant only to product versions that include preview features. Because each release contains a different set of new features, the code names of preview features for one version may not be relevant to another version. Therefore, lists that do not contain the code name of any feature that appears in the technical preview mode of the version that is currently installed, fail to activate the technical preview mode.

When this setting is blank, the technical preview mode is not activated, and users are not able to preview new features. This is the default value.

When this setting contains a semicolon-delimited list of the code names of one or more of the features that are included in the technical preview mode of the version of the product that is currently installed, WebFOCUS activates the technical preview mode, and users can open and test the new features included in the list.

When the technical preview mode is activated, administrators receive a message identifying the technical preview features that are currently enabled immediately after sign-in. This message is also posted to the event log along with other records of the administrator sign-in event. No other users receive this message after sign-in.

Designer/InfoAssist record limit (IBI_TOOL_RECORDLIMIT)

Establishes the maximum number of values to display in the Filters selection panel at design time.

For example, in WebFOCUS Designer, this value defines the maximum number of entries that can be included in a list of alphanumeric filter options that opens from the Filter toolbar. Similarly, in InfoAssist, this value defines the maximum number of entries that can be included in a list of alphanumeric filter options that opens from the Get Values list of the Creating a filtering condition dialog box for a filter based on a Constant value type.

5000 is the default value assigned to this setting.

Override for Tools Theme (IBI_TOOL_THEME)

Identifies the name of the theme assigned to InfoAssist and Business Intelligence Portal designer tools. This value is blank, by default, meaning that the default theme behavior is in effect for these tools. The other value, BIPNeutral, sets the default theme for these designer tools to a more modern and neutral appearance.

Parameter Prompting settings determine parameter prompting behavior in the WebFOCUS Client.

Null Behavior (IBIF_DESCRIBE_NULL)

Specifies the value (_FOC_NULL or FOC_NONE) that the WebFOCUS Client assigns (in a -SET command) to the amper variable when the dynamic multi-select list No Selection value is selected. The default value is _FOC_NULL.

Managed Reporting (IBIMR_PROMPTING)

Enables or disables parameter prompting for all Managed Reporting requests. Possible values are:

• Off. Turns off parameter prompting at the site level.
• Run with Default Values (XMLRUN). Prompts for amper variables that were created with the -DEFAULT command and any other amper variable that does not have a value.
• Always Prompt (XMLPROMPT). Prompts for amper variables that were created with the -DEFAULT command when there is another amper variable that does not have a value assigned. This is the default value.

Managed Reporting when Prompt Parameters Property Unset (IBIMR_PROMPTINGUNSET)

Enables or disables parameter prompting for Managed Reporting procedures (FEXes) when Managed Reporting (IBIMR_PROMPTING) is set to Always Prompt (XMLPROMPT) or Run with Default Values (XMLRUN), and the Prompt for Parameters check box is unselected in the FEX Properties dialog box. Possible values are:

• Off. Turns off parameter prompting.
• Run with Default Values (XMLRUN). Prompts for amper variables that were created with the -DEFAULT command and any other amper variable that does not have a value. This is the default value.
• Always Prompt (XMLPROMPT). Prompts for amper variables that were created with the -DEFAULT command when there is another amper variable that does not have a value assigned.

Auto Describe (IBI_AUTODESCRIBE)

Activates automatic indexing of report and chart parameters. If this check box is selected (True), when users save reports or charts, the parameters on which they are based are indexed automatically, making information about these parameters immediately searchable, and delivering more timely and comprehensive search results.

This check box is selected (True), by default.

Default Autoprompt Template (IBI_DESCRIBE_TEMPLATES)

Specifies the template that defines the layout of the autoprompt interface.

• Designer. Specifies the use of the Designer Autoprompt implementation and the Designer Autoprompt template. In this template, the Autoprompt interface uses the Designer page format. This is the default value.
• Responsive. Specifies the use of the responsive implementation and the autoprompt_jqm.jsp template.
• HTML_Top. Specifies the use of the HTML-based implementation and the autoprompt_top.html template, which displays parameters horizontally at the top of the page.
• HTML_Top_Checked. Specifies the use of the HTML-based implementation and the autoprompt_top_checked.html template. In this template, the Run in a new window check box is pre-selected, specifying that all reports open in a new window, by default.

You can add customized versions of HTML and Responsive autoprompt interface templates to this list by typing template name tags for them in the aptemplates.xml file. However, the Designer autoprompt interface template is not available for customization. For more information, see How to Add Custom Autoprompt Templates and How to Test Custom Autoprompt Templates.

Preselect all values for static list controls (IBI_FOCALL_DEFAULT)

Activates the automatic selection of all values in Responsive Autoprompt multiselect static selection list parameters at runtime, by default.

If this check box is selected (True), Responsive Autoprompt selection list parameters that contain multiselect static lists are automatically assigned FOC_ALL as their initial selection value, by default, causing these lists to automatically display all values as selected at runtime. However, if a multiselect static list designates a default value for display, that value overrides the automatic assignment of FOC_ALL as the initial selection value, and that default value is displayed as the initial selection instead.

If this check box is cleared (False), parameters that contain multiselect static lists are not automatically assigned FOC_ALL as the initial selection value, by default, and all items within the list are not selected automatically at runtime. If a multiselect static list contains a designated default value, that value is displayed, by default. To include all values from the static selection list in a query, a user must manually select the All Values option or individually select all values in the list.

This check box is cleared (False), by default.

Self Service (IBI_WFDESCRIBE_DEFAULT)

Enables or disables amper auto prompting for self-service reporting. Possible values are:

• Off. Turns off auto prompting. This is the default value.
• Run with Default Values (XMLRUN). Prompts for amper variables that were created with the -DEFAULT command and for any other amper variable that does not have a value.
• Always Prompt (XMLPROMPT). Only prompts for amper variables that were created with the -DEFAULT command when there is another amper variable that does not have a value assigned and, therefore, will be prompted for.
• Display XML (Debug with syntax error checking) (XML). Displays the XML document describing the amper variables in the browser. This setting is used internally, and is recommended for debugging and syntax error checking purposes only.
• Display XML (Debug) (XMLCHECK). Displays the XML document describing the amper variables in the browser. This setting is used internally, and is recommended for debugging purposes only.

Note: Managed Reporting uses a separate variable setting, which is IBIMR_PROMPTING.

Quick Data settings determine how Quick Data performs authentication.

Form Only (IBI_QUICK_DATA_FORM_ONLY)

Applies when MR authentication is selected for the IBI_Quick_Data_Security setting. Permitted values are

• Yes. Users may not create their own reports using InfoAssist, but may only use predefined ad hoc forms.
• No. Users may use predefined ad hoc forms or create their own reports, using InfoAssist. The default value is No (clear check box).

Security (IBI_QUICK_DATA_SECURITY)

Specifies the type of sign-in used by WebFOCUS Quick Data. Permitted values are Reporting Server and Managed Reporting. The default value is Reporting Server and requires no additional configuration.

Repository settings specify the authentication credentials that the JDBC driver uses to access the Repository.

Effective Policy Cache Limit (IBI_CACHE_EFFECTIVE_POLICIES_PER_SESSION_LIMIT)

Specifies the maximum number of security policies retained for a single session. The default value is 50 policies and the maximum value is 500 policies.

Effective Policy Cache Duration (IBI_CACHE_EFFECTIVE_POLICY_DURATION)

Specifies the duration, in minutes, that a cached security policy is considered valid. The default value is 180 minutes and the maximum value is 720 minutes.

User Name Cache Limit (IBI_CACHE_USERNAMES_LIMIT)

This information is not yet available.

External Group Cache Duration (IBI_CACHE_USERS_EXTERNAL_GROUPS_DURATION)

Specifies the duration, in minutes, that the list of external groups for each user will be retained. The default value is 180 minutes and the maximum value is 720 minutes.

External Group Cache Limit (IBI_CACHE_USERS_GROUPS_LIMIT)

Specifies the number of users for whom to retain the list of group memberships. The default value is 50 users and the maximum value is 1000 users.

User Profile Cache Duration (IBI_CACHE_USER_AFTER_SIGNOFF_DURATION)

Specifies the number of minutes that user security information will be retained after sign-out. The default value is 30 minutes.

Note: This setting may be useful for applications that run web services applications that sign in, perform a minor task, and sign out.

Procedure Cache Limit (IBI_CACHE_WFC_FEX_LIMIT)

Specifies how many procedures (.fex files) are cached in memory to improve response time. The default value is 100 procedures (.fex files).

Synchronization Interval (IBI_REPOSITORY_SYNC_INTERVAL)

Specifies, in minutes, the interval at which other JVMs will synchronize security information with the Repository, when multiple JVMs are using the same repository. For example, security information is not updated in the other application servers in a cluster or in the ReportCaster Distribution Server until this interval elapses. The default value is 1 minute.

Database Driver (IBI_REPOS_DB_DRIVER)

Specifies the Java Database Connectivity API (JDBC) driver used to access the Repository.

The value in this setting is not available for updates. If you must change the default value assigned to this setting, contact the Customer Services Support team.

Database Password (IBI_REPOS_DB_PASSWORD)

Specifies the password used by the JDBC driver to access the Repository.

Database URL (IBI_REPOS_DB_URL)

Specifies the URL used by the JDBC driver to access the Repository.

The value in this setting is not available for updates. If you must change the default value assigned to this setting, contact the Customer Services Support team.

Database User ID (IBI_REPOS_DB_USER)

Specifies the user ID used by the JDBC driver to access the Repository.

The value in this setting is not available for updates. If you must change the default value assigned to this setting, contact the Customer Services Support team.

Update Last Access Time (IBI_UPDATE_LAST_ACCESS)

Specifies whether the Last Accessed On property is updated in the Properties dialog box when a resource is accessed. The default value is ON, which indicates that the property is updated.

Source Code Management settings activate the use of a third-party source control provider with WebFOCUS or App Studio. They also identify the location of the server and root project where the source control provider repository is stored.

Enable Source Control (IBI_SCM_ENABLE)

When selected, this check box enables the integration of a source control provider to manage application code development in WebFOCUS or App Studio.

This check box and the Enable private working area (IBI_SCM_PWA_ENABLE) check box must be selected to activate the use of Git Source Control operations within WebFOCUS.

Provider (IBI_SCM_PROVIDER_TYPE)

Identifies the source control providers that are available for use when working with WebFOCUS or App Studio.

You can select the source control provider that you want to use from the list of available providers included in this setting.

• Git. Supports source control operations from WebFOCUS.
• Team Foundation Server. Supports source control operations from App Studio.

Typically, the applications created by these providers are installed on the same machine as the host server for WebFOCUS or App Studio.

Version (IBI_SCM_PROVIDER_VERSION)

Identifies the version number of the source control provider that is specified in the Provider (IBI_SCM_PROVIDER_TYPE) setting.

For example, when using Team Foundation Server 2013, type the value 2013.

This setting is not relevant to Git. Leave this setting blank when using Git as the source control provider.

Enable private working area (IBI_SCM_PWA_ENABLE)

When selected, this check box enables the use of a private working area for source control operations within WebFOCUS or App Studio.

This check box and the Enable Source Control (IBI_SCM_ENABLE) check box must be selected to activate the use of Git Source Control operations within WebFOCUS.

Location of Source Code Configuration (IBI_SCM_REPOSITORY_LOCATION)

Identifies the URL of the server hosting the Team Foundation Server, including the collection name that is used to host the projects.

For example, when using Team Foundation Server 2013, type a value that uses the format http://TFS_hostname:port/tfs/collection_name.

This setting is not relevant to Git. Leave this setting blank when using Git as the source control provider.

Location of Root Project (IBI_SCM_ROOT_PROJECT_LOCATION)

Identifies the path and folder name where the root source control project was installed.

For example, when using Team Foundation Server 2013, type the value $/TeamProject1.

This setting is not relevant to Git. Leave this setting blank when using Git as the source control provider.

Search settings configure general Search operations. They apply to Solr Search.

Solr Cloud (IBI_INFOSEARCH_SOLR_CLOUD)

This information is not yet available.

Solr Connection Timeout (ms) (IBI_INFOSEARCH_SOLR_TIMEOUT_MILLISECONDS)

This information is not yet available.

Solr URL (IBI_INFOSEARCH_SOLR_URL)

Identifies the URL of the Solr server for your product installation. When Solr is the designated search engine, the WebFOCUS Client directs indexing and search queries to this URL.

When this value is blank, no URL is identified and no connection can be made to the Solr server engine from the WebFOCUS Client. This setting is blank, by default.

If you are using an IBCloud installation, the cloud administrator must provide you with the correct URL and port number to assign to this setting.

If you are using your own SolrCloud or Solr stand-alone installation, you must identify the URL of the Solr Server in use in your organization and assign it to this value.

For a single cluster Solr configuration, in a non-SolrCloud installation, the format of the Solr URL is:

<scheme>://<host>:<port>/solr

Where:

scheme

Is the scheme in use in your organization. We recommend https.

host

Is the name of the machine that hosts the WebFOCUS Server.

port

Is the number of the port you use to connect to the Solr search engine.

For example: https://host_name:8983/solr

Maximum Number of Search Results (IBI_MAGNIFY_RECORDLIMIT)

Specifies the maximum number of search results returned by a search request. Any results beyond this number are not displayed to the user. The default value is 300 results.

Collection Name (IBI_SEARCH_COLLECTION)

This setting is relevant only if your organization uses the Basic Authentication plugin with the Apache Solr search engine.

If Solr Basic authentication is not in use, this setting is blank.

If Solr Basic authentication is in use, this setting contains the name of the collection that contains your search data and is accessible only with a valid Solr username and password. This value can be authenticated only if a collection name is also defined in the Solr Collections API. This is the default value.

The value ibi-protected appears in this setting, by default. If you do not use the default value, you must assign a unique name to this field, and assign the same unique name to your collection in the Solr Collections API.

For more information, see the Collections/Core Admin topic and the Collections API topic in the Apache Solr Reference Guide.

Password for Basic Authentication (IBI_SEARCH_PASSWORD)

This setting is relevant only if your organization uses the Basic Authentication plugin with the Apache Solr search engine.

A password appears in this setting by default. It is assigned to this setting during product installation. If not in use, leave as is. If in use, replace default password with the password used by your Solr administrator.

If Solr Basic authentication is in use, this setting contains the password that authenticates Solr-based indexing and search queries. This value can be authenticated only if a password is assigned to the security.json file in the Basic Authentication plugin.

If you are working within an IB Cloud installation, you must assign the password provided to you by the Customer Support team to this field.

If you create your own Solr installation, you must create your own password, assign it to this field, and to the password field of the security.json file in the Basic Authentication plugin.

For more information see the Basic Authentication Plugin topics in the Apache Solr Reference Guide.

Username for Basic Authentication (IBI_SEARCH_USERNAME)

This setting is relevant only if your organization uses the Basic Authentication plugin with the Apache Solr search engine.

If Solr Basic authentication is not in use, this setting is blank. This is the default value.

If Solr Basic authentication is in use, this setting contains the user name that authenticates Solr-based indexing and search queries. This value can be authenticated only if a user name is assigned to the security.json file in the Basic Authentication plugin.

If you are working within an IB Cloud installation, you must assign the user name provided to you by the Customer Support team to this field.

If you create your own Solr installation, you must create your own user name, assign it to this setting, and assign it to the username field of the security.json file in the Basic Authentication plugin.

For more information, see the Basic Authentication Plugin topics in the Apache Solr Reference Guide.

Text Generation Server settings define the connections to an independent server that provides narrative descriptions for chart headers, footers, and tooltips.

Text Generation Server URL (IBI_TEXT_GENERATION_SERVER_URL)

Identifies the URL of the external natural language generation (NLG) server that provides narrative descriptions for chart headers, footers and tooltips. If your product installation supports natural language generation for charts, type the URL of the text generation server in this setting. This setting is blank, by default.

When you activate the use of an external natural language generation (NLG) server, this setting contains a value, typically:

http://machine_name:20000/yseop-manager/direct/savvy-kb/dialog.do

Where:

machine_name

Is the name of the server that hosts the external natural language generator.

Validation settings specify the behavior of WebFOCUS when validation tests fail.

Note: The character patterns IBI, IBIFS, and PG_ are reserved for internal product variables. They should not be used at the beginning of variable names.

Validate (IBI_VALIDATE_ACTION)

Specifies the action to take if a URI-parameter validation test fails. The validation test is performed as a precaution against SQL injection and cross-site scripting attacks. Permitted values are:

• Log Only. WebFOCUS allows the request but logs the validation failure in the drive:\ibi\WebFOCUS82\logs\websecurity.log file.
• Custom Enforcement and Log. (ENFORCE) WebFOCUS blocks the request, logs the failure in the drive:\ibi\WebFOCUS82\logs\websecurity.log file, and takes the action specified by IBI_Validate.Error_Response.
• Default Enforcement and Log. (XMLENFORCE) WebFOCUS blocks the request, logs the failure in the drive:\ibi\WebFOCUS82\logs\websecurity.log file, and returns a descriptive XML response with an HTTP status code of 200 (success). This is the default and recommended setting.

Custom Response (IBI_VALIDATE_ERROR_RESPONSE)

Specifies the HTTP response code to return to the browser when URI-parameter validation has failed and IBI_Validate.Action is set to ENFORCE. Permitted values are any valid HTTP status code (such as 400 or 403), a URI, or a fully qualified URL. If an HTTP status code is entered, WebFOCUS returns a response header with the status code. If a URL or URI is entered, WebFOCUS returns 200 (success) and redirects the browser to the specified address. The default value is 400.

Response Header (IBI_VALIDATE_RESPONSE_HEADER)

For diagnostic purposes only. If True, returns an HTTP response header to the browser specifying the URLs that failed validation and the reason for their failure. The default value is False.