Setup

Server Configuration Parameters

 

Server Configuration Parameters page contains the main systems-related settings for EDG. Administrators can update the section via its Edit button and ensuring to click Save Changes when finished.

Server Parameters

Parameter Default Description
Server URL

This URL should be the EDG web-application’s own context path, without a trailing slash “/”. It enables email notifications with “live” EDG-server links (back to the webapp) for governance events or for tasks. For example, for the EDG (Tomcat) server, it would be something like: http://serverhostname/edg

For TopBraid Composer – Maestro Edition, it would be: http://localhost/:8083

Show Hidden Files false During data selection, show all the files that are present on each project.

GraphQL Features

Parameter Default Description
Enable aggregation fields false True to activate _count and _concat aggregation fields for the TopBraid GraphQL services.
Enable derive fields false True to activate deriveXY fileds for the TopBraid GraphQL services.

SWP Parameters

Parameter Default Description
ui label function URI false The URI of a SPARQL function that takes a resource as argument and returns a string representation. If set, this will be used whenever ui:label is called, making it possible to define custom label algorithms in a single place.
ui:lib function is constant false True to have ui:lib() always return the static value “lib”.
maximum number of table rows 1000 The maximum number of rows to be displayed by (search results) table widgets
Enable debug mode  false True to activate debug mode (for ui:debug etc). 
Generate <!– … –> comments  false True to preserve <!– … –> comments in the output. 
Inject swpsource attributes false True to inject swpsource attributes for debugging in (HTML/XML) source code.
Trace dynamic views false True to trace the actual SWP elements used by ui:classView and ui:resourceView in the log.

URI mappings

Parameter Default Description
Short Graph name A tuple consisting of a graph (URI) and a short name. Can be used to abbreviate graphs in servlet calls. For example the SPIN template servlet handles abbreviated names such as /tbl/template/swa/GetResourceValues/kennedys?… If you want to address the kennedys ontology with that URL, you need to add a short graph name that associates http://topbraid.org/examples/kennedys with the name “kennedys”.

Advanced Parameters

Parameter Default Description
Allow Anonymous Access false If no authentication scheme is used and this flag is true, anonymous access with READ and EXECUTE permission is allowed to the application.
Teamwork Administrator Role none This special teamwork role (viewer, manager, editor) controls the ability to modify workflow types by downloading and uploading the Workflow Templates file.  Assign a security role (such as from LDAP) here.
Enable SPARQL updates false If true, then the SPARQL end point (servlet) will allow update requests.
Timeout on SPARQL Endpoint If not set or 0, SPARQL endpoint has no timeout. Timeout is in milliseconds. If the timeout is reached, the system will throw a CancelQueryException to the user.
Enable Fair Locks true If true, then locks taken by TBL will use a first in first out queue, if false then order is less predictable.
Longer Stack Traces false Create longer stack traces, adding very large overhead. These are very useful for rapid resolution of certain types of problems. Set this parameter only if requested by TopQuadrant Customer Support.
Fail With Error on Design Inconsistency false When a possible software design inconsistency is detected, fail with an error.
Disable Auto-Complete Index false If true, disables the in-memory auto-complete index.  If set to true, startup time will be faster and memory consumption will be less. However, some auto-complete operations (input fields where you start typing and then suggest matching instances) will be slower and may deliver incomplete results because requests will time out after 5 seconds.
OWL-to-SHACL rules graph  none The URI of a named graph to use for the OWL-to-SHACL conversion features. Defaults to the graph stored in the file TopBraid/SHACL/owl2shacl.ttl. To restore that default, reset it to http://datashapes.org/owl2shacl instead of just deleting the value.
Enable SPARQL Query Management false Enable the query management functionality to monitor currently running queries in the system.
Suppress Warnings of Possible Design Inconsistency true When a possible software design inconsistency is detected, and the system is not configured to fail, then suppress the warnings. Setting this parameter to false will result in logged error message of any design inconsistencies.
Temporary Graphs Time Out 2 The length of time to wait before a temporary graph can be garbage collected (minutes).
Google Maps API Key To enable Google Maps viewing functions in TopBraid, obtain an API key (string) from Google and enter it here.
Scheduled Job Thread Count

Number of threads available for concurrent execution of scheduled jobs. Default is 3 if not changed. Use this setting with care.  

