SMS 2.0 ExComm Ed-Fi Server Launch Kit. Revision

Transcription

1 SMS 2.0 ExComm Ed-Fi Server Launch Kit Revision

2 Contents EXCOMM SERVER AND WHAT IT MEANS TO YOU... 3 EXCOMM SERVER PRE-INSTALL CHECKLIST... 3 CHOOSING A SKYWARD SERVER FOR EXCOMM... 4 EXCOMM SERVER INSTALL SUMMARY... 4 DOWNLOAD THE EXCOMM SERVER INSTALLER FILE FROM THE SKYWARD FTP SITE... 5 SKYWARD EXCOMM SERVER INSTALL... 6 CONFIGURE THE MONOLITH CONTROL CENTER...16 ENABLE REPLICATION TRIGGERS FOR EVENT PROCESSING...18 TEST THE ED-FI PLUGIN CONNECTION...20 CHANGING YOUR ED-FI PLUGIN KEY AND SECRET Page 2 of 21

3 ExComm Server and what it means to you ExComm is short for External Communications and can best be defined as server based services that utilizes plugins to communicate between Skyward SMS 2.0 and various 3 rd party systems. ExComm utilizes a plug-in architecture to communicate with other 3 rd party systems like Ed-Fi state reporting. If your school district is hosted by ISCORP or has a Managed Services Contract you do not need to continue any further. The hosting provider will perform the necessary ExComm Server setup and Ed-Fi plugin configuration. Managed Services customers will be installed by an IT Services technician. ExComm Server Pre-Install Checklist Student/School Management Minimum Version: June Release + Addendum 8 SMS 2.0 Version: (or later) System Requirements: Windows 2008 SP1 / 2008 R2 SP1 / 2012 / 2012 R2 / 2016 Server.NET 4.0 or Newer 1GB of Free RAM 14GB of Free Disk Space on the Skyward Drive If there is only one drive in your server then you need 16GB of free disk space. VMWare/Hyper-V Citrix XEN Virtual Servers are supported ExComm Server can be installed on any Skyward Server with OpenEdge 10.2B already installed (Typically your Database, Web, or Report Server) ExComm Server Install can take up to an hour to install. ExComm Server can be installed while users are in Skyward. The Replication Trigger Sync setup step requires users to be out of Skyward. ExComm Server Components to be installed: SQL Express 2014 Advanced w/management Studio ExComm SQL Backup Scheduled Task ExComm Windows Service Ed-Fi Plugin Page 3 of 21

4 Choosing a Skyward Server for ExComm Do you have a Single Skyward Server? If you have one Skyward Student / School Management Server, then this is where ExComm should be installed. Do you have Multiple Skyward Servers? If you have multiple Skyward Servers, then the recommendation is to install the ExComm Server on a Skyward Student / School Management Report Queue Server. Verify the server meets the minimum requirements before installing ExComm. ExComm Server Install typically takes about 30 minutes but can take up to an hour to install on older servers. ExComm Server can be installed while users are in Skyward. The last step, called the Replication Trigger Sync setup step requires users to be out of Skyward for approximately 10 minutes. ExComm Server Install Summary 1. Ensure your software is at the June Release + Addendum 8 or later 2. Download the ExComm Server Installer 3. Run the ExComm Installer (~45 minutes) 4. Configure Monolith Control Center (~5 minutes) 5. Run the Replication Trigger Sync (~10 minutes) * * Downtime required Page 4 of 21

5 Download the ExComm Server Installer file from the Secure FTP site. 1. Connect to our Secure FTP Instructions using the instructions found here: Secure FTP Instructions 2. Navigate to the Secure FTP folder of Hardware Public OE102B-Customer-DVD Windows 3. Download the file 10.2B Role ExComm Server Install.exe 4. Save the downloaded file to?:\skyward\install folder on the Skyward Windows server 5. Continue to the ExComm Server Installation instructions Page 5 of 21

6 Skyward ExComm Server Install Notes: The 10.2B Role - ExComm Server Install.exe needs to be installed on one Windows Skyward Student or School Management server that runs one of the following roles: Database, Report Queue or All in One skyward server. 1. To start the ExComm Server install double click 10.2B Role - ExComm Server Install.exe file. 2. The Welcome screen to ExComm Server Setup will appear Choose Next Page 6 of 21

7 3. The Installation Folder window will display The Install will automatically detect the current OpenEdge Installation path. If the path is not correct change to the Drive and folder path where Skyward was installed Choose Next. 4. The Skyward Suites Selection window will display Select your either the Student Management or School Management Suite (Student and Business Combined Database) Choose Next Page 7 of 21

8 5. The Programs Location window will display Choose your Student Management or School Management program folder Choose Next. 6. The Database Location window will display Select Yes if this server is also your Student Management or School Management Database Server and proceed to step 6a. Select No if this server is not your Database Server and proceed to step 6b. Choose Next Page 8 of 21

