Glue

5.6.5

Glue42 Enterprise is a real-time user interface (UI) integration platform. Applications are combined at the user interface level to provide a better user experience (UX). UI integration makes it easier for users to access the right data and functionality at the right time and also reduce the number of times they need to copy/paste their way between one application and another. Glue42 Enterprise provides intuitive paths from one function to the next, in order to deliver business outcomes quickly and reliably. It allows developers to connect to any (legacy, 3rd party or modern) web or desktop application and have multiple apps interact with each other in real time.

The Glue42 JavaScript library enables JavaScript applications to participate in Glue42 Enterprise and use Glue42 functionalities via a set of APIs.

Referencing the Library

From a JavaScript File

Glue42 JavaScript is a library available as a single JavaScript file, which you can include in your web applications using a <script> tag. If you are using a Glue42 installer, you can find the JavaScript files in %LOCALAPPDATA%\Tick42\GlueSDK\GlueJS\js\web.

<script type="text/javascript" src="desktop.umd.js"></script>

When deploying your application in production, it is recommended to always reference a specific minified version:

<script type="text/javascript" src="desktop.umd.min.js"></script>

Using the Glue42 CDN

You can alternatively point to Glue42 JavaScript npm packages and files via the Glue42 CDN by using URLs in the format:

https://cdn.glue42.com/:package@:version/:file
  • Using the latest version: https://cdn.glue42.com/desktop@latest;
  • Using a fixed version: https://cdn.glue42.com/desktop@5.6.1
  • Using a specific file different from the one defined in the package.json: https://cdn.glue42.com/browse/desktop@5.6.1/dist/web/@glue42/desktop.min.js
  • To see all available versions and files, append / to the URL: https://cdn.glue42.com/desktop/

From an NPM Module

The Glue42 JavaScript library is also available as an npm package, which you can include as a dependency in your project and import in your code. The currently available packages are @glue42/core and @glue42/desktop. The Core package is a subset of the Desktop package and offers basic functionalities for sharing data between applications (Interop, Shared Contexts, Pub/Sub, Metrics), while the Desktop package offers additional options for sharing data between apps (Channels), as well as advanced window management functionalities (App Management, Layouts, Window Management).

To include any of the packages as a dependency in your project, navigate to the root directory of your project and run:

npm install @glue42/desktop

Your package.json file now should have an entry similar to this:

{
  "dependencies": {
    "@glue42/desktop": "^5.6.1"
  }
}

Initializing the Library

When included, the JavaScript library will register a global factory function called Glue(). It should be invoked with an optional configuration object to initialize the library. The factory function will resolve with the initialized glue API object.

Initialization in a Glue42 window:

import Glue from "@glue42/desktop";

// You don't need to specify any configuration.
const initializeGlue42 = async () => {
  window.glue = await Glue();
};

initializeGlue42().catch(console.error);

See also the Glue42 Enterprise documentation for more details.

object

Description

Optional configuration object when initializing the Glue42 library.

Properties

appManager?:
boolean | "startOnly" | "skipIcons" | "full"

Whether to initialize the Application Manager or not.

Default: false

layouts?:
boolean | "full" | "slim" | "fullWaitSnapshot"

Whether to initialize the Layouts API or not.

Default: "slim"

activities?:
boolean | "trackMyOnly" | "trackMyTypeAndInitiatedFromMe" | "trackAll" | "trackTypes"

Whether to initialize the Activities API or not.

Default: "trackMyTypeAndInitiatedFromMe"

windows?:
boolean

Whether to initialize the Window Management API or not.

Default: true

channels?:
boolean

Whether to initialize the Channels API or not.

Default: false

displays?:
boolean

Whether to initialize the Displays library or not.

libraries?:
((glue: Glue, config?: Config) => Promise<void>)[]

A list of glue libraries which will be initiated internally and provide access to specific functionalities

application?:
string

Application name. If not specified, the value depends on the hosting environment. For the browser - document.title + random number (e.g., ClientList321333). In Glue42 - containerName + browserWindowName (e.g., Internal.ClientList).

gateway?:
GatewayConfig

Configurations for the Glue42 Gateway connection.

metrics?:
boolean | MetricsConfig

Metrics configurations.

contexts?:
boolean

Enable or disable the Contexts API.

bus?:
boolean

Enable or disable the Pub/Sub API.

logger?:
"off" | "trace" | "debug" | "info" | "warn" | "error" | LoggerConfig

Defines logging levels per output target.

customLogger?:
CustomLogger

