Contents

Title and Copyright Information

Send Us Your Comments

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Customer Support
• Review Patch Documentation
• Improved Process for Oracle Retail Documentation Corrections
• Oracle Retail Documentation on the Oracle Technology Network
• Conventions

1 Introduction

• Basic RPAS Concepts
  • Multidimensionality
  • Dimensions
  • Measures
  • Domains and Workbooks
    • Measure Data
• Overview of the RPAS Fusion Client
  • Terminology Differences Between Clients
• Administrative Workbooks and Wizards
• Hybrid Storage Architecture
• A Note about RPAS Configurability and Extensibility

2 Building and Upgrading Domains

• Building a Domain
  • Prerequisites
  • Client-Side Procedures
    • Zip the Configuration Project Folder
  • Server-Side Procedures
    • Unzip the Configuration File
    • Verify the Environment Variable Settings
    • Preparing the Input Files
• Building the Domain Manually or Through the Command-Line Interface
  • rpasInstall
    • rpasInstall Usage
  • Validate Domain Build Results
• After Building the Domain
  • Upgrading and Patching Domains
  • Upgrading From Any Release of RPAS Prior to 13.3
  • Domain Conversion
    • Domain Preparation Before Conversion
    • Setting up Domain Conversion Parameters
    • Running the Domain Conversion
    • Post-Conversion Processing
  • Upgrading From RPAS 13.3 or Later
  • Updating Domain Content
    • Hierarchies
    • Measure Properties
    • Rule Groups
    • Workbooks
  • RPAS 14.0 Cryptography Upgrades
  • Upgrade Configurations
    • Command-Line Support for Configuration Upgrading
    • Upgrade Application Configurations
  • convertDomain
    • convertDomain Usage
  • convertDomain -suggestDimBitSize
    • Usage for -suggestDimBitSize
  • upgradeDomain
    • upgradeDomain Usage
• fixDomain
  • fixDomain Usage

3 Domain Administration

• DomainDaemon
  • DomainDaemon Usage
  • Starting the DomainDaemon
  • Monitoring the DomainDaemon
  • Stopping the DomainDaemon
• Losing a Client-Server Connection
  • Graceful Termination of the Existing Session
  • Autosaved Workbooks

4 SSL

• Introduction
• Setting Up SSL
• Two-Way SSL
  • Configuring the RPAS Server
    • Setting Up the Key Store
    • Setting Up a Fusion Client Trust Store
    • Importing the Client Certificates
    • Starting the Domain Daemon
  • Configuring the Fusion Client
    • Setting Us a Key Store and a Trust Store
    • Importing the Client Certificates
• Two-Way SSL with Authentication Only
• Creating SSL Certificates Automatically

5 Setting Up the RPAS Fusion Client

• Maintaining Layout and Formatting
• Setting Up the Configuration Properties File
  • Latency
  • Other Properties Files
    • Files in the Config Folder
    • Files in the Config/rpas Folder
  • Updating the Session Reminder
  • Configuring Announcements
• Configuring Additional Domains
  • Sample Foundation.xml
• Logging into the Fusion Client

6 User Maintenance

• User Administration Activity
  • Adding a User
  • Adding a User Group
  • Deleting a User
  • Deleting a User Group
  • Editing a User
• Managing Users Using usermgr
  • usermgr Usage
  • XML Schema
  • Use Cases
    • Exporting from an Existing Domain
    • Importing into a Domain
    • Converting Between XML and Database

7 Single Sign-On

• SSO Authentication
  • Identity Assertion
  • Fetching Roles and Groups
  • Security Provider Order
• Manually Configuring SSO Within the Fusion Client

8 System Administration

• Auto Workbook Maintenance Wizard
  • Adding a Workbook to the Auto Build Queue
  • Deleting a Workbook from the Auto Build Queue
  • Editing a Workbook in the Auto Build Queue
• Workbook Batch Category Management
  • Workbook Batch Category Management Wizard
  • Adding a Category
  • Deleting a Category
  • Changing a Category Label
