Pane

Description

Navigation Pane (left side of main window)

This pane enables you to select and manage reports and directories, control the view in the navigation pane, and customize the appearance of reports in the content pane. The navigation tree that appears in this pane reflects the structure of the report repository. The tree contains expandable and collapsible nodes that represent a hierarchical view of report categories and their respective reports.

Use the navigation pane to:

• Select a report to view.
• Filter the reports that are displayed in the report repository tree to match regular expressions that you provide. Use filters when you have a large number of reports and you want to limit the reports that appear in the report repository tree to those that match your regular expression. For example, enter payroll in the filter text box and click Filter to show a list of reports that contain the word payroll in their name.
• Expand and collapse the entire report repository tree with one click. You can use this command in conjunction with filtering to quickly view all the reports in the tree that match your filtering criteria.
• Determine whether to display the report in frames or frameless format.
• Paginate reports that are viewed in frames format.
• Hover over a report to view a portion of its long description.
• Right-click a report to access a context menu that provides you with a list of actions that you can perform against that report:
  • Info : show detailed information about a report.
  • Edit (super user only): show detailed information about a report and enable users to edit that information.
  • Delete (super user only): remove reports from the report repository tree.
• Right-click a directory to access a context menu that provides you with a list of actions that you can perform against that directory:
  • Delete (super user only): remove directories from the report repository tree. You cannot delete a directory that contains reports.
  • Upload (super user only): Add a new report to the report repository.

Content Pane (right side of main window)

This pane enables you to view the reports you select from the report repository tree. There are two formats in which you can view a report:

• Frames format:
  • Using frames mode you can perform the following actions:
    • display reports in pages for rather than in one scrollable window
    • navigate back and forward
    • display a table of contents for the report
    • "go to" page entry
    • export report data to a CSV (comma separated values) file
    • convert a report to PDF
    • save a PDF version of the report
    • print a PDF version of the report
    • recalculate the values in a report.
      
      
• Frameless format: reports appear in a single window that scrolls to show the entire report and provides controls through the web browser toolbar such as:
  • print
  • save
  • navigate back and forward.

Note: If you are using a pop-up blocker in conjunction with your Windows web browser, pop-up windows in the report viewer will appear in the content pane rather than as their own separate window.

Task and description

How to

1. Start a command line session on the machine where you want to start the Aperi user interface.
2. Change to the directory where you installed the Aperi. For example: c:\aperi.
3. Change to the cpgui directory.
4. Type AperiRcpGui in the command line and press Enter.
5. Log in using your Aperi ID and password. Note that the level of authority associated with your Aperi user ID determines the functions that are available to you once you access the report viewer.
6. Click in the toolbar. A web browser appears with the URL: http://localhost:8080/aperi-reports.
7. If prompted, log in again using your ID and password.

1. Start a web browser.
2. Point your web browser: http://localhost:8080/aperi-reports/
3. Log in using your Aperi ID and password. Note that the level of authority associated with your Aperi user ID determines the functions that are available to you once you access the report viewer.

View a report
Select and generate a report in the report viewer.

1. (optional) Use the filtering options to limit the reports shown in the repository tree based on criteria that you define. Click here for more information.
2. Select Paginate Reports (frames) to view the report in frames format. If you do not select this check box the report will appear in frameless format. Click here for information about frames and frameless format.
3. Expand the directory in the repository tree that contains the report you want to view.
4. Left click the report to view it in the content pane.
5. Check the Paginate Reports (frames) box to view the report as pages when in frames format. If you do not check this box the report will appear on one scrollable page.

Filter reports that are displayed in the report repository tree
Filter the reports that are displayed in the report repository tree to match regular expressions that you provide.

1. In the navigation pane of the report viewer, enter a regular expression in the Filter text box. A regular expression is an expression that describes a set of strings and can consist of any of the following:
   • text string. For example, "payroll" matches all reports with an occurrence of "payroll" in its name.
   • ?: Use this wildcard to indicate a character in a text string. For example, "colou?r" matches both color and colour.
   • *: Use this wildcard to indicate any number of characters in a text string. For example, "go*gle" matches ggle, gogle, google, gooogle, etc.
