2.3 Installing ZENworks Reporting

Before starting the installation, perform the preinstallation tasks. For more information, see Section 2.2, Preinstallation Tasks.

IMPORTANT:You must install ZENworks Reporting only through media. You must not install it by mapping to a network drive. In the case of a Virtual Machine, it is recommended to copy the iso to the device where you want to install ZENworks Reporting, mount the iso as a virtual drive, then launch the installer.

  1. Start the ZENworks Reporting installation program by using one of the following methods:

    • Graphical User Interface (GUI) Installation

      1. Mount the DVD.

        On a Windows device, the installation begins automatically after inserting the DVD. If the installation does not begin automatically, run setup.exe from the mounted drive after inserting the DVD.

      2. On a Linux device, mount the DVD, then run the following command:

        sh /media/cdrom/setup.sh

    • Command Line Installation (Linux only)

      1. Mount the DVD.

      2. To start a command line installation to a directory where all users (including “others”) have “read and execute” access, either mount the DVD or copy the DVD’s files to a temporary location other than the /root directory.

        Ensure that the copied files and their parent directories have “read and execute” access for all the users (including “others”).

      3. Run the following command:

        /mount_location/setup.sh -e

      NOTE:If you are installing ZENworks Reporting on RHEL Operating system with Command Line installation method, then password might appear in clear text format. In this scenario, you must install compat-libstdc++-33-3.2.3-69.el6 package on RHEL Operating system.

    • Silent Mode Installation

      1. Create a silent install configuration file by using the following command:

        setup.exe/setup.sh -s

      2. Open the silent install configuration file in a text editor.

      3. Search for ADMINISTRATOR_PASSWORD=,LDAP_ADMINISTRATOR_PASSWORD=, (Optional) DB_SERVER_PASSWORD=, (Optional) SMTP_SERVER_PASSWORD=,

      4. Specify the actual password.

        For example, if the password is novell, then the entry will be ADMINISTRATOR_PASSWORD=novell

      5. Save the silent install configuration file and exit the editor.

      6. To run the silent install use the following command:

        setup.exe/setup.sh -s -f path_to_the_silent_install file

  2. Follow the prompts in the installation program. For more information, see Section 2.3.1, ZENworks Reporting Installation flow.

2.3.1 ZENworks Reporting Installation flow

The required information is listed in the order of the installation flow.

Installation Prompts

Explanation

Pre-Installation Summary

  • You are prompted to select the language in which the ZENworks Reportinginstaller must run. Select the language, then click Continue.

  • Read the license agreement and accept it by selecting I accept the terms of the License Agreement, then click Next.

Installation Path

The installer prompts to choose the directory where you want to install ZENworks Reporting.

  • For Windows: The default path is C:\Program Files. You can change this to any path available on the current server.

  • For Linux: The ZENworks Reporting is installed at the following path /opt/novell/zenworks-reporting. You cannot change the installation path.

Prerequisite Status

If the prerequisites are not met, you cannot continue with the installation. The prerequisites that are not met are displayed (GUI) or listed (command line).

Configure Ports

The installer prompts to specify ports for ZENworks Reporting. The default port values are displayed and can be modified.

The following ports are used by the ZENworks Reporting:

  • Server Port

  • Secure Server Port

  • AJP Connection Port

  • Shutdown Port

  • Database Server Port: Jaspersoft internally uses Postgres database. If you want to change the port you can change.

    After the installation, you can use ZENworks Reporting Configuration Tool to modify and reconfigure the above mentioned ports (except Database Server port). For more information, see ZENworks Reporting Configuration Tool in the ZENworks Reporting System Reference.

    NOTE:Use the ports greater than 1024, since the ports from 0-1023 are reserved ports.

Open Firewall Ports

If firewall is enabled, then installer prompts you to open ports used by ZENworks Reporting.

  • Select Yes, open the ports to open ports on firewall.

  • Select No, do not open the ports to manually open the ports used by ZENworks Reporting to access ZENworks Reporting from other devices.

Configure SSL

The installer prompts to configure SSL certificate details to be used by the server.

  • For Internal Certificate Authority:

    1. Select Internal Certificate Authority.

    2. Click Next.

  • For External Certificate Authority:

    1. Select External Certificate Authority.

    2. Specify the following:

      • Signed SSL Certificate: Click Choose, then browse for the .der signed certificate.

      • Private Key File: Click Choose, then browse for the .der private key associated with the signed certificate.

      • Certificate Authority Certificate: Click Choose, then browse for the .der trusted CA certificate.

      For information on creating external certificates to select while installing to a Linux server, see Creating an External Certificate, or for Windows see Creating an External Certificate.

      For information on creating external certificates for installing to a server using a silent installation for Linux, see Creating Your Response File. or for Windows, see Creating Your Response File.

    3. Click Next.