• Hierarchy Maintenance Workbook
  • Hierarchy Maintenance Example
  • Hierarchy Maintenance Wizard
  • Hierarchy Maintenance View
  • Maintaining a User-Defined Dimension Within a Hierarchy
• Security Administration Workbook
  • Security Overview
    • User and Group Security
    • Measure Level Security
    • Position Level Security
    • Workbook Security
  • Security Administration Workbook
    • Workbook Template Rights View
    • Workbook Template Measure Rights View
    • Measure Rights View
    • Dimension Modification Rights View
    • Position Level Security Views
    • Workbook Template Limits Views
    • Max Domain Session Limit View
    • Max User Session Limit View
  • Using the Security Administration Workbook
    • Accessing Security Administration
    • Setting or Modifying Users' Access to Workbook Templates
    • Setting Measure Availability for Workbook Templates
    • Assigning or Restricting User Access to Measures
    • Changing a User's Ability to Modify Dimensions
    • Setting or Modifying Access to Positions (if Position Level Security has been Enabled)
    • Limiting the Number of Workbooks that a User Can Save
    • Limiting the Number of Workbooks Per Template
    • Limiting the Number of Workbooks that a Group Can Save
• Measure Analysis Workbook
  • Measure Analysis View
  • Accessing Measure Analysis
  • Reviewing and Editing Sales or Other Registered Measure Data

9 Hierarchy Management

• Introduction
• Loading Hierarchies Using loadHier
  • loadHier Usage
  • loadHier Notes
  • Position Label Translation
• Integer Indexing
  • Changing the Bit Size
• Reindexing Domains Using reindexDomain
  • reindexDomain Usage
    • ReindexDomain Option: Analysis
    • ReindexDomain Option: Domain Properties
  • When to Reindex
    • Run Reports
  • How to Reindex a Dimension
    • Reindex Entire Domain as Needed
    • Reindex Entire Domain with Force Option
    • Reindex Dimensions
    • Prepending Calendar Dimensions
  • Reindex Domain Examples
    • Condition 1: Change of Bit Size
    • Condition 2: Using the -force Option
    • Condition 3: Fragmentation Checks
• Optimizing Domains Using optimizeDomain
  • optimizeDomain Usage
    • Examples
• Adding New Dimensions to Hierarchies
  • Exporting Measure Data
  • Exporting Hierarchy Data
  • Purging Hierarchy Data
  • Adding New Dimensions
  • Reloading Formal Hierarchy Data
  • Informalizing DPM Positions
  • Reloading Measure Data
  • Adding New Hierarchy Dimensions Sample Script
  • Transferring Data
    • Masks
    • transferData Usage
    • Scenarios
• FilterHier Utility
  • filterHier Usage
  • Notes
  • Error Conditions
• Position Repartitioning
  • Loading RDF and Curve Parameters after Repartitioning
    • Syntax
• Reconfiguring the Partitions of a Global Domain Using reconfigGlobalDomainPartitions
  • reconfigGlobalDomainPartitions Usage
  • Using an Input File
  • Notes, Assumptions, and Limitations
• Renaming Positions Using renamePositions
  • renamePositions Usage
• Managing Dimension Attributes Using dattrmgr
  • dattrmgr Usage
  • dattrmgr -report Examples
• Setting Properties for Dimensions Using dimensionMgr
  • Changing the Label of a Dimension
  • dimensionMgr Usage
• Exporting Hierarchy Data Using exportHier
  • exportHier Usage
• Informal Position Manager
  • InformalPositionMgr Usage
  • Basic Operations: Informalize, Formalize, and Remove
    • Error Handling
  • Creating Informal Positions in Bulk
    • Example 1: Creating Informal Positions on the STYL Dimension
    • Example 2: Creating Informal Positions on the SZ12 Dimension
    • Position Naming Convention
  • Data Slice Copying
    • Merging Informal Positions to Formal Positions
• Managing Position Lists as PQDs Using pqdMgr
  • pqdMgr Usage
  • pqdMgr Notes

