hyperion system 9 bi+ release 9.2 addendum - oracle · running background or foreground jobs ......

H Y P E R I O N ® S Y S T E M ™ 9 B I + ™

R E L E A S E 9 . 2

A D D E N D U M

P / N : D A 9 0 6 9 2 0 0 0

Copyright 1989-2006 Hyperion Solutions Corporation.All rights reserved.

“Hyperion,” the Hyperion logo, and Hyperion’s product names are trademarks of Hyperion. References to other companies and their products use trademarks owned by the respective companies and are for reference purpose only.

No portion hereof may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose other than the recipient’s personal use, without the express written permission of Hyperion.

The information contained herein is subject to change without notice. Hyperion shall not be liable for errors contained herein or consequential damages in connection with the furnishing, performance, or use hereof.

Any Hyperion software described herein is licensed exclusively subject to the conditions set forth in the Hyperion license agreement.

Use, duplication or disclosure by the U.S. Government is subject to restrictions set forth in the applicable Hyperion license agreement and as provided in DFARS 227.7202-1(a) and 227.7202-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (Oct 1988), FAR 12.212(a) (1995), FAR 52.227-19, or FAR 52.227-14, as applicable.

Hyperion Solutions Corporation5450 Great America ParkwaySanta Clara, California 95054

Printed in the U.S.A.

Contents iii

Contents

CHAPTER 1 System-Wide Enhancements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

User Defined Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Briottbl.txt Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

User Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Briottbl.txt File Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Server.xml and Custom User Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

JSPResources.properties and Resource files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

User Interface Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Setting the User Interface Language in Interactive Reporting Studio and Interactive Reporting Web Client (Offline Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Setting the User Interface Language for Interactive Reporting Jobs in Hyperion System 9 BI+ Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

User Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Running Background or Foreground Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Import Wizard Restructured . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Startup Parameter for Common Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Unicode Enabled Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Interactive Reporting Sort Order Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Encoding Interactive Reporting Database Connection Files . . . . . . . . . . . . . . . . . . . . . . . . 17

Interactive Reporting Application Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Unicode Migration Utility for Interactive Reporting Documents and Database Connection Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Unicode File Path Handling on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Unicode Compliant Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Unicode Font Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Unicode Compliant Font Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

File Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

File Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Database Connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Oracle SQL*Net Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

DataDirect Oracle Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

OLE DB Provider for Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Data Access Service ODBC Driver Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Data Access Service and Large Buffer Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

iv Contents

Informix Connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Open Client Connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Red Brick Connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Teradata Connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

National Strings for MS SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Bidirectional Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Understanding Bidirectional Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Bidirectional Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Row-level Security JOINOPER Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

CHAPTER 2 Workspace Administration Enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Hyperion Interactive Reporting Services Availability and Jobs . . . . . . . . . . . . . . . . . . . . . . . . . 30

Configuring Hyperion Interactive Reporting Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Determining When Job Request Maximum Limit is Reached . . . . . . . . . . . . . . . . . . . . . . 32

Process Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Job Service Exclusions for Interactive Reporting Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Default Open Interactive Reporting Document Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Production Reporting Dynamic Property Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

SAP Provider Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

SQL Batching for Keywords and Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Third-Party Software Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Impact Management Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Service Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

UTC Offset Option In Task Status Interactive Reporting Document . . . . . . . . . . . . . . . . 34

Compatible Replacement Data Model and Document Character Sets . . . . . . . . . . . . . . . 34

Workspace Desktop No Longer Available . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Interactive Reporting Job Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Job Queuing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Scheduled Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Background Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Foreground Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Disabling Job Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Job Limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Triggering Events (for Developers) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

CHAPTER 3 Financial Reporting Enhancements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

XBRL Setup and Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

XBRL Line Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Text as a XBRL Fact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

XBRL Footnotes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

XBRL Tuples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

XBRL Upgrade Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Changes to Prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Contents v

Merging of Equivalent Prompts Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Database Lookup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

CHAPTER 4 Interactive Reporting Enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Text Wrapping in Chart Legends . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Auto-Sizing Chart Legend Borders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Auto-Arranging Pie Chart Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Flywheel Mouse in Interactive Reporting Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Related Content Handling in Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Password Encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Increasing the Idle Connection Time-outs for the Interactive Reporting Web Client . . . . . . . 45

Dashboards and Object Model Enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

UnicodeEnabled (Property) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

SortOrderLang (Property) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

DefaultSortOrderLang (Property) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

UILanguage (Property) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

ResetDefaultSortOrderLang (Method) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Export (Method) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

ExportToStream (Method) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

ImportDataFile (Method) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

ImportSQLFile (Method) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Printout (Method) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Object Model Exclusion List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Dashboard Development Services Enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Unicode Enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Select User Interface Font and Language Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Lookup Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Accessing Multiple Point of View Embedded Browsers with Option Buttons . . . . . . . . . . 77

Diagnostics Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Language Properties Configuration Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Make Suggestion Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Quick Filters Text Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Export Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Date Formats Configuration Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Configuration Frame Navigation Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

CHAPTER 5 Production Reporting Enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

SAP BW Variable Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Localization of Production Reporting DDO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Additional Language Support for the HTML Navigation Bar . . . . . . . . . . . . . . . . . . . . . . . . . . 86

vi Contents

CHAPTER 6 SAP BW Enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Support for SAP Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

About SAP Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Variables and Processing Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Variable Type Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

VariableValue Text Function (Financial Reporting Only) . . . . . . . . . . . . . . . . . . . . . . . . . 90

Support for SAP Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

SAP Security Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Support for Key Figure Creation (Web Analysis Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

System-Wide Enhancements 5

C h a p t e r

1System-Wide Enhancements

This chapter describes the general changes and enhancements made to Hyperion System 9 BI+ Release 9.2.

In This Chapter User Defined Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

User Interface Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

User Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Running Background or Foreground Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Import Wizard Restructured . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Startup Parameter for Common Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Unicode Enabled Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

National Strings for MS SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Bidirectional Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Row-level Security JOINOPER Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

6 System-Wide Enhancements

User Defined LanguagesPrevious versions of Hyperion System 9 BI+ binaries supported a limited set of out-of-box user interface languages, but some of them did not have corresponding translation files. You could use one of the pre-defined user interface languages, but were unable to select other user interface languages.

In Release 9.2, any Interactive Reporting Sort Order Language (also known as Interactive Reporting document language) can be used as a user interface language. Dynamic loading of the user defined briottbl.txt translation files is also supported.

Table 1 shows user defined supported languages and includes the following columns:

● UI Language Name—Name of the language on the UI.

● Built in—Whether the corresponding user interface language is built into the installation and has the corresponding briottbl.txt translation file (except for English).

● Subdirectory Name—A subdirectory that can be searched in the Translation directory.

● Briottbl.txt header—A language name that must be present in the header of the corresponding briottbl.txt translation file. If the column contains several items, then any of the listed names can be used. Character case is ignored. For example, you could type: “simpchinese”, “SimpChinese” or “SIMPCHINESE”.

Table 1 User-Defined User Interface Languages

UI Language Name Built in Subdirectory Name Briottbl.txt Header

Afrikaans Afrikaans Afrikaans

Albanian Albanian Albanian

Arabic Arabic Arabic

Basque Basque Basque

Catalan Catalan Catalan

Chinese (Simplified) Yes Chinese SimpChinese

Chinese (Simplified)

Chinese (Traditional) Yes Chinesetrad TradChinese

Chinese (Traditional)

Croatian Croatian Croatian

Czech Czech Czech

Danish Danish Danish

Dutch Dutch Dutch

English Yes English English

English (UK) EnglishUK UKEnglish

Estonian Estonian Estonian

Finnish Finnish Finnish

User Defined Languages 7

French Yes French French

German Yes German German

Greek Greek Greek

Hebrew Hebrew Hebrew

Hungarian Hungarian Hungarian

Icelandic Icelandic Icelandic

Indonesian Indonesian Indonesian

Italian Yes Italian Italian

Japanese Yes Japanese Japanese

Korean Yes Korean Korean

Latvian Latvian Latvian

Lithuanian Lithuanian Lithuanian

Macedonian Macedonian Macedonian

Malay Malay Malay

Norwegian (Bokmal) NorwegianBokmal NorwegianBokmalNorwegian (Bokmal)

Norwegian (Nynorsk) NorwegianNynorsk NorwegianNynorsk Norwegian (Nynorsk)

Polish Polish Polish

Portuguese Yes Portuguese Portuguese

Romanian Romanian Romanian

Russian Russian Russian

Serbian (Cyrillic) SerbianCyrillic Serbian (Cyrillic)

Serbian (Latin) SerbianLatin Serbian (Latin)

Slovak Slovak Slovak

Slovenian Slovenian Slovenian

Spanish Yes Spanish Spanish

Swedish Swedish Swedish

Thai Thai Thai

Turkish Yes Turkish Turkish

Ukrainian Yes Ukrainian Ukrainian

Vietnamese Vietnamese Vietnamese

Table 1 User-Defined User Interface Languages (Continued)

UI Language Name Built in Subdirectory Name Briottbl.txt Header


➤ To configure a user interface language supported by the Hyperion System 9 BI+ binaries but not installed automatically:

1 Create an appropriate briottbl.txt translation file and place it in the corresponding subdirectory.

2 Select the user interface language (see “User Interface Language” on page 11).

Briottbl.txt FilesThe Hyperion System 9 BI+ binaries expect to find briottbl.txt files in the corresponding language dependant subdirectories of the Translations directory.

Figure 1 Translation Directory Structure

Example If you have an Arabic briottbl.txt translation file and need to configure an Arabic user interfacelanguage:

1. Verify the structure of the briottbl.txt to be configured. The header must contain the correct user interface language string identifier (in this case, Arabic).

2. Create an Arabic subdirectory in the Translations directory and copy the briottbl.txt file into it.

Table 2 Translation Directories for Binaries

Binary Location

BIService/Das <BaseDirectory>\..\lib\msgs\Translations (for example, D:\hps_83_340\lib\msgs)

where <BaseDirectory> is a directory specified by way of the –basedir parameter.

This default value can be overridden by the TRANSLATIONS_DIR setting in the server.xml file.

Interactive Reporting Studio/Interactive Reporting Web Client

<StdAppPath>\Translations

where <StdAppPath> is a directory from which the binary is inititated.

Chinesebriottbl.txt

Chinesetradbriottbl.txt

Frenchbriottbl.txt

Germanbriottbl.txt

Italianbriottbl.txt

Japanesebriottbl.txt

Koreanbriottbl.txt

Portuguesebriottbl.txt

Spanishbriottbl.txt

Translations

User Defined Languages 9

After completing the steps above, the Translations directory might look like:

User PreferencesThe UILanguage property of the corresponding User Preferences defines the user interface language used by the Release 9.2 binaries to translate user interface messages. The value of this property must be chosen from the UI language name column. As a rule, unknown values are ignored and the default user interface language is used instead.

To add this property through the user interface, see “User Interface Language” on page 11.

Depending on the application, the UILanguage property belongs to the [Regional Settings] section of the INI files described in Table 3.

Briottbl.txt File FormatThe Briottbl.txt translation file is a plain text file in the corresponding Windows ANSI encoding. The file consists of a one-line header and a set of translation lines.

The header line consists of a reserved word (or language) followed by the TAB character, followed by UI language name. The character case is not considered, that is you can use uppercase, lowercase or a combination of both: “Hyperionlanguage”, “HyperionLanguage” or “HYPERIONLANGUAGE”.

The translation lines have the same structure:

<string-to-translate> <TAB> <translated-string>

Strings on either side of the TAB character can contain \r, \n, or \t escape sequences that denote 0x0D, 0x0A and 0x09 ASCII characters respectively. Invalid lines (for example, a no TAB character) are ignored.

Table 3 Application and Corresponding INI files

Application File Name

Interactive Reporting Studio

brioqry_ev.ini

(The UI language setting property can be also set by selecting the Tools > Options > Program Options > UI Language option.)

Interactive Reporting Web Client

brioqplg_ev.ini

(The UI language setting property can be also set by selecting the Tools > Options > Program Options > UI Language option.)

BIService Das brioqry_ev.ini

(BIService and Das read this property at startup to retrieve the default UI language settings).

Arabicbriottbl.txt

Chinesetradbriottbl.txt


Server.xml and Custom User Languages The user languages displayed in the login screen and in User Preferences can be extended by modifying server.xml located in the common/config folder for the services installation where the Global Services Manger (GSM) is located. GSM shares this information with the rest of the system.

Below is an example of how to customize the list. A new entry must include all the entries that are bolded within the “LOCALE_LIST” propertylist tag, although the “VARIANT” node is optional and may not apply to all locales. The strings in red represent the locale and language specification. All “defid”s must be consistent with the example below.

<propertylist name="LOCALE_LIST" defid="000000f324d3875d-0000-114a-0ad72214"><propertystruct name="LOCALE" defid="000000f324d56aa3-0000-114a-0ad72214"> <property name="ISO_LANG_CODE" defid="000000f324d65997-0000-114a-0ad72214">zh</property> <property name="ISO_COUNTRY_CODE" defid="000000f324d6f616-0000-114a-0ad72214">CN</property> <property name="DEFAULT_LOCALE" defid="000000f324d778d3-0000-114a-0ad72214">false</property> <property name="VARIANT" defid="000001072f707a7f-0000-08c5-ac1b10de">simplified</property></propertystruct></propertylist>

The “DEFAULT_LOCALE” tells GSM that this value is the locale to use as the default in the JVM.

The “VARIANT” may not apply to most locales. This value is used for different sorting routines within the same language for Interactive Reporting.

JSPResources.properties and Resource filesTo correctly display the language list, the JSPResources.properties in the “WEB-INF/classes/msgs” folder must include the corresponding language text. For each “LOCALE” property structure, you must add the following entries in the JSPResources.properties file:

<Language><Country><Locale>

For example, to add Simplified Chinese to the language list:

language.zh.string=Chinesecountry.CN.string=CHINAlanguage.zh_CN.string=Simplified Chinese

The strings in red correspond to the server.xml entry. The last entry in the JSPResource.properties file represents the combination of the “ISO_LANGUAGE_CODE” and the “ISO_COUNTRY_CODE” in the server.xml file.

User Interface Language 11

Although these modifications add a new language entry in the login screen and user preference page, they do not guarantee that you can see localized strings based on this new entry within the entire system. In order for those changes to take place, the localized resource files must exist for the new language and locale entry in server.xml, since only a few localized language sets of properties files are released.

Workspace uses the JAVA Locale representation (language_country combination) to look for the correct localized resource files. For example, if the locale is “en_US”, the entry in server.xml has “en” for the language and “US” for the country.

The servlets look for resource files named “<resourcefilename>_en_US.properties”. If the files do not exist, the servlet looks for “<resourcefilename>_en.properties”. If this file does not exist, it uses the default “<resourcefilename>.properties” and displays the string. In this case, the new language strings in the JSPResource.properties file are added for the English representation. If you want to display another language, add it to the “JSPResource_<languagecode>_<countrycode>.properties file for that language. Otherwise it defaults to the JSPResource.properties file.

User Interface LanguageYou can set the user interface language for menus and messages in Hyperion System 9 BI+ products.

Review the following sections for information on:

● Setting the User Interface Language in Interactive Reporting Studio and Interactive Reporting Web Client (Offline Only)

● Setting the User Interface Language for Interactive Reporting Jobs in Hyperion System 9 BI+ Workspace

Note: In Workspace, the language is determined by the browser’s language setting.

Setting the User Interface Language in Interactive Reporting Studio and Interactive Reporting Web Client (Offline Only)For Interactive Reporting Studio, the default user interface language is determined at installation time. The user interface Language for the Interactive Reporting Web Client can be set manually after installation.

➤ To change the user interface language from either Interactive Reporting Studio or Interactive Reporting Web Client:

1 Select Tools > Program Options.


2 On the International tab, select a language and click OK.

3 Close and reopen the application.

The user interface language property is stored in the [Regional Settings] section of the configuration file with the following settings:

[Regional Settings]UILanguage=English

By default, the browser language is used to set the user language when connecting to Workspace. After you log on successfully, the Interactive Reporting Web Client uses that language. The userlang cookie is deposited and persists for all subsequent sessions unless the cookie is deleted.

When you open an Interactive Reporting document in the Interactive Reporting Web Client offline, the language from the operating system locale is used. You can change the language on International tab in the Options dialog box.

If you go on-line with the Interactive Reporting document, the user interface language must be the same as the one used while offline.

If the user interface language of Workspace differs, then the offline user interface language overrides the userlang cookie.

User Interface Language 13

Setting the User Interface Language for Interactive Reporting Jobs in Hyperion System 9 BI+ WorkspaceThe language used for menus and messages is determined by the Language setting in the browser.

Figure 2 Setting the User Interface Language for Interactive Reporting Jobs

➤ To set the user interface language when scheduling an Interactive Reporting job:

1 Select Import > File as Job or Properties of Job.

2 Select Publish Job > Job Defaults.

3 In Select Locale, select the default user interface language.

4 Select the country associated with the default user interface language from Country and click OK.

The country setting determines the data format (for example, the date/time format), and the Language setting determines the sort order and the job log language.

➤ To set the user interface language when running an Interactive Reporting job for each cycle:

1 From Select Locale in Run Job, select the default user interface language from Language.

2 Select the country associated with the default user interface language from Country and click Run Job.

The country setting determines the data format (for example, the date/time format), and the Language setting determines the sort order and the job log language.


User ManagementThe following Hyperion System 9 BI+ roles do not apply and should not be assigned to Hyperion Financial Management and Hyperion Planning users who access Financial Reporting or Web Analysis through Hyperion System 9 BI+:

● Dynamic Viewer

● Interactive Reporting Viewer

● Job Manager

● Job Publisher

● Job Runner

● Metrics Analyst

● Metrics Editor

● Metrics Viewer

● Personal Page Editor

● Personal Page Publisher

● Smart Form Publisher

● Trusted Application

Running Background or Foreground JobsPrior to release 9.2, users selected to run jobs in the background by selecting the Run this job in the background option in Job Properties. Jobs ran in the foreground by default.

With release 9.2, users have an additional option select how to run jobs by using the Run Job in > Foreground or Run Job in > Background menu options.

When running jobs in the background, users can continue working in Workspace, including viewing job status in Manage Jobs. When jobs are run in the foreground, a progress bar is displayed and users cannot perform other activities until the job finishes.

Import Wizard RestructuredIn Workspace, the Import Wizard has been restructured so that users can hit Finish without going through all the wizard steps. This saves time when you do not need to fill in all the customizable options for publishing.

Unicode Enabled Software 15

Startup Parameter for Common ServicesThe MCL.JDBCFetchMaxRowSize parameter affects the number of objects returned for a listing, the number of Interactive Reporting database connection files, the number of items returned from a search, and the objects listed in a Personal Page. The default value for this parameter is 100.

To change the value, add a new –D system property to the BP_FLAGS list in startCommonServices.bat (or shell):

-DMCL.JDBCetchMaxRowSize=<new value>

Unicode Enabled SoftwareRelease 9.2 is Unicode-enabled. As a result, Hyperion System 9 BI+ supports deployment on all supported platforms in all supported languages. This removes previous restrictions that supported Windows-only deployments when requiring languages other than English. In addition, Interactive Reporting documents can be used on any system, not just those using a code page compatible with the system that created the document.

More importantly, these documents can contain data representing many languages. For example, a document created on a Japanese version of Windows can be opened through Hyperion System 9 BI+ running on a Korean UNIX system, displaying data simultaneously from the Turkish and Traditional Chinese character sets.

Production Reporting already supports Unicode; however, it is now accessible by way of all supported platforms in any supported language.

Unicode-related changes include support for:

● Localization and internationalization of UNIX products

● Connectivity to Unicode as well as non-Unicode databases

● Multi-lingual data in Interactive Reporting documents


● Reading existing Interactive Reporting documents in Unicode-enabled Hyperion System 9 BI+ without performing migration. (Batch utilities are provided to convert existing Interactive Reporting documents to newer formats to gain performance.)

● Multiple locales or languages within the Interactive Reporting Web Client including: Windows 2000 Server editions, Windows Server 2003, Solaris 9 and 10, AIX 5.2 and 5.3, HP-UX 11, and RedHat Linux 4.0

● English, German, French, Portuguese (Brazilian), Spanish, Italian, Korean, Japanese, Traditional Chinese, and Simplified Chinese languages.

Review the following sections for information on:

● “Interactive Reporting Sort Order Language” on page 16

● “Encoding Interactive Reporting Database Connection Files” on page 17

● “Interactive Reporting Application Configuration Files” on page 18

● “Unicode Migration Utility for Interactive Reporting Documents and Database Connection Files” on page 18

● “Unicode File Path Handling on UNIX” on page 19

● “Unicode Compliant Fonts” on page 19

● “File Import” on page 21

● “File Export” on page 23

Interactive Reporting Sort Order LanguageWhen an existing Interactive Reporting document is opened in Unicode-enabled Interactive Reporting, the document is converted from the old format to the new, and the language is determined based on the document code page. In certain locales (for example, most of the European languages) the language cannot be determined based on the code page from the existing Interactive Reporting document. In this case, the user may be prompted to select the correct language for the document as shown below. When a new document is created, Interactive Reporting selects the language based on the user locale or language set in Windows unless the user selects another locale or language.

➤ To select the Document Sort Order Language manually:

1 Select File > Properties.


2 In Document Properties, select International.

3 Select the sort order language.

4 Select Use this choice by default to use the sort order language as the default for new Interactive Reporting documents.

5 Click OK.

The document sort order language property is stored in the config file with the settings:

[Regional Settings]DefDocLanguage=English

These settings can be copied to the Interactive Reporting server config file.

Interactive Reporting documents should be converted to the new format by opening and saving them back to disk.

Encoding Interactive Reporting Database Connection FilesIn addition to encoding your Interactive Reporting documents, it is recommended that you convert any existing Interactive Reporting database connection files (.oce) in the Interactive Reporting Studio.

➤ To convert an existing connection file:

1 Create a new Interactive Reporting document using the database connection file to be converted.

The Convert Interactive Reporting Data Connection File dialog box is displayed.

2 Select the language for textual data contained in the connection file from the drop-down list and click OK.

3 Save the connection by selecting Tools > Connection Manager > Logon.

If a database connection file is used in the Interactive Reporting Web Client, it is converted on the fly. In this case, the conversion language is assumed. If a connection file does not have any non-English textual data in it (which is common), the conversion is done successfully regardless of the language chosen.


Interactive Reporting Application Configuration FilesInteractive Reporting applications store some preferences in the system registry in order to allow different users to have their own personal settings. This is true for preferences contained in the Regional Settings and the Interactive Reporting sections which are located in registry for clients and in the config file for the Hyperion System 9 BI+ Workspace.

Unicode Migration Utility for Interactive Reporting Documents and Database Connection FilesYou can convert all Interactive Reporting documents and database connection files to Unicode format by using the Unicode Migration Utility. This utility enables you to convert multiple Interactive Reporting documents to Unicode format in batch mode. When pre-Release 9.2 Interactive Reporting documents are opened in the Release 9.2 Interactive Reporting product suite, they are converted automatically to the new Unicode format. When the documents are saved to disk, they are also stored in new format. Interactive Reporting documents in the Unicode format typically open faster because a conversion is unnecessary.

Table 4 Configuration File Locations in the Registry

Application Registry Path

Interactive Reporting Studio HKEY_CURRENT_USER\Software\Brio Software\brioqryEv

Interactive Reporting Web Client HKEY_CURRENT_USER\Software\Brio Software\BrioPluginEv

Table 5 Configuration File Names (now suffixed with _ev)

Application Configuration File Name

Interactive Reporting Studio brioqry_ev.ini

Interactive Reporting Web Client brioqplg_ev.ini

Hyperion System 9 BI+ Workspace intelligence_ev.ini

Table 6 Interactive Reporting Core Configuration Files (changed in Release 9.2)

File Configuration File Name

Format template file brioqry_ev.ini

Pre-defined metadata sources briometa_ev0.ini

Control access to tables created in the Process to Table feature

bqtbls_ev5.ini

Custom Menus bqtools_ev.ini


➤ To run the Unicode Migration Utility for Interactive Reporting documents:

1 Install the Migration Utility on a target platform.

See the Migration Guide for information on the Migration Utility.

2 Open a Command Prompt window.

3 Type: brioqry_s -cmd convert <language> -f <input files or directories> -outdir <output directories>

● brioqry_s -cmd convert -lang—Converts Interactive Reporting documents and database connection files to unicode format. For Interactive Reporting documents, specify the language parameter used for the sort order stored in the output file. For database connection files, this parameter determines the encoding of the input file

● -f—Specifies the name of the input files or directories to convert

● -outdir—Specifies the name of the output file or directories to which the converted files are stored.

For example, if you type:

brioqry_s –cmd convert –lang English –f C:\My_ir_docs D:\doc1.bqy –outdir C:\Converted_Files

the D:\doc1.bqy file and all Interactive Reporting documents and database connection files from the C:\My_ir_docs folder are converted to Unicode format and stored in the C:\Converted_Files folder.

Unicode File Path Handling on UNIX To ensure correct Unicode file path handling of the Hyperion System 9 BI+ Workspace on UNIX, the en_US.UTF-8 locale must be available on the UNIX system.

Unicode Compliant FontsRelease 9.2 is packaged with a set of Andale WT fonts, which facilitate the display and printing of multi-lingual texts. Both the Windows and UNIX Hyperion System 9 BI+ installers install these fonts automatically.

● Andale WT font is the default product font.

● Andale WT font does not show the European Union currency symbol properly. To correct this issue, use the Andale WT J/K/CS/TC symbols.

● Andale WT font does not have a complete set of Arabic letters. Use one of the Andale WT J/K/CS/TC fonts.

● Arabic text is not shown properly with Andale WT in an internet browser. Arabic text with this font is not processed according to Arabic script rules. Use Andale WT J/K/CS/TC fonts instead.

● If you export Arabic text to a PDF file, the text is not processed according to Arabic script with any fonts.


Unicode Font ConfigurationAll font settings are available in the config file for easy visibility, customization, and portability across all platforms. The Default Fonts and Interactive Reporting settings of the configuration file are reserved for font configuration. The default user preference is set to Andale WT upon installation.

Unicode Compliant Font PreferencesBy default Hyperion System 9 BI+ uses the Andale WT fonts for the display and printing of multi-lingual (Unicode compliant) text. To substitute this font with other fonts, use the new General and Dashboard tabs of the Default Fonts and Styles dialog box. Fonts definitions are set globally on the General tab. Font definitions on the Dashboard tab are set locally. When a new font is substituted, font changes are applied to new sections only and not the original sections. Also, you need to save and restart the application to apply the new settings.

Setting General Font PreferencesUse the General tab to select the text fonts displayed in a dialog box, fixed and variable widths.

➤ To apply a font substitute:

1 Select Tools > Options > Default Options.

The Default Fonts and Styles dialog box is displayed.

2 Select a font category to change from Settings.

● Dialog Font—Defines the font used for text in dialog boxes. Depending on the selected font, you can also select the font size from the Size drop-down box.

● Variable Width Font—Defines the font used for variable width fonts (such as Arial). Variable width fonts use characters of different widths.

● Fixed Width Font—Defines the font used for fixed with fonts (such as Courier). Fixed width fonts use characters of equal widths.

3 Select the substitute font from Font Name and click OK.

To revert to the default settings for fonts defined at installation, click Defaults.

4 Save the document and restart the application.

Setting Dashboard Font PreferencesUse the Dashboard tab to select the text fonts properties to be substituted in controls and text labels. For example, if you are working with an older Interactive Reporting document that uses an Arial font for text labels and contains Chinese data, text may not show up correctly on a Korean operating system (Win2K). To fix the display, you can specify an Arial font substitute with more Unicode compliant characters on the Dashboard tab.

To revert to the default settings for controls and text labels, click “Defaults”.


➤ To set a font substitute for a control or text label:

1 Select Tools > Options > Default Options.

2 In Default Fonts and Styles, select Controls or Text Labels from Settings.

3 In Font Name, select the substitute font from.

4 In Size, select the font size.

5 Select a font format.

6 Click OK.

To revert to the default settings for fonts defined at installation, click Defaults.

7 Save the document and restart the application.

File ImportWhen importing a text file from disk, you can encode the file.

If the file has an initial special Unicode byte order mark (BOM), the file is recognized. Otherwise, the encoding can be set using the Encoding drop-down.

In addition, the following Interactive Reporting Object Model methods accept an additional parameter that sets the input file encoding:

ImportDataFile(String Filename, BqImportDataFileFormat Format, BqEncoding Encoding)ImportSQLFile(String Filename, int numColumns, BqEncoding Encoding)LoadFromFile(String Filename, BqEncoding Encoding)

Table 7 BqEncoding Enumeration

BqEncoding Value

bqEnc_Unicode_UTF8 Unicode with UTF-8 encoding

bqEnc_Unicode_UTF16 16-bit Unicode – operating system default endian


bqEnc_Unicode_UTF16_BigEndian 16-bit Unicode, most significant byte comes first

bqEnc_Unicode_UTF16_LittleEndian 16-bit Unicode, least significant byte comes first

bqEnc_Unicode_UTF32 32-bit Unicode – operating system default endianess

bqEnc_Unicode_UTF32_BigEndian 32-bit Unicode, most significant byte comes first

bqEnc_Unicode_UTF32_LittleEndian 32-bit Unicode, least significant byte comes first

bqEnc_Arabic_ISO Arabic languages, ISO encoding (iso-8859-6)

bqEnc_Arabic_Windows Arabic languages, windows encoding (codepage 1256)

bqEnc_Baltic_ISO Baltic languages, ISO encoding (iso-8859-4)

bqEnc_Baltic_Windows Baltic languages, windows encoding (codepage 1257)

bqEnc_CentralEuropean_ISO Central European languages, ISO encoding (iso-8859-2)

bqEnc_CentralEuropean_Windows Central European languages, windows encoding (codepage 1250)

bqEnc_Chinese_GBK Chinese language, GBK encoding

bqEnc_Chinese_GB2312 Chinese language, GB2312 encoding

bqEnc_Chinese_HZ Chinese language, HZ-GB-2312 encoding

bqEnc_Chinese_BIG5 Chinese language, BIG5 encoding

bqEnc_Cyrillic_DOS Cyrillic languages, OEM encoding (windows codepage 866)

bqEnc_Cyrillic_ISO Cyrillic languages, ISO encoding (iso-8859-5)

bqEnc_Cyrillic_KOI8R Cyrillic languages, encoding KOI-8R

bqEnc_Cyrillic_KOI8U Cyrillic languages, encoding KOI-8U

bqEnc_Cyrillic_Windows Cyrillic languages, windows encoding (codepage 1251)

bqEnc_Greek_ISO Greek language, ISO encoding (iso-8859-7)

bqEnc_Greek_Windows Greek language, windows encoding (codepage 1253)

bqEnc_Hebrew_Windows Hebrew language, windows encoding (codepage 1255)

bqEnc_Japanese_EUC EUC - Japanese

bqEnc_Japanese_JIS Japanese, JIS

bqEnc_Japanese_ShiftJIS Japanese, Shift-JIS

bqEnc_Korean Korean (Unified Hangul Code)

bqEnc_Thai_Windows Thai language, windows encoding (codepage 874)

bqEnc_Turkish_ISO Turkish language, ISO encoding (iso-8859-2)

bqEnc_Turkish_Windows Turkish language, windows encoding (codepage 1254)

Table 7 BqEncoding Enumeration (Continued)

BqEncoding Value


File ExportWhen exporting an Interactive Reporting document or section to text or a Microsoft Excel (XLS file), the user can encode the file in the Save File dialog box, or supply optional encoding parameters in the Object Model as shown below. When the encoding parameter is not specified, the default encoding is used, which is determined from the context.

Export(Filename, BqExportFileFormat FileFormat, IncludeHeaders, Prompt, BqEncoding Encoding);ExportToStream([Filename, BqExportFileFormat FileFormat, IncludeHeaders, DataStreaming, Prompt, BqEncoding Encoding);

Note: For Interactive Reporting jobs, text files are exported in UTF-8 encoding. Microsoft Excel files are exported in default encoding that is determined from the context.

The TXT and CSV files can be exported using all available values of BqEncoding enumeration, but only these values are admitted in the Export to Excel (XLS) feature:

● bqEnc_Arabic_Windows

● bqEnc_Baltic_Windows

● bqEnc_CentralEuropean_Windows

● bqEnc_Chinese_GBK

● bqEnc_Chinese_BIG5

● bqEnc_Cyrillic_Windows

● bqEnc_Greek_Windows

● bqEnc_Hebrew_Windows

● bqEnc_Japanese_ShiftJIS

● bqEnc_Korean

● bqEnc_Thai_Windows

● bqEnc_Turkish_Windows

● bqEnc_WesternEuropean_Windows

● bqEnc_Vietnamese_Windows

bqEnc_WesternEuropean_ISO Western European languages, ISO encoding (iso-8859-9)

bqEnc_WesternEuropean_Windows Western European languages, windows encoding (codepage 1252)

bqEnc_Vietnamese_Windows Vietnamese language, windows encoding (codepage 1258)

Table 7 BqEncoding Enumeration (Continued)

BqEncoding Value


Database ConnectivityUnicode enabling of the software affects the Oracle SQL* Net Connection version and DataDirect Oracle Driver.

Oracle SQL*Net ConnectionThe Oracle client must use a 9.2.0.5 or higher version.

DataDirect Oracle DriverHyperion System 9 BI+ installs DataDirect version 5.1 drivers. For the DataDirect Oracle driver the Enable N-CHAR Support setting should be checked on the ODBC Oracle Wire Protocol Driver Setup.

OLE DB Provider for OracleAn OLEDB/OLEDB connection that uses Microsoft OLE DB Provider for Oracle might not return Unicode characters. For example the OLE DB connection for Oracle does not retrieve Russian and 2-byte characters properly.

Data Access Service ODBC Driver DocumentationInteractive Reporting Studio and Hyperion System 9 BI+ bundle branded ODBC drivers from DataDirect, version 5.1. "Branded" means these drivers only work with these applications. These drivers can be located under <Hyperion Home>/common/ODBC/Merant/5.1. When upgrading or migrating, it is recommended to update the data sources to use these newer versions of drivers.

You can obtain a complete set of documentation for these DataDirect Drivers from:

http://www.datadirect.com/techres/odbcproddoc/index.ssp.

The bundled drivers are the DB2 Wire Protocol Driver, Informix Wire Protocol Driver, Oracle Wire Protocol Driver, Microsoft SQL Server Wire Protocol driver, and Sybase Wire Protocol Driver. These are available on all operating systems supported by the Hyperion products.

Data Access Service and Large Buffer ModeIn order to gain performance during fetching of data, Data Access Service by default uses large buffer query mode ignoring the corresponding Interactive Reporting database connection file setting. This default can be changed by setting DAS_ALWAYS_USE_LARGE_QUERY_BUFFER under <SERVICES app="DAS"> in <BIPlus Home>/common/config/server.xml, as shown in the following example:

National Strings for MS SQL Server 25

<service type="DataAccess">…<property defid="0ad70321-0001-08aa-000000e738090110" name="DAS_ALWAYS_USE_LARGE_QUERY_BUFFER">false</property><property defid="0ad70321-0001-08aa-000000e738090110" name="DAS_RELATIONAL_DB_PARTIAL_RESULT_CELL_COUNT">50000</property>

If DAS_ALWAYS_USE_LARGE_QUERY_BUFFER is set to false, then Data Access Service reads and honors the Interactive Reporting data connection file setting of large query buffer mode.

Informix ConnectivityInformix connectivity is only supported using Data Direct ODBC drivers and Data Direct ODBC driver manager.

Open Client ConnectivityOpen Client connectivity for Sybase is not supported in Release 9.2. Existing Interactive Reporting database connection files that use Open Client connectivity should be modified to use ODBC to Sybase or ODBC to ODBC for Sybase databases.

Red Brick Connectivity Redbrick ODBC drivers do not support UTF16 encoding on UNIX. Consequently, Redbrick drivers are supported only on Windows platforms. If you are using a UNIX-based Hyperion System 9 BI+ system, Data Access Service configured for Redbrick should be installed in Windows.

Redbrick ODBC driver version 5.63 or higher must be used.

Teradata ConnectivityTeradata ODBC driver version 4.0 or higher must be used.

National Strings for MS SQL ServerNational strings (for example, ntext, nchar, and nvarchar data types) used in SQL statements against a MS SQL server must be prefixed with N. For example, you would enter:

This rule applies for national strings used for Custom SQL, Computed Items, Stored Procedures input parameters, and row level security.


Bidirectional Text Bidirectional text contains both right-to-left and left-to-right directional runs. Bidirectional text support is available on all platforms, in the user interface, and in all exported documents (HTML, Office HTML, and PDF).

Bidirectional text is rendered equally in all possible output modes with the following restrictions:

● Ligatures are not placed between Arabic letters if the text is exported to a PDF file. A ligature is a sequence of characters displayed as a single unit replacing characters that occur next to each other when common components are shared.

● In Office HTML Export, bidirectional processing is performed by Microsoft Excel after opening the exported document. As a result, text rendering may differ from what is presented in the Interactive Reporting Studio or the Hyperion System 9 BI+ Workspace.

● Release 9.2 does not change the system-defined bidirectional behavior of the edit, drop-down, and list-box user interface controls. This is true both for clients (Interactive Reporting Studio and Interactive Reporting Web Client) and the Hyperion System 9 BI+ Workspace.

Understanding Bidirectional TextEach language has its writing system, or script. Script includes the set of characters which are used for writing. Most languages can be viewed in a left-to-right (LTR) direction of the text, which means that writing begins from left-hand side of page, and concludes at the right-hand side. However there are scripts which have a right-to-left (RTL) direction, for example, Arabic and Hebrew.

Since both RTL and LTR directional text can be displayed within the same paragraph, these paragraphs are referred to as “bidirectional.” For example in the Hebrew text below, the text is written in the RTL direction, and numbers are LTR directional.

You read this sentence starting from the right side beginning with:

next reading number 1943, then reading:

Complex structures occur when a paragraph of one direction has a citation of different directional text. This citation can contain other citations, which can have original text direction and so on. Consequently text of different directions can be enclosed several times.

The part of the text which has the same direction is called a run.

Row-level Security JOINOPER Operator 27

Bidirectional text can be ordered in visual or logical order. When characters are ordered in the same way in which they are displayed - from left to right, it is a visual order. Entering or reading bidirectional text is done in logical order, which is the sequencing of characters ordered on the way in which characters should be read. Some text scripts require that characters be combined into one ligature when output.

Bidirectional Configuration SettingsBidirectional text properties can be set in the application configuration file. On UNIX, processing of bidirectional text is enabled by default. On Windows, bidirectional text support is performed when complex script support is enabled in the system. Additionally, bidirectional support is disabled by using the setting:

[Regional Settings]BidiEnabled=0

All paragraphs are left-to-right directional by default, but this setting can be modified by using the setting:

[Regional Settings]TextDirection=LTR|RTL|Context

All paragraphs have a left to right reading order if the setting is LTR, or a right to left reading order if the setting is RTL. Context refers to the paragraph direction based on the first letter of paragraph.

Row-level Security JOINOPER OperatorRow-level security rules now have the JOINOPER column in the BRIOSECR table, which is used when row-level security SQL is generated, and those restrictions specify a join table. The column can contain one of the following string values: =, <>, <, >, <=, >=, as well as the outer join options FULL, LEFT, and RIGHT. If no value is given, when the join table is added to the SQL, an equijoin (=) is chosen.

If the join table is already joined to the source table in the data model, the join type specified in the data model takes precedence.

Workspace Administration Enhancements 29

C h a p t e r

2Workspace Administration

Enhancements

This chapter lists the changes and enhancements made to Workspace Administration Release 9.2.

In This Chapter Hyperion Interactive Reporting Services Availability and Jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Job Service Exclusions for Interactive Reporting Jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Default Open Interactive Reporting Document Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Production Reporting Dynamic Property Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

SAP Provider Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

SQL Batching for Keywords and Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Third-Party Software Changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Impact Management Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Workspace Desktop No Longer Available . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Interactive Reporting Job Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Job Queuing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Triggering Events (for Developers) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

30 Workspace Administration Enhancements

Hyperion Interactive Reporting Services Availability and JobsAdministrators can configure Hyperion Interactive Reporting Service to run as either a dedicated job processor or as an interactive processor that processes both jobs and interactive reports.

When configured as a dedicated job processor, Hyperion Interactive Reporting Service registers with GSM as a dedicated job request processor, and is acquired by GSM only to receive job processing requests, not to process interactive requests.

As long as the number of job requests being concurrently processed is less than a specified maximum limit, Hyperion Interactive Reporting Service accepts additional requests to process jobs from a Job Service client. If the maximum limit is reached, Hyperion Interactive Reporting Service does not accept further requests to process jobs until at least one of the jobs in progress completes. Some of the job requests are blocked until the number of concurrent job requests being processed drops below the configured maximum limit. It is unspecified which jobs are blocked and when they are allowed to begin processing.

When configured as an interactive processor, Hyperion Interactive Reporting Service accepts jobs or interactive requests without restrictions. There is no theoretical limit to the number of requests of either type that it accepts and runs concurrently. Physically, Hyperion Interactive Reporting Service may run out of memory if too many requests are concurrently processed.

By default, Hyperion Interactive Reporting Service is configured as an interactive processor. If multiple instances of Hyperion Interactive Reporting Service are running, configuring some of them as dedicated job processors allows load processing to be distributed according to the request type.

Configuring Hyperion Interactive Reporting Service To specify how Hyperion Interactive Reporting Service runs, add the SERVICE_ROLE optional configuration property to server.xml (in Install Home\common\config). Valid values are:

● JOB_REQUEST_PROCESSOR—Dedicated job request processor

● GENERAL_REQUEST_PROCESSOR—Job and interactive request processor

When Hyperion Interactive Reporting Service is started it reads this property value in server.xml to determine its service role. By default, Hyperion Interactive Reporting Service is installed to run as both job and interactive request processor and there is no SERVICE_ROLE property in server.xml.

To specify the maximum number of concurrent job requests that Hyperion Interactive Reporting Service may process, add the MAX_CONCURRENT_JOB_REQUESTS optional configuration property to server.xml. The valid range of values is 0 to 5000.

If SERVICE_ROLE is set to JOB_REQUEST_PROCESSOR and MAX_CONCURRENT_JOB_REQUESTS is not in server.xml or is not set to a valid value, Hyperion Interactive Reporting Service uses the maximum value of 5000 by default. MAX_CONCURRENT_JOB_REQUESTS is ignored if SERVICE_ROLE is not defined in server.xml file or is set to GENERAL_REQUEST_PROCESSOR.

Hyperion Interactive Reporting Services Availability and Jobs 31

Add SERVICE_ROLE and MAX_CONCURRENT_JOB_REQUESTS to server.xml in the service type section used by Hyperion Interactive Reporting Service, after CACHE_LOCATION property.

This is a sample section of server.xml for Hyperion Interactive Reporting Service properties with the SERVICE_ROLE and MAX_CONCURRENT_JOB_REQUESTS (in bold) properties set.

<service type="BrioQuery"> <runtype>start</runtype> <fedName> <instanceid>000001033825e558-0000-0a07-ac1b1fb1</instanceid> <typeid>0ad70312-0000-0934-000000ea4ac65069</typeid> <versionid>00000000-0000-0000-0000000000000000</versionid> <pathname>BI1_hite</pathname> <servicedesc>BI1_hite</servicedesc> </fedName> <classInfo> <infotype>com.brio.one.services.brioquery.info.BrioQueryServiceInfo</infotype> </classInfo> <properties> <propertylist defid="0ad70321-0002-08aa-000000e738090110" name="BQ_EVENT_MONITOR_PROPERTY_LIST"> <property defid="0ad70321-0001-08aa-000000e738090110" name="EVENT_MONITORING">OFF</property> <property defid="0ad70321-0001-08aa-000000e738090110" name="MAXIMUM_DOCUMENTS_THRESHOLD">10000</property> <property defid="0ad70321-0001-08aa-000000e738090110" name="MAXIMUM_JOBS_THRESHOLD">10000</property> <property defid="0ad70321-0001-08aa-000000e738090110" name="MAXIMUM_UP_TIME_THRESHOLD">180</property> <property defid="0ad70321-0001-08aa-000000e738090110" name="SPECIFIC_SHUTDOWN_TIME">1290</property> <property defid="0ad70321-0001-08aa-000000e738090110" name="GRACE_TIME">3</property> </propertylist> <property defid="0ad70321-0001-08aa-000000e738090110" name="CACHE_LOCATION">C:\Brio\Brio8\BrioPlatform\cache</property> <property defid="0ad70321-0001-08aa-000000e738090110" name="SERVICE_ROLE">JOB_PROCESSOR_ONLY</property> <property defid="0ad70321-0001-08aa-000000e738090110" name="MAX_CONCURRENT_JOB_REQUESTS">10</property> <property defid="0ad70321-0001-08aa-000000e738090110" name="MAX_CONCURRENT_REQUESTS">5000</property> <property defid="0ad70321-0001-08aa-000000e738090110" name="MIN_DISK_SPACE">10</property> <property defid="0ad70321-0001-08aa-000000e738090110" name="DOCUMENT_UNLOAD_TIMEOUT">900</property> <property defid="0ad70321-0001-08aa-000000e738090110" name="DOCUMENT_UNLOAD_THRESHOLD">15</property> <property defid="0ad70321-0001-08aa-000000e738090110" name="POLLING_INTERVAL">180</property> <property defid="0ad70321-0001-08aa-000000e738090110" name="configurationURL">file:C:\Brio\Brio8\BrioPlatform\etc\log4j\remoteServiceLog4jConfig.xml</property> </properties>

</service>


Determining When Job Request Maximum Limit is ReachedWhen run as a dedicated job request processor, Hyperion Interactive Reporting Service logs status messages in the configured log file that indicate the number of concurrent jobs it is running and whether the concurrent job request maximum limit has been reached.

If the logging level is set to DEBUG, messages are printed that display the number of concurrent job requests being processed and the configured maximum limit for the number of concurrent jobs. This message is printed when a job request is received:

<message><![CDATA[Received job request for document SalesResultsWest.bqy. 4 job request(s) currently in progress. Maximum limit is 5.]></message>

Regardless of the logging level, when the maximum limit of number of concurrent job requests is reached, this message is printed that indicates so and that the service is no longer available:

<message><![CDATA[Service resetting to NOT AVAILABLE. Number of concurrent jobs has reached maximum limit of 5.]></message>

If the logging level is set to DEBUG and a job request starts processing, this message is logged:

<message><![CDATA[Executing job request for SalesResultsWest.bqy.]></message>

If the logging level is set to DEBUG and a job request completes processing, this message is logged:

<message><![CDATA[Ending job request for SalesResultsWest.bqy. 4 job request(s) currently in progress. Maximum limit is 5.]></message>

Regardless of the logging level, when Hyperion Interactive Reporting Service completes processing a job request, and the number of concurrent job requests becomes less than the configured maximum limit, this message is printed:

<message><![CDATA[Service resetting to AVAILABLE.]></message>

Process MonitorProcess Monitor currently monitors Hyperion Interactive Reporting Service and Hyperion Interactive Reporting Data Access Service, and constantly maintains one active service that processes new incoming requests. Services are put into standby to continue processing existing requests only when replaced by an active service. Process Monitor is enhanced to allow for the management of up to n pairs of Hyperion Interactive Reporting and Hyperion Interactive Reporting Data Access services. The default is 2.

To increase the number of managed service, change this setting in DASprocessmonitor.poperties or BIprocessmonitor.properties:

# Number of managed servicesMAX_NUMBER_OF_MANAGED_SERVICES=2

Setting the number of managed services to 3 assigns one service to actively process incoming requests, with up to 2 services standing by to process existing requests. Administrators must take memory usage of services into account when changing these sections.

SQL Batching for Keywords and Attributes 33

Regardless of the number of monitored services, there is only one active Hyperion Interactive Reporting Service and Hyperion Interactive Reporting Data Access Service in the system.

The number of service logs increases for each Hyperion Interactive Reporting Service and Hyperion Interactive Reporting Data Access Service that Process Monitor manages.

Job Service Exclusions for Interactive Reporting JobsA dynamic RSC property associated with every Job Service enables the administrator to exclude Interactive Reporting jobs from being processed by Job Service.

If the SUPPORT_BQY property for a Job Service is set to true, then that Job Service can run Interactive Reporting jobs; otherwise that Job Service cannot run Interactive Reporting jobs. If a Job Service is installed with Interactive Reporting Services, then SUPPORT_BQY is set to true by default.

Default Open Interactive Reporting Document Format The Default Open Format drop-down on the Interactive Reporting Preferences window enables you to set the default program to open Interactive Reporting documents when you select "open" from the menus in the Workspace Explore module. The default program can be set to either HTML or Interactive Reporting Web Client. If the preference is set to InteractiveReporting Web Client, the Interactive Reporting document is opened in a separate window.

➤ To select the default program:

1 Select File > Preferences > Interactive Reporting.

2 Select the default program to open the document from the Default Open Format drop-down and click OK.

Production Reporting Dynamic Property UpdatesAdministrator’s can use RSC to dynamically modify Production Reporting parameters (for example, application, dynamic, database, and so on), without having to restart services. Prior to release 9.2, Production Reporting parameter changes required that services be restarted.

SAP Provider SupportRelease 9.2 provides single sign-on login for products integrating with SAP.

SQL Batching for Keywords and AttributesWorkspace performs SQL batching for keywords and attributes when importing a file. All documents now have at least name and description key words.


Third-Party Software Changes● IONA Orbix changed from version 6.1 to version 6.3.

● JDBC drivers changed from DataDirect Connect for JDBC release 3.4 to release 3.5.

Impact Management ChangesImpact Management Services changes include:

● Service Configuration Parameters

● UTC Offset Option In Task Status Interactive Reporting Document

● Compatible Replacement Data Model and Document Character Sets

Service Configuration ParametersImpact Management Services contain several service configuration parameters that can be changed by running the LSC. Two properties visibly affect the behavior of the Impact Manager module system.

● Request queue polling interval—Determines the frequency that the service scans the requests queue. The user experiences this interval as the greatest possible delay between initiating an action and the service starting the action.

● Clear log entries after—Can affect the Task Status report of the Impact Manager module functions. Actions older than the value of the parameter may be purged from the repository.

UTC Offset Option In Task Status Interactive Reporting DocumentA UTC Offset option has been added to the Task Status Interactive Report Column that enables users in a different location to the thin client application server to manually select a time zone from a drop-down list. Selecting from the drop-down list corrects dates/times in the log entries accordingly.

Note: Users in the locality of the application server are not required to change this setting.

Compatible Replacement Data Model and Document Character SetsWhen performing a Data Model Update, both Interactive Reporting documents specified in Step 1, Specifying a Data Model, of the Impact Manager module must contain compatible character sets. For example, a data model in a Latin 1 document can be used to update a data model in a Latin 1 or Unicode Interactive Reporting document, but not a Latin 2 document. A data model in a Unicode document can only replace a data model in another Unicode document as Unicode documents can contain multiple character sets.

Job Queuing 35

For example, in Table 8, searching for bqy_a and Dm_1 to be replaced with bqy_b and Dm-33, provides these possibilities.

Workspace Desktop No Longer AvailableThe Workspace Desktop functionality is no longer available.

➤ To achieve an environment similar to the Workspace Desktop:

1 In the User Preferences dialog box, select the General tab.

2 Under Default Startup Options, set Content to Explore, and set the folder to the directory which contains the most frequently-accessed content.

Interactive Reporting Job LogA scheduled Interactive Reporting job now generates an HTML log file rather than a TXT file.

Job QueuingAdministrators can now control the number of concurrent jobs processed by the Job Service by increasing or decreasing the limit on the number of concurrent jobs, without restarting the services. Administrators can also disable the Job Service from processing job for a defined time interval. To accommodate this change, enhancements have been made to:

● Scheduled Jobs

● Background Jobs

● Foreground Jobs

Table 8 Replacement Data Models and Interactive Reporting Documents

Case Search For Replace With Comment

1 Unicode (U) Unicode (U) Only Unicode Interactive Reports are listed in Step 2, Candidates

2 Unicode (U) Code Page 1 (CP1) Both Unicode and CP1 Interactive Reports are listed in Step 2, Candidates

3 Code Page 1 (CP1) Code Page 1 (CP1) Both Unicode and CP1 Interactive Reports are listed in Step 2, Candidates

4 Code Page 2 (CP2) Code Page 1 (CP1) Error Message: The documents and the replacement data model must contain compatible character sets

5 Code Page 1 (CP1) Code Page 2 (CP2) Error Message: The documents and the replacement data model must contain compatible character sets

6 Code Page 1 (CP1) Unicode (U) Error Message: The documents and the replacement data model must contain compatible character sets


● Disabling Job Service

● Job Limit

Scheduled JobsScheduled jobs are queued when all job services are processing the maximum concurrent jobs defined. The queue is maintained in the Event Service. Schedules in the queue are sorted based on the priority of the schedule and the order in which they are triggered.

When a schedule is ready to be processed, the Event Service builds the job and submits it to the Service Broker. The Service Broker gets the list of all the Job Services that can process the job and checks the availability of the Job Service based on the number of concurrent jobs being processed by that Job Service. This information is obtained dynamically from each Job Service.

If the Service Broker cannot find a Job Service to process this job, a Job Limit Reached exception is occurs. Queuing is now enabled in Event Service and the schedule is added to the queue and the job data required to pick the Job Service is cached. This job data includes the application and executable information for the job.

When the next schedule is ready to be processed, the job is built and it is determined if the type of job is already in the queue (based on the job data cached). If the job is present, it is added to the queue. If not, the job is submitted to the Service Broker for processing.

When queuing is enabled in Event Service, a new Job Service polling thread is initialized. This thread checks for available Job Services. If a Job Service is available, the first schedule that can be processed by this Job Service is processed. The job data cached in the Event Service is used to determine if a Job Service can process the schedule. The job data of a schedule is removed from the cache after the schedule is submitted to the Job Service. If the job properties are modified, the new properties are used only if the changes were made after the schedule is fired and is added to the queue.

Background JobsIf a Job Service is not available to process a background job, a command is issued to the Event Server to create a schedule with a custom event to run at that time. This command persists the schedule information in the database. The schedule uses the job parameter that is associated with the background job, and it is processed as a normal schedule job in the Event Services.

Previously, if a job limit was reached when a background job was submitted directly to the Job Service, the job execution failed.

Foreground JobsIf a Job Service is not available to process a foreground job, an exception occurs notifying the user that the Job Service is busy. The user is also prompted with an option of queuing the job for being processed with the next available Job Service. If the user adds it to the queue, a

Triggering Events (for Developers) 37

schedule is created with a custom event to run at the time. The schedule is processed as a normal schedule job in the Event Service. The schedule and the event are deleted after the job is submitted to the Job Service.

Disabling Job ServiceThe Hold property on the new Dynamic tab of the Properties of Job Service dialog box enables the user to place the Job Service on hold. When the Job Service is on hold, no new job is processed, but the Job Service continues to process any job that is already running. This property can be changed without restarting the Job Service.

Job LimitThe Job_Limit property on the new Dynamic tab of the Properties of Job Service dialog box enables an administrator to modify the number of concurrent jobs that can be run by a Job Service. The job limit cannot be modified at runtime. When the job limit has been modified, Job Service properties are updated by way of the Name Service, which in turn notifies the Job Service about the change in the job limit. This property can be changed without restarting the Job Service.

Triggering Events (for Developers)Use this sample to trigger an external event using TriggerExternalEvent.jav. When this event is triggered, it is set to run immediately. Externally Triggered Events are always PUBLIC events.

Input parameters: acct pwd host port Ext Event Name

Output: External event named in the control file is triggered.

Financial Reporting Enhancements 39

C h a p t e r

3Financial Reporting

Enhancements

This chapter discusses the new features and functionality in Financial Reporting for Release 9.2.

In This Chapter XBRL Setup and Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

XBRL Line Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Text as a XBRL Fact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

XBRL Footnotes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

XBRL Tuples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

XBRL Upgrade Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Changes to Prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Merging of Equivalent Prompts Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Database Lookup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

40 Financial Reporting Enhancements

XBRL Setup and ManagementXBRL 2.1 specifications are now supported. Support for these specifications necessitated changes to the user interface and setup of XBRL.

● Setup for schema, context and units is now managed from the Task Menu and has been grouped under the menu item XBRL Management. In previous versions of Financial Reporting, only XBRL Schema was available and managed from the Administration menu (Administration > Schema Manager).]

● Using Context Manager, a designer may create, edit and delete contexts. Contexts may be assigned to columns, cells and text objects. This dialog has been altered to allow for a new name property and the elimination of the unit tab. The text function to retrieve context no longer supports unit parameters. Context information is saved with the report design and is only available to that report.

● The unit property has been separated from the XBRL context and is now defined separately. This means that each XBRL fact will now refer to a unit as well as a context. The setup of units is similar to XBRL contexts. A designer may create, edit and delete unit definitions. Units information is saved with the report design and is only available to that report. Units apply to numeric XBRL line items; non-numeric XBRL facts do not require units.

● A new text function has been added to retrieve the unit information. The XbrlUnit text function returns information about an XBRL unit that has been defined within a grid. It is similar to the existing XbrlContext text function. The function syntax is as follows: <<XbrlUnit("InfoType")>> where the InfoType parameter should be one of the following: unit, unit2 or unitOperation. The function is supported in a heading cell or text cell, but not in text objects.

XBRL Line ItemsYou may assign line items for multiple rows from within the Line Item Setup dialog. This makes it quicker and easier to define line items in a report.

Text as a XBRL FactYou may define any text in a report as an XBRL fact. For example, you may assign the Line Item “Balance Sheet” for the title of the report. XBRL facts can be assigned to text objects and text cells.

XBRL FootnotesYou may define XBRL footnotes. For example, you may want to explain the details of what comprises a line item “other income” as a footnote.

Changes to Prompts 41

XBRL TuplesYou may assign tuple facts. Tuples are a set of facts that exist multiple times in an instance document. For example, you may list names of company officers and assign XBRL facts (line item and context) accordingly.

XBRL Upgrade ConsiderationsIf a report that uses the XBRL 2.0 schema is opened, a warning dialog box informs you that, if you continue, the unsupported metadata will be removed. If you choose to remove the XBRL 2.0 schema, you must redefine context, units, and line items using the new XBRL 2.1 schema.

The unit parameter of the XBRLContext function will return an “invalid parameter” error if defined using “unit parameters.”

Changes to PromptsRelease 9.2 enhances prompt functionality.

● The display of prompts from within the batch contents "listing" has been removed. Now, when users attempts to save the batch, they will see the Respond to Prompts dialog box which contains all prompts (or for SAP BW, variables) contained in the objects within the batch. A user can specify members (or values for SAP BW) in the same manner as used when running reports or books. This makes the Respond to Prompts procedure the same wherever it is performed.

● Users may now choose whether to enter a single response for a member (or value) to be used for all the references to the data source which contains the prompt (or variable) or specify different members (or values) for each grid, report, or book. Entering a single response saves from having to re-enter the same response multiple times.

When a variable exists and there is more then one reference to the data source, or when the same prompt exists in more then one grid, the Respond to Prompts/Variable dialog box drop-down list allows the user to choose whether they want to respond to prompts at the grid, report/book, or batch level.

❍ When running a report:

❑ Respond to Prompts at the Report Level(Default)

❑ Respond to Prompts at the Grid Level

❍ When running a book:

❑ Respond to Prompts at the Book Level(Default)

❑ Respond to Prompts at the Report Level


❍ When editing a batch:

❑ Respond to Prompts at the Batch Level(Default)

❑ Respond to Prompts at the Report/Book Level


42 Financial Reporting Enhancements

Merging of Equivalent Prompts SetupIn User Preferences for Financial Reporting, the user can determine whether to respond only once or consecutively to prompts and variables that are repeated multiple times in a given report, book, or batch. When Merge Equivalent Prompts is selected, the user is presented with an equivalent prompt or variable selection only once; when Merge Equivalent Prompts is not selected, the user is presented with each occurrence of an equivalent prompt or variable.

The setting in User Preference takes precedence. However, If the Merge Equivalent Prompts is not set in User Preferences, the default setting in the fr_global.properties file is used. MergeEqualPrompts=1 is the default setting which turns on the merging of prompts/variables. The alternate setting, MergeEqualPrompts=0, turns off the merging of prompts/variables.

Database Lookup The way a database is selected within the Database Connection Properties dialog box has changed. The Database Lookup button has been combined with the Application Lookup button. The Application Lookup button displays a tree view of the applications and corresponding databases; the applications are listed as parents and the databases are listed as children. For datasources that are not associated with a database, only applications are listed.

To select an application and corresponding database, expand the application name, click the database name, then click OK.

Interactive Reporting Enhancements 43

C h a p t e r

4Interactive Reporting

Enhancements

This chapter describes the changes and enhancements made to Hyperion System 9 BI + Interactive Reporting Release 9.2.

In This Chapter Charts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Flywheel Mouse in Interactive Reporting Studio. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Related Content Handling in Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Password Encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Increasing the Idle Connection Time-outs for the Interactive Reporting Web Client . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Dashboards and Object Model Enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Dashboard Development Services Enhancements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

44 Interactive Reporting Enhancements

ChartsChart enhancements in Release 9.2 include:

● Text Wrapping in Chart Legends

● Auto-Sizing Chart Legend Borders

● Auto-Arranging Pie Chart Labels

Text Wrapping in Chart Legends Text wrapping is available for text items in the legend when the:

● Text wrapping is enable by way of the legend context menu or the Object Model TextWrap (Property).

● The longest text of items arranged in one column does not fit the width of the legend.

● Sufficient vertical space is available in the legend.

Auto-Sizing Chart Legend Borders If you resize the borders of a legend manually and later add or remove values, the size of the borders remains unchanged. To resize the borders of the legend automatically, enable the Auto-Size option on the legend context menu, or the Object Model Auto-Size (Property).

Auto-Arranging Pie Chart Labels If you reposition a pie label manually and the slices are later rearranged, the position of the label remains unchanged. To reposition the label automatically with the slice, enable the Auto Arrange option on the label context menu, or specify the item name or index value for the item in the Object Model AutoArrangeLabel (Method).

Flywheel Mouse in Interactive Reporting Studio The flywheel mouse is now functional in the Interactive Reporting Studio. The flywheel mouse utility provides automatic scrolling in active frames.

Related Content Handling in WorkspaceEmbedded browsers in the Dashboard section can be processed in parallel with the scripts and commands in the section. This feature significantly improves the loading time and enables viewing of the content faster. Related Content Handling is governed by:

Increasing the Idle Connection Time-outs for the Interactive Reporting Web Client 45

● Interactive Reporting Service—The Interactive Reporting server.xml contains an optional preloadEB flag, which when set to true, allows the service to load embedded browsers immediately. This flag applies to all Interactive Reporting documents serviced by the Interactive Reporting Service.

● Interactive Reporting document preload embedded browser property—Users can select one of three values: <system> (value of server.xml), False, or True. If true, the entire document is controlled by the flag, and the Object Model ActiveDocument.preloadEBs() method is ignored.

● ActiveDocument.PreloadContent () Method—Loads embedded browsers by a Dashboard section. If no section name is given as a parameter to this method, the active section is used.

Password EncryptionPassword Encryption has been enhanced to accommodate user credentials that contain characters from a language other than the Windows machine locale. Password encryption extends to database passwords specified in Interactive Reporting database connection files, Interactive Reporting documents and sections, and passwords present in the Zero Client, Interactive Reporting Web Client, and Interactive Reporting background/foreground Jobs.

Increasing the Idle Connection Time-outs for the Interactive Reporting Web Client

Using a configurable polling time, administrators can now control the frequency of messages that keep a Hyperion System 9 BI + Interactive Reporting Web Client connection active. This enhancement allows queries of varied lengths to process from an Interactive Reporting Web Client when running behind a proxy or firewall with finite idle-connection time-outs. Previously, time-outs could not be increased on a proxy server and firewalls in many deployments. By default there is no polling and this feature needs to be explicitly enabled.

➤ To enable this feature:

1 Open ws.conf from the <SERVLETS DEPLOYMENT>/config folder in an editor such as Notepad or Wordpad.

2 In ws.conf, type: WebClient.Applications.DAServlet.PollingTimeSec=0.

3 Change the PollingTimeSec parameter value from 0 to the desired value.

4 Save the entry is in ws.conf.

Use the Servlet Configurator <INSTALL_HOME>/servlets/bin, servletconfig.bat for Windows and servletconfig.sh for Unix to manipulate the value.

Note the value of the PollingTimeSec parameter value setting:

● The Default value is 0 indicating that there is no polling mechanism in place to keep the connection active.

● The PollingTimeSec value is in seconds.


● The PollingTimeSec value must be less than proxy or firewall time-out value (otherwise this configuration change has no effect).

● Setting the PollingTimeSec value too low increases network traffic. For example, if a firewall is set for a 15 min idle timeout, set the polling time to be 720 sec (== 12 min). There is no need to set the value for example to 10 seconds because an unnecessary network overhead results.

Dashboards and Object Model EnhancementsObject Model enhancements have been added in Release 9.2 which address the Unicode, Embedded Pivot Section Interactivity, and PrintOut features.

Unicode Object Model enhancements include:

● “UnicodeEnabled (Property)” on page 46

● “SortOrderLang (Property)” on page 47

● “DefaultSortOrderLang (Property)” on page 49

● “UILanguage (Property)” on page 56

● “ResetDefaultSortOrderLang (Method)” on page 64

Object Model methods that have been modified as a result of the Unicode feature include:

● “Export (Method)” on page 64

● “ExportToStream (Method)” on page 67

● “ImportDataFile (Method)” on page 69

● “ImportSQLFile (Method)” on page 71

The new “Printout (Method)” on page 72 has also been added in Release 9.2.

The “Object Model Exclusion List” on page 73 has been updated in Release 9.2.

UnicodeEnabled (Property)

Applies To: Application object

Description: This property is set to true in Unicode enabled applications.

Action: Read only

Example: This example shows how to read and show the value of the UnicodeEnabled (Property):

//Clear all TextBoxes except TextBox5TextBox1.Text = ""TextBox2.Text = ""TextBox3.Text = ""

Dashboards and Object Model Enhancements 47

TextBox4.Text = ActiveSection.Namevar ActionName = "UnicodeEnabled"TextBox1.Text ="Start " + ActionName if (TextBox5.Text == ""){ TextBox1.Text ="Step 1" try{TextBox3.Text = "UnicodeEnabled is: " + Application.UnicodeEnabled}catch(e){TextBox2.Text = "Caught: " + e.toString()}

}

else{ TextBox1.Text ="Step 2" try{Application.UnicodeEnabled = eval(TextBox5.Text)}catch(e){TextBox2.Text = "Caught: " + e.toString()}TextBox1.Text ="Step 3" try{TextBox3.Text = "UnicodeEnabled is: " + Application.UnicodeEnabled}catch(e){TextBox2.Text = "Caught: " + e.toString()}}TextBox1.Text ="End " + ActionName

SortOrderLang (Property)

Applies To: Document object

Description: This is a property of an Interactive Reporting document and controls how language dependent data sorting is performed within the document sections. Its possible value is a member of BqLanguage enumeration:

● bqLangAfrikaans

● bqLangAlbanian

● bqLangArabic

● bqLangBasque


● bqLangCatalan

● bqLangChinese_Simp (pinyin sort)

● bqLangChinese_Trad (big5han sort)

● bqLangChinese_GB2312_Sort

● bqLangChinese_Stroke_Sort

● bqLangCroatian

● bqLangCzech

● bqLangDanish

● bqLangDutch

● bqLangEnglish

● bqLangUKEnglish

● bqLangEstonian

● bqLangFinnish

● bqLangFrench

● bqLangGerman

● bqLangGerman_Phonebook_Sort

● bqLangGreek

● bqLangHebrew

● bqLangHungarian

● bqLangIcelandic

● bqLangIndonesian

● bqLangItalian

● bqLangJapanese

● bqLangKorean

● bqLangLatvian

● bqLangLithuanian

● bqLangMacedonian

● bqLangMalay

● bqLangNorwegian_Bokmal

● bqLangNorwegian_Nynorsk

● bqLangPolish

● bqLangPortuguese

● bqLangRomanian

● bqLangRussian

● bqLangSerbian_Cyrillic


● bqLangSerbian_Latin

● bqLangSlovak

● bqLangSlovenian

● bqLangSpanish

● bqLangSpanish_Trad_Sort

● bqLangSwedish

● bqLangThai

● bqLangTurkish

● bqLangUkrainian

● bqLangVietnamese

Action: Read/Write

DefaultSortOrderLang (Property)


Description: The DefaultSortOrderLang (Property) sets the default sort order language format that is applied to an existing Interactive Reporting document when a document is opened in a Unicode enabled application. If no default language is set (the check box is not enabled) in the user interface, this property returns 0, which does not correspond to any valid language. The sort order language of a Interactive Reporting document may be changed in order to start sorting the data according to UI language preferences.

The Application .ini file stores this property in the DefDocLanguage property of [Regional Settings]. It is interchangeable between all applications including Services.

Action: Read/Write

Example: This example shows how to read and write the value of a default sort order language in an Interactive Reporting document.

//Clear all TextBoxes except TextBox5TextBox1.Text = ""TextBox2.Text = ""TextBox3.Text = ""TextBox4.Text = ActiveSection.Namevar ActionName = "DefaultSortOrderLang"TextBox1.Text ="Start " + ActionName if (TextBox5.Text == ""){ TextBox1.Text ="Step 1" try{TextBox3.Text = "DefaultSortOrderLang is: " + Application.DefaultSortOrderLang


switch(Application.DefaultSortOrderLang){case 0: TextBox3.Text = "No Language specified"break; case 1: TextBox3.Text = "Language is bqLangAfrikaans"break; case 2: TextBox3.Text = "Language is bqLangAlbanian"break; case 3: TextBox3.Text = "Language is bqLangArabic"break; case 4: TextBox3.Text = "Language is bqLangBasque"break; case 5: TextBox3.Text = "Language is bqLangCatalan"break; case 6: TextBox3.Text = "Language is bqLangChinese_Simp"break; case 7: TextBox3.Text = "bqLangChinese_Trad"break; case 8: TextBox3.Text = "Language is bqLangChinese_GB2312_Sort"break; case 9: TextBox3.Text = "Language is bqLangChinese_Trad"break; case 10: TextBox3.Text = "Language is bqLangCroatian"break; case 11: TextBox3.Text = "Language is bqLangCzech"break; case 12: TextBox3.Text = "Language is bqLangDanish"break; case 13: TextBox3.Text = "Language is bqLangDutch"break; case 14: TextBox3.Text = "Language is bqLangEnglish"break; case 15: TextBox3.Text = "Language is bqLangUKEnglish"break; case 16: TextBox3.Text = "Language is bqLangEstonian"break; case 17: TextBox3.Text = "Language is bqLangFinnish"break; case 18: TextBox3.Text = "Language is bqLangFrench"


break; case 19: TextBox3.Text = "Language is bqLangGerman"break; case 20: TextBox3.Text = "Language is bqLangGerman_Phonebook_Sort"break; case 21: TextBox3.Text = "Language is bqLangGreek"break; case 22: TextBox3.Text = "Language is bqLangHebrew"break; case 23: TextBox3.Text = "Language is bqLangHungarian"break; case 24: TextBox3.Text = "Language is bqLangIcelandic"break; case 25: TextBox3.Text = "Language is bqLangIndonesian"break; case 26: TextBox3.Text = "Language is bqLangItalian"break; case 27: TextBox3.Text = "Language is bqLangJapanese"break; case 28: TextBox3.Text = "Language is bqLangKorean"break; case 29: TextBox3.Text = "Language is bqLangLatvian"break; case 30: TextBox3.Text = "Language is bqLangLithuanian"break; case 31: TextBox3.Text = "Language is bqLangMacedonian"break; case 32: TextBox3.Text = "Language is bqLangMalay"break; case 33: TextBox3.Text = "Language is bqLangNorwegian_Bokmal"break; case 34: TextBox3.Text = "Language is bqLangNorwegian_Nynorsk"break; case 35: TextBox3.Text = "Language is bqLangPolish"break; case 36: TextBox3.Text = "Language is bqLangPortuguese"break; case 37: TextBox3.Text = "Language is bqLangRomanian"break;


case 38: TextBox3.Text = "Language is bqLangRussian"break; case 39: TextBox3.Text = "Language is bqLangSerbian_Cyrillic"break; case 40: TextBox3.Text = "Language is bqLangSerbian_Latin"break; case 41: TextBox3.Text = "Language is bqLangSlovak"break; case 42: TextBox3.Text = "Language is bqLangSlovenian"break; case 43: TextBox3.Text = "Language is bqLangSpanish"break; case 44: TextBox3.Text = "Language is bqLangSpanish_Trad_Sort"break; case 45: TextBox3.Text = "Language is bqLangSwedish"break; case 46: TextBox3.Text = "Language is bqLangThai"break; case 47: TextBox3.Text = "Language is bqLangTurkish"break; case 48: TextBox3.Text = "Language is bqLangUkrainian"break; case 49: TextBox3.Text = "Language is bqLangVietnamese"break; default: TextBox3.Text = "Language Value is Not Available"}}catch(e){TextBox2.Text = "Caught: " + e.toString()}}else{ TextBox1.Text ="Step 2" try{Application.DefaultSortOrderLang = eval(TextBox5.Text)}catch(e){TextBox2.Text = "Caught: " + e.toString()}TextBox1.Text ="Step 3" try


{TextBox3.Text = "DefaultSortOrderLang is: " + Application.DefaultSortOrderLangswitch(Application.DefaultSortOrderLang){case 0: TextBox3.Text = "No Language specified"break; case 1: TextBox3.Text = "Language is bqLangAfrikaans"break; case 2: TextBox3.Text = "Language is bqLangAlbanian"break; case 3: TextBox3.Text = "Language is bqLangArabic"break; case 4: TextBox3.Text = "Language is bqLangBasque"break; case 5: TextBox3.Text = "Language is bqLangCatalan"break; case 6: TextBox3.Text = "Language is bqLangChinese_Simp"break; case 7: TextBox3.Text = "bqLangChinese_Trad"break; case 8: TextBox3.Text = "Language is bqLangChinese_GB2312_Sort"break; case 9: TextBox3.Text = "Language is bqLangChinese_Trad"break; case 10: TextBox3.Text = "Language is bqLangCroatian"break; case 11: TextBox3.Text = "Language is bqLangCzech"break; case 12: TextBox3.Text = "Language is bqLangDanish"break; case 13: TextBox3.Text = "Language is bqLangDutch"break; case 14: TextBox3.Text = "Language is bqLangEnglish"break; case 15: TextBox3.Text = "Language is bqLangUKEnglish"break; case 16: TextBox3.Text = "Language is bqLangEstonian"break; case 17: TextBox3.Text = "Language is bqLangFinnish"


break; case 18: TextBox3.Text = "Language is bqLangFrench"break; case 19: TextBox3.Text = "Language is bqLangGerman"break; case 20: TextBox3.Text = "Language is bqLangGerman_Phonebook_Sort"break; case 21: TextBox3.Text = "Language is bqLangGreek"break; case 22: TextBox3.Text = "Language is bqLangHebrew"break; case 23: TextBox3.Text = "Language is bqLangHungarian"break; case 24: TextBox3.Text = "Language is bqLangIcelandic"break; case 25: TextBox3.Text = "Language is bqLangIndonesian"break; case 26: TextBox3.Text = "Language is bqLangItalian"break; case 27: TextBox3.Text = "Language is bqLangJapanese"break; case 28: TextBox3.Text = "Language is bqLangKorean"break; case 29: TextBox3.Text = "Language is bqLangLatvian"break; case 30: TextBox3.Text = "Language is bqLangLithuanian"break; case 31: TextBox3.Text = "Language is bqLangMacedonian"break; case 32: TextBox3.Text = "Language is bqLangMalay"break; case 33: TextBox3.Text = "Language is bqLangNorwegian_Bokmal"break; case 34: TextBox3.Text = "Language is bqLangNorwegian_Nynorsk"break; case 35: TextBox3.Text = "Language is bqLangPolish"break; case 36:


TextBox3.Text = "Language is bqLangPortuguese"break; case 37: TextBox3.Text = "Language is bqLangRomanian"break; case 38: TextBox3.Text = "Language is bqLangRussian"break; case 39: TextBox3.Text = "Language is bqLangSerbian_Cyrillic"break; case 40: TextBox3.Text = "Language is bqLangSerbian_Latin"break; case 41: TextBox3.Text = "Language is bqLangSlovak"break; case 42: TextBox3.Text = "Language is bqLangSlovenian"break; case 43: TextBox3.Text = "Language is bqLangSpanish"break; case 44: TextBox3.Text = "Language is bqLangSpanish_Trad_Sort"break; case 45: TextBox3.Text = "Language is bqLangSwedish"break; case 46: TextBox3.Text = "Language is bqLangThai"break; case 47: TextBox3.Text = "Language is bqLangTurkish"break; case 48: TextBox3.Text = "Language is bqLangUkrainian"break; case 49: TextBox3.Text = "Language is bqLangVietnamese"break; default: TextBox3.Text = "Language Value is Not Available"}}catch(e){TextBox2.Text = "Caught: " + e.toString()}}TextBox1.Text ="End " + ActionName


UILanguage (Property)


Description: Defines the localization language of the application. This is the language of menus and messages. Its value is a member of the BqLanguage constant group.

Note: The UILanguage (Property) is not available in an Interactive Reporting document to be deployed in Workspace or in the Interactive Reporting Web Client (available offline only).

Action: Read/Write

Constants: The BqLanguage constant group consists of the following values:

● bqLangArabic

● bqLangBasque

● bqLangCatalan

● bqLangChinese_GB2312_Sort

● bqLangChinese_Simp

● bqLangChinese_Stroke_Sort

● bqLangChinese_Trad

● bqLangCroatian

● bqLangCzech

● bqLangDanish

● bqLangDutch

● bqLangEnglish

● bqLangEstonian

● bqLangFinnish

● bqLangFrench

● bqLangGerman

● bqLangGerman_Phonebook_Sort

● bqLangGreek

● bqLangHebrew

● bqLangHungarian

● bqLangIcelandic

● bqLangIndonesian

● bqLangItalian

● bqLangJapanese


● bqLangKorean

● bqLangLatvian

● bqLangLithuanian

● bqLangMacedonian

● bqLangMalay

● bqLangNorwegian_Bokmal

● bqLangNorwegian_Nynorsk

● bqLangPolish

● bqLangPortuguese

● bqLangRomanian

● bqLangRussian

● bqLangSerbian_Cyrillic

● bqLangSerbian_Latin

● bqLangSlovak

● bqLangSlovenian

● bqLangSpanish

● bqLangSpanish_Trad_Sort

● bqLangSwedish

● bqLangThai

● bqLangTurkish

● bqLangUKEnglish

● bqLangUkrainian

● bqLangVietnamese

Example: This example shows how to read and write the value of the user interface language in an Interactive Reporting document.

//Clear all TextBoxes except TextBox5TextBox1.Text = ""TextBox2.Text = ""TextBox3.Text = ""TextBox4.Text = ActiveSection.Name

var ActionName = "UILanguage"

TextBox1.Text ="Start " + ActionName

if (TextBox5.Text == ""){ TextBox1.Text ="Step 1"

try{


TextBox3.Text = "UILanguage is: " + Application.UILanguage

switch(Application.UILanguage){case 0: TextBox3.Text = "No Language specified"break; case 1: TextBox3.Text = "Language is bqLangAfrikaans"break; case 2: TextBox3.Text = "Language is bqLangAlbanian"break; case 3: TextBox3.Text = "Language is bqLangArabic"break; case 4: TextBox3.Text = "Language is bqLangBasque"break; case 5: TextBox3.Text = "Language is bqLangCatalan"break; case 6: TextBox3.Text = "Language is bqLangChinese_Simp"break; case 7: TextBox3.Text = "bqLangChinese_Trad"break; case 8: TextBox3.Text = "Language is bqLangChinese_GB2312_Sort"break; case 9: TextBox3.Text = "Language is bqLangChinese_Trad"break; case 10: TextBox3.Text = "Language is bqLangCroatian"break; case 11: TextBox3.Text = "Language is bqLangCzech"break; case 12: TextBox3.Text = "Language is bqLangDanish"break; case 13: TextBox3.Text = "Language is bqLangDutch"break; case 14: TextBox3.Text = "Language is bqLangEnglish"break; case 15: TextBox3.Text = "Language is bqLangUKEnglish"break; case 16: TextBox3.Text = "Language is bqLangEstonian"break; case 17: TextBox3.Text = "Language is bqLangFinnish"break; case 18: TextBox3.Text = "Language is bqLangFrench"


break; case 19: TextBox3.Text = "Language is bqLangGerman"break; case 20: TextBox3.Text = "Language is bqLangGerman_Phonebook_Sort"break; case 21: TextBox3.Text = "Language is bqLangGreek"break; case 22: TextBox3.Text = "Language is bqLangHebrew"break; case 23: TextBox3.Text = "Language is bqLangHungarian"break; case 24: TextBox3.Text = "Language is bqLangIcelandic"break; case 25: TextBox3.Text = "Language is bqLangIndonesian"break; case 26: TextBox3.Text = "Language is bqLangItalian"break; case 27: TextBox3.Text = "Language is bqLangJapanese"break; case 28: TextBox3.Text = "Language is bqLangKorean"break; case 29: TextBox3.Text = "Language is bqLangLatvian"break; case 30: TextBox3.Text = "Language is bqLangLithuanian"break; case 31: TextBox3.Text = "Language is bqLangMacedonian"break; case 32: TextBox3.Text = "Language is bqLangMalay"break; case 33: TextBox3.Text = "Language is bqLangNorwegian_Bokmal"break; case 34: TextBox3.Text = "Language is bqLangNorwegian_Nynorsk"break; case 35: TextBox3.Text = "Language is bqLangPolish"break; case 36: TextBox3.Text = "Language is bqLangPortuguese"break; case 37: TextBox3.Text = "Language is bqLangRomanian"break;


case 38: TextBox3.Text = "Language is bqLangRussian"break; case 39: TextBox3.Text = "Language is bqLangSerbian_Cyrillic"break; case 40: TextBox3.Text = "Language is bqLangSerbian_Latin"break; case 41: TextBox3.Text = "Language is bqLangSlovak"break; case 42: TextBox3.Text = "Language is bqLangSlovenian"break; case 43: TextBox3.Text = "Language is bqLangSpanish"break; case 44: TextBox3.Text = "Language is bqLangSpanish_Trad_Sort"break; case 45: TextBox3.Text = "Language is bqLangSwedish"break; case 46: TextBox3.Text = "Language is bqLangThai"break; case 47: TextBox3.Text = "Language is bqLangTurkish"break; case 48: TextBox3.Text = "Language is bqLangUkrainian"break; case 49: TextBox3.Text = "Language is bqLangVietnamese"break; default: TextBox3.Text = "Language Value is Not Available"}

}catch(e){TextBox2.Text = "Caught: " + e.toString()}

}

else{ TextBox1.Text ="Step 2" try{Application.UILanguage = eval(TextBox5.Text)}catch(e)


{TextBox2.Text = "Caught: " + e.toString()}

TextBox1.Text ="Step 3"

try{TextBox3.Text = "UILanguage is: " + Application.UILanguage

switch(Application.UILanguage){case 0: TextBox3.Text = "No Language specified"break; case 1: TextBox3.Text = "Language is bqLangAfrikaans"break; case 2: TextBox3.Text = "Language is bqLangAlbanian"break; case 3: TextBox3.Text = "Language is bqLangArabic"break; case 4: TextBox3.Text = "Language is bqLangBasque"break; case 5: TextBox3.Text = "Language is bqLangCatalan"break; case 6: TextBox3.Text = "Language is bqLangChinese_Simp"break; case 7: TextBox3.Text = "bqLangChinese_Trad"break; case 8: TextBox3.Text = "Language is bqLangChinese_GB2312_Sort"break; case 9: TextBox3.Text = "Language is bqLangChinese_Trad"break; case 10: TextBox3.Text = "Language is bqLangCroatian"break; case 11: TextBox3.Text = "Language is bqLangCzech"break; case 12: TextBox3.Text = "Language is bqLangDanish"break; case 13: TextBox3.Text = "Language is bqLangDutch"break; case 14: TextBox3.Text = "Language is bqLangEnglish"break; case 15: TextBox3.Text = "Language is bqLangUKEnglish"


break; case 16: TextBox3.Text = "Language is bqLangEstonian"break; case 17: TextBox3.Text = "Language is bqLangFinnish"break; case 18: TextBox3.Text = "Language is bqLangFrench"break; case 19: TextBox3.Text = "Language is bqLangGerman"break; case 20: TextBox3.Text = "Language is bqLangGerman_Phonebook_Sort"break; case 21: TextBox3.Text = "Language is bqLangGreek"break; case 22: TextBox3.Text = "Language is bqLangHebrew"break; case 23: TextBox3.Text = "Language is bqLangHungarian"break; case 24: TextBox3.Text = "Language is bqLangIcelandic"break; case 25: TextBox3.Text = "Language is bqLangIndonesian"break; case 26: TextBox3.Text = "Language is bqLangItalian"break; case 27: TextBox3.Text = "Language is bqLangJapanese"break; case 28: TextBox3.Text = "Language is bqLangKorean"break; case 29: TextBox3.Text = "Language is bqLangLatvian"break; case 30: TextBox3.Text = "Language is bqLangLithuanian"break; case 31: TextBox3.Text = "Language is bqLangMacedonian"break; case 32: TextBox3.Text = "Language is bqLangMalay"break; case 33: TextBox3.Text = "Language is bqLangNorwegian_Bokmal"break; case 34: TextBox3.Text = "Language is bqLangNorwegian_Nynorsk"break; case 35:


TextBox3.Text = "Language is bqLangPolish"break; case 36: TextBox3.Text = "Language is bqLangPortuguese"break; case 37: TextBox3.Text = "Language is bqLangRomanian"break; case 38: TextBox3.Text = "Language is bqLangRussian"break; case 39: TextBox3.Text = "Language is bqLangSerbian_Cyrillic"break; case 40: TextBox3.Text = "Language is bqLangSerbian_Latin"break; case 41: TextBox3.Text = "Language is bqLangSlovak"break; case 42: TextBox3.Text = "Language is bqLangSlovenian"break; case 43: TextBox3.Text = "Language is bqLangSpanish"break; case 44: TextBox3.Text = "Language is bqLangSpanish_Trad_Sort"break; case 45: TextBox3.Text = "Language is bqLangSwedish"break; case 46: TextBox3.Text = "Language is bqLangThai"break; case 47: TextBox3.Text = "Language is bqLangTurkish"break; case 48: TextBox3.Text = "Language is bqLangUkrainian"break; case 49: TextBox3.Text = "Language is bqLangVietnamese"break; default: TextBox3.Text = "Language Value is Not Available"}

}catch(e){TextBox2.Text = "Caught: " + e.toString()}

}

TextBox1.Text ="End " + ActionName


ResetDefaultSortOrderLang (Method)


Description: Clears the current sort order language. This action is the equivalent of disabling the Use this choice by default on the International tab of the Properties dialog box.

Example: This example shows how to use the ResetDefaultSortOrderLang (Method) to clear the default sort order language.

//Clear all textboxes except TextBox5TextBox1.Text = ""TextBox1.Text = ""TextBox1.Text = ""TextBox4.Text = ActiveSection.Namevar ActionName = "ResetDefaultSortOrderLang new"TextBox1.Text ="Start " + ActionNametry{Application.ResetDefaultSortOrderLang()}catch(e){TextBox2.Text = "Caught: " + e.toString()}TextBox1.Text ="End " + ActionName

Export (Method)

Applies To: ChartSection object, DataModelSection object, Document object, DashboardSection object, OLAPQuerySection object, PivotSection object, QuerySection object, ResultsSection object, Section object, TableSection object, ReportSection object

Description: Creates a new file with the information from a section object. Files can be created using the standard data formats from the BqExportFileFormat constant group.

Note: For UNIX users of the Export and ExportToStream methods, Interactive Reporting references the umask command of the user running the BIService to determine the three-digit octal code. This code defines the read-write-execute permissions to be turned off. Typically, umask is used in .login or .profile and in the Bourne and C shells. It is a built-in command.

Syntax: Expression.Export(Filename As String, [optional] FileFormat As BqExportFileFormat, [optional]IncludeHeaders As Boolean], [optional] Boolean Prompt, [optional] BqEncoding Encoding)

Expression Required: An expression that returns an object for any of the following sections:


● ChartSection

● DataModelSection

● DashboardSection

● OLAPQuerySection

● PivotSection

● QuerySection

● Section

● TableSection

Constants: The BqExportFileFormat constant group consists of the following values:

● bqExportFormatCSV

● bqExportFormatExcel2


● bqExportFormatHTML

● bqExportFormatJPEG

● bqExportFormatLotus123

● bqExportFormatPDF

● bqExportFormatText

● bqExportFormatOfficeHTML

● bqExportFormatOfficeMHTML

The BQEncoding constant group values include:

● bqEnc_Arabic_ISO


● bqEnc_Baltic_ISO



● bqEnc_CentralEuropean_ISO



● bqEnc_Chinese_GB2312


● bqEnc_Chinese_HZ

● bqEnc_Cyrillic_DOS

● bqEnc_Cyrillic_ISO


● bqEnc_Cyrillic_KOI8R

● bqEnc_Cyrillic_KOI8U


● bqEnc_Greek_ISO



● bqEnc_Japanese_EUC

● bqEnc_Japanese_JIS


● bqEnc_Korean


● bqEnc_Turkish_ISO


● bqEnc_Unicode

● bqEnc_Unicode_UTF16

● bqEnc_Unicode_UTF16_BigEndian

● bqEnc_Unicode_UTF16_LittleEndian






● bqEnc_WesternEuropean_ISO


For information on exporting an Interactive Reporting document to HTML format statically, see HTMLExportBreakRowCount (Property) and HTMLVerticalPageBreakUnits (Property) in the Object Model Guide to Properties and Constants.

For information on exporting an Interactive Reporting document to the HTML format dynamically (for use with the Hyperion System 9 BI + Workspace), see HTMLPregenerateMode (Property), HTMLPregenerateFirstLastNPages (Property), DHTMLExportBreakRowCount (Property), and DHTMLVerticalPageBreakUnits (Property) in the Object Model Guide to Properties and Constants.

Example: This example shows how to export a Results section to HTML. The first part of the script creates a computed column that displays the contents of the URL columns as HTML HREFs:

//Call the JavaScript link() method to convert the string to HREFsvar ComputedExpression = "URL.link()"


ActiveDocument.Sections["Results"].Columns.AddComputed("Clickable URLS",ComputedExpression)ActiveDocument.Sections["Results"].Export("C:\\HTML\\MyResults.htm", bqExportFormatHTML,false)

ExportToStream (Method)

Applies To: ChartSection object, DataModelSection object, Document object, DashboardSection object, OLAPQuerySection object, PivotSection object, QuerySection object, ResultsSection object, Section object, TableSection object, ReportSection object

Description: The ExportToStream (Method) enables you to use data streaming in Hyperion System 9 BI + Workspace. Streamed data displays before the entire file is exported. This feature improves performance.

If the file name and associated path information are specified when this method, this information is ignored when streaming is enabled. In the case of Interactive Reporting Studio, the file name and associated path information are used for writing data to disk with no additional errors cited when streaming is enabled (as in the case of export without streaming).

Note: For UNIX users of the Export and ExportToStream methods, Interactive Reporting references the umask command of the user running the BIService to determine the three-digit octal code. This code defines the read-write-execute permissions to be turned off. Typically, umask is used in .login or .profile and in the Bourne and C shells. It is a built-in command.

Syntax: Expression.Export( [optional]String Filename, [optional]BqExportFileFormat FileFormat, [optional]Boolean IncludeHeaders, [optional]Boolean DataStreaming, [optional]Boolean Prompt, [optional] BqEncoding Encoding)

Expression Required: An expression that returns an object for any of the following sections:

● ChartSection

● DataModelSection

● DashboardSection

● OLAPQuerySection

● PivotSection

● QuerySection

● Section

● TableSection


Constants: The ExportToStream (Method) uses the BqExportFileFormat constant group, which consists of the following values:

● bqExportFormatCSV



● bqExportFormatHTML

● bqExportFormatJPEG

● bqExportFormatLotus123

● bqExportFormatPDF

● bqExportFormatText

● bqExportFormatOfficeHTML

● bqExportFormatOfficeMHTML

















● bqEnc_Greek_ISO






● bqEnc_Korean





● bqEnc_Unicode











Example: This example shows how to export a Results section in a data stream to HTML. Because the streaming is enabled, no file name and associated path information have been specified:

ActiveDocument.Sections["Results"].ExportToStream("", bqExportFormatHTML, false, true, false)

ImportDataFile (Method)

Applies To: Sections collection, WebClientDocument object

Description: Imports a data file into a Query section.

Syntax: Expression.ImportDataFile(Filename As String, FileType As BqImportDataFileFormat, [optional] BqEncoding Encoding)

Expression Required: An expression that returns a Sections object

Constants: The BqImportDataFileFormat constant group contains the following values:

● bqImportFormatCommaText

● bqImportFormatExcel

● bqImportFormatTabText


















● bqEnc_Greek_ISO






● bqEnc_Korean




● bqEnc_Unicode











Example: This example shows how to import a comma separated data file:

var Filename = "C:\\Imports\\SalesData.csv"var MySection = ActiveDocument.Sections.ImportDataFile(Filename, bqImportFormatCommaText)


ImportSQLFile (Method)

Applies To: QuerySection

Description: Imports a complete SQL statement from a text file into an existing query, and retrieves the data set from the database server. When you import a file, it is scanned to determine the number of columns that will be returned by the SQL, with the request line becoming populated with a column indicator for each of the columns. Using this feature, you can take advantage of SQL statements that you have already written.

Before using this method, be sure that you are connected to a database server. The Query section to which you are importing the SQL must have no tables. In addition, the SQL file to be imported must begin with a SELECT statement and you should know the number of columns to be displayed in the Results section. When the SQL file has been imported into the query, you can drag items from the table to the Request line, use the Custom SQL feature, or display its properties.The imported SQL file cannot be edited, but you can specify a user-friendly name for the Request line item and identify its data type.

Syntax: Expression.ImportSQLFile(Filename As String,numColumns As Number, [optional] BqEncoding Encoding)

Expression Required: An expression that returns a Query object

Constants: The BQEncoding constant group values include:
















● bqEnc_Greek_ISO







● bqEnc_Korean




● bqEnc_Unicode











Example: This example shows how to set the imported SQL file name, and process the query:

var Filename = "C:\\Program Files\\Hyperion\\BIPlus\\docs\Samples\\SQLLoad\\SalesData.sql"var MySection = ActiveDocument.Sections["Query"].ImportSQLFile(Filename, 2)ActiveDocument.Sections["Query"].Process()

Printout (Method)

Applies To: Workspace object

Description: The Printout (Method) enables the data sent back to the client browser to include a PDF file as part of the data stream when the server finishes processing a script. This PDF data opens in a new window using the Adobe Acrobat Reader (version 7.0.1 or later required), and the Adobe Print dialog box is displayed. Users must reset the Print Range options in Adobe Acrobat Reader before clicking OK to initiate the printing.

Note that the script is run in its entirety before the PDF data is sent to the client browser. This may cause some unexpected behavior with existing documents, such as those with a script that displays an Alert dialog box saying “Print Complete”, when in fact it has not even started. Script authors should be aware of these factors when designing the application.

Use of the Alert (Method) after the Printout (Method) prevents the Printout (Method) from being executed in Workspace.

Printout (Method) 73

When used inWorkspace, the optional parameters of the method, such as pages to print, number of copies, etc., are ignored. These options can be specified in the Adobe Acrobat Reader’s Print dialog.

The Printout() method is not supported in scripts that run as the result of Document events (such as OnStartup). It is also not supported for section-level activation and deactivation events. The Printout() method has no effect on jobs and does not cause a printout to occur. It is also not supported when used as a method of a section of type Query or Datamodel.

Action: Read-Write

Object Model Exclusion ListThis section provides a list of those objects, methods and properties that you cannot reference when you design an Interactive Reporting document for deployment in Workspace. When a method or property on this list is encountered in a script, a warning is entered in an error log file and execution of the script continues if possible. If you need to include the syntax shown below, be sure to include it in an Interactive Reporting document designed for desktop viewing.

● ActiveDocument.Close()

● ActiveDocument.SetODSPassword()

● ActiveDocument.ODSUsername (Set only)

● ActiveDocument.Save()

● ActiveDocument.SaveAs()

● ActiveDocument.Sections["SectionName"].Copy()

● ActiveDocument.Sections["Chart"].XLabels.DrillInto()

● ActiveDocument.Sections["Dashboard"].Shapes["TextBox1"].OnChange()

● ActiveDocument.Sections["Dashboard"].Shapes["TextBox1"].OnEnter()

● ActiveDocument.Sections["Dashboard"].Shapes["ListBox1"].OnDoubleClick()

● ActiveDocument.Sections["Dashboard"].Shapes["Results1"].OnRowDoubleClick()

● ActiveDocument.Sections["OLAPQuery"].Slicers.Add()

Only the case where the last argument VariableSlicer=TRUE. Ignores the last argument, always defaulting to VariableSlicer=FALSE

● ActiveDocument.Sections["Query"].DataModel.Connection.DBLibAllowChangeDatabase

● ActiveDocument.Sections["Query"].DataModel.Connection.DBLibApiSeverity

● ActiveDocument.Sections["Query"].DataModel.Connection.DBLibDatabaseCancel

● ActiveDocument.Sections["Query"].DataModel.Connection.DBLibPacketSize

● ActiveDocument.Sections["Query"].DataModel.Connection.DBLibServerSeverity


● ActiveDocument.Sections["Query"].DataModel.Connection.DBLibUseQuotedIdentifiers

● ActiveDocument.Sections["Query"].DataModel.Connection.DBLibUseSQLTable

● ActiveDocument.Sections["Query"].DataModel.Connection.SaveWithoutUsername

● Application.CreateConnection()

● Application.DoEvents()

● Application.LoadSharedLibrary()

● Application.Shell()

● Application.ShowMenuBar()

● Application.Quit()

● Application.UILanguage() (set only)

● Console.Write()

● Console.WriteLn()

● Document.Close()

● Documents.Open()

● JOOLE Objects

Dashboard Export to HTML (Dashboards only exports JPG in other client applications)

The following properties do not have any user interface effect in Workspace, but the values set must be retained as part of the Interactive Reporting document. In the event that the Interactive Reporting document is saved locally for use with other Interactive Reporting clients, any changes made from the Workspace should be reflected. When encountered in a script, the methods and properties on this list do not cause an entry in an error log file and execution of the script continues.

● ActiveDocument.ShowCatalog

● ActiveDocument.ShowSectionTitleBar

● ActiveDocument.Sections["Query"].DataModel.Connection.SaveWithoutUsername

● ActiveDocument.Sections["Query"].DataModel.Connection.ShowMetadata

● ActiveDocument.Sections["Query"].DataModel.Limits["Year"].VariableLimit

● ActiveDocument.Sections["Query"].DataModel.MetaDataConnection.SaveWithoutUsername

● ActiveDocument.Sections["Query"].DataModel.MetaDataConnection.ShowMetadata

● ActiveDocument.Sections["Query"].DataModel.ShowIconJoins

● ActiveDocument.Sections["Query"].Limits["Quarter"].VariableLimit

● ActiveDocument.Sections["Query"].SaveResults

● ActiveDocument.Sections["DataModel"].DataModel.AutoJoin

● ActiveDocument.Sections["DataModel"].DataModel.Connection.SaveWithoutUsername

● ActiveDocument.Sections["DataModel"].DataModel.Connection.ShowMetadata

● ActiveDocument.Sections["DataModel"].DataModel.Limits["Year"].VariableLimit

Printout (Method) 75

● ActiveDocument.Sections["DataModel"].DataModel.MetaDataConnection.SaveWithoutUsername

● ActiveDocument.Sections["DataModel"].DataModel.MetaDataConnection.ShowMetadata

● ActiveDocument.Sections["DataModel"].DataModel.ShowIconJoins

● ActiveDocument.Sections["SectionName"].ShowOutliner

● ActiveDocument.Sections["Dashboard"].Shapes["EmbeddedSection"].ScrollbarsAlwaysShown

● ActiveDocument.Sections["Dashboard2"].Shapes["EmbeddedSectionResults"].ShowOutliner

● ActiveDocument.Sections["Dashboard2"].Shapes["Embedded"].ShowRowNumbers

● Application.ShowMenuBar

● Application.ShowStatusBar

● Application.StatusText

● Application.Visible

● Application.WindowState

● BqFontEffectOverDouble

● BqFontEffectOverLine

● BqFontEffectStrikeThru

● BqFontEffectSuperScript

● BqFontEffectSubScript

● Toolbars.Count

● Toolbars["Formatting"].Name

● Toolbars["Formatting"].Type

● Toolbars["Formatting"].Visible

● Toolbars["Sections"].Name

● Toolbars["Sections"].Type

● Toolbars["Sections"].Visible

● Toolbars["Navigation"].Name

● Toolbars["Navigation"].Type

● Toolbars["Navigation"].Visible


Dashboard Development Services EnhancementsEnhancements to Dashboard Development Services (Dashboard Studio, Dashboard Architect, and Components) include:

● “Unicode Enhancements” on page 76

● “Select User Interface Font and Language Options” on page 76

● “Lookup Component” on page 77

● “Accessing Multiple Point of View Embedded Browsers with Option Buttons” on page 77

● “Diagnostics Frame” on page 80

● “Language Properties Configuration Frame” on page 80

● “Make Suggestion Option” on page 81

● “Quick Filters Text Box” on page 81

● “Export Formats” on page 83

● “Date Formats Configuration Frame” on page 83

● “Configuration Frame Navigation Buttons” on page 83

Unicode EnhancementsThe Dashboard Studio Merge Utility and Import feature, and Dashboard Architect Import Utility were modified to automatically convert old code page based Interactive Reporting documents to Unicode before use, enabling documents with different languages to be merged or imported. Only the resulting documents are converted, originals remain unchanged.

The Dashboard Development Services Update Utility and Dashboard Studio Optimize Utility have also been extended to manipulate Unicode Interactive Reporting documents.

Select User Interface Font and Language OptionsThe ability to set the UI font and the UI language has been added to the Options dialog boxes in Dashboard Architect, Dashboard Studio, and the Dashboard Studio Optimize Utility. Previous releases of Dashboard Architect provided the ability to set the UI and code text fonts, however in Release 9.2, this is extended to include language settings.

Enabling the user to select the UI font and language is necessary for localized and Unicode releases, as fonts and languages display characters differently.

Note: Users must select an appropriately sized font that suits the UI, otherwise characters may be too large and cut off.

Dashboard Development Services Enhancements 77

Lookup ComponentAn option to escape the URL in the Dashboard Development Services Lookup component has been added, because in localized releases of the component, an issue may arise where characters are not recognized. The selected address is displayed incorrectly or not at all, and the Web browser Address box displays extra characters. In this case, you must change the value in text label called txlEscaped on Qiq_addresslookup.

Change the value in txlEscaped to be

1=Escaped0=Not escaped

Note: The escape option is on by default.

Accessing Multiple Point of View Embedded Browsers with Option ButtonsDashboard developers who want to place related documents on one dashboard frame, to enable users to view related information within one context, and without moving from frame to frame, can use option buttons.

A single Point of View (POV) embedded browser can occupy more than half the screen, so placing multiple POV objects on one frame can be difficult. The Point of View component enables you to share one embedded browser between multiple POV objects. Users select an option button to switch between POV views.

For example, to switch between Enterprise Metrics and Financial Reporting, click an option button.

As a Point of View object is displayed on a frame through an embedded browser, dashboard developers must create the embedded browser.


➤ To create a shared Point of View embedded browser:

1 In Interactive Reporting Studio, navigate to a frame that will contain the POV objects.

2 Press Ctrl+D to enter Design mode.

3 From the catalog pane, expand Controls, and drag an embedded browser object onto the frame.

4 Double-click the browser object.

Properties is displayed.

5 Type all^Hysl_pov as the object name.

6 Click OK.

7 Press Ctrl+D to exit Design mode.

Note: Some legacy information about adding option buttons is contained in the current documentation. This information is still applicable, yet the option buttons are not as efficient as this latest information.

Adding Option ButtonsThe POV component enables you to use option buttons to switch between embedded browsers, and reduce the amount of space used.

➤ To add option buttons:

1 In Interactive Reporting Studio, open a dashboard frame containing POV embedded browsers.


3 From the catalog pane, expand Controls, and drag an option button onto the frame.

4 Double–click the option button.


5 Type <url_name>^Hysl_pov^rbt as the object name.

For example, for a URL named Metrics_Clip, type Metrics_Clip^Hysl_pov^rbt.

6 Click OK.

7 Select the option button, right–click, and select Scripts.

Scripts Editor is displayed.

8 In Scripts Editor, perform an action:

● Type this line of code:

ActiveDocument.Sections[txlMe.Text].Qiq_onControlClick(this.Parent,this)

● Copy and paste the line of code from another button on the frame to avoid typing errors


9 Click OK.

10 Repeat steps 3–9 for every option button to be added.


Creating Multiple Shared Embedded BrowsersUsers with large screen sizes can place multiple shared POV embedded browsers on a frame. Each shared browser is individually controlled by a set of option buttons.

➤ To create multiple shared embedded browsers:

1 In Interactive Reporting Studio, navigate to a frame that will contain the POV objects.


3 From the catalog pane, expand Controls, and drag an embedded browser object onto the frame.

4 Double-click the browser object.


5 Type all2^Hysl_pov as the object name.

The object name numbers must be sequential. For example, enter all3^Hysl_pov, all4^Hysl_pov, and so on.

6 To assign an option button to a shared browser, use the procedural steps in Adding Option Buttons, and name it <url_name>^Hysl_pov^rbt^<browser_id>.

For example, to assign an option button with a Metrics_Clip URL to the shared browser all2^Hysl_pov, name the option button Metrics_Clip^Hysl_pov^rbt^all2.

If a browser_id is not specified, the option button will point to the default shared browser, all^Hysl_pov.

7 Select the option button, right–click, and select Scripts.

Scripts Editor is displayed.

8 In Scripts Editor, perform an action:

● Type this line of code

ActiveDocument.Sections[txlMe.Text].Qiq_onControlClick(this.Parent,this)

● Copy and paste the line of code from another button on the frame to avoid typing errors

9 Click OK.



Diagnostics FrameIn the Dashboard Studio Diagnostics frame, the Show Timings in Notepad button has been renamed to Export Timings. The timing information is now added to the trace log within the Interactive Reporting document, as tab-delimited text, and can be read by Workspace. Previously the information was written to a text file which was not available in Workspace.

Another button called Show Complexity has been added. This button summarizes the dashboard and compiles statistics for each section, for example, the number of objects by type, number of rows, and so on. The summary information can be saved into Excel and used to evaluate the complexity of the Interactive Reporting document. The information can then be imported into Interactive Reporting Studio for further analysis of the dashboard.

Language Properties Configuration FrameDashboard Studio templates Release 9.2 contain strings for all supported languages. These include English, French, German, Japanese, Simplified Chinese, and Korean. As a result, the dashboard may be slightly larger.

The Language Properties configuration frame was introduced in Release 8.5 to enable users to remove unnecessary languages from templates, editable source master (ESM) documents, or runtime dashboards. The frame is now available in 9.2 templates.

➤ To remove languages:

1 Move selected sections between Available Languages and Languages to Remove, by clicking or

.

2 Perform an action.

● Apply changes immediately.

a. Click Apply Now to remove languages from the current document.

The operation is not reversible. Selected languages will not be available in the template or ESM. A dialog box is displayed to confirm that the selected languages are to be removed.

b. Click OK.

The selected languages are removed from the document.

● Click Apply at Runtime to remove languages when the document is converted into a runtime release.

In this case, only the runtime document is affected and all languages are still available in the template or ESM.

Note: English is the default language for dashboards and is not available for deletion.


Make Suggestion OptionWhen using a localized release of Dashboard Studio, in Step 1: Create Queries, Tables, Charts,

Pivots and Reports, you must click for each section to ensure that localized chart or pivot

equivalents are appended to the section names. If is not clicked, clicking in Step 2 to automatically create frames may fail, because the suffix is not recognized.

Quick Filters Text BoxIn Dashboard Studio Release 9.2, the Quick Filters feature is extended to enable the configuration of text boxes to allow filter values to be entered and set.

Configuring a Quick Filters Text Box

➤ To configure a Quick Filters text box:

1 In Interactive Reporting Studio, press Ctrl+D to enter Design mode.

2 Select the text box, right–click, and select Properties.


3 Optional: If no sample text box is visible, from the catalog pane, expand Controls, and drag a text box object onto the frame.

4 In Name, replace Some_Filter with the name of the filter to be set.

For example, to associate the filter called Quarter with the text box, replace Some_Filter^qiqtxb1 with Quarter^qiqtxb1.

The specified filter name must match the name of a filter created in a table or results. In this respect, Interactive Reporting Studio is case-sensitive.

If a filter name contains a space, replace the space with an underscore (_) when setting the text box name; for example, Year_Name^qiqtxb.

5 Click OK.


Note: There is no sample text box provided in templates for this release.

Set Filter Command ButtonQuick Filters text boxes also come with a Set Filter command button. Use one command button to set filters from one or more text boxes on a frame, or configure a command button for each available text box.

If the name of the command button begins with qiqall for example, qiqall^qiqtxbcbt, the command button sets filter values selected from all text boxes on the frame.


To configure a command button to set filters for only one text box, replace qiqall from the object name with the name of the filter with which the button is associated. For example, a command button named Region^qiqtxbcbt sets values selected from only a text box called Region^qiqtxb.

Select values from multiple text boxes, and click the command button once to set all selected filters or multiple times to set values from one text box at a time. Although it may be faster to set filters by using the first method, if mutually exclusive conditions are selected, the first method can result in no data being displayed.

You can set one or more filter values at a time. If you are not familiar with the data, it may be best to select values from one text box and click the command button before selecting values from another text box.

Configuring Command ButtonsCommand buttons activate selected filters in a text box. Two options are available for configuring command buttons:

● Set one command button to activate all selected values.

● One command button is configured for each text box.

➤ To configure Quick Filters command buttons associated with text boxes:

1 In Interactive Reporting Studio, press Ctrl+D to enter Design mode.

2 Double–click a command button.


3 In Name, replace qiqall with the name of the associated text box.

For example, to set filters for Region values, replace qiqall with Region. In this respect, Interactive Reporting Studio is case–sensitive.

4 Enter a title that is visible to end users.

5 Copy and paste as many instances of the command button as required.

6 Repeat steps 2–5 to configure each button.

The sample button does not require configuring if a command button is not assigned to each text box.

7 Position the configured filter handlers on the frame.

The filter handlers are activated when selections are applied in the documents. See Step 6: Configure Filters of Dashboard Studio.

8 Click OK.



Export FormatsDashboard Studio Release 9.2 enables embedded sections to be exported to Microsoft Office HTML and Microsoft Office Web Archive (.MHTML) formats on Workspace.

➤ To export to one of these options:

1 In Workspace, select a dashboard frame with embedded sections, and click .

Workspace Export is displayed.

2 Select Section Names to export.

3 Select a File format option.

4 Click Export.

A popup is displayed enabling the embedded section to be viewed or saved.

Note: This feature is available in Hyperion System 9 BI+ Workspace; however, exporting to Office Web Archive may fail due to Internet Explorer security restrictions. Therefore, export the document as Office HTML, and save as a Web Archive when open in Internet Explorer.

Date Formats Configuration Frame Custom date formats can be entered and maintained in Interactive Reporting documents using the new Date Formats configuration frame. The new date formats are available when defining the As of Date in Step 7: Configure Properties of Dashboard Studio.

In previous releases, custom date formats were created for Quick Filters using the Filter Control EIS frame. In Dashboard Studio 9.2, the date function has been removed from the Filter Control EIS frame, however it does provide a list of predefined formats to associate with filters.

Configuration Frame Navigation ButtonsA set of buttons has been added to Dashboard Studio configuration frames to enable easy navigation from one step to another in a multi-form configurator. For single-form configurators, these buttons are not selectable.

These buttons are:

Production Reporting Enhancements 85

C h a p t e r

5Production Reporting

Enhancements

This chapter lists the changes and enhancements made to Hyperion System 9 BI + Production Reporting Release 9.2.

In This Chapter SAP BW Variable Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Localization of Production Reporting DDO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Additional Language Support for the HTML Navigation Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

86 Production Reporting Enhancements

SAP BW Variable SupportSee Chapter 6, “SAP BW Enhancements” for information on the enhancements to SAP BW Variable support.

Localization of Production Reporting DDOProduction Reporting DDO is localized in Release 9.2.

Additional Language Support for the HTML Navigation BarNew languages supported on the HTML Navigation Bar include Italian, Korean, and TChinese.

➤ To define the HTML Navigation Bar language in Production Reporting, use the -EH:language command-line flag.

➤ To define the HTML Navigation Bar language in Production Reporting Studio, select File/Edit > Preferences and select a language on the Navigation Bar tab.

Flag Description Program Database

-EH_LANGUAGE:xx Defines the HTML navigation bar language. You can specify English, French, German, Italian, Japanese, Korean, Portuguese, Spanish, SChinese, or TChinese.

Note: Only applicable with -PRINTER:EH or -PRINTER:EP.

Production Reporting ServerProduction Reporting ExecuteProduction Reporting Print

All

SAP BW Enhancements 87

C h a p t e r

6SAP BW Enhancements

This chapter lists the changes and enhancements made to SAP BW Release 9.2.

In This Chapter Support for SAP Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Support for SAP Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

SAP Security Integration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Support for Key Figure Creation (Web Analysis Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

88 SAP BW Enhancements

Support for SAP VariablesRelease 9.2 enhances the existing SAP BW variable support.

● “About SAP Variables” on page 88

● “Variables and Processing Types” on page 88

● “Variable Type Options” on page 89

● “VariableValue Text Function (Financial Reporting Only)” on page 90

About SAP VariablesSAP variables are query parameters defined in the BEx Query designer. They function as a store for characteristic values, hierarchies, hierarchy nodes, texts, and formula elements.

SAP variables are displayed in a Variable dialog box when creating a new Web Analysis, Production Reporting, or Financial Reporting document, opening a Web Analysis, Production Reporting, or Financial Reporting document, or explicitly selecting to refresh the variables from the shortcut menu in the Content pane. SAP variables are displayed only if the database connection is created against a BEx query with variables defined.

Users are prompted for variable values only if the variable was created in the original BEx query with Ready for Input selected. For variables that do not have Ready for Input selected, the default variable values are applied to the Web Analysis, Production Reporting, or Financial Reporting document upon creation.

Variables and Processing TypesIn order to run a variable, it must be associated with a processing type, which identifies in which way the variable is processed. Release 9.2 enhances the existing SAP BW variable support to include new these variable and processing type combinations:

Table 9 Variable and Processing Type Combinations

Variable Type

Processing TypeCharacteristic Values Hierarchies Hierarchy Nodes Formula

Manual Entry/Default Value

X X X X

Customer Exit X X X X

SAP Exit X X X

Authorization X X

Support for SAP Variables 89

Table 10 describes each variable type.

Table 11 describes each processing type.

Variable Type OptionsThere are five options for each variable type (with the exception of Hierarchies variables with all processing types and any variable type with the Replacement Path processing type) that determine the way values are selected for each variable. In the BEx variable dialog, they are listed under Variable Represents:

Table 10 Variable Descriptions

Variable/Processing Type Description

Characteristic Most common type of variable. Most common processing type is manual/ default with ready for input setting. Allows characteristic value to be selected at query run time. Authorization processing type—looks to the end-users’ authorization settings as defined with transaction RSMM and uses the value found there as input for the variable.

Hierarchy Behaves in same manner as characteristic variables. Represent an entire hierarchy tree for a given characteristic. Allow the query user to select new hierarchies versus simply selecting a different node within the same hierarchy.

Hierarchy Node Behaves in same manner as characteristic variables. Represents a given substructure within a hierarchy.

Formula Query parameters set in the query definition and not filled with values (processed) until the query is inserted into a workbook. Formula variables function as a store for individual formula elements.

Table 11 Processing Type Descriptions

Variable/Processing Type Description

Manual Entry/Default Value Variables processed with this processing type allow you to manually enter a value before inserting the query into the workbook. When you create the variables, you determine whether to enter a default value using the default value data.

Customer Exit ABAP code that may be written by SAP customer to fill a variable.

SAP Exit ABAP code written by SAP to fill a variable value.

Authorization Indicates that variable value is stored with user authorization.

Table 12 Variable Type Options

Option Name Variable Represents

Single Value One value only.

Multiple Single Values

Number of single values. Useful in hierarchy nodes, for example, to allow you to enter several single nodes.


Values for each of these options are supported in the Variable dialog box.

There are three additional options for each variable type that determine whether a value is required for the variable. In the BEx Variable dialog box, they are listed under Variable Value Is:

Variable Value Is can be modified after creating a variable in BEx, but Variable Represents can be set only at variable creation time.

VariableValue Text Function (Financial Reporting Only)The VariableValue text function allows users to know what values are used for a SAP-BW variable response. The report’s output displays the values selected. The function can be used within grids and text objects. The syntax is:

<<VariableValue (“GridName”, “VariableName”)>>

Where:

● “GridName” is the name of the grid with a SAP-BW data source. The “current” keyword is supported when the function is used inside of a grid (text cell and custom heading).

● “VariableName” is the name of the SAP-BW variable containing the return information. The VariableName can be either the technical name or the description.

Note: As with all other text functions, the optional quotes should be used when the variable name contains non-alphanumeric characters, such as parenthesis or commas.

Interval From and to value, that is, an interval.

Selection Option Any combination of single values and intervals.

Precalculated Value set

Set of values that are staged persistently in a database table by the Reporting Agent.

Table 13 Options for Variable Value Is

Variable Value Is Option Description

Optional Variable does not need a value during runtime.

Mandatory At least one value must be entered for the variable during runtime:

● Initial value (#) is permitted explicitly

● Initial value # means “unassigned”, that is, you cause it to explicitly select all data that has no booked values for this characteristic

Mandatory, Initial Value Not Allowed

At least one value must be entered for the variable during runtime; Initial value (#) is not permitted (that is, you must enter one or more concrete values in order to execute the query).

Table 12 Variable Type Options (Continued)

Option Name Variable Represents

Support for Key Figure Creation (Web Analysis Only) 91

Support for SAP AttributesRelease 9.2 supports the following SAP attributes:

● Display attributes —Users can select, search, filter, and include Display Attributes as part of queries and reports.

● Navigation Attributes (BEx Queries only)—Navigation attributes are selected from the field catalog like characteristics, and are used for navigation in Web Analysis, Production Reporting, and Financial Reporting documents. They can also be passed on to Web Analysis, Production Reporting, and Financial Reporting as selection criteria.

SAP Security IntegrationRelease 9.2 provides single sign-on login for Web Analysis, Production Reporting, and Financial Reporting users integrating with SAP. For detailed information, see the section titled “Working with an SAP Provider” in the Hyperion System 9 Shared Services Installation Guide.

Support for Key Figure Creation (Web Analysis Only)Web Analysis enables users to create and edit calculated and restricted key figures.

➤ To create or edit key figures:

1 Select Analysis Tools > Calculated Key Figures.

2 In Calculated Key Figures, select New or an existing key figure.

3 If creating a key figure, replace Untitled with a unique name.

4 Select a Function and related information:

Note: Information requested differs depending on the function selected.

Function Measure Second Measure Cube Hierarchy

Avg ✔ ✔

Var ✔ ✔

Max ✔ ✔

Median ✔ ✔

Min ✔ ✔

Sum ✔ ✔

Count ✔

Divide ✔ ✔


5 In Cube Hierarchy, double-click an entry to move it to Selections.

Caution! Only one hierarchy can be used. If you attempt to select another hierarchy, Web Analysis asks if you want to remove all selections made on the other hierarchy.

6 Click OK to close Calculated Key Figures.

7 In Key Figures Browser, select a key figure to move it to Selections and click OK.

Index A 93

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Index

Aapplication configuration files, 18

Bbidirectional text, 26

configuration settings, 27

ligatures, 26

understanding, 26

briottbl.txt files

about, 8

file formats, 9

Ccommand buttons, configuring, 82

Configuration Frame

data formats, 83

navigation buttons, 83

connectivity

Data Access Service and Large Buffer Mode, 24

Data Access Service ODBC Driver, 24

DataDirect Oracle Driver, 24

Informix, 25

OLE DB Provider for Oracle, 24

Open Client, 25

Oracle SQL*Net, 24

Red Brick, 25

Teradata, 25

Ddashboard fonts, 20

DefaultSortOrderLang (Property), 49

document character sets, 34

dynamic property updates, 33

E-EH_LANGUAGE, xx, 86

events, triggering, 37

Export (Method), 64

export formats, 83

ExportToStream (Method), 67

Ffile export, 23

file import, 21

Flywheel mouse, 44

fonts

configuration, 20

dashboard font preferences, 20

general font preferences, 20

HHTML navigation bar, 86

Iidle connection time outs, 45

Impact Management

document character sets, 34

replacement data model, 34

service configuration parameters, 34

UTC offset option, 34

ImportDataFile (Method), 69

ImportSQLFile (Method), 71

Interactive Reporting job log, 35

Interactive Reporting Services

about, 30

configuring, 30

job request maximum limit, 32

Process Monitor, 32

94 Index J


JJob Service exclusions, 33

jobs

background jobs, 36

disabling job service, 37

foreground jobs, 36

job limit, 37

job queuing, 35

scheduled jobs, 36

jobs, running in the foreground or background, 14

joinoper operator, 27

JSPResources.properties, 10

Llanguage

custom, 10

defining for Workspace, 13

defining when running a job, 13

defining when scheduling a job, 13

HTML navigation bar, 86

properties configuration frame, 80

sort order, 16

user-defined, 6

legends

auto-sizing borders, 44

text wrapping, 44

Mmake suggestion option, 81

MS SQL Server, national strings for, 25

Nnational strings, 25

OObject Model Exclusion List, 73

Ppassword encryption, 45

pie charts

auto-arranging pie labels, 44

Printout (Method), 72

Process Monitor, 32

Production Reporting, dynamic property updates, 33

prompts

changes to, 41

merging of, 42

QQuick Filters, 81

Rreplacement data model, 34

ResetDefaultSortOrderLang (Method), 64

row level security, joinoper operator, 27

SSAP Provider, 33

server.xml, 10

service configuration parameters, 34

Set Filter command button, 81

Sort Order Language, 16

SortOrderLang (Property), 47

SQL batching, 33

Tthird-party software, 34

tuples, 41

UUILanguage (Property), 56

Unicode, 15

compliant font preferences, 20

compliant fonts, 19

file export, 23

file import, 21

file path handling on Unix, 19

font configuration, 20

Migration Utility, 18

user-defined languages, 6

UnicodeEnabled (Property), 46

Unix, 19

user interface language, 11

user preferences, 9

UTC offset, 34

Index V 95


VVariableValue text function, 90

WWorkspace

desktop, 35

related content handling, 44

XXBRL

footnotes, 40

line items, 40

setup and management, 40

text as fact, 40

tuples, 41

upgrade considerations, 41