# Allscripts

This article describes the integration with the Allscripts connector, enabling streamlined metadata management through crawling, profiling, data preview, and manual lineage. It also secures authentication via Credential Manager.

<figure><img src="https://content.gitbook.com/content/ztcvwwOJCeaE1n6oHp4C/blobs/cB2ChJlT9SAe5A37ZX4F/unknown.png" alt=""><figcaption></figcaption></figure>

## Overview

### Connector Details

| Connector Category                                                             | Application |
| ------------------------------------------------------------------------------ | ----------- |
| Connector Version                                                              | Release7.2  |
| Releases Supported (Available from)                                            | Release6.3  |
| <p>Connectivity</p><p>\[How the connection is established with Allscripts]</p> | JDBC        |

### Connector Features

| Feature                                      | Availability |
| -------------------------------------------- | :----------: |
| Crawling                                     |       ✅      |
| Delta Crawling                               |       ❌      |
| Profiling                                    |       ✅      |
| Query Sheet                                  |       ❌      |
| Data Preview                                 |       ✅      |
| Auto Lineage                                 |       ❌      |
| Manual Lineage                               |       ✅      |
| Secure Authentication via Credential Manager |       ✅      |
| Data Quality                                 |       ❌      |
| DAM (Data Access Management)                 |       ❌      |
| Bridge                                       |       ✅      |

### Metadata Mapping

The following objects are crawled from the Allscripts and mapped to the corresponding UI assets.

<table><thead><tr><th width="158.333251953125">Allscripts Object</th><th width="171">Allscripts Attribute</th><th width="173.6666259765625">OvalEdge Attribute</th><th width="176">OvalEdge Category</th><th width="145.3333740234375">OvalEdge Type</th></tr></thead><tbody><tr><td>Schema</td><td>Schema_Name</td><td>Schema</td><td>Schemas</td><td>Schema</td></tr><tr><td>Table</td><td>Table_Name</td><td>Table</td><td>Tables</td><td>Table</td></tr><tr><td>Table</td><td>Description</td><td>Description</td><td>Tables</td><td>Description</td></tr><tr><td>Table</td><td>Table_Type</td><td>Table Type</td><td>Tables</td><td>Table_Type</td></tr><tr><td>Column</td><td>Column_Name</td><td>Column</td><td>Columns</td><td>Column</td></tr><tr><td>Column</td><td>Data_Type</td><td>Data Type</td><td>Columns</td><td>Data_Type</td></tr><tr><td>Column</td><td>Character_Maximum_Length</td><td>Length</td><td>Columns</td><td>Length</td></tr><tr><td>Column</td><td>Ordinal_Position</td><td>Position</td><td>Columns</td><td>Position</td></tr><tr><td>Column</td><td>Description</td><td>Description</td><td>Columns</td><td>Description</td></tr><tr><td>View</td><td>Table_Name</td><td>View Name</td><td>Views</td><td>View_Name</td></tr><tr><td>View</td><td>View_Definition</td><td>View Definition</td><td>Views</td><td>View_Definition</td></tr><tr><td>View</td><td>Description</td><td>Description</td><td>Views</td><td>Description</td></tr></tbody></table>

## Set up a Connection

### Prerequisites

The prerequisites to establish a connection:

### **Whitelisting Ports**

Whitelist the inbound port to allow OvalEdge to connect to the Allscripts Server database.

{% hint style="warning" %}
When any port is configured, specify the port number during connection setup, whitelist the port, and establish proper communication between the system and the Allscripts Server.
{% endhint %}

### Service Account User Permissions

{% hint style="warning" %}
Use a dedicated service account to establish the connection to the data source, configured with the following minimum set of permissions.
{% endhint %}

{% hint style="info" %}
**👨‍💻 Who can provide these permissions?** The Allscripts administrator grants these permissions, as standard accounts may not have the required access to assign them independently.
{% endhint %}

<table><thead><tr><th>Objects</th><th width="273.888916015625">System Tables</th><th>Access Permission</th></tr></thead><tbody><tr><td>Schema</td><td>Information_Schema.Schemata</td><td>Select</td></tr><tr><td>Tables</td><td>Information_Schema.Tables</td><td>Select</td></tr><tr><td>Columns</td><td>Information_Schema.Columns</td><td>Select</td></tr><tr><td>Views</td><td>Information_Schema.Views</td><td>Select</td></tr></tbody></table>

### Connection Configuration Steps

{% hint style="warning" %}
Users must have the Connector Creator role to configure a new connection.
{% endhint %}

1. Log in to OvalEdge, go to Administration > Connectors, click + **(New Connector)**, search for **Allscripts**, and complete the required parameters.

{% hint style="info" %}
Fields marked with an asterisk (\*) are mandatory for establishing a connection.
{% endhint %}