10 Data Management

• Loading Measure Data Using loadmeasure
  • Load File Names and Load Behavior
  • Loading Multiple Measures from One File
    • CSV Files
    • Fixed Width Files
  • Loading Data from Below the Base Intersection of the Measures
  • Staging Measure Loads
  • Running Pre-Load or Post-Load Scripts
  • Purging Old Measure Data
  • Behavior in a Global Domain Environment
  • Behavior in an Integrated Environment
  • loadmeasure Usage
  • Loading Image Paths for Positions
• Exporting Measure Data Using exportMeasure
  • exportMeasure Usage
• Exporting Measure Data Using exportData
  • exportData Usage
    • The -useLoadFormat Parameter
• Mapping Data Between Domains Using mapData
  • mapData Usage
• Moving Data between Arrays Using updateArray
  • updateArray Usage
• Scan Domain Data Using scanDomain
  • scanDomain Usage
• Repair Domain Metadata Using fixDomain
• Sync Measure NA Value with Array NA Value Using syncNAValue
  • syncNAValue Usage

11 Operational Utilities

• Finding Alerts Using alertmgr
  • alertmgr Usage
• Copying Domains Using copyDomain
  • copyDomain Usage
    • copyDomain: Format of the XML Configuration File
• Moving a Domain Using moveDomain
  • moveDomain Usage
    • moveDomain: Format of the XML Configuration File
    • Assumptions and Requirements
    • Minimum Space Requirement
• Setting Miscellaneous Domain Properties Using domainprop
  • domainprop Usage
    • Available Properties
• Calculation Engine Using mace
  • mace Usage
  • mace Restrictions in Global Domains
  • Executing mace in an Integrated Environment
• Managing the Workbook Batch Queue Using wbbatch
  • wbbatch Usage
• Workbook Manager with wbmgr
  • wbmgr Usage
• Registering Measures Using regmeasure
  • regmeasure Usage
• Registering Token Measures Using regTokenMeasure
  • regTokenMeasure Usage
• Batch Plug-In Tasks: execPluginTask.sh
  • execPluginTask.sh usage

12 Informational Utilities

• Retrieving Domain Information Using domaininfo
  • domaininfo Usage
• Checking the Validity of a Domain Using checkDomain
  • checkDomain Usage
• Determining RPAS Server Version Using rpasversion
  • rpasversion Usage
• List Contents of a Database Using listDb
  • listDb Usage
• Printing Data from Arrays Using printArray
  • printArray Usage
• Printing Data from Measures Using printMeasure
  • printMeasure Usage

13 Internationalization

• Translation
• Translation Administration
  • Translation Administration Workbook
    • Hierarchy Labels View
    • Dimension Labels View
    • Workbook Template Group Labels View
    • Workbook Template Labels View
    • Measure Labels View
    • Measure Descriptions View
    • User Group Labels View
    • Message Labels View
    • RGRP Labels View
• Taskflow Components Configuration

14 Commit as Soon as Possible

• Managing the Workbook Queue Using showWorkbookQueues
  • showWorkbookQueues Usage
• Commit ASAP Settings Using configCommitAsap
  • configCommitAsap Usage
  • Logging and Technical Information

15 Batch Processes and RPAS Utilities

• CSV File Format
• RPAS Utilities Logging Options
  • Log Levels
  • Utilities with Standard Logging
    • Scripts
  • Utilities with Multi-Process Logging
  • Utilities with Special Logging
  • Utilities and Database Locks
• Using Shell Scripts to Run Batch Processes
  • A Sample Shell Script
• Common Information and Parameters for RPAS Utilities
  • Configuration Tools Log Files
• RPAS Intraday Enabler
  • ride Usage
  • Scenarios
    • Scenario 1
    • Scenario 2
    • Scenario 3
    • Scenario 4
    • Scenario 5
    • Scenario 6
  • Domain Lock Status Using domainStatus
    • domainStatus Usage

16 RPAS ODBC/JDBC Driver

• ODBC Configuration
  • Defining the ODBC Server Configuration Settings
    • Add RPAS ODBC Manager in the Management Console
    • Configure Using the ODBC Manager
    • Import the Configuration Changes
  • Defining the ODBC Client Configuration for Windows
• Starting the RPAS ODBC Server Process
  • Testing the Connection Using Interactive SQL
• ODBC Client Configuration for UNIX
  • Client Configuration
  • Testing the Connection
• Installing and Using the RPAS JDBC Driver
  • Updating Environment Variables for the JDBC Driver on Windows
  • Updating Environment Variables for JDBC Driver on UNIX/Linux
  • Using the RPAS JDBC Driver
  • Enabling Spy for RPAS JDBC Driver
  • Using the jdbcisql Utility Provided with RPAS JDBC Driver
  • Using Oracle SQL Developer
  • Using Oracle JDeveloper
  • Using a Java Program
    • Running the Program
• Data Query
  • Limitations
    • Contention
    • Workbook Queries
  • Metadata
  • Fact and Dimension Tables
• Measure Security in the ODBC Driver
• Use Cases
  • Using Metadata Tables to Explore the Structure of a Domain or a Workbook
  • Querying Fact Data
  • Connecting to a Workbook
  • Requesting Additional Aggregate Tables
• Clients
  • Oracle Business Intelligence Enterprise Edition (OBIEE)
    • Configuring the ODBC Client for OBIEE
    • Connecting OBIEE to an RPAS Domain
  • Microsoft Access
  • JDeveloper
  • XML Publisher
  • Interactive SQL (ISQL) Utility
• Supported and Unsupported SQL Functions
  • Supported SQL Functions
    • Numeric Functions
    • String Functions
    • Time and Date Functions
    • System Functions
    • Aggregate Functions
    • Other Functions
  • Unsupported SQL Functions
    • Handling of NULLS
    • Schema Information
    • Data Definition Language (DDL)
    • Insert
    • SELECT Syntax
    • Value Expressions
    • Value Functions
    • Date and Time Functions
    • Advanced Value Expressions
    • Row Value Constructor
    • Predicates
    • Join Operators

17 Publishing Measure Change Events

• Configuring Subjects and Measures for Monitoring
• Configuring the RPAS JMS Publisher
  • Command Line
  • Configuration Settings
    • General Settings
    • Vendor-Specific Settings
    • File-Based JNDI Object Store
    • LDAP-Based JNDI Object Store
• Configuring the RPAS JMS Subscriber
  • Command Line
  • Configuration Settings

18 Guided Launch

• Launching the RPAS Fusion Client
  • Issuing a Launch Request from a Web Page
    • User Authentication
    • Deploying Guided Launch
    • Use Cases
  • RPAS Guided Launch Format
    • Workbook Settings
    • XML Schema
  • Open Workbook
    • Specifications
    • Examples
  • Building a Workbook
    • Specifications
    • Example
  • buildWorkbookContext Utility
    • Command Line Usage

19 Hybrid Storage Architecture

• Data Model
  • Naming Convention
  • Dimension-Fact Entity Relationship Diagram
    • Sample Integration Configuration
    • Sample ERD for Dimension and Fact Tables
  • Table Descriptions
    • RPAS Metadata Tables
    • Commit Metadata Tables
    • Dimension-Based Tables
    • Translation Table
    • Index Translation Table
    • Fact Tables
    • Temporary and Logging Tables
  • Schema Partitioning
    • Dimension and Fact Table Partitioning
    • ITT Table Partitioning
  • Sequence Descriptions
  • Package Descriptions
  • Access Schema Descriptions
  • Security Considerations
  • External Integration
    • Setup
    • Execution
• Configuring the RPAS Data Mart
  • RDM Repository
    • Directory Structure
  • RDM Properties in a Domain
  • Schema Information
  • Integration Configuration
    • Shared Hierarchies
    • Shared Facts
    • Integration Map
    • Domain and Configuration Map
    • Example
  • Partition Information
  • RDM SSL Connection
    • SSL Overview
    • Set Up SSL on Oracle Server
• RPAS HSA Build Process
  • RPAS Installation Utilities
    • RDM Preparation Script
    • RPAS Installer
    • RDM Manager
  • Pre-Installation – Preparing the Integration Environment
  • Installation – Building the RDM Schemas
  • Post-Installation – Initialization and Registration
    • Load Dimension Data
    • Register Participating Domains
    • Load Shared Fact Data
• Operating and Maintaining the RPAS Data Mart
  • upgradeRDM
    • Usage
  • patchRDM
    • Usage
  • loadDimData
    • Flat File Format
    • Filtered Shared Levels
    • Validation of Input Data
    • Usage
  • loadFactData
    • Input File Format
    • Input Files Location
    • Input File Naming
    • Input Data Validation
    • Data Loading Modes
    • Logging
    • Usage
  • transferFactData
    • Usage
  • checkRdm
    • Usage
• RDM Partitioning and RDM Partition Manager
  • Determining the RDM Partition Level
  • Mapping Local Domains to RDM Partitions
  • RDM Schema Partitioning
  • RDM Partition Manager
    • Usage
    • The Format of RDM Partition Configuration
  • Initial RDM Partitioning
  • Patching RDM and Integrating One or More New Domains
  • Hierarchy Operations Affecting RDM Partitioning
    • Dimension Data Loading in RDM and Domain
    • Domain Reclassification
    • Dynamic Position Maintenance
  • Coordinating RDM Partitioning Using the RDM Status Table
    • Status: loadHier in Progress
    • Status: reconfigGlobalDomainPartitions in Progress
    • Status: loadDimData in Progress
    • Status: Repartition in Progress
    • Status: Repartition Recommended
• Coordination of Domain Processes in an Integrated Environment
  • Recommended Process Sequencing
  • Parallel Execution of Processes
  • RDM Status Tables
  • RDM Status Messages
    • RDM is Missing Positions
    • Repartition Recommended
  • RDM Status Utility
    • Usage of rdmStatus Utility
• RPAS HSA Translation
  • Flat File Requirements
    • Dimension Label Flat File
    • Level Label Flat File
    • Fact Label and Description Flat Files
    • Position Label Flat Files
  • Source Language
  • loadTranslation
    • Input Files
    • loadTranslation Utility

20 OBIEE Reports

• Overview
• Report Setup
  • Configuring Access Control in OBIEE
    • Adding the Impersonator User
    • Add RPAS Users to OBIEE
  • Configuring an OBIEE Connection
• Report Configuration
  • Report Metadata Extractor Utility
  • Editing reportConfig.xml
  • Example Procedure
    • Generate reportConfig.xml
    • Edit reportConfig.xml

21 Images

• Overview
• Images
• XML Fragments
• CSV File
• Utilities
  • prepareMediaData.sh
  • validateMediaData.sh

A Appendix: Curve Administration Guide

• curvevalidate
  • curvevalidate Usage
• curvebatch
  • curvebatch Usage

B Appendix: RPAS Test Automation

• Introduction
• Usage
• Writing Test Cases
• Example
• Output
• Schema
  • 1. Top-Level Parent Tag
    • 1.1 testscript
    • 1.2 testsuite
    • 1.3 testcase
    • 1.4 once
    • 1.5 finalize
    • 1.6 setup
    • 1.7 teardown
    • 1.8 log
    • Sample Usage
  • 2. Generic Tags
    • 2.1 Attribute
    • 2.2 Description
    • 2.3 Fail
    • 2.4 key
    • 2.5 rpas-today
    • 2.6 shell
    • 2.7 register-measure
    • 2.8 unregister-measure
  • 3. Domain Operation Tags
    • 3.1 Assertions
    • 3.2 Domain Data Edit Operations
  • 4. Workbook Operation Tags
    • 4.1 Workbook Wizard Operations
    • 4.2 Workbook Operations
    • 4.3 Workbook Assertions
    • 4.4 Workbook Data Edit Operations
  • 5. Dynamic Position Maintenance (DPM) Tags
    • 5.1 Assertions
    • 5.2 Update Informal Position Operation
    • 5.3 Delete Informal Position Operation
  • 6. HSA Tags
    • 6.1 assert-fact-group
    • 6.2 assert-fact-table
    • 6.3 assert-fact-value-eq
    • 6.4 assert-fact-value-ge
    • 6.5 assert-fact-value-gt
    • 6.6 assert-fact-value-le
    • 6.7 assert-fact-value-lt
    • 6.8 assert-fact-value-ne
    • 6.9 assert-level-contain
    • 6.10 clear-rdm-status
    • 6.11 set-rdm-status
    • 6.12 set-fact-value
    • 6.13 reset-seq-generator
    • 6.14 assert-rdm-hier-exists
    • 6.15 assert-level-exists