There is a high likelihood that as the number of concurrent scheduled jobs increases, the potential for concurrency issues and other related problems increase as well. If, for example, two scheduled jobs are recalculating subscriptions on the same underlying graph, one operation may be blocked by the other – leading to even longer overall execution times and more parked and waiting threads as other scheduled jobs process. This can compound on itself as well.

OAuth Parameters

Used for API access in conjunction with SAML SSO user access. See https://doc.topquadrant.com/7.0/server-installation/#OAuth_Authentication for more information.

Parameter Default Description
Authorization server URL  The URL of the OAuth/OpenID authorization server.
Client ID The OAuth client ID.
Client Secret
Relying party A service that the OAuth client is authorized to use

LDAP Servers (Service Providers)

EDG can support multiple LDAP service providers (e.g., multiple Active Directory domains or LDAP servers). For each one, click the plus sign “+” to create a new LDAP stanza (parameter group).

Before applying any LDAP changes, please double-check all settings for accuracy. Inconsistencies with remote LDAP systems could result in the loss of EDG permissions, which could be especially problematic for administrators (i.e., users having roles with AdministratorGrp group privileges; see Rights Management). Please verify before proceeding. Losing administrator permissions would block access to Administration pages, including this one, thereby requiring external access to the EDG system environment to modify the configuration files directly.

 

Configuration parameters

For each LDAP server, open Server Configuration > Edit > Configuration parameters > “+” and enter the following server parameters. To delete an LDAP server configuration, open Edit and click its “x”.

Parameter Default Description
Connection URL LDAP service provider’s connection URL
Username for server connection Username for connection login
Password for server connection This appears only if other LDAP parameters are set, and it is set after Save Changes has completed.
User pattern string Based on the Tomcat JNDIRealm (for LDAP), this is the userSearch and userBase (e.g., “sAMAccountName={0},CN=Users,DC=sharepoint,DC=tqinc,DC=info”)
Role definition base roleBase: The base DN for role searches (e.g., “OU=Roles,DC=sharepoint,DC=tqinc,DC=info”)
Role name identifier roleName: The name of the attribute that has the role-entry’s name (e.g., “cn”)
Role search string roleSearch: The LDAP search filter for selecting role entries (e.g., “(member={0})”)

Membership search string

(OPTIONAL, Recommended)

For certain LDAPs (e.g., Active Directory), this is the reverse of roleSearch, used to find role memberships for a given user (e.g., “(memberOf={0})”).

Mail Settings

Parameter Default Description
SMTP Authentication On false Tells if smtp server requires authentication.
SMTP Server Smtp Server to be used for sending emails in TopBraid Live.
SMTP Server Port Number 587 Port used by smtp Server.
SSL Enabled false If SSL for mail is on
SMTP Username Username for authenticating on smtp server.
SMTP Password This appears only if other SMTP parameters are set, and it is set after Save Changes has completed.

AutoClassifier Configuration Parameters

Parameter Default Description
Maui Server URL The URL (with, if necessary, the port number and path) of the server running the Maui auto classifier, e.g., http://myserver.org:8080/mauiserver/
Maui Server user name Must be specified if Maui Server has been configured to require a user name and password (via the HTTP Basic Authentication protocol).
Maui password This appears only if the other Maui parameters are set, and it is set after Save Changes has completed.

Explorer Parameters

Parameter Default Description
Explorer users can view working copies false [Explorer viewers setting] Set to true on the Explorer server if read-only users can also see the working copies of the published asset collections.
Explorer users can use sparql endpoint false [Explorer viewers setting] Set to true if you do not want to block /sparql endpoint for explorer users
Explorer server

[Editor] URL of an Explorer server that receives published versions of asset collections for read-only viewers.

NOTE: This must end with /tbl, e.g. http://myserver.org:8080/edg/tbl.

Explorer server user name [Editor] User name for authentication on the Explorer server (needs Administrator privileges)
Explorer server password This appears only if the other Explorer server parameters are set, and it is set after Save Changes has completed.
Editor server

[ Explorer viewers ] URL of the EDG Editor (source) server, which can receive feedback from viewers of the published vocabularies.

NOTE: This must end with /swp, e.g. http://myserver.org:8080/edg/tbl/swp.

Editor server user name [ Explorer viewers] User name for authentication on the Editor (source) server ( Administrator privileges recommended)
Editor server password This appears only if the other Editor server parameters are set, and it is set after Save Changes has completed.