<table><thead><tr><th width="220.6666259765625">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "Allscripts" is displayed as the selected connector type.</td></tr><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selection.</p><p>Supported Credential Managers:</p><ul><li>Database</li><li>HashiCorp</li><li>AWS Secrets Manager</li><li>Azure Key Vault</li></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the Allscripts connection              </p><p>(Example: "Allscripts_Prod").</p></td></tr><tr><td>Connector Environment</td><td>Select the environment (Example: PROD, STG) configured for the connector.</td></tr><tr><td>Connector Description</td><td>Enter the description related to the connector.</td></tr><tr><td>Server*</td><td>Enter the IP address of the server where Allscripts is hosted.</td></tr><tr><td>Port*</td><td>Enter the required port number.</td></tr><tr><td>Name Space*</td><td>Enter the namespace associated with the Allscripts FHIR API environment. This value identifies the specific API domain or tenant used for data access and validation.</td></tr><tr><td>Driver*</td><td>By default, Allscripts uses ‘com.intersys.jdbc.CacheDriver.’ This field is not editable.</td></tr><tr><td>Username* </td><td>Enter the Username for the  Allscripts server.</td></tr><tr><td>Password* </td><td>Enter the Password associated with the Allscripts Username.</td></tr><tr><td>Connection String</td><td><p>Configure the connection string for the Allscripts server:</p><ul><li>Automatic Mode: The system generates a connection string based on the provided credentials.</li><li>Manual Mode: Enter a valid connection string manually.</li></ul><p>Replace placeholders with actual server details:</p><ul><li>{server} refers to the Impala host or IP address.</li><li>{sid} refers to the database name (schema).</li></ul><p>Authentication Plugins:<br>jdbc:Cache://{server}:{port}/{sid}</p><p>This is the default authentication string used for connecting to the Allscripts database. </p></td></tr><tr><td>Plugin Server</td><td>Enter the server name when running as a plugin server.</td></tr><tr><td>Plugin Port</td><td>Enter the port number on which the plugin is running.</td></tr></tbody></table>

**Default Governance Roles**

<table data-header-hidden><thead><tr><th width="220.6666259765625"></th><th></th></tr></thead><tbody><tr><td>Default Governance Roles*</td><td>Select the appropriate users or teams for each governance role from the drop-down list. All users and teams configured in OvalEdge Security are displayed for selection.</td></tr></tbody></table>

**Admin Roles**

<table data-header-hidden><thead><tr><th width="220.666748046875"></th><th></th></tr></thead><tbody><tr><td>Admin Roles*</td><td>Select one or more users from the dropdown list for Integration Admin and Security &#x26; Governance Admin. All users configured in OvalEdge Security are available for selection.</td></tr></tbody></table>

**No of Archive Objects**

<table data-header-hidden><thead><tr><th width="220.6666259765625"></th><th></th></tr></thead><tbody><tr><td>No Of Archive Objects*</td><td><p>This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive.</p><p>Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.</p></td></tr></tbody></table>

**Bridge**

<table data-header-hidden><thead><tr><th width="220.6666259765625"></th><th></th></tr></thead><tbody><tr><td>Select Bridge*</td><td><p>If applicable, select the bridge from the drop-down list.</p><p>The drop-down list displays all active bridges configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering firewall rules.</p></td></tr></tbody></table>

2. After entering all connection details, the following actions can be performed:
   * Click **Validate** to verify the connection.
   * Click **Save** to store the connection for future use.
   * Click **Save & Configure** to apply additional settings before saving.
3. The saved connection will appear on the Connectors home page.

## Manage Connector Operations

### Crawl/Profile

{% hint style="info" %}
To perform crawl and profile operations, users must be assigned the Integration Admin role.
{% endhint %}

The **Crawl/Profile** button allows users to select one or more schemas for crawling and profiling.&#x20;

1. Navigate to the Connectors page and click **Crawl/Profile**.
2. Select the schemas to crawl.
3. The **Crawl** option is selected by default. Click the **Crawl & Profile** radio button to enable both operations.
4. Click **Run** to collect metadata from the connected source and load it into the **Data Catalog**.
5. After a successful crawl, the information appears in the **Data Catalog > Databases** tab.

The **Schedule** checkbox allows automated crawling and profiling at defined intervals, from a minute to a year.

1. Click the **Schedule** checkbox to enable the **Select Period** drop-down.
2. Select a time period for the operation from the drop-down menu.
3. Click **Schedule** to initiate metadata collection from the connected source.
4. The system will automatically execute the selected operation (**Crawl** or **Crawl & Profile**) at the scheduled time.

### Other Operations

The **Connectors page** in OvalEdge provides a centralized view of all configured connectors, including their health status.

**Managing connectors includes:**

* **Connectors Health**: Displays the current status of each connector, with a green icon for active connections and a red icon for inactive connections, helping monitor connectivity to data sources.
* **Viewing**: Click the **Eye** icon next to the connector name to view connector details, including Tables, Views, and Columns.&#x20;

**Nine Dots Menu Options:**

To view, edit, validate, configure, or delete connectors, click on the Nine Dots menu.

* **Edit Connector**: Update and revalidate the data source.
* **Validate Connector**: Check the integrity of the connection.
* **Settings**: Modify connector settings.
  * **Crawler**: Configure data extraction.
  * **Profiler**: Customize data profiling rules and methods.
  * **Access Instructions**: Add notes on how data can be accessed.
  * **Business Glossary Settings**: Manage term associations at the connector level.
  * **Others**: Configure notification recipients for metadata changes.
* **Delete Connector**: Remove a connector with confirmation.

### Connectivity Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

<table><thead><tr><th width="83.66668701171875">S.No.</th><th>Error Message(s)</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Error while saving Database Connection : Cannot invoke "java.util.Map.get(Object)" because "types" is null</td><td><p>Error Description: The system failed to save the database connection because the internal parameter map (types) was not initialized during the connection setup.</p><p>Resolution: Verify the connector configuration to ensure all required fields are populated and retry saving. If the issue persists, restart the service and check the logs for missing parameter initialization.</p></td></tr></tbody></table>

***

Copyright © 2025, OvalEdge LLC, Peachtree Corners, GA, USA.