Skip Headers
Oracle® Retail Predictive Application Server Administration Guide for the Fusion Client
Release 14.1
E59119-01
  Go To Table Of Contents
Contents

Previous
Previous
 
Next
Next
 

C Appendix: Fusion Client Properties Files

Several properties files are located in the config folder of the Fusion Client installation. The majority of these files should not be altered. However, you can alter the "rpasConfig.properties File", "PivotTableStyles.properties File", "GraphConfig.xml File", and "cdtConfig.properties File" files. This appendix contains the following sections:

Editing Property Files

To edit these files, complete the following steps:

  1. Navigate to the following location in the RPAS Fusion Client installation directory:

    <RPAS_Fusion_Client_Installation>/config/rpas/
    
  2. Open the file with a text editor and edit the relevant parameters.

  3. Save and close the file.

  4. For the changes to take effect, restart the WebLogic server.

rpasConfig.properties File

Use the rpasConfig.properties file to alter the look and feel of the Fusion Client.

The first two settings (Cell Data Caching Block Size Properties and PivotTable Fetch Size Properties) affect the responsiveness of the workbook from the point of view of the user.

Larger settings result in a bigger block of data being loaded. As a result, the workbook is slower to open and is slower when refreshing. However, the user can scroll further before a refresh operation is required. Smaller settings ensure that the workbook loads more quickly, but a refresh operation must occur more frequently as the user scrolls.