JIRA Integration Parameters

Parameter Default Description
JIRA Server URL URL to access JIRA, e.g., https://mycompany.atlassian.net/ —NOTE: This URL must end with a slash “/”
JIRA User Name The JIRA login name to shared by all users (the password entry appears after the URL and username are set)
JIRA Password This appears only if the other JIRA parameters are set, and it is set after Save Changes has completed. You need to use API Tokens as passwords for Jira integration.

S3 Configuration

These are the global settings for using S3 for backups from the backup and restore page and S3 exports from the basket. The settings for the exports can be overridden in the collection itself. This bucket for Backups is required to use that feature.

S3 Export Bucket The default target bucket that will be utilized during S3 exports from the basket.
S3 Export Folder Optional, when specified all exports that use the global configuration will be written to the specified directory. The directory will be created if it does not exist.
S3 Export Backup The default target bucket that will be utilized during S3 backups from the backup and restore page.

Migrations

This section contains automated scripts that customers may need to run as part of upgrading to a new version. Please follow the migration instructions on when to use these.

 

Download Configuration Files

Download general config graph Click this link will download the current config.ttl from the system folder.
Downoad uiconfig graph Click this link to download the current uiconfig.ui.ttl from the system folder.

EDG Configuration Parameters

Server Configuration

Administrators can update the section via its Edit button and ensuring to click Save Changes when finished. Note that any required passwords must be entered after saving changes. NOTE: Database updates require an EDG server restart.

Teamwork Platform Parameters

Parameter Default Description
Comments activated true Allows comments on data resources
Tasks activated true Allows user tasks on data resources
Metrics dashboards activated false EDG only. This enables user viewing and administrator editing of metrics dashboards. For details, see Metrics Dashboard.
Disable Profile Avatars false Set this to true to remove the ability for users to add a profile image in the User Directory page. 
Default namespace suggestion http://example.org/{type}/new# This is the string used to pre-fill the Default namespace field for a new vocabulary/asset. The EDG default is http://example.org/{type}/new#, which an administrator can customize here. Note that the variable {type} produces the lowercase plural name of the vocabulary/asset type, e.g., “ontologies”.
Hide source code editing false

Selecting true will hide the source code editing window of the full-page resource editor, for all users.

Constraint violations block editing false If true then the edit forms will block saving of edits if violations have at least sh:Violation severity. By default, users can override all violations, irrespective of their severity level, and continue despite them.
Only admins can upload files from TriG files true If true then only administrators can upload TriG files containing graphs that are mapped to files.

 

URI Construction Rules

When a new asset is created, these parameters determine how its URI is automatically constructed.

 

Parameter Default Description
Local name construct method label

Usually, the new URI begins with the collection’s default namespace string (see the collection’s Settings utility group), and this parameter determines its suffix .

The parameter settings are as follows:

Parameter value URI structure
label or [EMPTY] The asset’s label is appended to the default namespace
uuid A generated UUID is appended to the default namespace
counter A sequential integer is appended to the default namespace (from a namespace-specific sequence beginning with 0)
custom [EMPTY] – The default namespace is not used: the editor must provide the full URI manually
Include class prefix true When true, prepend the asset’s classname to the preceding local-name suffix parameter (except for: custom)
URI Prefix Separator The character(s) used to separate the prefix value from the rest of the URI value when prefix is set, defaulting to “-“.
Include class acronym prefix true When the preceding parameter (class name prefix) is true and this is true, use an abbreviated form of the class name if available
Users cannot modify URI false When true, the URIs of new assets are automatically constructed and displayed, but collection editors cannot modify them.
URI Counter Offset 0 The default offset used in the case of counter being set to construct URIs, defaulting to 0.

Lucene Configuration Parameters

Parameter Default Description
Lucene Unlimited Matches  If true then queries using the Lucene text index will not use an upper boundary (10000) of matches. Activating this will return more complete results but may lead to bad worst-case performance. This setting applies to EDG editors and not Search the EDG
Use Lucene WhitespaceAnalyzer Changes the Lucene index analyzer (currently used for the Text Indices/GraphQL-based and Seach the EDG queries only). The default StandardAnalyzer drops characters such as / and – while the WhitespaceAnalyzer preserves them. You need to restart the server and then rebuild the text index for this change to take effect.