Configure User Source

The installer prompts to specify the LDAP (Lightweight Directory Access Protocol) connection details. In this panel, you must configure a user source to authenticate LDAP server connection through ZENworks Reporting.

 

1. Specify the following:

  • Server: Specify DNS name or IP Address of the LDAP server which is used for user authentication.

  • SSL: Select the SSL check box, if the LDAP server is configured in SSL mode, or clear the SSL check box, if the LDAP server is configured in non-SSL mode.

  • Port: The default port value is displayed based on the selected SSL. The default SSL port is 636 and default non-SSL port is 389. If the LDAP server is configured with a different port other than the above mentioned default ports, then the port must be updated accordingly.

  • Username: For each login, ZENworks Reporting server uses a double user authentication process. This user from LDAP is the first authentication user of ZENworks Reporting. Specify the Username in Distinguished Name (DN) format. For example,

    • For eDirectory cn=ReadOnlyUser,o=mycompany

    • For Microsoft Active Directory cn=ReadOnlyUser,cn=users,dc=organization,dc=com

    Active Directory allows to create Organization Unit (OU) and User name with some special characters that are not accepted by the ZENworks Reporting Installer (Installer does not proceed further with those characters). In this scenario, each of these special characters \ ; = , + < >" must be appended with a backslash “\”. For example, specify userfirstname,userlastname as userfirstname\,userlastname

    The first authentication user is used to get read-only access to the LDAP source, and ZENworks Reporting server validates it internally at every user login attempt. Hence, its credentials are permanently stored by ZENworks Reporting Installer through the Configure User Source panel during installation or reconfiguration.

    After installation, if this user is removed from LDAP or its password is changed, then LDAP will become inaccessible, as a result none of the users will not be able to login. In this case, reconfigure the first authentication user through ZENworks Reporting Configuration Tool. For more information, see ZENworks Reporting Configuration Tool in the ZENworks Reporting System Reference.

    The second authentication user is the LDAP user that interacts with the ZENworks Reporting server and is validated when that user attempts to login.

  • Password: Specify the password of the first authentication user.

  • (Optional) Root Context: The root context is an Organizational Unit (OU) from the LDAP, specified in Distinguished Name (DN) format. It represents the level in the LDAP tree from where to begin short listing the LDAP groups for the next Configure User Source panel.

    If the root context is specified, that OU of LDAP tree is considered as root and only the groups in that OU will be short listed. However, if the root context is not specified, the root level of LDAP tree is considered as root and all the groups in the LDAP will be short listed.

    From the short listed LDAP groups (displayed in the next panel), you will have to manually select the groups that requires administrator access permissions to ZENworks Reporting. The selected groups get mapped to the ZENworks Reporting administrator role, by virtue of which the users belonging to any of the selected groups become ZENworks Reporting administrators. Hence, to provide administrator rights to the users belonging to a LDAP group, that group must be mapped to the ZENworks Reporting administrator role.

 

IMPORTANT:Only administrators have complete access permissions to ZENworks Reporting. The administator priviledges are:

  • View, run, schedule, create, save, and delete various ZENworks Reporting resources (reports, views, domain, data sources and so on).

  • Assign access permissions (read, write, delete, execute, and administer) for various ZENworks Reporting resources to other users either at Role level or at User level.

  • Mapping other LDAP user groups to ZENworks Reporting administrator role by reconfiguration.

  • Manage ZENworks Reporting server settings.

  • Delete Users or Roles.

Users and Roles in ZENworks Reporting:

Roles define sets of users having similar permissions. In the LDAP server, it is recommended to maintain users in groups to have the advantage of a role based user management. When a user log in to the ZENworks Reporting for the first time, a user is created in the ZENworks Reporting repository. Based on the user's group in LDAP, a ZENworks Reporting Role is created and the User is assigned to the newly created role. For subsequent users belonging to the same LDAP group, at their first login, a user is created in ZENworks Reporting repository but it will be assigned to the previously created Role.

