Orgnazition of This Part

Transcription

1 Orgnazition of This Part

2 Table of Contents Tutorial: Organization of This Part...1 Lesson 1: Starting JReport Enterprise Server and Viewing Reports...3 Introduction...3 Installing JReport Enterprise Server...3 Starting JReport Enterprise Server...3 Setting up Reporting Environment if Necessary...3 Viewing Demo Reports...4 Viewing Demo Reports with a Web Browser...4 Lesson 2: Scheduling Tasks...5 Example 1: Publishing Reports to Versioning System...5 Example 2: Publishing Reports to File System...6 Example 3: Publishing Reports to E Mail...6 Example 4: Publishing Reports to Printer...6 Example 5: Publishing Reports to Fax...7 Lesson 3: Resource Tree...8 Introduction...8 Deploying Resources...8 Lesson 4: Security...9 Creating a New User...9 Auditing a Specific User...9 Creating a New Group...9 Creating a New Role...9 Assigning Permissions...10 I

3 Tutorial: Organization of This Part The Tutorial book covers the basic server configuration, administration and accessing instructions. After walking through the tutorial, you will be able to use the server for managing the interaction between client and server to enable activities such as scheduling and running reports. The book has the following chapters: Lesson One: Starting JReport Enterprise Server and Viewing Reports. Lesson Two: Scheduling Tasks. Lesson Three: Resource Tree. Lesson Four: Security JReport Manual Roadmap The following picture lists the other books in the JReport Designer manual, JReport Enterprise Server manual and JREntViewer manual, and the relationship between them. You are advised to get started from the JReport Designer manual. With some report designing knowledge, it is easy to learn JReport Enterprise Server in the server/client architecture. JReport Designer manual includes four books: Getting Started, Tutorial, User's Guide, User Reference. For SanFrancisco users, we have an individual manual: SanFrancisco Integration Manual. JReport Enterprise Server (abbreviated as JREntServer) manual has three books: Getting Started, Tutorial, User's Guide. In addition, the JREntViewer manual is for using JREntViewer for JREntServer. For a complete coverage of the features, operations and other information, please refer to the specific book: JReport Designer Getting Started An introduction to JReport. It covers issues associated with installation, setup, and configuration of JReport Designer. It is a combination of informational topics and strategic references to various topics in the Pro User's Guide and Pro User Reference. 1

4 Tutorial: Organization of This Part JReport Designer Tutorial Basic report building instructions. This includes the reporting features that you will find useful. The idea is that after you have walked through this Tutorial, you can easily follow the examples and build your own reports. For in depth feature coverage like building reports on XML, EJB, stored procedure, SQL file, please refer to the User's Guide. JReport Designer User's Guide In depth coverage of JReport Designer's features and generally explains how to do different things with the product. Browse to locate the chapters that are of interest to you for step by step instructions. JReport Designer User Reference Specifications, providing technical, system and other reference information related to the JReport built in objects, built in formula functions and APIs. JREntServer Getting Started An introduction to JReport. It covers issues associated with installation, setup, and configuration of JReport Enterprise Server. It describes most informational topics and references in the server User's Guide. JREntServer User's Guide Procedures to get a more in depth understanding of JREntServer. We show the steps involved in advanced server features like JSP, national language support, server API, application server integration, JReport (Client) Viewer Bean. JREntViewer Manual Complete coverage of features and instruction in using JREntViewer against JREntServer. The Client API usage is also introduced in this book. SanFrancisco Integration Manual Integration notes of JReport with IBM SanFrancisco, making IBM SanFrancisco application data ready/available for reporting, step by step instructions on how to wrap SanFrancisco BO or Bean to JReport Printable Object, through which a report 2

