The syntax for xfcustomreport is as follows. Brackets indicate optional entries.
-usagereport |
Generate a usage report. Use this command or the -userreport or -usergroupreport command. |
-userreport |
Generate a user report. Use this command or the -usagereport or -usergroupreport command. |
-usergroupreport |
Generate a user group report for groups (created using User Groups from the Administration page in the License Statistics web application). Use this command or the -usagereport or -userreport command. |
-hostreport |
Generate a host report. |
-hostgroupreport |
Generate a host group report (created using Host Groups from the Administration page in the License Statistics web application). |
-description description |
Text that describes the report. This text will be included in the report heading. |
-reportname report_name |
The name under which to save the generated HTML and CSV file. |
-database database1,database2... |
The databases to query. Enter the full or relative path and separate multiple entries with commas. |
-includecolumn max_used_hours, total_used_hours, max_used_licenses,total_licenses |
The columns to include in the report. Enter one or more of the options, separating multiple entries with commas. The valid options are as follows. max_used_hoursFor usagereport, shows the greatest number of hours any user has used the application at once based on the number of licenses used. For -userreport, shows the greatest number of hours that a particular user used an application based on the number of licenses used. This option cannot be used with -usergroupreport. total_used_hours For -usagereport, sums up the total number of hours the application has been used based on the number of licenses used. For -userreport, shows the total hours any single user used an application based on the number of licenses used. For-usergroupreport, shows the total number of hours each group used an application based on the number of licenses used. max_used_licenses For -usagereport, shows the greatest number of licenses used during the report period. For -userreport, shows the greatest number of licenses a single user used at once. This option cannot be used with -usergroupreport. total_licenses (-usagereport only) Shows the total licenses available during the report period. This option cannot be used with -userreport or -usergroupreport. |
-graphs enable/disable |
Optional. Specify whether to enable or disable graph output. The default is to enable graphs. |
-borrow enable/disable |
Optional. Specify whether to enable or disable including borrow information in reports. The default is to enable borrow. |
-delimiter tab/comma/semicolon |
Optional. Specify the delimiter in the CSV file. This can be tab, comma or semicolon. Default is comma. |
-featurereportmode includeall/excludeall |
Optional. Include or exclude all features in the report results. The default is to include all features. |
-featurefilter app1,app2... |
Optional. Exclude specified features from report results. Name each feature to exclude from results, separating multiple entries with commas. Note: feature names may not include spaces. Replace any spaces with underscores. |
-userhostreportmode includeall/excludeall |
Optional. For use with -userreport or -hostreport only. Include or exclude all users/hosts in the report results. The default is to include all users/hosts. |
-userhostfilter user1,user2,host1, host2... |
Optional. For use with -userreport or -hostreport only. Exclude specified users/hosts from report results. Name each user/host to exclude from results, separating multiple entries with commas. This feature is useful for creating detailed user/host group reports. |
-groupreportmode includeall/excludeall |
Optional. For use with -usergroupreport or -hostgroupreport only. Include or exclude all groups in the report results. The default is to include all groups. |
-groupfilter group1,group2... |
Optional. For use with -usergroupreport or -hostgroupreport only. Exclude specified groups from report results. Name each group to exclude from results, separating multiple entries with commas. |
-reportperiod day/week/month/quarter/year |
Optional. Specify the period of time on which to report. Default report period is monthly. |
-starttime yyyy-mm-dd |
Optional. Specify a start time for the report in yyyy-mm-dd format. All data before the specified time will be ignored. |
-endtime yyyy-mm-dd |
Optional. Specify an end time for the report. All data after the specified time will be ignored. |