Installing Report Module

This topic describes the system requirements, required files, and installation steps required to install the Report Module.

System Requirements

The following system requirements support Report Module:

• CygNet v9.2 or later, with all patches applied
• Dedicated GRP service for required file storage (see Step 1 below)
• HSS and MSS services required for report scheduling
• CygNet ODBC driver required for SQL-based reports

Required Files

The Report Module uses the following required files:

Installation Steps

To install the Report Module, you will need to perform the following steps:

1. Create a dedicated storage service to store Report Module definitions, templates, and published reports.
2. Run the ReportModuleSetup.exe installer.
3. Configure Version Management to deploy the Report Module to clients.
4. Store the report template file.
5. Customize the CygNet Studio screens.
6. Configure the Report Module settings for your environment.

1. Create a Storage Service

The Report Module uses a CygNet Group service to store files in a central location so they can be accessed by client or service machines. This GRP service should be exclusive to the Report Module and can be used to store generated reports for easy distribution.

We recommend calling this service STORAGE.

If your system is based on CygNet for Production, you probably already have a STORAGE or GRP_BSS installed.

Steps for adding a new service:

1. Using Windows Explorer, open your CygNet\Services directory and create a new service folder there. (Optionally, create two new folders on different drives: one for executables and one for data.)
2. Copy the required service start-up files to your new Services\XXX folder.
3. Edit the service .cfg file in one of the following two ways:
   • Use the Config File Manager.
   • Use a text editor to manually edit the file. For instance, replace relevant instances of XXX with the correct site name for the service. See also Configuration File Keywords.
4. Add the new service to the relevant Address Resolution Service (ARS).
   1. Using CygNet Explorer, open the ARS, right-click in its service pane, and click New.
   2. In the New Service dialog box, select the Service Type. See ARS Service Types.
   3. Type the Site and Service names.
   4. Type a Description for the service and click OK.
5. Add the new service to the Remote Service Manager (RSM).
   1. Using CygNet Explorer, open the RSM, right-click in its service pane, and click New.
   2. In the New RSM Entry dialog box, select the new service and confirm or alter its default settings.
   3. Optional: If the service executable and data folders are not under the same Services folder, type their directory paths in the Executable and Data fields respectively.
   4. Optional: Click Automatic Service Recovery… and configure recovery settings.
   5. Click OK to save RSM settings.
6. Once the service is added to the RSM, right-click its entry in the RSM and click Start.
7. Add security settings for the new service. See Implementing Security.
8. Associate other services with the new service. Which service(s) you associate depends on the service(s) involved. See specific service documentation for more information.
   1. Using Windows Explorer, open your CygNet\Services directory and locate the associated service folder.
   2. Open the associated service folder, and open the configuration file found there.
   3. Go to the Associated Services section of the .cfg file and either un-comment-out the service entry or add a service entry in the same format as other associated services.
   4. Save and close the .cfg file.
   5. In CygNet Explorer, go to the RSM, locate the affected associated service in the service pane, right-click it, and click Restart. This completes the association process.
   6. Repeat steps a - e for each associated service.
9. Now that your new service is installed and added, configure it to suit your needs. See specific service documentation for more information.

2. Install Files

Obtain the product source files from the CygNet Download Site (login required).

Extract the source files from the ReportModule.zip and run the installer, ReportModuleSetup.exe.

ReportModuleSetup.exe will take care of most aspects of setting up the Report Module on your system, including uploading the necessary libraries to your CygNet services. To ensure these files are installed on client systems, see the next step.

3. Configure Version Management

The setup program will install "ReportModule.rsp" in your APPS service, but in order for the reports to work, some other file needs to invoke "ReportModule.rsp". Typically this is done in the "StudSupp.rsq" file in APPS\SUPPORT. If this file doesn't exist you will need to create it. Please refer to the Version Management section for more information. You may make the required changes in a different file if you wish.

A typical "StudSupp.rsq" file looks like this:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# Installation specific version management file for CygNet Studio and CygNet Vision
################################################################
 
################################################################
# Add any custom entries to this file to ensure changes are not
# lost in the next update process.
################################################################
#
[SUPPORT]..\SUPPORT\ProEssGraph.rsp
[SUPPORT]..\SUPPORT\CXEXPORT.DLL <REGISTER>
 
[SUPPORT]..\Support\ODBC\CygNetODBC.rsp
[SUPPORT]..\Support\CR11\CR11.MSI <SHELLEXECWAIT=/qn /i>
 
[SUPPORT]..\SUPPORT\CxHMIRsm.OCX <REGISTER>
[SYSTEM]<SYSTEM>\RICHTX32.OCX <INUSENOMSG> <CREATENEW> <REGISTER>
 
[SUPPORT]..\Support\ReportModule.rsp
[SUPPORT]..\Support\CxXlsxViewer.rsp

The last two line items above are the important ones to include in your StudSupp.rsq file for module to function properly.

4. Configure Report Module

Using CygNet Studio open the SITENAME.BSS\M_RPT\ReportModuleConfiguration.csf file to configure the Report Module. See Configuring the Report Module for more information.

A Note About the Report Module CygNet Studio Screens

The CygNet Studio screens installed by the Report Module setup make up a complete set of screens required to configure the Report Module, create or edit a report definition file, schedule a report, and manage the storage of the report definitions file in the STORAGE Group service. The screens can be viewed alone in CygNet Studio or Vision, although they are included as nested views in the parent screen MainReportingScreen.csf (Report Module), which contains four tabs:

• MainReportingScreen.csf (Report Module)
  • Define Reports Tab contains ReportConfig.csf (Report Configuration)
  • Schedule Report Tab contains ReportScheduler_schedule.csf (Report Scheduler)
    • ReportScheduler_reportchooser.csf (Select Reports to Schedule...)
  • Group File Management Tab contains StorageManager.csf (Group File Management)
  • Module Config Tab contains ReportModuleConfiguration.csf (Report Module Configuration)
• ReportViewer.csf (Report Configuration)

The screens can be customized to suit your enterprise and environment as necessary.