5 Introduction Lesson 1: Starting JReport Enterprise Server and Viewing Reports In this lesson, you will learn how to set up JReport Enterprise Server on Windows NT, and how to view reports that are shipped to JReport Enterprise Server with JReport Enterprise Viewer or a common web browser. Installing JReport Enterprise Server To install JReport software, take the following steps. 1. Download the JReport install program EnvSvrSetup.exe from the Jinfonet web site: 2. Run EnvSvrSetup.exe and follow the prompts to install the software. In this lesson, we assume that you installed JReport Enterprise Server under C:\JREntServer. Reference Note: User's Guide Installing and Launching JReport Enterprise Server Starting JReport Enterprise Server From an MS DOS command prompt, issue the commands below: c:\> cd jrentserver\bin c:\jrentserver\bin\>jrentserver When you see the following information: Please send feedback about this product to support@jinfonet.com. Visit site for more information. JReport Enterprise Server is ready for service. JReport Enterprise Server is loaded and ready for service. Reference Note: User's Guide Installing and Launching JReport Enterprise Serve. Setting up Reporting Environment if Necessary Our sample uses a JDBC hsql bridge, but if you access JDBC data source, OOJDBC data source, user data source, or any other external classes, before you start the server, you need to add all the necessary classes into the classpath option set in the batch file starting the server. Let us take JDBC driver for example. To have catalogs and reports that are deployed to your JReport Server connect with their JDBC data source, you need to install relative database drivers and set the run time environment of JReport Server before the server starts up: 1. Install the JDBC Driver according to the instructions of the JDBC driver provider. 2. Edit <installroot>\bin\jrentservert.bat to include the JDBC driver to the classpath. <installroot> as the path where you installed JReport Enterprise Server. For example, your catalog uses the Oracle JDBC driver, edit JREntserver.bat to append the archive file of Oracle thin driver to classpath: change:... classpath "C:\JREntServer\lib\JRESServlets.jar;...;C:\TEMP"... To :... classpath "C:\JREntServer\lib\JRESServlets.jar;...C:\orc\thin\lib\classes111.zip;C:\TEMP"... For your convenience, after entering the JDBC URL, User Name and Password, you can leave JDBC Driver empty and give it in a 3

6 Lesson 1: Starting JReport Enterprise Server and Viewing Reports property file jdbcdrivers.properties. Note: This file must be located under %installroot%\bin directory for JReport Enterprise Server The format of the file is: jdbc.drivers=jdbcdrivername:jdbcdrivername:... Where, JDBCDriverName is the JDBC driver name that can be auto loaded when JReport server starts up and a colon : is the delimiter between two driver names. JReport will search from the first and find the one which can work with the driver, URL, User Name and Password in the catalog. Below is an example jdbcdrivers.properties file which specifies the Oracle thin driver and Interbase thin driver. jdbc.drivers=oracle.jdbc.driver.oracledriver:interbase.interclient.driver where oracle.jdbc.driver.oracledriver and interclient.driver are two JDBC Driver names. Viewing Demo Reports Here assume that: The IP of the machine where the server runs is The port which the server listens to is JReport Enterprise Server is started for service. Viewing Demo Reports with a Web Browser 1. Load a web browser (here we use IE), then input the home page of the server in the address bar. You are required to input your user name and password to login. 2. After logging in, the home page of JReport Enterprise Server will be shown. There is a resource tree in the left panel of the home page. Click the folder of the resource tree, the corresponding folder contents will be displayed in the right panel. 3. Browse to the folder which contains the report you want to view and click to open it. Click the report name or click the corresponding Run or AdvancedRun to view the report. You can view the report in the default format by clicking the report name or Run and clicking AdvancedRun enables you to view the report in the format you want. 4. There are some other operations you can do to the reports. Schedule Schedule a task for the reports. You can perform the task at a specified time or periodically. Versions See the versions of the report. Properties See the properties of the report. Delete Delete the report. 4

7 Lesson 2: Scheduling Tasks JReport Enterprise Server enables reports to be scheduled to run at a specific time or periodically. The build in tasks to schedule include Publish to Versioning System, Publish to File System, Publish to E mail, Publish to Printer and Value Based Trigger. In this lesson, you will learn two examples to schedule tasks to generate report versions and publish the report result to file system. For more detailed information about scheduling tasks, please refer to User's Guide Accessing JReport Enterprise Server. Example 1: Publishing Reports to Versioning System In this example, a task is set up and will be performed immediately. And the generated result is asked to be kept for 30 days. 1. Assume that JReport Enterprise Server is installed under C:\JREntServer. In the Command Prompt window, type in the following commands to start JReport Enterprise Server. C:\>cd JREntServer\bin C:\JREntServer\bin>JREntServer 2. To access the administration page of the server through IE browser, in the address bar, type in Here, the port number refers to the port on which the server listens (by default, it is 8888). If you don't know the IP of the machine on which the server runs, and if it is the same machine where you run your web browser, you can use localhost instead of the IP. Type in the user name and the password to access the home page of the server. 3. Browse to the folder which contains the report you want to schedule and click to open it. Click the corresponding Schedule, and then the schedule wizard appears. 4. On the Report tab, select the report and catalog version and input the parameter value in the box or select a value from the drop down list for the report (if the report has parameters). If the report has a style group, select the Enable Style Group check box and then choose the style group. Define the encoding and the time zone for the report. Check Use the default DB user and password defined in catalog. Click the Next button or the Publish tab to continue scheduling the task. 5. On the Publish tab, click To Version and then check Publish to Versioning System. Select the format you want and do the corresponding format settings. Save the result in the built in version folder and set 0 for the Max result version amount. Define the report expire in 30 days and then go to the Time tab to specify the time when the task is performed. 5

8 Lesson 2: Scheduling Tasks 6. In the Select time type to publish drop down list, choose Run this task immediately. 7. If you want to notify someone when the task is finished by the server by sending e mails, go to the Notification tab to do the settings. 8. Click Submit to let the server perform the task. Click the Schedule on the top banner. When the task is performing, you can get the record of this task in the Active table and it will be put into the Completed table when the task is finished by the server. Example 2: Publishing Reports to File System In this example, you will learn to set up a task to publish the results to various file formats repeatedly in the specified period. 1. Do the same 1, 2, 3 and 4 operations as Example On the Publish tab, click To Disk and then check Publish to File System. Select the format you want, type in the name of the result file and then do the corresponding settings according to your own requirement. Go to the Time tab to specify the time when the task is performed. 3. In the Select time type to publish drop down list, choose Run this task periodically. Select Daily from the Day(s) drop down list and define to repeat every one day. Select update at form the Time drop down list and specify the time as 9:00 AM. 4. If you want to notify someone when the task is finished by the server by sending e mails, go to the Notification tab to do the settings. 5. Click Submit to let the server perform the task. Click Schedule on the top banner, the scheduled task is recorded in the Scheduled table. Since you have not specify the duration during which the task will be performed by the server, the task will not stop being performed until you delete or disable it in the Scheduled table. Example 3: Publishing Reports to E Mail In this example, you will learn to set up a task to publish the report results to e mail. 1. Do the same 1, 2, 3 and 4 operations as Example On the Publish tab, click To E mail and New button to create a new e mail or click Edit button to edit a specified e mail in the Mail To list. 3. Fill in every field with correponding information. Select the format you want to export the report result to e mail and do the corresponding settings according to your requirements. Go to the Time tab to specify the time when the task is performed. 4. In the Select time type to publish drop down list, choose Run this task at and specify the date for the task. 5. If you want to notify someone when the task is finished by the server by sending e mails, go to the Notification tab to do the settings. 6. Click Submit to let the server perform the task. Click the Schedule on the top banner. When the task is performing, you can get the record of this task in the Active table and it will be put into the Completed table when the task is finished by the server. Example 4: Publishing Reports to Printer In this example, you will learn to set up a task to publish the report result to printer. 1. Do the same 1, 2, 3 and 4 operations as Example On the Publish tab, click To Printer and then check Publish to Printer. Select a JDK print method for the report result in the Select Print Method field, and then type a name with path of the printer in the Printer filed or select it from the drop down list. Go to the Time tab to specify the time when the task is performed. 3. In the Select time type to publish drop down list, choose Run this task immediately. Select Daily from the Day(s) drop down list and define to repeat every one day. Select update at form the Time drop down list and specify the time as 9:00 AM. 6

9 Lesson 2: Scheduling Tasks 4. If you want to notify someone when the task is finished by the server by sending e mails, go to the Notification tab to do the settings. 5. Click Submit to let the server perform the task. Click the Schedule on the top banner. When the task is performing, you can get the record of this task in the Active table and it will be put into the Completed table when the task is finished by the server. Example 5: Publishing Reports to Fax In this example, you will learn to set up a task to publish the report result to fax. Before you can fax the report result, you must have your modem configured; otherwise a warning message will display when you try to export to fax. 1. Do the same 1, 2, 3 and 4 operations as Example On the Publish tab, click To Fax and then check Publish to Fax. Fill every field with corresponding information and do correponding settings according to your own requirement. Go to the Time tab to specify the time when the task is periformed. 3. In the Select time type to publish drop down list, choose Run this task periodically. 4. If you want to notify someone when the task is finished by the server by sending e mails, go to the Notification tab to do the settings. 5. Click Submit to let the server perform the task. Click the Schedule on the top banner. When the task is performing, you can get the record of this task in the Active table and it will be put into the Completed table when the task is finished by the server. Index Index 7

