NAME

pmx-reports-custom - Registers custom policy reports.


SYNOPSIS

 pmx-reports-custom add --key KEY --title TITLE --file FILE
 pmx-reports-custom update --key KEY [--title TITLE] [--file FILE_LOCATION]
 pmx-reports-custom delete --key KEY
 pmx-reports-custom list [--key KEY]
 pmx-reports-custom init


DESCRIPTION

The pmx-reports-custom program registers custom policy reports that are displayed in addition to the standard reports in the Groups Web Interface. Use this tool to register, modify, and remove custom reports.


OPTIONS

add
Registers a new custom report. You must specify a key, title, and file. The key must match the key specified in the PureMessage policy, and you must add a corresponding section to the PureMessage policy to create a working custom report. See 'Administrative Groups > Viewing and Managing Reports' in the Adminstrator's Reference for more information).

The title is the name of the custom report that is displayed on the Report Types sidebar of the Groups Web Interface. Use file to specify the path to the file that contains the values (columns) of the report.

update
Modifies the report and its contents. Use the options described in add to change the key or title of the report. To modify the values, edit the specified file, and run pmx-reports-custom update.

delete
Removes a custom report and its contents. You must specify the report's key that was assigned when the report was created.

list
Shows all custom reports and their contents. Use the key option to view an individual report.

init
Restores custom reports to PureMessage's database in the event of a failure. It is only necessary to run this command if you were required to re-intialize the database. See the pmx-database command for more information.


COPYRIGHT

Copyright (C) 2000-2010 Sophos Group. All rights reserved. Sophos and PureMessage are trademarks of Sophos Plc and Sophos Group.