Overview of the Repository

The repository is a hierarchical structure of folders where JasperReports Server, administrators, and users store resources for creating and analyzing reports. In its appearance and function, the repository resembles a file system with a hierarchical structure of folders that contain resources. Internally, the repository is implemented as a database that is private to the server instance.

Folder Structure

The root of the repository tree structure is accessible only to the system admin logged in as superuser (See "Root of the Repository Showing Top-Level Organization Folders"). It contains the folders for each organization and folders for certain configuration settings.

In the repository, each organization has its own branch, contained in a folder named after the organization. Each organization’s top-level folder also contains a folder called Organizations so that sub-organizations can be created.

See "Root of the Repository Showing Top-Level Organization Folders" shows the superuser’s view, starting at root. In the Organizations folder there is a folder for the default organization, which is named “Organization.” At installation, the Organization folder has no resources; all of its resources are in subfolders.

JasperReports Server automatically restricts every user’s access to their own organization’s branch of the repository. Superuser/system admins can view and create folders in all organizations; organization admins can only view and create folders in the organizations they administer.

Resources

Resources are stored in the repository and used as input for creating reports and performing analysis. Certain resources, such as images, fonts, or JRXML files created in iReport, are uploaded from files. Others, such as data sources and Domains, are created in JasperReports Server. Of course, reports can also be saved in the repository to be run as often as needed, and output such as PDF or HTML can be saved in the repository as well.

Each resource has a unique ID, a name, and an optional description. As in a file system, the names of folders containing the resource give the path to the object. Users locate resources in the repository by browsing through folders, searching for keywords, or by filtering resources, such as by type or date. The repository displays the descriptions in listings or in tooltips to help users understand the contents or purpose of a resource.

Resources are stored in an internal format that is not accessible to users or administrators, although certain objects can be downloaded to your file system in an output format such as XML. Any repository object may be exported to a file with the js-export utility, but the resulting files are for backup or transfer to another JasperReports Server instance and cannot be modified.

JasperReports Server restricts access to folders and resources based on organizations, user names, and roles. The system admin and organization admin can define permissions as explained in section Overview of Users and Roles.

Sample Data

When you install the sample data in JasperReports Server, the default organization (Organization) has folders and objects with typical content. The sample data includes dashboards, reports, Domains, data sources, and many components used in these, such as input types, content files, and image files. Each type of content is stored in a separate folder, making it easy to locate. The Supermart Demo folder contains a complete example of inter-related dashboards, reports, and resources for various business scenarios in a fictional grocery store company.

Every Organizations folder contains a folder named Folder Template. It contains a set of the standard folders for an organization. When a new organization is created, Folder Template is used to create the new organization’s folders. The default folders are Ad Hoc Components, Temp, and themes, but organization admins can add folders and resources in Folder Template to be used in creating additional organizations.

root has a Public folder, which is a special template folder shared with all organizations. The superuser/system admin uses it to add resources (such as data sources, logos, and report templates) for all organizations of the parent organization.

Browsing and Searching

The repository can be browsed and searched. The available features and commands depend on the mode you are using. In many cases, such as editing permissions, you can use either mode, but sometimes only one mode displays the features and commands you need, such as when you copy an object.

•    Browse - On the Home page, click View > Repository.

In Browse mode, the Folders panel on the left lists the folders in the repository and the Repository panel lists the contents of the selected folder.

The menu bar at the top of the Repository panel appears only in Browse mode. It contains commands that are unique to browsing. The commands enable you to move and remove objects in the repository folders. Search mode does not have this feature.

In this example, the commands are Copy, Cut, Paste, and Delete; in other cases they could have Add and Delete, such as when you are adding an organization.

•    Search - On the Home page, click View > Search Results, View > Reports, or View > OLAP Views.

In Search mode, the Filters panel on the left lists filters to use in your search; the Repository panel lists the objects found by your search. You can select one or more filters and/or enter a search term in the field at the top of the Repository panel. If you select multiple filters, the combination is displayed at the top of the panel (All + Reports + Changed by me).