Jump to: navigation, search
MithiWiki Home > ConnectXf Home > ConnectXf Administration > Configuration > Generating MIS Reports


Troubleshooting Icon.png
Troubleshooting
Product ConnectXf
Version All
Applies to Administrators
Level Advanced



Overview

  • Once the Connect Xf servers have been configured to collect mail flow and mail box access data, the data can be used to generate reports.
  • These reports can be used by the server admins and are also used by Baya, the integrated web client to implement features such as Chat history, last login details etc.
  • This topic gives the details on how the server admin can generate reports from the data collected.

Configurations for generating reports

  • For Connect Xf versions 3.16 and below, the report generation API has to be called only on the server on which the report database is present.
  • From Connect Xf 3.18 onwards, reports can be generated from any server in the setup.
  • The configurations required for the same are as given in the following topic:
Server Configuration for report generation

Operations

  • The Server Statistics, Mail Traffic or User activity reports can be generated using the Command Line Interface.
  • The reports can be generated on demand or automatic scheduled jobs can be used to generate predefined reports and predefined times.
  • The following sections give details of the API used to generate the reports
  • Note: The API works on the data available in the database. If the data is not present, then the reports may show wrong results.

Generating a report on demand

  • On the command line interface, fire the following command:
/mithi/mcs/bin/getreports.sh
  • The table below gives a brief description of the parameters to the getreports.sh command.
  • For details refer to the help given by the command when invoked with the help parameter as follows
/mithi/mcs/bin/getreports.sh --help
Parameter Description
reportname
  • Name of the report.
  • Allowed values are any one for the report types.
  • For example activeusers, inactiveusers, usagestats etc.
periodfrom
  • Start date.
  • The report has to be generated from data starting at the given date and time. Format is dd/MM/yyyy:HH:mm:ss
periodto
  • End date.
  • The report has to be generated for data upto the given date and time. Format is dd/MM/yyyy:HH:mm:ss
mailboxlocation
  • Server name for which report is to be generated
  • This parameter is used in Activity reports and Mail traffic reports
servername
  • Server name for which report is to be generated
  • This parameter is used in Server statistics reports
outputtype
  • The output format required. Possible values html/csv. If not provided, default value is html.
sendmailto
  • Email id/s where report is to be sent. Multiple values can be provided with ** separated list
savetofile
  • Path where report is to be saved. Provide the folder name.
domainname
  • Domain name for which report is to be generated. If not provided generates report for all domains.
userid
  • Email id.
  • Generates the report for the email id provided. Used in user specific reports such as usersloginhistory.
groupby
  • When specified the output is grouped into the time intervals given.
  • Allowed values are any one of [hour, day, week, month, year]
toplimit
  • A number which restricts the number of records in the report.
  • Default is 100
  • Example of calling the getreports.sh API

 sh /mithi/mcs/bin/getreports.sh --reportname usersloginhistory --periodfrom 11/10/2011:11:11:11 --periodto 13/10/2011:22:22:22 --outputtype html --mailboxlocation Master --sendmailto support@test.int --userid postmaster@test.int

  • The above command will generate the report usersloginhistory for the user postmaster@test.int and user support@test.int will get the report via mail.

Scheduling automatic report generation

  • You can call the getreports command automatically using
  • the agent framework
  • scheduling a cron job.
  • Note: The jobs using the getreports.sh script should be scheduled at non-peak hours as they can use up server resources and slow down normal server operations.