Skip to main content

LumenLink Connection Module

Page/Section: Module-Connection-Overview

The Connection module in LumenLink manages all external and internal connectivity for a project. It is accessible from the left navigation under Integration Dev → Connection. The main page shows a tabular list of connections, where each row represents a single connection and columns include ID, Name, Type, and Status. Each column supports inline filtering using a search field under the header to quickly locate specific connections.

The Status column displays an enable/disable toggle for every connection row. Switching this toggle activates or deactivates the selected connection without opening the detail screen. At the bottom of the table, pagination controls allow navigation across multiple pages and a page-size selector defines how many rows are visible at once.

Connection List Actions

Page/Section: Module-Connection-Action-Bar

At the top-left of the connections table, an Actions toolbar exposes key operations:

  • Create (+)
  • Refresh
  • Edit (pencil)
  • Delete (trash)
  • Download

The Create button opens a type selector dropdown listing all supported connection types:

  • JDBC
  • REST
  • RESTIN (REST Inbound)
  • SFTP
  • AS2
  • SOAP
  • SMTP

Once a type is selected, LumenLink opens a new connection tab for that type with its corresponding configuration form.

The Refresh button reloads the table data to show newly created or updated connections. Edit and Delete are only enabled when at least one row is selected via the row checkboxes. Edit opens the connection configuration tab for modification, while Delete removes the selected connection records after confirmation.

The Download button opens a small dropdown that lets the user export the current table view in one of several formats:

  • CSV
  • Excel
  • PDF

Exports include the currently visible rows and columns, honoring column selection and filters.

Column Selector

Page/Section: Module-Connection-Column-Selector

On the top-right of the connections table, a column selector dropdown controls which additional metadata fields appear as table columns. The dropdown lists available columns, for example:

  • Type
  • Created At
  • Created By
  • Updated At
  • Other project-specific fields

Each line has a checkbox to show or hide that column in the main grid. A top-level checkbox can select or clear all, and a close icon clears the selection quickly. When a new column is enabled, it appears in the table with its own filter field under the header.

Common Connection Editor Behavior

Page/Section: Module-Connection-Editor-Common

When creating or editing a connection, LumenLink opens a connection editor tab specific to the chosen type (JDBC, REST, RESTIN, SFTP, AS2, SOAP, SMTP). All connection editors share common controls:

  • Top-right buttons:
    • Close (X): Exits the editor tab without applying unsaved changes.
    • Save (disk): Persists the connection configuration and keeps the tab open.
  • Required fields are usually marked with an asterisk.
  • Validation errors prevent saving until mandatory fields are correctly filled.

Each connection type then adds its own type-specific fields and behavior described below.

JDBC Connection

Page/Section: Module-Connection-JDBC

The JDBC Connection type is used to connect to relational databases via JDBC. It contains the following important fields:

  • Connection Name: Logical name used within LumenLink.
  • Username: Database user name.
  • Password: Database password, masked in the UI.
  • URL: JDBC connection URL, including host, port, and database.
  • Connection Type: Dropdown indicating database flavor.
  • Role: Optional database role or profile if supported.
  • Hostname and Port: Alternative way to specify server target.
  • Connection Mode: SID or Service Name for Oracle-style connections.
  • SID / Service Name: Identifier matching the selected mode.
  • Connection Color: Visual tag color used to distinguish this connection in the UI.

Security-related toggles include:

  • OS Authentication: Enables operating-system-based authentication when supported.
  • Kerberos Authentication: Enables Kerberos-based authentication.
  • Proxy Connection: Indicates that this database is reached via a proxy.

The JDBC editor provides several buttons at the bottom:

  • Save: Saves configuration without immediately connecting.
  • Connect: Attempts to establish a live connection using the provided details.
  • Clear: Resets fields in the form.
  • Cancel: Returns to the previous state.

