How do I configure Customer Web Service (CWS) on IIS?

You are here:
< Back

Before end-users and callers can start using Customer Web Service (CWS), the helpdesk administrator needs to first setup and configure certain settings, in the web access administrative panel in Team Helpdesk Outlook, and then on the IIS web server. The followings list all the steps required to be performed to get CWS website running in few minutes.

Step 1: Setting up an Application under IIS
Step 2: Set appropriate network permission to the IIS shared folder
Step 3: Extract/Copy all Customer Web Access application files to the IIS web folder

Step 4: Set ASP.NET permission on Temp sub-folder

Step 5: Configure web Access specific settings in Team Helpdesk add-in
Step 6: Write/Update XML metadata files from Team Helpdesk for Outlook

Step 1: Setting up an Application under IIS

The first step in setting up the Customer Web Service (CWS) site requires creating a new application under your IIS server. In this document, we discuss the configuration of an application on your default web site under your IIS.

To create a new application, right-click the site and select ‘Add Application…’.

You will be prompted with the ‘Add Application’ dialog box.

Type the alias for the Application, say, CWS and specify the physical folder on the local server to map to this alias. In this case, the physical folder on the server is D:\Inetpub\wwwwroot\CWS

Click OK. The image below displays the result.

Step 2: Set appropriate network permission to the shared folder

The just created ‘CWS’ IIS Application now needs to be set as a shared network folder for all the helpdesk technicians that uses Team Helpdesk for Outlook. Data interchange between the customer web access and the Team Helpdesk add-in in Outlook uses XML formats and are written to a temporary subfolder ‘Temp’ under the application folder. Due to this requirement, all helpdesk technicians working in Outlook will need to have full control over the ‘CWS’ network folder.

Right-click the CWS application from the tree view and click ‘Edit Permissions…

We need to grant full control to this folder (eg. D:\Inetpub\wwwroot\CWS) in both Sharing and Security tabs. Let us start with the first one. Click the Sharing tab > Advanced Sharing…

From the ‘Advanced Sharing’ box, enable the option ‘Share this folder’. And then click ‘Permissions’.

Once you are in the permissions dialog, you will see that by default, any users on the local network have read permission over the shared folder. For our needs, we need to allow all helpdesk users to save/update files under this folder. So, either you can add individual user or a group (if you have it defined).

In our example, we have defined a group ‘ServiceDesk’ comprising of all helpdesk users so that setting permission for all users can be done in a single click. Check the option ‘Full Control’ to allow all technicians in the helpdesk team to save/update ‘Customer Web Service’ specific metadata XML files.

Likewise, add the same helpdesk group (eg. ServiceDesk) under the Security tab and grant ‘Full Control’ access.

Step 3: Extract all Customer Web Service (CWS) application files

Now that we have created an exclusive web-enabled physical folder on the server and granted full control to all helpdesk users (step 1 and 2 respectively), the next step is to extract all the files and subfolders from the Customer Web Service zip archive (eg. CWS.zip) to the shared network IIS folder.

This CWS.zip is installed with Team Helpdesk Manager, and is located under the following folder in your system:

On Windows XP
C:\Documents and Settings\USERNAME\Application Data\AssistMyTeam\Team Helpdesk Resources

On Vista and Windows 7, 8
C:\Users\USERNAME\AppData\Roaming\AssistMyTeam\Team Helpdesk Resources

The contents of ‘CWS.zip’ are shown below:

Extract all the files and subfolders under the zip (eg. CustomerWebService.zip) file to the network shared web-enabled Customer Web Service (CWS) folder. For example, \\192.168.1.4\CWS where ‘192.168.1.4‘ is the windows server and ‘CWS‘ being the web-enabled folder (either configured as a website or virtual directory under an existing website in IIS). If step 2, if the permission (eg. full control) was successfully set, the files and subfolder would be extracted/copied to the network share.

Step 4: Set ASP.NET (Internet Guest Account) permission on Temp folder.