9 6a. Yes: If you selected Yes Select your Student Management or School Management Database from the selection list Choose Next and proceed to step 7. 6b. No: If you selected No Enter the IP Address and Database Port of your Student Management or School Management Database Choose Next. Note: The standard Student / School Database Port is Page 9 of 21

10 7. The Install SQL Express window will display Select Full Install (default) or if ExComm is already installed Select Add Ed-Fi Plugin Choose Next. Note: if you are adding an Ed-Fi plugin please skip to Step If you choose to Install SQL Express then Schedule Backup window displays Choose Yes to create a scheduled task to back up the SQL Express database to your Skyward backup folder Choose Next. Note: The SQL Express Database stores the ExComm/Ed-Fi plugin configuration and should be backed up on a regular basis Page 10 of 21

11 9. Optional: If you selected Yes to the SQL Backups the Backup Information window displays enter the Server, From Address, To Addresses, User, and User Password Choose Next. 10. The Select ExComm Plugins window will now display Select the desired plugin Choose Next Page 11 of 21

12 11. The Enter District Plugin Information window will now display Enter the Plugin information Choose Next. Note: WI and TN Ed-Fi customers the district Key and Secret can be found by logging into the Skyward Support Center and then browsing to Contact Management. MI Ed-Fi customers should obtain their info from their cockpit application. If you are still unsure what to enter, please contact Skyward IT Services. 12. The Password Complexity window will now display. If the server has complex passwords are enabled you will see an on-screen prompt explaining that the district serial number entered in the District Service Password window must meet the complexity requirements Choose OK Page 12 of 21

13 13. The Account Warning window may display if we detected that the Skyward!5233 Service account already exists on this server Choose OK. 14. The Enter District Service Password window will now display Enter the district s service password that will be used or was used for the Skyward!5233 service account Choose Next Note: Skyward typically uses your Skyward serial number as the service account password. The district serial number can be found by logging into the Skyward Support Center and then browsing to Contact Management. If you are still unsure what to enter, please contact Skyward IT Services/ Page 13 of 21

14 15. The Ready to Install windows displays Choose Next to start the installation. 16. The Installing ExComm Server window displays this can take up to an hour depending on the speed of your Skyward Server. The information that scrolls across the screen can be viewed in the installer log file Page 14 of 21

15 17. The Installation Complete window displays Choose the button to View ExComm Launch Kit (this file), View Installer Log, or Choose Finish to exit the installer Page 15 of 21

16 Configure the Monolith Control Center Note: If your district was already running ExComm for SIF you should skip all the Monolith Control Center steps and proceed to Enable Replication Triggers for Event Processing. 1. Open the Monolith 2 Student or School shortcut on the server desktop Control Center. Note: Customers that are already running ExComm for SIF can skip to Enable Replication Triggers for Event Processing. 2. Highlight the DAS you installed ExComm on Choose the Configure {your-server} Services button Choose Add Enter the ExComm Service Display Name Choose Stop for all Updates -> Choose Save Note: The service name is SkyStuExComm for Student Management customers and SkyExComm for School Management (Student and Business Combined Database) customers Page 16 of 21

17 3. Highlight the DAS you installed ExComm on Choose the Configure {your-server} AppServers button Choose Add Enter the AppServer Name and NameServer Port (5162) Choose Save Note: The AppServer Name is asstuexcomm for Student Management customers and asskyexcomm for School Management (Student and Business Combined Database) customers. 4. Highlight the DAS you installed ExComm on Choose the Configure {your-server} Databases button Highlight the Live Database and Choose Edit Select the Available AppServer and Click the Right Arrow to move it to the Selected AppServer list Choose Save. Your Monolith Configuration is complete! Page 17 of 21

18 Enable Replication Triggers for Event Processing 1. From the ExComm Server desktop open the Student/School ExComm Configuration Choose the Advanced Options pull down menu Choose Enable ExComm Events. 2. Open Monolith Choose Update Skyward Software Choose the Replication Sync button Warning! This steps shuts down all skyward databases included in your Monolith setup for approximately 10 minutes to run the Replication Sync process. Please notify your users of the downtime before you run the Replication Sync process Choose Yes to Run the Replication Sync (example on next page) Page 18 of 21

19 3. The Replication Trigger Complete will display Choose OK Choose Close Page 19 of 21

20 Test the Ed-Fi Plugin Connection 1. From the ExComm Server desktop Open the Student/School ExComm Configuration Choose the Plugins button Choose Configure Choose the Utilities pull down menu Choose Test EDFI Connection Note: The Ed-Fi Plugin communicates to the Ed-FI URL and OAuth URL using the https protocol on TCP port 443. Ensure your district allows access to these URLs on your District Firewall and/or Content Filter. Congratulations, your ExComm Ed-Fi Server Install is Complete! Page 20 of 21

21 Changing your Ed-Fi Plugin Key and Secret 1. If the need arises to change your Ed-Fi Plugin Key and Secret you can do so from the ExComm Server desktop Open the Student/School ExComm Configuration Choose the Plugins button Choose Configure Enter your districts Ed-Fi Key and Secret into the Application Key and Secret Code fields Choose Save Page 21 of 21