User Guide › Platform Config › Connectors

1. Overview

The Connectors module allows administrators to configure external integrations that Contract intELIEgence uses to exchange data with other systems. Connectors are the bridge between the platform and external email servers, databases, and ERP systems.

There are three connector types, each serving a different purpose within the platform:

Prerequisites

• Organisation must be set up.
• For Email Connectors — email server credentials (host, port, username, password) or OAuth credentials (Client ID, Tenant ID, Client Secret).
• For Data Connectors — database server address, port, credentials, and the target database/table details.
• For Sage Connectors — Sage API endpoint URL and API key pairs for GET (pull) and PUSH (send) operations.

2. Connector Listing

1. In the left navigation, under Platform Config, click Connectors.
2. The Connectors List shows all configured connectors with their Name, Description, Connector Type (DATA or EMAIL), and Platform.
3. Use the filter dropdowns and Search button to locate a connector.
4. Click Add Connector to create a new connector.

Connector list

2.1 Listing Columns

3. Email Connector

The Email Connector connects Contract intELIEgence to an email server. It is used in the SLA module for Email type SLAs, where the system monitors an inbox to track email-based service level performance.

3.1 Auth Type: App Password

Use this authentication method when connecting with traditional email server credentials (SMTP/IMAP).

1. Click Add Connector.
2. Select Connector Type: Email Connector.
3. Select Auth Type: App Password.
4. Enter a Name (required) — a descriptive name for this connector.
5. Enter a Description — optional notes about the connector's purpose.
6. Enter the Email Host (required) — the mail server address (e.g. imap.gmail.com, outlook.office365.com).
7. Enter the Email Port (required) — the server port (e.g. 993 for IMAP SSL, 587 for SMTP TLS).
8. Enter the From Email Address Pattern — filter to process only emails from addresses matching this pattern.
9. Enter the Read Email From File — specify a file path to read emails from, if applicable.
10. Enter the Subject Pattern — filter to process only emails with subjects matching this pattern.
11. Enter the Username (required) — the email account username.
12. Enter the Password (required) — the email account password or app-specific password.
13. Click Test Connectivity to verify the connection before saving.
14. Click Save.

Connector-Email Connector-Authtype-App Password

3.2 Auth Type: Graph API (OAuth)

Use this authentication method when connecting via Microsoft Graph API with OAuth credentials. This is the recommended approach for Microsoft 365 / Outlook environments.

1. Click Add Connector.
2. Select Connector Type: Email Connector.
3. Select Auth Type: Graph Api.
4. Enter a Name (required) — a descriptive name for this connector.
5. Enter a Description — optional notes.
6. Enter the Client Id (required) — the OAuth application (client) ID from Azure AD.
7. Enter the Tenant Id (required) — the Azure AD tenant ID.
8. Enter the Client Secret (required) — the OAuth client secret.
9. Enter the From Email Address Pattern — filter for sender addresses.
10. Enter the Read Email From File — specify a file path if applicable.
11. Enter the Subject Pattern — filter for email subjects.
12. Enter the Username (required) — the mailbox to monitor.
13. Click Test Connectivity to verify the connection before saving.
14. Click Save.

Connector-Email Connector-Authtype-oauth

4. Data Connector

The Data Connector connects Contract intELIEgence to an external database. It is used across multiple modules: KPI tracking (Data type SLAs), Performance Tracker, Cost Tracker (via Customer), and Contract Transaction imports.

4.1 Creating a Data Connector

The Data Connector uses a two-step process — first connect to the database server, then select the specific database and table.

Step 1 — Enter Connection Details:

