Changing WebFOCUS Client Settings in the WebFOCUS Administration Console

The client configuration settings are grouped into categories under the Configuration menu in the WebFOCUS console. The term Initial Value next to a setting means that the value shown initially is the installation default value and that it can be overridden by setting the variable explicitly in the URL request.

Reporting Server Configuration Settings

The Reporting Server configuration settings are available from the Reporting Server tab of the Administration Console.

Reference: Server Node Properties

The Server Node properties defined in the Basic pane are explained below.

Basic

Node Name

The name cannot be the same as any other node name, and it cannot contain more than forty-eight (48) characters. When the client accesses this server, it will use this name.

Node Description

Optional. The description of the node that appears in the Configuration pane. If this is omitted, the node name will be used.

x
Host

The Host name or IP address of the Host Server.

TCP/IP Port

The Port number for the TCP listener. The default port is 8120.

HTTP(S) Port

The Port number for the HTTP listener. This is typically one port after the TCP/IP port.

The default HTTP port is 8121.

Security

The security options for the Server connection.

  • Prompt for Credentials. The Client makes an explicit connection to the Server with the user ID and password specified in the Web Security tab. This is the default value.
  • HTTP Basic. The user ID and password are extracted from the authorization header. These credentials are then used to make an explicit connection to the Server. You should only select this option when your web tier is performing Basic Authentication.

    Note: You can verify that the authorization header is available by selecting HTTP Request Info in the Diagnostics tab.

  • Kerberos. The Client passes a Kerberos ticket for the user to the Server, along with the user ID and group memberships assigned to that user. This option enables an end-to-end single sign on solution from the desktop to the Client, from the Client to the Server, and from the Server to supported relational DBMS systems. To use Kerberos authentication, the Server must run in security OPSYS mode.
  • SAP Ticket. The Client passes the user MYSAPSSO cookie, which is created on SAP Enterprise Portal, to the Server. The Server then validates the cookie using the SAP security API. This option enables single sign on from the Client to a Server configured with the Data Adapter for SAP for environments using Open Portal Services in SAP Enterprise Portal.
  • Service Account. Allows you to specify a user ID and password to be used for all connections to the Server.

    The service account credentials are encrypted and stored in the SECURITY keyword of the odin.cfg file. When defined, the service account overrides any other credentials that may be presented for this Server node, and all users connect to the Server using the same credentials. This approach does not make it possible to identify which user is running a given request on the Server in Managed Reporting deployments, and therefore is not recommended for them.

  • Trusted. Allows non-authentication requests to connect to the Server as trusted. After a user is authenticated through a pre-authentication mechanism or a Sign in page, all subsequent requests to the Server are trusted.

    To use this option, the Server Security Provider must also be configured to allow trusted connections, and controls should be placed on the Server to ensure that it rejects connections from unauthorized clients. For example, you should employ the Server RESTRICT_TO_IP setting or configure a network firewall so that only your specified clients can connect to the Server.

    When you create a new Client Configuration, the Trusted option is selected, by default, and the Pass TIBCO WebFOCUS User ID and their Groups and Custom options appear below it. When you accept the default option, Pass TIBCO WebFOCUS User ID and their Groups, the Client passes the ID and group memberships assigned to the user to WebFOCUS Server. When you select the Custom option, the display refreshes to show the User ID and the User's Groups check boxes allowing you to customize the user information passed to the server. The options TIBCO WebFOCUS script variable and HTTP Header Field appear under both check boxes, as shown in the following image.

    The Custom Option on the Client Configuration page, and the configuration of check boxes and settings beneath it. This option includes the USER ID check box with the default WebFOCUS script variable assignment, IBIMR_user, and the User’s Groups check box, with the default WebFOCUS script variable assignment, IBIMR_memberof.

    Under the User ID check box, the TIBCO WebFOCUS script variable option displays the IBIMR_user parameter, by default. Under the User's Groups check box, the TIBCO WebFOCUS script variable option displays the IBIMR_memberof parameter, by default. You can type over the default values in the TIBCO WebFOCUS script variable options, and type your own values in the HTTP Header Field options.

    Note: When configuring the Client to make trusted connections to the Server, you must also enable the Server to accept trusted connections.

Advanced

The Server Node properties from the Advanced pane are explained below.

Service Name

Contains a description for the Server node. This description displays to end users.

Use HTTPS

Enables encrypted communication between the Client and the Server HTTP listener. The default value is off (check box cleared).

This option must be selected if the Server HTTP listener is configured to use SSL. If you are using a self-signed certificate to enable HTTPS communication with a Server, the certificate must be configured in the Java environment where the Client is installed. This enables HTTPS communication between the Server and the Administration Console.

TLS

Enables data encryption when transmitting data over the internet to ensure data privacy. The default value is off (check box cleared).

When selected, the Compression and Encryption options are hidden because TLS encrypts and compresses the data, by default.

Compression

Enables data compression. By default, data compression is disabled.

Encryption

Sets data encryption ability and the symmetric cryptography method used.