Reification Configuration Parameters

Parameter Default Description
Preserve reification statements If true then EDG file importers will not attempt to convert rdf:Statement instances into corresponding reification URIs (and vice versa on export). By default this conversion applies to blank nodes only, unless alsoConvertURIStatements is true. Among the RDF file exporters, only the Sorted Turtle writer will observe this flag – all others do not convert reification URIs back to rdf:Statements.
Also convert URI statements If true then EDG file importers will not only convert rdf:Statements that are blank nodes but also URI statements.
Record statement URIs If true then EDG file importers will record the original URIs of rdf:Statements as values of dash:uri for round-tripping later.

EDG Asset Collection Singletons

EDG Asset Collection Singletons are special asset collections that are automatically created when EDG is installed. Currently, there are two singletons: Governance Model and EDG Enumerations. Unlike other collection types, only one Governance Model and one EDG Enumerations collection can exist in a given installation of EDG. Assets in these collections are available for referencing in all other collections without a need to explicitly include them.

Setup EDG Enumerations – Administrators can use this function to populate selection values for built-in EDG properties such as status and confidentiality. You will be able to load files with pre-build values and/or enter your own values. 

Configure Asset Collection Types

For the asset collection types allowed by the installed TopBraid product license, these settings allow administrators to show or hide those types in the user interface. Administrators can also modify “default includes” for each asset collection type. Default includes are graphs that are automatically included when a new collection is created.

 

User Interface Configuration

Some TopBraid EDG features support assigning language tags to string attribute values using a drop-down list when editing, for example:

This section allows overriding and adding additional languages. The below entery is a space-delimited list where you can enter the language choices that will appear on EDG editing screens. Any codes can be entered, but the codes will interoperate better with other systems, such as Web browsers, if the ISO 639 language codes and, optionally, ISO 3166 country codes, are used. In the following, ISO codes for Spanish, English US English have been entered. These will be the only languages that appear in the language tag drop-down:

Default Notification Setup

These are the default notification settings that are used to initialize new collections. For each collection-related event, administrators can indicate default choices for the governance roles that should be notified of it. Each collection can override their initial default settings, and changes to these defaults do not affect existing collections. For information on associating governance roles with asset collections, see the Governance Model Overview. To manage a collection’s notifications, see the Manage > Configure Notifications documentation of its collection type.

Governance Roles

A user who is assigned a governance role will have permissions on a collection in that subject area. This global setting determines whether the role can create workflows. Note that a user having one role disabled for workflow creation could still create a workflow if they also have another applicable enabled role (or a permission profile assignment). There is also a setting for roles that edit source code. If checked, users will see the source code panel in the editor and be able to make changed directly here. Please disable source code editing for non-expert users.

 Landing Page Settings

The landing page widgets can be turned off or on for the entire EDG workspace. Users can turn off any widgets they don’t want to see individually from their users page, unless a widget has been deactivated here. It will then be unavailable to anyone.  Find more about customizing EDG home page widgets here.

Product Registration

Product registration page displays any previously entered license information (for example, the number of users or expiration dates). User can now update the registration with the license keys obtained from sales@topquadrant.com. To register your product simply click the “Change or Update license” link, this will display a button which will allow you to upload your license key. Once uploaded your license key file will be validated and registered for you. Note: If an administrator has set the license file location in the setup file instead of using the application interface then this option will not appear. The license file will need updated on the server instead.

Default Namespace and Prefixes

This page shows system-wide default namespace/prefix declarations in Turtle notation. 

Editing the default namespace prefixes is a potentially dangerous, low-level operation. Please make sure you are aware of potential consequences before proceeding. These prefixes are used to abbreviate reified triples. So if there is already data on this server that uses the currently defined prefixes and you change or delete them, the reified triples may no longer be found and remain as “orphans” in the graphs. In an ideal world, try to define your enterprise-wide prefixes once in the beginning of your use of EDG. If you want to start using a new prefix, then add it while no reified triples still use it. For example, add it here immediately after a new asset collection was created that uses a fresh prefix.

Access Control

Rights Management

Rights (group) management is the basic access control subsystem for a few items in EDG:

  • Changing “Any_Role (all users) are administrators” to a specified tomcat role having administrator rights.
  • Selecting the security role(s) that can create new asset collections by checking the Create box for that tomcat role.
  • Making selected graphs OTHER THAN EDG asset collections publicly readable. This option is typically applied to files uploaded from TBC to the server.