Pass this to override the build-in logger and handle logging on your own

auth?:
string | Auth

Authentication can use one of the following flows:

  • username/password;
  • token - access tokens can be generated after successful login from the Auth Provider (e.g., Auth0);
  • gatewayToken - Gateway tokens are time limited tokens generated by the Gateway after an explicit request. To generate one, use the glue.connection.authToken() method;
  • sspi - using sessionId and authentication challenge callback;

object

Description

Instance of the initialized Glue42 library.

methoddone
() => Promise<void>

Description

Disposes Glue42 API. This will remove all Interop methods and streams registered by the application.

Returns

Promise<void>

Properties

windows:
API

Window Management library.

activities:
API

Activities library.

appManager:
API

Application Management library.

layouts:
API

Layouts library.

channels:
API

Channels library.

hotkeys:
API

Hotkeys library.

displays:
API

Displays library.

Available since version Glue42 3.9

intents:
API

Intents API

Available since version Glue42 3.9

notifications:
API

Notifications API (alpha version)

Available since version Glue42 3.9

workspaces?:
API

Workspaces library

Available since version Glue42 3.10

themes?:
API

Themes API

Available since version Glue42 3.10

prefs:
API

Preferences API

Available since version Glue42 3.12

connection:
API

Connection library.

logger:
API

agm:
API

Interop library.

interop:
API

Interop library.

bus:
API

Pub/Sub library.

metrics:
API

Metrics library.

contexts:
API

Contexts library.

feedback:
(info?: FeedbackInfo) => void

Brings up the Glue42 Desktop feedback dialog.

info:
object

Info object containing versions of all included libraries and Glue42 itself.

version:
string

Glue42 version.

object

Description

Object describing a screen.

Properties

height:
number

Screen height.

isPrimary:
boolean

Whether this is the primary screen.

left:
number

Horizontal coordinate of the top left corner of the screen.

name:
string

Name of the screen assigned by the operating system.

scale:
number

Screen scale factor.

scaleX:
number

Scale factor of the horizontal axis of the screen.

scaleY:
number

Scale factor of the vertical axis of the screen.

top:
number

Vertical coordinate of the top left corner of the screen.

width:
number

Screen width.

workingAreaHeight:
number

Height of the working area.

workingAreaLeft:
number

Horizontal coordinate of the top left corner of the screen working area.

workingAreaTop:
number

Vertical coordinate of the top left corner of the screen working area.

workingAreaWidth:
number

Width of the working area.

object

Description

Authentication can use one of the following flows:

  • username/password;
  • token - access tokens can be generated after successful login from the Auth Provider (e.g., Auth0);
  • gatewayToken - Gateway tokens are time limited tokens generated by the Gateway after an explicit request. To generate one, use the glue.connection.authToken() method;
  • sspi - using sessionId and authentication challenge callback;

Properties

username?:
string

Username to be used

password?:
string

Password to be used

flowName?:
"sspi"

flowCallback?:
(sessionId: string, token: any) => Promise<{ data: any; }>

sessionId?:
string

token?:
string

Authenticate using token generated from the auth provider.

gatewayToken?:
string

Authenticate using gatewayToken

object

Description

Configurations for the Glue42 Gateway connection.

Properties

ws?:
string

URL for the WebSocket connections to the Gateway.

protocolVersion?:
number

Legacy (Version of the Gateway that you are connected to)

reconnectInterval?:
number

Reconnect interval in milliseconds.

Default: 500

reconnectAttempts?:
number

Number of reconnect attempts.

Default: 10

gwTokenProvider?:
GwTokenProvider

A way to pass custom token provider for Gateway v.3 tokens.

sharedWorker?:
string

webPlatform?:
WebPlatformConnection

An object containing the configuration settings when core is operating in a web platform environment

inproc?:
InprocGWSettings

Connect with GW in memory

object

Description

Metrics configurations.

Properties

disableAutoAppSystem?:
boolean

If false (default), an App system will be created on top level, and all other metrics will live in it. If true, an App system will be created, and all metrics will live on top level.

pagePerformanceMetrics?:
PagePerformanceMetricsConfig

object

Properties

facade:
GW3Facade

object

Properties

console?:
LogLevel

Console logging level.

publish?:
LogLevel

File logging level.

function

methodGlue
(config: Config) => Promise<Glue>

Description

Factory function that creates a new Glue42 instance.

Parameters

Name
Type
Required
Description

config

Config

no

Returns

Promise<Glue>