Glue
5.1.0Glue42 Desktop 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. The objective of Glue42 Desktop is therefore to provide intuitive paths from one function to the next, in order to deliver business outcomes quickly and reliably. Glue42 Desktop 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 Desktop and use Glue42 functionalities via a set of APIs.
Referencing
From a JavaScript File
Glue42 is a library available as a single JavaScript file, which you can include into your web applications using a <script> tag. If you are using a Glue42 installer, you can find the .js files in %LOCALAPPDATA%\Tick42\GlueSDK\GlueJS\js\web.
<script type="text/javascript" src="tick42-glue-5.1.0.js"></script>
Because the API evolves, we have chosen the following semantic version model:
BreakingChangesVersion.FeatureVersion.FixVersion
When deploying your application in production, we recommend that you always reference a specific minified version, e.g.:
<script type="text/javascript" src="tick42-glue-5.1.0-min.js"></script>
From an NPM Module
The Glue42 JavaScript library is also available as npm packages, which you can include as dependencies 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 (Activities, Channels), as well as advanced window management functionalities (App Management, Layouts, Window Management, Hotkeys).
To include any of our packages as a dependency in your project, navigate to the root directory of your project and run:
npm install
object
Description
Optional configuration object when initializing the Glue42 library.
Properties
appManager?:
Whether to initialize the Application Manager or not.
Default: false
layouts?:
Whether to initialize the Layouts API or not.
Default: "slim"
activities?:
Whether to initialize the Activities API or not.
Default: "trackMyTypeAndInitiatedFromMe"
windows?:
Whether to initialize the Window Management API or not.
Default: true
channels?:
Whether to initialize the Channels API or not.
Default: false
displays?:
Whether to initialize the Displays library or not.
application?:
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?:
Configurations for the Glue42 Gateway connection.
metrics?:
Metrics configurations.
contexts?:
Enable or disable the Contexts API.
bus?:
Enable or disable the Pub/Sub API.
logger?:
Defines logging levels per output target.
customLogger?:
Pass this to override the build-in logger and handle logging on your own
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 theglue.connection.authToken()method;sspi- usingsessionIdand authentication challenge callback;
object
Description
Instance of the initialized Glue42 library.
() => Promise<void>
Description
Disposes Glue42 API. This will remove all Interop methods and streams registered by the application.
Returns
Promise<void>
Properties
windows:
Window Management library.
activities:
Activities library.
appManager:
Application Management library.
layouts:
Layouts library.
channels:
Channels library.
hotkeys:
Hotkeys library.
displays:
intents:
notifications:
connection:
Connection library.
logger:
agm:
Interop library.
interop:
Interop library.
bus:
Pub/Sub library.
metrics:
Metrics library.
contexts:
Contexts library.
feedback:
Brings up the Glue42 Desktop feedback dialog.
info:
Info object containing versions of all included libraries and Glue42 itself.
version:
Glue42 version.
object
Description
Object describing a screen.
Properties
height:
Screen height.
isPrimary:
Whether this is the primary screen.
left:
Horizontal coordinate of the top left corner of the screen.
name:
Name of the screen assigned by the operating system.
scale:
Screen scale factor.
scaleX:
Scale factor of the horizontal axis of the screen.
scaleY:
Scale factor of the vertical axis of the screen.
top:
Vertical coordinate of the top left corner of the screen.
width:
Screen width.
workingAreaHeight:
Height of the working area.
workingAreaLeft:
Horizontal coordinate of the top left corner of the screen working area.
workingAreaTop:
Vertical coordinate of the top left corner of the screen working area.
workingAreaWidth:
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 theglue.connection.authToken()method;sspi- usingsessionIdand authentication challenge callback;
Properties
username?:
Username to be used
password?:
Password to be used
flowName?:
flowCallback?:
sessionId?:
token?:
Authenticate using token generated from the auth provider.
gatewayToken?:
Authenticate using gatewayToken
object
Description
Configurations for the Glue42 Gateway connection.
Properties
ws?:
URL for the WebSocket connections to the Gateway.
protocolVersion?:
Legacy (Version of the Gateway that you are connected to)
reconnectInterval?:
Reconnect interval in milliseconds.
Default: 500
reconnectAttempts?:
Number of reconnect attempts.
Default: 10
gwTokenProvider?:
A way to pass custom token provider for Gateway v.3 tokens.
Path to the shared worker file that contains glue0 shared worker related code
inproc?:
Connect with GW in memory
object
Description
Metrics configurations.
Properties
disableAutoAppSystem?:
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:
object
Properties
facade:
object
Properties
console?:
Console logging level.
publish?:
File logging level.
function
Description
Factory function that creates a new Glue42 instance.
Parameters
Returns
Promise<Glue>