JDBC provides a dedicated Test button that validates connectivity without saving permanent changes. This Test Connection capability is unique to JDBC among the listed connection types and is typically used to confirm credentials and network access before saving.

Mandatory Fields​

  • Connection Name*
  • Username*
  • Password*
  • URL* [file:1]

REST Connection

Page/Section: Module-Connection-REST

The REST Connection type configures outbound HTTP calls from LumenLink to external services. The editor is organized into four tabs:

  • Basic Details
  • Params
  • Headers
  • Authorization

REST Basic Details​

Page/Section: Module-Connection-REST-Basic

Key fields on the Basic Details tab:

  • Connection Name: Internal label for the REST connection.
  • URL: Full HTTP or HTTPS endpoint URL provided by the user.
  • Operation: HTTP method dropdown such as GET, POST, PUT, DELETE, and other verbs.

These fields define the target service and how LumenLink invokes it.

REST Params​

Page/Section: Module-Connection-REST-Params

The Params tab manages URL query parameters:

  • A Query Parameters section with an add (+) button.
  • Each added row typically contains Name and Value fields.
  • Parameters are appended to the URL when the connection is executed.

This design lets integrators externalize frequently changed parameters without modifying mappings or scripts.

REST Headers​

Page/Section: Module-Connection-REST-Headers

The Headers tab defines HTTP request headers:

  • A Request Headers section with an add (+) button.
  • Each row has a Header Name and Header Value.
  • Common usage includes setting Content-Type (for example application/json) and custom headers.

Headers configured here are automatically sent with each request that uses this connection.

REST Authorization​

Page/Section: Module-Connection-REST-Authorization

The Authorization tab controls authentication details. It exposes an Auth Type dropdown with options such as:

  • None
  • Basic Auth
  • Bearer Token
  • API Key

Depending on the selected type, additional fields appear, for example:

  • Basic Auth: Username and password fields.
  • Bearer Token: Token value entry.
  • API Key: Key value and, where relevant, header or query placement.

These authorization settings are applied automatically when the REST connection is used in adapters or workflows.

Mandatory Fields​

  • Connection Name*
  • URL*
  • Operation* [file:1]

RESTIN (REST Inbound) Connection

Page/Section: Module-Connection-RESTIN

A RESTIN Connection defines inbound REST endpoints that external systems call to send data into LumenLink. RESTIN reuses the same four-tab layout as REST:

  • Basic Details
  • Params
  • Headers
  • Authorization

The critical difference between REST and RESTIN lies in the URL handling:

  • For REST, the user supplies the URL of the target external service.
  • For RESTIN, LumenLink generates the inbound URL automatically for the connection.

The generated URL acts as a webhook-style endpoint that partners call. The rest of the configuration (parameters, headers, and authorization) controls how inbound requests are validated and parsed.

Mandatory Fields​

  • Connection Name*
  • Operation* [file:1]

SFTP Connection

Page/Section: Module-Connection-SFTP

The SFTP Connection configures secure file transfers over SFTP. Key fields include:

  • Connection Name: Label for the SFTP endpoint.
  • Host: SFTP server hostname or IP address.
  • Port: SFTP port, usually 22.
  • Username: SFTP account name.
  • Password: SFTP password, masked in the UI.

Directory and file-handling fields:

  • Inbound Directory: Folder from which files are picked up for inbound processing.
  • Outbound Directory: Folder where outbound files are written.
  • Archive Directory: Folder where successfully processed files are moved.
  • Error Directory: Folder where failed files are stored for investigation.
  • File Pattern: Pattern filter (for example *.csv) controlling which files are included.

This configuration lets LumenLink manage the full lifecycle of files: pickup, send, archive, and error handling.

Mandatory Fields​

  • Connection Name*
  • Host*
  • Port*
  • Username*
  • Password*
  • Inbound Directory*
  • File Pattern* [file:1]

AS2 Connection

Page/Section: Module-Connection-AS2

