web installationupdates.bksb.co.uk/faqpatches/guides/web_install_guide.pdfinstallation and we highly...

16
Web Installation Technical Guide 2010 Version

Upload: others

Post on 27-Sep-2020

1 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Web Installationupdates.bksb.co.uk/FAQPatches/Guides/web_install_guide.pdfinstallation and we highly recommend using the default value supplied in the installer as other products detect

Web InstallationTechnical Guide

2010 Version

Page 2: Web Installationupdates.bksb.co.uk/FAQPatches/Guides/web_install_guide.pdfinstallation and we highly recommend using the default value supplied in the installer as other products detect

Installation of the Software by Your Technical/MIS Team 2-3 Step By Step Guide 3-6 The Database Configuration Tool 7-8

Advanced Settings 9-11

Linking from Moodle 12

Update for bksb Portal and Reporting 13

Top FAQ’s 14

Contents

1

TECHNICAL AND INSTALLATION ENQUIRIES:

E-mail: [email protected] Tel: 01623 627191 ext. 8234

Page 3: Web Installationupdates.bksb.co.uk/FAQPatches/Guides/web_install_guide.pdfinstallation and we highly recommend using the default value supplied in the installer as other products detect

bksb Web Installation - Technical Guide

2

Installation of the Software by Your Technical/MIS Team

bksb cannot prescribe how your technical team install the bksb software as institutions operate under a variety of internal procedures. However, there follows a suggested set of shortcuts on the desktop (these could be a staff intranet link or favourites link) to enable both learners and teaching staff to quickly access appropriate areas of the bksb software. Such as bksb Learner Portal (bksb_Portal) and Tutor’s Reporting (bksb_reporting).

This installation suggestion appears in both the bksb Technical Guide and the bksb Tutor Guide to promote effective liaison between the technical and teaching teams.

bksb Learner Portal (bksb_Portal) Tutor’s Reporting (bksb_reporting)*

Accessed by Learner & Tutor (bksb_Portal)

Navigation Action upon click

L1. Resources View Resources L2. Assessments Start AssessmentsL3. Results View Assessment ResultsL4. Edit Details Edit Learner DetailsL5. Logout Logout of Current session

Accessed by Tutor (bksb_reporting)*

Navigation Action upon click

T1. Home Go to Reporting HomeT2. Tracking Grids View Tracking GridsT3. Learner Results View Learner ResultsT4. Learner Admin Add Learner/GroupT5. Summaries View Group Summaries T6. Group Manager Start Group ManagerT7. PLTS View PLTS Tracking GridsT8. English & Maths View English & Maths ResourcesT9. ICT View ICT ResourcesT10. Interactives Turn Interactives on/off

* Not all navigation elements will be available as this depends upon which software systems have been purchased.

NOTE: To install Tutor’s Reporting (bksb_reporting)right click the IA/DA disk/click Explore/Open the Group Profile/Run setup.exe

T1

T2

T3

T4

T5

T6

T7

T8

T9

T10

L1 L2 L3 L4 L5

Page 4: Web Installationupdates.bksb.co.uk/FAQPatches/Guides/web_install_guide.pdfinstallation and we highly recommend using the default value supplied in the installer as other products detect

Step By Step Installation

bksb Technical Guide for your Technical/MIS team – covers installation, set-up procedures, data validation, results saving and databases.

Technical Support - bksb offer a service to identify an organisation’s technical needs, create company-specific reporting and integration to a current database.

Step By Step Guide

1. Insert the CD into the PC to install bksb.

2. When the CD menu appears, click to install the web version.

3. After a few seconds, you may receive a dialog similar to (Figure 1). If this appears, it means that you are missing a required component(s).

Figure 1

4. Click Accept and a screen similar to [Figure 2] will appear which will display the progress of the components’ installation.

3

4

Page 5: Web Installationupdates.bksb.co.uk/FAQPatches/Guides/web_install_guide.pdfinstallation and we highly recommend using the default value supplied in the installer as other products detect

Step By Step Installation

4

Figure 2

