Trouble viewing images? Click on images to enlarge.
1. Verify VDM is installed and setup correctly. You can find setup instructions here.
2. Verify IIS is installed and setup correctly. You can find setup instructions here.
3. Verify Microsoft SQL Express 2014 is installed and setup correctly . You can find setup instructions here.
4. Extract the files from the WebReportsDeploy.zip (Download)
5. Open the IIS manager. Expand to the desired website, right click on the desired website, select "Deploy" and then "Import Application"
6. Browse to and select the WebReports.Zip in the extracted WebReportsDeploy folder. Click Next.
7. Use the default Selected Content from the package.
8. Use the default Connection String information. Click Next.
IMPORTANT: If the SQL server is not local, or the Instance is not SQLExpress, these connection strings will need to be modified to the correct server/instance.
For the third connection string (WebReportsEntities) it is vital to not use the connection wizard (...)
This connection string will need to be modified manually by ONLY replacing the following section: data source=localhost\SQLExpress;initial catalog=WebReports;integrated security=True.
9. The wizard will automatically install WebReports and apply the permissions to the SQL Database.
10. Verify that the installation was successful.
11. Edit the WebReports Permissions and give the IIS_IUSRS group permission to Write.
To do this right click on WebReports and edit Permissions.
12. Optional (Recommended): Create the event source for WebReports to write to the Windows Event log. Run the following command via Windows PowerShell (as administrator):
[system.Diagnostics.EventLog]::CreateEventSource("Web Reports", "Application")
13. Browse to the website/WebReports (the first launch will take some time as it's setting up the SQL database with the default roles/Administrator)
14. Set the WebReports OPTIONS. WebReport settings are controlled by a file named OPTIONS that is placed within the WebReports Installation path.
These options will need to be edited using notepad or text editor. A sample file is available. (Download)
- DataOutputLocation: This is the location where any temp data for views will be stored.
- LogLocation: This is the location of VDM's logs. Web Reports will write to the same log files.
- ExecutableLocation: This is the actual executable that will be used for WebReports. This can be changed from the 32-bit executable or the 64-bit executable.
- ReportLocation: This is the location where any views that will be used for WebReports are stored.
- ProfileLocation: This is the location of the connection profiles that will be used.
- ApplicationOptionsLocation: This is the location of VDM's options file.
- TempFileDuration: This tells WebReports (in minutes) how long temp data will be available until it is deleted.
- ShowRegisterOption: This option hides the registration button.
- AccountLockoutAttempts: This is how many failed login attempts before the account is locked.
- AccountLockoutDuration: This is the duration (in minutes) an account is locked out after any number of attempts.
- IPLockoutAttempts: This is how many failed login attempts (does not look at specific accounts) before the IP is locked.
- IPLockoutDuration: This is the duration (in minutes) an IP is locked out after any number of failed attempts.
- EmailProfile: This is the location of an Email profile from VDM. This email profile will be responsible for forgotten passwords and email confirmations.
- EnableSSO: This option enables the Single Sign On option. When enabled, WebReports will look for the SSO Header (next option). If the header exists, WebReports will then check the value of this header (username) and match it to the User that is setup in WebReports, bypassing the login (if the user exists and has access to the report).
- SSOHeader: This is the exact header that WebReports will look for if SSO is enabled. This header will need to contain the user id.
- AccountSessionTimeOut: This option defines how long a user can be idle (in minutes) before they're logged out.
- DownloadableFileDuration: This option is how long reports that are ran through the queue process are available to the user.
- HomeItemsPerPage: This option sets the number of items listed on the Home Page.
- ReportItemsPerPage: This option sets the number of items listed on the Reports Page.
- UserItemsPerPage: This option sets the number of items listed on the User Page.
- RoleItemsPerPage: This option sets the number of items on the Roles Page.
- RemovePortOnRedirect: This option strips out the TCP port on redirected calls, and is most commonly required in environments that leverage a Load Balancer
- AlternateServerURL: This option affects the download link delivered in the email when a Finished Report or Visualization has been queued. Use this entry if users should be directed to an alternate address. Example: https://www.bridgeworksllc.com
15. Run VDM as Administrator and go into the Global Options inside Settings.
Set the Web Reports Options File Location to where you created the OPTIONS file in the previous step. By default this would be c:\inetpub\wwwroot\WebReports\OPTIONS
16. Verify the folder locations inside the Global Options are accessible to the IIS_IUSRS group.
17. Click the Create File button.
18. Login as Administrator.
19. Change the Password for the Administrator Account by managing the account (click Hello Administrator).
Instructions on managing sections of Web Reports can be found here.