Adding Report Folders to Entuity

Transcription

1 Adding Report Folders to Entuity Purpose: The purpose of this Application note is to provide a short procedure that will demonstrate how to add a new report folder to an Entuity server. The procedure will also show how to place out-of-the-box report templates and custom report templates into this new folder. This procedure was written using a Release 16.5P01 Windows system. This procedure will work for Linux based systems and is also valid for older revision Entuity systems. This procedure will require either RDP or SSH access to the Entuity server as new directories and files will be created on the server. Procedure to Add a New Report Folder: The procedure below demonstrates how to add a new Report Folder to the Entuity server. If additional folders are required, just repeat the procedure in this section. 1. Establish an RDP or SSH connection to the Entuity server. This example uses a Windows-based server but the procedure is similar for Linux systems. 2. From Windows Explorer, change to the [ENTUTIY_HOME]\reports\reports folder. A list of all the standard report folders will be displayed. Page 1

2 3. Create a new Folder and assign a name to it. NOTE: The folder name cannot contain any spaces. Try to follow the Entuity convention of using capital letters for different words. The example folder used in this app note will be TestFolder. The new folder name is now displayed. On a Linux system, change to the ENTUITY_HOME/reports/reports directory and use the mkdir command to make a new directory. 4. Using a text editor, open the.folder.xml file that is located in the [ENTUITY_HOME]\reports\reports directory. A list of all default report folders is listed. Page 2

3 5. Add the new folder name to the XML file just before the </folder> tag: <folder>testfolder</folder> Please observe proper XML syntax for spacing. The file should now contain the new folder name: Save the changes to the file. Page 3

4 6. Browse to one of the existing default report folders. Locate the file named.folder.xml. In this example, the Administrative Reports folder is used. Copy this file to the newly created folder. 7. Copy the.folder.xml file to the newly created folder. Chang to the new folder. It should contain a single entry -.folder.xml. 8. Open the file with a text editor. The contents of the file are displayed and they are incorrect as they contain the tags for the Administrative Reports folder. Page 4

5 9. Change the name, label and description tags. The name tag must not contain any spaces and must match the name of the newly created folder. The label and description fields may contain spaces. While it is not necessary to change the creationdate, it would be beneficial to change at least the date to indicate it was recently created. In this example, the folder label is changed to Network Engineering Reports and the description to Reports used by Network Engineering. A sample of the file is shown below: Save the file after editing it. It is not necessary to restart the Entuity server. 10. From the web UI, go to Reports. Observe that the newly created folder is displayed. Page 5

6 Procedure to add an out-of-the-box report template to the New Report Folder: This section of the Application Note will provide a procedure to place existing out-of-the-box report templates into the newly created folder. This example will take the Outages Report template from the Availability folder and place it into the newly created reports folder. 1. Establish an RDP or SSH session to the Entuity server. Change to the [ENTUITY_HOME]\reports\reports\Availability folder. Report templates consist of a folder that contains the report files and a configuration file for the report. This example uses the Outages Report. Below is the display from the Availability Reports folder. The report file folder and the configuration file are highlighted below. Page 6

7 2. Copy the report folder and the report configuration file to the newly created folder. The newly created folder will now contain the OutagesReport_files folder, the OutagesReport.cfg file and the.folder.xml file. 3. From the web UI, go to Reports -> Network Engineering Reports. The Outages report is now part of the Network Engineering Reports repository. The report can be run on-demand or scheduled. The procedure can be repeated for any other out-of-the-box reports. The display below shows the reports available in the Network Engineering folder after the Spare Ports by View report from the Inventory folder has been copied to the Network Engineering Folder Page 7

8 Procedure to add a Report Builder report template to the New Report Folder: This section of the Application Note will provide a procedure to place a report created with Custom Report Builder into the newly created folder. 1. By default, all reports created with the Custom Report Builder are stored in the UserDefined reports folder. Via the web UI, it is possible to move any created Report Builder templates to an alternate folder. From the web UI, go to Reports -> User Defined. Select the report that is to be moved by clicking the notepad icon. In this example, the TopN CPU Utilization Report will be moved. 2. After clicking the notepad icon, the report template will be displayed. Click the plus sign to the right of Report Options. This will expand the options available. Page 8

9 3. The report URL displayed will be the system generated URL when the report was created. Notice that is points to the UserDefined reports folder. 4. Change the URL to point to the newly created folder. Choose a suitable name for the report. Do not use spaces in the URL string. Page 9

10 5. After changing the URL, save the report by scrolling to the bottom of the web page and clicking the Publish button. 6. After clicking the Publish button, the UI will redirect to the folder where the report was published. In the example, this is the TestFolder. Observe that the report is now contained in the new folder. This procedure can be repeated for any additional custom reports that need to be migrated to the newly created folder. Page 10