832
Actuate API Reference

Actuate API Reference - OpenText

  • Upload
    others

  • View
    11

  • Download
    0

Embed Size (px)

Citation preview

Page 1: Actuate API Reference - OpenText

Actuate API Reference

Page 2: Actuate API Reference - OpenText

Information in this document is subject to change without notice. Examples provided are fictitious. No part of this document may be reproduced or transmitted in any form, or by any means, electronic or mechanical, for any purpose, in whole or in part, without the express written permission of Actuate Corporation.

© 1995 - 2015 by Actuate Corporation. All rights reserved. Printed in the United States of America.

Contains information proprietary to:Actuate Corporation, 951 Mariners Island Boulevard, San Mateo, CA 94404

www.opentext.comwww.actuate.com

The software described in this manual is provided by Actuate Corporation under an Actuate License agreement. The software may be used only in accordance with the terms of the agreement. Actuate software products are protected by U.S. and International patents and patents pending. For a current list of patents, please see http://www.actuate.com/patents.

Actuate Corporation trademarks and registered trademarks include:Actuate, ActuateOne, the Actuate logo, Archived Data Analytics, BIRT, BIRT 360, BIRT Analytics, The BIRT Company, BIRT Content Services, BIRT Data Analyzer, BIRT for Statements, BIRT iHub, BIRT Metrics Management, BIRT Performance Analytics, Collaborative Reporting Architecture, e.Analysis, e.Report, e.Reporting, e.Spreadsheet, Encyclopedia, Interactive Viewing, OnPerformance, The people behind BIRT, Performancesoft, Performancesoft Track, Performancesoft Views, Report Encyclopedia, Reportlet, X2BIRT, and XML reports.

Actuate products may contain third-party products or technologies. Third-party trademarks or registered trademarks of their respective owners, companies, or organizations include: Mark Adler and Jean-loup Gailly (www.zlib.net): zLib. Adobe Systems Incorporated: Flash Player, Source Sans Pro font. Amazon Web Services, Incorporated: Amazon Web Services SDK. Apache Software Foundation (www.apache.org): Ant, Axis, Axis2, Batik, Batik SVG library, Commons Command Line Interface (CLI), Commons Codec, Commons Lang, Commons Math, Crimson, Derby, Hive driver for Hadoop, Kafka, log4j, Pluto, POI ooxml and ooxml-schema, Portlet, Shindig, Struts, Thrift, Tomcat, Velocity, Xalan, Xerces, Xerces2 Java Parser, Xerces-C++ XML Parser, and XML Beans. Daniel Bruce (www.entypo.com): Entypo Pictogram Suite. Castor (www.castor.org), ExoLab Project (www.exolab.org), and Intalio, Inc. (www.intalio.org): Castor. Alessandro Colantonio: CONCISE Bitmap Library. d3-cloud. Day Management AG: Content Repository for Java. Dygraphs Gallery. Eclipse Foundation, Inc. (www.eclipse.org): Babel, Data Tools Platform (DTP) ODA, Eclipse SDK, Graphics Editor Framework (GEF), Eclipse Modeling Framework (EMF), Jetty, and Eclipse Web Tools Platform (WTP). Bits Per Second, Ltd. and Graphics Server Technologies, L.P.: Graphics Server. Dave Gandy: Font Awesome. Gargoyle Software Inc.: HtmlUnit. GNU Project: GNU Regular Expression. Google Charts. Groovy project (groovy.codehaus.org): Groovy. Guava Libraries: Google Guava. HighSlide: HighCharts. headjs.com: head.js. Hector Project: Cassandra Thrift, Hector. Jason Hsueth and Kenton Varda (code.google.com): Protocole Buffer. H2 Database: H2 database. IDAutomation.com, Inc.: IDAutomation. IDRsolutions Ltd.: JPedal JBIG2. InfoSoft Global (P) Ltd.: FusionCharts, FusionMaps, FusionWidgets, PowerCharts. InfoVis Toolkit. Matt Inger (sourceforge.net): Ant-Contrib. Matt Ingenthron, Eric D. Lambert, and Dustin Sallings (code.google.com): Spymemcached. International Components for Unicode (ICU): ICU library. JCraft, Inc.: JSch. jQuery: jQuery, JQuery Sparklines. Yuri Kanivets (code.google.com): Android Wheel gadget. LEAD Technologies, Inc.: LEADTOOLS. The Legion of the Bouncy Castle: Bouncy Castle Crypto APIs. Bruno Lowagie and Paulo Soares: iText. Membrane SOA Model. MetaStuff: dom4j. Microsoft Corporation (Microsoft Developer Network): CompoundDocument Library. Mozilla: Mozilla XML Parser. MySQL Americas, Inc.: MySQL Connector/J. Netscape Communications Corporation, Inc.: Rhino. NodeJS. nullsoft project: Nullsoft Scriptable Install System. OOPS Consultancy: XMLTask. OpenSSL Project: OpenSSL. Oracle Corporation: Berkeley DB, Java Advanced Imaging, JAXB, Java SE Development Kit (JDK), Jstl, Oracle JDBC driver. PostgreSQL Global Development Group: pgAdmin, PostgreSQL, PostgreSQL JDBC driver. Progress Software Corporation: DataDirect Connect XE for JDBC Salesforce, DataDirect JDBC, DataDirect ODBC. Quality Open Software: Simple Logging Facade for Java (SLF4J), SLF4J API and NOP. Raphael. RequireJS. Rogue Wave Software, Inc.: Rogue Wave Library SourcePro Core, tools.h++. Sencha Inc.: Extjs, Sencha Touch. Shibboleth Consortium: OpenSAML, Shibboleth Identity Provider. Matteo Spinelli: iscroll. StAX Project (stax.codehaus.org): Streaming API for XML (StAX). Sam Stephenson (prototype.conio.net): prototype.js. SWFObject Project (code.google.com): SWFObject. ThimbleWare, Inc.: JMemcached. Twittr: Twitter Bootstrap. VMWare: Hyperic SIGAR. Woodstox Project (woodstox.codehaus.org): Woodstox Fast XML processor (wstx-asl). World Wide Web Consortium (W3C) (MIT, ERCIM, Keio): Flute, JTidy, Simple API for CSS. XFree86 Project, Inc.: (www.xfree86.org): xvfb. ZXing Project (code.google.com): ZXing.

All other brand or product names are trademarks or registered trademarks of their respective owners, companies, or organizations.

Document No. 141215-2-430302 June 19, 2015

Page 3: Actuate API Reference - OpenText

i

ContentsPart 1Actuate BIRT APIs

Chapter 1Actuate iHub environment information API reference . . . . . . . . . . . . . . . . 3About iHub environment information API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4iHub API reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4appendToJobStatus( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4getAuthenticationId( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5getServerWorkingDirectory( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5getUserName( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6getUserAgentString( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6getUserRoles( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7getVolumeName( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7setHeadline( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8setVersionName( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Part 2Actuate Information Delivery API

Chapter 2Actuate Information Delivery API operations . . . . . . . . . . . . . . . . . . . . . . 11IDAPI operations quick reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11Administrate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14CallOpenSecurityLibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16CancelJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16CancelReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16CloseInfoObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17CreateDatabaseConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17CreateIOCache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17CreateParameterValuesFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17CreateQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18CreateResourceGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18CubeExtraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18DataExtraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19DeleteDatabaseConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20DeleteIOCache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20DeleteResourceGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Page 4: Actuate API Reference - OpenText

ii

DownloadFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20DownloadTransientFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21ExecuteQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21ExecuteReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21ExecuteVolumeCommand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23ExtractParameterDefinitionsFromFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24ExportParameterDefinitionsToFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24FetchInfoObjectData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24GetAllCounterValues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25GetBookmarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25GetCapabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25GetCapabilitiesByCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25GetCapabilityCategories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26GetChannelACL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26GetConnectionProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26GetConnectionPropertyAssignees . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27GetContent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27GetCounterValues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27GetCubeMetaData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28GetCustomFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28GetDatabaseConnectionDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28GetDatabaseConnectionParameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28GetDatabaseConnectionTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28GetDataExtractionFormats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28GetDocumentConversionOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29GetDynamicData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29GetEmbeddedComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29GetFactoryServiceInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29GetFactoryServiceJobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31GetFileACL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33GetFileCreationACL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34GetFileDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35GetFileTypeParameterDefinitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36GetFolderItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36GetFormats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37GetInfoObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37GetJavaReportEmbededComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37GetJavaReportTOC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38GetJobDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39GetMetaData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41GetNoticeJobDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41GetPageCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43GetPageNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43

Page 5: Actuate API Reference - OpenText

iii

GetParameterPickList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44GetReportParameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45GetResourceGroupInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45GetResourceGroupList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46GetSavedSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47GetServerResourceGroupConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47GetStaticData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47GetStyleSheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47GetSyncJobInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47GetSystemMDSInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48GetSystemPrinters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48GetSystemServerList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49GetSystemVolumeNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49GetTOC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49GetUserExtendedProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49GetUserGroupExtendedProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50GetUserGroupProductAccess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50GetUserLicenseOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51GetUserPreference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51GetUserPrinterOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51GetVolumeProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52GrantUserGroupCapabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53GrantUserGroupProductAccess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53InstallApp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54IsSSOEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54OpenInfoObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Ping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56PrintReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60RevokeUserGroupCapabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61RevokeUserGroupProductAccess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62SaveSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62SaveTransientReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62SearchReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62SelectChannels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62SelectFiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63SelectFileTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64SelectGroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65SelectJavaReportPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65SelectJobNotices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66SelectJobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67SelectJobSchedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67SelectPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Page 6: Actuate API Reference - OpenText

iv

SelectRoles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68SelectUserGroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68SelectUsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70SetConnectionProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71SetServerResourceGroupConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72SetUserExtendedProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72SetUserGroupExtendedProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73SetUserPreference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73SubmitJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73SystemLogin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78UpdateDatabaseConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78UpdateIOCache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79UpdateResourceGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79UploadFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79VerifyAuthId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80WaitForExecuteReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80

Chapter 3Actuate Information Delivery API data types . . . . . . . . . . . . . . . . . . . . . . 83IDAPI data types quick reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .83AbsoluteDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .88acDouble . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89acNull . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89AdminOperation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89Aggregation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .91ArchiveRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .91Argument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .91Arrays of data types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .91ArrayOfAggregation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .93ArrayOfArchiveRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .94ArrayOfArgument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .94ArrayOfAttachment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .94ArrayOfBookMark . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .94ArrayOfCapabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .94ArrayOfChannel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .94ArrayOfChannelCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .94ArrayOfColumnDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95ArrayOfColumnSchema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95ArrayOfComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95ArrayOfComponentIdentifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95ArrayOfCounterInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95ArrayOfDataExtractionFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95ArrayOfDataFilterCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95

Page 7: Actuate API Reference - OpenText

v

ArrayOfDataRow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96ArrayOfDataSortColumn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96ArrayOfDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96ArrayOfDocumentConversionOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96ArrayOfFieldDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96ArrayOfFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96ArrayOfFileCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96ArrayOfFileContent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97ArrayOfFileType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97ArrayOfFilterCriteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97ArrayOfGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97ArrayOfGroupCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97ArrayOfGrouping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97ArrayOfInt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97ArrayOfIOCacheDBIndexConstraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97ArrayOfJobCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98ArrayOfJobNotice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98ArrayOfJobNoticeCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98ArrayOfJobProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98ArrayOfJobScheduleCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98ArrayOfJobScheduleDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98ArrayOfLong . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98ArrayOfLicenseOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99ArrayOfMDSInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99ArrayOfNameValuePair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99ArrayOfParameterDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99ArrayOfParameterValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99ArrayOfPendingSyncJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99ArrayOfPermission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99ArrayOfPrinter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100ArrayOfPrinterOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100ArrayOfPropertyValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100ArrayOfRecord . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100ArrayOfResourceGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100ArrayOfResourceGroupSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100ArrayOfResultSetSchema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100ArrayOfRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101ArrayOfRoleCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101ArrayOfRunningJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101ArrayOfServerInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101ArrayOfServerResourceGroupSetting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101ArrayOfService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101ArrayOfString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Page 8: Actuate API Reference - OpenText

vi

ArrayOfUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102ArrayOfUserCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102ArrayOfUserGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102ArrayOfUserGroupCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102Attachment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102Base64Binary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103BookMark . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103Boolean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103CancelJobStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104Channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104ChannelCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104ChannelField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104ChannelSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104ColumnDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104ColumnDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105ColumnSchema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105ComponentIdentifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105ComponentType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .106CopyFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .106CounterInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107CreateChannel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107CreateFileType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107CreateFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .108CreateGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109CreateRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109CreateUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109CreateUserGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109CustomEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109Daily . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110DatabaseConnectionDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110DataCell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110DataExtractionFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111DataFilterCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111DataRow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111DataSchema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112DataSortColumn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112DataSourceType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112DataType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113DateTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Decimal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113DeleteChannel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Page 9: Actuate API Reference - OpenText

vii

DeleteFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114DeleteFileType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115DeleteGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115DeleteJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115DeleteJobNotices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116DeleteJobSchedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116DeleteRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116DeleteUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .117DeleteUserGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .117DocumentConversionOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118Double . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118EventOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119EventType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119ExecuteReportStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120ExternalTranslatedUserNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120ExternalTranslatedRoleNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120ExternalTranslatedUserGroupNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121FieldDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121FieldValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122FileAccess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123FileCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123FileContent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124FileEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124FileField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124FileSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125FileType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126FilterCriteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128GroupCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128GroupField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Grouping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128GroupSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129InfoObjectData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129InfoObjectDataFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Int . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130IOCacheDBIndexConstraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130IOCacheDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130IOCacheState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130JobCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130JobEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Page 10: Actuate API Reference - OpenText

viii

JobField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131JobInputDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .132JobNotice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .135JobNoticeCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137JobNoticeField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137JobNoticeSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .138JobPrinterOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139JobProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .140JobSchedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .142JobScheduleCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .142JobScheduleDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143JobScheduleField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143JobScheduleSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .144JobSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .145LicenseOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147Long . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147MDSInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147Monthly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147MoveFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .149NameValuePair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150NewFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150ObjectIdentifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151OpenServerOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152PageIdentifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152ParameterDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152ParameterValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155PendingSyncJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158Permission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159PrinterOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161PrivilegeFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .162PropertyValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .163Range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .163Repeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .163Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .163ReportParameterType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .164ResourceGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .164ResourceGroupSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .165ResultSetSchema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .166RetryOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .166RetryOptionType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .166Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .167RoleCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .167

Page 11: Actuate API Reference - OpenText

ix

RoleField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167RoleSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167RunningJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167ScalarDataType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169SearchReportByIdList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169SearchReportByIdNameList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169SearchReportByNameList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170SearchResultProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170ServerInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170ServerResourceGroupSetting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171ServerState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172ServerStatusInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172ServerVersionInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173Short . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174SortColumn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174SystemType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174SupportedQueryFeatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175TransactionOperation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175TypeName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177UndeleteUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178UpdateChannel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178UpdateChannelOperation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178UpdateChannelOperationGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178UpdateFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179UpdateFileOperation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180UpdateFileOperationGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181UpdateFileType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182UpdateFileTypeOperation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182UpdateFileTypeOperationGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183UpdateGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183UpdateGroupOperation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183UpdateGroupOperationGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183UpdateJobSchedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183UpdateJobScheduleOperation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184UpdateJobScheduleOperationGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186UpdateOpenSecurityCache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186UpdateRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187UpdateUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

Page 12: Actuate API Reference - OpenText

x

UpdateUserGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .188UpdateUserGroupOperation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .189UpdateUserGroupOperationGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .190UpdateUserOperation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .191UpdateUserOperationGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .193UpdateVolumeProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .193UpdateVolumePropertiesOperation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .193UpdateVolumePropertiesOperationGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .194User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .194UserCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .196UserField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .196UserGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .197UserGroupCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .198UserGroupField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .198UserGroupSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .198UserSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .200VersioningOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .201ViewParameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .201Volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .203Weekly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .204

Part 3Actuate security API

Chapter 4Visualization Platform security reference . . . . . . . . . . . . . . . . . . . . . . . . 209About Actuate Visualization Platform security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .210Using the security adapter class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .210Using the upload security adapter interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .212

Chapter 5Java Report Server Security Extension reference . . . . . . . . . . . . . . . . . 215About the Java Report Server Security Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .216Report Server Security Extension (RSSE) API operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .216AuthenticateUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .216DoesRoleExist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .217DoesUserExist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .217GetConnectionProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .217GetTranslatedRoleNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .218GetTranslatedUserNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .218GetUserACL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .219GetUserProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .219

Page 13: Actuate API Reference - OpenText

xi

GetUsersToNotify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219PassThrough . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219SelectRoles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220SelectUsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221Stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223Report Server Security Extension (RSSE) API data types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223Arrays of data types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223ErrorMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224Permission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224PropertyValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224TranslatedRoleNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225TranslatedUserNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225UserAndProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

Part 4Actuate archiving API

Chapter 6Actuate archiving API reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229Archiving API Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230DeleteExpiredFiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230EndArchive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230GetNextExpiredFiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231StartArchive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232Archiving API data types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233ArrayOfFileInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233ArrayOfPermission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233ArrayOfString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234FileAccess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234FileInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236Permission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

Part 5Actuate JavaScript API

Chapter 7Actuate JavaScript API class reference . . . . . . . . . . . . . . . . . . . . . . . . . . 241Actuate JavaScript API overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

About the actuate namespace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

Page 14: Actuate API Reference - OpenText

xii

Using the Actuate library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .242Actuate JavaScript API classes quick reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .242Actuate JavaScript API reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .245Class actuate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .246Class actuate.AuthenticationException . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .254Class actuate.ConnectionException . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .256Class actuate.Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .257Class actuate.dashboard.DashboardDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .267Class actuate.dashboard.EventConstants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .268Class actuate.dashboard.GadgetScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .269Class actuate.dashboard.Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .272Class actuate.data.Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .274Class actuate.data.ReportContent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .279Class actuate.data.Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .280Class actuate.data.ResultSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .284Class actuate.data.Sorter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .286Class actuate.DataService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .289Class actuate.Exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .291Class actuate.Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .294Class actuate.parameter.Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .305Class actuate.parameter.ConvertUtility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .306Class actuate.parameter.EventConstants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309Class actuate.parameter.NameValuePair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .310Class actuate.parameter.ParameterData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312Class actuate.parameter.ParameterDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .320Class actuate.parameter.ParameterValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .335Class actuate.report.Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .343Class actuate.report.DataItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .351Class actuate.report.FlashObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .355Class actuate.report.Gadget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .359Class actuate.report.HTML5Chart.ClientChart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .364Class actuate.report.HTML5Chart.ClientOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .371Class actuate.report.HTML5Chart.ClientPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .375Class actuate.report.HTML5Chart.ClientSeries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .378Class actuate.report.HTML5Chart.Highcharts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .383Class actuate.report.HTML5Chart.Renderer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .384Class actuate.report.Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .391Class actuate.report.Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .395Class actuate.report.TextItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .451Class actuate.ReportExplorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .455Class actuate.reportexplorer.Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .462Class actuate.reportexplorer.EventConstants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .463

Page 15: Actuate API Reference - OpenText

xiii

Class actuate.reportexplorer.File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464Class actuate.reportexplorer.FileCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471Class actuate.reportexplorer.FileSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473Class actuate.reportexplorer.FolderItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482Class actuate.reportexplorer.PrivilegeFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484Class actuate.RequestOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488Class actuate.Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493Class actuate.viewer.BrowserPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513Class actuate.viewer.EventConstants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514Class actuate.viewer.PageContent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516Class actuate.viewer.ParameterValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520Class actuate.viewer.RenderOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522Class actuate.viewer.ScrollPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524Class actuate.viewer.SelectedContent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526Class actuate.viewer.UIConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529Class actuate.viewer.UIOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531Class actuate.viewer.ViewerException . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545

Chapter 8BIRT Interactive Crosstabs API class reference . . . . . . . . . . . . . . . . . . . 547About the BIRT Interactive Crosstabs JavaScript API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548Interactive Crosstabs API reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549Interactive Crosstabs JavaScript classes quick reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550Class actuate.XTabAnalyzer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552Class actuate.xtabanalyzer.Crosstab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569Class actuate.xtabanalyzer.Dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583Class actuate.xtabanalyzer.Driller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589Class actuate.xtabanalyzer.EventConstants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592Class actuate.xtabanalyzer.Exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593Class actuate.xtabanalyzer.Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596Class actuate.xtabanalyzer.GrandTotal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603Class actuate.xtabanalyzer.Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606Class actuate.xtabanalyzer.LevelAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609Class actuate.xtabanalyzer.Measure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610Class actuate.xtabanalyzer.MemberValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615Class actuate.xtabanalyzer.Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618Class actuate.xtabanalyzer.PageContent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625Class actuate.xtabanalyzer.ParameterValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627Class actuate.xtabanalyzer.Sorter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630Class actuate.xtabanalyzer.SubTotal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634Class actuate.xtabanalyzer.Total . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638Class actuate.xtabanalyzer.UIOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641

Page 16: Actuate API Reference - OpenText

xiv

Part 6Scripting function reference

Chapter 9Scripting reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647BIRT JavaScript classes quick reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .647Class BirtComp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .649Class BirtDateTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .657Class BirtDuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .672Class BirtMath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .679Class BirtStr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .684Class Finance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .690Class Formatter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .708

Chapter 10EasyScript Function Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709About EasyScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .710EasyScript functions quick reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .710Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .713ABS( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .713ADD_DAY( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .713ADD_HOUR( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .714ADD_MINUTE( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .714ADD_MONTH( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .715ADD_QUARTER( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .715ADD_SECOND( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .716ADD_WEEK( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .716ADD_YEAR( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .716BETWEEN( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .717CEILING( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .718DAY( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .718DIFF_DAY( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .719DIFF_HOUR( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .719DIFF_MINUTE( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .720DIFF_MONTH( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .720DIFF_QUARTER( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .721DIFF_SECOND( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .721DIFF_WEEK( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .722DIFF_YEAR( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .722FIND( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .723IF( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .724IN( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .724

Page 17: Actuate API Reference - OpenText

xv

ISNULL( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725LEFT( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725LEN( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726LIKE( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 727LOWER( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 727MATCH( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728MOD( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729MONTH( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730NOT( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730NOTNULL( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731NOW( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731QUARTER( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732RIGHT( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732ROUND( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733ROUNDDOWN( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733ROUNDUP( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734SEARCH( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735SQRT( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736TODAY( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736TRIM( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737TRIMLEFT( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737TRIMRIGHT( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737UPPER( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738WEEK( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738WEEKDAY( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738YEAR( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741

Page 18: Actuate API Reference - OpenText

xvi

Page 19: Actuate API Reference - OpenText

Part 1Actuate BIRT APIs

■ Actuate iHub environment information API reference

PartOne1

Page 20: Actuate API Reference - OpenText
Page 21: Actuate API Reference - OpenText

C h a p t e r 1 , A c t u a t e i H u b e n v i r o n m e n t i n f o r m a t i o n A P I r e f e r e n c e 3

C h a p t e r

1Chapter 1Actuate iHub environment

information API referenceThis chapter contains the following topics:

■ About iHub environment information API

■ iHub API reference

Page 22: Actuate API Reference - OpenText

4 A c t u a t e A P I R e f e r e n c e

appendToJobStatus( )

About iHub environment information APIReport developers distribute reports to users by publishing them to BIRT iHub. Sometimes a report requires information about the iHub environment to implement application or business logic based on, for example, the security credentials of the user running the report, the browser in which the report is viewed, the server volume on which the report is run, and so on. BIRT provides an API, referred to in this chapter as the iHub API, that enables access to this type of information.

To use the iHub API in a report, you write event handler scripts in either Java or JavaScript. BIRT event handlers are associated with all the elements that make up a report, such as data sources, data sets, tables, charts, and labels. When a report is run, BIRT fires events and executes event handlers in a specific sequence to generate and render the report.

Writing event handlers in a report requires knowledge of the BIRT event model. For information about the event model and details about writing event handlers in Java and JavaScript, see Application Integrator Guide. This chapter describes the additional requirements for accessing and debugging the iHub API in an event handler.

iHub API referenceThis section lists all the methods in the iHub API in alphabetical order. Each method entry includes a general description of the method, the JavaScript and Java syntaxes, the result the method returns, and examples.

appendToJobStatus( )Appends a specified string to the status of the current job. iHub writes status messages for each report-generation job.

JavaScriptsyntax

appendToJobStatus(statusString)

Javasyntax

public void appendToJobStatus( String statusString )

Argument statusStringThe string to add to the job status.

Usage Provide information for debugging purposes. For example, to verify that an event handler is executed, write a message indicating that the event method is called.

Page 23: Actuate API Reference - OpenText

C h a p t e r 1 , A c t u a t e i H u b e n v i r o n m e n t i n f o r m a t i o n A P I r e f e r e n c e 5

getAuthent icat ionId( )

JavaScriptexample

reportContext.getAppContext().get("ServerContext").appendToJobStatus("This message appears when beforeFactory is called.\n");

Javaexample

IServerContext scontext;scontext = (IServerContext)

reportContext.getAppContext().get("ServerContext");scontext.appendToJobStatus("This message appears when

beforeFactory is called.\n");

getAuthenticationId( )Retrieves the current user’s authentication ID.

JavaScriptsyntax

getAuthenticationId()

Javasyntax

public String getAuthenticationId()

Usage Use in cases when the report application needs to pass the ID to another application, such as IDAPI calls to iHub.

Returns An authentication ID in String format.

JavaScriptexample

reportContext.getAppContext().get("ServerContext").getAuthenticationId();

Javaexample

IServerContext scontext;scontext = (IServerContext)

reportContext.getAppContext().get("ServerContext");scontext.getAuthenticationId();

getServerWorkingDirectory( )Retrieves the path to the folder in the file system where temporary files are stored.

JavaScriptsyntax

getServerWorkingDirectory()

Javasyntax

public String getServerWorkingDirectory()

Usage Use to read or write information from and to the file system.

Returns The full path to the iHub working directory.

JavaScriptexample

reportContext.getAppContext().get("ServerContext").getServerWorkingDirectory();

Page 24: Actuate API Reference - OpenText

6 A c t u a t e A P I R e f e r e n c e

getUserName( )

Javaexample

IServerContext scontext;scontext = (IServerContext)

reportContext.getAppContext().get("ServerContext");scontext.getServerWorkingDirectory();

getUserName( )Retrieves the current user name.

JavaScriptsyntax

getUserName()

Javasyntax

public String getUserName()

Usage Use in cases when an application requires different code for different users.

Returns The current user name.

JavaScriptexample

reportContext.getAppContext().get("ServerContext").getUserName()

Javaexample

IServerContext scontext;scontext = (IServerContext)

reportContext.getAppContext().get("ServerContext");String currentUser = scontext.getUserName();

getUserAgentString( )Identifies the browser used to view a report.

JavaScriptsyntax

getUserAgentString()

Javasyntax

public String getUserAgentString()

Usage Use in cases when an application requires different code for different browsers. The browser information is available only when the report is rendered, so use getUserAgentString( ) in a report element’s onRender event.

Returns The browser type in String format. For Internet Explorer, for example, getUserAgentString( ) might return a string, such as:

Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; InfoPath.1; MS-RTC LM 8)

JavaScriptexample

reportContext.getAppContext().get("ServerContext").getUserAgentString();

Page 25: Actuate API Reference - OpenText

C h a p t e r 1 , A c t u a t e i H u b e n v i r o n m e n t i n f o r m a t i o n A P I r e f e r e n c e 7

getUserRoles( )

Javaexample

IServerContext scontext;scontext = (IServerContext)

reportContext.getAppContext().get("ServerContext");scontext.getUserAgentString();

getUserRoles( )Retrieves the roles assigned to the current user.

JavaScriptsyntax

getUserRoles()

Javasyntax

public List<String> getUserRoles()

Usage Use in cases when an application requires different code for different iHub security roles.

Returns The current user’s security roles.

JavaScriptexample

reportContext.getAppContext().get("ServerContext").getUserRoles();

Javaexample

IServerContext scontext;scontext = (IServerContext)

reportContext.getAppContext().get("ServerContext");List<String> userRoles = scontext.getUserRoles();

getVolumeName( )Retrieves the name of the iHub volume on which the report runs.

JavaScriptsyntax

getVolumeName()

Javasyntax

public String getVolumeName()

Usage Use in cases when an application running in a multi-volume environment requires volume information.

Returns The name of the iHub volume running a report.

JavaScriptexample

reportContext.getAppContext().get("ServerContext").getVolumeName();

Javaexample

IServerContext scontext;scontext = (IServerContext)

reportContext.getAppContext().get("ServerContext");scontext.getVolumeName();

Page 26: Actuate API Reference - OpenText

8 A c t u a t e A P I R e f e r e n c e

setHeadl ine( )

setHeadline( )Sets the headline of a generated report. A headline appears in a job completion notice that iHub writes to a channel.

JavaScriptsyntax

setHeadline(headline)

Javasyntax

public void setHeadline( String headline )

Argument headlineA string that represents the headline of a completed job.

Usage Use to specify a headline based on the contents of a report, or on the value of a report parameter.

JavaScriptexample

reportContext.getAppContext().get("ServerContext").setHeadline("Sales Report for " + params["Region"].value);

Javaexample

String region = (String)reportContext.getParameterValue("Region")IServerContext scontext;scontext = (IServerContext)

reportContext.getAppContext().get("ServerContext");scontext.setHeadline("Sales Report for " + region);

setVersionName( )Sets the version name of a generated report.

JavaScriptsyntax

setVersionName(versionName)

Javasyntax

public void setVersionName( String versionName )

Argument versionNameA string that represents the report’s version name.

Usage Use to specify a version name that includes dynamic data, such as the contents of a report, the value of a report parameter, or the report-generation date.

JavaScriptexample

reportContext.getAppContext().get("ServerContext").setVersionName("Version " + new Date());

Javaexample

IServerContext scontext;scontext = (IServerContext)

reportContext.getAppContext().get("ServerContext");scontext.setVersionName("Version " + new Date());

Page 27: Actuate API Reference - OpenText

Part 2Actuate Information Delivery API

■ Actuate Information Delivery API operations

■ Actuate Information Delivery API data types

PartTwo2

Page 28: Actuate API Reference - OpenText
Page 29: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 11

C h a p t e r

2Chapter 2Actuate Information

Delivery API operationsThis chapter provides reference documentation for Actuate Information Delivery API operation classes listed in alphabetical order. Each entry includes a general description of the operation and request-response elements.

IDAPI operations quick referenceTable 2-1 lists the Actuate IDAPI Operations. For more information about IDAPI Operation WSDL definitions, see Integrating Applications into BIRT iHub.

Table 2-1 IDAPI operations summary

Operation Description

Administrate Performs file and user administrative operations

CallOpenSecurityLibrary Executes an RSSE operation

CancelJob Cancels a job

CancelReport Cancels a report execute operation

CreateParameterValuesFile Creates a parameter values file

CreateResourceGroup Creates a resource group

CubeExtraction Extracts data from a cube

DataExtraction Extracts data from a non-cube resource or file

(continues)

Page 30: Actuate API Reference - OpenText

12 A c t u a t e A P I R e f e r e n c e

DeleteResourceGroup Removes a resource group

DownloadFile Downloads a file

ExecuteReport Generates a temporary report

ExecuteVolumeCommand Executes predefined volume control commands

ExtractParameterDefinitionsFromFile Extracts parameter definitions from a report file

ExportParameterDefinitionsToFile Exports parameter definitions from a report file

GetAllCounterValues Returns the values for all counters

GetBookmarks Returns a list of bookmarks from a report

GetCapabilities Returns a list of capabilities for a user group

GetCapabilitiesByCategory Returns a sorted list of capabilities for a group

GetCapabilityCategories Returns capability categories

GetCounterValues Returns the IDs, names, and values of a counter.

GetCubeMetaData Returns cube result set schema details

GetDataExtractionFormats Returns a list of the output format and MIME types for each file type

GetDocumentConversionOptions Returns a list of the document conversion options for each file type

GetFactoryServiceInfo Returns details about a Factory service

GetFactoryServiceJobs Returns a list of jobs pending and running for a Factory service

GetFileACL Returns the access control list for a file

GetFileCreationACL Returns the access control list for a template

GetFileDetails Returns details about a file

GetFileTypeParameterDefinitions Returns parameters for the specified file type

GetFolderItems Returns a list for folder contents

GetJavaReportEmbededComponent Returns an embedded component, such as an image or graph

GetJavaReportTOC Returns the table of contents

GetJobDetails Returns the detail information for a job

GetMetaData Returns metadata for the result set schema

GetNoticeJobDetails Returns the details of a job notice

Table 2-1 IDAPI operations summary (continued)

Operation Description

Page 31: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 13

GetPageCount Returns the number of pages in a report file

GetPageNumber Returns the current page number

GetParameterPickList Returns a parameter pick list

GetReportParameters Returns the list of report parameters

GetResourceGroupInfo Returns the resource group details

GetResourceGroupList Returns a list of resource groups

GetServerResourceGroupConfiguration Returns a resource group configuration

GetSyncJobInfo Returns information about an immediate job

GetSystemMDSInfo Returns Message Distribution service details

GetSystemPrinters Returns a list of printers

GetSystemServerList Returns a list of servers in a cluster

GetTOC Obsolete

GetUserExtendedProperties Returns the extended properties for a user

GetUserGroupExtendedProperties Returns the extended properties for a user group

GetUserGroupProductAccess Returns the product family access for a user group

GetUserLicenseOptions Returns a list of licensed options for a user

GetUserPreference Returns user preferences

GetUserPrinterOptions Returns user printing options

GetVolumeProperties Returns volume properties

GrantUserGroupCapabilities Adds user group capabilities

GrantUserGroupProductAccess Adds user group product access

InstallApp Installs an application

IsSSOEnabled Determines whether single-sign-on is enabled

Login Authenticates a user

Ping Pings the server

PrintReport Prints a document

RevokeUserGroupCapabilities Removes user group capabilities

RevokeUserGroupProductAccess Removes user group product access

SaveTransientReport Saves a report produced by an immediate job

(continues)

Table 2-1 IDAPI operations summary (continued)

Operation Description

Page 32: Actuate API Reference - OpenText

14 A c t u a t e A P I R e f e r e n c e

Administrate

AdministrateSpecifies the AdminOperation element which controls abilities to modify a volume. Only a volume administrator or a user in the Administrator role uses Administrate operations.

Requestelement

AdminOperationAny sequence of CopyFile, CreateFileType, CreateFolder, CreateUser, CreateUserGroup, DeleteFile, DeleteFileType, DeleteJob, DeleteJobNotices, DeleteJobSchedule, DeleteUser, DeleteUserGroup, MoveFile, Transaction, UndeleteUser, UpdateFile, UpdateFileType, UpdateJobSchedule, UpdateOpenSecurityCache, UpdateUser, UpdateUserGroup, or UpdateVolumeProperties. Specifies a set of operations and their execution order for an Administrate operation. AdminOperation is a set of complex data types which details how to create, delete, update, copy, and move items within a volume. Each AdminOperation element represents a single unit of work within

SelectFiles Sets selected files

SelectFileTypes Sets selected file types

SelectJavaReportPage Sets selected report page

SelectJobNotices Sets selected job notices

SelectJobs Sets selected jobs

SelectJobSchedules Sets selected job schedules

SelectUserGroups Sets selected user groups

SelectUsers Sets selected users

SetServerResourceGroupConfiguration Sets the resource group configuration

SetUserExtendedProperties Sets extended properties for a user

SetUserGroupExtendedProperties Sets extended properties for a user group

SetUserPreference Sets user preferences

SubmitJob Creates a job

SystemLogin Authenticates the administrator user

UpdateResourceGroup Refreshes the resource group list

UploadFile Copies a file to the volume

VerifyAuthId Checks for the existence of an AuthID

WaitForExecuteReport Returns the status of a cancel request for an immediate report job

Table 2-1 IDAPI operations summary (continued)

Operation Description

Page 33: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 15

Administrate

an Administrate operation. Only a volume administrator or a user in the Administrator role uses these operations. The valid AdminOperation values are listed and described in Table 2-2.

Table 2-2 Administrative operations

Value Purpose

CopyFile Copies a file or folder in the working directory to a specified target directory.

CreateFileType Creates a new file type in the volume.

CreateFolder Creates a folder in a volume.

CreateUser Creates a user in the volume.

CreateUserGroup Creates a user group.

DeleteFile Deletes files or folders from the volume.

DeleteFileType Deletes file types from the volume.

DeleteJob Deletes one or more jobs.

DeleteJobNotices Deletes one or more job notices.

DeleteJobSchedule Deletes a job schedule.

DeleteUser Deletes one or more users.

DeleteUserGroup Deletes one or more user groups.

MoveFile Moves a file or folder from the working directory to a specified target directory in the volume.

Transaction A packaging mechanism for Administrate operations. If a failure occurs anywhere in a transaction, all operations in the transaction fail.

UndeleteUser Restores a previously deleted user.

UpdateFile Updates file or folder properties in the volume.

UpdateFileType Updates file type properties in the volume.

UpdateJobSchedule Updates a job schedule.

UpdateOpenSecurityCache Flushes the volume’s open security cache and retrieves new data from an external security source.

UpdateUser Updates user properties.

UpdateUserGroup Updates user group properties.

UpdateVolumeProperties Updates the properties of a specific volume.

Page 34: Actuate API Reference - OpenText

16 A c t u a t e A P I R e f e r e n c e

Cal lOpenSecuri tyL ibrary

CallOpenSecurityLibraryCalls the Report Server Security Extension (RSSE) API AcRSSEPassThrough function or PassThrough message, which calls the RSSE for general purposes. The application then interprets the value AcRSSEPassThrough or PassThrough returns, along with the return code. The RSSE library registered with BIRT iHub determines the returned value.

Requestelement

InputParameterString. The input parameter string.

Responseelements

OutputParameterString. The output parameter.

ReturnCodeInt. The return code.

CancelJobTerminates a job.

Requestelement

JobIdString. The id of the job to be cancelled.

Responseelements

StatusCancelJobStatus. The status of the cancelled job.

ErrorDescriptionString. An error message regarding the cancelled job.

CancelReportStops synchronous report execution. Synchronous report execution can be cancelled only after the connection handle is received. ConnectionHandle is a session ID of the object.

The job submitter can cancel a report. Only the system administrator can cancel or get the information about the report of another user.

Requestelement

ObjectIdString. The object ID of the report to cancel.

Responseelements

StatusString. The status of the request. One of the following values:

■ SucceededThe synchronous report generation was successfully cancelled.

Page 35: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 17

CloseInfoObject

■ FailedThe request failed.

■ InActiveThe synchronous report generation is complete and cannot be cancelled.

ErrorDescriptionString. A description of any error that occurred.

CloseInfoObjectCloses an information object.

Requestelement

DataFetchHandleString. The handle to the information object.

CreateDatabaseConnectionObsolete since iHub Release 2.

CreateIOCacheObsolete since iHub Release 2.

CreateParameterValuesFileCreates a report object value (.rov) file. To create the ROV based on specified parameters, specify ParameterList. To create the ROV based on an executable file, specify BasedOnFileName or BasedOnFileId. To create the ROV based on another ROV, specify ParameterFile. If you create the ROV based on either an executable or ROV, all parameters must be defined in the based-on file.

CreateParameterValuesFile ignores parameters not defined in the based-on file.

Requestelements

BasedOnFileNameString. The name of the executable file on which to base the ROV. Specify either BasedOnFileName or BasedOnFileId.

BasedOnFileIdString. The ID of the executable file on which to base the ROV. Specify either BasedOnFileId or BasedOnFileName.

Page 36: Actuate API Reference - OpenText

18 A c t u a t e A P I R e f e r e n c e

CreateQuery

ParameterFileNewFile. The existing ROV on which to base the ROV.

ParameterValueListArrayOfParameterValue. The list of parameters on which to base the ROV.

FilePropertiesArrayOfString. The file properties to return.

Responseelement

ParameterValuesFileFile. The ROV attributes.

CreateQueryObsolete since iHub Release 2.

CreateResourceGroupCreates a resource group and specifies its properties.

Requestelements

ResourceGroupResourceGroup. The resource group details.

ResourceGroupSettingsListArrayOfResourceGroupSettings. The resource group settings.

CubeExtractionExtracts data from a specified data cube object.

Requestelements

ObjectObjectIdentifier. The ID of the object from which to extract the data.

ComponentArrayOfNameValuePair. The name, display name, or ID, and the value of the component from which to retrieve the data.

PropertiesArrayOfNameValuePair. The properties to retrieve.

ColumnsArrayOfString. The list of column names.

FilterListArrayOfDataFilterCondition. The list of available filters.

Page 37: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 19

DataExtract ion

SortColumnListArrayOfDataSortColumn. The list of columns on which to sort the query.

Responseelements

ResultSetSchemaResultSetSchema. The complex data type that describes the result set schema.

DataExtractionRefThe reference to the complex data type that describes the object in the attachment Attachment. and contains the attachment as binary data.

ConnectionHandleString. The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.

DataExtractionExtracts data from a specified object. DataExtraction does not support extraction from multiple components. If multiple components are specified, DataExtraction only extracts the data of the last component.

Requestelements

ObjectObjectIdentifier. The ID of the object from which to extract the data.

ComponentArrayOfNameValuePair. The name, display name, or ID, and the value of the component from which to retrieve the data.

PropertiesArrayOfNameValuePair. The properties to retrieve.

ColumnsArrayOfString. The list of column names.

FilterListArrayOfDataFilterCondition. The list of available filters.

SortColumnListArrayOfDataSortColumn. The list of columns on which to sort the query.

StartRowNumberInt. The row number from which to start data extraction.

Responseelements

ResultSetSchemaResultSetSchema. The complex data type that describes the result set schema.

DataExtractionRefAttachment. The reference to the complex data type that describes the object in the attachment and contains the attachment as binary data.

Page 38: Actuate API Reference - OpenText

20 A c t u a t e A P I R e f e r e n c e

DeleteDatabaseConnect ion

ConnectionHandleString. The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.

DeleteDatabaseConnectionObsolete since iHub Release 2.

DeleteIOCacheObsolete since iHub Release 2.

DeleteResourceGroupDeletes a resource group. You cannot delete a default resource group. If a scheduled job is assigned to a resource group that you delete, the job remains in a pending state when BIRT iHub runs the job. If job is running on a Factory assigned to a resource group that you delete, the job completes.

Element NameString. The name of the resource group to delete.

DownloadFileDownloads a file from a volume. An attachment is included in the response packet, which refers to file content. The file content is streamed back using SOAP attachment.

Requestelements

FileNameString. The name of the file to download. Specify either FileName or FileId.

FileIdString. The ID of the file to download. Specify either FileId or FileName.

DecomposeCompoundDocumentBoolean. Specifies whether to download a compound document as one file or multiple attachments. If False, you can download the file as a single file. If True, and the file is a compound document, BIRT iHub splits the file into several attachments. The default value is False.

Page 39: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 21

DownloadTransientFi le

DownloadEmbeddedBoolean. Specifies whether to send the attachment embedded in the body of the SOAP message or in a separate MIME boundary. If True, the response contains the attachment as embedded data. If False, the attachment is in a separate MIME boundary. The default value is False.

FilePropertiesArrayOfString. The file properties to return.

Responseelements

FileFile. The file properties.

ContentAttachment.The downloaded file in an embedded or chunked file operation.

ContainedFilesArrayOfAttachment. The downloaded set of files in a decomposed compound document operation.

DownloadTransientFileObsolete since iHub Release 2.

ExecuteQueryObsolete since iHub Release 2.

ExecuteReportTriggers the execution of a report in synchronous mode. If you specify WaitTime, BIRT iHub sends a response within the specified time. Otherwise, BIRT iHub sends a response when the request is complete or, if progressive viewing is enabled, when the first page is complete. Specify FileType in the SOAP header for all execute, submit, and view IDAPI requests.

Requestelements

JobNameString. The name of the job.

InputFileNameString. The name of the input executable file. Specify either InputFileName or InputFileId.

Page 40: Actuate API Reference - OpenText

22 A c t u a t e A P I R e f e r e n c e

ExecuteReport

InputFileIdString. The ID of the input executable file. Specify either InputFileId or InputFileName.

InputFileAttachment. Specifies that the input executable file is an attachment in the response. Valid only if the value of SaveOutputFile is False.

OutputFormatString. The display format for the output file.

SaveOutputFileBoolean. Specifies whether to use the RequestedOutputFile setting. If False, BIRT iHub ignores RequestedOutputFile. If True and RequestedOutputFile is missing, BIRT iHub reports an error.

RequestedOutputFileNewFile. The name to use for the output file. Required for persistent jobs.

ParameterValuesArrayOfParameterValue. The array of parameter values choice with which to overwrite the default parameter values:

■ ParameterValuesFileNameThe name of the report object value (.rov) file to create. If specified, BIRT iHub creates a persistent ROV. Otherwise, BIRT iHub creates a temporary ROV. Specify either ParameterValuesFileName or ParameterValuesFileId.

■ ParameterValuesFileIdThe ID of the ROV to create. If specified, BIRT iHub creates a persistent ROV. Otherwise, BIRT iHub creates a temporary ROV. Specify either ParameterValuesFileId or ParameterValuesFileName.

IsBundledBoolean. Specifies whether the report is bundled. If True, the report is bundled. If False, the report is not bundled. The default value is False.

OpenServerOptionsOpenServerOptions. The open server options to use. Valid options are:

■ KeepWorkingSpace

■ DriverTimeout

■ PollingInterval

ProgressiveViewingBoolean. Specifies whether to enable progressive viewing. True enables progressive viewing. The default value is True.

Page 41: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 23

ExecuteVolumeCommand

WaitTimeInt. The number of seconds BIRT iHub waits before sending a response to the report generation request. Use WaitTime to provide the ability to cancel a synchronous report generation request. The default value is 150 seconds.

Responseelements

StatusExecuteReportStatus. Indicates the execution status of a synchronous job. One of the following values:

■ Done

■ Failed

■ FirstPage

■ Pending

ErrorDescriptionString. The description of the error. Returned if Status is Failed.

OutputFileTypeString. Sets the file type for the output file.

ObjectIdString. The object ID of the report.

ConnectionHandleString. The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.

ExecuteVolumeCommandExecutes predefined volume control commands.

Requestelements

VolumeNameString. The volume on which to execute the commands.

CommandString. One or more of the following commands to execute:

■ StartPartitionPhaseOutStarts the storage location phase out.

■ StartArchiveStarts an archive pass.

■ StopArchiveStops an archive pass if one is currently running. If an archive pass is not currently running, this command returns a Failed status. This command is asynchronous. This means that the call returns without waiting for the archive

Page 42: Actuate API Reference - OpenText

24 A c t u a t e A P I R e f e r e n c e

ExtractParameterDef ini t ionsFromFile

pass to stop. To find out the status of the archive pass after sending this command, use GetVolumeProperties.

Only a user with the Operator or Administrator role can issue this command.

Responseelements

StatusString. The status of command execution. One of the following values:

■ SucceededThe command succeeded.

■ FailedThe command failed.

ExtractParameterDefinitionsFromFileRetrieves the parameter definitions from the specified file.

Requestelement

ContentAttachment. The parameter definitions to retrieve.

Responseelement

ParameterListArrayOfParameterDefinition. The requested parameter definitions.

ExportParameterDefinitionsToFileExports parameter definitions associated with the specified file to a new file.

Requestelements

ParameterListArrayOfParameterDefinition. The parameters to export.

DownloadEmbeddedBoolean. Specifies whether to send the attachment embedded in the body of the SOAP message or in a separate MIME boundary. If True, the response contains the attachment as embedded data. If False, the attachment is in a separate MIME boundary. The default value is False.

Responseelement

ContentAttachment. The exported parameter definitions.

FetchInfoObjectDataObsolete since iHub Release 2.

Page 43: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 25

GetAl lCounterValues

GetAllCounterValuesRetrieves the values of all counters.

Responseelement

CounterInfoListArrayOfCounterInfo. The values of all counters.

GetBookmarksRetrieves the bookmarks in a report design.

Requestelement

ObjectObjectIdentifier. The object from which to retrieve the bookmarks.

Responseelement

BookmarkListArrayOfBookMark. The array of bookmarks

GetCapabilitiesRequests the array of capabilities available for a user group.

Requestelements

UserGroupNameString. The user group name.

UserGroupIdString. The user group ID.

UserNameString. The user name.

UserIdString. The user ID.

CategoriesArrayOfString. The Categories list.

DirectOnlyBoolean. Indicates whether capabilities are direct only.

Responseelement

CapabilitiesThe array of Capabilities.

GetCapabilitiesByCategoryRequests the array of capabilities available for a user group category.

Page 44: Actuate API Reference - OpenText

26 A c t u a t e A P I R e f e r e n c e

GetCapabi l i tyCategor ies

Requestelement

CategoryString. The category name.

Responseelement

CapabilitiesArrayOfString. The capabilities list.

GetCapabilityCategoriesGets the list of capability categories.

Requestelement

GetCapabilityCategoriesThe GetCapabilityCategories request.

Responseelement

CategoriesArrayOfString. The categories list.

GetChannelACLObsolete since iHub Release 3.

GetConnectionPropertiesRetrieves the connection properties for a file, including user, role, or user group lists.

Requestelements

FileNameString. The name of the file.

FileIdString. The file ID of the file.

UserNamesString. The user names attached to the file.

UserIdString. The user ID attached to the file.

RoleNameString. The role names attached to the file.

RoleIdString. The role ID attached to the file.

UserGroup NamesString. The user group names attached to the file.

Page 45: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 27

GetConnect ionPropertyAssignees

UserGroupIdString. The user group ID attached to the file.

EffectiveBoolean. The user group ID attached to the file.

Responseelement

ConnectionPropertiesArrayOfPropertyValue. The list of user, role, and user groups attached to the file, and which properties are effective.

GetConnectionPropertyAssigneesRetrieves the users and user groups for a file.

Requestelements

FileNameString. The name of the file.

FileIdString. The file ID of the file.

Responseelements

UserNamesArrayOfString. The user names associated with the file.

RoleNamesArrayOfString. The roles names associated with the file.

UserGroupNamesArrayOfString. The user group names associated with the file.

GetContentObsolete since iHub Release 2.

GetCounterValuesRetrieves the IDs, names, and values of specific counters.

Requestelement

CounterIDListArrayOfLong. The list of counters for which to retrieve information.

Responseelement

CounterInfoListArrayOfCounterInfo. The IDs, names, and values of the specified counters

Page 46: Actuate API Reference - OpenText

28 A c t u a t e A P I R e f e r e n c e

GetCubeMetaData

GetCubeMetaDataRetrieves cube metadata describing a result set schema.

Requestelements

ObjectObjectIdentifier. The object from which to retrieve the metadata.

ComponentArrayOfNameValuePair. The name, display name, or ID, and the value of the component from which to retrieve the metadata.

Responseelement

ArrayOfResultSetSchemaArrayOfResultSetSchema. The complex data type that represents an array of ResultSetSchema objects.

GetCustomFormatObsolete since iHub Release 2.

GetDatabaseConnectionDefinitionObsolete since iHub Release 2.

GetDatabaseConnectionParametersObsolete since iHub Release 2.

GetDatabaseConnectionTypesObsolete since iHub Release 2.

GetDataExtractionFormatsRetrieves a list of DataExtractionFormat objects for a specific file type. These objects consist of an output format and a mime type.

Requestelement

FileTypeString. The name of the file type about which to retrieve information.

Page 47: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 29

GetDocumentConversionOptions

Responseelement

DataExtractionFormatsArrayOfDataExtractionFormat. The list of DataExtractionFormat objects.

GetDocumentConversionOptionsRetrieves a list of DocumentConversionOptions. A document conversion option includes a file type, output format, mime type and parameter definitions.

Requestelements

FileTypeString. The file type about which to retrieve the conversion options. When FileType is not set, the response includes options for all the Java report documents. In this case, GetDocumentConversionOptions ignores OutputFormat.

When a FileType is set, GetDocumentConversionOptions returns the options for the conversion to the specified OutputFormat.

OutputFormatString. The display format about which to retrieve the conversion options. When OutputFormat is not specified, the response includes parameters for all output formats.

If the FileType or OutputFormat fields specify unsupported formats, GetDocumentConversionOptions returns a SOAP fault.

Responseelement

ConversionOptionsArrayOfDocumentConversionOptions. The list of DocumentConversionOptions.

GetDynamicDataObsolete since iHub Release 2.

GetEmbeddedComponentObsolete since iHub Release 2.

GetFactoryServiceInfoRetrieves general information about a Factory service. The node name is specified in the TargetServer element of the SOAP header.

GetFactoryServiceInfo is available only to a BIRT iHub System administrator. To log in as a BIRT iHub System administrator, use SystemLogin.

Page 48: Actuate API Reference - OpenText

30 A c t u a t e A P I R e f e r e n c e

GetFactoryServiceInfo

To retrieve a list of servers for which you can obtain information, use GetSystemServerList.

Requestelement

GetFactoryServiceInfoInformation about the Factory service.

Responseelements

ServerNameString. The node for which information is returned.

PendingSyncJobsLong. The number of synchronous jobs in queue.

SyncJobQueueSizeLong. The maximum number of synchronous jobs allowed in the queue.

RunningSyncJobsLong. The number of synchronous jobs currently running.

RunningJobsLong. The total number of jobs currently running.

SyncFactoryProcessesLong. The number of Factories reserved for running synchronous jobs.

MaxFactoryProcessesLong. The maximum number of Factories that can run on the system.

TransientReportCacheSizeLong. The maximum disk space available for transient reports, in megabytes.

PercentTransientReportCacheInUseLong. The currently used percentage of disk space available for transient reports.

CurrentTransientReportTimeoutLong. The number of minutes after which transient reports are deleted from the synchronous cache adjusted according to disk space currently available in the synchronous cache.

TransientReportTimeoutLong. Time after which transient reports are deleted from the synchronous cache, in minutes.

SyncJobQueueWaitLong. The maximum time a job remains in the synchronous queue, in seconds.

MaxSyncJobRuntimeLong. The maximum job execution time, in seconds.

Page 49: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 31

GetFactoryServiceJobs

GetFactoryServiceJobsRetrieves information about pending synchronous jobs and all running jobs on the node. The node is specified in the TargetServer element of the SOAP header.

For pending synchronous jobs, GetFactoryServiceJobs always returns the following information in addition to any values you specify:

■ ConnectionHandle

■ ObjectId

■ IsTransient

■ Volume

For running jobs, GetFactoryServiceJobs always returns the following information in addition to any values you specify:

■ IsSyncJob

■ Volume

■ ConnectionHandle

■ ObjectId

■ IsTransient for synchronous jobs or JobId for asynchronous jobs

To retrieve all information, specify All.

GetFactoryServiceJobs is available only to a BIRT iHub System administrator. To log in as a BIRT iHub System administrator, use SystemLogin.

Requestelements

PendingSyncJobsResultDefArrayOfString. Requests the following information about pending synchronous jobs:

■ DefaultConnectionHandle, ObjectId, IsTransient, and Volume

■ AllAll information

■ ServerNameThe node on which the job originated

■ OwnerThe name of the user who submitted the job

■ ExecutableFileNameThe fully qualified name of the executable file

Page 50: Actuate API Reference - OpenText

32 A c t u a t e A P I R e f e r e n c e

GetFactoryServiceJobs

■ ExecutableVersionNumberThe fully qualified version number of the executable file

■ ExecutableVersionNameThe fully qualified version name of the executable file

■ SubmissionTimeThe time the job was submitted to the server

■ QueueTimeoutThe number of seconds remaining before the job is deleted from the queue

■ QueuePositionThe job’s position in the queue

RunningJobsResultDefArrayOfString. Requests the following information about all running jobs:

■ DefaultIsSyncJob, Volume, ConnectionHandle, ObjectId, IsTransient for synchronous jobs or JobId for asynchronous jobs.

■ AllAll information.

■ ServerNameThe node on which the job originated.

■ OwnerThe name of the user who submitted the job.

■ ExecutableFileNameThe fully qualified name of the executable file.

■ ExecutableVersionNumberThe fully qualified version number of the executable file.

■ ExecutableVersionNameThe fully qualified version name of the executable file.

■ SubmissionTimeThe time the job was submitted to the server.

■ StartTimeThe time at which the job execution started.

■ ExecutionTimeoutThe number of seconds remaining before the job execution expires. Always zero (infinite) for asynchronous reports.

Page 51: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 33

GetFileACL

■ IsSyncFactoryTrue if the Factory is running synchronous jobs, False if the Factory is running asynchronous jobs.

■ FactoryPidThe Process ID of the Factory.

Responseelements

PendingSyncJobsArrayOfPendingSyncJob. Information about pending synchronous jobs on the node.

RunningJobsArrayOfRunningJob. Information about all running jobs on the node.

GetFileACLRetrieves the ACL of the specified file or folder.

Requestelements

FileIdString. The ID of the file or folder for which to retrieve the ACL. Specific either FileId or FileName.

FileNameString. The full name of the file or folder for which to retrieve the ACL. Specify either FileName or FileId.

GrantedUserIdString. The user ID.

GrantedUserNameString. The user name.

GrantedRoleIdString. The role ID.

GrantedRoleNameString. The role name.

GrantedUserGroupIdString. The user group ID.

GrantedRoleNameString. The user group name.

FetchSizeInt. The maximum number of records to retrieve and return in a result set. The default value is 500.

Page 52: Actuate API Reference - OpenText

34 A c t u a t e A P I R e f e r e n c e

GetFi leCreat ionACL

FetchDirectionBoolean. If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.

CountLimitInt. The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to -1.

FetchHandleString. Retrieves more items from the result set. In the second and subsequent calls for data, specify the same search criteria as in the original call.

Responseelements

ACLArrayOfPermission. The ACL of the file or folder.

FetchHandleString. Indicates that the number of items in the result set exceeds the FetchSize limit.

TotalCountInt. The number of entries in the search result set.

GetFileCreationACLRetrieves the specified user FileCreationACL. The FileCreationACL is the template applied to all new files the user creates.

Requestelements

CreatedByUserNameString. The name of the user whose template to retrieve. Specify either CreatedByUserName or CreatedByUserId.

CreatedByUserIdString. The ID of the user whose template to retrieve. Specify either CreatedByUserId or CreatedByUserName.

GrantedUserIdString. The user ID. Specify either GrantedUserId or GrantedUserName.

GrantedUserNameString. The user name. Specify either GrantedUserName or GrantedUserId.

GrantedRoleIdString. The role ID. Specify either GrantedRoleId or GrantedRoleName.

GrantedRoleNameString. The role name. Specify either GrantedRoleName or GrantedRoleId.

Page 53: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 35

GetFi leDetai ls

FetchSizeInt. The maximum number of records to retrieve and return in a result set. The default value is 500.

FetchDirectionBoolean. If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.

CountLimitInt. The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to -1.

FetchHandleString. Retrieves more items from the result set. In the second and subsequent calls for data, specify the same search criteria as in the original call.

Responseelements

ACLArrayOfPermission. The user ACL.

FetchHandleString. Indicates that the number of items in the result set exceeds the FetchSize limit.

TotalCountInt. The number of entries in the search result set.

GetFileDetailsRetrieves the properties of the specified file.

Requestelements

FileNameString. The full name of the file for which to retrieve properties. Specify either FileName or FileId.

FileIdString. The ID of the file for which to retrieve properties. Specify either FileId or FileName.

ResultDefArrayOfString. The properties to retrieve. The file properties are always returned. In addition, you can specify one or more of the following:

■ ACLThe access control list (ACL) of the file

■ ArchiveRulesThe archive rules of the file

Page 54: Actuate API Reference - OpenText

36 A c t u a t e A P I R e f e r e n c e

GetFi leTypeParameterDefin i t ions

■ AccessTypeThe access rights to the file, private or shared

Responseelements

FileFile. The file properties.

ACLArrayOfPermission. The ACL. Returned only if ACL is specified in ResultDef.

ArchiveRulesArrayOfArchiveRule. The archive rules. Returned only if ArchiveRules is specified in ResultDef.

GetFileTypeParameterDefinitionsRetrieves parameters of the specified file type on the BIRT iHub to which the user is logged in.

Requestelement

FileTypeString. The name of the file type for which to retrieve information.

Responseelement

ParameterListArrayOfParameterDefinition. The list of parameters.

GetFolderItemsRetrieves all specified objects in a specified folder, such as all files or folders, a list of files or folders, or all users.

To search all files or folders that match the specified conditions, specify Search.

Requestelements

FolderNameString. The full path and the name of the folder from which to retrieve objects. Specify either FolderName or FolderId.

FolderIdString. The ID of the folder from which to retrieve objects. Specify either FolderId or FolderName.

ResultDefArrayOfString. The properties to retrieve. By default, the Id and Name are always returned. In addition, you can specify the following properties:

■ Description

■ FileType

■ Owner

Page 55: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 37

GetFormats

■ PageCount

■ Size

■ TimeStamp

■ Version

■ VersionName

■ UserPermissions

LatestVersionOnlyBoolean. Specifies whether only the latest version is returned. If True, only the latest version is returned. The default value is False.

SearchThe search condition. If conditions apply to multiple fields, use ConditionArray. FileSearch.

Responseelements

ItemListArrayOfFile. The objects matching the search criteria.

FetchHandleString. Indicates that the number of items in the result set exceeds the FetchSize limit.

TotalCountInt. The number of entries in the search result set.

GetFormatsObsolete since iHub Release 2.

GetInfoObjectObsolete since iHub Release 2.

GetJavaReportEmbededComponentRetrieves an embedded component in the document such as an image or a graph.

Requestelements

ObjectObjectIdentifier. The ID of the object from which to retrieve an embedded component in a document.

Page 56: Actuate API Reference - OpenText

38 A c t u a t e A P I R e f e r e n c e

GetJavaReportTOC

ComponentArrayOfNameValuePair. The name, display name, or ID, and the value of the component to retrieve.

AttributesArrayOfNameValuePair. Currently not used by BIRT reports.

DownloadEmbeddedBoolean. Specifies whether to send the attachment embedded in the body of the SOAP message or in a separate MIME boundary. If True, the response contains the attachment as embedded data. If False, the attachment is in a separate MIME boundary. The default value is False.

Responseelements

EmbeddedRefAttachment. Contains the following properties of the attachment:

■ MimeType

■ ContentEncoding

■ ContentLength

■ Locale

ConnectionHandleString. The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.

GetJavaReportTOCRetrieves the table of contents (TOC) of the document.

Requestelements

ObjectObjectIdentifier. The ID of the object from which to retrieve the TOC.

DownloadEmbeddedBoolean. Specifies whether to send the attachment embedded in the body of the SOAP message or in a separate MIME boundary. If True, the response contains the attachment as embedded data. If False, the attachment is in a separate MIME boundary. The default value is False.

ComponentArrayOfNameValuePair. The name, display name, or ID, and the value of the component from which to retrieve the TOC.

RecursiveBoolean. Specifies whether to search subfolders. If True, the search includes subfolders. The default value is False.

Page 57: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 39

GetJobDetai ls

Responseelements

TocRefAttachment. The details of the attachment such as contentId, contentType, contentLength, contentEncoding, locale, and contentData.

ConnectionHandleString. The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.

GetJobDetailsRetrieves the properties of a specified job.

Requestelements

JobIdString. The ID of the job from which to retrieve properties.

ResultDefArrayOfString. The properties to retrieve. You can specify the following properties:

■ JobAttributesThe general job properties

■ InputDetailThe job input parameters

■ SchedulesThe job schedule information

■ PrinterOptionsThe printer settings, if available

■ NotifyUsersThe names of users to receive notifications about the job

■ NotifyGroupsObsolete since iHub Release 3

■ NotifyChannelsObsolete since iHub Release 3

■ DefaultOutputFileACLThe output file ACL templates

■ StatusThe job status

■ ReportParametersThe report parameters from the report parameters value file associated with the job

Page 58: Actuate API Reference - OpenText

40 A c t u a t e A P I R e f e r e n c e

GetJobDetai ls

■ ResourceGroupThe name of the resource group to which the job is assigned

GroupingEnabledObsolete since iHub Release 2.

SupportedQueryFeaturesObsolete since iHub Release 2.

Responseelements

JobAttributesJobProperties. The general job attributes.

InputDetailJobInputDetail. The job input parameters.

SchedulesJobSchedule. The job schedule information.

PrinterOptionsPrinterOptions. The job printer settings.

NotifyUsersArrayOfString. The names of users to receive notifications about the job.

NotifyGroupsObsolete since iHub Release 3.

NotifyChannelsObsolete since iHub Release 3.

DefaultOutputFileACLArrayOfPermission. The output file access control list (ACL) templates.

StatusString. The job status.

ReportParametersArrayOfParameterValue. The report parameters associated with the job.

QueryObsolete since iHub Release 2.

OutputFileAccessTypeFileAccess. The access rights to the output file. One of the following values:

■ PrivateOnly the owner of the file and an administrator can access the file.

■ SharedAll users and roles specified in the access control list (ACL) for the file can access the file.

Page 59: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 41

GetMetaData

WaitForEventEvent. An event that must complete before processing the response.

GetMetaDataRetrieves the metadata describing a result set schema.

Requestelements

ObjectObjectIdentifier. The object from which to retrieve the metadata.

ComponentArrayOfNameValuePair. The name, display name, or ID, and the value of the component from which to retrieve the metadata.

Responseelement

ArrayOfResultSetSchemaArrayOfResultSetSchema. The complex data type that represents an array of ResultSetSchema objects.

GetNoticeJobDetailsRetrieves the properties of the specified job notice.

Requestelements

JobIdString. The ID of the job from which to retrieve properties.

ResultDefArrayOfString. The properties to retrieve. You can specify the following properties:

■ InputDetailThe job input parameters

■ SchedulesThe job schedule information

■ PrinterOptionsThe printer settings, if available

■ NotifyUsersThe names of users to receive notifications about the job

■ NotifyGroupsObsolete since iHub Release 3

■ NotifyChannelsObsolete since iHub Release 3

Page 60: Actuate API Reference - OpenText

42 A c t u a t e A P I R e f e r e n c e

GetNoticeJobDetai ls

■ DefaultOutputFileACLThe output file access control list (ACL) templates

■ StatusThe job status

■ ReportParametersThe report parameters from the report object value (.rov) file associated with the job

■ ResourceGroupThe name of the resource group to which the job is assigned

NotifiedChannelIdObsolete since iHub Release 3.

NotifiedChannelNameObsolete since iHub Release 3.

GroupingEnabledObsolete since iHub Release 2.

SupportedQueryFeaturesObsolete since iHub Release 2.

Responseelements

JobAttributesJobProperties. The general job attributes.

InputDetailJobInputDetail. The job input parameters.

SchedulesJobSchedule. The job schedule information.

PrinterOptionsJobPrinterOptions. The job printer settings.

NotifyUsersArrayOfString. The names of users to receive notifications about the job.

NotifyGroupsObsolete since iHub Release 3.

NotifyChannelsObsolete since iHub Release 3.

DefaultOutputFileACLArrayOfPermission. The output file access control list (ACL) templates.

StatusString. The job status.

Page 61: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 43

GetPageCount

ReportParametersArrayOfParameterValue. The report parameters from report object value (.rov) file associated with the job.

OutputFileAccessTypeFileAccess. The access rights to the output file. One of the following values:

■ PrivateOnly the owner of the file and an administrator can access the file.

■ SharedAll users and roles specified in the ACL for the file can access the file.

WaitForEventEvent. An event that must be completed before the response is processed.

GetPageCountRetrieves the number of pages in a report in a report generated by iHub.

Requestelement

ObjectObjectIdentifier. The object from which to retrieve page count.

Responseelements

PageCountString. The number of pages. If the report was uploaded to the volume and not generated by iHub, PageCount is 0.

IsReportCompletedBoolean. True if report generation is complete, False otherwise.

ConnectionHandleString. The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.

GetPageNumberRetrieves the page number of a bookmark component in a report.

Requestelements

ObjectObjectIdentifier. The object from which to retrieve the page number.

ComponentArrayOfNameValuePair. The name, display name, or ID, and the value of the component from which to retrieve the page number. The page number is a bookmark value in a report.

Page 62: Actuate API Reference - OpenText

44 A c t u a t e A P I R e f e r e n c e

GetParameterPickList

Responseelement

PageNumberString. The component element specifies ArrayOfNameValuePair as the data type. If multiple valid bookmarks are present inside a report, a response only returns the page number for first bookmark. Actuate IDAPI does not support getting the page number for multiple components. If you specify multiple components, the response only returns the page number for the first component.

GetParameterPickListRetrieves the parameters names from a pick list in a report.

Requestelements

ObjectObjectIdentifier. The identifier of the object from which to retrieve the parameter pick list.

CascadingGroupNameString. The cascading group name in the pick list containing the target list.

ParameterNameString. The name of the parameter. Each parameter name is unique within a report even between execution and view parameters.

PrecedingParameterValuesArrayOfParameterValue. The values of the parameters that precede the specified parameter.

FilterString. A string prefix to be applied to the overall selection list.

StartIndexLong. The index where the fetch operation starts.

FetchSizeLong. The maximum number of records to retrieve and return in a result set. The default value is 500.

CountLimitLong. The Number of entries to be counted after FetchSize is reached. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to -1.

Responseelements

ParameterPickListArrayOfNameValuePair. List of parameters.

TotalCountLong. The number of parameters in the list.

Page 63: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 45

GetReportParameters

GetReportParametersRetrieves report parameter values. GetReportParameters requires execute or read privileges when executed against a BIRT design, BIRT data design, or BIRT 360 dashboard file. When executed against a BIRT document file, GetReportParameters requires execute, secure read, or read privileges.

Requestelements

JobIdString. The ID of the job from which to retrieve the parameter values. Specify JobId to retrieve the parameter values from the report file associated with the job.

ReportFileIdString. The ID of the file from which to retrieve the parameter values. Specify ReportFileId or Report FileName to retrieve parameter values from an executable, document, or object value file, or a third-party compound storage file.

ReportFileNameString. The name of the file from which to retrieve the parameter values. Specify ReportFileName or Report FileId to retrieve parameter values from an executable, document, or object value file, or a third-party compound storage file.

ReportParameterTypeReportParameterType. Optional parameter type can include Execution, View, and All. If not specified, only execution parameters return to maintain backward compatibility.

WithoutDynamicPickListBoolean. If set to True, parameters will be returned without a dynamic pick list.

Responseelements

ParameterListArrayOfParameterDefinition. The list of parameter definition values such as group, cascading parent name, name, data type, default value, display name, help text, and so forth.

ViewParameterListArrayOfParameterDefinition. The list of view parameter definition values such as format, user agent, scaling factor, accept encoding, view operation, path information, embedded object path, redirect path, and PDF quality.

GetResourceGroupInfoRetrieves information about a specific resource group.

Requestelement

NameString. The name of the resource group for which to retrieve information.

Page 64: Actuate API Reference - OpenText

46 A c t u a t e A P I R e f e r e n c e

GetResourceGroupList

Responseelements

ResourceGroupResourceGroup. Contains the following information about the resource group:

■ Name

■ Disabled

■ Description

■ Type

■ MinPriorityApplies only to an asynchronous resource group

■ MaxPriorityApplies only to an asynchronous resource group

■ ReservedApplies only to a synchronous resource group

ResourceGroupSettingsListResourceGroupSettings. Contains the following information about the resource group:

■ ServerName

■ Activate

■ MaxFactory

■ FileTypes

GetResourceGroupListRetrieves a list of resource groups available to a BIRT iHub. GetResourceGroupList returns two lists, one for asynchronous resource groups and one for synchronous resource groups.

Responseelements

AsyncResourceGroupListArrayOfResourceGroup. The list of available asynchronous resource groups and the properties of each of those resource groups.

SyncResourceGroupListArrayOfResourceGroup. The list of available synchronous resource groups and the properties of each of those resource groups.

ViewResourceGroupListArrayOfResourceGroup. The list of available synchronous resource groups and the properties of each of those resource groups.

Page 65: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 47

GetSavedSearch

WorkUnitTypesArrayOfString. The list of available work unit types and properties.

GetSavedSearchObsolete since iHub Release 2.

GetServerResourceGroupConfigurationRetrieves information about resource groups available to the specified BIRT iHub.

Requestelement

ServerNameString. The name of the BIRT iHub from which to retrieve information.

Responseelement

ServerResourceGroupSettingListArrayOfServerResourceGroupSetting. Contains the following information about each resource group:

■ ResourceGroupName

■ Activate

■ Type

■ MaxFactory

■ FileTypes

GetStaticDataObsolete since iHub Release 2.

GetStyleSheetObsolete since iHub Release 2.

GetSyncJobInfoRetrieves information about a synchronous job.

GetSyncJobInfo is available only to a BIRT iHub System administrator. To log in as a BIRT iHub System administrator, use SystemLogin.

Page 66: Actuate API Reference - OpenText

48 A c t u a t e A P I R e f e r e n c e

GetSystemMDSInfo

Requestelement

ObjectIdString. The ID of the synchronous job for which to retrieve information.

Responseelements

StatusString. The status of the job. Valid values are:

■ Pending

■ Running

■ Completed

■ Failed

ErrorDescriptionString. The description of the error. Returned if Status is Failed.

PendingPendingSyncJob. The properties of the pending synchronous job.

RunningRunningJob. The properties of the running synchronous job.

GetSystemMDSInfoRetrieves the names and properties of an MDS in a cluster or stand-alone server without authenticating the client. Use GetSystemMDSInfo to route requests to an alternate MDS if the one to which the client connects fails.

Requestelement

OnlineOnlyBoolean. If True, information is retrieved only for an online MDS.

Responseelement

MDSInfoListArrayOfMDSInfo. The information about each MDS.

GetSystemPrintersRetrieves all system printer information on the BIRT iHub to which the user is logged in.

If GetSystemPrinters cannot retrieve the printer information, for example if the printer is temporarily unavailable, and you specified the PrinterName, the response contains empty or incomplete attributes. If GetSystemPrinters cannot retrieve the printer information and you did not specify PrinterName, a SOAP fault is generated.

Requestelements

PrinterNameString. The name of the printer for which to retrieve information. If not specified, information is retrieved for all printers configured for the volume.

Page 67: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 49

GetSystemServerList

GetAllPaperSizesBoolean. Indicates whether to retrieve all available paper sizes for the printer. If True, all paper sizes are retrieved. If False, only a subset of paper sizes are retrieved. The default value is False.

Responseelement

PrintersArrayOfPrinter. The printer information.

GetSystemServerList Retrieves the list of BIRT iHubs and their states.

GetSystemServerList can retrieve information about cluster servers and online stand-alone servers. GetSystemServerList cannot retrieve information about stand-alone servers that are offline.

GetSystemServerList is available only to a BIRT iHub System administrator. To log in as a BIRT iHub System administrator, use SystemLogin.

Responseelement

ServerListArrayOfServerInformation. Contains the following information about the server:

■ Server name

■ Server state

■ Error code of a failed server

■ Error description of a failed server

GetSystemVolumeNamesObsolete since iHub Release 2.

GetTOCObsolete since iHub Release 2.

GetUserExtendedPropertiesGets list of user extended properties, such as property name, ID, and product family.

Page 68: Actuate API Reference - OpenText

50 A c t u a t e A P I R e f e r e n c e

GetUserGroupExtendedPropert ies

Requestelements

PropertyNameString. The extended user property name.

PropertyNameListArrayOfString. The list of extended user property names.

UserNameString. The user name.

UserIdString. The user ID.

ProductFamilyString. The product family.

Responseelement

PropertiesArrayOfNameValuePair. The list of name-value pairs specifying the user extended properties.

GetUserGroupExtendedPropertiesGets list of user group extended properties, such as property name, user group name, ID, and product family.

Requestelements

PropertyNameString. The user group extended property name.

PropertyNameListArrayOfString. The list of user group extended property names.

UserGroupNameString. The user group name.

UserGroupIdString. The user group ID.

ProductFamilyString. The product family.

Responseelement

PropertiesArrayOfNameValuePair. The user group extended properties list.

GetUserGroupProductAccessGets list of product family access by user group name or ID.

Requestelements

UserGroupNameString. The user group name.

Page 69: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 51

GetUserLicenseOptions

UserGroupIdString. The user group ID.

Responseelement

ProductFamiliesArrayOfString. The list of accessible product families.

GetUserLicenseOptionsRetrieves the specified user license options.

Requestelements

UserIdString. The ID of the user for whom to retrieve the printer settings. Specify either UserId or UserName.

UserNameString. The name of the user for whom to retrieve the printer settings. Specify either UserName or UserId.

Responseelement

LicenseOptionsArrayOfString. The license options list.

GetUserPreferenceGets list of user preferences, including preference name and product family.

Requestelements

UserIdString. The user ID.

UserNameString. The user name.

PreferenceNameString. The preference name.

PreferenceNameListArrayOfString. The preference name list.

ProductFamilyString. The product family.

Responseelement

PreferenceArrayOfNameValuePair. The user preferences option list.

GetUserPrinterOptionsRetrieves the specified user printer settings.

Page 70: Actuate API Reference - OpenText

52 A c t u a t e A P I R e f e r e n c e

GetVolumePropert ies

If GetUserPrinterOptions cannot retrieve the printer information, for example if the printer is temporarily unavailable, and you specified the PrinterName, the response contains empty or incomplete attributes. If GetUserPrinterOptions cannot retrieve the printer information and you did not specify PrinterName, a SOAP fault is generated.

Requestelements

UserIdString. The ID of the user for whom to retrieve the printer settings. Specify either UserId or UserName.

UserNameString. The name of the user for whom to retrieve the printer settings. Specify either UserName or UserId.

PrinterNameString. The name of the printer for which to retrieve the settings.

Responseelement

PrinterOptionsArrayOfPrinterOptions. The printer settings.

GetVolumePropertiesRetrieves properties of a specific volume.

Requestelement

ResultDefArrayOfString. The properties to retrieve. By default, VolumeProperties are always returned. In addition, you can specify the following properties:

■ ArchiveLibrary

■ AutoArchiveSchedule

■ ExternalUserPropertyNames

■ OnlineBackupSchedule

■ TranslatedRoleNames

■ PrinterOptions

■ VolumeProperties

Responseelements

VolumePropertiesVolume. The volume properties.

TranslatedRoleNamesExternalTranslatedRoleNames. The translated role names.

ExternalUserPropertyNamesArrayOfString. The external user property names list.

Page 71: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 53

GrantUserGroupCapabi l i t ies

PrinterOptionsArrayOfPrinterOptions. The printer options.

AutoArchiveScheduleJobSchedule. The autoarchive schedule.

ArchiveLibrary String. The name of the archive application for the volume.

ArchiveServiceCmdString. The archive service command for the volume.

LicenseOptionsArrayOfLicenseOption. The license options for the volume.

GrantUserGroupCapabilitiesGrants listed user group capabilities by name or ID.

Requestelements

UserGroupNameString. The user group name.

UserGroupIdString. The user group ID.

CapabilitiesArrayOfCapabilities. The array of user group capabilities.

Responseelement

GrantUserGroupCapabilitiesResponseThe response is empty.

GrantUserGroupProductAccessGrants listed user group product family access by user group name or ID.

Requestelements

UserGroupNameString. The user group name.

UserGroupIdString. The user group ID.

ProductFamiliesArrayOfString. The list of accessible product families.

Responseelement

GrantUserGroupProductAccessResponseThe response is empty.

Page 72: Actuate API Reference - OpenText

54 A c t u a t e A P I R e f e r e n c e

Insta l lApp

InstallAppInstalls application using name, ZIP file path, and description.

Requestelements

NameString. The application name.

ZipFilePathString. The ZIP file path.

DescriptionString. The application description.

Responseelement

FolderIdString. The folder ID.

IsSSOEnabledDetermines whether Single-sign-on (SSO) is enabled.

Requestelements

RelayStateString. The relay state.

EntityIDString. The entity ID.

Responseelements

EnabledBoolean. Indicates whether SSO is enabled.

DestinationURLString. The destination URL.

SAMLRequestString. The SAML request.

RelayStateString. The relay state.

LoginAuthenticates a user to the iHub System.

Requestelements

UserString. The name of the user to log in.

Page 73: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 55

Login

PasswordString. The password of the user to log in. You must specify either Password or Credentials.

EncryptedPwdString. The password in encrypted.

CredentialsBase64Binary. Extended credentials data. Used for Report Server Security Extension (RSSE) integration. You must specify Either Credentials or Password.

DomainString. The volume to which to log in. In Release 11 and iHub 2, the Login message must specify the volume name using TargetVolume in the SOAP header and Domain in the SOAP message body. In iHub 3, specifying the volume name using TargetVolume and Domain in the SOAP message body are optional.

UserSettingBoolean. Specifies whether the response includes detailed user information. If True, the response includes all user attributes. If False, the response does not include detailed user information. The default value is False.

ValidateUserGroupsArrayOfString. Checks whether the user is in the specified user groups.

RunAsUserString. Specifies the user name in the run-time environment.

SAMLTokenString. The SAML token.

GetVolumeListBoolean. Indicates whether to get the volume list.

CapabilityCategoriesArrayOfString. The capability categories list.

ClientVersionString. Specify the enumeration value ihub3 or actuate11.

Responseelements

AuthIdString. The system-generated, encrypted, and authenticated token that the application uses in all subsequent requests.

AdminRightsString. Returned if the user has either Administrator or Operator rights.

UserUser. All user attributes except the user password.

Page 74: Actuate API Reference - OpenText

56 A c t u a t e A P I R e f e r e n c e

OpenInfoObject

LoginVolumeString. The login volume.

FeatureOptionsArrayOfString. The features available to the user:

■ ReportGeneration

■ PageSecureViewingBIRT Page Level Security option

ValidUserGroupsArrayOfString. The user roles from the ValidateRoles list. Does not return the user roles that ValidateRoles does not specify. For example, if ValidateRoles specifies Sales, Marketing, and Engineering and the user has Sales and Accounting roles, the response contains only Sales.

VolumesArrayOfString. The specified volumes.

CapabilitiesThe specified capabilities.

SAMLSessionIndexString. The specified SAML session index.

OpenInfoObjectObsolete since iHub Release 2.

PingTests whether a specific component of BIRT iHub is operational and retrieves other diagnostic information about the component.

Requestelements

DestinationString. The component to test. Valid values are:

■ MDSA Message Distribution service

■ EEAn Encyclopedia engine

■ FSA Factory service

Page 75: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 57

Ping

■ VSA View service

■ OSDAn open server driver

■ AISAn Actuate Integration service

■ ACSObsolete since iHub Release 3

ActionString. The optional action to take. Valid values are:

■ EchoEchoes the data specified in Payload.

■ ReadFileOpens the specified volume file, reads the file’s contents, then closes the file. Applies only if the value of Destination is EE, FS, or VS. Ping returns the timing of the read operation. Specify the file name in FileName.

■ WriteFileCreates a temporary file in a storage location, writes a specified number of bytes to the file, closes the file, then deletes the file. Applies only if the value of Destination is EE or FS. Ping returns the timing information for each step. Specify the storage location in PartitionName. Specify the number of bytes to read in NumBytes.

■ ConnectConnects to a data source. Specify the connection parameters in ConnectionProperties.

ModeString. The level of detail to return. Valid values are:

■ NormalReturns the names of components in the test path and the timestamps of the request entering and leaving each component. This is the default mode.

■ TraceReturns the timestamp of the request entering and leaving major subcomponents of the component being tested.

■ ConciseReturns the elapsed time between a component’s receipt of the request and the time the component sends a reply.

Page 76: Actuate API Reference - OpenText

58 A c t u a t e A P I R e f e r e n c e

Ping

ServerString. Specifies which instance of a Factory service or View service to test. Applies only if the value of Destination is FS or VS. Use Server in conjunction with the ProcessID element. To test all available instances of the Factory or View service, specify an asterisk (*). If not specified, the BIRT iHub load-balancing mechanism allocates an available instance of the requested service to respond to the request.

ProcessIDString. Specifies the process ID of the Factory or View service to test. Use in conjunction with the Server element. Applies only if the value of Destination is FS or VS.

FileNameString. If the value of Action is ReadFile, indicates the volume file to read. If the value of Destination is OSD, specifies the executable file to prepare for execution.

PartitionNameString. Specifies the name of the storage location on which to create the temporary file. Applies only if the value of Action is WriteFile.

NumBytesLong. Specifies the number of bytes to read or write. Applies only if the value of Action is ReadFile or WriteFile. If NumBytes is not specified or 0, the default value of 10 KB is used.

ConnectionPropertiesArrayOfParameterValue. An array of property name and value pairs that specify the parameter values for establishing a data source connection. Applies only if the value of Action is Connect. To establish a connection, you must specify a property with a name DBType and a value that specifies the type of database. You must also specify any other properties that the specific database interface requires. Table 2-3 lists the valid property names.

Table 2-3 Valid connection properties

Property nameApplicable database interface Description

DBType All The type of database. Valid values are:■ DB2, Informix, MSSQL■ ODBC, Oracle, Sybase, Progress,

Progress SQL92

DllPath DB2, Informix, MSSQL, ODBC, Oracle, Progress, Progress SQL92, Sybase

The name of the DLL providing the client database.

Page 77: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 59

Ping

PayloadString. Specifies the payload data. Applies only if the value of Action is Echo. Payload is binary data attached to the request.

Responseelements

ReplyString. The Ping reply, in plain text format. The information depends on the value of Mode.

PayloadString. If a value is specified for Payload in the request, the payload data as a string.

UserName DB2, Informix, MSSQL, ODBC, Oracle, Progress, Progress SQL92, Sybase

The database user name.

Password DB2, Informix, MSSQL, ODBC, Oracle, Progress, Progress SQL92, Sybase

The database password.

DataSource DB2, ODBC The name of the data source.

ConnectionString ODBC Any additional text that ODBC needs to establish the connection.

HostString Oracle The Oracle server name for the connection.

DatabaseEnvironment Informix The name of the database server, the database, or both database server and database to which to connect.

DatabaseList Progress The name of the database.

StartUpParameters Progress The Progress Open Interface Broker parameters.

Database Progress SQL92 The name of the database.

Host Progress SQL92 The host computer name for a remote database. Not used for a local database. Required if you are connecting to a database running on a database server.

ServiceOrPort Progress SQL92 The database service name or port number on the database server. Not used for a local database. The port number is an unsigned 16-bit integer in the range 1–65535.

Table 2-3 Valid connection properties

Property nameApplicable database interface Description

Page 78: Actuate API Reference - OpenText

60 A c t u a t e A P I R e f e r e n c e

Pr intReport

PrintReportPrints a document. PrintReport requests are always executed in asynchronous mode.

The document prints to the specified printer. If a printer is not specified, the document prints to the user default printer.

Both PrintReport and SubmitJob support printing. Use PrintReport to print an existing document. Use SubmitJob to schedule execution and printing from a design executable.

Requestelements

JobNameString. The job name.

PriorityInt. The job priority. Limited by the user Max job priority setting.

InputFileNameString. The name of the file to print. Specify either InputFileName or InputFileId.

InputFileIdString. The ID of the file to print. Specify either InputFileId or InputFileName.

SchedulesJobSchedule. The schedule for the print job. If not specified, the print request is sent immediately.

PrinterOptionsJobPrinterOptions. The job printer settings. The printer settings have the following precedence:

■ Job printer settings

■ User printer settings

■ System printer settings

NotifyUsersByNameArrayOfString. The names of users to receive job completion notice. Specify either NotifyUsersByName or NotifyUsersById.

NotifyGroupsByNameObsolete since iHub Release 3.

NotifyChannelsByNameObsolete since iHub Release 3.

NotifyUsersByIdArrayOfString. The IDs of users to receive the job completion notice. Specify either NotifyUsersById or NotifyUsersByName.

Page 79: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 61

RevokeUserGroupCapabil i t ies

NotifyGroupsByIdObsolete since iHub Release 3.

NotifyChannelsByIdObsolete since iHub Release 3.

SendSuccessNoticeBoolean. Specifies whether notices are sent if report printing succeeds.

SendFailureNoticeBoolean. Specifies whether notices are sent if report printing fails.

SendEmailForSuccessBoolean. Specifies whether an e-mail is sent when report printing succeeds.

SendEmailForFailureBoolean. Specifies whether an e-mail is sent when report printing fails.

OverrideRecipientPrefBoolean. Specifies whether recipient preferences are overridden.

RecordSuccessStatusBoolean. Specifies whether the job status is kept if report printing succeeds.

RecordFailureStatusBoolean. Specifies whether the job status is kept if report printing fails.

RetryOptionsRetryOptions. Specifies how to retry printing if the previous attempt failed. Used only if Retryable is specified.

Responseelement

JobIdString. The ID of the print job. Returned after the job is created.

RevokeUserGroupCapabilitiesRevokes list of user group capabilities using group name or ID.

Requestelements

UserGroupIdString. The user group ID.

UserGroupNameString. The user group name.

CapabilitiesArrayOfCapabilities. The array of user capabilities.

Responseelement

RevokeUserGroupCapabilitiesResponseThe revoke user group capabilities response. Data type undefined.

Page 80: Actuate API Reference - OpenText

62 A c t u a t e A P I R e f e r e n c e

RevokeUserGroupProductAccess

RevokeUserGroupProductAccessRevokes user group product access using group name, ID, and list of product families.

Requestelements

UserGroupIdString. The user group ID.

UserGroupNameString. The user group name.

ProductFamiliesArrayOfString. The product families list.

Responseelement

RevokeUserGroupProductAccessResponseThe revoke user group product access response. Data type undefined.

SaveSearchObsolete since iHub Release 2.

SaveTransientReportSaves a report to a specified file.

Requestelements

ObjectObjectIdentifier. The object identifier of the report.

NewFileNewFile. The file to which the report is saved.

Responseelement

FileIdString. File ID of created report file.

SearchReportObsolete since iHub Release 2.

SelectChannelsObsolete since iHub Release 2.

Page 81: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 63

SelectFi les

SelectFilesRetrieves information about a specified file.

To retrieve a single file or folder, specify Name or Id. To retrieve a list of files or folders, specify NameList or IdList. To search all file or folders that match specific condition, specify Search.

Requestelements

WorkingFolderIdString. The ID of the working folder in which to search for the file. Specify either WorkingFolderId or WorkingFolderName.

WorkingFolderNameString. The absolute path and the name of the working folder in which to search for the file. Specify either WorkingFolderName or WorkingFolderId.

RecursiveBoolean. Specifies whether to search subfolders. If True, the search includes subfolders. The default value is False.

LatestVersionOnlyBoolean. Specifies whether to search all versions of the file. If True, the search includes only the latest version. The default value is False.

ResultDefArrayOfString. The properties to retrieve.

SearchFileSearch. The search condition. If conditions apply to multiple fields, use ConditionArray.

NameListArrayOfString. The name of the file or folder list to retrieve. Specify either IdList or NameList.

IdListArrayOfString. The ID of the file or folder list to retrieve. Specify either IdList or NameList.

NameString. The name of a single file or folder to retrieve. Specify either Name or Id.

IdString. The ID of a file or folder to retrieve. Specify either Id or Name.

Page 82: Actuate API Reference - OpenText

64 A c t u a t e A P I R e f e r e n c e

SelectFi leTypes

ContentString. Specifies whether the file is embedded in or attached to the response. Valid values are:

■ EmbedThe file is embedded.

■ AttachThe file is attached.

Responseelements

ItemListArrayOfFile. The list of attached items that match the search criteria.

ContentItemListArrayOfFileContent. The list of embedded items that match the search criteria.

FetchHandleString. Indicates that the number of items in the result set exceeds the FetchSize limit.

TotalCountLong. The number of entries in the search result set.

SelectFileTypesSearches file types for specified information.

To search a single file type, specify Name. To search a list of file types, specify NameList. To search file types matching the specified conditions, specify Search. File names are case sensitive, and file type extensions are stored in uppercase. Specify uppercase for all file type extensions, for example, use RPTDESIGN instead of rptdesign.

Requestelements

ResultDefArrayOfString. The properties to retrieve.

SearchArrayOfString. The search conditions. If conditions apply to multiple fields, use ConditionArray.

NameList ArrayOfString. The list of file types to search.

NameString. The name of a single file type to search.

Responseelement

FileTypesArrayOfFileType. The specified file types.

Page 83: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 65

SelectGroups

SelectGroupsObsolete since iHub Release 2.

SelectJavaReportPageReturns a report page formatted in the specified display format indicated by the Page or Component element.

Requestelements

ObjectObjectIdentifier. The ID of the object from which to select the report page.

PagePageIdentifier. The identifier of the page to retrieve.

ComponentArrayOfNameValuePair. The name, display name, or ID, and the value of the component from which to retrieve the data.

ViewParameterValuesArrayOfParameterValue. Include view parameters if defined in the document. This feature is not currently supported for a BIRT report.

OutputFormatString. For a BIRT report, the output format can be HTML, rptdocument, or PDF. The default is rptdocument.

ViewPropertiesArrayOfNameValuePair. Specifies the layout and contents of a report such as the name of a bookmark name, table of contents, or an object ID. ViewProperties is available to the BIRT render task as the java.util.Map object in the Engine AppContext under the key ServerViewProperties.

DownloadEmbeddedBoolean. Specifies whether to send the attachment embedded in the body of the SOAP message or in a separate MIME boundary. If True, the response contains the attachment as embedded data. If False, the attachment is in a separate MIME boundary. The default value is False.

Responseelements

PageRefAttachment. Contains the following properties of the attachment:

■ MimeType

■ ContentEncoding

■ ContentLength

■ Locale

Page 84: Actuate API Reference - OpenText

66 A c t u a t e A P I R e f e r e n c e

SelectJobNotices

ConnectionHandleString. The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.

OutputPropertiesArrayOfNameValuePair. Applies only if Format is CSV. The properties to include in the search result are:

■ EnableColumnHeadersIf True, column headers are included in the search result. The default value is True.

■ UseQuoteDelimiterIf True, each data item in the search result is enclosed in double quotes (" "). The default value is True.

SelectJobNoticesRetrieves job notices matching the specified criteria.

Requestelements

ResultDefArrayOfString. The properties to retrieve. You can specify the following properties:

■ JobId

■ JobName

■ ActualHeadline

■ CompletionTime

■ ActualOutputFileId

■ ActualOutputFileName

■ VersionName

■ OutputFileSize

SearchJobNoticeSearch. The search conditions. If conditions apply to multiple fields, use ConditionArray.

Responseelements

JobNoticesArrayOfJobNotice. The selected job notices.

FetchHandleString. Indicates that the number of items in the result set exceeds the FetchSize limit.

Page 85: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 67

SelectJobs

TotalCountLong. The number of entries in the search result set.

SelectJobsSelects all jobs matching the specified conditions. SelectJobs returns states and information for job instances.

In Release 11 or iHub, use SelectJobSchedules to obtain job schedule information. In Release 10 Service Pack 1 and earlier, use SelectJobs with JobCondition, specifying Scheduled, Expired, or Cancelled, to obtain designated job schedule information.

Release 11 Service Pack 4 and later support backward compatibility for all pre-Release 11 applications that send a SelectJobs request. However, all Release 11 and iHub applications must implement the new SelectJobSchedules API to request schedule information.

Requestelements

ResultDefArrayOfString. The properties to retrieve.

SearchJobSearch. The search conditions. If conditions apply to multiple fields, use ConditionArray.

IdList ArrayOfString. The list of job IDs to search.

IdString. The ID of a single job to search.

Responseelements

JobsArrayOfJobProperties. The selected jobs.

FetchHandleString. Indicates that the number of items in the result set exceeds the FetchSize limit.

TotalCountLong. The number of entries in the search result set.

SelectJobSchedulesSelects all scheduled jobs matching the specified criteria. SelectJobSchedules also retrieves information for expired and cancelled jobs.

Page 86: Actuate API Reference - OpenText

68 A c t u a t e A P I R e f e r e n c e

SelectPage

In Release 11 or iHub, use SelectJobSchedules to obtain job schedule information. In Release 10 Service Pack 1 and earlier, use SelectJobs with JobCondition, specifying Scheduled, Expired, or Cancelled, to obtain designated job schedule information.

Release 11 Service Pack 4 and iHub support backward compatibility for all pre-Release 11 applications that send a SelectJobs request. However, all Release 11 and iHub applications must implement the new SelectJobSchedules API to request schedule information.

Requestelements

ResultDefArrayOfString. The properties to retrieve.

SearchJobScheduleSearch. The search conditions. If conditions apply to multiple fields, use ConditionArray.

IdList ArrayOfString. The list of job IDs to search.

IdString. The ID of a single job to search.

Responseelements

JobsArrayOfJobProperties. The selected jobs.

FetchHandleString. Indicates that the number of items in the result set exceeds the FetchSize limit.

TotalCountLong. The number of entries in the search result set.

SelectPageObsolete since iHub Release 2.

SelectRolesDeprecated since iHub Release 3. Replaced by SelectUserGroups.

SelectUserGroupsSearches user groups for specified information.

Page 87: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 69

SelectUserGroups

To search a single user group, specify Name or Id. To search a list of user groups, specify NameList or IdList. To search user groups matching the specified conditions, specify Search.

ResultDefArrayOfString. The properties to retrieve.

SearchUserGroupSearch. The search conditions. If conditions apply to multiple fields, use ConditionArray. When using RSSE external registration, SelectUserGroups allows only one search condition.

In the following example, <Condition> and <AssignedToUserName> are search conditions:

<Search><Condition>

<Field>Name</Field><Match>roleA</Match>

</Condition><ConditionArray xsi:nil="true"/><ParentUserGroupName xsi:nil="true"/><ChildUserGroupName xsi:nil="true"/><WithRightsToChannelName xsi:nil="true"/><AssignedToUserName>Administrator</AssignedToUserName><ParentRoleId xsi:nil="true"/><ChildRoleId xsi:nil="true"/><WithRightsToChannelId xsi:nil="true"/><AssignedToUserId xsi:nil="true"/>

</Search>

When using RSSE external registration, the previous search pattern is invalid, generating the following response:

<Description> <Message>The search pattern is too long or is incorrect.

</Message><Parameter1>More than one search condition is invalid under

External Registration</Parameter1>

</Description>

IdListArrayOfString. The list of user IDs to search. Specify either IdList or NameList.

NameList ArrayOfString. The list of user names to search. Specify either NameList or IdList.

IdString. The ID of the single user to search. Specify either Id or Name.

Page 88: Actuate API Reference - OpenText

70 A c t u a t e A P I R e f e r e n c e

SelectUsers

NameString. The name of the single user to search. Specify either Name or Id.

Responseelements

RolesArrayOfRole. The selected roles.

FetchHandleString. Indicates that the number of items in the result set exceeds the FetchSize limit.

TotalCountLong. The number of entries in the search result set.

SelectUsersSearches users for specified information.

To search a single user, specify Name or Id. To search a list of users, specify NameList or IdList. To search users matching the specified conditions, specify Search.

Requestelements

ResultDefArrayOfString. The properties to retrieve.

SearchUserSearch. The search conditions. If conditions apply to multiple fields, use ConditionArray. When using RSSE external registration, SelectUsers allows only one search condition.

IdListArrayOfString. The list of user IDs to search. Specify either IdList or NameList.

NameList ArrayOfString. The list of user names to search. Specify either NameList or IdList.

IdString. The ID of the single user to search. Specify either Id or Name.

NameString. The name of the single user to search. Specify either Name or Id.

Responseelements

UsersArrayOfUser. The selected users.

FetchHandleString. Indicates that the number of items in the result set exceeds the FetchSize limit.

Page 89: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 71

SetConnect ionPropert ies

TotalCountLong. The number of entries in the search result set. Not used when querying a volume that uses Open Security. In this case, TotalCount returns Null. To retrieve the number of entries from a volume that uses Open Security, use an array length. For example, the following code returns Null:

com.actuate.schemas.SelectUsersResponse userSrchResponse = proxy.selectUsers( userSel );

com.actuate.schemas.ArrayOfUser userArr = userSrchResponse.getUsers();

com.actuate.schemas.User []user = userArr.getUser();userSrchResponse.getTotalCount();int noOfUsers1 = userSrchResponse.getTotalCount().intValue();The following code returns the correct value:com.actuate.schemas.SelectUsersResponse userSrchResponse =

proxy.selectUsers( userSel );com.actuate.schemas.ArrayOfUser userArr =

userSrchResponse.getUsers();com.actuate.schemas.User []user = userArr.getUser();userSrchResponse.getTotalCount();int noOfUsers2 = user.length;

SetConnectionPropertiesSets the connection properties for a file based on user or role.

Requestelements

FileNameString. The name of the file.

FileIdString. The file ID.

UserNameString. User name for which to set property values.

UserIdString. User ID for which to set property values.

RoleNameString. The role name for which to set property values.

RoleIdString. The role ID for which to set property values.

UserGroupNameString. The user group name for which to set property values.

UserGroupIdString. The user group ID for which to set property values.

Page 90: Actuate API Reference - OpenText

72 A c t u a t e A P I R e f e r e n c e

SetServerResourceGroupConf igurat ion

ConnectionPropertiesArrayOfPropertyValue. An array of name-value pairs containing the connection properties being set.

SetServerResourceGroupConfigurationSets or updates properties of all resource groups on a BIRT iHub. SetServerResourceGroupConfiguration is available only to a volume administrator or a user with an Administrator role.

Requestelements

ServerNameString. The name of the BIRT iHub.

ServerResourceGroupSettingListArrayOfServerResourceGroupSetting. Contains one or more of the following properties to set or update:

■ Activate

■ MaxFactory

■ FileTypesCannot be set or updated for a default resource group

Responseelement

SetServerResourceGroupConfigurationResponseThe SetServerResourceGroupConfigurationResponse. Data type undefined.

SetUserExtendedPropertiesSets list of user extended properties using user name or ID and product family.

Requestelements

UserNameString. The user name.

UserIdString. The user ID.

PropertiesArrayOfNameValuePair. The user extended properties list.

ProductFamilyString. The product family.

Responseelement

SetUserExtendedPropertiesResponseThe SetUserExtendedPropertiesResponse. Data type undefined.

Page 91: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 73

SetUserGroupExtendedPropert ies

SetUserGroupExtendedPropertiesSets list of user group extended properties using user group name or ID.

Requestelements

UserGroupNameString. The user group name.

UserGroupIdString. The user group ID.

PropertiesArrayOfNameValuePair. The user group extended property list.

ProductFamilyString. The product family.

Responseelement

SetUserGroupExtendedPropertiesResponseThe SetUserGroupExtendedPropertiesResponse. Data type undefined.

SetUserPreferenceSets user preference using user name, ID, and product family.

Requestelements

UserIdString. The user ID.

UserNameString. The user name.

PreferenceArrayOfNameValuePair. The user preference list.

ProductFamilyString. The product family.

Responseelement

SetUserPreferenceResponseThe SetUserPreferenceResponse. Data type undefined.

SubmitJobGenerates and prints a report or information object in asynchronous mode. BIRT iHub sends a response after completing the request.

After generating a document in asynchronous mode, you can convert the document to one of the following formats:

■ Comma-separated values (CSV)

Page 92: Actuate API Reference - OpenText

74 A c t u a t e A P I R e f e r e n c e

Submi tJob

■ Excel XLS

■ Excel XLSX

■ PDF

■ PostScript

■ PowerPoint (PPT)

■ PowerPoint (PPTX)

■ PSV

■ Tab-separated values (TSV)

■ Word (DOC)

■ Word (DOCX)

When converting a document, the properties of the converted file are the same as the original document properties.

BIRT iHub only supports converting document output for asynchronous generation. Conversion is not supported for the following types of document output:

■ Synchronous generation

■ Report bursting

■ Page-level security

Both SubmitJob and PrintReport support printing. Use SubmitJob to schedule execution and printing from design executables. Use PrintReport to print an existing document.

Requestelements

JobNameString. The name of the job.

HeadlineString. The job headline.

PriorityInt. The job priority. Job priority is limited by the user Max job priority setting. Valid values are 0–1,000, where 1,000 is the highest priority.

ResourceGroupString. The resource group to which to assign the job. Available only to a volume administrator or a user with the Administrator role.

InputFileNameString. The full path, name, and version number of the file to use as input. If RunLatestVersion is specified, the version number is ignored.

Page 93: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 75

SubmitJob

InputFileIdString. The ID of the file to use as input.

RunLatestVersion

Boolean. Specifies whether to run or print the most recent version of the executable file. If True, the latest version of the file is used. If True, the version number in InputFileName is ignored.The default value is True.

RequestedOutputFileNewFile. The file name and extension for the output.

OperationString. Specifies the type of task to perform, RunReport, RunAndPrintReport, ConvertReport, or PrintReport.

ParameterValuesArrayOfParameterValue. A list of parameter values to use. Specify either ParameterValues, ParameterValueFileId, ParameterValueFileName.

ParameterValueFileNameString. The name of the parameter value file to use. Specify either ParameterValues, ParameterValueFileId, or ParameterValueFileName.

ParameterValueFileIdString. The ID of the report object values file to use. Specify either ParameterValues, ParameterValueFileId, or ParameterValueFileName.

SchedulesJobSchedule. Specifies the schedule on which to run the report. If not specified, the job runs immediately.

PrinterOptionsArrayOfPrinterOptions. If the job is to be printed, specifies the job printer settings. If the job is not to be printed, PrinterOptions is ignored. The printer settings have the following precedence:

■ Job printer settings

■ User printer settings

■ System printer settings

NotifyUsersByNameArrayOfString. The names of users to receive the job completion notice. Specify either NotifyUsersByName or NotifyUsersById.

NotifyGroupsByNameObsolete since iHub Release 3.

NotifyChannelsByNameObsolete since iHub Release 3.

Page 94: Actuate API Reference - OpenText

76 A c t u a t e A P I R e f e r e n c e

Submi tJob

NotifyUsersByIdArrayOfString. The IDs of users to receive the job completion notice. Specify either NotifyUsersById or NotifyUsersByName.

NotifyGroupsByIdObsolete since iHub Release 3.

NotifyChannelsByIdObsolete since iHub Release 3.

SendSuccessNoticeBoolean. Specifies whether success notices are sent if the job succeeds. Used only if OverrideRecipientPref is True. If SendSuccessNotice is True, notices are sent.

SendFailureNoticeBoolean. Specifies whether failure notices are sent if the job fails. Used only if OverrideRecipientPref is True. If SendFailureNotice is True, failure notices are sent to specified users and groups if the job fails.

SendEmailForSuccessBoolean. Specifies whether e-mail notifications are sent if the job succeeds. Used only if OverrideRecipientPref is True. If True, e-mail notifications are sent to specified users and groups if the job succeeds. The default value is False.

SendEmailForFailureBoolean. Specifies whether e-mail notifications are sent to specified users and groups if the job fails. Used only if OverrideRecipientPref is True. If SendEmailForFailure is True, e-mail notifications are sent. The default value is False.

AttachReportInEmailBoolean. Specifies whether to attach a report to an e-mail completion notice. Used only if OverrideRecipientPref is True. If AttachReportInEmail is True, the output file is attached to the e-mail notification if the job succeeds. If False, only a link to the output file is sent. Specify the format for the attachment in the EmailFormat parameter. The default value is False.

OverrideRecipientPrefBoolean. Specifies whether e-mail notifications and output attachments are sent according to job settings or user settings. If True, e-mail notifications and output attachments are sent according to job settings. If False, e-mail notifications and output attachments are sent according to user settings. The default value is False. If False, the following elements are ignored:

■ AttachReportInEmail

■ SendEmailForSuccess

■ SendEmailForFailure

■ SendSuccessNotice

Page 95: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 77

SubmitJob

■ SendFailureNotice

EmailFormatString. Specifies the output format of the report attached to the e-mail notification. Table 2-4 lists the valid format codes.

RecordSuccessStatusBoolean. Specifies whether to keep the job status for successful jobs. If True, the job status is kept if job execution succeeds.

RecordFailureStatusBoolean. Specifies whether to keep the job status for failed jobs. If True, the job status is kept if job execution fails.

IsBundledBoolean. Specifies whether a report is bundled. If True, the report is bundled. If False, the report is not bundled. The default value is False.

RetryOptionsRetryOptions. Specifies how to retry the job if the previous attempt failed. Used only if Retryable is specified.

OpenServerOptionsOpenServerOptions. Contains the following open server options:

■ KeepWorkingSpaceSpecifies whether the workspace directory is removed after the job completes.

■ DriverTimeoutThe time for the driver to return from executing a job.

■ PollingIntervalThe time interval for the open server to get status messages. The minimum value is 10 seconds.

Table 2-4 E-mail attachment formats

Format code File type description

DOC Microsoft Word

DOCX Microsoft Word 2010

PDF Adobe PDF

PPT Microsoft PowerPoint

PPTX Microsoft PowerPoint 2010

PS Adobe Postscript

XLS Microsoft Excel

XLSX Microsoft Excel 2010

Page 96: Actuate API Reference - OpenText

78 A c t u a t e A P I R e f e r e n c e

SystemLogin

KeepOutputFileBoolean. Specifies whether the generated output file remains in the volume if the generation request succeeds but the printing request fails. Used if Operation is RunAndPrintReport. If True, the output file remains in the volume if the printing request fails. If False, the output file is deleted if the printing request fails. The default value is False.

ConversionOptionsObsolete since iHub Release 2.

WaitForEventEvent. An event that must be completed before the response is processed.

DataACLArrayOfString. Specifies the access control list (ACL) restricting data privileges.

Responseelement

JobIdString. The job ID. Use the job ID to refer to the job in subsequent requests during the current session.

SystemLoginLogs the user in as the BIRT iHub administrator.

Requestelements

SystemPasswordString. The password.

SystemPasswordEncryptLevelLong. The encryption level of the SystemPassword. Valid values are:

■ 0 - No encryption

■ 1 - Two way encryption

■ 2 - Hash encryption

The default is hash encryption.

Responseelement

AuthIdString. The system-generated, encrypted authenticated string all subsequent requests use.

UpdateDatabaseConnectionObsolete since iHub Release 2.

Page 97: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 79

UpdateIOCache

UpdateIOCacheObsolete since iHub Release 2.

UpdateResourceGroupUpdates resource group properties. You cannot update the resource group name, type, or the name of the BIRT iHub on which the resource group runs.

Requestelements

ResourceGroupResourceGroup. Contains one or more of the following properties to update:

■ Disabled

■ Description

■ MinPriority

■ MaxPriority

■ Reserved

ResourceGroupSettingsListArrayOfResourceGroupSettings. Contains one or more of the following properties to update:

■ Activate

■ MaxFactory

■ FileTypes

UploadFileUploads a file to a volume. You can upload the file as a MIME attachment or embed it in the request. To embed the file in the request, specify the ContentData element of the attachment.

Requestelements

NewFileNewFile. The file to upload.

CopyFromLatestVersionArrayOfString. Copies one or more of the following properties from the latest version of the file, if one exists, to the version of the file that you upload:

■ DescriptionThe description of the file

Page 98: Actuate API Reference - OpenText

80 A c t u a t e A P I R e f e r e n c e

Ver i fyAuthId

■ PermissionsAccess control list (ACL) specifying the users and roles that can access the file

■ ArchiveRuleThe autoarchive rules for the file

ContentAttachment. The information about the file, such as the encoding the file uses and the data to upload.

Responseelement

FileIdString. The ID of the uploaded file.

VerifyAuthIdChecks the validity of an AuthID string with a target volume.

Requestelements

AuthIDString. An authentication ID.

VolumeString. The volume with which to verify the AuthID.

UserNameString. The user name.

Responseelement

isValidA boolean value for the validity of the AuthID with the target volume and user name.

WaitForExecuteReportRetrieves the status of the report generation request after receiving the Pending status. Send WaitForExecuteReport after sending CancelReport.

If progressive viewing is enabled, WaitForExecuteReport retrieves the status after the first page generates. Otherwise, WaitForExecuteReport waits until the report is complete.

If the current job status is Pending, WaitForExecuteReport waits for the report to generate.

Requestelement

ObjectIdString. The ID of the job.

Responseelements

StatusString. The status of the request. One of the following values:

■ Done

Page 99: Actuate API Reference - OpenText

C h a p t e r 2 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I o p e r a t i o n s 81

WaitForExecuteReport

■ Failed

■ FirstPage

ErrorDescriptionString. The description of the error. Returned if Status is Failed.

OutputFileTypeString. The type of the output file.

ObjectIdString. The object ID of the report.

ConnectionHandleString. The ID of the report. Supports viewing a report when the report is already in iHub System. Specified in the SOAP header.

Page 100: Actuate API Reference - OpenText

82 A c t u a t e A P I R e f e r e n c e

WaitForExecuteReport

Page 101: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 83

C h a p t e r

3Chapter 3Actuate Information

Delivery API data typesThis chapter provides reference documentation for Actuate Information Delivery API data type classes the uses listed in alphabetical order. Each entry includes a general description of the data type and elements.

IDAPI data types quick referenceTable 3-1 lists the Actuate IDAPI data types. For more information about IDAPI data type WSDL definitions, see Integrating Applications into BIRT iHub.

Table 3-1 IDAPI data type summary

Data Type Description

AbsoluteDate Date and run options for a job

acDouble Hexadecimal double

acNull Null value

AdminOperation Controls the ability to create, delete, update, copy, and move items within a volume.

Arrays of data types Arrays of singular data types

Attachment An attachment as binary data

Base64Binary Standard XML base64Binary data type

(continues)

Page 102: Actuate API Reference - OpenText

84 A c t u a t e A P I R e f e r e n c e

BookMark Bookmark metadata from a report document

Boolean Primitive XML boolean data type

CancelJobStatus Status of a cancel job request

Capabilities User capabilities for specific tools

ColumnDetail Type of data within a column

ColumnSchema The schema of a column

CopyFile A file or list of files to copy

CounterInfo A counter object

CreateFileType A file type to create

CreateFolder A folder to create

CreateUser A user to create

CreateUserGroup A user group to create

CustomEvent Details for a custom event

Daily Enumerated value for daily setting

DatabaseConnectionDefinition Details of a database connection

DataCell Type of data within a data cell

DataExtractionFormat Format of a file and its mime type

DataFilterCondition Details of a filter condition

DataRow Information from a data row

DataSchema Details of a data schema by column

DataSortColumn Details of a sorted data column

DataSourceType The type of file in which a parameter exists

DataType Details of a data type

Date A date

DateTime A date and time

Decimal Primitive XML decimal data type

DeleteFile Details of a file or folder to delete

DeleteFileType Details of a file type to delete

DeleteJob Details of a job to delete

DeleteJobNotices Details of job notices to delete

DeleteJobSchedule Details of a schedule to delete

Table 3-1 IDAPI data type summary (continued)

Data Type Description

Page 103: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 85

DeleteUser Details of a user to delete

DeleteUserGroup Details of a user group to delete

DocumentConversionOptions Conversion options of a file

Double Primitive XML double data type

Event Describes an event and its status

EventOptions Describes polling and other options for an event

EventType A type of event

ExecuteReportStatus The status of a temporary report

ExternalTranslatedUserNames The external name of an administrator user

ExternalTranslatedUserGroupNames The external name of the Administrators user group

FieldDefinition A scalar parameter

File Describes a file

FileAccess A file’s access type

FileCondition The field and condition for a file search

FileContent A list of attached files or the content of embedded files

FileEvent Information about file type events

FileField Lists file fields upon which a search can be performed

FileSearch A file search object

FileType A file type

Header The contents of a SOAP header

InfoObjectData Data from a BIRT information object

InfoObjectDataFormat An information object’s data format

Int Primitive XML integer data type

JobCondition The field and condition to match for a job search

JobEvent Information about job type events

JobField Describes job fields

JobInputDetail Job input and output files

JobNotice A job notice

(continues)

Table 3-1 IDAPI data type summary (continued)

Data Type Description

Page 104: Actuate API Reference - OpenText

86 A c t u a t e A P I R e f e r e n c e

JobNoticeCondition The field and condition for job notice field search

JobNoticeField Describes notice fields

JobNoticeSearch A notice search object

JobPrinterOptions Describes job printer options

JobProperties General job attributes

JobSchedule Details about a job schedule

JobScheduleCondition The field and condition for schedule field search

JobScheduleDetail A schedule for running a job

JobScheduleField Describes schedule fields

JobScheduleSearch A schedule search object

JobSearch A file search object

LicenseOption A license option

Long Primitive XML long data type

MDSInfo Describes a Message Distribution service (MDS)

Monthly Enumerated value for monthly setting

MoveFile Moves files or folders to a new location

NameValuePair A named piece of data and its value

NewFile Describes a file

ObjectIdentifier Describes object identifiers

PageIdentifier Describes page numbers

ParameterDefinition Defines a report parameter

ParameterValue Value of a report parameter

PendingSyncJob A job in the factory queue

Permission A user or user group’s privileges

Printer Describes a printer

PrinterOptions Describes printer options

PrivilegeFilter A filter based on user or user group privileges

PropertyValue A name-value pair

Repeat A job frequency

ReportParameterType Describes parameter types

ResourceGroup Defines a resource group

Table 3-1 IDAPI data type summary (continued)

Data Type Description

Page 105: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 87

ResourceGroupSettings Describes resource group settings

ResultSetSchema The schema for a result set

RetryOptions Retry options after failed report generation or printing

RetryOptionType Describes retry option types

RunningJob Describes a running job

ScalarDataType A scalar parameter type

ServerInformation Describes a BIRT iHub server

ServerResourceGroupSetting Describes the settings of a resource group

ServerState Describes the current state of Actuate iHub

ServerStatusInformation Describes the detailed status of Actuate iHub

ServerVersionInformation Describes the version of Actuate iHub

Service Simple XML service data type

Short Primitive XML short data type

Stream A streamed image

String Primitive XML string data type

SystemType Describes the network configuration of an iHub System

Time Standard XML Time data type

Transaction Packaging mechanism for Administrate operations

TypeName The name of a data type

UndeleteUser Operation that reverses a DeleteUser operation

UpdateFile Describes an update of file or folder details

UpdateFileOperation Operation to update file or folder details

UpdateFileOperationGroup Sequence of operations to update file or folder details

UpdateFileType Describes an update of a file type

UpdateFileTypeOperation Operation to update a file type

UpdateFileTypeOperationGroup Sequence of operations to update a file type

UpdateJobSchedule Describes an update of a job schedule

(continues)

Table 3-1 IDAPI data type summary (continued)

Data Type Description

Page 106: Actuate API Reference - OpenText

88 A c t u a t e A P I R e f e r e n c e

AbsoluteDate

AbsoluteDateA complex data type that includes a date and run options for a job.

UpdateJobScheduleOperation Operation to update a job schedule

UpdateJobScheduleOperationGroup Sequence of operations to update a job schedule

UpdateOpenSecurityCache Describes a security cache refresh operation

UpdateUser Describes an update of a user

UpdateUserGroup Describes an update of a user group

UpdateUserGroupOperation Operation to update a user group

UpdateUserGroupOperationGroup Sequence of operations to update a user group

UpdateUserOperation Operation to update a user

UpdateUserOperationGroup Sequence of operations to update a user

UpdateVolumeProperties Describes an update of volume properties

UpdateVolumePropertiesOperation Operation to update volume properties

UpdateVolumePropertiesOperationGroup Sequence of operations to update volume properties

User Describes a user

UserCondition The field and condition to match for a user search

UserField Describes the fields within a user element

UserGroup Describes a user group

UserGroupCondition The field and condition to match for a user group search

UserGroupField Lists user group fields on which a search can be performed

UserGroupSearch A user group search object

UserSearch A user search object

VersioningOption Options for handling the latest existing version

ViewParameter Describes a viewing parameter

Volume Describes a volume

Weekly Enumerated value for weekly setting

Table 3-1 IDAPI data type summary (continued)

Data Type Description

Page 107: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 89

acDouble

Elements RunOnString. The date that a job is scheduled to run.

OnceADayString. The days a job is to be run.

RepeatRepeat. Repeats the job run during a set start and stop time.

acDoubleA simple data type that represents a hexadecimal double.

acNullA simple data type that represents a null value.

AdminOperationControls the ability to create, delete, update, copy, and move items within a volume. An AdminOperation request represents a single unit of work within an Administrate operation. Only a volume administrator or a user in the Administrator user group uses these operations.

Elements TransactionA packaging mechanism for Administrate operations. If a failure occurs anywhere in a transaction, all operations in the transaction fail.

CreateUserCreates a user in the volume.

DeleteUserDeletes one or more users.

UndeleteUserUndeletes one or more previously deleted users within the unit of work.

UpdateUserUpdates user properties.

CreateUserGroupCreates a user group.

DeleteUserGroupDeletes one or more user groups.

Page 108: Actuate API Reference - OpenText

90 A c t u a t e A P I R e f e r e n c e

AdminOperat ion

UpdateUserGroupUpdates user group properties.

CreateFileTypeCreates a new file type in BIRT iHub.

DeleteFileTypeDeletes file types.

UpdateFileTypeUpdates file type properties in the volume.

CreateFolderCreates a folder in a volume.

DeleteFileDeletes files or folders from the volume.

MoveFileMoves a file or folder from the working directory to a specified target directory in the volume.

CopyFileCopies a file or folder in the working directory to a specified target directory.

UpdateFileUpdates file or folder properties in the volume.

DeleteJobDeletes one or more jobs.

DeleteJobNoticesDeletes one or more job notices.

DeleteJobScheduleDeletes a job schedule.

UpdateJobScheduleUpdates a job schedule.

UpdateVolumePropertiesUpdates the properties of a specific volume.

UpdateOpenSecurityCacheFlushes the volume’s open security cache and retrieves new data from an external security source.

Page 109: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 91

Aggregat ion

AggregationObsolete since iHub Release 2.

ArchiveRuleA complex data type that represents an archiving rule.

Elements FileTypeString. The file type. Cannot exceed 20 characters.

NeverExpireBoolean. Optional. Specifies whether the object expires.

ExpireDependentFilesBoolean. Optional. Specifies whether the object’s dependent files expire when the object is expired.

ArchiveOnExpirationBoolean. Optional. Specifies whether the object is archived before it is expired.

ExpirationAgeLong. Optional. The expiration age for the object. Use either this element or ExpirationTime, but not both.

ExpirationTimeDateTime. Optional. The expiration time for the object. Use either this element or ExpirationAge, but not both.

IsInheritedBoolean. Optional. Specifies whether the rule is inherited.

InheritedFromBoolean. Optional. The object from which the rule is inherited.

ArgumentObsolete since iHub Release 2.

Arrays of data typesData type definitions can be grouped into arrays. Each array has a specific definition for that data type. IDAPI supports empty arrays having no entries.

Page 110: Actuate API Reference - OpenText

92 A c t u a t e A P I R e f e r e n c e

Arrays of data types

The schema for an array of a data type generally follows the following pattern:

<xsd:complexType name="ArrayOfX"><xsd:sequence>

<xsd:element name="X" type="typens:X"maxOccurs="unbounded" minOccurs="0"/>

</xsd:sequence></xsd:complexType>

In the above listing, X is the data type of object the array contains. For example, the XML for an array of UserGroup objects is:

<xsd:complexType name="ArrayOfUserGroup"><xsd:sequence>

<xsd:element name="UserGroup" type="typens:UserGroup"maxOccurs="unbounded" minOccurs="0"/>

</xsd:sequence></xsd:complexType>

The following data types have arrays defined in this manner:

■ Aggregation ■ JobProperties

■ ArchiveRule ■ JobScheduleCondition

■ Argument ■ JobScheduleDetail

■ Attachment ■ LicenseOption

■ Capabilities ■ MDSInfo

■ Channel ■ NameValuePair

■ ChannelCondition ■ ParameterDefinition

■ ColumnDefinition ■ ParameterValue

■ ColumnSchema ■ PendingSyncJob

■ Component ■ Permission

■ ComponentIdentifier ■ Printer

■ CounterInfo ■ PrinterOptions

■ DataExtractionFormat ■ PropertyValue

■ DataFilterCondition ■ Record

■ DataRow ■ ResourceGroup

■ DataSortColumn ■ ResourceGroupSettings

■ DocumentConversionOptions ■ ResultSetSchema

■ FieldDefinition ■ Role

■ File ■ RoleCondition

■ FileCondition ■ RunningJob

Page 111: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 93

ArrayOfAggregation

Some array definitions are different from the ones listed above. These arrays have a type definition for the element other than what appears in the array name. For example, the ArrayOfDate is defined as:

<xsd:complexType name="ArrayOfDate"><xsd:sequence>

<xsd:element name="Date" type="typens:string"maxOccurs="unbounded" minOccurs="0" />

</xsd:sequence></xsd:complexType>

In this definition, the element name is Date, but its type is defined as a string. The ArrayOfDate type is defined as an array of string elements. The arrays in this format are listed in Table 3-2, along with the associated element type.

ArrayOfAggregationObsolete since iHub Release 2.

■ FileContent ■ ServerInformation

■ FileType ■ ServerResourceGroupSetting

■ FilterCriteria ■ Service

■ Group ■ SortColumn

■ GroupCondition ■ String

■ Grouping ■ Time

■ IOCacheDBIndexConstraint ■ User

■ JobCondition ■ UserCondition

■ JobNotice ■ UserGroup

■ JobNoticeCondition ■ UserGroupCondition

Table 3-2 Non-standard arrays

Array type Element type

Date string

String string

Int int

Component ComponentType

Long long

Page 112: Actuate API Reference - OpenText

94 A c t u a t e A P I R e f e r e n c e

ArrayOfArchiveRule

ArrayOfArchiveRuleArrayOfArchiveRule is a complex data type that represents an array of ArchiveRule objects.

ArrayOfArgumentObsolete since iHub Release 2.

ArrayOfAttachmentArrayOfAttachment is a complex data type that represents an array of Attachment objects.

ArrayOfBookMarkArrayOfBookMark is a complex data type that represents an array of BookMark objects.

ArrayOfCapabilitiesArrayOfCapabilities is a complex data type that represents an array of Capabilities objects.

ArrayOfChannelObsolete since iHub Release 3.

ArrayOfChannelConditionObsolete since iHub Release 3.

Page 113: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 95

ArrayOfColumnDefini t ion

ArrayOfColumnDefinitionObsolete since iHub Release 2.

ArrayOfColumnSchemaArrayOfColumnSchema is a complex data type that represents an array of ColumnSchema objects.

ArrayOfComponentObsolete since iHub Release 2.

ArrayOfComponentIdentifierObsolete since iHub Release 2.

ArrayOfCounterInfoArrayOfCounterInfo is a complex data type that represents an array of CounterInfo objects.

ArrayOfDataExtractionFormatArrayOfDataExtractionFormat is a complex data type that represents an array of DataExtractionFormat objects.

ArrayOfDataFilterConditionArrayOfDataFilterCondition is a complex data type that represents an array of DataFilterCondition objects.

Page 114: Actuate API Reference - OpenText

96 A c t u a t e A P I R e f e r e n c e

ArrayOfDataRow

ArrayOfDataRowArrayOfDataRow is a complex data type that represents an array of DataRow objects.

ArrayOfDataSortColumnArrayOfDataSortColumn is a complex data type that represents an array of DataSortColumn objects.

ArrayOfDateArrayOfDate is a complex data type that represents an array of Date objects.

ArrayOfDocumentConversionOptionsArrayOfDocumentConversionOptions is a complex data type that represents an array of DocumentConversionOptions.

ArrayOfFieldDefinitionArrayOfFieldDefinition is a complex data type that represents an array of FieldDefinition objects.

ArrayOfFileArrayOfFile is a complex data type that represents an array of File objects.

ArrayOfFileConditionArrayOfFileCondition is a complex data type that represents an array of FileCondition objects.

Page 115: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 97

ArrayOfFileContent

ArrayOfFileContentArrayOfFileContent is a complex data type that represents an array of FileContent objects.

ArrayOfFileTypeArrayOfFileType is a complex data type that represents an array of FileType objects.

ArrayOfFilterCriteriaObsolete since iHub Release 2.

ArrayOfGroupObsolete since iHub Release 2.

ArrayOfGroupConditionObsolete since iHub Release 2.

ArrayOfGroupingObsolete since iHub Release 2.

ArrayOfIntArrayOfInt is a complex data type that represents an array of Int objects.

ArrayOfIOCacheDBIndexConstraintObsolete since iHub Release 2.

Page 116: Actuate API Reference - OpenText

98 A c t u a t e A P I R e f e r e n c e

ArrayOfJobCondit ion

ArrayOfJobConditionArrayOfJobCondition is a complex data type that represents an array of JobCondition objects.

ArrayOfJobNoticeArrayOfJobNotice is a complex data type that represents an array of JobNotice objects.

ArrayOfJobNoticeConditionArrayOfJobNoticeCondition is a complex data type that represents an array of JobNoticeCondition objects.

ArrayOfJobPropertiesArrayOfJobProperties is a complex data type that represents an array of JobProperties objects.

ArrayOfJobScheduleConditionArrayOfJobScheduleCondition is a complex data type that represents an array of JobScheduleCondition objects.

ArrayOfJobScheduleDetailArrayOfJobScheduleDetail is a complex data type that represents an array of JobScheduleDetail objects.

ArrayOfLongArrayOfLong is a complex data type that represents an array of Long objects.

Page 117: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 99

ArrayOfLicenseOption

ArrayOfLicenseOptionArrayOfLicenseOption is a complex data type that represents an array of LicenseOption objects.

ArrayOfMDSInfoArrayOfMDSInfo is a complex data type that represents an array of MDSInfo objects.

ArrayOfNameValuePairArrayOfNameValuePair is a complex data type that represents an array of NameValuePair objects.

ArrayOfParameterDefinitionArrayOfParameterDefinition is a complex data type that represents an array of ParameterDefinition objects.

ArrayOfParameterValueArrayOfParameterValue is a complex data type that represents an array of ParameterValue objects.

ArrayOfPendingSyncJobArrayOfPendingSyncJob is a complex data type that represents an array of PendingSyncJob objects.

ArrayOfPermissionArrayOfPermission is a complex data type that represents an array of Permission objects.

Page 118: Actuate API Reference - OpenText

100 A c t u a t e A P I R e f e r e n c e

ArrayOfPrinter

ArrayOfPrinterArrayOfPrinter is a complex data type that represents an array of Printer objects.

ArrayOfPrinterOptionsArrayOfPrinterOptions is a complex data type that represents an array of PrinterOptions objects.

ArrayOfPropertyValueArrayOfPropertyValue is a complex data type that represents an array of PropertyValue objects.

ArrayOfRecordObsolete since iHub Release 2.

ArrayOfResourceGroupArrayOfResourceGroup is a complex data type that represents an array of ResourceGroup objects.

ArrayOfResourceGroupSettingsArrayOfResourceGroupSettings is a complex data type that represents an array of ResourceGroupSettings objects.

ArrayOfResultSetSchemaArrayOfResultSetSchema is a complex data type that represents an array of ResultSetSchema objects.

Page 119: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 101

ArrayOfRole

ArrayOfRoleDeprecated since iHub Release 3. Replaced by ArrayOfUserGroup.

ArrayOfRoleConditionDeprecated since iHub Release 3. Replaced by ArrayOfUserGroupCondition.

ArrayOfRunningJobArrayOfRunningJob is a complex data type that represents an array of RunningJob in the Factory.

ArrayOfServerInformationArrayOfServerInformation is a complex data type that represents an array of ServerInformation objects.

ArrayOfServerResourceGroupSettingArrayOfServerResourceGroupSetting is a complex data type that represents an array of ServerResourceGroupSetting objects.

ArrayOfServiceArrayOfService is a complex data type that represents an array of Service objects.

ArrayOfStringArrayOfString is a complex data type that represents an array of String objects.

Page 120: Actuate API Reference - OpenText

102 A c t u a t e A P I R e f e r e n c e

ArrayOfUser

ArrayOfUserArrayOfUser is a complex data type that represents an array of User objects.

ArrayOfUserConditionArrayOfUserCondition is a complex data type that represents an array of UserCondition objects.

ArrayOfUserGroupArrayOfUserGroup is a complex data type that represents an array of UserGroup objects.

ArrayOfUserGroupConditionArrayOfUserGroupCondition is a complex data type that represents an array of UserGroupCondition objects.

AttachmentA complex data type that describes the object in the attachment and contains the attachment as binary data.

Elements ContentIdString. Maps to the attachment’s MIME header. ContentId is required.

ContentTypeString. The type of file to upload, such as binary.

ContentLengthLong. Optional. The length of the object.

ContentEncodingString. Optional. The encoding the object uses. Cannot exceed 10 characters.

LocaleString. Optional. The object locale.

Page 121: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 103

Base64Binary

ContentDataBase64Binary. Optional. The attachment as binary data. Use ContentData to embed the file in the request.

Base64BinaryA standard XML base64Binary data type.

BookMarkA complex data type that specifies the bookmark value, display name, and element type in a report document.

Elements BookMarkValueString. The bookmark value, such as the page number.

DisplayNameString. The display name of the bookmark.

ElementTypeString. The element or component type.

BookMarkTypeString. Optional. The bookmark type.

BooleanA standard XML Boolean data type with a value of True or False.

CancelJobStatusA simple data type that represents the status of a request to cancel a synchronous report.

Element String. One of the following values:

SucceededThe synchronous report generation was successfully cancelled.

FailedThe request to cancel a synchronous report failed.

Page 122: Actuate API Reference - OpenText

104 A c t u a t e A P I R e f e r e n c e

Capabi l i t ies

InActiveThe synchronous report generation is complete and cannot be cancelled.

CapabilitiesA complex data type that represents the tasks that a user is permitted to perform using a specified tool. The tasks for each tool are grouped into a category.

Elements CategoryString. The name of a category, for example InteractiveViewer.

CapabilityNamesArrayOfString. The list of tasks that the user is permitted to perform. The available capability names differ according to the category.

ChannelObsolete since iHub Release 3.

ChannelConditionObsolete since iHub Release 3.

ChannelFieldObsolete since iHub Release 3.

ChannelSearchObsolete since iHub Release 3.

ColumnDefinitionObsolete since iHub Release 2.

Page 123: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 105

ColumnDetail

ColumnDetailA complex data type that describes the type of data within a column.

Elements nameString. The name of the column.

typeTypeName. The type of data within the column.

displayNameString. The display name of the column.

ColumnSchemaA complex data type that describes the schema of a column.

Elements NameString. The column name.

AliasString. Optional. User-defined name for column.

DataTypeInt. Optional. The data type of the column.

TypeNameString. The name of the data type.

LabelString. Optional. The column label.

VisibilityBoolean. Optional. Specifies whether column is visible. The default value is True.

AllowExportBoolean. Optional. Specifies whether to allow exporting the column. The default value is True.

ComponentIdentifierObsolete since iHub Release 2.

Page 124: Actuate API Reference - OpenText

106 A c t u a t e A P I R e f e r e n c e

ComponentType

ComponentTypeObsolete since iHub Release 2.

CopyFileA complex data type describes a copied file or list of files. To copy a single file or folder, specify Name or Id. To copy a list of files or folders, specify NameList or IdList. To copy files or folders that match specific conditions, specify Search.

Elements TargetString. The new location for the file or folder. The following rules apply:

■ If Target is a file, the operation fails if the source contains a folder.

■ If Target is a folder that does not exist, a folder is created.

■ If Target is a folder and the source contains a single folder, the contents of the source folder are copied to the target folder and merged with target folder contents.

■ If Target is a folder and the source contains a single file or multiple files and folders, the source files and folders are copied to the target folders. All source folders are copied as children of the target folder.

WorkingFolderNameString. The name of the working folder of the file or folder to copy. Specify either WorkingFolderName or WorkingFolderId.

WorkingFolderIdString. The ID of the working folder of the file or folder to copy. Specify either WorkingFolderId or WorkingFolderName.

RecursiveBoolean. Specifies whether to search subfolders. If True, the search includes subfolders. The default value is False.

SearchFileSearch. The search condition that specifies which folders or files to copy.

IdListArrayOfString. The list of file or folder IDs to copy. Specify either IdList or NameList.

NameList ArrayOfString. The list of file or folder names to copy. Specify either NameList or IdList.

Page 125: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 107

CounterInfo

IdString. The ID of the single file or folder to copy. Specify either Id or Name.

NameString. The name of the single file or folder to copy. Specify either Name or Id.

ReplaceExistingBoolean. If True, the copied file replaces the existing file, if one exists. If the existing file has any dependencies, it is not replaced regardless of the ReplaceExisting setting. If False or if the existing file has any dependencies, a new version of the file is created. The default value is True.

MaxVersionsLong. The maximum number of versions to create. MaxVersions applies only for files and is ignored for folders.

LatestVersionOnlyBoolean. Specifies whether all versions of the file are copied or only the latest version. Used only when a Search tag is specified. If True, only the latest version of the file that matches the search criteria is copied. If False, all versions of the file are copied. The default value is False.

CounterInfoA complex data type that describes a counter.

Elements CounterIdLong. The ID of the counter.

CounterNameString. The name of the counter.

CounterValueLong. The value of the counter.

CreateChannelObsolete since iHub Release 3.

CreateFileTypeAdds a file type. Available only to users with the Administrator user group.

Page 126: Actuate API Reference - OpenText

108 A c t u a t e A P I R e f e r e n c e

CreateFolder

Elements FileTypeFileType. The properties of the file type to add. The following properties are required:

■ Name

■ Extension

■ IsNative

■ IsExecutable

■ OutputType

■ IsPrintable

IgnoreDupBoolean. Specifies whether to report an error when creating the file type if one with the same name already exists. BIRT iHub always rejects a duplicate request regardless of the IgnoreDup setting. If True, BIRT iHub does not report an error. If False, BIRT iHub reports an error. The default value is False.

CreateFolderCreates a folder in a volume into which you are currently logged in. To create a folder, you must have permission to add folders to the volume.

Elements WorkingFolderNameString. The name of the working folder for the new folder. Specify either WorkingFolderName or WorkingFolderId.

WorkingFolderIdString. The ID of the working folder for the new folder. Specify either WorkingFolderId or WorkingFolderName.

FolderNameString. The name of the new folder, relative to the working folder, if specified. If you do not specify a working folder, you must specify a full path.

DescriptionString. The description of the folder.

IgnoreDupBoolean. Specifies whether to report an error when creating the folder if one with the same name already exists. BIRT iHub always rejects a duplicate request regardless of the IgnoreDup setting. If True, BIRT iHub does not report an error. If False, BIRT iHub reports an error. The default value is False.

Page 127: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 109

CreateGroup

CreateGroupObsolete since iHub Release 3.

CreateRoleDeprecated since iHub Release 3. Replaced by CreateUserGroup.

CreateUserCreates a user. Available only to users in the Administrator user group.

Elements UserUser. The properties of the user to create. Only a user name is required.

IgnoreDupBoolean. Specifies whether to report an error when creating the user if one with the same name already exists. BIRT iHub always rejects a duplicate request regardless of the IgnoreDup setting. If True, BIRT iHub does not report an error. If False, BIRT iHub reports an error. The default value is False.

CreateUserGroupCreates a user group. Available only to users in the Administrator user group.

Elements UserGroupUserGroup. The properties of the user group to create. Only a user group name is required.

ProductFamiliesArrayOfString. The list of product families associated with this user group.

IgnoreDupBoolean. Specifies whether to report an error when creating the user group if one with the same name already exists. BIRT iHub always rejects a duplicate request regardless of the IgnoreDup setting. If True, BIRT iHub does not report an error. If False, BIRT iHub reports an error. The default value is False.

CustomEventA complex data type that specifies information used within a custom event.

Page 128: Actuate API Reference - OpenText

110 A c t u a t e A P I R e f e r e n c e

Dai ly

Element EventParameterString. A value used within the custom event.

DailyA complex data type that describes daily types of job scheduling.

Elements FrequencyInDaysLong. The number of times a job is run daily in days.

OnceADayString. Optional. A string representing when a job is to run once a day.

RepeatRepeat. Optional. The number of times the schedule is repeated.

DatabaseConnectionDefinitionObsolete since iHub Release 2.

DataCellA complex data type describing the type of data within a data cell.

Elements One of the following elements:

intInt. An integer value.

shtShort. A short value.

dblDouble. A double value.

dbnacDouble. An Actuate double value.

curString. A currency value.

dtmDateTime. An date-and-time value.

Page 129: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 111

DataExtract ionFormat

strString. A string value.

blnBoolean. A Boolean value.

nllacNull. The null value.

DataExtractionFormatA complex data type that describes the format of a file and its mime type.

Elements OutputFormatString. The format of the file.

MimeTypeString. The file mime type.

DataFilterConditionA complex data type that describes a filter condition.

Elements ColumnNameString. The name of the column to filter.

OperationString. The filtering operation.

Operand1String. The first operand of the filter.

Operand2String. Optional. The second operand of the filter.

Operand3ArrayOfString. Optional. A list of operands for the filter.

DataRowA complex data type that contains the information from a data row.

Element CellDataCell. A data cell from the row. A DataRow contains as many Cell values as there are fields in the row.

Page 130: Actuate API Reference - OpenText

112 A c t u a t e A P I R e f e r e n c e

DataSchema

DataSchemaA complex data type that describes a data schema by column.

Element ColumnColumnDetail. The schema of the information stored within a column. A DataSchema contains as many Column values as there are fields in a row.

DataSortColumnA complex data type that describes a sorted data column.

Elements ColumnNameString. The name of the sorted column.

SortDirectionString. The direction of the sort. Valid values are:

■ ASC - Ascending

■ DES - Descending

DataSourceTypeA simple data type that specifies the type of file in which a parameter exists.

Element String. One of the following values:

InfoObjectAn information object.

ABInfoObjectAn Actuate Basic information object. Obsolete since iHub Release 2.

DataTypeA simple data type that specifies a data type.

Element String. One of the following values:

CurrencyA Currency data type.

DateA DateTime data type.

Page 131: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 113

Date

DateOnlyA Date data type.

TimeA Time data type.

DoubleA Double data type.

IntegerAn Int data type.

StringA String data type.

BooleanA Boolean data type.

StructureA structure. Obsolete since Actuate release 11.

TableA table. Obsolete since Actuate release 11.

DateDate is a standard XML Date data type that displays dates in the format CCYY-MM-DD.

DateTimeDateTime is a standard XML TimeInstant data type that shows the date and time in the format CCYY-MM-DDThh:mm:ss-sss. DateTime ignores milliseconds, if any.

DecimalDecimal is a standard XML Decimal data type that represents a number having arbitrary precision up to a maximum of 18 digits.

Page 132: Actuate API Reference - OpenText

114 A c t u a t e A P I R e f e r e n c e

DeleteChannel

DeleteChannelObsolete since iHub Release 3.

DeleteFileDeletes files or folders. To delete a single file or folder, specify Name or Id. To delete several files or folders, specify NameList or IdList. To delete files or folders that match the specified conditions, specify Search.

Elements WorkingFolderIdString. The ID of the working folder of the file or folder to delete. Specify either WorkingFolderId or WorkingFolderName.

WorkingFolderNameString. The name of the working folder of the file or folder to delete. Specify either WorkingFolderName or WorkingFolderId.

RecursiveBoolean. Specifies whether to delete subfolders. If True, subfolders are deleted. If False, only the specified folder is deleted. The default value is False.

LatestVersionOnlyBoolean. Specifies whether to delete only the latest version of the file. If True, only the latest version of the file is deleted. The default value is False.

SearchFileSearch. The search condition that specifies which folders or files to delete.

IdListArrayOfString. The list of file or folder IDs to delete. Specify either IdList or NameList.

NameList ArrayOfString. The list of file or folder names to delete. Specify either NameList or IdList.

IdString. The ID of the single file or folder to delete. Specify either Id or Name.

NameString. The name of the single file or folder to delete. Specify either Name or Id.

IgnoreMissingBoolean. Specifies what to do if the specified file or folder does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.

Page 133: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 115

DeleteFileType

DeleteFileTypeDeletes file types. To delete a single file type, specify Name or Id. To delete several file types, specify NameList or IdList.

Elements NameListArrayOfString. The list of file types to delete.

NameString. The name of a single file type to delete.

IgnoreMissingBoolean. Specifies what to do if the specified file type does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.

DeleteGroupObsolete since iHub Release 3.

DeleteJobDeletes scheduled, completed, cancelled, or failed jobs. If an instance of a scheduled report is running when the request is submitted, an exception is thrown.

To delete a single job, specify Id. To delete several jobs, specify IdList. To delete jobs that match the specified conditions, specify Search.

Elements SearchJobSearch. The search conditions. If conditions apply to multiple fields, use ConditionArray.

IdList ArrayOfString. The list of job IDs to delete.

IdString. The ID of the single job to delete.

IgnoreMissingBoolean. Specifies what to do if the specified job does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.

Page 134: Actuate API Reference - OpenText

116 A c t u a t e A P I R e f e r e n c e

DeleteJobNotices

IgnoreActiveJobBoolean. Flag indicating whether to delete a job if it is active.

DeleteJobNoticesDeletes job notices. A user in the Administrator user group can delete all job notices. To delete all job notices, do not specify the user or group.

Element SearchJobNoticeSearch. The search conditions. If conditions apply to multiple fields, use ConditionArray.

DeleteJobScheduleDeletes a job schedule. If an instance of a scheduled report is running when the request is submitted, an exception is thrown.

To delete a job schedule, specify Id. To delete several jobs, specify IdList. To delete jobs that match the specified conditions, specify Search.

Elements SearchJobScheduleSearch. The search conditions. If conditions apply to multiple fields, use ConditionArray.

IdList ArrayOfString. The list of job schedule IDs to delete.

IdString. The ID of the single job schedule to delete.

IgnoreMissingBoolean. Specifies what to do if the specified job does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.

IgnoreActiveJobBoolean. Flag indicating whether to delete a job if it is active.

DeleteRoleDeprecated since iHub Release 3. Replaced by DeleteUserGroup.

Page 135: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 117

DeleteUser

DeleteUserDeletes users. To delete a single user, specify Name or Id. To delete several users, specify NameList or IdList. To delete users that match the specified conditions, specify Search.

Elements SearchUserSearch. The search condition that specifies which users to delete.

IdListArrayOfString. The list of user IDs to delete. Specify either IdList or NameList.

NameList ArrayOfString. The list of user names to delete. Specify either NameList or IdList.

IdString. The ID of the single user to delete. Specify either Id or Name.

NameString. The name of the single user to delete. Specify either Name or Id.

IgnoreMissingBoolean. Specifies what to do if the specified user does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.

PurgeUserInfoBoolean. Purges user information from the system.

DeleteUserGroupDeletes a user group. Available only to users with the Administrator user group.

Elements SearchUserGroupSearch. The search condition that specifies which user groups to delete.

IdListArrayOfString. The list of user group IDs to delete. Specify either IdList or NameList.

NameListArrayOfString. The list of user group names to delete. Specify either NameList or IdList.

IdString. The ID of the single user group to delete. Specify either Id or Name.

Page 136: Actuate API Reference - OpenText

118 A c t u a t e A P I R e f e r e n c e

DocumentConversionOptions

NameString. The name of the single user group to delete. Specify either Name or Id.

IgnoreMissingBoolean. Specifies what to do if the specified user group does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.

DocumentConversionOptionsA complex data type that describes the conversion options of a file.

Elements FileTypeString. The file type of the file.

OutputFormatString. The output format of the file.

MimeTypeString. The mime type of the file.

OptionsArrayOfParameterDefinition. The list of conversion options.

DoubleDouble is a standard XML double data type, which is a signed 64-bit floating-point number.

EventA complex type that describes an event and its status.

Elements FileEventFileEvent. Optional. Specifies information for a file event. Specify one of this value, JobEvent, or CustomEvent.

JobEventJobEvent. Optional. Specifies information for a job event. Specify one of this value, FileEvent, or CustomEvent.

CustomEventCustomEvent. Optional. Specifies information for a custom event. Specify one of this value, FileEvent, or JobEvent.

Page 137: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 119

EventOptions

EventNameString. The name of the event.

EventTypeEventType. The type of event.

PollingIntervalLong. Optional. Specifies the amount of time to wait between event status checks. The minimum value is 10 seconds.

PollingDurationLong. Optional. Specifies the amount of time to check the event status.

LagTimeLong. Optional. Specifies lag time value for the event.

EventStatusString. Optional. The current status of the event. Valid values are:

■ Uninitialized

■ Polling

■ Satisfied

■ Expired

EventOptionsA complex data type that describes polling and other options for an event.

Elements DefaultEventPollingIntervalLong. Optional. The amount of time to wait between polling the event.

DefaultEventPollingDurationLong. Optional. The duration of time to poll for an event.

DefaultEventLagTimeLong. Optional. The amount of lag time for the event.

EnableCustomEventServiceBoolean. Optional. A flag indicating whether to enable the custom event service.

EventTypeA simple data type that represents a type of event.

Element String. One of the following values:

Page 138: Actuate API Reference - OpenText

120 A c t u a t e A P I R e f e r e n c e

ExecuteReportStatus

FileEventA file type event.

JobEventA job type event.

CustomEventA custom type event.

NoEventNo event.

ExecuteReportStatusA simple data type that represents the status of report execution.

Element String. One of the following values:

DoneThe report execution succeeded.

FailedThe report execution failed.

FirstPageThe first page is complete. Applies only if progressive viewing is enabled.

PendingThe job is either in the queue or in the process of generating. Applies only if WaitTime is specified.

ExternalTranslatedUserNamesA complex data type that represents a member of the Administrators user group.

Element AdministratorString. The external name of the administrator user.

ExternalTranslatedRoleNamesDeprecated since iHub Release 3. Replaced by ExternalTranslatedUserGroupNames.

Page 139: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 121

ExternalTranslatedUserGroupNames

ExternalTranslatedUserGroupNamesA complex data type that represents one of the following user groups:

■ Administrator

■ Operator

■ All

Elements AdministratorString. The external name of the administrator user group.

OperatorString. The external name of the operator user group.

AllString. The external name of the all user group.

FieldDefinitionA complex data type that describes a scalar parameter.

Elements NameString. The name of the parameter.

DisplayNameString. Optional. The display name of the parameter.

DataTypeScalarDataType. Optional. The data type of the parameter. Valid values are:

■ Currency

■ Date

■ Double

■ Integer

■ String

■ Boolean

IsHiddenBoolean. Optional. Specifies whether the parameter is hidden.

IsRequiredBoolean. Optional. Specifies whether the parameter is required.

Page 140: Actuate API Reference - OpenText

122 A c t u a t e A P I R e f e r e n c e

FieldValue

DefaultValueString. Optional. The default value of the parameter.

SelectValueListArrayOfString. Optional. The list of available parameter values.

FieldControlTypeString. Optional. The type of control used to represent the parameter. Valid values are:

■ ControlListAllowNewA text box

■ ControlListA drop-down list

SelectNameValueListArrayOfNameValuePair. Optional. A list of name-value pairs used within the field.

FieldValueObsolete since iHub Release 2.

FileA complex data type that describes a file.

Elements IdString. Optional. The file ID.

NameString. Optional. The name of the file. Actuate’s internal data store imposes a fixed upper limit on the length of certain text strings.

FileTypeString. Optional. The file type.

DescriptionString. Optional. The description of the file.

PageCountLong. Optional. The number of pages in the file.

SizeLong. Optional. The size of the file.

Page 141: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 123

Fi leAccess

TimeStampDateTime. Optional. The time the file was created or modified, in Coordinated Universal Time (UTC).

VersionLong. Optional. The version number.

VersionNameString. Optional. The version name.

OwnerString. Optional. The owner of the file.

UserPermissionsString. Optional. The current user permissions for the file.

AccessTypeFileAccess. Optional. The file’s access type. Valid values are:

■ PrivateOnly the owner of the file and an administrator can access the file.

■ SharedAll users and user groups specified in the access control list (ACL) for the file can access the file.

FileAccessA simple data type that specifies the file’s access type.

Element String. One of the following values:

PrivateOnly the owner of the file and an administrator can access the file.

SharedAll users and user groups specified in the access control list (ACL) for the file can access the file.

FileConditionA complex data type that represents the fields on which a search can be performed and the condition to match.

Elements FieldFileField. File field on which to perform a search.

Page 142: Actuate API Reference - OpenText

124 A c t u a t e A P I R e f e r e n c e

Fi leContent

MatchString. The condition to match. If the condition includes special characters, for example a dash, either escape the special character with a backslash (\) or enclose it in brackets ([]). For example, to search for a file 05-25-04Report.rptdocument, specify one of the following: 05\-25\-04Report.rptdocument 05[-]25[-]04Report.rptdocument

FileContentA complex data type that represents a list of attached files or the content of embedded files.

Elements FileFile. The attached file.

ContentAttachment. The content of an embedded file.

FileEventA complex data type that contains information pertaining to file type events.

Element MonitoredFilePathString. The file path of the file the event is monitoring.

FileFieldA simple type that describes different fields that may exist for a file.

Element String. One of the following values:

NameThe name of the file.

FileTypeThe file type.

DescriptionThe description of the file.

PageCountThe number of pages in the file.

Page 143: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 125

FileSearch

SizeThe size of the file.

TimeStampThe time the file was created or modified, in Coordinated Universal Time (UTC).

VersionOptional. The version number.

VersionNameThe version name.

OwnerThe owner of the file.

FileSearchA complex data type that represents a file search.

Elements ConditionFileCondition. Optional. The search condition. Specify either this parameter or ConditionArray.

ConditionArrayArrayOfFileCondition. Optional. An array of search conditions. Use if search conditions apply to multiple fields.

OwnerString. Optional. The file owner.

DependentFileNameString. Optional. The name of the dependent file. Specify one of this parameter, DependentFileId, RequiredFileName, or RequiredFileId.

DependentFileIdString. Optional. The ID of the dependent file. Specify one of this parameter, DependentFileName, RequiredFileName, or RequiredFileId.

RequiredFileNameString. Optional. The name of the required file. Specify one of this parameter, DependentFileName, DependentFileId, or RequiredFileId.

RequiredFileIdString. Optional. The ID of the required file. Specify one of this parameter, DependentFileName, DependentFileId, or RequiredFileName.

Page 144: Actuate API Reference - OpenText

126 A c t u a t e A P I R e f e r e n c e

Fi leType

PrivilegeFilterPrivilegeFilter. Optional. The privileges for which to search. Use PrivilegeFilter to determine whether the specified user or user group has the specified privileges on the file.

AccessTypeFileAccess. Optional. The file’s access type. Valid values are:

■ PrivateOnly the owner of the file and an administrator can access the file.

■ SharedAll users and user groups specified in the access control list (ACL) for the file can access the file.

FetchSizeInt. Optional. The maximum number of records to retrieve and return in a result set. The default value is 500.

FetchDirectionBoolean. Optional. If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.

CountLimitInt. Optional. The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to -1.

FetchHandleString. Optional. Retrieves more items from the result set. In the second and subsequent calls for data, specifies the same search criteria as in the original call.

IncludeHiddenObjectBoolean. Optional. Flag indicating if search should include hidden objects.

FileTypeA complex data type that describes a file type. Specify FileType in the SOAP header for all execute, submit, and view IDAPI requests.

Elements NameString. Optional. The file type name.

IsNativeBoolean. Optional. Specifies whether the file is an internal Actuate type. IsNative is read-only. Providing an input value for this attribute in CreateFileType or UpdateFileType causes SetAttributes to be ignored.

Page 145: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 127

FileType

IsExecutableBoolean. Optional. Specifies whether the file is executable. If False, the file type is set to Document file type. The OutputType and ExportBeforeViewing attributes do not apply to Document file type.

IsPrintableBoolean. Optional. Specifies whether the file is printable. If the file type is Executable, IsPrintable refers to the output file.

IsRequiredBoolean. Optional. Specifies whether the file is required.

OutputTypeString. Optional. The file type for the output file. Required if the file type is Executable.

LocalExtensionString. Optional. The local extension.

DisplayTypeString. Optional. Specifies either Simple or Advanced display types.

ShortDescriptionString. Optional. The short description of the file type.

LongDescriptionString. Optional. The long description of the file type.

SmallImageURLString. Optional. The URL of the small image for the file.

LargeImageURLString. Optional. The URL of the large image for the file.

ExportBeforeViewingBoolean. Optional. Specifies whether the file is exported before viewing.

DriverNameString. Optional. The name of the driver. Required if file type is Executable or Printable.

MutexClassString. Optional. The mutex class name.

ContentTypeString. Optional. The content type.

EnableAutoParamCollectionBoolean. Optional. True enables automatic parameter collection for the file type.

Page 146: Actuate API Reference - OpenText

128 A c t u a t e A P I R e f e r e n c e

Fi l terCri ter ia

IsCompoundDocBoolean. Optional. Specifies whether the file is a compound document. The default value is False.

AllowViewTimeParameterBoolean. Optional. Specifies whether to allow view-time parameters. The default value is True.

FilterCriteriaObsolete since iHub Release 2.

GroupObsolete since iHub Release 2.

GroupConditionObsolete since iHub Release 2.

GroupFieldObsolete since iHub Release 2.

GroupingObsolete since iHub Release 2.

GroupSearchObsolete since iHub Release 2.

Page 147: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 129

Header

HeaderThe SOAP header that contains authentication data, locale information, and other required or optional data.

Elements AuthIdA system-generated, encrypted String. All requests except Login requests must have a valid AuthId in the SOAP header. The header passes this identifier to BIRT iHub for validation.

TargetVolumeString. Optional. The volume to which to direct the request.

LocaleString. Optional. The format of Locale is <ll>_<CC>, where <ll> is the two-character language code and <CC> is the two-character country code of the locale. For example, fr_CA is the locale code for the French language used in Canada. Locale is used to format data using the language, date and time conventions, currency and other locale-specific conventions.

ConnectionHandleString. Optional. Supports keeping a connection open to view a persistent report.

TargetServerString. Optional. Refers to the BIRT iHub within a cluster to which to direct the request.

DelayFlushBoolean. Optional. BIRT iHub writes updates to the disk when the value is False.

FileTypeString. Optional. Supports specifying the file type to run, such as a BIRT design or HTML file.

TargetResourceGroupString. Optional. Supports assigning a synchronous report generation request to a specific resource group at run time.

RequestIDString. Optional. A unique value that identifies the SOAP message.

InfoObjectDataA complex data type that describes the data from a BIRT information object.

Elements DataSchemaThe schema for the data rows.

Page 148: Actuate API Reference - OpenText

130 A c t u a t e A P I R e f e r e n c e

InfoObjectDataFormat

DataRowsThe data rows from the information object.

InfoObjectDataFormatA simple data type that describes an information object’s data format.

Element NMTOKEN. One of the following values:

XMLThe file is in XML format.

CSVThe file is in comma separated values format.

IntA standard XML Integer data type that represents a number. Int derives from the Decimal data type by fixing the value of scale at 0.

IOCacheDBIndexConstraintObsolete since iHub Release 2.

IOCacheDefinitionObsolete since iHub Release 2.

IOCacheStateObsolete since iHub Release 2.

JobConditionA complex data type that represents the field on which to perform a search and the condition to match.

Page 149: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 131

JobEvent

Elements FieldJobField. An element that includes a field on which to perform a search.

MatchString. The condition to match. If the condition includes special characters, for example a dash, either escape the special character with a backslash (\) or enclose it in brackets ([]). For example, to search for a file 05-25-04Report.rptdocument, specify one of the following: 05\-25\-04Report.rptdocument 05[-]25[-]04Report.rptdocument

JobEventA complex data type that represents the information pertaining to a job type event.

Elements JobIdString. The ID of the job.

JobNameString. Optional. The job name.

JobStatusArrayOfString. Optional. The job status.

JobFieldA simple data type that represents the fields on which a search for jobs can be performed.

Element String. One of the following values:

JobNameThe job name.

OwnerThe owner of the job.

JobTypeThe type of job. Valid values are:

■ RunReport

■ PrintReport

■ RunAndPrintReport

■ ConvertReport

Page 150: Actuate API Reference - OpenText

132 A c t u a t e A P I R e f e r e n c e

JobInputDetai l

PriorityThe job priority.

RoutedToNodeThe node to which the job is routed.

StartTimeThe start time.

DurationSecondsThe job duration.

CompletionTimeThe time the job is completed.

StateThe state of the job. Valid values are:

■ Succeeded

■ Failed

■ Cancelled

NotifyCountThe number of notifications sent about the job.

OutputFileSizeThe size of the output file.

JobInputDetailA complex data type that describes the job input and output files.

Elements InputFileVersionNameString. Optional. The input file version.

OutputFileVersionNameString. Optional. The output file version.

ReplaceLatestVersionBoolean. Optional. Specifies whether to replace the latest version of the file with the current version.

OutputMaxVersionInt. Optional. The maximum number of versions to keep after a new version is generated.

Page 151: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 133

JobInputDetail

ValueFileTypeString. Optional. The type of a value file. If present, the value is either Temporary or Permanent.

ValueFileVersionNameString. Optional. The value file name.

IsBundledBoolean. Optional. Specifies whether the output object is bundled with the input object.

RetryOptionRetryOptionType. Optional. The retry settings. Valid values are:

■ Disabled

■ VolumeDefault

■ Specified

MaxRetryCountInt. Optional. The maximum number of retry attempts.

RetryIntervalInt. Optional. The interval between retry attempts. Measured in seconds.

MaxVersionsLong. Optional. The maximum number of versions to keep in the volume.

NeverExpireBoolean. Optional. Specifies whether the item expires.

ArchiveRuleInheritedBoolean. Optional. Specifies whether the archive rules are inherited from another object.

ExpirationAgeInt. Optional. Specifies the expiration age for the object.

ExpirationDateDateTime. Optional. The date when the job expires.

ArchiveOnExpireBoolean. Optional. Specifies whether the object is archived before it is expired.

KeepWorkspaceBoolean. Optional. Specifies whether to keep or remove the workspace directory after executing the job.

DriverTimeoutInt. Optional. The time for the driver to return from executing the job.

Page 152: Actuate API Reference - OpenText

134 A c t u a t e A P I R e f e r e n c e

JobInputDetai l

PollingIntervalInt. Optional. The time interval to get status messages. The minimum value is 10 seconds.

DebugInstructionString. Optional. The debug instructions.

SendSuccessNoticeBoolean. Optional. Specifies whether success notices are sent if the job succeeds. Used only if OverrideRecipientPref is True.

SendFailureNoticeBoolean. Optional. Specifies whether failure notices are sent if the job fails. Used only if OverrideRecipientPref is True.

SendEmailForSuccessBoolean. Optional. Specifies whether e-mail notifications are sent if the job succeeds. Used only if OverrideRecipientPref is True. If SendEmailForSuccess is True, e-mail notifications are sent to specified users if the job succeeds. The default value is False.

SendEmailForFailureBoolean. Optional. Specifies whether e-mail notifications are sent if the job fails. Used only if OverrideRecipientPref is True. If SendEmailForFailure is True, e-mail notifications are sent to specified users if the job fails. The default value is False.

AttachReportInEmailBoolean. Optional. Specifies whether the output file is attached to the e-mail notification for successful jobs. Used only if OverrideRecipientPref is True. If AttachReportInEmail is True, the output file is attached to the e-mail notification. If False, only a link to the output file is sent. Specify the format for the attachment in the EmailFormat element. The default value is False.

OverrideRecipientPrefBoolean. Optional. Specifies whether e-mail notifications and output attachments are sent according to job settings or user settings. If True, e-mail notifications and output attachments are sent according to job settings. If False, e-mail notifications and output attachments are sent according to user settings. The default value is False. If False, the following elements are ignored:

■ AttachReportInEmail

■ SendEmailForSuccess

■ SendEmailForFailure

■ SendSuccessNotice

■ SendFailureNotice

Page 153: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 135

JobNotice

EmailFormatString. Optional. Specifies the output format of the report attached to the e-mail notification. Table 3-3 lists the valid format codes.

RecordSuccessStatusBoolean. Optional. Specifies whether to record job success notices.

RecordFailureStatusBoolean. Optional. Specifies whether to record job failure notices.

KeepOutputFileBoolean. Optional. Specifies whether the generated output file remains in the volume if the generation request succeeds but the printing request fails. Used if the job is to be generated and printed. If True, the output file remains in the volume. If False, the output file is deleted if the printing request fails. The default value is False.

ConversionOptionsObsolete since iHub Release 2.

DataACLArrayOfString. Optional. Specifies the access control list (ACL) restricting data privileges.

JobNoticeA complex data type that describes a job notice.

Elements JobIdString. Optional. The job ID.

Table 3-3 E-mail attachment formats

Format code File type description

DOC Microsoft Word

DOCX Microsoft Word 2010

PDF Adobe PDF

PPT Microsoft PowerPoint

PPTX Microsoft PowerPoint 2010

PS Adobe Postscript

XLS Microsoft Excel

XLSX Microsoft Excel 2010

Page 154: Actuate API Reference - OpenText

136 A c t u a t e A P I R e f e r e n c e

JobNotice

JobNameString. Optional. The name of the job.

HeadlineString. Optional. The job headline.

JobStateString. Optional. The state of the job. Valid values are:

■ Succeeded

■ Failed

■ Cancelled

CompletionTimeDateTime. Optional. The time the job is completed.

ActualOutputFileNameString. Optional. The output file name that the BIRT iHub generated.

OutputFileNameString. Optional. The output file name.

OutputFileVersionNameString. Optional. The output file version name.

ActualOutputFileSizeLong. Optional. The size of the output file.

ActualOutputFileIdString. Optional. The output file ID that the BIRT iHub generated.

NotifiedUserIdString. Optional. The ID of the user who received the notice.

NotifiedUserNameString. Optional. The name of the user who received the notice.

NotifiedChannelIdObsolete since iHub Release 3.

NotifiedChannelNameObsolete since iHub Release 3.

OutputFileVersionLong. Optional. The output file version number.

Page 155: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 137

JobNoticeCondit ion

JobNoticeConditionA complex data type that represents the field on which to perform a search and the condition to match.

Elements FieldString. Optional. The field on which to perform a search. Valid values are:

■ JobId

■ JobName

■ OutputFileName

■ JobState

■ HeadLine

■ CompletionTime

MatchString. The condition to match. If the condition includes special characters, for example a dash, either escape the special character with a backslash (\) or enclose it in brackets ([]). For example, to search for a file 05-25-04Report.rptdocument, specify one of the following: 05\-25\-04Report.rptdocument05[-]25[-]04Report.rptdocument

JobNoticeFieldA simple data type that represents the fields on which a search can be performed.

Element String. One of the following values:

JobIdThe job ID.

JobNameThe name of the job.

OutputFileNameThe output file name.

JobStateThe state of the job.

HeadLineThe job headline.

Page 156: Actuate API Reference - OpenText

138 A c t u a t e A P I R e f e r e n c e

JobNoticeSearch

CompletionTimeThe time the job is completed.

JobNoticeSearchA complex data type that represents the job notice search.

Elements ConditionJobNoticeCondition. Optional. The search condition. Specify one of this parameter or CondtionArray.

ConditionArrayArrayOfJobNoticeCondition. Optional. An array of search conditions. Specify one of this parameter or Condition.

NotifiedUserIdString. Optional. The ID of the user who received the notice. Specify either this parameter or NotifiedUserName.

NotifiedUserNameString. Optional. The name of the user who received the notice. Specify either this parameter or NotifiedUserId.

NotifiedChannelIdObsolete since iHub Release 3.

NotifiedChannelNameObsolete since iHub Release 3.

FetchSizeInt. Optional. The maximum number of records to retrieve and return in a result set. The default value is 500.

FetchDirectionBoolean. Optional. If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.

CountLimitInt. Optional. The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to -1.

FetchHandleString. Optional. Retrieves more items from the result set. In the second and subsequent calls for data, specify the same search criteria as in the original call.

Page 157: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 139

JobPrinterOptions

JobPrinterOptionsA complex data type that describes the job printer options.

Elements PrinterNameString. The printer name.

OrientationString. Optional. The paper orientation.

PageSizeString. Optional. The page size.

ScaleLong. Optional. The scaling factor.

ResolutionString. Optional. The resolution.

NumberOfCopiesLong. Optional. The number of copies.

CollationOptionBoolean. Optional. Specifies whether the printer’s collation property is set.

PaperTrayBoolean. Optional. Specifies whether the printer’s paper tray option is set.

DuplexString. Optional. The value of the printer’s duplex property.

IsColorBoolean. Optional. Specifies whether the printer can print in color.

PaperLengthLong. Optional. The paper length.

PaperWidthLong. Optional. The paper width.

PageRangeString. Optional. The page range. Cannot exceed 20 characters.

FormNameString. Optional. The form name.

PrintToFileString. Optional. The setting of the print to file property. Cannot exceed 256 characters.

Page 158: Actuate API Reference - OpenText

140 A c t u a t e A P I R e f e r e n c e

JobPropert ies

JobPropertiesA complex data type that specifies the general job attributes, such as input document file name, output file name, and job execution status.

Elements JobIdString. Optional. The job ID.

JobNameString. Optional. The name of the job.

PriorityLong. Optional. The job priority.

ResourceGroupString. Optional. The name of the resource group to which a job is assigned, if any.

OwnerString. Optional. The owner of the job.

JobTypeString. Optional. The type of job. Valid values are:

■ RunReport

■ PrintReport

■ RunAndPrintReport

■ ConvertReport

StateString. Optional. The state of the job. Valid values are:

■ Scheduled

■ Pending

■ Waiting

■ Running

■ Succeeded

■ Failed

■ Cancelled

■ Expired

InputFileIdString. Optional. The input file ID.

Page 159: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 141

JobProperties

InputFileNameString. Optional. The input file full name and version number.

RunLatestVersionBoolean. Optional. Specifies whether to run the latest version of the file.

ParameterFileIdString. Optional. The parameter file ID. Exists only if the parameter file is specified.

ParameterFileNameString. Optional. The parameter file name. Exists only if the parameter file is specified.

ActualOutputFileIdString. Optional. The output file ID that the BIRT iHub generated.

ActualOutputFileNameString. Optional. The output file name that the BIRT iHub generated. This might be different from the RequestedOutputFileName.

RequestedOutputFileNameString. Optional. The requested name for the output file.

OutputFileVersionNameString. Optional. The output file version name.

SubmissionTimeDateTime. Optional. The time the job was submitted.

CompletionTimeDateTime. Optional. The time the job is completed.

PageCountLong. Optional. The number of pages.

OutputFileSizeLong. Optional. The size of the output file.

RoutedToNodeString. Optional. The node to which the job is routed.

DurationSecondsLong. Optional. The job duration.

StartTimeDateTime. Optional. The start time.

NextStartTimeDateTime. Optional. The next time the job is scheduled to run. Applies only to scheduled jobs.

Page 160: Actuate API Reference - OpenText

142 A c t u a t e A P I R e f e r e n c e

JobSchedule

RequestedHeadlineString. Optional. The headline for the job.

ActualHeadlineString. Optional. The headline that the BIRT iHub generated.

NotifyCountString. Optional. The number of notifications sent about the job.

EventNameString. Optional. The name of the job event.

EventTypeEventType. Optional. The job event type.

EventStatusString. Optional. The job event status.

EventParameterString. Optional. The parameter for the job event.

JobScheduleA complex data type that represents details about a job schedule.

Elements TimeZoneNameString. Optional. The time zone. Cannot exceed 32 characters.

ScheduleDetailsArrayOfJobScheduleDetail. The schedule details.

JobScheduleConditionA complex data type that represents the field on which to perform a search and the condition to match.

Elements FieldJobScheduleField. Field on which to perform a search.

MatchString. The condition to match. If the condition includes special characters, for example a dash, either escape the special character with a backslash (\) or enclose it in brackets ([]). For example, to search for a file 05-25-04Report.rptdocument, specify one of the following: 05\-25\-04Report.rptdocument 05[-]25[-]04Report.rptdocument

Page 161: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 143

JobScheduleDetai l

JobScheduleDetailA complex data type that specifies a schedule for running a job.

Elements ScheduleTypeString. The type of schedule. Valid values are:

■ AbsoluteDate

■ Daily

■ Weekly

■ Monthly

ScheduleStartDateString. Optional. The date on which to start the schedule. The date is a standard XML String data type in the format YYYY-MM-DDThh:mm:ss-sss. Milliseconds, if specified, are ignored.

ScheduleEndDateString. Optional. The date on which to end the schedule. The date is a standard XML String data type using the format YYYY-MM-DDThh:mm:ss-sss. Milliseconds, if specified, are ignored.

DatesExcludedArrayOfDate. Optional. An array of dates to exclude from the schedule.

AbsoluteDateAbsoluteDate. Optional. This value applies if ScheduleType is AbsoluteDate.

DailyDaily. Optional. This value applies if ScheduleType is Daily.

WeeklyWeekly. Optional. This value applies if ScheduleType is Weekly.

MonthlyMonthly. Optional. This value applies if ScheduleType is Monthly.

JobScheduleFieldA simple data type describing job schedule fields upon which a search can be performed.

Element String. One of the following values:

JobNameThe name of the job.

Page 162: Actuate API Reference - OpenText

144 A c t u a t e A P I R e f e r e n c e

JobScheduleSearch

OwnerThe owner of the job.

JobTypeThe type of job. Valid values are:

■ RunReport

■ PrintReport

■ RunAndPrintReport

■ ConvertReport

PriorityThe job priority.

NextStartTimeThe next time the job is scheduled to run. Applies only to scheduled jobs.

StateThe state of the job. Valid values are:

■ Scheduled

■ Pending

■ Running

■ Succeeded

■ Failed

■ Cancelled

■ Expired

ParameterFileIdThe parameter file ID. Exists only if the parameter file is specified.

JobScheduleSearchA complex data type that represents a job schedule search.

Elements ConditionJobScheduleCondition. Optional. The search condition. Specify this value or ConditionArray.

ConditionArrayArrayOfJobScheduleCondition. Optional. The array of search conditions. Specify this value or Condition.

Page 163: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 145

JobSearch

RequestedOutputFileNameString. Optional. The output file name.

InputFileNameString. Optional. The input file name.

InputFileIdString. Optional. The input file ID.

EventTypeEventType. Optional. The event type of the job.

NotifiedUserIdString. Optional. The ID of the user to notify. Specify either this value or NotifiedUserName.

NotifiedUserNameString. Optional. The name of the user to notify. Specify either this value or NotifiedUserId.

NotifiedChannelIdObsolete since iHub Release 3.

NotifiedChannelNameObsolete since iHub Release 3.

FetchSizeInt. Optional. The maximum number of records to retrieve and return in a result set. The default value is 500.

FetchDirectionBoolean. Optional. If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.

CountLimitInt. Optional. The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to -1.

FetchHandleString. Optional. Retrieves more items from the result set. In the second and subsequent calls for data, specifies the same search criteria as in the original call.

JobSearchA complex data type that represents a job search.

Elements ConditionJobCondition. Optional. The search condition. Specify this value or ConditionArray.

Page 164: Actuate API Reference - OpenText

146 A c t u a t e A P I R e f e r e n c e

JobSearch

ConditionArrayArrayOfJobCondition. Optional. The array of search conditions. Specify this value or Condition.

OwnerString. Optional. The owner of the job.

ActualOutputFileNameString. Optional. The output file name that the BIRT iHub generated.

ActualOutputFileIdString. Optional. The output file ID that the BIRT iHub generated.

RequestedOutputFileNameString. Optional. The output file requested name.

InputFileNameString. Optional. The input file name.

InputFileIdString. Optional. The input file ID.

NotifiedUserIdString. Optional. The ID of the user who received notification. Specify either this value or NotifiedUserName.

NotifiedUserNameString. Optional. The name of the user who received notification. Specify either this value or NotifiedUserId.

NotifiedChannelIdObsolete since iHub Release 3.

NotifiedChannelNameObsolete since iHub Release 3.

FetchSizeInt. Optional. The maximum number of records to retrieve and return in a result set. The default value is 500.

FetchDirectionBoolean. Optional. If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.

CountLimitInt. Optional. The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to -1.

FetchHandleString. Optional. Retrieves more items from the result set. In the second and subsequent calls for data, specifies the same search criteria as in the original call.

Page 165: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 147

LicenseOption

LicenseOptionA complex data type that represents a license option.

Elements NameString. Optional. The name of the license option.

DescriptionString. Optional. The description of the option.

ShortDescriptionString. Optional. A shorter description of the option.

ValueString. Optional. The value of the option.

LongLong is a standard XML long data type, which supports a 64-bit value, ranging from –9223372036854775808 to 9223372036854775807.

MDSInfoA complex data type that describes a Message Distribution service (MDS).

Elements ServerNameString. The server name.

MDSIPAddressString. The IP address of the MDS.

MDSPortNumberInt. The port number the MDS uses.

MDSSSLPortNumberInt. Optional. The SSL port number the MDS uses.

ServerStateServerState. Optional. The server state.

MonthlyA complex data type that describes monthly job scheduling.

Page 166: Actuate API Reference - OpenText

148 A c t u a t e A P I R e f e r e n c e

Monthly

Elements FrequencyInMonthsLong. The amount of times a job is to be run, in months.

OnDayInt. Optional. The day of the month on which to run the job.

OnWeekDayInt. Optional. The day of the month, excluding weekends, on which to run the job.

RunOnOptional. A complex type containing two String values. The first string, WeekDay, specifies the day of the week on which to run the job. Valid values for WeekDay are:

■ Mon

■ Tue

■ Wed

■ Thu

■ Fri

■ Sat

■ Sun

The second string, Occurrence, specifies which occurrence in the month of that day to run the job. Valid values for Occurrence are:

■ First

■ Second

■ Third

■ Fourth

■ Last

For example, the strings, Tue and Third, specify the third Tuesday of the month.

OnceADayString. Optional. Specifies the time the job is to be run.

RepeatRepeat. Optional. Specifies how often the schedule is to be repeated.

Page 167: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 149

MoveFi le

MoveFileMoves files or folders to a new location. To move a single file or folder, specify Name or Id. To move a list of files or folders, specify NameList or IdList. To move files or folders that match the specified conditions, specify Search.

Elements TargetString. The new location for the file or folder. The following rules apply:

■ If Target is a file, the operation fails if the source contains a folder.

■ If the source is a folder and a folder with the same name exists in the target location, the operation fails.

■ If the source is a file and a file with an identical name exists in the target location, the existing file in the target location is versioned or replaced, depending on the setting of the ReplaceExisting tag. If the existing file has any dependencies, the file is not replaced regardless of the ReplaceExisting setting.

■ If Target is a folder that does not exist, a folder is created.

WorkingFolderNameString. The name of the working folder of the file or folder to move. Specify either WorkingFolderName or WorkingFolderId.

WorkingFolderIdString. The ID of the working folder of the file or folder to move. Specify either WorkingFolderId or WorkingFolderName.

RecursiveBoolean. Specifies whether to search subfolders. If True, the search includes subfolders. The default value is False.

SearchFileSearch. The search condition that specifies which folders or files to move.

IdListArrayOfString. The list of file or folder IDs to move. Specify either IdList or NameList.

NameList ArrayOfString. The list of file or folder names to move. Specify either NameList or IdList.

IdString. The ID of the single file or folder to move. Specify either Id or Name.

NameString. The name of the single file or folder to move. Specify either Name or Id.

Page 168: Actuate API Reference - OpenText

150 A c t u a t e A P I R e f e r e n c e

NameValuePair

ReplaceExistingBoolean. If True, the existing file, if one exists, is replaced. If the existing file has any dependencies, it is not replaced. If False or the existing file has any dependencies, the file is versioned. The default value is True.

MaxVersionsLong. The maximum number of versions to create. MaxVersions applies only if a file is moved. If a folder is moved, MaxVersions is ignored.

LatestVersionOnlyBoolean. Specifies whether all versions or only the latest version of the file is moved. Used only when a Search tag is specified. If True, only the latest version of the file is moved. The default value is False.

NameValuePairA complex data type that represents a named piece of data and its value.

Elements NameString. The name of the data.

ValueString. The value of the data. Value supports the null value.

NewFileA complex data type that describes a file.

Elements NameString. The name of the file.

VersionNameString. Optional. The version name of the file.

ReplaceExistingBoolean. Optional. Deprecated. Use Versioning instead of ReplaceExisting. Specifies whether to overwrite the latest existing version when uploading a file. If the existing file has any dependencies, BIRT iHub does not overwrite the file and creates a new version, regardless of the ReplaceExisting setting.

VersioningVersioningOption. Optional. Specifies what to do with the latest existing version when uploading a file. Valid values are:

■ CreateNewVersionAlways creates a new version. This is the default value.

Page 169: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 151

ObjectIdent i f ier

■ ReplaceLatestIfNoDependentsReplaces the latest existing version if it does not have any dependent files. If the existing version has any dependents, BIRT iHub creates a new version instead of replacing the existing version.

■ ReplaceLatestDropDependencyReplaces the latest existing version if it does not have any dependent files. If the existing version has any dependents, BIRT iHub drops the dependency.

■ ReplaceLatestMigrateDependencyReplaces the latest existing version if it does not have any dependent files. If the existing version has any dependents, BIRT iHub moves the dependency to the new version.

MaxVersionsLong. Optional. The maximum number of versions to keep in the volume.

DescriptionString. Optional. The description of the file.

ArchiveRuleArchiveRule. Optional. The autoarchive rules for the file.

ACLArrayOfPermission. Optional. The access rights to the file.

AccessTypeFileAccess. Optional. The file’s access type. Valid values are:

■ PrivateOnly the owner of the file and an administrator can access the file.

■ SharedAll users and user groups specified in the access control list (ACL) for the file can access the file.

ObjectIdentifierA complex data type that describes object identifiers.

Elements IdString. Optional. The ID of the object.

NameString. Optional. The name of the object.

TypeString. Optional. The object type.

Page 170: Actuate API Reference - OpenText

152 A c t u a t e A P I R e f e r e n c e

OpenServerOpt ions

VersionLong. Optional. The object version number.

OpenServerOptionsObsolete since iHub Release 2.

PageIdentifierA complex data type that describes page numbers.

Elements RangeString. Optional. A page range.

PageNumLong. Optional. A page number.

ViewModeInt. Optional. The page viewing mode.

ParameterDefinitionA complex data type that defines a report parameter.

Elements GroupString. Optional. The parameter group.

NameString. The parameter name.

PositionInt. Optional. The index location of the parameter in the information object (.iob) or data source map (.sma) file. The index is 1-based. For a regular parameter, do not specify a value or specify 0.

DataTypeString. Optional. The data type of the parameter. Valid values are:

■ Currency

■ Date

■ Double

■ Integer

■ String

Page 171: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 153

ParameterDefini t ion

■ Boolean

■ Structure Obsolete since Actuate Release 11

■ Table Obsolete since Actuate Release 11

DefaultValueString. Optional. The default value of the parameter.

IsRequiredBoolean. Optional. Specifies whether the parameter is required.

IsPasswordBoolean. Optional. Specifies whether a password is required.

IsHiddenBoolean. Optional. Specifies whether the parameter is hidden.

DisplayNameString. Optional. The display name of the parameter.

IsAdHocBoolean. Optional. Specifies whether the parameter is ad hoc.

ControlTypeString. Optional. The type of control used to represent the parameter. Valid values are:

■ AutoSuggestAn autosuggest control

■ ControlRadioButtonA radio button

■ ControlListA drop-down list

■ ControlListAllowNewA text box

■ ControlCheckBoxA check box

■ FilterSimpleA simple filter

■ FilterAdvancedAn advanced filter

SelectValueListArrayOfString. Optional. The list of available parameter values.

Page 172: Actuate API Reference - OpenText

154 A c t u a t e A P I R e f e r e n c e

ParameterDefini t ion

OperatorListArrayOfString. Optional. Contains the operators used with ad hoc parameters.

ColumnNameObsolete since iHub Release 2.

ColumnTypeObsolete since iHub Release 2.

RecordDefinitionObsolete since iHub Release 2.

DefaultTableValuesObsolete since iHub Release 2.

DataSourceTypeObsolete since iHub Release 2.

CascadingParentNameString. Optional. The cascading parent name for this parameter definition.

SelectNameValueListArrayOfNameValuePair. Optional. The list of names of available parameters.

HelpTextString. Optional. The text to display when the user holds the cursor over a parameter. For example, a value of a data column.

IsViewParameterBoolean. Optional. Whether the parameter is a view parameter. The default value is False.

IsDynamicSelectionListBoolean. Optional. Flag indicating whether the selection list is dynamic or static.

AutoSuggestThresholdInt. Optional. The minimum number of characters to be entered before the AutoSuggest selection list is displayed.

StartExpandedBoolean. Optional.

GroupPromptTextString. Optional.

DefaultValueIsNullBoolean. Optional. Flag indicating that the default value is null.

Page 173: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 155

ParameterValue

ParameterValueA complex data type that defines the value of a report parameter.

Elements GroupString. Optional. The parameter group.

NameString. The parameter name.

DisplayNameString. Optional. The label or display name for the parameter that appears in the user interface.

PositionInt. Optional. The index location of the parameter in the information object (.iob) or data source map (.sma) file. The index is 1-based. For a regular parameter, do not specify a value or specify 0.

ValueString. Optional. The parameter value.

ValueIsNullBoolean. Optional. A flag indicating a null value.

PromptParameterBoolean. Optional. Allows the user to select the parameter.

TableValueObsolete since iHub Release 2.

DataSourceTypeObsolete since iHub Release 2.

IsViewParameterBoolean. Optional. Specifies whether the parameter is a view parameter.

The parameters listed in Table 3-4 are available to set the properties of a spreadsheet file created by running a BIRT report as a job:

Table 3-4 Excel spreadsheet output options

Parameter NameString value data type Applies to Description

$$$AC_CONVERSION_OPTION_rptdesign_XLS_PageRange

String Design Pages to export to excel. Use a single value, a comma-separated list, or a range specified by two numbers separated by a hyphen.

(continues)

Page 174: Actuate API Reference - OpenText

156 A c t u a t e A P I R e f e r e n c e

ParameterValue

$$$AC_CONVERSION_OPTION_rptdesign_XLS_excelRenderOption.wrappingText

Boolean Design Whether to wrap the text contents of cells. Use "true" to wrap, "false" to not wrap.

$$$AC_CONVERSION_OPTION_rptdesign_XLS_excelRenderOption.EnablePivotTable

Boolean Design Whether to export a cross tab as a pivot table. Use "true" to export a pivot table, "false" to export values in normal cells.

$$$AC_CONVERSION_OPTION_rptdesign_XLS_ChartDpi

Integer Design The dots per inch (dpi) used to display a chart as an image.

$$$AC_CONVERSION_OPTION_rptdocument_XLS_ChartDpi

Integer Document The dots per inch (dpi) used to display a chart as an image.

$$$AC_CONVERSION_OPTION_rptdesign_XLS_excelRenderOption.ExportChartsAsImages

Boolean Design Whether to export charts as images or live charts. Use "true" to export charts as images, "false" to export charts as live charts.

$$$AC_CONVERSION_OPTION_rptdesign_XLS_excelRenderOption.hideGridlines

Boolean Design Whether to hide the grid lines in the spreadsheet. Use "true" to hide the grid lines, "false" to display the grid lines.

$$$AC_CONVERSION_OPTION_rptdesign_XLS_excelRenderOption.multipleSheet

Boolean Design Whether to export the report in multiple sheets or a single sheet. Use "true" to create multiple sheets, "false" to create a single sheet.

$$$AC_CONVERSION_OPTION_rptdocument_XLS_excelRenderOption.multipleSheet

Boolean Document Whether to export the report in multiple sheets or a single sheet. Use "true" to create multiple sheets, "false" to create a single sheet.

$$$AC_CONVERSION_OPTION_rptdesign_XLS_excelRenderOption.AutoFitPivotTable

Boolean Boolean Whether to adjust the widths of pivot table columns to fit the content. Use "true" to adjust pivot table column widths, "false" to use the default column width.

Table 3-4 Excel spreadsheet output options (continued)

Parameter NameString value data type Applies to Description

Page 175: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 157

ParameterValue

Use code similar to the following lines to use these options:

NewFile requestedOutputFile = new NewFile();requestedOutputFile.setName(outputFileName);

ArrayOfParameterValue parameterValues = new ArrayOfParameterValue();

parameterValues.setParameterValue(new ParameterValue[] {actuateControl.newParameterValue("$$$AC_CONVERSION_OPTION_rptde

sign_XLS_PageRange", "2-3"),actuateControl.newParameterValue("$$$AC_CONVERSION_OPTION_rptde

sign_XLS_excelRenderOption.wrappingText", "false"),actuateControl.newParameterValue("$$$AC_CONVERSION_OPTION_rptde

sign_XLS_excelRenderOption.EnablePivotTable", "false"),actuateControl.newParameterValue("$$$AC_CONVERSION_OPTION_rptde

sign_XLS_ChartDpi", "96"), actuateControl.newParameterValue("$$$AC_CONVERSION_OPTION_rptde

sign_XLS_excelRenderOption.ExportChartsAsImages", "false"),actuateControl.newParameterValue("$$$AC_CONVERSION_OPTION_rptde

sign_XLS_excelRenderOption.hideGridlines", "false"), actuateControl.newParameterValue("$$$AC_CONVERSION_OPTION_rptde

sign_XLS_excelRenderOption.AutoFitPivotTable", "false"), actuateControl.newParameterValue("$$$AC_CONVERSION_OPTION_rptde

sign_XLS_excelRenderOption.multipleSheet", "true"), });

com.actuate.schemas.SubmitJob submitJob = new com.actuate.schemas.SubmitJob();

submitJob.setJobName("Sample Report");submitJob.setHeadline("IDAPI Course");submitJob.setInputFileName(inputFileName);submitJob.setRequestedOutputFile(requestedOutputFile);submitJob.setSchedules(null);submitJob.setParameterValues(parameterValues);submitJob.setOperation(SubmitJobOperation.RunReport);SubmitJobResponse submitJobResponse = null;submitJobResponse = actuateControl.proxy.submitJob(submitJob);

$$$AC_CONVERSION_OPTION_rptdesign_XLS_excelRenderOption.EnableLiveFormula

Boolean Boolean Whether to export aggregations and computed columns as live formulas or a number. Use "true" to export these values as live formulas, "false" to export numbers only.

Table 3-4 Excel spreadsheet output options (continued)

Parameter NameString value data type Applies to Description

Page 176: Actuate API Reference - OpenText

158 A c t u a t e A P I R e f e r e n c e

PendingSyncJob

PendingSyncJobA complex data type that describes a job in the queue waiting for Factory processing.

Elements ConnectionHandleBase64Binary. An optional element that supports keeping a connection open to view a persistent report. If ConnectionHandle is present in the SOAP header, the system routes subsequent viewing requests to the same View service that returned the ConnectionHandle. If present, BIRT iHub System ignores the value of TargetVolume.

ObjectIdString. The ID of the synchronous report for which to retrieve information.

IsTransientBoolean. True if the synchronous report is transient, False if the synchronous report is persistent.

VolumeString. The volume on which the job originated.

ServerNameString. Optional. The node on which the job is pending.

OwnerString. Optional. The name of the user who submitted the job.

ExecutableFileNameString. Optional. The fully qualified name of the report executable file.

ExecutableVersionNumberLong. Optional. The fully qualified version number of the report executable file.

ExecutableVersionNameString. Optional. The fully qualified version name of the report executable file.

SubmissionTimeDateTime. Optional. The time at which the job was submitted to the server.

PendingTimeLong. Optional. The number of seconds elapsed since the job entered the queue.

QueueTimeoutLong. Optional. The number of seconds remaining before the job is deleted from the queue.

QueuePositionLong. Optional. The job’s position in the queue.

Page 177: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 159

Permission

PermissionA complex data type that describes a user or user group’s privileges.

Elements RoleNameDeprecated since iHub Release 3. Replaced by UserGroupName.

UserGroupNameString. Optional. The user group name. Specify this value or UserName.

UserNameString. Optional. The user name. Specify this value or UserGroupName.

RoleIdDeprecated since iHub Release 3. Replaced by UserGroupId.

UserGroupIdString. Optional. The user group ID. Specify this value or UserId.

UserIdString. Optional. The user ID. Specify this value or UserGroupId.

AccessRightString. The privileges the user or user group has on an object. One or more of the following characters representing a privilege:

■ D—Delete

■ E—Execute

■ G—Grant

■ V—Visible

■ S—Secured Read

■ R—Read

■ W—Write

PrinterA complex data type that describes a printer.

Elements NameString. Optional. The name of the printer. Cannot exceed 50 characters.

ManufacturerString. Optional. The manufacturer of the printer.

Page 178: Actuate API Reference - OpenText

160 A c t u a t e A P I R e f e r e n c e

Pr inter

ModelString. Optional. The model of the printer.

LocationString. Optional. The location of the printer.

DescriptionString. Optional. The description of the printer.

SupportOrientationBoolean. Optional. Specifies whether the printer supports setting paper orientation.

OrientationString. Optional. The setting of the printer’s orientation property.

OrientationOptionsArrayOfString. Optional. The setting of the printer’s orientation options.

SupportPageSizeBoolean. Optional. Specifies whether page size can be set on the printer.

PageSizeString. Optional. The setting of the printer’s page size property.

PageSizeOptionsArrayOfString. Optional. The page sizes the printer supports.

SupportScaleBoolean. Optional. Specifies whether the printer supports setting the scaling factor.

ScaleLong. Optional. The setting of the printer’s scaling factor.

ScaleOptionsArrayOfInt. Optional. The setting of the printer’s scaling options.

SupportResolutionBoolean. Optional. Specifies whether the printer supports setting the resolution.

ResolutionString. Optional. The setting of the printer’s resolution property.

ResolutionOptionsThe setting of the printer’s resolution options.

SupportNumberOfCopiesBoolean. Optional. Specifies whether the printer supports setting the number of copies.

Page 179: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 161

PrinterOptions

NumberOfCopiesLong. Optional. The setting of the number of copies property.

SupportCollationBoolean. Optional. Specifies whether the printer supports setting the collation.

CollationBoolean. Optional. The setting of the printer’s collation property.

SupportPaperTrayBoolean. Optional. Specifies whether the printer supports setting the paper tray.

PaperTrayString. Optional. The setting of the printer’s paper tray property.

PaperTrayOptionsArrayOfString. Optional. The setting of the printer’s paper tray options.

SupportDuplexBoolean. Optional. Specifies whether the printer supports duplex printing.

DuplexString. Optional. The setting of the printer’s duplex property.

DuplexOptionsArrayOfString. Optional. The setting of the printer’s duplex options.

SupportColorModeBoolean. Optional. Specifies whether the printer supports printing in color.

ColorModeString. Optional. The setting of the printer’s color mode property.

ColorModeOptionsArrayOfString. Optional. The setting of printer’s color mode options.

StatusString. Optional. Indicates printer’s availability.

PrinterOptionsA complex data type that describes printer options.

Elements PrinterNameString. The name of the printer.

OrientationString. Optional. The paper orientation.

Page 180: Actuate API Reference - OpenText

162 A c t u a t e A P I R e f e r e n c e

Pr ivi legeFi l ter

PageSizeString. Optional. The page size.

ScaleLong. Optional. The scaling factor.

ResolutionString. Optional. The resolution.

NumberOfCopiesLong. Optional. The number of copies.

CollationOptionBoolean. Optional. Turns collation on and off.

PaperTrayString. Optional. The paper tray.

DuplexString. Optional. Sets duplex printing.

IsColorBoolean. Optional. Specifies whether the printer can print in color.

IsDefaultPrinterBoolean. Optional. Specifies whether the printer is the default printer.

PrivilegeFilterA complex data type that represents a privilege filter. Use PrivilegeFilter to retrieve only the data accessible to user groups or users with the specified privileges and to determine whether a user or user group has the specified privileges on an item.

Elements GrantedUserNameString. Optional. The name of the user privileges to retrieve. Specify one of this value, GrantedUserId, GrantedUserGroupId, or GrantedUserGroupName.

GrantedUserIdString. Optional. The ID of the user privileges to retrieve. Specify one of this value, GrantedUserName, GrantedUserGroupId, or GrantedUserGroupName.

GrantedRoleNameDeprecated since iHub Release 3. Replaced by GrantedUserGroupName.

GrantedRoleIdDeprecated since iHub Release 3. Replaced by GrantedUserGroupId.

Page 181: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 163

PropertyValue

GrantedUserGroupNameString. Optional. The name of the user group whose privileges to retrieve. Specify one of this value, GrantedUserName, GrantedUserId, or GrantedUserGroupId.

GrantedUserGroupIdString. Optional. The ID of the user group privileges to retrieve. Specify one of this value, GrantedUserName, GrantedUserId, or GrantedUserGroupName.

AccessRightsString. The privileges.

PropertyValueA complex data type that specifies a name-value pair.

Elements NameString. The name of the property.

ValueString. Optional. The value of the property.

RangeObsolete since Actuate Release 11.

RepeatA complex data type that describes how often a job run is to be repeated.

Elements StartTimeString. The time that the job is to start repeatedly running.

EndTimeString. The time that the job is to no longer run.

IntervalInSecondsLong. The time to wait between job runs.

RecordObsolete since Actuate Release 11.

Page 182: Actuate API Reference - OpenText

164 A c t u a t e A P I R e f e r e n c e

ReportParameterType

ReportParameterTypeA simple data type that describes parameter types.

Element String. One of the following values:

ExecutionAn execution parameter

ViewA view parameter.

AllAn all parameter type.

ResourceGroupA complex data type the describes a resource group.

Elements NameString. The name of the resource group.

DisabledBoolean. Optional. Specifies whether the resource group can run jobs. If True, resource group does not run jobs. The default value is False.

DescriptionString. Optional. The description of the resource group.

TypeString. Optional. The type of jobs the resource group runs. Valid values are:

■ SyncThe resource group runs synchronous jobs.

■ AsyncThe resource group runs asynchronous jobs.

ReportTypeString. Optional. The type of report the resource group creates.

VolumeString. Optional. The name of a volume to which to assign the resource group. Valid values are:

■ An empty stringAssigns all volumes on the BIRT iHub

Page 183: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 165

ResourceGroupSett ings

■ A volume nameAssigns the specified volume

MinPriorityLong. Optional. Applies only to an asynchronous resource group. Specifies the minimum priority for the resource group. Valid values are 0–1,000, where 1, 000 is the highest priority. MinPriority must be less than MaxPriority. The default value is 0.

MaxPriorityLong. Optional. Applies only to an asynchronous resource group. Specifies the maximum priority for the resource group. Valid values are 0–1,000, where 1, 000 is the highest priority. MaxPriority must be more than MinPriority. The default value is 1,000.

ReservedBoolean. Optional. Applies only to a synchronous resource group. True reserves the resource group to run only the jobs assigned to it. Use the TargetResourceGroup element in the SOAP header of an ExecuteReport request to assign a job.

StartArgumentsString. Optional. The starting arguments for the resource group.

WorkUnitTypeString. Optional. The license option type. An aggregate licensing model that defines iHub System features in terms of work units.

ResourceGroupSettingsA complex data type that describes the settings of a resource group.

Elements TemplateNameString. The name of the BIRT iHub template on which the resource group runs.

ActivateBoolean. Optional. Specifies whether the BIRT iHub is a member of the resource group. If True, the BIRT iHub is a member of the resource group. The default value is False.

MaxFactoryInt. Optional. The maximum number of Factory processes available to the resource group.

MinFactoryInt. Optional. The minimum number of Factory processes available to the resource group.

Page 184: Actuate API Reference - OpenText

166 A c t u a t e A P I R e f e r e n c e

ResultSetSchema

FileTypesArrayOfString. Optional. The file types the resource group can run.

StartArgumentsString. Optional. The starting arguments for the resource group.

ResultSetSchemaA complex data type that describes the result set schema.

Elements ResultSetNameString. Optional. Name of the result set.

ResultSetDisplayNameString. Optional. The display name of the result set. If not specified, the value of the Name element is used. If the query is performed on an information object (.iob) or data source map (.sma) file, DisplayName is used as the group label.

ArrayOfColumnSchemaArrayOfColumnSchema. Optional. An array of ColumnSchema objects.

RetryOptionsA complex data type that describes how to retry report generation or printing jobs that have failed.

Elements RetryOptionRetryOptionType. The retry options.

MaxRetryCountLong. Optional. The maximum number or retry attempts.

RetryIntervalLong. Optional. The interval between retry attempts. Measured in seconds.

RetryOptionTypeA simple data type that describes a retry option for failed jobs.

Element String. One of the following values:

DisabledSpecifies not to retry the job.

Page 185: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 167

Role

VolumeDefaultSpecifies using the default retry options for the volume.

SpecifiedSpecifies using the retry option defined on the job itself.

RoleDeprecated since iHub Release 3. Replaced by UserGroup.

RoleConditionDeprecated since iHub Release 3. Replaced by UserGroupCondition.

RoleFieldDeprecated since iHub Release 3. Replaced by UserGroupField.

RoleSearchDeprecated since iHub Release 3. Replaced by UserGroupSearch.

RunningJobA complex data type that describes a job the Factory is currently processing.

Elements IsSyncJobBoolean. Specifies whether the job is synchronous. True if the job is synchronous, False if the job is asynchronous.

ConnectionHandleBase64Binary. Optional. An element that supports keeping a connection open to view a persistent report. If ConnectionHandle is present in the SOAP header, the system routes subsequent viewing requests to the same View service that returned the ConnectionHandle. If present, BIRT iHub System ignores the value of TargetVolume.

ObjectIdString. Optional. The ID of the synchronous report for which to retrieve information.

Page 186: Actuate API Reference - OpenText

168 A c t u a t e A P I R e f e r e n c e

RunningJob

IsTransientBoolean. Optional. Specifies whether the synchronous report is transient. True if the synchronous report is transient, False if the synchronous report is persistent.

IsProgressiveBoolean. Optional. Specifies whether progressive viewing is enabled. True if progressive viewing is enabled.

JobIdString. Optional. The ID of the asynchronous job.

VolumeString. Optional. The volume on which the job originated.

ServerNameString. Optional. The node on which the job is running.

OwnerString. Optional. The name of the user who submitted the job.

ExecutableFileNameString. Optional. The fully qualified name of the executable file.

ExecutableVersionNumberLong. Optional. The version number of the executable file.

ExecutableVersionNameString. Optional. The version name of the executable file.

ResourceGroupString. Optional. The resource group for the job.

SubmissionTimeDateTime. Optional. The time at which the job was submitted to the server.

StartTimeDateTime. Optional. The time at which job execution started.

RunningTimeLong. Optional. The time elapsed since job execution started.

ExecutionTimeoutLong. Optional. The number of seconds remaining before job execution times out. The number is always zero (infinite) for asynchronous reports.

IsSyncFactoryBoolean. Optional. Specifies whether the Factory is running synchronous jobs. True if the Factory is running synchronous jobs, False if the Factory is running asynchronous jobs.

Page 187: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 169

ScalarDataType

FactoryPidLong. Optional. The process ID of the Factory.

ScalarDataTypeA simple data type that specifies a scalar parameter.

Element String. One of the following values:

CurrencyA Currency parameter.

DateA Date parameter.

DateOnlyA DateOnly parameter.

TimeA Time parameter.

DoubleA Double parameter.

IntegerAn Integer parameter.

StringA String parameter.

BooleanA Boolean parameter.

SearchReportByIdListObsolete since iHub Release 2.

SearchReportByIdNameListObsolete since iHub Release 2.

Page 188: Actuate API Reference - OpenText

170 A c t u a t e A P I R e f e r e n c e

SearchReportByNameList

SearchReportByNameListObsolete since iHub Release 2.

SearchResultPropertyObsolete since iHub Release 2.

ServerInformationA complex data type that describes a BIRT iHub.

Elements ServerNameString. The name of the BIRT iHub.

ServerStatusInformationServerStatusInformation. Optional. The status of the BIRT iHub. Valid values are:

■ ServerState

■ SystemType

■ StatusErrorCode

■ StatusErrorDescription

ServiceListArrayOfService. The list of available services.

OwnsVolumeBoolean. Optional. True if there are any volumes on the BIRT iHub, False otherwise.

DescriptionString. Optional. The description of the BIRT iHub.

ServerVersionInformationServerVersionInformation. The following information about the BIRT iHub version:

■ ServerVersion

■ ServerBuild

■ OSVersion

Page 189: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 171

ServerResourceGroupSett ing

ChangesPendingString. Optional. Server configuration has changed and the BIRT iHub or the system must be restarted for the changes to take effect.

NodeLockViolationBoolean. Optional. Specifies whether a licensing node-lock violation exists. The default value is False.

NodeLockViolationExpirationDateString. Optional. The date on which the grace period for a node-lock violation expires and the node lock takes effect. Contact Actuate Licensing about a node-lock licensing problem.

TemplateNameString. The name of the BIRT iHub configuration template.

ServerIPAddressString. Optional. The IP address or host name of the BIRT iHub.

PmdPortNumberInt. Optional. The port where the Process Management Daemon (PMD) listens.

LocalServerBoolean. Optional. Specifies whether the BIRT iHub is running on the local machine.

ServerResourceGroupSettingA complex data type that describes the settings of a resource group available to a BIRT iHub.

Elements ResourceGroupNameString. The name of the resource group.

ActivateBoolean. Optional. Specifies whether the BIRT iHub is a member of the resource group. If True, the BIRT iHub is a member of the resource group. The default value is False.

TypeString. Optional. The type of jobs the resource group runs. Valid values are:

■ SyncThe resource group runs synchronous jobs.

■ AsyncThe resource group runs asynchronous jobs.

Page 190: Actuate API Reference - OpenText

172 A c t u a t e A P I R e f e r e n c e

ServerState

MaxFactoryInt. Optional. The maximum number of Factory processes available to the resource group.

MinFactoryInt. Optional. The minimum number of Factory processes available to the resource group.

FileTypesArrayOfString. Optional. The file types the resource group can run.

StartArgumentsString. Optional. The list of arguments used when starting a resource group process. For example, the Default Java Async resource group uses the following arguments:-Xmx256M -Djava.awt.headless=true

-Djava.protocol.handler.pkgs=com.actuate.javaserver.protocol com.actuate.javaserver.Server

ServerStateA simple data type that describes the state of Actuate iHub.

Element String. One of the following values:

OFFLINEThe server is offline.

STARTINGThe server is starting.

ONLINEThe server is online.

STOPPINGThe server is stopping.

FAILEDThe server failed.

ServerStatusInformationA complex data type that describes the status of an Actuate iHub.

Page 191: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 173

ServerVersionInformation

Elements ServerStateServerState. The state of the Actuate iHub. Valid values are:

■ OFFLINE

■ STARTING

■ ONLINE

■ STOPPING

■ FAILED

SystemTypeSystemType. The type of Actuate iHub, cluster or stand-alone.

ServerStateErrorCodeLong. Optional. The code of the error if status is Failed.

ServerStateErrorDescriptionString. Optional. The description of the error if status is Failed.

ServerVersionInformationA complex data type that describes the version of an Actuate iHub.

Elements ServerVersionString. The version of the Actuate iHub.

ServerBuildString. The build number of the Actuate iHub.

OSVersionString. The version of the operating system.

ServiceA simple data type that represents a service.

Element String. One of the following values:

RequestA Message Distribution service (MDS).

ViewingA View service.

GenerationA Factory service.

Page 192: Actuate API Reference - OpenText

174 A c t u a t e A P I R e f e r e n c e

Short

CachingA Caching service.

IntegrationAn Integration service.

ShortShort is a standard XML short data type, which is a signed 16-bit integer, ranging in value from –32,768 to 32,767.

SortColumnObsolete since iHub Release 2.

StreamA complex data type that represents a streamed image.

Elements NameThe name of the image.

EmbeddedPropertySpecifies whether the image is embedded.

StringString is a standard XML String data type that represents character data.

SystemTypeA simple data type that describes the type of BIRT iHub System.

Element String. One of the following values:

ClusterA cluster system.

StandaloneA stand-alone system.

Page 193: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 175

SupportedQueryFeatures

SupportedQueryFeaturesObsolete since iHub Release 2.

TimeTime is a standard XML Time data type that displays time in the format hh:mm:ss.sss with an optional time zone indicator. For example, 13:20:00-05:00 indicates 1:20 p.m. Eastern Standard Time, which is five hours behind Coordinated Universal Time (UTC).

TransactionA packaging mechanism for Administrate operations. If a failure occurs anywhere in a transaction, all operations in the transaction fail.

Elements TransactionOperationThe transaction operation.

TransactionOperationControls the ability to create, delete, update, copy, and move items within a volume. A TransactionOperation represents a single unit of work within a Transaction. Only a volume administrator or a user in the Administrator user group uses these operations.

Elements One or more of the following elements:

CreateUserCreates a user in the volume.

DeleteUserDeletes one or more users.

UndeleteUserUndeletes one or more users.

UpdateUserUpdates user properties in the volume.

CreateGroupObsolete since iHub Release 3.

Page 194: Actuate API Reference - OpenText

176 A c t u a t e A P I R e f e r e n c e

Transact ionOperat ion

DeleteGroupObsolete since iHub Release 3.

UpdateGroupObsolete since iHub Release 3.

CreateChannelObsolete since iHub Release 3.

DeleteChannelObsolete since iHub Release 3.

UpdateChannelObsolete since iHub Release 3.

CreateRoleDeprecated since iHub Release 3. Replaced by CreateUserGroup.

DeleteRoleDeprecated since iHub Release 3. Replaced by DeleteUserGroup.

UpdateRoleDeprecated since iHub Release 3. Replaced by UpdateUserGroup.

CreateUserGroupCreates a user group in a volume.

DeleteUserGroupDeletes one or more user groups.

UpdateUserGroupUpdates user group properties in the volume.

CreateFileTypeCreates a new file type in the volume.

DeleteFileTypeDeletes a file type from the volume.

UpdateFileTypeUpdates file type properties in the volume.

CreateFolderCreates a folder in a volume.

DeleteFileDeletes files or folders from the volume.

MoveFileMoves a file or folder from the working directory to a specified target directory in the volume.

Page 195: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 177

TypeName

CopyFileCopies a file or folder in the working directory to a specified target directory.

UpdateFileUpdates file or folder properties in the volume.

DeleteJobDeletes one or more jobs.

DeleteJobNoticesDeletes one or more job notices.

DeleteJobScheduleDeletes a job schedule.

UpdateJobScheduleUpdates a job schedule.

UpdateVolumePropertiesUpdates the properties of a specific volume.

UpdateOpenSecurityCacheFlushes the volume’s open security cache and retrieves new data from an external security source.

TypeNameA simple data type that describes names of data types.

Element String. One of the following values:

intAn integer value.

shtA short value.

dblA double value.

dbnAn Actuate double value.

curA currency value.

dtmAn date-and-time value.

Page 196: Actuate API Reference - OpenText

178 A c t u a t e A P I R e f e r e n c e

UndeleteUser

strA string value.

blnA Boolean value.

nllThe null value.

UndeleteUserUndeletes users, reversing a DeleteUser operation within the unit of work of an AdminOperation. To undelete a single user, specify Id. To delete several users, specify IdList.

Elements IdListArrayOfString. The list of user IDs to undelete.

IdString. The ID of the single user to undelete.

IgnoreMissingBoolean. Specifies what to do if the specified user does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.

UpdateChannelObsolete since iHub Release 3.

UpdateChannelOperationObsolete since iHub Release 3.

UpdateChannelOperationGroupObsolete since iHub Release 3.

Page 197: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 179

UpdateFile

UpdateFileUpdates files or folders. To update files or folders, specify the types of updates to make using UpdateFileOperationGroup, then specify which files or folders to update.

To update the properties of a file or folder, you must have the write privilege on the file or folder. To update privileges to the file or folder, you must have the grant privilege on the file or folder.

To update a single file or folder, specify Name or Id. To update a list of files or folders, specify NameList or IdList. To update files or folders matching the specified conditions, specify Search.

Elements WorkingFolderIdString. The ID of the working folder of the file or folder to update. Specify either WorkingFolderId or WorkingFolderName.

WorkingFolderNameString. The name of the working folder of the file or folder to update. Specify either WorkingFolderName or WorkingFolderId.

LatestVersionOnlyBoolean. Specifies whether to search all versions of the file. If True, the search includes only the latest version. The default value is False.

RecursiveBoolean. Specifies whether to search subfolders. If True, the search includes subfolders. The default value is False.

UpdateFileOperationGroupSpecifies the group criteria used to perform the update file operation task:

■ SearchFileSearch. The search conditions. If conditions apply to multiple fields, use ConditionArray.

■ NameListArrayOfString. The list of file or folder names to update. Specify either NameList or IdList.

■ IdListArrayOfString. The list of file or folder IDs to update. Specify either IdList or NameList.

■ IdString. The ID of the single file or folder to update. Specify either Id or Name.

Page 198: Actuate API Reference - OpenText

180 A c t u a t e A P I R e f e r e n c e

UpdateFi leOperat ion

■ NameString. The name of the single file or folder to update. Specify either Name or Id.

IgnoreMissingBoolean. Specifies what to do if the specified file or folder does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.

UpdateFileOperationSpecifies the tasks to perform during the UpdateFile operation. To specify which files to update, use UpdateFile.

Elements SetAttributesFile. The general attributes to update.

AddDependentFilesByNameArrayOfString. The names of files to add as dependents. Specify either AddDependentFilesByName or AddDependentFilesById.

RemoveDependentFilesByNameArrayOfString. The names of dependent files to remove. Specify either RemoveDependentFilesByName or RemoveDependentFilesById.

SetDependentFilesByNameArrayOfString. The names of dependent files to update. Specify either SetDependentFilesByName or SetDependentFilesById.

AddRequiredFilesByNameArrayOfString. The names of required files to add. Specify either AddRequiredFilesByName or AddRequiredFilesById.

RemoveRequiredFilesByNameArrayOfString. The names of required files to remove. Specify either RemoveRequiredFilesByName or RemoveRequiredFilesById.

SetRequiredFilesByNameArrayOfString. The names of required files to update. Specify either SetRequiredFilesByName or SetRequiredFilesById.

AddDependentFilesByIdArrayOfString. The IDs of files to add as dependents. Specify either AddDependentFilesById or AddDependentFilesByName.

RemoveDependentFilesByIdArrayOfString. The IDs of dependent files to remove. Specify either RemoveDependentFilesById or RemoveDependentFilesByName.

Page 199: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 181

UpdateFi leOperat ionGroup

SetDependentFilesByIdArrayOfString. The IDs of dependent files to update. Specify either SetDependentFilesById or SetDependentFilesByName.

AddRequiredFilesByIdArrayOfString. The IDs of required files to add. Specify either AddRequiredFilesById or AddRequiredFilesByName.

RemoveRequiredFilesByIdArrayOfString. The IDs of required files to remove. Specify either RemoveRequiredFilesById or RemoveRequiredFilesByName.

SetRequiredFilesByIdArrayOfString. The IDs of required files to update. Specify either SetRequiredFilesById or SetRequiredFilesByName.

GrantPermissionsArrayOfPermission. The new privileges to grant. You cannot grant privileges to a file with private access.

RevokePermissionsArrayOfPermission. The privileges to revoke. You cannot revoke privileges to a file with private access.

SetPermissionsArrayOfPermission. The privileges to update. You cannot update privileges to a file with private access.

AddArchiveRulesArrayOfArchiveRule. The new autoarchive rules.

RemoveArchiveRulesArrayOfArchiveRule. The autoarchive rules to remove.

SetArchiveRulesArrayOfArchiveRule. The autoarchive rules to update.

SetParameterDefinitionsArrayOfParameterDefinition. The dynamic report parameters for third-party executable files.

UpdateFileOperationGroupSpecifies the UpdateFileOperation element within UpdateFile.

Element UpdateFileOperationThe UpdateFileOperation element to use during the UpdateFile operation.

Page 200: Actuate API Reference - OpenText

182 A c t u a t e A P I R e f e r e n c e

UpdateFi leType

UpdateFileTypeUpdates file types. To update file types, specify the types of updates to make using UpdateFileTypeOperationGroup, then specify which file types to update.

To update a single file type, specify Name or Id. To update a list of file types, specify NameList or IdList.

Elements UpdateFileTypeOperationGroupThe tasks to perform.

NameListArrayOfString. The list of file types to update.

NameString. The name of a single file type to update.

IgnoreMissingBoolean. Specifies what to do if the specified file type does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.

IgnoreDupBoolean. Specifies whether to report an error for a duplicate request. BIRT iHub always rejects a duplicate request regardless of the IgnoreDup setting. If True, BIRT iHub does not report an error. In a name list or ID list, True prevents BIRT iHub from performing duplicate operations. If False, BIRT iHub reports an error. The default value is False.

UpdateFileTypeOperationSpecifies the tasks to perform during the UpdateFileType operation.

Elements SetAttributesFileType. The general attributes to update.

SetParameterDefinitionsArrayOfParameterDefinition. The parameters to update.

SetWindowsIconBase64Binary. The Windows icon to display for the file type.

SetLargeWebIconBase64Binary. The large icon to display for the file type in a browser.

SetSmallWebIconBase64Binary. The small icon to display for the file type in a browser.

Page 201: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 183

UpdateFi leTypeOperat ionGroup

UpdateFileTypeOperationGroupSpecifies the UpdateFileTypeOperation element to use during the UpdateFileType operation.

Element UpdateFileTypeOperationThe UpdateFileTypeOperation element to use in the UpdateFileType operation.

UpdateGroupObsolete since iHub Release 3.

UpdateGroupOperationObsolete since iHub Release 3.

UpdateGroupOperationGroupObsolete since iHub Release 3.

UpdateJobScheduleUpdates job schedules. To update scheduled jobs, specify the types of updates to make using UpdateJobScheduleOperationGroup, then specify which jobs to update.

To update a single scheduled job, specify Id. To update a list of scheduled jobs, specify IdList. To update scheduled jobs matching the specified conditions, specify Search.

Elements UpdateJobScheduleOperationGroupThe tasks to perform.

SearchJobScheduleSearch. The search conditions. If conditions apply to multiple fields, use ConditionArray.

IdListArrayOfString. The list of job IDs to update.

Page 202: Actuate API Reference - OpenText

184 A c t u a t e A P I R e f e r e n c e

UpdateJobScheduleOperat ion

IdString. The ID of a single job to update.

IgnoreMissingBoolean. Specifies what to do if the specified job does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.

UpdateJobScheduleOperationSpecifies the tasks to perform during the UpdateJobSchedule operation.

Elements SetAttributesJobProperties. The general attributes to update.

SetParametersJobInputDetail. The input parameters, output parameters, autoarchive settings, and distribution location settings to update.

SetPrinterOptionsJobPrinterOptions. The printer options to update.

SetSchedulesJobSchedule. The schedules to set.

AddUserNotificationByNameArrayOfString. The name of the user to add to the notification list. Specify either AddUserNotificationByName or AddUserNotificationById.

RemoveUserNotificationByNameArrayOfString. The name of the user to remove from the notification list. Specify either RemoveUserNotificationByName or RemoveUserNotificationById.

SetUserNotificationByNameArrayOfString. The name of the user for whom to update notification. Specify either SetUserNotificationByName or SetUserNotificationById.

AddGroupNotificationByNameObsolete since iHub Release 3.

RemoveGroupNotificationByNameObsolete since iHub Release 3.

SetGroupNotificationByNameObsolete since iHub Release 3.

AddChannelNotificationByNameObsolete since iHub Release 3.

Page 203: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 185

UpdateJobScheduleOperat ion

RemoveChannelNotificationByNameObsolete since iHub Release 3.

SetChannelNotificationByNameObsolete since iHub Release 3.

AddUserNotificationByIdArrayOfString. The ID of the user to add to the notification list. Specify either AddUserNotificationById or AddUserNotificationByName.

RemoveUserNotificationByIdArrayOfString. The ID of the user to remove from the notification list. Specify either RemoveUserNotificationById or RemoveUserNotificationByName.

SetUserNotificationByIdArrayOfString. The ID of the user for whom to update notification. Specify either SetUserNotificationById or SetUserNotificationByName.

AddGroupNotificationByIdObsolete since iHub Release 3.

RemoveGroupNotificationByIdObsolete since iHub Release 3.

SetGroupNotificationByIdObsolete since iHub Release 3.

AddChannelNotificationByIdObsolete since iHub Release 3.

RemoveChannelNotificationByIdObsolete since iHub Release 3.

SetChannelNotificationByIdObsolete since iHub Release 3.

AddOutputFilePermissionsArrayOfPermission. The output file permissions to add. You cannot add file permissions to a file with private access.

RemoveOutputFilePermissionsArrayOfPermission. The output file permissions to remove. You cannot remove file permissions from a file with private access.

SetOutputFilePermissionsArrayOfPermission. The output file permissions to update. You cannot update file permissions of a file with private access.

SetParameterValuesArrayOfParameterValue. The parameter values to update.

Page 204: Actuate API Reference - OpenText

186 A c t u a t e A P I R e f e r e n c e

UpdateJobScheduleOperat ionGroup

SetQueryObsolete since iHub Release 3.

SetOutputFileAccessFileAccess. The access rights to the output file to update. Valid values are:

■ PrivateOnly the owner of the file and an administrator can access the file.

■ SharedAll users and user groups specified in the access control list (ACL) for the file can access the file.

SetWaitForEventEvent. The event to set that is being waited on. When set, processes that are waiting for this event will proceed.

UpdateJobScheduleOperationGroupSpecifies the UpdateJobScheduleOperation element within the UpdateJobSchedule operation.

Element UpdateJobScheduleOperationThe UpdateJobScheduleOperation element for use with the UpdateJobSchedule operation.

UpdateOpenSecurityCacheFlushes the volume’s open security cache and retrieves new data from the external security source. Use UpdateOpenSecurityCache when information in the external data source has changed and must be updated immediately.

In the request, specify the list of users, user groups, and translated user or user group names to update. If no users, user groups, or translated names are specified, all users, user groups, and translated names are updated. Otherwise, only the specified items are updated.

Elements UserNameListArrayOfString. The list of user names to retrieve.

GroupListObsolete since iHub Release 3.

RoleListDeprecated since iHub Release 3. Replaced by UserGroupList.

Page 205: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 187

UpdateRole

UserGroupListArrayOfString. The list of user groups to retrieve.

TranslatedUserNamesExternalTranslatedUserNames. The translated user names to retrieve, such as Administrator.

TranslatedRoleNamesDeprecated since iHub Release 3. Replaced by TranslatedUserGroupNames.

TranslatedUserGroupNamesExternalTranslatedUserGroupNames. The translated user group names to retrieve, such as Administrator.

UpdateRoleDeprecated since iHub Release 3. Replaced by UpdateUserGroup.

UpdateUserUpdates user properties. To update users, specify the types of updates to make using UpdateUserOperationGroup, then specify which users to update.

To update a single user, specify Name or Id. To update a list of users, specify NameList or IdList. To update users matching the specified conditions, specify Search.

Elements UpdateUserOperationGroupThe tasks to perform. The valid value are Search, IdList, NameList, Id, and Name.

SearchUserSearch. The search conditions. If search conditions apply to multiple fields, use ConditionArray.

IdListArrayOfString. The list of user IDs to update. Specify either IdList or NameList.

NameListArrayOfString. The list of user names to update. Specify either NameList or IdList.

IdString. The ID of a single user to update. Specify either Id or Name.

NameString. The name of a single user to update. Specify either Name or Id.

Page 206: Actuate API Reference - OpenText

188 A c t u a t e A P I R e f e r e n c e

UpdateUserGroup

IgnoreMissingBoolean. Specifies what to do if the specified user does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.

IgnoreDupBoolean. Specifies whether to report an error for a duplicate request. BIRT iHub always rejects a duplicate request regardless of the IgnoreDup setting. If True, BIRT iHub does not report an error. In a name list or ID list, True prevents BIRT iHub from performing duplicate operations. If False, BIRT iHub reports an error. The default value is False.

SkipPermissionErrorObsolete since iHub Release 3.

UpdateUserGroupUpdates a user group. Available only to users in the Administrator user group.

Elements UpdateUserGroupOperationGroupThe UpdateUserGroupOperation element to use during the UpdateUserGroup operation.

SearchUserGroupSearch. The search condition that specifies which user groups to delete.

IdListArrayOfString. The list of user group IDs to delete. Specify either IdList or NameList.

NameList ArrayOfString. The list of user group names to delete. Specify either NameList or IdList.

IdString. The ID of the single user group to delete. Specify either Id or Name.

NameString. The name of the single user group to delete. Specify either Name or Id.

IgnoreMissingBoolean. Specifies what to do if the specified user group does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.

Page 207: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 189

UpdateUserGroupOperat ion

IgnoreDupBoolean. Specifies whether to report an error when creating the user group if one with the same name already exists. BIRT iHub always rejects a duplicate request regardless of the IgnoreDup setting. If True, BIRT iHub does not report an error. If False, BIRT iHub reports an error. The default value is False.

UpdateUserGroupOperationSpecifies the tasks to perform during the UpdateUserGroup operation.

Elements SetAttributesUserGroup. The general attributes to update.

AssignedToUsersByNameArrayOfString. The names of user groups to which to assign users. Specify either AssignedToUsersByName or AssignedToUsersById.

DroppedFromUsersByNameArrayOfString. The names of user groups from which to delete users. Specify either DroppedFromUsersByName or DroppedFromUsersById.

SetBearingUsersByNameArrayOfString. The names of user groups to which to reassign users. Specify either SetBearingUsersByName or SetBearingUsersById.

AddChildUserGroupsByNameArrayOfString. The names of user groups to add to the user group as descendant user groups. Specify either AddChildUserGroupsByName or AddChildUserGroupsById.

RemoveChildUserGroupsByNameArrayOfString. The names of descendant user groups to remove from the UserGroup. Specify either RemoveChildUserGroupsByName or RemoveChildUserGroupsById.

SetChildUserGroupsByNameArrayOfString. The names of the user group’s descendant user groups. Specify either SetChildUserGroupsByName or SetChildUserGroupsById.

AddParentUserGroupsByNameArrayOfString. The names of user groups to add to the user group as its ascendant user groups. Specify either AddParentUserGroupsByName or AddParentUserGroupsById.

RemoveParentUserGroupsByNameArrayOfString. The name of the parent user group to remove. Specify either RemoveParentUserGroupsByName or RemoveParentUserGroupsById.

Page 208: Actuate API Reference - OpenText

190 A c t u a t e A P I R e f e r e n c e

UpdateUserGroupOperat ionGroup

SetParentUserGroupsByNameArrayOfString. The names of the user group’s ascendant user groups. Specify either SetParentUserGroupsByName or SetParentUserGroupsById.

AssignedToUsersByIdArrayOfString. The IDs of user groups to which to assign users. Specify either AssignedToUsersById or AssignedToUsersByName.

DroppedFromUsersByIdArrayOfString. The IDs of user groups from which to delete users. Specify either DroppedFromUsersById or DroppedFromUsersByName.

SetBearingUsersByIdArrayOfString. The IDs of user groups to which to reassign users. Specify either SetBearingUsersById or SetBearingUsersByName.

AddChildUserGroupsByIdArrayOfString. The IDs of user groups to add to the user group as descendant user groups. Specify either AddChildUserGroupsByName or AddChildUserGroupsById.

RemoveChildUserGroupsByIdArrayOfString. The IDs of descendant user groups to remove from the user group. Specify either RemoveChildUserGroupsById or RemoveChildUserGroupsByName.

SetChildUserGroupsByIdArrayOfString. The IDs of the user group’s descendant user groups. Specify either SetChildUserGroupsById or SetChildUserGroupsByName.

AddParentUserGroupsByIdArrayOfString. The IDs of user groups to add to the user group as its ascendant user groups. Specify either AddParentUserGroupsById or AddParentUserGroupsByName.

RemoveParentUserGroupsByIdArrayOfString. The IDs of the ascendant user groups to remove. Specify either RemoveParentUserGroupsByName or RemoveParentUserGroupsById.

SetParentUserGroupsByIdArrayOfString. The IDs of the user group’s ascendant user groups. Specify either SetParentUserGroupsById or SetParentUserGroupsByName.

UpdateUserGroupOperationGroupSpecifies the UpdateUserGroupOperation element to use during the UpdateUserGroup operation.

Page 209: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 191

UpdateUserOperat ion

Element UpdateUserGroupOperationThe UpdateUserGroupOperation element for use with the UpdateUserGroup operation.

UpdateUserOperationSpecifies the tasks to perform during the UpdateUser operation.

Elements SetAttributesUser. The general attributes to update.

AddToGroupsByNameObsolete since iHub Release 3.

RemoveFromGroupsByNameObsolete since iHub Release 3.

SetGroupMembershipsByNameObsolete since iHub Release 3.

AssignRolesByNameDeprecated since iHub Release 3. Replaced by AssignUserGroupsByName.

DropRolesByNameDeprecated since iHub Release 3. Replaced by DropUserGroupsByName.

SetRolesByNameDeprecated since iHub Release 3. Replaced by SetUserGroupsByName.

AssignUserGroupsByNameArrayOfString. The names of user groups to assign to users. Specify either AssignUserGroupsByName or AssignUserGroupsById.

DropUserGroupsByNameArrayOfString. The names of user groups from which to remove users. Specify either DropUserGroupsByName or DropUserGroupsById.

SetUserGroupsByNameArrayOfString. The names of user groups to update. Specify either SetUserGroupsByName or SetUserGroupsById.

SubscribeToChannelsByNameObsolete since iHub Release 3.

UnsubscribeFromChannelsByNameObsolete since iHub Release 3.

SetChannelSubscriptionsByNameObsolete since iHub Release 3.

Page 210: Actuate API Reference - OpenText

192 A c t u a t e A P I R e f e r e n c e

UpdateUserOperat ion

AddToGroupsByIdObsolete since iHub Release 3.

RemoveFromGroupsByIdObsolete since iHub Release 3.

SetGroupMembershipsByIdObsolete since iHub Release 3.

AssignRolesByIdDeprecated since iHub Release 3. Replaced by AssignUserGroupsById.

DropRolesByIdDeprecated since iHub Release 3. Replaced by DropUserGroupsById.

SetRolesByIdDeprecated since iHub Release 3. Replaced by SetUserGroupsById.

AssignUserGroupsByIDArrayOfString. The IDs of user groups to assign to users. Specify either AssignUserGroupsByName or AssignUserGroupsById.

DropUserGroupsByIDArrayOfString. The IDs of user groups from which to remove users. Specify either DropUserGroupsByName or DropUserGroupsById.

SetUserGroupsByIDArrayOfString. The IDs of user groups to update. Specify either SetUserGroupsByName or SetUserGroupsById.

SubscribeToChannelsByIdObsolete since iHub Release 3.

UnsubscribeFromChannelsByIdObsolete since iHub Release 3.

SetChannelSubscriptionsByIdObsolete since iHub Release 3.

AddFileCreationPermissionsArrayOfString. Grants users the permissions to add files.

RemoveFileCreationPermissionsRevokes users’ ability to add files.

SetFileCreationPermissionsArrayOfString. Modifies users’ ability to add files.

SetPrinterOptionsArrayOfString. The printer options to set for the users.

Page 211: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 193

UpdateUserOperat ionGroup

SetLicenseOptionsArrayOfString. The license options to set for the users.

AddLicenseOptionsArrayOfString. Grants users the right to add license options.

RemoveLicenseOptionsArrayOfString. Removes the right of users to add license options.

UpdateUserOperationGroupSpecifies the UpdateUserOperation element to use during the UpdateUser operation.

Element UpdateUserOperationThe UpdateUserOperation element for use with the UpdateUser operation.

UpdateVolumePropertiesUpdates a volume. To update a volume, specify the types of updates to make using UpdateVolumeOperationGroup, then specify which volume to update.

Element UpdateVolumePropertiesOperationGroupThe tasks to perform.

UpdateVolumePropertiesOperationSpecifies the tasks to perform during the UpdateVolumeProperties operation.

Elements SetAttributesVolume. Contains one or more of the following volume properties to update:

■ DefaultPrinterName

■ MaxJobRetryCount

■ JobRetryIntervalThe interval between retry attempts. Measured in seconds.

■ DefaultViewingPreference

■ DHTMLPageCaching

Page 212: Actuate API Reference - OpenText

194 A c t u a t e A P I R e f e r e n c e

UpdateVolumePropert iesOperat ionGroup

■ DHTMLPageCachingExpirationIf DHTMLPageCaching is True, set the DHTMLPageCachingExpiration to a valid value. To disable DHTMLPageCaching, set DHTMLPageCachingExpiration to -1.

SetPrinterOptionsArrayOfPrinterOptions. The volume printer options to update.

SetSystemPrintersArrayOfPrinter. The printer to set as the system printer for the volume.

ClearSystemPrintersArrayOfString. The printer to remove from the volume.

SetAutoArchiveSchedulesJobSchedule. The start of the autoarchive schedule for folders and files on the volume.

UpdateVolumePropertiesOperationGroupSpecifies the UpdateVolumePropertiesOperation element to use during the UpdateVolumeProperties operation.

Element UpdateVolumePropertiesOperationThe UpdateVolumePropertiesOperation element for use with the UpdateVolumeProperties operation.

UserA complex data type that describes a user.

Elements IdString. Optional. The user ID.

NameString. Optional. The user name. A user name is a string of 1 to 256 characters, including any character except a control character. A user name is not case-sensitive. BIRT iHub stores a user name in mixed case, always displaying it exactly the way it was typed during creation.

PasswordString. Optional. The user password. A password is a string of 1 to 256 characters, including any character except a control character or space. Security experts recommend using passwords of at least eight characters, including mixed-case alphabetic and numeric characters. A password is case-sensitive. The

Page 213: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 195

User

Administrator can change any user password. Users can only change their own passwords. BIRT iHub encrypts a user password.

EncryptedPwdString. Optional. The encrypted password of the user.

DescriptionString. Optional. The description of the user.

IsLoginDisabledBoolean. Optional. Specifies whether the user can log in.

EmailAddressString. Optional. The user e-mail address.

HomeFolderString. Optional. The user home folder.

ViewPreferenceString. Optional. The user viewer, Default or DHTML.

MaxJobPriorityLong. Optional. The maximum priority that the user can assign to a job.

MaxNoticesLong. Optional. The maximum number of notices that the user can retain.

SendNoticeForSuccessBoolean. Optional. Specifies whether the BIRT iHub sends success notices to the user.

SendNoticeForFailureBoolean. Optional. Specifies whether the BIRT iHub sends failure notices to the user.

SuccessNoticeExpirationLong. Optional. Specifies the minimum number of minutes success notices remain in the Completed folder. After this time elapses, BIRT iHub removes the notices the next time it removes requests from the volume’s Requests\Completed folder. If not set or set to 0, DefaultSuccessNoticeExpiration specified in Volume is used. To set the user success notices to never expire, set the value to 0xffffffff.

FailureNoticeExpirationLong. Optional. Specifies the minimum number of minutes failure notices remain in the Completed folder. After this time elapses, BIRT iHub removes the notices the next time it removes requests from the volume’s Requests\Completed folder. If not set or set to 0, DefaultFailureNoticeExpiration specified in Volume is used. To set the user failure notices to never expire, set the value to 0xffffffff.

Page 214: Actuate API Reference - OpenText

196 A c t u a t e A P I R e f e r e n c e

UserCondit ion

SendEmailForSuccessBoolean. Optional. Specifies whether the BIRT iHub sends success notices in an e-mail message to the user.

SendEmailForFailureBoolean. Optional. Specifies whether the BIRT iHub sends failure notices in an e-mail message to the user.

AttachReportInEmailBoolean. Optional. Specifies whether to attach a report to an e-mail completion notice.

DefaultPrinterNameString. Optional. The name of the user default printer.

UserConditionA complex data type that represents the field on which to perform a search and the condition to match.

Elements FieldString. The field on which to perform a search.

MatchString. The condition to match. If the condition includes special characters, for example a dash, either escape the special character with a backslash (\) or enclose it in brackets ([]). For example, to search for a file 05-25-04Report.rptdocument, specify one of the following:

05\-25\-04Report.rptdocument 05[-]25[-]04Report.rptdocument

UserFieldA simple data type that describes the fields within a user element.

Element String. One of the following values:

NameThe user name.

DescriptionThe description of the user.

IsLoginDisabledSpecifies whether the user can log in.

Page 215: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 197

UserGroup

EmailAddressThe user e-mail address.

HomeFolderThe user home folder.

ViewPreferenceThe user viewer, Default or DHTML.

MaxJobPriorityThe maximum priority that the user can assign to a job.

SuccessNoticeExpirationSpecifies the minimum number of minutes success notices remain in the Completed folder.

FailureNoticeExpirationSpecifies the minimum number of minutes failure notices remain in the Completed folder.

SendNoticeForSuccessSpecifies whether the BIRT iHub sends success notices to the user.

SendNoticeForFailureSpecifies whether the BIRT iHub sends failure notices to the user.

SendEmailForSuccessSpecifies whether the BIRT iHub sends success notices in an e-mail message to the user.

SendEmailForFailureSpecifies whether the BIRT iHub sends failure notices in an e-mail message to the user.

AttachReportInEmailSpecifies whether to attach a report to an e-mail completion notice.

DefaultPrinterNameThe name of the user default printer.

UserGroupA complex data type that describes a user group.

Elements IdString. Optional. The user group ID.

NameString. Optional. The name of the user group. Cannot exceed 50 characters.

Page 216: Actuate API Reference - OpenText

198 A c t u a t e A P I R e f e r e n c e

UserGroupCondit ion

DescriptionString. Optional. The description of the user group. Cannot exceed 500 characters.

UserGroupConditionA complex data type that represents the field on which to perform a user group search and the condition to match.

Elements FieldUserGroupField. The field on which to perform a search.

MatchString. The condition to match. If the condition includes special characters, for example a dash, either escape the special character with a backslash (\) or enclose it in brackets ([]). For example, to search for a file 05-25-04Report.rptdocument, specify one of the following: 05\-25\-04Report.rptdocument05[-]25[-]04Report.rptdocument

UserGroupFieldA simple data type that lists user group fields on which a search can be performed.

Element String. One of the following values:

NameThe name of the user group.

DescriptionThe description of the user group.

UserGroupSearchA complex data type that represents a user group search.

Elements ConditionUserGroupCondition. Optional. The search condition. Specify this value of ConditionArray.

ConditionArrayArrayOfUserGroupCondition. Optional. An array of search conditions. Specify this value of Condition.

Page 217: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 199

UserGroupSearch

ParentUserGroupNameString. Optional. The name of the parent user group of which the user is a member. Specify one of this value, ChildUserGroupName, AssignedToUserName, ParentUserGroupId, ChildUserGroupId, or AssignedToUserId.

ChildUserGroupNameString. Optional. The name of the child user group to which the user belongs. Specify one of this value, ParentUserGroupName, AssignedToUserName, ParentUserGroupId, ChildUserGroupId, or AssignedToUserId.

WithRightsToChannelNameObsolete since iHub Release 3.

AssignedToUserNameString. Optional. The user name to which the user group is assigned. Specify one of this value, ParentUserGroupName, ChildUserGroupName, ParentUserGroupId, ChildUserGroupId, or AssignedToUserId.

ParentUserGroupIdString. Optional. The ID of the parent user group to which the group belongs. Specify one of this value, ParentUserGroupName, ChildUserGroupName, AssignedToUserName, ChildUserGroupId, or AssignedToUserId.

ChildUserGroupIdString. Optional. The ID f the child user group to which the group belongs. Specify one of this value, ParentUserGroupName, ChildUserGroupName, AssignedToUserName, ParentUserGroupId, or AssignedToUserId.

WithRightsToChannelIdObsolete since iHub Release 3.

AssignedToUserIdString. Optional. The user ID to which the user group is assigned. Specify one of this value, ParentUserGroupName, ChildUserGroupName, AssignedToUserName, ParentUserGroupId, or ChildUserGroupId.

FetchSizeInt. Optional. The maximum number of records to retrieve and return in a result set. The default value is 500.

FetchDirectionBoolean. Optional. If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.

CountLimitInt. Optional. The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to -1.

Page 218: Actuate API Reference - OpenText

200 A c t u a t e A P I R e f e r e n c e

UserSearch

FetchHandleString. Optional. Retrieves more items from the result set. In the second and subsequent calls for data, specifies the same search criteria as in the original call.

UserSearchA complex data type that represents a user search.

Elements ConditionUserCondition. Optional. The search condition. Specify this value of ConditionArray.

ConditionArrayArrayOfUserCondition. Optional. An array of search conditions. Specify this value of ConditionArray.

MemberOfGroupNameObsolete since iHub Release 3.

WithRoleNameDeprecated since iHub Release 3. Replaced by WithUserGroupName.

WithUserGroupNameString. Optional. The name of the user group to which the user belongs. Specify one of this value, WithUserGroupId, or WithLicenseOption.

SubscribedToChannelNameObsolete since iHub Release 3.

MemberOfGroupIdObsolete since iHub Release 3.

WithRoleIdDeprecated since iHub Release 3. Replaced by WithUserGroupId.

WithUserGroupIdString. Optional. The ID of the user group to which the user belongs. Specify one of this value, WithUserGroupName, or WithLicenseOption.

WithLicenseOptionString. Optional. The name of the license option assigned to the user. Specify one of this value, WithUserGroupName, or WithUserGroupId.

SubscribedToChannelIdObsolete since iHub Release 3.

FetchSizeInt. Optional. The maximum number of records to retrieve and return in a result set. The default value is 500.

Page 219: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 201

VersioningOption

FetchDirectionBoolean. Optional. If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.

CountLimitInt. Optional. The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to -1.

FetchHandleString. Optional. Retrieves more items from the result set. In the second and subsequent calls for data, specifies the same search criteria as in the original call.

VersioningOptionA simple data type that specifies the options for handling the latest existing version when uploading a file.

Element String. One of the following values:

CreateNewVersionAlways creates a new version. This is the default value.

ReplaceLatestIfNoDependentsReplaces the latest existing version if it does not have any dependent files. If the existing version has any dependents, BIRT iHub creates a new version instead of replacing the existing version.

ReplaceLatestDropDependencyReplaces the latest existing version if it does not have any dependent files. If the existing version has any dependents, BIRT iHub drops the dependency.

ReplaceLatestMigrateDependencyReplaces the latest existing version if it does not have any dependent files. If the existing version has any dependents, BIRT iHub moves the dependency to the new version.

ViewParameterA complex data type that describes a viewing parameter.

Elements FormatString. Optional. The format in which the report displays. Valid formats are:

■ CSS

■ DHTML

■ DHTMLLong

Page 220: Actuate API Reference - OpenText

202 A c t u a t e A P I R e f e r e n c e

ViewParameter

■ DHTMLRaw

■ ExcelData

■ ExcelDisplay

■ ImageMapURLSupports users clicking a point in a chart to navigate to different report sections

■ PDF

■ PPT

■ PPTFullyEditable

■ ReportletValid only if ShowInReportlet is enabled during report design

■ RTF

■ RTFFullyEditable

■ XMLCompressedDisplay

■ XMLCompressedExcel

■ XMLCompressedPDF

■ XMLCompressedPPT

■ XMLCompressedReportlet

■ XMLCompressedRTF

■ XMLData

■ XMLDisplay

■ XMLReportlet

■ XMLStyle

UserAgentString. Optional. The browser to use for report viewing, such as Mozilla/4.0.

ScalingFactorLong. Optional. Adapts the size of a Reportlet to the Reportlet frame.

AcceptEncodingString. Optional. The list of encoding methods the browser supports.

ViewOperationString. Optional. The view operation, View or Print.

Page 221: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 203

Volume

PathInformationString. Optional. The path to the report.

EmbeddedObjPathString. Optional. The base URL to prepend to a static or dynamic object in a report. When viewing a report in a browser, the URL of an image, chart, JavaScript, or another resource refers to the volume. Use EmbeddedObjPath to change this URL.

RedirectPathString. Optional. Maps from the current URL to a new target.

PdfQualityLong. Optional. The viewing quality of a PDF.

VolumeA complex data type that describes a volume.

Elements NameString. The name of the volume.

ActuateVersionString. Optional. The version number.

ActuateBuildNumberString. Optional. The build number.

SecurityIntegrationOptionLong. Optional. The security integration option.

OpenSecuritySelectUsersOfRoleDeprecated since iHub Release 3. Replaced by OpenSecuritySelectUsersOfUserGroup.

OpenSecuritySelectUsersOfUserGroupBoolean. Optional. Applies only if using external registration security level. Indicates whether the SelectUsers operation for a user group is supported. If the operation is supported, iHub enables appropriate features in iHub Visualization Platform.

OpenSecuritySelectGroupsOfUserObsolete since iHub Release 3.

DefaultPrinterNameString. Optional. The name of the default printer.

MaxJobRetryCountLong. Optional. The maximum number of retry attempts.

Page 222: Actuate API Reference - OpenText

204 A c t u a t e A P I R e f e r e n c e

Weekly

JobRetryIntervalLong. Optional. The interval between retry attempts. Measured in seconds.

DefaultViewingPreferenceObsolete since iHub Release 2.

DHTMLPageCachingBoolean. Optional. True enables DHTML page caching.

DHTMLPageCachingExpirationAgeLong. Optional. If DHTMLPageCaching is True, set DHTMLPageCachingExpirationAge to a valid value. To disable DHTMLPageCaching, set DHTMLPageCachingExpirationAge to -1.

IsAutoArchiveRunningBoolean. Optional. Determines whether an archive pass is currently running. If True, an archive pass is running.

AuthorizationIsExternalBoolean. Optional. Specifies whether user registration is external.

ConnectionPropertiesAreExternalBoolean. Optional. Specifies whether connection properties are externalized using the Report Server Security Extension (RSSE).

DefaultSuccessNoticeExpirationLong. Optional. Specifies the minimum number of minutes success notices remain in the Completed folder. After this time elapses, BIRT iHub removes the notices the next time it removes requests from the volume’s Requests\Completed folder. This time applies to all users whose SuccessNoticeExpiration time is not set or is set to 0. The default value is 0, which means notices never expire.

DefaultFailureNoticeExpirationLong. Optional. Specifies the minimum number of minutes failure notices remain in the Completed folder. After this time elapses, BIRT iHub removes the notices the next time it removes requests from the volume’s Requests\Completed folder. This time applies to all users whose SuccessNoticeExpiration time is not set or is set to 0. The default value is 0, which means notices never expire.

ResourcePathString. Optional. The resource path to the volume.

WeeklyA complex data type describing weekly job scheduling.

Elements FrequencyInWeeksLong. The number of times a job is to run, in weeks.

Page 223: Actuate API Reference - OpenText

C h a p t e r 3 , A c t u a t e I n f o r m a t i o n D e l i v e r y A P I d a t a t y p e s 205

Weekly

RunOnString. The day to run the job.

OnceADayString. Optional. The time to run the job.

RepeatRepeat. Optional. The number of times to repeat the schedule.

Page 224: Actuate API Reference - OpenText

206 A c t u a t e A P I R e f e r e n c e

Weekly

Page 225: Actuate API Reference - OpenText

Part 3Actuate security API

■ Visualization Platform security reference

■ Java Report Server Security Extension reference

PartThree3

Page 226: Actuate API Reference - OpenText
Page 227: Actuate API Reference - OpenText

C h a p t e r 4 , V i s u a l i z a t i o n P l a t f o r m s e c u r i t y r e f e r e n c e 209

C h a p t e r

4Chapter 4Visualization Platform

security referenceThis chapter contains the following topics:

■ About Actuate Visualization Platform security

■ Using the security adapter class

■ Using the upload security adapter interface

Page 228: Actuate API Reference - OpenText

210 A c t u a t e A P I R e f e r e n c e

About Actuate Visualization Platform securityA reporting web application is accessible to any user who has a web browser and the URI for the application. This chapter discusses the Actuate Visualization Platform security features and how to use them to:

■ Ensure that users access only those objects in the volume for which they have permission.

■ Protect sensitive reports.

The types of security you can provide for Visualization Platform are:

■ Default user authentication. Use the default Visualization Platform and BIRT iHub facilities to ensure that users access only those reports and other volume items for which they have permission.

■ User authentication using the iPortal Security Extension (IPSE). Use IPSE to customize and control the user login and authentication process. For details about implementing custom user authentication, see “Creating a custom security adapter,” later in this chapter.

Using the security adapter classTo implement a custom security adapter, create a class that extends com.actuate.iportal.security.iPortalSecurityAdapter. This class contains the following methods.

authenticate( )Syntax boolean authenticate( javax.servlet.http.HttpServletRequest request )

Parameter requestThe request parameter sent from the iHub Information Console client web application.

Description Required method that evaluates the current user’s security credentials. The Login module calls authenticate( ) to validate the current user’s security credentials. If authenticate( ) returns False, the user is redirected to the login page.

Returns True for successful credential evaluation and False otherwise.

Throws An AuthenticationException indicating the reason for the failure, if credential evaluation is not successful.

getExtendedCredentials( )Syntax byte[] getExtendedCredentials( )

Page 229: Actuate API Reference - OpenText

C h a p t e r 4 , V i s u a l i z a t i o n P l a t f o r m s e c u r i t y r e f e r e n c e 211

Description Retrieves the current user’s extended security credentials.

Returns A byte array representing any extended credentials for the iHub to use to authenticate the user, or null if there are no extended credentials to evaluate.

getPassword( )Syntax String getPassword( )

Description Required method that retrieves the current user’s password. The Login module calls getPassword( ) and uses the password to establish a connection to the iHub and to access the volume.

Returns A string that is the password to use to establish the connection.

getRepositoryType( )Syntax String getServerUrl( )

Description Retrieves the repository type. The Login module calls this method to check the repository type. Alternatively, provide isEnterprise().

Returns A string that indicates the repository type. The repository type for iHub is enterprise.

getRunAsUser( )Syntax String getRunAsUser( )

Description Retrieves the runAs setting if the runAs is enabled. The Login module calls this method to retrieve the user name used for a run as operation.

Returns A string containing the user name that corresponds to the runAs user setting.

getServerUrl( )Syntax String getServerUrl( )

Description Retrieves the URL of the server to which the current user connects. The Login module calls getServerUrl( ).

Returns A string containing the URL for the iHub currently connected.

getUserHomeFolder( )Syntax String getUserHomeFolder( )

Description Retrieves the current user’s home folder. The Login module calls getUserHomeFolder( ) to access the user’s files.

Returns A string that is the user’s home folder. It is null if there is no home folder for the user.

Page 230: Actuate API Reference - OpenText

212 A c t u a t e A P I R e f e r e n c e

getUserName( )Syntax String getUserName( )

Description Required method that retrieves the current user’s login name. The Login module calls getUserName( ) to establish a connection to the iHub and to access the volume.

Returns A string containing the user name that the iHub recognizes.

getVolume( )Syntax String getVolume( )

Description Retrieves the volume to which the current user connects. The Login module calls getVolume( ) to retrieve the name of the volume to which the user wishes to connect.

Returns A string containing the domain and volume name for the volume to which the user connects to through the iHub. If null, the iHub connects to the default volume, read from the DEFAULT_VOLUME parameter in the Visualization Platform web.xml file.

getVolumeProfile( )Syntax String getVolumeProfile( )

Description Required method that retrieves the volume profile to which the current user connects. The Login module calls getVolumeProfile( ) to retrieve the name of the volume profile to which the user wishes to connect.

Returns A string containing the server profile name for the volume to which the user connects through the iHub.

isEnterprise( )Syntax boolean isEnterprise( )

Description Evaluates whether the user connects to a volume. The Login module calls isEnterprise( ) to determine whether to use a volume repository.

Returns True.

Using the upload security adapter interfaceTo implement a custom upload security adapter, create a class that implements the com.actuate.iportal.security.IUploadSecurityAdapter interface. This interface defines the following methods.

Page 231: Actuate API Reference - OpenText

C h a p t e r 4 , V i s u a l i z a t i o n P l a t f o r m s e c u r i t y r e f e r e n c e 213

getErrorMessage( )Syntax String getErrorMessage( javax.servlet.http.HttpServletRequest request)

Parameter requestThe request parameter sent from the iHub Information Console client web application.

Description A method that returns a custom error string when either isFileTypeAllowed or verifyFile returns False.

Returns String. An error message. If null, iHub Information Console client displays a generic default error message.

isFileTypeAllowed( )Syntax boolean isFileTypeAllowed( javax.servlet.http.HttpServletRequest request, string

fileType)

Parameters requestThe request parameter sent from the iHub Information Console client web application.

fileTypeString. The type of the upload file, as determined by file extension.

Description A required method used to do additional validation of the upload file.

Returns Boolean. True for an allowed file type and False otherwise.

verifyFile( )Syntax boolean verifyFile( javax.servlet.http.HttpServletRequest request, string filePath,

string dstPath)

Parameters requestThe request parameter sent from the iHub Information Console client web application.

filePathString. The path of the file stored on iHub Information Console client. The default location is the directory specified by TEMP_FOLDER_LOCATION parameter in web.xml.

dstPathString. The repository path to which the upload sends the file.

Description A required method used to do additional validation of the upload file.

Returns Boolean. True for successful file validation and False otherwise.

Page 232: Actuate API Reference - OpenText

214 A c t u a t e A P I R e f e r e n c e

Page 233: Actuate API Reference - OpenText

C h a p t e r 5 , J a v a R e p o r t S e r v e r S e c u r i t y E x t e n s i o n r e f e r e n c e 215

C h a p t e r

5Chapter 5Java Report Server

Security Extensionreference

This chapter consists of the following topics:

■ About the Java Report Server Security Extension

■ Report Server Security Extension (RSSE) API operations

■ Report Server Security Extension (RSSE) API data types

Page 234: Actuate API Reference - OpenText

216 A c t u a t e A P I R e f e r e n c e

Authent icateUser

About the Java Report Server Security ExtensionBIRT iHub System provides a SOAP-based API that supports running a Report Server Security Extension (RSSE) application as a web service. Using the Java RSSE framework, a developer can create an application that provides one of the following security features:

■ External authenticationAuthenticates a user password using an interface to an external security system such as Lightweight Directory Access Protocol (LDAP) or Microsoft Active Directory. Users, roles, notification groups, access control lists (ACLs), and other information remain on the volume.

■ External registrationManages users, roles, notification groups, access control lists (ACLs), and other information using an interface to an external security system such as Lightweight Directory Access Protocol (LDAP) or Microsoft Active Directory. The volume no longer manages this information.

■ Page-level securityControls user access to sensitive information in a BIRT report by implementing page-level security. A page-level security application requires a BIRT Page Level Security option license.

The following sections describe how to build, install, and customize these Java RSSE security applications in the Actuate Information Delivery API development environment.

Report Server Security Extension (RSSE) API operations

This section describes RSSE API operations. Note that TargetVolume and OrgId are set in the SOAP header of each request going to an RSSE service.

OrgId is an optional value to filter the users for a specific volume, which can be configured in System Console. How this value is used depends on the RSSE implementation.

AuthenticateUserVerifies that the user is authorized to access the BIRT iHub System. Implement AuthenticateUser for external user authentication and external user registration.

Page 235: Actuate API Reference - OpenText

C h a p t e r 5 , J a v a R e p o r t S e r v e r S e c u r i t y E x t e n s i o n r e f e r e n c e 217

DoesRoleExist

Requestelements

UserThe name of the user logging on to BIRT iHub.

PasswordThe user password.

CredentialsAdditional credentials for authenticating the user.

UserSettingSpecifies whether to return the user properties. If True, returns the user properties.

OrgIDSpecifies whether to return the user’s organization identifier. If True, returns the identifier.

Responseelements

UserAndPropertiesThe user name and properties.

DoesRoleExistVerifies whether the role exists in the external directory. BIRT iHub can call this function to clear references to deleted roles.

Requestelements

RoleNameThe name of the role to verify.

Responseelements

ExistsIndicates whether the role exists. If True, the role exists.

DoesUserExistVerifies whether the user exists in the external directory. BIRT iHub can call this function to clear references to deleted users.

Requestelements

UserNameThe name of the user to verify.

Responseelements

ExistsIndicates whether the user exists. If True, the user exists.

GetConnectionPropertiesRetrieves the connection properties for a user or role from an external data source for a pass-through security operation. In pass-through security, an information

Page 236: Actuate API Reference - OpenText

218 A c t u a t e A P I R e f e r e n c e

GetTranslatedRoleNames

object’s DCD file sets the securityPolicy to TranslatedCredential. The proxy user name and password settings, specifying the user login credentials in the DCD, contain empty quotes and are ignored by the implementation.

Requestelements

FileNameThe fully qualified name of an information object’s data connection definition (DCD) file.

UserNameThe name of the user or role.

Responseelements

ConnectionPropertiesThe requested name and value pairs.

GetTranslatedRoleNamesMaps the external security role names to Actuate security role names. Either use GetTranslatedRoleNames in conjunction with the external registration security level, or use the same role names for the external and Actuate roles.

For example, a user with the Actuate Administrator security role can manage all items in a volume. If the Administrator role in the external security system has a different meaning, GetTranslatedRoleNames can map the external security role to an Actuate role with a different name.

Requestelements

GetTranslatedRoleNamesThe external translated role names that map to the Actuate security role names.

Responseelements

TranslatedRoleNamesThe names that Actuate uses for external security roles.

GetTranslatedUserNamesMaps the external security user names to Actuate security user names. Either use GetTranslatedUserNames in conjunction with the external registration security level, or use the same user names for the external and Actuate users.

For example, a user with the Actuate Administrator privilege can manage all items in a volume. If the Administrator user in the external security system has a different meaning, GetTranslatedUserNames can map the external security user to an Actuate user with a different name. Deprecated in BIRT iHub Release 3.

Requestelements

GetTranslatedUserNamesThe external translated user names that map to the Actuate security user names.

Responseelements

TranslatedUserNamesThe names that Actuate uses for external security users.

Page 237: Actuate API Reference - OpenText

C h a p t e r 5 , J a v a R e p o r t S e r v e r S e c u r i t y E x t e n s i o n r e f e r e n c e 219

GetUserACL

GetUserACLRetrieves the user ACL. GetUserACL applies only if using page-level security. Page-level security controls printing, navigating, and all aspects of user viewing. Page-level security requires the Page Level Security option on BIRT iHub.

Requestelements

UserNameThe name of the user whose ACL to retrieve.

Responseelements

ACLThe list of pages of a document to which the user has access.

GetUserPropertiesRetrieves the user properties from an external directory. Regardless of security level implementation, implement GetUserProperties when the user properties are stored in an external security source.

Requestelements

UserThe name of the user whose properties to retrieve.

ResultDefThe properties to retrieve. Can contain user property names, roles, and PrivilegeTemplate.

Responseelements

ArrayOfUserAndPropertiesThe user properties.

GetUsersToNotifyRetrieves the list of users to notify about completed jobs.

Requestelements

GetUsersToNotifyThe list of users to notify about completed jobs.

Responseelements

UsersThe list of users to notify.

PassThroughCalls the RSSE for general purposes such as changing or refreshing the internal library state. If implemented, the RSSE calls PassThrough in response to the BIRT iHub receiving the Information Delivery API CallOpenSecurityLibrary request.

Page 238: Actuate API Reference - OpenText

220 A c t u a t e A P I R e f e r e n c e

SelectRoles

The RSSE passes the ReturnCode as a response to CallOpenSecurityLibrary, RSSE does not interpret the parameter.

Requestelements

InputThe input parameter string.

Responseelements

OutputThe output parameter string.

ReturnCodeThe integer parameter that the caller of CallOpenSecurityLibrary interprets.

SelectRolesSearches for roles that match the specified criteria. Required if using an external registration security level.

SelectRoles can also retrieve a user roles. To retrieve a user roles, specify a name in UserName. SelectRolesResponse then returns the list of the user roles.

The SelectRoles SOAP message invokes the SelectRolesOfUser method within the Java code, and does not invoke the SelectRoles method. iHub does not use the SelectRoles method to link a user account to a role.

Requestelements

QueryPatternThe string match.

UserNameThe name of a user whose information to retrieve.

FetchSizeThe maximum number of records to retrieve and return in a result set. The default value is 500.

Responseelements

RolesThe list of roles matching the search criteria.

TotalCountThe number of entries in the search result set.

SelectUsersRetrieves the names of users that match the specified criteria. For example, to retrieve the names of all users in the Sales group, specify Sales in GroupName.

SelectUsers is required if using an external registration security level.

Requestelements

QueryPatternThe string match.

Page 239: Actuate API Reference - OpenText

C h a p t e r 5 , J a v a R e p o r t S e r v e r S e c u r i t y E x t e n s i o n r e f e r e n c e 221

Start

RoleNameThe name of the role whose members to retrieve.

GroupNameThe name of the group whose members to retrieve.

FetchSizeThe maximum number of records to retrieve and return in a result set. The default value is 500.

Responseelements

UsersThe list of users matching the search criteria.

TotalCountThe number of entries in the search result set.

StartInitializes the RSSE. Implement Start to initialize RSSE. Called once for each cluster

Requestelements

ServerHomeThe path to the BIRT iHub installation, for example C:\Program Files\Actuate\Server on Windows.

VolumeThe name of the volume.

LogFileThe path to the log file for RSSE activity.

VersionThe BIRT iHub version number.

Responseelements

IntegrationLevelThe integration level of external security. One of the following values:

■ External_Authentication

■ External_Registration

■ None

ExternalPropertiesThe following external user or role properties are included in the response. All properties are required except where indicated.

■ EmailAddressThe user’s e-mail address

■ Description

Page 240: Actuate API Reference - OpenText

222 A c t u a t e A P I R e f e r e n c e

Start

A description of the user

■ HomeFolderThe user’s home folder

■ ViewPreferenceThe user’s web viewing preference, default or DHTML

■ MaxJobPriorityThe maximum request priority the user can set when creating a report printing or generation request

■ SendNoticeForSuccessSends a notice if the job succeeds

■ SendNoticeForFailureSends a notice if the job fails

■ SuccessNoticeExpirationThe number of minutes that elapse before a successful job notice is deleted

■ FailureNoticeExpirationThe number of minutes that elapse before a failed job notice is deleted

■ SendEmailForSuccessSends an email if the job succeeds

■ SendEmailForFailureSends an email if the job fails

■ AttachReportInEmailAttaches the report to the email if the job succeeds

■ DefaultObjectPrivilegesThe privileges that the user has by default on the objects the user creates

■ ChannelSubscriptionListA list of channels to which the user subscribes

■ LicenseOptions (optional)License options available to the user

RSSEVersionThe version of RSSE.

UserACLExternalSpecifies whether the user access list is stored externally. Applies only if using page-level security.

Page 241: Actuate API Reference - OpenText

C h a p t e r 5 , J a v a R e p o r t S e r v e r S e c u r i t y E x t e n s i o n r e f e r e n c e 223

Stop

ConnectionPropertyExternalSpecifies whether the user connection properties are retrieved externally from the RSSE. If True, the connection properties are retrieved externally. In this case, BIRT iHub directs requests to set connection properties to the RSSE and does not use GetConnectionProperties.

SelectUsersOfRoleApplies only under external registration. Specifies whether the RoleName element in SelectUsers is implemented. The setting indicates whether BIRT iHub enables this feature. The default value is False.

SupportGetTranslatedUserNamesSpecifies whether to support translation of user names from external source.

StopStops the Report Server Security Extension service. Implement Stop to close RSSE and free system resources.

Requestelements

StopCloses RSSE and free system resources.

Responseelements

StopResponseContains status information on results of stop operation.

Report Server Security Extension (RSSE) API data types

This section describes the RSSE API data types. Some data types have the same name as data types within the IDAPI, but do not have the same content.

Arrays of data typesData type definitions can be grouped into arrays. Each array has a specific definition for that data type.

The following data types have arrays defined and used in the RSSE:

■ Permission

■ PropertyValue

■ String

■ UserAndProperties

Page 242: Actuate API Reference - OpenText

224 A c t u a t e A P I R e f e r e n c e

ErrorMessage

ErrorMessageThe contents of a error message, including the request name, error code, and description.

Elements RequestNameThe request name or call included in the error message.

ErrorCodeThe error code.

DescriptionThe description associated with the error code.

PermissionA complex data type that describes a user access rights.

Elements RoleNameThe role name.

UserNameThe user name.

AccessRightThe privileges the user or role has on an object. One or more of the following characters representing a privilege:

■ D—Delete

■ E—Execute

■ G—Grant

■ V—Visible

■ S—Secured Read

■ R—Read

■ W—Write

PropertyValueA complex data type that describes a name-value pair.

Elements NameThe name portion of the name-value pair.

Page 243: Actuate API Reference - OpenText

C h a p t e r 5 , J a v a R e p o r t S e r v e r S e c u r i t y E x t e n s i o n r e f e r e n c e 225

TranslatedRoleNames

ValueThe value portion of the name-value pair.

TranslatedRoleNamesA complex data type that describes the role names RSSE uses that match external role names.

Elements AdministratorThe Administrator role name.

OperatorThe Operator role name.

AllAll other role names.

TranslatedUserNamesA complex data type that describes the administrator name RSSE uses that matches the external administrator name.

Elements AdministratorThe Administrator user name.

UserA complex data type describing an RSSE user and their attributes.

Elements NameThe username used to connect to iHub.

EmailAddressThe user e-mail address.

HomeFolderThe users’s home folder.

LicenseOptionsThe user license options.

ViewPreferenceThe user viewer, Default or DHTML.

Page 244: Actuate API Reference - OpenText

226 A c t u a t e A P I R e f e r e n c e

UserAndPropert ies

MaxJobPriorityThe maximum priority that the user can assign to a job.

SendNoticeForSuccessSpecifies whether the BIRT iHub sends success notices to the user.

SendNoticeForFailureSpecifies whether the BIRT iHub sends failure notices to the user.

SuccessNoticeExpirationSpecifies the minimum number of minutes success notices remain in the Completed folder. To set the user success notices to never expire, set the value to 0xffffffff.

FailureNoticeExpirationSpecifies the minimum number of minutes failure notices remain in the Completed folder. To set the user failure notices to never expire, set the value to 0xffffffff.

SendEmailForSuccessSpecifies whether the BIRT iHub sends success notices in an e-mail message to the user.

SendEmailForFailureSpecifies whether the BIRT iHub sends failure notices in an e-mail message to the user.

AttachReportInEmailSpecifies whether to attach a report to an e-mail completion notice.

UserAndPropertiesA complex data type describing an RSSE user and properties, such as privileges and roles.

Elements UserThe reference to the user object that contains the details to use to connect to iHub.

PrivilegeTemplatePermission list as specified in privilege template.

ChannelsAssigned channel names.

RolesAssigned role names.

Page 245: Actuate API Reference - OpenText

Part 4Actuate archiving API

■ Actuate archiving API reference

PartFour4

Page 246: Actuate API Reference - OpenText
Page 247: Actuate API Reference - OpenText

C h a p t e r 6 , A c t u a t e a r c h i v i n g A P I r e f e r e n c e 229

C h a p t e r

6Chapter 6Actuate archiving API

referenceThis chapter provides an alphabetical list of SOAP-based, archiving API operations and data types. Each entry includes a general description of the operation, its schema, and a description of its elements. The archiving API creates an application that archives files from an Encyclopedia volume.

This chapter consists of the following topics:

■ Archiving API Operations

■ Archiving API data types

Page 248: Actuate API Reference - OpenText

230 A c t u a t e A P I R e f e r e n c e

D e l e t e E x p i r e d F i l e s

Archiving API OperationsThis section describes archiving API operations.

DeleteExpiredFilesInforms iHub that the files in ExpiredFileIds are archived and instructs iHub to delete those files.

iHub deletes the file only if the file is expired. iHub sends the ID of each expired file in the GetNextExpiredFiles response. If ExpiredFileIds contains an ID of a file that iHub did not send, iHub ignores it.

If there are no IDs of expired files in any DeleteExpiredFiles call, iHub keeps expired files in the Encyclopedia volume and sends them to the archive application at the next archive pass.

Requestschema

<xsd:complexType name="DeleteExpiredFiles"><xsd:sequence>

<xsd:element name="SessionID" type="xsd:string"/><xsd:element name="ExpiredFileIds"

type="typens:ArrayOfString"/></xsd:sequence>

</xsd:complexType>

Requestelements

SessionIDThe ID that iHub generates for the current archiving session.

ExpiredFileIdsThe IDs of the files that were archived and can be deleted.

Responseschema

<xsd:complexType name="DeleteExpiredFilesResponse"/> <xsd:element name="DeleteExpiredFilesResponse"

type="typens:DeleteExpiredFilesResponse"/>

EndArchiveEnds an archiving session. After iHub receives the first StartArchive call, it allows 24 hours between subsequent archive requests. If iHub does not receive any archive requests within this time period, it automatically terminates the archive session.

Page 249: Actuate API Reference - OpenText

C h a p t e r 6 , A c t u a t e a r c h i v i n g A P I r e f e r e n c e 231

G e t N e x t E x p i r e d F i l e s

Requestschema

<xsd:complexType name="EndArchive"><xsd:sequence>

<xsd:element name="SessionID" type="xsd:string"/></xsd:sequence>

</xsd:complexType>

Requestelements

SessionIDThe ID that iHub generates for the current archiving session.

Responseschema

<xsd:complexType name="EndArchiveResponse"/> <xsd:element name="EndArchiveResponse"

type="typens:EndArchiveResponse"/>

GetNextExpiredFilesRetrieves information about expired files.

iHub always returns the ID, name, version, type, and location of each expired file. Use the ResultDef element to retrieve additional information.

Requestschema

<xsd:complexType name="GetNextExpiredFiles"><xsd:sequence>

<xsd:element name="SessionID" type="xsd:string"/><xsd:element name="ResultDef" type="typens:ArrayOfString"

minOccurs="0"/><xsd:element name="MaxFiles" type="xsd:long"

minOccurs="0"/></xsd:sequence>

</xsd:complexType>

Requestelements

SessionIDThe ID that iHub generates for the current archiving session.

ResultDefRequests the following information about the expired files:

■ DescriptionThe description of the file

■ PageCountThe number of pages in the file

■ SizeThe size of the file

■ TimeStampThe time the file was created or modified, in Coordinated Universal Time (UTC)

Page 250: Actuate API Reference - OpenText

232 A c t u a t e A P I R e f e r e n c e

S t a r t A r c h i v e

■ VersionNameThe version name of the file

■ OwnerThe owner of the file

■ AccessTypeThe file’s access type, private or shared

■ ACLThe access rights to the file

■ DependOnFilesInformation about the files on which the file depends

MaxFilesThe maximum number of files to retrieve and return in the result set. If not specified, the value is 1. iHub can return up to 500 files.

Responseschema

<xsd:complexType name="GetNextExpiredFilesResponse"><xsd:sequence>

<xsd:element name="ExpiredFiles"type="typens:ArrayOfFileInfo"/>

<xsd:element name="HasMore" type="xsd:boolean"/></xsd:sequence>

</xsd:complexType>

Responseelements

ExpiredFilesInformation about the expired files.

HasMoreIndicates whether more expired files are available. If True, more expired files are available.

StartArchiveStarts an archive pass. StartArchive is the first call that the API makes after initializing. After iHub receives the command to start the archive application, iHub waits five minutes to receive the StartArchive request. If it does not receive the request, iHub ignores the command and invalidates the SessionID.

Page 251: Actuate API Reference - OpenText

C h a p t e r 6 , A c t u a t e a r c h i v i n g A P I r e f e r e n c e 233

A r r a y O f F i l e I n f o

Requestschema

<xsd:complexType name="StartArchive"><xsd:sequence>

<xsd:element name="SessionID" type="xsd:string"/><xsd:element name="ProviderName" type="xsd:string"

minOccurs="0"/><xsd:element name="IncludeFolder" type="xsd:boolean"

minOccurs="0" /> </xsd:sequence>

</xsd:complexType>

Requestelements

SessionIDThe ID that iHub generates for the current archiving session.

ProviderNameA string identifying the archiving application.

IncludeFolderA flag indicating whether to include subfolders.

Responseschema

<xsd:complexType name="StartArchiveResponse"/><xsd:element name="StartArchiveResponse"

type="typens:StartArchiveResponse"/>

Archiving API data typesThis section describes archiving API data types.

ArrayOfFileInfoA complex data type that represents an array of FileInfo elements.

Schema <xsd:complexType name="ArrayOfFileInfo"><xsd:sequence>

<xsd:element name="FileInfo" type="typens:FileInfo"maxOccurs="unbounded" minOccurs="0" />

</xsd:sequence></xsd:complexType>

ArrayOfPermissionA complex data type that represents an array of Permission elements.

Page 252: Actuate API Reference - OpenText

234 A c t u a t e A P I R e f e r e n c e

A r r a y O f S t r i n g

Schema <xsd:complexType name="ArrayOfPermission"><xsd:sequence>

<xsd:element name="Permission" type="typens:Permission"maxOccurs="unbounded" minOccurs="0" />

</xsd:sequence></xsd:complexType>

ArrayOfStringA complex data type that represents an array of String elements.

Schema <xsd:complexType name="ArrayOfString"> <xsd:sequence> <xsd:element maxOccurs="unbounded" minOccurs="0"

name="String" type="xsd:string"/> </xsd:sequence>

</xsd:complexType>

Elements StringElement of the String data type.

FileAccessA simple data type that states whether a file is private or shared.

Schema <xsd:simpleType name="FileAccess"><xsd:restriction base="xsd:string">

<xsd:enumeration value="Private" /> <xsd:enumeration value="Shared" />

</xsd:restriction></xsd:simpleType>

FileInfoA complex data type that contains file information.

Schema <xsd:complexType name="FileInfo"><xsd:sequence>

<xsd:element name="Id" type="xsd:string" /> <xsd:element name="Name" type="xsd:string" /> <xsd:element name="Version" type="xsd:long" /> <xsd:element name="FileType" type="xsd:string" /> <xsd:element name="FileLocation" type="xsd:string" /> <xsd:element name="Description" type="xsd:string"

Page 253: Actuate API Reference - OpenText

C h a p t e r 6 , A c t u a t e a r c h i v i n g A P I r e f e r e n c e 235

F i l e I n f o

minOccurs="0" /> <xsd:element name="PageCount" type="xsd:long"

minOccurs="0"/> <xsd:element name="Size" type="xsd:long" minOccurs="0" /> <xsd:element name="TimeStamp" type="xsd:dateTime"

minOccurs="0" /> <xsd:element name="VersionName" type="xsd:string"

minOccurs="0" /> <xsd:element name="Owner" type="xsd:string" minOccurs="0" /> <xsd:element name="AccessType" type="typens:FileAccess"

minOccurs="0" /> <xsd:element name="ACL" type="typens:ArrayOfPermission"

minOccurs="0" /> <xsd:element name="DependOnFiles"

type="typens:ArrayOfFileInfo" minOccurs="0" /> </xsd:sequence>

</xsd:complexType>

Elements IdThe file ID.

NameThe file name.

VersionThe file version number.

FileTypeThe file type.

FileLocationThe location of the file.

DescriptionA description of the file.

PageCountThe number of pages within the file.

SizeThe size of the file.

TimeStampThe timestamp on the file.

VersionNameThe file version name.

OwnerThe owner of the file.

Page 254: Actuate API Reference - OpenText

236 A c t u a t e A P I R e f e r e n c e

H e a d e r

AccessTypeThe file access type.

ACLThe access control list for the file.

DependOnFilesA list of files that this file is dependent on.

HeaderThe SOAP header that contains authentication data, locale information, and other required or optional data.

Schema <xsd:complexType name="Header"> <xsd:sequence> <xsd:element name="AuthId" type="xsd:string"/>

<xsd:element minOccurs="0" name="TargetVolume" type="xsd:string"/>

<xsd:element minOccurs="0" name="Locale" type="xsd:string"/>

<xsd:element minOccurs="0" name="ConnectionHandle" type="xsd:string"/>

<xsd:element minOccurs="0" name="TargetServer" type="xsd:string"/>

<xsd:element minOccurs="0" name="DelayFlush" type="xsd:boolean"/>

<xsd:element minOccurs="0" name="FileType" type="xsd:string"/>

<xsd:element minOccurs="0" name="TargetResourceGroup" type="xsd:string"/>

<xsd:element minOccurs="0" name="RequestID" type="xsd:string"/>

</xsd:sequence> </xsd:complexType>

Elements AuthIdA system-generated, encrypted string. All requests except Login requests must have a valid AuthId in the SOAP header. The header passes this ID to Actuate iServer for validation.

TargetVolumeThe Encyclopedia volume to which to direct the request.

LocaleLocale is used to format data using the language, date and time conventions, currency and other locale-specific conventions.

Page 255: Actuate API Reference - OpenText

C h a p t e r 6 , A c t u a t e a r c h i v i n g A P I r e f e r e n c e 237

P e r m i s s i o n

ConnectionHandleAn optional element that supports keeping a connection open to view a persistent report.

TargetServerAn optional element that refers to the Actuate iServer within a cluster to which to direct the request.

DelayFlushA Boolean element that tells Actuate iServer to write updates to the disk when the value is False.

FileTypeAn optional element that supports specifying the file type to run, such as a BIRT design or HTMLfile.

TargetResourceGroupAn optional element that supports assigning a synchronous report generation request to a specific resource group at run time.

RequestIDA unique value that identifies the SOAP message.

PermissionA complex data type that describes access rights for roles or users.

Schema <xsd:complexType name="Permission"><xsd:sequence>

<xsd:choice><xsd:element name="RoleName" type="xsd:string" /> <xsd:element name="UserName" type="xsd:string" />

</xsd:choice><xsd:element name="AccessRight" type="xsd:string" />

</xsd:sequence></xsd:complexType>

Elements RoleNameThe role name being described.

UserNameThe user name being described.

Page 256: Actuate API Reference - OpenText

238 A c t u a t e A P I R e f e r e n c e

P e r m i s s i o n

AccessRightThe privileges the user or role has on an object. One or more of the following characters representing a privilege:

■ D—Delete

■ E—Execute

■ G—Grant

■ V—Visible

■ S—Secure Read

■ R—Read

■ W—Write

Page 257: Actuate API Reference - OpenText

Part 5Actuate JavaScript API

■ Actuate JavaScript API class reference

■ BIRT Interactive Crosstabs API class reference

PartFive5

Page 258: Actuate API Reference - OpenText
Page 259: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 241

C h a p t e r

7Chapter 7Actuate JavaScript API

class referenceThis chapter contains the following topics:

■ Actuate JavaScript API overview

■ Actuate JavaScript API classes quick reference

■ Actuate JavaScript API reference

Page 260: Actuate API Reference - OpenText

242 A c t u a t e A P I R e f e r e n c e

Actuate JavaScript API overviewThe Actuate JavaScript API is a set of JavaScript classes used to create custom web content that contains Actuate BIRT reports and report elements.

An HTML-based JSDoc JavaScript API class reference is provided for iHub Visualization Platform client and Actuate Java Components in the following file:

<Context Root>\help\jsapi\index.html

About the actuate namespaceAll of the Actuate JavaScript API classes are in the actuate namespace. To use the viewer element, call the actuate.Viewer class.

In addition, the Actuate JavaScript API has a static class:actuate

This class handles connections to Actuate web applications and is the only static class in the Actuate JavaScript API.

Using the Actuate libraryThe Actuate JavaScript library is available from any iHub Visualization Platform client installation or Actuate Deployment Kit for BIRT reports. The URL for the library is:http://127.0.0.1:8700/iportal/jsapi

■ 127.0.0.1:8700 is the host name and TCP port for an available Actuate web application host.

■ /iportal is the context root for the web application.

■ /jsapi is the default location of the Actuate JavaScript API libraries.

A script tag loads the Actuate JavaScript API library, as shown in the following code:

<script type="text/javascript" src="http://127.0.0.1:8700/iportal/jsapi">

</script>

To call JavaScript functions, use additional script tags after the script tag that adds these libraries for the page.

Actuate JavaScript API classes quick referenceTable 7-1 lists the Actuate JavaScript API classes.

Page 261: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 243

Table 7-1 Actuate JavaScript API classes

JavaScript class Description

actuate Entry point to the Actuate JavaScript API library

actuate.AuthenticationException Exception caused by failed authentication

actuate.ConnectionException Exception caused by a failed connection

actuate.Dashboard Dashboard class

actuate.dashboard.DashboardDefinition Dashboard wrapper class

actuate.dashboard.EventConstants Global constants for the dashboard events class

actuate.dashboard.GadgetScript Dashboard gadget script class

actuate.dashboard.Tab Dashboard tab class

actuate.data.Filter Conditions to filter data

actuate.data.ReportContent Represents downloaded content

actuate.data.Request Represents and processes a request for report data

actuate.data.ResultSet Results retrieved from a report document in response to a request

actuate.data.Sorter Sort conditions to sort data

actuate.DataService Data services to retrieve data from a report document

actuate.Exception Exception object passed to a callback function or exception handler

actuate.Parameter Parameters from a report

actuate.parameter.Constants Global navigation and layout constants used for the Parameter class

actuate.parameter.ConvertUtility Converts parameters into specific and generic formats

actuate.parameter.EventConstants Defines the events for parameters this API library supports

actuate.parameter.NameValuePair Display name and the associated value

(continues)

Page 262: Actuate API Reference - OpenText

244 A c t u a t e A P I R e f e r e n c e

actuate.parameter.ParameterData A high-level wrapper for an actuate.parameter.ParameterDefinition object

actuate.parameter.ParameterDefinition Qualities, options, name, and format for a parameter as the parameter displays and accepts values

actuate.parameter.ParameterValue The parameter’s value as processed by a report

actuate.report.Chart A report chart

actuate.report.DataItem A report data item

actuate.report.FlashObject A report Flash object

actuate.report.Gadget A report gadget

actuate.report.HTML5Chart.ClientChart An HTML5 enabled chart

actuate.report.HTML5Chart.ClientOption Options for an HTML5 enabled chart

actuate.report.HTML5Chart.ClientPoint A data point for an HTML5 enabled chart

actuate.report.HTML5Chart.ClientSeries A data series for an HTML5 enabled chart

actuate.report.HTML5Chart.Highcharts A Highcharts object

actuate.report.HTML5Chart.Renderer A Highcharts renderer object

actuate.report.Label A report label element

actuate.report.Table A report table element

actuate.report.TextItem A report text element

actuate.ReportExplorer The report explorer general container

actuate.reportexplorer.Constants Global constants used for ReportExplorer class

actuate.reportexplorer.EventConstants Global EventConstants used for ReportExplorer class

actuate.reportexplorer.File A file listed in the ReportExplorer and the file’s properties

actuate.reportexplorer.FileCondition A JavaScript version of com.actuate.schemas.FileCondition

Table 7-1 Actuate JavaScript API classes (continued)

JavaScript class Description

Page 263: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 245

Actuate JavaScript API referenceThis section provides an alphabetical listing of the JavaScript API classes.

actuate.reportexplorer.FileSearch A JavaScript version of com.actuate.schemas.FileSearch

actuate.reportexplorer.FolderItems A JavaScript version of com.actuate.schemas.GetFolderItemsResponse

actuate.reportexplorer.PrivilegeFilter A JavaScript version of com.actuate.schemas.PrivilegeFilter

actuate.RequestOptions URL parameters for requests to an iHub volume

actuate.Viewer A report viewer component that can be embedded in an HTML page

actuate.viewer.BrowserPanel A non-scrolling panel display

actuate.viewer.EventConstants Defines the events for the viewer this API library supports

actuate.viewer.PageContent Content shown on the viewer

actuate.viewer.ParameterValue Parameter values in the viewer

actuate.viewer.RenderOptions Options for downloading reports

actuate.viewer.ScrollPanel A scrolling panel display

actuate.viewer.SelectedContent Selected report element

actuate.viewer.UIConfig Enables UI elements of the scrolling panel display

actuate.viewer.UIOptions Enables UI elements of the viewer

actuate.viewer.ViewerException Exception constants supported for the viewer

Table 7-1 Actuate JavaScript API classes (continued)

JavaScript class Description

Page 264: Actuate API Reference - OpenText

246 A c t u a t e A P I R e f e r e n c e

actuate

Class actuateDescription The entry point to the Actuate JavaScript API library. The actuate class uses

load( ) to generate data, viewer, cross tab, parameter, explorer, and other components. The actuate class uses initialize( ) and authenticate( ) to connect to an Actuate web application service.

Use actuate.load( ) before calling actuate.initialize( ). The actuate.initialize( ) function loads all of the components added with load( ).

The initialize( ) function connects to an initial Actuate web application service. To connect to additional services simultaneously, use authenticate( ). Call initialize( ) before calling authenticate( ).

ConstructorThe static actuate class loads when the a <script> element loads the Actuate JavaScript API.

Function summaryTable 7-2 lists actuate functions.

Table 7-2 actuate functions

Function Description

authenticate( ) Connects to an Actuate web application service and authenticates

getDAViewer( ) Returns an Interactive Crosstab viewer instance

getDefaultIportalUrl( ) Returns the default service URL

getDefaultRequestOptions( ) Returns the default request options

getVersion( ) Returns the Actuate web application version

getUserId( ) Returns the user name of the logged-in user

getViewer( ) Returns a viewer instance

initialize( ) Connects to an initial Actuate web application service, loads an initial component, and invokes a callback function

isConnected( ) Reports whether a given Actuate web application is connected

isInitialized( ) Returns whether a library is initialized

load( ) Loads the library for an additional component

Page 265: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 247

actuate

authenticateSyntax void authenticate(string iPortalURL, actuate.RequestOptions requestOptions,

string userid, string password, function callback, string credentials, function errorCallback)

Connects to the Actuate web application service that is addressed by iPortalURL and authenticates the connection.

Parameters iPortalURLThe iPortalURL parameter is a required string parameter that specifies the target Actuate web application URL.

requestOptionsThe requestOptions parameter is an optional actuate.RequestOptions object. The requestOptions parameter defines the URL parameters to send with the authentication request, such as the iHub URL, volume, or repository type. Functions in the RequestOptions class enable the addition of custom parameters to the URL. When requestOptions is null, authenticate( ) uses the default parameter values for the target Actuate web application URL. These default parameter values are defined in the Actuate web application’s web.xml file.

useridThe userid parameter is an optional string parameter that contains the login user id when the login user id is not provided in the session.

passwordThe password parameter is an optional string parameter that contains the login password when the login password is not provided in the session.

credentialsThe credentials parameter is an optional string parameter. This parameter holds information that supports checking user credentials with an externalized system such as LDAP. The credentials parameter supports additional credential information for any additional security systems in place on the application server where the web service is deployed.

callbackThe callback parameter is an optional function to call after initialization. The actuate.authenticate( ) function passes the following variables to the callback function:

■ iportalURL: The iportal URL passed in from the iPortalURL parameter

logout( ) Logs a user out of an Actuate web application service

Table 7-2 actuate functions

Function Description

Page 266: Actuate API Reference - OpenText

248 A c t u a t e A P I R e f e r e n c e

actuate

■ userid: The authenticated user ID

■ iserverURL: The BIRT iHub URL

■ volume: The volume name

errorCallbackThe errorCallback parameter is an optional function that specifies a function to call when an error occurs. The possible errors are actuate.ConnectionException, actuate.AuthenticationException, and actuate.Exception. The callback function must take an exception as an argument.

Example To connect to an additional Actuate web service called digits, use code similar to the following:

actuate.authenticate("http://digits:8700/iportal", null, myname, mypassword, null, null, null);

getDAViewerSyntax actuate.XTabAnalyzer getDAViewer(string bookmark)

actuate.XTabAnalyzer getDAViewer(htmlelement daviewer)

Returns an Interactive Crosstab viewer instance containing the given bookmark element. Load the xTabAnalyzer module before calling actuate.getDAViewer( ).

Parameters bookmark This string parameter contains the name of the bookmark to retrieve or the name of an HTML <div> element.

daviewer This parameter is the DOM htmlelement object for the HTML <div> element that contains an Interactive Crosstab viewer.

Returns An actuate.XTabAnalyzer object that contains an Interactive Crosstab viewer. When actuate.getDAViewer( ) does not find an Interactive Crosstab viewer, the function returns null.

Example To retrieve the Interactive Crosstab viewer assigned to the first_daviewer <div> element on the page, use code similar to the following:

currentViewer = actuate.getDAViewer("first_daviewer");

getDefaultIportalUrlSyntax String getDefaultIportalUrl( )

Returns the default service URL.

Returns String. The default service URL.

Page 267: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 249

actuate

Example This example calls actuate.getDefaultIportalUrl( ) to return the default service URL:

alert ("The default service URL is " + actuate.getDefaultIportalUrl( ));

getDefaultRequestOptionsSyntax actuate.RequestOptions getDefaultRequestOptions( )

Returns the default request options.

Returns actuate.RequestOptions object that contains the default request options.

Example This example calls actuate.getDefaultRequestOptions( ) to return the default iHub URL:

alert ("The default iHub URL is " + actuate.getDefaultRequestOptions( ).getServerUrl( ));

getUserIdSyntax string getUserId( )

Returns the user name of the logged-in user that was supplied to authenticate( ). If single sign-on is used and login occurs without passing credentials to authenticate( ), this method returns null or an empty string.

Returns String. The user name provided to actuate.authenticate( ). Null or an empty string if authenticate is not used to log in.

Example The following sample code displays the user name in an alert box:

alert("User name: " + actuate.getUserId( ));

getVersionSyntax string getVersion( )

Returns the Actuate web application version.

Returns String. The string contains the Actuate web application version in the format "#version# (Build #buildnumber#)".

Example The following sample code displays the version in an alert box:

alert("Version: " + actuate.getVersion( ));

getViewerSyntax actuate.Viewer getViewer(string bookmark)

Page 268: Actuate API Reference - OpenText

250 A c t u a t e A P I R e f e r e n c e

actuate

actuate.Viewer getViewer(htmlelement viewer)

Returns a viewer instance containing the given bookmark element. Load the viewer module before calling actuate.getViewer( ).

Parameters bookmark This string parameter contains the name of the bookmark to retrieve or the name of an HTML <div> element.

viewer This parameter is the DOM htmlelement object for the HTML <div> element that contains a viewer.

Returns An actuate.Viewer object that contains a viewer. When actuate.getViewer( ) does not find a viewer, the function returns null.

Example To retrieve the viewer assigned to the first_viewer <div> element on the page, use code similar to the following:

currentViewer = actuate.getViewer("first_viewer");

initializeSyntax void initialize(string iPortalURL, actuate.RequestOptions requestOptions,

reserved, reserved, function callback, function errorCallback)

Connects to an initial Actuate web application service, loads all of the components added with load( ), and invokes a callback function.

Authentication is optional in initialize( ).

When using more than one service in one mashup page, use actuate.authenticate( ) to connect to additional services.

Parameters iPortalURLString. The target Actuate web application URL.

requestOptionsactuate.RequestOptions object. Optional. requestOptions defines URL parameters to send in the authentication request, such as the iHub URL, volume, or repository type. It can also add custom parameters to the URL. If requestOptions is null, initialize( ) uses the default parameter values for the target Actuate web application URL. These default parameter values are defined in Actuate web application’s web.xml file. Loading performance is improved if you create a requestOptions object to pass to initialize().

reservedSet to null.

reservedSet to null.

Page 269: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 251

actuate

callbackFunction. The callback function called after the initialization is done. The following arguments are passed to the callback function:

■ iportalUrl: The iportal URL passed in from the iPortalURL parameter

■ userId: The authenticated user ID

■ iserverUrl: The BIRT iHub URL

■ volume: The volume name

errorCallbackFunction. The function to call when an error occurs. The possible errors are actuate.ConnectionException, actuate.AuthenticationException, and actuate.Exception. errorCallback must take an exception as an argument.

Example To initialize the client connection to a web service on myhost and then run the init( ) function, use the following code:

actuate.initialize("http://myhost:8700/iportal", null, null, null, init, null);

isConnectedSyntax boolean isConnected(string iportalUrl, actuate.RequestOptions requestOptions)

Returns whether a given Actuate web application URL is connected.

Parameters iPortalURLString. The target Actuate web application URL.

requestOptionsactuate.RequestOptions object. Optional. requestOptions defines URL parameters to send with the authentication request, such as the iHub URL, volume, or repository type. It can also add custom parameters to the URL. If requestOptions is null, isConnected( ) uses the default parameter values for the target Actuate web application URL. These default parameter values are defined in Actuate web application’s web.xml file.

Returns Boolean. True if there is a connection to the given Actuate web application, False if there is no connection or if it is pending.

Example The following sample code connects to the digits service using authenticate if not currently connected:

if (!actuate.isConnected("http://digits:8700/iportal", null)){actuate.authenticate("http://digits:8700/iportal", null,

myname, mypassword, null, null, null);}

Page 270: Actuate API Reference - OpenText

252 A c t u a t e A P I R e f e r e n c e

actuate

isInitializedSyntax boolean isInitialized( )

Returns whether the library is already initialized.

Returns Boolean. True if the library is already initialized.

Example The following sample code initializes a connection with the Actuate web service if one is not already initialized:

if (!actuate.isInitialized( )){actuate.initialize("http://myhost:8700/iportal", null, null,

null, init, null);}

loadSyntax void load(string componentName)

Specifies a component for actuate.initialize( ) to load. Call this method before calling initialize( ). Available components are:

■ dashboard: The dashboard component including the actuate.dashboard package and actuate.Dashboard class

■ parameter: The parameter page component including the actuate.parameter package and actuate.Parameter class

■ reportexplorer: The report explorer component including the actuate.reportexplorer package and actuate.ReportExplorer class

■ viewer: The viewer component including the actuate.viewer and actuate.data packages, and the actuate.Viewer and actuate.DataService classes

■ xtabAnalyzer: The interactive crosstab component, including the actuate.xtabanalyzer package and actuate.XTabAnalyzer class

Parameter componentNameString. componentName is a case-sensitive parameter. Valid component names are listed above.

Example To enable a page to use viewer and parameters, call actuate.load( ) twice, as shown in the following code:

actuate.load("viewer");actuate.load("parameter");

logoutSyntax void logout(string iPortalURL, actuate.RequestOptions requestOptions, function

callback, function errorCallback)

Page 271: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 253

actuate

Logs out from the given Actuate web application URL and removes authentication information from the session. If the application was previously not logged in to this Actuate web application, it generates no errors but still calls the callback function.

Parameters iPortalURLString. The target Actuate web application URL.

requestOptionsactuate.RequestOptions object. Optional. requestOptions defines URL parameters to send with the authentication request, such as the iHub URL, volume, or repository type. It can also add custom parameters to the URL. If requestOptions is null, initialize( ) uses the default parameter values for the target Actuate web application URL. These default parameter values are defined in Actuate web application’s web.xml file.

callbackFunction. Optional. The callback function called after the logout completes. The following arguments are passed to the callback function:

■ iportalUrl: The iportal URL passed in from the iPortalURL parameter

■ iserverUrl: The BIRT iHub URL

■ volume: The volume name

errorCallbackFunction. The function called when an error occurs. The possible errors are actuate.ConnectionException, actuate.AuthenticationException, and actuate.Exception. errorCallback must take an exception as an argument.

Example The following sample code disconnects to the digits service if currently connected:

if (actuate.isConnected("http://digits:8700/iportal", null)){actuate.logout("http://digits:8700/iportal", null, null, null);

}

Page 272: Actuate API Reference - OpenText

254 A c t u a t e A P I R e f e r e n c e

actuate.Authent icat ionException

Class actuate.AuthenticationExceptionDescription AuthenticationException provides an object to pass to a error callback function

when an authentication exception occurs. The AuthenticationException object contains references to the URL, the UserId, and the request options used in the authentication attempt.

ConstructorThe AuthenticationException object is constructed when actuate.authenticate( ) fails.

Function summaryTable 7-3 lists actuate.AuthenticationException functions.

getIportalUrlSyntax string AuthenticationException.getIportalUrl( )

Returns the URL used for the authentication attempt. This URL is the provided Information Console URL plus any parameters provided as request options.

Returns String.

Example The following sample code retrieves the URL from an exception:

return AuthenticationException.getIportalUrl( );

getRequestOptionsSyntax actuate.RequestOptions AuthenticationException.getRequestOptions( )

Returns an instance of the RequestOptions that modified the URL that caused the exception, if applicable.

Returns actuate.RequestOptions object. A RequestOptions object defines URL parameters sent in the authentication request, such as the iHub URL, volume, or repository type. The RequestOptions object can also add custom parameters to the URL.

Table 7-3 actuate.AuthenticationException functions

Function Description

getIportalUrl( ) Returns the web service URL

getRequestOptions( ) Returns the request options

getUserId( ) Returns the user ID

Page 273: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 255

actuate.Authent icat ionExcept ion

Example The following sample code retrieves the RequestOptions object that caused the exception:

var exceptReqOpts = AuthenticationException.getRequestOptions( );

getUserIdSyntax string AuthenticationException.getUserId( )

Returns the user name provided to the failed authentication attempt.

Returns String.

Example The following sample code retrieves the UserId from an exception:

return AuthenticationException.getUserId( );

Page 274: Actuate API Reference - OpenText

256 A c t u a t e A P I R e f e r e n c e

actuate.Connect ionExcept ion

Class actuate.ConnectionExceptionDescription A container for a connection exception. ConnectionException provides an object

to pass to a error callback function when an exception occurs.

ConstructorThe ConnectionException object is constructed when there is a connection issue. For example, actuate.ConnectionException is created when a wrong URL is given in actuate.initialize( ) or actuate.authenticate( ), or if the server was unreachable.

Function summaryTable 7-4 describes actuate.ConnectionException functions.

getUrlSyntax string ConnectionException.getUrl( )

Returns the complete URL sent with the connection request. This URL is the provided Information Console URL plus any parameters provided as request options.

Returns String. The complete URL that was sent with the connection request.

Example This example calls ConnectionException.getUrl( ) to return the complete URL from a connection request:

alert ("Connection Error at " + ConnectionException.getUrl( ));

Table 7-4 actuate.ConnectionException function

Function Description

getUrl( ) Returns the whole URL

Page 275: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 257

actuate.Dashboard

Class actuate.DashboardDescription Represents a dashboard object.

ConstructorSyntax actuate.Dashboard(string container)

Constructs a dashboard object.

Parameter containerString. Optional. Container object or name of a container in the current document in which to render controls.

Function summaryTable 7-5 describes actuate.Dashboard functions.

Table 7-5 actuate.Dashboard functions

Function Description

downloadDashboard( ) Downloads the dashboard definitions.

embedTemplate( ) The personal dashboard uses an embedded template file.

getActiveTab( ) Returns the active tab name.

getDashboardName( ) Returns the dashboard name used by the dashboard object.

getTemplate( ) Returns the iHub volume repository path.

isAutoSaveEnabled( ) Returns whether autosave is enabled.

isSavingNeeded( ) Returns whether there are unsaved changes on the dashboard.

isUsingPersonalDashboard( ) Returns whether the dashboard is a personal dashboard.

onUnload( ) Unloads JavaScript variables that are no longer needed by the dashboard.

registerEventHandler( ) Registers an event handler.

removeEventHandler( ) Removes an event handler.

renderContent( ) Renders the dashboard.

save( ) Saves the dashboard as a .dashboard file.

saveAs( ) Saves the dashboard in non-default location.

(continues)

Page 276: Actuate API Reference - OpenText

258 A c t u a t e A P I R e f e r e n c e

actuate.Dashboard

downloadDashboardSyntax void Dashboard.downloadDashboard(function callback)

Downloads the dashboard metadata definitions.

Parameter callbackFunction. The callback function to use after the dashboard finishes downloading. This function must take the returned dashboard object as an input parameter.

Example This example specifies a function to call after the dashboard object finishes downloading:

myDashboard.downloadDashboard(runNext);function runNext(dashobject){

mydashboard.getDashboardName(dashobject);}

embedTemplateSyntax void Dashboard.embedTemplate(boolean isEmbedded)

A personal dashboard can use a shared template file or embed a template file.

setActiveTab( ) Sets a specific tab as the active tab.

setAutoSaveDelay( ) Sets the time interval before executing an automatic save for a personal dashboard.

setContainer( ) Sets the container for rendering the dashboard page HTML fragment.

setDashboardName( ) Sets the dashboard name to view.

setHeight( ) Sets the dashboard height.

setService( ) Sets the connection to the Actuate web service.

setSize( ) Sets the dashboard size.

setTemplate( ) Sets the template path.

setWidth( ) Sets the dashboard width.

showTabNavigation( ) Shows the tab toolbar.

submit( ) Submits the dashboard page component request.

usePersonalDashboard( ) Forces the dashboard framework to use a personal dashboard.

Table 7-5 actuate.Dashboard functions (continued)

Function Description

Page 277: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 259

actuate.Dashboard

Parameter isEmbeddedBoolean. When the isEmbedded parameter is true, the personal dashboard uses an embedded template file. The default value is false.

Example This example specifies that the personal dashboard myDashboard uses an embedded template file:

myDashboard.embedTemplate(true);

getActiveTabSyntax string Dashboard.getActiveTab

Returns the name of the current active tab for the dashboard.

Returns String. The name of the current active dashboard tab.

Example This example displays the name of the active tab for the myDashboard dashboard object in an alert box:

alert(myDashboard.getActiveTab( ));

getDashboardNameSyntax string Dashboard.getDashboardName( )

Returns the dashboard name used by the dashboard object.

Returns String. The dashboard’s name.

Example This example displays the dashboard object’s dashboard name in an alert box:

alert(myDashboard.getDashboardName( ));

getTemplateSyntax string Dashboard.getTemplate( )

Returns the repository path for the iHub volume.

Returns String. The repository path for the iHub volume.

Example This example displays the repository path for the iHub volume in an alert box:

alert(myDashboard.getTemplate( ));

isAutoSaveEnabledSyntax boolean Dashboard.isAutoSaveEnabled( )

Returns whether the autosave feature is enabled.

Returns Boolean. True indicates that autosave is enabled.

Page 278: Actuate API Reference - OpenText

260 A c t u a t e A P I R e f e r e n c e

actuate.Dashboard

Example This example informs the user of the status of the autosave feature:

if (dashboard.isAutoSavEnabled()){alert("Autosave is enabled.");

}else{alert("Autosave is disabled.");

}

isSavingNeededSyntax boolean Dashboard.isSavingNeeded( )

Returns whether there are unsaved changes on the dashboard.

Returns Boolean. True indicates that there are unsaved changes on the dashboard.

Example This example informs the user of unsaved changed:

if (dashboard.isSavingNeeded()){alert("The dashboard contains unsaved changes.");

}

isUsingPersonalDashboardSyntax boolean Dashboard.isUsingPersonalDashboard( )

Returns whether this dashboard is a personal dashboard.

Returns Boolean. True indicates that this dashboard is a personal dashboard.

Example This example informs the user that they are using a personal dashboard:

if (dashboard.isUsingPersonalDashboard)){alert("This is a personal dashboard.");

}

onUnloadSyntax void Dashboard.onUnload( )

Unloads JavaScript variables that are no longer needed by the dashboard.

Example This example unloads JavaScript variables and displays the dashboard object’s dashboard name in an alert box:

myDashboard.onUnload;alert("JS variables unloaded for " +

myDashboard.getDashboardName( ));

Page 279: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 261

actuate.Dashboard

registerEventHandlerSyntax void Dashboard.registerEventHandler(string eventName, function handler)

Registers an event handler to activate for parameter eventName. This function can assign several handlers to a single event.

Parameters eventNameString. Event name to capture.

handlerFunction. The function to execute when the event occurs. The handler must take two arguments: The dashboard instance that fired the event and an event object specific to the event type.

Example This example registers the errorHandler( ) function to respond to the ON_EXCEPTION event:

myDashboard.registerEventHandler(actuate.dashboard.EventConstants.ON_EXCEPTION, errorHandler);

removeEventHandlerSyntax void Dashboard.removeEventHandler(string eventName, function handler)

Removes an event handler to activate for parameter eventName.

Parameters eventNameString. Event name to remove from the internal list of registered events.

handlerFunction. The function to disable.

Example This example removes the errorHandler( ) function from responding to the ON_EXCEPTION event:

myDashboard.removeEventHandler(actuate.dashboard.EventConstants.ON_EXCEPTION, errorHandler);

renderContentSyntax void Dashboard.renderContent(object[ ] dashboardDefinitions, function callback)

Renders the dashboard definitions content to the container. The submit API calls the renderContent API internally. The renderContent( ) function assumes that the user has already a list of DashboardDefinition to process.

Parameters dashboardDefinitionsArray of objects. Each object is some piece of dashboard metadata and as many can be added as needed. Typically, this array contains the following metadata:

■ Number of tabs in a dashboard file

Page 280: Actuate API Reference - OpenText

262 A c t u a t e A P I R e f e r e n c e

actuate.Dashboard

■ Number of sections/columns in a dashboard tab

■ Number of gadgets in each section/column

■ Attributes of each gadget

■ Attributes of each tab

■ Dependency information between gadgets to support publishing and subscribing mechanism

callbackFunction. The callback function to call after renderContent( ) finishes.

Example This example renders the myDash dashboard object using the dashboardDefinition array defs and calls afterRender( ) once complete:

myDash.renderContent(defs, afterRender);

saveSyntax void Dashboard.save(function callback, boolean flag)

Saves the dashboard as a .dashboard file.

Parameters callbackFunction. Optional. The function to execute after the save operation completes.

flagBoolean. Optional. True indicates a synchronous save operation.

Example This example saves the dashboard as a .dashboard file:

myDash.save( );

saveAsSyntax void Dashboard.saveAs(function callback, string saveAsPath, boolean replace,

boolean flag)

Saves the dashboard as a .dashboard file to a specific path.

Parameters callbackFunction. Optional. The function to execute after the save operation completes.

saveAsPathString. Optional. Fully qualified path in which to save the dashboard. The default value is the path for the original dashboard file, if one exists, or the path for the user’s home directory.

replaceBoolean. Optional. True indicates to replace the latest version of the file. False indicates to create a new version.

Page 281: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 263

actuate.Dashboard

flagBoolean. Optional. True indicates a synchronous save operation.

Example This example saves the dashboard as a .dashboard file, replacing the latest version:

myDash.saveAs(null, null, true, true);

setActiveTabSyntax void Dashboard.setActiveTab(string tabName)

Sets a specified tab as the active tab. Only one tab can be active at a time.

Parameter tabNameString. The name of the tab to set as the active tab.

Example This example sets the Files tab as the active tab for this dashboard:

myDash.setActiveTab("Files");

setAutoSaveDelaySyntax void Dashboard.setAutoSaveDelay(integer seconds)

Sets the amount of time before executing an automatic save for a personal dashboard.

Parameter secondsInteger. The number of seconds to delay the automatic save.

Example This example sets the delay for the automatic save for dashboard myDash to 5 minutes:

myDash.setAutoSaveDelay(300);

setContainerSyntax void Dashboard.setContainer(string containerID)

The container that will be used for rendering the dashboard page HTML fragment.

Parameter containerID String. The container ID.

Example This example sets the container where the myDash dashboard object renders:

myDash.setContainer("leftpane");

Page 282: Actuate API Reference - OpenText

264 A c t u a t e A P I R e f e r e n c e

actuate.Dashboard

setDashboardNameSyntax void Dashboard.setDashboardName(string dashboardName)

Sets the dashboard name to view.

Parameter dashboardNameString. A fully qualified repository path and file name.

Example This example sets the path for the myDash dashboard object:

myDash.setDashboardName("/Dashboard/Contents/Hello.DASHBOARD");

setHeightSyntax void Dashboard.setHeight(integer height)

Sets the dashboard’s startup height.

Parameter heightInteger. Specifies the height in pixels.

Example To set the dashboard height to 400 pixels, use code similar to the following:

myDashboard.setHeight(400);

setServiceSyntax void Dashboard.setService(string iportalURL, actuate.RequestOptions

requestOptions)

Sets the web service this dashboard component connects to.

Parameters iportalURLString. The URL of the web service to connect to.

requestOptionsactuate.RequestOptions object. Request options, if any, to apply to the connection. See actuate.RequestOptions for details on the options that this parameter can set.

Example This example connects a dashboard component to the iPortal service and adds a custom URL parameter:

function setDashboardService( ){myDashboard.setService("http://127.0.0.1:8700/iportal",

myRequestOptions.setCustomParameters({myParam: "myValue"});}

setSizeSyntax void Dashboard.setSize(integer height, integer width)

Page 283: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 265

actuate.Dashboard

Sets the dashboard’s startup size.

Parameters heightInteger. Height in pixels.

widthInteger. Width in pixels.

Example To set the dashboard height to 400 pixels and the width to 800 pixels, use code similar to the following:

myDashboard.setSize(400, 800);

setTemplateSyntax void Dashboard.setTemplate(string path)

Sets the template path. This function overwrites the template path that is used by iHub Visualization Platform client.

Parameter pathString. Specifies a new template path. Use an iHub volume repository path.

Example This example sets the template path for myDashboard to /iportal/jsapi/template/path:

myDashboard.setTemplate("/iportal/jsapi/template/path");

setWidthSyntax void Dashboard.setWidth(integer width)

Sets the dashboard’s startup width.

Parameter widthInteger. Specifies the width in pixels.

Example To set the dashboard width to 800 pixels, use code similar to the following:

myDashboard.setWidth(800);

showTabNavigationSyntax void Dashboard.showTabNavigation(boolean show)

Shows the tab toolbar.

Parameter showBoolean. The tab toolbar is visible when this parameter is set to true.

Example To show the tab toolbar for the myDashboard dashboard object, use code similar to the following:

Page 284: Actuate API Reference - OpenText

266 A c t u a t e A P I R e f e r e n c e

actuate.Dashboard

myDashboard.showTabNavigation(true);

submitSyntax void Dashboard.submit(function callback)

Submits requests to the server for the dashboard. When this function is called, an AJAX request is triggered to submit all pending operations. When the server finishes the processing, it returns a response and the results are rendered on the page in the dashboard container.

Parameter callbackFunction. The function to execute after the asynchronous call processing is done.

Example This example submits the dashboard name that was set with setDashboardName( ):

dash.setDashboardName("/Dashboard/Contents/Hello.DASHBOARD");dash.submit( );

usePersonalDashboardSyntax void Dashboard.usePersonalDashboard(boolean true|false)

Forces the dashboard framework to use the user’s personal dashboard.

Parameter true|falseBoolean. A value of true sets the dashboard framework to ignore any value set by the setDashboardName( ) method. The dashboard framework creates a new personal dashboard file for the logged in user when no personal dashboard file is present.

Example To force the use of a personal dashboard for the myDashboard object, use code similar to the following:

myDashboard.usePersonalDashboard(true);

Page 285: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 267

actuate.dashboard.DashboardDefini t ion

Class actuate.dashboard.DashboardDefinitionDescription The DashboardDefinition class is a wrapper class for a dashboard file definition.

ConstructorSyntax actuate.dashboard.DashboardDefinition( )

Constructs a new DashboardDefinition object.

Function summaryTable 7-6 lists the actuate.dashboard.DashboardDefinition functions.

getDefaultActiveTabSyntax string DashboardDefinition.getDefaultActivetab( )

Returns the name of the default active tab for this dashboard definition.

Returns String. The name of the default active tab.

Example This example displays the default active tab for the myDashDef DashboardDefinition object in an alert box:

alert(myDashboard.getDefaultActiveTab( ));

getTabsSyntax array DashboardDefinition.getTabs( )

Returns an array of the tabs in this dashboard definition.

Returns Array. An array of actuate.dashboard.Tab objects.

Example This example assigns the array of tabs to the mytabs variable:

var mytabs = new Array[myDashDef.getTabs( )];

Table 7-6 actuate.dashboard.DashboardDefinition functions

Function Description

getDefaultActiveTab( ) Returns the name of the default active tab for this dashboard definition

getTabs( ) Returns an array of the tabs in this dashboard definition

Page 286: Actuate API Reference - OpenText

268 A c t u a t e A P I R e f e r e n c e

actuate.dashboard.EventConstants

Class actuate.dashboard.EventConstantsDescription Defines the event constants supported by the Dashboard class. Table 7-7 lists the

dashboard event constants.

Table 7-7 Actuate JavaScript API dashboard event constants

Event Description

ON_EXCEPTION Event triggered when an exception occurs.The event handler takes an actuate.Exception object as an input parameter.

ON_SESSION_TIMEOUT Session time-out event.Whenever a session time-out event occurs and the user tries to perform any operation on the explorer, a prompt dialog appears to ask whether the user wants to log in again. If the user clicks yes, the ON_SESSION_TIMEOUT event fires. If no handler has been registered for this event, the viewer displays a default login dialog.The event handler takes the current actuate.Dashboard object as an input parameter.

Page 287: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 269

actuate.dashboard.GadgetScript

Class actuate.dashboard.GadgetScriptDescription The actuate.dashboard.GadgetScript class is a container for the information

passed to the onChange event function.

ConstructorSyntax onChange( string event, actuate.dashboard.GadgetScript publisher, object data,

actuate.dashboard.GadgetScript thisGadget )

Constructs a new GadgetScript object. This object contains the publisher and thisGadget for an onChange event signature.

Parameters eventString. An event name.

publisheractuate.dashboard.GadgetScript object. The publisher gadget.

dataObject. Data to pass to the subscriber.

thisGadgetactuate.dashboard.GadgetScript object. thisGadget is this script gadget.

Function summaryTable 7-8 lists the actuate.dashboard.GadgetScript functions.

Table 7-8 actuate.dashboard.GadgetScript functions

Function Description

getCurrentReportParameters( ) Gets the current report parameter values for thisGadget

getGadgetName( ) Returns thisGadget’s name

getGadgetTitle( ) Returns thisGadget’s title

getGadgetType( ) Returns thisGadget’s type

getTabName( ) Returns the name of the tab containing thisGadget

getTabTitle( ) Returns the title of the tab containing thisGadget

Page 288: Actuate API Reference - OpenText

270 A c t u a t e A P I R e f e r e n c e

actuate.dashboard.GadgetScript

getCurrentReportParametersSyntax actuate.parameter.ParameterValue[ ]

GadgetScript.getCurrentReportParameters( )

Returns the current report parameter values for report and Reportlet gadgets.

Returns Array of actuate.parameter.ParameterValue objects. Parameter values assigned to this gadget.

getGadgetNameSyntax string GadgetScript.getGadgetName( )

Returns this gadget’s name.

Returns String. The name of this gadget.

Example This example displays this gadget’s name in an alert box:

alert(myGadgetScript.getGadgetName( ));

getGadgetTitleSyntax string GadgetScript.getGadgetTitle( )

Returns this gadget’s title.

Returns String. The title of this gadget.

Example This example displays this gadget’s title in an alert box:

alert(myGadgetScript.getGadgetTitle( ));

getGadgetTypeSyntax string GadgetScript.getGadgetType( )

Returns this gadget’s type.

Returns String. This gadget’s type.

Example This example displays this gadget’s type in an alert box:

alert(myGadgetScript.getGadgetType( ));

getTabNameSyntax string GadgetScript.getTabName( )

Returns the name of the tab containing this gadget.

Returns String. The name of the tab containing this gadget.

Page 289: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 271

actuate.dashboard.GadgetScript

Example This example displays the name of the tab containing this gadget in an alert box:

alert(myGadgetScript.getTabName( ));

getTabTitleSyntax string GadgetScript.getTabTitle( )

Returns the title of the tab containing this gadget.

Returns String. The title of the tab containing this gadget.

Example This example displays the title of the tab containing this gadget in an alert box:

alert(myGadgetScript.getTabTitle( ));

Page 290: Actuate API Reference - OpenText

272 A c t u a t e A P I R e f e r e n c e

actuate.dashboard.Tab

Class actuate.dashboard.TabDescription A wrapper class for the raw definition of a tab in a dashboard file.

ConstructorSyntax actuate.dashboard.Tab( )

Constructs a new tab object.

Function summaryTable 7-9 lists the actuate.dashboard.Tab functions.

getNameSyntax string Tab.getName( )

Returns the tab’s name.

Returns String. The name of the tab.

Example This example displays the tab object’s name in an alert box:

alert(myTab.getName( ));

getTabTypeSyntax string Tab.getTabType( )

Returns the tab’s type.

Returns String. The tab’s type. The legal type values are ISystemTabHandle and ITabHandle.

Example This example displays the tab object’s type in an alert box:

alert(myTab.getTabType( ));

Table 7-9 actuate.dashboard.Tab functions

Function Description

getName( ) Returns the tab’s name

getTabType( ) Returns the tab’s type

getTitle( ) Returns the tab’s title

Page 291: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 273

actuate.dashboard.Tab

getTitleSyntax string Tab.getTitle( )

Returns the tab’s title.

Returns String. The title of the tab.

Example This example displays the tab object’s title in an alert box:

alert(myTab.getTitle( ));

Page 292: Actuate API Reference - OpenText

274 A c t u a t e A P I R e f e r e n c e

actuate.data.Fi l ter

Class actuate.data.FilterDescription Specifies filter conditions to be used by other classes when processing data. A

filter has three components: a column, an operator, and a value or set of values. The condition is expressed as "value1 operator value2". For some operators, like "IN", the expression will be "value1 IN value2" where value2 is an array of strings.

Format numbers and date/time values in a locale neutral format, for example, "2.5" or "09/31/2008 01:02:03 AM".

ConstructorSyntax actuate.data.Filter(string columnName, string operator, string[ ] value1,

string[ ] value2)

Constructs a filter object.

Parameters columnNameString. The column name.

operatorString. The operator can be any operator. Table 7-10 lists the valid filter operators and the number of arguments to pass to the constructor or setValues( ).

Table 7-10 Filter operators

Operator DescriptionNumber ofarguments

BETWEEN Between an inclusive range 2

BOTTOM_N Matches the bottom n values 1

BOTTOM_PERCENT Matches the bottom percent of the values

1

EQ Equal 1

FALSE Matches false Boolean values 0

GREATER_THAN Greater than 1

GREATER_THAN_OR_EQUAL Greater than or equal 1

IN Matches any value in a set of values

1+

LESS_THAN Less than 1

LESS_THAN_OR_EQUAL Less than or equal 1

LIKE Search for a pattern 1

MATCH Matches a pattern 1

Page 293: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 275

actuate.data.Fil ter

value1String or array of strings. The first value to compare to the column value for the BETWEEN or NOT_BETWEEN operators.

value2String or array of strings. This parameter is only required for the BETWEEN or NOT_BETWEEN operators.

Example To select all of the rows matching a list of countries in their country fields, use code similar to the following:

var filter = new actuate.data.Filter("COUNTRY", actuate.data.Filter.IN,["Canada" , "USA", "UK", "Australia"]);

To create a filter to display only entries with a CITY value of NYC, use the following code:

var cityfilter = new actuate.data.Filter("CITY", actuate.data.Filter.EQ, "NYC");

Function summaryTable 7-11 lists actuate.data.Filter functions.

NOT_BETWEEN Not between an inclusive range

2

NOT_EQ Not equal 1

NOT_IN Does not match any value in a set of values

1+

NOT_LIKE Search for values that do not match a pattern

1

NOT_MATCH Does not match a pattern 1

NOT_NULL Is not null 0

NULL Is null 0

TOP_N Matches the top n values 1

TOP_PERCENT Matches the top percent of the values

1

TRUE Matches true Boolean values 0

Table 7-10 Filter operators

Operator DescriptionNumber ofarguments

Page 294: Actuate API Reference - OpenText

276 A c t u a t e A P I R e f e r e n c e

actuate.data.Fi l ter

getColumnNameSyntax string Filter.getColumnName( )

Returns the column name.

Returns String. The name of the column.

Example This example retrieves the name of the column:

function retrieveColumnName(myFilter){var colname = myFilter.getColumnName( );return colname;

}

getOperatorSyntax string Filter.getOperator( )

Returns the filter operator.

Returns String. Table 4-10 lists the legal filter operator values.

Example This example retrieves the name of the filter operator:

function retrieveFilterOperator(myFilter){var myOp = myFilter.getOperator( );return myOp;

}

getValuesSyntax string Filter.getValues( )

string[ ] Filter.getValues( )

Returns the evaluated results of this filter. When the filter is constructed or set with a single argument, the returned value corresponds to the single argument.

Table 7-11 actuate.data.Filter functions

Function Description

getColumnName( ) Returns the column name

getOperator( ) Returns the filter operator

getValues( ) Returns the value or values of the filter

setColumnName( ) Sets the name of the column to filter

setOperator( ) Sets the operator for the filter

setValues( ) Sets string values for the filter

Page 295: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 277

actuate.data.Fil ter

When two arguments or an array are set in the filter, the return value is an array of values.

Returns String or array of strings. Returns the value or values from the filter.

Example This example retrieves the name of the filter operator:

function retrieveValues(myFilter){var myVals = myFilter.getValues( );return myVals;

}

setColumnNameSyntax void Filter.setColumnName(columnName)

Sets the name of the column to filter.

Parameter columnNameString. The column name.

Example This example sets the name of the column to filter to Sales:

function setFilterSales( myfilter ){myfilter.setColumnName("Sales");

}

setOperatorSyntax void Filter.setOperator(string operator)

Sets filter operator. The operator determines the comparison made between the data in the column and the value or values set in the filter.

Parameter operatorString. The operator can be any valid operator. Table 7-10 lists the valid filter operators and the number of arguments to pass to Filter.setValues( ).

Example This example sets the filter to retrieve the bottom five values:

function setFilterBot5( ){myfilter.setOperator(actuate.data.Filter.BOTTOM_N);myfilter.setValues("5");

}

setValuesSyntax void Filter.setValues(string value)

void Filter.setValues(string value1, string value2)

void Filter.setValues(string[ ] values)

Page 296: Actuate API Reference - OpenText

278 A c t u a t e A P I R e f e r e n c e

actuate.data.Fi l ter

Sets string values for the filter to compare to the data in the column according to the operator. Table 7-10 lists the valid filter operators and the values they use. Takes either one or two values, or one array of values.

Parameters valueString. The value to compare to the column value.

value1String. The first value to compare to the column value for the BETWEEN operator.

value2String. The second value to compare to the column value for the BETWEEN operator.

valuesArray of strings. The values to compare to the column value for the IN operator.

Example This example sets the filter to retrieve values between 10 and 35:

function setFilter( myfilter ){myfilter.setOperator(actuate.data.Filter.BETWEEN);myfilter.setValues("10","35");

}

Page 297: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 279

actuate.data.ReportContent

Class actuate.data.ReportContentDescription The ReportContent class is a container for downloadable report content.

ConstructorSyntax actuate.data.ReportContent(data)

Constructs a ReportContent object.

Parameter dataString. Content text.

Function summaryTable 7-12 describes the actuate.data.ReportContent function.

getTextContentSyntax string ReportContent.getTextContent( )

Returns the text in the downloaded content.

Returns String. The text in the downloaded content.

Example To make a callback function that prints back the first line of text from some downloaded content back onto the page, use code similar to the following:

function callback(data1){var rcontent = data1.ReportContent.getTextContent( );var contentArray = rcontent.split("\n");var items = contentArray.lengthdocument.write("<P>\n")document.write(listItems.arguments[o] + "\n</P>")

}

Table 7-12 actuate.data.ReportContent function

Function Description

getTextContent( ) Returns the text in the downloaded content

Page 298: Actuate API Reference - OpenText

280 A c t u a t e A P I R e f e r e n c e

actuate.data.Request

Class actuate.data.RequestDescription Specifies a request for retrieving data and the conditions for that request. This

class provides the scope for a request by defining a target element and a range of rows. The scope of the request determines what goes into a ResultSet. Functions that use request can only retrieve ResultSets from report elements that have an explicit bookmark.

ConstructorSyntax actuate.data.Request(string bookmark, integer startRow, integer maxRow)

Constructs a request object that other classes use to retrieve data.

Parameters bookmarkString. A bookmark that identifies an Actuate report element. The actuate.data.Request object uses the bookmark to identify a report element from which to request information. If null, Request uses the first bookmark. Functions that use Request can only retrieve actuate.data.ResultSet objects from report elements that have an explicit bookmark.

startRowInteger. The numerical index of the requested first row. The smallest value is 0.

maxRowInteger. The numerical index of the requested last row. 0 indicates no limit.

Function summaryTable 7-13 lists actuate.data.Request functions.

Table 7-13 actuate.data.Request functions

Function Description

getBookmark( ) Returns the bookmark name

getColumns( ) Returns the column names

getFilters( ) Returns filters defined in this data condition

getMaxRows( ) Returns the max row number

getSorters( ) Returns sorters defined in this data condition

getStartRow( ) Returns the start row number

setBookmark( ) Sets the bookmark name

setColumns( ) Sets the columns to return

setFilters( ) Sets the filters for the returned data

Page 299: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 281

actuate.data.Request

getBookmarkSyntax string Request.getBookmarkName( )

Returns the bookmark name for this request.

Returns String. The bookmark used in the request object’s constructor.

Example This example retrieves the bookmark set in the myRequest object:

return myRequest.getBookmarkName( );

getColumnsSyntax string[ ] Request.getColumns( )

Returns a list of column names that match the request.

Returns Array of strings. The column names.

Example This example retrieves the first, third, and fifth column names from the request object myRequest:

function get135Columns(myRequest){var columns = myRequest.getColumns( );return columns[0];return columns[2];return columns[4];

}

getFiltersSyntax actuate.data.Filter[ ] Request.getfilters( )

Returns filters set for this request.

Returns Array of actuate.data.Filter objects.

getMaxRowsSyntax integer Request.getMaxRows( )

Returns the maximum number of rows to retrieve.

setMaxRows( ) Sets the max row number

setSorters( ) Sets the sorters for the returned data

setStartRow( ) Sets the start row number

Table 7-13 actuate.data.Request functions

Function Description

Page 300: Actuate API Reference - OpenText

282 A c t u a t e A P I R e f e r e n c e

actuate.data.Request

Returns Integer. The index of the last row in the request. 0 means no limit.

getSortersSyntax actuate.data.Sorter[ ] Request.getSorters( )

Returns sorters assigned to this request.

Returns Array of actuate.data.Sorter objects.

getStartRowSyntax Integer Request.getStartRow( )

Returns the index of the starting row as an integer.

Returns Integer. The startRow value. The first row in a column has an index of 0.

setBookmarkSyntax void Request.setBookmark(string bookmark)

Sets the bookmark of the element from which to request values.

Parameter bookmarkString. A bookmark.

Example This example sets the bookmark for the myRequest object to the string myRequestStart:

function setMyRequestBookmark(myRequest){myRequest.setBookmark("myRequestStart");

}

setColumnsSyntax void Request.setColumns(string[ ] columns)

Sets the request column names.

Parameter columnsAn array of strings designating the columns of requested data. Use an array for this argument, even if there is only one value.

setFiltersSyntax void Request.setFilters(actuate.data.Filter[ ] filters)

Adds filters to a request. Filters further refine the set of data provided by a request. Using setFilter removes the previous filters from the request object. All of the filters set in a request are applied when the request is used.

Page 301: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 283

actuate.data.Request

Parameter filtersAn array of actuate.data.Filter objects or a single actuate.data.Filter object to refine the request. Use an array for this argument, even if there is only one value.

setMaxRowsSyntax void Request.setMaxRows(integer maxrow)

Sets the maximum number of rows to retrieve.

Parameter maxrowInteger. The numerical index value for the last row to request. 0 indicates no limit.

Example This example sets the index of the last row for the myRequest request object to 50:

myRequest.setMaxRows(50);

setSortersSyntax void Request.setSorts(actuate.data.Sorter[ ] sorters)

Adds sorters to a request to sort the set of data that a request provides. Sorting the data increases the effectiveness of requests by providing the data in a relevant order. Using setSorters removes the previous sorter objects from the request object. All of the sorters set in a request are applied when the request is used.

Sorters are applied in the order that they occur in the array. For example, if the first sorter specifies sorting on a state column and the second sorter specifies sorting on a city column, the result set is sorted by city within each state.

Parameter sortersAn array of actuate.data.Sorter objects to sort the result of the request. Use an array for this argument, even if there is only one value.

Example This example sets the alphaNumericSorterSet array in myRequest:

myRequest.setSorters(alphaNumericSorterSet);

setStartRowSyntax void Request.setStartRow(integer startrow)

Sets the requested first row.

Parameter startrowInteger. The numerical value of the index for the first row to request. The first row in a column has an index of 0.

Example This example sets the index of the first row for the myRequest request object to 10:

myRequest.setStartRow(10);

Page 302: Actuate API Reference - OpenText

284 A c t u a t e A P I R e f e r e n c e

actuate.data.ResultSet

Class actuate.data.ResultSetDescription The actuate.data.ResultSet class represents the data retrieved from a report

document. The functions in the actuate.data.ResultSet class access the data by row. The actuate.data.ResultSet class keeps an internal reference to the current row and increments the current row with next( ).

ConstructorThere is no public constructor for actuate.data.ResultSet. The actuate.DataService.downloadResultSet and actuate.Viewer.downloadResultSet functions instantiate the ResultSet object. Set the reference to the ResultSet object in the callback function. For example, when the result set is used as the input parameter for the callback function, result becomes the label for the ResultSet, as shown below:

viewer.downloadResultSet(request, parseRS)function parseRS(resultset){

// do something with resultset}

Function summaryTable 7-14 lists actuate.data.ResultSet functions.

getColumnNamesSyntax string[ ] Request.getColumnNames( )

Returns a list of column names.

Returns Array of strings. The column names.

Example This example retrieves the first, third, and fifth column names from the ResultSet object myResult:

function get135Columns(myResult){var columns = myResult.getColumns( );return columns[0];

Table 7-14 actuate.data.ResultSet functions

Function Description

getColumnNames( ) Returns the column names

getValue( ) Returns the data by the given column index

next( ) Increments the current row

Page 303: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 285

actuate.data.ResultSet

return columns[2];return columns[4];

}

getValueSyntax string ResultSet.getValue(integer columnIndex)

Returns the value of the specified column from the current row. Specify the column by its numerical index. Use next( ) before using getValue( ) to set the cursor to the first record.

Parameter columnIndexInteger. The numerical index of the column from which to retrieve data.

Returns String. The field value.

Example This example returns the value for the column with an index value of 4 from the current row in the ResultSet object myResult:

return myResult.getValue(4);

nextSyntax boolean next( )

Increments the current row for the ResultSet. When no current row is set, next( ) sets the current row to the first row in the ResultSet. When no next row exists, next( ) returns false.

Returns Boolean. True indicates a successful row increment. False indicates that there are no further rows.

Example This example returns the value for the column with an index value of 4 from all of the rows in the ResultSet object myResult:

function getColumn4Rows(myResult){var nextrow = myResult.next( );while (nextrow){

return myResult.getValue(4);nextrow = myResult.next( );

}}

Page 304: Actuate API Reference - OpenText

286 A c t u a t e A P I R e f e r e n c e

actuate.data.Sorter

Class actuate.data.SorterDescription Specifies the conditions for sorting data as it is returned by a request or stored

temporarily in a local ResultSet object. The sort arranges rows based on the value of a specified column.

ConstructorSyntax actuate.data.Sorter(string columnName, boolean ascending)

Constructs a sorter object.

Parameters columnNameString. The name of the column to sort.

ascendingBoolean. True sets sorting to ascending. False sets sorting to descending.

Function summaryTable 7-15 lists actuate.data.Sorter functions.

getColumnNameSyntax string Sorter.getColumnName( )

Returns the name of the column to sort on.

Returns String. The column name.

Example This example displays an alert box that contains the column name currently being sorted on:

function showMyColumnName(mySorter){var sortColName = mySorter.getColumnName( );alert(sortColName);

}

Table 7-15 actuate.data.Sorter functions

Function Description

getColumnName( ) Returns the column name

isAscending( ) Returns true if the current sorting is ascending

setAscending( ) Sets the sort order to ascending or descending

setColumnName( ) Sets the column to which this sorter applies

Page 305: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 287

actuate.data.Sorter

isAscendingSyntax boolean Sorter.isAscending( )

Returns true if the current sort order is ascending. Returns false if the current order is descending.

Returns Boolean. True indicates ascending. False indicates descending.

Example This example checks if the current sort order is ascending. When the current sort order is descending, this code sets the order to ascending:

function makeAscending(mySort){if (mySort.isAscending( )) {

return;} else {

mySort.setAscending(true);}

}

setAscendingSyntax void Sorter.setAscending(boolean ascending)

Sets the sort order to ascending or descending.

Parameter ascendingBoolean. True sets the sort order to ascending. False sets the sort order to descending.

Example This example checks if the current sort order is descending. When the current sort order is ascending, this code sets the order to descending:

function makeAscending(mySort){if (mySort.isAscending( )) {

return;} else {

mySort.setAscending(true);}

}

setColumnNameSyntax void Sorter.setColumnName(string columnName)

Sets the column to sort on.

Parameter columnNameString. The column name.

Page 306: Actuate API Reference - OpenText

288 A c t u a t e A P I R e f e r e n c e

actuate.data.Sorter

Example This example makes the current sorter arrange the result set ascending by the Sales column:+

function makeAscendingOnSales(mySort){mySort.setColumnName("Sales");if (mySort.isAscending( )) {

return;} else {

mySort.setAscending(true);}

}

Page 307: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 289

actuate.DataService

Class actuate.DataServiceDescription Connects to an Actuate web application service to retrieve data from Actuate

BIRT reports as a ResultSet.

ConstructorSyntax actuate.DataService(string iportalUrl, actuate.RequestOptions requestOptions)

Constructs a DataService object.

Parameters iportalUrl String. Optional. The URL of an Actuate web application service. The DataService uses the web application service set in actuate.initialize if one is not specified.

requestOptionsactuate.RequestOptions object. Optional. Specifies the request options for the iportal web service connection. The DataService uses the options set in actuate.initialize if one is not specified.

Function summaryTable 7-16 describes the actuate.DataService function.

downloadResultSetSyntax void DataService.downloadResultSet(string datasource, actuate.data.Request

request, function callback, function errorCallback)

Returns data from an Actuate BIRT report document managed by an Actuate web application. The actuate.data.ResultSet object that downloadResultSet( ) returns is used by the callback function.

Parameters datasource String. The repository path and name of the file from which to retrieve data.

request actuate.data.Request object. Specifies the request for the report.

callbackFunction. The callback function to use after the ResultSet finishes downloading. This function must take the returned ResultSet object as an input parameter.

Table 7-16 actuate.DataService functions

Function Description

downloadResultSet( ) Retrieves data from a report in a ResultSet object

Page 308: Actuate API Reference - OpenText

290 A c t u a t e A P I R e f e r e n c e

actuate.DataService

errorCallbackFunction. Optional. The function to call when an error occurs. The possible errors are actuate.Exception objects. The errorCallback( ) function must take an exception as an argument.

Example This example retrieves a result set as specified by the myRequest request object, and calls the makeAscendingSales function, which must take a actuate.data.ResultSet object as an input parameter:

var myRequest = new actuate.data.Request("Top_5_Customers", 1, 0);var myDataService =

new actuate.DataService( "http://127.0.0.1:8900/iportal" );myDataService.downloadResultSet(

"/Public/Applications/BIRT Sample App/Report Designs/Customer Revenue Metrics.rptdocument", myRequest, makeAscendingSales, errorCallback);

Page 309: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 291

actuate.Except ion

Class actuate.ExceptionDescription A container for an uncategorized exceptions that also supports specific

exceptions. Exception provides an object to pass to a callback function or event handler when an exception occurs. The Exception object contains references to the exception’s origin, description, and messages.

ConstructorThe Exception object is constructed when unspecified exceptions occur. The exceptions are divided into three types, which determine the contents of the Exception object. These types are:

■ ERR_CLIENT: Exception type for a client-side error

■ ERR_SERVER: Exception type for a server error

■ ERR_USAGE: Exception type for a JSAPI usage error

Function summaryTable 7-17 lists actuate.Exception functions.

getDescriptionSyntax string Exception.getDescription( )

Returns exception details as provided by the Server, Client, and User objects.

Returns String. A detailed description of the error. Information is provided according to the type of exception generated, as shown below:

■ Server error: The SOAP string

■ Client error: For the Firefox browser, a list comprised of fileName+number+stack

■ Usage error: Any values set in the object generating the exception

Table 7-17 actuate.Exception functions

Function Description

getDescription( ) Returns details of the exception

getErrCode( ) Returns error code for server-side exceptions

getMessage( ) Returns a short message about the exception

getType( ) Returns the type of exception error

isExceptionType( ) Confirms exception type

Page 310: Actuate API Reference - OpenText

292 A c t u a t e A P I R e f e r e n c e

actuate.Except ion

Example This example displays the server error description in an alert box:

alert("Server error: " + Exception.getDescription( ));

getErrCodeSyntax string Exception.getErrCode( )

Returns the error code for server exceptions.

Returns String. A server error code.

Example This example displays the server error code in an alert box:

alert("Server error: " + Exception.getErrCode( ));

getMessageSyntax string Exception.getMessage( )

Returns a short message about the exception. This message is set for an actuate.Exception object with the actuate.Exception.initJSException( ) function.

Returns String. A server error code.

Example This example displays the error’s short message code in an alert box:

alert("Error Message: " + Exception.getMessage( ));

getTypeSyntax string Exception.getType( )

Returns the type of the exception:

■ ERR_CLIENT: Exception type for a client-side error

■ ERR_SERVER: Exception type for a server error

■ ERR_USAGE: Exception type for a Actuate JavaScript API usage error

Returns String. A server error code.

Example This example displays the error type in an alert box:

alert("Error type: " + Exception.getType( ));

isExceptionTypeSyntax boolean Exception.isExceptionType(object exceptionType)

Compares the input object to the exception contained in this actuate.Exception object to the exceptionType object argument.

Page 311: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 293

actuate.Except ion

Parameter exceptionTypeObject. Either an Exception object, such as an instance of actuate.Viewer.ViewerException, or the name of an Exception class as a string.

Returns Boolean. Returns true if the exception contained in this actuate.Exception object matches the exceptionType object argument.

Example To alert the user when the exception e is a usage error, use code similar to the following:

if (e.isExceptionType(actuate.exception.ERR_USAGE)){alert('Usage error occurred!');

}

Page 312: Actuate API Reference - OpenText

294 A c t u a t e A P I R e f e r e n c e

actuate.Parameter

Class actuate.ParameterDescription The actuate.Parameter class retrieves and displays Actuate BIRT report

parameters in an HTML container. Users can interact with the parameters on the page and pass parameter values to an actuate.Viewer object, but not to the server directly.

The actuate.Parameter class displays the parameters by page. The actuate.parameters.navigate( ) function changes the page display or changes the current position on the page.

ConstructorSyntax actuate.Parameter(string container)

Constructs a parameter object for a page, initializing the parameter component.

Parameter containerString. The name of the HTML element that displays the rendered parameter component or a container object. The constructor initializes the parameter component but does not render it.

Function summaryTable 7-18 lists actuate.Parameter functions.

Table 7-18 actuate.Parameter functions

Function Description

downloadParameters( ) Returns an array of ParameterDefinition objects

downloadParameterValues( ) Returns an array list of ParameterValue objects

getLayout( ) Returns the parameter layout

getParameterGroupNames( ) Returns the names of the groups of parameters

getReportName( ) Returns the name of the report file

getTransientDocumentName( ) Returns the name of the transient document

hideNavBar( ) Hides the navigation bar

hideParameterGroup( ) Hides report parameters by group

hideParameterName( ) Hides parameters by name

navigate( ) Navigates the parameter page

onUnload( ) Unloads unused JavaScript variables

Page 313: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 295

actuate.Parameter

downloadParametersSyntax void Parameter.downloadParameters(function callback)

Retrieves an array of actuate.parameter.ParameterDefinition objects that contain the report parameters for the report and sends the array to the callback function, which must take the array as an input parameter.

Parameter callbackFunction. The function to execute after the report parameters finish downloading. Parameter.downloadParameters( ) sends an array of actuate.parameter.ParameterDefinition objects to the callback function as an input argument.

Example This example retrieves a set of report parameters and sends them to a callback function:

registerEventHandler( ) Registers an event handler

removeEventHandler( ) Removes an event handler

renderContent( ) Renders the parameter content to the container

setAutoSuggestDelay( ) Sets the auto suggest delay time

setAutoSuggestFetchSize( ) Sets the fetch size of the auto suggestion list

setAutoSuggestListSize( ) Sets the size of the auto suggestion list

setExpandedGroups( ) Sets the groups to expand by default

setFont( ) Sets the font of the parameter page

setGroupContainer( ) Sets the HTML container for the group

setLayout( ) Sets the parameter layout type

setReadOnly( ) Sets the parameter UI to read-only

setReportName( ) Sets the remote report path and name

setService( ) Sets the Actuate web application service

setShowDisplayType( ) Sets the parameter page to display localized content

submit( ) Submits all the asynchronous operations that the user has requested on this Parameter object and renders the parameter component on the page

Table 7-18 actuate.Parameter functions

Function Description

Page 314: Actuate API Reference - OpenText

296 A c t u a t e A P I R e f e r e n c e

actuate.Parameter

function getChartParams(myParameter){myParameter.downloadParameters(callback( ));

}

downloadParameterValuesSyntax void Parameter.downloadParameterValues(function callback)

Returns an array of the actuate.parameter.ParameterValue objects for the parameter object. If no values have been set, the parameter object downloads the default values from the server.

Parameter callbackFunction. The function to execute after the report parameters finish downloading. Parameter.downloadParameterValues( ) sends an array of actuate.parameter.ParameterValue objects to the callback function as an input argument.

Example To download the parameter values and add them to the viewer, the callback function must use the values as an input parameter, as shown in the following code:

paramObj.downloadParameterValues(runNext);function runNext(values){

viewer.setParameterValues(values);}

getLayoutSyntax string Parameter.getLayout( )

Returns the parameter layout type.

Returns String. The parameter layout, which will match one of the layout constants in actuate.parameter.Constants:

■ actuate.parameter.Constants.LAYOUT_NONE

■ actuate.parameter.Constants.LAYOUT_GROUP

■ actuate.parameter.Constants.LAYOUT_COLLAPSIBLE

Example This example calls getLayout( ) to display the parameter layout type in an alert box:

alert(paramObj.getLayout( ));

getParameterGroupNamesSyntax string[ ] Parameter.getParameterGroupNames( )

Page 315: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 297

actuate.Parameter

Returns all the group names for the parameter page as an array of strings.

Returns Array of strings. Each string is a group name.

Example This example displays an alert box with the name of the first group for the parameter page:

var groupNames = paramObj.getParameterGroupNames( );alert("First Group Name: " + groupNames[0]);

getReportNameSyntax string Parameter.getReportName( )

Returns the name of the report file currently referenced by this Parameter object.

Returns String. The report file name.

Example This example displays an alert box with the name of the report file:

alert("Report file: " + paramObj.getReportName( ));

getTransientDocumentNameSyntax string Parameter.getTransientDocumentName( )

Returns the name of the transient document generated by running the report currently referenced by this Parameter object.

Returns String.

Example This example displays an alert box with the name of the transient document:

alert( "Transient document: " + paramObj.getTransientDocumentName( ));

hideNavBarSyntax void Parameter.hideNavBar( )

Hides the navigation bar for the parameter component in the LAYOUT_GROUP layout.

Example This example hides the navigation bar:

paramObj.hideNavBar( );alert("Navigation bar is hidden");

hideParameterGroupSyntax void Parameter.hideParameterGroup(string[ ] groupNames)

Page 316: Actuate API Reference - OpenText

298 A c t u a t e A P I R e f e r e n c e

actuate.Parameter

Hides all report parameters that belongs to a group or to a list of groups.

Parameter groupNamesString or array of strings. Hides any groups listed.

Example This example hides the report parameters that belong to the groups that are listed in the myGroups string array:

var myGroups = ["Group1", "Group2", "Group3"];paramObj.hideParameterGroup(myGroups);alert("Groups are hidden");

hideParameterNameSyntax void Parameter.hideParameterName(string[ ] parameterNames)

Hides report parameters as specified by name.

Parameter parameterNamesString or array of strings.

Example This example hides the parameters that are listed in the myParams string array:

var myParams = ["Parameter1", "Parameter2", "Parameter3"];paramObj.hideParameterName(myParams);alert("Parameters are hidden");

navigateSyntax void Parameter.navigate(string containerId, string navTarget)

Changes the current page of the parameter component. The navTarget determines the new location to display the parameter container.

Parameters containerIdString. The value of the id parameter for the HTML <div> element that holds the parameter component.

navTargetString constant. Which navigation button to trigger. Possible values from actuate.parameter.Constants are NAV_FIRST, NAV_PREV, NAV_NEXT, NAV_LAST.

Example This example displays the last page of the parameter component in the HTML <div> element with the myParams ID:

function myParamsLast(myParameter){myParameter.navigate("myParams", NAV_LAST);

}

Page 317: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 299

actuate.Parameter

onUnloadSyntax void Parameter.onUnload( )

Performs garbage collection for the parameter object and unloads JavaScript variables that are no longer needed by Parameter.

Example This example unloads JavaScript variables and displays an alert box:

myParameter.onUnload();alert("JS variables unloaded.");

registerEventHandlerSyntax void Parameter.registerEventHandler(actuate.parameter.EventConstants event,

function handler)

Registers an event handler to activate for parameter events. This function can assign several handlers to a single event.

Parameters eventactuate.parameter.EventConstants. A constant corresponding to a supported event. actuate.Parameter supports the following two events:

■ actuate.parameter.EventConstants.ON_CHANGED

■ actuate.parameter.EventConstants.ON_SELECTION_CHANGED

handlerFunction. The function to execute when the event occurs. The handler must take two arguments: the parameter instance that fired the event and an event object specific to the event type.

Example To register an event handler to catch exceptions, call actuate.Parameter.registerEventHandler using the ON_CHANGED constant after creating the viewer object, as shown in the following example:

function initParameter( ){parameter = new actuate.Parameter("acparameter");parameter.registerEventHandler(

actuate.parameter.EventConstants.ON_CHANGED, errorHandler);}

removeEventHandlerSyntax void Parameter.removeEventHandler(actuate.viewer.EventConstants event,

function handler)

Removes an event handler.

Page 318: Actuate API Reference - OpenText

300 A c t u a t e A P I R e f e r e n c e

actuate.Parameter

Parameters eventactuate.parameter.EventConstants. A constant corresponding to a supported event. actuate.Parameter supports the following two events:

■ actuate.parameter.EventConstants.ON_CHANGED

■ actuate.parameter.EventConstants.ON_SELECTION_CHANGED

handlerFunction. A handler function registered for the event.

Example To remove an event handler, call actuate.Parameter.removeEventHandler with a legal event constant, as shown in the following example:

function cleanupParameter( ){parameter.removeEventHandler(

actuate.parameter.EventConstants.ON_CHANGED, errorHandler);}

renderContentSyntax void Parameter.renderContent(actuate.parameter.ParameterDefinition[ ]

paramDefs, function callback)

Renders the parameter component to the container.

Parameters paramDefsArray of actuate.parameter.ParameterDefinition objects.

callbackFunction. The function to execute after the rendering is done.

Example This example calls renderContent( ) after hiding parameter groups:

function showNoGroups(myParameter){myParameter.hideParameterGroup(zipcodes);myParameter.renderContent(myParameterArray,

cleanupParameter(myParameter));}

setAutoSuggestDelaySyntax void Parameter.setAutoSuggestDelay(long delay)

Sets the auto suggest delay time.

Parameter delayLong. Interpreted as milliseconds.

Example This example implements a custom auto suggest list. The list is 10 suggestions long and displays 3 suggestions at a time after a delay of 250 milliseconds.

function myCustomAutoSuggest(myParameter){

Page 319: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 301

actuate.Parameter

myParameter.setAutoSuggestFetchSize(10);myParameter.setAutoSuggestListSize(3);myParameter.setAutoSuggestDelay(250);

}

setAutoSuggestFetchSizeSyntax void Parameter.setAutoSuggestFetchSize(integer size)

Sets the fetch size of the auto suggestion list. AutoSuggest fetches all suggestions from the server when the fetch size is not set.

Parameter sizeInteger. The number of suggestions to fetch at a time.

Example This example implements a custom auto suggest list. The list is 10 suggestions long and displays 3 suggestions at a time after a delay of 250 milliseconds.

function myCustomAutoSuggest(myParameter){myParameter.setAutoSuggestFetchSize(10);myParameter.setAutoSuggestListSize(3);myParameter.setAutoSuggestDelay(250);

}

setAutoSuggestListSizeSyntax void Parameter.setAutoSuggestListSize(integer size)

Sets the length of the auto suggestion list. AutoSuggest shows all of the suggestions from the server when the list length is not set.

Parameter sizeInteger. The number of suggestions to display.

Example This example implements a custom auto suggest list. The list is 10 suggestions long and displays 3 suggestions at a time after a delay of 250 milliseconds.

function myCustomAutoSuggest(myParameter){myParameter.setAutoSuggestFetchSize(10);myParameter.setAutoSuggestListSize(3);myParameter.setAutoSuggestDelay(250);

}

setExpandedGroupsSyntax void Parameter.setExpandedGroups(groupNames)

Defines a set of groups that are expanded by default.

Parameter groupNamesArray of strings. The group names to expand by default.

Page 320: Actuate API Reference - OpenText

302 A c t u a t e A P I R e f e r e n c e

actuate.Parameter

Example This example sets the "Motorcycles", "Trucks", and "Airplanes" groups as expanded by default:

var myGroups = new Array["Motorcycles", "Trucks", "Airplanes"];paramObj.setExpandedGroups(myGroups);

setFontSyntax void Parameter.setFont(string fontStyleString)

Sets the font of the parameter page content after the page is rendered.

Parameter fontStyleStringString. The name of a font.

Example This example sets the font to Arial for the parameters page:

paramObj.setFont("arial");

setGroupContainerSyntax void Parameter.setGroupContainer(string[ ] groupNames, string containerId)

Sets the HTML element container for the provided group. All parameter objects listed in groupNames are assigned to the container.

Parameters groupNamesArray of strings. The group names to be assigned.

containerIDString. The name of the HTML element that displays the group of rendered parameter components.

Example This example assigns the group names in the myGroups string array to the leftpane HTML element:

var myGroups = ["Group1", "Group2", "Group3"];paramObj.setGroupContainer(myGroups, "leftpane");

setLayoutSyntax void Parameter.setLayout(string layoutName)

Sets the parameter layout.

Parameter layoutNameString constant. Possible values are:

■ actuate.parameter.Constants.LAYOUT_GROUP

■ actuate.parameter.Constants.LAYOUT_NONE

■ actuate.parameter.Constants.LAYOUT_COLLAPSIBLE

Page 321: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 303

actuate.Parameter

Example This example sets the parameter object’s layout type to LAYOUT_COLLAPSIBLE:paramObj.setLayout("LAYOUT_COLLAPSIBLE");

setReadOnlySyntax void Parameter.setReadOnly(boolean readOnly)

Sets the parameters to read-only.

Parameter readOnlyBoolean. True indicates that the parameters are read-only.

Example This example makes the parameters read-only:

paramObj.setReadOnly(true);

setReportNameSyntax void Parameter.setReportName(string reportFile)

Sets the report file from which to get report parameters.

Parameter reportFileString. The report file path and name. The report file can be a report design file or a report document file.

Example To set the name using an HTML input tag with an ID of Selector, use the following code:

myViewer.setReportName(document.getElementById("Selector").value);

setServiceSyntax void Parameter.setService(string iPortalURL, actuate.RequestOptions

requestOptions)

Sets the target service URL to which the Parameter object links. If the service URL is not set, this Parameter object links to the default service URL set on the actuate object.

Parameters iPortalURLString. The target Actuate web application URL.

requestOptionsactuate.RequestOptions object. Optional. requestOptions defines URL parameters to send with the authentication request, such as the iHub URL, volume, or repository type. The URL can also include custom parameters.

Example This example sets the URL for the Actuate iPortal web application service:

paramObj.setService("http://127.0.0.1:8700/iportal", myRequestOptions);

Page 322: Actuate API Reference - OpenText

304 A c t u a t e A P I R e f e r e n c e

actuate.Parameter

setShowDisplayTypeSyntax void Parameter.setShowDisplayType(boolean showDisplayType)

Sets whether localized data is shown or not.

Parameter showDisplayTypeBoolean. True indicates that localized data is shown.

Example This example hides localized data:

paramObj.setShowDisplayType(false);paramObj.submit(alert("Localized data hidden.");

submitSyntax void Parameter.submit(function callback)

Submits requests to the server for the report parameters. When this function is called, an AJAX request is triggered to submit all the operations. When the server finishes the processing, it returns a response and the results are rendered on the page in the parameter container.

Parameter callbackFunction. The function to execute after the asynchronous call processing is done.

Example This example calls submit( ) after hiding localized data:

paramObj.setShowDisplayType(false);paramObj.submit(alert("Localized data hidden."));

Page 323: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 305

actuate.parameter.Constants

Class actuate.parameter.ConstantsDescription Global constants used for Parameter class. Table 7-19 lists the constants used for

the parameter class.

Table 7-19 Actuate iPortal JavaScript API parameter constants

Event Description

ERR_CLIENT Constants used to tell JSAPI user that there was a client-side error

ERR_SERVER Constants used to tell JSAPI user that there was a server-side error

ERR_USAGE Constants used to tell JSAPI user that there was a usage API error

LAYOUT_COLLAPSIBLE Constants to set layout of parameter component to collapsible group

LAYOUT_GROUP Constants to set layout of parameter component to group

LAYOUT_NONE Constants to set layout of parameter component to none

NAV_FIRST Constants to programmatically control the first page navigation link

NAV_LAST Constants to programmatically control the last page navigation link

NAV_NEXT Constants to programmatically control the next page navigation link

NAV_PREV Constants to programmatically control the previous page navigation link

Page 324: Actuate API Reference - OpenText

306 A c t u a t e A P I R e f e r e n c e

actuate.parameter.ConvertUt i l i ty

Class actuate.parameter.ConvertUtilityDescription actuate.parameter.ConvertUtility encodes multiple

actuate.parameter.ParameterValue objects into an array of generic objects. For multi-clue or dynamic filter parameters, use the array of generic objects as the input parameter for actuate.Viewer.setParameterValues.

ConstructorSyntax actuate.parameter.ConvertUtility(actuate.parameter.ParameterValue[ ]

aParamVals)

Constructs a new ConvertUtility object.

Parameter aParamValsArray of actuate.parameter.ParameterValue objects to convert.

Function summaryTable 7-20 lists actuate.parameter.ConvertUtility functions.

convertSyntax void ConvertUtility.convert(function callback)

Converts ParameterValues into an array of generic objects. The callback function takes the array as an argument.

Parameter callbackFunction. The callback function to call after converting the results. The callback function must take the generic array of objects as an argument.

Example This example stores the name-value pair array for myParamValues in a variable called nameValueArray:

var nameValueArray = new Array( );var converter = new actuate.ConvertUtility(myParamValues);

Table 7-20 actuate.parameter.ConvertUtility functions

Function Description

convert( ) Converts the ParameterValues to an array of generic objects

convertDate( ) Converts locale-neutral parameter values to the user’s login locale

getParameterMap( ) Returns the ParameterValues as an associative array

getParameterValues( ) Returns an array of ParameterValues

Page 325: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 307

actuate.parameter.ConvertUt i l i ty

converter.convert(callback);function callback (values){

nameValueArray = values;}

convertDateSyntax void ConvertUtility.convertDate(function callback)

Converts locale-neutral parameter values to the user’s login locale.

Parameter callbackFunction. An optional function to call when this function completes. The callback function receives an array of actuate.parameter.ParameterValue objects as a parameter.

Example This example converts the name-value pair array for myParamValues and stores the results in a variable called nameValueArray:

var nameValueArray = new Array( );var converter = new actuate.ConvertUtility(myParamValues);converter.convertDate(callback);function callback (values){

nameValueArray = values;}

getParameterMapSyntax object ConvertUtility.getParameterMap( )

Returns the parameters as an associative array. This function makes the name of each parameter an object property and sets the value of that property to the associated parameter value.

Returns Object.

Example This example stores the associative array for myParamValues in a variable called nameValueArray:

var paramMap = new Object( );var converter = new actuate.ConvertUtility(myParamValues);paramMap = converter.getParameterMap( );

getParameterValuesSyntax actuate.parameter.ParameterValue[ ] ConvertUtility.getParameterValues( )

Returns the array of ParameterValue objects.

Returns Array of actuate.parameter.ParameterValue objects.

Page 326: Actuate API Reference - OpenText

308 A c t u a t e A P I R e f e r e n c e

actuate.parameter.ConvertUt i l i ty

Example This example stores the array of ParameterValue objects for myParamValues in a variable called paramValues:

var paramValues = new Array( );var converter = new actuate.ConvertUtility(myParamValues);paramValues = converter.getParameterMap( );

Page 327: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 309

actuate.parameter.EventConstants

Class actuate.parameter.EventConstantsDescription Defines the supported event constants for parameters. Table 7-21 lists the

parameter event constants.

Table 7-21 Actuate JavaScript API parameter event constants

Event Description

ON_CHANGE_COMPLETED Event name triggered when the action is complete and no internal actions are triggered automatically. For example, when a cascading parameter is changed, its child parameter is changed automatically. This event is triggered when its child parameters are updated. The event handler takes the following arguments:■ actuate.Parameter: parameter component for which the

event occurred

ON_CHANGED Event triggered when a changed event occurs. For example, this event triggers if the value of a parameter control changes. The event handler takes the following arguments:■ actuate.Parameter: parameter component for which the

event occurred

ON_EXCEPTION Event triggered when an exception occurs. The event handler must take an actuate.Exception object as an input argument. The Exception object contains the exception information.

ON_SELECTION_CHANGED Event triggered when a selection change occurs. For example, this event triggers if the value of a parameter list control changes. The event handler must take an actuate.Parameter object as an input argument. This input argument is the parameter component for which the event occurred.

ON_SESSION_TIMEOUT Session time-out event. Whenever a session time-out event occurs and the user tries to perform any operation on parameter component, a prompt dialog will be shown to ask whether the user wants to log in again or not. If the user clicks yes, the ON_SESSION_TIMEOUT event will be fired. If no handler has been registered for this event, a default built-in login dialog will be displayed.The event handler takes the following arguments:■ actuate.Parameter: component for which the event

occurred

Page 328: Actuate API Reference - OpenText

310 A c t u a t e A P I R e f e r e n c e

actuate.parameter.NameValuePair

Class actuate.parameter.NameValuePairDescription The NameValuePair object contains a display name associated with a value. The

actuate.parameterDefinition.setSelectNameValueList( ) function takes an array of actuate.parameter.NameValuePair objects to use in a selection list. In this way, a ParameterDefinition can display a list of names and map them to values used internally. For example, set the name "My Default Country" for a NameValuePair to display "My Default Country" in the drop-down list in the interface, and set the value to "United States" internally for a US user.

ConstructorSyntax actuate.parameter.NameValuePair(string name, string value)

Constructs a new NameValuePair object.

Parameters nameString. The name to display in the selection list.

valueString. The value that selecting the name sets internally.

Function summaryTable 7-22 lists actuate.parameter.NameValuePair functions.

getNameSyntax string NameValuePair.getName( )

Returns the name for this NameValuePair.

Returns String.

Example This sample code returns the name component of the myNVPair NameValuePair object:

alert("Name component is " + myNVPair.getName( ));

Table 7-22 actuate.parameter.NameValuePair functions

Function Description

getName( ) Gets the name for this NameValuePair

getValue( ) Gets the value for this NameValuePair

setName( ) Sets the name for this NameValuePair

setValue( ) Sets the value for this NameValuePair

Page 329: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 311

actuate.parameter .NameValuePair

getValueSyntax string NameValuePair.getValue( )

Returns the value for this NameValuePair.

Returns String.

Example This sample code returns the value component of the myNVPair NameValuePair object:

alert("Value component is " + myNVPair.getValue( ));

setNameSyntax void NameValuePair.setName(string name)

Sets the name for the NameValuePair.

Parameter nameString.

Example This sample code sets the name component of the myNVPair NameValuePair object to "My hometown":

myNVPair.setName("My hometown");

setValueSyntax void NameValuePair.setValue(string value)

Sets the value for the NameValuePair.

Parameter valueString.

Example This sample code sets the value component of the myNVPair NameValuePair object to "Cleveland":

myNVPair.setValue("Cleveland");

Page 330: Actuate API Reference - OpenText

312 A c t u a t e A P I R e f e r e n c e

actuate.parameter.ParameterData

Class actuate.parameter.ParameterDataDescription The ParameterData class is a high-level wrapper for an

actuate.parameter.ParameterDefinition object.

ConstructorSyntax string actuate.parameter.ParameterData(string reportName,

actuate.parameter.ParameterDefinition pd)

Constructs a new ParameterData object.

Parameters reportNameString. The name of the report where the parameter definition originates.

pdactuate.parameter.ParameterDefinition object. The parameter definition set for this ParameterData object.

Function summaryTable 7-23 lists the actuate.parameter.ParameterData functions.

Table 7-23 actuateparameter.ParameterData functions

Function Description

getCascadingParentValues( ) Returns the cascading parent value

getChildData( ) Returns the child ParameterData object

getControlType( ) Returns the controlType UI value

getCurrentValue( ) Returns the current UI value set by the UI control

getDefaultValue( ) Returns the default value for this ParameterData object

getHelpText( ) Returns the help text for this ParameterData object

getNameValueList( ) Returns the list of name-value pairs for this ParameterData object

getParameterName( ) Returns the parameter name for this ParameterData object

getParentData( ) Returns the parent ParameterData object

getPickList( ) Returns the pick list for the child ParameterData object

Page 331: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 313

actuate.parameter.ParameterData

getCascadingParentValuesSyntax actuate.parameter.ParameterValue[ ]

ParameterData.getCascadingParentValues( actuate.parameter.ParameterValue[ ] parentValues)

Returns the cascading parent value.

Parameter parentValuesAn array of actuate.parameter.ParameterValue objects. This array is the one to be populated.

Returns An array of actuate.parameter.ParameterValue objects. This is the input array populated with the cascading parent values.

Example This sample code returns a storage array of actuate.parameter.ParameterValue objects representing the cascading parent values:

var parentValues = new Array( );parentValues = myParamData.getCascadingParentValues(parentValues);

getPromptText( ) Returns the prompt text for this ParameterData object

getSuggestionList( ) Returns the filter-based suggestion list for this ParameterData object

isAdhoc( ) Returns true when this parameter is a dynamic filter parameter

isCascadingParameter( ) Returns true when this parameter is a cascading parameter

isDynamicFilter( ) Returns true when this parameter is a dynamic filter

isMultiList( ) Returns true when this parameter is a multi-list

isRequired( ) Returns true when this parameter is required

setChildData( ) Indicates that the parameter data contains a child

setCurrentValue( ) Sets the UI value of the UI control

setParentData( ) Indicates that the parameter data contains a parent

setWebService( ) Defines a web service to send SOAP messages

Table 7-23 actuateparameter.ParameterData functions

Function Description

Page 332: Actuate API Reference - OpenText

314 A c t u a t e A P I R e f e r e n c e

actuate.parameter.ParameterData

getChildDataSyntax actuate.parameter.ParameterData ParameterData.getChildData( )

Returns the child ParameterData object.

Returns actuate.parameter.ParameterData object.

Example This example assigns the child ParameterData object to a myChildData variable:

var myChildData = myParameterData.getChildData( );

getControlTypeSyntax string ParameterData.getControlType( )

Returns the controlType UI value for this ParameterData object.

Returns String. The controlType UI value. Legal controlType UI values are:

■ null

■ AutoSuggest

■ ControlRadioButton

■ ControlList

■ ControlListAllowNew

■ ControlCheckBox

Example This sample code displays the controlType UI value for the myParamData object in an alert box:

alert(myParamData.getControlType( ));

getCurrentValueSyntax actuate.parameter.ParameterValue ParameterData.getCurrentValue( )

Returns the current UI value set by the UI control.

Returns actuate.parameter.ParameterValue. Returns null when the UI control has not set a value.

Example This sample code assigns the current UI value to the myCurrVal variable:

var myCurrVal = myParameterData.getCurrentValue( );

getDefaultValueSyntax string ParameterData.getDefaultValue( )

Returns the default value for this ParameterData object.

Page 333: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 315

actuate.parameter.ParameterData

Returns String. The default value. Returns null when the default value is null.

Example This sample code displays the default value for myParamData in an alert box:

alert(myParamData.getDefaultValue( ));

getHelpTextSyntax string ParameterData.getHelpText( )

Returns the help text for this ParameterData object.

Returns String. The help text.

Example This example displays the help text for the myParamData object in an alert box:

alert(myParamData.getHelpText( ));

getNameValueListSyntax actuate.parameter.NameValuePair[ ] ParameterData.getNameValueList( )

Returns the list of name-value pairs for this ParameterData object.

Returns Array of actuate.parameter.NameValuePair objects.

Example This example stores the array of NameValuePair objects for the myParamValues object in a variable called myNVList:

var myNVList = new Array( );myNVList = myParamValues.getNameValueList( );

getParameterNameSyntax string ParameterData.getParameterName( )

Returns the parameter name for this ParameterData object.

Returns String. The parameter name.

Example This sample code displays the parameter name for the myParamData object in an alert box:

alert(myParamData.getParameterName( ));

getParentDataSyntax actuate.parameter.ParameterData ParameterData.getParentData( )

Returns the parent ParameterData object.

Returns actuate.parameter.ParameterData object.

Page 334: Actuate API Reference - OpenText

316 A c t u a t e A P I R e f e r e n c e

actuate.parameter.ParameterData

Example This sample code assigns this ParameterData object’s parent ParameterData object to the myParentData variable:

var myParentData = myParameterData.getParentData( );

getPickListSyntax actuate.parameter.ParameterValue[ ] ParameterData.getPickList(function

callback)

Gets the pick list for the child of this parameter data.

Parameter callbackFunction. An optional function to call when this function completes. This function receives the following parameters:

■ An array of actuate.parameter.NameValuePair objects

■ An integer that represents the pick list’s total leftover count

Returns An array of actuate.parameter.ParameterValue objects.

Example This sample code uses the callback function runNext( ) to display the pick list’s total leftover count in an alert box and assigns the array of NameValuePair objects to the pickListNVPairs variable:

paramObj.getPickList(runNext);function runNext(pairs, leftover){

alert(leftover);var pickListNVPairs = new Array( );pickListNVPairs = pairs;

}

getPromptTextSyntax string ParameterData.getPromptText( )

Returns the prompt text for this ParameterData object.

Returns String. The prompt text.

Example This sample code displays the prompt text for the myParamData object in an alert box:

alert(myParamData.getPromptText( ));

getSuggestionListSyntax string[ ] ParameterData.getSuggestionList(function callback, string filter)

Returns the filter-based suggestion list for this ParameterData object.

Page 335: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 317

actuate.parameter.ParameterData

Parameters callbackFunction. An optional function to call when this function completes. This function receives an array of actuate.parameter.NameValuePair objects as a parameter.

filterString. The filter for the suggestion list.

Example This sample code uses the string "Trucks" to call back function runNext( ) to filter the suggestion list and assigns the filtered NameValuePair objects to the mySuggestions variable:

paramObj.getSuggestionList(runNext, "Trucks");function runNext(suggested){

var mySuggestions = new Array( );mySuggestions = suggested;

}

isAdhocSyntax boolean ParameterData.isAdhoc( )

Returns true when this parameter is a dynamic filter parameter.

Returns Boolean. True when this parameter is a dynamic filter.

Example This example displays the dynamic filter status of a parameter in an alert box:

alert(paramData.isAdhoc( ));

isCascadingParameterSyntax boolean ParameterData.isCascadingParameter( )

Returns true when this parameter is a cascading parameter.

Returns Boolean. True when this parameter is a cascading parameter.

Example This example displays the cascading parameter status of a parameter in an alert box:

alert(paramData.isCascadingParameter( ));

isDynamicFilterSyntax boolean ParameterData.isDynamicFilter( )

Returns true when this parameter is a dynamic filter.

Returns Boolean. True when this parameter is a dynamic filter.

Page 336: Actuate API Reference - OpenText

318 A c t u a t e A P I R e f e r e n c e

actuate.parameter.ParameterData

Example This example displays the dynamic filter status of a parameter in an alert box:

alert(paramData.isDynamicFilter( ));

isMultiListSyntax boolean ParameterData.isMultiList( )

Returns true when this parameter is shown as a multi-list UI element.

Returns Boolean. True when this parameter is shown as a multi-list UI element.

Example This example displays the multi-list UI element status of a parameter in an alert box:

alert(paramData.isMultiList( ));

isRequiredSyntax boolean ParameterData.isRequired( )

Returns true when this parameter is required.

Returns Boolean. True when this parameter is required.

Example This example displays the required status of a parameter in an alert box:

alert(paramData.isRequired( ));

setChildDataSyntax void ParameterData.setChildData(actuate.parameter.ParameterData childData)

Adds a child parameter to this parameter.

Parameter childDataAn actuate.parameter.ParameterData object that contains the child for this ParameterData object.

Example This sample code sets the ParameterData object myChildData as the child of the ParameterData object myParamData:

myParamData.setChildData(myChildData);

setCurrentValueSyntax void ParameterData.setCurrentValue(actuate.parameter.ParameterValue value)

Sets the UI value of the UI control. When a UI value changes, UIControl calls this method to update the ParameterData object.

Page 337: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 319

actuate.parameter.ParameterData

Parameter valueAn actuate.parameter.ParameterValue object set by the UI.

Example This sample code sets the ParameterValue object myValue as the value of the ParameterData object myParamData:

myParamData.setCurrentValue(myValue);

setParentDataSyntax void ParameterData.setParentData(actuate.parameter.ParameterData

parentData)

Sets a parent ParameterData object, making this ParameterData object its child.

Parameter parentDataAn actuate.parameter.ParameterData object that contains the parent for this ParameterData object.

Example This sample code sets the ParameterData object myParentData as the parent of the ParameterData object myParamData:

myParamData.setParentData(myParentData);

setWebServiceSyntax void ParameterData.setWebService(object webService)

Defines a web service to use to send SOAP messages.

Parameter webServiceObject. A web service to send SOAP messages.

Page 338: Actuate API Reference - OpenText

320 A c t u a t e A P I R e f e r e n c e

actuate.parameter.ParameterDef ini t ion

Class actuate.parameter.ParameterDefinitionDescription The ParameterDefinition object contains all of the qualities, values, names, and

conditions for a parameter. A ParameterDefinition object can display options to the user and respond to user-generated events. The actuate.Parameter class downloads an array of ParameterDefinition objects with downloadParameters( ). The order of this array is also the order in which the parameters are displayed. Parameters can be grouped to divide the parameters on the page into logical sets under a heading.

This class requires significant memory and bandwidth resources. ParameterValue is much smaller than ParameterDefinition. ParameterValue is the more efficient way to communicate to the server that a parameter value has changed.

ConstructorSyntax actuate.parameter.ParameterDefinition( )

Constructs a new ParameterDefinition object.

Function summaryTable 7-24 lists actuate.parameter.ParameterDefinition functions.

Table 7-24 actuate.parameter.ParameterDefinition functions

Function Description

getAutoSuggestThreshold( ) Gets the auto suggest threshold value for this ParameterDefinition

getCascadingParentName( ) Gets the cascadingParentName value for this ParameterDefinition

getColumnName( ) Gets the columnName value for this ParameterDefinition

getColumnType( ) Gets the columnType value for this ParameterDefinition

getControlType( ) Gets the controlType value for this ParameterDefinition

getCurrentDisplayName( ) Gets the auto suggest current display name for the current value of this ParameterDefinition

getDataType( ) Gets the dataType value for this ParameterDefinition

getDefaultValue( ) Gets the defaultValue value for this ParameterDefinition

Page 339: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 321

actuate.parameter.ParameterDefini t ion

getDefaultValueIsNull( ) Gets a flag if the default value is null for this ParameterDefinition

getDisplayName( ) Gets the displayName value for this ParameterDefinition

getGroup( ) Gets the group value for this ParameterDefinition

getHelpText( ) Gets the helpText value for this ParameterDefinition

getName( ) Gets the name value for this ParameterDefinition

getOperatorList( ) Gets the list of valid operators

getPosition( ) Gets the position value for this ParameterDefinition

getSelectNameValueList( ) Gets the selectNameValueList value for this ParameterDefinition

getSelectValueList( ) Gets the selectValueList value for this ParameterDefinition

isAdHoc( ) Returns whether the parameter is a dynamic filter

isHidden( ) Gets the isHidden value for this ParameterDefinition

isPassword( ) Gets the isPassword value for this ParameterDefinition

isRequired( ) Gets the isRequired value for this ParameterDefinition

isViewParameter( ) Obsolete since BIRT iHub release 2.

setAutoSuggestThreshold( ) Sets the auto suggest threshold value for this ParameterDefinition

setCascadingParentName( ) Sets the cascadingParentName value for this ParameterDefinition

setColumnName( ) Sets the columnName value for this ParameterDefinition

setColumnType( ) Sets the columnType value for this ParameterDefinition

(continues)

Table 7-24 actuate.parameter.ParameterDefinition functions (continued)

Function Description

Page 340: Actuate API Reference - OpenText

322 A c t u a t e A P I R e f e r e n c e

actuate.parameter.ParameterDef ini t ion

setControlType( ) Sets the controlType value for this ParameterDefinition

setCurrentDisplayName( ) Sets the current display name for this ParameterDefinition

setDataType( ) Sets the dataType value for this ParameterDefinition

setDefaultValue( ) Sets the defaultValue value for this ParameterDefinition

setDefaultValueIsNull( ) Sets the defaultValue to null for this ParameterDefinition

setDisplayName( ) Sets the displayName value for this ParameterDefinition

setGroup( ) Sets the group value for this ParameterDefinition

setHelpText( ) Sets the helpText value for this ParameterDefinition

setIsAdHoc( ) Sets whether the parameter is a dynamic filter

setIsHidden( ) Sets the isHidden value for this ParameterDefinition

setIsMultiSelectControl( ) Sets the isMultiSelectControl value for this ParameterDefinition

setIsPassword( ) Sets the isPassword value for this ParameterDefinition

setIsRequired( ) Sets the isRequired value for this ParameterDefinition

setIsViewParameter( ) Obsolete since BIRT iHub release 2.

setName( ) Sets the name value for this ParameterDefinition

setPosition( ) Sets the position value for this ParameterDefinition

setSelectNameValueList( ) Sets the selectNameValueList value for this ParameterDefinition

setSelectValueList( ) Sets the selectValueList value for this ParameterDefinition

Table 7-24 actuate.parameter.ParameterDefinition functions (continued)

Function Description

Page 341: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 323

actuate.parameter.ParameterDefini t ion

getAutoSuggestThresholdSyntax integer ParameterDefinition.getAutoSuggestThreshold( )

Gets the auto suggest threshold value for this ParameterDefinition. The auto suggest threshold determines the number of characters a user types in before they are given suggestions from auto suggest.

Returns Integer.

Example To store the auto suggest threshold of the parameter definition paramdef in a variable called threshold, use code similar to the following:

var threshold = paramdef.getAutoSuggestThreshold( );

getCascadingParentNameSyntax string ParameterDefinition.getCascadingParentName( )

Gets the cascadingParentName value for this ParameterDefinition. A cascading parent parameter is only used when one parameter depends upon another.

Returns String.

Example To store the cascading parent name of the parameter definition paramdef in a variable called parentname, use code similar to the following:

var parentname = paramdef.getCascadingParentName( );

getColumnNameSyntax string ParameterDefinition.getColumnName( )

Gets the columnName value for this ParameterDefinition. This setting sets the column to retrieve data from for a dynamic filter parameter that performs a query.

This setting has no effect on other types of parameters.

Returns String.

Example To store the column name of the parameter definition paramdef in a variable called columnname, use code similar to the following:

var columnname = paramdef.getColumnName( );

getColumnTypeSyntax string ParameterDefinition.getColumnType( )

Gets the columnType value for this ParameterDefinition. This setting sets the data type queried by an ad hoc parameter that performs a query.

Page 342: Actuate API Reference - OpenText

324 A c t u a t e A P I R e f e r e n c e

actuate.parameter.ParameterDef ini t ion

This setting has no effect on other types parameters.

Returns String. Possible values are: null, "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".

Example To store the column type of the parameter definition paramdef in a variable called columntype, use code similar to the following:

var columntype = paramdef.getColumnType( );

getControlTypeSyntax string ParameterDefinition.getControlType( )

Gets the controlType value for this ParameterDefinition. It determines the form element displayed for the user to set the parameter value.

Returns String. Possible values are: null, "", "ControlRadioButton", "ControlList", "ControlListAllowNew", and "ControlCheckBox".

Example To store the control type string for the parameter definition paramdef in a variable called controltype, use code similar to the following:

var columntype = paramdef.getColumnType( );

getCurrentDisplayNameSyntax string ParameterDefinition.getCurrentDisplayName( )

Gets the current display name for this ParameterDefinition.

Returns String.

Example To store the current display name of the parameter definition paramdef in a variable called displayname, use code similar to the following:

var displayname = paramdef.getDisplayName( );

getDataTypeSyntax string ParameterDefinition.getDataType( )

Gets the dataType value for this ParameterDefinition.

Returns String. Possible values are: "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".

Example To store the data type of the parameter definition paramdef in a variable called myParamType, use code similar to the following:

var myParamType = paramdef.getDataType( );

Page 343: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 325

actuate.parameter.ParameterDefini t ion

getDefaultValueSyntax string ParameterDefinition.getDefaultValue( )

Gets the defaultValue value for this ParameterDefinition, if applicable.

Returns String.

Example To store the default value as a string for the parameter definition paramdef in a variable called default, use code similar to the following:

var default = paramdef.getDefaultValue( );

getDefaultValueIsNullSyntax boolean ParameterDefinition.getDefaultValueIsNull( )

Returns true when the parameter’s default value is null.

Returns Boolean.

Example To alert the user that the default value is null for the parameter definition paramdef, use code similar to the following:

if (paramdef.getDefaultValueIsNull( )){alert('Default value is null!');

}

getDisplayNameSyntax string ParameterDefinition.getDisplayName( )

Gets the displayName for this ParameterDefinition.

Returns String.

Example To store the displayed name for the parameter definition paramdef in a variable called displayname, use code similar to the following:

var displayname = paramdef.getDisplayName( );

getGroupSyntax string ParameterDefinition.getGroup( )

Gets the group for this ParameterDefinition, indicating if it is a member of a group.

Returns String. A group name, or null if there is no group.

Example To print the group name for the parameter definition paramdef to the current document, use code similar to the following:

Page 344: Actuate API Reference - OpenText

326 A c t u a t e A P I R e f e r e n c e

actuate.parameter.ParameterDef ini t ion

document.write(paramdef.getGroup( ));

getHelpTextSyntax string ParameterDefinition.getHelpText( )

Gets the helpText for this ParameterDefinition.

Returns String. The help text.

Example To store the help text for the parameter definition paramdef in a variable called helptext, use code similar to the following:

var helptext = paramdef.getHelpText( );

getNameSyntax string ParameterDefinition.getName( )

Gets the name for this ParameterDefinition.

Returns String. The parameter name.

Example To store the name for the parameter definition paramdef in a variable called paramname, use code similar to the following:

var paramname = paramdef.getName( );

getOperatorListSyntax string[ ] ParameterDefinition.getOperatorList( )

Gets the operator list for this ParameterDefinition.

Returns An array of strings containing the operator list.

Example To store the list of operators for the parameter definition paramdef in a variable called ops, use code similar to the following:

var ops = new Array( );ops = paramdef.getOperatorList( );

getPositionSyntax Integer ParameterDefinition.getPosition( )

Gets the position in the array for this ParameterDefinition.

Returns Integer.

Example To store the position of the parameter definition paramdef in a variable called position, use code similar to the following:

Page 345: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 327

actuate.parameter.ParameterDefini t ion

var position = paramdef.getPosition( );

getSelectNameValueListSyntax selectNameValueList[ ] ParameterDefinition.getSelectNameValueList( )

Gets the selectNameValueList for this ParameterDefinition. This list applies if the parameter is set with a selection list.

Returns Array of actuate.parameter.NameValuePair objects.

Example To retrieve the name-value pair list for the parameter definition paramdef and put it into a new array, use code similar to the following:

var namevalues = new array( );namevalues = paramdef.getSelectNameValueList( ).slice( );

getSelectValueListSyntax string[ ] ParameterDefinition.getSelectValueList( )

Gets the selectValueList for this ParameterDefinition. This list applies when the parameter is set with a selection list.

Returns An array of strings containing the select value list.

Example To retrieve the list of values selectable for the parameter definition paramdef and put it into a new array, use code similar to the following:

var selectvalues = new array( );selectvalues = paramdef.getSelectValueList( ).slice( );

isAdHocSyntax boolean ParameterDefinition.isAdHoc( )

Returns true when this parameter is a dynamic filter parameter.

Returns Boolean. True when this parameter is a dynamic filter.

Example To set the default value to null for the parameter definition paramdef if it is a dynamic filter parameter, use code similar to the following:

if (paramdef.isAdHoc( )){paramdef.setDefaultValueIsNull(true);

}

isHiddenSyntax boolean ParameterDefinition.isHidden( )

Page 346: Actuate API Reference - OpenText

328 A c t u a t e A P I R e f e r e n c e

actuate.parameter.ParameterDef ini t ion

Gets the isHidden value for this ParameterDefinition.

Returns Boolean. True indicates that this parameter is hidden.

Example To reveal a parameter with the parameter definition paramdef if it is hidden, use code similar to the following:

if (paramdef.isHidden( )){paramdef.setIsHidden(false);

}

isPasswordSyntax boolean ParameterDefinition.isPassword( )

Gets the isPassword value for this ParameterDefinition.

Returns Boolean. True indicates that the parameter is a password.

Example To set the parameter definition paramdef as required if it is a password parameter, use code similar to the following:

if (paramdef.isPassword( )){paramdef.setIsRequired(true);

}

isRequiredSyntax boolean ParameterDefinition.isRequired( )

Gets the isRequired value for this ParameterDefinition.

Returns Boolean. True indicates that the parameter is required.

Example To set specific help text for the parameter definition paramdef if it is a required parameter, use code similar to the following:

if (paramdef.isRequired( )){paramdef.setHelpText("This parameter is required.");

}

isViewParameterObsolete since BIRT iHub release 2.

setAutoSuggestThresholdSyntax void ParameterDefinition.setAutoSuggestThreshold(integer threshold)

Page 347: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 329

actuate.parameter.ParameterDefini t ion

Sets the auto suggest threshold for this ParameterDefinition. The auto suggest threshold determines the number of characters a user types in before they are given suggestions from auto suggest.

Parameter thresholdInteger.

Example To always show the auto suggest dialog for the parameter definition paramdef, use code similar to the following:

paramdef.setAutoSuggestThreshold(0);

setCascadingParentNameSyntax void ParameterDefinition.setCascadingParentName(string

cascadingParentName)

Sets the cascadingParentName for this ParameterDefinition. This sets another parameter as this parameter’s parent.

Parameter cascadingParentNameString.

Example To set the parent name of the parameter definition paramdef to "Clark", use code similar to the following:

paramdef.setCascadingParentName("Clark");

setColumnNameSyntax void ParameterDefinition.setColumnName(string columnName)

Sets the columnName for this ParameterDefinition. Used for queries.

Parameter columnNameString.

Example To set the parameter definition paramdef to access the ProductName column, use code similar to the following:

paramdef.setColumnName("ProductName");

setColumnTypeSyntax void ParameterDefinition.setColumnType(string columnType)

Sets the columnType for this ParameterDefinition. Used for queries.

Parameter columnTypeString. Possible values are null, "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".

Page 348: Actuate API Reference - OpenText

330 A c t u a t e A P I R e f e r e n c e

actuate.parameter.ParameterDef ini t ion

Example To allow the parameter definition paramdef to interpret a column as untyped data, use code similar to the following:

paramdef.setColumnType("Unknown");

setControlTypeSyntax void ParameterDefinition.setControlType(string controlType)

Sets the control type of this ParameterDefinition.

Parameter controlTypeString. Possible values are null, "", "AutoSuggest", "ControlRadioButton", "ControlList", "ControlListAllowNew", and "ControlCheckBox".

Example To set the parameter definition paramdef to use a control list, use code similar to the following:

paramdef.setControlType("ControlList");

setCurrentDisplayNameSyntax void ParameterDefinition.setCurrentDisplayName(string currentDiplayName)

Sets the displayed name for this parameter.

Parameter currentDisplayNameString.

Example To set the display name for the parameter definition paramdef to "Year", use code similar to the following:

paramdef.setCurrentDisplayName("Year");

setDataTypeSyntax void ParameterDefinition.setDataType(string dataType)

Sets the dataType for this ParameterDefinition.

Parameter dataTypeString. Possible values are "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".

Example To set the parameter definition paramdef data type to date, use code similar to the following:

paramdef.setDataType("Date");

setDefaultValueSyntax void ParameterDefinition.setDefaultValue(string defaultValue)

Page 349: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 331

actuate.parameter.ParameterDefini t ion

Sets the default value for this ParameterDefinition.

Parameter defaultValueString.

Example To set the default value of parameter definition paramdef to "2016", use code similar to the following:

paramdef.setDefaultValue("2016");

setDefaultValueIsNullSyntax void ParameterDefinition.setDefaultValue(boolean value)

When true, sets the default value for this ParameterDefinition to null. Sets the default value to no value in all other cases.

Parameter valueBoolean.

Example To set the default value of parameter definition paramdef to null, use code similar to the following:

paramdef.setDefaultValueIsNull(true);

setDisplayNameSyntax void ParameterDefinition.setDisplayName(string displayName)

Sets the name to display on the parameter page for this ParameterDefinition.

Parameter displayNameString.

Example To set the displayed name of parameter definition paramdef to "Year", use code similar to the following:

paramdef.setDisplayName("Year");

setGroupSyntax void ParameterDefinition.setGroup(string group)

Sets the group value for this ParameterDefinition.

Parameter groupString.

Example To assign the parameter definition paramdef to the "Customer Details" parameter group, use code similar to the following:

paramdef.setGroup("Customer Details");

Page 350: Actuate API Reference - OpenText

332 A c t u a t e A P I R e f e r e n c e

actuate.parameter.ParameterDef ini t ion

setHelpTextSyntax void ParameterDefinition.setHelpText(string helpText)

Sets the helpText value for this ParameterDefinition.

Parameter helpTextString.

Example To set specific help text for the parameter definition paramdef if it is a required parameter, use code similar to the following:

if (paramdef.isRequired( )){paramdef.setHelpText("This parameter is required.");

}

setIsAdHocSyntax void ParameterDefinition.setIsAdHoc(boolean isAdHoc)

Sets this parameter as a dynamic filter parameter.

Parameter isAdHocBoolean. True makes this parameter into a dynamic filter.

Example To enable the parameter definition paramdef to accept dynamic filter values, use code similar to the following:

paramdef.setIsAdHoc(true);

setIsHiddenSyntax void ParameterDefinition.setIsHidden(boolean isHidden)

Sets the parameter to hidden.

Parameter isHiddenBoolean. True hides the parameter.

Example To hide a parameter defined by a parameter definition called paramdef, use code similar to the following:

paramdef.setIsHidden(true);

setIsMultiSelectControlSyntax void ParameterDefinition.setIsMultiSelectControl(boolean isMultiSelect)

Sets the parameter to accept multiple selected values.

Parameter isMultiSelectBoolean. True allows multiple selected values to be set for this parameter.

Page 351: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 333

actuate.parameter.ParameterDefini t ion

Example To allow a parameter defined by a parameter definition called paramdef to accept multiple selected values, use code similar to the following:

paramdef.setIsMultiSelectControl(true);

setIsPasswordSyntax void ParameterDefinition.setIsPassword(boolean isPassword)

Sets this parameter to treat its value as a password, which hides the input on the page and encrypts the value.

Parameter isPasswordBoolean. True indicates a password value.

Example To set the parameter type accepted by the parameter definition paramdef to password, use code similar to the following:

paramdef.setIsPassword(true);

setIsRequiredSyntax void ParameterDefinition.setIsRequired(boolean isRequired)

Sets the parameter to required.

Parameter isRequiredBoolean. True indicates a mandatory parameter.

Example To make the parameter defined by the parameter definition paramdef mandatory, use code similar to the following:

paramdef.setIsRequired(true);

setIsViewParameterObsolete since BIRT iHub release 2.

setNameSyntax void ParameterDefinition.setName(string name)

Sets the name to use internally for this ParameterDefinition.

Parameter nameString.

Example To set the internal name of the parameter definition paramdef to Year, use code similar to the following:

paramdef.setName("Year");

Page 352: Actuate API Reference - OpenText

334 A c t u a t e A P I R e f e r e n c e

actuate.parameter.ParameterDef ini t ion

setPositionSyntax void ParameterDefinition.setPosition(integer position)

Sets the position value for this ParameterDefinition. The index indicates the position in the array of the ParameterDefinition.

Parameter positionInteger.

Example To shift the parameter definition paramdef down on position in the parameter array, use code similar to the following:

paramdef.setPosition(++paramdef.getPosition( ));

setSelectNameValueListSyntax void ParameterDefinition.setSelectNameValueList

(actuate.parameter.NameValuePair[ ] selectNameValueList)

Sets the selectNameValueList value for this ParameterDefinition.

Parameter selectNameValueListArray of actuate.parameter.NameValuePair objects.

Example To set the parameter definition paramdef to select the same name-value list as the parameter definition nparam, use code similar to the following:

paramdef.setSelectNameValueList(nparam.getSelectNameValueList( ));

setSelectValueListSyntax void ParameterDefinition.setSelectValueList(array[ ] selectValueList)

Sets the selectValueList value for this ParameterDefinition.

Parameter selectValueListArray.

Example To set the parameter definition paramdef to select the values 2007-2009, use code similar to the following:

var values = new Array("2007", "2008", "2009");paramdef.setSelectValueList(values);

Page 353: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 335

actuate.parameter .ParameterValue

Class actuate.parameter.ParameterValueDescription ParameterValue is a container for the value of Parameter to be passed to a report

for processing. When a user sets a value in the interface, the corresponding ParameterValue must change.

Because ParameterValue is much smaller that ParameterDefinition, it is the recommended means of communicating to the server that a parameter value has changed or passing a parameter value to a viewer element. Sending an entire ParameterDefinition has a larger effect on system performance.

ConstructorSyntax actuate.parameter.ParameterValue( )

Constructs a new ParameterValue object.

Function summaryTable 7-25 lists actuate.parameter.ParameterValue functions.

Table 7-25 actuate.parameter.ParameterValue functions

Function Description

getColumnName( ) Gets the name of the column in this ParameterValue

getColumnType( ) Gets the data type value of the column for this ParameterValue

getDataType( ) Gets the dataType value for this ParameterValue

getDisplayName( ) Gets the displayed name for this ParameterValue

getGroup( ) Gets the group value for this ParameterValue

getName( ) Gets the name value for this ParameterValue

getPosition( ) Gets the position value for this ParameterValue

getPromptParameter( ) Gets the promptParameter value for this ParameterValue

getValue( ) Gets the value or values for this ParameterValue

getValueIsNull( ) Gets the valueIsNull value for this ParameterValue

isViewParameter( ) Gets the isViewParameter value for this ParameterValue

(continues)

Page 354: Actuate API Reference - OpenText

336 A c t u a t e A P I R e f e r e n c e

actuate.parameter.ParameterValue

getColumnNameSyntax string ParameterValue.getColumnName( )

Gets the column name value for this ParameterValue. Columns are supported as part of ad hoc parameters.

Returns String. The name of the column.

Example To store the column name for the parameter value pvalue in a variable called columnname, use code similar to the following:

var columnname = pvalue.getColumnName( );

getColumnTypeSyntax string ParameterValue.getColumnType( )

Gets the data type value of the column for this ParameterValue. Columns are supported as part of ad hoc parameters.

Returns String. Possible values are null, "", "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".

setColumnName( ) Sets the name of the column in this ParameterValue

setColumnType( ) Sets the data type value of the column for this ParameterValue

setDataType( ) Sets the dataType value for this ParameterValue

setDisplayName( ) Sets the displayed name for this ParameterValue

setGroup( ) Sets the group value for this ParameterValue

setIsViewParameter( ) Sets the isViewParameter value for this ParameterValue

setName( ) Sets the name value for this ParameterValue

setPosition( ) Sets the position value for this ParameterValue

setPromptParameter( ) Sets the promptParameter value for this ParameterValue

setValue( ) Sets the value for this ParameterValue

setValueIsNull( ) Sets the valueIsNull value for this ParameterValue

Table 7-25 actuate.parameter.ParameterValue functions (continued)

Function Description

Page 355: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 337

actuate.parameter .ParameterValue

Example To store the column type for the parameter value pvalue in a variable called columntype, use code similar to the following:

var columntype = pvalue.getColumnType( );

getDataTypeSyntax string ParameterValue.getDataType( )

Gets the dataType value for this ParameterValue.

Returns String. Possible values are null, "", "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".

Example To store the data type for the parameter value pvalue in a variable called type, use code similar to the following:

var type = pvalue.getDataType( );

getDisplayNameSyntax string ParameterValue.getDisplayName( )

Gets the displayed name for this ParameterValue.

Returns String. The displayed name.

Example To store the displayed name of the parameter value pvalue in a variable called displayedName, use code similar to the following:

var displayedName = pvalue.getDisplayName( );

getGroupSyntax string ParameterValue.getGroup( )

Gets the group value for this ParameterValue.

Returns String.

Example To store the group that the parameter value pvalue belongs to in a variable called group, use code similar to the following:

var group = pvalue.getGroup( );

getNameSyntax string ParameterValue.getName( )

Gets the name value for this ParameterValue.

Returns String.

Page 356: Actuate API Reference - OpenText

338 A c t u a t e A P I R e f e r e n c e

actuate.parameter.ParameterValue

Example To store the name of the parameter value pvalue in a variable called name, use code similar to the following:

var name = pvalue.getName( );

getPositionSyntax integer ParameterValue.getPosition( )

Gets the position value for this ParameterValue.

Returns Integer.

Example To save the position of the parameter value pvalue in the parameter list to a variable called pos, use code similar to the following:

var pos = pvalue.getPosition( );

getPromptParameterSyntax boolean ParameterValue.getPromptParameter( )

Gets the promptParameter value for this ParameterValue.

Returns Boolean.

Example To store the prompt parameter of the parameter value pvalue in a variable called prompt, use code similar to the following:

var prompt = pvalue.getPromptParameter( );

getValueSyntax string[ ] ParameterValue.getValue( )

Gets the value values for this ParameterValue.

Returns String or array of strings. The value or values of this ParameterValue object.

Example To store the value of the parameter value pvalue in a variable called value, use code similar to the following:

var value = pvalue.getValue( );

getValueIsNullSyntax boolean ParameterValue.getValueIsNull( )

Gets the valueIsNull value for this ParameterValue.

Returns Boolean. True indicates that this ParameterValue is null.

Page 357: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 339

actuate.parameter .ParameterValue

Example To alert the user that the value of the parameter value pvalue is null, use code similar to the following:

if (pavalue.getValueIsNull( )){alert('Default value is null!');

}

isViewParameterSyntax boolean ParameterValue.isViewParameter( )

Gets the isViewParameter value for this ParameterValue.

Returns Boolean. True indicates that this ParameterValue is visible.

Example To set specific help text for the parameter value pvalue if it is a view-time parameter, use code similar to the following:

if (pvalue.isViewParameter( )){pvalue.setHelpText("This is a view-time parameter.");

}

setColumnNameSyntax void ParameterValue.setColumnName(string columnName)

Sets the column name value for this ParameterValue.

Parameter columnNameString. The name of the column.

Example To set the column name for the parameter value pvalue to Year, use code similar to the following:

pvalue.setColumnName("Year");

setColumnTypeSyntax void ParameterValue.setColumnType(string columnType)

Sets the data type of the column for this ParameterValue. Used for queries.

Parameter columnTypeString. Possible values are "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".

Example To set the column type for the parameter value pvalue to Date, use code similar to the following:

pvalue.setColumnType("Date");

Page 358: Actuate API Reference - OpenText

340 A c t u a t e A P I R e f e r e n c e

actuate.parameter.ParameterValue

setDataTypeSyntax void ParameterValue.setDataType(string dataType)

Sets the dataType value for this ParameterValue.

Parameter dataTypeString. Possible values are "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".

Example To set the data type for the parameter value pvalue to Date, use code similar to the following:

pvalue.setDataType("Date");

setDisplayNameSyntax void ParameterValue.setDisplayName(string name)

Sets the displayed name value for this ParameterValue.

Parameter nameString. A displayed parameter name.

Example To set the display name of the parameter value pvalue to Year, use code similar to the following:

pvalue.setDisplayName("Year");

setGroupSyntax void ParameterValue.setGroup(string group)

Sets the group value for this ParameterValue.

Parameter groupString. The name of the group.

Example To set the group for the parameter value pvalue to Customer Details, use code similar to the following:

pvalue.setGroup("Customer Details");

setIsViewParameterSyntax void ParameterValue.setIsViewParameter(boolean isViewParameter)

Sets the isViewParameter value for this ParameterValue.

Parameter isViewParameterBoolean. True indicates a view-time parameter.

Page 359: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 341

actuate.parameter .ParameterValue

Example To make the parameter value pvalue into a view-time parameter, use code similar to the following:

pvalue.setIsViewParameter(true);

setNameSyntax void ParameterValue.setName(string name)

Sets the name value for this ParameterValue.

Parameter nameString. A parameter name.

Example To set the name of the parameter value pvalue to Year, use code similar to the following:

pvalue.setName("Year");

setPositionSyntax void ParameterValue.setPosition(integer position)

Sets the position value for this ParameterValue.

Parameter positionInteger. The position from the top of the parameter list.

Example To move the parameter value pvalue one place farther down in the parameter list, use code similar to the following:

pvalue.setPosition(++pvalue.getPosition( ));

setPromptParameterSyntax void ParameterValue.setPromptParameter(boolean promptParameter)

Sets the promptParameter value for this ParameterValue.

Parameter promptParameterBoolean. True indicates that this parameter prompts the user.

Example To set the parameter value pvalue to not prompt the user, use code similar to the following:

pvalue.setPromptParameter(false);

setValueSyntax void ParameterValue.setValue(string[ ] value)

Sets the value or values for this ParameterValue.

Page 360: Actuate API Reference - OpenText

342 A c t u a t e A P I R e f e r e n c e

actuate.parameter.ParameterValue

Parameter valueString or array of strings. The value or values of this ParameterValue object.

Example To set the value of the parameter value pvalue to 2016, use code similar to the following:

pvalue.setValue("2016");

To set the values of the ParameterValue object pvalues to 2014, 2015, and 2016, use code similar to the following:

pvalue.setValue({"2014", "2015", "2016"});

setValueIsNullSyntax void ParameterValue.setValueIsNull(boolean valueIsNull)

Sets the valueIsNull value for this ParameterValue.

Parameter valueIsNullBoolean. True indicates that this ParameterValue is null.

Example To set the value of parameter value pvalue to null, use code similar to the following:

pvalue.setValueIsNull(true);

Page 361: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 343

actuate.report .Chart

Class actuate.report.ChartDescription Provides functions to operate on a chart element, such as changing its format or

retrieving data from specific elements.

ConstructorThe actuate.report.Chart object is created when actuate.viewer.PageContent.getChartByBookmark( ) is called.

Function summaryTable 7-26 lists actuate.report.Chart functions.

Table 7-26 actuate.report.Chart functions

Function Description

clearFilters( ) Clears the filters applied to the given column

drillDownCategory( ) Drills down into a chart by category

drillDownSeries( ) Drills down into a chart by series

drillUpCategory( ) Drills up one level by category

drillUpSeries( ) Drills up one level by series

getBookmark( ) Returns the report element bookmark name

getClientChart( ) Returns an HTML5 instance of this chart

getHtmlDom( ) Returns the HTML element DOM object

getInstanceId( ) Returns the report element instance id

getPageContent( ) Returns the page content to which this element belongs

getType( ) Returns the report element type

hide( ) Hides this element

setChartTitle;l( ) Sets the title for this chart

setDimension( ) Sets the number of dimensions of the chart element

setFilters( ) Applies filters to this chart element

setSize( ) Sets the width and height of the chart element

setSubType( ) Sets a chart subtype to the chart element

show( ) Shows this element

(continues)

Page 362: Actuate API Reference - OpenText

344 A c t u a t e A P I R e f e r e n c e

actuate.report .Chart

clearFiltersSyntax void Chart.clearFilters(string columnName)

Clears the filters for a given column.

Parameter columnNameString. The name of the column.

Example This example clears existing filters from the PRODUCTLINE column of a chart and changes the chart title:

function resetFilter(bchart){bchart.clearFilters("PRODUCTLINE");bchart.setChartTitle("Orders By Country");bchart.submit( );

}

drillDownCategorySyntax void Chart.drillDownCategory(string categoryData)

Drills down into a chart by category.

Parameter categoryDataString. The name of the data category to drill down to.

drillDownSeriesSyntax void Chart.drillDownSeries(string seriesName)

Drills down into a chart by series.

Parameter seriesNameString. The name of the data series to drill down to.

drillUpCategorySyntax void Chart.drillUpCategory( )

Drills up into a chart by one data category level.

submit( ) Submits all the asynchronous operations that the user has requested on this report and renders the chart component on the page

Table 7-26 actuate.report.Chart functions (continued)

Function Description

Page 363: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 345

actuate.report .Chart

drillUpSeriesSyntax void Chart.drillUpSeries( )

Drills up into a chart by one series level.

getBookmarkSyntax string Chart.getBookmark( )

Returns the chart’s bookmark name.

Returns String. The chart’s bookmark name.

Example This example sets the chart’s title to the bookmark name:

function titleBookmark(bchart){bchart.setChartTitle(bchart.getBookmark( ));bchart.submit( );

}

getClientChartSyntax actuate.report.HTML5Chart.ClientChart Chart.getClientChart( )

Returns the HTML5 Chart instance if this chart has an HTML5 Chart output format, otherwise returns null.

Returns actuate.report.HTML5Chart.ClientChart. The HTML5 formatted chart or null.

Example This example displays the chart ID of the HTML5 chart in an alert box:

function showHTML5ChartID(myChart){var myHTML5Chart = myChart.getClientChart( );var HTML5ChartID = myHTML5Chart.getViewerId( );alert (HTML5ChartID);

}

getHtmlDomSyntax HTMLElement Chart.getHtmlDom( )

Returns the HTML element for this chart.

Returns HTMLElement. The HTML DOM element.

Example This example displays the HTML DOM element for this chart inside a red border:

function showHtmlDom(myChart){var domNode = myChart.getHtmlDom( );var box = document.createElement('div');box.style.border = '2px solid red';

Page 364: Actuate API Reference - OpenText

346 A c t u a t e A P I R e f e r e n c e

actuate.report .Chart

var label = document.createElement('h2');label.innerHTML = 'The HTML DOM:';box.appendChild(label);box.appendChild(domNode);document.body.appendChild(box);

}

getInstanceIdSyntax string Chart.getInstanceId( )

Returns the instance id of this report element.

Returns String. The instance id.

Example This example displays the instance ID of the report element in an alert box:

function showID(myChart){var elementID = myChart.getInstanceId( );alert (elementID);

}

getPageContentSyntax actuate.viewer.PageContent Chart.getPageContent( )

Returns the content of the page to which this chart belongs.

Returns actuate.report.PageContent. The report content.

Example This example displays the viewer ID of the page content in an alert box:

function showViewID(myChart){var pageContent = myChart.getPageContent( );var pageViewerID = pageContent.getViewerId( );alert (pageViewerID);

}

getTypeSyntax string Chart.getType( )

Returns the chart’s report element type.

Returns String. This method returns the string "Chart" when the type is actuate.report.Chart.CHART and the string "Flash Chart" when the type is actuate.report.Chart.FLASH_CHART.

Example This example displays the chart type in an alert box:

alert ("Chart is of type " + myChart.getType( ));

Page 365: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 347

actuate.report .Chart

hideSyntax void Chart.hide( )

Hides this element.

Example To hide the chart bchart, use code similar to the following:

alert("Hiding chart" + bchart.getBookmark( ));bchart.hide( );bchart.submit( );

setChartTitle;l

Syntax void Chart.setChartTitle(string title)

Sets the title for this chart element.

Parameter titleString. The title for the chart.

Example This example sets the chart’s title to the bookmark name:

function titleBookmark(bchart){bchart.setChartTitle(bchart.getBookmark( ));bchart.submit( );

}

setDimensionSyntax void Chart.setDimension(actuate.report.Chart dimension)

Sets the number of dimensions for the chart element. The chart dimension only works if supported by the chart’s type. A 3D chart does not support multiple value axes. Remove all of the y-axes after the first before converting a chart to 3D.

Parameter dimensionactuate.report.Chart. The number of dimensions in which to display the chart element. Supported values are 2D and 2D with depth. The constants defined for this argument are:

■ actuate.report.Chart.CHART_DIMENSION_2D

■ actuate.report.Chart.CHART_DIMENSION_2D_WITH_DEPTH

Example This example changes the chart bchart’s dimension to 2D with depth:

bchart.setChartTitle(bchart.getBookmark( ) + ": 2D with Depth");bchart.setDimension(

actuate.report.Chart.CHART_DIMENSION_2D_WITH_DEPTH );bchart.submit( );

Page 366: Actuate API Reference - OpenText

348 A c t u a t e A P I R e f e r e n c e

actuate.report .Chart

setFiltersSyntax void Chart.setFilters(actuate.data.Filter filter)

void Chart.setFilters(actuate.data.Filter[ ] filters)

Applies filters to this chart element. To apply more than one filter to a chart element, call this function multiple times, once for each filter object.

Parameters filterAn actuate.data.Filter object. A single filter condition to apply to this chart element.

filtersAn array of actuate.data.Filter objects. Filter conditions to apply to this chart element.

Example This example applies a filter to the chart and changes the chart’s title to reflect the filter:

function chartFilter(bchart){var filter = new actuate.data.Filter("PRODUCTLINE", "=",

"Trucks and Buses");var filters = new Array( );filters.push(filter);bchart.setFilters(filters);bchart.setChartTitle("Orders By Country (Trucks and Buses)");bchart.submit( );

}

setSizeSyntax void Chart.setSize(integer width, integer height)

Sets the width and height of the chart element displayed.

Parameters widthInteger. The width in pixels.

heightInteger. The height in pixels.

Example To set the chart bchart to be 600 pixels wide by 800 pixels high, use code similar to the following:

alert("Resizing " + bchart.getBookmark( ) + " to 600x800");bchart.setSize(600,800);bchart.submit( );

Page 367: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 349

actuate.report .Chart

setSubTypeSyntax void Chart.setSubType(string chartType)

Sets a subtype for this chart element. When the report calls submit( ), the report redraws the chart element as the requested type.

Parameter chartTypeString. The format in which to redraw the chart element. The constants that define the chart subtypes are:

■ CHART_SUBTYPE_PERCENTSTACKED

■ CHART_SUBTYPE_SIDEBYSIDE

■ CHART_SUBTYPE_STACKED

Example To change the subtype of the chart bchart to side-by-side, use code similar to the following:

bchart.setChartTitle("Side by Side Chart");bchart.setSubType(actuate.report.Chart.CHART_SUBTYPE_SIDEBYSIDE);bchart.submit( );

showSyntax void Chart.show( )

Shows this element.

Example To reveal the hidden chart bchart, use code similar to the following:

alert("Showing chart" + bchart.getBookmark( ));bchart.show( );bchart.submit( );

submitSyntax void Chart.submit(function callback)

Submits all the asynchronous operations for this chart. The submit( ) function triggers an AJAX request for all asynchronous operations. When the server finishes the processing, it returns a response and the results are rendered on the page in the chart container.

Parameter callbackFunction. Optional. A function to execute after the asynchronous call processing is done. Submit passes the current actuate.Viewer object to the callback as an input parameter.

Example This example sets the chart’s title to the bookmark name and pops up an alert box after calling submit( ):

Page 368: Actuate API Reference - OpenText

350 A c t u a t e A P I R e f e r e n c e

actuate.report .Chart

function titleBookmark(bchart){bchart.setChartTitle(bchart.getBookmark( ));bchart.submit(alert("Title Changed"));

}

Page 369: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 351

actuate.report.DataItem

Class actuate.report.DataItemDescription A container for a data element in a report. DataItem provides functions to operate

on a data element, such as retrieving the data value and getting the HTML DOM element from the report data element.

ConstructorThe DataItem object is constructed by actuate.viewer.PageContent.getDataItemByBookmark( ).

Function summaryTable 7-27 lists actuate.report.DataItem functions.

getBookmarkSyntax string DataItem.getBookmark( )

Returns the bookmark name for this data item.

Returns String.

Example This example displays the data item’s bookmark in an alert box:

alert(myDataItem.getBookmark( ));

Table 7-27 actuate.report.DataItem functions

Function Description

getBookmark( ) Returns the bookmark name for this data item

getData( ) Returns the data value on this data element

getHtmlDom( ) Returns the HTML element for this data item

getInstanceId( ) Returns the instance id of this report element.

getPageContent( ) Returns the page content to which this element belongs

getType( ) Returns the report element type

hide( ) Hides this element

show( ) Shows this element

submit( ) Applies the changes made to this DataItem

Page 370: Actuate API Reference - OpenText

352 A c t u a t e A P I R e f e r e n c e

actuate.report .DataI tem

getDataSyntax string DataItem.getData( )

Returns the data value of this data element.

Returns String. The data value.

Example This example displays the data element’s data value in an alert box:

alert(myDataItem.getData( ));

getHtmlDomSyntax HTMLElement DataItem.getHtmlDom( )

Returns the HTML element for this data item.

Returns HTMLElement.

Example This example displays the HTML DOM element for this data item inside a red border:

function showHtmlDom(myDataItem){var domNode = myDataItem.getHtmlDom( );var box = document.createElement('div');box.style.border = '2px solid red';var label = document.createElement('h2');label.innerHTML = 'The HTML DOM:';box.appendChild(label);box.appendChild(domNode);document.body.appendChild(box);

}

getInstanceIdSyntax string DataItem.getInstanceId( )

Returns the instance id of this report element.

Returns String. The instance id.

Example This example displays the instance ID of the report element in an alert box:

function showID(myDataItem){var elementID = myDataItem.getInstanceId( );alert (elementID);

}

Page 371: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 353

actuate.report.DataItem

getPageContentSyntax actuate.viewer.PageContent DataItem.getPageContent( )

Returns the page content to which this data item belongs.

Returns actuate.report.PageContent. report content.

Example This example displays the viewer ID of the page content in an alert box:

function showViewID(myDataItem){var pageContent = myDataItem.getPageContent( );var pageViewerID = pageContent.getViewerId( );alert (pageViewerID);

}

getTypeSyntax string DataItem.getType( )

Returns the report element type of this object, which is data.

Returns String. "Data".

Example This example checks the report element type and displays an alert if the type is not "Data":

if (myDataItem.getType( ) != "Data"){alert("Type mismatch; report element type is not data");

}

hideSyntax void DataItem.hide( )

Hides this element.

Example Use hide( ) to hide a data item object, as shown in the following code:

myDataItem.hide( );

showSyntax void DataItem.show( )

Shows this element.

Example Use show( ) to reveal a hidden data item object, as shown in the following code:

myDataItem.show( );

Page 372: Actuate API Reference - OpenText

354 A c t u a t e A P I R e f e r e n c e

actuate.report .DataI tem

submitSyntax void DataItem.submit(function callback)

Submits all the asynchronous operations for this DataItem. Submit( ) triggers an AJAX request for all asynchronous operations. When the server finishes the processing, it returns a response and the results are rendered on the page in the DataItem container.

Parameter callbackFunction. The function to execute after the asynchronous call processing is done.

Example Use submit( ) to execute changes on a data item object, as shown in the following code:

myDataItem.submit( );

Page 373: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 355

actuate.report .FlashObject

Class actuate.report.FlashObjectDescription A container for a Flash object in a report. FlashObject provides functions to

operate on a Flash object, such as retrieving content and getting the HTML DOM element from the report Flash element.

ConstructorThe FlashObject object is constructed by actuate.viewer.PageContent.getFlashObjectByBookmark( ).

Function summaryTable 7-28 lists actuate.report.FlashObject functions.

clearFiltersSyntax void FlashObject.clearFilters(string columnName)

Clears the filters of a given column.

Parameter columnNameString. The name of the column from which to clear the filters.

Example This example clears existing filters from the PRODUCTLINE column:

function resetFilter(flashobj){flashobj.clearFilters("PRODUCTLINE");

Table 7-28 actuate.report.FlashObject functions

Function Description

clearFilters( ) Removes filters from this FlashObject

getBookmark( ) Returns the bookmark name for this FlashObject

getHtmlDom( ) Returns the HTML element for this FlashObject

getInstanceId( ) Returns the report element instance id

getPageContent( ) Returns the page content to which this element belongs

getType( ) Returns the FlashObject’s element type

hide( ) Hides this element

setFilters( ) Adds filters to this FlashObject

show( ) Shows this element

submit( ) Applies changes made to this FlashObject

Page 374: Actuate API Reference - OpenText

356 A c t u a t e A P I R e f e r e n c e

actuate.report .FlashObject

flashobj.submit( );}

getBookmarkSyntax string FlashObject.getBookmark( )

Returns the bookmark of this FlashObject element.

Returns String.

Example This example displays the Flash object’s bookmark in an alert box:

function alertBookmark(myFlashobj){alert(myFlashobj.getBookmark( ));

}

getHtmlDomSyntax HTMLElement FlashObject.getHtmlDom( )

Returns the HTML element for this FlashObject.

Returns HTMLElement.

Example This example displays the HTML DOM element for this data item inside a red border:

function showHtmlDom(myFlashobj){var domNode = myFlashobj.getHtmlDom( );var box = document.createElement('div');box.style.border = '2px solid red';var label = document.createElement('h2');label.innerHTML = 'The HTML DOM:';box.appendChild(label);box.appendChild(domNode);document.body.appendChild(box);

}

getInstanceIdSyntax string FlashObject.getInstanceId( )

Returns the instance id of this report element.

Returns String. The instance id.

Example This example displays the instance ID of the report element in an alert box:

function showID(myFlashObject){var elementID = myFlashObject.getInstanceId( );

Page 375: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 357

actuate.report .FlashObject

alert (elementID);}

getPageContentSyntax actuate.viewer.PageContent FlashObject.getPageContent( )

Returns the page content to which this FlashObject belongs.

Returns actuate.viewer.PageContent. report content.

Example This example displays the viewer ID of the page content in an alert box:

function showViewID(myFlashobj){var pageContent = myFlashobj.getPageContent( );var pageViewerID = pageContent.getViewerId( );alert (pageViewerID);

}

getTypeSyntax string FlashObject.getType( )

Returns the report element type of this object, which is FlashObject.

Returns String. "FlashObject".

Example This example checks the report element type and displays an alert if the type is not "FlashObject":

if (myFlashObject.getType( ) != "FlashObject"){alert("Type mismatch, report element type is not FlashObject");

}

hideSyntax void FlashObject.hide( )

Hides this element.

Example Use hide( ) to hide the Flash object, as shown in the following code:

myFlashobj.hide( );

setFiltersSyntax void FlashObject.setFilters(actuate.data.Filter[ ] filters)

Sets the given filters.

Page 376: Actuate API Reference - OpenText

358 A c t u a t e A P I R e f e r e n c e

actuate.report .FlashObject

Parameter filtersAn array of actuate.data.Filter objects. The filter conditions to apply to this chart element.

Example This example applies a filter to the Flash object:

function newFilter(myFlashobj){var filter = new

actuate.data.Filter("PRODUCTLINE", "=", "Trucks and Buses");var filters = new Array( );filters.push(filter);myFlashobj.setFilters(filters);

}

showSyntax void FlashObject.show( )

Shows this element.

Example Use show( ) to reveal a hidden Flash object, as shown in the following code:

myFlashobj.show( );

submitSyntax void FlashObject.submit(function callback)

Submits all the asynchronous operations for this FlashObject. Submit( ) triggers an AJAX request for all asynchronous operations. When the server finishes the processing, it returns a response and the results are rendered on the page in the FlashObject container.

Parameter callbackFunction. The function to execute after the asynchronous call processing is done.

Example This example clears existing filters from the PRODUCTLINE column and pops up an alert box:

function alertResetFilter(flashobj){flashobj.clearFilters("PRODUCTLINE");flashobj.submit(alert("Filters Cleared"));

}

Page 377: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 359

actuate.report .Gadget

Class actuate.report.GadgetDescription A container for a Flash gadget object in a report. The Gadget class provides

functions to operate on a Flash gadget object, such as retrieving content and getting the HTML DOM element from the report Flash element.

ConstructorThe Gadget object is constructed by viewer.PageContent.getGadgetByBookmark( ).

Function summaryTable 7-29 lists actuate.report.Gadget functions.

clearFiltersSyntax void Gadget.clearFilters(string columnName)

Clears the filters of a given column.

Parameter columnNameString. The name of the column from which to clear the filters.

Table 7-29 actuate.report.Gadget functions

Function Description

clearFilters( ) Removes filters from this gadget

getBookmark( ) Returns the bookmark name for this gadget

getHtmlDom( ) Returns the HTML element for this gadget

getInstanceId( ) Returns the report element instance id

getPageContent( ) Returns the page content to which this element belongs

getType( ) Returns the gadget’s element type, which is gadget

hide( ) Hides this element

setFilters( ) Adds filters to this gadget

setGadgetType( ) Sets the gadget type

setSize( ) Resizes the gadget’s width and height

show( ) Shows this element

submit( ) Applies changes made to this gadget

Page 378: Actuate API Reference - OpenText

360 A c t u a t e A P I R e f e r e n c e

actuate.report .Gadget

Example This example clears existing filters from the PRODUCTLINE column:

function resetFilter(myGadget){myGadget.clearFilters("PRODUCTLINE");myGadget.submit( );

}

getBookmarkSyntax string Gadget.getBookmark( )

Returns the bookmark of this Gadget element.

Returns String. The gadget’s bookmark.

Example This example displays the gadget’s bookmark in an alert box:

function alertBookmark(myGadget){alert(myGadget.getBookmark( ));

}

getHtmlDomSyntax HTMLElement Gadget.getHtmlDom( )

Returns the HTML element for this gadget.

Returns HTMLElement.

Example This example displays the HTML DOM element for this gadget inside a red border:

function showHtmlDom(myGadget){var domNode = myGadget.getHtmlDom( );var box = document.createElement('div');box.style.border = '2px solid red';var label = document.createElement('h2');label.innerHTML = 'The HTML DOM:';box.appendChild(label);box.appendChild(domNode);document.body.appendChild(box);

}

getInstanceIdSyntax string Gadget.getInstanceId( )

Returns the instance id of this report element.

Returns String. The instance id.

Page 379: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 361

actuate.report .Gadget

Example This example displays the instance ID of the report element in an alert box:

function showID(myGadget){var elementID = myGadget.getInstanceId( );alert (elementID);

}

getPageContentSyntax actuate.viewer.PageContent Gadget.getPageContent( )

Returns the page content to which this gadget belongs.

Returns actuate.viewer.PageContent. report content.

Example This example displays the viewer ID of the page content in an alert box:

function showViewID(myGadget){var pageContent = myGadget.getPageContent( );var pageViewerID = pageContent.getViewerId( );alert (pageViewerID);

}

getTypeSyntax string Gadget.getType( )

Returns the report element type of this object, which is Gadget.

Returns String. "Gadget".

Example This example checks the report element type and displays an alert if the type is not "Gadget":

if (myGadget.getType( ) != "Gadget"){alert("Type mismatch, report element type is not Gadget");

}

hideSyntax void Gadget.hide( )

Hides this element.

Example Use hide( ) to hide a gadget, as shown in the following code:

myGadget.hide( );

setFiltersSyntax void Gadget.setFilters(actuate.data.Filter[ ] filters)

Page 380: Actuate API Reference - OpenText

362 A c t u a t e A P I R e f e r e n c e

actuate.report .Gadget

Sets the given filters.

Parameter filtersAn array of actuate.data.Filter objects. The filter conditions to apply to this chart element.

Example This example applies a filter to the gadget:

function newFilter(myGadget){var filter = new actuate.data.Filter("PRODUCTLINE", "=",

"Trucks and Buses");var filters = new Array( );filters.push(filter);myGadget.setFilters(filters);

}

setGadgetTypeSyntax void Gadget.setGadgetType(string chartType)

Specifies the gadget type for the Gadget element. The chart type is a constant.

Parameter chartTypeString. The possible values are constants as listed below:

■ GADGET_TYPE_BULLET: Bullet gadget subtype

■ GADGET_TYPE_CYLINDER: Cylinder gadget subtype

■ GADGET_TYPE_LINEARGAUGE: LinearGauge gadget subtype

■ GADGET_TYPE_METER: Meter gadget subtype

■ GADGET_TYPE_SPARK: Spark gadget subtype

■ GADGET_TYPE_THERMOMETER: Thermometer gadget subtype

Example To change the gadget type to a meter, use code similar to the following:

myGadget.setGadgetType(actuate.report.Gadget.GADGET_TYPE_METER);

setSizeSyntax void Gadget.setSize(integer width, integer height)

Specifies the width and height of a gadget in pixels.

Parameters widthInteger. The width in pixels.

heightInteger. The height in pixels.

Page 381: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 363

actuate.report .Gadget

Example To set the gadget to a 300-by-300-pixel square area, use code similar to the following:

myGadget.setSize(300, 300);

showSyntax void Gadget.show( )

Shows this element.

Example Use show( ) to reveal a hidden gadget, as shown in the following code:

myGadget.show( );

submitSyntax void Gadget.submit(function callback)

Submits all the asynchronous operations for this gadget. Submit( ) triggers an AJAX request for all asynchronous operations. When the server finishes the processing, it returns a response and the results are rendered on the page in the gadget container.

Parameter callbackFunction. The function to execute after the asynchronous call processing is done.

Example This example clears existing filters from the PRODUCTLINE column and pops up an alert box:

function alertResetFilter(myGadget){myGadget.clearFilters("PRODUCTLINE");myGadget.submit(alert("Filters Cleared"));

}

Page 382: Actuate API Reference - OpenText

364 A c t u a t e A P I R e f e r e n c e

actuate.report .HTML5Chart.Cl ientChart

Class actuate.report.HTML5Chart.ClientChartDescription A container for an HTML5-enabled chart element in a report. ClientChart

provides functions to operate on a ClientChart element on the client side only, such as retrieving the chart size or setting the title and series values for the currently displayed chart.

ConstructorThe ClientChart object is constructed by actuate.report.Chart.getClientChart( ).

Function summaryTable 7-30 lists actuate.report.HTML5Chart.ClientChart functions.

Table 7-30 actuate.report.HTML5Chart.ClientChart functions

Function Description

addSeries( ) Adds a series to the chart

getCategoryCount( ) Returns the number of categories in the chart

getChartHeight( ) Returns the height of the chart in pixels

getChartWidth( ) Returns the width of the chart in pixels

getClientOptions( ) Returns the chart options

getCore( ) Returns the core Highcharts object

getSeriesCount( ) Returns the number of run-time series in the chart

getXAxisMax( ) Returns the maximum value of X-axis series

getXAxisMin( ) Returns the minimum value of X-axis series

getYAxisMax( ) Returns the maximum value of Y-axis series

getYAxisMin( ) Returns the minimum value of Y-axis series

isChartWithAxes( ) Returns whether chart has axes

redraw( ) Redraws the chart according to chart options

removeSeries( ) Removes specified series

setSeriesVisible( ) Hides or displays specified series

setTitle( ) Updates chart title

setValues( ) Updates values of specified series

setXAxisRange( ) Changes the minimum and maximum of the X-axis and zooms in on the new data range

Page 383: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 365

actuate.report .HTML5Chart .Cl ientChart

addSeriesSyntax void ClientChart.addSeries(string seriesName, Array values)

Adds a data series to this ClientChart.

Parameters seriesNameString. A name for the series.

valuesArray. The values for the series, defining X and Y value pairs.

Example This example adds the monthly revenue series as an array of numbers:

myClientChart.addSeries('monthly revenue', [1,5.5, 2,4.5, 3,7.8, 4,7.7, 5,1.2, 6,8.5 7,1.9, 8,4.5, 9,12, 10,9.1, 11,4, 12,6.6]);

getCategoryCountSyntax integer ClientChart.getCategoryCount( )

Returns the number of categories in this ClientChart.

Returns Integer. The number of categories.

Example This example displays the number of categories in myClientChart as an alert:

alert("This HTML5 client chart has" + myClientChart.getCategoryCount( ) + "categories.");

getChartHeightSyntax integer ClientChart.getChartHeight( )

Returns the height of this ClientChart in pixels.

Returns Integer. The height of the chart in pixels.

Example This example displays the height of myClientChart as an alert:

alert("Height: " + myClientChart.getHeight( ));

getChartWidthSyntax integer ClientChart.getChartWidth( )

setYAxisRange( ) Changes the minimum and maximum of the Y-axis and zooms in on the new data range

Table 7-30 actuate.report.HTML5Chart.ClientChart functions

Function Description

Page 384: Actuate API Reference - OpenText

366 A c t u a t e A P I R e f e r e n c e

actuate.report .HTML5Chart.Cl ientChart

Returns the width of this ClientChart in pixels.

Returns Integer. The width of the chart in pixels.

Example This example displays the width of myClientChart as an alert:

alert("Width: " + myClientChart.getChartWidth( ));

getClientOptionsSyntax actuate.report.HTML5Chart.ClientOption ClientChart.getClientOptions( )

Returns the ClientOptions set for this ClientChart.

Returns actuate.report.HTML5Chart.ClientOption object. The client options.

Example This example retrieves the client options for myClientChart and stores them in the myClientOptions variable:

var myClientOptions = myClientChart.getClientOptions( );

getCoreSyntax actuate.report.HTML5Chart.Highcharts ClientChart.getCore( )

Returns the Highcharts object contained in this ClientChart.

Returns actuate.report.HTML5Chart.Highcharts object. A Highcharts object.

Example This example retrieves the Highcharts object from myClientChart and stores it in the myHighchart variable:

var myHighchart = myClientChart.getCore( );

getSeriesCountSyntax integer ClientChart.getSeriesCount( )

Returns the number of run-time series in this ClientChart.

Returns Integer. The number of series.

Example This example displays the number of run-time series in myClientChart as an alert:

alert("Runtime Series: " + myClientChart.getSeriesCount( ));

getXAxisMaxSyntax float ClientChart.getXAxisMax( )

Returns the maximum value of the series associated with the X-axis in this ClientChart.

Page 385: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 367

actuate.report .HTML5Chart .Cl ientChart

Returns Float. The axis series’ maximum.

Example This example displays the maximum value of the series associated with the X-axis in myClientChart as an alert:

alert("Max for X-axis series: " + myClientChart.getXAxisMax( ));

getXAxisMinSyntax float ClientChart.getXAxisMin( )

Returns the minimum value of the series associated with the X-axis in this ClientChart.

Returns Float. The axis series’ minimum.

Example This example displays the minimum value of the series associated with the X-axis in myClientChart as an alert:

alert("Min for X-axis series: " + myClientChart.getXAxisMin( ));

getYAxisMaxSyntax float ClientChart.getYAxisMax( integer axisIndex)

Returns the maximum value of a series associated with the Y-axis in this ClientChart.

Parameter axisIndexInteger. Optional. Axis index. The minimum value is 0, which is the default value, indicating the first Axis.

Returns Float. The axis series’ maximum.

Example This example displays the maximum value of the series associated with the Y-axis in myClientChart as an alert:

alert("Max for Y-axis series: " + myClientChart.getYAxisMax( ));

getYAxisMinSyntax float ClientChart.getYAxisMin( integer axisIndex)

Returns the minimum value of a series associated with the Y-axis in this ClientChart.

Parameter axisIndexInteger. Optional. Axis index. The minimum value is 0, which is the default value, indicating the first Axis.

Returns Float. The axis series’ minimum.

Page 386: Actuate API Reference - OpenText

368 A c t u a t e A P I R e f e r e n c e

actuate.report .HTML5Chart.Cl ientChart

Example This example displays the minimum value of the series associated with the Y-axis in myClientChart as an alert:

alert("Min for Y-axis series: " + myClientChart.getYAxisMin( ));

isChartWithAxesSyntax boolean ClientChart.isChartWithAxes( )

Returns whether this chart has axes.

Returns Boolean. True indicates axes, false otherwise.

Example This example displays whether myClientChart has axes:

alert("Chart has axes: " + myClientChart.isChartWithAxes( ));

redrawSyntax void ClientChart.redraw(actuate.report.HTML5Chart.ClientOption chartOptions)

Redraws this ClientChart with options.

Parameter chartOptionsactuate.report.HTML5Chart.ClientOption object. Optional. The chart options.

Example This example redraws myClientChart with the default options:

myClientChart.redraw( );

removeSeriesSyntax void ClientChart.removeSeries(string seriesName, boolean redraw)

Removes a series by name.

Parameters seriesNameString. The name of the series to remove.

redrawBoolean. Optional. Specifies whether to redraw the chart. Default is true.

Example This example removes the series monthly revenue from myClientChart and redraws the chart:

myClientChart.removeSeries('monthly revenue', true);

setSeriesVisibleSyntax void ClientChart.setSeriesVisible(string seriesName, boolean visible)

Makes a series visible.

Page 387: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 369

actuate.report .HTML5Chart .Cl ientChart

Parameters seriesNameString. The name of the series to change.

visibleBoolean. Optional. True indicates visible. Default is true.

Example This example sets the series monthly revenue as visible for myClientChart:

myClientChart.setSeriesVisible('monthly revenue', true);

setTitleSyntax void ClientChart.setTitle(string title)

Sets the title of this ClientChart.

Parameter titleString. Chart title text.

Example This example sets the title of myClientChart to 'Annual Report':

myClientChart.setTitle('Annual Report');

setValuesSyntax void ClientChart.setValues(string seriesName, float[ ] values, boolean redraw)

Sets the value for a series.

Parameters seriesNameString. Name of the series to change.

valuesArray of float. The values for the series, defining X and Y value pairs.

redrawBoolean. Optional. Specifies whether to redraw the chart. Default is true.

Example This example adds the monthly revenue series as an array of numbers:

myClientChart.setValues('monthly revenue', [1,5.5, 2,4.5, 3,7.8, 4,7.7, 5,1.2, 6,8.5 7,1.9, 8,4.5, 9,12, 10,9.1, 11,4, 12,6.6]);

setXAxisRangeSyntax void ClientChart.setXAxisRange(float min, float max, boolean redraw)

Sets the value range for the X-axis.

Parameters minFloat. A new minimum value.

Page 388: Actuate API Reference - OpenText

370 A c t u a t e A P I R e f e r e n c e

actuate.report .HTML5Chart.Cl ientChart

maxFloat. A new maximum value.

redrawBoolean. Optional. Specifies whether to redraw the chart. Default is true.

Example This example sets the X-axis range to 1 through 3 and redraws the chart:

myClientChart.setXAxisRange(1,3);

setYAxisRangeSyntax void ClientChart.setYAxisRange(float min, float max, boolean redraw, integer

axisIndex)

Sets the value range for the Y-axis.

Parameters minFloat. A new minimum value.

maxFloat. A new maximum value.

redrawBoolean. Optional. Specifies whether to redraw the chart. Default is true.

axisIndexInteger. Optional. Axis index. The minimum value is 0, which is the default value, indicating the first Axis.

Example This example sets the Y-axis range to 0 through 15 and redraws the chart:

myClientChart.setYAxisRange(0,15);

Page 389: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 371

actuate.report .HTML5Chart.Cl ientOption

Class actuate.report.HTML5Chart.ClientOptionDescription A container for a ClientOption element in a report. ClientOption provides

functions to change ClientChart features, such as orientation, type, and title.

ConstructorSyntax void actuate.report.HTML5Chart.ClientOption( )

Generates a new ClientOption object to manage the chart options for a ClientChart.

Function summaryTable 7-31 lists actuate.report.HTML5Chart.ClientOption functions.

addSeriesSyntax void ClientOption.addSeries(string seriesName, float[ ] values)

Adds a data series to this ClientOption.

Parameters seriesNameString. A name for the series.

valuesArray of float. The values for the series, defining X and Y value pairs.

Example This example adds the monthly revenue series as an array of numbers:

myClientOption.addSeries('monthly revenue', [1,5.5, 2,4.5, 3,7.8, 4,7.7, 5,1.2, 6,8.5 7,1.9, 8,4.5, 9,12, 10,9.1, 11,4, 12,6.6]);

Table 7-31 actuate.report.HTML5Chart.ClientOption functions

Function Description

addSeries( ) Adds a series to the chart

explodePieSlice( ) Explodes specified pie’s slice

isChartWithAxes( ) Checks if current chart is chart with axes

pivotChart( ) Inverts chart

setChartType( ) Updates chart type

setSeriesVisible( ) Hides or shows specified series

setTitle( ) Updates chart title

setXAxisTitle( ) Updates X-axis title

setYAxisTitle( ) Updates Y-axis title

Page 390: Actuate API Reference - OpenText

372 A c t u a t e A P I R e f e r e n c e

actuate.report .HTML5Chart.Cl ientOption

explodePieSliceSyntax void ClientOption.explodePieSlice(string categoryName, boolean sliced)

Explodes the specified pie chart’s slice.

Parameters categoryNameString. The name of a category.

slicedBoolean. Optional. True means the chart is sliced. Default is true.

Example This example explodes the Q1 category from a chart with myClientOption:

myClientOption.explodePieSlice('Q1');

isChartWithAxesSyntax boolean ClientChart.isChartWithAxes( )

Returns whether this chart has axes.

Returns Boolean.

Example This example displays whether myClientOption has axes:

alert("Options has axes: " + myClientOption.isChartWithAxes( ));

pivotChartSyntax void ClientChart.pivotChart( )

Switches the axes of the chart, if the chart has axes.

Example This example switches the axes in myClientOption and then redraws myClientChart with the switched axes:

var myClientOption = myClientChart.getClientOption( )myClientOption.pivotChart( );myClientChart.redraw(myClientOption);

setChartTypeSyntax void ClientOption.setChartType(string chartType, boolean isCurve)

Sets the chart type in this ClientOption.

Parameters chartTypeString. The chart type. Valid values are line, area, bar, scatter, and pie.

isCurveBoolean. Optional. Indicates if line or area chart is curve. Default value is false.

Page 391: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 373

actuate.report .HTML5Chart.Cl ientOption

Example This example changes the chart type to pie in myClientOption:

myClientOption.setChartType('pie');

setSeriesVisibleSyntax void ClientOption.setSeriesVisible(string seriesName, boolean visible)

Makes a series visible.

Parameters seriesNameString. The name of the series to change.

visibleBoolean. Optional. Default is true.

Example This example sets the series months as visible for myClientOption:

myClientOption.setSeriesVisible('monthly revenue', true);

setTitleSyntax void ClientOption.setTitle(string title)

Sets the title of this ClientOption.

Parameter titleString. Chart title text.

Example This example sets the title of myClientOption to 'Annual Report':

myClientOption.setTitle('Annual Report');

setXAxisTitleSyntax void ClientOption.setTitle(string title)

Sets the X-axis title of this ClientOption.

Parameter titleString. X-axis title text.

Example This example sets the title of the X-axis in myClientOption to 'Month':

myClientOption.setXAxisTitle('Month');

setYAxisTitleSyntax void ClientOption.setTitle(string title, integer ChartOptions)

Sets the Y-axis title of this ClientOption.

Page 392: Actuate API Reference - OpenText

374 A c t u a t e A P I R e f e r e n c e

actuate.report .HTML5Chart.Cl ientOption

Parameters titleString. Y-axis title text.

chartOptionsInteger. Optional. Axis index. The minimum value is 0, which is the default value, indicating the first Axis.

Example This example sets the title of the Y-axis in myClientOption to 'Dollars, in millions':

myClientOption.setYAxisTitle('Dollars, in millions');

Page 393: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 375

actuate.report .HTML5Chart.ClientPoint

Class actuate.report.HTML5Chart.ClientPointDescription Represents a data point in a chart. ClientPoint provides functions to manage a

point in a series on an individual basis, including selections, options, and events. The options for ClientPoint are defined in the Highcharts point class, which is documented at the following URL:http://api.highcharts.com/highcharts

ConstructorSyntax void actuate.report.HTML5Chart.ClientPoint( )

Generates a new ClientPoint object to manage a data point for a ClientChart.

Function summaryTable 7-32 lists actuate.report.HTML5Chart.ClientPoint functions.

applyOptionsSyntax void ClientPoint.applyOptions({float | object} options)

Applies the options containing the x and y data and possibly some extra properties. This is called on point initialization or from point.update.

Parameter optionsFloat, array of float, or object. The point options. If options is a single number, the point gets that number as the Y value. If options is an array, the point gets the first two numbers as an X and Y value pair. If options is an object, advanced options as outlined in the Highcharts options.point are applied. The fields include color, events, id, marker, legend, Index (pie chart only), name, sliced (pie chart only), x, and y.

Example This example changes the Y value of myClientPoint to 12:

myClientPoint.applyOptions(12);

Table 7-32 actuate.report.HTML5Chart.ClientPoint functions

Function Description

applyOptions( ) Changes the point values or options

destroy( ) Destroys a point to clear memory

remove( ) Removes a point

select( ) Toggles the selection of a point

remove( ) Updates the point with new options

Page 394: Actuate API Reference - OpenText

376 A c t u a t e A P I R e f e r e n c e

actuate.report .HTML5Chart.Cl ientPoint

destroySyntax void ClientPoint.destroy( )

Destroys a point to clear memory. Its reference still stays in series.data.

Example This example destroys the options and values for myClientPoint:

myClientPoint.destroy( );

removeSyntax void ClientPoint.remove(boolean redraw, {boolean | object} animation)

Removes this point and optionally redraws the series and axes.

Parameters redrawBoolean. Optional. Specifies whether to redraw the chart. Default is true.

animationBoolean or object. Optional. Whether to apply animation, and optionally animation configuration. Default is true.

Example This example removes myClientPoint from a series, and redraws the chart with animation to display the changed series:

myClientPoint.remove( );

selectSyntax void ClientPoint.select(boolean selected, boolean accumulate)

Selects this point.

Parameters selectedBoolean. Specifies whether to select or deselect the point.

accumulateBoolean. Whether to add this point to the previous selection. By default, this is true when the Ctrl (PC) or Cmd (Macintosh) key is held during selection.

Example This example selects MyClientPoint and deselects all other points:

myClientPoint.select(true, false);

removeSyntax void ClientPoint.remove(boolean redraw, {boolean | object} animation)

Updates this point and optionally redraws the series and axes.

Parameters redrawBoolean. Optional. Specifies whether to redraw the chart. Default is true.

Page 395: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 377

actuate.report .HTML5Chart.ClientPoint

animationBoolean or object. Optional. Whether to apply animation, and optionally animation configuration. Default is true.

Example This example removes myClientPoint and redraws the chart:

myClientPoint.remove();

updateSyntax void ClientPoint.update({float|float[ ]|object} options, boolean redraw, {boolean |

object} animation)

Updates this point and optionally redraws the series and axes.

Parameters optionsFloat, array of float, or object. The point options. If options is a single number, the point gets that number as the Y value. If options is an array, the point gets the first two numbers as an X and Y value pair. If options is an object, advanced options as outlined in the Highcharts options.point are applied. The fields include color, events, id, marker, legend, Index (pie chart only), name, sliced (pie chart only), x, and y.

redrawBoolean. Optional. Specifies whether to redraw the chart. Default is true.

animationBoolean or object. Optional. Whether to apply animation, and optionally animation configuration. Default is true.

Example This example updates myClientPoint with an X value of 1 and a Y value of 12, then redraws the point:

myClientPoint.update([1,12]);

Page 396: Actuate API Reference - OpenText

378 A c t u a t e A P I R e f e r e n c e

actuate.report .HTML5Chart.Cl ientSer ies

Class actuate.report.HTML5Chart.ClientSeriesDescription A container for a ClientSeries in a ClientChart. ClientSeries provides functions to

manage a series and the graph of that series. In the ClientSeries object, all the points are accessible from the ClientSeries.data array.

ConstructorSyntax void actuate.report.HTML5Chart.ClientSeries( )

Generates a new ClientSeries object to manage a series for a ClientChart.

Function summaryTable 7-33 lists actuate.report.HTML5Chart.ClientSeries functions.

addPointSyntax void ClientSeries.addPoint({float | object} options, boolean redraw, boolean shift,

{boolean | object} animation)

Adds a point dynamically to the series.

Parameters optionsObject. The point options. If options is a single number, the point gets that number as the Y value. If options is an array, the point gets the first two numbers as an X and Y value pair. If options is an object, advanced options as outlined in

Table 7-33 actuate.report.HTML5Chart.ClientSeries functions

Function Description

addPoint( ) Adds a point to the series

cleanData( ) Sorts the data and removes duplicates

destroy( ) Clears DOM objects and frees up memory

hide( ) Hides the series graph

redraw( ) Redraws the series after an update in the axes

remove( ) Removes a series and optionally redraws the chart

render( ) Renders the series graph and markers

select( ) Sets the selected state of the series graph

setData( ) Replaces the series data with a new set of data

setVisible( ) Sets the visibility of the series graph

show( ) Shows the series graph

Page 397: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 379

actuate.report .HTML5Chart.Cl ientSeries

the Highcharts options.point are applied. The fields include color, events, id, marker, legend, Index (pie chart only), name, sliced (pie chart only), x, and y.

redrawBoolean. Optional. Specifies whether to redraw the chart. Default is true.

shiftBoolean. When shift is true, the graph of the series shifts one point toward the end of the series and a point added to the beginning of the series. Default is false.

animationBoolean or object. Optional. Whether to apply animation, and optionally animation configuration. Default is true.

Example This example adds a point of value 12 to the end of myClientSeries:

myClientSeriesaddPoint(12);

cleanDataSyntax void ClientSeries.cleanData( )

Sorts the series and removes duplicate points or values.

Example This example sorts myClientSeries and removes its duplicate points and values:

myClientSeries.cleanData( );

destroySyntax void ClientSeries.destroy( )

Clears DOM series objects and frees memory.

Example This example clears the memory of myClientSeries and its member objects:

myClientSeries.destroy( );

hideSyntax void ClientSeries.hide( )

Hides the graph of this series.

Example This example hides myClientSeries graph from the chart:

myClientSeries.hide( );

redrawSyntax void ClientSeries.redraw( )

Page 398: Actuate API Reference - OpenText

380 A c t u a t e A P I R e f e r e n c e

actuate.report .HTML5Chart.Cl ientSer ies

Redraws the graph of this series after updating the data and axes.

Example This example redraws the graph of myClientSeries:

myClientSeries.redraw( );

removeSyntax void ClientSeries.remove(boolean redraw, {boolean | object} animation)

Removes this series and optionally redraws the chart.

Parameters redrawBoolean. Optional. Specifies whether to redraw the chart. Default is true.

animationBoolean or object. Optional. Whether to apply animation, and optionally animation configuration. Default is true.

Example This example removes the graph of myClientSeries from the chart:

myClientSeries.remove( );

renderSyntax void ClientSeries.render( )

Renders the graph of this series and its markers.

Example This example renders the graph of myClientSeries to the chart:

myClientSeries.render( );

selectSyntax void ClientSeries.select(boolean selected)

Selects this series.

Parameter selectedBoolean. Optional. Specifies whether to select or deselect the series. If undefined, toggles selection.

Example This example selects myClientSeries:

myClientSeries.select(true);

setDataSyntax void ClientSeries.setData({float | object}[ ] data, boolean redraw)

Replaces the series data with a new set of data.

Page 399: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 381

actuate.report .HTML5Chart.Cl ientSeries

Parameters dataArray of float and/or object. An array of data points for the series. The points can be given in three ways:

1 A list of numerical values, which are assigned as Y values, paired with X values starting with 0 and incrementing by 1 for each additional number. For example: [0, 5, 3, 5]

2 A list of arrays with two values, which are assigned as X and Y value pairs. If the first value is a string, it is applied as the name of the point, and the x value is incremented following the above rules. For example: [[4, 2], [6, 3], [8, 2]]

3 A list of objects with named values, which are assigned to points using the Highcharts point configuration specification options.point. For example: [{name: 'Point 1',

color: '#00FF00',y: 0

}, {name: 'Point 2',

color: '#FF00FF',y: 5

}]

redrawBoolean. Optional. Specifies whether to redraw the chart. Default is true.

Example This example replaces the points in myClientSeries with three new points:

myClientSeries.setData([[4, 2], [6, 3], [8, 2]]);

setVisibleSyntax void ClientSeries.setVisible(boolean vis, boolean redraw)

Sets the visibility of this series.

Parameters visBoolean. Optional. Specifies whether to display the series. True displays the series, false hides it. If no value is provided, the visibility changes to false if visibility is true, and true if visibility is false.

redrawBoolean. Optional. Specifies whether to redraw the chart. Default is true.

Example This example sets myClientSeries to visible and redraws it:

myClientSeries.setVisible(true);

Page 400: Actuate API Reference - OpenText

382 A c t u a t e A P I R e f e r e n c e

actuate.report .HTML5Chart.Cl ientSer ies

showSyntax void ClientSeries.show( )

Displays the graph of this series.

Example This example displays the graph of myClientSeries:

myClientSeries.show( );

Page 401: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 383

actuate.report .HTML5Chart .Highcharts

Class actuate.report.HTML5Chart.HighchartsDescription A container for a Highcharts element in a ClientChart. For reference material for

Highcharts, consult the BIRT Designer Professional help or access the Highcharts documentation at the following URL:http://api.highcharts.com/highcharts

ConstructorSyntax void actuate.report.HTML5Chart.Highcharts( )

Generates a new Highcharts object to manage the Highcharts for a ClientChart.

Page 402: Actuate API Reference - OpenText

384 A c t u a t e A P I R e f e r e n c e

actuate.report .HTML5Chart.Renderer

Class actuate.report.HTML5Chart.RendererDescription A container for a Highcharts renderer object. Directly accesses the Highcharts

rendering layer to draw primitive shapes like circles, rectangles, paths or text directly. The renderer represents a wrapper object for SVG in modern browsers and VML in older versions of Microsoft Internet Explorer.

ConstructorSyntax void actuate.report.HTML5Chart.Renderer( )

Generates a new Renderer object to manage the Highcharts rendering options for a ClientChart.

Function summaryTable 7-34 lists actuate.report.HTML5Chart.Renderer functions.

arcSyntax object Renderer.arc(integer x, integer y, integer r, integer innerR, float start,

float end)

Generates and draws an arc on the chart.

Parameters xInteger. The X position of the arc’s center, measured in pixels from the left edge of the rendering area.

Table 7-34 actuate.report.HTML5Chart.Renderer functions

Function Description

arc( ) Draws and returns an arc

circle( ) Draws a Scalable Vector Graphic circle

clipRect( ) Defines a clipping rectangle

destroy( ) Destroys the renderer and its allocated members

g( ) Creates a group

image( ) Displays an image

path( ) Draws a path

rect( ) Draws and returns a rectangle

setSize( ) Resizes the box and re-aligns all aligned elements

text( ) Adds text to the Scalable Vector Graphic object

Page 403: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 385

actuate.report .HTML5Chart.Renderer

yInteger. The Y position of the arc’s center, measured in pixels from the top edge of the rendering area.

rInteger. The outer radius, measured in pixels.

innerRInteger. The inner radius, measure in pixels.

startFloat. The starting angle of the arc, measured in radians, where 0 is directly right and -Math.PI/2 is directly upward. The arc is drawn clockwise from start to end.

endFloat. The ending angle of the arc, measured in radians, where 0 is directly right and -Math.PI/2 is directly upward.

Returns Highcharts element object. The Element class is a JavaScript wrapper for SVG elements used in the rendering layer of Highcharts. For reference material for Highcharts, consult the BIRT Designer Professional help or access the Highcharts documentation at the following URL:http://api.highcharts.com/highcharts

Example This example draws a 50-pixel wide half-circle arc, concave down, with a center 200 pixels from the left edge and 150 pixels from the top edge of the chart area:

myRenderer.arc(200, 150, 100, 50, -Math.PI, 0);

circleSyntax object Renderer.circle(integer x, integer y, integer r)

Generates and draws a Scalable Vector Graphic circle on the chart.

Parameters xInteger. The X position of the circle’s center, measured in pixels from the left edge of the rendering area.

yInteger. The Y position of the circle’s center, measured in pixels from the top edge of the rendering area.

rInteger. The radius, measured in pixels.

Returns Highcharts element object. The Element class is a JavaScript wrapper for SVG elements used in the rendering layer of Highcharts. For reference material for Highcharts, consult the BIRT Designer Professional help or access the Highcharts documentation at the following URL:http://api.highcharts.com/highcharts

Page 404: Actuate API Reference - OpenText

386 A c t u a t e A P I R e f e r e n c e

actuate.report .HTML5Chart.Renderer

Example This example draws a circle with a center 200 pixels from the left edge and 150 pixels from the top edge of the chart area:

myRenderer.circle(200, 150, 100);

clipRectSyntax object Renderer.clipRect(string id, integer x, integer y, integer width,

integer height)

Generates and draws a clipping rectangle on the chart.

Parameters idString. A string to identify the element.

xInteger. The X position of the rectangle’s upper left corner, measured in pixels from the left edge of the rendering area.

yInteger. The Y position of the rectangle’s upper left corner, measured in pixels from the top edge of the rendering area.

widthInteger. The width, in pixels.

heightInteger. The height, in pixels.

Returns Highcharts element object. The Element class is a JavaScript wrapper for SVG elements used in the rendering layer of Highcharts. For reference material for Highcharts, consult the BIRT Designer Professional help or access the Highcharts documentation at the following URL:http://api.highcharts.com/highcharts

Example This example draws a 100-pixel-by-100-pixel rectangle 100 pixels from the left and top edges of chart area:

myRenderer.cliprect('myClipRect', 100, 100, 100, 100);

destroySyntax void Renderer.destroy( )

Destroys this renderer and its allocated elements.

Example This example destroys the myRenderer object and frees its memory:

myRenderer.destroy( );

Page 405: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 387

actuate.report .HTML5Chart.Renderer

gSyntax object Renderer.g(string name)

Adds an SVG/VML group to the Renderer object.

Parameter nameString. The name of the group. Used in the class name, which will be “highcharts-”+ name. Other Element objects are added to the group by using this group as the first parameter in .add( ) for the element wrappers.

Returns Highcharts element object. The Highchart.Element class is a JavaScript wrapper for SVG elements used in the rendering layer of Highcharts. For reference material for Highcharts, consult the BIRT Designer Professional help or access the Highcharts documentation at the following URL:http://api.highcharts.com/highcharts

Example This example creates a new group called myGroup:

myRenderer.g('myGroup');

imageSyntax object Renderer.image(string src, integer x, integer y, integer width,

integer height)

Generates and draws a image on the chart.

Parameters srcString. A URL for the image.

xInteger. The X position of the image’s upper left corner, measured in pixels from the left edge of the rendering area.

yInteger. The Y position of the image’s upper left corner, measured in pixels from the top edge of the rendering area.

widthInteger. The width, in pixels.

heightinteger. The height, in pixels.

Returns Highcharts element object. The Highchart.Element class is a JavaScript wrapper for SVG elements used in the rendering layer of Highcharts. For reference material for Highcharts, consult the BIRT Designer Professional help or access the Highcharts documentation at the following URL:http://api.highcharts.com/highcharts

Page 406: Actuate API Reference - OpenText

388 A c t u a t e A P I R e f e r e n c e

actuate.report .HTML5Chart.Renderer

Example This example adds the sun.png image to the chart 100 pixels from the left and top of the edge of the chart:

myRenderer.image('http://highcharts.com/demo/gfx/sun.png', 100, 100, 30, 30);

pathSyntax object Renderer.path(object[ ] path)

Adds a path to the renderer based on SVG’s path commands. In SVG-capable browsers, all path commands are supported, but in VML only a subset is supported, including the moveTo, lineTo, and curve commands.

Parameter pathArray of string and integer objects. An SVG path with attributes split up in array form.

Returns Highcharts element object. The Highchart.Element class is a JavaScript wrapper for SVG elements used in the rendering layer of Highcharts. For reference material for Highcharts, consult the BIRT Designer Professional help or access the Highcharts documentation at the following URL:http://api.highcharts.com/highcharts

Example This example draws a path from the upper left corner of the rendering area (0, 0) to the points (100, 100), (200, 50), and (300, 100), where the first number represents the distance from the left edge of the rendering area and the second number represents the distance from the top edge of the rendering area:

myRenderer.path(['M', 0, 0, 'L', 100, 100, 200, 50, 300, 100]);

rectSyntax object Renderer.rect(integer x, integer y, integer width, integer height, integer r,

integer strokeWidth)

Generates and draws a rectangle on the chart.

Parameters xInteger. The X position of the rectangle’s upper left corner, measured in pixels from the left edge of the rendering area.

yInteger. The Y position of the rectangle’s upper left corner, measured in pixels from the top edge of the rendering area.

widthInteger. The width, in pixels.

heightInteger. The height, in pixels.

Page 407: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 389

actuate.report .HTML5Chart.Renderer

rInteger. The corner radius, measured in pixels.

strokeWidthInteger. Stroke measurement to support crisp drawing.

Returns Highcharts element object. The Highchart.Element class is a JavaScript wrapper for SVG elements used in the rendering layer of Highcharts. For reference material for Highcharts, consult the BIRT Designer Professional help or access the Highcharts documentation at the following URL:http://api.highcharts.com/highcharts

Example This example draws a 100-pixel-by-100-pixel rectangle 100 pixels from the left and top edges of chart area with 5-pixel-radius quarter-circles as edges:

myRenderer.rect(100, 100, 100, 100, 5);

setSizeSyntax void Renderer.setSize(integer width, integer height, boolean animate)

Resizes the rendering area and re-aligns all aligned elements.

Parameters widthInteger. The width, in pixels.

heightInteger. The height, in pixels.

animateBoolean. Optional. Whether to animated the resize. Default is true.

Example This example resizes the renderer area to 500 pixels by 500 pixels:

myRenderer.setSize(500, 500);

textSyntax object Renderer.text(string str, integer x, integer y, boolean useHTML)

Adds text to the Scalable Vector Graphic object.

Parameters strString. The text in this text element.

xInteger. The X position of the text’s lower left corner, measured in pixels from the left edge of the rendering area.

yInteger. The Y position of the text’s lower left corner, measured in pixels from the top edge of the rendering area.

Page 408: Actuate API Reference - OpenText

390 A c t u a t e A P I R e f e r e n c e

actuate.report .HTML5Chart.Renderer

useHTMLBoolean. Specifies whether to use HTML to render the text.

Returns Highcharts element object. The Highchart.Element class is a JavaScript wrapper for SVG elements used in the rendering layer of Highcharts. For reference material for Highcharts, consult the BIRT Designer Professional help or access the Highcharts documentation at the following URL:http://api.highcharts.com/highcharts

Example This example adds a text graphic that reads “Series 1” 140 pixels from the left edge of the rendering area and 150 pixels from the top edge of the rendering area:

myRenderer.text('Series 1', 140, 150, false);

Page 409: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 391

actuate.report .Label

Class actuate.report.LabelDescription A container for a Label element in a report. Label provides functions to operate

on a Label element, such as retrieving the label text and getting the HTML DOM element from the report label.

ConstructorThe Label object is constructed by viewer.PageContent.getLabelByBookmark( ).

Function summaryTable 7-35 lists actuate.report.Label functions.

getBookmarkSyntax string Label.getBookmark( )

Returns the bookmark name for this Label.

Returns String. The Label’s bookmark.

Example This example displays the Label’s bookmark in an alert box:

alert(myLabel.getBookmark( ));

getHtmlDomSyntax HTMLElement Label.getHtmlDom( )

Table 7-35 actuate.report.Label functions

Function Description

getBookmark( ) Returns the bookmark name for this Label

getHtmlDom( ) Returns the HTML element for this Label

getInstanceId( ) Returns the report element instance id

getLabel( ) Returns the text of this Label element

getPageContent( ) Returns the page content to which this element belongs

getType( ) Returns the Label’s element type

hide( ) Hides this element

show( ) Shows this element

submit( ) Applies changes made to this gadget

Page 410: Actuate API Reference - OpenText

392 A c t u a t e A P I R e f e r e n c e

actuate.report .Label

Returns the HTML element for this Label.

Returns HTMLElement.

Example This example displays the HTML DOM element for this Label inside a red border:

function showHtmlDom(myLabel){var domNode = myLabel.getHtmlDom( );var box = document.createElement('div');box.style.border = '2px solid red';var label = document.createElement('h2');label.innerHTML = 'The HTML DOM:';box.appendChild(label);box.appendChild(domNode);document.body.appendChild(box);

}

getInstanceIdSyntax string Label.getInstanceId( )

Returns the instance id of this report element.

Returns String. The instance id.

Example This example displays the instance ID of the report element in an alert box:

function showID(myLabel){var elementID = myLabel.getInstanceId( );alert (elementID);

}

getLabelSyntax string Label.getLabel( )

Returns the text of this Label element.

Returns String. The Label text.

Example This example displays the text of the myLabel object in an alert box:

alert("Label element text is " + myLabel.getLabel( ));

getPageContentSyntax actuate.viewer.PageContent Label.getPageContent( )

Returns the page content to which this Label belongs.

Returns actuate.viewer.PageContent. report content.

Page 411: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 393

actuate.report .Label

Example This example displays the viewer ID of the page content in an alert box:

function showViewID(myLabel){var pageContent = myLabel.getPageContent( );var pageViewerID = pageContent.getViewerId( );alert (pageViewerID);

}

getTypeSyntax string Label.getType( )

Returns the report element type of this object, which is Label.

Returns String. "Label".

Example This example checks the report element type and displays an alert if the type is not "Label":

if (myElement.getType( ) != "Label"){alert("Type mismatch, report element type is not Label")

}

hideSyntax void Label.hide( )

Hides this element.

Example Use hide( ) to hide a report label, as shown in the following code:

myLabel.hide( );

showSyntax void Label.show( )

Shows this element.

Example Use show( ) to reveal a report label, as shown in the following code:

myLabel.show( );

submitSyntax void Label.submit(function callback)

Submits all the asynchronous operations for this Label. Submit( ) triggers an AJAX request for all asynchronous operations. When the server finishes the processing, it returns a response and the results are rendered on the page in the label container.

Page 412: Actuate API Reference - OpenText

394 A c t u a t e A P I R e f e r e n c e

actuate.report .Label

Parameter callbackFunction. The function to execute after the asynchronous call processing is done.

Example Use submit( ) to execute changes on a Label object, as shown in the following code:

myLabel.submit( );

Page 413: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 395

actuate.report .Table

Class actuate.report.TableDescription A container for a Table element in a report. Table provides functions to operate on

a Table element, such as manipulating columns, groups, and data.

ConstructorThe Table object is constructed by viewer.PageContent.getTableByBookmark( ).

Function summaryTable 7-36 lists actuate.report.Table functions.

Table 7-36 actuate.report.Table functions

Function Description

applyConditionalColumnFormatting( ) Applies conditional formatting on a selected column, based on a column name

clearFilters( ) Clears the filters from the given column

deleteColumn( ) Deletes a column, based on column name

getBookmark( ) Returns the bookmark name for this Table

getColumn( ) Gets the Table data by column index and returns only the data from the current visible page

getColumnName( ) Returns a column name by specifying the column index

getHtmlDom( ) Returns the HTML element for this Table

getInstanceId( ) Returns the report element instance id

getPageContent( ) Returns the page content to which this element belongs

getRow( ) Gets the Table data by row index

getType( ) Returns the report element type

groupBy( ) Adds an inner group to this Table

hide( ) Hides this element

hideColumn( ) Hides a Table column by specifying the column name

hideDetail( ) Hides detailed information for displayed groups

insertComputedColumn( ) Inserts a computed column in a table

moveToLeft( ) Moves a column to the left

(continues)

Page 414: Actuate API Reference - OpenText

396 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

applyConditionalColumnFormattingSyntax void Table.applyConditionalColumnFormatting(string ColumnName, JSON

formatRules)

Applies conditional formatting to a given column.

Parameter ColumnNameString. The name of the column.

formatRulesJSON. An array of the formatting values, structured according to the JSON standard. You can specify one or more formatting rules.

Syntax:

var formatRules = [{formatRule1},{formatRule2},...,{formatRuleN}]

A formatting rule consists of three components, and has the following syntax:

{bindingName:"<columnName>", condition:<condition>, effect:<effect>}

■ bindingNameA bindingName specifies a column name on which the format applies. Use double quotation marks to surround the name of the column, as shown in this example:

moveToRight( ) Moves a column to the right

removeGroup( ) Removes an inner group

setAlignment( ) Sets the alignment of a column

setFilters( ) Applies filters to this Table

setHeaderAlignment( ) Sets a header alignment of a column

setSorters( ) Adds sorters to this Table

show( ) Shows this element

showColumn( ) Shows a Table column by specifying the column name

showDetail( ) Shows detailed information for displayed groups

submit( ) Submits all the asynchronous operations that the user has requested on this report and renders the Table component on the page

swapColumns( ) Swaps two columns, reordering the columns

Table 7-36 actuate.report.Table functions (continued)

Function Description

Page 415: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 397

actuate.report .Table

bindingName : "CUSTOMERNAME"

■ conditionA condition specifies a filter condition in the following format:

condition: {operator:"<operator>", operands:"<operands>"}

The conditions are based on actuate.model.FilterCondition, and consists of operator and operands:

■ An operator takes one of the values described in Table 7-37.

■ Operands provide the values required by an operator to define a filtering condition. To describe a single value, use a literal operand, as shown in the example:

operator: "eq",operands : [ { literal : 124 } ]

To describe more than one operand, for example, the values between 131 and 161:

operator: "between",operands : [ {literal : 131},{literal : 161} ]

■ effectThe effect property specifies the conditional formatting. The syntax is based on actuate.model.Font class. Always consider the web browser when implementing the formatting. Not all browsers support all properties.

Table 7-37 Filter conditions

Operator Description

eq Equal, =

ne Not equal, <>

lt Less than, <

le Less than, or equal, <=

ge Greater than, or equal, >=

gt Greater than, >

between Between

not-between Not between

is-null Equal to NULL

is-not-null Not equal to NULL

like Checks if the column data matches a pattern

not-like Checks if a column data does not match a pattern

Page 416: Actuate API Reference - OpenText

398 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

effect:{family: "<value>", size : "<value>", color : "<value>", backgroundColor : "<value>", bold : <boolean_value>, italic : <boolean_value>, underline : <boolean_value>,

}

Table 7-38 describes the formatting properties.

Example This example shows the formatting rule for changing the background color of a column "COUNTRY", with index 124, to rgb(255,0,0):

var formatRules = [{

bindingName : "CUSTOMERNUMBER",condition : {

operator : "eq",operands : [ { literal : 124 } ]

},effect : {

bold : true,italic : true,underline : false,backgroundColor : "rgb(255,0,0)"

}}

];var columnName = "COUNTRY";

Table 7-38 Formatting effects

Effect Description

family Specifies the font family for text

size Specifies the font size of text

color Specifies the text color in RGB or hexadecimal format.

backgroundColor Specifies the table column background color

bold Sets the style of the text to bold

italic Sets the style of the text to italic

underline Sets the style of the text to underline

Page 417: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 399

actuate.report .Table

tableObj.applyConditionalColumnFormatting( columnName, formatRules );

tableObj.submit( );

clearFiltersSyntax void Table.clearFilters(string columnName)

Clears the filters of a given column.

Parameter columnNameString. The name of the column.

Example This example clears existing filters from the PRODUCTLINE column:

function resetFilter(myTable){myTable.clearFilters("PRODUCTLINE");myTable.submit( );

}

deleteColumnSyntax void Table.deleteColumn(string columnName)

Deletes a column from a table.

Parameter columnNameString. The name of the column.

Example This example deletes the PRODUCTLINE column from a table:

var pgContent = viewer.getCurrentPageContent( );var table = pgContent.getTableByBookmark( bookmark );table.deleteColumn( “PRODUCTLINE” );table.submit( );

getBookmarkSyntax string Table.getBookmark( )

Returns the Table’s name.

Returns String. The name of the Table.

Example This example displays the Table’s bookmark in an alert box:

function alertBookmark(myTable){alert(myTable.getBookmark( ));

}

Page 418: Actuate API Reference - OpenText

400 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

getColumnSyntax array[ ] Table.getColumn(integer columnIndex)

Gets the Table data by column index. Returns the data from the current visible page.

Parameter columnIndexInteger. Optional. The numerical index of the column from which to retrieve data. The getColumn( ) function returns the values for the first column when no value is provided for columnIndex.

Returns Array. A list of data in the format of the column.

Example This example returns the first column in myTable:

function getMyColumn(myTable) {return myTable.getColumn( );

}

getColumnNameSyntax void Table.getColumnName(int columnIndex)

Returns a column name based on a column index.

Parameter columnIndexInteger. The index of the column.

Example This example clears existing filters from the PRODUCTLINE column:

viewer.registerEventHandler( actuate.viewer.impl.EventConstants.ON_CONTENT_SELECTED, mySelectionCB );

...function mySelectionCB( viewerInstance, selectedItem ) { var table = viewerInstance.getTable( ); var colIdx = selectedItem.getColumnIndex( ); var columnName = table.getColumnName( colIdx ); // Updated text control shows selected column name document.getElementById( "txtColumnId" ).value = columnName;}

getHtmlDomSyntax HTMLElement Table.getHtmlDom( )

Returns the Table’s name.

Returns String. The name of the Table.

Example This example displays the HTML DOM element for this Table inside a red border:

Page 419: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 401

actuate.report .Table

function showHtmlDom(myTable){var domNode = myTable.getHtmlDom( );var box = document.createElement('div');box.style.border = '2px solid red';var label = document.createElement('h2');label.innerHTML = 'The HTML DOM:';box.appendChild(label);box.appendChild(domNode);document.body.appendChild(box);

}

getInstanceIdSyntax string Table.getInstanceId( )

Returns the instance id of this report element.

Returns String. The instance id.

Example This example displays the instance ID of the report element in an alert box:

function showID(myTable){var elementID = myTable.getInstanceId( );alert (elementID);

}

getPageContentSyntax actuate.viewer.PageContent Table.getPageContent( )

Returns the page content to which this Table belongs.

Returns actuate.viewer.PageContent. report content.

Example This example displays the viewer ID of the page content in an alert box:

function showViewID(myTable){var pageContent = myTable.getPageContent( );var pageViewerID = pageContent.getViewerId( );alert (pageViewerID);

}

getRowSyntax array[ ] Table.getRow(integer rowIndex)

Gets the Table data by row index. Returns the data from the current visible page.

Page 420: Actuate API Reference - OpenText

402 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

Parameter rowIndexInteger. Optional. The numerical index of the row from which to retrieve data. The getRow( ) function returns the values for the first row when no value for rowIndex is provided.

Returns Array. A list of data in the format of the columns that cross the row.

Example This example retrieves the first row in myTable:

function getMyRow(myTable) {return myTable.getRow( );

}

getTypeSyntax string Table.getType( )

Returns the report element type of this object, which is Table.

Returns String. "Table".

Example This example returns the report element type of this object in an alert box:

function getTableType(myTable) {alert("Element type is: " + myTable.getType( ));

}

groupBySyntax void Table.groupBy(string columnName)

Groups the data in a table by the values in a given column. If there is an existing group, this operation will add the new group after the existing group.

Parameter columnNameString. The name of the column to use for the innermost group to the Table.

Example This example groups the data in myTable by the values in the TOTAL column:

function groupByColumn(myTable) {myTable.groupBy("TOTAL");

}

hideSyntax void Table.hide( )

Hides this element.

Example This example hides myTable:

myTable.hide( );

Page 421: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 403

actuate.report .Table

hideColumnSyntax void Table.hideColumn(string columnName)

Hides a table column by specifying the column name.

Parameter columnNameString. The data binding name for the column to hide.

Example This example hides the TOTAL column from myTable:

function myHiddenColumn(myTable) {myTable.hideColumn("TOTAL");myTable.submit( );

}

hideDetailSyntax void Table.hideDetail(string columnName)

Hides information for a column from the grouped data displayed on the page. If every column is hidden, only the group name is visible.

Parameter columnNameString. The data binding name for the column to hide.

Example This example hides the TOTAL column from the grouped data visible for myTable:

function hideMyDetail(myTable) {myTable.hideDetail("TOTAL");myTable.submit( );

}

insertComputedColumnSyntax void Table.insertComputedColumn( String columnName, String columnLabel,

JSON computedAttrs )

Inserts a computed column in a table.

Parameters columnNameString. The name of the column, after which the new computed column is inserted.

columnLabelString. The label of the new computed column.

computedAttrsJSON. The definition of the formulas and data used to calculate the new column.

Page 422: Actuate API Reference - OpenText

404 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

The computedAttrs array must provide the following attributes:

■ categoryNameString. Defines the function category, as listed in Table 7-39.

■ functionNameString. Defines the function name, as listed in Table 7-39.

■ ArgumentsThe number of the arguments and their formats are different for each function. You can find their definitions in each function description later in this section.

All functions and their attributes are defined in iv_config.xml, located in the iHub or Information Console installations:

<context root>\WEB-INF

The JSON format definition of the computedAttrs parameter has the following syntax:

var computedAttrs = { "category" :{

"categoryName" : "<CATEGORY_NAME>","function" : {

"functionName" : "<FUNCTION_NAME>","arguments" : [ { <argument1>},...,{<argumentN > } ]

}}

}

Table 7-39 Expression functions categories and names

Category Function Description

Financial functions

% OF Calculates the percent for the selected column value in the scope of the selected base group.

% OF DIFFERENCE

Calculates the percent of the difference between values in two numbers.

RUNNINGSUM Calculates the running total for the selected Column at the specified base group.

Math functions

ABS Returns the absolute value of a number without regard to its sign. For example, 6 is the absolute value of 6 and -6.

ADD Calculates the sum, number 1 + number 2.

CEILING Rounds a number to the nearest specified multiple of significance, away from zero.

DIFFERENCE Calculates the difference, number2 – number1.

Page 423: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 405

actuate.report .Table

Math functions

(continued)

MOD Calculates the remainder value of number divided by divisor. The remainder displays the same sign as the divisor.

PRODUCT Calculates the product, number 1 * number 2.

RANK Calculates the rank for the Column value at the specified level.

RATIO Calculates the ratio, number 1 / number 2.

ROUND Rounds the number to the specified number of decimal digits. Decimal is an integer and can be negative. The default value for decimal is 0.

ROUNDDOWN A number rounded down to a specified number of digits.

ROUNDUP A number rounded up to a specified number of digits.

SQRT Calculates the square root of a number.

DateTime functions

ADD_DAY Adds a specified number of days to a date value.

ADD_HOUR Adds a specified number of hours to a date value.

ADD_MINUTE Adds a specified number of minutes to a date value.

ADD_MONTH Adds a specified number of months to a date value.

ADD_QUARTER Adds a specified number of quarters to a date value.

ADD_SECOND Adds a specified number of seconds to a date value.

ADD_WEEK Adds a specified number of weeks to a date value.

ADD_YEAR Adds a specified number of years to a date value.

DAY Returns a number from 1 to 31 representing the day of the month.

DIFF_DAY Calculates the number of days between two date values.

DIFF_HOUR Calculates the number of hours between two date values.

DIFF_MINUTE Calculates the number of minutes between two date values.

DIFF_MONTH Calculates the number of months between two date values.

DIFF_QUARTER Calculates the number of quarters between two date values.

DIFF_SECOND Calculates the number of seconds between two date values.

DIFF_WEEK Calculates the number of weeks between two date values.

(continues)

Table 7-39 Expression functions categories and names (continued)

Category Function Description

Page 424: Actuate API Reference - OpenText

406 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

DateTime functions

(continued)

DIFF_YEAR Calculates the number of years between two date values.

MONTH Returns the month for a specified date value.

NOW Returns the current date and time.

QUARTER Returns the quarter number for a specified date value.

TODAY Returns the current date that includes a time value of midnight, 12:00 AM.

WEEK Returns a number from 1 to 52 representing the week of the year.

WEEKDAY Returns the day of the week for a specified date value.

YEAR Returns the four-digit year value for a specified date value.

Comparison functions

BETWEEN Tests if a value is between two specified values.

IN Tests if a value is equal to a value in a list.

ISNULL Tests if a value in a specified data field is a null value. A null value means no value exists.

LIKE Tests if a string matches a pattern.

NOTNULL Tests if a value in a specified data field is a non-null value.

Text functions

FIND Finds the location of a substring in a string.

LEFT Extracts a substring from a string, starting from the leftmost, or first, character.

LEN Counts the number of characters in a string.

LOWER Converts all letters in a string to lowercase.

RIGHT Extracts a substring from a string, starting from the rightmost, or last, character.

SEARCH Finds the location of a substring in a string. The substring can contain wild card characters.

TRIM Removes the leading and trailing blanks from a specified string. TRIM( ) does not remove blank characters between words.

TRIMLEFT Removes the leading blanks from a specified string.

TRIMRIGHT Removes the trailing blanks from a specified string.

UPPER Converts all letters in a string to uppercase.

Table 7-39 Expression functions categories and names (continued)

Category Function Description

Page 425: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 407

actuate.report .Table

Financial functions

% OF

Calculates the percent for the selected column value in the scope of the selected base group.

Arguments valueString. The name of the first column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. The name of the second column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

expressionString. Defines an expression used in the calculation, using JavaScript syntax conventions. Use object literals { } to reference the arguments of the function in the expression.

"{0}/{1}*100%"

In the example above, {0} references the first argument of the function, in this case the value of the first column, {1} references value of the second column. The numbers 0 and 1 refer to the arguments in the order of their definition.

Example This example creates a computed column Q1/Year, calculating the percent of the revenue at the first quarter from the total yearly revenue, by product code.

var columnNameAfter = "PRODUCTCODE";var columnName1 = "FirstQuarterTotal";var columnName2 = "YearTotal";var columnLabel = "Q1/Year";var category = "Financial";var categoryFunc = "% OF";

var expression = "{0}/{1}*100%";var arguments = [

{ "value" : "["+columnName1+"]" },{ "value" : "["+columnName2+"]" }

];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.expression = expression;

Page 426: Actuate API Reference - OpenText

408 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs );table.submit();

% OF DIFFERENCE

Calculates the percent of the difference between values in two numbers

Arguments valueString. The name of the first column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. The name of the second column in format. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

expressionString. Defines an expression used in the calculation, using JavaScript syntax conventions. Use object literals { } to reference the arguments of the function in the expression.

({1}-{0})/{0}*100%

In the example above, {0} references the first argument of the function, in this case the value of the first column, {1} references value of the second column. The numbers 0 and 1 refer to the arguments in the order of their definition.

Example The example creates a computed column Q1/Year, calculating the % of difference between the first quarter and yearly revenue by product code.

var columnName1 = "FirstQuarterTotal";var columnName2 = "YearTotal";var columnLabel = "Q1/Year";var category = "Financial";var categoryFunc = "% OF DIFFERENCE";

var expression = "({1}-{0})/{0}*100%";var arguments = [

{ "value": "["+columnName+"]"},{"value":"["+columnName+"]"}

];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;

Page 427: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 409

actuate.report .Table

computedAttrs.category.function.expression = expression;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit();

RUNNINGSUM

Calculates the running total for the selected Column at the specified base group level.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

aggregationTypeString. Defines the type of the aggregation type.

Example This example creates a computed column Running Sum, calculating the running sum of quarterly sales by product code.

var columnNameAfter = "PRODUCTCODE";var columnName = "QuarterTotal";var columnLabel = "Running Sum";var category = "Financial";var categoryFunc = "RUNNINGSUM";

var arguments = [ { "value" : "[" + columnName + "]" }, { "aggregationType" : "Expression" }

];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs );table.submit( );

Math functions

ABS

Returns the absolute value of a number without regard to its sign. For example, 6 is the absolute value of 6 and -6.

Page 428: Actuate API Reference - OpenText

410 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Example This example creates a computed column ABS-Revenue that is the absolute value of the revenue for the product code.

var columnNameAfter = "PRODUCTCODE";var columnName = "REVENUE";var columnLabel = "ABS-Revenue";var category = "Math";var categoryFunc = "ABS";

var arguments = [ {"value":"["+columnName+"]"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

ADD

Calculates a sum of two columns.

Arguments valueString. The name of the first column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. The name of the second column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

expressionString. Defines an expression used in the calculation, using JavaScript syntax conventions. Use object literals { } as the function arguments in the expression.

"{0}+{1}"

In the example above, {0} references the first argument of the function, in this case the value of the first column, {1} references value of the second column. The numbers 0 and 1 refer to the arguments in the order of their definition.

Page 429: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 411

actuate.report .Table

Examples This example creates a computed column, adding the revenue from Q1 and Q2.

var columnNameAfter = "PRODUCTCODE";var columnName1 = "Q1";var columnName2 = "Q2";var columnLabel = "Q1+Q2";var category = "Math";var categoryFunc = "ADD";

var expression = "{0}+{1}";var arguments = [

{ "value" : "["+columnName1+"]" },{ "value" : "["+columnName2+"]" }

];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.expression = expression;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs );table.submit( );

The example generates the following JSON object:

{ "arguments" : [{ "value" : "[Q1]" }, { "value" : "[Q2]" }], "category" : "Math", "expression" : "{0}+{1}", "function" : "ADD", "label" : "Q1+Q2"}

CEILING

Rounds a number to the nearest specified multiple of significance, away from zero.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. The multiple of significance to which Number is to be rounded.

Example This example creates a computed column that displays the nearest integer that is a multiple of 3.

Page 430: Actuate API Reference - OpenText

412 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

var columnNameAfter = "PRODUCTCODE";var columnName = "Revenue";var columnLabel = "Revenue-ceiling";var category = "Math";var categoryFunc = "CEILING";

var arguments = [{"value":"["+columnName+"]"}, {"value":"3"}];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

DIFFERENCE

Calculates the difference between two numbers.

Arguments valueString. The name of the first column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. The name of the second column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

expressionString. Defines an expression used in the calculation, using JavaScript syntax conventions. Use object literals { } to reference the arguments of the function in the expression.

"{0}+{1}"

In the example above, {0} references the first argument of the function, in this case the value of the first column, {1} references value of the second column. The numbers 0 and 1 refer to the arguments in the order of their definition.

Example The example creates a computed column displaying the difference in Q1 and Q2 revenues.

var columnNameAfter = "PRODUCTCODE";var columnName1 = "Q1";var columnName1 = "Q2";var columnLabel = "Q2-Q1";

Page 431: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 413

actuate.report .Table

var category = "Math";var categoryFunc = "DIFFERENCE";

var expression = "{1}-{0}";var arguments = [

{ "value" : "["+columnName+"]" },{ "value" : "["+columnName+"]" }

];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.expression = expression;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

MOD

Calculates the remainder value of number divided by divisor. The remainder displays the same sign as the divisor.

Arguments valueString. Table column name, that gives the number for which you want to find the remainder. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. Divisor. The number by which you want to divide the column value.

Example The example creates a computed column that displays the remainder of parts, considering eight parts are used in a unit.

var columnNameAfter = "Account";var columnName = "PARTS";var columnLabel = "Parts-Mod";var category = "Math";var categoryFunc = "MOD";

var arguments = [ {"value":"["+columnName+"]"}, {"value":"8"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;

Page 432: Actuate API Reference - OpenText

414 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

table.insertComputedColumn( columnNameAfter, columnLabel, computedAttrs);

table.submit( );

PRODUCT

Calculates the product, number 1 * number 2.

Arguments valueString. The name of the first column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. The name of the second column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

expressionString. Defines an expression used in the calculation, using JavaScript syntax conventions. Use object literals { } to reference the arguments of the function in the expression.

"{0}+{1}"

In the example above, {0} references the first argument of the function, in this case the value of the first column, {1} references value of the second column. The numbers 0 and 1 refer to the arguments in the order of their definition.

Example This example creates a computed column, multiplying the number of items ordered by the price of the item.

var columnNameAfter = "PRODUCTCODE";var columnName1 = "ORDER-PARTS";var columnName2 = "PART-PRICE";var columnLabel = "ORDER-PRICE";var category = "Math";var categoryFunc = "PRODUCT";

var expression = "{0}*{1}";var arguments = [

{ "value" : "["+columnName1+"]" },{ "value" : "["+columnName2+"]" }

];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;

Page 433: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 415

actuate.report .Table

computedAttrs.category.function.expression = expression;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

RANK

Calculates the rank for the Column value in the list of column values.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

expressionString.

Example This example creates a computed column, to display the rank of the product line.

var columnNameAfter = "PRODUCTCODE";var columnName = "PRODUCTLINE";var columnLabel = "Rank";var category = "Math";var categoryFunc = "RANK";

var arguments = [ {"value":"["+columnName+"]" ,"aggregationType":"Expression"},{"value":"true","aggregationType":"ascending"}

];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

RATIO

Calculates the ratio of two numbers.

Page 434: Actuate API Reference - OpenText

416 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

Arguments valueString. The name of the first column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. The name of the second column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

expressionString. Defines an expression used in the calculation, using JavaScript syntax conventions. Use object literals { } to reference the arguments of the function in the expression.

"{0}+{1}"

In the example above, {0} references the first argument of the function, in this case the value of the first column, {1} references value of the second column. The numbers 0 and 1 refer to the arguments in the order of their definition.

Example This example creates a computed column for the ratio of sales from Q1 and Q2.

var columnNameAfter = "PRODUCTCODE";var columnName1 = "Q1";var columnName2 = "Q2";var columnLabel = "Q1/Q2";var category = "Math";var categoryFunc = "RATIO";

var expression = "{0}/{1}";var arguments = [

{"value":"["+columnName1+"]"},{"value":"["+columnName2+"]"}

];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.expression = expression;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

ROUND

Rounds the number to a specified number of decimal digits.

Page 435: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 417

actuate.report .Table

Arguments valueString. The name of the dataset column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. The number of digits to which to round the column value.

Example This example creates a computed column that displays the revenue for the product code rounded to two decimal places.

var columnNameAfter = "PRODUCTCODE";var columnName = "REVENUE";var columnLabel = "Revenue";var category = "Math";var categoryFunc = "ROUND";

var arguments = [ {"value":"["+columnName+"]"}, {"value":"2"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

ROUNDDOWN

Rounds a number down to a specified number of digits.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. Specifies the number of digits to which to round the column value down.

Example This example creates a computed column that displays the revenue for the product code rounded down to an integer value.

var columnNameAfter = "PRODUCTCODE";var columnName = "REVENUE";var columnLabel = "Revenue-rounddown";var category = "Math";var categoryFunc = "ROUNDDOWN";var arguments = [ {"value":"["+columnName+"]"}, {"value":"0"} ];var computedAttrs = {};

Page 436: Actuate API Reference - OpenText

418 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

ROUNDUP

Rounds a number up to a specified number of digits.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. Specifies the number of digits to which to round the column value up.

Example This example creates a computed column that displays the price for the product code rounded up to two decimal places.

var columnNameAfter = "PRODUCTCODE";var columnName = "UNITPRICE";var columnLabel = "Unitprice-roundup";var category = "Math";var categoryFunc = "ROUNDUP";

var arguments = [ {"value":"["+columnName+"]"}, {"value":"2"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

SQRT

Calculates the square root of a number.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Page 437: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 419

actuate.report .Table

Example This example creates a computed column that displays the length of the product as the square root of its area.

var columnNameAfter = "PRODUCTCODE";var columnName = "PRODUCTAREA";var columnLabel = "Length";var category = "Math";var categoryFunc = "SQRT";

var arguments = [ {"value":"["+columnName+"]"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

DateTime functions

ADD_DAY

Adds a specified number of days to a date value.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. Number of days.

Example This example creates a computed column that displays the expected delivery date of an order by adding 10 to the order date.

var columnNameAfter = "PRODUCTCODE";var columnName = "ORDERDATE";var columnLabel = "DELIVERYDATE";var category = "Date & Time";var categoryFunc = "ADD_DAY";

var arguments = [ {"value":"["+columnName+"]"},{"value":"10"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;

Page 438: Actuate API Reference - OpenText

420 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

table.insertComputedColumn( columnNameAfter, columnLabel, computedAttrs);

table.submit( );

ADD_HOUR

Adds a specified number of hours to a date value.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. Number of hours.

Example This example creates a computed column that displays the expected response time for a call by adding 4 hours to the call time.

var columnNameAfter = "PRODUCTCODE";var columnName = "CALLTIME";var columnLabel = "ResponseTime";var category = "Date & Time";var categoryFunc = "ADD_HOUR";

var arguments = [ {"value":"["+columnName+"]"}, {"value":"4"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

ADD_MINUTE

Adds a specified number of minutes to a date value.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. Number of minutes.

Example This example creates a computed column that displays the expected processing completion time by adding 10 minutes to the log time.

Page 439: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 421

actuate.report .Table

var columnNameAfter = "PRODUCTCODE";var columnName = "LOGTIME";var columnLabel = "ProcessTime";var category = "Date & Time";var categoryFunc = "ADD_MINUTE";

var arguments = [ {"value":"["+columnName+"]"}, {"value":"10"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

ADD_MONTH

Adds a specified number of months to a date value.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. Number of months.

Example This example creates a computed column that displays the date on which an action takes effect by adding 6 months to a start date.

var columnNameAfter = "PRODUCTCODE";var columnName = "STARTDATE";var columnLabel = "EFFECTDATE";var category = "Date & Time";var categoryFunc = "ADD_MONTH";

var arguments = [ {"value":"["+columnName+"]"}, {"value":"6"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

Page 440: Actuate API Reference - OpenText

422 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

ADD_QUARTER

Adds a specified number of quarters to a date value.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. Number of quarters.

Example This example creates a computed column that displays the end date of a period by adding 1 quarter to the start date.

var columnNameAfter = "PRODUCTCODE";var columnName = "STARTDATE";var columnLabel = "ENDDATE";var category = "Date & Time";var categoryFunc = "ADD_QUARTER";

var arguments = [ {"value":"["+columnName+"]"}, {"value":"1"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

ADD_SECOND

Adds a specified number of seconds to a date value.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. Number of seconds.

Example This example creates a computed column that displays the expected end time of a process by adding 30 seconds to a start time.

var columnNameAfter = "PRODUCTCODE";var columnName = "STARTTIME";var columnLabel = "ENDTIME";var category = "Date & Time";

Page 441: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 423

actuate.report .Table

var categoryFunc = "ADD_SECOND";

var arguments = [ {"value":"["+columnName+"]"}, {"value":"30"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

ADD_WEEK

Adds a specified number of weeks to a date value.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. Number of weeks.

Example This example creates a computed column that displays the expected end date of a process by adding 6 weeks to the start date.

var columnNameAfter = "PRODUCTCODE";var columnName = "STARTDATE";var columnLabel = "ENDDATE";var category = "Date & Time";var categoryFunc = "ADD_WEEK";

var arguments = [ {"value":"["+columnName+"]"}, {"value":"6"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

ADD_YEAR

Adds a specified number of years to a date value.

Page 442: Actuate API Reference - OpenText

424 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. Number of years.

Example This example creates a computed column that displays the expected end date of a process by adding 4 years to the start date.

var columnNameAfter = "PRODUCTCODE";var columnName = "STARTDATE";var columnLabel = "ENDDATE";var category = "Date & Time";var categoryFunc = "ADD_YEAR";

var arguments = [ {"value":"["+columnName+"]"}, {"value":"4"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

DAY

Returns a number from 1 to 31 representing the day of the month.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Example This example creates a computed column that displays the day of the month of a date-and-time field.

var columnNameAfter = "PRODUCTCODE";var columnName = "STARTTIME";var columnLabel = "Day of month";var category = "Date & Time";var categoryFunc = "DAY";

var arguments = [ {"value":"["+columnName+"]"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};

Page 443: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 425

actuate.report .Table

computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

DIFF_DAY

Calculates the number of days between two date values.

Arguments valueString. The name of the first column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. The name of the second column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Example This example creates a computed column that displays the number of days between order and delivery by comparing two dates.

var columnNameAfter = "PRODUCTCODE";var columnName1 = "ODRDERDATE";var columnName2 = "DELIVERYDATE";var columnLabel = "EXECUTIONINDAYS";var category = "Date & Time";var categoryFunc = "DIFF_DAY";

var arguments = [ {"value":"["+columnName1+"]"},{"value":"["+columnName2+"]"}

];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

DIFF_HOUR

Calculates the number of hours between two date values.

Page 444: Actuate API Reference - OpenText

426 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

Arguments valueString. The name of the first column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. The name of the second column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Example This example creates a computed column that displays the number of hours between order and delivery by comparing two dates.

var columnNameAfter = "PRODUCTCODE";var columnName1 = "ODRDERDATE";var columnName2 = "DELIVERYDATE";var columnLabel = "EXECUTIONINHOURS";var category = "Date & Time";var categoryFunc = "DIFF_HOUR";

var arguments = [{"value":"["+columnName1+"]"},{"value":"["+columnName2+"]"}

];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

DIFF_MINUTE

Calculates the number of minutes between two date values.

Arguments valueString. The name of the first column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. The name of the second column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Page 445: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 427

actuate.report .Table

Example This example creates a computed column that displays the number of minutes between order and delivery by comparing two dates.

var columnNameAfter = "PRODUCTCODE";var columnName1 = "ODRDERDATE";var columnName2 = "DELIVERYDATE";var columnLabel = "EXECUTIONINMINUTES";var category = "Date & Time";var categoryFunc = "DIFF_MINUTE";

var arguments = [{"value":"["+columnName1+"]"},{"value":"["+columnName2+"]"}

];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

DIFF_MONTH

Calculates the number of months between two date values.

Arguments valueString. The name of the first column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. The name of the second column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Example This example creates a computed column that displays the number of months between order and delivery by comparing two dates.

var columnNameAfter = "PRODUCTCODE";var columnName1 = "ODRDERDATE";var columnName2 = "DELIVERYDATE";var columnLabel = "EXECUTIONINMONTHS";var category = "Date & Time";var categoryFunc = "DIFF_MONTH";

var arguments = [

Page 446: Actuate API Reference - OpenText

428 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

{"value":"["+columnName1+"]"},{"value":"["+columnName2+"]"}

];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

DIFF_QUARTER

Calculates the number of quarters between two date values.

Arguments valueString. The name of the first column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. The name of the second column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Example This example creates a computed column that displays the number of quarters between order and delivery by comparing two dates.

var columnNameAfter = "PRODUCTCODE";var columnName1 = "ODRDERDATE";var columnName2 = "DELIVERYDATE";var columnLabel = "EXECUTIONINQUARTERS";var category = "Date & Time";var categoryFunc = "DIFF_QUARTER";

var arguments = [{"value":"["+columnName1+"]"},{"value":"["+columnName2+"]"}

];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;

Page 447: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 429

actuate.report .Table

table.insertComputedColumn( columnNameAfter, columnLabel, computedAttrs);

table.submit( );

DIFF_SECOND

Calculates the number of seconds between two date values.

Arguments valueString. The name of the first column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. The name of the second column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Example This example creates a computed column that displays the number of seconds between order and delivery by comparing two dates.

var columnNameAfter = "PRODUCTCODE";var columnName1 = "ODRDERDATE";var columnName2 = "DELIVERYDATE";var columnLabel = "EXECUTIONINSECONDS";var category = "Date & Time";var categoryFunc = "DIFF_SECOND";

var arguments = [{"value":"["+columnName1+"]"},{"value":"["+columnName2+"]"}

];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

DIFF_WEEK

Calculates the number of weeks between two date values.

Arguments valueString. The name of the first column. The column name description follows the BIRT syntax convention. Use the following syntax:

Page 448: Actuate API Reference - OpenText

430 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

value:[ColumnName]

valueString. The name of the first column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Example This example creates a computed column that displays the number of weeks between order and delivery by comparing two dates.

var columnNameAfter = "PRODUCTCODE";var columnName1 = "ODRDERDATE";var columnName2 = "DELIVERYDATE";var columnLabel = "EXECUTIONINWEEKS";var category = "Date & Time";var categoryFunc = "DIFF_WEEK";

var arguments = [{"value":"["+columnName1+"]"},{"value":"["+columnName2+"]"}

];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

DIFF_YEAR

Calculates the number of years between two date values.

Arguments valueString.The name of the first column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. The name of the second column. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Example This example creates a computed column that displays the number of years between order and delivery by comparing two dates.

var columnNameAfter = "PRODUCTCODE";

Page 449: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 431

actuate.report .Table

var columnName1 = "ODRDERDATE";var columnName2 = "DELIVERYDATE";var columnLabel = "EXECUTIONINYEARS";var category = "Date & Time";var categoryFunc = "DIFF_YEAR";

var arguments = [{"value":"["+columnName1+"]"},{"value":"["+columnName2+"]"}

];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

MONTHReturns the month for a specified date value.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. Defines the option for the format of the returned month value. Use the following options, as shown in Table 7-41.

Example This example creates a computed column that displays the month number of a date.

var columnNameAfter = "PRODUCTCODE";var columnName = "STARTTIME";var columnLabel = "MONTH";

Table 7-40 Month options

Option Description

1 To get the month as a number from 1 to 12.

2 To get the full month name, for example, January. The result is locale-specific.

3 To get the abbreviated month name, for example, Jan. The result is locale-specific.

Page 450: Actuate API Reference - OpenText

432 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

var category = "Date & Time";var categoryFunc = "MONTH";

var arguments = [{"value":"["+columnName+"]"},{"value":1}

];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

NOW

Returns the current date and time.

Example This example creates a computed column that displays the current date and time.

var columnNameAfter = "PRODUCTCODE";var columnName = "ORDERDATE";var columnLabel = "NOW";var category = "Date & Time";var categoryFunc = "NOW";

var arguments = [ ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

QUARTER

Returns the quarter number for a specified date value.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Page 451: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 433

actuate.report .Table

Example This example creates a computed column that displays the quarter number of a date.

var columnNameAfter = "PRODUCTCODE";var columnName = "ORDERDATE";var columnLabel = "QUARTER";var category = "Date & Time";var categoryFunc = "QUARTER";

var arguments = [ {"value":"["columnName"]"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

TODAY

Returns the current date including a time value of midnight, 12:00 AM.

Example This example creates a computed column that displays today’s date.

var columnNameAfter = "PRODUCTCODE";var columnLabel = "Today";var category = "Date & Time";var categoryFunc = "TODAY";

var arguments = [ ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

WEEK

Returns a number from 1 to 52 representing the week of the year.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Page 452: Actuate API Reference - OpenText

434 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

Example This example creates a computed column that displays the week number of a date.

var columnNameAfter = "PRODUCTCODE";var columnName = "STARTDATE";var columnLabel = "WEEK";var category = "Date & Time";var categoryFunc = "WEEK";

var arguments = [ {"value":"["+columnName+"]"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

WEEKDAY

Returns the day of the week for a specified date value.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. Defines the option for the format of the returned week day value. Use the following options, as shown in Table 7-41.

Example This example creates a computed column that displays the numeric day of the week for a date, with Monday being 0.

Table 7-41 Weekday options

Option Description

1 To get the day as a number from 1 (Sunday) to 7 (Saturday)

2 To get the day as a number from 1 (Monday) to 7 (Sunday)

3 To get the day as a number from 0 (Monday) to 6 (Sunday)

4 To get the full weekday name, for example, Wednesday. The result is locale-specific

5 To get the abbreviated weekday name, for example Wed. The result is locale-specific

Page 453: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 435

actuate.report .Table

var columnNameAfter = "PRODUCTCODE";var columnName = "STARTTIME";var columnLabel = "WEEKDAY";var category = "Date & Time";var categoryFunc = "WEEKDAY";

var arguments = [ {"value":"["+columnName+"]"}, {"value":3} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

YEAR

Returns the four-digit year value for a specified date value.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Example This example creates a computed column that displays the year value of a date.

var columnNameAfter = "PRODUCTCODE";var columnName = "STARTTIME";var columnLabel = "YEAR";var category = "Date & Time";var categoryFunc = "YEAR";

var arguments = [ {"value":"["+columnName+"]"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

Page 454: Actuate API Reference - OpenText

436 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

Comparison functions

BETWEEN

Returns true if a value is between two specified values, and false if it is not in this range.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. Defines the value for the lower bound.

valueString. Defines the value for the upper bound.

Example This example creates a computed column that displays whether a value is in the range 1 to 3.

var columnNameAfterPosition = "PRODUCTCODE";var columnName = "QUANTITY";var columnLabel = "InRange";var category = "Comparison";var categoryFunc = "BETWEEN";

var arguments = [{"value":"["+columnName+"]"},{"value":"1"},{"value":"3"}

];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfterPosition, columnLabel,

computedAttrs);table.submit( );

IN

Returns true if a value is equal to a value in a list and false if not.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Page 455: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 437

actuate.report .Table

valueString. Comma-separated list of values.

Example This example creates a computed column that displays whether a country value is either France or Spain.

var columnNameAfterPosition = "PRODUCTCODE";var columnName = "COUNTRY";var columnLabel = "IN";var category = "Comparison";var categoryFunc = "IN";

var arguments = [{"value":"["+columnName+"]"},{"value":"\"France\", "\Spain\""}

];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

ISNULL

Returns if a value in a specified data field is a null value. A null value means no value exists.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Example This example creates a computed column that displays whether a city column has no value.

var columnNameAfter = "PRODUCTCODE";var columnName = "CITY";var columnLabel = "isNULL";var category = "Comparison";var categoryFunc = "ISNULL";

var arguments = [ {"value":"["+columnName+"]"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;

Page 456: Actuate API Reference - OpenText

438 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

LIKE

Returns true if a string matches a pattern, and false if it does not match a pattern.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. Defines the string pattern to match. You must enclose the pattern in double quotation marks (" "). The match is case-sensitive. You can use the following special characters in a pattern:

■ A percent character (%) matches zero or more characters. As shown in the usage example below, %ace% matches any string value that contains the substring ace, such as Facebook, and MySpace. It does not match Ace Corporation because this string contains a capital A, and not the lowercase a.

■ An underscore character (_) matches exactly one character. For example, t_n matches tan, ten, tin, and ton. It does not match teen or tn.

■ To match a literal percent (%), underscore (_), precede those characters with two backslash (\\) characters. For example, to see if a string contains M_10, specify the following pattern:

"%M\\_10%"

Example This example creates a computed column that displays whether a company name contains the string 'ace'.

var columnNameAfter = "PRODUCTCODE";var columnName = "COMPANYNAME";var columnLabel = "Like";var category = "Comparison";var categoryFunc = "LIKE";

var arguments = [{"value":"["+columnName+"]"},{"value":"%ace%"}];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;

Page 457: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 439

actuate.report .Table

table.insertComputedColumn( columnNameAfter, columnLabel, computedAttrs);

table.submit( );

NOTNULL

Returns true, if a value in a specified data field is a non-null value.

Arguments valueString. Table column name. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Example This example creates a computed column that displays whether a product line column contains a value.

var columnNameAfter = "PRODUCTCODE";var columnName = "PRODUCTLINE";var columnLabel = "NotNull";var category = "Comparison";var categoryFunc = "NOTNULL";

var arguments = [ {"value":"["+columnName+"]"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

Text functions

FIND

Finds the numerical position of a substring in a string.

Arguments value

String. Defines the string to find.

valueString. Table column name. Defines the string in which to search. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. The starting position from which to start the search.

Page 458: Actuate API Reference - OpenText

440 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

Example This example creates a computed column that displays the location of the string 'Car' in the product line column.

var columnNameAfter = "PRODUCTCODE";var columnName = "PRODUCTLINE";var columnLabel = "FIND";var category = "Text";var categoryFunc = "FIND";

var arguments = [{"value":"\"Car\""},{"value":"["+columnName+"]"},{"value":"1"}

];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

LEFT

Extracts a substring from a string, starting from the leftmost, or first, character.

Arguments valueString. Table column name. Defines the string from which to extract a substring. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. The number of characters to extract, starting from the first character. If the number is zero, the function returns an empty string. If the number is greater than the length of the string, the function returns the entire string.

Example This example creates a computed column that displays the first 10 characters of the product line column.

var columnNameAfter = "PRODUCTCODE";var columnName = "PRODUCTLINE";var columnLabel = "LEFT";var category = "Text";var categoryFunc = "LEFT";

var arguments = [ {"value":"["+columnName+"]"}, {"value":"10"} ];var computedAttrs = {};

Page 459: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 441

actuate.report .Table

computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

LEN

Counts the number of characters in a string.

Arguments valueString. Table column name. Defines the string to evaluate. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Example This example creates a computed column that displays the number of characters in the value of the product line column.

var columnNameAfter = "PRODUCTCODE";var columnName = "PRODUCTLINE";var columnLabel = "LEN";var category = "Text";var categoryFunc = "LEN";var arguments = [ {"value":"["+columnName+"]"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

LOWER

Converts all letters in a string to lowercase.

Arguments valueString. Table column name. The string to convert to lowercase. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Example This example creates a computed column that displays the product line column value in lowercase.

Page 460: Actuate API Reference - OpenText

442 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

var columnNameAfter = "PRODUCTCODE";var columnName = "PRODUCTLINE";var columnLabel = "LOWER";var category = "Text";var categoryFunc = "LOWER";

var arguments = [ {"value":"["+columnName+"]"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

RIGHT

Extracts a substring from a string, starting from the rightmost, or last character.

Arguments valueString. Table column name. Defines the string from which to extract a substring. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. The number of characters to extract, starting from the last character. If the number is zero, the function returns an empty string. If the number is greater than the length of the string, the function returns the entire string.

Example This example creates a computed column that displays the last 5 characters of the product line column.

var columnNameAfter = "PRODUCTCODE";var columnName = "PRODUCTLINE";var columnLabel = "Right";var category = "Text";var categoryFunc = "RIGHT";

var arguments = [ {"value":"["+columnName+"]"}, {"value":"5"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;

Page 461: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 443

actuate.report .Table

table.insertComputedColumn( columnNameAfter, columnLabel, computedAttrs);

table.submit( );

SEARCH

Finds the location of a substring in a string. The substring can contain wildcard characters.

Arguments valueString. The string pattern to search for. You must enclose the pattern in quotation marks (" "). You can use the following special characters in a pattern:

■ An asterisk (*) matches zero or more characters, including spaces. For example, t*n matches tn, tin, and teen.

■ A question mark (?) matches exactly one character. For example, t?n matches tan, ten, tin, and ton. It does not match teen or tn.

valueString. Table column name. Defines the string in which to search. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

valueString. The starting position from which to start the search.

Example This example creates a computed column that displays the location of a string matching the pattern 'a*Cars' in the product line column.

var columnNameAfter = "PRODUCTCODE";var columnName = "PRODUCTLINE";var columnLabel = "SEARCH";var category = "Text";var categoryFunc = "SEARCH";

var arguments = [ {"value":"\"a*Cars\""},{"value":"["+columnName+"]"},{"value":"1"}

];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

Page 462: Actuate API Reference - OpenText

444 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

TRIM

Removes the leading and trailing blank characters from a string.

Arguments valueString. Table column name. The string from which to remove leading and trailing blank characters. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Example This example creates a computed column that displays the trimmed value of the product line column.

var columnNameAfter = "PRODUCTCODE";var columnName = "PRODUCTLINE";var columnLabel = "Trim";var category = "Text";var categoryFunc = "TRIM";

var arguments = [ {"value":"["+columnName+"]"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

TRIMLEFT

Removes the leading blank characters from a string.

Arguments valueString. Table column name. The string from which to remove leading blank characters. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Example This example creates a computed column that displays the value of the product line column with no leading spaces.

var columnNameAfter = "PRODUCTCODE";var columnName = "PRODUCTLINE";var columnLabel = "TrimLeft";var category = "Text";var categoryFunc = "TRIMLEFT";

var arguments = [ {"value":"["+columnName+"]"} ];

Page 463: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 445

actuate.report .Table

var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

TRIMRIGHT

Removes the trailing blank characters from a string.

Arguments valueString. Table column name. The string from which to remove trailing blank characters. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Example This example creates a computed column that displays the value of the product line column with no trailing spaces.

var columnNameAfter = "PRODUCTCODE";var columnName = "PRODUCTLINE";var columnLabel = "TrimRight";var category = "Text";var categoryFunc = "TRIMRIGHT";

var arguments = [ {"value":"["+columnName+"]"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

UPPER

Converts all letters in a string to uppercase.

Arguments valueString. Table column name. The string to convert to uppercase. The column name description follows the BIRT syntax convention. Use the following syntax:

value:[ColumnName]

Page 464: Actuate API Reference - OpenText

446 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

Example This example creates a computed column that displays the product line column value in uppercase.

var columnNameAfter = "PRODUCTCODE";var columnName = "PRODUCTLINE";var columnLabel = "Upper";var category = "Text";var categoryFunc = "UPPER";

var arguments = [ {"value":"["+columnName+"]"} ];var computedAttrs = {};computedAttrs.category = {};computedAttrs.category.function = {};computedAttrs.category.categoryName = category;computedAttrs.category.function.functionName = categoryFunc;computedAttrs.category.function.arguments = arguments;table.insertComputedColumn( columnNameAfter, columnLabel,

computedAttrs);table.submit( );

moveToLeftSyntax void Table.moveToLeft(string columnName)

Moves a column to the left of the current position.

Parameter columnNameString. The name of the column.

Example This example moves a column to the left:

var pgContent = viewer.getCurrentPageContent( );var table = pgContent.getTableByBookmark( bookmark );table.moveToLeft( columnName );table.submit( );

moveToRightSyntax void Table.moveToRight(string columnName)

Moves a column to the right of the current position.

Parameter columnNameString. The name of the column.

Example This example moves a column to the right:

var pgContent = viewer.getCurrentPageContent( );var table = pgContent.getTableByBookmark( bookmark );table.moveToRight( columnName );table.submit( );

Page 465: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 447

actuate.report .Table

removeGroupSyntax void Table.removeGroup()

Removes the innermost group.

Example This example removes the innermost group from myTable and displays an alert box after calling submit( ):

function removeMyGroup(myTable) {myTable.removeGroup();myTable.submit(alert("Group removed"));

}

setAlignmentSyntax void Table.setAlignment(string columnName, string alignment)

Changes the alignment of a given column.

Parameters columnNameString. The name of the column.

alignmentString. The alignment values can be "right", "left", "center".

Example This example shows how to align a column to the right:

var pgContent = viewer.getCurrentPageContent( );var table = pgContent.getTableByBookmark( bookmark );// right align the columntable.setAlignment( columnName, "right" ); table.submit( );

setFiltersSyntax void Table.setFilters(actuate.data.Filter filter)

void Table.setFilters(actuate.data.Filter[ ] filters)

Applies a filter or filters to this Table element.

Parameters filteractuate.data.Filter object. A single filter condition to apply to this Table.

filtersAn array of actuate.data.Filter objects. Filter conditions to apply to this Table.

Example To add a filter to the Table to display only entries with a CITY value of NYC, use the following code:

Page 466: Actuate API Reference - OpenText

448 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

var filters = new Array( );var city_filter = new actuate.data.Filter("CITY",

actuate.data.Filter.EQ, "NYC");filters.push(city_filter);table.setFilters(filters);

setHeaderAlignmentSyntax void Table.setHeaderAlignment(string columnName, string alignment)

Changes the alignment of a column header.

Parameters columnNameString. The name of the column.

alignmentString. The alignment values can be "right", "left", "center".

Example This example shows how to center a column header:

var pgContent = viewer.getCurrentPageContent( );var table = pgContent.getTableByBookmark( bookmark );// center a columnName headertable.setHeaderAlignment( columnName, "center" ); table.submit( );

setSortersSyntax void Table.setSorters(actuate.data.Sorter sorter)

void Table.setSorters(actuate.data.Sorter[ ] sorters)

Applies a sorter or sorters to this Table.

Parameters sorteractuate.data.Sorter object. A single sort condition to apply to this Table.

sortersAn array of actuate.data.Sorter objects. Sort conditions to apply to this Table.

Example This example adds the myStateSorter and myCitySorter sorters to myTable:

function setAllMySorters(myTable) {myTable.setSorters(["myStateSorter", "myCitySorter"]);

}

showSyntax void Table.show( )

Shows this element.

Page 467: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 449

actuate.report .Table

Example Use show( ) to reveal a report Table, as shown in the following code:

myTable.show( );

showColumnSyntax void Table.showColumn(string columnName)

Shows the Table column by specifying the column name.

Parameter enabledString. The data binding name for the column to display.

Example This example shows the PRODUCTLINE column in myTable:

function showMyColumn(myTable) {myTable.showColumn("PRODUCTLINE");myTable.submit( );

}

showDetailSyntax void Table.showDetail(string columnName)

Displays information for a column from the grouped data displayed on the page. If every column is hidden, only the group name is visible.

Parameter columnNameString. The data binding name for the column to display.

Example This example shows the information from the PRODUCTLINE column in the grouped data that is displayed for myTable:

function showMyDetail(myTable) {myTable.showDetail("PRODUCTLINE");myTable.submit( );

}

submitSyntax void Table.submit(function callback)

Submits all the asynchronous operations for this Table element. The submit( ) function triggers an AJAX request to submit all the asynchronous operations. When the server finishes the processing, it returns a response and the results are rendered on the page in the table container.

Parameter callbackFunction. The function called after the asynchronous call processing finishes.

Example This example clears existing filters from the PRODUCTLINE column and pops up an alert box:

Page 468: Actuate API Reference - OpenText

450 A c t u a t e A P I R e f e r e n c e

actuate.report .Table

function alertResetFilter(myTable){myTable.clearFilters("PRODUCTLINE");myTable.submit(alert("Filters Cleared"));

}

swapColumnsSyntax void Table.swapColumns(string columnName1, string columnName2)

Swaps the columns to reorder to column sequence of the Table.

Parameters columnName1String. The first column to swap in the column order.

columnName2String. The second column to swap in the column order.

Example This example swaps the TOTAL and PRODUCTLINE columns in myTable:

function swapMyColumns(myTable){myTable.swapColumns("TOTAL", "PRODUCTLINE");myTable.submit( );

}

Page 469: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 451

actuate.report .TextI tem

Class actuate.report.TextItemDescription A container for a Text element in a report. TextItem provides functions to operate

on a Text element, such as retrieving the text value and getting the HTML DOM element from the report Text element.

ConstructorThe TextItem object is constructed by viewer.PageContent.getTextByBookmark( ).

Function summaryTable 7-42 lists actuate.report.TextItem functions.

getBookmarkSyntax string TextItem.getBookmark( )

Returns the bookmark name for this Text item.

Returns String.

Example This example displays the table’s bookmark in an alert box:

function alertBookmark(myTextItem){alert(myTextItem.getBookmark( ));

}

Table 7-42 actuate.report.TextItem functions

Function Description

getBookmark( ) Returns the bookmark name for this Text

getHtmlDom( ) Returns the HTML element for this Text

getInstanceId( ) Returns the report element instance id

getPageContent( ) Returns the page content to which this element belongs

getText( ) Returns the text in this Text element

getType( ) Returns the Text element’s type

hide( ) Hides this element

show( ) Shows this element

submit( ) Applies changes made to this element

Page 470: Actuate API Reference - OpenText

452 A c t u a t e A P I R e f e r e n c e

actuate.report .TextI tem

getHtmlDomSyntax HTMLElement TextItem.getHtmlDom( )

Returns the HTML element for this Text.

Returns HTMLElement.

Example This example displays the HTML DOM element for this Text item inside a red border:

function showHtmlDom(myTextItem){var domNode = myTextItem.getHtmlDom( );var box = document.createElement('div');box.style.border = '2px solid red';var label = document.createElement('h2');label.innerHTML = 'The HTML DOM:';box.appendChild(label);box.appendChild(domNode);document.body.appendChild(box);

}

getInstanceIdSyntax string TextItem.getInstanceId( )

Returns the instance id of this report element.

Returns String. The instance id.

Example This example displays the instance ID of the report element in an alert box:

function showID(myTextItem){var elementID = myTextItem.getInstanceId( );alert (elementID);

}

getPageContentSyntax actuate.viewer.PageContent TextItem.getPageContent( )

Returns the page content to which this Text belongs.

Returns actuate.viewer.PageContent. report content.

Example This example displays the viewer ID of the page content in an alert box:

function showViewID(myTextItem){var pageContent = myTextItem.getPageContent( );var pageViewerID = pageContent.getViewerId( );alert (pageViewerID);

}

Page 471: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 453

actuate.report .TextI tem

getTextSyntax string TextItem.getText( )

Returns the text of this Text element.

Returns String. The content text.

Example This example displays the text of the myTextItem object in an alert box:

alert("Text content for myTextItem is " + myTextItem.getText( ));

getTypeSyntax string TextItem.getType( )

Returns the report element type of this object, which is Text.

Returns String. "Text".

Example This example checks the report element type and displays an alert if the type is not "Text":

if (myTextItem.getType( ) != "Text"){alert("Type mismatch, report element type is not Text");

}

hideSyntax void TextItem.hide( )

Hides this element.

Example This example hides myTextItem:

myTextItem.hide( );myTextItem.submit( );

showSyntax void TextItem.show( )

Shows this element.

Example This example shows myTextItem:

myTextItem.show( );myTextItem.submit( );

submitSyntax void TextItem.submit(function callback)

Page 472: Actuate API Reference - OpenText

454 A c t u a t e A P I R e f e r e n c e

actuate.report .TextI tem

Submits all the asynchronous operations for this TextItem. The submit( ) function triggers an AJAX request for all asynchronous operations. The server returns a response after processing. The results render on the page in the TextItem container.

Parameter callbackFunction. The function to execute after the asynchronous call processing is done.

Example This example uses submit( ) after calling show( ) to show myTextItem:

myTextItem.show( );myTextItem.submit( );

Page 473: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 455

actuate.ReportExplorer

Class actuate.ReportExplorerDescription The actuate.ReportExplorer class retrieves and displays a navigable repository or

file system interface that enables users to navigate folders and select files. This generic user interface enables the user to browse and select repository contents.

ConstructorSyntax actuate.ReportExplorer(string container)

Constructs a ReportExplorer object, initializing the ReportExplorer component.

Parameter containerString. The name of the HTML element that displays the rendered ReportExplorer component or a container object. The constructor initializes the ReportExplorer component but does not render it.

Function summaryTable 7-43 lists actuate.ReportExplorer functions.

Table 7-43 actuate.ReportExplorer functions

Function Description

getFolderName( ) Gets the root folder name

getLatestVersionOnly( ) Gets the latestVersionOnly flag

getResultDef( ) Gets the resultDef value for this GetFolderItems

getSearch( ) Gets the search value for this GetFolderItems

onUnload( ) Unloads unused JavaScript variables

registerEventHandler( ) Registers the event handler

removeEventHandler( ) Removes the event handler

setContainer( ) Sets the div container

setFolderName( ) Sets the root folder name

setLatestVersionOnly( ) Sets the latestVersionOnly flag

setResultDef( ) Sets the resultDef value for this GetFolderItems

setSearch( ) Sets the search value for this GetFolderItems

setService( ) Sets the JSAPI web service

setStartingFolder( ) Sets the path for the initial folder selection

setUseDescriptionAsLabel( ) Sets flag to use descriptions as file/folder labels

(continues)

Page 474: Actuate API Reference - OpenText

456 A c t u a t e A P I R e f e r e n c e

actuate.ReportExplorer

getFolderNameSyntax string ReportExplorer.getFolderName( )

Returns the name of the root folder for this ReportExplorer.

Returns String. The folder name.

Example This example displays the root folder’s name in an alert box:

function alertRootFolder(myReportExplorer){alert(myReportExplorer.getFolderName( ));

}

getLatestVersionOnlySyntax boolean ReportExplorer.getLatestVersionOnly( )

Returns the latest version only flag for this ReportExplorer.

Returns Boolean. True indicates that ReportExplorer displays only the latest version of each report.

Example This example displays the latest version only flag in an alert box:

function alertLatestVersionFlag(myReportExplorer){alert(myReportExplorer.getLatestVersionOnly( ));

}

getResultDefSyntax string[ ] ReportExplorer.getResultDef( )

Returns the results definition.

Returns Array of strings. Valid values are: "Name", "FileType", "Version", "VersionName", "Description", "Timestamp", "Size", and "PageCount".

Example This example displays the results definition an alert box:

function alertResultsDefinition(myReportExplorer){alert(myReportExplorer.getResultDef( ));

}

showFoldersOnly( ) Sets the flag to only display folders

submit( ) Applies changes made to this element

Table 7-43 actuate.ReportExplorer functions (continued)

Function Description

Page 475: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 457

actuate.ReportExplorer

getSearchSyntax actuate.ReportExplorer.FileSearch ReportExplorer.getSearch( )

Returns the FileSearch object assigned to this ReportExplorer.

Returns actuate.reportexplorer.FileSearch object. The file search settings.

Example This example sets the FileSearch setting for reportexplorer1 to the FileSearch settings of reportexplorer2:

reportexplorer1.setSearch(reportexplorer2.getSearch( ));

onUnloadSyntax void ReportExplorer.onUnload( )

Unloads JavaScript variables that are no longer needed by ReportExplorer.

Example This example cleans up unused JavaScript variables for myReportExplorer:

myReportExplorer.onUnload( );

registerEventHandlerSyntax void ReportExplorer.registerEventHandler(string eventName, function handler)

Registers an event handler to activate for parameter eventName. This function can assign several handlers to a single event.

Parameters eventNameString. Event name to capture.

handlerFunction. The function to execute when the event occurs. The handler must take two arguments: the ReportExplorer instance that fired the event and an event object specific to the event type.

Example This example registers the errorHandler( ) function to respond to the ON_EXCEPTION event:

myReportExplorer.registerEventHandler(actuate.ReportExplorer.EventConstants.ON_EXCEPTION, errorHandler);

removeEventHandlerSyntax void ReportExplorer.removeEventHandler(string eventName, function handler)

Removes an event handler to activate for parameter eventName.

Parameters eventNameString. Event name to remove from the internal list of registered events.

Page 476: Actuate API Reference - OpenText

458 A c t u a t e A P I R e f e r e n c e

actuate.ReportExplorer

handlerFunction. The function to disable.

Example This example removes the errorHandler( ) function from responding to the ON_EXCEPTION event:

myReportExplorer.removeEventHandler(actuate.ReportExplorer.EventConstants.ON_EXCEPTION, errorHandler);

setContainerSyntax void ReportExplorer.setContainer(string containerId)

Sets the HTML element container for the ReportExplorer content.

Parameter containerIDString. The name of the HTML element that displays the group of rendered ReportExplorer components.

Example This example sets MyReportExplorer to render the <div> element labeled "History":

myReportExplorer.setContainer("History");

setFolderNameSyntax void ReportExplorer.setFolderName(string folderName)

Sets the name of the root folder for this ReportExplorer.

Parameter folderNameString. The name of the repository folder to use as the root folder. Use a repository path to use subfolders for the root folder. The string '~/' maps to the current user’s home folder.

Example This example sets the report explorer root folder to /Public:

myReportExplorer.setFolderName("/Public");

setLatestVersionOnlySyntax void ReportExplorer.setLatestVersionOnly(boolean latestVersionOnly)

Sets the latest version only flag for this ReportExplorer.

Parameter latestVersionOnlyBoolean. True removes all but the latest versions from the report explorer.

Example This example sets ReportExplorer to display only the latest versions of all files:

myReportExplorer.setLatestVersionOnly( true );

Page 477: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 459

actuate.ReportExplorer

setResultDefSyntax void ReportExplorer.setResultDef(string[ ] resultDef)

Sets the results definition.

Parameter resultDefArray of strings. Valid values are: "Name", "FileType", "Version", "VersionName", "Description", "Timestamp", "Size", and "PageCount". iHub requires the Name, FileType, and Version fields in the results definition array to identify all files.

Example This example sets the result set to five columns of data including name, file type, version, version name, and description:

var resultDef = "Name|FileType|Version|VersionName|Description";myReportExplorer.setResultDef( resultDef.split("|") );

setSearchSyntax void ReportExplorer.setSearch(actuate.ReportExplorer.FileSearch search)

Assigns a FileSearch object to this ReportExplorer.

Parameter searchactuate.reportexplorer.FileSearch object. The file search settings.

Example This example sets the FileSearch setting for reportexplorer1 to the FileSearch settings of reportexplorer2:

reportexplorer1.setSearch(reportexplorer2.getSearch( ));

setServiceSyntax void ReportExplorer.setService(string iportalURL, actuate.RequestOptions

requestOptions)

Sets the target service URL to which this explorer links. When the service URL is not set, this viewer links to the default service URL which is set on the actuate object.

Parameters iPortalURLString. The target Actuate web application URL, either a Java Component or iHub Visualization Platform client.

requestOptionsactuate.RequestOptions object. Optional. requestOptions defines URL parameters to send with the authentication request, such as the iHub URL, volume, or repository type. The URL can also include custom parameters.

Example This example sets the URL for the Actuate iPortal web application service:

Page 478: Actuate API Reference - OpenText

460 A c t u a t e A P I R e f e r e n c e

actuate.ReportExplorer

myExplorer.setService("http://127.0.0.1:8700/iportal", myRequestOptions);

setStartingFolderSyntax void ReportExplorer.setStartingFolder(string strfoldername)

Sets the fully qualified path of the initially selected folder in the explorer tree.

Parameter strfoldernameString. The fully qualified path of a folder.

Example This example sets the initially selected folder to Public in the local repository:

myExplorer.setStartingFolder("C:\Actuate3\BIRTiHubVisualization\modules\BIRTiHub\iHub\web\iportal\WEB-INF\repository\Public");

setUseDescriptionAsLabelSyntax void ReportExplorer.setUseDescriptionAsLabel(boolean useDescription)

Sets the explorer to display the folder description as the folder label instead of the folder name.

Parameter useDescriptionBoolean. True displays descriptions for folders instead of folder names.

Example This example displays descriptions for folders instead of folder names:

myExplorer.setUseDescriptionAsLabel(true);

showFoldersOnlySyntax void ReportExplorer.showFoldersOnly(boolean flag)

Sets ReportExplorer to display folders but not files.

Parameter flagBoolean. True displays folders but not files.

Example This example displays folders in ReportExplorer but not files:

myExplorer.showFoldersOnly(true);

submitSyntax void ReportExplorer.submit(function callback)

Submits requests to the server for ReportExplorer. When this function is called, an AJAX request is triggered to submit all the operations. When the server finishes the processing, it returns a response and the results are rendered on the page in the ReportExplorer container.

Page 479: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 461

actuate.ReportExplorer

Parameter callbackFunction. The function to execute after the asynchronous call processing is done.

Example This example submits ReportExplorer with a root folder that set with setStartingFolder( ) and result definition set with setResultDef( ):

myExplorer.setStartingFolder("/Dashboard/Contents");var resultDef = "Name|FileType|Version|VersionName|Description";myExplorer.setResultDef( resultDef.split("|") );myExplorer.submit( );

Page 480: Actuate API Reference - OpenText

462 A c t u a t e A P I R e f e r e n c e

actuate.reportexplorer.Constants

Class actuate.reportexplorer.ConstantsDescription Global constants used for ReportExplorer class. Table 7-44 lists the constants used

for the ReportExplorer class.

Table 7-44 Actuate iPortal JavaScript API ReportExplorer constants

Event Description

ERR_CLIENT Constant used to tell JSAPI user that there was a client-side error

ERR_SERVER Constant used to tell JSAPI user that there was a server-side error

ERR_USAGE Constant used to tell JSAPI user that there was a usage API error

NAV_FIRST Constant reference for the first page navigation link

NAV_LAST Constant reference for the last page navigation link

NAV_NEXT Constant reference for the next page navigation link

NAV_PREV Constant reference for the previous page navigation link

Page 481: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 463

actuate.reportexplorer .EventConstants

Class actuate.reportexplorer.EventConstantsDescription Defines the event constants supported by this API for report explorers. Table 7-45

lists the ReportExplorer event constants.

Table 7-45 Actuate JavaScript API ReportExplorer event constants

Event Description

ON_EXCEPTION Event triggered when an exception occurs.An event handler registered to this event must take an actuate.Exception object as an input argument. The Exception object contains the exception information.

ON_SELECTION_CHANGED Event triggered when a selection change occurs. For example, this event triggers if the value of a ReportExplorer list control changes.An event handler registered to this event must take an actuate.ReportExplorer.File object corresponding to the file object in which the selection occurred and a string that contains a repository path as input arguments.

ON_SESSION_TIMEOUT Event triggered when a user attempts to perform any operation after a session has timed out and chooses yes on a prompt dialog asking whether or not to reload the page content.An event handler registered to this event takes no input arguments.

Page 482: Actuate API Reference - OpenText

464 A c t u a t e A P I R e f e r e n c e

actuate.reportexplorer.Fi le

Class actuate.reportexplorer.FileDescription A reference object for displaying and controlling a file reference.

ConstructorSyntax actuate.reportexplorer.File( )

Constructs a new File object.

Function summaryTable 7-46 lists actuate.reportexplorer.File functions.

Table 7-46 actuate.reportexplorer.File functions

Function Description

getAccessType( ) Gets the accessType value for this File

getDescription( ) Gets the description value for this File

getFileType( ) Gets the fileType value for this File

getId( ) Gets the id value for this File

getName( ) Gets the name value for this File

getOwner( ) Gets the owner value for this File

getPageCount( ) Gets the pageCount value for this File

getSize( ) Gets the size value for this File

getTimeStamp( ) Gets the timeStamp value for this File

getUserPermissions( ) Gets the userPermissions value for this File

getVersion( ) Gets the version value for this File

getVersionName( ) Gets the versionName value for this File

setAccessType( ) Sets the accessType value for this File

setDescription( ) Sets the description value for this File

setFileType( ) Sets the fileType value for this File

setId( ) Sets the id value for this File

setName( ) Sets the name value for this File

setOwner( ) Sets the owner value for this File

setPageCount( ) Sets the pageCount value for this File

setSize( ) Sets the size value for this File

setTimeStamp( ) Sets the timeStamp value for this File

Page 483: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 465

actuate.reportexplorer.Fi le

getAccessTypeSyntax string File.getAccessType( )

Gets the access type.

Returns String. Either "private" or "shared" according to whether the file is shared or not.

Example To stop a script from running if a file is private, use code similar to the following:

if(file.getAccessType( ) == "private"){ return;}

getDescriptionSyntax string File.getDescription( )

Gets the description from the file.

Returns String. The description.

Example To stop a script from running if a file does not have a description, use code similar to the following:

if(file.getDescription( ) == (null || "")){ return;}

getFileTypeSyntax string File.getFileType( )

Gets the file extension for this File.

Returns String. The file type.

Example To store the file extension of the File object file in a variable called type, use code similar to the following:

var type = file.getFileType( );

getIdSyntax integer File.getId( )

Gets the file ID value.

setUserPermissions( ) Sets the userPermissions value for this File

setVersion( ) Sets the version value for this File

setVersionName( ) Sets the versionName value for this File

Table 7-46 actuate.reportexplorer.File functions

Function Description

Page 484: Actuate API Reference - OpenText

466 A c t u a t e A P I R e f e r e n c e

actuate.reportexplorer.Fi le

Returns Integer. The file ID.

Example To store the file id of the File object file in a variable called id, use code similar to the following:

var id = file.getFileId( );

getNameSyntax string File.getName( )

Gets the name of the file.

Returns String. The file name.

Example To store the name of the File object file in a variable called name, use code similar to the following:

var name = file.getName( );

getOwnerSyntax string File.getOwner( )

Gets the name of the File’s owner.

Returns String. The owner’s name

Example To store the name of the owner of the File object file in a variable called owner, use code similar to the following:

var owner = file.getOwner( );

getPageCountSyntax integer File.getPageCount( )

Gets the number pages in the file, if applicable.

Returns Integer. The number of pages.

Example To halt a script if the number of pages exceeds 100 in the file referenced by the File object largefile, use code similar to the following:

if (largefile.getPageCount( ) > 100) {return;}

getSizeSyntax integer File.getSize( )

Gets the size value for this File.

Returns Integer.

Page 485: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 467

actuate.reportexplorer.Fi le

Example To store a File object size in a variable called size, use code similar to the following:

var size = file.getSize( );

getTimeStampSyntax string File.getTimeStamp( )

Gets the time stamp for this file.

Returns String. A date and time of the file’s creation or last modification.

Example To store the time stamp for the file referenced by the File object oldfile in a variable called timestamp, use code similar to the following:

var timestamp = oldfile.getTimeStamp( );

getUserPermissionsSyntax string File.getUserPermissions( )

Gets the user permissions.

Returns String. The current user’s permissions for this file.

Example To store a file’s permissions in the permissions variable, use code similar to the following:

var permissions = file.getUserPermissions( );

getVersionSyntax integer File.getVersion( )

Gets the version of the file.

Returns Integer. The version.

Example To store the file version in the version variable, use code similar to the following:

var version = file.getVersion( );

getVersionNameSyntax string File.getVersionName( )

Gets the version name.

Returns String. The version name.

Example To store a version name in the version variable, use code similar to the following:

var version = file.getVersionName( );

Page 486: Actuate API Reference - OpenText

468 A c t u a t e A P I R e f e r e n c e

actuate.reportexplorer.Fi le

setAccessTypeSyntax void File.setAccessType(string accessType)

Sets the access type.

Parameter accessTypeString. "private" or "shared" indicating whether the file has been shared or not.

Example To make a file private, use code similar to the following:

file.setAccessType("private")

setDescriptionSyntax void File.setDescription(string description)

Sets the description from the file.

Parameter descriptionString. The description.

Example To clear a file’s description, use code similar to the following:

file.setDescription("");

setFileTypeSyntax void File.setFileType(string fileType)

Sets the file type for this file.

Parameter fileTypeString. The file type, which is a file extension.

Example To assign a file’s type if none is assigned, use code similar to the following:

if (file.getFileType == null) {file.setFileType("txt");}

setIdSyntax void File.setId(integer id)

Sets the file ID value.

Parameter idInteger. A file ID number.

Example To set a file’s ID to 42, use code similar to the following:

file.setId("42");

Page 487: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 469

actuate.reportexplorer.Fi le

setNameSyntax void File.setName(string name)

Sets the name of the file.

Parameter nameString. The name.

Example To set a file’s name to releasedates, use code similar to the following:

file.setName("releasedates");

setOwnerSyntax void File.setOwner(string owner)

Sets the name of the owner.

Parameter ownerString. A user name.

Example To set a file’s owner to Administrator, use code similar to the following:

file.setOwner("Administrator");

setPageCountSyntax void File.setPageCount(integer pageCount)

Sets the number pages in the file.

Parameter pageCountInteger. The number of pages, which must be less than the current number of pages.

Example To set a File object’s page to 100 if available, use code similar to the following:

if(file.getPageCount( ) > 100) {file.setPageCount(100);}

setSizeSyntax void File.setSize(integer size)

Sets the size of the file.

Parameter sizeInteger. File size in bytes.

Example To set a file’s size to 0, use code similar to the following:

file.setSize(0);

Page 488: Actuate API Reference - OpenText

470 A c t u a t e A P I R e f e r e n c e

actuate.reportexplorer.Fi le

setTimeStampSyntax void File.setTimeStamp(string timeStamp)

Sets the time stamp.

Parameter timeStampString. A date and time of the file’s creation or last modification.

Example To set a file’s time stamp to the current time, use code similar to the following:

var currenttime = new Date( );file.setTimeStamp(currenttime.toLocaleString( ));

setUserPermissionsSyntax void File.setUserPermissions(string userPermissions)

Sets the user permissions.

Parameter userPermissionsString. The current user’s permissions for this file.

Example To apply the user permissions for file1 to file2, use code similar to the following:

file2.setUserPermissions(file1.getUserPermissions( ));

setVersionSyntax void File.setVersion(integer version)

Sets the version of the file.

Parameter versionInteger. The version.

Example To set the file’s version to 1 for the first version, use code similar to the following:

file.setVersion(1);

setVersionNameSyntax void File.setVersionName(string versionName)

Sets the version name.

Parameter versionNameString. A version name.

Example To set a file’s version name to 2014, use code similar to the following:

file.setVersionName("2014");

Page 489: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 471

actuate.reportexplorer .Fi leCondit ion

Class actuate.reportexplorer.FileConditionDescription Used in actuate.reportexplorer.FileSearch objects for comparison. Contains a

display field associated with a filter string called a match. This can be used for the purposes of comparing field values for searching, filtering, or batch operations. For example, a file condition can match the FileType field with rptdesign to identify all the rptdesign files for a filter.

ConstructorSyntax actuate.reportexplorer.FileCondition( )

Constructs a new FileCondition object.

Function summaryTable 7-47 lists actuate.reportexplorer.FileCondition functions.

getFieldSyntax string FileCondition.getField( )

Returns the field for this FileCondition.

Returns String. Possible values are "Name", "FileType", "Description", "PageCount", "Size", "TimeStamp", "Version", "VersionName", and "Owner".

Example To store the display field of fcondition in a variable called field, use code similar to the following:

var field = fcondition.getField( );

getMatchSyntax string FileCondition.getMatch( )

Returns the match value for this FileCondition.

Returns String. A string for comparison.

Table 7-47 actuate.reportexplorer.FileCondition functions

Function Description

getField( ) Gets the field for this FileCondition

getMatch( ) Gets the match value for this FileCondition

setField( ) Sets the field for this FileCondition

setMatch( ) Sets the match value for this FileCondition

Page 490: Actuate API Reference - OpenText

472 A c t u a t e A P I R e f e r e n c e

actuate.reportexplorer.Fi leCondi t ion

Example To store the matching condition of fcondition in a variable called match, use code similar to the following:

var match = fcondition.getMatch( );

setFieldSyntax void FileCondition.setField(string field)

Sets the field for the FileCondition.

Parameter fieldString. Possible values are "Name", "FileType", "Description", "PageCount", "Size", "TimeStamp", "Version", "VersionName", and "Owner".

Example To set the display field to FileType for fcondition, use code similar to the following:

fcondition.setField("FileType");

setMatchSyntax void FileCondition.setMatch(string match)

Sets the match value for the FileCondition.

Parameter matchString. A string for comparison.

Example To set the match value for fcondition to rptdesign, use code similar to the following:

fcondition.setField("rptdesign");

Page 491: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 473

actuate.reportexplorer.Fi leSearch

Class actuate.reportexplorer.FileSearchDescription Searches the contents of files according to one or more file conditions. FileSearch

represents a JavaScript version of com.actuate.schemas.FileSearch.

ConstructorSyntax actuate.reportexplorer.FileSearch( )

Constructs a new FileSearch object.

Function summaryTable 7-48 lists actuate.reportexplorer.FileSearch functions.

Table 7-48 actuate.reportexplorer.FileSearch functions

Function Condition

getAccessType( ) Gets the accessType value for this FileSearch

getCondition( ) Gets the condition value for this FileSearch

getConditionArray( ) Gets the ConditionArray value for this FileSearch

getCountLimit( ) Gets the countLimit value for this FileSearch

getDependentFileId( ) Gets the file id value for this FileSearch

getDependentFileName( ) Gets the file name value for this FileSearch

getFetchDirection( ) Gets the fetch direction for this FileSearch

getFetchHandle( ) Gets the fetchHandle value for this FileSearch

getFetchSize( ) Gets the fetchSize value for this FileSearch

getIncludeHiddenObject( ) Gets the includeHiddenObject value for this FileSearch

getOwner( ) Gets the owner’s user name for this FileSearch

getPrivilegeFilter( ) Gets the privilegeFilter value for this FileSearch

getRequiredFileId( ) Gets the requiredFileId for this FileSearch

getRequiredFileName( ) Gets the requiredFileName value for this FileSearch

setAccessType( ) Sets the accessType value for this FileSearch

setCondition( ) Sets the condition value for this FileSearch

setConditionArray( ) Sets the ConditionArray value for this FileSearch

(continues)

Page 492: Actuate API Reference - OpenText

474 A c t u a t e A P I R e f e r e n c e

actuate.reportexplorer.Fi leSearch

getAccessTypeSyntax string FileSearch.getAccessType( )

Gets the access type.

Returns String. Either "private" or "shared" according to whether the FileSearch has been shared or not.

Example To halt a script if a FileSearch is private, use code similar to the following:

if(fsearch.getAccessType( ) == "private"){ return;}

getConditionSyntax actuate.reportexplorer.FileCondition FileSearch.getCondition( )

Gets the condition from the FileSearch.

Returns actuate.reportexplorer.FileCondition object. A condition to apply in a search.

Example To halt a script if a FileSearch does not have a condition, use code similar to the following:

if(fsearch.getCondition( ) == null){ return;}

setCountLimit( ) Sets the maximum number of match results to display for this FileSearch

setDependentFileId( ) Sets the file id value for this FileSearch

setDependentFileName( ) Sets the file name value for this FileSearch

setFetchDirection( ) Sets the fetch direction for this FileSearch

setFetchHandle( ) Sets the fetchHandle value for this FileSearch

setFetchSize( ) Sets the fetchSize value for this FileSearch

setIncludeHiddenObject( ) Sets the includeHiddenObject value for this FileSearch

setOwner( ) Sets the owner value for this FileSearch

setPrivilegeFilter( ) Sets the PrivilegeFilter value for this FileSearch

setRequiredFileId( ) Sets the requiredFileId value for this FileSearch

setRequiredFileName( ) Sets the requiredFileName value for this FileSearch

Table 7-48 actuate.reportexplorer.FileSearch functions (continued)

Function Condition

Page 493: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 475

actuate.reportexplorer.Fi leSearch

getConditionArraySyntax actuate.reportexplorer.FileCondition[ ] FileSearch.getConditionArray( )

Gets the file condition array for this FileSearch.

Returns Array of actuate.reportexplorer.FileCondition objects. Multiple conditions to apply in a search.

Example To retrieve the array of file conditions from the FileSearch object fsearch, use code similar to the following:

var conditions = new Array( );conditions = fsearch.getConditionArray( );

getCountLimitSyntax integer FileSearch.getCountLimit( )

Gets the maximum number of match results to display set for this file search.

Returns Integer. The maximum number of match results to display. 0 indicates unlimited.

Example To retrieve the count limit from the FileSearch object fsearch, use code similar to the following:

var limit = fsearch.getCountLimit( );

getDependentFileIdSyntax string FileSearch.getDependentFileId( )

Gets the file ID of the FileSearch, identifying the file it is set to search.

Returns String. The file ID.

Example To retrieve the file Id from the FileSearch object fsearch, use code similar to the following:

var id = fsearch.getDependantFileId( );

getDependentFileNameSyntax string FileSearch.getDependentFileName( )

Gets the file name of the FileSearch.

Returns String. The file name.

Example To retrieve the file name from the FileSearch object fsearch, use code similar to the following:

var name = fsearch.getDependentFileName( );

Page 494: Actuate API Reference - OpenText

476 A c t u a t e A P I R e f e r e n c e

actuate.reportexplorer.Fi leSearch

getFetchDirectionSyntax boolean FileSearch.getFetchDirection( )

Gets the fetch direction of the FileSearch.

Returns Boolean. True indicates ascending order.

Example To switch the fetch direction for the FileSearch object fsearch, use code similar to the following:

fsearch.setFetchDirection(!fsearch.getFetchDirection( ));

getFetchHandleSyntax string FileSearch.getFetchHandle( )

Gets the fetch handle.

Returns String. The fetch handle.

Example To retrieve the fetch handle from the FileSearch object fsearch, use code similar to the following:

var handle = fsearch.getFetchHandle( );

getFetchSizeSyntax integer FileSearch.getFetchSize( )

Gets the fetch size.

Returns Integer. The fetch size.

Example To halt a script if a FileSearch has a fetch size of 0, use code similar to the following:

if(fsearch.getFetchSize( ) == 0){ return;}

getIncludeHiddenObjectSyntax boolean FileSearch.getIncludeHiddenObject( )

Gets the includeHiddenObject value for this FileSearch.

Returns Boolean. True includes hidden object.

Example To alert the user that hidden objects are enabled for a FileSearch, use code similar to the following:

if(fsearch.getIncludeHiddenObejct( )){alert("Hidden objects are enabled.");

}

Page 495: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 477

actuate.reportexplorer.Fi leSearch

getOwnerSyntax string FileSearch.getOwner( )

Gets the owner’s name.

Returns String. The owner’s user name.

Example To retrieve the owner of fsearch, use code similar to the following:

var owner = fsearch.getOwner( );

getPrivilegeFilterSyntax actuate.reportexplorer.PrivilegeFilter FileSearch.getPrivilegeFilter( )

Gets the privilege filter.

Returns actuate.reportexplorer.PrivilegeFilter object. A privilege filter.

Example To retrieve the privilege filter for fsearch, use code similar to the following:

var privileges = fsearch.getPrivilegeFilter( );

getRequiredFileIdSyntax integer FileSearch.getRequiredFileId( )

Gets the requiredFileId of FileSearch.

Returns Integer. A field ID.

Example To retrieve the required field ID assigned to fsearch, use code similar to the following:

var id = fsearch.getRequiredFileId( );

getRequiredFileNameSyntax string FileSearch.getRequiredFileName( )

Gets the requiredFileName name.

Returns String. A file name.

Example To retrieve the file name assigned to fsearch, use code similar to the following:

var id = fsearch.getRequiredFileName( );

setAccessTypeSyntax void FileSearch.setAccessType(string accessType)

Page 496: Actuate API Reference - OpenText

478 A c t u a t e A P I R e f e r e n c e

actuate.reportexplorer.Fi leSearch

Sets the access type.

Parameter accessTypeString. Either "private" or "shared" according to whether FileSearch has been shared or not.

Example To make a FileSearch fsearch private, use code similar to the following:

fsearch.setAccessType("private");

setConditionSyntax void FileSearch.setCondition(actuate.reportExplorer.FileCondition condition)

Sets a search condition for this FileSearch.

Parameter conditionactuate.reportexplorer.FileCondition object. A condition to apply to this search.

Example To clear FileSearch fsearch’s condition, use code similar to the following:

fsearch.setCondition(null);

setConditionArraySyntax void FileSearch.setConditionArray(actuate.reportExplorer.FileCondition[ ]

ConditionArray)

Sets multiple search conditions for this FileSearch.

Parameter ConditionArrayArray of actuate.reportexplorer.FileCondition objects. Conditions to apply to this search.

Example To clear FileSearch fsearch’s condition array, use code similar to the following:

fsearch.setConditionArray(null);

setCountLimitSyntax void FileSearch.setCountLimit(integer countlimit)

Sets the maximum number of match results to display.

Parameter countlimitInteger. The maximum number of match results to display. 0 indicates unlimited.

Example To set FileSearch fsearch to stop searching after finding 100 matches, use code similar to the following:

fsearch.setCountLimit(100);

Page 497: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 479

actuate.reportexplorer.Fi leSearch

setDependentFileIdSyntax void FileSearch.setDependentFileId(string dependentFileId)

Sets the file ID of the FileSearch.

Parameter dependentFileIdString. A file ID.

Example To set FileSearch fsearch’s File ID to current, use code similar to the following:

fsearch.setDependentFileId("current");

setDependentFileNameSyntax void FileSearch.setDependentFileName(string dependentFileName)

Sets the file name of FileSearch.

Parameter dependentFileNameString. A file name.

Example To set FileSearch fsearch’s file name to current, use code similar to the following:

fsearch.setDependentFileName("current");

setFetchDirectionSyntax void FileSearch.setFetchDirection(boolean fetchDirection)

Sets the fetch direction for this FileSearch.

Parameter fetchDirectionBoolean. True indicates ascending order.

Example To switch the fetch direction for the FileSearch object fsearch, use code similar to the following:

fsearch.setFetchDirection(!fsearch.getFetchDirection( ));

setFetchHandleSyntax void FileSearch.setFetchHandle(string fetchHandle)

Sets the fetch handle for FileSearch.

Parameter fetchHandleString. A fetch handle.

Example To set FileSearch fsearch’s fetch handle to ezsearch, use code similar to the following:

fsearch.setFetchHandle("ezsearch");

Page 498: Actuate API Reference - OpenText

480 A c t u a t e A P I R e f e r e n c e

actuate.reportexplorer.Fi leSearch

setFetchSizeSyntax void FileSearch.setFetchSize(integer fetchSize)

Sets the fetch size.

Parameter fetchSizeInteger. The fetch size.

Example To set FileSearch fsearch’s fetch size to 12, use code similar to the following:

fsearch.setFetchSize(12);

setIncludeHiddenObjectSyntax void FileSearch.setIncludeHiddenObject(boolean includeHiddenObject)

Sets the includeHiddenObject value for this FileSearch.

Parameter includeHiddenObjectBoolean. True includes hidden object.

Example To prohibit FileSearch fsearch from including hidden objects, use code similar to the following:

fsearch.setIncludeHiddenObject(false);

setOwnerSyntax void FileSearch.setOwner(string owner)

Sets the owner for this FileSearch.

Parameter ownerString. The owner’s user name.

Example To set the FileSearch fsearch owner to administrator, use code similar to the following:

fsearch.setOwner("administrator");

setPrivilegeFilterSyntax void FileSearch.setPrivilegeFilter(actuate.reportexplorer.PrivilegeFilter

privilegeFilter)

Sets the privilege filter.

Parameter privilegeFilteractuate.reportexplorer.PrivilegeFilter object. The privilege filter.

Example To assign the privilege filter pfilter to the FileSearch fsearch, use code similar to the following:

Page 499: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 481

actuate.reportexplorer.Fi leSearch

fsearch.setPrivilegeFilter(pfilter);

setRequiredFileIdSyntax void FileSearch.setRequiredFileId(string requiredFileId)

Sets the requiredFileId for this FileSearch.

Parameter requiredFileIdString. A file ID.

Example To set the FileSearch fsearch file ID to permanent, use code similar to the following:

fsearch.setRequiredFileId("permanent");

setRequiredFileNameSyntax void FileSearch.setRequiredFileName(string requiredFileName)

Sets the required file name.

Parameter requiredFileNameString. A file name.

Example To set the FileSearch fsearch file name to permanent, use code similar to the following:

fsearch.setRequiredFileName("permanent");

Page 500: Actuate API Reference - OpenText

482 A c t u a t e A P I R e f e r e n c e

actuate.reportexplorer.FolderI tems

Class actuate.reportexplorer.FolderItemsDescription A container for the contents of a folder. FolderItems represents a JavaScript

version of com.actuate.schemas.GetFolderItemsResponse.

ConstructorSyntax actuate.reportexplorer.FolderItems( )

Constructs a new FolderItems object.

Function summaryTable 7-49 lists actuate.reportexplorer.FolderItems functions.

getFetchHandleSyntax string FolderItems.getFetchHandle( )

Retrieves the fetch handle for this folder’s contents.

Returns String. The fetch handle.

Example To retrieve the fetch handle from fitems, use code similar to the following:

var handle = fitems.getFetchHandle( );

getItemListSyntax actuate.reportexplorer.File[ ] FolderItems.getItemList( )

Gets the list of file contents for the folder.

Returns Array of actuate.reportexplorer.File objects. A list of the folder contents.

Example To store the fitems item list in the files variable, use code similar to the following:

Table 7-49 actuate.reportexplorer.FolderItems functions

Function Description

getFetchHandle( ) Gets the fetchHandle value for GetFolderItemsResponse

getItemList( ) Gets the itemList value for GetFolderItemsResponse

getTotalCount( ) Gets the totalCount value for GetFolderItemsResponse

setFetchHandle( ) Sets the fetchHandle value for GetFolderItemsResponse

setItemList( ) Sets the itemList value for GetFolderItemsResponse

setTotalCount( ) Sets the totalCount value for GetFolderItemsResponse

Page 501: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 483

actuate.reportexplorer.FolderI tems

files = fitems.getItemList( );

getTotalCountSyntax string FolderItems.getTotalCount( )

Returns the maximum number of list items to retrieve from this folder.

Returns String. The total count.

Example To retrieve the total count from fitems, use code similar to the following:

var count = fitems.getTotalCount( );

setFetchHandleSyntax void FolderItems.setFetchHandle(string fetchHandle)

Sets the fetch handle value for this FolderItems object.

Parameter fetchHandleString. The fetch handle.

Example To set the FolderItems fitems fetch handle to dir, use code similar to the following:

fitems.setFetchHandle("dir");

setItemListSyntax void FolderItems.setItemList(ctuate.reportexplorer.File[ ] itemList)

Sets the list of contents for this folder.

Parameter itemListArray of actuate.reportexplorer.File objects. A list of the folder contents.

Example To assign the item list from fitems1 to fitems2, use code similar to the following:

fitems2.setItemList(fitems1.getItemList( ));

setTotalCountSyntax void FolderItems.setDataType(string totalCount)

Sets the maximum number of list items to retrieve from this folder.

Parameter totalCountString. The total count.

Example To reset the count total for fitems, use code similar to the following:

fitems.setTotalCount("0");

Page 502: Actuate API Reference - OpenText

484 A c t u a t e A P I R e f e r e n c e

actuate.reportexplorer.Pr iv i legeFi l ter

Class actuate.reportexplorer.PrivilegeFilterDescription The PrivilegeFilter class contains a set of user-identifying information and access

rights that are associated with identified users. PrivilegeFilter represents a JavaScript version of com.actuate.schemas.PrivilegeFilter.

ConstructorSyntax actuate.reportexplorer.PrivilegeFilter( )

Constructs a new PrivilegeFilter object.

Function summaryTable 7-50 lists actuate.reportexplorer.PrivilegeFilter functions.

Table 7-50 actuate.reportexplorer.PrivilegeFilter functions

Function Description

getAccessRights( ) Gets the accessRights value for this PrivilegeFilter

getGrantedRoleId( ) Gets the grantedRoleId value for this PrivilegeFilter

getGrantedRoleName( ) Gets the grantedRoleName value for this PrivilegeFilter

getGrantedUserId( ) Gets the grantedUserId value for this PrivilegeFilter

getGrantedUserName( ) Gets the grantedUserName value for this PrivilegeFilter

setAccessRights( ) Sets the accessRights value for this PrivilegeFilter

setGrantedRoleId( ) Sets the grantedRoleId value for this PrivilegeFilter

setGrantedRoleName( ) Sets the grantedRoleName value for this PrivilegeFilter

setGrantedUserId( ) Sets the grantedUserId value for this PrivilegeFilter

setGrantedUserName( ) Sets the grantedUserName value for this PrivilegeFilter

Page 503: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 485

actuate.reportexplorer.Priv i legeFi l ter

getAccessRightsSyntax string privilegeFilter.getAccessRights( )

Gets the repository access rights value for this PrivilegeFilter.

Returns String. Repository access rights.

Example To halt a script if the access rights of a PrivilegeFilter pfilter are null, use code similar to the following:

if(pfilter.getAccessRights( ) == null){ return;}

getGrantedRoleIdSyntax string PrivilegeFilter.getGrantedRoleId( )

Gets the grantedRoleId value for this PrivilegeFilter.

Returns String. A role ID.

Example To retrieve the granted role ID for a PrivilegeFilter pfilter, use code similar to the following:

var roleid = pfilter.getGrantedRoleId( );

getGrantedRoleNameSyntax string PrivilegeFilter.getGrantedRoleName( )

Gets the grantedRoleName value for this PrivilegeFilter.

Returns String. A role name.

Example To retrieve the granted role name for a PrivilegeFilter pfilter, use code similar to the following:

var rolename = pfilter.getGrantedRoleName( );

getGrantedUserIdSyntax string PrivilegeFilter.getGrantedUserId( )

Gets the grantedUserId value for this PrivilegeFilter.

Returns String. A user ID.

Example To retrieve the granted user ID for a PrivilegeFilter pfilter, use code similar to the following:

var userid = pfilter.getGrantedUserId( );

Page 504: Actuate API Reference - OpenText

486 A c t u a t e A P I R e f e r e n c e

actuate.reportexplorer.Pr iv i legeFi l ter

getGrantedUserNameSyntax string PrivilegeFilter.getGrantedUserName( )

Gets the grantedUserName value for this PrivilegeFilter.

Returns String. A user name.

Example To retrieve the granted user name for a PrivilegeFilter pfilter, use code similar to the following:

var username = pfilter.getGrantedUserName( );

setAccessRightsSyntax void PrivilegeFilter.setAccessRights(string accessRights)

Sets the repository access rights value for this PrivilegeFilter.

Parameter accessRightsString. The access rights.

Example To copy the set of access rights from PrivilegeFilter pfilter1 to PrivilegeFilter pfilter2, use code similar to the following:

pfilter2.setAccessRights(pfilter1.getAccessRights( ));

setGrantedRoleIdSyntax void PrivilegeFilter.setGrantedRoleId(string grantedRoleId)

Sets the grantedRoleId of the column for this PrivilegeFilter.

Parameter grantedRoleIdString. A role ID.

Example To set the granted role ID of the PrivilegeFilter pfilter to All, use code similar to the following:

pfilter.setGrantedRoleId("All");

setGrantedRoleNameSyntax void PrivilegeFilter.setGrantedRoleName(string grantedRoleName)

Sets the grantedRoleName value for this PrivilegeFilter.

Parameter grantedRoleNameString. A role name.

Example To set the granted role name of the PrivilegeFilter pfilter to Everyone, use code similar to the following:

pfilter.setGrantedRoleName("Everyone");

Page 505: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 487

actuate.reportexplorer.Priv i legeFi l ter

setGrantedUserIdSyntax void PrivilegeFilter.setGrantedUserId(string grantedUserId)

Sets the grantedUserId value for this PrivilegeFilter.

Parameter grantedUserIdString. A user ID.

Example To set the granted user ID of the PrivilegeFilter pfilter to administrator, use code similar to the following:

pfilter.setGrantedRoleId("Administrator");

setGrantedUserNameSyntax void PrivilegeFilter.setGrantedUserName(string grantedUserName)

Sets the grantedUserName value for this PrivilegeFilter.

Parameter grantedUserNameString. A user name.

Example To set the granted user name of the PrivilegeFilter pfilter to administrator, use code similar to the following:

pfilter.setGrantedRoleId("Administrator");

Page 506: Actuate API Reference - OpenText

488 A c t u a t e A P I R e f e r e n c e

actuate.RequestOptions

Class actuate.RequestOptionsDescription The request options that loginServlet requires to authenticate requests.

RequestOptions is used by other classes to provide authentication information. It also adds any customized options to the request URL.

ConstructorSyntax actuate.RequestOptions( actuate.RequestOptions requestOptions)

Constructs a new RequestOptions object.

Parameter requestOptionsactuate.RequestOptions object. Optional. Provides request option settings to copy into this RequestOptions object.

Function summaryTable 7-51 lists actuate.RequestOptions functions.

Table 7-51 actuate.RequestOptions functions

Function Description

getIServerUrl( ) Returns the BIRT iHub URL value

getLocale( ) Returns the current locale

getRepositoryType( ) Returns the repository type

getRESTAuthToken( ) Returns the current REST API authentication token

getVolume( ) Returns the volume

getVolumeProfile( ) Returns the volume profile

setCustomParameters( ) Appends custom parameters to the request URL

setIServerUrl( ) Sets the BIRT iHub URL value

setLocale( ) Sets the locale

setRepositoryType( ) Sets the repository type: enterprise or workgroup

setRESTAuthToken( ) Sets the authentication token to use when running JSAPI commands from a REST API application

setVolume( ) Sets the volume

setVolumeProfile( ) Sets the volume profile

Page 507: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 489

actuate.RequestOptions

getIServerUrlSyntax string RequestOptions.getIserverurl( )

Returns the BIRT iHub URL.

Returns String. The URL for BIRT iHub.

Example To retrieve the BIRT iHub URL from the RequestOptions object reqOps, use code similar to the following:

var iHubUrl = reqOps.getIServerUrl( );

getLocaleSyntax string RequestOptions.getLocale( )

Returns the current locale or null if no locale is set.

Returns String. The locale value; null for default.

Example This example pops up an alert box if the locale value is set to the default:

var locale = reqOps.getLocale( );if (locale == null){

alert("Locale value is default");}

getRepositoryTypeSyntax string RequestOptions.getRepositoryType( )

Returns the repository type: enterprise or workgroup.

Returns String. Valid repository type values are enterprise or workgroup.

Example To retrieve the repository type for the RequestOptions object reqOps, use code similar to the following:

var repositorytype = reqOps.getRepositoryType( );

getRESTAuthTokenSyntax string RequestOptions.getRESTAuthToken( )

Returns the current REST API authentication token. setRESTAuthToken( ) sets the token to the value retrieved from the REST API login resource.

Returns String. The value set by setRESTAuthToken( ) or null if not set.

Example To retrieve the REST API authentication token for the RequestOptions object reqOps, use code similar to the following:

Page 508: Actuate API Reference - OpenText

490 A c t u a t e A P I R e f e r e n c e

actuate.RequestOptions

var restAuthToken = reqOps.getRESTAuthToken( );if (restAuthToken == null){

alert("REST API authentication token is not available");}

getVolumeSyntax string RequestOptions.getVolume( )

Returns the volume.

Returns String. The name of the volume.

Example To retrieve the volume for the RequestOptions object reqOps, use code similar to the following:

var encyVol = reqOps.getVolume( );

getVolumeProfileSyntax string RequestOptions.getVolumeProfile( )

Returns the volume profile by name. Valid volume profile names are listed in the service’s WEB-INF\volumeProfile.xml file.

Returns String. The volume profile.

Example To retrieve the volume profile for the RequestOptions object reqOps, use code similar to the following:

var volProfile = reqOps.getVolumeProfile( );

setCustomParametersSyntax void RequestOptions.setCustomParameters(object parameters)

Returns a custom parameter in the request URL.

Parameter parametersObject. An associative array of name:value pairs for URL parameters.

Example To add "&myParam=myValue" in a request URL derived from RequestOptions object, use code similar to the following:

MyRequestOptions.setCustomParameters({myParam: "myValue"});

setIServerUrlSyntax void RequestOptions.setIServerUrl(string iServerUrl)

Sets the BIRT iHub URL.

Page 509: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 491

actuate.RequestOptions

Parameter IserverurlString. The BIRT iHub URL value.

Example This example sets the BIRT iHub URL for the reqOps RequestOptions object:

reqOps.setIserverUrl("http://127.0.0.1:8700");

setLocaleSyntax void RequestOptions.setLocale(string Locale)

Sets the locale.

Parameter LocaleString. Optional. The locale value. Null indicates the default locale.

Example This example resets the locale for the reqOps RequestOptions object to the default value provided by the actuate web service to which the JSAPI connects:reqOps.setLocale( );

This example resets the locale for the reqOps RequestOptions object to Spain using the Spanish locale code listed in <context root>\WEB-INF\localemap.xml:

reqOps.setLocale("es_ES");

setRepositoryTypeSyntax void RequestOptions.setRepositoryType(string repositoryType)

Sets the repository type, either enterprise or workgroup.

Parameter repositoryTypeString. Valid repository type values are enterprise or standalone, as designated by the Actuate web application service with which to connect. Use the following constants:

■ actuate.RequestOptions.REPOSITORY_ENCYCLOPEDIA

■ actuate.RequestOptions.REPOSITORY_STANDALONE

Example This example sets the repository to workgroup:

reqOps.setRepositoryType(actuate.RequestOptions.REPOSITORY_STANDALONE);

setRESTAuthTokenSyntax void RequestOptions.setRESTAuthToken(string restAuthToken)

Sets the authentication token to use when running JSAPI commands from a REST API application.

Page 510: Actuate API Reference - OpenText

492 A c t u a t e A P I R e f e r e n c e

actuate.RequestOptions

Parameter restAuthTokenString. The value provided by the REST API login resource.

Example This example sets the REST API authentication token, using the value, authId, provided by the REST API login resource and initializes the JSAPI:

function acLoad( ) {actuate.load( "viewer" );var iportalUrl = 'http://mymachine:8700/iportal';var reqOps = new actuate.RequestOptions( );reqOps.setRepositoryType(

actuate.RequestOptions.REPOSITORY_ENCYCLOPEDIA );reqOps.setIServerUrl( "http://mymachine:8000" );reqOps.setVolumeProfile( "Default Volume" );reqOps.setRESTAuthToken( authId );actuate.initialize( iportalUrl, reqOps, null, null,

JSAPILoaded, JSAPINotLoaded );}

setVolumeSyntax void RequestOptions.setVolume(string volume)

Sets the volume.

Parameter volumeString. The volume.

Example To set the volume to marcom if the RequestOptions object reqOps volume is null, use code similar to the following:

if( reqOps.getVolume( ) == null){reqOps.setVolume("marcom");

}

setVolumeProfileSyntax void RequestOptions.setVolumeProfile(string volumeProfile)

Sets the volume profile to use. Valid volume profile names are listed in the service’s WEB-INF\volumeProfile.xml file.

Parameter volumeProfileString. The volume profile.

Example To set the volume profile to myServer if the RequestOptions object reqOps volume profile is null, use code similar to the following:

if( reqOps.getVolume( ) == null){reqOps.setVolumeProvile("myServer");

}

Page 511: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 493

actuate.Viewer

Class actuate.ViewerDescription The actuate.Viewer class retrieves and displays Actuate BIRT report contents in

an HTML container. The actuate.Viewer class displays the report by page. The goto functions of this class change the current position and page displayed in the viewer.

ConstructorSyntax actuate.Viewer(object viewContainer)

actuate.Viewer(string viewContainerId)

Constructs a new viewer object. The container is an HTML object defined on the HTML page.

Parameters viewContainerObject. A document object that references the <div> element that holds the viewer.

viewContainerIdString. The value of the id parameter for the <div> element that holds the viewer.

Example To assign the viewer to display in a <div id='containerName' /> tag on the page, use the following constructor call:

var myViewer = new actuate.Viewer("containerName");

Function summaryTable 7-52 lists actuate.Viewer functions.

Table 7-52 actuate.Viewer functions

Function Description

disableIV( ) Disables Interactive Viewer features

downloadReport( ) Exports a report using the specified format

downloadResultSet( ) Exports data to an external file

enableIV( ) Enables Interactive Viewer features

getChart( ) Retrieves a chart by bookmark

getClientHeight( ) Gets the viewer’s height

getClientWidth( ) Gets the viewer’s width

getContentByBookmark( ) Gets the report content by bookmark

(continues)

Page 512: Actuate API Reference - OpenText

494 A c t u a t e A P I R e f e r e n c e

actuate.Viewer

getContentByPageRange( ) Gets the report content by page range

getContentMargin( ) Gets the margin dimensions of the content in pixels

getCurrentPageContent( ) Returns the report content displayed in the viewer

getCurrentPageNum( ) Returns the current page number

getCustomViz( ) Retrieves a Custom Visualization item by bookmark

getDataItem( ) Retrieves a data item by bookmark

getFlashObject( ) Retrieves a Flash object by bookmark

getGadget( ) Retrieves a gadget by bookmark

getHeight( ) Returns the viewer height setting

getLabel( ) Retrieves a label by bookmark

getReportletBookmark( ) Returns the bookmark of a Reportlet displayed in the viewer

getReportName( ) Returns the report file displayed in the viewer

getTable( ) Retrieves a table by bookmark

getText( ) Retrieves a text element by bookmark

getTotalPageCount( ) Returns the total number of pages

getUIConfig( ) Gets the UIConfig object assigned to the viewer

getUIOptions( ) Returns the UIOptions object

getViewer( ) Returns a viewer object containing the given bookmarked element

getWidth( ) Returns the viewer width setting

gotoBookmark( ) Goes to the position in the report specified by the bookmark

gotoPage( ) Goes to the specified page

isInteractive( ) Returns whether interactive viewing features are enabled

saveReportDesign( ) Saves a report design to the repository

saveReportDocument( ) Saves a report document to the repository

setContentMarg( ) Sets the viewer content margin

Table 7-52 actuate.Viewer functions (continued)

Function Description

Page 513: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 495

actuate.Viewer

disableIVSyntax void Viewer.disableIV(function callback)

setFocus( ) Sets the focus element of the viewer

setHeight( ) Sets the viewer height

setParameters( ) Sets the parameters to run a report using a list of literal string pairs

setParameterValues( ) Sets the parameters to run a report using a generated object

setReportDocument( ) Sets the report document to render within this Viewer

setReportletBookmark( ) Sets bookmark name for a Reportlet

setReportName( ) Sets the report file to render within this Viewer

setService( ) Sets the target service URL

setSize( ) Sets the size of the viewer

setSupportSVG( ) Sets the Scalable Vector Graphic support flag to enable Scalable Vector Graphics content

setUIOptions( ) Sets UIOptions using a UIOptions object

setViewingMode( ) Sets the dashboard viewing mode

setWidth( ) Sets the width of the viewer

showDownloadReportDialog( ) Enables the export report dialog window

showDownloadResultSetDialog( ) Enables the download data dialog window

showFacebookCommentPanel( ) Shows the Facebook comments panel

showParameterPanel( ) Shows the parameter panel

showPrintDialog( ) Enables the print dialog window

showTocPanel( ) Shows the table of contents panel

submit( ) Submits all the asynchronous operations that the user has requested on this Viewer and renders the viewer component on the page

useDefaultIV Sets the default user interface for the viewer

Table 7-52 actuate.Viewer functions (continued)

Function Description

Page 514: Actuate API Reference - OpenText

496 A c t u a t e A P I R e f e r e n c e

actuate.Viewer

Disables the Interactive Viewer features of this viewer object. This is an asynchronous setting committed by submit( ).

Parameter callbackFunction. The callback function to call after the Interactive Viewer is disabled.

Example To disable the Interactive Viewer option for myViewer, use code similar to the following:

myViewer.disableIV(function alertUser( ){alert("IV disabled");});

downloadReportSyntax void Viewer.downloadReport(string format, string pages,

actuate.viewer.RenderOptions renderoption)

Exports the report with a specified format. The downloadReport function does not return any object. The report is exported to the client side. Then the browser opens a download window for the user to specify a location for the report.

Parameters formatString. The format in which to export the report. Valid values and their corresponding formats are:

■ doc: Word

■ docx: Word 2007

■ html: HTML-encoded web page

■ ppt: PowerPoint

■ pptx: PowerPoint 2007

■ pdf: Adobe PDF

■ ps: PostScript

■ xls: Excel

■ xlsx: Excel 2007

pagesString. The pages to retrieve. Indicate page ranges by using the first page number of the range and the last page number separated by a dash. To use more than one value, separate individual page numbers or page ranges with commas.

renderoptionactuate.viewer.RenderOptions object. Optional. Sets the rendering options for the download, which currently only applies to multisheet xls format reports.

Example To download the first five pages of the report in the viewer, use the following code:

viewer.downloadReport("pdf", "1-5", null);

Page 515: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 497

actuate.Viewer

downloadResultSetSyntax void Viewer.downloadResultSet(actuate.data.Request request, function callback)

Gets all the data from the report as specified by the request. This function makes an AJAX call to the server for the data that is not in the current page. Write a callback function to process the result set. The callback must take an actuate.data.ResultSet object as an argument.

Parameters request actuate.data.Request object. The request to generate the result set.

callbackFunction. The callback function to call after retrieving the results. The callback function must take an actuate.data.ResultSet object as an argument.

Example This example creates an actuate.data.ResultSet object from the report in myViewer as specified by myRequest and passes it to a callback function:

myViewer.downloadResultSet(myRequest, callback);

enableIVSyntax void Viewer.enableIV(function callback)

Enables interactive viewing features for this Viewer, which enables the selection and modification of report content. This function must be used in the callback of viewer.submit( ) as shown in the example below.

Parameter callbackFunction. The callback function to call after enabling the Interactive Viewer features.

Example This function must be used in the callback of viewer.submit( ) as shown in the following example:

function runInteractive() {myviewer.setReportName("/Public/Applications/BIRT Sample App

/Report Designs/Customer Order History.rptdesign");myviewer.submit(function() {myviewer.enableIV(callback);});

}

getChartSyntax actuate.report.Chart Viewer.getChart(string bookmark)

Returns an instance of the chart referenced by a bookmark.

Parameter bookmarkString. The bookmark name.

Returns actuate.report.Chart object.

Page 516: Actuate API Reference - OpenText

498 A c t u a t e A P I R e f e r e n c e

actuate.Viewer

Example This example returns the chart with the bookmark ChartBookmark:

function getMyChartByBookmark(myReport) {var bviewer = myReport.getViewer("Chart");var bpagecontents = bviewer.getCurrentPageContent( );return bpagecontents.getChart("ChartBookmark");

}

getClientHeightSyntax integer Viewer.getClientHeight( )

Gets the browser window’s height.

Returns Integer. Height in pixels.

Example To reset the viewer height to 20 pixels less than the browser window if it is larger than the browser window, use code similar to the following:

if(myViewer.getClientHeight( ) < myViewer.getHeight( )){myViewer.setHeight(myViewer.getClientHeight( ) - 20);

}

getClientWidthSyntax integer Viewer.getClientWidth( )

Gets the browser window’s width.

Returns Integer. Width in pixels.

Example To reset the viewer width to 20 pixels less than the browser window if it is larger than the browser window, use code similar to the following:

if(myViewer.getClientWidth( ) < myViewer.getWidth( )){myViewer.setWidth(myViewer.getClientWidth( ) - 20);

}

getContentByBookmarkSyntax void Viewer.getContentByBookmark(string bookmark, string format,

function callback)

Gets the report content by bookmark and passes the content as data to a callback.

Parameters bookmarkString. The bookmark of a report element to retrieve.

formatString. The output format, which is either html or xhtml.

Page 517: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 499

actuate.Viewer

callbackFunction. Callback to be called once the operation is finished. The callback must take actuate.data.ReportContent object as an argument.

Example To retrieve the content with the bookmark FirstChart as html, use code similar to the following:

myViewer.getContentByBookmark("FirstChart", "html", processChart);

getContentByPageRangeSyntax void Viewer.getContentByPageRange(string PageRange, string format,

function callback)

Gets the report content by page range and passes the content as data to a callback.

Parameters PageRangeString. Page range to retrieve the report content, separated by a dash.

formatString. The output format, which is either html or xhtml.

callbackFunction. Callback to be called once the operation is finished. The callback must take actuate.data.ReportContent object as an argument.

Example To retrieve the content from pages 3 through 5 as html, use code similar to the following:

myViewer.getContentByPageRange("3-5", "html", processPages);

getContentMarginSyntax integer | object Viewer.getContentMargin( )

Gets the viewer content margin.

Returns Integer or Object. An integer indicates the same margin on all sides, in pixels. The object contains the pixel values for the top, bottom, left, and right margins of the viewer in an array. For example, a 25-pixel top content margin and no margin in the other directions would be the object array {top:25, left:0, right:0, bottom:0}.

Example To set the margin of the viewer newViewer to match the margin of myViewer, use code similar to the following:

newViewer.setContentMargin(myViewer.getContentMargin( ));

getCurrentPageContentSyntax actuate.viewer.Content Viewer.getCurrentPageContent( )

Page 518: Actuate API Reference - OpenText

500 A c t u a t e A P I R e f e r e n c e

actuate.Viewer

Returns the report content displayed in the viewer. This function is the entry point for retrieving the report elements from this viewer object.

Returns actuate.viewer.PageContent object.

Example Use this function to access the bookmarks for specific elements in the page content. For example, to access the table "mytable" on the page loaded in the myViewer viewer object, use the following code:

var element = myViewer.getCurrentPageContent( ).getTableByBookmark("mytable");

getCurrentPageNumSyntax integer Viewer.getCurrentPageNum( )

Returns the page number for the page currently being displayed.

Returns Integer. The current page number.

Example This function is useful to move to another page relative to the current page. To go to the next page in a document, use the following code:

viewer.gotoPage(viewer.getCurrentPageNum( ) + 1);

getCustomVizSyntax void getCustomViz( String bookmark )

Returns an instance of the Custom Visualization object referenced by a bookmark.

Parameter String. The bookmark name.

Returns Returns an instance of a Custom Visualization object.

Example To get a new customViz object with a bookmark, use code similar to the following:

var myViewer = new actuate.Viewer("container");var customViz = myViewer.getCustomViz("cv-bookmark");

getDataItemSyntax actuate.report.DataItem Viewer.getDataItem(string bookmark)

Returns an instance of report data referenced by a bookmark.

Parameter bookmarkString. The bookmark name.

Returns actuate.report.DataItem object.

Example To get the report data with the bookmark FirstDataItem and store it in the variable myDataItem, use code similar to the following:

Page 519: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 501

actuate.Viewer

var myDataItem = myViewer.getDataItem("FirstDataItem");

getFlashObjectSyntax actuate.report.FlashObject Viewer.getFlashObject(string bookmark)

Returns an instance of the Flash object referenced by a bookmark.

Parameter bookmarkString. The bookmark name.

Returns actuate.report.FlashObject object.

Example To get the Flash object with the bookmark FirstFlashObject and store it in the variable myFlashObject, use code similar to the following:

var myFlashObject = myViewer.getFlashObject("FirstFlashObject");

getGadgetSyntax actuate.report.Gadget Viewer.getGadget(string bookmark)

Returns an instance of the gadget referenced by a bookmark.

Parameter bookmarkString. The bookmark name.

Returns actuate.report.Gadget object.

Example To get the gadget with the bookmark FirstGadget and store it in the variable myGadget, use code similar to the following:

var myGadget = myViewer.getGadget("FirstGadget");

getHeightSyntax string Viewer.getHeight( )

Returns the height value of the viewer.

Returns String.

Example This example decreases the viewer’s height by 10:

var height = myViewer.getHeight( );myViewer.setHeight(height - 10);

getLabelSyntax actuate.report.Label Viewer.getLabel(string bookmark)

Returns an instance of the label referenced by a bookmark.

Page 520: Actuate API Reference - OpenText

502 A c t u a t e A P I R e f e r e n c e

actuate.Viewer

Parameter bookmarkString. The bookmark name.

Returns actuate.report.Label object.

Example To get the label with the bookmark FirstLabel and store it in the variable myLabel, use code similar to the following:

var myLabel = myViewer.getLabel("FirstLabel");

getReportletBookmarkSyntax string Viewer.getReportletBookmark( )

Returns the bookmark of the current report page or element.

Returns String. Bookmark.

Example This example displays the bookmark of the current report page in an alert box:

alert ("Report bookmark is " + myViewer.getReportletBookmark( ));

getReportNameSyntax string Viewer.getReportName( )

Returns the name of the report file, either a report design file or report document file, that is currently displayed in this Viewer.

Returns String.

Example This example displays the currently displayed report file name in an alert box:

alert ("Currently displaying " + myViewer.getReportName( ));

getTableSyntax actuate.report.Table Viewer.getTable(string bookmark)

Returns an instance of the table referenced by a bookmark.

Parameter bookmarkString. The bookmark name.

Returns actuate.report.Table object.

Example To get the table with the bookmark FirstTable and store it in the variable myTable, use code similar to the following:

var myTable = myViewer.getTable("FirstTable");

Page 521: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 503

actuate.Viewer

getTextSyntax actuate.report.Text Viewer.getText(string bookmark)

Returns an instance of the Text object referenced by a bookmark.

Parameter bookmarkString. The bookmark name.

Returns actuate.report.Text object.

Example To get the Text object with the bookmark Title and store it in the variable myText, use code similar to the following:

var myText = myViewer.getText("Title");

getTotalPageCountSyntax integer Viewer.getTotalPageCount( )

Returns the total number of pages in the report being viewed.

Returns Integer.

Example This function is useful to move to the last page of a document. To go to the last page in a document, use the following code:

viewer.gotoPage(viewer.getTotalPageCount( ));

getUIConfigSyntax actuate.viewer.UIConfig Viewer.getUIConfig( )

Returns the current UI configuration.

Returns actuate.viewer.UIConfig object. This function returns null when no UIConfig object is set.

Example To retrieve and store the content pane from the viewer, use the following code:

var contentpane = viewer.getUIConfig( ).getContentPane( );

getUIOptionsSyntax actuate.viewer.UIOptions Viewer.getUIOptions( )

Returns the UIOptions set in this viewer object.

Returns actuate.viewer.UIOptions object. This function returns null when no UIOptions object is set.

Example To retrieve and store the uiOptions for the viewer, use the following code:

var options = myViewer.getUIOptions( );

Page 522: Actuate API Reference - OpenText

504 A c t u a t e A P I R e f e r e n c e

actuate.Viewer

getViewerSyntax actuate.Viewer Viewer.getViewer(string bookmark)

actuate.Viewer Viewer.getViewer(object elementID)

Returns a viewer object containing the report element that is associated with a bookmark or contained in an HTML element.

Parameters bookmarkString. The bookmark of the report element to view.

elementIDObject. An HTML element that contains the viewer.

Returns actuate.Viewer object or null if the viewer is not found.

Example This example uses getViewer( ) to retrieve a report element and return the bookmark of the chart in that report:

function chartBookmark(myReport){var bviewer = myReport.getViewer("Chart");var bpagecontents = bviewer.getCurrentPageContent( );return bpagecontents.getChartByBookmark("ChartBookmark");

}

getWidthSyntax string Viewer.getWidth( )

Returns the width value of the viewer.

Returns String.

Example This example decreases the viewer’s width by 10:

var width = myViewer.getWidth( );myViewer.setWidth(width - 10);

gotoBookmarkSyntax void Viewer.gotoBookmark(string bookmark)

Goes to the page position by the specified bookmark. The viewer displays to the first page when the bookmark is not found.

Parameter bookmarkString. The bookmark of a report element.

Example To move the viewer to the page position specified by the value of the 'bookmark' parameter, use this code:

viewer.gotoBookmark(document.getElementById('bookmark').value);

Page 523: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 505

actuate.Viewer

gotoPageSyntax void Viewer.gotoPage(integer pageNumber)

Goes to the specified page. The viewer throws an exception when the page is not found.

Parameter pageNumberInteger. A page number in the report.

Example To go to the first page of a report, use the following code:

viewer.gotoPage(1);

isInteractiveSyntax boolean Viewer.isInteractive( )

Returns the interactive viewing status of the viewer. Enables or disables the interactive viewing features with actuate.Viewer.enableIV( ).

Returns Boolean. True when interactive viewing features are enabled.

Example This example displays an alert box with the interactive status of the viewer:

alert("Interactivity of this viewer is set to " + myViewer.isInteractive( ));

saveReportDesignSyntax void Viewer.saveReportDesign(string filename, function callback)

Saves the current viewer content as a report design. The viewer must enable interactive viewing with enableIV( ) prior to saving a report design.

Parameters filenameString. Sets the name of the saved file. The current file name is used if null. The file name must be a path relative to the viewer’s repository.

callbackFunction. Optional. The function to execute after the asynchronous call processing is done. The callback takes the current actuate.Viewer object as an input parameter.

Example To save the content of the viewer as the report design called NewDesign, use the following code:

myViewer.saveReportDesign("NewDesign");

saveReportDocumentSyntax void Viewer.saveReportDocument(string filename, function callback)

Page 524: Actuate API Reference - OpenText

506 A c t u a t e A P I R e f e r e n c e

actuate.Viewer

Saves the current viewer content as a report document. The viewer must enable interactive viewing with enableIV( ) prior to saving a report design.

Parameters filenameString. Sets the name of the saved file. The current file name is used if null. The file name must be a path relative to the viewer’s repository.

callbackFunction. Optional. The function to execute after the asynchronous call processing is done. The callback takes the current actuate.Viewer object as an input parameter.

Example To save the content of the viewer as the report document called NewDocument, use the following code:

myViewer.saveReportDocument("NewDocument");

setContentMargSyntax void Viewer.setContentMargin(string[ ] margin)

void Viewer.setContentMargin(int margin)

Sets the viewer content margin.

Parameter marginArray of strings or integer. Each member of the array is the margin for the top, left, right, and bottom internal margins for the viewer. An integer sets all margins to that value.

Example To set the internal margin of the viewer to a 10-pixel buffer, use the following code:

myViewer.setContentMargin(10);

setFocusSyntax void setFocus(boolean focus)

Sets the focus for the viewer.

Parameter focusBoolean. The viewer’s context menu is in focus when this parameter is set to true.

Example This example blurs the context menu for the viewer:

viewer.setFocus(false);

setHeightSyntax void Viewer.setHeight(integer height)

Page 525: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 507

actuate.Viewer

Sets the viewer height.

Parameter heightInteger. The height in pixels.

Example To set the height of the viewer to 600 pixels, use the following code:

viewer.setHeight(600);

setParametersSyntax void Viewer.setParameters(string[ ] params)

Sets parameters for executing report using literal string pairs.

Parameter paramsArray of strings. Each string in the array is constructed of name:"value" pairs. Use a literal list, such as {param1:"value1", param2:"value2", … }.

Example To set the value of a parameter, city, to the value, New York, use the following object literal:

viewer.setParameters({ city:"New York"});

setParameterValuesSyntax void Viewer.setParameterValues(actuate.parameter.ParameterValue[ ]

parameters)

Sets parameter values for executing a report using ParameterValue objects.

Parameter parametersArray of actuate.parameter.ParameterValue objects. An array of this kind is returned by actuate.Parameter.downloadParameterValues( ) and is the recommended function for creating the parameters input.

Example To set parameter values for a report to the values in the pvs array, use this code:

viewer.setParameterValues(pvs);

setReportDocumentSyntax void Viewer.setReportName(string reportFile, string connectionHandle)

Sets the report document to render in this Viewer.

Parameters reportFileString. The report file path for a report document file. To set the version for the report, add a semicolon and the version number. For example, “/Public/Applications/BIRT Sample App/Report Designs/Customer Sales Dashboard.rptdocument;1” retrieves version 1 of Customer Sales Dashboard.rptdocument.

Page 526: Actuate API Reference - OpenText

508 A c t u a t e A P I R e f e r e n c e

actuate.Viewer

connectionHandleString. Optional. The unique identifier generated by iHub for a temporary report.

Example To open the Top Sales Performers report, set the report by name and then call submit( ), as shown in the following example:

viewer.setReportDocument("/Public/Applications/BIRT Sample App/Report Designs/Top Sales Performers.rptdocument");

viewer.submit( );

setReportletBookmarkSyntax void Viewer.setReportletBookmark(string bookmark)

Sets the bookmark for the Reportlet rendered.

Parameter bookmarkString. The bookmark ID used to render the Reportlet. Viewer requires a bookmark to render a Reportlet. Viewer does not support automatically generated generic bookmarks from a BIRT report.

Example To open the Top_5_Customers Reportlet of the Customer Sales Dashboard, set the Reportlet bookmark by name and then call viewer.submit, as shown in the following example:

viewer.setReportName("/Public/Applications/BIRT Sample App/Report Designs/Customer Dashboard.rptdocument");

viewer.setReportletBookmark("Top_5_Customers");viewer.submit( );

setReportNameSyntax void Viewer.setReportName(string reportFile)

Sets the report file, either a report design or report document, to render in this Viewer.

Parameter reportFileString. The report file path for a report design file or report document file. To set the version for the report, add a semicolon and the version number. For example, “/Public/Applications/BIRT Sample App/Report Designs/Customer Sales Dashboard.rptdesign;1” retrieves version 1 of Customer Sales Dashboard.rptdesign.

Example To open the Top Sales Performers report, set the report by name and then call submit( ), as shown in the following example:

viewer.setReportName("/Public/Applications/BIRT Sample App/Report Designs/Top Sales Performers.rptdesign");

viewer.submit( );

Page 527: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 509

actuate.Viewer

setServiceSyntax void Viewer.setService(string iPortalURL, actuate.RequestOptions

requestOptions)

Sets the target service URL to which this Viewer links. When the service URL is not set, this Viewer links to the default service URL, which is set on the actuate object.

Parameters iPortalURLString. The target Actuate web application URL, either a Java Component or iHub Visualization Platform client.

requestOptionsactuate.RequestOptions object. Optional. requestOptions defines URL parameters to send with the authentication request, such as the iHub URL, volume, or repository type. The URL can also include custom parameters.

Example This example sets the URL for the Actuate iPortal web application service:

myViewer.setService("http://127.0.0.1:8700/iportal", myRequestOptions);

setSizeSyntax void Viewer.setSize(integer width, integer height)

Resizes the viewer’s width and height.

Parameters widthInteger. The new width is specified in pixels.

heightInteger. The new height is specified in pixels.

Example To set the viewer’s size to 300 pixels by 300 pixels, use code similar to the following:

myViewer.setSize(300, 300);

setSupportSVGSyntax void Viewer.setSupportSVG(boolean usvgFlag)

Controls Scalable Vector Graphics support for the viewer.

Parameter svgFlagBoolean. True enables Scalable Vector Graphic support.

Example To disable Scalable Vector Graphic support for the myViewer viewer, use code similar to the following:

myViewer.setSupportSVG(false);

Page 528: Actuate API Reference - OpenText

510 A c t u a t e A P I R e f e r e n c e

actuate.Viewer

setUIOptionsSyntax void Viewer.setUIOptions(actuate.viewer.UIOptions options)

Sets the UI options for the viewer using an actuate.viewer.UIOptions object.

Parameter optionsactuate.viewer.UIOptions object. Enables or disables various controls and features.

Example To hide the toolbar for the viewer, use the following code:

uioptions.enableToolBar(false);viewer.setUIOptions(uioptions);viewer.submit( );

setViewingModeSyntax void Viewer.setViewingMode(string viewer)

Sets the dashboard viewing mode.

Parameter vieweractuate.Constant.ViewingMode constant. Legal values are NON_DASHBOARD, DASHBOARD_NORMAL, and DASHBOARD_MAX.

Example To display content without dashboard features, use the following code:

viewer.setViewingMode(actuate.Constant.ViewingMode.NON_DASHBOARD);

setWidthSyntax void Viewer.setWidth(string width)

Sets the viewer width.

Parameter widthString.

Example To set the width of the viewer to 800 pixels, use the following code:

viewer.setWidth(800);

showDownloadReportDialogSyntax void Viewer.showDownloadReportDialog( )

Displays the export report dialog window.

Example Use this code to display the report dialog window:

myViewer.showDownloadReportDialog( );

Page 529: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 511

actuate.Viewer

showDownloadResultSetDialogSyntax void Viewer.showDownloadResultSetDialog( )

Displays the export data dialog window.

Example Use this code to display the result set download dialog window:

viewer.showDownloadResultSetDialog( );

showFacebookCommentPanelSyntax void Viewer.showFacebookCommentPanel( )

Displays the Facebook comments panel.

Example Use this code to display the Facebook comments panel:

viewer.showFacebookCommentPanel( );

showParameterPanelSyntax void Viewer.showParameterPanel( )

Displays the parameter panel.

Example Use this code to display the parameter panel:

viewer.showParameterPanel( );

showPrintDialogSyntax void Viewer.showPrintDialog( )

Displays the print dialog window.

Example Use this code to display the print dialog window:

viewer.showPrintDialog( );

showTocPanelSyntax void Viewer.showTocPanel( )

Displays the table of contents panel.

Example Use this code to display the table of contents panel:

viewer.showTocPanel( );

Page 530: Actuate API Reference - OpenText

512 A c t u a t e A P I R e f e r e n c e

actuate.Viewer

submitSyntax void Viewer.submit(function callback, boolean rerun)

Updates and reloads the viewer after submitting requests for the viewer. The submit( ) function triggers an AJAX request for all asynchronous operations. When the server finishes the processing, it returns a response and the results are rendered on the page in the viewer container. Calling submit( ) when a previous submit( ) is pending throws an exception.

Parameters callbackFunction. Optional. The function to execute after the asynchronous call processing is done.

rerunBoolean. Optional. Indicates whether to re-run the report design when refreshing. Default to true.

Example To open the Top Sales Performers report, set the report by name and then call submit( ), as shown in the following example:

viewer.setReportName("/Public/Applications/BIRT Sample App/Report Designs/Top Sales Performers.rptdesign");

viewer.submit( );

useDefaultIVSyntax void useDefaultIV( Boolean )

Sets the default user interface for the viewer.

Parameter Boolean. True defines the Interactive Viewer interface as a default interface. False disables the Interactive Viewer user interface from showing up.

Returns Void

Example If this is set to false, you must implement your own user interface:

var ui = new actuate.viewer.UIOptions( );//Don't show any IV UI interactionsui.useDefaultIVUI( false ); viewer.setUIOptions( ui );

Page 531: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 513

actuate.viewer.BrowserPanel

Class actuate.viewer.BrowserPanelDescription A container for a browser content panel in a viewer. This class defines the default

scroll bars for a content panel.

ConstructorSyntax actuate.Viewer.BrowserPanel( )

Constructs a new BrowserPanel object for the parent viewer. The browser panel has vertical and horizontal scroll bars for navigation.

Page 532: Actuate API Reference - OpenText

514 A c t u a t e A P I R e f e r e n c e

actuate.viewer.EventConstants

Class actuate.viewer.EventConstantsDescription Defines the event constants supported by this API. Table 7-53 lists the viewer

event constants.

Table 7-53 Actuate JavaScript API viewer event constants

Event Description

ON_CONTENT_CHANGED Calls a registered event handler when the report content is reloaded.The event handler must take the viewer instance that fired the event as an input argument.

ON_CONTENT_SELECTED Calls a registered event handler when the relevant part of the report content is selected. Supported selected contents are:■ Column■ Table■ Data■ Label■ TextWhen the content is selected, the corresponding object is passed into user’s event handler function. For example, if the table area is selected in a viewer, actuate.Viewer.Table is passed into the event handler.The event handler must take the viewer instance that fired the event and an instance of actuate.viewer.SelectedContent as input arguments.

ON_DIALOG_OK This event fires when the user clicks the OK button in a dialog.The event handler must take the viewer object that fired the event and a dialog.AdvancedFilterDialog object as input parameters.

ON_EXCEPTION An exception event is broadcast when an error occurs.The event handler must take the viewer instance that fired the event and an instance of actuate.viewer.Exception as input arguments.

ON_SESSION_TIMEOUT Calls a registered event handler when the session expires.The event handler must take the viewer instance that fired the event as an input argument.

Page 533: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 515

actuate.viewer.EventConstants

ON_CONTENT_DRAG_SELECTION

This event occurs when a user drags a cell from a table.

ON_CONTENT_DROP_SELECTION

This event fires when a user drops a cell into a table.

Table 7-53 Actuate JavaScript API viewer event constants

Event Description

Page 534: Actuate API Reference - OpenText

516 A c t u a t e A P I R e f e r e n c e

actuate.viewer.PageContent

Class actuate.viewer.PageContentDescription A container for the content of a report document file. actuate.Viewer.PageContent

contains a comprehensive list of report elements, such as tables, charts, labels, and data items.

ConstructorThe PageContent object is constructed by actuate.viewer.getCurrentPageContent( ).

Function summaryTable 7-54 lists actuate.viewer.PageContent functions.

getChartByBookmarkSyntax actuate.report.Chart PageContent.getChartByBookmark(string bookmark)

Returns the chart element specified by the given bookmark.

Parameter bookmarkString. A bookmark to identify a chart element. When the bookmark value is not given, this function returns the first chart element found in the report content.

Table 7-54 actuate.viewer.PageContent functions

Function Description

getChartByBookmark( ) Returns a chart element specified by the given bookmark

getDataItemByBookmark( ) Returns a data element specified by the given bookmark

getFlashObjectByBookmark( ) Returns a Flash object specified by the given bookmark

getGadgetByBookmark( ) Returns a Flash gadget specified by the given bookmark

getLabelByBookmark( ) Returns a label element specified by the given bookmark

getTableByBookmark( ) Returns a table element specified by the given bookmark

getTextByBookmark( ) Returns a text element specified by the given bookmark

getViewerId( ) Returns the viewer ID

Page 535: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 517

actuate.viewer.PageContent

Returns actuate.report.Chart object.

Example This example retrieves the Chart object and changes the chart title:

this.onclick = function(event){var bviewer = this.getViewer( );var bpagecontents = bviewer.getCurrentPageContent( );var bchart = bpagecontents.getChartByBookmark("ChartBookmark");bchart.setChartTitle("Orders By Country (Classic Cars)");bchart.submit( );

}

getDataItemByBookmarkSyntax actuate.report.DataItem PageContent.getDataItemByBookmark(string bookmark)

Returns the data element specified by the given bookmark.

Parameter bookmarkString. A bookmark to identify a data element. When the bookmark value is not given, the first data element found in the report content is returned.

Returns actuate.report.DataItem object.

Example Use this function to access the bookmarks for specific elements in the page content. For example, to access the data element "myDataItem" on the page loaded in the myViewer viewer object, use the following code:

var element = myViewer.getCurrentPageContent( ).getDataItemByBookmark("myDataItem");

getFlashObjectByBookmarkSyntax actuate.report.FlashObject PageContent.getFlashObjectByBookmark(string

bookmark)

Returns the Flash object specified by the given bookmark.

Parameter bookmarkString. A bookmark to identify a Flash object. When the bookmark value is not given, the first data element found in the report content is returned.

Returns actuate.report.FlashObject object.

Example Use this function to access the bookmarks for specific elements in the page content. For example, to access the Flash object "myFlashObj" on the page loaded in the myViewer viewer object, use the following code:

var element = myViewer.getCurrentPageContent( ).getFlashObjectByBookmark("myFlashObj");

Page 536: Actuate API Reference - OpenText

518 A c t u a t e A P I R e f e r e n c e

actuate.viewer.PageContent

getGadgetByBookmarkSyntax actuate.report.Gadget PageContent.getGadgetByBookmark(string bookmark)

Returns the gadget element specified by the given bookmark.

Parameter bookmarkString. A bookmark to identify a gadget element. When the bookmark value is not given, the first data element found in the report content is returned.

Returns actuate.report.Gadget object.

Example Use this function to access the bookmarks for specific elements in the page content. For example, to access the gadget "myGadget" on the page loaded in the myViewer viewer object, use the following code:

var element = myViewer.getCurrentPageContent( ).getGadgetByBookmark("myGadget");

getLabelByBookmarkSyntax actuate.report.Label PageContent.getLabelByBookmark(string bookmark)

Returns the label element specified by the given bookmark.

Parameter bookmarkString. A bookmark to identify a label element. When the bookmark value is not given, the first label element found in the report content is returned.

Returns actuate.report.Label object.

Example Use this function to access the bookmarks for specific elements in the page content. For example, to access the label "LabelOne" on the page loaded in the myViewer viewer object, use the following code:

var element = myViewer.getCurrentPageContent( ).getLabelByBookmark("LabelOne");

getTableByBookmarkSyntax actuate.report.Table PageContent.getTableByBookmark(string bookmark)

Returns the table element specified by the given bookmark.

Parameter bookmarkString. A bookmark to identify a table element. When the bookmark value is not given, the first table element found in the report content is returned.

Returns actuate.report.Table object.

Example Use this function to access the bookmarks for specific elements in the page content. For example, to access the table mytable on the page loaded in the myViewer viewer object, use the following code:

Page 537: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 519

actuate.viewer.PageContent

var element = myViewer.getCurrentPageContent( ).getTableByBookmark("mytable");

getTextByBookmarkSyntax actuate.report.TextItem PageContent.getTextByBookmark(string bookmark)

Returns the text element specified by the given bookmark.

Parameter bookmarkString. A bookmark to identify a text element. If the bookmark value is not given, the first text element found in the report content is returned.

Returns actuate.report.TextItem object.

Example Use this function to access the bookmarks for specific elements in the page content. For example, to access the text item "myTextItem" on the page loaded in the myViewer viewer object, use the following code:

var element = myViewer.getCurrentPageContent( ).getTextByBookmark("myTextItem");

getViewerIdSyntax string PageContent.getViewerId( )

Returns the viewer ID.

Returns String. The viewer ID.

Example This example displays the viewer ID in an alert box:

alert("The Viewer ID is " + myViewer.getViewerId( ));

Page 538: Actuate API Reference - OpenText

520 A c t u a t e A P I R e f e r e n c e

actuate.viewer.ParameterValue

Class actuate.viewer.ParameterValueDescription The ParameterValue class is a JavaScript version of the

com.actuate.schemas.ParameterValue class.

ConstructorSyntax actuate.parameter.ParameterValue( )

Constructs a new ParameterValue object.

Function summaryTable 7-55 lists the actuate.viewer.ParameterValue functions.

getNameSyntax string ParameterValue.getName( )

Returns the name value.

Returns String. The name value.

Example To store the name of a viewer.ParameterValue object in a variable called vPVname, use code similar to the following:

var vPVname = myParamValue.getName( );

getValueSyntax object ParameterValue.getValue( )

Returns the value value.

Returns Object. The value value, a string or array of strings.

Table 7-55 actuate.viewer.ParameterValue functions

Function Description

getName( ) Returns the name value

getValue( ) Returns the value value

getValueIsNull( ) Returns the valueIsNull value

setColumnName( ) Sets the name value

setValue( ) Sets the value value

setValueIsNull( ) Sets the valueIsNull value

Page 539: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 521

actuate.viewer.ParameterValue

Example To store a ParameterValue’s value in vPVvalue, use the following code:

var vPVvalue = myParamValue.getValue( );

getValueIsNullSyntax boolean ParameterValue.getValueIsNull( )

Returns the valueIsNull value.

Returns Boolean. The valueIsNull value.

Example This example displays an alert with the valueIsNull of the ParameterValue object:

alert("Value is null: " + myParamValue.getValueIsNull( ));

setColumnNameSyntax void ParameterValue.setColumnName(string columnName)

Sets the columnName value.

Parameter columnNameString. The column name.

Example To set the column name to "Motorcycles", use code similar to the following:

myParamValue.setColumnName("Motorcycles");

setValueSyntax void ParameterValue.setValue(object value)

Sets the value. A value can be a string or an array of strings.

Parameter valueObject. The value for this ParameterValue object, a string or an array of strings.

Example To set the value for a ParameterValue to myValues, use the following code:

var myValues = myParamValue.setValue(myValues);

setValueIsNullSyntax void ParameterValue.setValueIsNull(boolean valueIsNull)

Sets the valueIsNull value.

Parameter valueIsNullBoolean. The valueIsNull value.

Example To set a ParameterValue’s setValueIsNull to true, use the following code:

myParamValue.setValueIsNull(true);

Page 540: Actuate API Reference - OpenText

522 A c t u a t e A P I R e f e r e n c e

actuate.viewer.RenderOpt ions

Class actuate.viewer.RenderOptionsDescription The RenderOptions class specifies render options for the

actuate.Viewer.downloadReport( ) function. Currently, the only supported option is multisheet.

ConstructorSyntax actuate.Viewer.RenderOptions( )

Constructs a new RenderOptions object for the parent viewer.

Function summaryTable 7-56 lists actuate.viewer.RenderOptions functions.

getOptionsSyntax Object[ ] RenderOptions.getOptions( )

Returns the render options map.

Returns Array, arranged in string and object pairs corresponding to option names and option values.

Example This example displays an alert box with the options status of render options:

alert("Rendering Options: " + options.getOptions( ));

setOptionSyntax void RenderOptions.setOption(string option, boolean value)

Specifies a render option and its setting.

Parameters optionString. The permitted value is actuate.viewer.RenderOptions.IS_MULTISHEET, which is used for xls format download only.

valueBoolean. Enabled value for IS_MULTISHEET. True indicates that the xls format file has multiple worksheets.

Table 7-56 actuate.viewer.RenderOptions functions

Function Description

getOptions( ) Returns whether mouse scrolling is enabled

setOption( ) Returns whether mouse panning is enabled

Page 541: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 523

actuate.viewer.RenderOptions

Example To disable multisheet for the options object, use code similar to the following:

options.setOption(actuate.viewer.RenderOptions.IS_MULTISHEET, false);

Page 542: Actuate API Reference - OpenText

524 A c t u a t e A P I R e f e r e n c e

actuate.viewer.Scrol lPanel

Class actuate.viewer.ScrollPanelDescription A container for a scrolling content panel in a viewer, which includes the scroll

panel control, as shown in Figure 7-1.

Figure 7-1 Scroll panel control

A ScrollPanel object enhances the viewer with scroll controls, such as mouse wheel scrolling.

ConstructorSyntax actuate.Viewer.ScrollPanel( )

Constructs a new ScrollPanel object for the parent viewer enabled scroll controls.

Function summaryTable 7-57 lists actuate.viewer.ScrollPanel functions.

getMouseScrollingEnabledSyntax boolean ScrollPanel.getMouseScrollingEnabled( )

Returns true when mouse scrolling is enabled.

Returns Boolean.

Example This example displays an alert with the mouse scrolling status of a scroll panel:

alert("Mouse scrolling enabled: " + sPanel.getMouseScrollingEnabled( ));

Table 7-57 actuate.viewer.ScrollPanel functions

Function Description

getMouseScrollingEnabled( ) Returns whether mouse scrolling is enabled

getPanInOutEnabled( ) Returns whether mouse panning is enabled

setMouseScrollingEnabled( ) Enables mouse scrolling

setPanInOutEnabled( ) Enables panning

Page 543: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 525

actuate.viewer.Scrol lPanel

getPanInOutEnabledSyntax boolean ScrollPanel.getPanInOutEnabled( )

Returns true when panning in and out is enabled.

Returns Boolean.

Example This example displays an alert with the panning in and out status of a scroll panel:

alert("Panning enabled: " + scrollPanel.getPanInOutEnabled( ));

setMouseScrollingEnabledSyntax void ScrollPanel.setMouseScrollingEnabled(boolean enabled)

Enables mouse scrolling for this scroll panel.

Parameter enabledBoolean.

Example To disable mouse scrolling for sPanel, use code similar to the following:

sPanel.setMouseScrollingEnabled(false);

setPanInOutEnabledSyntax void ScrollPanel.setPanInOutEnabled(boolean enabled)

Enables panning in and out for this scroll panel.

Parameter enabledBoolean.

Example To disable panning for the sPanel object, use code similar to the following:

sPanel.setPanInOutEnabled(false);

Page 544: Actuate API Reference - OpenText

526 A c t u a t e A P I R e f e r e n c e

actuate.viewer.SelectedContent

Class actuate.viewer.SelectedContentDescription A container for content selected in the viewer. SelectedContent provides an object

to pass to a handler when the user-defined ON_CONTENT_SELECTED event occurs. This object contains an instance of the element selected in the viewer.

ConstructorThe SelectedContent object is constructed when an ON_CONTENT_SELECTED event occurs.

Function summaryTable 7-58 lists actuate.viewer.SelectedContent functions.

getBookmarkSyntax String SelectedContent.getBookmark( )

Returns the string value of the bookmark for the currently selected column.

Returns String.

Example To retrieve the bookmark of a selected column, use the following code:

//Register an event handler function mySelectionCBviewer.registerEventHandler( actuate.viewer.impl.EventConstants

.ON_CONTENT_SELECTED, mySelectionCB );

// implement the registered event handler function mySelectionCBfunction mySelectionCB( viewerInstance, selectedItem ) {

var bookmark = selectedItem.getBookmark( );}

Table 7-58 actuate.viewer.SelectedContent functions

Function Description

getBookmark( ) Returns the bookmark value for the currently selected element

getBrowserEventObject( ) Returns the native browser event click

getColumnIndex( ) Returns the currently selected table column index number

getRowIndex( ) Returns the index location of the currently selected table row

getSelectedElement( ) Returns a copy of the currently selected element

Page 545: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 527

actuate.viewer.SelectedContent

getBrowserEventObjectSyntax Event SelectedContent.getBrowserEventObject( )

Returns the native browser event occurring on click. You can inspect what the type of the click event is.

Returns Integer.

Example To retrieve the index of a selected table row, use the following code:

//Register an event handler function mySelectionCBfviewer.registerEventHandler(

actuate.viewer.impl.EventConstants.ON_CONTENT_SELECTED, mySelectionCB );

// implement the registered event handler function mySelectionCBfunction mySelectionCB( viewerInstance, selectedItem ) { var event = selectedItem.getBrowserEventObject( ); if ( isRightClick( event ) ) { // show custom menu } else { // highlight cell selection } }

getRowIndexSyntax Integer SelectedContent.getRowIndex( )

Returns the Integer value of the currently selected table row.

Returns Integer.

Example To retrieve the index of a selected table row, use the following code:

//Register an event handler function mySelectionCBviewer.registerEventHandler(

actuate.viewer.impl.EventConstants.ON_CONTENT_SELECTED, mySelectionCB );

// implement the registered event handler function mySelectionCBfunction mySelectionCB( viewerInstance, selectedItem ) {

var rowIdx = selectedItem.getRowIndex( );}

getColumnIndexSyntax integer SelectedContent.getColumnIndex( )

Page 546: Actuate API Reference - OpenText

528 A c t u a t e A P I R e f e r e n c e

actuate.viewer.SelectedContent

Returns the numerical index for the currently selected column. Returns null when the user selects a non-table element.

Returns Integer.

Example To retrieve the index of a selected column, use the following code:

var index = selected.getColumnIndex( );

getSelectedElementSyntax object SelectedContent.getSelectedElement( )

Returns an instance of the currently selected element. The instance can be one of the following objects:

■ actuate.report.Chart

■ actuate.report.DataItem

■ actuate.report.Label

■ actuate.report.Table

■ actuate.report.TextItem

To determine the object type, use the Object.getType( ) function. The type strings for the above objects are Chart, Data, Label, Table, or Text, respectively.

Returns Object. An instance of the currently selected element.

Example To retrieve and store a label bookmark if a selected element is a label, use the following code:

var selected = selected.getColumnIndex( );if (selected.getType( ) == "Label"){

var bmark = Object.getBookmark( );}

Page 547: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 529

actuate.viewer.UIConfig

Class actuate.viewer.UIConfigDescription The UIConfig class specifies feature availability for the viewer.

ConstructorSyntax void actuate.viewer.UIConfig( )

Generates a new UIConfig object to manage the content panel for the viewer. By default, the content panel is an actuate.viewer.ScrollPanel object with ScrollControl, PanInOut, and MouseScrolling enabled.

Function summaryTable 7-59 lists actuate.viewer.UIConfig functions.

getContentPanelSyntax object UIConfig.getContentPanel( )

Returns the content panel object.

Returns Object. Valid objects are actuate.viewer.BrowserPanel, actuate.viewer.ScrollPanel, and null. A null value indicates a content panel configured with the browser scroll bar enabled.

Example To retrieve and store the content panel from the viewer, use the following code:

var contentpanel = viewer.getUIConfig( ).getContentPanel( );

getShowTocSyntax boolean UIConfig.getShowToc( )

Returns the showToc flag.

Returns Boolean.

Example To determine if the showToc flag is set to true, use the following code:

Table 7-59 actuate.viewer.UIConfig functions

Function Description

getContentPanel( ) Returns the content panel configuration

getShowToc( ) Gets the showToc flag

setContentPanel( ) Sets the content panel configuration

setShowToc( ) Sets the showToc flag

Page 548: Actuate API Reference - OpenText

530 A c t u a t e A P I R e f e r e n c e

actuate.viewer.UIConfig

if (!viewer.getUIConfig( ).getShowToc( )){ ...}

setContentPanelSyntax void UIConfig.setContentPanel(objectcontentPanel)

Sets the content panel for the viewer.

Parameter contentPanelObject. Valid objects are actuate.viewer.BrowserPanel, actuate.viewer.ScrollPanel, and null. A null value sets a content panel configured with the browser scroll bar enabled.

Example To set the content panel to BrowserPanel if it is null, use the following code:

var contentpanel = viewer.getUIConfig( ).getContentPanel( );if (contentpanel == null){

var newconfig = viewer.getUIConfig( );newconfig.setContentPanel(new actuate.viewer.BrowserPanel( ));viewer.setUIConfig(newconfig);

}

setShowTocSyntax void UIConfig.setShowToc(boolean showToc)

Sets the showToc flag.

Parameter showTocBoolean.

Example To hide the Toc in the UI, use the following code:

var newconfig = viewer.getUIConfig( );newconfig.setShowToc(false);viewer.setUIConfig(newconfig);

Page 549: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 531

actuate.viewer.UIOptions

Class actuate.viewer.UIOptionsDescription The UIOptions class specifies feature availability for the viewer object.

ConstructorSyntax void actuate.viewer.UIOptions( )

Generates a new UIOptions object to manage the features of the viewer.

Function summaryTable 7-60 lists actuate.viewer.UIOptions functions.

Table 7-60 actuate.viewer.UIOptions functions

Function Description

enableAdvancedSort( ) Enables the advanced sort feature

enableAggregation( ) Enables the aggregation feature

enableCalculatedColumn( ) Enables the calculated column feature

enableChartProperty( ) Enables the chart properties feature

enableChartSubType( ) Enables the chart subtype selection

enableCollapseExpand( ) Enables the collapse/expand feature

enableColumnEdit( ) Enables the column editing feature

enableColumnResize( ) Enables the column resizing feature

enableContentMargin( ) Enables the content margin feature

enableDataAnalyzer( ) Enables the Interactive Crosstabs feature

enableDataExtraction( ) Enables the data extraction feature

enableEditReport( ) Enables the report editing feature

enableExportReport( ) Enables the export report feature

enableFacebookComments( ) Enables the Facebook comments feature

enableFilter( ) Enables the filter feature

enableFlashGadgetType( ) Enables the Flash gadget type change feature

enableFormat( ) Enables the format editing feature

enableGroupEdit( ) Enables the group editing feature

enableHideShowItems( ) Enables the hide/show item feature

enableHighlight( ) Enables the highlight feature

(continues)

Page 550: Actuate API Reference - OpenText

532 A c t u a t e A P I R e f e r e n c e

actuate.viewer.UIOptions

enableAdvancedSortSyntax void UIOptions.enableAdvancedSort(boolean enabled)

Enables or disables the advanced sort feature.

Parameter enabledBoolean. True enables this option.

enableHoverHighlight( ) Enables the hover highlight feature

enableLaunchViewer( ) Enables the launch viewer feature

enableLinkToThisPage( ) Enables the "link to this page" feature

enableMainMenu( ) Enables the main menu feature

enableMoveColumn( ) Enables column moving

enablePageBreak( ) Enables the page break editing feature

enablePageNavigation( ) Enables the page navigation feature

enableParameterPage( ) Enables the parameter page feature

enablePrint( ) Enables the print feature

enableReorderColumns( ) Enables the column reordering

enableRowResize( ) Enables row resizing

enableSaveDesign( ) Enables the report design save feature

enableSaveDocument( ) Enables the report document save feature

enableShowToolTip( ) Enables the show tooltip feature

enableSort( ) Enables the sort feature

enableSuppressDuplicate( ) Enables the duplication suppression feature

enableSwitchView( ) Enables the switch view feature

enableTextEdit( ) Enables the text editing feature

enableTOC( ) Enables the table of contents feature

enableToolBar( ) Enables the toolbar feature

enableToolbarContextMenu( ) Enables the toolbar context menu feature

enableToolbarHelp( ) Enables the toolbar help feature

enableTopBottomNFilter( ) Enables the top N and bottom N filter feature

enableUndoRedo( ) Enables the undo and redo feature

getFeatureMap( ) Returns a list of enabled and disabled features

Table 7-60 actuate.viewer.UIOptions functions (continued)

Function Description

Page 551: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 533

actuate.viewer.UIOptions

Example To disable the advanced sort feature, use code similar to the following:

viewerOpts.enableAdvancedSort(false);

enableAggregationSyntax void UIOptions.enableAggregation(boolean enabled)

Enables or disables the aggregation feature.

Parameter enabledBoolean. True enables this option.

Example To disable the aggregation feature, use code similar to the following:

viewerOpts.enableAggregation(false);

enableCalculatedColumnSyntax void UIOptions.enableCalculatedColumn(boolean enabled)

Enables or disables the calculated column feature.

Parameter enabledBoolean. True enables this option.

Example To disable the calculated column feature, use code similar to the following:

viewerOpts.enableCalculatedColumn(false);

enableChartPropertySyntax void UIOptions.enableChartProperty(boolean enabled)

Enables or disables the chart properties feature.

Parameter enabledBoolean. True enables this option.

Example To disable the chart properties feature, use code similar to the following:

viewerOpts.enableChartProperty(false);

enableChartSubTypeSyntax void UIOptions.enableChartSubType(boolean enabled)

Enables or disables the chart subtype selection feature.

Parameter enabledBoolean. True enables this option.

Page 552: Actuate API Reference - OpenText

534 A c t u a t e A P I R e f e r e n c e

actuate.viewer.UIOptions

Example To disable the chart subtype selection feature, use code similar to the following:

viewerOpts.enableChartSubType(false);

enableCollapseExpandSyntax void UIOptions.enableCollapseExpand(boolean enabled)

Enables or disables the collapse/expand feature.

Parameter enabledBoolean. True enables this option.

Example To disable the collapse/expand feature, use code similar to the following:

viewerOpts.enableCollapseExpand(false);

enableColumnEditSyntax void UIOptions.enableColumnEdit(boolean enabled)

Enables or disables the column editing feature.

Parameter enabledBoolean. True enables this option.

Example To disable the column editing feature, use code similar to the following:

viewerOpts.enableColumnEdit(false);

enableColumnResizeSyntax void UIOptions.enableColumnResize(boolean enabled)

Enables or disables the column resizing feature.

Parameter enabledBoolean. True enables this option.

Example To disable the column resizing feature, use code similar to the following:

viewerOpts.enableColumnResize(false);

enableContentMarginSyntax void UIOptions.enableContentMargin(boolean enabled)

Enables or disables the content margin feature.

Parameter enabledBoolean. True enables this option.

Page 553: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 535

actuate.viewer.UIOptions

Example To disable the content margin feature, use code similar to the following:

viewerOpts.enableContentMargin(false);

enableDataAnalyzerSyntax void UIOptions.enableDataAnalyzer(boolean enabled)

Enables or disables the Interactive Crosstabs feature.

Parameter enabledBoolean. True enables this option.

Example To disable the Interactive Crosstabs feature, use code similar to the following:

viewerOpts.enableDataAnalyzer(false);

enableDataExtractionSyntax void UIOptions.enableDataExtraction(boolean enabled)

Enables or disables the data extraction feature.

Parameter enabledBoolean. True enables this option.

Example To disable the data extraction feature, use code similar to the following:

viewerOpts.enableDataExtraction(false);

enableEditReportSyntax void UIOptions.enableEditReport(boolean enabled)

Enables or disables the report editing feature.

Parameter enabledBoolean. True enables this option.

Example To disable the report editing feature, use code similar to the following:

viewerOpts.enableEditReport(false);

enableExportReportSyntax void UIOptions.enableExportReport(boolean enabled)

Enables or disables the export report feature.

Parameter enabledBoolean. True enables this option.

Page 554: Actuate API Reference - OpenText

536 A c t u a t e A P I R e f e r e n c e

actuate.viewer.UIOptions

Example To disable the export report feature, use code similar to the following:

viewerOpts.enableExportReport(false);

enableFacebookCommentsSyntax void UIOptions.enableFacebookComments(boolean enabled)

Enables or disables the Facebook comments feature.

Parameter enabledBoolean. True enables this option.

Example To disable the Facebook comments feature, use code similar to the following:

viewerOpts.enableFacebookComments(false);

enableFilterSyntax void UIOptions.enableFilter(boolean enabled)

Enables or disables the filter feature.

Parameter enabledBoolean. True enables this option.

Example To disable the filter feature, use code similar to the following:

viewerOpts.enableFilter(false);

enableFlashGadgetTypeSyntax void UIOptions.enableFlashGadgetType(boolean enabled)

Enables or disables the Flash gadget type change control.

Parameter enabledBoolean. True enables this option.

Example To disable the Flash gadget type change control, use code similar to the following:

viewerOpts.enableFlashGadgetType(false);

enableFormatSyntax void UIOptions.enableFormat(boolean enabled)

Enables or disables the format editing feature.

Parameter enabledBoolean. True enables this option.

Page 555: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 537

actuate.viewer.UIOptions

Example To disable the format editing feature, use code similar to the following:

viewerOpts.enableFormat(false);

enableGroupEditSyntax void UIOptions.enableGroupEdit(boolean enabled)

Enables or disables the group editing feature.

Parameter enabledBoolean. True enables this option.

Example To disable the group editing feature, use code similar to the following:

viewerOpts.enableGroupEdit(false);

enableHideShowItemsSyntax void UIOptions.enableHideShowItems(boolean enabled)

Enables or disables the hide/show item feature.

Parameter enabledBoolean. True enables this option.

Example To disable the hide/show feature, use code similar to the following:

viewerOpts.enableHideShowItems(false);

enableHighlightSyntax void UIOptions.enableHighlight(boolean enabled)

Enables or disables the highlight feature.

Parameter enabledBoolean. True enables this option.

Example To disable the highlight feature, use code similar to the following:

viewerOpts.enableHighlight(false);

enableHoverHighlightSyntax void UIOptions.enableHoverHighlight(boolean enabled)

Enables or disables the hover highlight feature.

Parameter enabledBoolean. True enables this option.

Page 556: Actuate API Reference - OpenText

538 A c t u a t e A P I R e f e r e n c e

actuate.viewer.UIOptions

Example To disable the hover highlight feature, use code similar to the following:

viewerOpts.enableHoverHighlight(false);

enableLaunchViewerSyntax void UIOptions.enableLaunchViewer(boolean enabled)

Enables or disables the launch viewer feature.

Parameter enabledBoolean. True enables this option.

Example To disable the launch viewer feature, use code similar to the following:

viewerOpts.enableLaunchViewer(false);

enableLinkToThisPageSyntax void UIOptions.enableLinkToThisPage(boolean enabled)

Enables or disables the "link to this page" feature.

Parameter enabledBoolean. True enables this option.

Example To disable the "link to this page" feature, use code similar to the following:

viewerOpts.enableLinkToThisPage(false);

enableMainMenuSyntax void UIOptions.enableMainMenu(boolean enabled)

Enables or disables the main menu feature.

Parameter enabledBoolean. True enables this option.

Example To disable the main menu feature, use code similar to the following:

viewerOpts.enableMainMenu(false);

enableMoveColumnSyntax void UIOptions.enableMoveColumn(boolean enabled)

Enables or disables the option to move columns.

Parameter enabledBoolean. True enables this option.

Page 557: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 539

actuate.viewer.UIOptions

Example To disable the option to move columns, use code similar to the following:

viewerOpts.enableMoveColumn(false);

enablePageBreakSyntax void UIOptions.enablePageBreak(boolean enabled)

Enables or disables the page break editing feature.

Parameter enabledBoolean. True enables this option.

Example To disable the page break editing feature, use code similar to the following:

viewerOpts.enablePageBreak(false);

enablePageNavigationSyntax void UIOptions.enablePageNavigation(boolean enabled)

Enables or disables the page navigation feature.

Parameter enabledBoolean. True enables this option.

Example To disable the page navigation feature, use code similar to the following:

viewerOpts.enablePageNavigation(false);

enableParameterPageSyntax void UIOptions.enableParameterPage(boolean enabled)

Enables or disables the parameter page feature.

Parameter enabledBoolean. True enables this option.

Example To disable the parameter page feature, use code similar to the following:

viewerOpts.enableParameterPage(false);

enablePrintSyntax void UIOptions.enablePrint(boolean enabled)

Enables or disables the print feature.

Parameter enabledBoolean. True enables this option.

Page 558: Actuate API Reference - OpenText

540 A c t u a t e A P I R e f e r e n c e

actuate.viewer.UIOptions

Example To disable the print feature, use code similar to the following:

viewerOpts.enablePrint(false);

enableReorderColumnsSyntax void UIOptions.enableReorderColumns(boolean enabled)

Enables or disables the column reordering feature.

Parameter enabledBoolean. True enables this option.

Example To disable the column reordering feature, use code similar to the following:

viewerOpts.enableReorderColumns(false);

enableRowResizeSyntax void UIOptions.enableRowResize(boolean enabled)

Enables or disables row resizing.

Parameter enabledBoolean. True enables this option.

Example To disable row resizing, use code similar to the following:

viewerOpts.enableRowResize(false);

enableSaveDesignSyntax void UIOptions.enableSaveDesign(boolean enabled)

Enables or disables the report design save feature.

Parameter enabledBoolean. True enables this option.

Example To disable the report design save feature, use code similar to the following:

viewerOpts.enableSaveDesign(false);

enableSaveDocumentSyntax void UIOptions.enableSaveDocument(boolean enabled)

Enables or disables the report document save feature.

Parameter enabledBoolean. True enables this option.

Page 559: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 541

actuate.viewer.UIOptions

Example To disable the report document save feature, use code similar to the following:

viewerOpts.enableSaveDocument(false);

enableShowToolTipSyntax void UIOptions.enableShowToolTip(boolean enabled)

Enables or disables the showing of tooltips.

Parameter enabledBoolean. True enables this option.

Example To disable the showing of tooltips, use code similar to the following:

viewerOpts.enableShowToolTip(false);

enableSortSyntax void UIOptions.enableSort(boolean enabled)

Enables or disables the sort feature.

Parameter enabledBoolean. True enables this option.

Example To disable the sort feature, use code similar to the following:

viewerOpts.enableSort(false);

enableSuppressDuplicateSyntax void UIOptions.enableSuppressDuplicate(boolean enabled)

Enables or disables the duplication suppression feature.

Parameter enabledBoolean. True enables this option.

Example To disable the duplication suppression feature, use code similar to the following:

viewerOpts.enableSuppressDuplicate(false);

enableSwitchViewSyntax void UIOptions.enableSwitchView(boolean enabled)

Enables or disables the switch view feature.

Parameter enabledBoolean. True enables this option.

Page 560: Actuate API Reference - OpenText

542 A c t u a t e A P I R e f e r e n c e

actuate.viewer.UIOptions

Example To disable the switch view feature, use code similar to the following:

viewerOpts.enableSwitchView(false);

enableTextEditSyntax void UIOptions.enableTextEdit(boolean enabled)

Enables or disables the text editing feature.

Parameter enabledBoolean. True enables this option.

Example To disable the text editing feature, use code similar to the following:

viewerOpts.enableTextEdit(false);

enableTOCSyntax void UIOptions.enableTOC(boolean enabled)

Enables or disables the table of contents feature.

Parameter enabledBoolean. True enables this option.

Example To disable the table of contents feature, use code similar to the following:

viewerOpts.enableTOC(false);

enableToolBarSyntax void UIOptions.enableToolBar(boolean enabled)

Enables or disables the toolbar feature.

Parameter enabledBoolean. True enables this option.

Example To disable the toolbar feature, use code similar to the following:

viewerOpts.enableToolBar(false);

Example This code initializes a new viewer display, using enableToolBar(false) to disable the toolbar:

function initDisplay( ){var uioptions = new actuate.viewer.UIOptions( );viewer = new actuate.Viewer("viewerpane");var viewerwidth = 800;var viewerheight = 600;viewer.setWidth(viewerwidth);viewer.setHeight(viewerheight);

Page 561: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 543

actuate.viewer.UIOptions

uioptions.enableToolBar(false);viewer.setUIOptions(uioptions);document.getElementById("display").disabled = false;

}

enableToolbarContextMenuSyntax void UIOptions.enableToolbarContextMenu(boolean enabled)

Enables or disables the context menu feature.

Parameter enabledBoolean. True enables this option.

Example This code initializes a new viewer display, using enableToolbarHelp(true) to enable the toolbar help feature:

function initDisplay( ){var uioptions = new actuate.viewer.UIOptions( );viewer = new actuate.Viewer("viewerpane");var viewerwidth = 800;var viewerheight = 600;viewer.setWidth(viewerwidth);viewer.setHeight(viewerheight);uioptions.enableToolBar(true);uioptions.enableToolbarHelp(true);viewer.setUIOptions(uioptions);document.getElementById("display").disabled = false;

}

enableToolbarHelpSyntax void UIOptions.enableToolbarHelp(boolean enabled)

Enables or disables the toolbar help feature.

Parameter enabledBoolean. True enables this option.

Example To disable the toolbar help feature, use code similar to the following:

viewerOpts.enableToolbarHelp(false);

enableTopBottomNFilterSyntax void UIOptions.enableTopBottomNFilter(boolean enabled)

Enables or disables the top N and bottom N filter feature.

Parameter enabledBoolean. True enables this option.

Page 562: Actuate API Reference - OpenText

544 A c t u a t e A P I R e f e r e n c e

actuate.viewer.UIOptions

Example To disable the top N and bottom N filter feature, use code similar to the following:

viewerOpts.enableTopBottomNFilter(false);

enableUndoRedoSyntax void UIOptions.enableUndoRedo(boolean enabled)

Enables or disables the undo and redo feature.

Parameter enabledBoolean. True enables this option.

Example To disable the undo and redo feature, use code similar to the following:

viewerOpts.enableUndoRedo(false);

getFeatureMapSyntax object UIOptions.getFeatureMap( )

Returns the features and their Boolean values as an associative array. This function makes the name of each feature an object property and sets the value of that property to the associated enabled Boolean value.

Returns Object.

Page 563: Actuate API Reference - OpenText

C h a p t e r 7 , A c t u a t e J a v a S c r i p t A P I c l a s s r e f e r e n c e 545

actuate.viewer.ViewerExcept ion

Class actuate.viewer.ViewerExceptionDescription A container for an exception. ViewerException provides an object to pass to a

handler when the user-defined ON_EXCEPTION event occurs. It contains a reference to the element that generated the exception.

ConstructorThe ViewerException object is constructed when an ON_EXCEPTION event occurs. The exceptions are divided into three types, which determine the contents of the Exception object. These types are:

■ ERR_CLIENT: Exception type for a client-side error

■ ERR_SERVER: Exception type for a server error

■ ERR_USAGE: Exception type for a JSAPI usage error

Function summaryTable 7-61 lists actuate.viewer.ViewerException functions.

getElementSyntax object ViewerException.getElement( )

Returns an instance of the element that caused the exception, if applicable. The instance can be an object of one of following types:

■ actuate.report.Chart

■ actuate.report.DataItem

■ actuate.report.Label

■ actuate.report.Table

■ actuate.report.TextItem

To determine the object type, use the Object.getType( ) function. The type strings for the above objects are "Chart", "Data", "Label", "Table", or "Text", respectively.

Returns Object. An instance of the element that generated the exception.

Table 7-61 actuate.viewer.ViewerException functions

Function Description

getElement( ) Returns the element for which the exception occurred

getErrorMessage( ) Returns the exception message

Page 564: Actuate API Reference - OpenText

546 A c t u a t e A P I R e f e r e n c e

actuate.viewer.ViewerExcept ion

Example This example displays the type of element that generated the exception in an alert box:

alert("Exception in " + vException.getElement.getType( ));

getErrorMessageSyntax string ViewerException.getErrorMessage( )

Returns the error message for the exception.

Returns String. A server error message.

Example This example displays the server error code in an alert box:

alert("Server error message: " + vException.getErrorMessage( ));

Page 565: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 547

C h a p t e r

8Chapter 8BIRT Interactive

Crosstabs API classreference

This chapter contains the following topics:

■ About the BIRT Interactive Crosstabs JavaScript API

■ Interactive Crosstabs API reference

■ Interactive Crosstabs JavaScript classes quick reference

Page 566: Actuate API Reference - OpenText

548 A c t u a t e A P I R e f e r e n c e

About the BIRT Interactive Crosstabs JavaScript APIThe Interactive Crosstabs portion of the Actuate JavaScript API is a set of JavaScript classes that modify, analyze, and display data within cross tab elements. These classes are available to users of iHub Visualization Platform client. The Actuate JavaScript API functions that are described in this chapter invoke and control the Interactive Crosstabs viewer and elements that are associated with the viewer. The Interactive Crosstabs JavaScript can be placed within a web page or any other location where the Actuate JavaScript API interfaces with a cross tab.

The actuate.xtabAnalyzer class represents the Interactive Crosstabs viewer that contains cross tab information. Load the analyzer with actuate.load( ).

actuate.load("xtabAnalyzer");

Load the XTabAnalyzer component to prepare the actuate.XTabAnalyzer component for use in a web page. Call actuate.XTabAnalyzer functions to create and prepare an analytics cross tab. Call the XTabAnalyzer submit( ) function to display an existing cross tab in a specified HTML <div> element on a web page.

The following JavaScript code creates an Interactive Crosstabs viewer instance:

var ctViewer = new actuate.XTabAnalyzer("cTab");

In this example, cTab is the name value for the <div> element that holds the cross tab content. The web page body must contain a <div> element with an ID value of cTab, as shown in the following code:

<DIV ID="cTab"></DIV>

When no <div> element with the correct ID value exists in the web page body, the Interactive Crosstabs viewer launches in a pop-up window.

To load a cross tab or a data cube, use setReportName( ):

ctViewer.setReportName("~/MyXtabSummary.rptdocument");

The example code loads a report document, MyXtabSummary.rptdocument located in the user’s home folder, that consists of a single data cube and cross tab. The report document can be loaded into the Interactive Crosstabs viewer directly.

To access a cross tab element that is part of a larger report, use the cross tab element’s bookmark after setting the report name. A bookmark is set in a report designer or by an external function. Retrieve a cross tab element with actuate.xtabanalyzer.PageContent.getCrosstabByBookmark( ). For example, the following code retrieves a cross tab with the bookmark SampleRevenue:

var content = ctViewer.getCurrentPageContent( );var crosstab = content.getCrosstabByBookmark("SampleRevenue");

Page 567: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 549

The code in this example retrieves the current page content and the cross tab element within that page, returning an actuate.xtabanalyzer.Crosstab object. This cross tab object supports the modification of the cross tab with the functions in the XTabAnalyzer subclasses.

To set the bookmark for a cross tab element, create a bookmark for the element within BIRT Designer Professional or call setXTabBookmark( ), as shown in the following code:

ctViewer.setXTabBookmark("SampleRevenue");

This example code assigns the bookmark SampleRevenue to the cross tab.

The XTabAnalyzer.submit( ) function triggers an AJAX request to display the report with all the asynchronous operations that previous viewer functions have prepared. Call submit( ) as shown in the following code:

ctViewer.submit( );

Upon executing submit( ), the Actuate web application returns the report with the cross tab in the assigned <div> element.

Interactive Crosstabs API referenceThis section provides an alphabetic listing of the Interactive Crosstabs API classes.

The examples in this section consist of JavaScript functions usable by a typical web page. These examples use a sample report document called reportfile.rptdocument. The sample report document contains a cross tab that has been bookmarked within BIRT Designer Professional with the value of Sample Revenue. Use any equivalent file of that design. Place the Interactive Crosstabs viewer in the acviewer container. The acviewer container is a <div> tag in the HTML page with the following code:

<DIV ID="acviewer" STYLE="border-width: 1px; border-style: solid;display:none;"></DIV>

The JavaScript setup for the examples includes the initialization of the Data Analytics module and the setup of variables for use by the examples, as shown in the following code:

<HTML>...<SCRIPT TYPE="text/javascript" LANGUAGE="JavaScript"><!-- Load the xtabAnalyzer viewer component-->actuate.load("xtabAnalyzer");actuate.load("dialog");actuate.initialize("../../", null, null, null, run);

Page 568: Actuate API Reference - OpenText

550 A c t u a t e A P I R e f e r e n c e

var content;var crosstab;var viewer;var container;

function run( ){container = document.getElementById("acviewer");viewer = new actuate.XTabAnalyzer(container);viewer.setReportName("reportfile.rptdocument");viewer.setXTabBookmark("Sample Revenue");viewer.submit( );content = viewer.getCurrentPageContent( );crosstab = content.getCrosstabByBookmark( );

}<!-- JavaScript application functions --></SCRIPT><!-- Other HTML code -->...</HTML>

The viewer variable points to the XTabAnalyzer object. The content variable points to the data within the web page. The crosstab variable points to the cross tab. These variables are used throughout the examples as needed.

Place example functions in the area marked "JavaScript application functions". The section marked "Other HTML code" contains <div> and other tags necessary for the web page.

Call the examples as any other JavaScript function. For example, the following HTML code creates a button with the label "Job 1" on it. When a user clicks that button, the page runs the JavaScript function Job1.

<INPUT TYPE="button" CLASS="btn" VALUE="Job 1" ONCLICK="Job1( );">

Interactive Crosstabs JavaScript classes quick reference

Table 8-1 lists the Interactive Crosstabs JavaScript classes.

Table 8-1 Actuate Interactive Crosstabs JavaScript classes

JavaScript class Description

actuate.XTabAnalyzer An Interactive Crosstabs viewer component that can be embedded in an HTML page

actuate.xtabanalyzer.Crosstab A cross tab element

Page 569: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 551

actuate.xtabanalyzer.Dimension A data dimension

actuate.xtabanalyzer.Driller A helper class for drilling down through cross tab data

actuate.xtabanalyzer.EventConstants Global constants for Interactive Crosstabs events class

actuate.xtabanalyzer.Exception Exception object sent to calling function

actuate.xtabanalyzer.Filter Filter conditions to filter data

actuate.xtabanalyzer.GrandTotal A cross tab grand total

actuate.xtabanalyzer.Level A cross tab level

actuate.xtabanalyzer.LevelAttribute An attribute for a level

actuate.xtabanalyzer.Measure A data measure

actuate.xtabanalyzer.MemberValue Data as a member value

actuate.xtabanalyzer.Options Options for the cross tab

actuate.xtabanalyzer.PageContent The content shown in the Interactive Crosstabs viewer

actuate.xtabanalyzer.ParameterValue A cross tab parameter value

actuate.xtabanalyzer.Sorter Conditions for sorting data

actuate.xtabanalyzer.SubTotal A cross tab subtotal

actuate.xtabanalyzer.Total A cross tab total

actuate.xtabanalyzer.UIOptions Enables UI elements of Interactive Crosstabs

Table 8-1 Actuate Interactive Crosstabs JavaScript classes

JavaScript class Description

Page 570: Actuate API Reference - OpenText

552 A c t u a t e A P I R e f e r e n c e

actuate.XTabAnalyzer

Class actuate.XTabAnalyzerDescription The XTabAnalyzer class represents an Interactive Crosstabs viewer, used to view

and operate a cross tab.

ConstructorSyntax actuate.XTabAnalyzer( )

Constructs a new Interactive Crosstabs object.

actuate.XTabAnalyzer(object xtabContainer, actuate.xtabanalyzer.UIOptions uiOptions)

actuate.XTabAnalyzer(string xtabContainerId, actuate.xtabanalyzer.UIOptions uiOptions)

Constructs a new Interactive Crosstabs object in the specified container.

Parameters xtabContainerObject. A document object referencing the HTML <div> element that contains the XTabAnalyzer viewer.

xtabContainerIdString. The value of the ID parameter for an HTML <div> element to hold the XTabAnalyzer viewer. For example, with 'containerName' as the xtabContainer parameter, a <DIV ID='containerName' /> tag on the page displays the viewer at the location of the <div> element.

uiOptionsactuate.xtabanalyzer.UIOptions object. Optional. UIOptions references display options for the viewer.

Function summaryTable 8-2 lists actuate.XTabAnalyzer functions.

Table 8-2 actuate.XTabAnalyzer functions

Function Description

commit( ) Commits all changes to the report design

forceSoftRestart( ) Forces the viewer to restart

getCurrentPageContent( ) Returns the Current Page Content object

getCurrentPageNum( ) Returns the current page number

getGadgetId Returns the gadget ID of the shown cross tab

getHeight( ) Returns the viewer height

Page 571: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 553

actuate.XTabAnalyzer

getLeft( ) Returns the viewer left margin

getParameterValues( ) Returns the parameter values

getPosition( ) Returns the CSS position attribute value

getTop( ) Returns the viewer top margin

getTotalPageCount( ) Returns the total page count

getUIOptions( ) Returns the actuate.xtabanalyzer.UIOptions object assigned to this viewer

getViewer( ) Gets a viewer within a container

getWidth( ) Returns the viewer width

getXTabBookmark( ) Returns the bookmark of the cross tab displayed in the viewer

getXTabIid( ) Returns the instance ID of the cross tab displayed in the viewer

isActive( ) Checks if current viewer pop-up is active

isDashboard( ) Checks if the current viewer pop-up is a dashboard

isInteractive( ) Checks if the current viewer is interactive

registerEventHandler( ) Registers an event handler

removeEventHandler( ) Removes an event handler

reset( ) Resets the viewer object

resizeTo( ) Resizes the viewer

rollback( ) Rolls back all changes in the viewer and refreshes its content

setGadgetId Sets the gadget id of the cross tab

setHeight( ) Sets the viewer height

setIVMode( ) Sets whether the viewer is in IV mode

setLeft( ) Sets the viewer left margin

setOnClosed( ) Sets callback when the pop-up window is closed

setPageNum( ) Sets the page number

setParameterValues( ) Sets the parameter values

setPosition( ) Sets the CSS position attribute

(continues)

Table 8-2 actuate.XTabAnalyzer functions (continued)

Function Description

Page 572: Actuate API Reference - OpenText

554 A c t u a t e A P I R e f e r e n c e

actuate.XTabAnalyzer

commitSyntax void XTabAnalyzer.commit(function callback)

Commits all design changes to a generated document as a single operation. If ivMode is not set to true, call setIVMode( ) to set the value of ivMode to true before calling commit( ).

Parameter callbackFunction. The callback function called after commit finishes.

Example This example opens a design with a cross tab and pivots the cross tab:

function pivot( ){// Make a change to the cross tab

crosstab.pivot( );crosstab.submit( );viewer.commit( );

}

forceSoftRestartSyntax void XTabAnalyzer.forceSoftRestart( )

Forces the viewer to restart.

Example This example restarts the viewer:

setReportletDocumentMode( ) Sets a Reportlet to document mode

setReportName( ) Sets the report to load into the interactive cross tab

setService( ) Sets the iHub System and request options

setSupportSVG( ) Sets whether or not the client browser supports SVG

setTop( ) Sets the top margin

setUIOptions( ) Sets the user interface options for the viewer

setWidth( ) Sets the viewer width

setXTabBookmark( ) Sets a bookmark for the cross tab

setXTabIid( ) Sets the instance ID of the cross tab

submit( ) Submits asynchronous operations and renders the requested components

Table 8-2 actuate.XTabAnalyzer functions (continued)

Function Description

Page 573: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 555

actuate.XTabAnalyzer

this.onclick = function(event){forceSoftRestart( );

}

getCurrentPageContentSyntax actuate.xtabanalyzer.PageContent XTabAnalyzer.getCurrentPageContent( )

Returns the Current Page Content object.

Returns actuate.xtabanalyzer.PageContent object. Content from the current page.

Example This example retrieves the cross tab from the current page:

function getCrosstab(analyzerViewer){var content = analyzerViewer.getCurrentPageContent( );return content.getCrosstabByBookmark( );

}}

getCurrentPageNumSyntax integer XTabAnalyzer.getCurrentPageNum( )

Returns the current page number.

Returns Integer. The current page number.

Example This example retrieves the page number:

function retrievePageNum( ){return analyzerViewer.getCurrentPageNum( );

}}

getGadgetIdSyntax string XTabAnalyzer.getGadgetId( )

Returns the gadget ID of the shown cross tab. This function is used for dashboard integration.

Returns String. A gadget ID.

Example This example retrieves the gadget ID:

function retrieveGadgetID( ){return analyzerViewer.getGadgetId( );

}}

getHeightSyntax integer XTabAnalyzer.getHeight( )

Page 574: Actuate API Reference - OpenText

556 A c t u a t e A P I R e f e r e n c e

actuate.XTabAnalyzer

Returns the height of the viewer.

Returns Integer. The height in pixels.

Example This example retrieves the current height of the viewer and doubles the height if the current height is lower than 630 pixels:

function doubleHeight( ){var height = viewer.getHeight( );if (height < 630){

viewer.setHeight(height * 2);viewer.submit( );

}}}

getLeftSyntax integer XTabAnalyzer.getLeft( )

Returns the left margin of the viewer.

Returns Integer. The left margin in pixels.

Example This example retrieves the position of the viewer’s left margin and moves the margin 20 pixels to the right if the left margin is fewer than 45 pixels from the left edge of the screen:

function moveLeftMargin( ){var left = viewer.getLeft( );if (left < 45){

viewer.setLeft(left + 20);viewer.submit( );

}}}

getParameterValuesSyntax actuate.xtabanalyzer.ParameterValue[ ] XTabAnalyzer.getParameterValues( )

Returns the parameter values.

Returns actuate.xtabanalyzer.ParameterValue[ ] or actuate.parameter.ParameterValue[ ]. An array of parameter values.

getPositionSyntax string XTabAnalyzer.getPosition( )

Returns the CSS position attribute for the viewer.

Returns String. The CSS position attribute.

Page 575: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 557

actuate.XTabAnalyzer

Example This example changes the CSS positioning type from relative to absolute:

function changePosition( ){if (viewer.getPosition( ) == 'relative'){

viewer.setPosition('absolute');viewer.submit( );

}}}

getTopSyntax integer XTabAnalyzer.getTop( )

Returns the top margin of the viewer.

Returns Integer. The top margin in pixels.

Example This example retrieves the value for the viewer’s top margin and moves the margin 20 pixels down the screen if the margin was fewer than 45 pixels from the top of the screen:

function moveTopMargin( ){var top = viewer.getTop( );if (top < 45){

viewer.setTop(top + 20);viewer.submit( );

}}}

getTotalPageCountSyntax integer XTabAnalyzer.getTotalPageCount( )

Returns the total page count.

Returns Integer. The total number of pages.

Example This example displays an alert with the total page count from viewer:

alert("Total pages: " + viewer.getTotalPageCount( ));}

getUIOptionsSyntax actuate.xtabanalyzer.UIOptions getUIOptions( )

Returns the user interface options object for the cross tab analyzer. The UIOptions object specifies what features are used within the viewer.

Returns actuate.xtabanalyzer.UIOptions object. Interactive Crosstabs user interface options.

Page 576: Actuate API Reference - OpenText

558 A c t u a t e A P I R e f e r e n c e

actuate.XTabAnalyzer

Example This example retrieves the user interface options and sets one of the UIOptions values:

function resetUIOptions( ){var options = viewer.getUIOptions( );options.enableToolbar(false);viewer.setUIOptions(options);

}}

getViewerSyntax static XTabAnalyzer.getViewer(HTMLElement container)

Returns a viewer by container. To retrieve the viewer for the current object, do not specify a container. This function is useful to retrieve the instance ID for a specific viewer when there are multiple viewers on a page.

Parameter containerHTMLElement. The container instance ID from which to retrieve the viewer.

Returns XTabAnalyzer object. The Interactive Crosstabs viewer.

Example This example retrieves the viewer:

function retrieveViewer( ){return viewer.getViewer( );

}}

getWidthSyntax string XTabAnalyzer.getWidth( )

Returns the width value of the viewer.

Returns String. The width in pixels.

Example This example retrieves the width of the viewer, then alters it based on the size:

function doubleWidth( ){var width = viewer.getWidth( );if (width < 630){

viewer.setWidth(width * 2);viewer.submit( );

}}}

getXTabBookmarkSyntax string XTabAnalyzer.getXTabBookmark( )

Returns the bookmark name for the cross tab set to render in the viewer.

Page 577: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 559

actuate.XTabAnalyzer

Returns String. The bookmark for a cross tab.

Example This example retrieves the bookmark that the cross tab is associated with, changes the bookmark, and resets the bookmark. This functionality supports the use of multiple cross tab elements within a single design.

function changeBookmark( ){var oldBookMark = viewer.getXTabBookmark( );viewer.setXTabBookmark("crosstab2");viewer.submit( );

}}

getXTabIidSyntax string XTabAnalyzer.getXTabIid( )

Returns the current instance ID of the interactive cross tab. This function is useful in integration with Interactive Viewer and supports the ability of Interactive Viewer to obtain and use the interactive cross tab instance ID.

Returns String. An interactive cross tab instance ID.

Example This example retrieves the interactive cross tab instance ID:

function retrieveXTablid( myviewer ){return myviewer.getXTablid( );

}}

isActiveSyntax boolean XTabAnalyzer.isActive( )

Returns true when an interactive cross tab pop-up is active and false otherwise.

Returns Boolean. True indicates an active interactive cross tab pop-up window.

Example This example checks if a viewer exists by checking two conditions: the viewer variable exists, or isActive( ) returns true. When both conditions fail, the example code creates a new viewer object within a container:

function checkViewer( ){if(!viewer || !viewer.isActive( )){

viewer = new actuate.XTabAnalyzer(container);}

}}

isDashboardSyntax boolean XTabAnalyzer.isDashboard( )

Returns true when dashboard mode is active and false in all other cases.

Page 578: Actuate API Reference - OpenText

560 A c t u a t e A P I R e f e r e n c e

actuate.XTabAnalyzer

Returns Boolean. True indicates dashboard mode.

isInteractiveSyntax boolean XTabAnalyzer.isInteractive( )

Returns whether this Interactive Crosstabs Viewer is in Interactive mode.

Returns Boolean. True indicates dashboard mode.

Example This example displays whether myDataAnalyzer is interactive:

alert("Interactive mode: " + myDataAnalyzer.isInteractive( ));}

registerEventHandlerSyntax void XTabAnalyzer.registerEventHandler(string viewerEvent, function handler)

Registers an event handler for the specified event. This function throws actuate.xtabanalyzer.Exception when invalid arguments are passed.

Parameters viewerEventString. Specifies the event that triggers the handler call. For a list of supported events, see actuate.xtabanalyzer.EventConstants.

handlerFunction. Called when the event occurs.

Example This example changes an event handler from one function to another:

function changeEventHandler( event ){viewer.removeEventHandler(

actuate.xtabanalyzer.EventConstants.ON_CONTENT_CHANGED, oldChangedHandler);

viewer.registerEventHandler(actuate.xtabanalyzer.EventConstants.ON_CONTENT_CHANGED, newChangedHandler);

}}

removeEventHandlerSyntax void XTabAnalyzer.removeEventHandler(string viewerEvent, function handler)

Removes an event handler from the specified event. This function throws actuate.xtabanalyzer.Exception when invalid arguments are passed.

Parameters viewerEventString. Specifies the event from which to remove the event handler. For a list of supported events, see actuate.xtabanalyzer.EventConstants.

handlerFunction. The function to deregister from the event.

Page 579: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 561

actuate.XTabAnalyzer

Example This example changes an event handler from one function to another:

function changeEventHandler( event ){viewer.removeEventHandler(

actuate.xtabanalyzer.EventConstants.ON_CONTENT_CHANGED, oldChangedHandler);

viewer.registerEventHandler(actuate.xtabanalyzer.EventConstants.ON_CONTENT_CHANGED, newChangedHandler);

}}

resetSyntax void XTabAnalyzer.reset( )

Resets the viewer to its initial state.

Example This example resets the viewer. All changes to the viewer made prior to this call are discarded:

function resetViewer( ){viewer.reset( );

}}

resizeToSyntax void XTabAnalyzer.resizeTo(integer width, integer height)

Resizes the viewer to the specified height and width.

Parameters widthInteger. The width in pixels.

heightInteger. The height in pixels.

Example This example resizes the viewer when the new width is fewer than 1000 pixels and the new height is fewer than 650 pixels:

function resizeViewer(width,height){if ((width < 1000) && (height < 650)){

viewer.resizeTo(width,height);}

}}

rollbackSyntax void XTabAnalyzer.rollback(function callback)

Rolls back all changes in the viewer since the last commit( ) call and refreshes the viewer’s content. The value of ivMode must be true for rollback( ) to function.

Page 580: Actuate API Reference - OpenText

562 A c t u a t e A P I R e f e r e n c e

actuate.XTabAnalyzer

Parameter callbackFunction. The callback function called after rollback finishes.

Example This example rolls back all changes to the viewer made since the last commit or submit function call:

function rollbackViewer( ){viewer.rollback( );

}

setGadgetIdSyntax void XTabAnalyzer.setGadgetId(string gadgetId)

Sets the cross tab gadget ID. This function is used for dashboard integration.

Parameter gadgetIdString. The gadget ID used to render the cross tab.

Example This example sets the gadget ID:

function setGadgetID(id){viewer.setGadgetId(id);

}

setHeightSyntax void XTabAnalyzer.setHeight(integer height)

Changes the height of the viewer.

Parameter heightInteger. The height in pixels.

Example This example retrieves the viewer’s current height. When the current height is fewer than 630 pixels, the example code doubles the viewer’s height.

function doubleHeight( ){var height = viewer.getHeight( );if (height < 630){

height = height * 2;viewer.setHeight(height);viewer.submit( );

}}

setIVModeSyntax void XTabAnalyzer.setIVMode(boolean ivMode)

Page 581: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 563

actuate.XTabAnalyzer

Sets IVMode for the viewer. Integrating a Data Analytics viewer with the Interactive Viewer affects the undo/redo feature. When set to true, all changes to the Data Analytics viewer must be committed as one transaction. The Interactive Viewer can undo or redo the entire batch.

Parameter ivModeBoolean. Set to true if using IV mode.

Example This example sets IVMode for the viewer:

function setViewerMode(mode){viewer.setIVMode(mode);

}

setLeftSyntax void XTabAnalyzer.setLeft(integer left)

Sets the position of the viewer’s left margin.

Parameter leftInteger. The left margin for the viewer in pixels.

Example This example retrieves the left edge of the viewer and moves the viewer 20 pixels to the right when the margin to the edge of the screen is less than 45 pixels:

function moveLeftMargin( ){var left = viewer.getLeft( );if (left < 45){

viewer.setLeft(left + 20);viewer.submit( );

}}

setOnClosedSyntax void XTabAnalyzer.setOnClosed(function callback)

Sets a callback function to call when a viewer pop-up closes.

Parameter callbackFunction. The function to call when the pop-up closes.

Example This example checks to see if a pop-up window is active and sets a callback function to trigger when the pop-up closes:

function setPopupCloser( ){if(viewer.isActive( )){

viewer.setOnClosed(closerCallbackFunctionName);}

}

Page 582: Actuate API Reference - OpenText

564 A c t u a t e A P I R e f e r e n c e

actuate.XTabAnalyzer

setPageNumSyntax void XTabAnalyzer.setPageNum(function pageNum)

Sets the page number.

Parameter pageNumInteger. The page number.

Example This example sets the sets the page number to the first page:

function setPageNumberToFirst( ){if(viewer.isActive( )){

viewer.setPageNum(1);}

}

setParameterValuesSyntax void XTabAnalyzer.setParameterValues(actuate.xtabanalyzer.ParameterValue[ ]

parameterValues)

Sets the parameter values.

Parameter parameterValuesactuate.xtabanalyzer.ParameterValue[ ] or actuate.parameter.ParameterValue[ ]. An array of parameter values.

setPositionSyntax void XTabAnalyzer.setPosition(string position)

Sets the CSS position attribute.

Parameter positionString. The value for the CSS position attribute.

Example This example changes the type of CSS positioning in use:

function changePosition( ){var pos = viewer.getPosition( );if (pos == 'relative'){

viewer.setPosition('absolute');viewer.submit( );

}}

setReportletDocumentModeSyntax void XTabAnalyzer.setReportletDocumentMode(boolean reportletMode)

Page 583: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 565

actuate.XTabAnalyzer

Sets whether the viewer displays documents as Reportlets.

Parameter reportletModeBoolean. True indicates Reportlet display mode.

setReportNameSyntax void XTabAnalyzer.setReportName(string reportName, string connectionHandle)

Sets the report file name for the viewer. The file must be a report document file or report design file.

Parameters reportNameString. The name of the report file.

connectionHandleString. Optional. The unique identifier generated by iHub for a temporary report.

Example This example sets the report name to reportfile.rptdocument and reloads the Interactive Crosstabs viewer with its content:

function run( ){container = document.getElementById("acviewer");viewer = new actuate.XTabAnalyzer(container);viewer.setReportName("reportfile.rptdocument");viewer.submit( );

}

setServiceSyntax void XTabAnalyzer.setService(string iPortalURL, actuate.RequestOptions

requestOptions)

Sets the Actuate web application URL. This function can request options for that URL.

Parameters iPortalURLString. The URL of the Actuate web application.

requestOptionsactuate.RequestOptions object. Request options for the web application. This parameter is optional.

Example This example sets the service and request options:

function setServerOptions(URL,options){viewer.setService(URL,options);

}

Page 584: Actuate API Reference - OpenText

566 A c t u a t e A P I R e f e r e n c e

actuate.XTabAnalyzer

setSupportSVGSyntax void XTabAnalyzer.setSupportSVG(boolean svgFlag)

Sets a flag indicating whether or not the browser supports SVG.

Parameter svgFlagBoolean. Flag indicating SVG support in the browser. This parameter’s value is true when the browser supports SVG and false in all other cases.

Example This example sets the browser’s level of SVG support:

function setSVG(flag){viewer.setSupportSVG(flag);

}

setTopSyntax void XTabAnalyzer.setTop(integer top)

Sets the top margin for the viewer.

Parameter topInteger. The top margin for the viewer in pixels.

Example This example retrieves the current top margin for the viewer and moves the margin 20 pixels down the screen when the current position of the margin is fewer than 45 pixels from the top of the screen:

function moveTopMargin( ){var top = viewer.getTop( );if (top < 45){

top = top + 20;viewer.setTop(top);viewer.submit( );

}}

setUIOptionsSyntax void XTabAnalyzer.setUIOptions(actuate.xtabanalyzer.uioptions options)

Sets the user interface options enabled for the viewer.

Parameter optionsActuate.xtabanalyzer.uioptions object. The options object for the viewer.

Example This example retrieves the user interface options and sets one of the UIOptions values:

function resetUIOptions( ){var options = viewer.getUIOptions( );

Page 585: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 567

actuate.XTabAnalyzer

options.enableToolbar(false);viewer.setUIOptions(options);

}

setWidthSyntax void XTabAnalyzer.setWidth(integer width)

Sets the width for the viewer.

Parameter widthInteger. The width for the viewer in pixels.

Example This example retrieves the width of the viewer. When the viewer is fewer than 630 pixels wide, the example code doubles the viewer’s width:

function doubleWidth( ){var width = viewer.getWidth( );if (width < 630){

viewer.setWidth(width * 2);viewer.submit( );

}}

setXTabBookmarkSyntax void XTabAnalyzer.setXTabBookmark(string bookmark)

Sets the bookmark for a cross tab to render in the viewer.

Parameter bookmarkString. The bookmark for a cross tab.

Example This example retrieves the bookmark for the cross tab the viewer is associated with, changes the bookmark, and reloads the bookmark. This functionality enables the use of multiple cross tab elements within a single design.

function changeBookmark( ){var oldBookMark = viewer.getXTabBookmark( );viewer.setXTabBookmark("crosstab2");viewer.submit( );

}

setXTabIidSyntax void XTabAnalyzer.setXTabIid(string iid)

Sets the instance ID for viewer rendering. This function is useful in integration with Interactive Viewer, and supports the ability of Interactive Viewer to obtain and use the cross tab instance ID.

Page 586: Actuate API Reference - OpenText

568 A c t u a t e A P I R e f e r e n c e

actuate.XTabAnalyzer

Parameter iidString. The instance ID.

Example This example sets the cross tab instance ID:

function setxtabInstance(id){viewer.setXTablid(id);

}

submitSyntax void XTabAnalyzer.submit(function callback, boolean rerun)

Submits requests to the server for the Interactive Crosstabs viewer. This method triggers an AJAX request to submit all pending operations for this object. The server returns a response after processing the pending operations. The results render on the page in the Interactive Crosstabs container. The submit( ) function throws an exception when another submit( ) operation is pending. A CONTENT_CHANGED event fires when the Interactive Crosstabs content changes.

Parameters callbackFunction. Optional. A function called when submit completes. This function receives the current XTabAnalyzer object as an input parameter.

rerunBoolean. Optional. Indicates whether re-run the report design when it refreshes. Default to true.

Example This example retrieves the left margin of the viewer and expands the margin. The change does not take effect until submit( ) executes. The submit( ) function calls the function in the submitCallback parameter when submit( ) finishes executing. The callback function contains any processing that must occur after submit( ) finishes. Do not place code after the submit( ) call in the same function because submit( ) is asynchronous.

function moveLeftMargin( ){var left = viewer.getLeft( );if (left < 45){

viewer.setLeft(left + 20);viewer.submit(submitCallback);

}}

Page 587: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 569

actuate.xtabanalyzer.Crosstab

Class actuate.xtabanalyzer.CrosstabDescription The actuate.xtabanalyzer.Crosstab class represents a cross tab report element.

ConstructorSyntax actuate.xtabanalyzer.Crosstab( )

Constructs a new cross tab object.

Function summaryTable 8-3 lists actuate.xtabanalyzer.Crosstab functions.

Table 8-3 actuate.xtabanalyzer.Crosstab functions

Function Description

addDimension( ) Adds a dimension to the cross tab

addMeasure( ) Adds a measure to the cross tab

applyOptions( ) Sets options for the cross tab

changeMeasureDirection( ) Switches measure direction

clearFilters( ) Clears cross tab filters

drill( ) Drills up or down measure levels, replacing drill and filter conditions

drillDown( ) Drills down a measure level, updating drill conditions

drillUp( ) Drills up a measure level, updating drill conditions

editMeasure( ) Edits a measure

getBookmark( ) Retrieves the cross tab element bookmark

getColumn( ) Retrieves table data by column index

getData( ) Returns the data from a cross tab

getHtmlDom( ) Retrieves the HTML DOM object

getPageContent( ) Retrieves the content of the page the cross tab belongs to

getRow( ) Retrieves table data by row index

getType( ) Retrieves the report element type

hideDetail( ) Hides the detail of a specified level

(continues)

Page 588: Actuate API Reference - OpenText

570 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Crosstab

addDimensionSyntax void Crosstab.addDimension(actuate.xtabanalyzer.Dimension dimension)

Adds a dimension to the cross tab object.

Parameter dimensionactuate.xtabanalyzer.Dimension object. The dimension to add.

Example This example adds a date-based, multi-level dimension to a cross tab:

function addDimension( ){// Create a dimension for dates in the first column

var dimension = new actuate.xtabanalyzer.Dimension( );dimension.setIndex(0);dimension.setAxisType(

actuate.xtabanalyzer.Dimension.COLUMN_AXIS_TYPE);dimension.setDimensionName("dates");

// Create levels using levels from the data cube.var level = new actuate.xtabanalyzer.Level( );level.setLevelName("year");dimension.addLevel(level);var level = new actuate.xtabanalyzer.Level( );level.setLevelName("quarter");dimension.addLevel(level);

// Add the dimension to the cross tab.crosstab.addDimension(dimension);crosstab.submit( );

}

pivot( ) Pivots the cross tab

removeDimension( ) Removes a dimension from the cross tab

removeMeasure( ) Removes a measure from the cross tab

reorderDimension( ) Reorders a dimension

reorderMeasure( ) Reorders a measure

setFilters( ) Sets the cross tab’s filters

setSorters( ) Sets the cross tab’s sorters

setTotals( ) Sets the cross tab’s totals

showDetail( ) Shows details to the lower level

submit( ) Applies changes made to the cross tab

Table 8-3 actuate.xtabanalyzer.Crosstab functions (continued)

Function Description

Page 589: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 571

actuate.xtabanalyzer.Crosstab

addMeasureSyntax void Crosstab.addMeasure(actuate.xtabanalyzer.Measure measure, integer

options)

Adds a measure to the cross tab object.

Parameters measureactuate.xtabanalyzer.Measure object. The measure to add.

optionsInteger. The options for the add measure operation. These options distinguish the origin of the function call, which can be from another dialog or directly from the Actuate JavaScript API.

Example This example adds a measure to a cross tab:

function addMeasure( ){//Create a measure for revenue organized by date and product line.

var measure = new actuate.xtabanalyzer.Measure( );measure.setIndex(1);measure.setMeasureName("Quarter Rate");measure.setExpression(

"[revenue]/[revenue_SalesDate/year_Product/PRODUCTLINE]");

// Apply the measure to the cross tabcrosstab.addMeasure(measure);crosstab.submit( );

}

In this example, the expression set with setExpression( ) is in EasyScript, which is described in Using Actuate BIRT Designer Professional.

applyOptionsSyntax void Crosstab.applyOptions(string | actuate.xtabanalyzer.Options

measureDirection, string rowMirrorStartingLevel, string columnMirrorStartingLevel, string emptyCellValue)

Sets measure direction, empty settings, row mirror starting level, column mirror starting level, and empty cell value.

Parameters measureDirectionString or actuate.xtabanalyzer.Options object. When measureDirection is a string, measureDirection is set to horizontal or vertical and the other parameters set options individually. When an actuate.xtabanalyzer.Options object is specified, all the options are set using settings from this object and applyOptions ignores all subsequent parameters.

rowMirrorStartingLevelString. Sets the mirror starting level empty setting for a row.

Page 590: Actuate API Reference - OpenText

572 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Crosstab

columnMirrorStartingLevelString. Sets the mirror starting level empty setting for a column.

emptyCellValueString. Sets the value of an empty cell.

changeMeasureDirectionSyntax void Crosstab.changeMeasureDirection( )

Switches the measure direction between horizontal and vertical.

Example This example changes the measure direction:

function changeMeasureDirection( ){if( crosstab ){

crosstab.changeMeasureDirection( );crosstab.submit( );

}}

clearFiltersSyntax void Crosstab.clearFilters(actuate.xtabanalyzer.Level level, String filterType)

Clears the filters from a level.

Parameters levelactuate.xtabanalyzer.Level object. Optional. The level from which to clear the filters. To clear all filters, do not specify a level.

filterTypeString. Optional. The filter type. To clear all filter types, do not specify a filter type.

Example This example clears the filters from the level filterLevel:

function clearLevelFilters( ){if( crosstab ){

crosstab.clearFilters("filterLevel");crosstab.submit( );

}}

drillSyntax void Crosstab.drill(actuate.xtabanalyzer.Driller driller)

Drills up or down a dimension level. Removes all drill/filter conditions defined on specified dimension first, then adds new drill/filter conditions.

Page 591: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 573

actuate.xtabanalyzer.Crosstab

Parameter drilleractuate.xtabanalyzer.Driller object. The driller object specifies drill conditions on a dimension.

Example This example drills to a level within a dimension. Any existing drill conditions are replaced.

function drillToDimension(memberVal){var driller = new actuate.xtabanalyzer.Driller( );driller.setAxisType(

actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE);driller.addMember(memberVal);myCrosstab.drill(driller);myCrosstab.submit( );

}

drillDownSyntax void Crosstab.drillDown(actuate.xtabanalyzer.Driller driller)

Drills down a dimension level. This method updates the drill conditions specified in the Driller object and leaves all other conditions in place.

Parameter drilleractuate.xtabanalyzer.Driller object. A drill condition object.

Example This example drills down a level within a dimension. Any existing drill conditions are unchanged.

function drillToDimension(memberVal){var driller = new actuate.xtabanalyzer.Driller( );driller.setAxisType(

actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE);driller.addMember(memberVal);myCrosstab.drillDown(driller);myCrosstab.submit( );

}

drillUpSyntax void Crosstab.drillUp(actuate.xtabanalyzer.Driller driller)

Drills up a dimension level. This method updates the drill conditions specified in the Driller object and leaves all other conditions in place.

Parameter drillerA drill condition object.

Example This example drills up a level within a dimension. Any existing drill conditions are unchanged.

Page 592: Actuate API Reference - OpenText

574 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Crosstab

function drillToDimension( ){var driller = new actuate.xtabanalyzer.Driller( );driller.setAxisType(

actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE);// Add the member list to the Driller. Add the Driller to the// crosstab.

driller.addMember(memberVal);myCrosstab.drillUp(driller);myCrosstab.submit( );

}

editMeasureSyntax void Crosstab.editMeasure(actuate.xtabanalyzer.Meaure Measure, integer opts)

Edits a measure in the Computed Measure view.

Parameters Measureactuate.xtabanalyzer.Measure object. A measure to change.

optsInteger. Optional. Options for the editMeasure function. These options distinguish the origin of the function call, which can be from another dialog or directly from the Actuate JavaScript API.

Example This example edits a measure:

function editComputedMeasure( ){if( crosstab ){

var measure = new actuate.xtabanalyzer.Measure( );measure.setMeasureName("measureName");measure.setExpression("measureExpression");crosstab.editMeasure(measure);crosstab.submit( );

}}

getBookmarkSyntax string Crosstab.getBookmark( )

Returns the bookmark that is associated with the cross tab element.

Returns String. The cross tab bookmark.

Example The following code retrieves the bookmark that is associated with the cross tab object:

function getCrosstabBookmark( ){var crosstabBookmark = crosstab.getBookmark( );

Page 593: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 575

actuate.xtabanalyzer.Crosstab

if( !crosstabBookmark ){alert( "No cross tab bookmark found!" )return null;

}return crosstabBookmark;

}

getColumnSyntax string[ ] Crosstab.getColumn(integer columnIndex)

Returns the table data by column index.

Parameter columnIndexInteger. The column index, starting with 1.

Returns String[ ]. The column data as an array of strings. This function returns null when the value of columnIndex is out of range. This function only returns data from the current visible page.

Example The following code retrieves data from a data column:

function getColumnData(index,value){var columnData = crosstab.getColumn(index);if( !columnData ){

alert( "Invalid column index!" )return null;

}return columnData[value];

}

getDataSyntax String[ ] Crosstab.getData(boolean forceReparse)

Returns the data in a cross tab.

Parameter forceReparseBoolean. Forces a cache refresh when true.

Returns String[ ]. The data from the cross tab as an array of strings.

getHtmlDomSyntax HTMLElement Crosstab.getHtmlDom( )

Returns the HTML element DOM object.

Returns HTMLElement. The DOM element containing the cross tab.

Page 594: Actuate API Reference - OpenText

576 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Crosstab

Example The following code retrieves the DOM object and uses the DOM object to retrieve an element within the document:

function getContainer(containerName){var HTMLDom = crosstab.getHtmlDom( );var container = HTMLDom.getElementById(containerName);return container;

}

getPageContentSyntax actuate.xtabanalyzer.PageContent Crosstab.getPageContent( )

Returns the page content from the current page to which this cross tab belongs. This function returns the same information as XTabAnalyzer.getCurrentPageContent( ).

Returns actuate.xtabanalyzer.PageContent. The report content.

Example This example retrieves the page content:

function retrievePageContent( ){return crosstab.getPageContent( );

}

getRowSyntax string[ ] Crosstab.getRow(integer rowIndex)

Returns table data based on row index.

Parameter rowIndexInteger. The row index, starting with 1.

Returns String[ ]. The row data as an array of string values. This function returns null when the value of rowIndex is out of range. This function only returns data from the current visible page.

Example The following code retrieves data from a data row:

function getRowData(index,value){var rowData = crosstab.getRow(index);if( !rowData ){

alert( "Invalid row index!" )return null;

}

return rowData[value];}

Page 595: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 577

actuate.xtabanalyzer.Crosstab

getTypeSyntax string Crosstab.getType( )

Returns the report element type.

Returns String containing the value "Crosstab".

hideDetailSyntax void Crosstab.hideDetail(string levelName)

Hides details of the specified level.

Parameter levelNameString. The full name of a dimension level to hide.

Example This example hides lower level details in a level:

function hideDetail( ){if(crosstab){

var levelName = "rollLevelName";crosstab.hideDetail(levelName);crosstab.submit( );

}}

pivotSyntax void Crosstab.pivot( )

Pivots the cross tab.

Example This example pivots a cross tab:

function pivot(crosstab){crosstab.pivot( );crosstab.submit( );

}

removeDimensionSyntax void Crosstab.removeDimension(object dimension, integer axisType,

integer[ ] levels)

Removes a dimension from the cross tab.

Parameters dimensionactuate.xtabanalyzer.dimension object, a dimension index, or a dimension name. The dimension to remove.

Page 596: Actuate API Reference - OpenText

578 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Crosstab

axisTypeInteger. The dimension axis type. Axis type can be one of the following values:

■ actuate.xtabanalyzer.Dimension.COLUMN_AXIS_TYPE

■ actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE

levelsThe levels assigned in the dimension, as an array of actuate.xtabanalyzer.Level objects, a level index array, or a level name array.

Example This example removes a dimension with several layers. The level names are in a text control named levelNames and are separated by semicolons.

function removeDimension( ){if(crosstab){

crosstab.removeDimension("dimensionName",null,"levelName");crosstab.submit( );

}}

removeMeasureSyntax void Crosstab.removeMeasure(actuate.xtabanalyzer.Measure measure)

void Crosstab.removeMeasure(integer measure)

void Crosstab.removeMeasure(string measure)

Removes a measure from the cross tab.

Parameter measureactuate.xtabanalyzer.measure object, index, or name. The measure to remove.

Example This example removes a measure from a cross tab:

function removeMeasure( ){crosstab.removeMeasure("measureName");crosstab.submit( );

}

reorderDimensionSyntax void Crosstab.reorderDimension(actuate.xtabanalyzer.Dimension dimension,

integer axisType, integer newIndex, integer newAxisType)

Reorders a dimension within a cross tab. This function can change a dimension’s index or axis type.

Parameters dimensionactuate.xtabanalyzer.dimension object, or a dimension index or a dimension name. The dimension to reorder.

Page 597: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 579

actuate.xtabanalyzer.Crosstab

axisTypeInteger. The dimension axis type. Axis type can be one of the following values:

■ actuate.xtabanalyzer.Dimension.COLUMN_AXIS_TYPE

■ actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE

newIndexThe new index for the dimension.

newAxisTypeThe new axis type.

Example This example changes the index and axis type of a dimension:

function changeDimensionOrder( ){var dimensionIndex = 5;var newDimensionIndex = 2;

var axisType = actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE;var newAxisType =

actuate.xtabanalyzer.Dimension.COLUMN_AXIS_TYPE;crosstab.reorderDimension(dimensionIndex, axisType,

newDimensionIndex, newAxisType);crosstab.submit( );

}

reorderMeasureSyntax void Crosstab.reorderMeasure(actuate.xtabanalyzerMeasure measure,

integer newIndex)

void Crosstab.reorderMeasure(integer measure,integer newIndex)

void Crosstab.reorderMeasure(string measure,integer newIndex)

Reorders a measure within a cross tab.

Parameters measureactuate.xtabanalyzer.Measure object, or a measure index or a measure name. The measure to reorder.

newIndexThe new index for the measure.

Example This example reorders a measure:

function changeMeasureOrder( ){var index = 6;var newIndex = 3;crosstab.reorderMeasure(index, newIndex);crosstab.submit( );

}

Page 598: Actuate API Reference - OpenText

580 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Crosstab

setFiltersSyntax void Crosstab.setFilters(actuate.xtabanalyzer.Filter[ ] filters)

Sets an array of filters for the cross tab.

Parameter filtersArray of actuate.xtabanalyzer.Filter objects. The filter conditions.

Example This example creates a Filter object and then places it into the cross tab:

function filterLevel( ){var levelName = "levelName";var operator = actuate.xtabanalyzer.Filter.BETWEEN;var filterValue = "20000;50000";var filter = new actuate.xtabanalyzer.Filter(levelName,

operator);filter.setValues(filterValue.split(";"));crosstab.setFilters(filter);crosstab.submit( );

}

setSortersSyntax void Crosstab.setSorters(actuate.xtabanalyzer.Sorter[ ] sorters)

Sets an array of sorters for the cross tab.

Parameter sortersArray of actuate.xtabanalyzer.Sorter objects. The sort settings.

Example This example creates a sorter and adds it to the cross tab:

function sortLevel( ){var levelName = "levelName";var sortAscending = true;var sorter = new actuate.xtabanalyzer.Sorter(levelName);sorter.setAscending(sortAscending);crosstab.setSorters(sorter);crosstab.submit( );

}

setTotalsSyntax void Crosstab.setTotals(actuate.xtabanalyzer.GrandTotal[ ] grandTotals,

actuate.xtabanalyzer.SubTotal[ ] subTotals)

Sets totals for the cross tab.

Page 599: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 581

actuate.xtabanalyzer.Crosstab

Parameters grandTotalsArray of actuate.xtabanalyzer.GrandTotal objects. Grand totals. To set a subtotal, set this parameter to null.

subTotalsArray of actuate.xtabanalyzer.SubTotal objects. Subtotals.

Example This example adds a grand total to a cross tab:

function addGrandTotal( ){var grandTotal = new actuate.xtabanalyzer.GrandTotal( );grandTotal.setAxisType(

actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE);

var total = new actuate.xtabanalyzer.Total( );total.setMeasureIndex(1);total.setAggregationFunction("SUM");total.setEnabled(true);grandTotal.addTotal(total);

crosstab.setTotals(grandTotal);crosstab.submit( );

}

showDetailSyntax void Crosstab.showDetail(string axisType)

Shows a level of detail within a cross tab.

Parameter axisTypeString. The dimension axis type. Axis type can be one of the following values:

■ actuate.xtabanalyzer.Dimension.COLUMN_AXIS_TYPE

■ actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE

Example This example uses showDetail to expose extra detail on a level:

function showDetail( ){var axisType = actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE;crosstab.showDetail(axisType);crosstab.submit( );

}

submitSyntax void Crosstab.submit(function callback)

Applies the changes made to this element. This is an asynchronous operation.

Page 600: Actuate API Reference - OpenText

582 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Crosstab

Parameter callbackFunction. Optional. The function called when submit( ) completes. This function receives the current XTabAnalyzer object as an input parameter.

Example This example uses submit( ) to confirm changes to the cross tab:

function showDetail(crosstab){var axisType = actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE;crosstab.showDetail(axisType);crosstab.submit( );

}

Page 601: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 583

actuate.xtabanalyzer .Dimension

Class actuate.xtabanalyzer.DimensionDescription The Dimension class specifies a cross tab Dimension object.

ConstructorSyntax actuate.xtabanalyzer.Dimension( )

The Dimension class is used to specify a Dimension object.

Function summaryTable 8-4 lists actuate.xtabanalyzer.Dimension functions.

addLevelSyntax void Dimension.addLevel(actuate.xtabanalyzer.Level level)

Adds a level to the dimension.

Parameter levelactuate.xtabanalyzer.Level object. A level to add to the dimension.

Example This example adds a level to a dimension:

Table 8-4 actuate.xtabanalyzer.Dimension functions

Function Description

addLevel( ) Adds the level to the dimension

getAxisType( ) Returns the axis type

getDimensionName( ) Returns the dimension name

getIndex( ) Returns the index of the dimension

getLevels( ) Returns cross tab levels

getNewAxisType( ) Returns the new axis type

getNewIndex( ) Returns the new index

setAxisType( ) Sets the axis type

setDimensionName( ) Sets the dimension name

setIndex( ) Sets the index

setLevels( ) Sets the levels

setNewAxisType( ) Sets the new axis type

setNewIndex( ) Sets the new index axis type

Page 602: Actuate API Reference - OpenText

584 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Dimension

function addLvl(dimension,levelName){var level = new actuate.xtabanalyzer.Level( );level.setLevelName(levelName);dimension.addLevel(level);

}

getAxisTypeSyntax integer Dimension.getAxisType( )

Returns the axis type for the dimension.

Returns Integer. The axis type can be one of the following values:

■ actuate.xtabanalyzer.Dimension.COLUMN_AXIS_TYPE

■ actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE

Example This example retrieves and sets the axis type:

function swapAxis(dimension){if (dimension.getAxisType( ) ==

actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE){dimension.setNewAxisType(

actuate.xtabanalyzer.Dimension.COLUMN_AXIS_TYPE);} else {

dimension.setNewAxisType(actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE);

}}

getDimensionNameSyntax string Dimension.getDimensionName( )

Returns the name of this dimension.

Returns String. The dimension name.

Example This example retrieves the dimension name:

function getDimName(dimension){if(dimension){

return dimension.getDimensionName( );}return null;

}

getIndexSyntax integer Dimension.getIndex( )

Page 603: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 585

actuate.xtabanalyzer .Dimension

Returns the dimension index.

Returns Integer. The dimension index.

Example This example retrieves and increments the index:

function incrementIndex(dimension){var newIndex = dimension.getIndex( ) + 1;dimension.setNewIndex(newIndex);

}

getLevelsSyntax actuate.xtabanalyzer.Level[ ] Dimension.getLevels( )

Returns the dimension levels.

Returns actuate.xtabanalyzer.Level[ ]. Array of dimension levels.

Example This example retrieves the dimension levels:

function getDimLevels(dimension){if(dimension){

return dimension.getLevels( );}return null;

}

getNewAxisTypeSyntax integer Dimension.getNewAxisType( )

Returns the new axis type.

Returns Integer containing the new axis type.

Example This example retrieves the new axis type:

function getNewDimAxis(dimension){if(dimension){

return dimension.getNewAxisType( );}return null;

}

getNewIndexSyntax integer Dimension.getNewIndex( )

Returns the new index.

Returns Integer. The new index.

Page 604: Actuate API Reference - OpenText

586 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Dimension

Example This example retrieves the new index:

function getNewDimIndex(dimension){if(dimension){

return dimension.getNewIndex( );}return null;

}

setAxisTypeSyntax void Dimension.setAxisType(integer axisType)

Sets the axis type when creating a new dimension. Use setNewAxisType( ) to change a dimension that already exists.

Parameter axisTypeThe axis type for the dimension. The axis type has the following legal values:

■ actuate.xtabanalyzer.Dimension.COLUMN_AXIS_TYPE

■ actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE

Example This example sets the axis type for a new dimension:

function setRowAxis(dimension){dimension.setAxisType(

actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE);}

setDimensionNameSyntax void Dimension.setDimensionName(string dimensionName)

Sets the name for a dimension during its creation.

Parameter dimensionNameString. The name of the dimension.

Example This example sets the dimension name to a value taken from a page element:

function setDimensionName(dimension){var dimensionName =

document.getElementById("dimensionName").value;dimension.setDimensionName(dimensionName);

}

setIndexSyntax void Dimension.setIndex(integer index)

Sets the index for the dimension.

Page 605: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 587

actuate.xtabanalyzer .Dimension

Parameter indexThe index of the dimension.

Example This example sets the dimension index to a value taken from a page element:

function setDimensionIndex(dimension){var dimensionIndex =

document.getElementById("dimensionIndex").value;dimension.setIndex(dimensionIndex);

}

setLevelsSyntax void Dimension.setLevels(xtabanalyzer.Level[ ] levels)

Sets levels for the dimension.

Parameter levelsArray of xtabanalyzer.Level objects representing the levels for the dimension.

Example This example sets the dimension levels:

function setDimensionLevels(dimension,levels){if (dimension && levels){

dimension.setLevels(levels);}

}

setNewAxisTypeSyntax void Dimension.setNewAxisType(integer newAxisType)

Sets the new axis type.

Parameter newAxisTypeInteger. The new axis type.

Example This example retrieves and changes the axis type:

function swapAxis(dimension){if (dimension.getAxisType( ) ==

actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE){dimension.setNewAxisType(

actuate.xtabanalyzer.Dimension.COLUMN_AXIS_TYPE);} else {

dimension.setNewAxisType(actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE);

}}

Page 606: Actuate API Reference - OpenText

588 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Dimension

setNewIndexSyntax void Dimension.setNewtIndex(integer newIndex)

Sets the new index.

Parameter newIndexInteger. The new index.

Example This example retrieves and increments the index:

function incrementIndex(dimension){var newIndex = dimension.getIndex( ) + 1;dimension.setNewIndex(newIndex);

}

Page 607: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 589

actuate.xtabanalyzer.Dri l ler

Class actuate.xtabanalyzer.DrillerDescription The Driller class enables an application to drill down or up levels on a member

within a dimension.

ConstructorSyntax actuate.xtabanalyzer.Driller( )

Creates a Driller object.

Function summaryTable 8-5 lists actuate.xtabanalyzer.Driller functions.

addMemberSyntax void Driller.addMember(actuate.xtabanalyzer.MemberValue member)

Adds a dimension member to the drill condition. Functional candidates are Dimension members with levels.

Parameter memberactuate.xtabanalyzer.MemberValue object. A member value to add.

Example This example adds a member to a Driller object:

function drillDownDimension( ){var driller = new actuate.xtabanalyzer.Driller( );driller.setDimension(

actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE);var memberValue =

new actuate.xtabanalyzer.MemberValue("drillLevelName");memberValue.setValue("drillLevelValue");driller.addMember(memberValue);crosstab.drill( driller );

Table 8-5 actuate.xtabanalyzer.Driller functions

Function Description

addMember( ) Adds a member to the drill condition

getDimension( ) Retrieves the driller dimension

getMembers( ) Retrieves the members used by the drill

setDimension( ) Sets the driller dimension

setMembers( ) Adds an array of members to the drill condition

Page 608: Actuate API Reference - OpenText

590 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Dri l ler

crosstab.submit( );}

getDimensionSyntax string Driller.getDimension( )

Returns the dimension name for the drill condition.

Returns String. A dimension name.

Example This example retrieves the dimension of the driller:

function getDrillerAxis(driller){if (driller){

return driller.getDimension( );}return null;

}

getMembersSyntax actuate.xtabanalyzer.MemberValue[ ] Driller.getMembers( )

returns the list of members assigned to the driller.

Returns Array of actuate.xtabanalyzer.MemberValue. A dimension member.

Example This example retrieves the members that a driller uses:

function getDrillerMembers(driller){if (driller){

return driller.getMembers( );}return null;

}

setDimensionSyntax void Driller.setDimension(string dimension)

Sets the dimension for the driller by name.

Parameter dimensionString. A dimension name.

Example This example sets the dimension name for the driller:

Page 609: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 591

actuate.xtabanalyzer.Dri l ler

function setRowAxis(driller){if (driller){

dimension.setDimension("Row");}

}

setMembersSyntax void Driller.setMembers(actuate.xtabanalyzer.MemberValue[ ] member)

Sets an array of members to the drill condition.

Parameter memberArray of actuate.xtabanalyzer.MemberValue objects. An array of members.

Example This example sets the axis type for the driller:

function setDrillerMembers(driller,members){if (driller && members){

driller.setMembers(members);}

}

Page 610: Actuate API Reference - OpenText

592 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .EventConstants

Class actuate.xtabanalyzer.EventConstantsDescription Defines constants for xtabanalyzer events. Table 8-6 lists the cross tab analyzer

event constants.

Table 8-6 actuate.xtabanalyzer.Dimension constants

Constant Description

ON_CONTENT_CHANGED Content changed event. Triggers when the displayed content has changed, for example when changing cross tab report content. The event handler takes an actuate.XTabAnalyzer object that represents the viewer for which the event occurred, as the only parameter.

ON_CONTENT_SELECTED Content selected event. Triggers when a user clicks on report elements. The event handler takes the following parameters: ■ actuate.XTabAnalyzer: object viewer for

which event occurred■ actuate.xtabanalyzer.SelectedContent: the

SelectedContent object

ON_EXCEPTION Exception event. Triggers when an exception occurs during an asynchronous operation. The event handler takes the following arguments: ■ actuate.XTabAnalyzer: viewer for which the

event occurred■ actuate.Exception: Exception object

ON_SESSION_TIMEOUT Session time-out event. When a session time-out event occurs and the user tries to perform any operation on a viewer, a prompt dialog appears asking the user whether or not to log in again. When the user chooses to log in again, the ON_SESSION_TIMEOUT event triggers. When no handler is registered for this event, a default built-in login dialog will be displayed. The event handler takes one parameter: an actuate.XTabAnalyzer object, representing the viewer where the event occurred.

Page 611: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 593

actuate.xtabanalyzer.Except ion

Class actuate.xtabanalyzer.ExceptionDescription A container for an XTabAnalyzer exception that supports specific exceptions. The

Exception class provides an object to pass to a callback function or event handler when an exception occurs. The Exception class contains references to the exception’s origin, description, and messages.

ConstructorThe Exception object is constructed when unspecified exceptions occur. The exceptions are divided into three types, which determine the contents of the Exception object. These types are:

■ ERR_CLIENT: Exception type for a client-side error

■ ERR_SERVER: Exception type for a server error

■ ERR_USAGE: Exception type for a JSAPI usage error

Function summaryTable 8-7 lists actuate.xtabanalyzer.Exception functions.

getDescriptionSyntax string Exception.getDescription( )

Returns exception details as provided by the Server, Client, and User objects.

Returns String. A detailed description of the error. Information is provided according to the type of exception generated, as shown below:

■ ERR_SERVER: The SOAP string

Table 8-7 actuate.xtabanalyzer.Exception functions

Function Description

getDescription( ) Returns details of the exception

getElement( ) Returns the report element for which the exception occurred, if available

getErrCode( ) Returns the error code for ERR_SERVER

getMessage( ) Returns a short message about the error

getType( ) Returns the type of error exception

isExceptionType( ) Returns Boolean indicating whether exception is of certain type

Page 612: Actuate API Reference - OpenText

594 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Except ion

■ ERR_CLIENT: For the Firefox browser, a list comprised of fileName+number+stack

■ ERR_USAGE: Any value set when the object was created

Example This example consists of a function that registerEventHandler( ) set as a callback. The callback function takes an instance of the Exception class. Each of the functions for the Exception class can be called with the results formatted to create a message or for some other use.

function errorHandler(viewerInstance, exception){alert(exception.getDescription( ));

}

getElementSyntax string Exception.getElement( )

Returns the report element for which the exception occurred, if available.

Returns String. The report element for which the exception occurred.

Example This example uses getElement( ):

function errorHandler(viewerInstance, exception){alert("Error in " + exception.getElement( ));

}

getErrCodeSyntax string Exception.getErrCode( )

Returns the error code for ERR_SERVER.

Returns String. The error code for ERR_SERVER.

Example This example uses getErrCode( ):

function errorHandler(viewerInstance, exception){alert(exception.getErrCode( ));

}

getMessageSyntax string Exception.getMessage( )

Returns a short message about the error.

Returns String. A short message about the exception.

Example This example uses getMessage( ):

Page 613: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 595

actuate.xtabanalyzer.Except ion

function errorHandler(viewerInstance, exception){alert(exception.getMessage( ));

}

getTypeSyntax string Exception.getType( )

Returns the type of exception error.

Returns String. The errType exception type.

Example This example uses getType( ):

function errorHandler(viewerInstance, exception){alert(exception.getType( ));

}

isExceptionTypeSyntax boolean Exception.isExceptionType(object exceptionType)

Checks an exception’s type for a match against a specified type.

Parameter exceptionTypeAn exception type as string, or exception class. For example, "actuate.viewer.ViewerException" or actuate.viewer.ViewerException.

Returns True if the exception is of the stated type, false otherwise.

Example This example checks to see if the exception is a client error type:

function errorHandler(viewerInstance, exception){if (exception.isExceptionType(ERR_CLIENT){

alert("CLIENT ERROR");}

}

Page 614: Actuate API Reference - OpenText

596 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Fi l ter

Class actuate.xtabanalyzer.FilterDescription The Filter class creates a filter condition on a cross tab dimension level. The

condition is expressed as value1 operator value2. The values can either be a single value, or an array of values, depending on the operator. For example, IN can be expressed as value1 IN value2 value3 ... valueN.

ConstructorSyntax actuate.xtabanalyzer.Filter(string levelName, string levelAttributeName, string

operator, string value, string filterType)

actuate.xtabanalyzer.Filter(string levelName, string levelAttributeName, string operator, string value1, string value2, string filterType)

actuate.xtabanalyzer.Filter(string levelName, string levelAttributeName, string operator, string[ ] values, string filterType)

Constructs a cross tab Filter object.

Parameters levelNameString. The dimension level full name.

levelAttributeNameString. The dimension level attribute name.

operatorString. The operator can be any operator. Table 8-8 lists the valid filter operators and the number of arguments to pass to the constructor or setValues( ).

Table 8-8 Filter operators

Operator DescriptionNumber of arguments

BETWEEN Between an inclusive range 2

BOTTOM_N Matches the bottom n values

1

BOTTOM_PERCENT Matches the bottom percent of the values

1

EQ Equal 1

FALSE Matches false Boolean values

0

GREATER_THAN Greater than 1

GREATER_THAN_OR_EQUAL Greater than or equal 1

Page 615: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 597

actuate.xtabanalyzer.Fi l ter

valueString. The value to compare to the column value.

value1String. The first value to compare to the column value for the BETWEEN or NOT_BETWEEN operators.

value2String. The second value to compare to the column value for the BETWEEN or NOT_BETWEEN operators.

valuesArray of strings. The values to compare to the column value for the IN and NOT_IN operators.

IN Matches any value in a set of values

1+

LESS_THAN Less than 1

LESS_THAN_OR_EQUAL Less than or equal 1

LIKE Search for a pattern 1

MATCH Equal 1

NOT_BETWEEN Not between an inclusive range

2

NOT_EQ Not equal 1

NOT_IN Does not match any value in a set of values

1+

NOT_LIKE Searches for values that do not match a pattern

1

NOT_MATCH Not equal 1

NOT_NULL Is not null 0

NULL Is null 0

TOP_N Matches the top n values 1

TOP_PERCENT Matches the top percent of the values

1

TRUE Matches true Boolean values

0

Table 8-8 Filter operators

Operator DescriptionNumber of arguments

Page 616: Actuate API Reference - OpenText

598 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Fi l ter

filterTypeString. The filter type.

Function summaryTable 8-9 lists actuate.xtabanalyzer.Filter functions.

getFilterTypeSyntax string Filter.getFilterType( )

Returns the filter type.

Returns String. The filter type.

Example This example retrieves the filter type for a filter:

function getType(filter){if(filter){

return filter.getFilterType( );}else{

return null;}

}

getLevelAttributeNameSyntax string Filter.getLevelAttribute Name( )

Returns the name of the dimension level attribute to which this filter applies.

Table 8-9 actuate.xtabanalyzer.Filter functions

Function Description

getFilterType( ) Returns the filter type

getLevelAttributeName( ) Returns the dimension level attribute name

getLevelName( ) Returns the name of the filtered level

getOperator( ) Returns the filter operator

getValues( ) Returns the set of values the filter is using

setFilterType( ) Sets the filter type

setLevelAttributeName( ) Sets the dimension level attribute name

setLevelName( ) Sets the dimension level name

setOperator( ) Sets the filter operator

setValues( ) Sets the values for the filter

Page 617: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 599

actuate.xtabanalyzer.Fi l ter

Returns String. The level attribute name.

Example This example retrieves the filter level attribute name for a filter:

function getLevelAttribute(filter){if(filter){

return filter.getLevelAttributeName( );}else{

return null;}

}

getLevelNameSyntax string Filter.getLevelName( )

Returns the name of the dimension level to which this filter applies.

Returns String. A level name.

Example This example retrieves the filter level name for a filter:

function getLevel(filter){if(filter){

return filter.getLevelName( );}else{

return null;}

}

getOperatorSyntax string Filter.getOperator( )

Returns the filter operator.

Returns String. The filter operator.

Example This example retrieves the filter operator:

function getFilterOp(filter){if(filter){

return filter.getOperator( );}else{

return null;}

}

Page 618: Actuate API Reference - OpenText

600 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Fi l ter

getValuesSyntax string[ ] Filter.getValues( )

Returns an array containing the values used in the filter.

Returns Array of strings. The values for the filter.

Example This example retrieves the filter level name for a filter:

function getFilterOp(filter){if(filter){

return filter.getValues( );}else{

return null;}

}

setFilterTypeSyntax void Filter.setFilterType(string filterType)

Sets the filter type to filter.

Parameter filterTypeString. The type of filter.

Example This example sets the filter type to equality:

function filterLevel( ){var filterType = "equality";var filter = new actuate.xtabanalyzer.Filter("levelName",

"attributeName", actuate.xtabanalyzer.Filter.EQ, "2000", "blank");

filter.setFilterType(filterType);crosstab.setFilters( filter );crosstab.submit( );

}

setLevelAttributeNameSyntax void Filter.setLevelAttributeName(string levelAttributeName)

Sets the dimension level attribute to filter on by name.

Parameter levelAttributeNameString. The name of the level attribute to filter.

Example This example sets the level attribute name to attributeName:

function filterLevel( ){var attributeName = "attributeName";

Page 619: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 601

actuate.xtabanalyzer.Fi l ter

var filter = new actuate.xtabanalyzer.Filter("levelName", "blank", actuate.xtabanalyzer.Filter.EQ, "2000", "equality");

filter.setLevelAttributeName(attributeName);crosstab.setFilters( filter );crosstab.submit( );

}

setLevelNameSyntax void Filter.setLevelName(string level)

Sets the level to filter by name.

Parameter levelString. The name of the level to filter.

Example This example sets the filter level name to levelName:

function filterLevel( ){var levelName = "levelName";var filter = new actuate.xtabanalyzer.Filter("blank",

"attributeName", actuate.xtabanalyzer.Filter.EQ, "2000", "equality");

filter.setLevelName(levelName);crosstab.setFilters( filter );crosstab.submit( );

}

setOperatorSyntax void Filter.setOperator(string operator)

Sets the filter operator.

Parameter operatorString. The filter operator.

Example This example sets the filter operator to EQ:

function filterLevel( ){var operator = "EQ";var filter = new actuate.xtabanalyzer.Filter("levelName",

"attributeName", actuate.xtabanalyzer.Filter.NOT, "2000", "equality");

filter.setOperator(operator);crosstab.setFilters( filter );crosstab.submit( );

}

Page 620: Actuate API Reference - OpenText

602 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Fi l ter

setValuesSyntax void Filter.setValues(string[ ] value1, string[ ] value2)

Sets the values for the filter.

Parameters value1String or array of strings. The first value of the filter.

value2String or array of strings. Optional. The second value of the filter.

Example This example sets the filter values to 2010 and 2015:

function filterLevel( ){if(crosstab){

var filterValue = "2010;2015";var filter = new actuate.xtabanalyzer.Filter("levelName",

"attributeName", actuate.xtabanalyzer.Filter.BETWEEN);filter.setValues(filterValue.split(";") );crosstab.setFilters( filter );crosstab.submit( );

}}

Page 621: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 603

actuate.xtabanalyzer.GrandTotal

Class actuate.xtabanalyzer.GrandTotalDescription The GrandTotal class specifies a cross tab GrandTotal object.

ConstructorSyntax actuate.xtabanalyzer.GrandTotal( )

Constructs a new GrandTotal object.

Function summaryTable 8-10 lists actuate.xtabanalyzer.GrandTotal functions.

addTotalSyntax void GrandTotal.addTotal(object total)

Adds a total to the cross tab.

Parameter totalactuate.xtabanalyzer.total. The total to add to the cross tab.

Example This example adds totals to a grand total:

function addTotal(grandTotal){// The indexStr can be set from a web page or other source as// necessary.

var indexStr = "0;1;2;3;4";var indexs = indexsStr.split(";");var count = indexs.length;var measureIndexs = [ ];for(var i = 0;i < count;i++){

measureIndexs.push(parseInt(indexs[i]));}for( var i = 0; i < measureIndexs.length; i++){

Table 8-10 actuate.xtabanalyzer.GrandTotal functions

Function Description

addTotal( ) Adds a total

getAxisType( ) Returns the axis type

getTotals( ) Returns the totals array

getType( ) Returns the grand total type

setAxisType( ) Sets the axis type

setTotals( ) Sets the totals array

Page 622: Actuate API Reference - OpenText

604 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .GrandTotal

var total = new actuate.xtabanalyzer.Total( );total.setMeasureIndex(measureIndexs[i]);total.setAggregationFunction("SUM");total.setEnabled(true);grandTotal.addTotal(total);

}}

getAxisTypeSyntax integer GrandTotal.getAxisType( )

Returns the axis type for the total.

Returns Integer. The following values are legal axis types:

■ actuate.xtabanalyzer.Dimension.COLUMN_AXIS_TYPE

■ actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE

Example This example retrieves and sets the axis type:

function swapAxis(grandtotal){if (grandtotal.getAxisType( ) ==

actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE){grandtotal.setNewAxisType(

actuate.xtabanalyzer.Dimension.COLUMN_AXIS_TYPE);} else {

grandtotal.setNewAxisType(actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE);

}}

getTotalsSyntax object[ ] GrandTotal.getTotals( )

Returns an array containing the totals.

Returns Array of Total objects. The totals.

Example This example retrieves totals from a GrandTotal object:

var totalsArray = [ ];function getTotals(grandTotal,totalsArray){

totalsArray = grandTotal.getTotals( );}

getTypeSyntax string GrandTotal.getType( )

Page 623: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 605

actuate.xtabanalyzer.GrandTotal

Returns the type for the total.

Returns String. The total type.

setAxisTypeSyntax void GrandTotal.setAxisType(integer axisType)

Sets the axis type for the total.

Parameter axisTypeInteger. Axis type for the total.

Example This example retrieves and sets the axis type:

function swapAxis(grandtotal){if (grandtotal.getAxisType( ) ==

actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE){grandtotal.setNewAxisType(

actuate.xtabanalyzer.Dimension.COLUMN_AXIS_TYPE);} else {

grandtotal.setNewAxisType(actuate.xtabanalyzer.Dimension.ROW_AXIS_TYPE);

}}

setTotalsSyntax void GrandTotal.setTotals(actuate.xtabanalyzer.Total[ ] totals)

Sets totals as an array.

Parameter totalsArray of actuate.xtabanalyzer.Total objects to add to the grand total.

Example This example copies the totals from grandtotal1 into grandtotal2:

grandtotal2.setTotals(grandtotal1.getTotals( ));

Page 624: Actuate API Reference - OpenText

606 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Level

Class actuate.xtabanalyzer.LevelDescription Defines a cross tab dimension level, its controls, and content.

ConstructorSyntax actuate.xtabanalyzer.Level( )

Creates a cross tab Level object.

Function summaryTable 8-11 lists actuate.xtabanalyzer.Level functions.

addAttributeSyntax void Level.addAttribute(actuate.xtabanalyzer.LevelAttribute attr)

Adds the level attribute.

Parameter indexactuate.xtabanalyzer.LevelAttribute object. A level attribute.

Example This example sets a name for newly created level attribute and assigns the attribute to a level:

var attribute = new actuate.xtabanalyzer.LevelAttribute( );attribute.setName("pounds");level.addLevelAttribute( attribute );

getAttributesSyntax actuate.xtabanalyzer.LevelAttribute[ ] Level.getAttributes( )

Returns the level attributes.

Table 8-11 actuate.xtabanalyzer.Level functions

Function Description

addAttribute( ) Adds the level attribute

getAttributes( ) Returns the level attributes

getIndex( ) Returns the index of the level

getLevelName( ) Returns the level name

setIndex( ) Sets the index level

setLevelName( ) Sets the level name

Page 625: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 607

actuate.xtabanalyzer .Level

Returns Array of actuate.xtabanalyzer.LevelAttribute objects. The level attributes.

Example This example retrieves the level index and stores it in a variable called lattributes:

var lattributes = new actuate,xtabanalyzer.LevelAttribute[ ];lattributes = level.getAttributes( );

getIndexSyntax integer Level.getIndex( )

Returns the level index.

Returns Integer. The level index.

Example This example retrieves the level index:

function levelIndex(level){if (level){

return level.getIndex( );}return null;

}

getLevelNameSyntax string Level.getLevelName( )

Returns the level name.

Returns String. The level name.

Example This example retrieves the level name:

function levelName(level){if (level){

return level.getLevelName( );}return null;

}

setIndexSyntax void Level.setIndex(integer index)

Sets the level index.

Parameter indexInteger. The level index.

Example This example sets the level index:

Page 626: Actuate API Reference - OpenText

608 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Level

function assignIndex(level,index){if (level){

return level.setIndex(index);}

}

setLevelNameSyntax void Level.setLevelName(string levelName)

Sets the level name.

Parameter levelNameString. The level name.

Example This example sets level names for newly created levels:

var levelNames ="year;month;day";...function addLevels(dimension,levelNames);{

var levelNamesArray = levelNames.split(";");for( var i = 0; i < levelNames.length; i++ ){

var level = new actuate.xtabanalyzer.Level( );level.setLevelName(levelNames[i]);dimension.addLevel( level );

}}

Page 627: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 609

actuate.xtabanalyzer .LevelAtt r ibute

Class actuate.xtabanalyzer.LevelAttributeDescription Defines an attribute for a level.

ConstructorSyntax actuate.xtabanalyzer.LevelAttribute( )

Creates a cross tab level attribute object.

Function summaryTable 8-12 lists actuate.xtabanalyzer.LevelAttribute functions.

getNameSyntax string LevelAttribute.getName( )

Returns the level attribute name.

Returns String. A level attribute name.

Example This example retrieves the level attribute name and stores it in a variable attname:

var attname = levelattribute.getName( );

setNameSyntax void LevelAttribute.setName(string attributeName)

Sets the level attribute name.

Parameter attributeNameString. The level attribute name.

Example This example sets a name for newly created level attribute and assigns the attribute to a level:

var attribute = new actuate.xtabanalyzer.LevelAttribute( );attribute.setName("pounds");level.addLevelAttribute( attribute );

Table 8-12 actuate.xtabanalyzer.Level functions

Function Description

getName( ) Returns the level attribute name

setName( ) Sets the level attribute name

Page 628: Actuate API Reference - OpenText

610 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Measure

Class actuate.xtabanalyzer.MeasureDescription Defines a cross tab measure.

ConstructorSyntax actuate.xtabanalyzer.Measure( )

Creates a cross tab measure object.

Function summaryTable 8-13 lists actuate.xtabanalyzer.Measure functions.

getAggregationFunctionSyntax string Measure.getAggregationFunction( )

Returns the aggregation function name.

Returns String. An aggregation function name.

Example This example changes the aggregation function:

function swapMeasureAggregation(measure){if (measure.getAggregation( ) == "EQ"){

measure.setAggregation("NE");

Table 8-13 actuate.xtabanalyzer.Measure functions

Function Description

getAggregationFunction( ) Returns the aggregation function name

getDataType( ) Returns the computed column data type

getExpression( ) Returns the computed measure expression

getIndex( ) Returns the measure index

getMeasureName( ) Returns the measure name

getNewIndex( ) Returns the new index

setAggregationFunction( ) Sets the aggregation function name

setDataType( ) Sets the computed column data type

setExpression( ) Sets the computed measure expression

setIndex( ) Sets the measure index

setMeasureName( ) Sets the measure name

setNewIndex( ) Sets the new index

Page 629: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 611

actuate.xtabanalyzer .Measure

}else{measure.setAggregation("EQ");

}}

getDataTypeSyntax string Measure.getDataType( )

Returns the computed column data type.

Returns String. The data type.

Example This example retrieves the computed column data type:

function getColumnDataType(measure){if (measure){

return measure.getDataType( );}return null;

}

getExpressionSyntax string Measure.getExpression( )

Returns the computed measure expression.

Returns String. An expression.

Example This example retrieves the computed measure expression:

function getMeasureExpression(measure){if (measure){

return measure.getExpression( );}return null;

}

getIndexSyntax integer Measure.getIndex( )

Returns the measure index.

Returns Integer. The measure index.

Example This example retrieves the measure index:

function getMeasureIndex(measure){if (measure){

Page 630: Actuate API Reference - OpenText

612 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Measure

return measure.getIndex( );}return null;

}

getMeasureNameSyntax string Measure.getMeasureName( )

Returns the measure name.

Returns String. The name of the measure.

Example This example retrieves the measure name:

function getMeasureName(measure){if (measure){

return measure.getMeasureName( );}return null;

}

getNewIndexSyntax integer Measure.getNewIndex( )

Retrieves the new index. The new index is set by setNewIndex and represents the index value the measure has after submit( ) finishes executing.

Returns Integer. The new index.

Example This example retrieves the new measure index:

function getNewMeasureIndex(measure){if (measure){

return measure.getNewIndex( );}return null;

}

setAggregationFunctionSyntax void Measure.setAggregationFunction(string aggregationFunction)

Sets the aggregation function name.

Parameter aggregationFunctionString. The aggregation function name.

Example This example changes the aggregation function:

Page 631: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 613

actuate.xtabanalyzer .Measure

function swapMeasureAggregation(measure){if (measure.getAggregation( ) == "EQ"){

measure.setAggregation("NE");}else{

measure.setAggregation("EQ");}

}

setDataTypeSyntax void Measure.setDataType(string dataType)

Sets the computed column data type name.

Parameter dataTypeString. The data type.

setExpressionSyntax void Measure.setExpression(string expression)

Sets the computed measure expression.

Parameter expressionString. The computed measure expression.

Example This example uses setExpression:

function addMeasure(viewer){var crosstab = getCrosstab(viewer);if(crosstab){

var measureName = "measureName";var measureExpression =

"[revenue]/[revenue_SalesDate/year_Product/PRODUCTLINE]";

var measure = new actuate.xtabanalyzer.Measure( );measure.setIndex(1);measure.setMeasureName(measureName);measure.setExpression(measureExpression);

crosstab.addMeasure(measure);crosstab.submit( );

}}

setIndexSyntax void Measure.setIndex(integer index)

Sets the index.

Page 632: Actuate API Reference - OpenText

614 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Measure

Parameter indexInteger. The index of this measure.

Example This example uses setIndex to add a new measure to a cross tab:

function setIndex(measure, index){measure.setIndex(index);

}

setMeasureNameSyntax void Measure.setMeasureName(string measureName)

Sets the measure name.

Parameter measureNameString. The measureName.

Example This example sets the measure name which is taken from a page element:

function renameMeasure(measure){var measureName = document.getElementById("measureName").value;measure.setMeasureName(measureName);

}

setNewIndexSyntax void Measure.setNewIndex(integer newIndex)

Sets a new measure index.

Parameter newIndexInteger. The new measure index.

Example This example changes the index for the measure:

function changeIndex(measure,index){if (measure){

measure.setNewIndex(index);}

}

Page 633: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 615

actuate.xtabanalyzer.MemberValue

Class actuate.xtabanalyzer.MemberValueDescription Defines a member value used for sort, filter, or drill functionality.

ConstructorSyntax actuate.xtabanalyzer.MemberValue(levelName, value, (MemberValue))

Creates a MemberValue object for a given level and value. The object can contain multiple member values.

Parameters levelNameString. Dimension level name of member.

valueString. Value for the member to contain.

MemberValueOptional actuate.xtabanalyzer.MemberValue object. MemberValue object to add during construction.

Function summaryTable 8-14 lists actuate.xtabanalyzer.MemberValue functions.

addMemberSyntax void MemberValue.addMember(actuate.xtabanalyzer.MemberValue member)

Adds a member value.

Parameter memberactuate.xtabanalyzer.MemberValue object. A member value.

Example MemberValue is an embedded class that can be a single value or an array of values. This example has a single member that contains four members:

Table 8-14 actuate.xtabanalyzer.MemberValue functions

Function Description

addMember( ) Adds a member value object

getLevelName( ) Retrieves the level name

getMembers( ) Retrieves an array of members

getValue( ) Returns the level value

setLevelName( ) Sets the level name

setValue( ) Sets the member value

Page 634: Actuate API Reference - OpenText

616 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .MemberValue

function addMembers(memberData){var mv1 = new MemberValue('dim/state','CA');var mv2 = new MemberValue('dim/state','CN');var mv3 = new MemberValue(memberData);var mv = new MemberValue('dim/country','USA');mv.addMember(mv1);mv.addMember(mv2);mv.addMember(mv3);return mv;

}

getLevelNameSyntax string MemberValue.getLevelName( )

Returns the level name of the member.

Returns String. The level name.

Example This example retrieves the level name for the member value:

function getLevelName(level){if (level){

return level.getLevelName( );}return null;

}

getMembersSyntax actuate.xtabanalyzer.MemberValue[ ] MemberValue.getMembers( )

Returns all the member value objects contained in this member value object.

Returns Array of actuate.xtabanalyzer.MemberValue. An array of MemberValue objects.

Example This example returns the number of members in a member object:

function getMemberCount(members){if (members){

var membersArray[] = members.getMembers( );return membersArray.length;

}return null;

}

getValueSyntax string MemberValue.getValue( )

Page 635: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 617

actuate.xtabanalyzer.MemberValue

Returns the level value.

Returns String. The level value.

Example This example returns the value for the level:

function getMemberValue(members){if (members){

return members.getValue( );}return null;

}

setLevelNameSyntax void MemberValue.setLevelName(string level)

Sets the level name.

Parameter levelString. The name of the level.

Example This example sets the level name:

function getMemberValue(members){if (members){

return members.getValue( );}return null;

}

setValueSyntax void MemberValue.setValue(string level)

Sets the level value.

Parameter levelString. The value for the level.

Example This example sets the level value:

function setMemberLevelValue(member,lvlValue){if (member){

member.setValue(lvlValue);}

}

Page 636: Actuate API Reference - OpenText

618 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Opt ions

Class actuate.xtabanalyzer.OptionsDescription The Options class specifies options for the cross tab.

ConstructorSyntax actuate.xtabanalyzer.Options(string measureDirection, string

rowMirrorStartingLevel, string columnMirrorStartingLevel, string emptyCellValue, boolean enablePageBreak, integer rowPageBreakInterval, integer columnPageBreakInterval)

Creates an options object that contains options for how the cross tab displays data.

Parameters measureDirectionString. The measure direction. Legal values for measure direction are:

■ DIRECTION_HORIZONTAL

■ DIRECTION_VERTICAL

rowMirrorStartingLevelString. Row mirror starting level name.

columnMirrorStartingLevelString. Column mirror starting level name.

emptyCellValueString. Value to display for an empty cell.

enablePageBreakBoolean. Enables page breaks when true.

rowPageBreakIntervalInteger. Row page break interval.

columnPageBreakIntervalInteger. Column page break interval.

grandTotalsDisplayOptionString. Grand totals display option. Legal values for total display options are:

■ DIRECTION_HORIZONTAL

■ DIRECTION_VERTICAL

subtotalsDisplayOptionString. Subtotals display option. Legal values for total display options are:

■ DIRECTION_HORIZONTAL

■ DIRECTION_VERTICAL

Page 637: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 619

actuate.xtabanalyzer.Options

Function summaryTable 8-15 lists actuate.xtabanalyzer.Options functions.

getColumnMirrorStartingLevelSyntax string Options.getColumnMirrorStartingLevel( )

Returns the column mirror starting level name.

Returns String. Column mirror starting level name.

Example This example retrieves the column mirror starting level:

function getColumnMirrorStart(options){if (options){

return options.getColumnMirrorStartinglevel( );}return null;

}

Table 8-15 actuate.xtabanalyzer.Options functions

Function Description

getColumnMirrorStartingLevel( ) Returns the column mirror starting level full name

getColumnPageBreakInterval( ) Returns the column page break interval

getEmptyCellValue( ) Returns the empty cell value

getEnablePageBreak( ) Returns the page break enabled or disabled status

getMeasureDirection( ) Returns the measure direction

getRowMirrorStartingLevel( ) Returns the row mirror starting level full name

getRowPageBreakInterval( ) Returns the row page break interval

setColumnMirrorStartingLevel( ) Sets the column mirror starting level full name

setColumnPageBreakInterval( ) Sets the column page break interval

setEmptyCellValue( ) Sets the empty cell value

setEnablePageBreak( ) Sets the flag to enable page breaks

setMeasureDirection( ) Sets the measure direction

setRowMirrorStartingLevel( ) Sets the row mirror starting level full name

setRowPageBreakInterval( ) Sets the row page break interval

Page 638: Actuate API Reference - OpenText

620 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Opt ions

getColumnPageBreakIntervalSyntax integer Options.getColumnPageBreakInterval( )

Returns the column page break interval.

Returns Integer. The column page break interval.

Example This example retrieves the column page break interval:

function getColumnPBInterval(options){if (options){

return options.getColumnPageBreakInterval( );}return null;

}

getEmptyCellValueSyntax string Options.getEmptyCellValue( )

Returns the empty cell value.

Returns String. Value to display for an empty cell.

Example This example retrieves the empty cell:

function getEmptyCell(options){if (options){

return options.getEmptyCellValue( );}return null;

}

getEnablePageBreakSyntax boolean Options.getEnablePageBreak( )

Returns the page break status.

Returns Boolean. Page breaks are enabled when the value is true.

Example This example retrieves the column page break interval when page breaks are enabled:

function getColumnPBEnabled(options){if (options.getEnablePageBreak( )) {

return options.getColumnPageBreakInterval( );} else {

alert ("Page breaks not enabled.");return null;

}

Page 639: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 621

actuate.xtabanalyzer.Options

}

getMeasureDirectionSyntax string Options.getMeasureDirection( )

Returns the measure direction.

Returns String. The measure direction. Legal values for measure direction are:

■ DIRECTION_HORIZONTAL

■ DIRECTION_VERTICAL

Example This example retrieves the measure direction:

function getMeasureDirection(options){if (options){

return options.getMeasureDirection( );}return null;

}

getRowMirrorStartingLevelSyntax string Options.getRowMirrorStartingLevel( )

Returns the row mirror starting level name.

Returns String. Row mirror starting level name.

Example This example retrieves the row mirror starting level:

function getRowMirrorStart(options){if (options){

return options.getRowMirrorStartinglevel( );}return null;

}

getRowPageBreakIntervalSyntax integer Options.getRowPageBreakInterval( )

Returns the row page break interval.

Returns Integer. The row page break interval.

Example This example retrieves the row page break interval:

function getRowPBInterval(options){if (options){

Page 640: Actuate API Reference - OpenText

622 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Opt ions

return options.getRowPageBreakInterval( );}return null;

}

setColumnMirrorStartingLevelSyntax void Options.setColumnMirrorStartingLevel(string levelName)

Sets the column mirror starting level name.

Parameter levelNameString. The column mirror starting level name.

Example This example sets the column mirror starting level:

function setColumnMirrorLevel(options,level)(if (options){

options.setColumnMirrorStartingLevel(level);}

}

setColumnPageBreakIntervalSyntax void Options.setColumnPageBreakInterval(integer columnPageBreakInterval)

Sets the column page break interval.

Parameter columnPageBreakIntervalInteger. The column page break interval.

Example This example sets the column page break interval:

function setColumnPBInterval(options,interval)(if (options){

options.setColumnPageBreakInterval(interval);}

}

setEmptyCellValueSyntax void Options.setEmptyCellValue(string emptyCellValue)

Sets the empty cell value.

Parameter emptyCellValueString. The empty cell value.

Example This example sets the empty cell value:

function setEmptyCell(options, cellValue)(if (options){

Page 641: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 623

actuate.xtabanalyzer.Options

options.setEmptyCellValue(cellValue);}

}

setEnablePageBreakSyntax void Options.setEnablePageBreak(boolean enablePageBreak)

Enables or disables page breaks.

Parameter enablePageBreakBoolean. Enables page breaks when true.

Example This example enables page breaks and sets the row page break interval:

function enablesetRowPBInterval(options,interval)(if (options){

options.setEnablePageBreak(true);options.setRowPageBreakInterval(interval);

}}

setMeasureDirectionSyntax void Options.setMeasureDirection(string measureDirection)

Sets the measure direction.

Parameter measureDirectionString. The measure direction. The measure direction. Legal values for measure direction are:

■ DIRECTION_HORIZONTAL

■ DIRECTION_VERTICAL

Example This example sets the measure direction:

function setMeasureDirection(options,direction){if (options){

options.setMeasureDirection(direction);}

}

setRowMirrorStartingLevelSyntax void Options.setRowMirrorStartingLevel(string levelName)

Sets the row mirror starting level.

Page 642: Actuate API Reference - OpenText

624 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Opt ions

Parameter levelNameString. Row mirror starting level name.

Example This example sets the row mirror starting level:

function setRowMirrorLevel(options,level){if (options){

options.setRowMirrorStartingLevel(level);}

}

setRowPageBreakIntervalSyntax void Options.setRowPageBreakInterval(integer rowPageBreakInterval)

Sets the row page break interval.

Parameter rowPageBreakIntervalInteger. The row page break interval.

Example This example sets the row page break interval:

function setRowPBInterval(options,interval)(if (options){

options.setRowPageBreakInterval(interval);}

}

Page 643: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 625

actuate.xtabanalyzer.PageContent

Class actuate.xtabanalyzer.PageContentDescription A container for the content of a cross tab page. It contains a comprehensive list of

report elements, such as tables, charts, labels, and data items.

ConstructorSyntax actuate.xtabanalyzer.PageContent( )

Creates a PageContent object that represents the report content that is generated by a report design file or document file.

Function summaryTable 8-16 lists actuate.xtabanalyzer.PageContent functions.

getCrosstabByBookmarkSyntax actuate.xtabanalyzer.crosstab PageContent.getCrosstabByBookmark(string

bookmark)

Returns a cross tab object associated with a bookmark.

Parameter bookmarkThe bookmark name of the item requested.

Returns actuate.xtabanalyzer.crosstab object.

Example This example retrieves the viewer ID, then retrieves the cross tab:

function getCrosstab( ){var viewer = PageContent.getViewerId( );var content = viewer.getCurrentPageContent( );var crosstab = content.getCrosstabByBookmark( );return crosstab;

}

getViewerIdSyntax string PageContent.getViewerId( )

Returns the XTabAnalyzer ID. The XTabAnalyzer is the cross tab viewer element.

Table 8-16 actuate.xtabanalyzer.PageContent functions

Function Description

getCrosstabByBookmark( ) Returns a report cross tab object

getViewerId( ) Returns the cross tab viewer ID

Page 644: Actuate API Reference - OpenText

626 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .PageContent

Returns String. The XTabAnalyzer ID.

Example This example retrieves the viewer ID, then retrieves the cross tab:

function getCrosstab( ){var viewer = PageContent.getViewerId( );var content = viewer.getCurrentPageContent( );var crosstab = content.getCrosstabByBookmark( );return crosstab;

}

Page 645: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 627

actuate.xtabanalyzer.ParameterValue

Class actuate.xtabanalyzer.ParameterValueDescription A container for the ParameterValue in the xtabanalyzer.

ConstructorSyntax actuate.xtabanalyzer.ParameterValue(string name, string value, boolean

valueIsNull)

The ParameterValue class is used to specify a cross tab ParameterValue object.

Parameters nameString. The parameter name.

valueString. The parameter value.

valueIsNullBoolean. Whether the value is null.

Function summaryTable 8-17 lists actuate.xtabanalyzer.ParameterValue functions.

getNameSyntax string ParameterValue.getName( )

Returns the name for the parameter.

Returns String. The parameter name.

Example This example retrieves the parameter name:

function getParameterName(parametervalue){if (parametervalue){

return parametervalue.getName( );

Table 8-17 actuate.xtabanalyzer.ParameterValue functions

Function Description

getName( ) Returns the parameter name

getValue( ) Returns the parameter value

getValueIsNull( ) Returns whether the parameter has a null value

setName( ) Sets the parameter name

setValue( ) Sets the parameter value

setValueIsNull( ) Sets whether the parameter has a null value

Page 646: Actuate API Reference - OpenText

628 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .ParameterValue

}return null;

}

getValueSyntax String[ ] Dimension.getValue( )

Returns the name for the ParameterValue.

Returns String or array of strings. The parameter value or values.

Example This example retrieves the parameter value:

function getParameterValue(parametervalue){if (parametervalue){

return parametervalue.getValue( );}return null;

}

getValueIsNullSyntax boolean ParameterValue.getValueIsNull( )

Returns whether the parameter value is null.

Returns Boolean. True indicates the parameter value is null.

Example This example switches whether the parameter value is null:

if (parametervalue){if (parametervalue.getValueIsNull){

parametervalue.setValueIsNull(false);} else {

parametervalue.setValueIsNull(true);}

}

setNameSyntax void ParameterValue.setName(string name)

Sets the parameter name.

Parameter nameString. The parameter name.

Example This example sets the parameter name:

Page 647: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 629

actuate.xtabanalyzer.ParameterValue

function setParameterName(parametervalue, name){parametervalue.setName(name);

}

setValueSyntax void ParameterValue.setValue(string[ ] value)

Sets the parameter value.

Parameter valueString. The parameter value.

Example This example sets the parameter value:

function setParameterValue(parametervalue, value){parametervalue.setValue(value);

}

setValueIsNullSyntax void ParameterValue.setValueIsNull(boolean valueIsNull)

Sets the valueIsNull for the ParameterValue.

Parameter valueIsNullBoolean. True switches the value to null. False disables the null value setting.

Example This example switches whether the parameter value is null:

if (parametervalue){if (parametervalue.getValueIsNull){

parametervalue.setValueIsNull(false);} else {

parametervalue.setValueIsNull(true);}

}

Page 648: Actuate API Reference - OpenText

630 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Sorter

Class actuate.xtabanalyzer.SorterDescription Defines a sort condition used to sort on a dimension level or measure.

ConstructorSyntax actuate.xtabanalyzer.Sorter(string levelName)

Constructs a new sorter object.

Function summaryTable 8-18 lists actuate.xtabanalyzer.Sorter functions.

getKeySyntax string Sorter.getKey( )

Returns the sort key. This is the name of the measure or dimension level to sort the cross tab on.

Returns String. The key to sort on.

Example This example retrieves the sort key:

function getSortKey(sorter){if (sorter){

return sorter.getKey( );}return null;

}

Table 8-18 actuate.xtabanalyzer.Sorter functions

Function Description

getKey( ) Returns the sort key

getLevelName( ) Returns the level name

getMember( ) Returns the sort member

isAscending( ) Returns the sort direction

setAscending( ) Sets ascending or descending sort

setKey( ) Sets the sort key

setLevelName( ) Sets the level name

setMember( ) Sets the sort member

Page 649: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 631

actuate.xtabanalyzer.Sorter

getLevelNameSyntax string Sorter.getLevelName( )

Returns dimension level to sort on.

Returns String. The name of a dimension level.

Example This example retrieves the level name associated with the sorter:

function getSortLevel(sorter){if (sorter){

return sorter.getLevelName( );}return null;

}

getMemberSyntax actuate.xtabanalyzer.MemberValue Sorter.getMember( )

Returns the member value to sort on.

Returns actuate.xtabanalyzer.MemberValue object. A member value.

Example This example retrieves the sort member:

function getSortMember(sorter){if (sorter){

return sorter.getMember( );}return null;

}

isAscendingSyntax boolean Sorter.isAscending( )

Returns the sort order.

Returns Boolean. True when the sorter is ascending and false in all other cases.

Example This example retrieves the level name that is associated with the sorter:

function ascending(sorter){if (sorter){

return sorter.isAscending( );}return null;

}

Page 650: Actuate API Reference - OpenText

632 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Sorter

setAscendingSyntax void Sorter.setAscending(boolean ascending)

Sets the sort order to ascending or descending.

Parameter ascendingBoolean. Set to true for ascending, set to false for descending.

Example This example swaps the sort direction:

sorter.setAscending(!(sorter.isAscending));

setKeySyntax void Sorter.setSortKey(string sortKey)

Sets the key to sort on.

Parameter sortKeyString. The sort key.

Example This example sets the sort key:

function setSortKey(sorter,key){sorter.setKey(key);

}

setLevelNameSyntax void Sorter.setLevelName(string levelName)

Sets the dimension level name to sort on.

Parameter levelNameString. A dimension level name.

Example This example sets the level name to sort:

function setSortLevel(sorter,level){sorter.setLevelName(level);

}

setMemberSyntax void Sorter.setMember(actuate.xtabanalyzer.MemberValue member)

Sets the member value to sort on.

Parameter memberactuate.xtabanalyzer.MemberValue object. A member value.

Example This example sets the sort member:

Page 651: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 633

actuate.xtabanalyzer.Sorter

function setSortMember(sorter,member){sorter.setMember(member);

}

Page 652: Actuate API Reference - OpenText

634 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .SubTotal

Class actuate.xtabanalyzer.SubTotalDescription A SubTotal object.

ConstructorSyntax actuate.xtabanalyzer.SubTotal( )

Constructs a new SubTotal object.

Function summaryTable 8-19 lists actuate.xtabanalyzer.SubTotal functions.

addTotalSyntax void SubTotal.addTotal(actuate.xtabanalyzer.Total total)

Adds a total to the subtotal.

Parameter totalactuate.xtabanalyzer.Total. The total object being added.

Example This example uses addTotal( ) to create a subtotal:

function addSubTotal( ){var subTotal = new actuate.xtabanalyzer.SubTotal( );subTotal.setLevelName("year");subTotal.setLocation("after");var indexStr = "0;1;2;3;4";var indexs = indexsStr.split(";");var measureIndexs = [ ];for(var i = 0;i < indexs.length;i++){

Table 8-19 actuate.xtabanalyzer.SubTotal functions

Function Description

addTotal( ) Add a total

getLevelName( ) Returns the full level name

getLocation( ) Returns the location

getTotals( ) Returns the totals array

getType( ) Returns the type string

setLevelName( ) Sets the full level name

setLocation( ) Sets the location

setTotals( ) Sets the totals array

Page 653: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 635

actuate.xtabanalyzer.SubTotal

measureIndexs.push(parseInt(indexs[i]));}for( var i = 0; i < measureIndexs.length; i++){

var total = new actuate.xtabanalyzer.Total( );total.setMeasureIndex(measureIndexs[i]);total.setAggregationFunction("SUM");total.setEnabled(true);subTotal.addTotal(total);

}crosstab.setTotals(null,subTotal);crosstab.submit( );

}

getLevelNameSyntax string SubTotal.getLevelName( )

Returns the level for the subtotal.

Returns String. The level name for the subtotal.

Example This example retrieves the level name from the subtotal:

function getLevelName(subTotal){if (subTotal){

return subTotal.getLevelName( );}return null;

}

getLocationSyntax string SubTotal.getLocation( )

Returns the location name for the subtotal.

Returns String. The location name.

Example This example retrieves the level name from the subtotal:

function getLocation(subTotal){if (subTotal){

return subTotal.getLocation( );}return null;

}

getTotalsSyntax object[ ] SubTotal.getTotals( )

Page 654: Actuate API Reference - OpenText

636 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .SubTotal

Returns the totals used to calculate the subtotal.

Returns actuate.xtabanalyzer.Total[ ]. An array of total objects.

Example This example retrieves the totals from a SubTotal object:

var totalsArray = [ ];function getTotals(subTotal,totalsArray){

totalsArray = subTotal.getTotals( );}

getTypeSyntax string SubTotal.getType( )

Returns the type for the subtotal.

Returns String. The type for the subtotal.

Example This example retrieves the type from the subtotal:

function getLevelName(subTotal){if (subTotal){

return subTotal.getType( );}return null;

}

setLevelNameSyntax void SubTotal.setLevelName(string levelName)

Sets the level for the subtotal by name.

Parameter levelNameString. The level name.

Example This example sets the level name for a subtotal:

function subTotalLevel(subTotal,levelName){if(subTotal){

subTotal.setLevelName(levelName);}

}

setLocationSyntax void SubTotal.setLocation(string location)

Sets the location for the subtotal.

Page 655: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 637

actuate.xtabanalyzer.SubTotal

Parameter locationString. The location. Value can be either before or after.

Example This example sets the location for a subtotal:

function subTotalLocation(subTotal,location){if(subTotal){

subTotal.setLocation(location);}

}

setTotalsSyntax void SubTotal.setTotals(actuate.xtabanalyzer.Total[ ] totals)

Sets the totals using an array.

Parameter totalsArray of actuate.xtabanalyzer.Total objects to add to the subtotal.

Example This example uses setTotals( ) to create a subtotal:

function addSubTotal( ){var subTotal = new actuate.xtabanalyzer.SubTotal( );subTotal.setLevelName("year");subTotal.setLocation("after");var indexStr = "0;1;2;3;4";var indexs = indexsStr.split(";");var count = indexs.length;var measureIndexs = [ ];for(var i = 0;i < count;i++){

measureIndexs.push(parseInt(indexs[i]));}var totals = Array(count);for( var i = 0; i < measureIndexs.length; i++){

var total = new actuate.xtabanalyzer.Total( );total.setMeasureIndex( measureIndexs[i] );total.setAggregationFunction( "SUM" );total.setEnabled(true);totals[i] = total;

}subTotal.setTotals(totals);crosstab.setTotals( null, subTotal );crosstab.submit( );

}

Page 656: Actuate API Reference - OpenText

638 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Total

Class actuate.xtabanalyzer.TotalDescription A container for a total in the xtabanalyzer. Total handles numeric aggregation

functions for a measure.

ConstructorSyntax actuate.xtabanalyzer.Total( )

The Total class is used to specify a cross tab total object.

Function summaryTable 8-20 lists actuate.xtabanalyzer.Total functions.

getAggregationFunctionSyntax string Total.getAggregationFunction( )

Returns the aggregation function for the total.

Returns String. An aggregation function.

Example This example changes the aggregation function:

function swapTotalAggregation(total){if (total.getAggregationFunction( ) == "SUM"){

total.setAggregationFunction("COUNT");} else {

total.setAggregationFunction("SUM");}

}

Table 8-20 actuate.xtabanalyzer.Total functions

Function Description

getAggregationFunction( ) Returns the aggregation function name

getMeasureIndex( ) Returns the measure index

isEnabled( ) Returns whether or not the total is enabled

setAggregationFunction( ) Sets the aggregation function name

setEnabled( ) Sets the enabled flag

setMeasureIndex( ) Sets the index for the total

Page 657: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 639

actuate.xtabanalyzer.Total

getMeasureIndexSyntax integer Dimension.getMeasureIndex( )

Retrieves the measure index for the total.

Returns Integer. The measure index.

Example This example retrieves the measure index:

function getMeasureIndex(total){if (total){

return total.getIndex( );}return null;

}

isEnabledSyntax boolean Total.isEnabled( )

Returns whether the total is enabled.

Returns Boolean. True indicates this total is enabled.

Example This example enables and disables a total:

if (total){total.setEnabled(!total.isEnabled( ));

}

setAggregationFunctionSyntax void Total.setAggregationFunction(string aggregationFunction)

Sets the aggregation function name.

Parameter aggregationFunctionString. The aggregation function name.

Example This example changes the aggregation function:

function swapTotalAggregation(total){if (total.getAggregationFunction( ) == "SUM"){

total.setAggregationFunction("COUNT");} else {

total.setAggregationFunction("SUM");}

}

Page 658: Actuate API Reference - OpenText

640 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .Total

setEnabledSyntax void Total.setEnabled(boolean enabled)

Sets whether total is enabled or disabled.

Parameter enabledBoolean. True if the total is enabled. False for disabled.

Example This example enables and disables a total:

if (total){total.setEnabled(!total.isEnabled( ));

}

setMeasureIndexSyntax void Total.setMeasureIndex(integer measureIndex)

Sets the measure index for the total.

Parameter measureIndexInteger. The measure index for the total.

Example This example uses setMeasureIndex( ) to create a subtotal:

function addSubTotal( ){var subTotal = new actuate.xtabanalyzer.SubTotal( );subTotal.setLevelName("year");subTotal.setLocation("after");var indexStr = "0;1;2;3;4";var indexs = indexsStr.split(";");var count = indexs.length;var measureIndexs = [];for(var i = 0;i < count;i++){

measureIndexs.push(parseInt(indexs[i]));}for( var i = 0; i < measureIndexs.length; i++) {var total = new actuate.xtabanalyzer.Total( );total.setMeasureIndex(measureIndexs[i]);total.setAggregationFunction("SUM");total.setEnabled(true);subTotal.addTotal(total);}crosstab.setTotals(null,subTotal);crosstab.submit( );

}

Page 659: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 641

actuate.xtabanalyzer.UIOptions

Class actuate.xtabanalyzer.UIOptionsDescription Specifies feature availability for the Interactive Crosstabs viewer.

ConstructorSyntax void actuate.xtabanalyzer.UIOptions( )

Generates a new UIOptions object to manage the features of the xtabanalyzer.

Function summaryTable 8-21 lists actuate.xtabanalyzer.UIOptions functions.

enableCrosstabViewSyntax void UIOptions.enableCrosstabView(boolean enabled)

Enables or disables the cross tab layout view.

Parameter enabledBoolean. True enables this option.

Example This example enables or disables the cross tab view:

function setCrosstabView(flag){var uiOptions = new actuate.xtabanalyzer.UIOptions( );uiOptions.enableCrosstabView(flag);myXTabAnalyzer.setUIOptions(uiOptions);

}

Table 8-21 actuate.xtabanalyzer.UIOptions functions

Function Description

enableCrosstabView( ) Enables the cross tab layout view feature

enableCubeView( ) Enables the cube view feature

enableFilterSummaryView( ) Enables the filter summary view

enableToolBar( ) Enables the toolbar feature

enableToolbarHelp( ) Enables the toolbar help feature

enableToolbarSave( ) Enables the toolbar save feature

enableToolbarSaveDesign( ) Enables the toolbar save design feature

enableToolbarSaveDocument( ) Enables the toolbar save document feature

getFeatureMap( ) Returns a list of enabled and disabled features

Page 660: Actuate API Reference - OpenText

642 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .UIOptions

enableCubeViewSyntax void UIOptions.enableCubeView(boolean enabled)

Enables or disables the cube view.

Parameter enabledBoolean. A value of true enables this option.

Example This example enables or disables the cube view:

function setCubeView(flag){var uiOptions = new actuate.xtabanalyzer.UIOptions( );uiOptions.enableCubeView(flag);myXTabAnalyzer.setUIOptions(uiOptions);

}

enableFilterSummaryViewSyntax void UIOptions.enableFilterSummaryView(boolean enabled)

Enables or disables the filter summary view.

Parameter enabledBoolean. A value of true enables this option.

Example This example enables or disables the filter summary view:

function setFilterSummary(flag) {var uiOptions = new actuate.xtabanalyzer.UIOptions( );uiOptions.enableFilterSummaryView(enabled);myXTabAnalyzer.setUIOptions(uiOptions);

}

enableToolBarSyntax void UIOptions.enableToolBar(boolean enabled)

Enables or disables the toolbar feature.

Parameter enabledBoolean. A value of true enables this option.

Example This example enables or disables the toolbar:

function setToolbar(flag){var uiOptions = new actuate.xtabanalyzer.UIOptions( );uiOptions.enableToolBar(flag);myXTabAnalyzer.setUIOptions(uiOptions);

}

Page 661: Actuate API Reference - OpenText

C h a p t e r 8 , B I R T I n t e r a c t i v e C r o s s t a b s A P I c l a s s r e f e r e n c e 643

actuate.xtabanalyzer.UIOptions

enableToolbarHelpSyntax void UIOptions.enableToolbarHelp(boolean enabled)

Enables or disables the toolbar help feature.

Parameter enabledBoolean. A value of true enables this option.

Example This example enables or disables toolbar help:

function setToolbarHelp(flag){var uiOptions = new actuate.xtabanalyzer.UIOptions( );uiOptions.enableToolbarHelp(flag);myXTabAnalyzer.setUIOptions(uiOptions);

}

enableToolbarSaveSyntax void UIOptions.enableToolbarSave(boolean enabled)

Enables or disables the toolbar save feature.

Parameter enabledBoolean. A value of true enables this option.

Example This example enables or disables toolbar save:

function setToolbarSave(flag){var uiOptions = new actuate.xtabanalyzer.UIOptions( );uiOptions.enableToolbarSave(flag);myXTabAnalyzer.setUIOptions(uiOptions);

}

enableToolbarSaveDesignSyntax void UIOptions.enableToolbarSaveDesign(boolean enabled)

Enables or disables the toolbar save design feature.

Parameter enabledBoolean. A value of true enables this option.

Example This example enables or disables toolbar save design:

function setToolbarSave(flag){var uiOptions = new actuate.xtabanalyzer.UIOptions( );uiOptions.enableToolbarSaveDesign(flag);myXTabAnalyzer.setUIOptions(uiOptions);

}

Page 662: Actuate API Reference - OpenText

644 A c t u a t e A P I R e f e r e n c e

actuate.xtabanalyzer .UIOptions

enableToolbarSaveDocumentSyntax void UIOptions.enableToolbarSaveDocument(boolean enabled)

Enables or disables the toolbar save document feature.

Parameter enabledBoolean. A value of true enables this option.

Example This example enables or disables toolbar save document:

function setToolbarSave(flag){var uiOptions = new actuate.xtabanalyzer.UIOptions( );uiOptions.enableToolbarSaveDocument(flag);myXTabAnalyzer.setUIOptions(uiOptions);

}

getFeatureMapSyntax Object UIOptions.getFeatureMap( )

Returns the features and their Boolean values as an associative array. This function makes the name of each feature an object property and sets the value of that property to the associated enabled Boolean value.

Returns Object. An associative array of string name and Boolean value pairs.

Example This example retrieves the feature map:

function retrieveFeatureMap( ){var uiOptions = new actuate.xtabanalyzer.UIOptions( );var features = uiOptions.getFeatureMap( );return features;

}

Page 663: Actuate API Reference - OpenText

Part 6Scripting function reference

■ Actuate JavaScript API class reference

■ BIRT Interactive Crosstabs API class reference

PartSix6

Page 664: Actuate API Reference - OpenText
Page 665: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 647

C h a p t e r

9Chapter 9Scripting reference

This chapter provides reference information for the BIRT JavaScript classes. BIRT provides several JavaScript classes in addition to the native JavaScript classes that are a part of Rhino JavaScript. A report developer can access any of the BIRT classes and their properties and functions when writing an expression. The BIRT classes appear in the expression builder’s Category list as BIRT Functions.

BIRT event handlers written in Java code cannot directly access the BIRT JavaScript classes. It is possible to partially circumvent this restriction, however, by defining a new user property on an element and assigning the value of that property using a JavaScript expression. The JavaScript expression can use any of the BIRT JavaScript objects. Since Java code has access to the value of a user property, Java code can, in this way, access the result of evaluating a JavaScript expression. The primary restriction of this technique is that the expression is evaluated at the time the element is created and is therefore static.

BIRT JavaScript classes quick referenceTable 9-1 lists the BIRT JavaScript classes.

Table 9-1 Actuate JavaScript API classes

JavaScript class Description

BirtComp Compares values

BirtDateTime Calculates dates and times

(continues)

Page 666: Actuate API Reference - OpenText

648 A c t u a t e A P I R e f e r e n c e

BirtDuration Calculates durations

BirtMath Performs mathematic calculations.

BirtStr Performs string operations

Finance Performs financial calculations

Formatter Generated formatted strings

Table 9-1 Actuate JavaScript API classes (continued)

JavaScript class Description

Page 667: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 649

Class BirtCompThe BirtComp class provides functions to compare values, for example, to test if a value is equal to, greater than, or less than another value. All the functions return boolean values. This class is static. The application cannot create instances of the class.

BirtComp.anyOfThis function compares one or more values to the contents of a field.

Syntax boolean BirtComp.anyOf( source, target1, ..., targetN )

Parameters sourceA field with contents to use for comparison.

targetThe value or values to find in source.

Returns Boolean. True if a target value matches a value in source; returns false otherwise.

Examples The following example tests if Canada, Mexico, or USA are values in the Country field. If any one of the countries is in the field, the function returns true.BirtComp.anyOf(dataSetRow["Country"], "Canada", "Mexico", "USA")

The following example tests if Jan 15, 2009 or Jan 31, 2009 are values in the payDate field:BirtComp.anyOf(dataSetRow["payDate"], "2009-01-15", "2009-01-31")

The following example tests if two specific product codes are values in the productCode field. If either value appears in the field, the string Obsolete is displayed; otherwise the productCode value is displayed as it appears in the field.if (BirtComp.anyOf(dataSetRow["PRODUCTCODE"], "S18_1749",

"S18_2248" )){displayString = "Obsolete"

}else{dataSetRow["PRODUCTCODE"]

}

BirtComp.betweenThis function tests if a value is between two specified values.

Syntax boolean BirtComp.between( source, target1, target2 )

Parameters sourceThe value to test.

Page 668: Actuate API Reference - OpenText

650 A c t u a t e A P I R e f e r e n c e

target1The first value in the range of values to compare to.

target2The second value in the range of values to compare to.

Returns True if the source value is between the target1 and target values; returns false otherwise.

Examples The following expressions test field values to see if they are within a specified range of values:BirtComp.between( row["SalesTotal"], 10000, 20000 )BirtComp.between( row["CustomerName"], "A", "M" )BirtComp.between( row["OrderDate"], "2009-01-01", "2009-01-31" )

The following example calculates shipment dates. If an OrderDate value is in December 2008 (between 12/01/08 and 12/31/08), add 5 days to the OrderDate value. If an OrderDate value is in a month other than December, add 3 days to the OrderDate value.if (BirtComp.between(row["OrderDate"], "2008-12-01", "2008-12-31"

)){shipDate = BirtDateTime.addDay( row["OrderDate"], 5 )}

else{ShipDate = BirtDateTime.addDay( row["OrderDate"], 3 )}

BirtComp.compareStringThis function tests if a string value matches another string value, given specified conditions.

Syntax boolean BirtComp.compareString( source1, source2, ignoreCase, trim )

Parameters source1The first string value to use in the comparison.

source2The second string value to use in the comparison.

ignoreCaseSpecify true to perform a case-insensitive comparison. Specify false to perform a case-sensitive comparison.

trimSpecify true to remove any leading or trailing blanks before comparing the two values. Blanks in the middle of a string are not removed. Specify false if you want the comparison to include leading or trailing blanks.

Returns True if the source1 value matches the source2 value; returns false otherwise.

Page 669: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 651

Examples The following expressions compare strings with different conditions specified:BirtComp.compareString( "Jackson", "Jackson", false, false ) //

returns trueBirtComp.compareString( "Jackson", "jackson", false, true ) //

returns falseBirtComp.compareString( "Jackson", "jackson", true, false ) //

returns trueBirtComp.compareString( "Jackson ", "jackson", true, false ) //

returns falseBirtComp.compareString( "Jackson ", "jackson", true, true ) //

returns true

BirtComp.equalToThis function tests if a value is equal to another value.

Syntax boolean BirtComp.equalTo( source, target )

Parameters sourceThe first value to use in the comparison.

targetThe second value to use in the comparison.

Returns True if the source value is equal to the target value; returns false otherwise.

Examples The following expressions test field values to see if they are equal to specified values:BirtComp.equalTo( row["SalesTotal"], 10000 )BirtComp.equalTo( row["Country"], "France" )BirtComp.equalTo( row["OrderDate"], "2009-02-15" )

BirtComp.greaterOrEqualThis function tests if a value is greater than or equal to another value.

Syntax boolean BirtComp.greaterOrEqual( source, target )

Parameters sourceThe first value to use in the comparison.

targetThe second value to use in the comparison.

Returns True if the source value is greater than or equal to the target value; returns false otherwise.

Examples The following expressions test field values to see if they are greater than or equal to specified values:BirtComp.greaterOrEqual( row["SalesTotal"], 10000 )BirtComp.greaterOrEqual( row["ProductCode"], "S50_4000" )

Page 670: Actuate API Reference - OpenText

652 A c t u a t e A P I R e f e r e n c e

BirtComp.greaterOrEqual( row["OrderDate"], "2009-02-15" )

BirtComp.greaterThanThis function tests if a value is greater than another value.

Syntax boolean BirtComp.greaterThan( source, target )

Parameters sourceThe first value to use in the comparison.

targetThe second value to use in the comparison.

Returns True if the source value is greater than the target value; returns false otherwise.

Examples The following expressions test field values to see if they are greater than specified values:BirtComp.greaterThan( row["SalesTotal"], 10000 )BirtComp.greaterThan( row["CustomerName"], "M" )BirtComp.greaterThan( row["OrderDate"], "2009-02-15" )

BirtComp.lessOrEqualThis function tests if a value is less than or equal to another value.

Syntax boolean BirtComp.lessOrEqual( source, target )

Parameters sourceThe first value to use in the comparison.

targetThe second value to use in the comparison.

Returns True if the source value is less than or equal to the target value; returns false otherwise.

Examples The following expressions test field values to see if they are less than or equal to specified values:BirtComp.lessOrEqual( row["SalesTotal"], 10000 )BirtComp.lessOrEqual( row["ProductCode"], "S18_4000" )BirtComp.lessOrEqual( row["OrderDate"], "2009-02-15" )

BirtComp.lessThanThis function tests if a value is less than another value.

Syntax boolean BirtComp.lessThan( source, target )

Parameters sourceThe first value to use in the comparison.

Page 671: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 653

targetThe second value to use in the comparison.

Returns True if the source value is less than the target value; returns false otherwise.

Examples The following expressions test field values to see if they are less than specified values:BirtComp.lessThan( row["SalesTotal"], 10000 )BirtComp.lessThan( row["CustomerName"], "M" )BirtComp.lessThan( row["OrderDate"], "2009-02-15" )

BirtComp.likeThis function tests if a string value matches a pattern. The pattern must use SQL pattern-matching syntax.

Syntax boolean BirtComp.like( source, target )

Parameters sourceThe string value to evaluate.

targetThe string pattern to match. You must enclose the pattern in double quotation marks (" "). Use the correct case when typing the characters that you want to match. You can use the following special character in a pattern:

■ A percent character (%) matches zero or more characters. For example, %ace% matches any string value that contains the substring ace, such as Facebook and MySpace. It does not match Ace Corporation because this string contains a capital A, and not the lowercase a.

■ An underscore character (_) that matches exactly one character. For example, t_n matches tan, ten, tin, and ton. It does not match teen or tn.

To match a literal percent (%) or underscore (_) character, precede those characters with two backslash (\\) characters. For example, to match S_10, use the following pattern:S\\_10

To match 50%, use the following pattern:50\\%

Returns True if the source value matches the target value; returns false otherwise.

Examples The following example returns true for values in the productCode field that start with S18:BirtComp.like( row["productCode"], "S18%" )

The following example returns true for productName values that contain the substring Ford preceded by a single character:BirtComp.like( row["productName"], "_Ford%" )

Page 672: Actuate API Reference - OpenText

654 A c t u a t e A P I R e f e r e n c e

BirtComp.matchThis function tests if a string value matches a pattern. The pattern must use JavaScript regular expression syntax.

Syntax boolean BirtComp.match( source, target )

Parameters sourceThe string value to evaluate.

targetThe string pattern to match. In JavaScript regular expression syntax, you specify a pattern within a pair of forward slash (/) characters. You can use any special character supported by JavaScript regular expressions, such as the following:

■ A question mark (?) matches zero or one occurrence of the character previous to it. For example, /te?n/ matches tn, ten, and often. It does not match teen or intern.

■ An asterisk (*) matches zero or any number of occurrences of the character previous to it. For example, /te*n/ matches tn, ten, often, and teen. It does not match intern.

■ A period (.) matches any character. For example, /te.*/ matches ten, often, teen, intern.

■ A caret (^) specifies that the substring to look for is at the beginning of a string. For example, /^ten/ matches ten, tennis, and tense. It does not match often or pretend.

■ An i character specifies a case-insensitive search. For example, /smith/i matches Smith, blacksmith, and Smithsonian.

To match a special character literally, precede the special character with a backslash (\) character. For example, to match S*10, use the following pattern:/S\*10/

Returns True if the source value matches the target value; returns false otherwise.

Examples The following example returns true for values in the productCode field that start with S18:BirtComp.match( row["productCode"], /^S18/ )

The following example returns true for productName values that contain the substring Ford:BirtComp.match( row["productName"], /Ford/ )

BirtComp.notBetweenThis function tests if a value is not between two specified values.

Syntax boolean BirtComp.notBetween( source, target1, target2 )

Page 673: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 655

Parameters sourceThe value to test.

target1The first value in the range of values to compare to.

target2The second value in the range of values to compare to.

Returns True if the source value is not between the target1 and target values; returns false otherwise.

Examples The following expressions test field values to see if they are outside a specified range of values:BirtComp.notBetween( row["SalesTotal"], 10000, 20000 )BirtComp.notBetween( row["CustomerName"], "A", "M" )BirtComp.notBetween( row["OrderDate"], "2009-01-01", "2009-01-31"

)

The following example calculates shipment dates. If an OrderDate value is not in December 2008 (not between 12/01/08 and 12/31/08), add 3 days to the OrderDate value. If an OrderDate value is in December, add 5 days to the OrderDate value.if (BirtComp.notBetween(row["OrderDate"], "2008-12-01", "2008-12-

31" )){shipDate = BirtDateTime.addDay( row["OrderDate"], 3 )}

else{ShipDate = BirtDateTime.addDay( row["OrderDate"], 5 )}

BirtComp.notEqualThis function tests if a value is not equal to another value.

Syntax boolean BirtComp.notEqual( source, target )

Parameters sourceThe first value to use in the comparison.

targetThe second value to use in the comparison.

Returns True if the source value is not equal to the target value; returns false otherwise.

Examples The following expressions test field values to see if they are not equal to specified values:BirtComp.notEqual( row["SalesTotal"], 10000 )BirtComp.notEqual( row["Country"], "France" )BirtComp.notEqual( row["OrderDate"], "2009-02-15" )

Page 674: Actuate API Reference - OpenText

656 A c t u a t e A P I R e f e r e n c e

BirtComp.notLikeThis function tests if a string value does not match a pattern. The pattern must use SQL pattern-matching syntax.

Syntax boolean BirtComp.notLike( source, target )

Parameters sourceThe string value to evaluate.

targetThe string pattern to compare to. You must enclose the pattern in double quotation marks (" "). Use the correct case when typing the characters that you want to match. You can use the following special character in a pattern:

■ A percent character (%) matches zero or more characters. For example, %ace% matches any string value that contains the substring ace, such as Facebook and MySpace. It does not match Ace Corporation because this string contains a capital A, and not the lowercase a.

■ An underscore character (_) that matches exactly one character. For example, t_n matches tan, ten, tin, and ton. It does not match teen or tn.

To match a literal percent (%) or underscore (_) character, precede those characters with two backslash (\\) characters. For example, to match S_10, use the following pattern:S\\_10

To match 50%, use the following pattern:50\\%

Returns True if the source value does not match the target value; returns false otherwise.

Examples The following example returns false for values in the productCode field that start with S18:BirtComp.notLike( row["productCode"], "S18%" )

The following example returns false for productName values that contain the substring Ford preceded by a single character:BirtComp.notLike( row["productName"], "_Ford%" )

Page 675: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 657

Class BirtDateTimeThe BirtDateTime class provides functions to determine the amount of time between two dates or times, to add or subtract time spans, and to get parts of a date. Since date spans are just numbers, the application can use normal math on them: multiplication, division, addition, subtraction, and so on. This class is static. The application cannot create instances of the class.

BirtDateTime.addDayThis function returns a new date that results from adding a given number of days to a date. The number of days to add can be negative. In this case, the result is as if that number is subtracted from the date.

Syntax Date BirtDateTime.addDay( Date date, Number n )

Parameters dateDate object. A date object that represents the start date.

nNumber object. The number of days to add to the date. Decimals are treated as integers, rounded down to the nearest integer.

Returns Date object. A date that results from adding the specified number of days to the start date.

Examples The following example adds days to a specific date:var startDate = "2008-12-31"; var endDate;endDate = BirtDateTime.addDay( startDate, 1 ); // returns Jan 01,

2009endDate = BirtDateTime.addDay( startDate, -1 ); // returns Dec 30,

2008

The following example adds 15 days to each date value in the InvoiceDate field:BirtDateTime.addDay( row["InvoiceDate"], 15 )

BirtDateTime.addHourThis function returns a new date that results from adding a given number of hours to a date. The number of hours to add can be negative. In this case, the result is as if that number is subtracted from the date.

Syntax Date BirtDateTime.addHour( Date date, Number n )

Parameters dateA date object that represents the start date. If a start date does not have a time value, the function assumes the time is midnight (00:00:00).

Page 676: Actuate API Reference - OpenText

658 A c t u a t e A P I R e f e r e n c e

nNumber object. The number of hours to add to the date.

Returns Date object. A date that results from adding the specified number of hours to the start date.

Examples The following example adds hours to a specific date and time:var startDate = "2008-12-31 15:00:00"; var endDate;endDate = BirtDateTime.addHour( startDate, 8 ); // returns Dec 31,

2008 11:00 PMendDate = BirtDateTime.addHour( startDate, -8 ); // returns Dec

31, 2008 7:00 AM

The following example adds 36 hours to each date value in the StartTime field:BirtDateTime.addHour( row["StartTime"], 36 )

BirtDateTime.addMinuteThis function returns a new date that results from adding a given number of minutes to a date. The number of minutes to add can be negative. In this case, the result is as if that number is subtracted from the date.

Syntax Date BirtDateTime.addMinute( Date date, Number n )

Parameters dateA date object that represents the start date. If a start date does not have a time value, the function assumes the time is midnight (00:00:00).

nNumber object. The number of minutes to add to the date.

Returns Date object. A date that results from adding the specified number of minutes to the start date.

Examples The following example adds minutes to a specific date and time:var startDate = "2008-12-31 10:30:00"; var endDate;endDate = BirtDateTime.addMinute( startDate, 45 ); // returns Dec 31, 2008 11:15 AMendDate = BirtDateTime.addMinute( startDate, -30 ); // returns Dec 31, 2008 10:00 AM

The following example adds 15 minutes to each date value in the StartTime field:BirtDateTime.addMinute( row["StartTime"], 15 )

Page 677: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 659

BirtDateTime.addMonthThis function returns a new date that results from adding a given number of months to a date. The number of months to add can be negative. In this case, the result is as if that number is subtracted from the date.

This function always returns a valid date. If necessary, the day part of the resulting date is adjusted downward to the last day of the resulting month in the resulting year. For example, if you add 1 month to Jan 31, 2008, addMonth( ) returns Feb 29, 2008 (2008 is a leap year), not Feb 31, 2008.

Syntax Date BirtDateTime.addMonth( Date date, Number n )

Parameters dateDate object. A date object that represents the start date.

nNumber object. The number of months to add to the date. Decimals are treated as integers, rounded down.

Returns Date object. A date that results from adding the specified number of months to the start date.

Examples The following example adds months to a specific date:var startDate = "2008-12-31"; var endDate;endDate = BirtDateTime.addMonth( startDate, 1 ); // returns Jan

31, 2009endDate = BirtDateTime.addMonth( startDate, -1 ); // returns Nov

30, 2008endDate = BirtDateTime.addMonth( startDate, 2 ); // returns Feb

28, 2009

The following example adds 10 months to each date value in the InvoiceDate field:BirtDateTime.addMonth( row["InvoiceDate"], 10 )

BirtDateTime.addQuarterThis function returns a new date that results from adding a given number of quarters to a date. A quarter is equal to three months. For example, if you add 2 quarters to Sep 10, 2008, the function returns Mar 10, 2009. The number of quarters to add can be negative. In this case, the result is as if that number is subtracted from the date.

Syntax Date BirtDateTime.addQuarter( Date date, Number n )

Parameters dateA date object that represents the start date.

Page 678: Actuate API Reference - OpenText

660 A c t u a t e A P I R e f e r e n c e

nNumber object. The number of quarters to add to the date.

Returns Date object. A date that results from adding the specified number of quarters to the start date.

Examples The following example adds quarters to a specific date:var startDate = "2008-12-15"; var endDate;endDate = BirtDateTime.addQuarter( startDate, 1 ); //returns Mar

15, 2009endDate = BirtDateTime.addQuarter( startDate, -2 ); //returns Jun

15, 2008

The following example adds 2 quarters to each date value in the ForecastClosing field:BirtDateTime.addQuarter( row["ForecastClosing"], 2 )

BirtDateTime.addSecondThis function returns a new date that results from adding a given number of seconds to a date. The number of seconds to add can be negative. In this case, the result is as if that number is subtracted from the date.

Syntax Date BirtDateTime.addSecond( Date date, Number n )

Parameters dateA date object that represents the start date. If a start date does not have a time value, the function assumes the time is midnight (00:00:00).

nNumber object. The number of seconds to add to the date.

Returns Date object. The result from adding the specified number of seconds to the start date.

Examples The following example adds seconds to a specific date and time:var startDate = "2008-12-31 10:30:00"; var endDate;endDate = BirtDateTime.addSecond( startDate, 10000 ); // returns returns Dec 31, 2008 1:16:40 PMendDate = BirtDateTime.addSecond( startDate, -10000 ); // returns Dec 31, 2008 7:43:20 AM

The following example adds 6000 seconds to each date value in the StartTime field:BirtDateTime.addSecond( row["StartTime"], 6000 )

Page 679: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 661

BirtDateTime.addWeekThis function returns a new date that results from adding a given number of weeks to a date. The number of weeks to add can be negative. In this case, the result is as if that number is subtracted from the date.

Syntax Date BirtDateTime.addWeek( Date date, Number n )

Parameters dateA date object that represents the start date.

nNumber Object. The number of weeks to add to the date.

Returns Date object. A date that results from adding the specified number of weeks to the start date.

Examples The following example adds weeks to a specific date:var startDate = "2008-12-31"; var endDate;endDate = BirtDateTime.addWeek( startDate, 1 ); // returns Jan 07,

2009endDate = BirtDateTime.addWeek( startDate, -1 ); // returns Dec

24, 2008

The following example adds 2 weeks to each date value in the InvoiceDate field:BirtDateTime.addWeek( row["InvoiceDate"], 2 )

BirtDateTime.addYearThis function returns a new date that results from adding a given number of years to a date. The number of years to add can be negative. In this case, the result is as if that number is subtracted from the date.

Syntax Date BirtDateTime.addYear( Date date, Number n )

Parameters dateA date object that represents the start date.

nNumber object.The number of years to add to the date. Decimals are treated as integers, rounded down.

Returns A date that results from adding the specified number of years to the start date.

Examples The following example adds years to a specific date:var startDate = "2008-12-31"; var endDate;endDate = BirtDateTime.addYear( startDate, 1 ); // returns Dec 31,

2009

Page 680: Actuate API Reference - OpenText

662 A c t u a t e A P I R e f e r e n c e

endDate = BirtDateTime.addYear( startDate, -1 ); // returns Dec 31, 2007

The following example adds 5 years to each date value in the HireDate field:BirtDateTime.addYear( row["HireDate"], 5 )

BirtDateTime.dayThis function returns a number from 1 to 31 that represents the day of the month for a given date. For example, if the date is 2009-01-19, the function returns 19.

Syntax integer BirtDateTime.day( Date date )

Parameter dateDate object. A date object from which to get the day.

Returns An integer that represents the day of the month for a given date.

Examples The following example returns the day of the month for each value in the ShipDate field:BirtDateTime.day( row["ShipDate"] )

The following example returns the day of the month for the current date:BirtDateTime.day( (BirtDateTime.today())

BirtDateTime.diffDayThis function returns the number of days between two dates. A day is calculated by subtracting the day value of the first date from the day value of the second date. For example, if the first date is 2008-12-30 23:59:59 and the second date is 2008-12-31 00:00:00, the function returns 1 day, even though only one second separates the two dates.

Syntax integer BirtDateTime.diffDay( Date date1, Date date2 )

Parameters date1A date object that represents the start of the time span.

date2A date object that represents the end of the time span.

Returns Integer. The number of days between two dates.

Examples The following example returns the number of days between specific dates:BirtDateTime.diffDay( "2009-01-01", "2009-04-15" ) // returns 104

The following example returns the number of days from the current date to the end of 2009:BirtDateTime.diffDay( BirtDateTime.today(), "2009-12-31" )

Page 681: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 663

The following example returns the number of days between values in the InvoiceDate and PaymentDate fields:BirtDateTime.diffDay( row["InvoiceDate"], row["PaymentDate"] )

BirtDateTime.diffHourThis function returns the number of hours between two dates. An hour is calculated by subtracting the hour value of the first date from the hour value of the second date. For example, if the first date is 2009-01-31 1:30:00 and the second date is 2009-01-31 2:00:00, the function returns 1 hour, even though only 30 minutes separates the two dates. If a date does not have a time value, the function assumes the time is midnight (00:00:00).

Syntax integer BirtDateTime.diffHour( Date date1, Date date2 )

Parameters date1A date object that represents the start of the time span.

date2A date object that represents the end of the time span.

Returns Integer. The number of hours between two dates.

Examples The following example returns the number of hours between specific dates:BirtDateTime.diffHour( "2009-01-31 12:00:00", "2009-02-01

12:00:00")// returns 24BirtDateTime.diffHour( "2009-01-31", "2009-02-01 12:00:00")// returns 36. Because the first date does not have a time,

midnight is assumed.

The following example returns the number of hours from the current date and time to the end of 2009:BirtDateTime.diffHour( BirtDateTime.now(), "2009-12-31" );

The following example returns the number of hours between values in the StartTime and FinishTime fields:BirtDateTime.diffHour( row["StartTime"], row["FinishTime"] )

BirtDateTime.diffMinuteThis function returns the number of minutes between two dates. A minute is calculated by subtracting the minute value of the first date from the minute value of the second date. For example, if the first date is 2009-01-31 1:30:59 and the second date is 2009-01-31 1:31:00, the function returns 1 minute, even though only one second separates the two dates. If a date does not have a time value, the function assumes the time is midnight (00:00:00).

Syntax integer BirtDateTime.diffMinute( Date date1, Date date2 )

Page 682: Actuate API Reference - OpenText

664 A c t u a t e A P I R e f e r e n c e

Parameters date1A date object that represents the start of the time span.

date2A date object that represents the end of the time span.

Returns Integer. The number of minutes between two dates.

Examples The following example returns the number of minutes between specific dates:BirtDateTime.diffMinute( "2009-01-31 1:30:30", "2009-01-31

10:45:00")// returns 555BirtDateTime.diffMinute( "2009-01-31", "2009-01-31 12:00:00")// returns 720. Because the first date does not have a time,

midnight is assumed.

The following example returns the number of minutes from the current date and time to the beginning of 2010:BirtDateTime.diffMinute( BirtDateTime.now(), "2010-01-01" )

The following example returns the number of minutes between values in the StartTime and FinishTime fields:BirtDateTime.diffMinute( row["StartTime"], row["FinishTime"] )

BirtDateTime.diffMonthThis function returns the number of months between two dates. A month is calculated by subtracting the month value of the first date from the month value of the second date. For example, if the first date is 2009-01-31 and the second date is 2009-02-01, the function returns 1 month, even though only one day separates the two dates.

Syntax integer BirtDateTime.diffMonth( Date date1, Date date2 )

Parameters date1A date object that represents the start of the time span.

date2A date object that represents the end of the time span.

Returns Integer. The number of months between two dates.

Examples The following example returns the number of months between specific dates:BirtDateTime.diffMonth( "2009-01-31", "2009-04-15") // returns 3

The following example returns the number of months from the current date to the beginning of 2010:BirtDateTime.diffMonth( BirtDateTime.today(), "2010-01-01" );

Page 683: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 665

The following example returns the number of months between values in the ProjectStart and ProjectComplete fields:BirtDateTime.diffMonth( row["ProjectStart"],

row["ProjectComplete"] )

BirtDateTime.diffQuarterThis function returns the number of quarters between two dates. A quarter is calculated by subtracting the month value of the first date from the month value of the second date. A difference of 3 months is equal to 1 quarter. For example, if the first date is 2009-01-31 and the second date is 2009-07-01, the function returns 2. If the first date is 2009-01-01 and the second date is 2009-09-30, the function also returns 2.

Syntax integer BirtDateTime.diffQuarter( Date date1, Date date2 )

Parameters date1A date object that represents the start of the time span.

date2A date object that represents the end of the time span.

Returns Integer. The number of quarters between two dates.

Examples The following example returns the number of quarters between specific dates:BirtDateTime.diffQuarter( "2009-01-31", "2009-04-15") // returns 1

The following example returns the number of quarters from the current date to the beginning of 2010:BirtDateTime.diffQuarter( BirtDateTime.today(), "2010-01-01" );

The following example returns the number of quarters between values in the ProjectStart and ProjectComplete fields:BirtDateTime.diffQuarter( row["ProjectStart"],

row["ProjectComplete"] )

BirtDateTime.diffSecondThis function returns the number of seconds between two dates. If a date does not have a time value, the function assumes the time is midnight (00:00:00).

Syntax integer BirtDateTime.diffSecond( date1, date2 )

Parameters date1A date object that represents the start of the time span.

date2A date object that represents the end of the time span.

Returns Integer. The number of seconds between two dates.

Page 684: Actuate API Reference - OpenText

666 A c t u a t e A P I R e f e r e n c e

Examples The following example returns the number of seconds between specific dates:BirtDateTime.diffSecond( "2009-01-31 11:30:30", "2009-01-31

12:00:00")// returns 1770BirtDateTime.diffSecond( "2009-01-31", "2009-01-31 1:00:00")// returns 3600. Because the first date does not have a time,

midnight is assumed.

The following example returns the number of seconds from the current date and time to the beginning of 2010:BirtDateTime.diffSecond( BirtDateTime.now(), "2010-01-01" )

The following example returns the number of seconds between values in the StartTime and FinishTime fields:BirtDateTime.diffSecond( row["StartTime"], row["FinishTime"] )

BirtDateTime.diffWeekThis function returns the number of weeks between two dates. A week is calculated by subtracting the week number of the first date from the week number of the second date. For example, if the first date is 2009-01-02 (week 1 of the year) and the second date is 2009-01-05 (week 2 of the year), the function returns one week, even though only three days separates the two dates.

Syntax integer BirtDateTime.diffWeek( Date date1, Date date2 )

Parameters date1A date object that represents the start of the time span.

date2A date object that represents the end of the time span.

Returns Integer. The number of weeks between two dates.

Examples The following example returns the number of weeks between specific dates:BirtDateTime.diffWeek( "2009-01-01", "2009-02-01") // returns 5

The following example returns the number of weeks from the current date to the beginning of 2010:BirtDateTime.diffWeek( BirtDateTime.today(), "2010-01-01" );

The following example returns the number of weeks between values in the ProjectStart and ProjectComplete fields:BirtDateTime.diffWeek( row["ProjectStart"],

row["ProjectComplete"] )

Page 685: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 667

BirtDateTime.diffYearThis function returns the number of years between two dates. A year is calculated by subtracting the year value of the first date from the year value of the second date. For example, if the first date is 2009-01-01 and the second date is 2009-12-31, the function returns 0. If the first date is 2008-11-15 and the second date is 2009-01-15, the function returns 1.

Syntax integer BirtDateTime.diffYear( Date date1, Date date2 )

Parameters date1A date object that represents the start of the time span.

date2A date object that represents the end of the time span.

Returns Integer. The number of years between two dates.

Examples The following example returns the number of years between specific dates:BirtDateTime.diffYear( "2005-01-01", "2009-06-01") // returns 4

The following example returns the number of years between each value in the HireDate field and the current date:BirtDateTime.diffYear( row["HireDate"], BirtDateTime.today() )

BirtDateTime.firstDayOfMonthThis function returns the date for the first day of the month in which the input date falls.

Syntax Date BirtDateTime.firstDayOfMonth( Date date)

Parameters dateA date object from which to get the month.

Returns Date object. The first day of the month for a given date.

Examples The following example shows the month values returned for a specific date:BirtDateTime.firstDayOfMonth( "2009-02-15" ) // returns 2009-02-01

BirtDateTime.firstDayOfQuarterThis function returns the date for the first day of the quarter in which the input date falls.

Syntax Date BirtDateTime.firstDayOfQuarter( Date date)

Parameters dateA date object from which to get the quarter.

Returns Date object. The first day of the quarter for a given date.

Page 686: Actuate API Reference - OpenText

668 A c t u a t e A P I R e f e r e n c e

Examples The following example shows the quarter values returned for a specific date:BirtDateTime.firstDayOfQuarter( "2009-02-15" )

// returns 2009-01-01

BirtDateTime.firstDayOfWeekThis function returns the date for the first day of the week in which the input date falls, which is always a Sunday.

Syntax Date BirtDateTime.firstDayOfWeek( Date date)

Parameters dateA date object from which to get the week.

Returns Date object. The first day of the week for a given date.

Examples The following example shows the week values returned for a specific date:BirtDateTime.firstDayOfWeek( "2009-02-15" ) // returns 2009-02-15

BirtDateTime.firstDayOfYearThis function returns the date for the first day of the year in which the input date falls.

Syntax Date BirtDateTime.firstDayOfYear( Date date)

Parameters dateA date object from which to get the year.

Returns Date object. The first day of the year for a given date.

Examples The following example shows the year values returned for a specific date:BirtDateTime.firstDayOfYear( "2009-02-15" ) // returns 2009-01-01

BirtDateTime.monthThis function returns the month for a given date. Depending on the option you specify, the function returns the month as a number, the full month name, or the abbreviated month name. The month name is locale-specific.

Syntax string BirtDateTime.month( Date date, integer option )

Parameters dateA date object from which to get the month.

optionInteger. Optional. A number that represents the month format to return. Use one of the following values:

■ 1 to get the month as a number from 1 to 12

Page 687: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 669

■ 2 to get the full month name, for example, January

■ 3 to get the abbreviated month name, for example, Jan

If you omit this argument, the function returns the month as a number.

Returns String. The month for a given date.

Examples The following example shows the month values returned for a specific date:BirtDateTime.month( "2009-02-15" ) // returns 2BirtDateTime.month( "2009-02-15", 2 ) // returns FebruaryBirtDateTime.month( "2009-02-15", 3) // returns Feb

The following example returns the month for the current date:

BirtDateTime.month( (BirtDateTime.today() )

BirtDateTime.nowThis function returns the current date and time, for example, Feb 2, 2009 2:05 PM.

Syntax Date BirtDateTime.now( )

Returns Date object. The current date and time.

Example The following example returns the number of hours from the current date and time to Christmas:BirtDateTime.diffHour( BirtDateTime.now(), "2009-12-25" )

BirtDateTime.quarterThis function returns a number from 1 to 4 that represents the quarter in which a given date falls. The first quarter begins on January 1.

Syntax integer BirtDateTime.quarter( Date date )

Parameter dateA date object from which to get the quarter number.

Returns Integer. The quarter number for a given date.

Examples The following example shows the quarter numbers returned for specific dates:BirtDateTime.quarter( "2009-02-15" ) // returns 1BirtDateTime.quarter( "2009-07-10" ) // returns 3

The following example returns the quarter number for each value in the CloseDate field:BirtDateTime.quarter( row["CloseDate"] )

The following example returns the quarter number for the current date:BirtDateTime.quarter( (BirtDateTime.today() )

Page 688: Actuate API Reference - OpenText

670 A c t u a t e A P I R e f e r e n c e

BirtDateTime.todayThis function returns the current date that includes a time value of midnight, for example, Feb 2, 2009 12:00 AM.

Syntax Date BirtDateTime.today( )

Returns Date object. The current date with a time value of midnight.

Examples The following example returns the number of days from the current date to Christmas:BirtDateTime.diffDay( BirtDateTime.today(), "2009-12-25" )

The following example calculates the number of years from each value in the HireDate data field to the current date.BirtDateTime.diffDay( BirtDateTime.today(), "2009-12-25" )

BirtDateTime.weekThis function returns a number from 1 to 52 that represents the week number for a given date.

Syntax integer BirtDateTime.week( date )

Parameter dateA date object from which to get the week number.

Returns Integer. The week number for a given date.

Examples The following example shows the week numbers returned for specific dates:BirtDateTime.week( "2009-02-15" ) // returns 8BirtDateTime.week( "2009-10-12" ) // returns 42

The following example returns the week number for each value in the CloseDate field:BirtDateTime.week( row["CloseDate"] )

The following example returns the week number for the current date:BirtDateTime.week( (BirtDateTime.today() )

BirtDateTime.weekDayThis function returns the day of the week for a given date. Depending on the option you specify, the function returns the day of the week as a number, the full weekday name, or the abbreviated weekday name. The weekday name is locale-specific.

Syntax string BirtDateTime.weekDay( Date date, integer option )

Parameters dateA date object from which to get the day of the week.

Page 689: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 671

optionInteger. Optional. A number that represents the format to return. Use one of the following values:

■ 1 to get the day as a number from 1 (Sunday) to 7 (Saturday)

■ 2 to get the day as a number from 1 (Monday) to 7 (Sunday)

■ 3 to get the day as a number from 0 (Monday) to 6 (Sunday)

■ 4 to get the full weekday name, for example, Wednesday

■ 5 to get the abbreviated weekday name, for example, Wed

If you omit this argument, the function assumes option 1.

Returns String. The day of the week for a given date.

Examples The following example shows the week day values returned for a specific date:BirtDateTime.weekDay( "2009-02-02" ) // returns 2BirtDateTime.weekDay( "2009-02-02", 2 ) // returns 1BirtDateTime.weekDay( "2009-02-02", 4 ) // returns Monday

The following example returns the day of the week for the current date:BirtDateTime.weekDay( (BirtDateTime.today() )

BirtDateTime.yearThis function returns the four-digit year value for a given date. For example, if the date is 2009-01-19, the function returns 2009.

Syntax integer BirtDateTime.year( date )

Parameter dateA date object from which to get the year.

Returns Integer. The four-digit year value for a given date.

Examples The following example returns the year for each value in the HireDate field:BirtDateTime.year( row["HireDate"] )

The following example returns the year for the current date:BirtDateTime.year( (BirtDateTime.today())

Page 690: Actuate API Reference - OpenText

672 A c t u a t e A P I R e f e r e n c e

Class BirtDurationThe BirtDuration class provides functions to get parts of time periods, or durations, used in XML documents. The durations are specified in the following form:PnYnMnDTnHnMnS

where

■ P indicates the period (required).

■ nY indicates the number of years.

■ nM indicates the number of months.

■ nD indicates the number of days.

■ T indicates the start of a time section (required if the duration includes hours, minutes, or seconds).

■ nH indicates the number of hours.

■ nM indicates the number of minutes.

■ nS indicates the number of seconds.

For example, the following value indicates a duration of 2 years, 3 months, and 5 days:P2Y3M5D

The following value indicates a duration of 10 hours:PT10H

The BirtDuration class is static. The application cannot create instances of the class.

BirtDuration.addThis function adds two durations together, and returns the sum.

Syntax string BirtDuration.add(string lexicalDuration1, string lexicalDuration2)

Parameters lexicalDuration1String. The first duration to add.

lexicalDuration2String. The second duration to add.

Returns String. The sum of the two input durations.

Examples The following example adds two durations:BirtDuration.add("P1Y3M", "P13M") // returns P2Y4M

Page 691: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 673

BirtDuration.addToThis function adds a duration to a specified date object.

Syntax Date BirtDuration.add(string lexicalDuration, Date date)

Parameters lexicalDurationString. The duration to add.

dateDate object. The date and time to modify.

Returns Date object. The date advanced by the duration.

Examples The following example adds one year to today’s date and time:var today = new Date();var annualDate = BirtDuration.addTo(today, "P1Y")

BirtDuration.compareThis function tests if a duration is the same, greater than, or less than another duration.

Syntax integer BirtDuration.compare(string lexicalDuration1, string lexicalDuration2)

Parameters lexicalDuration1String. The first duration to use in the comparison.

lexicalDuration2String. The second duration to use in the comparison.

Returns Integer. Partial order relation between the two durations. Returns 1 if the first duration is greater, 0 if they are equal and -1 if the second duration is greater.

Examples The following expressions compare the lengths of specific durations:BirtDuration.compare("P1Y", "P12M"); // returns 0BirtDuration.compare( "P3M" , "P100D" ) // returns -1BirtDuration.compare( "PT25H" , "P1D" ) // returns 1

BirtDuration.dayThis function returns the days value of a given duration.

Syntax integer BirtDuration.day( string lexicalDuration )

Parameter lexicalDurationString. A duration from which to get the days value.

Returns An integer that represents the days value of the specified duration.

Examples The following examples show the day values returned for specific durations:

Page 692: Actuate API Reference - OpenText

674 A c t u a t e A P I R e f e r e n c e

BirtDuration.day( "P1Y15DT12H" ) // returns 15BirtDuration.day( "P5Y2M" ) // returns 0

BirtDuration.getSignThis function returns the sign of a duration.

Syntax integer BirtDuration.getSign( string lexicalDuration )

Parameters lexicalDurationString. The duration to analyze.

Returns Integer. The sign of the duration as a multiplier. Returns 1 for a positive duration, -1 for a negative duration, and 0 for null or 0 value.

Examples The following expression analyzes the sings of a specific duration:BirtDuration.getSign("P0Y"); // returns 0BirtDuration.getSign("-P8Y2M3D"); // returns -1

BirtDuration.hourThis function returns the hours value of a given duration.

Syntax integer BirtDuration.hour( string lexicalDuration )

Parameter lexicalDurationString. A duration from which to get the hours value.

Returns An integer that represents the hours value of the specified duration.

Examples The following examples show the hour values returned for specific durations:BirtDuration.hour( "P1Y15DT12H" ) // returns 12BirtDuration.hour( "P5Y2M" ) // returns 0

BirtDuration.isLongerThanThis function tests if a duration is longer than another duration. Sometimes the order relationship between certain durations cannot be determined, for example, one month (P1M) and 30 days (P30D), or one year (P1Y) and 365 days (P365D). In cases such as these, the function returns false.

Syntax boolean BirtDuration.isLongerThan( string lexicalDuration1, string lexicalDuration2 )

Parameters lexicalDuration1String. The first duration to use in the comparison.

lexicalDuration2String. The second duration to use in the comparison.

Page 693: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 675

Returns Boolean. True if the first duration is longer than the second duration; returns false otherwise.

Examples The following expressions compare the lengths of specific durations:BirtDuration.isLongerThan( "P1Y3M" , "P13M" ) // returns trueBirtDuration.isLongerThan( "P2M" , "P62D" ) // returns falseBirtDuration.isLongerThan( "PT25H" , "P1D" ) // returns true

BirtDuration.isShorterThanThis function tests if a duration is shorter than another duration. Sometimes the order relationship between certain durations cannot be determined, for example, one month (P1M) and 30 days (P30D), or one year (P1Y) and 365 days (P365D). In cases such as these, the function returns false.

Syntax boolean BirtDuration.isShorterThan( string lexicalDuration1, string lexicalDuration2 )

Parameters lexicalDuration1String. The first duration to use in the comparison.

lexicalDuration2String. The second duration to use in the comparison.

Returns Boolean. True if the first duration is shorter than the second duration; returns false otherwise.

Examples The following expressions compare the lengths of specific durations:BirtDuration.isShorterThan( "P1Y3M" , "P13M" ) // returns falseBirtDuration.isShorterThan( "P2M" , "P62D" ) // returns falseBirtDuration.isShorterThan( "PT25H" , "P1D" ) // returns falseBirtDuration.isShorterThan( "P27D" , "P1M" ) // returns true

BirtDuration.minuteThis function returns the minutes value of a given duration.

Syntax integer BirtDuration.minute( string lexicalDuration )

Parameter lexicalDurationString. A duration from which to get the minutes value.

Returns Integer. A number that represents the minutes value of the specified duration.

Examples The following examples show the minutes values returned for specific durations:BirtDuration.minute( "P1Y15DT12H30M45S" ) // returns 30BirtDuration.minute( "P5Y2M8DT15H" ) // returns 0

Page 694: Actuate API Reference - OpenText

676 A c t u a t e A P I R e f e r e n c e

BirtDuration.monthThis function returns the months value of a given duration.

Syntax integer BirtDuration.month( string lexicalDuration )

Parameter lexicalDurationString. A duration from which to get the months value.

Returns Integer. A number that represents the months value of the specified duration.

Examples The following examples show the month values returned for specific durations:BirtDuration.month( "P1Y3M15DT12H30M45S" ) // returns 3BirtDuration.month( "P5Y8DT15H" ) // returns 0

BirtDuration.multiplyThis function returns the product of a duration and a regular number.

Syntax string BirtDuration.multiply( string lexicalDuration, integer factor )

Parameter lexicalDurationString. A duration to multiply.

factorInteger. A regular number to multiply.

Returns String. The product of the input duration and the factor.

Examples The following examples show the products returned for a specific duration and factor:BirtDuration.multiply( "P1Y3M15DT12H30M45S", 1) // returns P1Y3M15DT12H30M45SBirtDuration.multiply( "P5Y8DT15H", 0) // returns P0Y0DT0H

BirtDuration.negateThis function returns the negative value of a duration.

Syntax string BirtDuration.negate( string lexicalDuration )

Parameter lexicalDurationString. A duration to negate.

Returns String. The negative value of the input duration.

Examples The following examples show the negative result from a specific duration:BirtDuration.negate( "P1Y3M15DT12H30M45S") // returns -P1Y3M15DT12H30M45S

Page 695: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 677

BirtDuration.secondThis function returns the seconds value of a given duration.

Syntax integer BirtDuration.second( string lexicalDuration )

Parameter lexicalDurationString. A duration from which to get the seconds value.

Returns Integer. A number that represents the seconds value of the specified duration.

Examples The following examples show the seconds values returned for specific durations:BirtDuration.second( "P1Y3M15DT12H30M45S" ) // returns 5BirtDuration.second( "P5Y8DT15H" ) // returns 0

BirtDuration.subtractThis function subtracts a duration from another duration.

Syntax string BirtDuration.subtract( string lexicalDuration1, string lexicalDuration2 )

Parameters lexicalDuration1String. The duration to subtract from.

lexicalDuration2String. The duration subtracted from lexicalDuration1.

Returns String. The difference of the two input durations.

Examples The following example subtracts two durations:BirtDuration.subtract("P1Y3M", "P13M") // returns P0Y2M

BirtDuration.timeInMillsThis function returns the number of milliseconds in a given duration, from a specified start date. The number of milliseconds in a duration can change depending on the start date. For example, a duration of one month can be 28, 29, 30, or 31 days, depending on the start date. If the start date is January 1, the function calculates the milliseconds between January 1 and February 1 (excluding February 1), which equals 2678400000 milliseconds or 31 days. If the start date is February 1, 2009 (a leap year), the function calculates the milliseconds between February 1 and March 1, which equals 2505600000 milliseconds or 29 days.

Syntax Number BirtDuration.timeInMills( string lexicalDuration, Date startDate )

Parameters lexicalDurationString. A duration whose length in milliseconds to get.

startDateDate object. Represents the start date.

Returns Number object. The number of milliseconds in the specified duration.

Page 696: Actuate API Reference - OpenText

678 A c t u a t e A P I R e f e r e n c e

Examples The following examples show the number of milliseconds returned for specific durations and start dates:BirtDuration.timeInMills( "P1Y3M10D" , "2009-01-01" ) // returns

40172400000BirtDuration.timeInMills( "P1Y3M10D" , "2008-01-01" ) // returns

40258800000BirtDuration.timeInMills( "PT6H45M20S" , "2009-01-01" ) //

returns 24320000

BirtDuration.yearThis function returns the year value of a given duration.

Syntax integer BirtDuration.year( string lexicalDuration )

Parameter lexicalDurationString. A duration from which to get the year value.

Returns Integer. A number that represents the year value of the specified duration.

Examples The following examples show the year values returned for specific durations:BirtDuration.year( "P1Y3M15DT12H30M45S" ) // returns 1BirtDuration.year( "P8DT15H" ) // returns 0

Page 697: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 679

Class BirtMathThe BirtMath class provides functions to manipulate numeric data, for example, to add, subtract, multiple, divide, and round numbers. A number is a generic object that can be cast as another type in the Data Type field of the Edit Data Binding dialog. This class is static. The application cannot create instances of the class.

BirtMath.addThis function returns the sum of two numbers.

Syntax Number BirtMath.add( Number n1, Number n2 )

Parameters n1Number object. The first number to use in the calculation.

n2The second number to use in the calculation.

Returns Number object. The number that results from adding n1 and n2.

Example The following example returns the sum of values in the SalesTotal and Shipping fields:BirtMath.add( row["SalesTotal"], row["Shipping"] )

BirtMath.ceilingThis function rounds a number up, away from 0, to the nearest specified multiple.

Syntax Number BirtMath.ceiling( Number n, Number significance )

Parameters nNumber object. The number to round up.

significanceNumber object. The multiple to round n to.

Returns Number object. A number that results from the rounding. If n is an exact multiple of significance, no rounding occurs.

Examples BirtMath.ceiling( ) is commonly used to round up prices. For example, to avoid dealing with pennies, you can round prices in a Price field up to the nearest nickel with the following expression:BirtMath.add( row["SalesTotal"], row["Shipping"] )

If the Price value is 20.52, the expression returns 20.55.

The following expression rounds prices up to the nearest dime:

Page 698: Actuate API Reference - OpenText

680 A c t u a t e A P I R e f e r e n c e

BirtMath.ceiling( row["Price"] , 0.1 )

If the Price value is 20.52, the expression returns 20.60. If the Price value is 20.40, the expression returns 20.40. No rounding occurs because 20.40 is a multiple of 0.1.

The following expression rounds prices up to the nearest dollar:BirtMath.ceiling( row["Price"] , 1 )

If the Price value is 20.30, the expression returns 21.

BirtMath.divideThis function returns the result of dividing one number by another.

Syntax Number BirtMath.divide( Number dividend, Number divisor )

Parameters dividendNumber object. The number to be divided.

divisorNumber object. The number by which dividend is divided.

Returns Number object. A number that results from dividing dividend by divisor.

Examples The following example shows the results of dividing specific numbers:BirtMath.divide( 10, 2 ) // returns 5BirtMath.divide( 2, 10) // returns 0.2

The following example returns the result of dividing values in the Total field by values in the Quantity field:BirtMath.divide( row["Total"], row["Quantity"] )

BirtMath.modThis function returns the remainder after a number is divided by a divisor.

Syntax Number BirtMath.mod( Number number, Number divisor )

Parameters numberNumber object. The number to be divided.

divisorNumber object. The number by which the first number is divided. You must specify a non-zero number.

Returns The remainder after number is divided by divisor.

Examples The following examples shows the results that the function returns for specific numbers:BirtMath.mod( 10, 3 ) // returns 1

Page 699: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 681

BirtMath.mod( 10, 5 ) // returns 0BirtMath.mod( 10, 6 ) // returns 4

The following example checks if numbers in the Grade field are odd or even. When the divisor is 2, the function returns 0 for even numbers, and 1 for odd numbers.BirtMath.mod( row["Grade"], 2 )

BirtMath.multiplyThis function returns the multiplication of two numbers.

Syntax Number BirtMath.multiply( Number n1, Number n2 )

Parameters n1Number object. The first number to use in the calculation.

n2Number object. The second number to use in the calculation.

Returns Number object. A number that results from multiplying n1 and n2.

Example The following example returns the result of multiplying values in the QuantityOrdered and PriceEach fields:BirtMath.multiply( row["QuantityOrdered"], row["PriceEach"] )

BirtMath.roundThis function rounds a number to a specified number of digits.

Syntax Number BirtMath.round( Number number, Number dec )

Parameters numberNumber object. The number to round.

decNumber object. The number of digits to round number to. If you omit this argument, the function assumes 0.

Returns Number object. A number rounded to a specified number of digits.

Examples The following examples shows the results that the function returns for specific numbers:BirtMath.round( 1545.50 ) // returns 1546BirtMath.round( 1545.56, 1 ) // returns 1545.6BirtMath.round( 1545.23, 1 ) // returns 1545.2BirtMath.round( 1545.50, -1 ) // returns 1550

The following example rounds the values in the PriceEstimate field to return an integer:BirtMath.round( row["PriceEstimate"], 0 )

Page 700: Actuate API Reference - OpenText

682 A c t u a t e A P I R e f e r e n c e

BirtMath.roundDownThis function rounds a number down to a specified number of digits.

Syntax Number BirtMath.roundDown( Number number, Number dec )

Parameters numberNumber object. The number to round.

decNumber object. The number of digits to round number down to. If you omit this argument, the function assumes 0.

Returns Number object. A number rounded down to a specified number of digits.

Examples The following examples shows the results that the function returns for specific numbers:BirtMath.roundDown( 1545.50 ) // returns 1545BirtMath.roundDown( 1545.56, 1 ) // returns 1545.5BirtMath.roundDown( 1545.23, 1 ) // returns 1545.2BirtMath.roundDown( 1545.50, -1 ) // returns 1540

The following example rounds down the values in the PriceEstimate field to return an integer:BirtMath.roundDown( row["PriceEstimate"], 0 )

BirtMath.roundUpThis function rounds a number up to a specified number of digits.

Syntax Number BirtMath.roundUp( Number number, Number dec )

Parameters numberNumber object. The number to round up.

decNumber object. The number of digits to round number up to. If you omit this argument, the function assumes 0.

Returns Number object. A number rounded up to a specified number of digits.

Examples The following examples shows the results that the function returns for specific numbers:BirtMath.roundUp( 1545.50 ) // returns 1546BirtMath.roundUp( 1545.56, 1 ) // returns 1545.6BirtMath.roundUp( 1545.23, 1 ) // returns 1545.3BirtMath.roundUp( 1545.50, -1 ) // returns 1550

The following example rounds up the values in the PriceEstimate field to return an integer:BirtMath.roundUp( row["PriceEstimate"], 0 )

Page 701: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 683

BirtMath.safeDivideThis function returns the result of dividing one number by another, preventing a division by zero condition.

Syntax Number BirtMath.safeDivide( Number dividend, Number divisor, object ifZero )

Parameters dividendNumber object. The number to be divided.

divisorNumber object. The number by which dividend is divided.

ifZeroObject. The value to return when divisor is 0.

Returns Number object. Number object. A number that results from dividing dividend by divisor.

Examples The following example shows the results that the function returns for specific numbers:BirtMath.safeDivide( 10, 2, 0 ) // returns 5BirtMath.safeDivide( 10, 0, 0 ) // returns 0

The following example returns the result of dividing values in the Revenue field by values in the Volume field. If the Volume value is 0, the function returns 0.BirtMath.safeDivide( row["Revenue"], row["Volume"], 0 )

BirtMath.subtractThis function returns the result of subtracting one number from another.

Syntax Number BirtMath.subtract( Number n1, Number n2 )

Parameters n1Number object. The number from which to subtract.

n2Number object. The number to subtract from n1.

Returns Number object. A number that results from subtracting n2 from n1.

Example The following example shows the results of subtracting specific numbers:BirtMath.subtract( 12, 4 ) // returns 8BirtMath.subtract( 4, 12) // returns -8

The following example returns the result of subtracting values in the Discount field from values in the Total field:BirtMath.subtract( row["Total"], row["Discount"] )

Page 702: Actuate API Reference - OpenText

684 A c t u a t e A P I R e f e r e n c e

Class BirtStrThe BirtStr class provides functions to manipulate strings, for example, to concatenate strings, trim extra spaces, get parts of a string, and display strings in lower or upper case. This class is static. The application cannot create instances of the class.

BirtStr.charLengthThis function returns the length of a given string.

Syntax integer BirtStr.charLength( string source )

Parameter sourceString. The string to evaluate.

Returns Integer. The number of characters in the specified string.

Examples The following example returns the length of a specific string:BirtStr.charLength( "Julie Murphy" ) // returns 12

The following example returns the length of each value in the CustomerName field:BirtStr.charLength( row["CustomerName"] )

BirtStr.concatThis function returns the string that results from concatenating specified strings.

Syntax string BirtStr.concat( string source1, ..., sourceN )

Parameter source1, ..., sourceNString. The strings to concatenate.

Returns String. The string that results from concatenating a series of strings.

Example The following example returns a full address by concatenating values from multiple fields:BirtStr.concat( row["AddressLine1"], ", ", row["AddressLine2"], ",

", row["City"], " ", row["PostalCode"], "row["State"], ", ", row["Country"] )

BirtStr.indexOfThis function returns the position of a specified substring in a given string.

Syntax integer BirtStr.indexOf( sring target, string source, integer start )

Page 703: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 685

Parameters targetString. The substring to search for. The search is case-sensitive.

sourceString. The string in which to look for a specified substring.

startInteger. Optional. The position in the source string where the search starts. If you omit this argument, the function starts the search from the first character of the string.

Returns Integer. The numerical position of the substring in the string. The first character of a string starts at 0. If the substring is not found, the function returns -1.

Examples The following example returns the numeric position of specified characters in specific strings:BirtStr.indexOf( " ", "Julie Murphy" ) // returns 5BirtStr.indexOf( "-", "ModelA-1234-567" ) // returns 6BirtStr.indexOf( "-", "ModelA-1234-567", 7 ) // returns 11

The following example uses BirtStr.indexOf( ) in conjunction with BirtStr.left( ) to display the characters that precede the space character in a customer name. The BirtStr.left( ) function extracts a substring of a specified length, starting from the first character. In this example, the length of the substring to display is equal to the numerical position of the space character.spaceCharPosition = BirtStr.indexOf( " ", row["customerName"] );displayFirstName = BirtStr.left( row["customerName"],

spaceCharPosition );

If the customer name is Julie Murphy, the expression returns Julie.

BirtStr.leftThis function extracts a substring of a specified length from a string, starting from the leftmost, or first, character.

Syntax string BirtStr.left( string source, integer n )

Parameters sourceString. The string from which to extract a substring.

nInteger. The number of characters to extract, starting from the first character.

Returns String. A substring of a specific length.

■ If you omit n, the number of characters to extract, the function returns the first character only.

■ If n is zero, the function returns an empty string.

Page 704: Actuate API Reference - OpenText

686 A c t u a t e A P I R e f e r e n c e

■ If n is greater than the length of the string, the function returns the entire string.

Examples The following example returns substrings of various lengths from specific strings:BirtStr.left( "Julie Murphy", 5 ) // returns JulieBirtStr.left( "Julie Murphy", 12 ) // returns Julie Murphy

The following example uses BirtStr.indexOf( ) in conjunction with BirtStr.left( ) to display the characters that precede the space character in a customer name. The BirtStr.left( ) function extracts a substring of a specified length, starting from the first character. In this example, the length of the substring to display is equal to the numerical position of the space character.spaceCharPosition = BirtStr.indexOf( " ", row["customerName"] );displayFirstName = BirtStr.left( row["customerName"],

spaceCharPosition );

If the customer name is Julie Murphy, the expression returns Julie.

BirtStr.rightThis function extracts a substring of a specified length from a string, starting from the rightmost, or last, character.

Syntax String BirtStr.right( String source, integer n )

Parameters sourceString. The string from which to extract a substring.

nInteger. The number of characters to extract, starting from the last character.

Returns String. A substring of a specific length.

■ If you omit n, the number of characters to extract, the function returns the last character only.

■ If n is zero, the function returns an empty string.

■ If n is greater than the length of the string, the function returns the entire string.

Examples The following example returns substrings of various lengths from specific strings:BirtStr.right( "Julie Murphy", 6 ) // returns MurphyBirtStr.right( "Julie Murphy", 12 ) // returns Julie Murphy

The following example uses BirtStr.right( ) in conjunction with the BirtStr.indexOf( ) and BirtStr.charLength( ) functions to display the characters that appear after the space character in a customer name. This example assumes that the number of characters after the hyphen varies. Therefore, the length of the entire string (returned by BirtStr.charLength( )) minus the length up to the hyphen (returned by BirtStr.indexOf( )) is the number of characters to display.

Page 705: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 687

spaceCharPosition = BirtStr.indexOf( " ", row["customerName"] );displayLastName = BirtStr.right( row["customerName"],

(BirtStr.charLength( row["customerName"] - (spaceCharPosition + 1)) )

If the customer name is Julie Murphy, the expression returns Murphy. If the customer name is Kwai Li, the expression returns Li.

BirtStr.searchThis function returns the position of a specified substring in a given string. The substring can contain wildcard characters.

Syntax integer BirtStr.search( string pattern, string source, integer index )

Parameters patternString. The string pattern to search for. The search is case-insensitive. You can use the following wildcard characters in a pattern:

■ An asterisk (*) matches zero or more characters, including spaces. For example, t*n matches tn, tin, and teen.

■ A question mark (?) matches exactly one character. For example, t?n matches tan, ten, tin, and ton. It does not match teen or tn.

To match a literal asterisk or question mark in a string, precede those characters with two backslash characters (\\). For example, to find the substring R*10, use the following string pattern:"R\\*10"

sourceString. The string in which to look for a specified substring.

indexInteger. Optional. The position in the source string where the search starts. If you omit this argument, the function starts the search from the first character of the string.

Returns Integer. The numerical position of the substring in the string. The first character of a string starts at 0. If the substring is not found, the function returns -1.

Examples The following example returns the numeric position of specified string patterns in specific strings:BirtStr.search( "XM?", "XMS-ModelA-1234-567" ) // returns 0BirtStr.search( "ModelA*", "XMS-ModelA-1234-567" ) // returns 4BirtStr.search( "-", "XMS-ModelA-1234-567", 4 ) // returns 10

The following example searches for the string pattern, S*A, in each value in the ProductCode field. If the product code is KBS5412A, the expression returns 2.BirtStr.search( "S*A", row["ProductCode"] )

Page 706: Actuate API Reference - OpenText

688 A c t u a t e A P I R e f e r e n c e

The following example uses BirtStr.search( ) in conjunction with BirtStr.left( ) to display the characters that precede the string pattern, -Model*, in a product name. The BirtStr.left( ) function extracts a substring of a specified length, starting from the first character. In this example, the length of the substring to display is equal to the numerical position of the string pattern.stringPatternPosition = BirtStr.search( "-Model*",

row["productName"] );displayString = BirtStr.left( row["productName"],

stringPatternPosition );

If the product name is XMS-ModelA-1234, the expression returns XMS.

BirtStr.toLowerThis function converts all letters in a string to lowercase.

Syntax string BirtStr.toLower( string source )

Parameter sourceString. The string to convert to lowercase.

Returns String. The specified string in all lowercase letters

Example The following example displays all the values in the productLine field in lowercase:BirtStr.toLower( row["productLine"] )

BirtStr.toUpperThis function converts all letters in a string to uppercase.

Syntax string BirtStr.toUpper( string source )

Parameter sourceString. The string to convert to uppercase.

Returns String. The specified string in all uppercase letters

Example The following example displays all the values in the customerName field in uppercase:BirtStr.toUpper( row["customerName"] )

BirtStr.trimThis function returns a string with all leading and trailing blank characters removed. It does not remove blank characters between words.

Syntax string BirtStr.trim( string source )

Parameter sourceString. The string from which to remove leading and trailing blank characters.

Page 707: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 689

Returns String. A string with all leading and trailing blank characters removed.

Example The following example uses BirtStr.trim( ) to remove all leading and trailing blank characters from values in the FirstName and LastName data fields. BirtStr.trim( row["FirstName"]) + " " +

BirtStr.trim(row["LastName"] )

BirtStr.trimLeftThis function returns a string with all leading and trailing blank characters removed. It does not remove blank characters between words.

Syntax string BirtStr.trimLeft( string source )

Parameter sourceString. The string from which to remove leading blank characters.

Returns String. A string with all leading blank characters removed.

Example The following example concatenates a literal string with each value in the customerName field. BirtStr.trimLeft( ) removes all blank characters preceding the customerName value so that there are no extra blank characters between the literal string and the customerName value."Customer name: " + BirtStr.trimLeft( row["customerName"] )

BirtStr.trimRightThis function returns a string with all trailing blank characters removed. It does not remove blank characters between words.

Syntax string BirtStr.trimRight( string source )

Parameter sourceString. The string from which to remove trailing blank characters.

Returns String. A string with all trailing blank characters removed.

Example The following example concatenates each value in the Comment field with a semicolon, then with a value in the Action field. BirtStr.trimRight( ) removes all blank characters after the Comment value so that there are no extra blank characters between the Comment string and the semicolon.BirtStr.trimRight( row["Comment"]) + "; " + row["Action"] )

Page 708: Actuate API Reference - OpenText

690 A c t u a t e A P I R e f e r e n c e

Class Finance The Finance class is a BIRT-provided JavaScript class that provides a set of static financial functions that you can use to perform a variety of common business computations. Financial values can be represented as a float value. The application cannot create an instance of this class.

Finance.ddb This function returns the depreciation of an asset for a given, single period using the double-declining balance method. Double-declining balance depreciation is an accelerated method of depreciation that results in higher depreciation charges and greater tax savings in the earlier years of the useful life of a fixed asset than are given by the straight-line depreciation method (SLN), where charges are uniform throughout.

The function uses the following formula for depreciation over a single period:

depreciation = (( initialCost - totalDepreciationFromPriorPeriods) * 2) / assetLifespan

The following rules apply:

■ assetLifespan and singlePeriod must both be expressed in terms of the same units of time.

■ All parameters must be positive numbers.

Syntax double ddb( double cost, double salvage, double life, integer period )

Parameters initialDouble. Numeric expression that specifies the initial cost of the asset.

salvageDouble. Numeric expression that specifies the value of the asset at the end of its useful life.

lifeDouble. Numeric expression that specifies the length of the useful life of the asset. You must provide this value in the same units of measure as singlePeriod. For example, if singlePeriod represents a month, then assetLifespan must be expressed in months.

periodInteger. Numeric expression that specifies the period for which you want DDB to calculate the depreciation. You must provide this value in the same units of measure as assetLifespan. For example, if assetLifespan is expressed in months, then singlePeriod must represent a period of one month.

Returns Double.

Page 709: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 691

Example The following example calculates the depreciation for the first year under the double-declining balance method for a new machine purchased at $1400, with a salvage value of $200, and a useful life estimated at 10 years. The result ($280) is assigned to the variable Year1Deprec: Year1Deprec = Finance.ddb(1400, 200, 10, 1)

See also Finance.sln functionFinance.syd function

Finance.fv This function returns the future value of an annuity based on periodic constant payments, and on an unvarying interest rate. An annuity is a series of cash payments, constant in value, made over a period of time. An annuity can be an investment, such as a monthly savings plan, or a loan, such as a home mortgage. The future value of an annuity is the cash balance you want after you have made your final payment.

For example, if you set up a savings plan with a goal of having $75,000 in 18 years to pay for your child’s education, the future value of the plan is $75,000.

Or if you take out a loan for $11,000, the future value of the loan is $0.00, as it is for any typical loan.

The following rules apply:

■ ratePerPeriod, numberPayPeriods, and eachPmt must all be expressed in terms of the same units, such as weekly, monthly, or yearly.

■ You must express cash paid out, such as deposits to savings, using negative numbers, and cash received, such as dividend checks, using positive numbers.

Syntax double fv( double rate, integer nPer, double pmt, double pvalue, integer due )

Parameters rateDouble numeric expression that specifies the interest rate that accrues per period. You must provide this value in the same units of measure as numberPayPeriods. For instance, if numberPayPeriods is expressed in months, then ratePerPeriod must be expressed as a monthly rate.

nPerInteger that specifies the total number of payment periods in the annuity. You must provide this value in the same units of measure as ratePerPeriod. For instance, if ratePerPeriod is expressed as a monthly rate, then numberPayPeriods must be expressed in months.

pmtDouble numeric expression that specifies the amount of each payment. You must provide this value in the same units of measure as ratePerPeriod. For instance, if ratePerPeriod is expressed in months, then eachPmt must be expressed as a monthly payment.

Page 710: Actuate API Reference - OpenText

692 A c t u a t e A P I R e f e r e n c e

pvalueDouble numeric expression that specifies the value today of a future payment, or stream of payments. For example, if you put $23.94 in the bank today and leave it there for 15 years at an interest rate of 10% compounded annually, you end up with about $100. The present value of that $100 is approximately $23.94.

dueInteger that specifies whether each payment is made at the beginning (1), or at the end (0) of each period. This value must be 0 or 1.

Returns Double

Example The following example assumes you deposit $10,000 in a savings account for your daughter when she is born. If the account pays 5.7% compounded daily, how much will she have for college in 18 years? The answer, $27,896.60, is assigned to the variable TotalValue:

TotalValue = Finance.fv(0.057/365, 18*365, 0, -10000, 1)

The following example is almost the same as the previous one. In this one, however, assume that the interest is compounded monthly instead of daily, and that you have decided to make an additional monthly deposit of $55 into the account. The future value assigned to TotalValue in this case is $48,575.82:

TotalValue = Finance.fv(0.057/12, 18*12, -55, -10000, 1)

See also Finance.ipmt functionFinance.nper functionFinance.pmt functionFinance.ppmt functionFinance.pv functionFinance.rate function

Finance.ipmt Returns the interest payment for a given period of an annuity, based on periodic, constant payments, and on an unvarying interest rate. An annuity is a series of cash payments, constant in value, made over a period of time. An annuity can be an investment, such as a monthly savings plan, or a loan, such as a home mortgage. Each payment consists of two components, principal and interest. iPmt returns the interest component of the payment.

The following rules apply:

■ ratePerPeriod and numberPayPeriods must be expressed in terms of the same units, such as weekly, monthly, or yearly.

■ You must express cash paid out, such as deposits to savings, using negative numbers, and cash received, such as dividend checks, using positive numbers.

Page 711: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 693

Syntax double ipmt( double rate, integer per, integer nPer, double pmt, double pvalue, double fvalue, integer due )

Parameters rateDouble numeric expression that specifies the interest rate that accrues per period. You must provide this value in the same units of measure as numberPayPeriods. For example, if numberPayPeriods is expressed in months, then ratePerPeriod must be expressed as a monthly rate.

perInteger that specifies the particular period for which you want to determine how much of the payment for that period represents interest. You must provide this value in the range 1 through numberPayPeriods.

nPerInteger that specifies the total number of payment periods in the annuity. You must provide this value in the same units of measure ratePerPeriod For example, if ratePerPeriod is expressed as a monthly rate, then numberPayPeriods must be expressed in months.

pvalueDouble numeric expression that specifies the value today of a future payment or stream of payments. For example, if you put $23.94 in the bank today and leave it there for 15 years at an interest rate of 10% compounded annually, you end up with about $100. In this case, the present value of that $100 is approximately $23.94.

fvalueDouble numeric expression that specifies the cash balance you want after you have made your final payment. For example:

■ You set up a savings plan with a goal of having $75,000 in 18 years to pay for your child’s education. For this plan, the future value is $75,000.

■ You take out a loan for $11,000. The future value is $0.00, as it is for any typical loan.

dueInteger that specifies whether each payment is made at the beginning (1) or at the end (0) of each period. This value must be 0 or 1.

Returns Double.

Example The following example assumes you are making monthly payments the first of each month on a loan of $20,000, over 36 months, at an APR of 11.5%. How much of your 5th payment represents interest? The answer, $171.83, is assigned to Interest5:

Interest5 = Finance.ipmt(.115/12, 5, 36, -20000, 0, 1)

See also Finance.fv functionFinance.nper function

Page 712: Actuate API Reference - OpenText

694 A c t u a t e A P I R e f e r e n c e

Finance.pmt functionFinance.ppmt functionFinance.pv functionFinance.rate function

Finance.irr This function returns the internal rate of return for a series of periodic cash flows, payments, and receipts in an existing array. The internal rate of return is the interest rate for an investment consisting of payments and receipts that occur at regular intervals. The cash flow for each period does not need to be constant, as it does for an annuity.

IRR is closely related to the net present value function, NPV, because the rate of return calculated by IRR is the interest rate corresponding to a net present value of zero. IRR calculates by iteration. Starting with the value of <starting guess>, it repeats the calculation until the result is accurate to within 0.00001 percent. If it cannot determine a result after 20 iterations, the function fails.

The following rules apply:

■ You must express cash paid out, such as deposits to savings, using negative numbers, and cash received, such as dividend checks, using positive numbers.

■ cashArray must contain at least one negative and one positive number.

■ In cases where you have both a positive cash flow, or income, and a negative one, or payment, for the same period, use the net flow for that period.

■ If no cash flow or net cash flow occurs for a particular period, you must type 0 (zero) as the value for that period.

The following tips can be useful:

■ Because IRR uses the order of values within the array to interpret the order of payments and receipts, be sure to type your payment and receipt values in the correct sequence.

■ If IRR fails, try a different value for startingGuess.

Syntax double irr( double[ ] cash, double intrate)

Parameters cashArray of double values that specify the name of an existing array of Doubles representing cash flow values. cashArray must contain at least one positive value, or receipt, and one negative value, or payment.

sDouble numeric expression that specifies the value you estimate internal rate of return will be. In most cases, this is 0.1, or 10 percent.

Returns Double

Page 713: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 695

Example The following example assumes you have filled the array myArray with a series of cash flow values. The internal rate of return is assigned to the variable IRRValue:

IRRValue = Finance.irr( myArray, .1 )

See also Finance.mirr functionFinance.npv functionFinance.rate function

Finance.mirr This function returns the modified internal rate of return for a series of periodic cash flows, or payments and receipts, in an existing array. The modified internal rate of return is the internal rate of return (IRR) when payments and receipts are financed at different rates. MIRR takes into account both the cost of the investment, or the financeRate, and the interest rate received on the reinvestment of cash, or the reinvestmentRate.

The following rules apply:

■ You must express cash paid out, such as deposits to savings, using negative numbers, and cash received, such as dividend checks, using positive numbers.

■ cashArray must contain at least one negative and one positive number.

■ In cases where you have both a positive cash flow, or income, and a negative one, or payment, for the same period, use the net flow for that period.

■ If no cash flow or net cash flow occurs for a particular period, you must type 0 (zero) as the value for that period.

Because MIRR uses the order of values within the array to interpret the order of payments and receipts, be sure to type payment and receipt values in the correct sequence.

Syntax double mirr( double[ ] arptr, double frate, double rrate)

Parameters arptrArray of Doubles that specifies the name of an existing array of cash flow values. Array must contain at least one positive value, or receipt, and one negative value, or payment.

frateDouble numeric expression that specifies the interest rate paid as the cost of financing. Must be a decimal value that represents a percentage.

rrateDouble numeric expression that specifies the interest rate received on gains from cash reinvestment. Must be a decimal value that represents a percentage.

Returns Double.

Page 714: Actuate API Reference - OpenText

696 A c t u a t e A P I R e f e r e n c e

Example The following example assumes you have filled the array myArray with a series of cash flow values. If the interest rate you pay for financing is 12%, and the rate your earn on income is 11.5%, what is the modified internal rate of return? The answer is assigned to the variable MIRRValue:

MIRRValue = Finance.mirr( myArray, 0.12, 0.115 )

See also Finance.irr functionFinance.rate function

Finance.nperReturns the number of periods for an annuity based on periodic, constant payments, and on an unvarying interest rate. An annuity is a series of cash payments, constant in value, made over a period of time. An annuity can be an investment, such as a monthly savings plan, or a loan, such as a home mortgage.

The following rules apply:

■ ratePerPeriod and eachPmt must be expressed in terms of the same units, such as weekly, monthly, or yearly.

■ You must express cash paid out, such as deposits to savings, using negative numbers, and cash received, such as dividend checks, using positive numbers.

Syntax double nper( double rate, double pmt, double pvalue, double fvalue, integer due )

Parameters rateDouble numeric expression that specifies the interest rate that accrues per period. You must provide this value in the same units of measure as eachPmt. For instance, if eachPmt is expressed as a monthly payment, then ratePerPeriod must be expressed as the monthly interest rate.

pmtDouble numeric expression that specifies the amount of each payment. You must provide this value in the same units of measure as ratePerPeriod. For instance, if ratePerPeriod is expressed in months, then eachPmt must be expressed as a monthly payment.

pvalueDouble numeric expression that specifies the value today of a future payment or of a stream of payments. For example, if you put $23.94 in the bank today and leave it there for 15 years at an interest rate of 10% compounded annually, you will end up with about $100. In this case, the present value of that $100 is approximately $23.94.

fvalueDouble numeric expression that specifies the cash balance you want after you have made your final payment. For example:

Page 715: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 697

■ You set up a savings plan with a goal of having $75,000 in 18 years to pay for your child’s education. For this plan, the future value is $75,000.

■ You take out a loan for $11,000. The future value is $0.00, as it is for any typical loan.

dueInteger that specifies whether each payment is made at the beginning (1), or at the end (0) of each period. This value must be 0 or 1.

Returns Double.

Example The following example assumes you are making monthly payments at the first of each month on a loan of $20,000, at an APR of 11.5%. If each payment is $653.26, how many payments will you have to make to finish paying off the loan? The answer, 36, is assigned to the variable NumPeriods.

NumPeriods = Finance.nper(.115/12, -653.26, 20000, 0, 1)

See also Finance.fv functionFinance.ipmt functionFinance.pmt functionFinance.ppmt functionFinance.pv functionFinance.rate function

Finance.npvThis function returns the net present value of a varying series of periodic cash flows, both positive and negative, at a given interest rate. While PV determines the present value of a series of constant payments, NPV does the same for a series of varying payments. Net present value is the value in today's dollars of all future cash flows associated with an investment minus any initial cost. In other words, it is that lump sum of money that would return the same profit or loss as the series of cash flows in question, if the lump sum were deposited in a bank today and left untouched to accrue interest at the rate given by <rate> for the same period of time contemplated by the cash flow stream.

The following rules apply:

■ The NPV investment begins one period before the date of the first cash flow value and ends with the last cash flow value in the array.

■ If your first cash flow occurs at the beginning of the first period, its value must be added to the value returned by NPV and must not be included in the cash flow values of cashArray.

■ You must express cash paid out, such as deposits to savings, using negative numbers, and cash received, such as dividend checks, using positive numbers.

■ cashArray must contain at least one negative and one positive number.

Page 716: Actuate API Reference - OpenText

698 A c t u a t e A P I R e f e r e n c e

■ In cases where you have both a positive cash flow, or income, and a negative one, or payment, for the same period, use the net flow for that period.

■ If no cash flow or net cash flow occurs for a particular period, you must supply 0 (zero) as the value for that period.

Because NPV uses the order of values within the array to interpret the order of payments and receipts, be sure to supply your payment and receipt values in the correct sequence.

Syntax double npv( double rate, double[ ] arptr )

Parameters rateDouble numeric expression that specifies the discount rate over the length of the period. You must express this value as a decimal.

arptrArray of doubles that specifies the name of an existing array of cash flow values. Array must contain at least one positive value, receipt, and one negative value, payment.

Returns Double.

Example The following example assumes you have filled the array myArray with a series of cash flow values, and that the interest rate is 11%. What is the net present value? The answer is assigned to the variable NetPValue:

NetPValue = Finance.npv( .11, MyArray )

Finance.percent This function computes the percentage of two numbers. This function handles the two key housekeeping tasks associated with computing percents: handling zero in the numerator and handling null values.

Syntax double percent( double denom, double num, double valueIfZero )

Parameters denomDouble. The denominator. The argument must contain a numeric value.

numDouble. The numerator. The argument must contain a numeric value. The value can be zero.

valueIfZeroDouble. The percent value to return if the numerator is zero. The default is null.

Returns The ratio of the two numbers expressed as a percentage. Returns 0 if the numerator is zero. Returns null if either of the two arguments are null.

Example pct = Finance.percent( 20, 50 ) // returns 40pct = Finance.percent( 20, 0 ) // returns 0

Page 717: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 699

Finance.pmtReturns the payment for an annuity, based on periodic, constant payments, and on an unvarying interest rate. An annuity is a series of cash payments, constant in value, made over a period of time. An annuity can be an investment, such as a monthly savings plan, or a loan, such as a home mortgage.

The following rules apply:

■ ratePerPeriod and numberPayPeriods must be expressed in terms of the same units, such as weekly, monthly, or yearly.

■ You must express cash paid out, such as deposits to savings, using negative numbers, and cash received (such as dividend checks) using positive numbers.

Syntax double pmt( double rate, integer nPer, double pvalue, double fvalue, integer due )

Parameters rate

Double numeric expression that specifies the interest rate that accrues per period. You must provide this value in the same units of measure as ratePerPeriod. For instance, if numberPayPeriods is expressed in months, then ratePerPeriod must be expressed as a monthly rate.

nPerInteger that specifies the total number of payment periods in the annuity. You must provide this value in the same units of measure as ratePerPeriod. For instance, if ratePerPeriod is expressed as a monthly rate, then numberPayPeriods must be expressed in months.

pvalueDouble numeric expression that specifies the value in today's dollars of a future payment, or stream of payments. For example, if you put $23.94 in the bank today and leave it there for 15 years at an interest rate of 10% compounded annually, you end up with about $100. In this case, the present value of that $100 is approximately $23.94.

fvalueDouble numeric expression that specifies the cash balance you want after you have made your final payment. For example:

■ You set up a savings plan with a goal of having $75,000 in 18 years to pay for your child’s education. For this plan, the future value is $75,000.

■ You take out a loan for $11,000. The future value is $0.00, as it is for any typical loan.

dueInteger that specifies whether each payment is made at the beginning (1), or at the end (0) of each period. This value must be a 0 or 1.

Page 718: Actuate API Reference - OpenText

700 A c t u a t e A P I R e f e r e n c e

Returns Double.

Example The following example assumes you are making monthly payments the first of each month on a loan of $20,000, over 36 months, at an APR of 11.5%. How much will each of your payments be? The answer, $653.26, is assigned to PaymentAmt.

PaymentAmt = Finance.pmt(.115/12, 36, -20000, 0, 1)

See also Finance.fv functionFinance.ipmt functionFinance.nper functionFinance.ppmt functionFinance.pv functionFinance.rate function

Finance.ppmt Returns the principal payment for a given period of an annuity, based on periodic, constant payments, and on an unvarying interest rate. An annuity is a series of cash payments, constant in value, made over a period of time. An annuity can be an investment, such as a monthly savings plan, or a loan, such as a home mortgage. Each payment in an annuity consists of two components: principal and interest. ppmt returns the principal component of the payment.

The following rules apply:

■ ratePerPeriod and numberPayPeriods must be expressed in terms of the same units such as weeks, months or years.

■ You must express cash paid out, such as deposits to savings, using negative numbers, and cash received, such as dividend checks, using positive numbers.

Syntax double ppmt( double rate, integer per, integer nPer, double pmt, double pvalue, double fvalue, integer due )

Parameters rateDouble numeric expression that specifies the interest rate that accrues per period. You must provide this value in the same units of measure as nPer. For instance, if nPer is expressed in months, then rate must be expressed as a monthly rate.

perInteger that specifies the particular period for which you want to determine how much of the payment for that period represents interest. This value must be in the range 1 through nPer.

nPerInteger that specifies the total number of payment periods in the annuity. You must provide this value in the same units of measure as rate. For instance, if rate is expressed as a monthly rate, then nPer must be expressed in months.

Page 719: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 701

pvalue Double numeric expression that specifies the value today of a future payment, or stream of payments. For example, if you put $23.94 in the bank today and leave it there for 15 years at an interest rate of 10% compounded annually, you end up with about $100. In this case, the present value of that $100 is approximately $23.94.

fvalueDouble numeric expression that specifies the cash balance you want after you have made your final payment. For example:

■ You set up a savings plan with a goal of having $75,000 in 18 years to pay for your child’s education. For this plan, the future value is $75,000.

■ You take out a loan for $11,000. The future value is $0.00, as it is for any typical loan.

dueInteger that specifies whether each payment is made at the beginning (1), or at the end (0) of each period. This value must be a 0 or 1.

Returns Double.

Example The following example assumes you are making monthly payments at the first of each month on a loan of $20,000, over 36 months, at an APR of 11.5%. How much of your 5th payment represents principal? The answer, $481.43, is assigned to Principal5:

Principal5 = Finance.ppmt(.115/12, 5, 36, -20000, 0, 1)

See also Finance.fv function Finance.ipmt function Finance.nper function Finance.pmt function Finance.pv function Finance.rate function

Finance.pv This function returns the present value of an annuity based on periodic, constant payments to be paid in the future, and on an unvarying interest rate. An annuity is a series of cash payments, constant in value, made over a period of time. An annuity can be an investment, such as a monthly savings plan, or a loan, such as a home mortgage. The present value is the value today of a future payment, or of a stream of payments structured as an annuity.

For example, if you put $23.94 in the bank today and leave it there for 15 years at an interest rate of 10% compounded annually, you end up with about $100. So, the present value of that $100 is approximately $23.94.

Page 720: Actuate API Reference - OpenText

702 A c t u a t e A P I R e f e r e n c e

The following rules apply:

■ ratePerPeriod and numberPayPeriods must be expressed in terms of the same units, weekly, monthly, or yearly.

■ You must express cash paid out, such as deposits to savings, using negative numbers, and cash received, such as dividend checks, using positive numbers.

Syntax double pv( double rate, integer nPer, double pmt, double fvalue, integer due)

Parameters rateDouble numeric expression that specifies the interest rate that accrues per period. You must provide this value in the same units of measure as nPer. For instance, if nPer is expressed in months, then rate must be expressed as a monthly rate.

nPerInteger that specifies the total number of payment periods in the annuity. You must provide this value in the same units of measure as rate. For instance, if rate is expressed as a monthly rate, then nPer must be expressed in months.

pmtDouble numeric expression that specifies the amount of each payment. You must provide this value in the same units of measure as rate. For instance, if rate is expressed in months, then pmt must be expressed as a monthly payment.

fvalueDouble. Specifies the cash balance you want after you have made your final payment. For example:

■ You set up a savings plan with a goal of having $75,000 in 18 years to pay for your child's education. For this plan, the future value is $75,000.

■ You take out a loan for $11,000. The future value is $0.00, as it is for any typical loan.

dueInteger that specifies whether each payment is made at the beginning or at the end of each period. This value must be a 1 for beginning of period, or 0 (zero) for end of period.

Returns Double

Example The following example assumes you are considering the purchase of a corporate bond with a $1000 face value. The bond pays an annual coupon of $100, matures in 15 years, and the next coupon is paid at the end of one year. The yield to maturity on similar bonds is 12.5%. What is a fair price for this bond, or in other words, what is its present value? The answer, $834.18, is assigned to the variable PresentValue:

PresentValue = Finance.pv(.125, 15, 100, 1000, 0)

The following examples assumes you have won the lottery. The jackpot is $10 million, which you receive in yearly installments of $500,000 per year for

Page 721: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 703

20 years, beginning one year from today. If the interest rate is 9.5% compounded annually, how much is the lottery worth today? The answer, $4,406,191.06, is assigned to PresentValue:

PresentValue = Finance.pv(.095, 20, 50000,10000000, 0)

The following example assumes you want to save $11,000 over the course of 3 years. If the APR is 10.5% and you plan to save $325 monthly, and if you make your payments at the beginning of each month, how much would you need to start off with in your account to achieve your goal? The answer, $2,048.06, is assigned to StartValue. Note that eachPmt is expressed as a negative number because it represents cash paid out:

StartValue = Finance.pv(.105/12, 3*12, -325, 11000, 1)

See also Finance.fv functionFinance.ipmt functionFinance.nper functionFinance.pmt functionFinance.ppmt functionFinance.rate function

Finance.rate This function returns the interest rate per period for an annuity. An annuity is a series of cash payments, constant in value, made over a period of time. An annuity can be an investment, such as a monthly savings plan, or a loan, such as a home mortgage.

Rate calculates the interest rate on an annuity iteratively. Starting with the value of startingGuess, it repeats the calculation until the result is accurate to within 0.00001 percent. If it cannot determine a result after 20 iterations, the function fails.

The following rules apply:

■ numberPayPeriods, and eachPmt must be expressed in terms of the same units, such as weekly, monthly, or yearly.

■ You must express cash paid out, such as deposits to savings, using negative numbers and cash received, such as dividend checks, using positive numbers.

The following tips can be helpful:

■ Because Rate uses the order of values within the array to interpret the order of payments and receipts, be sure to provide your payment and receipt values in the correct sequence.

■ If Rate fails, try a different value startingGuess.

Page 722: Actuate API Reference - OpenText

704 A c t u a t e A P I R e f e r e n c e

Syntax double rate( integer nper, double pmt, double pvalue, double fvalue, integer due, double guess)

Parameters nperInteger that specifies the total number of payment periods in the annuity. You must provide this value in the same units of measure as pmt. For instance, if pmt is expressed as a monthly payment, then nper must be expressed in months.

pmtDouble numeric expression that specifies the amount of each payment. You must provide this value in the same units of measure as nper. For instance, if nper is expressed in months, then pmt must be expressed as a monthly payment.

pvalueDouble numeric expression that specifies the value today of a future payment, or of a stream of payments. For example, if you put $23.94 in the bank today and leave it there for 15 years at an interest rate of 10% compounded annually, you will end up with about $100. So in this case, the present value of that $100 is approximately $23.94.

fvalueDouble numeric expression that specifies the cash balance you want after you have made your final payment. For example:

■ You set up a savings plan with a goal of having $75,000 in 18 years to pay for your child’s education. For this plan, the future value is $75,000.

■ You take out a loan for $11,000. The future value is $0.00, as it is for any typical loan.

dueInteger that specifies whether each payment is made at the beginning or at the end of each period. This value must be a 1 for beginning of period or 0 (zero) for end of period.

guessDouble numeric expression that specifies the value you estimate Rate will return. In most cases, this is 0.1, or 10 percent.

Returns Double

Example The following example assumes you have taken out a loan for $20,000, that you are paying off over the course of 3 years. If your payments are $653.26 per month, and you make them at the beginning of each month, what interest rate (APR) are you paying? The answer, .115 or 11.5%, is assigned to the variable InterestRate. Note that the return value of Rate must be multiplied by 12 to yield an annual rate:

InterestRate = Finance.rate(3*12, -653.26, 20000, 0, 1, .1) * 12

See also Finance.fv functionFinance.ipmt function

Page 723: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 705

Finance.nper functionFinance.pmt functionFinance.ppmt functionFinance.pv function

Finance.sln This function returns the straight-line depreciation of an asset for a single period. Straight-line depreciation is the oldest and simplest method of depreciating a fixed asset. It uses the book value of the asset less its estimated residual value, and allocates the difference equally to each period of the asset’s life. Such procedures are used to arrive at a uniform annual depreciation expense that is charged against income before calculating income taxes. All arguments must be positive numbers.

Syntax double sln( double cost, double salvage, double life )

Parameters costDouble numeric expression that specifies the initial cost of the asset.

salvageDouble numeric expression that specifies the value of the asset at the end of its useful life. You can type a salvage value to view the straight line depreciation offset by the salvage value, or return straight line depreciation without salvage value by supplying 0 (zero) in salvage value.

lifeDouble numeric expression that specifies the length of the useful life of the asset. You must provide this value in the same units of measure you want the function to return. For example, if you want SLN to determine the annual depreciation of the asset, assetLifespan must be given in years.

Returns Double.

Example The following example calculates the depreciation under the straight-line method for a new machine purchased at $1400, with a salvage value of $200, and a useful life estimated at 10 years. The result, $120 annually, is assigned to AnnualDeprec:

AnnualDeprec = Finance.sln(1400, 200, 10)

See also Finance.ddb functionFinance.syd function

Finance.syd This function returns sum-of-years’-digits depreciation of an asset for a specified period. Sum-of-years’-digits is an accelerated method of depreciation that results in higher depreciation charges and greater tax savings in the earlier years of the

Page 724: Actuate API Reference - OpenText

706 A c t u a t e A P I R e f e r e n c e

useful life of a fixed asset than are given by the straight-line depreciation method (SLN), where charges are uniform throughout.

The function bases depreciation on an inverted scale of the total of digits for the years of useful life. For instance, if the asset’s useful life is 4 years, the digits 4, 3, 2, and 1 are added together to produce 10. SYD for the first year then becomes four tenths of the depreciable cost of the asset, or the cost less salvage value. The rate for the second year becomes three tenths, and so forth.

The following rules apply:

■ singlePeriod and assetLifespan must both be expressed in terms of the same units of time.

■ All arguments must be positive numbers.

Syntax double syd( double cost, double salvage, double life, integer period )

Parameters costDouble numeric expression that specifies the initial cost of the asset.

salvageDouble numeric expression that specifies the value of the asset at the end of its useful life.

lifeDouble numeric expression that specifies the length of the useful life of the asset. You must give this value in the same units of measure as period. For example, if period represents a month, then life must be expressed in months.

periodInteger that specifies the period for which you want syd to calculate the depreciation. You must give this value in the same units of measure as life. For example, if life is expressed in months, then period must represent a period of one month.

Returns Double

Example The following example calculates the depreciation for the first year under the sum-of-years’-digits method for a new machine purchased at $1400, with a salvage value of $200, and a useful life estimated at 10 years. The result, $218.18, is assigned to Year1Deprec.

Year1Deprec = Finance.syd(1400, 200, 10, 1)

Note that:

■ This result is equivalent to 10/55 * $1,200

■ 55 = 10 + 9 + 8 + 7 + 6 + 5 + 4 + 3 + 2 + 1

■ 10 is the 1st (Year 1) term in this series of digits

Page 725: Actuate API Reference - OpenText

C h a p t e r 9 , S c r i p t i n g r e f e r e n c e 707

The following example calculates the depreciation of the same asset for the second year of its useful life. The result, $196.36, is assigned to Year2Deprec. Year2Deprec = Finance.syd(1400, 200, 10, 2)

Note that:

■ This result is equivalent to 9/55 * $1,200

■ 55 = 10 + 9 + 8 + 7 + 6 + 5 + 4 + 3 + 2 + 1

■ 9 is the 2nd (Year 2) term in this series of digits

See also Finance.ddb functionFinance.sln function

Page 726: Actuate API Reference - OpenText

708 A c t u a t e A P I R e f e r e n c e

Class FormatterThe Formatter class is a BIRT-provided JavaScript class that provides one static function to retrieve a formatted string from an object using any of the set String Format pattern values. These values are identical to the XML pattern markup for data type format values defined in Properties.

Formatter.formatThis function returns a formatted string derived from the input object.

Syntax string format(object value, string pattern)

Parameters valueObject. The data to format into a patterned string.

patternString. The valid values include:

■ > for uppercase

■ < for lowercase

■ ^ to preserve leading white space

■ Custom combinations of characters and the @ wildcard for the right-aligned character, such as @@@@@-@@@@ for zip+4

Returns String. The formatted string.

Example The following example returns the uppercase values for the customer’s last name: Formatter.format(dataSetRow["CONTACTLASTNAME"], '>')

Page 727: Actuate API Reference - OpenText

C h a p t e r 1 0 , E a s y S c r i p t F u n c t i o n R e f e r e n c e 709

C h a p t e r

10Chapter 10EasyScript Function

ReferenceThis chapter contains the following topics:

■ About EasyScript

■ EasyScript functions quick reference

■ Functions

■ Operators

Page 728: Actuate API Reference - OpenText

710 A c t u a t e A P I R e f e r e n c e

About EasyScriptEasyScript is an expression syntax similar to the syntax used in Excel formulas. Like Excel, EasyScript provides functions for performing calculations on report data. In BIRT Designer Professional, EasyScript is supported in most places an expression is required. For example, when specifying an expression for a computed column, a column binding, a filter condition, or a map rule, you can use either JavaScript or EasyScript.

EasyScript functions quick referenceTable 10-1 lists the EasyScript functions.

Table 10-1 EasyScript functions

EasyScript function Description

ABS( ) Returns the absolute value of a number without regard to its sign

ADD_DAY( ) Adds a specified number of days to a date value

ADD_HOUR( ) Adds a specified number of hours to a date value

ADD_MINUTE( ) Adds a specified number of minutes to a date value

ADD_MONTH( ) Adds a specified number of months to a date value

ADD_QUARTER( ) Adds a specified number of quarters to a date value

ADD_SECOND( ) Adds a specified number of seconds to a date value

ADD_WEEK( ) Adds a specified number of weeks to a date value

ADD_YEAR( ) Adds a specified number of years to a date value

BETWEEN( ) Tests if a value is between two specified values

CEILING( ) Rounds a number up to the nearest specified multiple

Page 729: Actuate API Reference - OpenText

C h a p t e r 1 0 , E a s y S c r i p t F u n c t i o n R e f e r e n c e 711

DAY( ) Returns a number from 1 to 31 that represents the day of the month

DIFF_DAY( ) Calculates the number of days between two date values

DIFF_HOUR( ) Calculates the number of hours between two date values

DIFF_MINUTE( ) Calculates the number of minutes between two date values

DIFF_MONTH( ) Calculates the number of months between two date values

DIFF_QUARTER( ) Calculates the number of quarters between two date values

DIFF_SECOND( ) Calculates the number of seconds between two date values

DIFF_WEEK( ) Calculates the number of weeks between two date values

DIFF_YEAR( ) Calculates the number of years between two date values

FIND( ) Finds the location of a substring in a string

IF( ) Returns one value if a specified condition evaluates to true, or another value if the condition evaluates to false

IN( ) Tests if a value is equal to a value in a list

ISNULL( ) Tests if a value in a specified field is a null value

LEFT( ) Extracts a substring from a string, starting from the left-most, or first, character

LEN( ) Counts the number of characters in a string

LIKE( ) Tests if a string matches a pattern

LOWER( ) Converts all letters in a string to lowercase

(continues)

Table 10-1 EasyScript functions (continued)

EasyScript function Description

Page 730: Actuate API Reference - OpenText

712 A c t u a t e A P I R e f e r e n c e

MATCH( ) Tests if a string matches a pattern

MOD( ) Returns the remainder after a number is divided by another

MONTH( ) Returns the month for a specified date value

NOT( ) Negates a Boolean expression

NOTNULL( ) Tests if a value in a specified field is a non-null value

NOW( ) Returns the current date and time

QUARTER( ) Returns the quarter number for a specified date value

RIGHT( ) Extracts a substring from a string, starting from the right-most, or last, character

ROUND( ) Rounds a number to a specified number of digits

ROUNDDOWN( ) Rounds a number down to a specified number of digits

ROUNDUP( ) Rounds a number up to a specified number of digits

SEARCH( ) Finds the location of a substring in a string

SQRT( ) Calculates the square root of a number

TODAY( ) Returns the current date

TRIM( ) Removes the leading and trailing blanks from a specified string

TRIMLEFT( ) Removes the leading blanks from a specified string

TRIMRIGHT( ) Removes the trailing blanks from a specified string

UPPER( ) Converts all letters in a string to uppercase

WEEK( ) Returns a number from 1 to 52 that represents the week of the year

Table 10-1 EasyScript functions (continued)

EasyScript function Description

Page 731: Actuate API Reference - OpenText

C h a p t e r 1 0 , E a s y S c r i p t F u n c t i o n R e f e r e n c e 713

FunctionsThis section is a complete reference to all of the EasyScript functions in BIRT Designer Professional. This reference organizes the functions alphabetically. Each function entry includes a general description of the function, its syntax, the arguments to the function, the result the function returns, and an example that shows typical usage.

ABS( )Returns the absolute value of a number without regard to its sign. For example, 6 is the absolute value of 6 and -6.

Syntax ABS(number)

Argument numberThe number for which you want to find the absolute value.

Returns An integer that represents the absolute value of a specified number.

Example The following example returns the absolute value for each number in the TemperatureCelsius field:ABS([TemperatureCelsius])

ADD_DAY( )Adds a specified number of days to a date value.

Syntax ADD_DAY(date, n)

Arguments dateThe date or date expression that represents the start date.

nThe number of days to add to the start date. If you specify a negative number, the result is as if the number is subtracted from the start date.

WEEKDAY( ) Returns the day of the week for a specified date value

YEAR( ) Returns the four-digit year value for a specified date value

Table 10-1 EasyScript functions (continued)

EasyScript function Description

Page 732: Actuate API Reference - OpenText

714 A c t u a t e A P I R e f e r e n c e

Returns The date value that results from adding the specified number of days to the start date.

Example The following example adds 15 days to each date value in the InvoiceDate field:ADD_DAY([InvoiceDate], 15)

ADD_HOUR( )Adds a specified number of hours to a date value.

Syntax ADD_HOUR(date, n)

Arguments dateThe date or date expression that represents the start date. If a start date does not have a time value, the function assumes the time is midnight, 12:00 AM.

nThe number of hours to add to the start date. If you specify a negative number, the result is as if the number is subtracted from the start date.

Returns The date-and-time value that results from adding the specified number of hours to the start date.

Example The following example adds eight hours to each date value in the ShipDate field:ADD_HOUR([ShipDate], 8)

ADD_MINUTE( )Adds a specified number of minutes to a date value.

Syntax ADD_MINUTE(date, n)

Arguments dateThe date or date expression that represents the start date. If a start date does not have a time value, the function assumes the time is midnight, 12:00 AM.

nThe number of minutes to add to the start date. If you specify a negative number, the result is as if the number is subtracted from the start date.

Returns The date-and-time value that results from adding the specified number of minutes to the start date.

Example The following example subtracts 30 minutes from each date in the StartTime field:ADD_MINUTE([StartTime], -30)

Page 733: Actuate API Reference - OpenText

C h a p t e r 1 0 , E a s y S c r i p t F u n c t i o n R e f e r e n c e 715

ADD_MONTH( )Adds a specified number of months to a date value.

Syntax ADD_MONTH(date, n)

Arguments dateThe date or date expression that represents the start date.

nThe number of months to add to the start date. If you specify a negative number, the result is as if the number is subtracted from the start date.

Returns The date value that results from adding the specified number of months to the start date. This function always returns a valid date. If necessary, the day part of the resulting date is adjusted downward to the last day of the resulting month in the resulting year. For example, if you add one month to 1/31/08, ADD_MONTH( ) returns 2/29/08, not 2/31/08 or 2/28/08, because 2008 is a leap year.

Example The following example adds two months to each date value in the InitialRelease field:ADD_MONTH([InitialRelease], 2)

ADD_QUARTER( )Adds a specified number of quarters to a date value.

Syntax ADD_QUARTER(date, n)

Arguments dateThe date or date expression that represents the start date.

nThe number of quarters to add to the start date. If you specify a negative number, the result is the number subtracted from the start date.

Returns The date value that results from adding the specified number of quarters to the start date. A quarter is equal to three months. For example, if you add two quarters to 9/22/08, ADD_QUARTER( ) returns 3/22/09.

Example The following example adds two quarters to each date value in the ForecastClosing field:ADD_QUARTER([ForecastClosing], 2)

Page 734: Actuate API Reference - OpenText

716 A c t u a t e A P I R e f e r e n c e

ADD_SECOND( )Adds a specified number of seconds to a date value.

Syntax ADD_SECOND(date, n)

Arguments dateThe date or date expression that represents the start date. If a start date does not have a time value, the function assumes the time is midnight, 12:00 AM.

nThe number of seconds to add to the start date. If you specify a negative number, the result is as if the number is subtracted from the start date.

Returns The date-and-time value that results from adding the specified number of seconds to the start date.

Example The following example adds 30 seconds to each date value in the StartTime field:ADD_SECOND([StartTime], 30)

ADD_WEEK( )Adds a specified number of weeks to a date value.

Syntax ADD_WEEK(date, n)

Arguments dateThe date or date expression that represents the start date.

nThe number of weeks to add to the start date. If you specify a negative number, the result is as if the number is subtracted from the start date.

Returns The date value that results from adding the number of weeks to the start date.

Example The following example adds two weeks to each date value in the OrderDate field:ADD_WEEK([OrderDate], 2)

ADD_YEAR( )Adds a specified number of years to a date value.

Syntax ADD_YEAR(date, n)

Arguments dateThe date or date expression that represents the start date.

Page 735: Actuate API Reference - OpenText

C h a p t e r 1 0 , E a s y S c r i p t F u n c t i o n R e f e r e n c e 717

nThe number of years to add to the start date. If you specify a negative number, the result is as if the number is subtracted from the start date.

Returns The date value that results from adding the number of years to the start date.

Example The following example adds five years to each date value in the HireDate field:ADD_YEAR([HireDate], 5)

BETWEEN( )Tests if a value is between two specified values.

Syntax BETWEEN(source, target1, target2)

Arguments sourceThe value to test. The value can be a string, numeric, or date value.

target1The first value in the range of values to compare to. String and date values must be enclosed in double quotation marks (" ").

target2The second value in the range of values to compare to. String and date values must be enclosed in double quotation marks (" ").

Returns True if source is between target1 and target2, or equal to target1 or target2; returns false otherwise.

Examples The following example tests each value in the SalesTotal field to see if the value is between 10000 and 20000:BETWEEN([SalesTotal], 10000, 20000)

The following example tests each value in the CustomerName field to see if the value is between A and M:BETWEEN([CustomerName], "A", "M")

The following example tests each value in the ReceiptDate field to see if the value is between 10/01/07 and 12/31/07:BETWEEN([ReceiptDate], "10/01/07", "12/31/07")

The following example uses BETWEEN( ) in conjunction with the IF( ) and ADD_DAY( ) functions to calculate a shipment date. If an orderDate value is in December 2007 (between 12/1/07 and 12/31/07), add five days to the orderDate value. If an orderDate value is in a month other than December, add three days to the orderDate value.IF(BETWEEN([orderDate], "12/01/07", "12/31/07"),

ADD_DAY([orderDate], 5), ADD_DAY([orderDate], 3))

Page 736: Actuate API Reference - OpenText

718 A c t u a t e A P I R e f e r e n c e

CEILING( )Rounds a number up to the nearest specified multiple.

Syntax CEILING(number, significance)

Arguments numberThe number to round up.

significanceThe multiple to round number to.

Returns The number that results from the rounding. If the specified number value is an exact multiple of significance, no rounding occurs.

Examples CEILING( ) is commonly used to round up prices. For example, to avoid dealing with pennies, you can round prices in a Price field up to the nearest nickel with the following expression: CEILING([Price], 0.05)

If the Price value is 20.52, CEILING( ) returns 20.55.

The following example rounds prices up to the nearest dime:CEILING([Price], 0.1)

If the Price value is 20.52, CEILING( ) returns 20.60. If the Price value is 20.50, CEILING( ) returns 20.50. No rounding occurs because 20.50 is already a multiple of 0.1.

The following example rounds prices up to the nearest dollar:CEILING([Price], 1)

If the Price value is 20.30, CEILING( ) returns 21.0.

DAY( )Returns a number from 1 to 31 that represents the day of the month.

Syntax DAY(date)

Argument dateThe date or date expression from which you want to extract the day.

Returns The number of the day of the month for the specified date value.

Example The following example gets the number of the day for each date value in the ShipDate field:DAY([ShipDate])

Page 737: Actuate API Reference - OpenText

C h a p t e r 1 0 , E a s y S c r i p t F u n c t i o n R e f e r e n c e 719

DIFF_DAY( )Calculates the number of days between two date values.

Syntax DIFF_DAY(date1, date2)

Arguments date1The first date or date expression to use in the calculation.

date2The second date or date expression to use in the calculation.

Returns The number of days between date1 and date2. If date1 is earlier than date2, the result is a positive number; otherwise the result is a negative number.

Example The following example calculates the time it takes to pay invoices by computing the number of days between each value in the invoiceDate field and each value in the paymentDate field:DIFF_DAY([invoiceDate],[paymentDate])

The following example calculates the number of days from an order date to Christmas:DIFF_DAY([orderDate], "12/25/10")

The following example calculates the number of days from the current date to Christmas. TODAY( ) is a function that returns the current date.DIFF_DAY(TODAY(), "12/25/10")

DIFF_HOUR( )Calculates the number of hours between two date values.

Syntax DIFF_HOUR(date1, date2)

Arguments date1The first date or date expression to use in the calculation. If the date does not have a time value, the function assumes the time is midnight, 12:00 AM.

date2The second date or date expression to use in the calculation. If the date does not have a time value, the function assumes the time is midnight, 12:00 AM.

Returns The number of hours between date1 and date2.

Example The following example calculates the number of hours between each value in the startTime field and each value in the finishTime field:DIFF_HOUR([startTime],[finishTime])

Page 738: Actuate API Reference - OpenText

720 A c t u a t e A P I R e f e r e n c e

The following example calculates the number of hours from the current date to Christmas. NOW( ) is a function that returns the current date and time.DIFF_HOUR(NOW(), "12/25/10")

DIFF_MINUTE( )Calculates the number of minutes between two date values.

Syntax DIFF_MINUTE(date1, date2)

Arguments date1The first date or date expression to use in the calculation. If the date does not have a time value, the function assumes the time is midnight, 12:00 AM.

date2The second date or date expression to use in the calculation. If the date does not have a time value, the function assumes the time is midnight, 12:00 AM.

Returns The number of minutes between date1 and date2.

Example The following example calculates the number of minutes between each value in the startTime field and each value in the finishTime field:DIFF_MINUTE([startTime],[finishTime])

The following example calculates the number of minutes from the current date to Christmas. NOW( ) is a function that returns the current date and time.DIFF_MINUTE(NOW(), "12/25/10")

DIFF_MONTH( )Calculates the number of months between two date values.

Syntax DIFF_MONTH(date1,date2)

Arguments date1The first date or date expression to use in the calculation.

date2The second date or date expression to use in the calculation.

Returns The number of months between date1 and date2. The function calculates the difference by subtracting the month number of date1 from the month number of date2. For example, if date1 is 8/1/08 and date2 is 8/31/08, DIFF_MONTH( ) returns 0. If date1 is 8/25/08 and date2 is 9/5/08, DIFF_MONTH( ) returns 1.

Example The following example calculates the number of months between each value in the askByDate field and each value in the ShipByDate field:DIFF_MONTH([askByDate],[shipByDate])

Page 739: Actuate API Reference - OpenText

C h a p t e r 1 0 , E a s y S c r i p t F u n c t i o n R e f e r e n c e 721

The following example calculates the number of months from each value in the hireDate field to the end of the year:DIFF_MONTH([hireDate], "12/31/10")

DIFF_QUARTER( )Calculates the number of quarters between two date values.

Syntax DIFF_QUARTER(date1, date2)

Arguments date1The first date or date expression to use in the calculation.

date2The second date or date expression to use in the calculation.

Returns The number of quarters between date1 and date2. DIFF_QUARTER( ) calculates the difference by subtracting the quarter number of date1 from the quarter number of date2. For example, if date1 is 1/1/10 and date2 is 3/31/10, DIFF_QUARTER( ) returns 0 because both dates are in quarter 1. If date1 is 3/31/10 and date2 is 4/15/10, DIFF_QUARTER( ) returns 1 because date1 is in quarter 1 and date2 is in quarter 2.

Example The following example calculates the number of quarters between each value in the PlanClosing field and each value in the ActualClosing field:DIFF_QUARTER([PlanClosing],[ActualClosing])

The following example calculates the number of quarters from each value in the orderDate field to the end of the year:DIFF_QUARTER([orderDate], "12/31/10")

DIFF_SECOND( )Calculates the number of seconds between two date values.

Syntax DIFF_SECOND(date1, date2)

Arguments date1The first date or date expression to use in the calculation. If the date does not have a time value, the function assumes the time is midnight, 12:00 AM.

date2The second date or date expression to use in the calculation. If the date does not have a time value, the function assumes the time is midnight, 12:00 AM.

Returns The number of seconds between date1 and date2.

Page 740: Actuate API Reference - OpenText

722 A c t u a t e A P I R e f e r e n c e

Example The following example calculates the number of seconds between each value in the startTime field and each value in the finishTime field:DIFF_SECOND([startTime],[finishTime])

The following example calculates the number of seconds from the current date to Christmas. NOW( ) is a function that returns the current date and time.DIFF_SECOND(NOW(), "12/25/10")

DIFF_WEEK( )Calculates the number of weeks between two date values.

Syntax DIFF_WEEK(date1, date2)

Arguments date1The first date or date expression to use in the calculation.

date2The second date or date expression to use in the calculation.

Returns The number of weeks between date1 and date2. The function calculates the difference by subtracting the week number of date1 from the week number of date2. For example, if date1 is 1/1/10 (week 1 of the year), and date2 is 1/4/10 (week 2 of the year), DIFF_WEEK( ) returns 1.

Example The following example calculates the number of weeks between each value in the askByDate field and each value in the shipByDate field:DIFF_WEEK([askByDate],[shipByDate])

The following example calculates the number of weeks from each value in the orderDate field to the end of the year:DIFF_WEEK([orderDate], "12/31/10")

DIFF_YEAR( )Calculates the number of years between two date values.

Syntax DIFF_YEAR(date1, date2)

Arguments date1The first date or date expression to use in the calculation.

date2The second date or date expression to use in the calculation.

Returns The number of years between date1 and date2. The function calculates the difference by subtracting the year number of date1 from the year number of

Page 741: Actuate API Reference - OpenText

C h a p t e r 1 0 , E a s y S c r i p t F u n c t i o n R e f e r e n c e 723

date2. For example, if date1 is 1/1/10 and date2 is 12/31/10, DIFF_YEAR( ) returns 0. If date1 is 11/25/09 and date2 is 1/5/10, DIFF_YEAR( ) returns 1.

Example The following example calculates the number of years between each value in the HireDate field and each value in the TerminationDate field:DIFF_YEAR([HireDate],[TerminationDate])

The following example calculates the number of years from each value in the HireDate field to the current date. TODAY( ) is a function that returns the current date.DIFF_YEAR([HireDate], TODAY())

FIND( )Finds the location of a substring in a string.

Syntax FIND(target, source)

FIND(target, source, index)

Arguments targetThe substring to search for. The search is case-sensitive.

sourceThe string in which to search.

indexThe position in str where the search starts.

Returns The numerical position of the substring in the string. The first character of a string starts at 1. If the substring is not found, FIND( ) returns 0.

Examples The following example searches for the substring, Ford, in each ProductName value: FIND("Ford", [ProductName])

If the product name is 1969 Ford Falcon, FIND( ) returns 6.

The following example searches for the first hyphen (-) in each product code:FIND("-", [ProductCode])

If the product code is ModelA-1234-567, FIND( ) returns 7.

The following example uses FIND( ) in conjunction with the LEFT( ) function to display the characters that precede the hyphen in a product code. The LEFT( ) function extracts a substring of a specified length, starting from the first character. In this example, the length of the substring to display is equal to the numerical position of the hyphen character.LEFT([ProductCode], FIND("-", [ProductCode]))

Page 742: Actuate API Reference - OpenText

724 A c t u a t e A P I R e f e r e n c e

If the product code is ModelA-1234, the expression returns the following string:ModelA

IF( )Returns one value if a specified condition evaluates to true, or another value if the condition evaluates to false.

Syntax IF(c, vt, vf)

Arguments cThe condition to test.

vtThe value to return if the condition evaluates to true.

vfThe value to return if the condition evaluates to false.

Returns Returns the vt value if c is TRUE or the vf value if c is false.

Example The following example calculates and displays different discount amounts based on the value in the Total field. If the Total value is greater than 5000, the discount is 15%. Otherwise, the discount is 10%.IF([Total]>5000, [Total]*15%, [Total]*10%)

The following example uses IF( ) in conjunction with the BETWEEN( ) and ADD_DAY( ) functions to calculate a shipment date. If an orderDate value is in December 2010 (between 12/1/10 and 12/31/10), add five days to the orderDate value. If an orderDate value is in a month other than December, add three days to the orderDate value.IF(BETWEEN([orderDate], "12/1/10", "12/31/10"),

ADD_DAY([orderDate], 5), ADD_DAY([orderDate], 3))

The following example checks each value in the Office field. If the value is Boston, San Francisco, or NYC, display U.S. If the value is something other than Boston, San Francisco, or NYC, display Europe and Asia Pacific.IF([Office]="Boston" OR [Office]="San Francisco" OR

[Office]="NYC", "U.S.", "Europe and Asia Pacific")

IN( )Tests if a value is equal to a value in a list.

Syntax IN(source, target1,..., targetN)

Page 743: Actuate API Reference - OpenText

C h a p t e r 1 0 , E a s y S c r i p t F u n c t i o n R e f e r e n c e 725

Arguments sourceThe value to test. The value can be a string, numeric, or date value.

target1, ..., targetNThe value or values to compare to.

Returns True if the source value is equal to one of the target values; returns false otherwise.

Example The following example tests if New Haven, Baltimore, or Cooperstown are values in the city field. If any one of the cities is in the field, IN( ) returns true.IN([city], "New Haven", "Baltimore", "Cooperstown")

The following example tests if 9/15/08 or 9/30/08 are values in the payDate field:IN([payDate], "9/15/08", "9/30/08")

The following example uses IN( ) in conjunction with the IF( ) function to test if Ships or Trains are values in the ProductLine field. If Ships or Trains is a value in the field, display Discontinued Item; otherwise, display the product line value as it appears in the field.IF(IN([ProductLine], "Ships", "Trains"),"Discontinued Item",

[ProductLine])

ISNULL( )Tests if a value in a specified field is a null value. A null value means that no value exists.

Syntax ISNULL(source)

Argument sourceThe field in which to check for null values.

Returns True if a value in the specified field is a null value; returns false otherwise.

Example The following example uses ISNULL( ) in conjunction with the IF( ) function to test for null values in the BirthDate field. If there is a null value, display No date specified; otherwise display the BirthDate value.IF(ISNULL([BirthDate]), "No date specified", [BirthDate])

LEFT( )Extracts a substring from a string, starting from the left-most, or first, character.

Syntax LEFT(source)

LEFT(source, n)

Page 744: Actuate API Reference - OpenText

726 A c t u a t e A P I R e f e r e n c e

Arguments sourceThe string from which to extract a substring.

nThe number of characters to extract, starting from the first character.

Returns A substring of a specific length.

■ If you omit n, the number of characters to extract, the function returns the first character only.

■ If n is zero, the function returns an empty string.

■ If n is greater than the length of the string, the function returns the entire string.

Example The following example displays the first letter of each name in the CustomerName field:LEFT([CustomerName])

The following example uses the LEFT( ) and FIND( ) functions to display the characters that precede the hyphen in a product code:LEFT([ProductCode], FIND("-", [ProductCode]))

If the product code is ModelA-1234, the expression returns the following string:ModelA

LEN( )Counts the number of characters in a string.

Syntax LEN(source)

Argument sourceThe string expression to evaluate.

Returns The number of characters in the specified string.

Example The following example returns the length of each value in the ProductCode field:LEN([ProductCode])

The following example uses LEN( ) in conjunction with the RIGHT( ) and FIND( ) functions to display the characters that appear after the hyphen in a product code. RIGHT( ) extracts a substring of a specified length, starting from the last character. In this example, the length of the entire string returned by LEN( ) minus the length up to the hyphen is the number of characters to display:RIGHT([ProductCode], LEN([ProductCode]) - FIND("-" ,

[ProductCode]))

If the product code is ModelA-Ford, the expression returns Ford.

Page 745: Actuate API Reference - OpenText

C h a p t e r 1 0 , E a s y S c r i p t F u n c t i o n R e f e r e n c e 727

LIKE( )Tests if a string matches a pattern.

Syntax LIKE(source, pattern)

sourceThe string to evaluate.

patternThe string pattern to match. You must enclose the pattern in double quotation marks (" "). The match is case-sensitive. You can use the following special characters in a pattern:

■ A percent character (%) matches zero or more characters. For example, %ace% matches any string value that contains the substring ace, such as Facebook, and MySpace. It does not match Ace Corporation because this string contains a capital A, and not the lowercase a.

■ An underscore character (_) matches exactly one character. For example, t_n matches tan, ten, tin, and ton. It does not match teen or tn.

To match a literal percent (%), underscore (_), precede those characters with two backslash (\\) characters. For example, to see if a string contains M_10, specify the following pattern:"%M\\_10%"

Returns True if the string matches the pattern; returns false otherwise.

Example The following example returns true for values in the customerName field that start with D:LIKE([customerName], "D%")

The following example returns true for productCode values that contain the substring Ford:LIKE([productCode], "%Ford%")

The following example uses two LIKE( ) expressions to look for the substrings "Ford" or "Chevy" in each ProductName value. If a product name contains either substring, the expression displays U.S. Model; otherwise, it displays Imported Model.IF(((LIKE([ProductName], "%Ford%") = TRUE) OR (LIKE([ProductName],

"%Chevy%") = TRUE)), "U.S. model", "Imported Model")

LOWER( )Converts all letters in a string to lowercase.

Page 746: Actuate API Reference - OpenText

728 A c t u a t e A P I R e f e r e n c e

Syntax LOWER(source)

Argument sourceThe string to convert to lowercase.

Returns The specified string in all lowercase letters.

Example The following example displays all the string values in the productLine field in lowercase:LOWER([productLine])

MATCH( )Tests if a string matches a pattern. The pattern must use JavaScript regular expression syntax.

Syntax MATCH(source, pattern)

Arguments sourceThe string to evaluate.

patternThe string pattern to match. You must enclose the pattern in quotation marks (" "). In JavaScript regular expression syntax, a pattern is enclosed within a pair of forward slash (/) characters. However, for this argument, the forward slash characters are optional. For example, the following values are equivalent:"smith""/smith/"

You can use any special character supported by JavaScript regular expressions, such as the following:

■ A question mark (?) matches zero or one occurrence of the character previous to it. For example, "te?n" matches tn, ten, and often. It does not match teen or intern.

■ An asterisk (*) matches zero or any number of occurrences of the character precious to it. For example, "te*n" matches tn, ten, often, and teen. It does not match intern.

■ A period (.) matches any character. For example, "te.*" matches ten, often, teen, and intern.

■ A caret (^) specifies that the pattern to look for is at the beginning of a string. For example, "^ten" matches ten, tennis, and tense. It does not match often or pretend.

■ An i character specifies a case-insensitive search. For example, "/smith/i" matches Smith, blacksmith, and Smithsonian. In this case, the pair of forward slashes is required.

Page 747: Actuate API Reference - OpenText

C h a p t e r 1 0 , E a s y S c r i p t F u n c t i o n R e f e r e n c e 729

To match a special character literally, precede the special character with two backslash (\\) characters. For example, to check if a string contains S*10, specify the following pattern:"/S\\*10/"

Returns True if the string matches the pattern; returns false otherwise.

Examples The following example returns true for values in the ProductCode field that start with S18:MATCH([ProductCode], "/^S18/")

The following example uses MATCH( ) to check if the values in the SKU field contain the letters EM followed by a number that ends with 99. If there is a match, display Discontinued; otherwise, display the SKU value.IF(MATCH([SKU], "/EM.*99/"), "Discontinued", [SKU])

MOD( )Returns the remainder after a number is divided by another.

Syntax MOD(number, divisor)

Arguments numberThe number to divide.

divisorThe number by which to divide the number value. You must specify a non-zero number.

Returns The remainder after the number value is divided by the divisor value. Different applications and programming languages define the modulo operation differently when either the dividend or the divisor are negative. For example, in EasyScript and Excel, MOD(-5, 3) returns 1. However, in JavaScript and most databases, the modulo operation returns -2.

Examples The following examples shows the results that the function returns for specific numbers:MOD(10, 5) // returns 0MOD(11, 5) // returns 1MOD(12, 5) // returns 2MOD(-10, 5) //returns 0MOD(-11, 5) //returns 4MOD(-12, 5) //returns 3MOD(10, -5) //returns 0MOD(11, -5) //returns -4MOD(12, -5) //returns -3

Page 748: Actuate API Reference - OpenText

730 A c t u a t e A P I R e f e r e n c e

The following example uses MOD( ) to check if numbers in the Grade field are odd or even. When the divisor is 2, MOD( ) returns 0 for even numbers, and 1 for odd numbers.MOD([Grade], 2)

The following example uses MOD( ) and YEAR( ) to get the last digit of a year. YEAR( ) returns the year number of a date. Dividing a number by 10 returns the last digit of the number.MOD(YEAR([BirthDate]), 10)

MONTH( )Returns the month for a specified date value.

Syntax MONTH(date)

MONTH(date, option)

Arguments dateThe date or date expression whose month to get.

optionA number that represents the month format to return. Use one of the following values:

■ 1 to get the month as a number from 1 to 12.

■ 2 to get the full month name, for example, January. The result is locale-specific.

■ 3 to get the abbreviated month name, for example, Jan. The result is locale-specific.

If you omit option, MONTH( ) returns the month as a number.

Returns The month for a specified date value.

Example The following example returns the month, 1–12, for each value in the ShipDate field:MONTH([ShipDate])

The following example returns the full month name for each ShipDate value:MONTH([ShipDate], 2)

NOT( )Negates a Boolean expression.

Syntax NOT(x)

Page 749: Actuate API Reference - OpenText

C h a p t e r 1 0 , E a s y S c r i p t F u n c t i o n R e f e r e n c e 731

Argument xThe Boolean value or expression to negate.

Returns True if the expression evaluates to false, and false if the expression evaluates to true.

Example The following example uses NOT( ) in conjunction with the IF( ) function. It tests if the value in the State field is not CA. If the value is not CA, it returns the value in the Markup field multiplied by 10%, and by 15% if it is.IF(NOT([State]="CA"),[Markup]*10%,[Markup]*15%)

The previous IF( ) expression is semantically equivalent to the following expression:IF([State]="CA",[Markup]*15%,[Markup]*10%)

NOTNULL( )Tests if a value in a specified field is a non-null value.

Syntax NOTNULL(source)

Argument sourceThe field in which to check for non-null values.

Returns True if a value in the specified field is not a null value; returns false otherwise.

Example The following example uses NOTNULL( ) in conjunction with the IF( ) function to test for non-null values in the BirthDate field. If there is a non-null value, display the BirthDate value; otherwise display No date specified.IF(NOTNULL([BirthDate]), [BirthDate], "No date specified")

NOW( )Returns the current date and time.

Syntax NOW( )

Returns The current date and time. For example:Feb 10, 2010 2:55 PM

Example The following example uses the DIFF_DAY( ) and NOW( ) functions to calculate the number of days from the current date and time to Christmas:DIFF_DAY(NOW(), "12/25/10")

Page 750: Actuate API Reference - OpenText

732 A c t u a t e A P I R e f e r e n c e

QUARTER( )Returns the quarter number for a specified date value.

Syntax QUARTER(date)

Arguments dateThe date or date expression whose quarter number to get.

Returns A number from 1 to 4 that represents the quarter for a specified date value. Quarter 1 starts in January.

Examples The following example displays the quarter number for each value in the CloseDate field:QUARTER([CloseDate])

The following example displays a string—Q1, Q2, Q3, or Q4—for each value in the CloseDate field:"Q" & QUARTER([CloseDate])

RIGHT( )Extracts a substring from a string, starting from the right-most, or last, character.

Syntax RIGHT(source)

RIGHT(source, n)

Arguments sourceThe string from which to extract a substring.

nThe number of characters to extract, starting from the last character.

Returns A substring of a specific length.

■ If you omit n, the number of characters to extract, the function returns the last character only.

■ If n is zero, the function returns an empty string.

■ If n is greater than the length of the string, the function returns the entire string.

Example The following example displays the last four characters of each value in the ProductCode field:RIGHT([ProductCode], 4)

The following example uses RIGHT( ) in conjunction with the LEN( ) and FIND( ) functions to display the characters that appear after the hyphen in a product code.

Page 751: Actuate API Reference - OpenText

C h a p t e r 1 0 , E a s y S c r i p t F u n c t i o n R e f e r e n c e 733

This example assumes that the number of characters after the hyphen varies. Therefore, the length of the entire string (returned by LEN( )) minus the length up to the hyphen (returned by FIND( )) is the number of characters to display. RIGHT([ProductCode], LEN([ProductCode]) - FIND("-" ,

[ProductCode]))

If the product code is ModelA-Ford, the expression returns Ford. If the product code is ModelCZ15-Toyota, the expression returns Toyota.

ROUND( )Rounds a number to a specified number of digits.

Syntax ROUND(number)

ROUND(number, dec)

Arguments numberThe number to round.

decThe number of digits to round number to. If you omit dec, ROUND( ) assumes 0.

Returns A number rounded to a specified number of digits.

Example The following example rounds the numbers in the PriceEstimate field to return an integer. For example, if the PriceEstimate value is 1545.50, ROUND( ) returns 1546. If the PriceEstimate value is 1545.25, ROUND( ) returns 1545.ROUND([PriceEstimate])

The following example rounds the numbers in the PriceEstimate field to one decimal place. For example, if the PriceEstimate value is 1545.56, ROUND( ) returns 1545.6. If the PriceEstimate value is 1545.23, ROUND( ) returns 1545.2.ROUND([PriceEstimate], 1)

The following example rounds the numbers in the PriceEstimate field to one digit to the left of the decimal point. For example, if the PriceEstimate value is 1545.56, ROUND( ) returns 1550. If the PriceEstimate value is 1338.50, ROUND( ) returns 1340.ROUND([PriceEstimate], -1)

ROUNDDOWN( )Rounds a number down to a specified number of digits.

Page 752: Actuate API Reference - OpenText

734 A c t u a t e A P I R e f e r e n c e

Syntax ROUNDDOWN(number)

ROUNDDOWN(number, dec)

Arguments numberThe number to round down.

decThe number of digits to round number down to. If you omit dec, ROUND( ) assumes 0.

Returns A number rounded down to a specified number of digits.

Example The following example rounds down the numbers in the PriceEstimate field to return an integer. For example, if the PriceEstimate value is 1545.25, ROUNDDOWN( ) returns 1545. If the PriceEstimate value is 1545.90, ROUNDDOWN( ) returns 1545.ROUNDDOWN([PriceEstimate])

The following example rounds down the numbers in the PriceEstimate field to one decimal place. For example, if the PriceEstimate value is 1545.56, ROUNDDOWN( ) returns 1545.5. If the PriceEstimate value is 1545.23, ROUNDDOWN( ) returns 1545.2.ROUNDDOWN([PriceEstimate], 1)

The following example rounds the numbers in the PriceEstimate field down to one digit to the left of the decimal point. For example, if the PriceEstimate value is 1545.56, ROUNDDOWN( ) returns 1540. If the PriceEstimate value is 1338.50, ROUNDDOWN( ) returns 1330.ROUNDDOWN([PriceEstimate], -1)

ROUNDUP( )Rounds a number up to a specified number of digits.

Syntax ROUNDUP(number)

ROUNDUP(number, dec)

Arguments numberThe number to round up.

decThe number of digits to round number up to. If you omit dec, ROUND( ) assumes 0.

Returns A number rounded up to a specified number of digits.

Example The following example rounds up the numbers in the PriceEstimate field to return an integer. For example, if the PriceEstimate value is 1545.25,

Page 753: Actuate API Reference - OpenText

C h a p t e r 1 0 , E a s y S c r i p t F u n c t i o n R e f e r e n c e 735

ROUNDUP( ) returns 1546. If the PriceEstimate value is 1545.90, ROUNDUP( ) returns 1546.ROUNDUP([PriceEstimate])

The following example rounds up the numbers in the PriceEstimate field to one decimal place. For example, if the PriceEstimate value is 1545.56, ROUNDUP( ) returns 1545.6. If the PriceEstimate value is 1545.23, ROUNDUP( ) returns 1545.3.ROUNDUP([PriceEstimate], 1)

The following example rounds up the numbers in the PriceEstimate field to one digit to the left of the decimal point. For example, if the PriceEstimate value is 1545.56, ROUNDUP( ) returns 1550. If the PriceEstimate value is 1338.50, ROUNDUP( ) returns 1340.ROUNDUP([PriceEstimate], -1)

SEARCH( )Finds the location of a substring in a string. The substring can contain wildcard characters.

Syntax SEARCH(pattern, source)

SEARCH(pattern, source, index)

Arguments patternThe string pattern to search for. You must enclose the pattern in double quotation marks (" "). You can use the following special characters in a pattern:

■ An asterisk (*) matches zero or more characters, including spaces. For example, t*n matches tn, tin, and teen.

■ A question mark (?) matches exactly one character. For example, t?n matches tan, ten, tin, and ton. It does not match teen or tn.

sourceThe string in which to search.

indexThe position in source where the search starts.

Returns The numerical position of the string pattern in the string. The first character of a string starts at 1. If the substring is not found, SEARCH( ) returns 0.

Examples The following example searches for the string pattern, S*A, in each product code. If the product name is KBS5412A, SEARCH( ) returns 3.SEARCH("S*A", [ProductCode])

The following example uses SEARCH( ) in conjunction with the LEFT( ) function to display the characters that precede the first space character in a product name.

Page 754: Actuate API Reference - OpenText

736 A c t u a t e A P I R e f e r e n c e

The LEFT( ) function extracts a substring of a specified length, starting from the first character. In this example, the length of the substring to display is equal to the numerical position of the space character.LEFT([ProductName], SEARCH(" ", [ProductName]))

If the product name is 1969 Ford Falcon, the expression returns 1969.

SQRT( )Calculates the square root of a number.

Syntax SQRT(number)

Argument numberThe number for which you want to find the square root. The number must be a positive number.

Returns A number that is the square root of the specified number.

Examples The following example calculates the square root of each numeric value in the LotSize field:SQRT([LotSize])

The following example uses SQRT( ) to calculate the actual distance travelled uphill, given the base distance and elevation values. This example applies the Pythagorean theorem, which states that . Using this theorem, the actual distance traveled is c, which means we want to calculate:

which translates to the following expression:SQRT((([Distance] * [Distance]) + ([Elevation] * [Elevation])))

TODAY( )Returns the current date that includes a time value of midnight, 12:00 AM.

Syntax TODAY( )

Returns The current date in the following format:Feb 11, 2010 12:00 AM

Examples The following example calculates the number of days from the current date to Christmas:DIFF_DAY(TODAY(), "12/25/10")

a2 b2+ c2

=

c a2 b2+=

Page 755: Actuate API Reference - OpenText

C h a p t e r 1 0 , E a s y S c r i p t F u n c t i o n R e f e r e n c e 737

The following example calculates the number of years from each value in the HireDate field to the current date:DIFF_YEAR([HireDate], TODAY())

TRIM( )Removes the leading and trailing blanks from a specified string. TRIM( ) does not remove blank characters between words.

Syntax TRIM(source)

Argument sourceThe string from which to remove leading and trailing blank characters.

Returns A string with all leading and trailing blank characters removed.

Example The following example uses TRIM( ) to remove all leading and trailing blank characters from values in the FirstName and LastName fields. The expression uses the & operator to concatenate each trimmed FirstName value with a space, then with each trimmed LastName value.TRIM([FirstName]) & " " & TRIM([LastName])

TRIMLEFT( )Removes the leading blanks from a specified string.

Syntax TRIMLEFT(source)

Argument sourceThe string from which to remove the leading blank characters.

Returns A string with all leading blank characters removed.

Example The following example concatenates a literal string with each value in the customerName field. TRIMLEFT( ) removes all blank characters preceding the customerName value so that there are no extra blank characters between the literal string and the customerName value.

"Customer name: " & TRIMLEFT([customerName])

TRIMRIGHT( )Removes the trailing blanks from a specified string.

Syntax TRIMRIGHT(source)

Page 756: Actuate API Reference - OpenText

738 A c t u a t e A P I R e f e r e n c e

Argument sourceThe string from which to remove the trailing blank characters.

Returns A string with all trailing blank characters removed.

Example The following example concatenates each value in the Comment field with a semicolon, then with a value in the Action field. TRIMRIGHT( ) removes all blank characters after the Comment value so that there are no extra blank characters between the Comment string and the semicolon.TRIMRIGHT([Comment]) & "; " & [Action]

UPPER( )Converts all letters in a string to uppercase.

Syntax UPPER(source)

Argument sourceThe string to convert to uppercase.

Returns The specified string in all uppercase letters.

Example The following example displays all the string values in the customerName field in all uppercase:UPPER([customerName])

WEEK( )Returns a number from 1 to 52 that represents the week of the year.

Syntax WEEK(date)

Argument dateThe date or date expression whose week of the year to get.

Returns A number that represents the week of the year for the specified date value.

Example The following example gets the week number of the year for each date value in the ShipDate field:WEEK([ShipDate])

WEEKDAY( )Returns the day of the week for a specified date value.

Syntax WEEKDAY(date, option)

Page 757: Actuate API Reference - OpenText

C h a p t e r 1 0 , E a s y S c r i p t F u n c t i o n R e f e r e n c e 739

Arguments dateThe date or date expression from which you want to get the day of the week.

optionA number that represents the weekday format to return. Use one of the following values:

■ 1 to get the day as a number from 1 (Sunday) to 7 (Saturday).

■ 2 to get the day as a number from 1 (Monday) to 7 (Sunday).

■ 3 to get the day as a number from 0 (Monday) to 6 (Sunday).

■ 4 to get the full weekday name, for example, Wednesday. The result is locale-specific.

■ 5 to get the abbreviated weekday name, for example Wed. The result is locale-specific.

If you omit option, WEEKDAY( ) assumes option 1.

Returns The day of the week for a specified date value.

Example The following example gets the full weekday name for each date value in the DateSold field:WEEKDAY([DateSold], 4)

YEAR( )Returns the four-digit year value for a specified date value.

Syntax YEAR(date)

dateThe date or date expression from which you want to extract the year part.

Returns The number that represents the four-digit year for the specified date value.

Example The following example gets the four-digit year for each date value in the ShipDate field, and adds 15 to the four-digit year. For example, if the ShipDate value is Sep 16, 2008, YEAR( ) returns 2023.(YEAR([ShipDate]) + 15)

OperatorsTable 10-2 lists the operators in EasyScript.

Page 758: Actuate API Reference - OpenText

740 A c t u a t e A P I R e f e r e n c e

Table 10-2 EasyScript operators

Operator Use to Example

+ Add two or more numeric values together

[OrderAmount] + [SalesTax]

- Subtract one numeric value from another

[OrderAmount] - [Discount]

* Multiply numeric values [Price] * [Quantity]

/ Divide numeric values [Profit]/12

^ Raise a numeric value to a power [Length]^2

% Specify a percent [Price] * 80%

= Test if two values are equal IF([ProductName] = "1919 Ford Falcon", "Discontinued Item", [ProductName])

> Test if one value is greater than another value

IF([Total] > 5000, [Total]*15%, [Total]*10%)

< Test if one value is less than another value

IF([SalePrice] < [MSRP], "Below MSRP", "Above MSRP")

>= Test if one value is greater than or equal to another value

IF([Total] >= 5000, [Total]*15%, [Total]*10%)

<= Test if one value is less than or equal to another value

IF([SalePrice] <= [MSRP], "Below or equal to MSRP", "Above MSRP")

<> Test if two values are not equal IF([Country] <> "USA", "Imported product", "Domestic product")

AND Test if two or more conditions are true

IF(([Gender] = "Male" AND [Salary] >= 150000 AND [Age] < 50), "Match found", "No match")

OR Test if any one of multiple conditions is true

IF(([City] = "Boston") OR ([City] = "San Francisco"), "U.S.", "Europe and Asia")

& Concatenate string values [FirstName] & " " & [LastName]

Page 759: Actuate API Reference - OpenText

I n d e x 741

IndexSymbols^ (caret) character 728^ operator 740? (question mark) character 728, 735. (period) character

pattern matching 728" (double quotation mark) character

pattern matching and 727* (asterisk) character

pattern matching 728search expressions 735

* operator 740/ (forward slash) character 728/ operator 740\ (backslash) character 729& operator 740% (percent) character 727% operator 740+ operator 740< operator 740<= operator 740<> operator 740= operator 740> operator 740>= operator 740– operator 740_ (underscore) character

pattern matching 727

Numerics3D charts 347

AABInfoObject element 112ABS function 713absolute values 713AbsoluteDate data type 88AbsoluteDate element 143AcceptEncoding element 202access control lists

applying 151getting templates for 34

retrieving file or folder 33, 35retrieving users 219storing externally 222

access rights 159, 224, 238, 485, 486See also privileges

access type attributes 123access types

getting 465, 474job properties and 40setting 468, 478

accessingBIRT Interactive Crosstabs 548cross tab elements 548JavaScript API class libraries 242

AccessRight element 159, 224, 238AccessRights element 163AccessType element 123, 126, 151, 236AccessType property 36acDouble data type 89ACL element

FileInfo type 236GetFileACL operations 34GetFileCreationACL operations 35GetFileDetails operations 36GetUserACL operations 219NewFile type 151

ACL filesSee also access control lists

ACL property 35ACL templates 34ACLs. See access control listsacNull data type 89AcRSSEPassThrough function 16ACS. See Caching serviceaction attributes (Ping) 57action element 57actions

completing 309Activate element 165, 171Activate property 72, 79Active Directory servers 216active tab (dashboards) 263active tabs (dashboards) 267

Page 760: Actuate API Reference - OpenText

742 A c t u a t e A P I R e f e r e n c e

ActualHeadline element 142ActualOutputFileId element

JobNotice type 136JobProperties type 141JobSearch type 146

ActualOutputFileName elementJobNotice type 136JobProperties type 141JobSearch type 146

ActualOutputFileSize element 136actuate class 242, 246Actuate namespace 242ActuateBuildNumber element 203ActuateVersion element 203acviewer container 549ad hoc parameters

defining 153generating query output and 323testing for 317, 327

ad hoc queries 323AddArchiveRules element 181addAttribute function 606AddChannelNotificationById element 185AddChannelNotificationByName element

184AddChildRolesById element 190AddChildRolesByName element 189ADD_DAY function 713AddDependentFilesById element 180AddDependentFilesByName element 180addDimension function 570AddFileCreationPermissions element 192AddGroupNotificationById element 185AddGroupNotificationByName element 184ADD_HOUR function 714adding

bookmarks 103chart titles 347computed fields 710cross tabs 569custom security adapters 210dashboards 257data items 351data service components 289data sorters 286, 630display names. See display namesexpressions 710

file types 107, 126filter conditions 111, 274, 596filters 274Flash objects 355, 359folders 108HTML5 charts 364interactive features 497label elements 391licensing options 193page breaks 620, 623parameter components 294parameter groups 320, 331, 340passwords 333privilege filters 484rendering options 522report components 246report elements 516Report Explorer components 455report viewer components 493scroll panels 524sort conditions 286, 630standard charts 343tables 395text elements 451users to Encyclopedia 109

addition operator 740addLevel function 583AddLicenseOptions element 193addMeasure function 571addMember function 589, 615ADD_MINUTE function 714ADD_MONTH function 715AddOutputFilePermissions element 185AddParentRolesById element 190AddParentRolesByName element 189addPoint function 378, 379ADD_QUARTER function 715AddRequiredFilesById element 181AddRequiredFilesByName element 180ADD_SECOND function 716addSeries function 365, 371AddToGroupsById element 192AddToGroupsByName element 191addTotal function 603, 634AddUserNotificationById element 185AddUserNotificationByName element 184ADD_WEEK function 716

Page 761: Actuate API Reference - OpenText

I n d e x 743

ADD_YEAR function 716Administrate element 14Administrate operations 14, 89

See also administration operationsadministration operations

creating users and 109defining transaction operations and 175developing 14, 89

Administrator elementExternalTranslatedUserGroupNames type

121ExternalTranslatedUserNames type 120TranslatedRoleNames type 225TranslatedUserNames type 225

administrator names 225Administrator user groups 120, 121administrators

See also administration operationscreating Login requests for 78managing iHub services and 29, 31

AdminOperation element 14AdminOperation operations 89AdminRights element 55advanced sort feature 532aggregate data. See aggregationaggregate functions. See aggregation

functionsaggregation

enabling or disabling 533Aggregation data type 91aggregation functions

changing 610getting 610, 638setting 612, 639

aging rules. See archiving rulesAIS. See Integration servicealerts 293Alias element 105All element 121, 164, 225All user groups 121AllowExport element 105AllowViewTimeParameter element 128alphaNumericSorterSet array 283analyzing data 548AND operator 740animation (charts) 379annuities

future value of 691interest payment for 692interest rate per period for 703number of periods for 696present value of 701principal for 700returning payments for 699

appendToJobStatus method 4application programming interfaces

iHub environment 4application programming interfaces (APIs)

See also Information Delivery APIarchiving and 229RSSE applications and 216

applicationsbuilding security 216building user interfaces for. See user

interfacesdeveloping 4developing IDAPI. See IDAPI applicationsdeveloping RSSE. See RSSE applicationsdeveloping web. See web applicationsgetting user name information for 249getting version information for 249logging out of 253retrieving browser instance for 6retrieving volume names for 7testing connections for 251

applyOptions function 375, 571arc function 384archive application 53archive files

See also jar files; war filesarchive rules. See archiving rulesarchive service command 53archive settings 184ArchiveLibrary element 53ArchiveLibrary property 52ArchiveOnExpiration element 91ArchiveOnExpire element 133ArchiveRule data type 91ArchiveRule element 151ArchiveRule objects 94

See also archiving rulesArchiveRule property 80ArchiveRuleInherited element 133ArchiveRules element 36

Page 762: Actuate API Reference - OpenText

744 A c t u a t e A P I R e f e r e n c e

ArchiveRules property 35ArchiveServiceCmd element 53archiving

folders 233archiving API 229archiving operations

developing 229getting schedules for 53scheduling 194setting parameters for 184starting 23, 232stopping 23, 230testing for 204

archiving rulesgetting 35inheriting 91removing 181setting attributes of 91, 94setting file specific 80

area charts 372Argument data type 91arguments. See command line arguments;

parametersarray definitions 91ArrayOfAggregation data type 93ArrayOfArchiveRule data type 94ArrayOfArgument data type 94ArrayOfAttachment data type 94ArrayOfBookMark data type 94ArrayOfCapabilities data type 94ArrayOfChannel data type 94ArrayOfChannelCondition data type 94ArrayOfColumnDefinition data type 95ArrayOfColumnSchema element 166ArrayOfComponent data type 95ArrayOfComponentIdentifier data type 95ArrayOfCounterInfo data type 95ArrayOfDataExtractionFormat data type 95ArrayOfDataFilterCondition data type 95ArrayOfDataRow data type 96ArrayOfDataSortColumn data type 96ArrayOfDate data type 96ArrayOfDocumentConversionOptions data

type 96ArrayOfFieldDefinition data type 96ArrayOfFile data type 96ArrayOfFileCondition data type 96

ArrayOfFileContent data type 97ArrayOfFileInfo type 233ArrayOfFileType data type 97ArrayOfFilterCriteria data type 97ArrayOfGroup data type 97ArrayOfGroupCondition data type 97ArrayOfGrouping data type 97ArrayOfInt data type 97ArrayOfIOCacheDBIndexConstraint data

type 97ArrayOfJobCondition data type 98ArrayOfJobNotice data type 98ArrayOfJobNoticeCondition data type 98ArrayOfJobProperties data type 98ArrayOfJobScheduleCondition data type 98ArrayOfJobScheduleDetail data type 98ArrayOfLicenseOption data type 99ArrayOfLong data type 98ArrayOfMDSInfo data type 99ArrayOfNameValuePair data type 99ArrayOfParameterDefinition data type 99ArrayOfParameterValue data type 99ArrayOfPendingSyncJob data type 99ArrayOfPermission data type 99ArrayOfPermission type 233ArrayOfPrinter data type 100ArrayOfPrinterOptions data type 100ArrayOfPropertyValue data type 100ArrayOfRecord data type 100ArrayOfResourceGroup data type 100ArrayOfResourceGroupSettings data type

100ArrayOfResultSetSchema data type 100ArrayOfResultSetSchema element 28, 41ArrayOfRole data type 101ArrayOfRoleCondition data type 101ArrayOfRunningJob data type 101ArrayOfServerInformation data type 101ArrayOfServerResourceGroupSetting data

type 101ArrayOfService data type 101ArrayOfString data type 101ArrayOfString type 234ArrayOfUser data type 102ArrayOfUserAndProperties element 219ArrayOfUserCondition data type 102ArrayOfUserGroup data type 102

Page 763: Actuate API Reference - OpenText

I n d e x 745

ArrayOfUserGroupCondition data type 102arrays

data type definitions and 91, 223ascending sort order 286, 287, 632assetLifespan argument 690, 705, 706AssignedToUserId element 199AssignedToUserName element 199AssignedToUsersById element 190AssignedToUsersByName element 189AssignRolesById element 192AssignRolesByName element 191AssignUserGroupsByID element 192AssignUserGroupsByName element 191asterisk (*) character

pattern matching 728search expressions 735

asynchronous commands (volumes) 23asynchronous jobs 60, 73, 164asynchronous mode 73asynchronous resource groups 46, 165AsyncResourceGroupList element 46Attachment data type 102Attachment objects 94attachments

downloading 20embedding in SOAP messages 21selecting specific pages as 65sending components as 38sending files as 124sending reports as 22sending to multiple locales 102setting attributes of 102setting output formats for 77

AttachReportInEmail elementJobInputDetail type 134SubmitJob operations 76User type 196, 226UserField type 197

AttachReportInEmail property 222attributes

See also propertiesAttributes element 38authenticate function

actuate class 247security adapter 210

AuthenticateUser operations 216authentication

accessing applications and 210accessing external security systems and

216customizing 210logging in to web services and 247logging into iHub System and 216

authentication exceptions 254authentication IDs 5authentication information

requesting 488unloading 253

authentication requests 254authentication token

REST API 489, 491AuthenticationException class 254AuthenticationException objects 254AuthId element

Login operations 55SOAP headers and 129, 236SystemLogin operations 78

AuthorizationIsExternal element 204auto suggest delays 300auto suggest threshold values 323, 329auto suggestion list controls 330auto suggestion lists 301, 316AutoArchiveSchedule element 53AutoArchiveSchedule property 52autoarchiving. See archiving operationsautosave feature 259, 263autosuggest list controls 153, 154AutoSuggestThreshold element 154axes values (charts)

data points and 381multiple series and 347testing for 368, 372

axis labels (charts) 373Axis servers. See Apache Axis environmentsaxis type values (cross tabs) 586axis types (cross tabs)

changing 587getting 585, 604setting 586, 587, 605

Bbackslash (\) character 729bandwidth 320

Page 764: Actuate API Reference - OpenText

746 A c t u a t e A P I R e f e r e n c e

bar charts 372Base64Binary data type 103BasedOnFileId element 17BasedOnFileName element 17batch operations 471beans. See JavaBeansBETWEEN function 717BETWEEN operator 274, 596binary data 59BIRT APIs 4BIRT design files

See also design filesBIRT Designer Professional

creating expressions and 710BIRT iHub. See iHub SystemBIRT Interactive Crosstabs. See Interactive

CrosstabsBIRT report files 45

See also report filesBIRT reports 65

See also reportsBIRT Viewer

See also report viewerblank characters 737bln element 111, 178BookMark data type 103bookmark names 281, 391, 451Bookmark objects 94BookmarkList element 25bookmarks

accessing cross tabs and 548, 558, 574, 625adding Flash objects and 356, 501, 517creating 103displaying report elements and 282, 504displaying Reportlets and 502, 508getting chart instance for 497, 516getting chart names for 345getting data item for 351, 500, 517getting gadgets associated with 360, 501,

518getting labels associated with 391, 501, 518getting page numbers for 43, 44getting report content for 498, 500, 502getting text element for 451, 500, 503, 519navigating through reports and 504retrieving from designs 25retrieving result sets and 280

returning table objects for 399, 502, 518returning viewer objects for 504sending requests for 281, 282

BookMarkType element 103BookMarkValue element 103Boolean data type 103, 113, 153Boolean element 113, 169Boolean expressions 274, 275, 596, 597Boolean parameter 169Boolean values 178, 724, 730bottom N filter feature 543BOTTOM_N operator 274, 596BOTTOM_PERCENT operator 274, 596BrowserPanel class 513browsers. See web browsersbuild numbers 173, 203bullet gadgets 362bundling report files 22, 77, 133Business Intelligence and Reporting Tools.

See BIRTbutton constants (navigation) 298button controls 153button elements 298, 330

Ccache

open security 186transient reports 30

cache database. See Caching service databaseCaching element 174Caching service 57, 174calculated columns 533

See also computed columnscalculations

EasyScript expressions and 710, 739callback functions

closing Interactive Crosstabs and 563connecting to web services and 251, 253downloading parameters and 295handling exceptions and 254, 256, 291retrieving parameters and 296, 306retrieving result sets and 284, 289, 497

callback parameter 247, 251CallOpenSecurityLibrary operations 16, 219CancelJob operations 16CancelJobStatus data type 103

Page 765: Actuate API Reference - OpenText

I n d e x 747

cancelled jobs 67CancelReport operations 16Capabilities data type 104Capabilities element

GetCapabilities operations 25GetCapabilitiesByCategory operations 26GrantUserGroupCapabilities operations 53Login operations 56RevokeUserGroupCapabilities operations

61capabilities list 26Capabilities objects 94CapabilityCategories element 55CapabilityNames element 104capitalization 738caret (^) character 728cascading parameter names 154, 323, 329cascading parameters

changing 309getting values 313testing for 317

CascadingGroupName element 44CascadingParentName element 154case conversions 727, 738case-insensitive searches 728case-sensitive searches 723, 727case sensitivity

file names 64passwords 194user names 194

cashArray argument 694, 695, 698Categories element 25, 26Categories list 25, 26Category element 26, 104Category list (Expression Builder) 647category series (charts)

drilling through 344getting maximum value of 366getting minimum value of 367setting value range for 369

CEILING function 718cell attributes 110Cell element 111cells (empty) 572, 620, 622changeMeasureDirection function 572changes, undoing or redoing 544ChangesPending element 171

changingaggregation functions 610chart subtype 349chart titles 344, 348cross tabs 549data 534data series 369file or folder privileges 181gadget types 536iHub server configurations 171label elements 394parameters 294, 309, 320passwords 195report designs 554reports 535text elements 542volumes 14

Channel data type 104ChannelCondition data type 104ChannelField data type 104channels

adding subscribers to 222deleting 114updating 178

Channels element 226ChannelSearch data type 104ChannelSubscriptionList property 222character data. See stringscharacter encoding. See encodingcharacter encryption. See encryptioncharacter patterns

filter expressions 274, 275search expressions 124, 131, 137, 196

character strings. See stringscharacters

converting case 727, 738counting 726finding matching 727, 728, 735finding specific 723, 726, 732matching literal 727, 729passwords and 194removing leading or trailing 737search conditions and 124user names and 194

chart bookmarks 345, 497, 516Chart class 343chart dimension constants 347

Page 766: Actuate API Reference - OpenText

748 A c t u a t e A P I R e f e r e n c e

chart elementsadding 343, 364determining type 346displaying 349getting bookmarks for 497, 516hiding 347setting size 348

chart gadgets 362chart IDs 345, 346chart objects 343

See also chartschart properties

enabling or disabling 533chart subtypes 349, 533chart titles 344, 345, 347, 348chart types 372chart wizard launcher

See also chart builderCHART_DIMENSION_2D constant 347CHART_DIMENSION_2D_WITH_DEPTH

constant 347charts

See also Flash charts; HTML5 chartschanging subtype of 349changing titles for 344, 348clearing data filters for 344creating 343developing. See charting APIsdisplaying 349drilling through 344, 345getting bookmark name for 345getting embedded 37getting HTML element for 345getting page associated with 346selecting subtypes for 533setting filters for 348setting number of dimensions for 347setting title for 347submitting requests for 349

CHART_SUBTYPE_PERCENTSTACKED constant 349

CHART_SUBTYPE_SIDEBYSIDE constant 349

CHART_SUBTYPE_STACKED constant 349check boxes 153, 330ChildUserGroupId element 199ChildUserGroupName element 199

circle function 385class libraries 242, 252class names 127class reference 242, 245, 550, 647classes

connecting to web applications and 242developing with 549scripting for 647

clearFilters functionChart class 344FlashObject class 355Gadget class 359Table class 399XTabAnalyzer class 572

ClearSystemPrinters element 194client applications. See applicationsClientChart class 364ClientChart objects 364ClientOption class 371ClientOption objects 371ClientPoint class 375ClientSeries class 378client-side error constants 305, 462client-side errors 291, 594ClientVersion element 55clipping rectangles 386clipRect function 386CloseInfoObject operations 17closing

information objects 17Cluster element 174cluster node lock violations 171cluster nodes 141clusters

getting information about 49setting as system type 174

codeBIRT JavaScript classes and 647displaying cross tabs and 548

collapse/expand feature 534Collation element 161CollationOption element 139, 162color printers 139, 161, 162ColorMode element 161ColorModeOptions element 161column editing feature 534Column element 112

Page 767: Actuate API Reference - OpenText

I n d e x 749

column headersSee also column names

column headingsSee also column names

column index valuesaccessing result sets and 285displaying cross tabs and 575getting 285, 400, 512, 526, 527, 528

column mirror starting levelgetting 619setting 572, 618, 622

column namesdisplaying parameters and 323, 336, 339,

521filtering data and 276, 277getting list of 281, 284running queries and 329setting aliases for 105setting display names for 105sorting data and 286, 287

column schema objects 95column schemas 105, 112column types

parameter definitions and 323, 329parameter value objects and 336, 339

COLUMN_AXIS_TYPE constant 586ColumnDefinition data type 104ColumnDetail data type 105columnMirrorStartingLevel parameter 572,

618ColumnName element

DataFilterCondition type 111DataSortColumn type 112ParameterDefinition type 154

columnPageBreakInterval parameter 618columns

adding to cross tabs 619changing data in 534creating expressions for 710describing file 124exporting 105extracting data from 19filtering values in 111, 344getting 400, 575hiding 105, 403matching top or bottom values in 274moving 538

reordering 450, 540resizing 534retrieving data values in 285, 323retrieving index values for 285, 400, 512,

526, 527, 528retrieving result sets and 282, 285searching 723selecting 512, 526, 527, 528setting page breaks on 620, 622, 623setting type 105showing calculated values in 533, 613showing table 449sorting on 19, 286, 287

Columns element 18, 19ColumnSchema data type 105ColumnSchema objects 95ColumnType element 154comma-separated values files. See CSV filesCommand element 23command status attributes 24commands (volumes) 23commit function 554completed jobs 219completion notices 60, 75, 226

See also notificationsCompletionTime element

JobField type 132JobNotice type 136JobNoticeField type 138JobProperties type 141

Component elementCubeExtraction operations 18DataExtraction operations 19GetCubeMetaData operations 28GetJavaReportEmbeddedComponent

operations 38GetJavaReportTOC operations 38GetMetaData operations 41GetPageNumber operations 43SelectJavaReportPage operations 65

component names (reports) 252ComponentIdentifier data type 105components

getting embedded 37getting page number for 43, 44retrieving data from 19sending as attachments 38

Page 768: Actuate API Reference - OpenText

750 A c t u a t e A P I R e f e r e n c e

ComponentType data type 106compound documents 20computed columns 611, 613, 710

See also calculated columnscomputed measures 611, 613concatenation

string data and 740concatenation operator 740Concise mode (Ping) 57Condition element

FileSearch type 125JobNoticeSearch type 138JobScheduleSearch type 144JobSearch type 145UserGroupSearch type 198UserSearch type 200

conditional expressionsBoolean values and 730testing data values and 724, 740

ConditionArray elementFileSearch type 125JobNoticeSearch type 138JobScheduleSearch type 144JobSearch type 146UserGroupSearch type 198UserSearch type 200

conditions. See filter conditions; search conditions

configuration template names 171configurations

changing 171iHub servers and 171resource groups and 47, 72

Connect action 57connection definition files. See database

connection definition filesconnection exceptions 256connection handles. See ConnectionHandle

elementconnection parameters 58, 250connection properties

externalizing 204, 223getting 26, 217setting 71

connection strings 59ConnectionException class 256ConnectionException objects 256

ConnectionHandle elementCubeExtraction operations 19DataExtraction operations 20ExecuteReport operations 23GetJavaReportEmbeddedComponent

operations 38GetJavaReportTOC operations 39GetPageCount operations 43PendingSyncJob type 158RunningJob type 167SelectJavaReportPage operations 66SOAP headers and 129, 237WaitForExecuteReport operations 81

ConnectionProperties elementGetConnectionProperties operations 27,

218Ping operations 58SetConnectionProperties operations 72

ConnectionPropertiesAreExternal element 204

ConnectionPropertyExternal element 223connections

accessing volumes and 212authenticating users and 247closing 253displaying dashboards and 264getting properties for 26, 217, 223handling errors for 256logging in to web applications and 289opening 250ping operations and 58preserving 167setting properties for. See connection

propertiestesting 251

ConnectionString property 59consolidator application. See log consolidator

applicationConstants class 305, 462ContainedFiles element 21content components 279Content element

DownloadFile operations 21ExportParameterDefinitionsToFile

operations 24ExtractParameterDefinitionsFromFile

operations 24

Page 769: Actuate API Reference - OpenText

I n d e x 751

FileContent type 124SelectFiles operations 64UploadFile operations 80

content panels (viewer) 513, 524, 529, 530content variable 550ContentData element 103ContentEncoding element 102ContentEncoding property 38ContentId element 102ContentItemList element 64ContentLength element 102ContentLength property 38ContentType element 102, 127context menus 543control commands (volumes) 23control type attributes 122, 153control type UI values 314control types 324, 330ControlType element 153conversion options 29, 73, 118ConversionOptions element 29, 78, 135conversions

case 727, 738convert function 306convertDate function 307ConvertUtility class 306CopyFile element 90, 177CopyFile operations 106CopyFromLatestVersion element 79copying

access rights 486CounterId element 107CounterIDList element 27CounterInfo data type 107CounterInfo objects 95CounterInfoList element 25, 27CounterName element 107counters 25, 27, 107CounterValue element 107counting

items in folders 37items in lists 44pages in files 466pages in reports 43, 503, 557search results records 126, 146, 201

CountLimit elementFileSearch type 126

GetFileACL operations 34GetFileCreationACL operations 35GetParameterPicklist operations 44JobNoticeSearch type 138JobScheduleSearch type 145JobSearch type 146UserGroupSearch type 199UserSearch type 201

CreateChannel element 176CreateChannel operations 107CreateDatabaseConnection operations 17CreatedByUserId element 34CreatedByUserName element 34CreateFileType element 90, 176CreateFileType operations 107CreateFolder element 90, 176CreateFolder operations 108CreateGroup element 175CreateIOCache operations 17CreateNewVersion element 201CreateParameterValuesFile operations 17CreateQuery operations 18CreateResourceGroup operations 18CreateRole operations 109CreateUser element 89, 175, 176CreateUser operations 109CreateUserGroup element 89, 176CreateUserGroup operations 109creating

auto suggestion lists 301bookmarks 103computed fields 710cross tabs 569custom security adapters 210dashboards 257data service components 289data sorters 286, 630debugging messages 4display names. See display namesEasyScript expressions 710filter conditions 111, 274, 596filters 274Flash gadgets 359Flash objects 355folders 108HTML5 charts 364IDAPI applications. See applications

Page 770: Actuate API Reference - OpenText

752 A c t u a t e A P I R e f e r e n c e

job requests 73label elements 391Login requests 78parameter components 294parameter groups 320, 331, 340passwords 333print jobs 60privilege filters 484report explorer 455report files 150report parameters 152resource groups 18, 164result sets 284scroll panels 524sort conditions 286, 630standard charts 343tables 395text elements 451user groups 197, 198users 109viewer components 493web-based applications 242

credentialsevaluating 210external data sources 218external users 55, 247iHub system 211, 217

Credentials element 55, 217credentials parameter 247cross tab bookmarks 548, 558, 574, 625cross tab elements 548, 577cross tab filter objects 596cross tab gadgets 555, 562cross tab layout view 641cross tab objects 549, 569cross tab report elements 549, 569cross tab Reportlets 565cross tabs

accessing 548adding dimensions to 570, 583adding measures to 571, 610changing 549creating 569displaying 548, 625drilling through 572, 573, 589filtering data in 572, 580, 596getting bookmarks for 558, 574

getting columns in 575getting empty cell values for 620getting level values in 617getting measure direction for 621getting page breaks for 620, 621getting rows in 576handling errors for 593handling events for 560, 592hiding detail data in 577loading 548pivoting elements in 577removing dimensions from 577removing measures from 578rendering 567reordering elements in 578, 579retrieving data for 575, 576selecting elements in 592setting display options for 571, 618setting empty cell values in 572, 622setting level values for 617setting measure direction for 623setting page breaks for 622, 623, 624sorting data in 580, 630submitting changes to 581switching measure direction in 572viewing detail data in 581viewing summary data in 603, 634, 638

Crosstab class 569Crosstab objects 549, 569crosstab variable 550CSS files

See also cascading style sheetsCSS formats 201CSS position attribute 556, 564CSV element 130CSV files 66CSV formats 130cube view 642CubeExtraction operations 18cubes

extracting data from 18getting metadata for 28loading 548

cur element 110, 177Currency data type 112, 152Currency element 112, 169Currency parameter 169

Page 771: Actuate API Reference - OpenText

I n d e x 753

currency valuesrounding 718

current date 731, 736current time 731, 736CurrentTransientReportTimeout element 30custom event web service 119custom events 109, 118, 120CustomEvent data type 109CustomEvent element 118, 120customizing

auto suggestion lists 301security adapters 210URL parameters 247user authentication 210user interfaces 531, 641user logins 210

cylinder gadgets 362

DDaily data type 110Daily element 143Dashboard class 257dashboard components 252dashboard definitions 258, 261, 267dashboard event constants 268dashboard files 45dashboard metadata 261dashboard names 259, 264dashboard objects 257dashboard page fragment (HTML) 263dashboard tab names 267, 270, 272dashboard tab objects 272dashboard tab toolbar 265dashboard tab type constants 272dashboard tabs

constructing 272determining gadget specific 271getting active 267getting array of 267getting names 270, 272, 273getting type 272setting as active 263

dashboard templates 259, 265DashboardDefinition class 267DASHBOARD_MAX constant 510DASHBOARD_NORMAL constant 510

dashboardsadding tabs to 272changing gadgets in 269closing 260creating 257determining status of 559downloading 258getting active tab for 259, 267getting content for 261getting tabs in 267handling events for 261, 268, 269saving 259, 260, 262setting active tab for 262, 263setting auto save delay for 263setting size of 264, 265setting viewing mode for 510setting web service connection for 264showing personal 266showing tab toolbar in 265submitting requests for 266viewing cross tabs and 555viewing gadgets and 271, 562

dataaggregating. See aggregationanalyzing 548changing 534displaying 618downloading 279extracting. See data extraction operationsfiltering 162hiding 353, 577localizing. See localesprompting for 155, 320, 338, 341returning from web services 289returning subsets of 284selecting 526submitting requests for 280updating 318

Data Analytics module 549Data Analytics viewer 563Data Analyzer

enabling or disabling 535data analyzer component 252

See also Interactive Crosstabsdata charts viewer

See also chartsdata cubes. See cubes

Page 772: Actuate API Reference - OpenText

754 A c t u a t e A P I R e f e r e n c e

data elementsSee also data itemsadding 351getting 517

data extraction format objects 95data extraction operations 19, 28, 535data fields

See also columnsdata filters. See filtersdata item IDs 352data item objects 351data items 351, 352, 353, 354

See also datadata object values files

exporting parameter definitions in 24retrieving parameters in 24, 45submitting jobs and 75

data point arrays 381data point options 375, 378data points (charts) 375, 378data repositories

See also Encyclopedia volumesdisplaying content 455getting type 211

data repository access rights 485, 486data repository file paths 259data repository type constants 491data repository types 489, 491data rows. See rowsdata series (charts)

adding 365, 371, 378changing 369deleting 368, 379drilling through 344, 345getting number of run-time 366getting values for 366, 367managing 378removing 380replacing 380setting values for 369, 370setting visibility of 368, 373, 381

data series objects 378, 379data service class 289data service components 252data service objects 289data services 289data set fields

finding character patterns in 727, 728, 735finding specific characters in 723, 726, 732removing blank characters in 737, 738testing for non-null values in 731testing for null values in 725

data set fields. See fieldsdata sorters. See sortersdata type definitions 91, 223data types

assigning to columns 105computed columns 611, 613defining 83, 112naming 177parameter definitions 152, 323, 324, 330report parameters 121, 337, 340RSSE applications 223setting cell specific 110SOAP-based archiving interface 233

DataACL element 78, 135database connection definition files 217database connection properties. See

connection propertiesdatabase drivers. See driversDatabase property 59database schemas. See schemasdatabase types 58DatabaseConnectionDefinition data type 110DatabaseEnvironment property 59DatabaseList property 59databases

See also data sourcespinging 58

DataCell data type 110DataExtraction operations 19, 28, 535DataExtractionFormat data type 111DataExtractionFormat objects 95DataExtractionFormats element 29DataExtractionRef element 19DataFetchHandle element 17DataFilterCondition data type 111DataFilterCondition objects 95DataItem class 351DataRow data type 111DataRow objects 96DataRows element 130DataSchema data type 112DataSchema element 129

Page 773: Actuate API Reference - OpenText

I n d e x 755

DataService class 289DataSortColumn data type 112DataSortColumn objects 96DataSource property 59DataSourceType data type 112DataSourceType element 154, 155DataType data type 112DataType element

ColumnSchema type 105FieldDefinition type 121ParameterDefinition type 152

Date data type 113, 152Date element 112, 169Date objects 96date parameters 169date values 88, 143, 274, 307

adding days to 713adding months to 715adding quarters to 715adding time values to 714, 716adding weeks to 716adding years to 716calculating days between 719calculating months between 720calculating quarters between 721calculating time values between 719, 720,

721calculating weeks between 722calculating years between 722returning current 731, 736returning month for 730returning quarter in 732returning weekdays for 718, 738returning weeks for 738returning year for 739setting conditions for 724testing equality of 725testing range of values for 717

date-and-time values 177DateOnly element 113, 169DateOnly parameter 169DatesExcluded element 143DateTime data type 112, 113DAY function 718days

adding to date values 713calculating number of 719

returning number in month 718returning specific 738

dbl element 110, 177dbn element 110, 177DBType property 58DCD. See database connection definitionsddb method 690debugging

event handlers 4files 134

debugging messages 4DebugInstruction element 134Decimal data type 113decimal values 113

rounding 733, 734DecomposeCompoundDocument element 20default authentication 210default iHub server URL 249default parameters 247default printer 162, 203default request options 249default resource group 20default values

downloading 296field definitions and 122getting 325overwriting 22setting 153, 331

default web service URL 248DefaultEventLagTime element 119DefaultEventPollingDuration element 119DefaultEventPollingInterval element 119DefaultFailureNoticeExpiration element 204DefaultObjectPrivileges property 222DefaultOutputFileACL element 40, 42DefaultOutputFileACL property 39, 42DefaultPrinterName element 196, 197, 203DefaultPrinterName property 193DefaultSuccessNoticeExpiration element 204DefaultTableValues element 154DefaultValue element 122, 153DefaultValueIsNull element 154DefaultViewingPreference element 204DefaultViewingPreference property 193DelayFlush element 129, 237delays 300delete privilege 159, 238

Page 774: Actuate API Reference - OpenText

756 A c t u a t e A P I R e f e r e n c e

DeleteChannel element 176DeleteChannel operations 114DeleteDatabaseConnection operations 20DeleteExpiredFiles operations 230DeleteExpiredFiles type 230DeleteFile element 90, 176DeleteFile operations 114DeleteFileType element 90, 176DeleteFileType operations 115DeleteGroup element 176DeleteGroup operations 115DeleteIOCache operations 20DeleteJob element 90, 177DeleteJob operations 115DeleteJobNotices element 90, 177DeleteJobNotices operations 116DeleteJobSchedule element 90, 177DeleteJobSchedule operations 116DeleteResourceGroup operations 20DeleteRole operations 116DeleteUser element 89, 175DeleteUser operations 117DeleteUserGroup element 89, 176DeleteUserGroup operations 117deleting

archiving rules 181authentication information 253blank characters 737channels 114data groups 447data series 368, 379, 380dimensions 577duplicate values 379event handlers 299, 560file dependencies 201file types 115files 114, 230folders 114job schedules 116jobs 115measures 578notification groups 115notifications 116resource groups 20security roles 189system printers 194user groups 117

users 117, 178denom argument 698dependent files. See file dependenciesDependentFileId element 125DependentFileName element 125DependOnFiles element 236Deployment Kit 254depreciation 690, 705descending sort order 286, 287, 632Description element

CreateFolder operations 108ErrorMessage type 224File type 122, 124FileInfo type 235InstallApp operations 54LicenseOption type 147NewFile type 151Printer type 160ResourceGroup type 164ServerInformation type 170User type 195UserField type 196UserGroup type 198UserGroupField type 198

Description property 221CopyFromLatestVersion element 79ResourceGroup element 79ResultDef element 36

design filesgetting parameters from 45naming 507, 508, 565

designscommitting changes to 554saving 540saving viewer content as 505

destination attributes (Ping) 56Destination element 56DestinationURL element 54destroy function

ClientPoint class 376ClientSeries class 379HTML5Chart Renderer class 386

detail data 449, 577, 581developing

charts. See charting APIsIDAPI applications. See IDAPI applicationsreport items 647

Page 775: Actuate API Reference - OpenText

I n d e x 757

RSSE applications. See RSSE applicationsweb applications 4, 242

DHTML formats 201DHTMLPageCaching element 204DHTMLPageCaching property 193DHTMLPageCachingExpiration property 194DHTMLPageCachingExpirationAge element

204diagnostic information 56

See also Ping operationsdialog boxes

exporting data and 510printing reports and 511viewing result sets and 511

dialog event constants 514DIFF_DAY function 719DIFF_HOUR function 719DIFF_MINUTE function 720DIFF_MONTH function 720DIFF_QUARTER function 721DIFF_SECOND function 721DIFF_WEEK function 722DIFF_YEAR function 722Dimension class 583dimension index values 579, 586, 588dimension names 584, 586dimension objects 583dimensions

adding levels to 583, 587, 606, 609adding to cross tabs 570, 583changing axis type 579, 587drilling through 572, 573, 589expanding or collapsing members in 581filtering 598, 600, 601, 602getting level values in 617getting levels 585, 599hiding detail data in 577naming 586removing 577reordering 578setting axis type for 586, 587setting index values for 586, 588sorting values 630, 631, 632viewing charts and 347

DIRECTION_HORIZONTAL value 618, 621, 623

DIRECTION_VERTICAL value 618, 621, 623

DirectOnly element 25directories

creating folders for 108preserving workspace 133

directory pathstemporary files 5

directory paths. See pathsDisabled element 164, 166Disabled property 79disableIV function 495display formats. See formatsdisplay names

columns 105parameter definitions 324, 325, 330, 331parameter values 310, 337, 340scalar parameters 121

displayingcolumns 449cross tabs 548, 625data 618data cubes 642data items 353data series 368, 373, 381dates 113Flash objects 355, 358, 363folders 460HTML5 charts 382label elements 393, 501parameter groups 302PDF documents 203report items 537report parameters 294, 320Reportlets 502standard charts 349summary data 603, 634, 638table elements 448table of contents 529, 530, 542tables 395text 452, 453, 500, 503toolbars 542, 642tooltips 541

DisplayName elementBookMark type 103FieldDefinition type 121ParameterDefinition type 153ParameterValue type 155

displayName element 105

Page 776: Actuate API Reference - OpenText

758 A c t u a t e A P I R e f e r e n c e

displayname variable 324DisplayType element 127distributed iHub System. See clustersdistribution location settings 184div tag 548division 729, 740DllPath property 58document conversion options 29, 73, 118document files

getting names 297naming 303, 507, 508, 565

document output formats (Word) 496documentation 385, 386, 387, 388, 389, 390

See also help collectionsDocumentConversionOptions data type 118DocumentConversionOptions objects 96documents

See also reportsdownloading 20getting embedded components in 37getting parameters for 45getting table of contents for 38running Interactive Crosstabs and 548saving 506, 540

DoesRoleExist operations 217DoesUserExist operations 217Domain element 55Done element 120Double data type 113, 118, 152Double element 113, 169Double parameter 169double quotation mark (") character

pattern matching and 727double values 89, 118, 177double-declining depreciation 690.dov files. See data object values filesdownload operations 20

See also downloadingdownload result set dialog 511downloadDashboard function 258DownloadEmbedded element

DownloadFile operations 21ExportParameterDefinitionsToFile

operations 24GetJavaReportEmbeddedComponent

operations 38GetJavaReportTOC operations 38

SelectJavaReportPage operations 65DownloadFile operations 20downloading

See also download operationscompound documents 20dashboards 258data 279report files 20report parameters 295, 296reports 279, 496result sets 289, 497, 511

downloadParameters function 295downloadParameterValues function 296downloadReport function 496downloadResultSet function

DataService class 289Viewer class 497

DownloadTransientFile operations 21drawing elements (Highcharts) 384drill function 572drillDown function 573drillDownCategory function 344drillDownSeries function 344Driller class 589Driller objects 589drillUp function 573drillUpCategory function 344drillUpSeries function 345driver names 127DriverName element 127drivers

ping operations and 58polling 134running open server 57setting timeout intervals for 133

DriverTimeout element 133drop-down list controls 122, 153DroppedFromUsersById element 190DroppedFromUsersByName element 189DropRolesById element 192DropRolesByName element 191DropUserGroupsByID element 192DropUserGroupsByName element 191dtm element 110, 177Duplex element 139, 161, 162DuplexOptions element 161duplicate names 109, 149

Page 777: Actuate API Reference - OpenText

I n d e x 759

duplicate values 379duplicating. See copyingduplication suppression feature 541DurationSeconds element 132, 141dynamic filter parameters

converting values 306defining 332getting column names for 323, 336getting column type for 323, 336

dynamic filter queries 323dynamic filters 317

EeachPmt argument 691, 696, 702, 704EasyScript expressions 710EasyScript function reference 713EasyScript functions quick reference 710EasyScript operators 739Echo action 57editMeasure function 574Effective element 27elements. See report elements; XML elementsElementType element 103e-mail

directing to external users 221sending attachments with. See attachmentssetting notification options for. See

notificationsEmailAddress element 195, 197, 225EmailAddress property 221EmailFormat element 77, 135EmbeddedObjPath element 203EmbeddedProperty element 174EmbeddedRef element 38embedTemplate function 258empty cells 572, 620, 622empty strings 726, 732emptyCellValue parameter 572, 618enableAdvancedSort function 532enableAggregation function 533EnableAutoParamCollection element 127enableCalculatedColumn function 533enableChartProperty function 533enableChartSubType function 533enableCollapseExpand function 534enableColumnEdit function 534

EnableColumnHeaders property 66enableColumnResize function 534enableContentMargin function 534enableCrosstabView function 641enableCubeView function 642EnableCustomEventService element 119Enabled element 54enableDataAnalyzer function 535enableDataExtraction function 535enableEditReport function 535enableExportReport function 535enableFacebookComments function 536enableFilter function 536enableFilterSummaryView function 642enableFlashGadgetType function 536enableFormat function 536enableGroupEdit function 537enableHideShowItems function 537enableHighlight function 537enableHoverHighlight function 537enableIV function 497enableLaunchViewer function 538enableLinkToThisPage function 538enableMainMenu function 538enableMoveColumn function 538enablePageBreak function 539enablePageBreak parameter 618enablePageNavigation function 539enableParameterPage function 539enablePrint function 539enableReorderColumns function 540enableRowResize function 540enableSaveDesign function 540enableSaveDocument function 540enableShowToolTip function 541enableSort function 541enableSuppressDuplicate function 541enableSwitchView function 541enableTextEdit function 542enableTOC function 542enableToolBar function

Viewer.UIOptions class 542XTabAnalyzer.UIOptions class 642

enableToolbarContextMenu function 543enableToolbarHelp function 543, 643enableToolbarSave function 643enableToolbarSaveDesign function 643

Page 778: Actuate API Reference - OpenText

760 A c t u a t e A P I R e f e r e n c e

enableToolbarSaveDocument function 644enableTopBottomNFilter function 543enableUndoRedo function 544encrypted tokens 55EncryptedPwd element 55, 195encryption levels 78Encyclopedia engine 56Encyclopedia volumes

assigning resource groups to 164defining attributes of 203developing transaction operations for 175naming 203removing items in 230testing for 170updating properties for 193

EndArchive operations 230EndArchive type 231EndTime element 163enterprise repository type 491EntityID element 54environments 4EQ operator 274, 596ERR_CLIENT constant

parameter class 305ReportExplorer class 462

ERR_CLIENT exception typeactuate.Exception class 291ViewerException class 545XTabAnalyzer.Exception class 593

error callback functions 254, 256, 290error codes 173, 292, 594error constants 305, 462error descriptions 291, 593error messages

Interactive Crosstabs 594uncategorized exceptions 292viewer 546

errorCallback parameter 248, 251ErrorCode element 224ErrorDescription element

CancelJob operations 16CancelReport operations 17ExecuteReport operations 23GetSyncJobInfo operations 48WaitForExecuteReport operations 81

ErrorMessage data type 224errors

iHub server status and 173RSSE applications and 224web service requests and 248, 251

ERR_SERVER constantparameter class 305ReportExplorer class 462

ERR_SERVER exception typeactuate.Exception class 291ViewerException class 545XTabAnalyzer.Exception class 593

ERR_USAGE constantparameter class 305ReportExplorer class 462

ERR_USAGE exception typeactuate.Exception class 291ViewerException class 545XTabAnalyzer.Exception class 593

escape characters 124Event data type 118event handlers

accessing iHub environment and 4debugging 4displaying cross tabs and 560, 592displaying dashboards and 261, 268, 269displaying parameters and 299displaying reports and 514exceptions and 291getting help for 4navigating repository content and 457, 463registering 299, 560removing 299, 560selecting report elements and 526

event model 4event names 119event status codes 119event types 119EventConstants class

Dashboard class 268Parameter class 309ReportExplorer class 463Viewer class 514XTabAnalyzer class 592

EventName element 119, 142EventOptions data type 119EventParameter element 110, 142events

defining attributes of 118

Page 779: Actuate API Reference - OpenText

I n d e x 761

defining options for 119handling. See event handlersrunning jobs and 131, 142setting polling interval for 119specifying custom 109, 120

EventStatus element 119, 142EventType data type 119EventType element

Event type 119JobProperties type 142JobScheduleSearch type 145

Excel formats 202, 496Excel spreadsheets 522Exception class 291, 593exception classes 254, 256, 545exception objects 291exception types

constructing exception objects and 291getting 292, 595testing for 292, 595

exceptionsauthentication and 254connections and 256cross tabs and 592, 593report parameters and 309viewer and 514, 545

executable file types 127executable files

attaching to responses 22generating report files from 17getting parameters from 45submitting job requests for 74

ExecutableFileName element 158, 168ExecutableVersionName element 158, 168ExecutableVersionNumber element 158, 168execute privilege 159, 238ExecuteQuery operations 21ExecuteReport operations

defining 21ExecuteReportStatus data type 120ExecuteVolumeCommand operations 23Execution element 164execution parameters 45, 164execution requests. See ExecuteReport

operationsexecution status attributes 23, 80ExecutionTimeout element 168

Exists element 217ExpirationAge element 91, 133ExpirationDate element 133ExpirationTime element 91expired jobs 67ExpireDependentFiles element 91ExpiredFileIds element 230ExpiredFiles element 232explodePieSlice function 372exponentiation 740export report dialog 510ExportBeforeViewing element 127exporting reports 496, 510, 535ExportParameterDefinitionsToFile operations

24expressions

adding conditions to 724, 731, 740calculating data values and 710, 739computing cross tab values and 611, 613creating 710filtering data and 274, 596literal characters in 727, 729matching text patterns and 727, 728scripting and 647

extended security credentials 211Extensible Markup Language. See XMLExtension property 108external authentication 216external data sources 186, 217, 219external security integration levels 221external security systems 216, 219external translated user names 120external user credentials 55, 247external user groups 121external user names 187, 218external user properties 52, 219external user registration

assigning security roles and 203authenticating users for 216described 216enabling 204getting user names for 220searching roles for 220searching users for 69, 70

external user roles 52, 69, 217external users 70, 217ExternalProperties element 221

Page 780: Actuate API Reference - OpenText

762 A c t u a t e A P I R e f e r e n c e

ExternalTranslatedRoleNames data type 120ExternalTranslatedUserGroupNames data

type 121ExternalTranslatedUserNames data type 120ExternalUserPropertyNames element 52ExternalUserPropertyNames property 52ExtractParameterDefinitionsFromFile

operations 24

FFacebook comments 536Facebook comments panel 511Factory process IDs 169Factory processes 172Factory service

assigning resource groups to 165enabling 173getting information about 29, 31pinging 58running jobs and 20, 158, 167

FactoryPid element 169failed connections 256FAILED element 172Failed element 103, 120failed jobs 77, 120, 166failed requests 254failure notices

deleting 222print operations 61setting expiration time for 195, 197submit job operations 76

FailureNoticeExpiration elementUser type 195, 226UserField type 197

FailureNoticeExpiration property 222FALSE operator 274, 596feature maps 544, 644FeatureOptions element 56features 529, 531, 641fetch direction (FileSearch) 476, 479fetch handles

file searches 476, 479folder items 482, 483

fetch size (FileSearch) 476, 480FetchDirection element

FileSearch type 126

GetFileACL operations 34GetFileCreationACL operations 35JobNoticeSearch type 138JobScheduleSearch type 145JobSearch type 146UserGroupSearch type 199UserSearch type 201

FetchHandle elementFileSearch type 126GetFileACL operations 34GetFileCreationACL operations 35GetFolderItems operations 37JobNoticeSearch type 138JobScheduleSearch type 145JobSearch type 146SelectFiles operations 64SelectJobs operations 66, 67SelectJobSchedules operations 68SelectUserGroups operations 70SelectUsers operations 70UserGroupSearch type 200UserSearch type 201

FetchInfoObjectData operations 24FetchSize element

FileSearch type 126GetFileACL operations 33GetFileCreationACL operations 35GetParameterPicklist operations 44JobNoticeSearch type 138JobScheduleSearch type 145JobSearch type 146SelectRoles operations 220SelectUsers operations 221UserGroupSearch type 199UserSearch type 200

Field elementFileCondition type 123JobCondition type 131JobNoticeCondition type 137JobScheduleCondition type 142UserCondition type 196UserGroupCondition type 198

FieldControlType element 122FieldDefinition data type 121FieldDefinition objects 96fields

finding character patterns in 727, 728, 735

Page 781: Actuate API Reference - OpenText

I n d e x 763

finding specific characters in 723, 726, 732removing blank characters in 737, 738See also columnstesting for non-null values in 731testing for null values in 725

FieldValue data type 122file access type attributes 123file access types

getting 465, 474job properties and 40setting 468, 478

file attributesSee also file properties

File class 464File data type 122file dependencies

expiring 91getting 475moving files and 149removing 201replacing existing files and 151, 201searching for 125, 479specifying 180

file descriptions 122, 127, 465, 468File element 21, 36, 124file events 118, 120, 124file IDs 465, 468, 475, 479

See also FileId elementfile lists 106, 471file name extensions 64, 127, 465file names

getting 297, 466, 477, 502moving files and duplicate 149saving report designs and 505saving report documents and 506search operations and 64setting 122, 150, 469, 481viewing reports and 507, 508

File objects 96, 464file owner attribute 123file owners

getting 466, 477setting 469, 480

file paths. See pathsfile properties

downloading files and 21getting 35

setting 122, 234updating 179

file search objects 457, 459, 473file size 466, 469file size attribute 122, 125, 141file system interface 455file type attributes 126file type events 124file type icons 127, 182file type objects 97file types

adding 107, 126deleting 115duplicating 108getting conversion options for 29getting extensions 465getting parameters for 36resource groups and 166searching 64setting 23, 122, 468updating 182

FileAccess data type 123FileAccess type 234FileCondition class 471FileCondition data type 123FileCondition objects 96FileContent data type 124FileContent objects 97file-creation privileges 34, 192FileCreationACL template 34FileEvent data type 124FileEvent element 118, 120FileField data type 124FileId element

DownloadFile operations 20GetConnectionProperties operations 26GetConnectionPropertyAssignees

operations 27GetFileACL operations 33GetFileDetails operations 35SaveTransientReport operations 62SetConnectionProperties operations 71UploadFile operations 80

FileInfo elements 233FileInfo type 234FileLocation element 235FileName element

Page 782: Actuate API Reference - OpenText

764 A c t u a t e A P I R e f e r e n c e

DownloadFile operations 20GetConnectionProperties operations 26,

218GetConnectionPropertyAssignees

operations 27GetFileACL operations 33GetFileDetails operations 35Ping operations 58SetConnectionProperties operations 71

FileProperties element 18, 21files

See also report filesassigning privileges to 123attaching to e-mail 76, 124counting pages in 466creating 150debugging 134defining attributes of 122, 234defining fields in 124deleting 114expiring 230getting expired 231handling missing 180monitoring 124naming. See file namesnavigating through 455referencing 464searching 123, 125, 473setting number of pages in 469setting properties for. See file propertiesspecifying input 74specifying owner of 123, 125streaming 174

FileSearch class 473FileSearch data type 125FileSearch objects 457, 459, 473FileType data type 126FileType element

ArchiveRule operations 91CreateFileType operations 108DocumentConversionOptions type 118File type 122, 124FileInfo type 235GetDataExtractionFormats operations 28GetDocumentConversionOptions

operations 29

GetFileTypeParameterDefinitions operations 36

SOAP headers and 129, 237FileType objects 97FileType property 36FileTypes element

ResourceGroupSettings type 166SelectFileTypes operations 64ServerResourceGroupSetting type 172

FileTypes property 72, 79Filter class 274, 596filter condition objects 95filter conditions

adding 111, 274, 596getting operator in 599getting values of 276, 277, 600matching character patterns and 274, 275setting operator in 277, 601setting values for 278, 602

filter controls 153Filter element 44filter expressions 274, 596

creating 710filter objects 274, 596filter operators 274, 276, 277, 596filter strings 471filter summary view 642FilterCriteria data type 128filtering

data 162file lists 471, 477, 480

FilterList element 18, 19filters

adding gadgets and 359, 362adding table elements and 399, 446, 447,

448clearing 355, 399, 446, 447, 448creating 274determining if dynamic 317displaying charts and 344, 348displaying cross tabs and 572, 580, 596displaying Flash objects and 355, 357enabling or disabling 536, 543getting column names for 276getting type for 598retrieving data and 274setting column names for 277

Page 783: Actuate API Reference - OpenText

I n d e x 765

setting level names for 600, 601submitting requests and 281, 282

Finance class 690financeRate argument 695financial methods 690–707financial values 690FIND function 723finding data. See search operationsFirefox browsers 291FirstPage element 120Flash charts 346, 358, 362Flash object elements 357Flash objects 355, 356, 501, 517FlashObject class 355floating-point numbers 118focus 506folder IDs 36folder labels 460folder lists 106, 483folder names 108, 456folder paths. See pathsFolderId element 36, 54FolderItems class 482FolderName element 36, 108folders

archiving 233creating 108deleting 114displaying 460duplicating 108getting access rights to 33getting files in 36, 63getting home 211getting names 456handling missing 180moving 86, 149naming 108, 458navigating through 455setting home 195, 197updating 179

fonts 302forceSoftRestart function 554format 708format editing feature 536Format element 201format method 708formats

See also output formatsdownloading reports and 496localizing data and 274retrieving information objects and 130

Formatter class 708formatter methods 708FormName element 139forward slash (/) character 728FrequencyInDays element 110FrequencyInMonths element 148FrequencyInWeeks element 204functions

See also callback functions; methodsActuate JavaScript API 245calculating data values and 710EasyScript expressions and 713Interactive Crosstabs JavaScript API 548

functions reference 710future value (annuities) 691futureValue argument

ipmt method 693nper method 696pmt method 699ppmt method 701pv method 702rate method 704

fv method 691

Gg function 387Gadget class 359gadget elements 359, 518gadget IDs 555gadget names 270gadget objects 359gadget script objects 269gadget type change control 536gadget types 362gadgets

adding to dashboards 262changing 269, 536displaying 363filtering 359, 362getting instance of 360, 501getting title of 270getting type 270

Page 784: Actuate API Reference - OpenText

766 A c t u a t e A P I R e f e r e n c e

hiding 361retrieving bookmarks for 360setting size 362specifying type 362

GadgetScript class 269GADGET_TYPE_BULLET constant 362GADGET_TYPE_CYLINDER constant 362GADGET_TYPE_LINEARGAUGE constant

362GADGET_TYPE_METER constant 362GADGET_TYPE_SPARK constant 362GADGET_TYPE_THERMOMETER constant

362garbage collection 299generating

debugging messages 4query output 323, 329, 339report components 246report object value files 17, 22

Generation element 173generation requests

cancelling 103getting status of 16, 23, 80retrying 166setting status attributes for 120setting wait intervals for 23submitting jobs for 75

getAccessRights function 485getAccessType function 465, 474getActiveTab function 259getAggregationFunction function 610, 638GetAllCounterValues operations 25GetAllPaperSizes element 49getAttributes function 606getAuthenticationId method 5getAutoSuggestThreshold function 323getAxisType function 584, 604getBookmark function

Chart class 345Crosstab class 574DataItem class 351FlashObject class 356Gadget class 360Label class 391Request class 281Table class 399TextItem class 451

GetBookmarks operations 25GetCapabilities operations 25GetCapabilitiesByCategory operations 25GetCapabilityCategories element 26GetCapabilityCategories operations 26getCascadingParentName function 323getCascadingParentValues function 313getCategoryCount function 365GetChannelACL operations 26getChart function 497getChartByBookmark function 516getChartHeight function 365getChartWidth function 365getChildData function 314getClientChart function 345getClientHeight function 498getClientOptions function 366getClientWidth function 498getColumn function 400, 575getColumnIndex function 512, 527getColumnMirrorStartingLevel function 619getColumnName function

Filter class 276ParameterDefinition class 323ParameterValue class 336Sorter class 286

getColumnNames function 284getColumnPageBreakInterval function 620getColumns function 281getColumnType function 323, 336getCondition function 474getConditionArray function 474GetConnectionProperties operations 26, 217,

223GetConnectionPropertyAssignees operations

27GetContent operations 27getContentByBookmark function 498getContentByPageRange function 499getContentMargin function 499getContentPanel function 529getControlType function 314, 324getCore function 366GetCounterValues operations 27getCountLimit function 475getCrosstabByBookmark function 625GetCubeMetaData operations 28

Page 785: Actuate API Reference - OpenText

I n d e x 767

getCurrentDisplayName function 324getCurrentPageContent function

Viewer class 499XTabAnalyzer class 555

getCurrentPageNum function 500, 555getCurrentReportParameters function 270getCurrentValue function 314GetCustomFormat operations 28getDashboardName function 259getData function 352, 575GetDatabaseConnectionDefinition operations

28GetDatabaseConnectionParameters

operations 28GetDatabaseConnectionTypes operations 28GetDataExtractionFormats operations 28getDataItem function 500getDataItemByBookmark function 517getDataType function

Measure class 611ParameterDefinition class 324ParameterValue class 337

getDAViewer function 248getDefaultActiveTab function 267getDefaultIportalUrl function 248getDefaultRequestOptions function 249getDefaultValue function 314, 325getDefaultValueIsNull function 325getDependentFileId function 475getDependentFileName function 475getDescription function

actuate.Exception class 291ReportExplorer.File class 465XTabAnalyzer.Exception class 593

getDimension function 590getDimensionName function 584getDisplayName function 325, 337GetDocumentConversionOptions operations

29GetDynamicData operations 29getElement function 545, 594GetEmbeddedComponent operations 29getEmptyCellValue function 620getEnablePageBreak function 620getErrCode function 292, 594getErrorMessage function 213, 546getExpression function 611

getExtendedCredentials function 210GetFactoryServiceInfo element 30GetFactoryServiceInfo operations 29GetFactoryServiceJobs operations 31getFeatureMap function 544, 644getFetchDirection function 476getFetchHandle function 476, 482getFetchSize function 476getField function 471GetFileACL operations 33GetFileCreationACL operations 34GetFileDetails operations 35getFileType function 465GetFileTypeParameterDefinitions operations

36getFilters function 281getFilterType function 598getFlashObject function 501getFlashObjectByBookmark function 517GetFolderItems operations 36getFolderName function 456GetFormats operations 37getGadget function 501getGadgetByBookmark function 518getGadgetId function 555getGadgetName function 270getGadgetTitle function 270getGadgetType function 270getGrantedRoleId function 485getGrantedRoleName function 485getGrantedUserId function 485getGrantedUserName function 486getGroup function 325, 337getHeight function 501, 555getHelpText function 315, 326getHtmlDom function

Chart class 345Crosstab class 575DataItem class 352FlashObject class 356Gadget class 360Label class 391Table class 400TextItem class 452

getId function 465getIncludeHiddenObject function 476getIndex function 584, 607, 611

Page 786: Actuate API Reference - OpenText

768 A c t u a t e A P I R e f e r e n c e

GetInfoObject operations 37getInstanceId function

Chart class 346DataItem class 352FlashObject class 356Gadget class 360Label class 392Table class 401TextItem class 452

getIportalUrl function 254getIServerUrl function 489getItemList function 482GetJavaReportEmbeddedComponent

operations 37GetJavaReportTOC operations 38GetJobDetails operations 39getKey function 630getLabel function 392, 501getLabelByBookmark function 518getLatestVersionOnly function 456getLayout function 296getLeft function 556getLevelAttributeName function 598getLevelName function

Filter class 599Level class 607MemberValue class 616Sorter class 631SubTotal class 635

getLevels function 585getLocale function 489getLocation function 635getMatch function 471getMaxRows function 281getMeasureDirection function 621getMeasureIndex function 639getMeasureName function 612getMember function 631getMembers function 590, 616getMessage function 292, 594GetMetaData operations 41getMouseScrollingEnabled function 524getName function

File class 466LevelAttribute class 609NameValuePair class 310ParameterDefinition class 326

ParameterValue class 337, 520, 627Tab class 272

getNameValueList function 315getNewAxisType function 585getNewIndex function 585, 612GetNextExpiredFiles operations 231GetNextExpiredFiles type 231GetNextExpiredFilesResponse type 232GetNoticeJobDetails operations 41getOperator function 276, 599getOperatorList function 326getOptions function 522getOwner function 466, 477getPageContent function

Chart class 346Crosstab class 576DataItem class 353FlashObject class 357Gadget class 361Label class 392Table class 401TextItem class 452

getPageCount function 466GetPageCount operations 43GetPageNumber operations 43getPanInOutEnabled function 525getParameterGroupNames function 296getParameterMap function 307getParameterName function 315GetParameterPickList operations 44getParameterValues function 307, 556getParentData function 315getPassword function 211getPickList function 316getPosition function 326, 338, 556getPrivilegeFilter function 477getPromptParameter function 338getPromptText function 316getReportletBookmark function 502getReportName function 297, 502GetReportParameters operations 45getRepositoryType function 211, 489getRequestOptions function 254getRequiredFileId function 477getRequiredFileName function 477GetResourceGroupInfo operations 45GetResourceGroupList operations 46

Page 787: Actuate API Reference - OpenText

I n d e x 769

getRESTAuthToken function 489getResultDef function 456getRow function 401, 576getRowMirrorStartingLevel function 621getRowPageBreakInterval function 621getRunAsUser function 211GetSavedSearch operations 47getSearch function 457getSelectedElement function 528getSelectNameValueList function 327getSelectValueList function 327getSeriesCount function 366GetServerResourceGroupConfiguration

operations 47getServerUrl function 211getServerWorkingDirectory method 5getShowToc function 529getSize function 466getSorters function 282getStartRow function 282GetStaticData operations 47GetStyleSheet operations 47getSuggestionList function 316GetSyncJobInfo operations 47GetSystemMDSInfo operations 48GetSystemPrinters operations 48GetSystemServerList operations 49GetSystemVolumeNames operations 49getTable function 502getTableByBookmark function 518getTabName function 270getTabs function 267getTabTitle function 271getTabType function 272getTemplate function 259getText function 453, 503getTextByBookmark function 519getTextContent function 279getTimeStamp function 467getTitle function 273GetTOC operations 49getTop function 557getTotalCount function 483getTotalPageCount function 503, 557getTotals function 604, 635getTransientDocumentName function 297GetTranslatedRoleNames operations 218

getType functionChart class 346Crosstab class 577DataItem class 353Exception class 292, 595FlashObject class 357Gadget class 361GrandTotal class 604Label class 393SubTotal class 636Table class 402TextItem class 453

getUIConfig function 503getUIOptions function 503, 557getUrl function 256GetUserACL operations 219getUserAgentString method 6GetUserExtendedProperties operations 49GetUserGroupExtendedProperties

operations 50GetUserGroupProductAccess operations 53GetUserGroupProductAccessResponse

element 53getUserHomeFolder function 211getUserId function 249, 255GetUserLicenseOptions operations 51getUserName function 212getUserPermissions function 467GetUserPreference operations 51GetUserPrinterOptions operations 51GetUserProperties operations 219getUserRoles method 6, 7GetUsersToNotify operations 219getValue function

MemberValue class 616NameValuePair class 311ParameterValue class 338, 520, 628ResultSet class 285

getValueIsNull function 338, 521, 628getValues function 276, 600getVersion function 249, 467getVersionName function 467getViewer function

actuate class 249Viewer class 504XTabAnalyzer class 558

getViewerId function 519, 625

Page 788: Actuate API Reference - OpenText

770 A c t u a t e A P I R e f e r e n c e

getVolume function 212, 490GetVolumeList element 55getVolumeName method 7getVolumeProfile function 490GetVolumeProperties operations 52getWidth function 504, 558getXAxisMax function 366getXAxisMin function 367getXTabBookmark function 558getXTabIid function 559getYAxisMax function 367getYAxisMin function 367global constants 305, 462gotoBookmark function 504gotoPage function 505grand totals 603GrandTotal class 603grant privilege 159, 238GrantedRoleId element

GetFileACL operations 33GetFileCreationACL operations 34PrivilegeFilter type 162

grantedRoleId value 485, 486GrantedRoleName element

GetFileACL operations 33GetFileCreationACL operations 34PrivilegeFilter type 162, 163

grantedRoleName value 485, 486GrantedUserGroupId element 33, 163GrantedUserId element

GetFileACL operations 33GetFileCreationACL operations 34PrivilegeFilter type 162

grantedUserId value 485, 487GrantedUserName element

GetFileACL operations 33GetFileCreationACL operations 34PrivilegeFilter type 162

grantedUserName value 486, 487GrantPermissions element 181GrantUserGroupCapabilities operations 53GrantUserGroupCapabilitiesResponse

element 53GrantUserGroupProductAccess operations

50graphical user interfaces. See user interfacesgraphics elements 387

See also imagesgraphs. See chartsGREATER_THAN operator 274, 596GREATER_THAN_OR_EQUAL operator

274, 596Group data type 128group editing feature 537Group element 152, 155group names 109groupBy function 402GroupCondition data type 128GroupField data type 128grouping data rows 402Grouping data type 128GroupingEnabled element 40, 42GroupList element 186GroupName element 221GroupPromptText element 154groups

See also notification groups; resource groups

assigning privileges 159assigning to users 191creating user 109defining administrator 120defining attributes of 197, 198deleting 117external users and 121getting assigned privileges for 162getting available capabilities for 25, 26getting product family access of 53granting capabilities for 53granting product family access to 50removing in tables 447removing users 191revoking capabilities for 61revoking product access for 62searching 198updating 188, 189, 191validating 55

GroupSearch data type 128GUI components

See also user interfaces

HHasMore element 232

Page 789: Actuate API Reference - OpenText

I n d e x 771

Header data type 129header elements (SOAP messages)

See also SOAP headersHeader type 236Headline element 74, 136, 137headlines 8, 136help 543, 643help text 154, 315, 326, 332HelpText element 154hexadecimal values 89hidden files 476, 480hidden objects 126hidden parameters 121, 153hide function

Chart class 347ClientSeries class 379DataItem class 353FlashObject class 357Gadget class 361Label class 393Table class 402TextItem class 453

hide/show item feature 537hideColumn function 403hideDetail function 403, 577hideNavBar function 297hideParameterGroup function 297hideParameterNames function 298hiding

chart elements 347columns 105, 403data 353, 577Flash objects 357, 361HTML5 charts 379label elements 393navigation bars 297parameters 121report parameters 298, 328, 332table of contents 530tables 402text items 453

Highcharts class 383Highcharts documentation 385, 386, 387, 388,

389, 390Highcharts drawing elements 384Highcharts objects 366, 383Highcharts point class 375

Highcharts point configurations 381Highcharts renderer objects 384, 386, 389highlighting 537home folder

getting 211setting 195

HomeFolder element 195, 197, 225HomeFolder property 222Host property 59HostString property 59hours 714, 719hover highlight feature 537HTML code 390HTML elements

adding Flash objects to 356, 360adding table elements to 400adding text elements to 392, 452creating cross tabs and 548, 575displaying charts and 345displaying data and 352, 493displaying Interactive Crosstabs and 549,

552displaying parameters and 294

HTML formats 496HTML forms 294, 302HTML5 charts

adding animation feature to 379adding data series to 365, 371, 378changing data series in 369displaying 382drawing functions for 384getting number of run-time series in 366getting options for 366getting series values for 366, 367getting size of 365, 366getting specific instance of 345hiding 379instantiating 364labeling axes values 373pivoting axes values in 372redrawing 368, 380, 381removing data points in 376removing duplicate values for 379removing series from 368, 379, 380rendering 380replacing data series in 380resizing drawing area for 389

Page 790: Actuate API Reference - OpenText

772 A c t u a t e A P I R e f e r e n c e

selecting data points in 376selecting series for 380setting data point properties for 375setting options for 371setting series values for 369, 370setting series visibility in 381setting title of 369, 373setting type 372updating data points in 377viewing data series in 368, 373

HTTP sessionsrunning Interactive Crosstabs and 592

hyperlinksSee also URLsenabling or disabling 538sending output files and 76

hypertext markup language. See HTML codeHyperText Transfer Protocol. See HTTP

Ii character in search expressions 728icons

file types 127, 182Id element

CopyFile operations 107DeleteFile operations 114DeleteJob operations 115, 116DeleteUser operations 117DeleteUserGroup operations 117File type 122FileInfo type 235MoveFile operations 149ObjectIdentifier type 151SelectFiles operations 63SelectJobs operations 67SelectJobSchedules operations 68SelectUserGroups operations 69SelectUsers operations 70UndeleteUser operations 178UpdateJobSchedule operations 184UpdateUser operations 187UpdateUserGroup operations 188User type 194UserGroup type 197

IDAPI applicationsSee also Information Delivery API

archiving and 229defining operations for 11integrating with external security sources

216IdList element

CopyFile operations 106DeleteFile operations 114DeleteJob operations 115, 116DeleteUser operations 117DeleteUserGroup operations 117MoveFile operations 149SelectFiles operations 63SelectJobs operations 67SelectJobSchedules operations 68SelectUserGroups operations 69SelectUsers operations 70UndeleteUser operations 178UpdateJobSchedule operations 183UpdateUser operations 187UpdateUserGroup operations 188

IF function 724, 740IgnoreActiveJob element 116IgnoreDup element

CreateFileType operations 108CreateFolder operations 108CreateUser operations 109CreateUserGroup operations 109UpdateFileType operations 182UpdateUser operations 188UpdateUserGroup operations 189

IgnoreMissing elementDeleteFile operations 114DeleteFileType operations 115DeleteJob operations 115, 116DeleteUser operations 117DeleteUserGroup operations 118UndeleteUser operations 178UpdateFile operations 180UpdateFileType operations 182UpdateJobSchedule operations 184UpdateUser operations 188UpdateUserGroup operations 188

iHub API 4iHub API reference 4iHub clusters. See clustersiHub licensing options 51, 147, 200iHub processes 58

Page 791: Actuate API Reference - OpenText

I n d e x 773

iHub repository. See Encyclopedia volumesiHub server URLs

getting 249, 489setting 490

iHub serversassigning resource groups to 165, 171authenticating users for 54configuring 171defining attributes of 170deleting expired files on 230getting login names for 212getting resource groups for 46getting security credentials for 211getting state of 49getting URLs for 249, 489naming 170publishing report files to 4setting as system type 174setting response times for 23setting state 172setting status of 170, 172setting URLs for 490setting version attributes for 170, 173

iHub service type definition 173iHub services

See also specific iHub serviceiHub System

getting printer information for 48getting user licenses for 51, 200integrating with external security sources

216logging in to 54, 78, 212setting licensing options for 147, 165setting security credentials for 217setting type attributes for 174testing components of 56updating user licensing for 193

iHub volumesgetting names of 7

image components 37image elements 387image function 387ImageMapURL formats 202images

streaming 174IN function 724IN operator 274, 597

InActive element 104IncludeFolder element 233IncludeHiddenObject element 126includeHiddenObject value 480inclusive range operators 274, 275index values

accessing result sets and 285changing axis type and 579displaying cross tabs and 575, 576displaying tables and 401getting column 285, 400, 512, 526, 527, 528getting data row 281, 282getting level 607getting measure 611, 612, 639incrementing 588setting data row 283setting dimension 586, 588setting level 607setting measure 613, 614, 640setting parameter position and 334

indexes 585, 588InfoObject element 112InfoObjectData data type 129InfoObjectDataFormat data type 130Information Console Security Extension 210

See also IPSE applicationsInformation Console URL 254Information Delivery API

See also IDAPI applicationsarchiving interface for 229array definitions and 91data type reference for 83, 233operations reference for 11, 230

information object files 130information objects

accessing parameters in 112, 152closing 17external security systems and 218retrieving data from 129submitting job requests for 73

InheritedFrom element 91initialCost argument 690, 705, 706initialize function 250input 320Input element 220input file IDs. See InputFileId elementinput file names. See InputFileName element

Page 792: Actuate API Reference - OpenText

774 A c t u a t e A P I R e f e r e n c e

input filesattaching to responses 22submitting jobs and 74, 132, 141

input messagesSee also requests

input parameterscallback functions and 284generic objects as 306job schedules and 184open security libraries and 220

InputDetail element 40, 42InputDetail property 39, 41InputFile element 22InputFileId element

ExecuteReport operations 22JobProperties type 140JobScheduleSearch type 145JobSearch type 146PrintReport operations 60SubmitJob operations 75

InputFileName elementExecuteReport operations 21JobProperties type 141JobScheduleSearch type 145JobSearch type 146PrintReport operations 60SubmitJob operations 74

InputFileVersionName element 132InputParameter element 16InstallApp operations 54Int data type 113, 130int element 110, 177int objects 97Integer data type 130, 152Integer element 113, 169Integer parameter 169integers 97, 130, 177Integration element 174Integration service 57, 174Integration Technology. See iHub Integration

TechnologyIntegrationLevel element 221Interactive Crosstab viewers

getting specific instance 248Interactive Crosstabs

accessing 548

adding toolbars. See Interactive Crosstabs toolbars

changing CSS position attribute for 564closing 563determining status of 559, 560displaying cross tabs and 552, 625displaying data cubes and 642displaying specific object in 558enabling driller for 589enabling filter summary view 642getting content for 555, 625getting CSS position attribute for 556getting current instance 559getting feature map for 644getting ID for 625getting margins for 556, 557getting parameters for 627getting size 556, 558getting UI options for 557handling errors for 593handling events for 592initializing 549instantiating 548, 552integrating with Interactive Viewer 559,

563, 567loading 548resizing 561, 562, 567restarting 554restoring initial state 561rolling back changes to 561saving documents 643, 644sessions timing out and 592setting display options for 571, 618setting margins for 563, 566setting UI options for 566, 641submitting requests for 549, 568

Interactive Crosstabs API 548Interactive Crosstabs API class reference 550Interactive Crosstabs API classes 549Interactive Crosstabs API error constants 593Interactive Crosstabs API event constants 592Interactive Crosstabs objects 552Interactive Crosstabs toolbars

enabling or disabling 642help feature for 643save design feature for 643save document feature for 644

Page 793: Actuate API Reference - OpenText

I n d e x 775

save feature for 643Interactive Crosstabs viewer 548, 552, 558Interactive Crosstabs viewer ID 625interactive features 497Interactive mode (Data Analytics) 563Interactive mode (Interactive Crosstabs) 560Interactive Viewer

disabling 496enabling 497integrating crosstab analyzer with 559, 563,

567interactive viewing status 505interest 692, 694interest rates 703interfaces

See also user interfacesinternal rate of return 694, 695IntervalInSeconds element 163IOCacheDBIndexConstraint data type 130IOCacheDefinition data type 130IOCacheState data type 130ipmt method 692iportal URL 248, 254iportal web service connection 289iPortalSecurityAdapter class 210

See also IPSE applicationsiPortalURL parameter 247, 250iportalURL variable 247, 251, 253IPSE applications 210irr method 694isActive function 559IsAdHoc element 153isAdHoc function 317, 327isAscending function 287, 631IsAutoArchiveRunning element 204isAutoSaveEnabled function 259IsBundled element 22, 77, 133isCascadingParameter function 317isChartWithAxes function 368, 372IsColor element 139, 162IsCompoundDoc element 128isConnected function 251isDashboard function 559IsDefaultPrinter element 162isDynamicFilter function 317IsDynamicSelectionList element 154isEnabled function 639

isEnterprise function 212iServer releases 45, 67, 68iServer System. See iHub SystemiserverURL parameter 491iserverURL variable 248, 251, 253isExceptionType function 292, 595IsExecutable element 127IsExecutable property 108isFileTypeAllowed function 213IsHidden element 121, 153isHidden function 327IsInherited element 91isInitialized function 252isInteractive function 505, 560IsLoginDisabled element 195, 196isMultiList function 318IS_MULTISHEET constant 522IsNative element 126IsNative property 108ISNULL function 725IsPassword element 153isPassword function 328IsPrintable element 127IsPrintable property 108IsProgressive element 168IsReportCompleted element 43IsRequired element 121, 127, 153isRequired function 318, 328isSavingNeeded function 260IsSSOEnabled operations 54IsSyncFactory element 168IsSyncJob element 167IsTransient element 158, 168isUsingPersonalDashboard function 260IsViewParameter element 154, 155isViewParameter function 328, 339ItemList element 37, 64IUploadSecurityAdapter interface 212ivMode parameter 563

JJava code 647Java RSSE framework 216

See also RSSE applicationsJavaScript API

designing cross tabs and 548, 549

Page 794: Actuate API Reference - OpenText

776 A c t u a t e A P I R e f e r e n c e

developing with 242JavaScript API class libraries 242, 252JavaScript API class reference 242, 245, 550,

647JavaScript API classes 242, 549JavaScript API function reference 245JavaScript API functions

Interactive Crosstabs 548JavaScript API usage error constants 305, 462JavaScript API usage errors 291, 594JavaScript classes 647JavaScript expressions 647

matching string patterns and 728job attributes 88job condition objects 98job events 118, 120, 131, 142job IDs 140job names 140job owners 158job state attributes 132, 136, 140, 144job status attributes 23, 48job type attributes 131, 140, 144, 164JobAttributes element 40, 42JobAttributes property 39JobCondition data type 130JobCondition objects 98JobEvent data type 131JobEvent element 118, 120JobField data type 131JobId element

CancelJob operations 16GetJobDetails operations 39GetNoticeJobDetails operations 41GetReportParameters operations 45JobEvent type 131JobNotice type 135JobNoticeField type 137JobProperties type 140PrintReport operations 61RunningJob type 168SubmitJob operations 78

JobInputDetail data type 132JobName element

ExecuteReport operations 21JobEvent type 131JobField type 131JobNotice type 136

JobNoticeField type 137JobProperties type 140JobScheduleField type 143PrintReport operations 60SubmitJob operations 74

JobNotice data type 135JobNotice objects 98JobNoticeCondition data type 137JobNoticeCondition objects 98JobNoticeField data type 137JobNotices element 66JobNoticeSearch data type 138JobPrinterOptions data type 139JobProperties data type 140JobProperties objects 98JobRetryInterval element 204JobRetryInterval property 193jobs 4, 8

assigning resource groups to 74, 140cancelling 16, 103deleting 115failing. See failed jobsgetting information about 31, 47, 67getting parameters for 40, 45getting properties for 39getting state of 67pending. See pending jobspreserving status information for 77print operations and. See print jobsprioritizing 74, 140removing resource groups and 20repeating 163retrying 77, 166running 101, 167scheduling 142, 143searching 67, 130, 131, 145selecting 67sending notifications for. See notificationssetting file attributes for 132setting options for 88setting properties for 140setting state 136, 140setting status of 23, 48, 120submitting 73updating schedules for 183, 184

Jobs element 67, 68JobSchedule data type 142

Page 795: Actuate API Reference - OpenText

I n d e x 777

JobScheduleCondition data type 142JobScheduleCondition objects 98JobScheduleDetail data type 143JobScheduleDetail objects 98JobScheduleField data type 143JobScheduleSearch data type 144JobSearch data type 145JobState element 136, 137JobStatus element 131JobType element 131, 140, 144

KKeepOutputFile element 78, 135KeepWorkspace element 133

LLabel class 391Label element 105label elements 391, 501, 518Label objects 391labels (report explorer) 460LagTime element 119LargeImageURL element 127LatestVersionOnly element

CopyFile operations 107DeleteFile operations 114GetFolderItems operations 37MoveFile operations 150SelectFiles operations 63UpdateFile operations 179

launch viewer feature 538layout type constants (parameters) 296, 302LAYOUT_COLLAPSIBLE event 305LAYOUT_GROUP event 305LAYOUT_NONE constant 305LDAP servers 216leading characters 737LEFT function 725LEN function 726LESS_THAN operator 274, 597LESS_THAN_OR_EQUAL operator 274, 597level attribute names 609level attribute objects 609level attributes 606Level class 606level index values 607

level namesgetting 599, 607, 616, 635setting 601, 608, 617, 636

level objects 606LevelAttribute class 609libraries

determining if initialized 252loading JavaScript API class 242running Open Security applications and

16, 219LicenseOption data type 147LicenseOption objects 99LicenseOptions element 51, 53, 225LicenseOptions property 222licensing options (iHub) 51, 147, 200Lightweight Directory Access Protocol. See

LDAP serversLIKE function 727LIKE operator 274, 597line charts 372linear gauge gadgets 362links (Information Console)

See also hyperlinksLinux servers

See also UNIX systemslist boxes 330list controls 122, 153, 330lists

copying files or folders in 106counting parameters in 44displaying parameters and 122filtering file 471getting parameter names in 44returning user preferences in 51searching 471selecting repository contents and 455setting items for folder 483testing values in 724

literal characters 727, 729literal strings 507load function

actuate class 252loading

class libraries 242cross tabs 548data cubes 548Interactive Crosstabs 548

Page 796: Actuate API Reference - OpenText

778 A c t u a t e A P I R e f e r e n c e

JavaScript API library 242report components 246, 252

Locale elementAttachment type 102SOAP headers and 129, 236

Locale property 38locales

converting parameters for 307formatting data for 274getting current 489sending attachments and 102setting 491showing data for 304

LocalExtension element 127LocalServer element 171Location element 160location settings (distribution) 184locks 171log files

tracking error information and. See error log files

tracking usage information and. See usage log files

LogFile element 221logging counters 25, 27logging in to

iHub System 54, 78, 212Login operations

See also SystemLogin operationsdefining 54

Login requestsdisabling 195, 196

loginscustomizing 210getting user information for 211, 212

LoginVolume element 56logout function 252Long data type 147Long objects 98LongDescription element 127LOWER function 727lowercase characters 727

Mmail. See e-mailmain menu 538

Management Consoleenabling features for 203

Manufacturer element 159map rules 710margins

enabling or disabling 534getting Interactive Crosstabs 556, 557getting viewer 499setting Interactive Crosstabs 563, 566setting viewer 506

Match elementFileCondition type 124JobCondition type 131JobNoticeCondition type 137JobScheduleCondition type 142UserCondition type 196UserGroupCondition type 198

MATCH function 728MATCH operator 274, 597matching character patterns 727, 728, 735mathematical operations 740MaxFactory element 165, 172MaxFactory property 72, 79MaxFactoryProcesses element 30MaxFiles element 232MaxJobPriority element 195, 197, 226MaxJobPriority property 222MaxJobRetryCount element 203MaxJobRetryCount property 193MaxNotices element 195MaxPriority element 165MaxPriority property 79MaxRetryCount element 133, 166MaxSyncJobRuntime element 30MaxVersions element

CopyFile operations 107JobInputDetail type 133MoveFile operations 150NewFile type 151

MDS. See Message Distribution serviceMDSInfo data type 147MDSInfo objects 99MDSInfoList element 48MDSIPAddress element 147MDSPortNumber element 147MDSSSLPortNumber element 147Measure class 610

Page 797: Actuate API Reference - OpenText

I n d e x 779

measure index valuesgetting 611, 612, 639setting 613, 614, 640

measure names 612, 614measure objects 610measureDirection parameter 571, 618measures

adding to cross tabs 571, 610changing direction of 572changing order of 579deleting 578editing 574entering expressions for 613filtering data in 601, 602getting aggregate functions for 610getting data type of 611getting direction for 621getting expressions for 611getting index for 611, 612, 639getting level values in 617getting names 612naming 614setting aggregate function for 612setting data type of 613setting direction of 571, 623setting index values for 613, 614, 640sorting values 630

member value objects 615, 616MemberOfGroupId element 200MemberOfGroupName element 200members (cross tabs)

defining values for 615drilling through 589, 591getting level names for 616sorting values 631, 632

MemberValue class 615memory 320menus

enabling or disabling 538, 543Message Distribution service

enabling 173getting names and properties for 48pinging 56setting attributes of 147

messages. See e-mailmetadata

creating dashboards and 261

retrieving 28, 41metadata components 28metadata schemas. See schemasmeter gadgets 362methods 4

See also functionsscripting 647

Microsoft Active Directory servers 216Microsoft NET environments. See .NET

environmentsMicrosoft Windows. See Windows systemsMIME attachments 21MimeType element 111, 118MimeType property 38MinFactory element 165, 172MinPriority element 165MinPriority property 79minutes 714, 720mirr method

Finance class 695mirror column starting level

getting 619setting 572, 618, 622

mirror row starting levelgetting 621setting 571, 618, 623

missing files or folders 180MOD function 729mode attributes (Ping) 57Mode element 57Model element 160modified internal rate of return 695modulus 729MonitoredFilePath element 124monitoring counters 25, 27monitoring tools

See also performance monitoringMONTH function 730Monthly data type 147Monthly element 143months

adding to date values 715calculating number of 720returning 730

mouse scrolling 524, 525move columns feature 538MoveFile element 90

Page 798: Actuate API Reference - OpenText

780 A c t u a t e A P I R e f e r e n c e

MoveFile operations 149multi-clue parameters 306multilingual reports. See localesmulti-list UI elements 318multiplication operator 740multi-select parameters 332multisheet render option 522multi-volume environments 7MutexClass element 127

NName element

ColumnSchema type 105CopyFile operations 107DeleteFile operations 114DeleteFileType operations 115DeleteResourceGroup operations 20DeleteUser operations 117DeleteUserGroup operations 118FieldDefinition type 121File type 122, 124FileInfo type 235FileType type 126GetResourceGroupInfo operations 45InstallApp operations 54LicenseOption type 147MoveFile operations 149NameValuePair type 150NewFile type 150ObjectIdentifier type 151ParameterDefinition type 152ParameterValue type 155Printer type 159PropertyValue type 163, 224ResourceGroup type 164SelectFiles operations 63SelectFileTypes operations 64SelectUserGroups operations 70SelectUsers operations 70Stream type 174UpdateFileType operations 182UpdateUser operations 187UpdateUserGroup operations 188User type 194, 225UserField type 196UserGroup type 197

UserGroupField type 198Volume type 203

name element 105Name property 108NameList element

CopyFile operations 106DeleteFile operations 114DeleteFileType operations 115DeleteUser operations 117DeleteUserGroup operations 117MoveFile operations 149SelectFiles operations 63SelectFileTypes operations 64SelectUserGroups operations 69SelectUsers operations 70UpdateFileType operations 182UpdateUser operations 187UpdateUserGroup operations 188

namesSee also user namesdefining file types and driver 127duplicating 109, 149getting administrator 225getting parameter 44, 154getting translated role 52, 218setting volume 203

namespace 242name-value pairs 150, 163, 224nameValueArray variable 306NameValuePair class 310NameValuePair data type 150NameValuePair objects 99naming

configuration templates 171data types 177Encyclopedia volumes 203files 122, 150folders 108, 458iHub servers 170parameters 152, 155printers 161, 203report designs 507, 508, 565report documents 303, 507, 508, 565report files 469, 481reports 8resource groups 164user groups 197

Page 799: Actuate API Reference - OpenText

I n d e x 781

users 194naming restrictions. See case sensitivitynative file types 126NAV_FIRST constant 305, 462navigate function 298navigation bars 297navigation buttons 298navigation constants 305, 462navigation feature (page) 539navigation links 305, 462NAV_LAST constant 305, 462NAV_NEXT constant 305, 462NAV_PREV constant 305, 462negation 730net present value 697NeverExpire element 91, 133NewFile data type 150NewFile element 62, 79next function 285NextStartTime element 141, 144nll element 111, 178NodeLockViolation element 171NodeLockViolationExpirationDate element

171nodes. See cluster nodesNoEvent element 120NON_DASHBOARD constant 510non-native reports. See third-party reportsnon-null values 731Normal mode (Ping) 57NOT function 730NOT_BETWEEN operator 275, 597NOT_EQ operator 275, 597notification groups

deleting 115notification headlines 136notifications 8

deleting 116expiring 204getting list of users for 219getting parameters for 43getting properties for 41, 66overriding preferences for 61print operations and 60searching 66, 137, 138sending 75sending attachments with. See attachments

setting attributes of 135setting number sent 142

NotifiedChannelId elementGetNoticeJobDetails operations 42JobNotice type 136JobNoticeSearch type 138JobScheduleSearch type 145JobSearch type 146

NotifiedChannelName elementGetNoticeJobDetails operations 42JobNotice type 136JobNoticeSearch type 138JobScheduleSearch type 145JobSearch type 146

NotifiedUserId elementJobNotice type 136JobNoticeSearch type 138JobScheduleSearch type 145JobSearch type 146

NotifiedUserName elementJobNotice type 136JobNoticeSearch type 138JobScheduleSearch type 145JobSearch type 146

NotifyChannels element 40, 42NotifyChannels property 39, 41NotifyChannelsById element 61, 76NotifyChannelsByName element 60, 75NotifyCount element 132, 142NotifyGroups element 40, 42NotifyGroups property 39, 41NotifyGroupsById element 61, 76NotifyGroupsByName element 60, 75NotifyUsers element 40, 42NotifyUsers property 39, 41NotifyUsersById element 60, 76NotifyUsersByName element 60, 75NOT_IN operator 275, 597NOT_LIKE operator 275, 597NOT_MATCH operator 275, 597NOTNULL function 731NOT_NULL operator 275, 597NOW function 731nper method 696npv method

Finance class 697NULL operator 275, 597

Page 800: Actuate API Reference - OpenText

782 A c t u a t e A P I R e f e r e n c e

null value data type 89, 178null value flag 154, 155null values

assigning to parameters 331, 342, 521, 629authentication and 247getting 325, 338, 521subtotals and 580testing for 275, 597, 628, 725

num argument 698number of periods (annuities) 696NumberOfCopies element 139, 161, 162numberPayPeriods argument

fv method 691ipmt method 693pmt method 699ppmt method 700pv method 702rate method 704

numberscomputing percentages of 698

NumBytes element 58numeric data types 112, 177numeric values

defining as double 118defining as integer 130defining as long 147defining as short 174dividing by non-zero values 729filtering 274getting square root of 736returning absolute 713rounding 718, 733, 734setting conditions for 724specifying precision for 113testing equality of 725, 740testing range of values for 717

OObject element

CubeExtraction operations 18DataExtraction operations 19GetBookmarks operations 25GetCustomFormatData operations 28GetJavaReportEmbeddedComponent

operations 37GetJavaReportTOC operations 38

GetMetaData operations 41GetPageCount operations 43GetPageNumber operations 43GetParameterPicklist operations 44SaveTransientReport operations 62SelectJavaReportPage operations 65

object IDs 151See also ObjectId element

object types 528, 545ObjectId element

CancelReport operations 16ExecuteReport operations 23GetSyncJobInfo operations 48PendingSyncJob type 158RunningJob type 167WaitForExecuteReport operations 80, 81

ObjectIdentifier data type 151objects

as input parameters 306expiring 91getting bookmarks for 25getting custom formats for 28getting data from 19searching 126selecting viewer content and 526, 558setting privileges for 222

ODBC databases 59OFFLINE element 172OnceADay element 89, 110, 148, 205ON_CHANGE_COMPLETED constant 309ON_CHANGED constant 309ON_CONTENT_CHANGED constant 514,

592ON_CONTENT_SELECTED constant 514,

592ON_CONTENT_SELECTED event 526OnDay element 148on-demand report generation. See

synchronous jobsON_DIALOG_OK constant 514ON_EXCEPTION constant

Dashboard class 268Parameter class 309ReportExplorer class 463Viewer class 514XTabAnalyzer class 592

ON_EXCEPTION event 545

Page 801: Actuate API Reference - OpenText

I n d e x 783

online analytical processing servers. See OLAP servers

ONLINE element 172online help

See also helpOnlineBackupSchedule property 52OnlineOnly element 48onRender events 6ON_SELECTION_CHANGED constant 309,

463ON_SESSION_TIMEOUT constant

Dashboard class 268Parameter class 309ReportExplorer class 463Viewer class 514XTabAnalyzer class 592

onUnload functionDashboard class 260Parameter class 299ReportExplorer class 457

OnWeekDay element 148Open Security cache 186Open Security library 16, 219Open Security web service 71, 203open server drivers 57open server options 22open server reports 77OpenInfoObject operations 56opening

connections 250reports 507, 508

OpenSecuritySelectGroupsOfUser element 203

OpenSecuritySelectUsersOfRole element 203OpenSecuritySelectUsersOfUserGroup

element 203OpenServerOptions data type 152OpenServerOptions element 22, 77Operand1 element 111Operand2 element 111Operand3 element 111operating systems 173Operation element 75, 111operations

administration. See Administrate operations

archiving files and. See archiving operations

login. See Login operationsrunning RSSE applications and 216searching. See search operationsupdating files and. See update operations

Operator element 121, 225operator lists 326Operator user groups 121OperatorList element 154operators (ad hoc parameters) 154operators (EasyScript) 739operators (filter expressions) 274, 276, 277,

596Options class 618Options element 118OR operator 740OrgID element 217Orientation element

JobPrinterOptions type 139Printer type 160PrinterOptions type 161

OrientationOptions element 160OSVersion element 173output

attaching to e-mail 76converting 29, 74formatting. See output formatslinking to 76saving 22viewing PDF 203

Output element 220output file access types 40output file names 22output file types 23, 81, 127output files

creating job notifications and 76executing jobs and 75, 132, 141, 185formatting content 22getting access rights to 40saving 78, 135setting size of 141

output formatsconverting report documents and 29, 73displaying reports and 65, 201exporting reports and 496sending e-mail attachments and 77

Page 802: Actuate API Reference - OpenText

784 A c t u a t e A P I R e f e r e n c e

output messagesSee also responses

output parameters 184, 220OutputFileAccessType element 40, 43OutputFileName element 136, 137OutputFileSize element 132, 141OutputFileType element 23, 81OutputFileVersion element 136OutputFileVersionName element

JobInputDetail type 132JobNotice type 136JobProperties type 141

OutputFormat elementDataExtractionFormat type 111DocumentConversionOptions type 118ExecuteReport operations 22GetDocumentConversionOptions

operations 29SelectJavaReportPage operations 65

OutputMaxVersion element 132OutputParameter element 16OutputProperties element 66OutputType element 127OutputType property 108OverrideRecipientPref element 61, 76, 134Owner element

File type 123, 125FileInfo type 235FileSearch type 125JobField type 131JobProperties type 140JobScheduleField type 144JobSearch type 146PendingSyncJob type 158RunningJob type 168

Owner property 36OwnsVolume element 170

Ppage break editing feature 539page break intervals 620, 621, 622page break status 620page breaks 620, 623page components

accessing report elements in 516adding Flash objects to 357, 361

adding tables to 401, 449adding text elements to 392, 452creating cross tabs and 555, 576, 625displaying charts and 346, 348, 379displaying data and 353getting content from 500, 555getting current number for 500getting Flash objects in 517, 518linking to 538navigating to specific 305, 462, 505, 539

page content objects 516, 625page counts

files 466, 469reports 43, 503, 557

Page element 65page-level security 216, 219

See also page security applicationPage Level Security feature (BIRT) 56Page Level Security licensing option 216page navigation constants 305, 462page navigation feature 539page numbers 43, 152, 500page position (viewer) 504page ranges 139, 152, 496, 499PageContent class 516, 625PageCount element 43, 122, 124, 141, 235PageCount property 37PageIdentifier data type 152PageNum element 152PageNumber element 44PageRange element 139PageRef element 65pages

counting file 466counting report 43, 503, 557numbering 152retrieving 65setting range of 139, 152setting size 139, 160, 162

PageSecureViewing feature 56PageSize element 139, 160, 162PageSizeOptions element 160paper orientation 139, 160, 161paper size 49, 139paper trays 139, 161, 162PaperLength element 139PaperTray element 139, 161, 162

Page 803: Actuate API Reference - OpenText

I n d e x 785

PaperTrayOptions element 161PaperWidth element 139Parameter class 294, 305parameter components 252, 294parameter control type UI values 314parameter control types 324, 330parameter convert utility class 306parameter definition data type 152parameter definition names 326parameter definition objects 99, 295, 312, 320parameter definitions

creating 152, 320displaying parameters and 310, 335entering passwords and 328, 333exporting 24getting auto suggest threshold for 323getting column names for 323getting control type for 324getting data type for 324getting default values for 325getting display names for 324, 325getting help text for 326getting name-value pair for 327getting operator list for 326getting required parameters for 328getting values for 327naming 333retrieving 24selecting report parameters and 327, 334setting auto suggest threshold for 329setting column names for 329setting column type for 329setting control type for 330setting data type for 330setting display names for 330, 331setting help text for 332setting multiple values for 332setting name-value pairs for 334setting required parameters for 333specifying data type returned by 323specifying default values for 331storing position of 326, 334

parameter events 299parameter files

See also data object values files; report object value files

parameter global constants 305

parameter group definitions 152parameter group names 297, 302parameter groups

creating 320, 331, 340displaying 302expanding 301hiding parameters in 298returning 325, 337

parameter index values 334parameter layout type constants 296parameter lists

changing values in 309defining name-value pairs for 310, 334getting auto suggest threshold for 323getting name-value pair for 327getting parameter names in 44getting parameter position in 338returning 45selecting values in 122, 153setting auto suggest delays for 300setting auto suggest threshold for 329setting column names for 339, 521setting column type for 339setting fetch size of 301setting length of 301setting parameter position in 341

parameter maps 307parameter names

getting cascading 323getting for specific value 337, 520getting from cross tabs 627getting from data objects 315getting from lists 44setting 329, 341, 628specifying display names for 153, 155

parameter objects 294, 299, 303parameter page components 252parameter pages

changing 298displaying parameter definitions and 331displaying parameters and 294, 305, 320enabling 539getting group names for 297getting layout type for 296hiding navigation bar for 297loading 252navigating through 298, 305

Page 804: Actuate API Reference - OpenText

786 A c t u a t e A P I R e f e r e n c e

rendering content for 294, 300setting fonts for 302setting layout of 302

parameter panels 511parameter types 164parameter value objects 335, 520, 627parameter values files. See data object values

files; report object value filesParameterData class 312ParameterDefinition class 320ParameterDefinition data type 152ParameterDefinition objects 99, 295, 312, 320ParameterFile element 18ParameterFileId element 141, 144ParameterFileName element 141ParameterList element

ExportParameterDefinitionsToFile operations 24

ExtractParameterDefinitionsFromFile operations 24

GetFileTypeParameterDefinitions operations 36

GetReportParameters operations 45ParameterName element 44ParameterPickList element 44parameters

See also report parametersaccessing result sets and 284adding to HTML containers 294adding to viewer component 306authenticating web services and 247converting values 306customizing 247defining dynamic filters. See dynamic filter

parametersdefining scalar 121, 169determining type 317, 327filtering data and 274generating query output and 329, 339getting cross tab 556getting custom URL 490getting file type 36getting job specific 40getting viewer 520, 521handling events for 299, 309initializing HTTP sessions and 250linking to web services 303

localizing 304performing garbage collection for 299prompting for input and 320, 338, 341retrieving data and 312returning Interactive Crosstabs 627running jobs and 75, 185running reports and 297, 507submitting requests for 304, 335

ParameterValue class 335, 520, 627ParameterValue data type 155ParameterValue objects 99, 307ParameterValueFileId element 75ParameterValueFileName element 75ParameterValueList element 18ParameterValues element 22, 75ParameterValuesFile element 18ParameterValuesFileId value 22ParameterValuesFileName value 22paramValues variable 308parent parameters 323parentname variable 323ParentUserGroupId element 199ParentUserGroupName element 199PartitionName element 58partitions 23, 58PassThrough message 16PassThrough operations 219pass-through security 217Password element 55, 194, 217password parameter 247Password property 59passwords

changing 195creating system 78creating user 55, 194encrypting 333external security systems and 216getting 211, 328requiring 153

path commands (SVG) 388path function 388PathInformation element 203paths

dashboard templates 259, 265Report Explorer 460temporary files 5

pattern matching 727, 728, 735

Page 805: Actuate API Reference - OpenText

I n d e x 787

pattern operators 274, 275Payload element 59PDF documents

setting viewing quality of 203PDF formats 202, 496PdfQuality element 203Pending element 48, 120pending job attributes 31pending job status 120pending jobs 31, 158PendingSyncJob data type 158PendingSyncJob objects 99PendingSyncJobs element 30, 33PendingSyncJobsResultDef element 31PendingTime element 158percent (%) character 727percent method 698percentages 698

calculating 740PercentTransientReportCacheInUse element

30performance 320period (.) character

pattern matching 728Permission data type 159, 224Permission element 233Permission objects 99Permission type 237permissions. See privilegesPermissions property 80persistent connections 167personal dashboards 260, 266pick lists. See selection listspie chart sectors 372pie charts 372Ping operations 56Ping requests 56, 57Ping responses 59pivot function 577pivotChart function 372pixel values (viewer) 499plug-in extensions. See extensionsPMD. See Process Management DaemonPmdPortNumber element 171pmt method 699PollingDuration element 119PollingInterval element

Event type 119JobInputDetail type 134

port numbers 59ports 147Position element 152, 155PostScript formats 496PowerPoint formats 202, 496ppmt method 700PPT formats. See PowerPoint formatsPrecedingParameterValues element 44Preference element 51, 73PreferenceName element 51PreferenceNameList element 51preferences (users). See user preferencespreferences (viewer) 195, 197, 222present value (annuities) 701presentValue argument

fv method 692ipmt method 693nper method 696pmt method 699ppmt method 701rate method 704

principal (annuities) 700print dialog 511print jobs

See also printingcreating 60preserving status information for 77retrying 61, 77, 166scheduling 60, 73setting printer options for 60, 139setting priority for 60, 74updating 184

print requests. See print jobsprint to file property 139Printer data type 159Printer objects 100printer option objects 100printer options 60, 139, 161printer settings. See printer optionsPrinterName element 48, 52, 139, 161PrinterOptions data type 161PrinterOptions element

GetJobDetails operations 40GetNoticeJobDetails operations 42GetUserPrinterOptions operations 52

Page 806: Actuate API Reference - OpenText

788 A c t u a t e A P I R e f e r e n c e

GetVolumeProperties operations 53PrintReport operations 60SubmitJob operations 75

PrinterOptions objects 100PrinterOptions property 39, 41, 52printers

defining attributes for 159getting information about 48getting settings for 51naming 161, 203setting options for 60, 139, 161specifying default 162updating options for 194updating user list for 192

Printers element 49printing

reports 60, 511, 539specific page ranges 139to files 139

printing requests. See print jobsPrintReport operations 60PrintToFile element 139prioritizing jobs 74, 140Priority element

JobField type 132JobProperties type 140JobScheduleField type 144PrintReport operations 60SubmitJob operations 74

private access type 40, 123Private element 123private files 123, 151, 234, 465, 468privilege attributes 159, 224privilege filter objects 484privilege filters

creating 484getting 477setting 480setting attributes of 162

PrivilegeFilter class 484PrivilegeFilter data type 162PrivilegeFilter element 126privileges

assigning to files or folders 192assigning to users or groups 159, 162, 224,

470assigning to users or roles 237

changing file or folder properties and 181getting user 467revoking 192searching for 126testing 162updating 181, 186

PrivilegeTemplate element 226process IDs 58Process Management Daemon port 171ProcessID element 58ProductFamilies element 51, 53, 62, 109ProductFamily element

GetUserExtendedProperties operations 50GetUserGroupExtendedProperties

operations 50GetUserPreference operations 51SetUserExtendedProperties operations 72SetUserGroupExtendedProperties

operations 73SetUserPreference operations 73

profiles (volume) 490, 492progressive viewing 22, 168ProgressiveViewing element 22prompt text 316PromptParameter element 155prompts 155, 320, 338, 341properties

channels 178charting applications and 533connections 26, 71, 217, 223Encyclopedia volumes 193file details operations 35file type 108file update operations 179file upload operations 79folder items 36JavaScript expressions and 647jobs 39, 140Message Distribution service 48notifications 41, 66output 74report parameters 307resource groups

getting 46setting 72, 165updating 72, 79

RSSE applications 223, 226

Page 807: Actuate API Reference - OpenText

I n d e x 789

scripting for 647search results 66users 187, 191, 217, 219volumes 52

Properties elementCubeExtraction operations 18DataExtraction operations 19GetUserExtendedProperties operations 50GetUserGroupExtendedProperties

operations 50SetUserExtendedProperties operations 72SetUserGroupExtendedProperties

operations 73property name-value definitions 163, 224PropertyName element 50PropertyNameList element 50PropertyValue data type 163, 224PropertyValue objects 100ProviderName element 233publishing

reports 4PurgeUserInfo element 117purging. See deletingpv method 701

QQUARTER function 732quarters

adding to date values 715calculating number of 721returning number for 732

queriesfiltering data cubes with 19running ad hoc 323running dynamic filter 323setting column names for 329setting column types for 329, 339

Query elementGetJobDetails operations 40

QueryPattern element 220question mark (?) character 728, 735queue 30, 158QueuePosition element 158QueueTimeout element 158

Rradio buttons 153, 330Range data type 163Range element 152range of values

testing values in 717, 740rate argument 698rate method 703ratePerPeriod argument

fv method 691ipmt method 693nper method 696pmt method 699ppmt method 700pv method 702

RCP Report Designer packageSee also BIRT RCP Report Designer

read privilege 159, 238ReadFile action 57read-only parameters 303Record data type 163RecordDefinition element 154RecordFailureStatus element 61, 77, 135records 126, 146, 201

See also rowsRecordSuccessStatus element 61, 77, 135rect function 388rectangles 386, 388recurring jobs 163Recursive element

CopyFile operations 106DeleteFile operations 114GetJavaReportTOC operations 38MoveFile operations 149SelectFiles operations 63UpdateFile operations 179

RedirectPath element 203redo feature 544redraw function 368, 379referencing

report files 464registerEventHandler function

Dashboard class 261Parameter class 299ReportExplorer class 457XTabAnalyzer class 560

Page 808: Actuate API Reference - OpenText

790 A c t u a t e A P I R e f e r e n c e

reinvestmentRate argument 695RelayState element 54remainders 729remote databases 59remove function 376, 380RemoveArchiveRules element 181RemoveChannelNotificationById element

185RemoveChannelNotificationByName

element 185RemoveChildRolesById element 190RemoveChildRolesByName element 189RemoveDependentFilesById element 180RemoveDependentFilesByName element 180removeDimension function 577removeEventHandler function

Dashboard class 261Parameter class 299ReportExplorer class 457XTabAnalyzer class 560

RemoveFileCreationPermissions element 192RemoveFromGroupsById element 192RemoveFromGroupsByName element 191removeGroup function 447RemoveGroupNotificationById element 185RemoveGroupNotificationByName element

184RemoveLicenseOptions element 193removeMeasure function 578RemoveOutputFilePermissions element 185RemoveParentRolesById element 190RemoveParentRolesByName element 189RemoveRequiredFilesById element 181RemoveRequiredFilesByName element 180removeSeries function 368RemoveUserNotificationById element 185RemoveUserNotificationByName element

184removing. See deletingrender function 380render options 522render options map 522renderContent function 261, 300Renderer class 384Renderer objects 384, 386, 389rendering

cross tabs 567

dashboard content 261HTML5 charts 380parameter components 294, 300

RenderOptions class 522reorderDimension function 578reorderMeasure function 579Repeat data type 163Repeat element 89, 110, 148, 205ReplaceExisting element 107, 150ReplaceLatestDropDependency element 201ReplaceLatestIfNoDependents element 201ReplaceLatestMigrateDependency element

201ReplaceLatestVersion element 132Reply element 59report classes 244report components. See componentsreport content objects 279report design engine classes

See also Design Engine APIreport design files

getting parameters from 45naming 507, 508, 565

report design save feature 540report designs

committing changes to 554saving 540saving viewer content as 505

report document filesgetting names 297naming 303, 507, 508, 565

report document save feature 540report documents

See also reportsdownloading 20getting embedded components in 37getting parameters for 45getting table of contents for 38running Interactive Crosstabs and 548saving 506, 540

report element IDs 352report element types 528report elements

adding 516displaying charts and 343, 364, 383displaying data and 353displaying text and 391, 451

Page 809: Actuate API Reference - OpenText

I n d e x 791

getting bookmarks for 500, 504getting from viewer 500getting type 528handling exceptions for 545, 594retrieving result sets and 280selecting 528setting bookmarks for 282submitting requests for 393, 454

Report Encyclopedia. See Encyclopedia volumes

report execution requests. See ExecuteReport operations

report explorer. See ReportExplorer components

report filesSee also files; specific report file typebundling 22, 77, 133deleting 114, 230downloading 20exporting 127getting access rights to 33getting names 297, 466, 502getting parameters from 24, 45getting security roles for 27moving 86, 149naming. See file namesreplacing 150, 151returning information about 63returning list of 63returning location of 36searching for 123, 125, 473selecting 455setting access rights for 151setting privileges for 123, 181, 185setting version for 123, 125, 150, 201submitting jobs for 75updating 179uploading 79

report gadgets 270report generation requests

cancelling 103getting status of 16, 23, 80retrying 166setting status attributes for 120setting wait intervals for 23submitting jobs for 75

report items

developing 647displaying 537

report object value filescreating 17, 22exporting parameter definitions in 24generating reports from 75retrieving parameters in 24, 45

report objects. See reportsreport parameter files

See also data object values files; report object value files

report parametersSee also parametersassigning data types to 121, 152, 330, 340binding to data sources 112changing 294, 309, 320creating help text for 154defining 152determining if required 318, 328downloading 295, 296enabling auto collection for 127exporting definitions 24getting control type for 314getting data type of 324, 337getting definitions for 24, 45getting display names for 337getting file names for 297getting values for 45, 270, 338hiding 121, 298, 328, 332naming 152, 155, 628overwriting default values 22prompting for 155, 338restricting values for. See cascading

parametersretrieving 303selecting 301, 316, 327, 334setting control type attributes for 122, 153setting display names for 340setting properties for 307setting values for 155, 335, 520, 629specifying as read-only 303specifying default values for 153, 331specifying multiple values for 332specifying null values for 342, 521, 629specifying required 153, 333testing for null values in 628viewing 294, 320

Page 810: Actuate API Reference - OpenText

792 A c t u a t e A P I R e f e r e n c e

writing to files 17, 22, 141writing to information objects 112, 152

Report Server Security Extension 216See also RSSE applications; RSSE API

report servers. See iHub serversreport status attributes 16, 23, 120report template files 258report titles 503ReportContent class 279ReportContent objects 279ReportExplorer class 455ReportExplorer components

getting file descriptions for 465getting files for 465, 466, 467getting folders for 456getting latest items 456getting results definitions for 456getting timestamps for 467getting user information for 484handling events for 457, 463instantiating 455loading 252retrieving data for 459searching for items for 457, 459, 471, 473setting container for 458setting file descriptions for 468setting file names for 469setting file types for 468setting file version for 470setting folder names for 458setting folder paths for 460setting items displayed in 460setting labels for 460setting latest version flag for 458setting results definitions for 459setting target service URL for 459setting timestamps for 470submitting requests for 460viewing report items and 455

ReportExplorer event constants 463ReportExplorer global constants 462ReportFileId element 45ReportFileName element 45ReportGeneration feature 56reporting system. See iHub SystemReportlet format 202Reportlet gadgets 270

Reportletsgetting bookmarks for 502scaling 202setting bookmarks for 508setting document mode for 565

ReportParameters element 40, 43ReportParameters property 39, 42ReportParameterType data type 164ReportParameterType element 45reports

adding data items to 351adding Flash objects to 355building security applications for 216cancelling 16changing 535converting output for 29, 73, 118counting pages in 43, 503, 557downloading 279, 496exporting 496, 510, 535getting embedded components in 37getting name of transient 297getting parameters for 45, 294getting status of 80getting user information for 484getting version of 467hiding data in 353naming 8navigating through 505, 513, 539opening 507, 508printing 60, 511, 539publishing 4reloading 514retrieving content from bookmarks 498retrieving data from 289retrieving parameters from 297, 303retrieving specific pages 496, 499, 500, 504running 21saving 22, 62selecting content in 514, 526sending as attachments. See attachmentssetting locale for 491setting page breaks for 539setting page numbers for 152setting parameters for 507setting version information for 470submitting requests for 73suppressing duplicate values in 541

Page 811: Actuate API Reference - OpenText

I n d e x 793

viewing hidden elements in 358viewing table of contents for 529, 530, 542

ReportType element 164repositories

See also Encyclopedia volumesdisplaying content 455getting type 211

repository access rights 485, 486repository file paths 259repository types 489, 491REPOSITORY_ENCYCLOPEDIA constant

491REPOSITORY_STANDALONE constant 491Request class 280Request element 173request objects 280RequestedHeadline element 142RequestedOutputFile element 22, 75RequestedOutputFileName element 141, 145,

146RequestID element 129, 237RequestName element 224RequestOptions class 488RequestOptions objects 254, 488requestOptions parameter 247, 250requests

See also SOAP messagesadding filters to 282adding Flash objects and 358, 363adding sorters to 283authenticating 488displaying charts and 349displaying cross tabs and 549displaying dashboards and 266displaying reports and 512displaying tables and 449downloading result sets and 497failing 254getting bookmarks for 281getting options for 249retrieving data and 280, 354retrieving parameters and 304, 335retrieving printer information and 48retrieving report elements and 393, 454routing to alternate MDS 48running Interactive Crosstabs and 568

required parameters 153, 318, 328, 333

required passwords 153RequiredFileId element 125requiredFileId value 477, 481RequiredFileName element 125requiredFileName value 477, 481Reserved element 165Reserved property 79reset function 561resizeTo function 561resizing

columns 534Interactive Crosstabs 561, 562, 567rows 540viewers 265, 498, 501, 509

Resolution element 139, 160, 162ResolutionOptions element 160resource group objects 100resource groups

assigning to jobs 74, 140binding to iHub servers 165, 171configuring 72creating 18, 164deleting 20getting information about 45, 47getting list of 46getting properties for 46naming 164running jobs and 164setting priority for 165setting properties for 72, 165specifying as reserved 79, 165updating 72, 79

ResourceGroup data type 164ResourceGroup element

CreateResourceGroup operations 18GetResourceGroupInfo operations 46JobProperties type 140RunningJob type 168SubmitJob operations 74UpdateResourceGroup operations 79

ResourceGroup objects 100ResourceGroup property 40, 42ResourceGroupName element 171ResourceGroupSettings data type 165ResourceGroupSettings objects 100ResourceGroupSettingsList element

CreateResourceGroup operations 18

Page 812: Actuate API Reference - OpenText

794 A c t u a t e A P I R e f e r e n c e

GetResourceGroupInfo operations 46UpdateResourceGroup operations 79

ResourcePath element 204responses

See also SOAP messagesattaching files to 22retrieving printer information and 48, 52setting wait intervals for 23

REST APIauthentication token 489, 491

result set names 166result set objects 284, 497result set schema objects 100result set schemas 19, 28, 41, 166result sets

See also queries; search resultsaccessing data in 284creating 284downloading 289, 497, 511getting content in 285incrementing data rows for 285referencing 284retrieving data for 280, 284, 289sorting values in 283, 286

ResultDef elementGetFileDetails operations 35GetFolderItems operations 36GetJobDetails operations 39GetNextExpiredFiles operations 231GetNoticeJobDetails operations 41GetUserProperties operations 219GetVolumeProperties operations 52SelectFiles operations 63SelectFileTypes operations 64SelectJobNotices operations 66SelectJobs operations 67SelectJobSchedules operations 68SelectUserGroups operations 69SelectUsers operations 70

ResultSet class 284ResultSet objects 284, 497ResultSetDisplayName element 166ResultSetName element 166ResultSetSchema data type 166ResultSetSchema element 19ResultSetSchema objects 100RetryInterval element 133, 166

RetryOption element 133, 166RetryOptions data type 166RetryOptions element 61, 77RetryOptionType data type 166ReturnCode element 16, 220RevokePermissions element 181RevokeUserGroupCapabilities operations 61RevokeUserGroupCapabilitiesResponse

element 61RevokeUserGroupProductAccess operations

62RevokeUserGroupProductAccessResponse

element 62rich text formats 202RIGHT function 732Role data type 167role IDs 190, 485, 486role names 218, 485, 486RoleCondition data type 167RoleField data type 167RoleId element 26, 71, 159RoleList element 186RoleName element

DoesRoleExist operations 217GetConnectionProperties operations 26Permission type 159, 224, 237SelectUsers operations 221, 223SetConnectionProperties operations 71

RoleNames element 27roles 6, 7

assigning privileges 159, 224, 237deleting 189getting external user 52, 218, 221getting file-specific 27mapping external users to 218, 225reassigning 189searching 68, 220testing for external 217translating 218

Roles elementSelectRoles operations 220SelectUserGroups operations 70UserAndProperties type 226

RoleSearch data type 167rollback function 561ROUND function 733ROUNDDOWN function 733

Page 813: Actuate API Reference - OpenText

I n d e x 795

rounding 718, 733, 734ROUNDUP function 734RoutedToNode element 132, 141.rov files. See report object value filesrow index values

getting 281, 282retrieving table data and 401, 576setting 283

row mirror starting levelgetting 621setting 571, 618, 623

row objects 96ROW_AXIS_TYPE constant 586rowMirrorStartingLevel parameter 571, 618rowPageBreakInterval parameter 618rows

adding to cross tabs 576, 621adding to tables 401getting first 282getting index values for 281, 282getting last 281grouping 402iterating through 285resizing 540retrieving result sets and 283, 285retrieving specific sets of 275returning from information objects 130setting attributes of 111setting index values for 283setting page breaks for 623setting page breaks on 621, 624

RPCs. See remote procedure callsrptdesign format

See also report design filesrptdocument format

See also report document filesRSSE API 216RSSE API data types 223RSSE API libraries 16, 219RSSE API operations 216RSSE applications

See also Report Server Security Extensioninitializing 221logging in to iHub System and 55registering external users for. See external

user registrationrunning as web service 216

setting user properties for 226stopping 223

RSSEVersion element 222RTF formats 202rules

EasyScript expressions and map 710rules. See archiving rulesrun requests. See report generation requestsRunAsUser element 55RunLatestVersion element 75, 141running

Interactive Crosstabs 548JavaScript API library 242jobs 101, 167reports 21

Running element 48RunningJob data type 167RunningJob objects 101RunningJobs element 30, 33RunningJobsResultDef element 32RunningSyncJobs element 30RunningTime element 168RunOn element 89, 148, 205

SsalvageValue argument 690, 705, 706SAMLRequest element 54SAMLSessionIndex element 56SAMLToken element 55sample report document 549save function 262SaveOutputFile element 22saveReportDesign function 505saveReportDocument function 505SaveSearch operations 62SaveTransientReport operations 62saving

dashboards 259, 260, 262output files 78, 135report designs 540report documents 506, 540reports 22, 62temporary files 62, 133viewer content 505, 506

Scalable Vector Graphics 509, 566

Page 814: Actuate API Reference - OpenText

796 A c t u a t e A P I R e f e r e n c e

Scalable Vector Graphics elements 384, 385, 387

scalar parameters 121, 169ScalarDataType data type 169Scale element 139, 160, 162ScaleOptions element 160scaling factor (printer) 139, 160scaling options 160ScalingFactor element 202scatter charts 372schedule attributes 88schedule type attributes 143scheduled jobs 20, 67

See also jobsScheduleDetails element 142ScheduleEndDate element 143schedules

deleting 116getting information about 67running print jobs and 60, 73running reports and 75searching 68, 142, 143, 144setting archiving 194setting frequency 110, 147, 204updating 183, 184

Schedules elementGetJobDetails operations 40GetNoticeJobDetails operations 42PrintReport operations 60SubmitJob operations 75

Schedules property 39, 41ScheduleStartDate element 143ScheduleType element 143scheduling jobs 142, 143schema objects 95, 100schemas

See also WSDL schemascolumn values and 112cube metadata and 28information objects and 129result sets and 166

script tag 242scripting reference 647scripts

financial methods in 690–707formatter methods in 708

scroll bars 513

scroll controls 524scroll panels 524scrolling 524, 529ScrollPanel class 524search conditions

entering special characters in 124finding users and 196, 198, 200getting 474, 475matching character patterns and 124, 131,

137, 196moving files and 149retrieving files and 125, 471retrieving job schedules and 142, 143, 144setting 123, 478specifying multiple 478

search criteria. See search conditionsSearch element

CopyFile operations 106DeleteFile operations 114DeleteJob operations 115, 116DeleteJobNotices operations 116DeleteUser operations 117DeleteUserGroup operations 117GetFolderItems operations 37MoveFile operations 149SelectFiles operations 63SelectFileTypes operations 64SelectJobNotices operations 66SelectJobs operations 67SelectJobSchedules operations 68SelectUserGroups operations 69SelectUsers operations 70UpdateJobSchedule operations 183UpdateUser operations 187UpdateUserGroup operations 188

search expressionscase sensitivity and 723string patterns in 727, 728wildcard characters in 735

SEARCH function 735search operations

See also searchingassigning FileSearch objects to 459comparing field values and 471getting FileSearch objects for 457retrieving external user information and

220

Page 815: Actuate API Reference - OpenText

I n d e x 797

setting conditions for. See search conditions

search resultscounting records for 126, 146, 201retrieving number of items in 64, 71setting CSV options for 66

searchingSee also search operationsfiles 64, 123, 125, 473jobs 67, 130, 131, 145list items 471notifications 66, 137, 138schedules 68, 142, 143, 144security roles 68, 220user groups 198users 70, 196, 200, 220

SearchReport operations 62SearchReportByIdList data type 169SearchReportByIdNameList data type 169SearchReportByNameList data type 170SearchResultProperty data type 170seconds 716, 721secure read privilege 159, 238security 210security adapter class 210security adapters 212–213security applications 216security credentials. See credentialssecurity integration options 203security manager 210security roles 6, 7security roles. See rolesSecurityIntegrationOption element 203select function 376, 380SelectChannels operations 62SelectedContent class 526SelectFiles operations 63SelectFileTypes operations 64SelectGroups operations 65selection list flag 154selection lists 44, 316SelectJavaReportPage operations 65SelectJobNotices operations 66SelectJobs operations 67SelectJobSchedules operations 67SelectNameValueList element 122, 154SelectPage operations 68

SelectRoles operations 68, 220SelectRolesOfUser function 220SelectUserGroups operations 68SelectUsers operations 70, 220SelectUsersOfRole element 223SelectValueList element 122, 153SendEmailForFailure element

JobInputDetail type 134PrintReport operations 61SubmitJob operations 76User type 196, 226UserField type 197

SendEmailForFailure property 222SendEmailForSuccess element

JobInputDetail type 134PrintReport operations 61SubmitJob operations 76User type 196, 226UserField type 197

SendEmailForSuccess property 222SendFailureNotice element 61, 76, 134SendNoticeForFailure element 195, 197, 226SendNoticeForFailure property 222SendNoticeForSuccess element 195, 197, 226SendNoticeForSuccess property 222SendSuccessNotice element 61, 76, 134series (charts)

adding 365, 371, 378changing 369deleting 368, 379drilling through 344, 345getting number of run-time 366getting values for 366, 367managing 378removing 380replacing 380setting values for 369, 370setting visibility of 368, 373, 381

series objects 378, 379Server element 58server error constants 305, 462server errors 291, 593server state attributes 172, 173server status attributes 170, 172server URLs

getting 249, 489setting 490

Page 816: Actuate API Reference - OpenText

798 A c t u a t e A P I R e f e r e n c e

ServerBuild element 173ServerHome element 221ServerInformation data type 170ServerInformation objects 101ServerIPAddress element 171ServerList element 49ServerName element

GetFactoryServiceInfo operations 30GetServerResourceGroupConfiguration

operations 47MDSInfo type 147PendingSyncJob type 158RunningJob type 168ServerInformation type 170SetServerResourceGroupConfiguration

operations 72ServerResourceGroupSetting data type 171ServerResourceGroupSetting objects 101ServerResourceGroupSettingList element 47,

72servers

See also iHub serversaccessing 210pinging 59

ServerState data type 172ServerState element 147, 173ServerStateErrorCode element 173ServerStateErrorDescription element 173ServerStatusInformation data type 172ServerStatusInformation element 170ServerVersion element 173ServerVersionInformation data type 173ServerVersionInformation element 170Service data type 173Service objects 101ServiceList element 170ServiceOrPort property 59services

See also iHub services; web servicesSessionID element 230, 231, 233setAccessRights function 486setAccessType function 468, 477setActiveTab function 263setAggregationFunction function 612, 639SetArchiveRules element 181setAscending function 287, 632SetAttributes element

UpdateFileOperation operations 180UpdateFileTypeOperation operations 182UpdateJobScheduleOperation operations

184UpdateUserGroupOperation operations

189UpdateUserOperation operations 191UpdateVolumePropertiesOperation

operations 193SetAutoArchiveSchedules element 194setAutoSaveDelay function 263setAutoSuggestDelay function 300setAutoSuggestFetchSize function 301setAutoSuggestListSize function 301setAutoSuggestThreshold function 328setAxisType function 586, 605SetBearingUsersById element 190SetBearingUsersByName element 189setBookmark function 282setCascadingParentName function 329SetChannelNotificationById element 185SetChannelNotificationByName element 185SetChannelSubscriptionsById element 192SetChannelSubscriptionsByName element

191setChartTitle function 347setChartType function 372setChildData function 318SetChildRolesById element 190SetChildRolesByName element 189setColumnMirrorStartingLevel function 622setColumnName function

Data.Filter class 277Data.Sorter class 287ParameterDefinition class 329ParameterValue class 339, 521

setColumnPageBreakInterval function 622setColumns function 282setColumnType function 329, 339setCondition function 478setConditionArray function 478SetConnectionProperties operations 71setContainer function 263, 458setContentMarg function 506setContentPanel function 530setControlType function 330setCountLimit function 478

Page 817: Actuate API Reference - OpenText

I n d e x 799

setCurrentDisplayName function 330setCurrentValue function 318setCustomParameter function 490setDashboardName function 264setData function 380setDataType function

Measure class 613ParameterDefinition class 330ParameterValue class 340

setDefaultValue function 330setDefaultValueIsNull function 331setDependentFileId function 479setDependentFileName function 479SetDependentFilesById element 181SetDependentFilesByName element 180setDescription function 468setDimension function 347, 590setDimensionName function 586setDisplayName function 331, 340setEmptyCellValue function 622setEnabled function 640setEnablePageBreak function 623setExpandedGroups function 301setExpression function 613setFetchDirection function 479setFetchHandle function 479, 483setFetchSize function 480setField function 472SetFileCreationPermissions element 192setFileType function 468setFilters function

Chart class 348Crosstab class 580FlashObject class 357Gadget class 361Request class 282Table class 447

setFilterType function 600setFocus function 506setFolderName function 458setFont function 302setGadgetId function 562setGadgetType function 362setGrantedRoleId function 486setGrantedRoleName function 486setGrantedUserId function 487setGrantedUserName function 487

setGroup function 331, 340setGroupContainer function 302SetGroupMembershipsById element 192SetGroupMembershipsByName element 191SetGroupNotificationById element 185SetGroupNotificationByName element 184setHeadline method 8setHeight function

Dashboard class 264Viewer class 506XTabAnalyzer class 562

setHelpText function 332setId function 468setIncludeHiddenObject function 480setIndex function

Dimension class 586Level class 607Measure class 613

setIsAdHoc function 332setIServerUrl function 490setIsHidden function 332setIsMultiSelectControl function 332setIsPassword function 333setIsRequired function 333setIsViewParameter function 333, 340setItemList function 483setIVMode function 562setKey function 632SetLargeWebIcon element 182setLatestVersionOnly function 458setLayout function 302setLeft function 563setLevelAttributeName function 600setLevelName function

Filter class 601Level class 608MemberValue class 617Sorter class 632SubTotal class 636

setLevels function 587SetLicenseOptions element 193setLocale function 491setLocation function 636setMatch function 472setMaxRows function 283setMeasureDirection function 623setMeasureIndex function 640

Page 818: Actuate API Reference - OpenText

800 A c t u a t e A P I R e f e r e n c e

setMeasureName function 614setMember function 632setMembers function 591setMouseScrollingEnabled function 525setName function

File class 469LevelAttribute class 609NameValuePair class 311ParameterDefinition class 333ParameterValue class 341, 628

setNewAxisType function 587setNewIndex function 588, 614setOnClosed function 563setOperator function 277, 601setOption function 522SetOutputFileAccess element 186SetOutputFilePermissions element 185setOwner function 469, 480setPageCount function 469setPageNum function 564setPanInOutEnabled function 525SetParameterDefinitions element 181, 182SetParameters element 184setParameters function 507SetParameterValues element 185setParameterValues function

Viewer class 507XTabAnalyzer class 564

setParentData function 319SetParentRolesById element 190SetParentRolesByName element 190SetPermissions element 181setPosition function

ParameterDefinition class 334ParameterValue class 341XTabAnalyzer class 564

SetPrinterOptions elementUpdateJobScheduleOperation operations

184UpdateUserOperation operations 192UpdateVolumePropertiesOperation

operations 194setPrivilegeFilter function 480setPromptParameter function 341SetQuery element 186setReadOnly function 303setReportDocument function

Viewer class 507setReportletBookmark function 508setReportletDocumentMode function 564setReportName function

Parameter class 303Viewer class 508XTabAnalyzer class 548, 565

setRepositoryType function 491setRequiredFileId function 481setRequiredFileName function 481SetRequiredFilesById element 181SetRequiredFilesByName element 180setRESTAuthToken function 491setResultDef function 459SetRolesById element 192SetRolesByName element 191setRowMirrorStartingLevel function 623setRowPageBreakInterval function 624SetSchedules element 184setSearch function 459setSelectNameValueList function 334setSelectValueList function 334setSeriesVisible function 368, 373SetServerResourceGroupConfiguration

operations 72SetServerResourceGroupConfiguration

Response element 72setService function

Dashboard class 264Parameter class 303ReportExplorer class 459Viewer class 509XTabAnalyzer class 565

setShowDisplayType function 304setShowToc function 530setSize function

Chart class 348Dashboard class 264File class 469Gadget class 362HTML5Chart Renderer class 389Viewer class 509

SetSmallWebIcon element 182setSorters function

Crosstab class 580Request class 283Table class 448

Page 819: Actuate API Reference - OpenText

I n d e x 801

setStartingFolder function 460setStartRow function 283setSubType function 349setSupportSVG function 509, 566SetSystemPrinters element 194setTemplate function 265setTimeStamp function 470settings. See propertiessetTitle function 369, 373setTop function 566setTotalCount function 483setTotals function

Crosstab class 580GrandTotal class 605SubTotal class 637

setUIOptions functionViewer class 510XTabAnalyzer class 566

setUseDescriptionAsLabel function 460SetUserExtendedProperties operations 72SetUserExtendedPropertiesResponse element

72SetUserGroupExtendedProperties operations

73SetUserGroupExtendedPropertiesResponse

element 73SetUserGroupsByID element 192SetUserGroupsByName element 191SetUserNotificationById element 185SetUserNotificationByName element 184setUserPermissions function 470SetUserPreference operations 73SetUserPreferenceResponse element 73setValue function

NameValuePair class 311ParameterValue class 341viewer.ParameterValue class 521XTabAnalyzer.MemberValue class 617XTabAnalyzer.ParameterValue class 629

setValueIsNull functionParameterValue class 342, 629viewer class 521

setValues functionClientChart class 369Data.Filter class 277XTabAnalyzer.Filter class 602

setVersion function 470

setVersionName function 470setVersionName method 8setViewingMode function 510setVisible function 381setVolume function 492setVolumeProfile function 492SetWaitForEvent element 186setWebService function 319setWidth function

Dashboard class 265Viewer class 510XTabAnalyzer class 567

SetWindowsIcon element 182setXAxisRange function 369setXAxisTitle function 373setXTabBookmark function 567setXTabIid function 567setYAxisRange function 370setYAxisTitle function 373shared access type 40, 123Shared element 123shared files 123, 151, 234Short data type 174short values 177ShortDescription element 127, 147show function

Chart class 349ClientSeries class 382DataItem class 353FlashObject class 358Gadget class 363Label class 393Table class 448TextItem class 453

showColumn function 449showDetail function

Crosstab class 581Table class 449

showDownloadReportDialog function 510showDownloadResultSetDialog function 511showFacebookCommentPanel function 511showFoldersOnly function 460showParameterPanel function 511showPrintDialog function 511showTabNavigation function 265showToc flag 529, 530showTocPanel function 511

Page 820: Actuate API Reference - OpenText

802 A c t u a t e A P I R e f e r e n c e

sht element 110, 177Simple Object Access Protocol. See SOAPsingle sign-on authentication 54singlePeriod argument 690, 693, 700, 706Size element 122, 125, 235Size property 37SkipPermissionError element 188sln method 705SmallImageURL element 127SOAP endpoints

See also SOAP portsSOAP headers

defining attributes of 129, 236SOAP message error descriptions 291, 593SOAP messages

binding to web service operations 319SOAP requests. See requestsSOAP responses. See responsesSOAP-based archiving interface 229SOAP-based RSSE API 216SOAP-based RSSE data types 223SOAP-based RSSE operations 216Software Development Kit

See also SDK packagesort columns 19, 96, 112sort conditions 286, 630sort feature 532, 541sort fields. See sort columnssort keys 630, 632sort order

setting 286, 287, 632testing for 287, 631

sort order attributes 112SortColumn data type 174SortColumnList element 19SortDirection element 112Sorter class 286, 630sorter object arrays 283, 580sorter objects 283, 286, 630sorters

creating 286, 630getting column names for 286sending requests for 282, 283setting column names for 287setting sort order for 287, 632specifying specific tables for 448testing sort order for 287, 631

sorting data 283source code

BIRT JavaScript classes and 647spark gadgets 362special characters 124, 727, 728, 735Specified element 167spreadsheets. See Excel spreadsheetsSQL statements. See queriesSQRT function 736square root 736SSL port number 147Standalone element 174stand-alone servers 49, 174Start operations (RSSE) 221StartArchive command 23StartArchive operations 232StartArchive type 233StartArguments element

ResourceGroup type 165ResourceGroupSettings type 166ServerResourceGroupSetting type 172

StartExpanded element 154StartIndex element 44starting

archiving operations 23archiving sessions 232RSSE applications 221

STARTING element 172startingGuess argument 694, 704StartPartitionPhaseOut command 23StartRowNumber element 19StartTime element

JobField type 132JobProperties type 141Repeat type 163RunningJob type 168

StartUpParameters property 59State element 132, 140, 144Status element

CancelJob operations 16CancelReport operations 16ExecuteReport operations 23ExecuteVolumeCommand operations 24GetJobDetails operations 40GetNoticeJobDetails operations 42GetSyncJobInfo operations 48Printer type 161

Page 821: Actuate API Reference - OpenText

I n d e x 803

WaitForExecuteReport operations 80status information 77, 120status messages

cancelled jobs and 16cancelling reports and 16

Status property 39, 42Stop operations 223StopArchive command 23stopping

archiving operations 23archiving sessions 230report execution 16RSSE applications 223

STOPPING element 172str element 111, 178straight-line depreciation 705Stream data type 174streaming content 174String data type 113, 152, 174String element 113, 169

ArrayOfString type 234String objects 101String parameter 169string pattern operators 274, 275string patterns 727, 728, 735strings

concatenating 740converting case 727, 738counting characters in 726filtering files and 471finding substrings in 723, 735job schedules and 143matching characters in 727, 728naming report files and 122passwords and 194removing blank characters in 737returning length of 726returning substrings in 725, 732running reports and 507testing conditions for 724, 731testing equality of 725, 740testing range of values for 717user names and 194

Structure data type 153Structure element 113subdirectories. See subfolderssubfolders

deleting 114getting files in 36

SubmissionTime element 141, 158, 168submit function

Chart class 349Crosstab class 581Dashboard class 266DataItem class 354FlashObject class 358Gadget class 363Label class 393Parameter class 304ReportExplorer class 460Table class 449TextItem class 453Viewer class 512XTabAnalyzer class 568

SubmitJob operationsdefining 73printing requests and 60, 74

SubscribedToChannelId element 200SubscribedToChannelName element 200subscribers (channels) 222SubscribeToChannelsById element 192SubscribeToChannelsByName element 191substrings

extracting 725, 732finding location of 723, 735

SubTotal class 634subtotals 580, 634, 637subtraction operator 740Succeeded element 103success notices 61, 76, 204

deleting 222SuccessNoticeExpiration element 195, 197,

226SuccessNoticeExpiration property 222summary data

generating grand totals and 603generating subtotals and 580, 634getting aggregate function for 638getting level names for 635getting location name for 635getting type names for 636setting aggregation function for 639setting level names for 636setting location of 636

Page 822: Actuate API Reference - OpenText

804 A c t u a t e A P I R e f e r e n c e

sum-of-years’-digits depreciation 705SupportCollation element 161SupportColorMode element 161SupportDuplex element 161SupportedQueryFeatures data type 175SupportedQueryFeatures element 40, 42SupportGetTranslatedUserNames element

223SupportNumberOfCopies element 160SupportOrientation element 160SupportPageSize element 160SupportPaperTray element 161SupportResolution element 160SupportScale element 160SVG elements 384, 385, 387SVG flag 509, 566SVG path commands 388swapColumns function 450switch view feature 541syd method 705SyncFactoryProcesses element 30synchronous job status attributes 23, 48synchronous jobs

cancelling 103getting information about 31, 47pending 158running 164, 167

synchronous reports 16, 21synchronous resource groups 46, 165SyncJobQueueSize element 30SyncJobQueueWait element 30SyncResourceGroupList element 46system administrators

See also administratorssystem passwords 78system printers 48, 194system schemas. See schemassystem-generated tokens 55SystemLogin operations 78SystemPassword element 78SystemPasswordEncryptLevel element 78SystemType data type 174SystemType element 173

TTab class 272

tab objects 272tab type constants 272table bookmarks 399Table class 395Table data type 153Table element 113table elements 395table names 399, 400table objects 395table of contents (reports)

displaying 529, 530enabling or disabling 542getting 38

table of contents panel 511tables

adding page breaks to 620, 623displaying 395filtering data in 399, 446, 447, 448getting columns in 400getting instance ID of 401getting rows for 401grouping rows in 402hiding 402hiding columns in 403hiding data in 403removing groups from 447reordering columns in 450, 538, 540resizing columns in 534resizing rows in 540retrieving 502, 518showing columns in 449showing groups in 449submitting requests for 449suppressing duplicate values in 541

TableValue element 155tab-separated values files. See TSV filesTarget element 106, 149target service URL 459, 509TargetResourceGroup element 129, 237TargetServer element 129, 237TargetVolume element 129, 236tasks 104tcpmon utility. See TCPMonitortemplate files 258template paths 265TemplateName element 165, 171templates

Page 823: Actuate API Reference - OpenText

I n d e x 805

access control lists 34temporary files 5temporary files. See transient filestemporary reports. See transient reportstesting

connections 251iHub components 56report generation 43

textdisplaying 500, 503getting from downloaded content 279getting from text elements 453getting label 392

text box controls 122, 153text editing feature 542text elements 451, 453, 519text files 66text function 389text graphic elements 389text item objects 451text items 451, 452, 453text objects 500, 503text strings. See stringsTextItem class 451thermometer gadgets 362third-party files 453D charts 347Time data type 113, 175time data types 113, 175Time element 113, 169time formats 175Time parameters 169time stamps

file creation operations and 123, 125getting 467setting 470

time values 274adding to date values 714, 716calculating number of 719, 720, 721returning current 731, 736

time zone indicator 175time zones 142TimeInstant data type 113TimeStamp element 123, 125, 235TimeStamp property 37TimeZoneName element 142titles

charts 344, 345, 347, 348reports 503

TocRef element 39TODAY function 736tokens 55toolbar help feature 543toolbar save feature 643toolbars

disabling 642Interactive Crosstabs 642viewers 542

tooltips 541top N filter feature 543TOP_N operator 275, 597TOP_PERCENT operator 275, 597Total class 638total objects 636, 638TotalCount element

GetFileACL operations 34GetFileCreationACL operations 35GetFolderItems operations 37GetParameterPicklist operations 44SelectFiles operations 64SelectJobs operations 67SelectJobSchedules operations 68SelectRoles operations 220SelectUserGroups operations 70SelectUsers operations 71, 221

totalsadding grand totals and 603, 605adding to subtotals 580, 634, 637enabling or disabling 639, 640getting 604, 636returning axis type for 604returning index values for 639returning type 605setting axis type for 605setting index values for 640viewing in cross tabs 638

Trace mode (Ping) 57trailing characters 737Transaction element 89Transaction operations 175TransactionOperation operations 175transactions 175

See also Transaction operationstransient files 5

Page 824: Actuate API Reference - OpenText

806 A c t u a t e A P I R e f e r e n c e

getting names 297saving 133

transient reports 30, 62, 168TransientReportCacheSize element 30TransientReportTimeout element 30translated user names 223TranslatedRoleNames data type 225TranslatedRoleNames element 52, 187, 218TranslatedRoleNames property 52TranslatedUserGroupNames element 187TranslatedUserNames data type 225TranslatedUserNames element 187TRIM function 737TRIMLEFT function 737TRIMRIGHT function 737TRUE operator 275, 597type definitions (WSDL) 83Type element

ObjectIdentifier type 151ResourceGroup type 164ServerResourceGroupSetting type 171

type element 105TypeName data type 177TypeName element 105types. See data types

UUI configuration objects 503, 529UI elements 318

See also user interfacesUIConfig class 529UIOptions class

Viewer 531XTabAnalyzer 641

uncategorized exceptions 291undefined parameters 17UndeleteUser element 89, 175UndeleteUser operations 178underscore (_) character

pattern matching 727undo feature 544Uniform Resource Locators. See URLsuniversal hyperlinks. See hyperlinksUniversal Resource Identifiers. See URIsUnsubscribeFromChannelsById element 192

UnsubscribeFromChannelsByName element 191

update function 377UpdateChannel element 176UpdateChannel operations 178UpdateChannelOperation operations 178UpdateChannelOperationGroup operations

178UpdateDatabaseConnection operations 78UpdateFile element 90, 177UpdateFile operations 179, 180, 181UpdateFileOperation element 181, 183UpdateFileOperation operations 180, 181UpdateFileOperationGroup operations 181UpdateFileType element 90, 176UpdateFileType operations 182UpdateFileTypeOperation operations 182,

183UpdateFileTypeOperationGroup operations

183UpdateGroup element 176UpdateGroup operations 183UpdateGroupOperation operations 183UpdateGroupOperationGroup operations

183UpdateJobSchedule element 90, 177UpdateJobSchedule operations 183, 184UpdateJobScheduleOperation element 186UpdateJobScheduleOperation operations 184,

186UpdateJobScheduleOperationGroup

operations 186UpdateOpenSecurityCache element 90, 177UpdateOpenSecurityCache operations 186UpdateResourceGroup operations 79UpdateRole operations 187, 190UpdateUser element 89, 175UpdateUser operations 187, 191UpdateUserGroup element 90, 176UpdateUserGroup operations 188UpdateUserGroupOperation element 191UpdateUserGroupOperation operations 189UpdateUserGroupOperationGroup

operations 190UpdateUserOperation element 193UpdateUserOperation operations 191, 193UpdateUserOperationGroup operations 193

Page 825: Actuate API Reference - OpenText

I n d e x 807

UpdateVolumeProperties element 90, 177UpdateVolumeProperties operations 193UpdateVolumePropertiesOperation element

194UpdateVolumePropertiesOperation

operations 193, 194UpdateVolumePropertiesOperationGroup

operations 194updating

channels 178data 318external user information 187file types 182folders 179licensing options 193Open Security cache 186print jobs 184privileges 181, 186report files 179resource groups 72, 79schedules 183, 184user groups 188, 189, 191user properties 187, 191

upload security adapter interface 212UploadFile operations

defining 79uploading

report files 79UPPER function 738uppercase characters 738URIs

overview 11, 83URL parameters

authentication requests and 247, 303returning custom parameters in 490

URLsaccessing JavaScript library and 242accessing web services and 565displaying reports and 203getting 249, 256, 489retrieving parameters and 303returning default web service 248returning failed requests for 254returning from exception objects 254setting server 490setting target service 459, 509testing connections for 251

usage error constants 305, 462usage errors 291, 594usePersonalDashboard function 266UseQuoteDelimiter property 66user attributes 55, 194, 196, 225user credentials 55, 247User data type 194, 225User element

AuthenticateUser operations 217CreateUser operations 109GetUserProperties operations 219Login requests 54Login responses 55UserAndProperties type 226

user group names 26user groups. See groupsuser IDs

See also UserId elementauthentication and 247, 255privilege filters and 485, 487removing users and 117

user information 484user interface configuration objects 503, 529user interface elements 318user interface options

enabling 531getting 503, 557setting Interactive Crosstabs 566, 641setting viewer 510

user interfacesbrowsing repository contents and 455

user namesduplicating 109filtering privileges and 486, 487getting translated 223logging in to iHub and 212mapping external 218setting 194

User objects 102user preferences

adding users and 196getting list of 51setting 73

UserACLExternal element 222UserAgent element 202UserAndProperties data type 226UserAndProperties element 217

Page 826: Actuate API Reference - OpenText

808 A c t u a t e A P I R e f e r e n c e

UserCondition data type 196UserCondition objects 102UserField data type 196UserGroup data type 197UserGroup element 109UserGroup objects 102UserGroupCondition data type 198UserGroupCondition objects 102UserGroupField data type 198UserGroupId element

GetCapabilities operations 25GetConnectionProperties operations 27GetUserGroupExtendedProperties

operations 50GetUserGroupProductAccess operations

53GrantUserGroupCapabilities operations 53GrantUserGroupProductAccess

operations 51Permission type 159RevokeUserGroupCapabilities operations

61RevokeUserGroupProductAccess

operations 62SetConnectionProperties operations 71SetUserGroupExtendedProperties

operations 73UserGroupList element 187UserGroupName element

GetCapabilities operations 25GetUserGroupExtendedProperties

operations 50GetUserGroupProductAccess operations

53GrantUserGroupCapabilities operations 53GrantUserGroupProductAccess

operations 50Permission type 159RevokeUserGroupCapabilities operations

61RevokeUserGroupProductAccess

operations 62SetConnectionProperties operations 71SetUserGroupExtendedProperties

operations 73UserGroupNames element 26, 27UserGroupSearch data type 198

UserId elementGetCapabilities operations 25GetConnectionProperties operations 26GetUserExtendedProperties operations 50GetUserLicenseOptions operations 51GetUserPreference operations 51GetUserPrinterOptions operations 52Permission type 159SetConnectionProperties operations 71SetUserExtendedProperties operations 72SetUserPreference operations 73

userID parameter 247userid variable 248, 251UserName element

DoesUserExist operations 217GetCapabilities operations 25GetConnectionProperties operations 218GetUserACL operations 219GetUserExtendedProperties operations 50GetUserLicenseOptions operations 51GetUserPreference operations 51GetUserPrinterOptions operations 52Permission type 159, 224, 237SelectRoles operations 220SetConnectionProperties operations 71SetUserExtendedProperties operations 72SetUserPreference operations 73

UserName property 59UserNameList element 186UserNames element 26, 27UserPermissions element 123UserPermissions property 37users

adding to groups 109assigning privileges 159, 192, 224, 237assigning to groups 191authenticating 216checking for existence of 217creating 109defining available features for 56deleting 117, 178developing RSSE applications for 216getting access control lists for 219getting ACL templates for 34getting assigned privileges for 162getting authentication IDs for 5getting home folders for 211

Page 827: Actuate API Reference - OpenText

I n d e x 809

getting licensing options for 51, 200getting passwords for 211getting printer settings for 51getting properties for 217, 219getting security credentials for 211getting security roles for 6, 7, 220reassigning roles to 189removing from groups 117searching 70, 196, 200, 220sending notifications to 75, 219setting home folders for 195, 197setting licensing options for 147setting passwords for 55, 194setting preferences for 196updating licenses 193updating properties for 187, 191updating roles for 189validating credentials for 210

Users element 70, 219, 221UserSearch data type 200UserSetting element 55, 217

VValidateUserGroups element 55ValidUserGroups element 56Value element

LicenseOption type 147NameValuePair type 150ParameterValue type 155PropertyValue type 163, 225

value series (charts)getting maximum values 367getting minimum values 367setting value range for 370three-dimensional charts and 347

ValueFileType element 133ValueFileVersionName element 133valueIfZero argument 698valueIsNull value 338, 521ValueIsNullValue element 155values

See also dataassigning to data components 150changing parameter 309, 320computing percentages of 698converting 306

downloading parameters and 296filtering cross tabs and 596filtering locale-specific data and 274filtering top or bottom 543financial methods and 690getting default 325getting empty cell 620getting level 617getting list of 327getting parameter 338, 520, 521, 556getting series 366, 367matching set of 274, 275matching top or bottom 274negating Boolean 730overwriting parameter 22prompting for 155, 320, 338, 341removing duplicate 379retrieving counter 25, 27returning absolute 713returning specific 285, 352returning square root of 736rounding 718, 733, 734selecting 332setting conditions for 724, 731setting default 153, 331setting display names for 310setting empty cell 572, 622setting level 617setting parameter 155, 335, 520, 629setting property 224setting series 369specifying null 342, 521, 629suppressing duplicate 541testing conditions for 740testing equality of 725, 740testing for non-null 731testing for null 275, 597, 628testing if null 725testing range of 717, 740

variablesunloading JavaScript 299, 457

vector graphics elements 384, 385, 387Vector Markup Language graphics elements

384, 387, 388verifyFile function 213version attributes 150, 170, 201Version element

Page 828: Actuate API Reference - OpenText

810 A c t u a t e A P I R e f e r e n c e

File type 123, 125FileInfo type 235ObjectIdentifier type 152RSSE Start operations 221

version information 173, 467, 470version names 8, 470

See also VersionName elementversion numbers 123, 125Version property 37Versioning element 150VersioningOption data type 201VersionName element 123, 125, 150, 235VersionName property 37View element 164view parameter definitions 45view parameters

See also ViewParameter elementdefining parameter types and 164setting 154, 155setting attributes for 201

view properties 65View service 58, 173Viewer class 493viewer classes 245viewer components 252, 493viewer event constants 514viewer IDs 519, 625viewer objects 493, 558viewer preferences 195, 197, 222viewer variable 550ViewerException class 545viewers

accessing report content for 497building user interface for 455determining status of 505disabling 496displaying charts in 497, 516displaying reports in 493enabling interactive features for 497, 529,

531getting browser size for 498getting content for 497, 498, 499, 500getting file names for 502getting margins for 499getting size 501, 504getting specific instance 250, 504getting UI options for 503

handling events for 514handling exceptions for 545launching 538reloading 512resizing 265, 498, 501, 509saving contents 505, 506scrolling in 513, 524, 529selecting content in 526sessions timing out and 592setting focus for 506setting margins for 506setting size 507, 509, 510setting UI options for 510showing main menu in 538showing toolbar help in 543showing toolbars in 542submitting requests for 512switching views 541

viewingcolumns 449cross tabs 548, 625data 618data cubes 642data items 353data series 368, 373, 381dates 113Flash objects 355, 358, 363folders 460HTML5 charts 382label elements 393, 501parameter groups 302PDF documents 203report items 537report parameters 294, 320Reportlets 502standard charts 349summary data 603, 634, 638table elements 448table of contents 529, 530, 542tables 395text 452, 453, 500, 503toolbars 542, 642tooltips 541

Viewing element 173viewing mode (dashboards) 510viewing mode constants 510viewing parameters. See view parameters

Page 829: Actuate API Reference - OpenText

I n d e x 811

viewing preferences. See viewer preferencesviewing service. See View serviceViewMode element 152ViewOperation element 202ViewParameter data type 201ViewParameterList element 45ViewParameterValues element 65ViewPreference element 195, 197, 225ViewPreference property 222ViewProperties element 65ViewResourceGroupList element 46views, switching 541view-time parameters 128, 339, 340Visibility element 105visible privilege 159, 238Vista computers. See Windows systemsVML graphics elements 384, 387, 388volume administrators. See administratorsVolume data type 203Volume element

PendingSyncJob type 158ResourceGroup type 164RunningJob type 168Start operations 221

volume file paths 259volume names 7volume partitions 23, 58volume profiles 212, 490, 492volume schemas. See schemasvolume variable 248, 251, 253VolumeDefault element 167VolumeName element 23VolumeProperties element 52VolumeProperties property 52volumes

changing 14developing administration operations for

89executing commands for 23getting current 212getting properties for 52getting specific 490integrating with external security sources

216pinging 58setting profiles for 492specifying 492

testing connections to 212uploading files to 79

Volumes element 56volumes. See Encyclopedia volumes

Wwait intervals 23WaitForEvent element 41, 43, 78WaitForExecuteReport operations 80WaitTime element 23web applications 4

See also applicationscustomizing content for 242

web browser content panels 513web browser exceptions 291web browser windows 498web browsers 6

displaying file types in 182getting exception descriptions for 291rendering output for 384specifying 202

web icons 127, 182web pages

accessing class libraries for 242adding report components to 246displaying cross tabs in 548displaying reports as 252, 493enabling SVG support for 509, 566retrieving data for 279

web service applicationsSee also IDAPI applications

web service connections 289Web Service Description Language. See

WSDLweb services

closing connections to 253displaying dashboards and 264getting default URL for 248linking parameters to 303opening connections for 250running RSSE applications as 216sending SOAP messages over 319setting URLs for 459, 509, 565

web services messaging framework. See SOAP

WEEK function 738

Page 830: Actuate API Reference - OpenText

812 A c t u a t e A P I R e f e r e n c e

WEEKDAY function 738weekdays

adding to date values 713calculating number of 719returning number in month 718returning specific 738

Weekly data type 204Weekly element 143weeks

adding to date values 716calculating number of 722returning 738

whenDue argumentfv method 692ipmt method 693nper method 697pmt method 699ppmt method 701pv method 702rate method 704

wildcard characters 727, 735WithLicenseOption element 200WithoutDynamicPickList element 45WithRightsToChannelId element 199WithRightsToChannelName element 199WithRoleId element 200WithRoleName element 200WithUserGroupId element 200WithUserGroupName element 200Word document output formats 496work unit licenses 165workgroup repository type 491WorkingFolderId element

CopyFile operations 106CreateFolder operations 108DeleteFile operations 114MoveFile operations 149SelectFiles operations 63UpdateFile operations 179

WorkingFolderName elementCopyFile operations 106CreateFolder operations 108DeleteFile operations 114MoveFile operations 149SelectFiles operations 63UpdateFile operations 179

worksheets 522

workspace directories 133WorkUnitType element 165WorkUnitTypes element 47write privilege 159, 238WriteFile action 57WSDL documents

See also WSDL filesWSDL elements

See also XML elementsWSDL schemas

defining data type arrays and 92WSDL type definitions 83WSDL2Java package

See also code emitter

Xx-axis labels (charts) 373x-axis values (charts)

returning maximum value for 366returning minimum value for 367setting data points for 381setting range for 369

XML attributes. See attributesXML code

See also codeXML element (information objects) 130XML formats 130, 202XML reports. See XML documentsXML schemas

See also WSDL schemasXP computers. See Windows systemsXTabAnalyzer class 548, 552xtabAnalyzer components 252XTabAnalyzer event constants 592XTabAnalyzer exception objects 593

Yy-axis labels (charts) 373y-axis values (charts)

converting chart dimensions and 347returning maximum value for 367returning minimum value for 367setting data points for 381setting value range for 370

YEAR function 739years

Page 831: Actuate API Reference - OpenText

I n d e x 813

adding to date values 716calculating number of 722getting 739

ZZipFilePath element 54zooming 525

Page 832: Actuate API Reference - OpenText

814 A c t u a t e A P I R e f e r e n c e