ReportCaster API Functionality
The ReportCaster API consists of packaged Java classes
published by Information Builders. The ReportCaster API enables
developers to use JavaServer Pages (JSP) technology or a Java application
to create an independent, customized application that offers the
features of ReportCaster.
x
The ReportCaster API provides
methods that enable you to:
- Create a new
Address Book.
- Add a line
to an existing Address Book, which includes destination address
and burst value.
- Retrieve an
Address Book from a repository.
- Retrieve a
list of all public Address Books for a specific distribution method.
- Retrieve a
list of all private Address Books belonging to a specific owner
for a specific distribution method.
- Update an existing
Address Book by adding a new destination or burst value.
- Delete an Address
Book.
- Delete a line
from an Address Book, which includes destination address and burst value.
x
The ReportCaster API provides
methods that enable you to:
- Create a report
schedule specifying the run time, distribution method (email, FTP,
printer, Managed Reporting, or Report Library), notification parameters,
report format, and whether to burst the report.
- Schedule alerts.
- Schedule the
distribution of a file or the contents of a URL.
- Schedule a
Managed Reporting procedure.
- Retrieve a
list of scheduled Managed Reporting procedures.
- List the procedures
(FOCEXECs) on the default WebFOCUS Reporting Server available for
scheduling.
- Specify whether
to use a Distribution List, distribution file name, single destination, or
dynamic address list.
- Specify whether
the report output should be sent within the body of the email (inline)
or as an attachment (email distribution only).
- Update a schedule.
- Delete a schedule.
- Retrieve a
list of existing schedules.
- Retrieve the
properties and details of a schedule.
- Run a job once
at a specific time without storing the schedule information in the WebFOCUS
repository.
x
The ReportCaster API provides
methods that enable you to:
- Distribute
reports to the Report Library.
- Manage content
of the Report Library.
- Track versioning.
- View content
in the Report Library.
- Create an Access
List.
- Manage the
contents of an Access List.
xReportCaster Console Options
The ReportCaster API provides
methods that enable you to:
- Query the ReportCaster
Distribution Server queue to show a list of pending jobs.
- Query the ReportCaster
Distribution Server queue to show a list of running jobs.
- Change priority
of a job from the default (3).
- Delete a pending
job from the queue.
- Suspend and Resume
the Distribution Server.
- Get the status of
the Distribution Server.
x
The ReportCaster API provides
methods that enable you to:
- Retrieve the
list of schedules that have log information stored in the WebFOCUS
repository.
- Retrieve log
information for a specific schedule.
- Retrieve log
information based on log field values and specified conditions.
- Purge log records
for a specified schedule.
- Purge log records
based on log field values and specified conditions.