This page DOES NOT control the read/write access for any asset collections created in EDG.

Rights management consists of two kinds of activities:

  • defining rights groups, and
  • assigning user security roles to various rights groups.

Each rights group represents specific access rights (i.e., Create, Read, Update, Delete and Execute) on the group’s selected workspace resources (or their generic “wildcard” types). For example, a file can be specified with CRUD access, whereas a SPARQLMotion script should have CRUD+E, and an exposed web service should only have E access. Users are then assigned to rights groups according to their security roles.

Prerequisite: Users’ Security Roles

The users’ side of rights management consists of knowing their security roles, which are configured during EDG’s installation and initial setup. A user security role must:

  1. be defined in a Tomcat/Realm, such as LDAP or tomcat-users.xml, and
  2. it must appear in the permitted security roles setup of the TopBraid (which define entries for security-constraint tags in the application’s web.xml).

See Server Installation and Integration for details.

EDG also has one special, pre-defined (pseudo-) security role: ANY_ROLE, which automatically represents every user. This role can be used to assign access rights universally.

Defining Rights Groups

AdministratorGroup

EDG has a special, pre-defined rights group: AdministratorGroup, which conveys full access to all EDG resources (including asset collections in EDG).

The AdministratorGroup must always be assigned to at least one users security role that has at least one accessible login.

On initial EDG installation, the AdministratorGroup is assigned to ANY_ROLE. This assignment should be moved to one or more proper security roles as part of the initial application setup (by first assigning the AdministratorGroup to a proper role, then deleting it from ANY_ROLE).

Defining new groups

To define a new rights group: select an existing role > click Add Group > choose the –New Group– option > enter a name for the new group > click Create Group.

Rights groups cover one or more resources in the EDG’s workspace, including projects (directories/folders) and various types of files. The selected group’s workspace resources are listed in the Resource Rights section. Resources can be added or deleted, and each resource’s access rights can be enabled or disabled. To add particular workspace resources, click the Add Resources button. To add generic resource types, click the Add Wildcard button. The defined ANY_ resource types are as follows.

  • ANY_RESOURCE: Any resource defined by TopBraid.
  • ANY_SDB_RESOURCE: Any SDB data connector (.sdb file).
  • ANY_TDB_RESOURCE: Any TDB data connector (.tdb file).
  • ANY_GRAPH_RESOURCE: Any named graph in the TopBraid workspace. This is a superset of ANY_SDB_RESOURCE and ANY_TDB_RESOURCE.
  • ANY_FOLDER_RESOURCE: Any folder in the TopBraid workspace.
  • ANY_FILE_RESOURCE: Any file that is not a graph, such a text, Excel, XML, etc.
  • ANY_PROJECT_RESOURCE: Any project in the TopBraid workspace. This differs from the PROJECT resource type in that this refers to all Eclipse/Equinox project in the workspace.

Then for each resource item, select which specific CRUD+E access rights are enabled or disabled for the group. The access types are as follows:

  • Create: Group members can create new resources.
  • Read: Group members can read resources.
  • Update: Group members can update/modify resources.
  • Delete: Group members can delete resources.
  • Execute: Group members can execute server-side scripts.

IMPORTANT:

When you want to ‘remove’ a group from a particular role – use the X icon next to the group name.

