SAM Server Utility User s Guide

Transcription

1 SAM Server Utility User s Guide Updated July 2014 Copyright 2010, 2012, 2014 by Scholastic Inc. All rights reserved. Published by Scholastic Inc. PDF0157 (PDF) SCHOLASTIC, READ 180, SYSTEM 44, SCHOLASTIC EXPERT 21, SCHOLASTIC ACHIEVEMENT MANAGER, and associated logos are trademarks and/or registered trademarks of Scholastic Inc. LEXILE and LEXILE FRAMEWORK are registered trademarks of MetaMetrics, Inc. Other company names, brand names, and product names are the property and/or trademarks of their respective owners.

2 Table of Contents Introduction... 3 Launching the SAM Server Utility... 3 The Home Screen... 4 The Service Manager... 5 The Database Manager... 6 Managing the Backup Location... 6 Performing a One-Time Backup... 8 Restoring the Database... 9 Running SQL Files The Admin Manager SAM Diagnostics Memory Configuration Password Configuration Database Utilities Database Cleanup Utility Server Cleanup Utility Scholastic Agent Manager SAM Activity Monitor Capture Performance Log Technical Support By Phone On the Web SAM Server Utility User s Guide Updated Table of Contents 2

3 Introduction The SAM Server Utility contains tools that allow administrators to customize and maintain a SAM installation. Use the SAM Server Utility to: Back up and restore databases Stop and start Scholastic services Collect files to send to Technical Support to resolve problems Change your server s memory configuration Change your district s minimum password requirements Delete records and files from the server at the end of the school year Launching the SAM Server Utility There are several ways to launch the SAM Server Utility; however, the utility must be run directly on the server. It cannot be run remotely from a workstation. To launch the SAM Server Utility in Windows: 1. Open My Computer à <install directory> à ScholasticEE à Sam_Server à util. 2. Double-click the Sam Server Utility.exe icon. To launch the SAM Server Utility using a Macintosh: 1. Open a Finder window. 2. Open <install directory> à ScholasticEE à Sam_Server à util. 3. Double-click the Sam Server Utility icon. To launch the SAM Server Utility using Novell/Linux: 1. Open a Finder window. 2. Open <install directory> à ScholasticEE à Sam_Server à util. 3. Double-click the Sam Server Utility icon. SAM Server Utility User s Guide Updated Introduction 3

4 The Home Screen The Home screen provides four options: Scholastic Service Manager: Use this to check if services are running and to stop and start Scholastic services. Scholastic Database Manager: Use this to create a database backup file, to restore a database backup file, or to run an SQL script. Scholastic Admin Manager: Use this to change your memory configurations or to collect support files to send to Scholastic Technical Support. NOTE: You should only access this tab if instructed to do so by Scholastic Technical Support. Scholastic Agent Manager: Use this to set your proxy host and port to connect to SAM Connect. View Server Activity: Opens the SAM Activity Monitor, which allows the SAM administrator to view server activity if the district is experiencing performance issues. SAM Server Utility User s Guide Updated The Home Screen 4

5 The Service Manager The Service Manager displays the status of the three Scholastic services on the SAM server and allows those services to be stopped and restarted. The SAM Server will not work properly unless each of these services show as started. The SAM Server uses three services: The ScholasticJBoss service is a software engine that controls many of the background operations of the SAM server. The ScholasticMySQL service is a database management system that controls the operations of the SAM database. The ScholasticAgent service manages your server s ability to connect to SAM Connect. When stopping these services, stop the ScholasticJBoss service before the ScholasticMySQL service. When restarting these services, always restart the ScholasticMySQL service before the ScholasticJBoss service. The ScholasticAgent service may be stopped and restarted at any point in the procedure. SAM Server Utility User s Guide Updated The Service Manager 5

6 The Database Manager The Database Manager allows users to make copies of the backup file generated in SAM, direct where the duplicate file should be saved, perform manual one-time database backups, restore the database, or run SQL scripts. Managing the Backup Location Backups of the SAM database are regularly scheduled through SAM. The Database Manager allows administrators to select an alternate location for the backup file and directs SAM to create a second backup file in that location. To manage the backup location: 1. Click Select Backup Directory under the Backup Location heading. 2. Select the directory where the backup file will be saved and click OK. SAM Server Utility User s Guide Updated The Database Manager 6