Select one of the following options from the drop-down list:

  • 0. Off. This is the default value.
  • AES. Advanced Encryption Standard. The AES selections are in the format
    CIPHER(x)(-MODE)

    where:

    CIPHER

    Is AES128, AES192, AES256.

    x

    Is optional and defines an RSA key length of 1024 bits. When this is not specified, the RSA key is 512 bits.

    CBC

    Is optional and defines the use of Cipher Block Chaining (CBC) mode. When the mode is not specified, Electronic Code Book (ECB) is used.

    For example, AES256x-CBC is the AES256 cipher with a 1024-bit RSA key in CBC mode. AES128 is the AES128 cipher with a 512-bit RSA key in ECB mode.

Connect Limit

Specifies the number of seconds that the Client will hold the pending connection. Other possible values are 0 (no wait) and -1 (infinite wait). The default value is -1.

Maximum Wait

Specifies the time, in seconds, that the Client will wait before timeout. You can optionally specify different return times for the first row and other rows. A single number indicates that the return time is valid for any row. If two numbers are separated by a comma, the first number specifies the return time for the first row and the second number specifies the return time for the subsequent rows. The default value is -1, which indicates an infinite wait time.

Security Object

For any security option, an administrator can specify one or more HTTP header names and/or cookie names as follows:

  • Cookie. Specify each HTTP cookie name separated by a comma (,). For example:
    cookie_name1, cookie_name2
  • Header. Specify each HTTP header name separated by a comma (,). For example:
    header_name1, header_name2

Note:

  • HTTP cookie and header names must not contain commas (,) or colons (:). These are reserved delimiters.
  • REMOTE_USER is a special type of HTTP header variable whose contents will not be sent to the Server. Therefore, it is not a valid HTTP header value. Instead, specify the WF_REMOTE_USER variable.

Basic Cluster Manager Configuration Properties

Node Name

Is the host name or IP address of the server.

Node Description

Optional. The description of the node that appears in the Configuration pane. If this is omitted, the node name will be used.

Remote CLM Host

Is the Host name or IP address of the Cluster Manager on which a remote Cluster Manager (CLM) is listening. If more than one address is specified, one of the addresses will be randomly selected until a successful connection to the CLM happens. The number of IP addresses defined in this setting must be the same as the number of port numbers defined in Remote CLM Port. Separate multiple host names or IP addresses with a comma.

Remote CLM Port

Is the UDP number of the Port on which the Cluster Manger server is listening. The default port is 8200. If more than one port number is specified, the number of port numbers must be the same as the number of IP addresses defined in Remote CLM Host. Separate multiple host names or IP addresses with a comma.

Security

The security options for the Server cluster.

  • Prompt for Credentials. The Client makes an explicit connection to the Cluster Manager with the user ID and password specified in the Web Security tab. This is the default value.
  • HTTP Basic. The user ID and password are extracted from the authorization header. These credentials are then used to make an explicit connection to the Cluster Manager. You should only select this option when your web tier is performing Basic Authentication.

    Note: You can verify that the authorization header is available in by selecting HTTP Request Info in the Diagnostics tab.

  • Kerberos. The Client passes a Kerberos ticket for the user to the Cluster Manager, along with the user ID and group memberships assigned to that user. This option enables an end-to-end single sign on solution from the desktop to the Client, from the Client to the Cluster Manager, and from the Cluster Manager to supported relational DBMS systems. To use Kerberos authentication, the Cluster Manager must run in security OPSYS mode.
  • SAP Ticket. The Client passes the user MYSAPSSO cookie, which is created on SAP Enterprise Portal, to the Cluster Manager. The Cluster Manager then validates the cookie using the SAP security API. This option enables single sign on from the Client to a Cluster Manager configured with the Data Adapter for SAP for environments using Open Portal Services in SAP Enterprise Portal.
  • Service Account. Allows you to specify a user ID and password to be used for all connections to the Cluster Manager.

    The service account credentials are encrypted and stored in the SECURITY keyword of the odin.cfg file. When defined, the service account overrides any other credentials that may be presented for this Cluster Manager node, and all users connect to the Cluster Manager using the same credentials. This approach does not make it possible to identify which user is running a given request on the Cluster Manager in Managed Reporting deployments, and therefore is not recommended for them.

  • Trusted. Allows you to connect to the Cluster Manager with only a user ID. This option is useful when no password is available for the user. Controls should be placed on the Cluster Manager to ensure that connections from unauthorized clients are rejected. For example, you can employ the Cluster Manager RESTRICT_TO_IP setting or configure a network firewall so that only a particular client can connect to the Cluster Manager.

    When you create a new Cluster Manager Configuration, the Trusted option is selected, by default, and the Pass TIBCO WebFOCUS User ID and their Groups, and Custom options appear below it.

    When you accept the default option, Pass TIBCO WebFOCUS User ID and their Groups, the Client passes the ID and group memberships assigned to the user to the WebFOCUS Server. When you select the Custom option, additional settings appear and you can customize the user information sent from the Client to the WebFOCUS Server.

    Note: When configuring the Client to make trusted connections to the Server, you must also enable the Cluster Manager to accept trusted connections.