When you want to ‘delete’ a group completely – use the trashcan icon. (note that this will remove the group from all roles that were associated with it.

Project names should contain no spaces – if they do, you will get an error trying to expand them. Please correct the source Project name and re-upload it with no spaces.

EDG Permissions Management

This view gives administrators global access to permission profile settings for current EDG asset collections. (For an overview of access control in EDG, see Governance Model and Users.) Administrators can assign or revoke either individual users or their security roles to viewereditor or manager profiles for any or all collections, along with their working copies.

The first three settings let administrators (re-) assign or remove profiles for users on all collections:

  click image to enlarge it

The sections below let you define or remove assignments specific to each collection:

 

In the following, the Administrator and Jane Smith have been assigned an editor role for the Enterprise Ontology vocabulary, and JimHarrison is being assigned a viewer role for the same vocabulary:

Note that roles are modular and thus can be assigned roles like users.

Password Management

Users with privileges to view the Password Management page can add, delete, or edit the password entry in the secure storage. The “Add Password” button lets users add the password, and when the entry is selected, the user then can change the password for that entry or click the x to delete that entry.

The Password Management page manages the contents of Equinox secure storage, which defines an encrypted file indexed by a URL and user id and storing a password encrypted by the secure storage password and the key. This means in particular that if the user id or URL changes for a given entry, the password must be re-entered using this page or any other sources for secure storage entries.

There are two sources for secure storage passwords:

  1. Checking the “Send necessary connection credentials” in TopBraid Composer’s Export > Deploy project to TopBraid Live Server. This sends the contents of the Composer user’s local secure storage to the server’s secure storage. This is necessary when one is deploying a project from the IDE (Composer) that may contain passwords for connector files, SPARQLMotion scripts, etc. Note that to transfer the data form Composer’s secure storage to the server’s secure storage requires unencrypting Composer’s secure storage and sending the content in plain text. For full security, use https when performing a deploy that includes “Send necessary connection credentials”,
  2. Using this page.

Password Management

 

 

EDG Rights: Create for the Teamwork Repositories Project

EDG has a Teamwork framework that controls access to asset collections via permission profiles. It also has a Governance Model that uses governance roles to control access to the collections and their workflows via governance areas. (For an overview of access control in EDG, see Governance Model .)

Both permission profiles and governance roles are largely separate from rights groups—except that for EDG users to create asset collections, they require the Create right on the EDG Repositories project at least).

External Systems Integration

This page allows you to configure connections to external systems. Some features in EDG require connection to Amazon S3 buckets. This page stores the configured buckets which can then be used in the Attachments panel, S3 exports from the Basket and Corpora.

Bucket, Region: Name of S3 bucket and region location

Authentication type: Credentials or environment. See AWS link for details, https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html#Using_CreateAccessKey

Folder: Optional if using folders

Be sure to test your connection. If there are issues connecting, you will find detailed information in the workspace logs.

 

 

Deployment and Export

Base URI Management

Displays all projects and all registered graphs in the TopBraid workspace. Each graph will have a base URI (the graph name) and the file name in the project’s workspace. If there is more than one file with the same graph name (base URI) a Warning icon will be displayed. Information icons indicate projects and graphs that import missing ontologies not registered in the workspace. These warnings normally need to be resolved. 

Upload Project

This menu choice lets you add a project developed elsewhere (for example, a local copy of TopBraid Composer Maestro Edition) to run on this server. The Project Upload page gives you a field to identify the zip file of the project you’re uploading. To create the zip file, zip up the project folder within the development machine’s workspace, including the .project file created by Eclipse. Please refresh the text index after a project upload. This will allow searching in the collection editor page. 

After uploading a project that contains any collection data, refresh the text indices to enable search. 

Delete Project

This menu choice lets you delete projects from the server. Selecting it lists projects on your server, with Show buttons for each and Delete buttons for projects that are not part of the default installation of your server.

The Show button lists User Applications and User Sessions for that project, and Delete deletes the project.

Send Project to Another Server

This sends an EDG project, or its selected contents, from the current server to another EDG server. From the listed projects, an administrator can either send an entire project or its selected contents, such as an asset collection’s graph-pair (data and teamwork, .tch).

If the source is using a relational database (RDBMS), then the receiving server must have a compatible RDBMS configured, presumably to an independent location (optionally in the same database server). If the Also send database triples option is selected, the transfer will also copy the triples from the source data to the destination data. If it is not selected, the database connection files will be transferred but without the triples. This could cause the asset collection(s) to be empty, in which case they might not appear in the users’ listing of the corresponding asset collection type(s) (although an administrator could verify their presence via Base URI Management page). Keep in mind that the database type of the source files will remain the same and not be converted, regardless of the destination servers’ configured database.

If the Send UI configurations (etc.) option is selected, then it will send the UI configurations file from server.topbraid.org/dynamic/uiconfig; otherwise, the default uiconfig file will be used at that location.

For details of other methods to deploy project to server, please refer to Methods to Deploy Projects to Server.

Create TriG file of all EDG production graphs

Clicking this link will download a TriG file of the collections, not including working copies, in this EDG workspace. This file will be very large and include triples from EDG system graphs. The main purpose of this feature is to replicate an EDG workspace for testing/debugging. History (tch) and metadata such as permissions will not be retained. 