7 3. The window will close and the directory path name will appear in the text field in the upper left corner of the screen. 4. Click Save Backup Directory. The utility will warn that the JBoss service will stop during the procedure. Click OK to start the procedure or Cancel to cancel it. When the procedure is finished, a message will appear saying the secondary backup location has been successfully created. Click OK to finish the procedure. SAM Server Utility User s Guide Updated The Database Manager 7

8 Performing a One-Time Backup To manually back up the database from the Database Manager: 1. Click the Select Backup Directory button under the One-Time Backup heading. 2. Select the directory where the backup file will be saved and click OK (or Choose on a Macintosh). The window will close and the directory pathname will appear in the text field in the upper left corner of the screen. 3. Click the Perform Backup button. The system warns to keep the Backup Database screen open while it creates the backup file. Click OK to create a SQL file in the selected directory; click Cancel to return to the Backup Database screen without creating a backup. SAM Server Utility User s Guide Updated The Database Manager 8

9 Restoring the Database Use the Restore Database function to restore a previously saved database backup file into your current SAM installation. WARNING: The Restore Database function will erase the current database in your SAM installation. Make sure to save a backup of the current database before you proceed with the Restore Database function. To restore a database: 1. Click the Select Source File button. 2. Select the backup (SQL) file to restore and click OK (or Open on a Macintosh). The filename appears in the field in the upper left corner of the screen. SAM Server Utility User s Guide Updated The Database Manager 9

10 3. Click Perform Restore. The system warns that the restore will erase the current database and prompt a backup. Click OK to proceed with the restore process without creating a database backup; click Cancel to return to the Restore Database screen and manually create a database backup file. 4. A second warning appears stating that the ScholasticJBoss service will be stopped during the restore. The restore function will automatically stop and restart the ScholasticJBoss service; users do not have to stop and restart it themselves. 5. Click OK to restore the database. A warning message appears reminding the administrator that the database restore will erase the existing database. Click OK to continue the restore, or Cancel to return to the Restore Database screen without restoring the database. 6. When the database is restored, a message appears reporting that the restore has been completed successfully. Click OK. SAM Server Utility User s Guide Updated The Database Manager 10

11 Running SQL Files When necessary, Scholastic Technical Support sends a SQL file. These files are usually to clean or correct a problem with the database. To execute the file, use the Run SQL File function of the SAM Server Utility. Tech Tip Only use this function to run an SQL script provided by Scholastic Customer Service. Running any other type of SQL script might damage the existing database. Always back up the existing database and store the resulting ZIP file in a safe place before running an SQL script with this screen. To run the SQL script: 1. Click the Select SQL File button to open a window from which to select the SQL file from Scholastic Technical Support. 2. Click the Run SQL File button. SAM Server Utility User s Guide Updated The Database Manager 11

12 The Admin Manager The Admin Manager consists of four screens that collect files and logs for troubleshooting, change memory configurations, change the district s password requirements, and clean up or optimize the database. SAM Diagnostics The SAM Diagnostics screen collects files to send to Scholastic Technical Support to resolve problems with the SAM installation. The default setting on this screen is all four checkboxes selected. Unless instructed by your Scholastic Field Technician, do not change the default options. If the settings need to change, click the boxes to select or deselect the types of files in the ZIP file. Click Reset to restore the default settings. Click Save to create a ZIP file that will include files for every selected category and any comments entered in the text box. Scholastic Technical Support will use this ZIP file to troubleshoot your problem. SAM Server Utility User s Guide Updated The Admin Manager 12

13 Memory Configuration The Memory Configuration Screen allows changes to the SAM installation s memory configurations. Tech Tip DO NOT CHANGE THESE SETTINGS UNLESS SPECIFICALLY TOLD TO DO SO BY YOUR SCHOLASTIC FIELD TECHNICIAN. The memory configurations are: JBoss Heap Size: This allocates the size of objects that are kept in memory for the Java application. MySQL Buffer Pool Size: This allocates the cache size of the buffer for the MySQL service. Each memory setting can affect different aspects of the SAM server s functionality. The system makes use of the JBoss Heap Size, for instance, during many data movement functions. While running reports, though, the system makes use of the MySQL Buffer Pool Size. To change the memory configuration settings: 1. Move the slider for either the JBoss Heap Size or the MySQL Buffer Pool Size. The system will display the megabytes allocated for each setting. 2. Click Update Memory. The system will automatically stop and restart services and issue an alert when the process is finished. Changing the memory settings without clicking Update Memory will result in the new settings NOT being saved. The Reset button will return the memory settings to their previously saved settings, but NOT to the default settings. Once these settings are changed, the default settings can be returned to only manually. SAM Server Utility User s Guide Updated The Admin Manager 13