2. Click Filter or press Enter to update the repository tree with reports that match the regular expression you defined.
3. Click Clear to clear the filter and reset the report repository tree to its default display (all reports).

1. Start the report viewer in a standalone web browser or RCP GUI.
2. Select frames format for the report you want to convert to PDF.
3. Left click the name of the report in the report repository tree. The report appears in the content pane.
4. Click . The report appears as a PDF in the right-hand side of the content pane.

1. Start the report viewer in a standalone web browser or RCP GUI.
2. Left click the report you want to generate in the navigation tree on the left side of the window. The report appears in the content pane.
3. Select Paginate Reports (frames). This will enable you to generate a PDF of the report.
4. Click . The report appears as a PDF in the right-hand side of the content pane.
5. Click the save button on the PDF toolbar.
6. Complete the fields on the PDF save window that appears to determine the filename of the report and where you want to save it. The report will be saved as a PDF file to the specified location and can be opened by a PDF reader at a later time.

1. Start the report viewer in a standalone web browser or RCP GUI.
2. Left click the report you want to generate in the navigation tree on the left side of the window. The report appears in the content pane.
3. Select Paginate Reports (frames). This will enable you to generate a PDF of the report.
4. Click . The report appears as a PDF in the right-hand side of the content pane.
5. Click the print button on the PDF toolbar.
6. Complete the fields on the PDF print window to determine the settings for printing the report.

1. Start the report viewer in a standalone web browser or RCP GUI.
2. Select frames format for the report you want to convert to CSV.
3. Left click the name of the report in the report repository tree. The report appears in the content pane.
4. Click in the toolbar. A window appears that enables you to determine properties of the CSV file.
5. Complete the fields on the CSV window and save the file.

1. In the navigation pane of the report viewer, right click the name of a report whose properties you want to view.
2. Select from the context menu. The Report Info window appears.
3. View the properties of a report on the Report Info window. The values on this window are for display only.
4. Hover over a field on the report to view a short description of that field:
   
   
   • Report Design File: The filename of the report. This filename contains the definition of a report as created through the report designer.
     
     
   • Remote Repository Directory: The directory where the report will appear in the report repository. For example, if the value in this field is Data, the report will appear in the Data folder of the report repository tree. For example, if the value in this field is /Data/Payroll, the report it will appear in the repository tree under Data > Payroll > report_name.
     
     
   • Deployer: The user ID of the person who added the report.
     Date: The date when the report was added.
     
     
   • Editor: The user ID of the person who most recently edited a report's properties.
     Date: The date when a report's properties were last edited.
     
     
   • authorization: The authorization/role of users that can access a report. Only users with the roles selected in this section can access the report.
     • No Access Restrictions: All Aperi users can view the new report.
     • Restrict to Sum of Selected Roles Below: If this box is checked only users with the roles that are checkled below can access the report:
       • Super User. Only users with a Super User role can access the report.
       • Aperi Administrator. Only users with an Aperi Adminstrator role can access the report.
       • Operator and Administrator roles: Disk Administrator, Disk Operator, Fabric Administrator, Fabric Operator, Data Administrator, Data Operator, Tape Administrator, Tape Operator. Only users that have all the selected roles can access the report.
         
         
   • Report Title: (optional) A title for the report. This title appears in the report repository tree and in the content pane when the report is displayed. If there is no value in this field the title will be derived from the filename entered in the Report Design File field. For example, if the filename in the Local Report Design to Upload field is assets_by_computer.rptdesign, the title of the report will be assets_by_computer.
     
     
   • Report Description: (optional) A description for the report. The description appears when you hover over the report in the report repository tree.
     
     
5. Click Cancel to close the window.