5. After these components have been installed, you may need to restart the computer. If asked to do so, then please click ‘yes’ to reboot. After the reboot, the installer will continue with your product installation.

6. You will now receive a Windows installer welcome screen [Figure 3].

7. Click Next.

Figure 3

7

Page 6: Web Installationupdates.bksb.co.uk/FAQPatches/Guides/web_install_guide.pdfinstallation and we highly recommend using the default value supplied in the installer as other products detect

Step By Step Installation

8. You will now receive a screen with the following options [Figure 4]:

a. Site: This specifies the IIS website to install bksb to. This is most commonly changed when SharePoint is installed, as it installs before “Default Web Site”. Therefore, you will need to change this dropdown to prevent any conflicts.

b. Virtual Directory: The Virtual Directory box is used to specify the name that you want your server to use for the application. For example, if your server was called ‘bksb’ and you wanted the virtual directory name to be ‘bksb_Portal’, you would navigate to http://bksb/bksb_Portal/ in order to access the bksb software. This value varies for each installation and we highly recommend using the default value supplied in the installer as other products detect this default value.

c. Application Pool: The Application Pool can be ignored in this software as it automatically creates an application pool with the name “ASP.NET 2.0”. The automated creation of the Application Pool is done, as the Microsoft .NET Framework 1.1 can’t run alongside any other version of the .NET Framework within the same application pool.

Figure 4

9. Click Next.

10 Now you will receive a Confirm Installation window. Click next [Figure 5] and wait for installation to complete.

5

a

b

c

9

Page 7: Web Installationupdates.bksb.co.uk/FAQPatches/Guides/web_install_guide.pdfinstallation and we highly recommend using the default value supplied in the installer as other products detect

Step By Step Installation

6

Figure 5

10

Page 8: Web Installationupdates.bksb.co.uk/FAQPatches/Guides/web_install_guide.pdfinstallation and we highly recommend using the default value supplied in the installer as other products detect

The Database Configuration Tool

The Database Configuration Tool

We have now automated the entire setup of the bksb database, as SQL Server is a mandatory component.

Below is a direct copy of the Technical Guide for the bksb Database Configuration Utility(using the bksb Database Configuration Utility).

Configuring the SQL Server (See Figure 6)

1. To choose the SQL server that you would like to create the bksb database on, you have 3 options: 1a. Select an automatically detected SQL Server from the “Local Detected Servers” list. 1b. Enter the remote or local server’s details manual and:

1bi. Enter the server name

1bii. Enter Instance name (for SQL express and 2005 enterprise when instances are installed) 1biii. Configure “Security Setting” (Default setting of Integrated security is typically acceptable)

1c. Click ‘New Instance’ to install new copy of SQL Server

Testing the Connection

2. Click ‘Test Connection’ if any errors occur in the testing of the connection, then they will be shown in a message box along with the details of the error.

2a. Create database Creates a new database called bksb_mini

2b. Create Tables Creates the SQL table needed for the assessments and results

2c. Create Views Creates the SQL views needed to link learner data

2d. Create Procedures Creates the SQL procedures used to select, insert and update data. A list of SQL procedures can be found on www.bksb.co.uk

2e. Insert Data Inserts all of the predefined rows of data needed for the software to run

7

Page 9: Web Installationupdates.bksb.co.uk/FAQPatches/Guides/web_install_guide.pdfinstallation and we highly recommend using the default value supplied in the installer as other products detect

The Database Configuration Tool

8

1a

1b 1bi

2

2a 2b 2c

2d 2e 2f

3

4

!

2f. Create permissions The ‘Create permissions’ button creates an SQL user called ‘bksb’ on the server with the password supplied. You must retype the password correctly before it can be used.

If you are having issues with the passwords incorrectly matching, you can click the ‘Show Password’ which will display the password in plain text.

3. Click Save to Config The ‘Save to Config’ button is used to write the SQL connection string to the selected config file you chose from the ‘Browse’ button.

When the application has successfully saved the configuration, you will receive a message box saying “Congratulations, the configuration file has now been updated. You may now close the configuration window.”

4. You may now exit the configuration tool and launch the software.

