Scenario: You want to configure the Advanced Reporting feature and access the reports based on Advanced Reporting using a Installed/Windows App Client on a remote computer.
To install Advanced Reporting using Post-Installation, see Post-Installation Steps for Advanced Reporting.
Reference: For background information, see the reference section.
Workflow diagram:
Prerequisites:
You have installed the Server with an extension that provides advanced reports, such as, Energy and Power Reporting Templates or Advanced Reports for Pharma etc. This will install the Advanced Reporting extension with the prerequisite Advanced Reporting BIRT Extension. NOTE: To install the latest version of prerequisite Advanced Reporting BIRT extension, verify that the install check box is by default selected in the prerequisite version selection window.
You have added the extensions which provide advanced reports, such as, Energy and Power Reporting Templates or Advanced Reports for Pharma etc. to the Server project. This will add the extensions Advanced Reporting, Application Host Base, Web Services to the server project (see Add an Installed Extension to a Project in Server Projects Configuration Procedures.)
You have created the Advanced Reporting web application in SMC (see Create a Website in Setting up the Windows App Client).
Ensure that the Default Web Client does not belong to any management station security group. However, if it does, ensure that this group does not restrict access rights, otherwise, you are not able to view the reports. For more information, see No Access to View Reports.
When the Advanced Reporting extension is installed, the prerequisite Advanced Reporting BIRT extension is installed with following default settings:
The installation path is “$SystemDrive\Program Files\Apache Software Foundation\Tomcat 9.0”.
The default connection port assigned to the Tomcat server is 18080 (if the default connection port is in use, the next available free port is assigned to Tomcat).
The LocaleName is set according to the current Regional settings. To verify the Regional settings, navigate to Control panel > Region > Adminstrative.
After successful installation of the Server, check that the Apache Tomcat service is running in the Services window, otherwise manually start it.
Check the port value in the Birt_Installer_[yyyymmdd-hhmmss].txt log file located at C:\ProgramData\Siemens\GMS\InstallerFramework\GMS_Prerequisites_Install_Log to confirm the port assigned to Tomcat. A different port value is auto-assigned in case a default value (18080) is already used.
Manually set this auto-assigned Tomcat port number (other than the default port number) in the Url field, in the SMC when creating Advanced Reporting web application.
NOTE: There is no support for remote Tomcat Server for Advanced Reporting.
You need to create the Advanced Reporting web application to work with Advanced Reporting.
The Web Services Application is created in SMC.
In the SMC tree, navigate to Websites >[website] where you want to create a web application.
Click Create Advanced Reporting Application.
In the Advanced Reporting Information expander, do the following: a. Set the correct Tomcat port in the default URL: http://localhost:18080/gms-birt. b. From the drop-down list, select the appropriate Web Services URL. The Web Services URL is listed in the drop-down list only if it is present under the same website. If the URL is not present, manually enter the URL in the following format, https://[hostname]:[port]/[application name]. c. Enter the System ID of your project. If the System ID is changed in the Server Project Information expander in the Project Settings tab, update the ID manually in the Advanced Reporting Information expander as it will not be automatically updated. NOTE: When updating an Advanced Reporting web application, ensure the following: - With Version 5.1, the Advanced Reporting web application requires you to specify the Web Services URL and System ID. In this case, update the existing Advanced Reporting web application by clicking Edit and specify the value for Web Services URL and System ID. - If any energy reports are configured in your project and if the web services URL that you have set using the Advanced Reporting web application is different than the URL that is configured on the Advanced Reporting configuration page, then you must regenerate the cache. If you do not want to regenerate the cache, then do not update the Advanced Reporting web application for the particular project.
In the Web Application Details expander, type a unique name for the web application.
Click Save.
A confirmation message displays.
Click OK.
The data is validated and, on successful creation, the following occurs: - A new Advanced Reporting web application node is created and selected by default. - A read-only URL for Tomcat Server http://localhost:18080/gms-birt displays in the Advanced Reporting Information expander. 5, - A read-only https URL for Advanced Reporting web application https://[Fully qualified host name of the Tomcat server]:[Port Number]/[Advanced Reporting web application name] displays in the Web Application Details expander.
In the System Management Console (SMC) proceed as follows: a. In the SMC tree, select the Advanced Reporting web application, if not already selected. b. From the Web Application Details expander, click Copy URL to copy the URL for Advanced Reporting web application: https://[Fully qualified host name of the Tomcat server]:[Port Number]/[Advanced Reporting web application name]
In the Extended Operation tab, in the Main URL Value text box, paste the copied https URL and click Set.
The Main URL is configured.
In the Application Viewer tab, click the link for Configuration Page.
The wizard on the Configuration Page - Advanced Reporting displays. If the configuration page does not display, it means that either the Main URL is not configured properly or the Tomcat Server cannot be reached or has stopped. Alternatively, the Default Web Client, internally used for accessing the advanced reports, restricts the access rights. For more information, see Troubleshooting.
Use this procedure to deploy the Advanced Reporting templates from the library to the Tomcat server. If the dependent extensions (for example, Energy and Power Reporting Templates, InfoCenter Reports, and Advanced Reports for Pharma) are added to the project, then the respective templates are already deployed in the libraries at the path [InstallationDrive]:\[Installation Folder]\[Project Name]\libraries\[Library Name]\AdvRpt\[Zip File for Pharma or Energy Reports (AdvR_GMS_Pharma or AdvR_GMS_EnergyReport].
The dependent extensions for which the template synchronization must be done during the Advanced Reporting template synchronization step are added to the Server project along with the Advanced Reporting extension.
In the Synch Libraries page of the wizard, do the following: a. In the Synchronization Source (URL or file path) field, enter the path to the libraries folder of your project. For example, [Installation Drive]:\[Installation Folder]\[Project Name]\libraries. b. In the Synchronization localization Source (file path) field, enter the path to the exports folder of your project. For example, [Installation Drive]:\[Installation Folder]\GMSMainProject\libraries\Exports. c. Ensure the Set the target folder automatically, if not set the Target folder in next field check box is selected to automatically set the ID of the system as the name of the folder where the advanced reporting templates will be extracted on the Tomcat server. Alternatively, to manually enter the System ID, unselect the check box and then select the option button next to Target name and type the System ID. d. In the Type of Source drop-down list, retain the default Archives Only. e. Click Next.
The Advanced Reporting templates (including the templates for the configured dependent extensions such as Energy and Pharma reports) are synchronized and deployed at the path C:\Program Files\Apache Software Foundation\Tomcat 9.0\webapps\gms-birt\[System ID] folder on the Tomcat Server.
In the Layout Settings page of the wizard, specify the values for the position of the page number, the current page number with the total number of pages in the report or just the current page number, date/time when the report is generated, display user name, display system name and ID, name of the customer, name of the site, the logo to be displayed on the report, and the page format for output.
Click Next.
The layout settings for your report are now configured.
In the Cache Settings pageof the wizard, select the Allow Caching check box to allow caching, clean cache on shutdown is by default unchecked. Retain the default values for the default maximum age of cached data, the minimum time before renewal of cache, and the timeout value for concurrent requests. NOTE: If Energy Reporting extension is added to the project, then in the Cache Settings page, you must also specify the values for the maximum resolution of aggregated consumption reports, and the date from when the consumption data is stored.
.
and specify the value for Web Services URL and System ID.
.
.