Edit the properties of a report
(super user only) Edit the properties of a report including its title, description, source filename, the directory in which it is located, and the roles to which it is associated.

1. In the navigation pane of the report viewer, right click the name of a report whose properties you want to edit.
2. Select from the context menu. The Edit Report window appears.
3. Edit the fields on the Edit Report window to change a report's directory and filename, rearrange the authorization, or change the title and description of a report.
   
   
   • Report Design File: Edit the filename of the report. This filename represents the definition of a report as created through the report designer. Click Browse.. to use a file-browsing window to locate and select the report_name.rptdesign file for the report you want to add, where report_name is the name of the report.
     
     
   • Remote Repository Directory: Edit the directory where the report will appear in the report repository. The default directory that appears in this field reflects the directory from which the upload option was selected in the report repository tree. For example, if you right-clicked a directory named "Data" in the report repository tree and selected the upload option, the value /Data appears in this field.
     
     You can change this directory or append subdirectories to it. For example, if you enter /Data/Payroll, when you upload the report it will appear in the repository tree under Data > Payroll > report_name.
     
     
   • authorization: Use the fields in the area to restrict access to reports based on a user's level of authorization/role in Aperi. By default, reports are available to all users.
     • No Access Restrictions: Check this box to indicate that all Aperi users can view the new report.
     • Restrict to Sum of Selected Roles Below: Check this box to specify what user roles can view the report. When you check this box the following additional roles become selectable:
       • Super User. Check this role to indicate that only users with a Super User role can access the report. Note that other roles become disabled if those roles are redundant or conflicting with the Aperi Administrator role. For example, if you select Super User, the Aperi Administrator role is redundant and becomes disabled because it already has access to anything that the Aperi Administrator has access. All the administrator and operator roles become disabled because they would conflict due to the Aperi Administrator because more restrictive than those roles.
       • Aperi Administrator. Check this role to indicate that only users with an Aperi Adminstrator role can access the report. Note that other roles become disabled if those roles are redundant or conflicting with the Aperi Administrator role. For example, if you select Aperi Administrator, the Super User role is redundant and becomes disabled because it already has access to anything that the Aperi Administrator has access. All the administrator and operator roles become disabled because they would conflict due to the Aperi Administrator because more restrictive than those roles.
       • Operator and Administrator roles: Disk Administrator, Disk Operator, Fabric Administrator, Fabric Operator, Data Administrator, Data Operator, Tape Administrator, Tape Operator. Check these boxes to limit access to a report based on a product function and its related roles. For example, check Data Operator only to enable users with those roles to access a Data report. Users with Tape, Fabric, and Disk roles will not be able to access the report.
         
         You can select multiple roles by using ctrl+click. Only users that have all the roles selected will be able to access a report. For example, if you select Data Administrator and Fabric Adminstrator, only users with both those roles will be able to access the report.
         
         
   • Report Title: (optional) Edit a title for the report. This title appears in the report repository tree and in the content pane when the report is displayed. If you do not enter a value in this field the title will be derived from the filename entered in the Report Design File field. For example, if you leave this field blank and the filename in the Local Report Design to Upload field is assets_by_computer.rptdesign, the title of the report will be assets_by_computer.
     
     
   • Report Description: (optional) Edit a description for the report. The description appears when you hover over the report in the report repository tree.
     
     
4. Click Commit to save your changes to the report. Click Cancel to close the window without saving your changes.

1. In the navigation pane of the report viewer, right click the name of a report that you want to delete.
2. Select from the context menu. The Delete Report window appears and shows information about the report.
3. Click Delete to confirm the delete. The report is removed from the report repository tree.
   Click Cancel to close the Delete Report window without deleting the report.

1. In the navigation pane of the report viewer, right click the name of a directory that you want to delete. You cannot delete a directory that contains reports. Click here for information on how to delete a report.
2. Select from the context menu. The Delete Directory window appears and shows information about the directory.
3. Click Delete to delete the report. The directory is removed from the report repository tree.
   Click Cancel to close the Delete Directory window without deleting the directory.