14 Password Configuration Use the Password Configuration utility to set or modify a district s minimum password requirements. SAM version contains two types of student password requirements: Grades Pre-K to 2: Passwords must contain between 3 and 16 characters and cannot be only the user s first or last name or a combination of the two. Grades 3 to 12: Passwords must contain between 6 and 16 characters and cannot be only the user s first or last name or a combination of the two. Passwords must also contain at least one numeral. SAM version teacher and administrator passwords must contain between 8 and 16 characters and cannot be only the user s first or last name or a combination of the two. Passwords must also contain at least one uppercase letter, one lowercase letter, and one numeral. Changes made in the Password Configuration utility will affect only new or modified passwords. Existing passwords are not affected. To access the Password Configuration utility, click the Password Configuration tab, then click SAM Admin to open the utility. Log into the utility with a SAM District Administrator or District Technical Administrator username and password. SAM Server Utility User s Guide Updated The Admin Manager 14

15 To change the password settings: Minimum Password: Use the pull-down menu to change the minimum number of characters required in a password. The default setting is six. Enforce Mix Case: Check the box to require that each password include at least one uppercase and one lowercase letter. The default setting is unchecked. Enforce Numeric: Check the box to require that each password contain at least one numeral. The default setting is checked. Enforce Special Character: Check the box to require that each password contain at least one of the following special characters: -, ^,. The default setting is unchecked. Click Save to save changes, or click Restore Default to restore default settings. NOTE: If password requirements were previously modified, the values will need to be reset using this utility after upgrading to version SAM Server Utility User s Guide Updated The Admin Manager 15

16 Database Utilities Using the Database Utilities is an important part of keeping the SAM installation running smoothly. SAM databases commonly accumulate data that may no longer be necessary over the course of a school year deleted student records, data related to deleted records, and files created during the school year that are no longer needed. Database Cleanup Utility When students are deleted from Inactive Accounts, those students records are not automatically deleted completely from the database. This allows their records to be restored in case of an emergency or if they were deleted in error. However, as a district s SAM database accumulates deactivated and deleted student records over time, these records may impair the functioning of the database. Because of this, Scholastic recommends that districts periodically clean up their database by removing the records of deactivated and deleted students. The Database Cleanup Utility removes these records safely without affecting the rest of the database. To run the Database Cleanup Utility: 1. From the SAM Server Utility Home Screen, click the Admin Manager button. 2. From the Admin Manager window, click the Database Utilities tab. 3. Click Run Database Cleanup Utility. The utility will completely and safely remove every record from the Inactive Accounts in SAM for students who have been deleted. NOTE: Depending on the number of deleted records in the database, this can take several hours to run. Once this process completes, the user receives a message that these records were successfully deleted. SAM Server Utility User s Guide Updated The Admin Manager 16

17 Server Cleanup Utility Over the course of a school year, Scholastic technology programs write several files to the server that may have once been essential but are no longer necessary. You should run the Server Cleanup Utility at the end of the school year and again at the beginning of a new year. To run the Server Cleanup Utility: 1. From the SAM Server Utility Home Screen, click the Admin Manager button. 2. From the Admin Manager window, click the Database Utilities tab. 3. Under the Server Cleanup Utility banner, select which type of old files to remove. Unless otherwise instructed by Scholastic, select all four types of files: Student Recordings Saved Reports Database Backup Default Location Database Backup Alternate Location 4. Click Run Server Cleanup Utility. This completely removes all unessential files that have accumulated over the school year. SAM Server Utility User s Guide Updated The Admin Manager 17

