Technicians Guide. Version November Innovative Solutions for Education Management

Transcription

1 Technicians Guide Version November 2015 Innovative Solutions for Education Management

2 Contents Introduction... 3 Performance factors... 3 Demand... 3 Network resources... 4 Hardware recommendations... 5 Server... 5 Client... 7 Server database... 7 Database creation and installation... 7 Client configuration text file... 9 Configuring user permissions on the SQL Server... 9 Removing the database... 9 Client software... 9 Standard installation... 9 Remote deployment and installation Command-line MSI command-line examples Group Policy deployment example Administrator login Page 2 of 12

3 Introduction The 4cast curriculum planning solution is a traditional client server application, consisting of a.net desktop client connecting to a SQL Server database. Most commonly it is used in a multi-user environment with client access across an internal network. It can also be used as a standalone installation with the database and client installed on the same computer, for example with SQL Express. Performance factors To maintain acceptable performance levels, the required network resources are a function of the demand and invariably a balance needs to be found. High demand requires more network resource Fewer network resources support lower levels of demand Demand Like all relational databases, 4cast can place heavy demands on the existing underlying hardware and infrastructure. The level of demand and its impact can vary widely and depends on many factors, some of which are technical or limited by the available resources but mostly they are operational decisions. Demand Higher performance Lower performance Number of concurrent users Volume of additional data collected Extra processing Frequency of use Curriculum planning is going to be managed by a small number of users. Basic costs and additional income information will be collected and there are a small number of user defined fields set up. A small number of simple formula fields are set up. Planning is undertaken over a longer time period. Every member of the curriculum team will be contributing to the plan. Detailed costs, additional income and staffing information will be collected and there are a large number of user defined fields set up. A larger number of more complex formula fields are set up. All planning is undertaken in an intensive period by all staff. Page 3 of 12

4 Network resources Though we are always seeking to improve software efficiency and it is designed to minimise network traffic, curriculum planning by its very nature can rely on working with large datasets. Alongside the demand, many other factors may contribute to the available network resource. Resource Higher performance Lower performance Server load A dedicated server with a separate instance only used by this application. A shared server with a single shared instance used by other database applications. Connection Wired Wireless Generally faster, more resilient and with greater bandwidth capacity and lower latency. Flexible but access point signal strength, capacity and reliability can vary widely meaning lower bandwidth and higher latency. Premises A single site LAN. WAN operations spread across multiple sites at different locations. Capacity Modern infrastructure operating well within capacity. Dated infrastructure operating at or near capacity. Personnel On premises only. Remote homeworking using a low speed broadband VPN. Network performance can have the most significant impact on some aspects of software operation, particularly when opening or refreshing large datasets. It is essential to take bandwidth and latency sensitivity into account when assessing resources. Application performance can be severely impacted by low bandwidth and high latency. Page 4 of 12

5 Time (s) This chart illustrates how performance can be suddenly and significantly impacted by a reduction in bandwidth. Typically the threshold is at around 30Mbps Bandwidth (Mbps) The impact of other undesirable network features such as drop (packet loss), lag and throttling will have an impact, though it may not be noticeable except in extreme cases, for example hardware failure or poor configuration. To increase performance and provide more effective control of your network you may want to consider Quality of Service (QoS) in order to prioritise network traffic flow, allocate network bandwidth and resources. For example, you could reserve bandwidth or prioritise traffic for the default SQL Server TCP port Hardware recommendations Absolute minimum hardware requirements can often be specified but from a practical viewpoint offer little benefit. The specifications given below are realistic and can be used as a guide, though much will depend on individual circumstances, particularly where resources are not dedicated but shared. Server Item Recommended Minimum Operating system SQL Server Windows Server 2008 or above 2008-R2 or above on a separate instance 2008 Hard disk Note that SQL Express 2008-R2 can be used but performance may be severely impacted with multiple concurrent connections. We would only recommend using this on a standalone PC running both server and client. 4 GB free space for database Page 5 of 12

6 Item Recommended Minimum Memory 16 GB or more Note that 4GB or more is recommended on a standalone PC running both server and client. Processor x86 or x GHz or faster Quad-Core Other.NET Framework 4 Page 6 of 12

7 Client Item Recommended Minimum Operating system Memory Display 64-bit Windows 7 or above 4 GB or more 1280*800 or 1366*768 resolution or higher Windows XP SP3 Other Though the software will operate, functionality will be impaired at lower resolutions. Microsoft Excel (or equivalent) Adobe Acrobat Reader (or equivalent) Note that these are optional but will facilitate the viewing of export data on the client..net Framework 4 Client Profile Note this is downloaded automatically as part of the client install if required or can be downloaded and installed separately beforehand. Server database The server database installer is provided as a standard Windows executable (.exe). Database creation and installation The installer can be run from any workstation with network access to the SQL server and does not have to be run on the SQL server itself. Dependent on your permissions to the SQL server you may need to run as administrator to create the database. There are 2 options when running the SQL server installation, create a new or update an existing 4cast database. Prior to any upgrade we strongly recommend a SQL database backup is taken. Enter the credentials for the server as a username and password combination or use trusted Windows authentication. Enter the server name, and instance name if necessary, in the format SERVERNAME\INSTANCENAME or IPADDRESS\INSTANCENAME. Click refresh to retrieve a list of SQL servers on your network. Select whether to create a new database or update an existing one. Click the Connect button to connect to the SQL server. Page 7 of 12

