PDF (6.91 MB) - Actuate Corporation

798 Pages·2012·8.32 MB·English

by  Actuate Corporation

Using BIRT iServer Integration Technology
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 - 2012 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.actuate.com
www.birt-exchange.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 Data Analyzer, BIRT
Performance Analytics, Collaborative Reporting Architecture, e.Analysis, e.Report, e.Reporting,
e.Spreadsheet, Encyclopedia, Interactive Viewing, OnPerformance, Performancesoft, Performancesoft Track,
Performancesoft Views, ReportEncyclopedia, Reportlet, The people behind BIRT, X2BIRT, and XMLreports.
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. Apache
Software Foundation (www.apache.org): Axis, Axis2, Batik, Batik SVG library, Commons Command Line
Interface (CLI), Commons Codec, Derby, Hive driver for Hadoop, Shindig, Struts, Tomcat, Xalan, Xerces,
Xerces2 Java Parser, and Xerces-C++ XML Parser. Castor (www.castor.org), ExoLab Project (www.exolab.org),
and Intalio, Inc. (www.intalio.org): Castor. Codejock Software: Xtreme Toolkit Pro. Eclipse Foundation, Inc.
(www.eclipse.org): Babel, Data Tools Platform (DTP) ODA, Eclipse SDK, Graphics Editor Framework (GEF),
Eclipse Modeling Framework (EMF), and Eclipse Web Tools Platform (WTP), licensed under the Eclipse
Public License (EPL). Bits Per Second, Ltd. and Graphics Server Technologies, L.P.: Graphics Server. Gargoyle
Software Inc.: HtmlUnit, licensed under Apache License Version 2.0. GNU Project: GNU Regular Expression,
licensed under the GNU Lesser General Public License (LGPLv3). HighSlide: HighCharts.
IDAutomation.com, Inc.: IDAutomation. Jason Hsueth and Kenton Varda (code.google.com): Protocole
Buffer. IDRsolutions Ltd.: JBIG2, licensed under the BSD license. ImageMagick Studio LLC.: ImageMagick.
InfoSoft Global (P) Ltd.: FusionCharts, FusionMaps, FusionWidgets, PowerCharts. Matt Inger
(sourceforge.net): Ant-Contrib, licensed under Apache License Version 2.0. Matt Ingenthron, Eric D. Lambert,
and Dustin Sallings (code.google.com): Spymemcached, licensed under the MIT OSI License. International
Components for Unicode (ICU): ICU library. jQuery: jQuery, licensed under the MIT License. Yuri Kanivets
(code.google.com): Android Wheel gadget, licensed under the Apache Public License (APL). KL Group, Inc.:
XRT Graph, licensed under XRT for Motif Binary License Agreement. LEAD Technologies, Inc.:
LEADTOOLS. Bruno Lowagie and Paulo Soares: iText, licensed under the Mozilla Public License (MPL).
Microsoft Corporation (Microsoft Developer Network): CompoundDocument Library. Mozilla: Mozilla XML
Parser, licensed under the Mozilla Public License (MPL). MySQL Americas, Inc.: MySQL Connector. Netscape
Communications Corporation, Inc.: Rhino, licensed under the Netscape Public License (NPL). OOPS
Consultancy: XMLTask, licensed under the Apache License, Version 2.0. Oracle Corporation: Berkeley DB,
Java Advanced Imaging, JAXB, JDK, Jstl. PostgreSQL Global Development Group: pgAdmin, PostgreSQL,
PostgreSQL JDBC driver. Progress Software Corporation: DataDirect Connect XE for JDBC Salesforce,
DataDirect JDBC, DataDirect ODBC. Rogue Wave Software, Inc.: Rogue Wave Library SourcePro Core,
tools.h++. Sam Stephenson (prototype.conio.net): prototype.js, licensed under the MIT license. Sencha Inc.:
Ext JS. ThimbleWare, Inc.: JMemcached, licensed under the Apache Public License (APL). World Wide Web
Consortium (W3C)(MIT, ERCIM, Keio): Flute, JTidy, Simple API for CSS. XFree86 Project, Inc.:
(www.xfree86.org): xvfb. ZXing authors (code.google.com): ZXing, licensed under the Apache Public License
(APL).
All other brand or product names are trademarks or registered trademarks of their respective owners,
companies, or organizations.
Document No. 120201-2-430301 July 30, 2012
Contents
About Using BIRT iServer Integration Technology . . . . . . . . . . . . . . . . . .xix
Part 1
Introduction to the Actuate Information Delivery API
Chapter 1
Understanding the Information Delivery API and schema . . . . . . . . . . . . . 3
About the Actuate Information Delivery API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
About web services and WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Understanding the elements of iServer’s WSDL schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
About the definitions element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
About data type definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
About message definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
About the portType definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
About the binding definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
About the service definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Accessing the Actuate schema using a web browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
Chapter 2
Constructing a SOAP message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
About SOAP messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Calling an Actuate web service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
About SOAP message elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Understanding the HTTP header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Understanding the SOAP envelope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
About XML namespace declarations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Understanding the SOAP header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Understanding the SOAP message body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
About SOAP Fault messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Chapter 3
Understanding Actuate Information Delivery API operations . . . . . . . . . 25
About Actuate Information Delivery API operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Working with BIRT iServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Working with channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Working with Encyclopedia volumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Working with files and folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Working with groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Working with information objects and databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
i
Working with jobs and reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35
Working with searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40
Performing a search operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40
Using special characters in searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41
Working with users, roles, and security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42
Chapter 4
Running, printing, and viewing a document . . . . . . . . . . . . . . . . . . . . . . . 45
Generating or printing a document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
Running a synchronous report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47
Generating a cube from a cube design profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48
Setting a time frame for an ExecuteReport response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49
Waiting for report generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50
Running a synchronous report that uses parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51
Retrieving report parameter values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52
Creating a report object value (.rov) file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
Running or printing a job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
Understanding SubmitJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
Specifying parameters for a job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56
Using a parameter values file as input to a job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56
About hidden, required parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57
Scheduling report generation or printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57
Working with a job notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58
About e-mail attachments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59
About notifying a channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59
Sending an e-mail notification using SubmitJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59
Sending an e-mail notification using UpdateJobSchedule . . . . . . . . . . . . . . . . . . . . . . . . . . .60
Notifying a channel using SubmitJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62
Notifying a channel using UpdateJobSchedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62
Customizing an e-mail notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63
Using the e-mail template for multiple locales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63
Retrieving job properties using GetJobDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64
Retrieving job properties using GetNoticeJobDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65
Cancelling a job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66
Working with a resource group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67
Creating an asynchronous resource group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68
Creating a synchronous resource group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69
Updating a resource group’s properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70
Getting a list of resource groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71
Retrieving the properties of a specific resource group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72
Retrieving properties for all resource groups on a BIRT iServer . . . . . . . . . . . . . . . . . . . . . . . .73
Setting properties for the resource groups on a BIRT iServer . . . . . . . . . . . . . . . . . . . . . . . . . .74
Deleting a resource group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75
ii
Assigning a report to a resource group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Assigning a job to a resource group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Retrieving the resource group to which a job is assigned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Working with a query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
About information object file types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
About query programming tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Generating a data object instance file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Filtering data in a query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Scheduling a query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Creating a data object value file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Viewing the details of a query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Viewing the details of a scheduled query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Modifying the details of a scheduled query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Viewing the details of a query notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Working with multidimensional data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Retrieving and viewing data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Requesting a page or range of pages using SelectPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Retrieving the attachment to a SelectPage response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Using SelectPage to print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Retrieving report content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Retrieving embedded data and style sheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Searching within a document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Searching for a range of pages using SearchReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Getting a table of contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Requesting a page count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Retrieving display formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .110
Retrieving a custom format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .110
Managing a large list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .111
Working with a large message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .112
Delivering a multilingual document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115
Chapter 5
Administering an Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . 117
About the Encyclopedia service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118
Defining the data on which an operation acts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118
Defining data using Id or IdList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118
Defining data using Name or NameList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119
Defining data using Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119
Administering security and authentication operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Logging in as a report user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Logging in with SystemLogin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Getting an access control list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Requesting a file or folder’s ACL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
iii
Retrieving the ACL for a channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124
Getting a user’s ACL template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .125
Setting an additional condition on an ACL request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .126
About Encyclopedia-level management operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .127
Uploading a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .127
Uploading an Actuate report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .128
Uploading a third-party report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129
Copying file properties when uploading a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129
Attaching or embedding a file in a request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130
Uploading a file as an attachment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131
About the HTTP header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131
Writing the UploadFile request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .132
Downloading a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .133
Downloading a file as an attachment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .134
Updating a file or folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .134
Updating a file’s parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .135
Updating the privilege settings of a file or folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .136
Selecting properties of a file or folder in an Encyclopedia volume . . . . . . . . . . . . . . . . . . . . .138
Requesting a list of files or folders in a working directory using SelectFiles . . . . . . . . . .139
About the Search element in SelectFiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .140
Using a privilege filter with SelectFiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .141
Retrieving a property list for an item in a folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .142
Retrieving properties of an item in a folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143
Setting a condition using GetFolderItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .144
Using GetFileDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .145
Getting the details of an Actuate report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .145
Getting the details of a cube design profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .146
Managing Encyclopedia volume items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .146
Ignoring error conditions in an Administrate operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147
Creating an item in an Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147
Creating a user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147
Creating a folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .148
Creating a security role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .149
Deleting an item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150
Deleting a file or folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150
Deleting a user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150
Updating an item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151
Updating a job schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151
Updating a channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152
Moving a file or folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .153
Copying a file or folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .154
About composite operations and transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155
About sequences in composite Administrate operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156
iv
Working with a transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
About TransactionOperation and AdminOperation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Searching within an Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Selecting an item in an Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Selecting a job or job list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Getting Encyclopedia volume, printer, and file type information . . . . . . . . . . . . . . . . . . . . . 161
Getting Encyclopedia volume properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Getting BIRT iServer System printer information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Retrieving a user’s printer settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Retrieving parameter definitions for a file type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Extracting parameter definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Exporting file parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Executing a predefined Encyclopedia volume command . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Diagnosing reporting environment problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
About Ping request options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Sending a Ping request in Concise mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Sending a Ping request in Normal mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Sending a Ping request in Trace mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Monitoring BIRT iServer information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Getting information about BIRT iServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Getting information about a running or pending job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Getting information about Factory service processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Monitoring or cancelling a request for a synchronous report . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Monitoring a request for a synchronous report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Cancelling a request for a synchronous report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Part 2
Developing Actuate Information Delivery API applications
Chapter 6
Developing Actuate Information Delivery API applications
using Java . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
About the Apache Axis 1.4 client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Generating the com.actuate.schemas library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
About third-party code libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
About the Actuate Information Delivery API framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Using a data type from a WSDL document to generate a JavaBean . . . . . . . . . . . . . . . . . . . 189
Using metadata to map XML to a Java type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Mapping the portType to a Service Definition Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Using a WSDL binding to generate a Java stub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Implementing the Actuate API service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Developing Actuate Information Delivery API applications . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
v
Writing a program that logs in to an Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . . .195
About the auxiliary classes provided by the sample application . . . . . . . . . . . . . . . . . . . .197
Logging in to the Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .200
Capturing SOAP messages using Axis TCPMonitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .201
Writing a simple administration application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .202
Creating a user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .203
About ActuateControl.createUser() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .204
About ActuateControl.runAdminOperation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .205
Performing a search operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .206
Using com.actuate.schemas.SelectFiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .206
Using ResultDef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .209
Writing a batch or transaction application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .211
About batch and transaction operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .211
Implementing a transaction-based application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .212
Uploading a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .214
About ways of uploading a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .214
Using com.actuate.schemas.UploadFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .214
How to build an application that uploads a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .215
Downloading a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .218
Using com.actuate.schemas.DownloadFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .219
How to build an application that downloads a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .219
Executing a report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .222
Understanding the structure of an ExecuteReport application . . . . . . . . . . . . . . . . . . . . . .223
Using the SelectPage class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .224
Using SelectJavaReportPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .227
Scheduling a custom event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .232
Implementing a custom event service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .236
Building a custom event service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .236
About the custom event web service sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .237
SOAP-based event web service operations and data types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .238
ArrayOfEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .238
ArrayOfEventStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .239
Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .239
EventStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .239
GetEventStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .240
Chapter 7
Developing Actuate Information Delivery API applications
using Microsoft .NET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
About the Microsoft .NET client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .242
About the Actuate Information Delivery API framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .245
Using a data type from a WSDL document to generate a C# class . . . . . . . . . . . . . . . . . . . . .245
Mapping the portType to a web service interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .247
vi
Developing Actuate Information Delivery API applications . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Writing a program that logs in to an Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Writing a simple administration application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Performing a search operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Writing a batch or transaction application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
About batch and transaction operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Implementing a transaction-based application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Uploading a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
About ways of uploading a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Using UploadFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
How to build an application that uploads a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Downloading a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Using DownloadFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
How to build an application that downloads a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Chapter 8
Actuate Information Delivery API operations . . . . . . . . . . . . . . . . . . . . . 265
About the SOAP header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Administrate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
AdminOperation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
CallOpenSecurityLibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
CancelJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
CancelReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
CloseInfoObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
CopyFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
CreateChannel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
CreateDatabaseConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
CreateFileType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
CreateFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
CreateGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
CreateParameterValuesFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
CreateQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
CreateResourceGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
CreateRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
CreateUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
CubeExtraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
DataExtraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
DeleteChannel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
DeleteDatabaseConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
DeleteFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
DeleteFileType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
DeleteGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
DeleteJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
vii
DeleteJobNotices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .289
DeleteJobSchedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .289
DeleteResourceGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .290
DeleteRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .290
DeleteUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .291
DownloadFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .292
DownloadTransientFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .293
ExecuteQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .294
ExecuteReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .297
ExecuteVolumeCommand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .299
ExtractParameterDefinitionsFromFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .301
ExportParameterDefinitionsToFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .301
FetchInfoObjectData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .302
GetBookmarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .303
GetChannelACL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .303
GetConnectionPropertyAssignees . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .305
GetContent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .306
GetCubeMetaData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .308
GetCustomFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .308
GetDatabaseConnectionDefinition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .309
GetDatabaseConnectionParameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .310
GetDatabaseConnectionTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .311
GetDataExtractionFormats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .311
GetDocumentConversionOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .312
GetDynamicData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .312
GetEmbeddedComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .314
GetFactoryServiceInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .316
GetFactoryServiceJobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .318
GetFileACL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .321
GetFileCreationACL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .322
GetFileDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .324
GetFileTypeParameterDefinitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .325
GetFolderItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .326
GetFormats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .327
GetInfoObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .328
GetJavaReportEmbededComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .329
GetJavaReportTOC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .330
GetJobDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .331
GetMetaData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .334
GetNoticeJobDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .334
GetPageCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .337
GetPageNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .338
GetParameterPickList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .339
viii