Advanced Cluster Manager Configuration Properties

Use HTTPS

Enables encrypted communication between the Client and the HTTP listener.

The default value is off.

This option must be selected if the Cluster Manager HTTP listener is configured to use SSL. If you are using a self-signed certificate to enable HTTPS communication with a Cluster Manager , the certificate must be configured in the Java environment where the WebFOCUS Client is installed. This enables HTTPS communication between the Cluster Manager and the Administration Console.

Compression

Enables data compression. By default, data compression is disabled.

Encryption

Sets data encryption ability and the symmetric cryptography method used.

Select one of the following options from the drop-down list:

  • 0. Off. This is the default value.
  • AES. Advanced Encryption Standard. The AES selections are in the format
    CIPHER(x)(-MODE)

    where:

    CIPHER

    Is AES128, AES192, AES256.

    x

    Is optional and defines an RSA key length of 1024 bits. When this is not specified, the RSA key is 512 bits.

    CBC

    Is optional and defines the use of Cipher Block Chaining (CBC) mode. When the mode is not specified, Electronic Code Book (ECB) is used.

    For example, AES256x-CBC is the AES256 cipher with a 1024-bit RSA key in CBC mode. AES128 is the AES128 cipher with a 512-bit RSA key in ECB mode.

  • IBCRYPT. User-defined IBCRYPT DLL is loaded.
Connect Limit

Specifies the number of seconds that the Client will hold the pending connection. This is useful in a cluster deployment to avoid a lengthy delay of failover response. Other possible values are 0 (no wait) and -1 (infinite wait). The default value is -1.

Maximum Wait

Specifies the time, in seconds, that the Client will wait before timeout. You can optionally specify different return times for the first row and other rows. A single number indicates the return time is valid for any row. If two numbers are separated by a comma, the first number specifies the return time for the first row and the second number specifies the return time for the subsequent rows. The default value is -1, which indicates an infinite wait time.

Security Object

For any security option, an administrator can specify one or more HTTP header names or cookie names as follows:

  • Cookie. Specify each HTTP cookie name separated by a comma (,). For example:

    cookie_name1, cookie_name2

  • Header. Specify each HTTP header name separated by a comma (,). For example:

    header_name1, header_name2

Note:

  • HTTP cookie and header names must not contain commas (,) or colons (:). These are reserved delimiters.
  • REMOTE_USER is a special type of HTTP header variable whose contents will not be sent to the Server. Therefore, it is not a valid HTTP header value. Instead, specify the WF_REMOTE_USER variable.

Reference: Reporting Server Node Security Options

The security options from the Client Configuration pane are explained below.

x
Prompt for Credentials

WebFOCUS makes an explicit connection to the Reporting Server with the user ID and password specified in the Web Security tab. This is the default value.

HTTP Basic

WebFOCUS extracts the user ID and password from the authorization header. These credentials are then used to make an explicit connection to the Reporting Server. You should only select this option when your web tier is performing Basic Authentication.

Note: You can verify that the authorization header is available in by selecting HTTP Request Info in the Diagnostics tab.

Kerberos

WebFOCUS passes a Kerberos ticket for the user to the Reporting Server. This option enables an end-to-end single sign on solution from the desktop to WebFOCUS, from WebFOCUS to the Reporting Server, and from the Reporting Server to supported relational DBMS systems. To use Kerberos authentication, the Reporting Server must run in security OPSYS mode.

For more information about additional setup requirements for Kerberos, see BAD XREF HERE "Configuring Kerberos for Single Sign On.

SAP Ticket

WebFOCUS passes the user MYSAPSSO cookie, which is created on SAP Enterprise Portal, to the Reporting Server. The Reporting Server then validates the cookie using the SAP security API. This option enables single sign on from WebFOCUS to a Reporting Server configured with the Data Adapter for SAP for environments using Open Portal Services in SAP Enterprise Portal.

Service Account

Allows you to specify a user ID and password to be used for all connections to the Reporting Server.

The service account credentials are encrypted and stored in the SECURITY keyword of the odin.cfg file. When defined, the service account overrides any other credentials that may be presented to WebFOCUS for this Reporting Server node, and all users connect to the Reporting Server using the same credentials. This approach does not make it possible to identify which user is running a given request on the Reporting Server in Managed Reporting deployments, and therefore is not recommended for them.

Trusted

Allows you to connect to the Reporting Server with only a user ID. This option is useful when no password is available for the user. Controls should be placed on the Server to ensure that connections from unauthorized clients are rejected. For example, you can employ the Reporting Server RESTRICT_TO_IP setting or configure a network firewall so that only a particular client can connect to the Server.

Note: When configuring the WebFOCUS Client to make trusted connections to the Reporting Server, you must also enable the Reporting Server to accept trusted connections.

Reference: Cluster Manager Configuration

Remote CLM Host

Is the Host name or IP address of the Cluster Manager server.

Remote CLM Port

Is the Port number for the TCP listener of the Cluster Manger server. The default port is 8200.

TIBCO WebFOCUS Designer Properties

Settings on the Designer Properties page of the Administration Console determine the display and use of features in WebFOCUS Designer. To open this page, in the Administration Console, scroll down to the bottom of the Configuration tab menu, and then select Designer Properties.

Reference: Understanding WebFOCUS Designer Properties

Administrators can use the settings on the Designer Properties page to specify default values assigned to WebFOCUS Designer settings.

If the Allow User Override check box is selected for an option, users can change the value assigned to the setting by the administrator.

Data Preview Method

Sets the default action for whether charts and reports are previewed by using sample data, actual live data from the data source, or dummy test data. Valid values for the Data Preview Method setting are Sample, Live, and Test. The default value is Live.

If the Allow User Override check box is selected for this option, users can change the value assigned to the setting by the administrator in WebFOCUS Designer.

Record Limit

Sets the default maximum number of rows retrieved from the data source when the design-time preview is created. This feature is useful in reducing response time if users are working with a large amount of data. The Record Limit setting does not affect the chart or report output at run time. Valid values for the Record Limit setting are 100, 500, 1000, 5000, 10000, and All rows. The default value is 500 rows.

If the Allow User Override check box is selected for this option, users can change the value assigned to the setting by the administrator in WebFOCUS Designer.

This setting is unavailable if Test is selected as the Data Preview Method.

Enforce Limit

Sets the default action that determines whether the record limit must be applied to the data source before or after creating a design-time preview. This setting is used only if Live is selected as the Data Preview Method. Valid values for the Enforce Limit setting are At the Source and Post Retrieval. If At the Source is selected as the Enforce Limit value, then the record limit is applied to the data source before the design-time preview is generated. If Post Retrieval is selected as the Enforce Limit value, then the record limit is applied to the data source after the design-time preview is generated. The default value is Post Retrieval.

If the Allow User Override check box is selected for this option, users can change the value assigned to the setting by the administrator in WebFOCUS Designer.

InfoAssist Properties

Settings in the InfoAssist Properties page of the Administration Console determine the display and use of features in the InfoAssist tool that opens when creating or updating content.

To open the InfoAssist Properties page, in the Administration Console, scroll down to the bottom of the Configuration tab menu, and then click InfoAssist Properties. You can then enable or disable options for the InfoAssist tool.

Reference: Understanding InfoAssist Home Tab Properties

x

VaThe InfoAssist Home tab enables you to control the most commonly used properties and options from the Home tab. These properties are:

Use Live Preview Mode

Determines whether InfoAssist opens in the Live Preview mode or the Query Design View, by default. When Yes is selected, InfoAssist opens in the Live Preview mode as the default. When Yes is not selected, InfoAssist starts with the Query Design View. If the Allow User Override check box is selected for this option, users can change the setting specified by the administrator.

Record Limit

Enables the Record Limit menu of the Home tab. If Show is not selected, the Record Limit menu is removed from the InfoAssist interface.

Themes

Provides InfoAssist users with various color-coded StyleSheet themes that can be used to style reports and charts. Users can select standard themes, or select customized cascading style sheet themes created by your organization.

Page Heading

Enables the Header & Footer menu of the Home tab. This menu can be used to add a heading or footing to each page of the report output.

Report Heading

Enables the Header & Footer menu of the Home tab. This menu can be used to add a heading or footing to the first page of the report output.

Reference: Understanding InfoAssist Format Tab Properties

x

For reports or charts, InfoAssist displays a list of output file format options, such as HTML, PDF, or Excel, in the Format Group of the Home tab. Other options that make additional layouts and display features available when creating a report or chart appear on the Format tab itself. You can control the display of both types of options through the settings contained in this section.

Note: Settings in this section do not affect the display of Format tab features for visualizations.

PDF Analytic Document Format

Enables the use of the PDF Analytic Document Format in InfoAssist. This format adds the portability and interactive enhancements of In-Document Analytics to PDF reports. The resulting output is designed for offline analysis and includes all of the data and JavaScript tools required to support analytic operations such as filtering, sorting, and charting in a self-contained report.

When this check box is selected, this format is available as an option in the Output File Format list that opens from the Format group of the InfoAssist Home Page ribbon. It is also available for selection as a default output format from the Report Output Format list, the Chart Output Format list, and the Document Output Format list in the Tool Options Dialog Defaults section of the InfoAssist Properties page.

This check box is cleared, by default.

HTML Analytic Document Format

Enables the use of the HTML Analytic Document Format in InfoAssist. This format adds the portability and interactive enhancements of In-Document Analytics to HTML reports. The resulting output is designed for offline analysis and includes all of the data and JavaScript tools required to support analytic operations such as filtering, sorting, and charting in a self-contained report.

When this check box is selected, this format is available as an option in the Output File Format list that opens from the Format group of the InfoAssist Home Page ribbon. It is also available for selection as a default output format from the Report Output Format list, the Chart Output Format list, and the Document Output Format list in the Tool Options Dialog Defaults section of the InfoAssist Properties page

This check box is selected, by default.

Additional HTML Formats for Chart