By default, any user present in the LDAP server can login to ZENworks Reporting. All the logged in users are assigned to ROLE_USER in ZENworks Reporting. Among them, the administrators are assigned to ROLE_ADMINISTRATOR (ZENworks Reporting administrator role). For all other users, a role is created based on the LDAP group they belong to. For example, if “user1” is a user that belongs to LDAP group “group1”, then a role by name “ROLE_group1” is created and user1 is assigned to that Role.

An administrator cannot assign a user to a role. Users can be assigned to roles only through the LDAP by mapping the user's corresponding LDAP groups to ZENworks Reporting roles such as ROLE_ADMINISTRATOR, ROLE_USER, and so on.

2. Click Next.

3. Select the LDAP groups that you want to map to the ROLE_ADMINISTRATOR role.

This panel displays the short listed LDAP groups based on the Root Context. From this list, you must select at least one or more user groups that you want to map to the ROLE_ADMINISTRATOR. If you have selected a parent group (a group containing other sub-groups) to be mapped to the administrator role, the sub-groups that are under the parent group will not be mapped to the administrator role. If you want to map any sub-groups to the administrator role, they must be selected individually.

For example, a “Finance” group has sub-groups (finance_account, finance_purchase, finance_administration) and a user (finance_manager). If the “Finance” group is selected, to map to administrator role, only the user (finance_manager) gets the administrator rights. The rights does not flow down to the users in the nested sub-groups. If you want administrator rights for the users in the sub-groups too, then select these groups (finance_account, finance_purchase and finance_administration) too, so that these also get mapped to the administrator role.

4. Click Next.

To Configure Multiple User Sources

ZENworks Reporting 5 supports only one user source. You can overcome this limitation by using the ZENworks Reporting LDAP Utility. Using this utility, you can add another user source and map to its required groups for the ZENworks Reporting administrator role on your existing ZENworks Reporting.

You must run the utility on your existing ZENworks Reporting server. It prompts you to separately configure another LDAP source and manually enter the LDAP groups that need to be mapped to the administrator role on the same server.

If you want to map a group on another user source, run the ZENworks Reporting LDAP Utility again. For more information about ZENworks Reporting LDAP Utility, see the TID 7014511 in the Novell Support Knowledgebase.

IMPORTANT:Run the ZENworks Reporting LDAP Utility tool, after installation is completed.

Configure Data Source

Data source configuration publishes the domains and reports for ZENworks Reporting. A domain is a collection of objects mapped to a database schema. You can configure the data source by using one of the following methods:

  • For ZENworks Configuration Management:

    1. Select ZENworks Configuration Management.

    2. Specify the following:

      • Server Address: The DNS name or the IP address of the ZENworks server from where you want to download the domain and reports.

      • SSL Port: The SSL port for ZENworks server.

      • Username: The ZENworks user with Super Administrator rights.

      • Password: The password of ZENworks user.

    3. Click Next, the ZENworks certificate dialog box is displayed.

    4. Validate the certificate and click Yes in the Certificate dialog box.

      The installer fetches required ZENworks configuration and reporting resource files from the specified ZENworks Configuration Management server and publishes reports, domains, and data source in ZENworks Reporting.

 

  • For other ZENworks products:

    1. Select Reporting Configuration file, to configure different ZENworks products supported by ZENworks Reporting.

    2. Click Choose, browse to a resource (for example, ZENworks Mobile Management) that has been downloaded and is locally available, then click Next.

      Any resource (.zip) can be configured or re-configured after installation by using ZENworks Reporting Configuration Tool.

    3. The installer prompts to configure database connection. This option allows you to connect to the database used by the appropriate ZENworks product. Following are the database types that can be configured:

      • Sybase SQL Anywhere

      • Microsoft SQL Server

      • Oracle

    4. Specify the following, based on the database that you have selected:

      • Server: Specify the ZENworks database IP address.

      • Database Server Port: This port is used by ZENworks database, specify the port used by ZENworks database.

      • Database Name

      • Instance Name: This field is displayed, if Microsoft SQL Server is selected.

      • Username: Specify the database user created by the ZENworks.

      • Password

    5. Click Next.

Configure Outbound Email Server

The installer prompts to configure the Outbound Email Server. This configuration is required to enable email notification feature for Report Scheduling.

  • To configure the Outbound Email Server now:

    1. Clear the Configure Outbound Email Server later check box.

    2. Specify the following:

      • SMTP Mail Server Address: Specify DNS name or the IP address of the SMTP server. SMTP server is used for sending emails.

      • Port: Specify port number on which the SMTP server is listening. By default, the port number is 25.

      • From Email Address: Specify sender’s email address using which all scheduled reports is sent.

      • Password: Specify sender’s password.

    3. Click Next.

  • To configure the Outbound Email Server later:

    1. Select the Configure Outbound Email Server later check box.

    2. Click Next.

