LDP Settings

Overview

The LDP Settings are available for configuring when the LDP module is being used. Each site on which forms are to be placed must be registered with the Server-Side Module (SSM).

Note: Live Delivery Platform is an optional set of features in OU Campus. Please contact the university’s designated OmniUpdate Sales Director for details.

The following functionality is available from the LDP Settings panel:

  • LDP Admin Host: The host on which the SSM resides. This is the hostname or IP address of the server used by the application to access LDP administrator functionality.
  • Download Reg File: When downloaded, the registration file contains the necessary components, which must then be run on the server with the SSM.
  • Test Connection: After registering the file on the SSM, test the connectivity to ensure that the file has been registered properly. 
  • Include CAPTCHA: Toggles on and off the option to use a CAPTCHA code in LDP Forms. Note: CAPTCHA must be implemented for the site in order for CAPTCHA to be included. Turning this radio button on without implementing CAPTCHA will not add CAPTCHA to forms. For more information, visit the Form Asset page.
  • LDP Gallery Directory: Each site for which an LDP Image Gallery is to be used requires a directory to be configured in which the images are stored. This is a staging location, so unlike the production server settings, FTP Root should not be included with the LDP Gallery Directory. Include only preceding slash / and the directory name to specify the directory to contain the images. Without a directory defined in this field, Image Galleries will not be able to be created in the site, even if LDP is activated.

Site Settings for LDP Settings

LDP Settings Panel in Site Settings

One SSM installation can work with as many sites as necessary. Each site includes its own unique identifier. When working with a Form Asset, which is one of the Live Delivery Platform modules, forms to be submitted also require a unique identifier. The SSM that is required for forms to function properly is installed as part of the implementation of LDP as it contains the databases necessary to house the form submissions. During the initial installation of the SSM, the current sites are registered with the SSM. When adding sites after the initial implementation registration is accomplished by using the registration file found in the site settings.

The SSM is installed on the institution’s production server. It can be installed on the same server or a different server than that of the website. It is written in Python and the installation includes a MySQL database, which is where the form data are stored. As part of the configuration of the SSM, a server-side connector script is installed on the same server as the website. The connector script’s language is determined based on the needs of the institution. The purpose of the connector script is to act as a bridge between the website where the data is being submitted and the SSM.

Registering a Site

Each site needs to be registered with the SSM in order to function properly. This adds the following to the SSM database:

  • Name
  • Site’s UUID
  • Public Key

The values for a site’s UUID and public key are automatically generated when a site is created and are shown in the Site Information panel of the site settings. The UUID is used for LDP forms; the public key for authentication purposes. If a the public key is regenerated, the site must be re-registered.

To register the site:

  1. Navigate in OU Campus to Setup > Sites > Edit.
  2. Click on Download Reg File.

    Download Reg File Button
  3. Save the file and upload it to the SSM on the production server.
  4. Run a command for each registration file and replace /root/registration-site.ldp or C:\Program Files (x86)\OmniUpdate\SSM\registration-file-path.ldp with the path to the registration file on the server.
    • On Linux servers, the command is as follows:

      cd /opt/oussm

      bin/oussm -c /opt/oussm/ssmconfig.ini register /root/registration-site.ldp
    • On Windows servers, the command is as follows:

      C:\> cd "\Program Files (x86)\OmniUpdate\SSM"

      C:\Program Files (x86)\OmniUpdate\SSM> run.exe register "C:\Program Files (x86)\OmniUpdate\SSM\registration-file-path.ldp"

The site is now registered. An example of successful registration messaging is:

2017-04-06 11:14:28-0700 [-] Log opened.
2017-04-06 11:14:28-0700 [-] Database is version 5, application is version 5
2017-04-06 11:14:28-0700 [-] Notifying OUCampus of our existence for site: www

After the site is registered, the registration file can be deleted.

The OmniUpdate Support Team can also register additional sites.

SSM Test Connection Messages

After the Server-Side Module (SSM) has been installed, or during troubleshooting of the SSM, the use Test Connectivity tool may be used to help troubleshoot.

Stage Test Connection Message Steps to Take Toward Resolution
Initial Connection Connection Timed Out Has the SSM been installed? If not, install it.

Has the firewall on the server on which the SSM has been installed been opened to port 7516? If not, open the port. It must remain open.

Is the SSM running? If not, restart the server. If the start up file has not been included, it should be.
During Authentication Authentication Failed. Has the site been registered with the SSM? Has the site been registered with the SSM? If not, register it.

Has the public key been regenerated? If not, download the registration file again and re-register the site.
Success Test complete: meets overall minimum version.