Enables the use of the PNG, JPEG, GIF, and SVG output formats. The default value is PNG. PNG is not available as a format for chart output.

Additional PDF Formats for Chart

Enables the use of the PDF/SVG and PDF/GIF output formats. The default value is PDF/SVG.

Excel 2000 Format

Enables the use of the Excel 2000 spreadsheet output format. The Excel 2000 format supports most StyleSheet attributes, allowing for full report formatting. The computer on which the report displays must have Microsoft Excel 2000 installed.

When this check box is selected, this output format option is available for use when selected from the Output Format drop-down menus in the Tool Options Dialog Defaults section.

This check box is selected, by default.

Excel 2000 Formula

Enables the use of the Excel 2000 formulas when the Excel 2000 Format option is selected.

This check box is selected, by default.

x
Excel 2007 Format

Enables the use of the Excel 2007 spreadsheet output format. The computer on which the report displays must have Microsoft Excel 2007 installed.

When this check box is selected, this output format option is available for use when selected from the Output Format drop-down menus in the Tool Options Dialog Defaults section of the InfoAssist Properties page.

This check box is selected, by default.x

Excel 2007 Formula

Enables the use of the Excel 2007 formulas when the Excel 2007 Format check box is selected.

This check box is selected, by default.

Excel Pivot

Enables the use of the Excel 2000 PivotTable output format. PivotTable is an Excel tool for analyzing complex data.

This check box is not selected, by default.

Excel CSV

Enables the use of the comma separated values (CSV) file format.

When this check box is selected, the Excel CSV format option is available for use in InfoAssist, and it appears on the Home tab in the Format group options list under the Excel format option. When it is cleared, this option is not available, and it does not appear in the Format group options list.

This check box is selected, by default.

HTML Format

Enables the use of the HTML page report format.

When this check box is selected, this output format option is available for use when selected from the Output Format drop-down menus in the Tool Options Dialog Defaults section of the InfoAssist Properties page.

InfoMini Run Immediate

If Enable is selected, reports run immediately when InfoMini first launches. This setting is enabled, by default.

Other Chart Types

Allows the creation of more complex graph output types, such as spectral maps, gauge charts, and Pareto charts.

Pages on Demand

Enables the display of report output one page at a time. Users can use the navigation menu at the bottom of the output screen to view each page. This option is activated only when HTML or active report output format is selected.

PDF Format

Enables the use of the PDF report format.

When this check box is selected, this output format option is available for use when selected from the Output Format drop-down menus in the Tool Options Dialog Defaults section of the InfoAssist Properties page.

PowerPoint 2000 Format

Enables the use of the PowerPoint® 2000 document output format. The computer on which the report appears must have Microsoft PowerPoint 2000 or higher installed.

When this check box is selected, this output format option is available for use when selected from the Output Format drop-down menus in the Tool Options Dialog Defaults section of the InfoAssist Properties page.

PowerPoint 2007 Format

Enables the use of the PowerPoint® 2007 document output format. The computer on which the report appears must have Microsoft PowerPoint 2007 or higher installed.

When this check box is selected, this output format option is available for use when selected from the Output Format drop-down menus in the Tool Options Dialog Defaults section of the InfoAssist Properties page.

Stack Measures

Displays all numeric measure field names in the first column of the report output, with the corresponding numeric data values displayed across time in a column for each selected time period. The Stack Measures feature is activated only when HTML, Excel, or PowerPoint output format is selected.

User Selection

Allows users to change the output type of their reports at run time.

Reference: Understanding InfoAssist View Tab Properties

x

Enables InfoAssist users to customize the view of different report components in the InfoAssist tool, such as the design mode, output location, and data view. You can configure the following properties in the InfoAssist View tab:

Display View Tab

Enables the View tab and all of its menu options. If this is not selected, the View tab is removed from the InfoAssist interface.

Data Panel

Allows the user to customize Data Panel settings. Values are Logical (default), List, and Structured.

Query Panel

Allows the user to customize the view of the query components, such as Filters, Column and Row labels, and Measures when building a report. Values are Tree (default), Area 2x2 (2 columns by 2 rows), Area 1x4 (1 column by 4 rows). If the Allow User Override check box is selected for this option, users can change the setting specified by the administrator.

Reference: Understanding InfoAssist Tool Options Dialog Defaults Properties

x

Settings in the Tool Options Dialog Default section enable administrators to specify default tool settings. If the Allow User Override check box is selected for an option, users can change the setting specified by the administrator. However, the administrator cannot specify a default value that has already been disabled in one of the other groups. For example, if you have disabled the PDF Analytic Document Format option in the Format Tab section, you will receive an error message if you attempt to set that format as a default Report, Chart, or Document Output Format in the Tools Options Dialog Defaults section.

Report Output Format

Sets the default format for reports. Valid values are HTML, HTML Analytic Document, PDF, PDF Analytic Document, EXL07, EXL2K, PowerPoint 2000, and PowerPoint 2007. The format options in this list are available only when their corresponding check box is selected in the Format Tab section of the InfoAssist Properties page. If that check box is cleared, you receive a message warning you that the format option is not enabled when you select it from this list. The default value is HTML.

