Difference between revisions of "Service pack"

From PARS
Jump to navigationJump to search
Line 1: Line 1:
To update PARS to a newer version, you will need to run a PARS service pack. This can be done from any workstation that has SIMS installed, and only needs to be done on one workstation. Every other workstation on the network will update PARS automatically the next time someone logs in. You '''do not''' need to kick users out of PARS to run an update. PARS Connect users will automatically receive the update once the IIS server has been updated. <br> <br>
+
[[Image:topology.png|thumb|The PARS Connect network topology]]
  
To run a service pack, you will first need to download it from our website, www.tascsoftware.co.uk . Log in to our website using the login box at the top-right of the page, and then click the "Downloads" link from the top of our homepage. <br> <br>
+
To install PARS or update it to a newer version, you will need to run a PARS Service Pack. This can only be done from the IIS server. PARS Connect users will be kicked out if you run a Service Pack, though you do '''not''' need to kick out PARS .Net users. Once the Service Pack has finished running, users will automatically receive the update from the IIS server. <br> <br>
  
[[Image:servicepack01.jpg]] <br> <br>
+
Installation is performed on an IIS server. To install PARS on your IIS server, the server will need the following components installed: <br> <br>
  
The PARS update will be called "PARS .net Update vX.XXX" - where the X.XXX is replaced by the version number. Usually the updates are minor and intended for a small number of schools. If enough minor releases have been made emails will be sent out notifying users of the latest version. PARS .net and PARS Connect service packs are both contained in the same download available from our website. <br> <br>
+
*SIMS .Net Workstation
 +
*<u>[[IIS|IIS (version 7 or higher)]]</u>
 +
*Microsoft .Net Framework (version 4.0 or higher) <br> <br>
  
If you can see two service packs for PARS, the earlier one is considered the most recent "stable" patch. The later service pack, while still stable, has spent less time in use. Check the revision history of the latest version to see the differences between the two service packs. <br> <br>
+
=Downloading the Service Pack=
  