Figure 6

Browse(!) The ‘Browse’ button is used to locate the configuration file for the application.

1bii

1biii

1c

Page 10: Web Installationupdates.bksb.co.uk/FAQPatches/Guides/web_install_guide.pdfinstallation and we highly recommend using the default value supplied in the installer as other products detect

Web.config Settings

The web.config only has 1 element which will generally be changed - the ‘ConnectionString’.

ConnectionString

example and usage of ’ConnectionString’

Data Source=bksb\sqlexpress;

Data Source is the name of your server and instance name. In this example, the server name is bksb and the instance name is sqlexpress.

Initial Catalog=bksb_Mini;

Initial Catalog is the name of the database which you wish to use. In the example, this is the bksb_Mini database.

Persist Security Info=True;

Persist Security Info is used to securely send the password to the SQL server and should always be set to True.

User ID=bksb;

User ID is the user login name for connecting the software to the SQL Server. The default setting for this is bksb as the ‘Database Configuration Tool’ uses bksb as the default login name.

Password=bksb

The Password can be set to whatever you choose, as long as it matches the User ID password you set up on the server.

providerName=”System.Data.SqlClient”

Never change the providerName as it is used by the webpages to determine how to access the SQL server.

9

Advanced Settings

Page 11: Web Installationupdates.bksb.co.uk/FAQPatches/Guides/web_install_guide.pdfinstallation and we highly recommend using the default value supplied in the installer as other products detect

ClientSettings.config Settings

ClientSettings.config is accessed through IIS (Internet Information Services) Expand Server Name/Expand Sites/Right click the instance you want to edit/Click Explore/Open ClientSettings.config

<add key=”AdminPassword” value=”123”/> • The AdminPassword key is used to set the password for accessing the Group/Student Management interface.

• Acceptable value: Alpha/Numeric

<add key=”ShowResourceLinks” value=”true”/>

• The ShowResourceLinks key is used to define whether links to the resources should be shown on the results page. • Acceptable value: True or False

<add key=”Entry1-3_Location” value=”C:\Resources\#CD E1-3 2008\”/>

• The Entry1-3_Location key is used to define where the resources for Entry 1-3 are located. The location must be on a local hard drive and must be set up with read permissions for the group ‘everyone’.

• Acceptable value: Alpha/Numeric and \

<add key=”Level1-3_Location” value=”C:\Resources\#CD Level 1-3 2008\”/> • The Level1-3_Location key is used to define where the resources for Level 1-3 are located. The location must be on a local hard drive and must be set up with read permissions for the group ‘everyone’. • Acceptable value Alpha/Numeric and \

<add key=”ShowPercentage” value=”true”/>

• The ShowPercentage key is used to define whether the assessment percentage should be shown on the diagnostic assessment results page.

• Acceptable value True or False

10

Advanced Settings

Page 12: Web Installationupdates.bksb.co.uk/FAQPatches/Guides/web_install_guide.pdfinstallation and we highly recommend using the default value supplied in the installer as other products detect

Advanced Settings

<add key=”ShowGroupReferenceList” value=”true”/>

• The ShowGroupReferenceList key is used to define whether the login screen should have a list of groups for the learner to select from. After a learner selects a group and clicks to login, they will be assigned to the selected group.

• Acceptable value True or False

<add key=”AllowRegistration” value=”true”/>

• The AllowRegistration key is used to either turn on or off the function to allow learners to enter a reference which does not exist and create it themselves. Turning this on means that you do not need to pre-populate the database of users as they can enter their reference along with first name and surname and create a new learner login.

• Acceptable value True or False

<add key=”AllowIntegratedLogin” value=”true”/>

• The AllowIntegratedLogin key is used to specify whether or not to populate the login screen with the details of the current user from Active Directory. You must turn off anonymous access in IIS under the Directory Security tab of the virtual directory properties dialog. As well as turning anonymous access off you must select an authentication method e.g. Basic authentication and or Digest authentication. The name is filled in using the FullName field in Active Directory and therefore may not be fully populated if the name contains either more than 1 space or no space at all.

• Acceptable value True or False

