Requirements & Installation
Requirements
To use the PReS Connect REST API Cookbook with Working Examples source you will require the following:
- A working installation of PReS Connect
- Any modern web browser able to display HTML51
If using Internet Explorer, you may find issues when using the working examples with PReS Connect's Server Security Settings set to enabled.
The working examples use HTML5 Local Storage to facilitate authentication and certain simplicity / ease-of-use (across browser tabs). Depending on how your Internet Explorer security settings are configured, you may experience issues if the security level of your zone is set too high.
Essentially, the security zone needs to have the security option Userdata persistence (under Miscellaneous) set to enabled. Without this option enabled, the working examples will not function correctly when using them with PReS Connect's Server Security Settings set to enabled.
After running the Authenticate/Login to Server working example to re-authenticate, you should only need to refresh existing pages in order for the authentication credentials (token) to be picked up. In the case of Internet Explorer, you may need to restart the browser for the changes to be picked up.
If all else fails, disabling of the Sever Security Settings in the PReS Connect Server Preferences should avoid issues with running the various examples on Internet Explorer.
Any recent version of Mozilla Firefox, Google Chrome, or Microsoft Edge with support for HTML5 should be suitable for running the working examples contained in this guide. Microsoft Internet Explorer 11 may also be suitable in some cases.
Installation
The working examples source comes pre-installed with PReS Connect and can be located in a sub-directory of your existing PReS Connect installation directory.
To locate the source on Windows:
- Open up Windows Explorer and navigate to the PReS Connect installation directory followed by its plugins sub-directory.
- Find the com.objectiflune.serverengine.rest.gui directory and navigate to its www sub-directory
- You should now be exploring the following or similar location:
- C:\Program Files\Objectif Lune\OL Connect\plugins\com.objectiflune.serverengine.rest.gui_1.X.XXXXX.XXXXXXXX-XXXX\www
- The www directory contains a cookbook sub-directory, which contains all of the working examples source. You should find a directory structure matching that shown on the Structure of the Working Examples page.
You can access the PReS Connect REST API Cookbook with Working Examples source locally by entering the following URL in your web browser: