Running an Embedded Lite Client

Lite Client

Trail: PROIV Documentation > Developer > Lite Client > Lite Client and the Browser > Running an Embedded Lite Client

The Lite Client can be run embedded in an existing HTML page or stand alone in its own HTML page. The PROIV dashboard offers URLs to run Lite Client in stand alone mode.

Loading an Embedded Lite Client

The following files need to loaded by the HTML page before the Lite Client session can be started. All the example URLs show here are for a PROIV version 12 install on the local machine.

proiv-lite-client.js: This is the Lite Client JavaScript library file. It is available in a minimised version that has had all white space and comments removed so it is much smaller (proiv-lite-client.min.js).
Example URL: http://localhost:12804/base-default/lite-client/libraries/proiv-lite-client.js

PROIVDefault-templates.js: This is the Lite Client template file that holds the templates for the components.
Example URL: http://localhost:12804/base-default/lite-client/resources/PROIVDefault-templates.js

PROIVDefault-mapping.js: This is the Lite Client mapping file that holds the values of properties used in constructing the omponent templates.
Example URL: http://localhost:12804/base-default/lite-client/resources/PROIVDefault-mapping.js

PROIVDefault.css: This is the Lite Client CSS file that holds the CSS used in the omponent templates.
Example URL: http://localhost:12804/base-default/lite-client/resources/PROIVDefault.css

fontawesome.min.css: This is one of the font icon files used by the Lite Client.
Example URL: http://localhost:12804/base-default/lite-client/libraries/fontawesome.min.css

regular.min.css: This is a CSS file used by the fontawesome font icons.
Example URL: http://localhost:12804/base-default/lite-client/libraries/regular.min.css

solid.min.css: This is a CSS file used by the fontawesome font icons.
Example URL: http://localhost:12804/base-default/lite-client/libraries/solid.min.css

Starting an Embedded Lite Client Session

At any time a Lite Client session can be started using the following piece of JavaScript:

var sessionKey = proiv.startPROIVSession({
   sessionNodeID: "proiv_session",
   URI: "http://localhost:12804/base-default/connect",
   connectionData: {service: "Default"}
});

The sessionNodeID is the id of the DOM node that is to hold the Lite Client session HTML. The URI is the Lite Client connection servlet and in this example is for a PROIV version 12 install on the local machine. The service refers to a PROIV dashboard Client Connector Client Service that holds all the properties defined for the connection.

The startPROIVSession function returns a unique key defined for the session.

Stopping an Embedded Lite Client Session

A Lite client session can be stopped at any time by running the function proiv.endPROIVSession(sessionKey). This takes a session key provided by the startPROIVSession function. You can call endPROIVSession without a session key in which case the most recently active session will be stopped.

Comment on this topic

Topic ID: 870023