After running the service pack file as detailed above, log in to the IIS server and locate the file ServiceController.exe. This is found in [Shared SIMS folder]/PARS/CONNECT. The shared SIMS folder is usually S:\SIMS, to confirm this click Start -> Run -> Enter this text: SIMS.ini -> hit enter. A text file will open, find the line: SIMSDIRECTORY=(etc). Run this file, click "Commit" followed by "Begin". This will kick all users out of PARS Connect and complete the update process. <br> <br>
+
Download the latest PARS Service Pack from our website, [http://www.tascsoftware.co.uk/web/support/_downloads.aspx www.tascsoftware.co.uk]. You will need to have your helpdesk login details available for this. If you have forgotten your login details, or have never had an account, you can contact us using our [http://www.tascsoftware.co.uk/web/contact.aspx website contact page]. Alternatively, you can call us on 01902 824281. <br> <br>
  
==Updating the SIMS database==
+
When you have logged into our website, you will see a list of available downloads. PARS Connect and PARS .Net updates are both contained in the PARS service pack. <br> <br>
  
If you are performing a SIMS update, we recommend that you also update PARS. First update SIMS as normal, then update PARS following the steps above. <br> <br>
+
[[Image:downloads.jpg|600px]] <br> <br>
  
==Troubleshooting a PARS service pack==
+
=Installing or Updating (running the Service Pack)=
  
Here is a walkthrough of the process of applying a service pack along with an explanation of some of the most common errors that can occur: <br> <br>
+
Once you have downloaded the latest Service Pack, run it on the IIS server. A window will open - follow the steps below to install or update PARS Connect. <br> <br>
  
Once the service pack knows where to find the shared PARS folder (by checking the local [[SIMS.ini]] file for SIMSDIRECTORY=(etc)), it attempts to gain exclusive access to it by renaming it to PARSSP. If it cannot do this then the following error will appear: <br> <br>
+
PARS Connect is a browser-based version of PARS. Even if you are using PARS .Net only and you have not paid for a PARS Connect licence, you still need to install PARS Connect using the Service Pack, as PARS Connect handles [[automation]], [[licence details|licencing]], and version updates. Instructions for this are found below. <br> <br>
  
[[image:Negotiate_exclusivity.jpg]] <br> <br>
+
If you want to update or install PARS .Net, you should first ensure that PARS Connect is installed on your IIS server. You can then  follow the instructions in the section below for installing PARS .Net. <br> <br>
  
Common reasons for this are that the folder is open/in use or the service pack is being run from within the folder. Try renaming the folder by hand. If this is not possible reboot the server and try again. <br> <br>
+
'''Please note that the Service Pack <u>must</u> be run on the IIS server, not any other machine. <br> <br>
  
Once the service pack has renamed the PARS folder to PARSSP, it updates all of the files in the folder. When this stage has finished it renames to folder back to PARS. This stage of the process is now over. <br> <br>
+
==Prerequisites==
  
Every time PARS .net workstation is run, the bootstrap.exe programme checks the local and remote versions of bootstrap.exe and PARS.exe. If these files are different it deletes all of the local files and copies the updated ones from the shared PARS folder. This process can be forced by adding the shortcut switch /C to the end of the PARS target line. This is '''not''' applicable to PARS Connect. <br> <br>
+
This tab will check that you have the required prerequisites in order to install or update PARS. If any components are missing, install them then rerun the PARS Service Pack. <br> <br>
  
 +
[[Image:prequisites.jpg|800px]] <br> <br>
 +
 +
==Database==
 +
 +
At this stage the Service Pack will check the connection to the SIMS database. If the Service Pack cannot find your SIMS database, you will need to find out why then resolve the issue before running the PARS Service Pack. Running SIMS on the server may provide some clues as to why the PARS Service Pack could not connect to the SIMS database. <br> <br>
 +
 +
[[Image:database.jpg|800px]] <br> <br>
 +
 +
===Installation===
 +
 +
If you are installing PARS you will be asked for your SQL System Administrator (sa) password. <br> <br>
 +
 +
[[Image:sapwd.jpg]] <br> <br>
 +
 +
Enter your SQL sa password then click "Connect". <br> <br>
 +
 +
===Updating===
 +
 +
If you are updating PARS for the first time since migrated your SIMS SQL server, you may be asked for your SQL SA password. If this is not the case and you are being asked to provide an SA password '''when updating PARS''' then do not proceed any further and contact our [[Help:Contents|helpdesk]] immediately. <br> <br>
 +
 +
==Application==
 +
 +
This tab allows you to select the website where PARS will be installed. <br> <br>
 +
 +
===Installation===
 +
 +
You should see a message box asking whether you wish to perform a new install. '''If you do not see the window below, contact our [[Help:Contents|helpdesk]].''' <br> <br>
 +
 +
[[Image:newinstall.jpg]] <br> <br>
 +
 +
You will see "Default Web Site" and "Create new website", as well as the names of any other websites hosted by this IIS server. We recommend installing PARS as a new website. However if you do not know where to install the files for the PARS website, you can use the Default Web Site instead. <br> <br>
 +
 +
===Updating PARS===
 +
 +
'''If you see a message box like the one below, please contact our [[Help:Contents|helpdesk]].''' <br> <br>
 +
 +
[[Image:newinstall.jpg]] <br> <br>
 +
 +
You will see a list of websites here, one of which should have an asterisk (*) after its name and will already be selected. If you can see multiple sites with an asterisk their names then PARS has been installed more than once. <br> <br>
 +
 +
You should then see a window like the one below: <br> <br>
 +
 +
[[Image:application02.jpg|800px]] <br> <br>
 +
 +
==Session State==
 +
 +
This tab gives options for handling the session state of logged in users. '''If you are unsure of which option you need to select, or do not know the pros and cons of each option, then you should choose the top option.''' <br> <br>
 +
 +
[[Image:sessionstate.jpg|800px]] <br> <br>
 +
 +
==Commit==
 +
 +
As long as there are no errors, you will not see this tab. The installer will skip past this tab and perform all of the steps for you. <br> <br>
 +
 +
[[Image:commit01.jpg|800px]] <br> <br>
 +
 +
A window will open explaining whether or not the Commit tab ran successfully. If everything was successful then the window will disappear after 5 seconds. Otherwise the window will stay open telling you what went wrong. <br> <br>
 +
 +
[[Image:auto_success.jpg|800px]] <br> <br>
 +
 +
==Auxiliary==
 +
 +
If your window looks like the one below then the installation or update has completed successfully and you can click the "Finish" button to finalise it. <br> <br>
 +
 +
[[Image:auxiliary01.jpg|800px]] <br> <br>
 +
 +
If you see the following image then the Service Pack thinks that the server you have used is not your main PARS IIS server. If this is correct, click "Finish". <br> <br>
 +
 +
[[Image:whichmain.jpg]] <br> <br>
 +
 +
If this server '''is''' your main PARS IIS server (perhaps because you have migrated your server) then select "Yes", then click "Finish". <br> <br>
 +
 +
=Installing PARS .Net=
 +
 +
PARS .Net can only be installed on SIMS workstations. To get the .msi file, download it from [this link] and install it on the relevant machines. <br> <br>
 +
 +
=Extras=
 +
 +
==CAPTCHA==
 +
 +
If you wish you can set a [http://en.wikipedia.org/wiki/Captcha CAPTCHA] which will be required for users to log in to PARS Connect. To enable this, find the web.config file on the IIS server (by default it is found in c:\inetpub\wwwroot\pars) and open the file in Notepad. Find the lines of text below and make sure that "value" is set to "On". <br> <br>
 +
 +
<setting name="CAPTCHA" serializeAs="String">
 +
  <value>On</value>
 +
</setting>
 +
 +
==PINS==
 +
 +
Each user can be assigned a temporary PIN that is required along with their password in order to log in. The PIN is valid for 5 minutes after it is issued and is send to a person's email address or as an SMS message when a person tries to log in. To enable this, find the web.config file on the IIS server (by default it is found in c:\inetpub\wwwroot\pars) and open the file in Notepad. Find the lines of text below and make sure that "value" is set to "On". <br> <br>
 +
 +
<setting name="PINS" serializeAs="String">
 +
  <value>On</value>
 +
</setting>
 
[[Category:Technical]]
 
[[Category:Technical]]
 +
[[Category:Configuration]]

Revision as of 16:46, 8 July 2014

The PARS Connect network topology

To install PARS or update it to a newer version, you will need to run a PARS Service Pack. This can only be done from the IIS server. PARS Connect users will be kicked out if you run a Service Pack, though you do not need to kick out PARS .Net users. Once the Service Pack has finished running, users will automatically receive the update from the IIS server.

Installation is performed on an IIS server. To install PARS on your IIS server, the server will need the following components installed:

Downloading the Service Pack

Download the latest PARS Service Pack from our website, www.tascsoftware.co.uk. You will need to have your helpdesk login details available for this. If you have forgotten your login details, or have never had an account, you can contact us using our website contact page. Alternatively, you can call us on 01902 824281.

When you have logged into our website, you will see a list of available downloads. PARS Connect and PARS .Net updates are both contained in the PARS service pack.

Downloads.jpg

Installing or Updating (running the Service Pack)

Once you have downloaded the latest Service Pack, run it on the IIS server. A window will open - follow the steps below to install or update PARS Connect.

PARS Connect is a browser-based version of PARS. Even if you are using PARS .Net only and you have not paid for a PARS Connect licence, you still need to install PARS Connect using the Service Pack, as PARS Connect handles automation, licencing, and version updates. Instructions for this are found below.

If you want to update or install PARS .Net, you should first ensure that PARS Connect is installed on your IIS server. You can then follow the instructions in the section below for installing PARS .Net.

Please note that the Service Pack must be run on the IIS server, not any other machine.

Prerequisites

This tab will check that you have the required prerequisites in order to install or update PARS. If any components are missing, install them then rerun the PARS Service Pack.

Prequisites.jpg

Database

At this stage the Service Pack will check the connection to the SIMS database. If the Service Pack cannot find your SIMS database, you will need to find out why then resolve the issue before running the PARS Service Pack. Running SIMS on the server may provide some clues as to why the PARS Service Pack could not connect to the SIMS database.

Database.jpg

Installation

If you are installing PARS you will be asked for your SQL System Administrator (sa) password.

Sapwd.jpg

Enter your SQL sa password then click "Connect".

Updating

If you are updating PARS for the first time since migrated your SIMS SQL server, you may be asked for your SQL SA password. If this is not the case and you are being asked to provide an SA password when updating PARS then do not proceed any further and contact our helpdesk immediately.

Application

This tab allows you to select the website where PARS will be installed.

Installation

You should see a message box asking whether you wish to perform a new install. If you do not see the window below, contact our helpdesk.

Newinstall.jpg

You will see "Default Web Site" and "Create new website", as well as the names of any other websites hosted by this IIS server. We recommend installing PARS as a new website. However if you do not know where to install the files for the PARS website, you can use the Default Web Site instead.

Updating PARS

If you see a message box like the one below, please contact our helpdesk.

Newinstall.jpg

You will see a list of websites here, one of which should have an asterisk (*) after its name and will already be selected. If you can see multiple sites with an asterisk their names then PARS has been installed more than once.

You should then see a window like the one below:

Application02.jpg

Session State

This tab gives options for handling the session state of logged in users. If you are unsure of which option you need to select, or do not know the pros and cons of each option, then you should choose the top option.

Sessionstate.jpg

Commit

As long as there are no errors, you will not see this tab. The installer will skip past this tab and perform all of the steps for you.

Commit01.jpg

A window will open explaining whether or not the Commit tab ran successfully. If everything was successful then the window will disappear after 5 seconds. Otherwise the window will stay open telling you what went wrong.

Auto success.jpg

Auxiliary

If your window looks like the one below then the installation or update has completed successfully and you can click the "Finish" button to finalise it.

Auxiliary01.jpg

If you see the following image then the Service Pack thinks that the server you have used is not your main PARS IIS server. If this is correct, click "Finish".

Whichmain.jpg

If this server is your main PARS IIS server (perhaps because you have migrated your server) then select "Yes", then click "Finish".

Installing PARS .Net

PARS .Net can only be installed on SIMS workstations. To get the .msi file, download it from [this link] and install it on the relevant machines.

Extras

CAPTCHA

If you wish you can set a CAPTCHA which will be required for users to log in to PARS Connect. To enable this, find the web.config file on the IIS server (by default it is found in c:\inetpub\wwwroot\pars) and open the file in Notepad. Find the lines of text below and make sure that "value" is set to "On".

<setting name="CAPTCHA" serializeAs="String">
  <value>On</value>
</setting>

PINS

Each user can be assigned a temporary PIN that is required along with their password in order to log in. The PIN is valid for 5 minutes after it is issued and is send to a person's email address or as an SMS message when a person tries to log in. To enable this, find the web.config file on the IIS server (by default it is found in c:\inetpub\wwwroot\pars) and open the file in Notepad. Find the lines of text below and make sure that "value" is set to "On".

<setting name="PINS" serializeAs="String">
  <value>On</value>
</setting>