Chart Output Format

Sets the default format for charts. Valid values are HTML, HTML5, HTML Analytic Document, PDF, PDF Analytic Document, EXL07, EXL2K, PowerPoint 2000, and PowerPoint 2007. The format options in this list are available only when their corresponding check box is selected in the Format Tab section of the InfoAssist Properties page. If that check box is cleared, you will receive a message warning you that the format option is not enabled when you select it from this list. The default value is HTML5.

Document Output Format

Sets the default format for documents that are generated in InfoAssist. Valid values are HTML, HTML Analytic Document, PDF, PDF Analytic Document, EXL07, EXL2K, PowerPoint 2000, and PowerPoint 2007. The format options in this list are available only when their corresponding check box is selected in the Format Tab section of the InfoAssist Properties page. If that check box is cleared, you will receive a message warning you that the format option is not enabled when you select it from this list. The default value is HTML Analytic Document.

Page Orientation

Sets the default page orientation for reports and charts. Valid values are Portrait and Landscape. The default value is Landscape. If the Allow User Override check box is selected for this option, users can change the setting specified by the administrator.

Page Size

Sets the default page size for reports and charts. Valid values are A3, A4, A5, Letter, Tabloid, Legal, PPT-SLIDE, and Large Size. The default value is Letter. If the Allow User Override check box is selected for this option, users can change the setting specified by the administrator.

Data Preview Method

Sets the default action for whether reports are previewed using sample data or actual data from the data source. Valid values are Live and Sample. The default value is Live. If the Allow User Override check box is selected for this option, users can change the setting specified by the administrator.

Record Limit

Sets the default maximum number of rows retrieved from the data source when Interactive Design view is selected. This feature is useful in reducing response time if users are working with a large amount of data. It is applicable only when developing the report. The record limit setting will not affect the report output at run time. Valid values are, All, 1, 10, 50, 100, 500, 1000, 2000, 5000, 10000 rows. The default value is 500 rows. If the Allow User Override check box is selected for this option, users can change the setting specified by the administrator.

Output Target

Sets the default location for reports and charts. Valid values are Single tab, New tab, Single window, and New window. The default value is Single tab. If the Allow User Override check box is selected for this option, users can change the setting specified by the administrator.

In-Document Analytics

Sets the default value for the In-Document Analytics setting in the Procedure Settings dialog box, which opens from the InfoAssist Quick Access toolbar. Valid values are Designer Style and Legacy. In the InfoAssist Properties page setting, the Designer Style value is selected, by default.

The value assigned to this setting determines the default interface for InfoAssist to use when running reports, charts, and documents based on the HTML Analytic Document format. When users create new HTML Analytic reports, charts, and documents in InfoAssist, they can override the default value established in the InfoAssist Properties page setting by selecting an alternative option from the In-Document Analytics setting that appears in the Procedure Settings dialog box.

InfoAssist/Portal StyleSheet

Sets the StyleSheet to be used for InfoAssist and the Portal. Click Change Stylesheet to open the Browse predefined template files window. The value displayed, by default, is Warm.sty.

If the Allow User Override check box is selected for this option, users can change the setting specified by the administrator.

Visualization StyleSheet

Sets the StyleSheet to be used when creating visualizations. Click Change Stylesheet to open the Browse predefined template files window. The value displayed, by default, is Warm.sty.

If the Allow User Override check box is selected for this option, users can change the setting specified by the administrator.

Encode HTML

Encodes script tags within data, so that the tags are replaced and not executable in a browser. The default value is Yes. This includes the ON TABLE SET HTMLENCODE ON command in the procedure.

Enable Pages On Demand

Allows InfoAssist users to view report output one page at a time. The user can use the navigation menu at the bottom of the output screen to view each page. This option is activated only when HTML or active report output format is selected.

Rows retrieved from cache

Establishes how many rows of cached data stored in a binary file are returned to the output window at one time. The default value is 100 rows.

HTML Freeze Height

Determines how the Freeze option, located on the Format tab in the Navigation group of the InfoAssist ribbon, automatically freezes the height of a report area.

If the AutoFit value is assigned to this setting, reports produced when the Freeze option is selected automatically fit the height of the window or pane in which they appear. This is the default value.

If the Fixed value is assigned to this setting, reports produced when the Freeze option is selected are set automatically to a fixed height of four inches, regardless of the size of the window or pane in which they appear.

HTML Accordion

Determines whether the Accordion option, located on the Format tab in the Navigation group of the InfoAssist ribbon, displays accordion reports that automatically resize data to fit the container in which they appear.

If the AutoFit value is assigned to this setting, reports produced when the Accordion option is selected automatically resize the display of data to fit the size of the container in which they appear, and automatically adjust column widths based on the size of the largest data value or column title. This is the default value.

If the legacy value is assigned to this setting, reports produced when the Accordion option is selected do not automatically resize the display of data to fit the size of the container in which they appear, and do not automatically adjust column widths.

x

Enabling the Cache Through Global Preferences

