Technical resources

Detailed technical information for architects, developers and technical decision makers looking to use ExpressConnect.

Developer resources Schedule a technical session

Architecture overview

ExpressConnect is an embedded API platform add-on for TRIRIGA / MREF. The API Explorer and API Builder run as UX web applications.

OpenAPI Explorer

Browse and try APIs

API Builder

Build and publish APIs

Client tools

Connect and test drive

TRIRIGA / MREF application server

IBM Maximo Real Estate and Facilities (MREF)

MREF core applications

Business objects and workflows

MREF platform

Runtime services and data model

Embedded cache

Mappings, metadata and resources

ExpressConnect

ExpressAPI

REST APIs and OpenAPI documents

ExpressEvent

Event-driven data exchange

Embedded capabilities

Transform

MREF to Maximo Manage mappings

Webhook

Publish events to an endpoint

WebSocket

Real-time bi-directional data exchange and event subscriptions

Define APIs, generate and activate them, load the cache, serve requests, publish the specification, and stream events.

01
Define the APIs
In the API Builder, a TRIRIGA / MREF UX application, authors choose the pack, module and business objects, then the paths, fields, actions and linked objects, reading the live data model.
02
Generate and activate
The builder creates the TRIRIGA / MREF reports, UX data sources, mapping files and API resource records and activates them in the runtime. Existing APIs are imported and revised the same way.
03
Load the cache
Workflow steps load path mappings, metadata and authentication state into the embedded cache.
04
Serve requests
Clients call the REST endpoint under the TRIRIGA / MREF host; the ExpressAPI servlet resolves the path and executes against business objects.
05
Publish the specification
Every publication or revision regenerates the shared OpenAPI document that the API Explorer and your tools consume, with a Postman collection alongside it.
06
Stream events
TRIRIGA / MREF workflows hand changes to ExpressEvent, which delivers them over WebSocket or webhooks.

Component deep dive

Explore ExpressAPI, ExpressEvent, ExpressAdaptor and the platform modules that support them.

Versioned REST servlet with generated OpenAPI documents

ExpressAPI receives OpenAPI-style REST calls under the TRIRIGA / MREF host and routes them into TRIRIGA / MREF business logic, with paging, filtering, cache control and transformation headers. Its APIs come from the licensed packs or from the API Builder.

Hundreds of pre-built REST endpoints
Connect to business data through documented APIs, ready to call from your integration tools.
OpenAPI 3.x generated from metadata
The specification is produced from the TRIRIGA / MREF metadata, not hand-written.
Embedded cache with resource-scoped keys
Cached projections are keyed by API resource and record so two APIs never overwrite each other.
MREF to Maximo Manage transformations
Dataset transformations for person, asset and location records.

GET https://<tririga-host>/html/en/default/rest/expapi/latest/buildings?h={"_page":{"_offset":0,"_size":100}}
Cookie: <session cookie from /expapi/latest/auth/login>
X-EXPAPI-TRANSFORM: none
Accept: application/json

Paging uses _page with _offset and _size; skipCache bypasses the cache for one request.

{
  "data": [
    {
      "ID": "<Sample Text String>",
      "buildingId": 123456789
    }
  ],
  "counts": {
    "total": 1, "size": 1,
    "hasMore": false, "nextOffset": -1
  }
}

Illustrative success response, shortened from the OpenAPI example. Fields and values depend on your data and API configuration.

curl --get \
  'https://<tririga-host>/html/en/default/rest/expapi/latest/buildings' \
  --data-urlencode 'h={"_page":{"_offset":0,"_size":100}}' \
  --cookie '<session cookie from /expapi/latest/auth/login>' \
  --header 'X-EXPAPI-TRANSFORM: none' \
  --header 'Accept: application/json'

Replace the host and session cookie with those from your environment. cURL encodes the paging query before sending the request.

Event engine with an embedded WebSocket server and webhook delivery

Workflow steps gather TRIRIGA / MREF changes, filter them, transform the payload and transmit it over WebSocket or webhooks.

Gather, filter, transform, transmit
Four workflow steps you compose per event type.
Subscriptions per data object or module
Choose which records and modules raise events.
Trigger workflows generated for you
The workflow builder creates the trigger workflows for a subscription.

> Connecting to configured WebSocket server...> Connecting to configured WebSocket server...

> Connection established> Connection established

___ ___ ___ ___ ___ | / / \ |\ | \ / | | \ / | \ / |_/ | | | \ | \ / |__ |___/ | __ |__ \ / | \ | | | \| V | | \ | | | / \ | \ \___/ | | |___ | \ \___/ |___ / \ ___ ___ ___ ___ ___ | / / \ |\ | \ / | | \ / | \ / |_/ | | | \ | \ / |__ |___/ | __ |__ \ / | \ | | | \| V | | \ | | | / \ | \ \___/ | | |___ | \ \___/ |___ / \

