This article shares steps for installing the web service on an externally accessible web server. This is required when schools or districts decide to integrate their user database using Directory Services. This web service acts an intermediary between the Directory Services and School Loop.
Please also review School Loop recommendations when using external web services.
Follow these steps:
- Make sure Java JRE 5 or better is installed on the web server, and the path to the Java bin folder is in your system
- Download and unzip the web service distribution. This consists of a 'dist' folder with all of the necessary files to configure and run the web service. (School Loop provides the download link for this during the integration phase).
- Create a Keystore (a self-generated certificate will suffice). Open a command prompt and type:
keytool -genkey -validity 999 -keystore security/keystore
Note: The path at the end of that command is used to place the Keystore file in the security folder which is inside the dist folder. It may be easiest to specify the full path to this location.
- Optionally, but recommended, create a Truststore if using SSL to connect web service to the LDAP (Lightweight Directory Access Protocol) server.
- Open a command prompt and type:
java InstallCert your-AD-server-ipAddress-goes-here:636and hit return, when prompted.
- Edit the LdapApp.properties file in the dist folder to adjust the provider URL, AD login, web-service port, and the Keystore file as needed.
- Open a command prompt and change directory to the dist folder. Start the service with the run command file in the dist folder.
The web service is able to link the school's user database in Directory Services with School Loop.