Pre-Install / Upgrade Server Audit
Prior to installing or upgrading Workbench at a client site, a Site Audit of the current server environment should be undertaken to identify any issues which may prevent the install / upgrade from being carried out successfully.
The Site Audit involves a Workbench Technical Consultant logging into the site and collecting relevant details about the target servers where Workbench is to be installed / upgraded.
Conducting the Audit
- Fill out the checklist with details about the server(s) that Workbench will be deployed too (Its a good idea to copy the checklist and paste into a JIRA issue).
- On True / False questions, delete the incorrect answer.
- Try to keep version numbers either as integer or floating point values. This will help when comparing values later on.
- Separate multiple entries on the line with a comma.
- Sections that are not installed or won't be included in the install / upgrade, leave section headings in grey and values empty.
- Sections that need attention, bold and mark with red text.
Checklist
(Copy the content between the horizontal lines into the appropriate Server Audit JIRA issue - it should interpret the Markdown syntax correcly. See the example below)
h3. Information collected from client servers
h5. Server Details
- Server Name:
- Operating System:
- Workgroup / Domain:
- PowerShell Version:
h5. Workbench Components
- Database Server: True/False
- Report (SSRS) Server: True/False
- Web Server (IIS): True/False
- Workbench Application Server: True/False
- Workbench Client: True/False
- Sharperlight: True/False
h5. Database Server Details
- SQL Server Instance:
- SQL Server Version:
- SQL Login with Sysadmin: True / False
- Workbench Databases / Versions:
- EBA client: True / False
h5. Report (SSRS) Server Details
- SSRS Instance:
- SSRS SQL Server Version:
- Web Service URL:
- Report Manager URL:
- No encryption key error: True / False
h5. Web Server (IIS) Details
- Server name:
- NET Framework Version:
- IIS Version:
- WebWorkbench Version:
- Workbench Web Sites:
- Application Pools:
- URLs
- Physical Path:
h5. Workbench Application Server Details
- Workbench Share
- UNC:
- Physical Path:
- Workbench Applications / MDE's (Filename):
- Custom MDE: True / False
- Custom Scripts: True / False
- GST Rate Settings
- GSTType Table and Control File have the same rate: True / False
h5. Workbench Client Details
- Office version:
- KB2881029 installed (required for Workbench client): True / False
h5. Sharperlight
- Sharperlight Version:
- Datamodel Version:
h5. Email Options
- Preferred emailing method:
h5. Windows Accounts
- Workbench_Users account exists: True / False
h5. Web Browser
- Supported Web Browser: Google Chrome / Mozilla Firefox / IE11 or Edge
Example output in JIRA
Information collected from client servers
Server Details
- Server Name:
- Operating System:
- Workgroup / Domain:
- PowerShell Version:
Workbench Components
- Database Server: True/False
- Report (SSRS) Server: True/False
- Web Server (IIS): True/False
- Workbench Application Server: True/False
- Workbench Client: True/False
- Sharperlight: True/False
Database Server Details
- SQL Server Instance:
- SQL Server Version:
- Workbench Databases / Versions:
Report (SSRS) Server Details
- SSRS Instance:
- SSRS SQL Server Version:
- Web Service URL:
- Report Manager URL:
Web Server (IIS) Details
- Server name:
- NET Framework Version:
- IIS Version:
- Workbench Web Sites:
- Application Pools:
- URLs
- Physical Path:
Workbench Application Server Details
- Workbench Share
- UNC:
- Physical Path:
- Workbench Applications / MDE's (Filename):
- Custom MDE?
Workbench Client Details
- Office version:
- KB2881029 installed (required for Workbench client): (boolean)
Sharperlight
- Sharperlight Version:
- Datamodel Version:
Collection Methods
Methods for collecting various bits of information.
- TODO