Web Service Installation Instructions

The Web Service (WS) is used to facilitate the transfer of information between the database holding the HR /Payroll data, wherever it may be located, and either of the Self Service (SS) or Candidate Capture (CC) functions which are both externally hosted.

Prerequisites

The Windows account being used to perform the installation of both the Windows Desktop Application (WDA) and WS must have administrative permissions.

An up to date version of the WDA must be installed on the server that the WS is to be installed on.

The WDA must be configured to communicate with the required HR/Payroll database. Please see the appropriate guidance notes on using the Connection Manager to describe the location of the HR/Payroll database and any other required facilities such as Financial database or Financial Web Service.

The HR Portal User on the Connection Manager must be set to the appropriate Application User (not Windows). This is the User ID that is going to be used to access the system when requests come in from SS and CC. To access the Connection Manager, navigate to the appropriate sub folder of the WDA installation. This is typically:

C:\Program Files (x86)\Jane\System
or C:\Program Files (x86)\PS Financial\PS People\System

If you have used a version of the WDA installation Setup which enables you to dictate the location of the software folder then please navigate to the System sub folder within your chosen software folder.

Once this System folder has been located, please locate and click on file: jsconnection.exe

Login using the administrator’s password for the WDA.

Select the appropriate Portal user in the HR Portal User drop down list:

If a template database has been used to instigate the use of the WDA then it is likely that an appropriate user such as ‘Portal Self-Service User’ has already been defined.

Installing the Web Service

  1. Ensure the Windows Desktop Application is installed and configured on the target machine.
  2. Navigate to IIS (as Administrator) and create a new Application Pool, call it ‘RESTWebService’. Verify that the .NET Framework Version of the application pool is set to ‘v4.0’ and the Pipeline Mode is ‘Integrated’. Also, go to Advanced Settings and set ‘Enable 32-bit Applications’ to TRUE.
  3. Create a new site in IIS on the target machine called ‘RESTWebService’ where the Windows application will be installed. Make sure the application pool is set to the one created in step 2. Create a new folder in C:\inetpub called ‘RESTWebService’ and set that as the Physical Path. The port number you select must not conflict with any existing web sites. It is recommended that this port number should be 8000 or greater.
  4. Add a new Web Application to the site where the WS files will be stored. Call it ‘RESTWebService’. Again, set the physical path to the one described in the previous step.
  5. Unzip the folder containing the WS files and copy them into the ‘RESTWebService’ folder. The WS files will be sent out to you.
  6. Test that the WS is up and running. To do this you can navigate to the version endpoint: http://localhost:<port number if applicable>/RESTWebService/JaneRecruitment.svc/version
  7. Take the appropriate actions to secure the WS by applying an SSL certificate for example, and make it externally facing. This may be a more extensive process than the previous sentence implies but the steps required to make the WS visible by an external function will be dictated by the local infrastructure, in particular the Firewall(s). Hence, the modifications required to these Firewalls can only be described by a local technician. Complex domain structures and strictly controlled user access may also prohibit the WS from being ‘seen’ by these external functions (SS and CC). We would also suggest that you modify the WS installation to only allow communications with the SS and CC facilities. These Web Sites are: www.SelfService.Global & www.Applicant.Website
  8. Inform Jane Systems of the full URL that is hosting the WS, such as: http://servername.cloudapp.net/JaneRecruitment.svc. This needs to be configured within the external facilities controlling the SS and CC. Any associated port numbers should also be provided.