[PDF] Hyperion Workspace Developers Guide

View - Download Hyperion Workspace Developers Guide

Previous PDF

Next PDF

HYPERION® WORKSPACE

RELEASE 9.3.1

DEVELOPER'S GUIDE

Workspace Developer's Guide, 9.3.1

Copyright © 1989, 2007, Oracle and/or its affiliates. All rights reserved.

Authors: Patty Andrews

The Programs (which include both the software and documentation) contain proprietary information; they are provided

under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent, and

other intellectual and industrial property laws. Reverse engineering, disassembly, or decompilation of the Programs, except

to the extent required to obtain interoperability with other independently created software or as specified by law, is

prohibited.

The information contained in this document is subject to change without notice. If you find any problems in the

documentation, please report them to us in writing. This document is not warranted to be error-free. Except as may be

expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or

transmitted in any form or by any means, electronic or mechanical, for any purpose.

If the Programs are delivered to the United States Government or anyone licensing or using the Programs on behalf of the

United States Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to

U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the

applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication,

disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall be subject

to the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent applicable, the additional

rights set forth in FAR 52.227-19, Commercial Computer Software--Restricted Rights (June 1987). Oracle USA, Inc., 500

Oracle Parkway, Redwood City, CA 94065.

The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous

applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy and other measures

to ensure the safe use of such applications if the Programs are used for such purposes, and we disclaim liability for any

damages caused by such use of the Programs.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their

respective owners.

The Programs may provide links to Web sites and access to content, products, and services from third parties. Oracle is

not responsible for the availability of, or any content provided on, third-party Web sites. You bear all risks associated with

the use of such content. If you choose to purchase any products or services from a third party, the relationship is directly

between you and the third party. Oracle is not responsible for: (a) the quality of third-party products or services; or (b)

fulfilling any of the terms of the agreement with the third party, including delivery of products or services and warranty

obligations related to purchased products or services. Oracle is not responsible for any loss or damage of any sort that you

may incur from dealing with any third party.

Contents

Part I. API Documentation ............................................................. 9 Chapter 1. Getting Started with Java APIs ................................................. 11 Basic Steps .......................................................... 11 Understanding Hyperion Home and Install Home .......................... 11 Importing the Interactive Reporting SDK Package ........................... 12 Obtaining a Session Interface .......................................... 12 Invoking Reporting and Analysis Services ................................. 12 Java Exceptions ....................................................... 13 Java-Accessed Functions ................................................ 14 Chapter 2. Batch Driver Sample Program Control File ......................................... 15 About the Batch Driver Control File ........................................ 15 Control Statements .................................................... 16 Accessor Control Statements .......................................... 17 Category Control Statements .......................................... 17 Data Control Statements ............................................. 18 Interactive Reporting Database Connection Control Statements ................ 18 Interactive Reporting Control Statements ................................. 19 Chapter 3. Workspace Artifacts ........................................................ 21 Interfaces ........................................................... 21 AbsoluteTimeEvent ................................................ 21 Authorization ..................................................... 21 BaseObject ....................................................... 22 BQYDocument .................................................... 22 BQYJob ......................................................... 22 Category ........................................................ 22 Collection ....................................................... 23 CustomCalendar ................................................... 23 DataObject ....................................................... 23 ExternallyTriggered Event ............................................ 23

Contentsiii

