Who is this article for?
IT Personnel planning an upgrade to Q-Pulse 7.
IT knowledge access required.
Important: This article is part of a series of articles covering the upgrade process. Please visit How to Perform a Q-Pulse 7 Upgrade to view the entire process.
The Web Reporting Portal (AKA Web Reporting) is an optional feature that needs to be purchased. Web Reporting allows a lightweight web interface for submitting Occurrence reports into the Q-Pulse Occurrences module.
It is important that this tool is upgraded along with your existing Q-Pulse system.
This article outlines:
1. How to Upgrade Web Reporting
Note: Before you begin you should identify the installation location of your Web Reporting Portal. By default this will be C:\inetpub\wwwroot\Reporting
- Browse to the location of your Web Reporting folder.
- Rename this folder to 'ReportingOLD'.
- Copy the contents of the new Web Reporting installation files to C:\inetpub\wwwroot\ as 'Reporting'
- Edit the permissions within the new 'Reporting' folder and give the IIS_IUSRS group the following access:
- Full control on the Uploads folder
- Modify on the Resources folder
- Modify on the Content folder
- Copy the formConfig.xml file from the old installation and paste this into the new installation folder.
For Example: Copy C:\inetpub\wwwroot\ReportingOLD\Resources\Config\formConfig.xml to C:\inetpub\wwwroot\Reporting\Resources\Config\formConfig.xml.
- Update the Web.Config file in c:\inetpub\wwwroot\Reporting and set the following configuration:
- QPulseDatabaseDisplayName – This should be set to the name displayed on the Q-Pulse login screen of the database you wish to report into.
<add key="QPulseDatabaseDisplayName" value="Default"/>
- QPulseUsername – The username of the Q-Pulse user that will be used to submit unauthenticated reports. This user should have the full occurrence access and read access to all other modules (to allow reference list retrieval). If access to occurrence forms is set to use job roles this account must have all relevant job roles applied within the people module.
- QPulsePassword – The password for the above user.
- QPulseAPIEndpoint – This should be configured with the location of the Q-Pulse web services API along with the two endpoints within the client element.
- Authentication Mode – Should be set to ON to enable authenticated mode. To run with unauthenticated mode set to OFF.
- AdminUsers - Q-Pulse usernames with access to the admin area of the portal can be specified in a comma separated list e.g. Admin, ColinD.
- CacheRefreshURL – This URL should be amended to match the virtual directory where Q-Pulse Web Reporting has been deployed. This is required to trigger the cache refresh action of the application.
- If your API is configured for iPad reporting you will need to update the endpoint as follows: address=http://localhost/QPulse5WebServices/services/Occurrence.svc/soap
- If the Q-Pulse web services are not installed on the same machine as the web reporting portal all the endpoints will need to have localhost updated to the IP address or machine name where they reside.
- If the Q-Pulse web services are setup to use SSL the mode attribute on the security elements will need to be changed to Transport e.g. <security mode=”Transport” />
- If multiple instances of Q-Pulse Web Reporting are setup on the same server you should ensure that each has a unique value specified for the name attribute on the forms element. This is to avoid conflicts with authentication cookies. E.g. <forms name=".ASPXAuth_QP1"…
- Test on the server using the URL http://localhost/reporting as this will display any error details in the event of a configuration problem.
With the application server successfully upgraded you are ready to upgrade a client and test the system is functioning. Please see the Post-Upgrade Checklist for the next steps or How to Perform a Q-Pulse 7 Upgrade to review the whole process.