Import TriG File

This page lets you create multiple asset collections at once by uploading a TriG file with multiple asset collections. This functions the same as the + (plus) button in the header of EDG. 

Refresh Workspace

Refresh workspace rereads the workspace directory an re-registers SPARQLMotion scripts, SPIN functions and templates, and SWP views. If modifications to a file are made outside of TopBraid, i.e. on a file system instead of Export… Deploy on Composer or ProjectUpload on the server then Refresh Workspace will add the file to file registry and register any scripts, templates, and views defined in the file.

Backup/Restore

Starting in EDG version 6.4.2, a new feature has been added for Administrators of EDG to take backups of the collections in the workspace and restore from a backup if needed. Restores should be reserved for disaster recovery purposes. Please test it in a development environment to get familiar with the process. Note, this is memory intensive. If your server is low on memory, the restore could fail. We recommend manually running garbage collection prior to a restore through the memory management page. This feature should not replace any existing backup strategy you have for your organization, only supplement and enhance it.

Important details prior to using this feature:

  • Backups can be downloaded to local machine of user or stored in AWS S3 bucket. They are also stored in Tomcat\webapps\edg\config\restore folder upon doing a restore. This is in case of rollback. If you are doing frequent restores, please clear this folder out periodically to save disk space.
  • Everything in the workspace will be backed up/restored besides EDG system files and configurations. During the restore process, if there are any TDB databases (including new collections you have created) in the system that do not exist in the backup you are restoring, they will be cleared.  Any other files in custom projects will remain, regardless of if they were in the backup or not.
  • This feature is only available for TDB backed data, not RDBMS or Data Platform. Data Platform backup and restore will be coming soon.
  • Once a restore is in progress do not navigate away from the page or shutdown the server. It may take time to do the restore, so please let it finish. If you get an error then you may have to restart Tomcat.

 

User Data

Layouts

This page lists the layouts that have been either installed by default or have been saved by users. Layouts are used in the editors for asset collections. 

 

System Monitoring

Server Information

Information about the copy of Enterprise Data Governance being used and the system on which it is running.

 

Memory Management

A detailed report on current memory usage. The report includes a link that lets you request garbage collection to clean up the memory.

Max: Xmx value

Total: What the JVM has allocated

Free: The difference between what the JVM has allocated and what’s in-use

View EDG Log

TopBraid error log, including warnings and errors from the Web application container (for example, Tomcat).

Component Monitoring

Process Management

This shows active EDG threads and allows administrators to end them. For each active EDG thread (e.g., a query), this shows its internal ID, descriptive details (e.g., the query text), the thread’s source (for example, the server’s SPARQL endpoint), and the current duration. Administrators can terminate individual threads. To enable management of SPARQL queries, see Server Configuration parameters above.

Auto-Complete Management

This lets an administrator manually rebuild the search indexes used for GUI auto-complete and quick-search fields. This may be (rarely) needed in case an auto-complete gets corrupted due to updates outside of the control of TopBraid, or due to other unforeseen situations.

Search the EDG Index

This Lucene index supports text and facet search across all asset collections selected to be indexed by EDG. This index is rebuilt periodically  – on server start up and after changes made to the index. This page allows rebuilding and refreshing of the index.

This endpoint can be used to rebuild the index via API, safindexconfig:RebuildSearchTheEdgIndex. More information on this endpoint can be found on the available web services page in server administration. 

GeoSPARQL Indices

For use with TopBraid EDG GeoSPARQL support.

Text Indices

This Lucene index supports text search in EDG tabular editors. It updates automatically, synchronously with users’ edits. It offers Rebuild and Delete actions which should be used mainly for special situations such as external uploading of .tdb files into the workspace with a server restart. This index is associated with EDG UI file: projects/server.topbraidlive.org/web/2018/textindex.ui.ttlx. See that file’s comments for further technical details.

This index is not rebuilt upon server restart. If a workspace restore, send project from another server, or restore snapshot of EDG has been used, please manually rebuild the index. 

This endpoint can be used to rebuild the index via API, tbladmin:RebuildTeamworkIndex. More information on this endpoint can be found on the available web services page in server administration. 

Scheduled Jobs

This shows the status any active automated EDG services. To develop customized automated services, please contact TopQuadrant Professional Services.