In InfoAssist, the cache option enables you to send only the first page of report output using the Analytic Document Format to the browser and retrieve subsequent pages from a temporary cache on the WebFOCUS Server. You can enable the cache locally through the Advanced tab of the Analytic Document Options dialog box in InfoAssist. You can enable the cache option globally by configuring the relevant InfoAssist Properties settings in the WebFOCUS Administration Console. For more information about the impact of these settings on InfoAssist, see the Using the Cache Option section of the TIBCO WebFOCUS® InfoAssist User's Manual.

Procedure: How to Enable the Cache Through InfoAssist Properties

You can globally enable the cache for InfoAssist by using settings in the Administration Console, as described in the following steps:

  1. Open the Administration Console.
  2. On the Configuration tab, click InfoAssist Properties.
  3. On the InfoAssist Properties page, under the Tool Options Dialog Defaults section:
    1. Select the Yes checkbox, in the Enable Pages On Demand setting.
    2. Accept the default value of 100 in the Rows retrieved from cache setting, or type an alternative value that conforms to your requirements.
  4. At the bottom of the page, click Save.
  5. When you receive a message that the changes were saved successfully, click OK.

Procedure: How to Validate the Cache Configuration

You can confirm that InfoAssist uses the global settings you configure in the Administration Console, as described in the following steps:

  1. Open InfoAssist to create a new report or edit an existing report.
  2. On the Home tab, in the Format group, click the Output File Format list, and then click HTML Analytic Document or PDF Analytic Document.
  3. Click the Format tab.
  4. In the Navigation group, confirm that the Pages on Demand option is highlighted.
  5. In the Features group, click Analytic Document Options.
  6. In the Analytic Document Options dialog box, click Advanced.
  7. Compare the value in the Rows Retrieved field to the value you accepted or typed in the Rows retrieved from cache setting in the Administration Console.

    If the two values are a match, the Administration Console configuration update was a success. If they do not match, review your configuration of the Administration Console setting.

Reference: Understanding InfoAssist File Options

Determines which of the following file types can be selected by InfoAssist users when creating and saving HOLD files:

Binary

Stores report or chart data as binary numbers in numeric fields. Binary files use the extension (*.ftm).

FOCUS

Stores report or chart data as text in a segment structure that conforms to FOCUS database requirements. FOCUS files use the extension (*.foc).

Comma Delimited with Titles

Stores report or chart data as text in sequence by field. Alphanumeric fields are enclosed in quotation marks. Fields are separated by commas and are preceded by Field Names. Comma Delimited with Titles files use the extension (*.csv) (Comma Separated Values).

Plain Text

Stores report or chart data as text in sequence by field without delimiters or field names. Plain Text files use the extension (*.ftm).

Tab Delimited

Stores report or chart data as text in sequence by field. Fields are separated by tab characters. Tab Delimited files use the extension (*.tab).

Tab Delimited with Titles

Stores report or chart data as text in sequence by field. Fields are separated by tab characters, and are preceded with field names. Tab Delimited with Titles files use the extension (*.tab).

Database Table

Stores report or chart data as text in a field structure that conforms to a Structured Query Language (SQL) Database format. Database Table files use the extension (*.sql).

Database Table output is only available when working against an SQL database.

Hyperstage

Stores report or chart data as text in a field structure that conforms to the Hyperstage database table format. Hyperstage files use the extension (*.bht).

Hyperstage output is only available when the WebFOCUS Server has a Hyperstage adapter configuration.

SQL script

Stores report or chart data as text in a sequential field structure that can be imported into a database table that conforms to the Structured Query Language (SQL) Database format. SQL Script files use the extension (*.sql).

SQL Script output is only available when working against an SQL database.

XML

Stores report or chart data as text in a field structure that conforms to the rules of the Extensible Markup Language. Fields are separated by tags that identify content. XML files use the extension (*.xml).

JSON

Stores report or chart data as text in a structure that conforms to the rules of JavaScript Object Notations. JSON files use the extension (*.json).

Reference: Understanding InfoAssist Chart Type Options

Leaflet Maps

Enables the icons required for the use of Leaflet maps in both chart and visualization mode of InfoAssist. The two Leaflet map icons enable you to select either a Choropleth or a Proportional Symbol (Bubble) map based on the Leaflet open-source JavaScript library for mobile-friendly interactive maps.

In chart mode, these icons are available in the Select a chart dialog box. To open this dialog box, click Other on the Format tab, in the Chart Types group. In the Select a chart dialog box, click Map.

In visualization mode, these icons are available in the Select a Visual dialog box. To open this dialog box, click Change on the Home tab, in the Visual group.

If this setting is not selected, Leaflet map icons do not appear in either location. The default value is selected.

Reference: Understanding InfoAssist Auto Drill Properties

Settings in this section enable the use of drill-down navigation options, which are part of the Auto Drill functionality.

Single Click Navigate

Enables the use of single click navigation, which is an automatic drill down to the next level of a dimension within the body of a report or chart made in response to a single click on a top-level entry or feature.

