Developer Guide

 

This guide describes options and advanced techniques for customizing capabilities of TopBraid EDG. The target audience for this guide are advanced users, administrators, and developers who have working understanding of semantic standards, software development and development tools including the TopBraid Composer – Maestro Edition (TBC-ME). Documentation for TBC-ME is available directly in the help menu of TBC-ME application or online here

In general, any product modifications or extensions should be developed in a non-production environment and thoroughly tested under relevant conditions before deploying into production. This guide is for advanced users who are able to support the changes they make and adjust them at upgrade time. 

If you need further help for tailoring TopBraid EDG to better suit your needs, please contact TopQuadrant to explore the following options:

  • Having TopQuadrant quickly configure a customized EDG solution to meet your detailed requirements. We will be pleased to quote and provide affordable customization and tailoring services.

  • Enabling your organization to develop and maintain customizations for EDG by guiding and training your selected personnel to perform the variety of customization capabilities.

EDG Integration Points

For dynamic integration with other systems, EDG offers these options for developers. Such as GraphQL, SPARQL, Available Web Services. 

EDG Integration Scenario Examples

This section provides sample scenarios for integrating external systems with TopBraid EDG. 

Application Configuration

This section illustrates some of the ways that EDG can be extended to customize the user experience.

Teamwork Framework and Workflows

This guide explains the development and runtime framework called TopBraid Teamwork Framework as well as how to customize Governance Model and Workflows for TopBraid EDG.

Customizing EDG Ontologies

Users of EDG can extend and configure the ontology models shipped with EDG. The models use SHACL to represent property constraints (e.g., datatypes) as well as to represent general display information such as how property fields are grouped, ordered and described. 

Scheduled Jobs

TopBraid EDG includes a mechanism for running SWP scripts on a schedule to automate recurring tasks. This guide gives example use cases. 

Preparing RDF Data for Loading into EDG

If you already have data in RDF format, this section of the guide will help you load it into EDG.