Group .......................................................... 23 InstancePermission ................................................. 24 Job ............................................................. 24 JobOutput ....................................................... 24 ObjectID ........................................................ 25 OCEDocument .................................................... 25 ParameterList ..................................................... 25 PhysicalResource .................................................. 25 Query .......................................................... 26 QueryVector ...................................................... 26 RecurringTimeEvent ................................................ 26 ReportMartEntity .................................................. 26 Respository ...................................................... 27 Role ............................................................ 27 ScheduledTask .................................................... 27 Scheduler ........................................................ 27 Session .......................................................... 27 SPFSet .......................................................... 28 SQRJob ......................................................... 28 SQRJobOutput .................................................... 28 User ............................................................ 28 Classes ............................................................. 28 JobParameter ..................................................... 29 Logger .......................................................... 29 ObjectType ....................................................... 29 ReportMartException ............................................... 30 SessionFactory .................................................... 30 UnknownReportMartException ........................................ 30 UserValidationException ............................................. 30 Chapter 4. Sample Java Programs ...................................................... 31 Prerequisites for Running the Sample Programs ............................... 31 Running the Sample Programs ............................................ 31 API Samples ......................................................... 32 AddBQYDocument.java ............................................. 33 AddBQYJob.java ................................................... 33 AddCategory.java .................................................. 33 AddDocument.java ................................................. 34 AddExternalLink.java ............................................... 34 ivContents AddFavorites.java .................................................. 34 AddGroup.java .................................................... 35 AddLink.java ..................................................... 35 AddObjectType.java ................................................ 35 AddOCEDocument.java ............................................. 35 AddRole.java ..................................................... 36 AddSPF.java ...................................................... 36 AddSubscription.java ............................................... 36 AddUser.java ..................................................... 37 AddVersions.java .................................................. 37 AutoZip.java ..................................................... 37 BatchDriver.java ................................................... 38 CategoryDelete.java ................................................ 38 ExecuteBQYDocument.java ........................................... 39 ExecuteBQYJob.java ................................................ 39 ExecuteSQRJob.java ................................................ 39 ExpirationDate.java ................................................ 40 FetchCategory.java ................................................. 40 FetchDocument.java ................................................ 40 ListEvents.java .................................................... 40 ListGroups.java .................................................... 41 ListUsers.java ..................................................... 41 Login.java ....................................................... 41 ObjectByPath.java .................................................. 41 ObjectById.java ................................................... 42 PublishEvent.java .................................................. 42 PublishOutputDirectory.java .......................................... 42 PublishPrinterResource.java .......................................... 43 QueryGroup.java .................................................. 43 QueryUser.java .................................................... 43 ReplaceObject.java ................................................. 43 SQRParms.java .................................................... 44 TriggerExternalEvent.java ............................................ 44 Attributes and Supporting Classes ......................................... 44 Part II. Customization ............................................................... 45 Chapter 5. Java Server Pages .......................................................... 47 JSP Directory ........................................................ 47 JSPs Identified by User Tasks ............................................. 48

Contentsv

Modifying File Properties ............................................... 48 General Widget .................................................... 49 Advanced Options Widget ............................................ 49 Interactive Reporting Database Connection Widget ......................... 50 Creating Events ...................................................... 51 Manage Jobs Page .................................................. 51 Manage Events Page ................................................ 52 Create Recurring Event Page .......................................... 53 Create Externally Triggered Event Page .................................. 54 Scheduling Jobs ...................................................... 54 Scheduling Information Page .......................................... 55 Schedule General Properties Page ....................................... 56 Select Job Parameters ............................................... 56 Set Values Page .................................................... 57 Interactive Reporting Jobs ............................................ 57 SQR Production Reporting Jobs ........................................ 58 Generic Jobs ...................................................... 58 When to Run Page ................................................. 59 Notification Page .................................................. 59 Chapter 6. Customizing E-mail Notifications ............................................... 61 Configuring E-mail Notifications .......................................... 61 Notification Types .................................................... 61 Template File Directory ................................................. 62 Choosing HTML or Text Format .......................................... 62 Template File Replacement Tokens ........................................ 63 Properties in the notification.properties File .................................. 64 Images in HTML-Formatted E-mail Notifications .............................. 67 Chapter 7. SmartCuts ............................................................... 69 About SmartCuts ..................................................... 69 SmartCut Considerations ............................................... 70 get Command ........................................................ 70 Getting and Viewing Documents, Reports, or Forms ......................... 70 Getting Report Output .............................................. 71 Getting One Job Output Artifact ....................................... 73 run Command ....................................................... 73 SmartCut Variables for Interactive Reporting Documents and Jobs ................. 74 bqtype .......................................................... 75quotesdbs_dbs4.pdfusesText_8

[PDF] Interaktiver Waschsalon

[PDF] interalpen-hotel tyrol

[PDF] Interblocs : Septembre 2012 - CHU Sainte - Santé Et Remise En Forme

[PDF] INTERBOURSE VAL D`ISERE 2014 Résultats Officiels Ladies - Anciens Et Réunions

[PDF] INTERBULL PLAN MARS 2010.qxd

[PDF] interbuna - add beton

[PDF] Intercalaire 1 (nouvelle boîte) - Anciens Et Réunions

[PDF] INTERCALAIRE – Suite de l`imprimé M0

[PDF] intercall call manager - West Unified Communications Services

[PDF] INTERCAMBIO MUSICAL Fuimos 20 cantando nuestra amistad y - Anciens Et Réunions

[PDF] Intercédons pour le monde musulman ! Ressources de prière

[PDF] Interception of Communications (Admissibility of Evidence) Bill [HL] - Anciens Et Réunions

[PDF] Interception système pour la capture et le rejeu de traces - Gestion De Projet

[PDF] Intercité de nuit Paris – Foix – Ax-les-Thermes – Latour-de

[PDF] Interclasse 3° Listes 2010 2011 - Anciens Et Réunions