1. Click Add Connector.
2. Select Connector Type: Data Connector.
3. Enter a Name (required) — a descriptive name for this connector.
4. Select a Platform (required) — the platform type, sourced from Catalogs → Platform Type (e.g. Document Management).
5. Enter the Server/URL (required) — the database server address (e.g. IP address or hostname).
6. Enter the Port (required) — the database server port (e.g. 3306 for MySQL, 1433 for MSSQL, 1521 for Oracle).
7. Enter a Description — optional notes.
8. Select the Database Type (required) — MySql, MSSql, or Oracle.
9. Enter the Username (required) — database login username.
10. Enter the Password (required) — database login password.
11. Click Connect.

Step 2 — Select Database and Table:

Once the connection is established successfully (indicated by a green "connected to database" message), two additional dropdowns appear:

1. Select the Instance/Database (required) — the specific database on the server.
2. Select the Table (required) — the specific table to read data from.
3. Click Save.

Connector-Data Connector

4.2 Supported Database Types

5. Sage Connector

The Sage Connector integrates Contract intELIEgence with Sage ERP systems. It supports two-way data exchange: pulling (GET) suppliers and transactions from Sage into Contract intELIEgence, and pushing (PUSH) contract and supplier information back to Sage.

The default Sage connectors for supplier sync and transaction sync are configured in Organisation → Settings (Default Supplier Connector and Default Transaction Connector fields).

5.1 Sage Versions

Two Sage versions are supported, each with a slightly different form:

5.2 Creating a Sage 200 Connector

1. Click Add Connector.
2. Select Connector Type: Sage Connector.
3. Select Sage Version: Sage 200.
4. Enter a Name (required) — a descriptive name for this integration.
5. Enter a Description — notes about the integration (e.g. "IPPO INTEGRATION: iserve & Sage ERP 200").
6. Enter the Error Notification Email — email address to receive alerts when the integration encounters errors.
7. Select the Error Notification Message — the notification template to use for error alerts (from Notification module).
8. Enter the Server/URL (required) — the Sage API endpoint URL.
9. Enter the Port — the API port if applicable.
10. Enter the GET API Key Name (required) and GET API Key Value (required) — the API key pair for pulling data from Sage into Contract intELIEgence.
11. Enter the PUSH API Key Name (required) and PUSH API Key Value (required) — the API key pair for sending data from Contract intELIEgence to Sage.
12. Enter the Identifier (required) — a unique identifier for this Sage instance.
13. Click Ping to verify the connection. A green "Ping Successful" message confirms connectivity.
14. Click Save.

Connector - Sage - 200

5.3 Creating a Sage X3 Connector

The Sage X3 form is similar to Sage 200 but does not include the Port and Identifier fields.

1. Click Add Connector.
2. Select Connector Type: Sage Connector.
3. Select Sage Version: Sage X3.
4. Enter a Name (required).
5. Enter a Description.
6. Enter the Error Notification Email and select the Error Notification Message.
7. Enter the Server/URL (required).
8. Enter the GET API Key Name (required) and GET API Key Value (required).
9. Enter the PUSH API Key Name (required) and PUSH API Key Value (required).
10. Click Ping to verify the connection.
11. Click Save.

Connector - Sage - X3

6. Connection Testing

Each connector type has a built-in connectivity test to verify the configuration before saving:

7. Tips

• Always test connectivity (Test Connectivity / Connect / Ping) before saving to catch configuration errors early.
• Use descriptive names for connectors — especially when multiple connectors of the same type exist (e.g. "Sales DB - Transaction Import" vs "Support DB - Cost Tracker").
• For Email Connectors, use the From Email Address Pattern and Subject Pattern to limit which emails are processed — this avoids irrelevant emails triggering SLA updates.
• For Data Connectors, ensure the database user has read permissions on the target table. Write permissions are not required.
• For Sage Connectors, configure the default supplier and transaction connectors in Organisation → Settings after creating the Sage connector.
• Use the Error Notification Email on Sage Connectors to proactively monitor integration health — this sends alerts when sync operations fail.
• Platform Type for Data Connectors comes from Catalogs — ensure the required platform types are configured before creating connectors.

8. Troubleshooting