Skip to main content
This section provides guides and references to use the IBM Informix connector. Configure and schedule Informix metadata and profiler workflows from the Collate UI:
Note: This connector is available exclusively in Collate and is not part of the open-source OpenMetadata distribution.

Requirements

Metadata

To extract metadata, the user used in the connection needs to have access to the Informix system catalogs. By default, a user can see only the rows in the system catalogs that correspond to objects for which the user has the proper access privileges.

Lineage and Usage

To extract lineage and usage, you need to enable SQL tracing in Informix and the user used in the connection needs to have SELECT access to the sysmaster:syssqltrace table.
SQLTRACE Levels:
  • 0 — Disabled (no query capture)
  • 1 — Captures queries exceeding a threshold
  • 2 — Captures all DDL and DML statements (recommended for lineage)
  • 3 — Full trace including all queries
Note: Enabling SQL tracing at level 2 or 3 may increase disk I/O. Monitor your syssqltrace table size and periodically flush old entries using ONMODE -Y 0 to disable, truncate, then re-enable. You can check the current SQLTRACE status by running:
Best Practices:
  • Use SQLTRACE level 2 for a balance of coverage and performance
  • Periodically flush the syssqltrace table after successful lineage/usage extraction
  • Keep SQLTRACE enabled only as long as needed if performance impact is a concern

Profiler and Data Quality

Executing the profiler workflow or data quality tests will require the user to have SELECT permission on the tables/schemas where the profiler/tests will be executed. More information on the profiler workflow setup can be found here and data quality tests here.

Metadata Ingestion

To ingest metadata from Informix, you need to create a service connection. The service connects Informix with Collate. Once you create a service, Collate automatically starts ingesting metadata.

Step 1: Add New Service

  1. In the left navigation, click Connections.
  2. On the Connections page, click Add New Service.
Add New Service

Step 2: Select a Service and Connector

From the service type dropdown, select Database Services, then click the Informix connector tile. Select Service

Step 3: Add Service Name and Description

  • Enter a unique, descriptive Service Name. Collate identifies services by their service name. Enter a name that distinguishes this deployment from other Informix services you are ingesting metadata from.
  • Optional: Enter a Description for the service.
Add New Service Name
Note: The service name cannot be changed after it is set.

Step 4: Configure Connection Options

Specify where ingestion runs, provide your source credentials, and verify the connection.

Select Ingestion Runner

Select an Ingestion Runner: the runner where the ingestion pipeline will execute. Add Name and Select Ingestion Runner

Enter Connection Details

Enter the connection details for Informix. The right-hand panel in the UI displays inline help for each field. Configure Service Connection
  • Username: Specify the User to connect to Informix. It should have enough privileges to read all the metadata.
  • Password: Password to connect to Informix.
  • Host and Port: Enter the fully qualified hostname and port number for your Informix deployment in the Host and Port field. For example: localhost:9088. If you are running ingestion inside Docker and your Informix instance is on the host machine, use host.docker.internal:9088.
  • Database: The name of the Informix database to connect to. This is a required field.
  • Server Name: The Informix server name as defined in the sqlhosts file or the INFORMIXSERVER environment variable. This identifies the specific Informix server instance to connect to. For example: informix.
  • Ingest All Databases: Enable this toggle to ingest metadata from all databases on the Informix server. When disabled (default), only the database specified above will be ingested. You can use databaseFilterPattern on top of this setting to further filter databases.
  • SSL Mode: Choose the SSL mode for the connection:
    • disable — No SSL encryption; the connection is unencrypted (default).
    • allow — Uses SSL if the server requires it, otherwise connects without SSL.
    • prefer — Prefers SSL but falls back to unencrypted if the server does not support it.
    • require — Enforces SSL encryption but does not verify the server certificate.
    • verify-ca — Enforces SSL and validates the server certificate against the provided CA certificate.
    • verify-full — Enforces SSL, validates the server certificate, and verifies the hostname.
  • SSL Configuration: SSL configuration details. Provide the CA certificate to validate the Informix server certificate. You can paste the PEM content directly or upload the certificate file. This is required when SSL Mode is set to verify-ca or verify-full.
    • CA Certificate: The CA certificate used for SSL validation.
    • SSL Certificate: The SSL certificate used for client authentication (for mutual TLS).
    • SSL Key: The private key associated with the SSL certificate (for mutual TLS).

Advanced Configuration

Database Services have an Advanced Configuration section, where you can pass extra arguments to the connector and, if needed, change the connection Scheme. This would only be required to handle advanced connectivity scenarios or customizations.
  • Connection Options (Optional): Enter the details for any additional connection options that can be sent to database during the connection. These details must be added as Key-Value pairs.
  • Connection Arguments (Optional): Enter the details for any additional connection arguments such as security or protocol configs that can be sent during the connection. These details must be added as Key-Value pairs.
Tip: When using a Hybrid Ingestion Runner, any sensitive credential fields—such as passwords, API keys, or private keys—must reference secrets using the following format:
This applies only to fields marked as secrets in the connection form (these typically mask input and show a visibility toggle icon). For more information about managing secrets in hybrid setups, see the Hybrid Ingestion Runner Secret Management Guide

Test Connection