Every web application has an errors.aspx file, which displays all errors for all applications including date/time, current username and the error message generated.

ClientSettings.config is hard to configure?

Some people may find that the Client settings file is hard to configure (especially without syntax highlighting).

We have now developed a small graphical interface to choose the settings you need to configure in this file. Available to download from our website under tech support.

11

Page 13: Web Installationupdates.bksb.co.uk/FAQPatches/Guides/web_install_guide.pdfinstallation and we highly recommend using the default value supplied in the installer as other products detect

Linking from Moodle

Linking from Moodle

It is now possible to create a link on moodle which will log a user directly into the bksb portal without the need to re-enter details. If the learner has not used the software before then their user will be created automatically.

1. Log into moodle as an administrator2. Turn Editing on3. Create a new resource (Link to file or Website)4. Give the link a name e.g. bksb Portal5. In the Parameters panel click “Show Advanced”6. Set the Variable names as below (example screenshot below) a. Reference b. FirstName c. LastName

12

 

Page 14: Web Installationupdates.bksb.co.uk/FAQPatches/Guides/web_install_guide.pdfinstallation and we highly recommend using the default value supplied in the installer as other products detect

Update for bksb Portal and Reporting

Rolling Update for bksb Portal and Reporting (UK customers only)

At bksb we are always looking to ensure our software remains user friendly. We welcome feedback from all customers and endeavour to add requested features and offer support with any issues.

This FAQ article links to a rolling update of bksb which can be applied to bring bksb up to the latest version when required.

WARNING: Applying an update to the wrong product may require a re-installation.

There are 2 updates available to download from our website,one for bksb_Portal and another for bksb_Reporting (steps 1-4 will work for both Portal & Reporting).

1. Download & Save from our website under tech support

2. Run/open the file

3. If C:\inetpub\wwwroot\bksb_Portal\ is in the portal location (a), click update (b). Otherwise, click browse (c) to select the location of the bksb_Portal folder.

4. Once the Update button has been clicked, wait for the successfully completed message and click OK.

Backup Database

Once you have selected the location of your working bksb_Portal, click “Backup Database” (d) andselect location to backup the database (This folder must have permission for SQL to write to it. Add the group “everyone” with modify access if needed.)

Click OK.

Wait for backup to complete.

If you receive an error while updating or backing up your database, copy the error and send to technical support, e-mail: [email protected].

13

ab

c

d

Page 15: Web Installationupdates.bksb.co.uk/FAQPatches/Guides/web_install_guide.pdfinstallation and we highly recommend using the default value supplied in the installer as other products detect

Top FAQ’s

Importing large groups

You want to import a large group of learners into bksb, but don’t want to enter them manually one by one.

Solution:Download the bksb CSV Import utility (also allows copy/paste from Excel).Available to download from our website under tech support.

PDF files are not found with Functional Skills Resource CD

You may find when you receive your Functional Skills Resource CD that the PDF files don’t link into the interface.

Solution:Use the ClientSettings configuration utility to set the location of the resources. This utility, when selecting the resource locations, will automatically move and create the necessary folders.Available to download from our website.

Unable to find or access folder

This is caused when the user running bksb does not have access to read and write to the specified folder.

Solution:Windows Vista & 7 Home: Please set permissions on C:\program files\bksb\ as permissions are slightly different for Vista.

This fix is for all versions of Windows (2000, XP, Vista & 7)

1. Log on as an Administrator 2. Navigate to ‘C:\Program Files\bksb\bksb Standalone v3 IA & Diag\’ 3. Right click ‘Results’ 4. Click ‘Properties’ 5. Click ‘Security’ tab 6. Click ‘Add’ 7. Manually enter the name ‘everyone’ without quotes 8. Click ‘OK’ 9. Put a check next to modify

10. Launch bksb again

For more technical support queries visit our website (www.bksb.co.uk)under Tech Support.

14

Page 16: Web Installationupdates.bksb.co.uk/FAQPatches/Guides/web_install_guide.pdfinstallation and we highly recommend using the default value supplied in the installer as other products detect

© bksb 2010