Print

Configuring EA GraphLink in Genie 

Overview 

EA GraphLink serves as the connection layer between Genie and the Sparx Systems Enterprise Architect (EA) database. It enables Genie to interpret user prompts and retrieve model data accurately through a secure graph-based API. 

Configuring EA GraphLink in Genie is a mandatory setup that allows all EA-related queries, such as fetching elements, relationships, or diagrams, to be routed through this layer for seamless integration and reliable data access. 

When configured, Genie Chat can: 

  • Retrieve EA model information in real time 
  • Provide accurate and context-aware model details in responses 
  • Generate Prolaborate hyperlinks in chat responses for EA artifacts when the Prolaborate URL is configured 

 Prerequisites

Before starting the configuration, ensure the following details are available: 

  • API access credentials (API URL and Access Token) from an actively running EA GraphLink instance. 
  • Prolaborate Base URL and Repository ID if Prolaborate integration and hyperlink generation are required 
  • Please ensure that the Genie runs on either the domain or localhost. If it runs on the domain, it must be added to the “Allowed External Hosts” list in the Management Portal. This is not required if it is running on localhost.
 EA GraphLink

Accessing EA GraphLink Configuration in Genie

1. Log in to Genie using an Admin account. Initially, the admin can use the Configure button as shown in the image below.

Configure button

2. To update or add a new GraphLink profile, navigate to Configuration → GraphLink

ea-graphlink-menu

3. Click  “Add GraphLink” to create a new profile. 

Add GraphLink
  1. To modify an existing GraphLink profile, click the Edit icon next to the desired entry. 
edit-added-ea-graphlink-model

Adding an EA GraphLink Profile 

adding-new-ea-graphlink-model-details
Field Description 
Name A user-defined name to identify the EA GraphLink profile within Genie. 
GraphLink Endpoint The API URL where Genie sends queries to the EA GraphLink service. 
Token A secure access token used to authenticate and authorize requests. 
Set as default Enable this option to make the profile the default connection for all users. 

Tip: Copy the Endpoint URL and Access Token directly from your EA GraphLink instance to ensure accuracy and avoid configuration errors. 

Optional: Configuring Prolaborate 

To enable Genie to include Prolaborate hyperlinks in chat responses, configure the following: 

Field Description 
Prolaborate URL The base URL of your Prolaborate instance. 
Repository ID A unique ID identifying the EA repository within Prolaborate 

Note: This step is optional but recommended, as it enhances context and improves overall usability within Genie responses.  

Verifying the Configuration 

  1. Click “Save” after entering all required details. 
  1. Once the profile is successfully added, the Genie Chat page will open without the configuration pop-up that appeared earlier. 
  1. If Prolaborate is configured, verify that hyperlinks are generated correctly for a sample artifact. 

Configuring Training Data for an EA GraphLink Profile  

Overview 

Training data helps Genie better understand the context and structure of your EA models by providing domain-specific examples, patterns, and keywords. When you add training data to an EA GraphLink profile, Genie learns how to interpret queries more accurately and deliver context-aware responses aligned with your enterprise model. 

This feature allows administrators to define and manage curated datasets that improve the precision and relevance of Genie’s answers for that specific EA GraphLink profile. 

Accessing Training Data Configuration 

Training data can be added in two ways within Genie: 

Approach 1: Ea Graphlink Manage Icon 

GraphLink → Manage (GraphLink Profile List) 

  • Click the Manage icon for the desired GraphLink profile to open the Model Explorer settings, where training data can be configured. 
manage-gear-icon

Approach 2: From Model Explorer 

  • From the bottom-left corner of the Genie chat page, select Configuration
configuration-button
  • Under the Agents section, select Model Explorer
  • On the Model Explorer page, click Add Training Data
Add training data

Query Explorer 

Query Explorer provides a user-friendly interface to interact with the Enterprise Architect Repository. It enables the creation of custom queries to retrieve and analyze data. 

  • Once you click Add Training Data, the following screen will appear. 
train-ea-model-after-add-traning-data-button

Key Functionality 

  • Retrieves sparx EA model details linked to conversation results 

Usage Flow 

  1. Add the required query through EA GraphLink 
  1. Open the Genie chat page 
  1. Locate and select Model Explorer agent icon to view associated data 
model-explorer-icon-on-chat
  1. When the Model Explorer agent icon is selected, the Genie chat responses are generated using only the tools available within the selected model, as intended. 
selected-model-explorer-from-chat

Subscribe to our Newsletter

Marketing Subscription Form
Tags: