Version: OpCon (Cloud - Current)

Custom Reports

Custom reports in OpCon are built using the BIRT (Business Intelligence and Reporting Tools) framework. You can edit the Continuous-supplied BIRT reports or create entirely new ones to meet specific reporting requirements.

Reports are run by BIRTRptGen.exe, located in [[SMAOpConPath]]\Utilities\. You schedule them as Windows jobs in Enterprise Manager and copy the finished .rptdesign files to the SAM BIRT ReportEngine folder.

Install the BIRT Environment

To set up a standalone environment for designing reports, complete the following steps:

Create a directory to hold the BIRT environment (referred to below as the BIRT directory). This directory will contain everything needed for report design.
Create a projects subdirectory inside the BIRT directory.
Locate the jtds-1.2.5.jar file and copy it to the BIRT directory.
Download BIRT for your environment from the Eclipse BIRT archive: http://archive.eclipse.org/birt/downloads/build.php?build=R-R1-3_7_1-201109131734
Move the downloaded file to the BIRT directory.
Extract the zip file into the BIRT directory.
Go to the eclipse subdirectory and select eclipse.exe to start the program.
Browse to the projects subdirectory you created in step 2.
Select the Use this as the default and do not ask again option, then select OK.
After Eclipse opens, go to File > New > Project. The New Project wizard opens.
Expand the Business Intelligence and Reporting Tools folder.
Select Report Project, then select Next.
Enter OpCon_Reports in the Project name field. Leave Use default location selected.
Select Finish.
When asked if you want to open the Report Designer perspective, select Remember my decision, then select Yes.
Select the x on the Welcome tab to close the Welcome screen if it is displayed.

The workspace opens in the Report Designer perspective.

Result: The BIRT Report Designer environment is ready for use.

Import the Continuous-Supplied Reports

To import the predefined OpCon reports into your BIRT project, complete the following steps:

Go to File > Import. The Import wizard opens.
Expand the General folder.
Select File System, then select Next.
Browse to the reports subdirectory under the Enterprise Manager directory.
Select the reports folder to include all of its subdirectories, then select OK.
Select the reports folder option in the left pane.
Enter OpCon_Reports in the Into folder field if it is not already populated.
Select Finish.

Result: The Continuous-supplied reports are available in the OpCon_Reports project and you can now edit them or use them as the basis for new reports.

Create a New Report

To create a new custom report, complete the following steps:

Right-click OpConXPS_Reports in the Navigator pane.
Select New > Report.
Enter a file name for the report, then select Finish.
Go to the OpConXPS_Libraries folder in the Resource Explorer.
Expand opconxps_library.rptlibrary > data sources.
Right-click opconxps and select Add to Report.
Select the Data Explorer tab.
Select opconxps under Data Sources.
In the Driver Class field, verify the value is net.sourceforge.jtds.jdbc.Driver.
Select Manage Drivers.
Select Add, browse to the BIRT directory, and select the jtds-1.2.5.jar file.
Select OK.

Import the Database Connection Parameters

To connect the report to the OpCon database, import the following parameters from the shared library:

Data_Source_Connection (parameter group): holds database connection settings
User_Id: filters privilege access in the report query

To import the database connection parameters, complete the following steps:

In the Resource Explorer, go to Shared Resources > OpConXPS_Libraries > opconxps_library.rptlibrary > Report Parameters.
Expand the Report Parameters folder.
Right-click Parameter Group - Data_Source_Connection and select Add to report.
Right-click User_Id and select Add to report.

Result: The connection parameters appear in the report's parameter list. Configure each parameter to match your environment:

Parameter	Description	Example
Driver_Class	JDBC driver class; do not change this value	`net.sourceforge.jtds.jdbc.Driver`
Driver_URL	Database URL in the format required by the driver	`jdbc:jtds:sqlserver://servername/databasename`
Database	Name of the OpCon database	`opconxps`
User_Name	Database login user name	—
User_Password	Database login password	—

For a SQL Server named instance, append ;instance=<instance name> to the Driver_URL value.

After you finish editing the report, copy the .rptdesign file from the OpCon_Reports\OpConXPS_Reports folder (for example, C:\BIRT\projects\OpCon_Reports\OpConXPS_Reports) to the reports subdirectory under the Enterprise Manager directory (for example, C:\Program Files\OpConxps\EnterpriseManager x64\reports\OpConXPS_Reports).

Schedule a Custom Report

To schedule a custom report to run automatically, complete the following steps:

Copy the .rptdesign file to [[SMAOpConPath]]\SAM\BIRT\ReportEngine\OpConXPS_Reports on the OpCon server.
In Enterprise Manager, open or create a Schedule.
Add a Windows job. Use the report name as the job name.
Select the Windows primary machine for the job.
In the Job Action field, select Run Program.
In the User Id field, select Use Service Account.
In the Command Line field, enter:
```
[[SMAOpConPath]]\Utilities\BIRTRptGen.exe -rReportName
```
Replace ReportName with the name of your report file (without the .rptdesign extension).
(Optional) Add parameters after the report name using the format -pParameterName=ParameterValue.
In the Working Directory field, enter:
```
[[SMAOpConPath]]\Utilities\
```
Add a Frequency to the job, then build the job.

Result: The report runs on the defined schedule. Output is generated by BIRTRptGen.exe and processed by the SAM BIRT processor.

Install the BIRT Environment​

Import the Continuous-Supplied Reports​

Create a New Report​

Import the Database Connection Parameters​

Schedule a Custom Report​

Install the BIRT Environment

Import the Continuous-Supplied Reports

Create a New Report

Import the Database Connection Parameters

Schedule a Custom Report