18 Scholastic Agent Manager If the district is using a proxy server to connect to SAM Connect, use the Agent Manager to configure the proxy server IP address and port. The Agent Manager screen contains six settings: Proxy Host Detected: The IP address (or server name) of the proxy server that the Agent Manager has detected. Proxy Port Detected: The port number of the proxy server, if applicable. Proxy Host for SAM Connect: The IP address (or server name) entered on the proxy configuration screen during SAM Server installation. Proxy Port for SAM Connect: The port number that was entered on the proxy configuration screen during the SAM Server installation process. Proxy User for SAM Connect: If the proxy server requires logging in, the proxy user s username that allows access to the proxy server. Proxy Password for SAM Connect: The password connected to the proxy user s username that permits logging in to the proxy server. If SAM Connect is unable to connect to the server, and if the proxy host and port used do not match the proxy host and port detected, change the detected host and port to match the used host and port. Click Save to save your changes, or Reset to restore the original detected settings. The Agent Manager detects the proxy server based on the profile of the logged-in user. Since two users might have different proxy servers, only the technical director should access the screen settings. SAM Server Utility User s Guide Updated Scholastic Agent Manager 18

19 SAM Activity Monitor The SAM Activity Monitor displays scheduled events and key server performance indicators and provides SAM administrators with a single place to view server activity. This helps to identify causes and solutions for performance issues. To open the SAM Activity Monitor, click View Server Activity from the Home Screen. The Activity Monitor opens in a separate browser window. The Activity Monitor has three tabs: Performance Indicators: This tab shows the number of database connections currently being used and the maximum number available, Java virtual machine data, CPU usage (percentage used), and disk usage data (maximum MB available, MB used, and MB free). SAM Server Utility User s Guide Updated SAM Activity Monitor 19 TM & Scholastic Inc. All rights reserved. PDF0157 (PDF)

20 Server Requests: This tab shows the number of server hits by Scholastic program, both in total and since the last refresh. Scheduled Jobs: This tab shows all scheduled server tasks, along with job status and scheduled time. Click the View Current Activity link to see, in a separate browser window, which tasks are currently running on the server. Click Refresh to update the displayed data on any tab. Click Save to save the page as a text file. Saving the text file allows SAM administrators to send the data to Scholastic to help troubleshoot performance issues. SAM Server Utility User s Guide Updated SAM Activity Monitor 20 TM & Scholastic Inc. All rights reserved. PDF0157 (PDF)

21 Capture Performance Log While the Activity Monitor allows administrators to view SAM Server activity in real time, by clicking the Capture Performance Log link administrators can review server activity for a specific period of time. This can be very helpful when needing to capture specific server activity information when troubleshooting with Scholastic. To capture server performance information for a period of time, click Capture Performance Log from the Activity Monitor screen to open the Performance Log Login Screen. Use the administrator s SAM username and password to log in. SAM Server Utility User s Guide Updated SAM Activity Monitor 21 TM & Scholastic Inc. All rights reserved. PDF0157 (PDF)

22 Logging in brings the user to the Scheduler Screen. To schedule a log, click the Start Date field and use the pull-down calendar to schedule the start date. Use the same method to schedule the end date. Click Done when the date is selected. To put the scheduled logging in the queue, click Schedule (the end date must be greater than the current date to allow the server information to record correctly). SAM Server Utility User s Guide Updated SAM Activity Monitor 22 TM & Scholastic Inc. All rights reserved. PDF0157 (PDF)

23 When the logging is scheduled, it will appear in the Scheduled Log Jobs area. To cancel the scheduled logging, click Delete Job. To view a log, click View Log Files from the Scheduler Screen. The list of available log files opens (click Refresh if the desired file is not on the list). Click the file name link to open or save the log file. Scholastic recommends saving the log file so, if necessary, it can be sent to Scholastic Technical Support for review. SAM Server Utility User s Guide Updated SAM Activity Monitor 23 TM & Scholastic Inc. All rights reserved. PDF0157 (PDF)

24 Technical Support By Phone Call Scholastic Technical Support at with any questions, concerns, or problems with the deployment, the SAM installation, or any Scholastic program. On the Web Support is also available at the Scholastic Education Product Support website ( The site contains program documentation, manuals, and guides, as well as Frequently Asked Questions and live chat support for customers with active Product Maintenance and Support Plans. SAM Server Utility User s Guide Updated Technical Support 24 TM & Scholastic Inc. All rights reserved. PDF0157 (PDF)