Once the credentials have been added, click on Test Connection and Save the changes. Test Connection

Step 5: Configure Ingestion Options

In the What to Ingest step, use filter patterns to control which assets Collate ingests from your database service. Filter patterns use regular expressions applied to asset names.

How Filter Patterns Work

  • Include: Add one or more comma-separated regular expressions. Collate ingests only assets whose names match at least one expression. Leave blank to include all assets.
  • Exclude: Add one or more comma-separated regular expressions. Collate skips any asset whose name matches an expression. Leave blank to exclude nothing.
Rules match asset names using one of five expressions:
  • contains: matches any name containing the value. For example, sales matches my_sales_data and sales_2024.
  • starts with: matches names beginning with the value. For example, prod_ matches prod_db and prod_schema.
  • ends with: matches names ending with the value. For example, _raw matches events_raw and logs_raw.
  • is exactly: matches the exact name only. For example, analytics matches only analytics.
  • matches regex: matches names using a regular expression. For example, ^prod_.*_v\d+$ matches prod_events_v1.
When both Include and Exclude are set, Exclude takes priority.
Tip: Leave all filter patterns empty to ingest all databases, schemas, and tables available in the source.
Filter Options The Database, Schema, Table, and Stored Procedure sections each include the following filter options:
  • Database: Controls which databases Collate ingests from the source.
  • Schema: Controls which schemas within the ingested databases are included.
  • Table: Controls which tables and views within the ingested schemas are included.
  • Stored Procedure: Controls which stored procedures are included in metadata ingestion.
Each section provides the following controls:
  • Scan Mode: You can choose between the following scan modes:
    • Scan all: Ingests every asset of that type the connector can access. This is the default.
    • Only specific: Enables include rules so only assets matching at least one rule are ingested.
  • Exclude system toggle: Use this toggle to automatically filter out system-reserved names defined by the connector — for example, Exclude system databases for the Databases section.
  • Always exclude: Add permanent exclusion rules (shown in red). Assets matching these rules are never ingested, regardless of include rules.
  • Preview: Shows a real-time summary of what will be in scope based on your current rules.
  • Include rules (available only in Only specific mode): Click + Add to define a rule. Added rules appear as chips; an asset is included if it matches any rule.
Tip: If AutoPilot is enabled, usage tracking, data lineage, and other downstream workflows start automatically after the first metadata ingestion completes.

Step 6: Create & Deploy

Click Create & Deploy to deploy the agent and start the first metadata ingestion run. Collate saves the service configuration and immediately begins pulling metadata from the source. To monitor ingestion progress or view the service you just added, go to Connections in the left navigation and select your service.

Configure Metadata Agent and Schedule Ingestion

The Metadata Agent extracts schemas, tables, columns, and other structural metadata from your source and keeps your Collate catalog in sync. It powers discovery, lineage, and governance across your data assets. When you click Create & Deploy, Collate automatically deploys a Metadata Agent for this service and triggers the first ingestion run. View its status and run history from the Agents tab on the service detail page. To configure the additional Metadata Agent and schedule ingestion, follow these steps:
  1. In the left navigation, click Connections and select your service.
  2. Click the Agents tab.
  3. Click Add Agent and select Metadata from the dropdown. Add Metadata Agent For some services, the dropdown is not available and clicking Add Agent takes you directly to the agent configuration page.
  4. On the Configure Ingestion page, do the following and click Next.
    • Name this Ingestion: Enter a unique recognizable name for this ingestion pipeline. Name this Ingestion
    • Agent Setup: Configure core parameters for metadata extraction. The following fields are available: Agent Setup
    • Filter Patterns: Apply include or exclude rules to scope which databases, schemas, tables, and stored procedures this agent ingests. For more information about various filter options, see Step 5: Configure Ingestion Options. Filter Patterns
    • Scope & Behaviour: Control how the agent handles metadata during ingestion. Toggle each option on or off based on your needs:
      Note: Available toggles vary by connector. Stored procedure options only appear for connectors that support stored procedures.
      Scope & Behaviour
    • Advanced Config: Optional connector-specific settings such as Include Views and Extract JSON Schema. Advanced Config
  5. On the Schedule Interval page, set when the agent runs:
    • Schedule: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression.
    • On-Demand: No automatic schedule; trigger the agent manually when needed.
    Schedule Interval
  6. Click Add to deploy the agent.

Securing Informix Connection with SSL in Collate

To establish secure connections between Collate and Informix, first set the SSL Mode in the connection form, then navigate to the SSL Configuration section. The SSL mode controls how the connection is encrypted and whether certificates are verified:
  • For require mode: SSL encryption is enforced but the server certificate is not validated. No certificate configuration is needed.
  • For verify-ca mode: SSL encryption is enforced and the server certificate is validated against the provided CA certificate. Provide the caCertificate in the SSL Configuration section.
  • For mutual TLS (client and server authentication): Provide all three parameters — caCertificate (CA certificate to validate the server), sslCertificate (client SSL certificate), and sslKey (private key for the client certificate).
SSL Configuration

Troubleshooting

Informix Troubleshooting

Learn more about how to troubleshoot common Informix connector issues and resolve configuration or ingestion errors.