Actuate BIRT Studio URIs Reference
BIRT Studio is a web application that is initiated by a Java servlet. The BIRT Studio servlet manages binary content and performs tasks such as uploading and downloading binary files.
You invoke the BIRT Studio servlet using the following syntax:
http://<web server>:<port>/<context root>/wr
*web server is the fully qualified domain name or IP address of the machine hosting the web or application server.
*port is the port on which the application server listens for requests.
*context root is the BIRT Report Studio context root.
*wr is the name to which the servlet is mapped in the web application’s web.xml file. A typical location for web.xml is <context root>\WEB-INF.
Servlet names are case‑sensitive. Do not modify the servlets, their names, or their mapping in web.xml.
BIRT Studio
The BIRT Studio servlet loads the BIRT Studio user interface and establishes a connection to a report repository. A report repository is required in order to use the servlet.
Name
com.actuate.erni.servlet.ERNIViewerServlet
Invoke the BIRT Studio servlet as:
http://<web server>:<port>/<context root>/wr?<parameters>
URI parameters
The BIRT Studio servlet requires repository parameters in order to operate. Table 5‑2 lists and describes the URI parameters for the BIRT Studio servlet.
Table 5‑2 BIRT Studio URI parameters
URI parameter
Description
repositoryType
The repository type. Use Enterprise for a volume.
serverURL
The URL of a web or application server machine.
volume
The name of a volume that is managed by the URL to which you connect.
__vp
The name of a server configured in VolumeProfile.xml. BIRT Studio uses the volume information in a VolumeProfile entry except when a volume parameter specifies a different one.
In addition to the initial BIRT Studio page, you can open BIRT Studio with:
*A specific report design
*A specific template
*A report design that accesses a specific information object
*A report design that accesses a specific information object and a report template
In the example URLs in the following topics, special characters are represented by codes, as shown in Table 5‑3.
Table 5‑3 Codes for special characters in URLs
Character
Code
Colon (:)
%3a
Slash (/)
%2f
Period (.)
%2e
Space ( )
%20
To open an existing report design in BIRT Report Studio, use a URL like the one shown in the following example:
http://urup.domain.com:8080/ajc/wr?__report=
%2fApplications%2fBIRT%20Sample%20App%2fCustomer%20Order%20History.rptdesign&pCountry=USA
*__report=%2fApplications%2fBIRT%20Sample%20App%2fCustomer%20Order%20History.rptdesign is the path to the report design to use.
*pCountry=USA is a parameter-value pair for the report design.