There is no single optimum setting for these values. Requirements change from implementation to implementation, depending on the expected size of the pivot table that users work with.

  • Cell Data Caching Block Size Properties: The block size is set to be 33% more than the maximum table size in each dimension. The default setting accommodates 22 columns and 35 rows, which is typical for a 1280x1024 screen. This default setting ensures that the pivot table fetches no more than one block of cell values when refreshed, and at the same time allows for some nearby scrolling without causing a server fetch. Set the values to be the same as the values for the pivottable.fetch.columns and pivottable.fetch.rows properties.


    Note:

    If there is a fixed number of rows or columns, and you want to allow the users to freely scroll in that direction without causing a server fetch, you may want to adjust the default settings. The relevant row or columns property may be set to that value. However, this may significantly increase load and refresh times.

    As mentioned above, if you change the pivottable.fetch.column and pivottable.fetch.rows properties, ensure you set the celldatacache properties to be same as the former. The values shown are the defaults.

    • celldatacache.fetch.columns=30

    • celldatacache.fetch.rows=47

    • celldatacache.enabled=true


      Note:

      These values are not used if the block.celldata.fetch.and.cache.strategy property is set to false in the Internal Configuration section.

  • PivotTable Fetch Size Properties: Set these properties to match your largest pivot table fetch size, which is the best block size that the middle tier fetches from RPAS. (See the celldatacache.fetch property above.) In some cases, a smaller size provides better scrolling performance.

    You can adjust the following settings. The values shown below are the defaults.

    • pivottable.fetch.columns=30

    • pivottable.fetch.rows=47

    It is recommended that you set the Cell Data Caching Block Size Properties and PivotTable Fetch Size Properties to identical values. By setting the values in this manner, a single fetch from the pivot table (on the browser) to the application server matches a single fetch from RPAS.

  • Pivot Table Default Column Header Properties: Use these properties to configure the height and width of column headers. These sizes can override the autosize feature in the pivot table, allowing the administrator to set specific default sizes for headers that have not been sized by a user yet. The values provided for the properties are in pixel size.

    pivottable.default.col.header.row.height=-1
    pivottable.default.col.width=80 
    

    If you set the value to -1 or comment it out, the column typically resizes so that the text before the first white space is visible.

  • Pivot Table Default Row Header Properties: Use these properties to configure the height and width of row headers. These sizes can override the autosize feature in the pivot table, allowing the administrator to set specific default sizes for headers that have not been sized by a user yet. The values provided for the properties are in pixel size.

    pivottable.default.row.header.column.width=300
    pivottable.default.row.height=-1                                                
    

    If you set the value to -1 or comment it out, the column typically resizes so that the text before the first white space is visible.

  • Internal Configuration Property: Use this property to configure the cell data fetch and cache strategy. Set it to true to fetch and cache in fixed sized blocks the coordinates whose vertices are integer multiples of the block height (y-coord) and the block width (x-coord). Set to false to fetch blocks based on the displayed screen coordinates. All fetches retrieve only the data that is not already cached. The default setting is true.

    block.celldata.fetch.and.cache.strategy=false

  • XML Persistence Properties: Set the following properties as desired. The values shown below are the default.

    • xmlpersistence.enabled=false

    • serverloglevel=error

      This enables the RPAS Server logging levels. Logs are sent to the appropriate users' folder on the RPAS Server machine. The logs are named rpas_D<login_date_time>.

      Possible values are all, profile, debug, audit, information, warning, error, or none.

    • datacontrol.enabled=true

      This property is set to true to enable CDF DataControl. Do not change this value.

    • printexport.maximum.cells=200000

      If set to 0, it runs the export for all the cells but it may cause an out-of-memory error on the server.

    • insertmeasure.maximum.measures=10

      Limits how many measures can be inserted at once.

  • Real Time Alert Blocking Properties: These settings can be used to tune the how the real time alert hits are obtained from the server for the purpose of navigation and filtering. There are two settings for navigation and one for filtering.

    - real.time.alerts.max.block.size=1000

    When fetching real time alert hits for alert navigation, get at most this amount at a time from the server. Default value is 1000, minimum value is 2.

    - real.time.alerts.max.blocks.per.view=3

  • Number of blocks of real time alert hits (of the size above) to cache on a view for navigation purposes. Default value is 3, and minimum value is 1.

    - real.time.alerts.max.filter.block.size=10000

    When fetching real time alert hits for filtering a view, get at most this amount at a time from the server. Default value is 10000, and minimum value is 2.

  • Real Time Alert Count Display on the Tool Bar: For real time alerts, the count of the active alert is displayed on the toolbar. This setting defines the maximum width of the alert count on the toolbar before an overflow form is used instead. The overflow is defined via resourcesReal Time

    toolbar.alert.count.max.width=5

    This setting -1 = no limit, and 0 = do not show the count. Default is 5.

  • Restrict Size of Cell-based Operations: Extremely large selections can lead to memory problems in Cut, Copy, Paste, Fill, or Clear operations. This setting defines a limit.

    ccp.max.selection.size=10000

    Maximum selection size in number of cells. The default is 10000.

  • Valid Image Hosts: Users can specify a web URL as the location of an image. This can be dangerous if left unchecked. Users are only allowed to enter URLs from the hosts defined by this setting.

    valid.image.url.hosts=xyz.com

    List of valid hostnames should be separated by commas. Enter only hostname and not the http protocol. For example, xyz.com. Note that the hostname is not case sensitive.

  • Splash Screen Property: Use this property to alter the splash screen. Set this property to true if the splash screen should be displayed on a calculate function. Otherwise, set it to false. The default is true.

    splash.screen.on.calculate=true

  • Valid Image File Types Property: Use this property to specify the file type for images. Note that the file names are not case sensitive.

    valid.image.file.types=jpg,jpeg,png,gif

  • The Fusion Client pivot table displays only the "primary" image of a media measure or attribute value. This property defines the ID of the primary image:

    pivottable.default.header.image.id=main
    

    The default is "main". If there is no image in the value with this ID the first image is used.

  • When displaying an image, each place in the Fusion Client UI gets a URL for a specific size id in the data, by default "thumb" or "full". These properties define the size id requested for each UI location:

    pivottable.default.header.image.size.id=thumb
    detailpopup.default.browse.image.size.id=thumb
    detailpopup.default.selected.image.size.id=full
    viewimages.carousel.image.size.id=full
    

    The URLs loaded into media data for these size ids are expected to refer to image files appropriate for browser display at the dimensions defined below.

  • Each place in the Fusion Client UI that displays an image has a height and width defined that specifies the dimensions for displaying an image. This is used as the initial expected size for the image display, and also as the maximum height and width for the image. If the image fits in these dimensions, it will be displayed at the image's size. If the image is larger, it will be proportionally sized down to fit in these dimensions. Smaller images are not sized up.

    pivottable.default.header.image.height=100
    pivottable.default.header.image.width=100
    detailpopup.default.browse.image.height=100
    detailpopup.default.browse.image.width=100
    detailpopup.default.selected.image.height=400
    detailpopup.default.selected.image.width=400
    

    The default values are as shown above. Sizes larger than the default may cause layout issues in some situations.

  • Concurrent Session Property: Set this property to true if you want the Fusion Client to automatically create a new concurrent RPAS session. The default is false. When this property is set to false, users are asked if they want to create a new concurrent session or terminate the old session and create a new one.

    autocreate.concurrent.session=false

  • Custom Menu Character Length Property: Use this property to set the number of characters that the custom menu buttons should truncate to. The default is 20.

    custom.menu.number.of.characters=20

  • Title Bar Color Properties: Use these properties to set the color of the title bar in the selected or deselected window. You can specific colors by using hex color codes (EBF1F9) or by entering common HTML colors (white, black, red, and so on).

    • selected.window.background.color=EBF1F9

    • unselected.window.background.color=white

  • Expand Taskflow Property: Use this property to set the initial collapse or expand state of the taskflow after the first workbook is built or opened in a user session. The user's updates after login remain throughout the session.

    minimize.workbook.taskflow=false

  • Polling Frequency: Use this property to determine the polling frequency for the commit status on the workbook page. The time specified is in milliseconds. A shorter time means that the Fusion Client checks more frequently for an update on the commit status.

    commitStatus.polling.interval=3000