Add a new report
(super user only) Upload a new report design to the report viewer. Add and define properties for a new report in the report viewer.

1. Use the report designer to design a report that you want to add.When you create a report in the report designer, it creates a file for that report with the name report_name.rptdesign, where report_name typically indicates the name of a report. You will need to know this filename when adding the report to the report viewer.
2. Access the report viewer.
3. In the navigation pane of the report viewer, right click the directory where you want to upload the new report. The report will appear in this directory after you add it.
4. Select from the context menu. The Deploy Report window appears.
5. Enter information about the new report in the following fields:
   
   
   • Local Report Design to Upload: Enter the filename of the report. This filename represents the definition of a report as created through the report designer. Click Browse.. to use a file-browsing window to locate and select the report_name.rptdesign file for the report you want to add, where report_name is the name of the report.
     
     
   • Remote Repository Directory: Indicate the directory where the report will appear in the report repository. The default directory that appears in this field reflects the directory from which the upload option was selected in the report repository tree. For example, if you right-clicked a directory named "Data" in the report repository tree and selected the upload option, the value /Data appears in this field.
     
     You can change this directory or append subdirectories to it. For example, if you enter /Data/Payroll, when you upload the report it will appear in the repository tree under Data > Payroll > report_name.
     
     
   • Overwrite Existing?: Check this box to overwrite an existing report or directory.
     
     
   • Create Directories as Needed?: Check this box to create the directory you entered in the Remote Repository Directory field if it does not already exist in the report repository tree.
     
     
   • authorization: Use the fields in the area to restrict access to reports based on a user's level of authorization/role in Aperi. By default, reports are available to all users.
     • No Access Restrictions: Check this box to indicate that all Aperi users can view the new report.
     • Restrict to Sum of Selected Roles Below: Check this box to specify what user roles can view the report. When you check this box the following additional roles become selectable:
       • Super User. Check this role to indicate that only users with a Super User role can access the report. Note that other roles become disabled if those roles are redundant or conflicting with the Aperi Administrator role. For example, if you select Super User, the Aperi Administrator role is redundant and becomes disabled because it already has access to anything that the Aperi Administrator has access. All the administrator and operator roles become disabled because they would conflict due to the Aperi Administrator because more restrictive than those roles.
       • Aperi Administrator. Check this role to indicate that only users with an Aperi Adminstrator role can access the report. Note that other roles become disabled if those roles are redundant or conflicting with the Aperi Administrator role. For example, if you select Aperi Administrator, the Super User role is redundant and becomes disabled because it already has access to anything that the Aperi Administrator has access. All the administrator and operator roles become disabled because they would conflict due to the Aperi Administrator because more restrictive than those roles.
       • Operator and Administrator roles: Disk Administrator, Disk Operator, Fabric Administrator, Fabric Operator, Data Administrator, Data Operator, Tape Administrator, Tape Operator. Check these boxes to limit access to a report based on a product function and its related roles. For example, check Data Operator/Administrator only to enable users with those roles to access a Data report. Users with Tape, Fabric, and Disk roles will not be able to access the report.
         
         You can select multiple roles by using ctrl+click. Only users that have all the roles selected will be able to access a report. For example, if you select Data Administrator and Fabric Adminstrator, only users with both those roles will be able to access the report.
         
         
   • Report Title: (optional) Enter a title for the report. This title appears in the report repository tree and in the content pane when the report is displayed. If you do not enter a value in this field the title will be derived from the filename entered in the Local Report Design to Upload field. For example, if you leave this field blank and the filename in the Local Report Design to Upload field is assets_by_computer.rptdesign, the title of the report will be assets_by_computer.
     
     
   • Report Description: (optional) Enter a description for the report. The description appears when you hover over the report in the report repository tree.
     
     
6. Click Upload to add the report. The report appears in the report repository tree.
   Click Cancel to close the window without adding the report.
   
   
7. View the report in the report repository tree.