7.2 Specifying available reports

You can specify whether a user can generate reports. On the Reporting page, users choose from a list of available options, which report(s) to run.

1. Open the reporting.xml file located in the Viewpoint home directory.
2. Comment out any reports you do not want available using the <!-- and --> tags. Reports that are available by default to all users with the report.read permission are the following:

Report	Description
Events	A report showing historical event information in the form of a table, pie chart, or bar chart
Job and Processor Hours by Credential	A list report of processor hours and jobs by credential. The data is displayed in table format by year, then by month.
Job and Processor Hours by Month	A bar chart of the chosen year with total processor hours and jobs for each month
Jobs and Processor Hours by Quarter and Year Bar Chart	A bar chart of totals for jobs and processor hours by quarter and year
Jobs Submitted	A report presenting the jobs submitted by credentials (user, group, account, and quality of service) for the supplied time in table format with name and total of jobs
Jobs Submitted and Completed Line Chart	A line chart showing number of jobs over the specified time and for the specified credential with the option of showing completed jobs
Total Active Processor Count	Line chart showing the number of active processors over the specified credential and credential name
Total Allocated Node Count	Displays the number of total allocated nodes over time in a line chart for the given start and end time by credential and credential name
Total Queue Time	A table and pie chart view of queue hours over the specified time and for the specified credential
Used Wallclock Time	A table and pie chart view of used wallclock hour for the specified time and for the specified credential

3. Give reports individual permissions so that only certain users may access them (for details, see Adding permissions to individual reports).
4. Once the permission is created, add it to the users’ permissions for them to view it. To do so:
   1. Open the core.xml file in the Viewpoint home directory and scroll to the <definition name="role-name"> that will receive the permission.
   2. Insert the new permission name within that element.
   

   To grant a group access to all reports within a certain category, insert an asterisk rather than the report name: <permission name="report.jobs.*" />

   Similarly, to give permission to all reports, grant the following role: <permission name="report.*" />

5. Create a custom category. To do so, create a directory for each category to hold its corresponding reports. For example, you could create the jobs directory to place all the job-related reports, such as Jobs Submitted. This will be located in the Tomcat webapps/reporting/report directory.
   1. Change the <category> element to the directory name so that Viewpoint can locate it.
   2. Modify the <display-category> to update the display name for the category. As an example, see this configuration for the Jobs Submitted report:

   <reports>
       <report>
           <display-name>Jobs Submitted</display-name>
           <report-design>jobs_submitted.rptdesign</report-design>
           <display-category>Jobs</display-category>
           <category>jobs</category>
           <description>Presents the Jobs submitted by credential (user, group, account and quality of service) for the supplied time in table format with name and total of jobs</description>
           <permission name="report.jobs.jobs_submitted" />
       </report>
   </reports>
   
   

   Viewpoint looks in the jobs directory to locate the report. A user with the report.job.jobs_submitted permission may view the report on the Reporting page. The Reporting page will show that the report is in the Jobs category.
6. Change the report name that users will see by modifying the <display-name> element within <report>.
7. Change the viewable report category on the Viewpoint Reporting page by modifying the text in the <display-category> element.
8. Alter the description of the report viewable in the Viewpoint Reporting page by modifying the text in the <description> element.

Related topics 

• Configuring reports

© 2012 Adaptive Computing