5.0 Documentation

 

Installation

When you install the PureWeb SDK, you install API libraries to develop your service and your client, as well as the PureWeb server which provides middle tier functionality. You can also install sample applications to get you started quickly; these are available on public GitHub repositories, see Sample applications.

Here's what's available for each operating system:

  • Windows: PureWeb server, as well as APIs and samples for service (C++, .Net) and client (HTML5) development
  • Linux: PureWeb server, as well as APIs and samples for service (C++) and client (HTML5) development

Install the libraries

Before completing the procedure below, uninstall any previous instances of the PureWeb server from your computer. (On Windows, it is possible to keep multiple instances on the same computer, but not recommended. If you do, you will have to take special care with the environment variables; this is clarified in the installation instructions.)

If you have an existing installation and are installing the SDK as part of an upgrade, read the Upgrade Notes first. There are significant changes since the 4.3 release, and you may need to make backup copies of some files in your current installation.

The PureWeb SDK will be provided as compressed files, one for each of the following:

  • The PureWeb server
  • The API libraries for the service (C++ / .Net)
  • The API libraries for the client (HTML5)

Windows

  1. Please make sure that you have your PureWeb server license (.lic) file handy.
  2. Set up your environment as indicated in the System requirements. This includes installing OpenJDK 11 and the Visual C++ 2017 64-bit redistributable. Also check that you have the JAVA_HOME environment variable and that it is pointing to the location where Java 11 is installed (for example JAVA_HOME=C:\Program Files\Java\jdk-11.0.1). The path to JAVA_HOME must also be included in your Path variable.
  3. At the root of your [install_path], create the directory structure for the components (the name of the folders matters, use the exact names provided below):
    • \tomcat-server (the location that will hold the PureWeb server files)
    • \sdk\Libs (the location that will hold the service-side API libraries)
    • \sdk\Libs\HTML5 (the location that will hold the client-side API libraries)
  4. Extract the contents of the compressed files in the relevant directory:
    • Extract the content of the pureweb-tomcat-server file into the tomcat-server directory.
    • Extract the content of the pureweb-sdk-C++ or pureweb-sdk-dotnet file into the \sdk\Libs directory.
    • Extract the content of the pureweb-sdk-html5 file into the \sdk\Libs\HTML5 directory.

      Each component contains a copy of the end user license agreement (EULA) and third-party copyright notice. If you install the libraries for both the C++ and .Net services, you will be warned about overwriting these files. You can ignore this warning.

  5. Edit the system environment variables by adding (or editing, if you had installed the product before) the following PureWeb-specific variables:
    • PUREWEB_HOME must point to the root of your [install_path], for example:
      PUREWEB_HOME=C:\PureWeb
    • PUREWEB_LIBS must point to the location of the API libraries, for example:
      PUREWEB_LIBS=C:\PureWeb\sdk\Libs

      If you choose to have side-by-side installations of PureWeb on Windows, each will have a different install path. You will need to change the value of the PUREWEB_HOME and PUREWEB_LIBS environment variables each time that you switch to a different instance of the application.

  6. Place the .lic license file in the following directory:
    [install_path]\tomcat-server\conf
  7. Check that your firewall configuration allows TCP port 8080 to accept incoming connections. Port 8080 is the default port, but you can change it, see Configuring the ports.
  8. Reboot, to ensure that the new environment variables are correctly set.

HTML5 (Linux)

  1. Please make sure that you have your PureWeb server license (.lic) file handy.
  2. Set up your environment as indicated in the System requirements. This includes installing OpenJDK 11 and the Visual C++ 2017 64-bit redistributable.
  3. At the root of your [install_path], create the directory structure for the components (the name of the folders matters, use the exact names provided below):
    • /tomcat-server (the location that will hold the PureWeb server files)
    • /sdk/Libs (the location that will hold the service-side API libraries)
    • /sdk/Libs/HTML5 (the location that will hold the client-side API libraries)
  4. Extract the contents of the compressed files in the relevant directory:
    • Extract the content of the pureweb-tomcat-server file into the tomcat-server directory.
    • Extract the content of the pureweb-sdk-C++ file into the \sdk\Libs directory.

      There is currently a glitch in the .zip file, which adds an extra layer in the directory structure. The PureWeb server expects the C++ libraries to reside at this location:
      [install_path]/sdk/libs/C++
      but the .zip file gets extracted here:
      [install_path]/sdk/libs/pureweb-sdk-C++/C++
      You must manually move the C++ directory up one level.

    • Extract the content of the pureweb-sdk-html5 file into the \sdk\Libs\HTML5 directory.
  5. Edit the system environment variables by adding (or editing, if you had installed the product before) the following PureWeb-specific variables:
    • PUREWEB_HOME must point to the root of your [install_path], for example:
      PUREWEB_HOME=opt/PureWeb
    • PUREWEB_LIBS must point to the location of the API libraries, for example:
      PUREWEB_LIBS=opt/PureWeb/sdk/Libs
  6. Place the .lic license file in the following directory:
    [install_path]/tomcat-server/conf
  7. Reboot, to ensure that the new environment variables are correctly set.

To confirm that it works, start the PureWeb server and log in (see Accessing the server). You should be able to see the configuration pages and navigate the links.


Change the default settings

After installing the PureWeb server, you may wish to edit some of the default configuration settings.

The links below provide instructions on some configuration procedures that you would typically perform shortly after installation.