Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


When installing Workbench automatically creates a standard directory structure used to hold all the files related to the setup and usage of Workbench. This ensures a standard usage of file locations for use in shortcuts, and for clarity of support.

All downloaded files are then stored in these directories.

 

  • To create this structure, select the Download option for the file Directory Structure.zip
  • Save the file into the Workbench directory you have created

Image Removed

 

  • Uncompress the file Directory Structure.zip into the Workbench directory. It contains a file called install.vbs.
  • Double click this file and follow the instructions
  • You will be asked to input the directory path

 

Image Removed

 

  • If you are on the machine where the already created Workbench directory is you can type the local path e.g. C:\Workbench.
  • If you are accessing from another machine you will need to put the unc path e.g. \\server\workbench
  • You will now be asked to enter the names of the Workbench instances that will be used on this site. This usually is Workbench Live and Workbench Test, but in some cases you may have more Workbench databases.

Image Removed

 

  • Repeat this process for each Workbench instance.
  • When you have entered the last instance click OK when the field is blank
  • This has now created the Workbench server directory structure for each Workbench instance.

 

Image Removed

  • The Workbench directory will now contain the subdirectories and files as detailed below.

Image Removed

...

  • APP: Will have a subdirectory for each Workbench instance
  • Reports: Should have a subdirectory called Samples Setup: Should two sub directories one called Client Setup and one called Server Setup
  • Transfer: Should have one sub directory Email Attachments

If for some reason one or more of these subdirectories are missing you can create them manually. , a single server is normally chosen as the Workbench Application Server. This server hosts the Workbench Application Share, where all the Workbench files are stored.

The Workbench Application Share should be accessible by all Workbench users and servers. Both NTFS and sharing permissions need to allow Workbench users and servers to write to the share.

Files generated by Workbench during normal operation will be loaded into the Workbench Application Share, and files downloaded into the server environment, by Workbench staff, will normally reside here too.

 

...

 

Standard Server Directory Structure

The Workbench Application directory follows a standard directory structure:

 

C:\WORKBENCH
├───App
│   ├───Live
│   └───Test
├───Attachments
├───Backups
│   ├───Databases
│   │   ├───Workbench
│   │   └───WorkbenchTest
│   ├───Mde
│   └───Web
├───Documents
├───File Store
├───Interface
├───Licences
│   └───Previous
├───Manuals
├───Releases
│   ├───Custom
│   ├───Interfaces
│   ├───Mde
│   ├───Sharperlight
│   └───Web
├───Reports
│   └───Samples
├───Scripts
├───Server Transfer
├───Setup
│   ├───Client Setup
│   └───Server Setup
├───Transfer
│   └───Email Attachments
└───Workbench Shared Files

Note: the folder can reside under any directory other than C:\ as shown in the example above.

 

Application Directory Permissions

The Workbench Application Directory is created by Workbench technical staff during installation. It is possible to manually create the folders manually if needed. 

When creating the folders manually, keep in mind, the following groups need write access to the network share / application directory:

  • Workbench Users - normally the Workbench_Users Active Directory security group is sufficient.
  • NT AUTHORITY\NETWORK SERVICE - required if WebWorkbench is installed. NETWORK SERVICE is the default credential setup for WebWorkbench.
  • Service account which the Workbench SQL Server is running under. 

 

Scripted Installation

The Workbench PowerShell Modue, WorkbenchToolbelt, has a cmdlet for creating the Workbench Application Directory.

The PowerShell script can be downloaded from: toolbelt.workbench-cloud.net/Workbench-CreateApplicationDirectory.ps1. Once downloaded onto the target system, import the script into the current PowerShell environment, then run the cmdlet to create the Workbench Application Directory.

Example usage after downloading the script to the desktop of the server, and running the Workbench-CreateApplicationDirectory cmdlet from  a PowerShell console:

Image Added

 

Resulting directories created by the PowerShell cmdlet:

Image Added

 

For more information about the Workbench-CreateApplicationDirectory cmdlet see the cmdlet Confluence page.