ExpressEvent WebSocket serverExpressEvent WebSocket server

Instance: Test ServerInstance: Test Server

Version: 1.0.1Version: 1.0.1

> Authenticated session ready> Authenticated session ready

{"data":{"subscription":["people/create","people/activate"]}}{"data":{"subscription":["people/create","people/activate"]}}

> Waiting for subscribed events...> Waiting for subscribed events...

Connector designs for integration middleware

Connector designs for IBM App Connect Enterprise, MuleSoft and webMethods, generated from the OpenAPI specification.

Generated from the specification
Each connector starts from the same OpenAPI 3.x document the Explorer exports.
Named middleware platforms
The platforms named in the licence terms.

KonvergeX API

Response

Buildings

GETGet building records/buildings
POSTCreate a building record/buildings

OpenAPI 3.x
IBM App Connect Enterprise
MuleSoft
webMethods

Runtime services and integration tools

Manage API access, event connections and data transformations alongside the embedded cache.

Embedded cache
Ehcache-based cache for path mappings, metadata and authentication state.
AuthServer
Handles session login and logout so integrations can authenticate with the application server.
WebSocket Server
Keeps a bi-directional connection open between the application server and connected clients, delivering subscribed events as records change.
API Key Manager
Generate API keys for integration clients using a configured user and expiry duration, without sending login credentials with each request.
Transformation Manager
Map person, asset and location data from TRIRIGA / MREF into the format expected by Maximo Manage.

Inside the application server

Embedded cache
Authentication
Utilities
WebSocket Server
API Key Manager
Transformation Manager

Security model

Review the runtime boundary, authentication, permissions and deployment options.

Runtime
Runs inside your TRIRIGA / MREF application server
ExpressConnect runs inside your TRIRIGA / MREF application server. Your data stays where MREF keeps it.
Access
Session and API-key authentication
Consumers log in and use a session, or present an API key that is issued and managed inside TRIRIGA / MREF.
Deployment
Deploy where you need
On-premises, cloud, hybrid or OpenShift.
Permissions
Authorisation and data segregation
ExpressAPI respects the existing authorisation and data segregation rules defined by your TRIRIGA / MREF security groups. API access follows the permissions of the authenticated user.

TRIRIGA / MREF
Application server

1 of 4

Tools for developer productivity

Work from a shared specification and data model, with Explorer and caching built into the platform.

Automated documentation
Automate API documentation as you build, launch, grow and manage integrations. API Builder refreshes the shared specification whenever you publish or revise an API.
Documented operations
427+
REST operations described in the specification
Consistent data model
The same 40+ data objects and field names in every integration, so teams stop re-mapping the same records project after project.
Mapping reuse
Illustrative
72%
Example fields reused
One standard model, reused across projects.
Rapid onboarding
New developers start from the Explorer, the specification and the builder's live view of business objects, fields and associations instead of undocumented know-how. The embedded cache keeps responses fast under load.
Response time
up to 40%faster
*Under test conditions with up to 100,000 records

Developer resources

Check which operations are available, try requests in the API Explorer and use the OpenAPI specification to build your integration.

OpenAPI specification
The current specification describes 427 operations across 40 resources. Licensed customers export it from the API Explorer or download it, with a Postman collection, from the API Builder. Contact the team to request access.
Request the specification
API Explorer
Browse and try APIs, then download a software development kit (SDK) in TypeScript, Python, Java or C#. Choose an API pack, group, resource or the whole API. Available in licensed environments with SDK generation enabled.
API Flows
Define how one or more APIs work together to support a business flow.

Want to see the APIs against your own data?

A technical session walks through the Explorer, the specification, the API Builder and the event framework on a TRIRIGA / MREF instance like yours.

Schedule a technical session Support

Technical resources

Architecture overview

Define the APIs

Generate and activate

Load the cache

Serve requests

Publish the specification

Stream events

Component deep dive

Versioned REST servlet with generated OpenAPI documents

Hundreds of pre-built REST endpoints

OpenAPI 3.x generated from metadata

Embedded cache with resource-scoped keys

MREF to Maximo Manage transformations

Security model

Runs inside your TRIRIGA / MREF application server

Session and API-key authentication

Deploy where you need

Authorisation and data segregation

Tools for developer productivity

Automated documentation

Consistent data model

Rapid onboarding

Developer resources

OpenAPI specification

API Explorer

API Flows

Want to see the APIs against your own data?