Count Triples

This screen lets you run a report to see how much data you have in your EDG instance. The results will be displayed on this page for the last run. As well, each file will have a triple count from the last run on the Base URI Managment page. Please run the job after hours as it is resource intense.

Current Ontology Optimization Caches

Lists the active caches for ontologies.

Log of SPARQL Function Calls

This screen lets you start, stop, clear, and refresh the logging of SPARQL function calls, as shown below. This can be especially useful when debugging applications under development.

Development and QA

Available Web Services

EDG exposes CRUD operations through:

  1. GraphQL queries, including mutations.
  2. SPARQL endpoint which can be called via a REST API
  3. Templated RESTful Web Services for common operations. These services are typically implemented as:
    1. SPIN Templates – defined in .spin. files
    2. SPARQLMotion scripts – defined in .sms. files
    3. SWP Services defined in .ui. files

TopBraid EDG offers a number of pre-built RESTful services. Additional templated web services can be developed  by customers, as needed, using the provided IDE, TopBraid Composer. For more information on Web Services with TopBraid see https://www.topquadrant.com/web-services-and-topquadrant-products/ and https://www.topquadrant.com/creating-web-services-with-the-topbraid-platform/

See Deploy Projects REST for examples of some common APIs to create and import collections in EDG.

Authentication applied to EDG will also apply to the web service call. Please see Server Installation and Integration-Authentication for more information.

TopBraid includes a facility for auto-generating API documentation. This means that any API that has been developed and deployed is automatically fully documented when marked as public. This includes pre-built TopQuadrant provided APIs as well as any customer developed APIs.

Selecting the Available Web Services link displays a page that lists web services available on this server. Selecting the checkbox next to any of these names displays documentation below the list about how to call that web service.  Note: See below “Available Services List” for all currently available services.

For templated services, the following values can either be supplied in the HTTP request’s Accept header or as the value of the _format argument:

Response type Format name Arguments accepted
application/sparql-results+xml SPARQL XML Results xml
application/sparql-results+json SPARQL JSON Results json
application/sparql-results+json-simple Simple JSON Format json-simple
text/csv Comma separated values csv
text/tab-separated-values Tab separated values tsv
application/rdf+xml RDF/XML application/rdf+xml
text/turtle Turtle text/turtle

If you do not explicitly specify the response type, defaults will be used. The default serialization of SELECT result sets is JSON, following the SPARQL protocol. When you call a service from a web browser’s address bar, the mime type will typically be requested as something that includes the string “xml”, and in this case it will produce SPARQL XML Results. CONSTRUCT queries are returned in Turtle format by default.

The value of the _base argument can be a full graph URI or a short graph name. To define short graph names, go to the Server Administration -> Server Configuration Parameters page. In the section named “URI Parameters” define an instance of “Short graph names”.

To call a saved SPARQL query outside the EDG application, navigate to the Export tab -> Export using Saved SPARQL Query and copy the Service URL.

Available Web Services list

Example generated documentation from EDG. 

URL Routes

Routes provide shorter or alternate URLs for deployed pages or services. New routes can be defined by setting the ui:uriTemplate property of an SWP ui:ServiceThis is considered an experimental feature and not recommended for production systems. Routes become active after a workspace refresh.

Query TopBraid Platform API using GraphQL

This page brings up the GraphiQL tool for TopBraid EDG.

GraphiQL is a graphical interactive in-browser GraphQL IDE which features syntax highlighting, type ahead and documentation. The GraphiQL IDE from Server Administration is scoped to the EDG platform. You can use this for example, to query for a list of collection types or permissions for collections. 

Create snapshot of EDG

Creates a snapshot of the environment of EDG for testing purposes.

The snapshot consists of collections in the workspace plus history. You can save this then use the “Restore snapshot” feature to have a replicated environment, useful for testing upgrades or customizations.

Restore snapshot of EDG

A snapshot of EDG consists of collections in the workspace plus history. You can save this by using “create snapshot of edg” then use the “Restore snapshot”  to have a replicated environment, useful for testing upgrades or customizations.

Warning: This will replace all data stored in your EDG Repositories folder! Only use this feature if no process is currently executing and no other users are logged in.

Run all DASH Test Cases

This feature is used to execut DASH test cases from *.test.* files and test case asset collections