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.
Overview
Connector Details
Connector Category
Application
Connector Version
Release7.2
Releases Supported (Available from)
Release6.3
Connectivity
[How the connection is established with Allscripts]
JDBC
Connector Features
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.
Schema
Schema_Name
Schema
Schemas
Schema
Table
Table_Name
Table
Tables
Table
Table
Description
Description
Tables
Description
Table
Table_Type
Table Type
Tables
Table_Type
Column
Column_Name
Column
Columns
Column
Column
Data_Type
Data Type
Columns
Data_Type
Column
Character_Maximum_Length
Length
Columns
Length
Column
Ordinal_Position
Position
Columns
Position
Column
Description
Description
Columns
Description
View
Table_Name
View Name
Views
View_Name
View
View_Definition
View Definition
Views
View_Definition
View
Description
Description
Views
Description
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.
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.
Service Account User Permissions
Use a dedicated service account to establish the connection to the data source, configured with the following minimum set of permissions.
Schema
Information_Schema.Schemata
Select
Tables
Information_Schema.Tables
Select
Columns
Information_Schema.Columns
Select
Views
Information_Schema.Views
Select
Connection Configuration Steps
Users must have the Connector Creator role to configure a new connection.
Log in to OvalEdge, go to Administration > Connectors, click + (New Connector), search for Allscripts, and complete the required parameters.
Connector Type
By default, "Allscripts" is displayed as the selected connector type.
Credential Manager*
Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selection.
Supported Credential Managers:
Database
HashiCorp
AWS Secrets Manager
Azure Key Vault
Connector Name*
Enter a unique name for the Allscripts connection
(Example: "Allscripts_Prod").
Connector Environment
Select the environment (Example: PROD, STG) configured for the connector.
Connector Description
Enter the description related to the connector.
Server*
Enter the IP address of the server where Allscripts is hosted.
Port*
Enter the required port number.
Name Space*
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.
Driver*
By default, Allscripts uses ‘com.intersys.jdbc.CacheDriver.’ This field is not editable.
Username*
Enter the Username for the Allscripts server.
Password*
Enter the Password associated with the Allscripts Username.
Connection String
Configure the connection string for the Allscripts server:
Automatic Mode: The system generates a connection string based on the provided credentials.
Manual Mode: Enter a valid connection string manually.
Replace placeholders with actual server details:
{server} refers to the Impala host or IP address.
{sid} refers to the database name (schema).
Authentication Plugins: jdbc:Cache://{server}:{port}/{sid}
This is the default authentication string used for connecting to the Allscripts database.
Plugin Server
Enter the server name when running as a plugin server.
Plugin Port
Enter the port number on which the plugin is running.
Default Governance Roles
Default Governance Roles*
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.
Admin Roles
Admin Roles*
Select one or more users from the dropdown list for Integration Admin and Security & Governance Admin. All users configured in OvalEdge Security are available for selection.
No of Archive Objects
No Of Archive Objects*
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.
Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.
Bridge
Select Bridge*
If applicable, select the bridge from the drop-down list.
The drop-down list displays all active bridges configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering firewall rules.
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.
The saved connection will appear on the Connectors home page.
Manage Connector Operations
Crawl/Profile
The Crawl/Profile button allows users to select one or more schemas for crawling and profiling.
Navigate to the Connectors page and click Crawl/Profile.
Select the schemas to crawl.
The Crawl option is selected by default. Click the Crawl & Profile radio button to enable both operations.
Click Run to collect metadata from the connected source and load it into the Data Catalog.
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.
Click the Schedule checkbox to enable the Select Period drop-down.
Select a time period for the operation from the drop-down menu.
Click Schedule to initiate metadata collection from the connected source.
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.
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.
1
Error while saving Database Connection : Cannot invoke "java.util.Map.get(Object)" because "types" is null
Error Description: The system failed to save the database connection because the internal parameter map (types) was not initialized during the connection setup.
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.
Copyright © 2025, OvalEdge LLC, Peachtree Corners, GA, USA.
Last updated
Was this helpful?