For AI agents: visit https://docs.ol-hub.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

Home Guides Reference Changelog

Guides

Home Guides Reference Changelog

Getting Started

Welcome to OpenLegacy Hub!
Creating Microservice-based APIs with OL Hub
Sign up to the OL Hub
Generating API Keys
The OpenLegacy Dashboard
OL Hub open source dependency list
Role-based Access Control (RBAC)
User and Team Management
SSO Authentication (SaaS)
SSO Integration with Keykloac (Enterprise)
License Management
- Production License Count and Usage
- License Renewal

Installation

OpenLegacy CLI
OpenLegacy Hub Enterprise
OpenLegacy Hub Enterprise Light

Creating Modules and Assets

Creating Modules and Assets
Connection Profiles
Handling Redefine Statements
- Asset Variants
- Dynamic Redefine fields
Reusing Connections
Pre Processors
Resources
Legops

DOMAINS & MODELS

Global Models

Creating Projects

Create a Project
Create an OpenAPI contract

Creating the Method Flow

Adding fields to the method flow
Mapping fields between steps
Using JWT fields in the method
- Authenticating JWT Against the OPA Service
Add an expression step to the method flow
Add a condition step to the method flow
Invoke on Condition (Invoke Step)
Handling Errors in the flow
Add a Parallel step to the method flow
Customizing method fields using expressions
Create and use Flow Functions
Screens flow
- Screen Project - Connection Pool
Customizing method flow using entrypoints
Testing the Method Flow

Working with Projects

Tag a Project
Labels and Filters
Exporting Projects
Deploying Projects Automatically
Project Configuration Variables
Reverse API
- IBMi(AS/400) Reverse API Cobol Client Deployment
- z/OS CICS Reverse API Cobol Client Deployment
Legacy Screen Applications
Deploy to the OL Hub Runtime
OL-Hub Runtime Dashboard
Executing a Project Test Plan
Creating a Custom Deployer in OpenLegacy Hub
OpenLegacy MCP Endpoint

Maintenance

Exporting and Importing Repositories

Advanced configuration

Including Error Messages in OpenLegacy API REST Responses
Red Hat Marketplace - Getting Started
Deploy to No-Code Container
CICS Adapter Rollback
Create a DB Poller Service
Customizing service generator templates
Configure the XML Connector Parser
Configuring Webhooks
Using Remote and Local Agents
Using Asset Caching
H3270 SSL Connection Configuration
Kafka Producer - Serialization of Additional Message Properties
Parallelism in Kafka Consumer Projects
OpenLegacy REST Connector – Proxy Configuration Guide
Flow Logging
Using Original Name when creating as asset
Recording Mainframe Screen Sessions with the Loki Recorder
Using Project Configurations and Flow Variables in an Expression Step

Connector guides

IBM Mainframe
IBMi (AS400)
- IBMi-AS400-COBOL Connector
- IBMi-AS400-PCML Connector
Message Queues
SAP Connector
REST
SOAP-WSDL Connector Guide
Databases
Files
- Files SFTP Connector Guide
- XML-FILES-XSD Connector Guide
Temenos
- Temenos T24 TAFC Connector Guide
- Temenos T24 TAFJ Connector Guide
Micro Focus Connector Guide
VSAM-CICS Connector Guide
ISO8583 Connector Guide
CORBA Connector Guide

Generator Guides

Spring Java Rest Generator
Spring Java Controllers Generator
Spring Java SOAP Generator
Spring Java Kafka Generator
Spring Java IBM MQ Generator
Spring Java ActiveMQ Generator
Spring Java File Consumer
Spring Java DB Poller Generator
AWS Java Lambda Generator

Glossary

Asset
Business Fields
Business Operation
Connector
Contract and Method
Data Consumer
Data Source
Module
Project
Service
Solution

FAQ

How to configure my CLI to work against an on-prem instance
How to Resolve SSL Connection Error when working with CLI against the OpenLegacy Hub
How to resolve SSL connection Error when starting the OpenLegacy API
How to generate OpenLegacy Lowcode API with Maven
How to start OpenLegacy Lowcode API with Gradle
How to resolve an OpenLegacy API that fails to start
How to Configure the Log Level
How to Dockerize the OpenLegacy API
How to work with OPZ
How to Log Binary Information
How to configure and run Mainframe H3270 Screens project
How to configure and run the IBMi TN5250J Screens project
How to run the OpenLegacy LightHub on a different port
How to resolve - java.security.NoSuchAlgorithmException Cannot find any provider supporting AES/CBC/PKCS7Padding - When working against the LightHub
How to work with project tags
How to set OL HUB Logging level
OpenLegacy LowCode API - Supported Environment Variables
How to work with OLB
How to add tracing information to OpenLegacy LowCode API
OpenLegacy H3270 Connector and the USER Directory
How to Configure Azure AD for SSO
How to receive changelog RSS feeds
How to Dismiss Empty Records In a Collection By Key Field
🛡️ Using Self-Signed Certificates with Java-Based Applications
Working With Distributed Tracing with OpenLegacy: Propagating Trace ID and Span ID
Running the OpenLegacy API with GraalVM JDK
Using Environment Variables Inside The Connection
No-Code Integration Setup for OpenLegacy H3270 Screens API
Matching Buffers to COBOL REDEFINE Structures
No Methods in OpenAPI Endpoint
How to Suppress Vert.x Block Logs

miscellaneous

OpenLegacy Trust Center
Support and Maintenance Policy

Powered by

How to configure my CLI to work against an on-prem instance

To configure the CLI you should run the following command:

ol config hub --hub-url <OPENLEGACY HUB URL> local
ol config hub local --active