PivotTableStyles.properties File

The RPAS Fusion Client installs with the following default formatting styles for the cells that appear on the pivot table in the views:

  • Read-only cells: Cell with a light grey background.

  • Protected cells: Cell with a light grey background.

  • Edited cells: Text within the cell appear in italics with no background color.

You can change the default formatting styles (set a different background color or font style) using the PivotTableStyles.properties file. To change the default pivot table cell formatting styles, edit the following parameters

  • pivotTable.protected.style: Style for the protected cells in the pivot table.

  • pivotTable.unprotected.style: Style for the unprotected cells in the pivot table.

  • pivotTable.readonly.style: Style for the read-only cells in the pivot table.

  • pivotTable.edited.style: Style for the edited cells in the pivot table.

  • pivotTable.edited.text.style: Style for the edited text in a cell.

  • pivotTable.unedited.style: Style for the unedited text in a cell.

  • pivotTable.undefined.style: Style for the undefined cells.

  • pivotTable.ambiguous.char: Character to display when an ambiguous aggregation occurs.

To set a background color, specify background-color:<hexadecimal code for the color>;. For example, background-color:DDDDDD;.

To set a font style, specify font-style:<text-style>;. For example, font-style:italic;.

The Header text size is configurable; the default value is 150 characters.

The following properties define the default colors used by the Treemap chart for continuous and grouped subtypes:

  • treemap.default.color1=#00AA00

  • treemap.default.color2=#AA0000

The property treemap.default.color1 defines the default color associated with minimum value for the continuous subtype and the default color for Group 1 for the grouped subtype.

The property treemap.default.color2 defines the default color associated with maximum value for the continuous subtype and the default color for Group 2 for the grouped subtype.

GraphConfig.xml File

Use the GraphConfig.xml file to set default graph type and individual settings for each graph type.

Global Settings

In the graphGlobal section of the file, define the following properties:

  • defaultGraphType: Enter the name of the graphic that you want to be the default graph type.

  • highlighting: The default setting is highlight. Do not change this property.

  • animate: The default setting is animationOn. Do not change this property.

  • maxGroups: Enter the maximum number of groups. The value must be between 1 and 5000. The default is 100.

  • maxSeries: Enter the maximum number of series. The value must be between 1 and 5000. The default is 100.

  • maxIntersections: Enter the maximum number of intersections. The value must be between 1 and 25000. The default is 1000.


    Note:

    For MaxGroups, maxSeries, and maxIntersections, the default values are recommended. Setting these values to a larger value may impact performance.

Individual Graph Settings

You can also alter the properties of individual graph types. The individual graph properties are the same as the properties in the Global Settings section, but with one addition:

  • defaultGraphSubtype: Enter the graph type for each graph's subtype.

  • axisPaddingPct: This controls the percentage to scale the axis for bubble charts. The formula is amount to pad = (max value - min value) x axisPaddingPct/100.

  • axisAutoScaled: Turns auto scaling on for bubble charts.

cdtConfig.properties File

Use the cdtConfig.properties file to configure the CDT Editor for consumer decision trees. The following properties are available:

  • cdt.template.name: The template name for the CDT Editor workbook.

  • cdt.info.view.name: The name of the worksheet view that contains the CDT XML, user description, and isvalid status (CDT INFO).

  • cdt.info.xml.meas.name: The name of the measure that stores CDT as XML in the CDT INFO worksheet view.

  • cdt.info.desc.meas.name: The name of the measure that holds the user description in the CDT INFO worksheet view.

  • cdt.info.is.valid.meas.name: The name of the measure that indicates the validity of the version at a Category, Trading Area, and Consumer Segment intersection.

  • cdt.category.dimension.name: The name of the CDT dimension that contains Categories.

  • cdt.trading.area.dimension.name: The name of the CDT dimension that contains Trading Areas.

  • cdt.consumer.segment.dimension.name: The name of the CDT dimension that contains Consumer Segments.

  • cdt.attr.view.name: The name of the worksheet view that contains the attribute names and values information (ATTR).

  • cdt.attr.value.meas.name: The name of the measure that hold the attribute values for each SKU and attribute name in the ATTR worksheet view.

  • cdt.prod.attr.dimension.name: The name of the product attributes dimension that contains attribute-names.

  • cdt.approval.view.name: The name of the worksheet view that contains the Accept XML status for processing (APPROVAL).

  • cdt.accept.xml.measure.name: The name of the measure that indicates if any new or modified CDT XML has been processed (accepted) in the APPROVAL worksheet view.