Installing and Using the Zimbra Usage Reporting Utility

This document contains information to install and use the Zimbra Usage
Reporting Utility (utility).

Installing the Zimbra Usage Reporting Utility

Using the Zimbra Usage Reporting Utility

Installing the Zimbra Usage Reporting Utility

Installation Requirements

The Zimbra Usage Reporting Utility installer package

Java 1.6 or higher

Installing the Utility

1. Obtain the utility installer package from your Zimbra representative. The

installer package is a zip file containing the usage reporting application.

2. Unzip the installer package to a data center location that can access the

Zimbra LDAP instance.

3. Open a text editor and edit the zimbracmsclient.properties file. See the

example below.
a. Resource Loading is configured by Zimbra. Do not edit these fields.
## RESOURCE LOADING
resources.use.url = false;
resources.file = ZimbraResources.properties
resources.url = http://localhost/ZimbraResources.properties

b. Edit the LDAP Server URL.

## SERVER URL
ldap.url=ldap://<<ldap IP address>>
ldap.cn=uid=zimbra,cn=admins,cn=zimbra<<Zimbra edits this field>>
ldap.password=<<ldap password. The password is obtained from the Zimbra server. Run
$ zmlocalconfig -s zimbra_ldap_password.>>
ldap.output.debug=<<true or false. true is the default.>>

Zimbra, Inc.

Beta 2014

Installing and Using the Zimbra Usage Reporting Utility

endpoint.url=https://zimbrauat.compliance.flexnetoperations.com <<Do not edit this field. This is

where the server is reporting.>>

c. Enter the device.id. Provide a simple name for your device with no spaces.
device.id= <<Enter a name with no spaces>>

d. Edit the account.id.The account ID is a value received from your Zimbra

representative.
account.id=<<Enter the value received from your Zimbra representative>>

e. Do not edit the following. These are configured by Zimbra.

## CAPABILITIES FOR STANDARD EDITION FEATURES
se.feature.name=SECount
se.feature.version=1.0
## CAPABILITIES FOR PROFESSIONAL EDITION FEATURES
pe.feature.name=PECount
pe.feature.version=1.0
## CAPABILITIES FOR BUSINESS EDITION FEATURES
be.feature.name=BECount
be.feature.version=1.0
## CAPABILITIES FOR BUSINESS EDITION PLUS FEATURES
bep.feature.name=BEPCount
bep.feature.version=1.0

Beta 2014

Zimbra, Inc.

Installing and Using the Zimbra Usage Reporting Utility

Example of the zimbracmsclient.properties configuration

## RESOURCE LOADING
resources.use.url = false
resources.file = ZimbraResources.properties
resources.url = http://localhost/ZimbraResources.properties
## SERVER URL
ldap.url=ldap://192.168.2.132:xxx
ldap.cn=cn=config
ldap.password=o9DGlCxxx
ldap.output.debug=true
endpoint.url=https://zimbrauat.compliance.flexnetoperations.com
device.id=Example
account.id=GZXNUKXUY0XYZ
## CAPABILITIES FOR STANDARD EDITION FEATURES
se.feature.name=SECount
se.feature.version=1.0
## CAPABILITIES FOR PROFESSIONAL EDITION FEATURES
pe.feature.name=PECount
pe.feature.version=1.0
## CAPABILITIES FOR BUSINESS EDITION FEATURES
be.feature.name=BECount
be.feature.version=1.0
## CAPABILITIES FOR BUSINESS EDITION PLUS FEATURES
bep.feature.name=BEPCount
bep.feature.version=1.0

4. Execute the Client

a. Included in the installer package zip file is a shell script for executing the
Java application. Access the script and launch the application.
#!/bin/sh
java -jar ZimbraCMSClient.jar -p zimbracmsclient.properties

The application is running.

Zimbra, Inc.

Beta 2014

Installing and Using the Zimbra Usage Reporting Utility

Using the Zimbra Usage Reporting Utility

To start using the utility, use the steps in this section to launch the user interface
and view usage reports.
1. Obtain the utility download URL from your Zimbra representative. You will

receive an email, or a download site is available.

2. Launch the application.
3. Enter your Login ID and Password, and click Login.

If you do not know your password, or you have not set up an account, use the
Password Finder link on the Login page or contact Support.

4. Under Usage Management, click Usage Reports. The View Usage screen

displays.
5. Select a product from the Product Family drop-down menu and enter a start
date in the As of Date field for the usage report.

Beta 2014

Zimbra, Inc.

Installing and Using the Zimbra Usage Reporting Utility

Select Usage
Reports

Select the product and

enter a start date for the
usage report.

6. After you enter your query information, the usage report displays. Select how

you want to view the usage information by selecting the type of report to
display. You can view the report as Gauges, Table, Timeline, or Compare
Meters using the clickable icons on the right of the screen.
Select how you
want to view the
report.

Zimbra, Inc.

Beta 2014

Installing and Using the Zimbra Usage Reporting Utility

Legal Notices
Copyright 2014 Zimbra, Inc. All rights reserved. This product is protected by U.S. and international
copyright and intellectual property laws. Zimbra and Telligent are registered trademarks or
trademarks of Zimbra, Inc. in the United States and other jurisdictions. You may not alter or remove
any trademark, copyright, or other notice from copies of the content. All other marks and names
mentioned herein may be trademarks of their respective companies.
Zimbra, Inc.
3000 Internet Blvd., Suite 200
Frisco, Texas 75034
www.zimbra.com
Beta - February 2014

Beta 2014

Zimbra, Inc.