You can also configure the Outbound Email Server after installation by using the ZENworks Reporting Configuration Tool.

For more information, see ZENworks Reporting Configuration Tool in the ZENworks Reporting System Reference.

Installation summary

GUI Installation: To modify any information that you have entered, click Previous.

Click Install to begin the installation, or click Cancel to exit the installation.

Command Line Installation: To modify any information that you have entered, type back and press Enter.

Press Ctrl+C to exit the installation.

Installation completion

A confirmation message appears when the installation is complete.

A zenworks-reporting folder is created in the installation directory.

ZENworks Reporting version

  • On Linux: Installed ZENworks Reporting Version can be found in the ZRSRelease.txt file, located at /opt/novell/zenworks-reporting directory.

  • On Windows: Installed ZENworks Reporting Version can be found in the ZRSRelease.txt file, located at %ZRS_HOME% (it is an environment variable) directory.

After installation, for managing Users and Roles, see ZENworks Reporting Management in the ZENworks Reporting System Reference.

2.3.2 ZENworks Reporting applications

After installing ZENworks Reporting the following applications are installed on your device as part of Jaspersoft engine:

  • Apache Tomcat 6.0.26 version

  • PostgreSQL 9.0 version: It is used internally by ZENworks Reporting engine.

2.3.3 ZENworks Reporting Installation verification

After the installation, perform any one of the following to verify that ZENworks Reporting is running:

  • Launch ZENworks Reporting Console

    Use following URL to launch the ZENworks Reporting Console in a Web browser. By default ZENworks Reporting port is 8080.

    http://DNS_name_or_IP_address_of_zenworks_reporting:zenworks_reporting_port

    For example, http://127.0.0.1:8080

    Specify User name and password to log in to the ZENworks Reporting. User name must be smaccountname or cn is used (for example, user1).

    This can be done either on the server where you installed ZENworks Reporting, or on a qualified workstation.

  • Check the Windows services by using the GUI

    On the server, click Start, select Administrative Tools > Services, then review the status of the Novell ZENworks Reporting Server and Novell ZENworks Reporting Embedded Datastore services.

    If they are not running, start the ZENworks Reporting. Right-click the Novell ZENworks Reporting Server service, then select Start, right-click the Novell ZENworks Reporting Embedded service, then select Start.

    The Restart option stops all related services that are already running and starts each of them in correct order, including Novell ZENworks Reporting Server and Novell ZENworks Reporting Embedded services.

  • Check the Windows services by using a command line

    On the server, click Start, Open command prompt, then run the following commands:

    sc query NovellZENworksReportingServer

    sc query "Novell ZENworks Reporting Embedded Datastore"

    This lists all the ZENworks Reporting statuses.

    To start the services, run the following commands:

    sc start NovellZENworksReportingServer

    sc start "Novell ZENworks Reporting Embedded Datastore"

  • Check the Linux services by using the configuration command

    On the server, run the following command:

    /etc/init.d/NovellZENworksReportingServer status

    This lists all the ZENworks Reporting statuses.

    To start the services, run the following command:

    /etc/init.d/NovellZENworksReportingServer start

2.3.4 ZENworks Reporting Paths

The ZENworks Reporting is installed within the ZENworks installation folder:

  • For Windows:

    %ZRS_HOME% represents the ZENworks Reporting installation path. The default path is C:\Program Files\Novell\zenworks-reporting\

  • For Linux:

    /opt/novell/zenworks-reporting/

2.3.5 Installer Logs

The Installer logs are stored in the following location:

On Windows: %ZRS_HOME%\logs

The default path is C:\Program Files\Novell\zenworks-reporting\logs\

On Linux: /var/opt/novell/zenworks-reporting/log/

2.3.6 ZENworks Reporting Services

To stop, start, or restart the ZENworks Reporting services.

  • For Windows:

    1. Click Start > All Programs > ZENworks Reporting 5.

    2. Go to the Start or Stop > Services folder.

    3. Click Stop Service to stop the services or click Start Service to start the services.

  • For Linux:

    Execute the following commands:

    • To Start the Service: /etc/init.d/NovellZENworksReportingServer start

    • To Stop the Service: /etc/init.d/NovellZENworksReportingServer stop

    • To Restart the Service: /etc/init.d/NovellZENworksReportingServer restart