10 Lesson 3: Resource Tree Introduction Resources on JReport Enterprise Server are organized in a tree structure, which is called Resource Tree. The resource tree holds folders under its root, and the resources reside in folders. Only the resources that are organized in the resource tree can be accessed and queried by the client. When you access JReport Enterprise Server, the resource tree is displayed in the left panel of the page. The resource tree consists of folders which contain the report documents and executable reports. Click a folder on the resource tree, the contents of the folder will be shown in the left panel. There are two built in folders under the resource tree root Public Reports and My Reports. You can create your own folders in either of them. The Public Reports folder and My Reports folder cannot be deleted. Deploying Resources Before you can perform any tasks on JReport Enterprise Server, you need to have your own resources deployed and organized. There are several ways to deploy resources (catalogs, reports, or folders) from outside: deploying reports using JReport Designer, depoly resources from local computer, and deploy resources from remote computer. For example, deploying a folder from local computer: 1. In the folder where you want to deploy resources, click deploy. Here we click the Deploy in the Public Folder. 2. On the Properties tab, click Local Deploy. 3. Type a resource name in the Resource Name box. Here we use Test. 4. Provide the real path for the File or Folder Name field. If the resource type is report or catalog, please include the file name in the path. You can also click the Browse button to find the file or folder you want. 5. Type a brief description to describe the resource in the Description box. It can be anything you like. 6. Select a resource type in the drop down list. Please make sure the resource type consists with the resource real path, as mentioned in step 4. Here we choose Folder. 7. Apply the archive policy as you like. 8. Click Submit to start to deploy the folder. After the folder is deployed successfully, you can see the newly deployed folder Test displayed on the resource tree. Index Index 8

11 Lesson 4: Security JReport Enterprise Server provides a security system for you to set up and maintain security on the server and protect the resources on the server from inappropriate access by users. In this lesson you will learn how to manage security in JReport Enterprise Server. Creating a New User To use JReport Enterprise Server, you must have a user account, which consists of a unique user name and a password. JReport Enterprise Server verifies your identity when you type your user name and your password and then log on. If your user account has been disabled or deleted, JReport Enterprise Server prevents you from accessing the web services that JReport Enterprise Server provides, in order to ensure that only valid users have access. JReport Enterprise Server comes with two built in user accounts, which are admin and guest. The built in user accounts cannot be deleted. The Admin user account can neither be deleted nor disabled. To create a new user, 1. Log on to JReport Enterprise Server using the administration port, which is 8889 by default. 2. Click Security on the top banner, click User. 3. Click Create a new user. 4. Finish the options on the New User dialog and click OK to create the new user. Now you can find the newly created user in the user list. Auditing a Specific User JReport Enterprise Server can record user access and management information in the log files by auditing the user. To audit the user, 1. Log on to JReport Enterprise Server using the administration port, which is 8889 by default. 2. Click Security on the top banner, click User. 3. Click the corresponding Auditing link. 4. On the Auditing dialog, specify which kind of event you want the server to record in the log file and in what case the event will be recorded, successful or failed. Creating a New Group The principle group, which represents an organization of user accounts, is available for managing users. Users or groups can be added into a group as its sub members, and therefore inherit the resource and folder permissions from the group. To create a new group, 1. Log on to JReport Enterprise Server using the administration port, which is 8889 by default. 2. Click Security on the top banner, click Group. 3. Click Create a New Group. 4. Finish the options on the New Group dialog and click OK to create the new group. Creating a New Role Users must have certain user rights and permissions to perform tasks on certain resources. Roles help you efficiently assign those user rights and permissions to users. Assigning one or more roles to users gives the users all of the user rights and permissions the roles have to perform their jobs with. A role can also be assigned to other groups or roles, and hence the groups or roles will inherit the resource and folder permissions that the roles have. JReport Enterprise Server comes with two built in roles, which are administrators and everyone. The built in roles cannot be deleted. 9

12 Lesson 4: Security To create a new role, 1. Log on to JReport Enterprise Server using the administration port, which is 8889 by default. 2. Click Security on the top banner, click Role. 3. Click Create a new Role. 4. Finish the options on the New Role dialog and click OK to create the new role. Now you can find the newly created role in the role list. Assigning Permissions Permissions, associated with resources and folders, are the rules that are granted to users to control their access to resources and folders. The permissions include: Visible, Read, Write, Deleted, Execute, Schedule, and Grant. After you set permissions on a parent folder, new resources and subfolders created in the folder inherit these permissions. If you do not want them to inherit permissions, enable their user permissions and set their permissions separately. The resources and folders will inherit permission from their parent folder if their user permissions are not enabled. To set, view, change, or remove resource and folder permissions, find the resource to which you want set permissions and click its Properties. Check Enable User Permissions, and then do the operations according to your own requirements. Index 10