BusinessObjects Enterprise Java SDK

This document is the API specification for the BusinessObjects Enterprise Java SDK.

See:
          Description

Packages
com.businessobjects.sdk.ceutils.prompts This package contains one class that provides utility functions that allow you to set and populate prompts based on different data sources.
com.businessobjects.sdk.plugin.admin.webiserveradmin This package provides an interface that allows you to manage the metrics and performance options for the Web Intelligence Report Server.
com.businessobjects.sdk.plugin.desktop.category This packages contains two classes that allow you to manage categories.
com.businessobjects.sdk.plugin.desktop.inbox This package allows you to create and manage a user’s inbox.
com.businessobjects.sdk.plugin.desktop.note This package allows you to enable discussion threads within your reports and documents.
com.businessobjects.sdk.plugin.desktop.overload This package contains a series of classes that allow you to manage overloads and their interaction with IUniverse objects.
com.businessobjects.sdk.plugin.desktop.universe This package contains two interfaces that allow you to gather information about a universe and manage it within the BusinessObjects Enterprise Infrastructure.
com.businessobjects.sdk.plugin.desktop.webi This package is responsible for managing Web Intelligence documents within the BusinessObjects Enterprise Infrastructure.
com.crystaldecisions.sdk.exception This package defines the exceptions thrown by BusinessObjects Enterprise.
com.crystaldecisions.sdk.framework This package implements the highest object model that branches off to the individual library implementations.
com.crystaldecisions.sdk.occa.enadmin This package should be used in conjunction with the Server plugin package to retrieve general server metrics.
com.crystaldecisions.sdk.occa.infostore This package provides the ability to query for InfoObjects, as well as add, delete, and update them.
com.crystaldecisions.sdk.occa.pluginmgr This package manages the deployment of desktop plugins.
com.crystaldecisions.sdk.occa.security This package contains interfaces that allow you to interact with the security session.
com.crystaldecisions.sdk.plugin This package is the base level package for all BusinessObjects Enterprise plugins.
com.crystaldecisions.sdk.plugin.admin.apsadmin This package has been deprecated.
com.crystaldecisions.sdk.plugin.admin.auditadmin This package allows you to create a log of user-generated events, which can then be analyzed.
com.crystaldecisions.sdk.plugin.admin.cachepageserveradmin This package provides interfaces through which you can monitor and manage the behavior of each Crystal Reports Cache Server and each Crystal Reports Page Server.
com.crystaldecisions.sdk.plugin.admin.cmsadmin This package allows you to retrieve the metrics specific to a CMS cluster.
com.crystaldecisions.sdk.plugin.admin.eventserveradmin This package allows you to monitor the Event Server and the files that trigger those events.
com.crystaldecisions.sdk.plugin.admin.fileserveradmin This package allows you to monitor and manage a file server.
com.crystaldecisions.sdk.plugin.admin.jobserveradmin This package allows you to monitor a Job Server and includes metrics on the scheduled jobs, object types and process types.
com.crystaldecisions.sdk.plugin.admin.reportappserveradmin This package allows you to perform a number of Report Application Server (RAS) server tasks.
com.crystaldecisions.sdk.plugin.admin.ssoadmin This package allows you to manage the cache expiry time for single sign-on (SSO) authentication.
com.crystaldecisions.sdk.plugin.admin.wcsadmin This package has been deprecated as of BusinessObjects Enterprise XI.
com.crystaldecisions.sdk.plugin.authentication.enterprise This package allows you to configure the settings for users who log on to the system with the secEnterprise authentication method.
com.crystaldecisions.sdk.plugin.authentication.ldap This package allows you to map groups and their members from your LDAP user database to BusinessObjects Enterprise, verify all logon requests that specify LDAP and third-party single sign-on (SSO) authentication, and utilize the Secure Socket Layer (SSL) protocol to ensure that data transmitted across a network is not compromised.
com.crystaldecisions.sdk.plugin.authentication.secwinad This package contains interfaces that allow you to map users and groups from a Windows 2000 Active Directory (AD) user database to BusinessObjects Enterprise, verify all logon requests that specify AD authentication, and provide Kerberos single sign-on (SSO) access to AD group members.
com.crystaldecisions.sdk.plugin.authentication.secwinnt This package contains two interfaces that allow you to map groups and their members from your Windows NT user database to BusinessObjects Enterprise, and verify all logon requests that specify Windows NT Authentication.
com.crystaldecisions.sdk.plugin.desktop.calendar This package contains five classes that provide a framework that allows you to create and manage business calendars.
com.crystaldecisions.sdk.plugin.desktop.common This package allows you to gather and set processing information on a Crystal report or Web Intelligence document before or after scheduling it.
com.crystaldecisions.sdk.plugin.desktop.connection This package allows you to retrieve the metrics for each connection to a single Central Management Server (CMS) or for each active connection to each CMS in a cluster.
com.crystaldecisions.sdk.plugin.desktop.event This package provides an interface through which file events, schedule events, and user events can be created and monitored.
com.crystaldecisions.sdk.plugin.desktop.excel This package allows you to view reports formatted as Excel spreadsheets.
com.crystaldecisions.sdk.plugin.desktop.folder This package provides the ability to work with Folder objects.
com.crystaldecisions.sdk.plugin.desktop.hyperlink This package provides the ability to retrieve and set the url of Hyperlink objects.
com.crystaldecisions.sdk.plugin.desktop.licensekey This package allows you to monitor license key information, and add additional license keys.
com.crystaldecisions.sdk.plugin.desktop.objectpackage This package provides the functionality to use Object packages.
com.crystaldecisions.sdk.plugin.desktop.pdf This package allows you to view reports formatted as PDF documents.
com.crystaldecisions.sdk.plugin.desktop.powerpoint This package allows you to view reports formatted as PowerPoint documents.
com.crystaldecisions.sdk.plugin.desktop.program This package enables you to add non-BusinessObjects Enterprise objects into the BusinessObjects Enterprise Infrastructure.
com.crystaldecisions.sdk.plugin.desktop.report This package is designed to provide an interface through which detailed information about each report may be obtained.
com.crystaldecisions.sdk.plugin.desktop.rtf This package allows you to view reports formatted as RTF documents.
com.crystaldecisions.sdk.plugin.desktop.server This package allows you to manage servers in the BusinessObjects Enterprise system.
com.crystaldecisions.sdk.plugin.desktop.servergroup This package allows you to manage groups consisting of servers or server groups.
com.crystaldecisions.sdk.plugin.desktop.shortcut This package represents a shortcut object that behaves in a similar manner to a Windows Shortcut; that is, it can reference another object.
com.crystaldecisions.sdk.plugin.desktop.txt This package allows you to view reports formatted as text files.
com.crystaldecisions.sdk.plugin.desktop.user This package provides an interface through which an administrator can set the specific behavior of each user in the Enterprise system.
com.crystaldecisions.sdk.plugin.desktop.usergroup This package allows you to manage user groups and their group associates.
com.crystaldecisions.sdk.plugin.desktop.word This package allows you to view reports formatted as Word documents.
com.crystaldecisions.sdk.plugin.destination.diskunmanaged This package provides an interface through which the destination options for a disk can be specified.
com.crystaldecisions.sdk.plugin.destination.ftp This package provides an interface through which the destination options for FTP can be specified.
com.crystaldecisions.sdk.plugin.destination.managed This package contains two classes that provide a framework through which managed destination options can be maintained.
com.crystaldecisions.sdk.plugin.destination.smtp This package provides an interface through which the destination options for email can be specified.
com.crystaldecisions.sdk.properties This package is designed to provide an interface through which detailed information about IInfoObject properties can be retrieved.

 

This document is the API specification for the BusinessObjects Enterprise Java SDK.

The BusinessObjects Enterprise Java SDK is a Software Development Kit that provides you with the tools for building scalable web applications. These applications can be divided into two categories: applications that allow users to perform client tasks, such as viewing, scheduling, and exporting reports, and applications that enable administrators to perform administrative tasks, such as managing servers, creating user and groups, gathering metrics, and handling security.

Client tasks

The BusinessObjects Enterprise Java SDK provides you with the tools and components to design a client desktop with the following functionality:

Administrative tasks

The BusinessObjects Enterprise SDK allows you to create your own management tools-- ones that can perform administrative tasks such as the following:

Note: The com.crystaldecisions.sdk.occa.managedreports package is no longer a component of the BusinessObjects Enterprise Java SDK. It's functionality can now be accessed from the Report Application Server (RAS) SDK.

Related Documentation