The Customer Web Service functionality is built upon ASP.NET 2.0 and AJAX technology. Typically, an ASP.NET application requires read, execute, and list access for the ASP.NET account (also known as Internet Guest Account) for the web site root (for example: D:\inetpub\wwwroot\CWS or any alternative site directory you may have configured in IIS), the content directory and the application root directory in order to monitor for configuration file changes. The application root corresponds to the folder path associated with the application virtual directory in the IIS Administration tool.

Under your IIS server, you have multiple subfolders under the CWS application. The special interest that we have now is for the ‘Temp’ folder, as this is the folder that saves uploaded attachments from support request case temporarily. Hence, the ASP.NET account needs to be configured to have full control over this ‘Temp’ folder. You do that by right-clicking ‘Temp folder > ‘Edit Permission…’.

From the Temp properties dialog box, click the ‘Security’ tab, and click the ‘Edit…’ button to invoke the ‘Permissions’ tab.

In the ‘Permissions’ dialog box, select the ASP.NET (Internet Guest) account. Different version of IIS has different ASP.NET account name. For example, in IIS version 5 (windows 2000 server), it is ASPNET, and in IIS version 6 (windows server 2003), it is IIS_WPG group whereas in IIS 7 version (Windows 7 and 2008 server), it is IIS_IUSRS group.

In the screenshot below, we have IIS 7 version and hence, the IIS_IUSR group is allowed ‘Full Control‘ over the ‘Temp‘ folder.

Step 5: Configure CWS specific settings from Outlook

The Customer Web Service (CWS) site does not make use of a database to store the helpdesk settings and lists. Instead, the data and settings are stored as XML metadata files and are saved/updated from the Team Helpdesk add-in interface in Outlook (by helpdesk managers/technicians). The document takes you to finer detail on various web access settings that need to be configured in the administrative tool, before saving/updating the XML metadata files in the IIS folder.

Displayed below is a part of the Customer Web Service (CWS) settings dialog. To save/update the CWS specific XML metadata files from Outlook to the shared network web-enabled folder (on the server), it needs to know the full UNC folder path. If the network folder resource requires a network credential, then you will be prompted to enter one

Check this option to update the CWS specific settings metadata automatically when there is any change in the Team Helpdesk settings in Outlook/Exchange. The Team Helpdesk lists and settings (eg. problem categories and types) would surely change/update in due time. The helpdesk manager would need to update the web service XML metadata files accordingly, so that data used in the web service application is in synch with that in Outlook. Though the helpdesk manager can manually update the data files for web service, it would be a tedious task if the settings in Outlook are to change every now and then. In such scenario, it is recommended to allow Team Helpdesk (in Outlook) to automatically update CWS specific metadata XML files in the shared network folder, when there is any changes in the lists and settings in Outlook.

Check this option to create/Update knowledge base data XML files in the web-enabled CWS network folder.

Check this option to make the custom fields available in the support request submission web form.

Check this option to make the asset fields available in the support request submission web form.

The Caller Web Access (CWA) site, which is a part of the Customer Web Service (CWS) site, requires a user credential for caller to access their support cases online. Helpdesk managers can define this credential (eg. password) in the Team Helpdesk Callers list dialog. Alternatively, a random password can be generated automatically when a new caller is added to the Callers list.

Step 6: Write/Update XML metadata files from Outlook

The last remaining step is to save/update the Customer Web Service (CWS) specific XML metadata files in the CWS network web-folder. The XML metadata files contain the required Team Helpdesk lists and settings defined by the helpdesk manager in Outlook and these files feed data to the Customer Web Service applications when end-users submit new support requests via web-form or when callers login to load their support cases.

Before any XML data files can be updated, the helpdesk manager needs to specify the network share that was configured in Step 2. If the appropriate permission was set, clicking the ‘Update data’ button generate all the required XML files.

Now, open your web browser and point to the CWS URL. Usually the URL is in the format http://[IIS Server Name]/CWS/

For example, in our instance, it would be http://byteStation/CWS/