Sharepoint 2010

Application Setup

Please ensure the latest HR Application is installed on the same system as the HR Web Service as this implementation will control the provision of information by the Web Service.

QLx

For the webparts to work correctly with QLx, it is required to setup a non-administrative user called REMOTE_HR.

THE SOFTWARE

A Software Portal user must be set in the Connection Manager (jsconnection.exe).

Install the HR Web Service

1. You will need to create a new application pool (called HRWebService) within Internet Information Services (IIS) Manager, ensuring that you are running as the administrator (right click IIS Manager -> Run as Administrator). Verify that the .Net Framework Version of the application pool is set to v2.0.50727. If not, change it under Basic Settings. Once the application pool has been created, go to Advanced Settings, and set Enable 32-Bit Applications to true.

2. Next you will need to create a new web site (same name as application pool for consistency) where the HR Web Service will be hosted. Make sure that the application pool is set to the application pool created in step 1. Create a new folder, C:inetpubHRWebService and set that as the physical path. The port number can be any number as long as it doesn’t conflict with any existing web sites (recommended to be 8000 or greater).

3. Download and unzip HRWebService.zip, select setup.exe and follow the instructions of the installation wizard, installing the web service to the web site created above.

4. If you get an error indicating that the installer was interrupted before HR Web Service could be installed, verify that the following Role Service has been enabled:

Go to the service roles of the computer:

Control Panel > Programs > Programs and Features > Turn Windows features on or off

Find the IIS Service Role and add a new role service:

Roles > Web Server (IIS) > Add Role Service

Make sure the following option is ticked on:

Management Tools > IIS 6 Management Compatibility > IIS 6 Metabase Compatibility

Re-run the HR Web Service installer.

5. Edit the Web.Config as an administrator in the HRWebService folder (created in step 2) and make sure that the Jane.Environment key is to “QL” for QL-x, or “JANE” for Jane HR.

6. To verify that the web service is functioning correctly, within a web browser, navigate to the web site where you installed the HR Web Service (https://<HRWEBSERVICE_SITE>/HRWebService/CallComObject.asmx).

Note: <HRWEBSERVICE_SITE> should be replaced with the appropriate URL, as created in step 2.

Note: If you receive an access error in step 6, check the web site’s authentication. In the IIS Manager, click on the web site where the HR Web Service is installed and click on Authentication. You’ll need to ensure that Annonymous and/or Windows Authentication is enabled (more information: https://technet.microsoft.com/en-us/library/cc733010(v=WS.10).aspx).

Install The Web Parts

Download and unzip QLHRWebParts.zip.
From the Command prompt:
cd “C:Program FilesCommon FilesMicrosoft Sharedweb server extensions14BIN”
(14 – SharePoint 2010, 15 – SharePoint 2013)
If you already have a previous version installed, add the following two lines to identify and remove any existing installations:
STSADM.EXE -o enumwppacks
STSADM.EXE -o deletewppack -name QLHRWebParts_<Version>.cab
Add this line to finish installing the web parts:
STSADM.EXE -o addwppack -globalinstall -filename <pathToCabFile>

Configuring the SharePoint web.config

Finally, the following entries will need to be added/modified in the SharePoint site’s web.config. Typically this would reside in c:inetpubwwwrootwssVirtualDirectories80.

Under <modules runAllManagedModulesForAllRequests=”true”>, remove the following line:

<remove name=”Session” />

In the appSettings section (below the </system.net> tag), add the following settings:

<!– URL of the HR Web Service –>

<add key=”HRWebService” value=”https://<HRWEBSERVICE_SITE>/HRWebService/CallComObject.asmx” />

QLx users need to add the following:

<add key=”Agresso.QLP.Environment” value=”<PUT_YOUR_CONNECTION_CODE_HERE>” /> <!– QL Administrator – Connection Code –>

<add key=”Agresso.QLP.Qualifier” value=”<PUT_YOU_REMOTE_HR_PASSWORD_HERE>” />  <!– Password for REMOTE_HR user –>

Some web parts will also need additional configuration settings. The HR Calendar will need config entries to set the colors for Training, Absence and Leave. Please see https://ps.people-help.online/sys-admin-webconfig-options for the entry names.

With SharePoint 2010 and above, the calendar body of the date control will be transparent by default. Add the following to the web.config to fix this:

<add key=”Agresso.QLP.CustomStyle.CalendarBody” value=”ms-rteStyle-Normal” />

If you are installing on SharePoint 2013, perform the following step: 

The following entry will need to be added to the web.config appSettings section. This is to fix an issue where the text in the date control is unreadable:

<add key=”Agresso.QLP.CustomStyle.TextEntry” value=”ms-rteFontSize-1″ />

Testing the Web Parts

  1. To test that the web parts are communicating with the web service correctly, insert the HR Version Numbers web part and verify that each section is displaying both a version number and a date.
  2. To test that data is being retrieved successfully, insert the HR Personnel Card web part and verify that specific employee details are displayed. To ensure that the correct details are returned, the role web part property should be set to SS (self service) and the SharePoint user account has been mapped to an employee within the application. This is done via the Windows user field on the HR record personal details screen.

Issues with Testing the Web Parts

Communication issues – HR Version Numbers Web Part

If the HR web service version number and date is not being displayed, verify that the HR web service is running by loading the URL of the web service in a web browser.

If the web service is running correctly, the following should be returned:

If this is not returned, please go back to the “Install the HR Web Service” section of the instructions and verify that each step has been completed.

Data retrieval issues – HR Personnel card Web Part

If the application software section is not returning the version number and date, please verify the following:

  • Ensure that the HR Portal user has been set in the connection manager
  • Ensure that the HR Portal user exists within the system
  • Ensure that the environment setting in the HR Web Service web.config has been set to the appropriate environment

If there is a specific issue which is not explained here, please refer to the Troubleshooting Section.

SharePoint Site Access

By default, once the SharePoint site is up and running, only the site owner will be able to access the site. To allow other users to access the site you will need to add them to the appropriate SharePoint groups.

SharePoint has 3 groups by default. Owners, Visitors and Members.

Owners – Members of this group have complete control over the site and are able to add/remove users, create Document Libraries and modify all aspects of the site.

Members – Members of this group are able to add/remove/modify web parts, create pages, update documents etc.

Visitors – Members of this group have read-only access to the site and are unable to modify pages or web parts.

See here  for more information about SharePoint groups.

To add users to a group, go to Site Actions > Site Permissions. Click on the appropriate group and then select New > Add Users. Generally the System Administrator should be added to the Owners group. For maintainability, it is better to add an Active Directory users group to the SharePoint Visitors group rather than individual users.