The AS2 Connection supports EDI-style secure B2B message exchange using the AS2 protocol. Important fields:

  • Connection Name: Internal name for the AS2 link.
  • Partner Name: Logical name of the trading partner.
  • AS2 Identifier: Local AS2 ID configured for this system.
  • Partner AS2 Identifier: Partner AS2 ID.
  • Partner URL: URL to which AS2 messages are posted.
  • Username: Optional HTTP authentication user if required.

Cryptographic configuration:

  • Encryption Algorithm: Dropdown to choose the encryption algorithm.
  • Signing Algorithm: Dropdown to choose the digital signing algorithm.
  • Encryption Certificate Path: File path or reference to the certificate used for encryption.
  • Signing Certificate Path: Certificate used to validate signatures.
  • Private Key Path: Path to the private key used for signing or decryption.

Delivery acknowledgements (MDN) and optimization:

  • MDN Signed: Toggle indicating if MDNs must be signed.
  • MDN Asynchronous: Toggle for asynchronous MDN behavior.
  • Enable Compression: Toggle to enable message compression before sending.

These options define how messages are secured, authenticated, and acknowledged between LumenLink and the partner.

Mandatory Fields​

  • Connection Name*
  • Partner Name*
  • AS2 Identifier*
  • Partner AS2 Identifier*
  • Partner URL* [file:1]

SOAP Connection

Page/Section: Module-Connection-SOAP

The SOAP Connection configures SOAP-based web service calls. The major fields are:

  • Connection Name: Name used throughout LumenLink.
  • WSDL URL: URL to the service WSDL document.
  • Service Name: Name of the service defined in the WSDL.
  • Port Name: Port or binding to be used.
  • Endpoint URL: Concrete service endpoint URL when overriding WSDL defaults.
  • SOAP Version: Dropdown to select protocol version such as 1.1 or 1.2.
  • Authentication Type: Dropdown defining how the SOAP call is authenticated.

Timeouts and performance:

  • Connection Timeout (ms): Maximum time allowed to establish a connection.
  • Read Timeout (ms): Maximum time to wait for a response.

Security and networking:

  • Enable SSL/TLS: Toggle to enable secure HTTPS transport.
  • Proxy Host and Proxy Port: Optional outbound proxy configuration.
  • Proxy Username and Proxy Password: Credentials when the proxy requires authentication.

These settings collectively determine how SOAP messages are constructed, transmitted, and secured.

Mandatory Fields​

  • Connection Name*
  • WSDL URL*
  • Service Name*
  • Port Name*
  • Authentication Type (None, Basic Auth, WS-Security, Certificate)*** [file:1]

SMTP Connection

Page/Section: Module-Connection-SMTP

The SMTP Connection handles outbound email notifications from LumenLink. Key fields:

  • Connection Name: Internal name for the SMTP configuration.
  • SMTP Server: Hostname or IP of the mail server.
  • Port: Port used for SMTP, such as 25, 465, or 587.

Email identity:

  • From Name: Display name shown to recipients.
  • From Email: Sender email address.
  • Reply-To Email: Optional address for replies.

Security and authentication:

  • Security Type: Dropdown indicating security mode such as None, SSL, or TLS.
  • Validate SSL Certificates: Toggle to enforce certificate validation.
  • Authentication Required: Toggle that, when enabled, indicates credentials are needed and exposes additional username and password fields.

Connection behavior:

  • Connection Timeout (ms): Maximum time to establish SMTP connection.
  • Socket Timeout (ms): Maximum time waiting on socket operations.
  • Max Connections: Upper limit of simultaneous SMTP connections.
  • Enable Debug Mode: Toggle that increases logging for troubleshooting mail delivery.

This configuration enables reliable email dispatch for alerts, notifications, and integration workflows.

Mandatory Fields​

  • Connection Name*
  • SMTP Server*
  • Port*
  • Security Type (None, TLS, SSL)*
  • From Email* [file:1]