8 If you are creating a new database accept the default or select an alternative folder. If you are updating an existing database, select the database name from the drop-down list. Version information is shown at the bottom of the screen. Click the Go button to create or update the database. An installation log file is created in the logs subfolder below the installer file location. Page 8 of 12

9 Client configuration text file An encrypted connection configuration text file connection.txt is created within the same folder as the server installer. This can be used alongside the client MSI (Microsoft Installer Package) for remote installation and deployment. Prior to client installation place the configuration file in the same directory as the client MSI so that once installed the client application automatically uses the connection configuration. Alternatively, the configuration file can be deployed using the Files preference extension in Group Policy. For further information please see the section on remote installation of the client. Configuring user permissions on the SQL Server Each user needs to be mapped to the login for the database and given db_owner database role membership. During operation the client software controls user permissions within the database. Removing the database All planning data will be deleted. It cannot be recovered without a backup. Ensure all users are logged out Connect to the SQL Server instance using SQL Server Management Studio Delete the database. In the confirmation dialog ensure the option to close existing connections at the bottom of this screen is selected. Client software The installation files are packaged as a compressed (zip) archive containing two digitally signed files. Standard installation To start the installation wizard, extract all files from the zip archive to the same location and run setup.exe. If you are using Windows Vista or above you will probably see a User Account Control warning similar to that shown below: Page 9 of 12

10 The files are digitally signed by us (the verified publisher) so you can click Yes. Once setup begins simply follow each of the wizard stages through, for example: Once installation is complete, an icon will be placed on your Windows desktop and Start menu which you can use to login. Remote deployment and installation Undertake remote installation by using the MSI for deployment via Microsoft AD (Active Directory) Group Policy or SCCM (System Center Configuration Manager) or other commercially available tools. Command-line The MSI can be run alone and silently with connection settings for SQL Server set automatically to avoid individual users having to specify the connection manually by using the connection.txt connection configuration text file. An encrypted copy of the configuration file is generated automatically during the server installation. Before installing the client, place the configuration file in the same directory as the MSI so that once installed the client application automatically uses the connection configuration. During the client installation process the configuration file is installed into the application directory for access by all users. MSI command-line examples Install to C:\INSTALLPATH in quiet mode with no user interaction. Note that in this MSI the option APPDIR replaces the standard TARGETDIR: msiexec /i setup.msi /q APPDIR="C:\INSTALLPATH" msiexec /package setup.msi /quiet APPDIR="C:\INSTALLPATH" Page 10 of 12

11 Uninstall in quiet mode with no user interaction: msiexec /x setup.msi /q msiexec /uninstall setup.msi /quiet For further information on MSI command-line options type msiexec at a command prompt or see: Group Policy deployment example Outlined below is an example for how you might deploy the client using Group Policy on Microsoft Windows Server. 1. Create a distribution point The first step in deploying a MSI through GPO is to create a distribution point on the publishing server. This can be done by following these steps: Log on to the server as an Administrator user. Create a shared network folder (this folder will contain the MSI package). Set permissions on this folder in order to allow access to the distribution package. Copy the MSI in the shared folder. 2. Create a Group Policy object A MSI package is deployed (distributed) through GPO as a Group Policy Object. In order to create an object for your package you can follow these steps: Start the Active Directory Users and Computers snap-in. To do this, click Start, point to Administrative Tools, and then click Active Directory Users and Computers. In the console tree, right-click your domain, and then click Properties. Click the Group Policy tab, and then click New. Type a name for this new policy and then press Enter. Click Properties, and then click the Security tab. Clear the Apply Group Policy check box for the security groups that you don't want this policy to apply to. Select the Apply Group Policy check box for the groups that you want this policy to apply to. When you are finished, click OK. 3. Assign an MSI package A package can be assigned per-user or per-machine. Also, if the package is assigned, it will automatically be installed silently. We recommend an assigned deployment type and installing the application at logon. In order to assign a package you can follow these steps: Click on the Start button, go to Programs, select Administrative Tools and then select Active Directory Users and Computers Right-click your domain name in the console tree and select the Properties context menu Go to the Group Policy tab, select the object you want and click Edit Expand Software Settings under Computer (or User) Configuration under Policies Right-click Software Installation, select the New context menu and then click on Package In the Open dialog type the full UNC path of the shared package you want to assign Click on the Open button Page 11 of 12

12 Click on Assigned and then click OK (the package will be added to the right pane of the Group Policy window) Close the Group Policy snap-in, click OK and exit the Active Directory Users and Computers snap-in When the client computers start (or the user logs on), the assigned package will be installed automatically 4. Deploying the configuration file The encrypted configuration file can also be deployed with the MSI using the Files preference extension in Group Policy. In order to deploy the configuration file you can follow these steps: Click on the Start button, go to Programs, select Administrative Tools and then select Active Directory Users and Computers Right-click your domain name in the console tree and select the Properties context menu Go to the Group Policy tab, select the object you want and click Edit Expand Files under Computer (or User) Configuration under Preferences Right-click Files, select the New context menu and then click on File Select Update from the drop-down list as the action Select the connection configuration text file as the Source Enter the path, including the file name, as the Destination INSTALLPATH\connection.txt Click OK (the file will be added to the right pane of the Group Policy window) Close the Group Policy snap-in, click OK and exit the Active Directory Users and Computers snap-in When the client computers start (or the user logs on), the file will be copied automatically Administrator login Once the software is installed we recommend you try logging in to check the connection. The system is installed with the default password Drake for the Administrator user. We suggest that this is changed. Passwords are case sensitive. Page 12 of 12