By default, this check box is not selected, meaning that single click navigation is disabled, and top-level Auto Drill entries or features display the Drilldown menu in response to a single click. If this check box is selected, single click navigation is enabled, and instead of displaying the Drilldown menu, top-level Auto Drill entries or features automatically refresh the report or chart with results based on the next lower level of your selected dimension in response to a single click.

Breadcrumbs

Enables the display of a breadcrumb trail at the top of an Auto Drill report or chart.

By default, this check box is selected, and Auto Drill reports and charts display a breadcrumb trail. If this check box is cleared, Auto Drill reports and charts do not display a breadcrumb trail.

In an Auto Drill report or chart, a breadcrumb trail displays a series of links to previous versions that were generated as you drilled through each level of your selected dimension to reach the version currently on display.

Restore Original

Enables the display of the Restore Original option in the Drilldown menu.

By default, this check box is selected, and the Restore Original option appears in the Drilldown menu. If this check box is cleared, the Restore Original option does not appear in the Drilldown menu.

In an Auto Drill report or chart, the Restore Original option returns you directly to the original version.

Drill Up

Enables the display of the Drill up option in the Drilldown menu.

By default, this check box is selected, and the Drill up option appears in the Drilldown menu. If this check box is cleared, the Drill up option does not appear in the Drilldown menu.

In an Auto Drill report or chart, the selection of the Drill up option refreshes the display with results based on the next level above the current level of your selected dimension.

Drill Down

Enables the display of the Drill down option in the Drilldown menu.

By default, this check box is selected, and the Drill down option appears in the Drilldown menu. If this check box is cleared, the Drill down option does not appear in the Drilldown menu.

In an Auto Drill report or chart, the selection of the Drill down option refreshes the display with results based on the next level below the current level of your selected dimension.

Note: In addition to disabling the Drill down option, clearing this setting also removes hyperlinks from top level report entries and the breadcrumb trail display from reports and charts. If the Single Click Navigate setting is also cleared, clearing the Drill Down setting effectively disables Auto Drill navigation tools in reports and charts that contain only the top level of a dimension value in their design. If the Single Click Navigate setting is selected, and the report or chart contains entries below the top level, clearing the Drill Down setting shifts the Single Click Navigation feature to those lower-level entries. However, because this setting also suppresses the display of the Drilldown menu, users will neither be able to restore the original version of the report or chart, nor will they be able to drill back up to a higher level.

Reference: Understanding InfoAssist Miscellaneous Options

x
Use two-part file name

If selected, this option requires the use of two-part file names, which specify the path to the Master File location. If not selected, a one-part file name must be used instead. The default value is selected.

Expand Data Source Tree

Determines whether the initial view of the data source tree is expanded or collapsed. If selected, the tree is expanded. If not selected, the tree is collapsed. The default value is selected.

Join Tool

Displays the Join menu option on the InfoAssist Data tab. If not selected, the Join menu option is removed from the Data tab. The default value is selected.

Layout Tab

Enables the Layout tab in the InfoAssist ribbon. If not selected, the Layout tab is removed from the InfoAssist ribbon. The default value is selected.

Series Tab

Enables the Series tab in the InfoAssist ribbon. The Series tab displays when working with charts and visualizations. It provides access to charting properties and options in the Properties, Line, and Pie menus. If not selected, the Series tab is removed from the InfoAssist ribbon. The default value is selected.

Enable Path Enforcement

Establishes the default condition of the Enforce Paths container The Enforce Paths container. that appears at the top of the Data pane of the Resources panel in the InfoAssist Application Window.

When you move a field from the Data pane into a field container on the Query pane, path enforcement automatically limits the display of available fields in the Data Source Tree to those with valid logical connections, based on their multi-path relationships, to the field that moved into the field container.

When this check box is cleared, the default value for this setting, the Enforce Paths container is not enabled, by default. Under this condition, the display of available fields in the Data Source Tree does not change when users move a field into a field container in the Query pane. Within the InfoAssist session, users can click the Enforce Paths container to enable path enforcement.

When this check box is selected, the Enforce Paths container is enabled, by default. Under this condition, fields in the Data Source Tree with no logical connection to a field moved into a field container in the Query pane are dimmed and unavailable. Within the InfoAssist session, users can click the Enforce Paths container to disable path enforcement.

Note: When you save a new procedure, the current condition of the Enforce Paths container is saved with the procedure. When you re-open the procedure in the InfoAssist Application Window, the condition of the Enforce Paths container is established by the value stored in the procedure instead of the value assigned to the Enable Path Enforcement setting.

InfoAssist Basic Properties

When your installation is only licensed for InfoAssist Basic, the InfoAssist Properties are limited to the following settings:

Format Tab
  • Additional HTML Formats for Chart
  • Additional PDF Formats for Chart
  • Excel 2000 Format
  • Excel 2000 Formula
  • Excel 2007 Format
  • Excel 2007 Formula
  • Excel Pivot
Auto Drill
  • Single Click Navigate
  • Breadcrumbs
  • Restore Original
  • Drill Up
  • Drill Down
Miscellaneous
  • Use two-part file name