C Appendix: Fusion Client Properties Files

• Editing Property Files
• rpasConfig.properties File
• PivotTableStyles.properties File
• GraphConfig.xml File
  • Global Settings
  • Individual Graph Settings
• cdtConfig.properties File

D Appendix: Environment Variables

• Required Settings
• Database Settings
  • RPAS_ARRAY_TAG
  • RPAS_CACHE
  • RPAS_PAGE_SIZE
  • RPAS_PAGE_SPLIT_PERCENTAGE
  • RPAS_LOCK_TIMEOUT
  • RPAS_REQUEST_TIMEOUT
  • RPAS_USER_MODE
• Java Special Expression Settings
  • RPAS_JAVA_CLASSPATH
  • RPAS_JAVA_DEBUG_PORT
  • RPAS_JAVA_MAXHEAPSIZE
• Log Settings
  • RPAS_CACHE_LM_MULTIPILER / RPAS_DISABLE_LM_DIRECT
  • RPAS_CLIENT_TIMEOUT / RPAS_SERVER_TIMEOUT
  • RPAS_COMMIT_FAILED_MAX / RPAS_COMMIT_SUCCESS_MAX
  • RPAS_JAVA_MAXHEAPSIZE
  • RPAS_LOCK_DETAIL_PATH
  • RPAS_LOCK_LOGGING
  • RPAS_LOCK_LOG_PATH
  • RPAS_LOCK_TRACK_DATABASES
  • RPAS_LOCK_ACCESS_LIMIT
  • RPAS_LOG_BACKUPS
  • RPAS_LOG_FD
  • RPAS_LOG_FLUSH
  • RPAS_LOG_LEVEL
  • RPAS_LOG_PATH
  • RPAS_REQUEST_TIMEOUT
  • RPAS_SHELL
  • RPAS_SPLIT_BUF_MB
  • RPAS_STATS_PATH
  • RPAS_TCPNODELAY
  • RPAS_TRACE_SSL
  • TMPDIR
  • TODAY_RETEK
• Parallelization Settings
  • RPAS_EXPORT_MEASURES_MAX
  • RPAS_MIN_MEAS_PER_PROC
  • RPAS_PROCESSES
• Profiling Logging
  • RPAS_PROFILING_ENABLE
  • RPAS_PROFILING_PATH
• Date and Time Setting
  • RPAS_TODAY
  • RPAS_TODAY_STATIC
• Numeric Precision
  • RPAS_INCAGGPRC
  • epsilon
• RPAS_SSL_WALLET
• LDR_CNTRL=NAMEDSHLIB=RPASZONE
• Nagle's Algorithm

E Appendix: RPAS Diagnostic Tool

• Diagnostic Tool Description
  • Using Recorder
  • Using Replayer
    • Configuring Realplayer for Use
    • Replayer Use
  • Using the Transaction Log as Data Store
  • Working with Oracle Support
• Design
  • Data Stored in Log File
  • Replay
• Replaying - Real Time Scenarios
  • Example 1: Percent of Parent Measure Creation Error
  • Example 2: Dimension Exception When Overwriting Level Split on Dimension
  • Example 3: Performance Issues