Skip to end of metadata
Go to start of metadata

Page Contents

Crosswalk Utilities

To perform various kinds of operations on a particular Crosswalk, open its name-link in the Crosswalks home listing. This shows the Crosswalk's assets view/edit page, where the menu bar also lists multiple utility categories, each of whose operations are listed in the corresponding subviews.

Dashboard View

A model's dashboard summarizes various kinds of status and quality measurements that are relevant for that model's type.


Process summarizes information about tasks and workflows.

Settings View

The Settings view of this collection pertains to its various references (e.g., inclusions, URIs and namespaces, metadata, etc.).


These sections show the references (owl:imports) made from other models to this one.

Namespaces and Prefixes

This view lists the collection graph's namespace prefixes, which can be used in SPARQL queries, etc.. The collection's managers can edit them using Turtle notation.

NOTE: Although comments (#) are accepted, they are not preserved.

Graph URI

This is an internal identifier for any data asset created by EDG.

External Graph URI

This defines a base URI that automatically maps with EDG's internal Graph URI (see utilities > Settings) during imports and exports. A manager can either edit this manually or set it automatically by importing an RDF file when no other value exists for the external URI. Also, RDF file import automatically redirects any owl:imports statements to the local copies. Thus, a manager can create a new ONTOlogy and then import an RDF file to pre-populate it correctly.

The inverse mapping happens when graphs are exported back to RDF files: their external Graph URI is used instead of the internal urn:x-evn-master:... URIs.


This section lets you view or edit information about the Crosswalk. There is a rich selection of metadata fields, and it is easy to configure EDG to include additional fields if required. The metadata is organized into sections. The view mode only shows the sections and fields that contain information, while the edit mode shows all sections and all fields.


This section records descriptive properties of the Crosswalk, including its official name (if different from the common name or label).

subject area

This is the governance area (business or data-subject) to which this Crosswalk is assigned (if any).


The Status section records the life cycle stages of the Crosswalk.

Users View

Crosswalk Permissions

Managers of a production collection or a workflow can assign its permission profiles (viewer, editor, or manager) to various users, either as individuals or as security roles (e.g., from LDAP). A production manager can also assign permissions on its child workflows. For non-managers, this view is read-only.

Whereas a production collection allows settings for any EDG user, a workflow copy only allows access to viewers (at least) of the parent production collection. Because each collection or workflow assigns its permissions separately, a given user can have different profiles for a particular production copy and one of its child workflows, or for two different workflows. A blank setting excludes access to the user or role. Any user with multiple assignments on a given collection or workflow receives the greatest level assigned. See Workflows - Permissions for Production Collections and Workflow Copies for details.

Crosswalk Governance Roles

This section allows managers to assign governance roles to users: as individuals, as security roles (e.g., from LDAP), or as organizations. For details on governance roles, see Governance Model > Governance Areas (and Roles).

Import View

From any Crosswalk's production or working-copy home page, the Import functions lets editors copy graph data into the given Crosswalk from external sources such as RDF files, spreadsheets, etc.

Import RDF File

Any Crosswalk can import data from an external RDF file (in a serialized format). The Import > Import RDF File link shows a screen where the Choose File button opens a dialog for picking the external source file.

Choose the source file and identify its format. Decide whether to record new triples in the change history (use with care!) and then click Finish to complete the import. A message will indicate whether the import was successful.

When importing RDF into a Working Copy, the addition of each triple can be added as an entry in the change history, where it will be available to all the relevant reports. When importing into a production copy, the Record each new triple in change history checkbox gives you the option of adding these to the change history; note that this is not recommended when importing large amounts of data.

Import Crosswalk from Spreadsheet

This loads mapping pairs into a Crosswalk based on two selected columns in a spreadsheet. Users may specify the column indices (default: from 1 to 2) and, for Excel, the sheet index. Each spreadsheet column represents one of the Crosswalk's two classes, each of which must have a primary key defined (see Ontology Editing: Setting a primary key for a class). When a primary key value from a spreadsheet column is prepended with the primary key's URI-prefix (as defined in the corresponding class), then the resulting URI must identify an instance in the corresponding model. If no instance matches such a URI, then the importer will not add a mapping for that spreadsheet row.

Export View

Export Crosswalk as a Graph

Any viewer of a collection can export its data in a standard RDF serialization format.

Creation of reports and exporting of data are available when working with both production and working copies of reference data to anyone with who has read access.

To export subsets of Crosswalk data according to custom criteria and sorting, note that EDG's Search screen provides fine-grained control over the data to display on the Search Results area. That form's gear menu offers several choices to export the results into spreadsheet-compatible formats (e.g., for Excel). See Crosswalk View or Edit for details on searching.

For any collection, to generate an RDF representation of the graph data, select Export > Export Crosswalk as a Graph and then an RDF format:  JSON-LD, N-TriplesRDF/XML, Turtle or TriG, with or without inferences ("with inferences" adds a dedicated graph named urn:x-topbraid:inferences, which has any triples inferred via SHACL or SPIN rules; note that this computes on-the-fly and might be very slow).

Browser interactions might vary: displaying the data directly or via a kind of view source command. Alternatively, instead of directly clicking a format link, the browser might provide (on the link) a right-click menu option to save the link target to a file (i.e., without explicitly displaying the link result in the browser). A dialog box will prompt for the file location and name.

SPARQL Endpoint

This allows users of the collection to run new or saved SPARQL queries on it and to optionally save queries for others. Saved queries can be deleted by their creators and by collection managers. If SPARQL updates have been enabled by an administrator, editors (and managers) can run them, but viewers cannot. Note that the Pivot Table and Geo functions can be slow on some platforms and are not supported for Internet Explorer.

Export using Saved SPARQL Query

This lists the SPARQL queries that have been saved for the collection. For each query, it provides a URL that will run it, along with an Export Query button that runs it and shows the results.

Export using Saved Search

The Saved Search link shows a screen listing your saved searches. These are searches that you have saved using the Save current search button in the search form of the Editor page.


After setting the Result Format for a given search, clicking its Export button will download the search results in that format. Your saved searches are web services. They can also be used as an APIs by other systems.

GraphQL Queries

This allows users of the collection to run new or saved GraphQL queries on it. For users unfamiliar with GraphQL, there is an included link to a tutorial inside TopBraid EDG and TopBraid Composer. For more information on GraphQL visit

Crosswalk as a Spreadsheet

Creates a comma-separated spreadsheet containing one row for each mapping in this Crosswalk.

Reports View

Anyone with read access to a production Crosswalk or working copy can generate various standard reports for it. Custom reports are also possible.

Problems and Suggestions Report

For any Crosswalk (production copy or working copy managed by a workflow), Reports > Problems and Suggestions checks the current state of the Crosswalk against all of its applicable quality rules (i.e., its shapes and validity constraints they define) and enrichment rules. A message box shows the rule-processing progress and then shows the report. Note that the report results are also reflected in the Dashboard > Completeness and Validity display.

Users can also enable validity checking when they are viewing individual resources in the form. This setting the applies across all of asset collections user works with. See the View or Edit documentation for details.

To develop custom extensions to this feature, see EDG Developer Guide > Extending the Problems and Suggestions Reports.

Crosswalk mapping suggestions

For crosswalk collections, the report also lists potential mappings between assets in the two collections. Suggestions may have percentage-of-confidence estimates, by which users can filter them. Each suggestion also has an Apply link that will create the indicated mapping in the crosswalk.

View Change History

Click Reports > View Change History to show the Change History view. For a production copy, this shows all the changes made since it has been created. For a workflow, this shows only changes made within the working copy managed by the workflow.

Clicking the Search button on the Change History screen displays a time-stamped list of the saves made in the Matching Changes panel, and clicking one of those lines displays details about what changes were made as part of that save operation in the Details of Selected Change panel. Below, the change made on July 30th has just been clicked, showing that three values were added and one was deleted as part of the change made with a particular save operation.

If you are logged in as a user who is editor or manager of the vocabulary/asset collection or a workflow where the change was made, then a link Revert this Change will appear in the bottom panel. Click on this link to undo this operation. This will in fact create a new "forward" edit in the change history, with yourself as author. Note that this feature should be used with care, because reverting some steps from the middle of the change history may lead to orphan resources in your model.

If you are logged in as a user who is editor or manager of an asset collection and look at a change performed in a working copy as part of a workflow, then a link Commit this Change to production will appear in the bottom panel. You can click on this link to move the change history entry (in the example above, the three additions and the deletion) out of the workflow copy and into the production copy, essentially cherry-picking which change from a workflow copy you want to accept. As with the Revert feature mentioned above, this feature should be used with care, because committing some steps from the middle of the change history may lead to creating data statements that are disconnected from the rest of the information. For example, when you commit a change that has modified some attribute of a newly created code, then you should also make sure that the change that created the code in the first place has also been committed.

Before you click the Search button, you can narrow the scope of the search by filling out any or all of the fields at the top of the form:

  • creator Enter the name of a particular EDG user to only see changes by that user. This field uses typeahead, so that if you have users named "Joe" and "Joan" and only type in "Jo", these two names will appear in a drop-down list for you to pick from.

  • date Enter a date in the first date field to see all changes after that date, a date in the second field to see all changes before that date, or in both fields to see the changes within a particular date range. (There's no need to actually type in the date value; clicking in either field displays a calendar where you can then click on the date you want to enter.)

  • status Enter "committed" or "uncommitted" to only list changes with one of these status values.

Comparison Report

For a production Crosswalk, this report shows its differences with another, user-selected Crosswalk. For a working copy, it shows the differences to its parent production version. Note that differences do not extend to the contents of included asset collections. The report will list each changed assets and properties that were changed, showing the changed values. If a value was added, it is shown in green. If it was deleted, it is shown in pink.

For example, the following shows what happens after the preferred label property for "South Korea" is edited, an alternative label is added, and a "Seoul" is added as a narrower value of the "South Korea" resource (renamed to "Republic of Korea").

The right hand side of each change contains a link View Change that displays a dialog box with details of the change log entry that caused that particular change. Depending on your permissions, you can revert or commit the change in that dialog box. See View Change History for further information on reverting and committing individual changes.

Property Value Rules

This shows the collection's property values that are inferred through SHACL: sh:defaultValue or sh:values (see Inferring Data with SHACL Property Value Rules for details). The inferred properties are depicted diagrammatically.

Workflows View

This view allows users to start workflows, and it lists both the active and completed workflows, if any. (For general information about workflows, see Workflows).

Start new Workflow

This button opens a form for starting a workflow. If multiple workflow templates (types) are available, select the appropriate one. The new workflow requires a name and allows you to enter an optional description, both of which remain editable by managers. For more information, see Workflows Utilities and related pages.

Users can also create a workflow pertaining to a selected asset (see View or Edit > Actions > Additional asset actions). Such workflows record the identity of the selected asset but are otherwise ordinary.

Workflows in Progress

This section lists any active (uncommitted) workflows of the collection. To access a particular workflow, select its row and click Go to Workflow. You will see a page showing you the status of the workflow and, depending on the workflow's status and your role, allowing you to move the workflow to the next state.

Also depending on workflow's status and your role, you can view or edit the workflow and view or execute various utility actions on it. A workflow can be used to process changes to multiple assets or changes to one specific asset. Each workflow isolates its changes to its own workflow copy, which does not affect other workflows or the production version, until and unless the workflow is committed back into production.

If the workflow was created for a specific asset, its name will appear in the row. Selecting the row and clicking  Go to Asset will open the asset's details view, which workflow editors can also modify.

Completed Workflows

This table works similarly to Workflows in Progress except that it lists the workflows that reached the terminal state. Typically, this means that changes have been finalized and committed to the asset collection. Users can view the history of workflow transitions. Each completed workflow shows its number of changed statements (triples), giving users information about the volume of changes made as part of the workflow. For completed workflows with extensive changes, preserving such history of changed triples might occupy considerable space. Therefore, asset collection managers can select a completed workflow and use the Archive action to remove the audit trail from the change history. The change records are copied into a file in a new project that an administrator can access if the change history details are ever needed again. To browse these files, use the Base URI Management page in the Server Administration area. The files will be located in a project (or folder) called "Archive". If these are not longer needed you can move them off the server. 

Tasks View

The Tasks feature allows users to associate tasks with asset collection resources. If the Tasks item is not listed in asset collections' main utility (operations) view, then see EDG Configuration Parameters for how an administrator can enable the Tasks activated configuration parameter.

Tasks for [Crosswalk NAME]

When this feature is active, tasks can be associated with either a top-level asset collection or with a resource it contains, such as a class, property, or individual code. The Tasks management view of an asset collection shows the tasks associated with it at any level. At the bottom of the view, the Create Task link displays a dialog box where you can add a new task's description and user assignment. Once you click this dialog box's OK button, EDG adds the task to the list for this data asset, where you can reset its status or who it's assigned to with that form's drop-down lists. You can then filter the list display by these values.

When editing a particular asset resource within a collection, the Tasks button on its details edit form allows viewing and creating tasks about the resource. The button also indicates the number of tasks assigned to the resource.

Newly created tasks are, by default, assigned to the manager of the asset collection, who can then reassign tasks to other users. A user assigned to a task can change its status and enter comments about tasks.

Administrators can activate a feature to Send task emails in the EDG Configuration Parameters. When activated, users with an email address (e.g. via LDAP) will receive emails whenever a task gets assigned to them, or if a property of an assigned task has changed.

Comments View

The Comments feature allows users to associate comments with asset collections and asset resources. If the Comments item is not listed in asset collections' main utility (operations) view, then see EDG Configuration Parameters for how an administrator can enable the Comments activated configuration parameter.

Recent Comments

When viewing or editing a resource such as a class, instance, or taxonomy concept, the Comments button in the lower-right shows how many comments have been added to the selected resource for this production or workflow copy. Clicking the button displays a dialog box where you can see previous comments and add your own under the "Add Comment" title; click the OK button when you are finished.

Comments have a status such as "open," "declined" or "resolved." The status of those can be changed using a drop-down list to the right of each comment entry. If you also have the TopBraid Explorer (Viewer) application, the display can also include comments from those viewers, marked with (via TopBraid Explorer).

To get a list of of the most recent 100 comments for a production or workflow copy, select its Comments management view. These comments can be filtered by status, for example, to only display the "open" comments.

When resources such as concepts, classes, or instances are deleted, their comments are not automatically deleted with them. These are known as "orphan comments." If there are any orphan comments associated with a given asset collection, the Comments view will include a hypertext link saying "Delete the X orphan comments about entities that no longer exist," where X is the number of orphan comments associated with this asset collection. Clicking this link will delete these comments.

Manage View

Each collection's Manage view is only available to its managers.

Create a Cloned Version

Managers of a particular Crosswalk can use the Create a Cloned Version function to create one or more named clones of the Crosswalk. A new clone will have the same content and user permission settings as the original production instance. However, neither the change history nor the working copies will be cloned.

Cloning is often used to "branch off" a version of the Crosswalk, so that it can be referenced and imported separately from the current version. For example, one could start with a Crosswalk called "People." Then, on reaching a milestone, one could create a clone and call it "People 1.0." Now, any other Crosswalk that explicitly should only use terms from version 1.0 could change its includes to that version only, while the ongoing work towards version 2.0 will continue on the main "People" Crosswalk.


Managers can Clear a particular Crosswalk, which deletes all of its content, history, working copies, comments, and tasks. The empty Crosswalk itself and its user permission settingss will be preserved. This feature can be used prior to file imports, to replace the whole content with an externally generated version.


Managers can delete a Crosswalk via its   Delete  link, which raises a message box to confirm the deletion. Clicking  OK  will delete the Crosswalk production instance and any working copies and history data.

A deleted Crosswalk is not recoverable.

Configure Notifications

For each Crosswalk, EDG can send notification messages to users in selected roles when certain kinds of changes happen to it. In order to receive email notifications the SMTP parameters in the Server Configuration must be configured. The Manage > Configure Notifications link provides a page listing all available Notification Events together with check-boxes to select the governance roles that will be notified:

The association of users with the governance roles for this collection is configured via governance areas. The user settings can be specified directly as individual users or indirectly as either user security roles or job titles. See Governance Model Overview for a discussion.

JIRA Project Key

Note that this item only appears if an administrator has setup the EDG Administration: JIRA Integration Parameters.

JIRA is Atlassian's web application for team issue-tracking. EDG's JIRA launch-in-context (LiC) feature allows users who are working in both EDG and JIRA to launch from editing particular EDG asset items into related JIRA searches and new items.

If the EDG JIRA feature has been administratively setup, then each collection manager can optionally set a JIRA project key string for the asset collection, where the JIRA-key identifies a specific project in the JIRA application. Setting the project key then enables JIRA LiC functions for collection editors. When editing any asset item, editors can use its gear menu to create or search for related JIRA issues. See Crosswalk View or Edit – Manage > JIRA Launch-in-Context for details.

Setting the project key also adds a JIRA link to the collection's utilily view header, which launches into JIRA to show the configured project's open items.

Record Triple Counts only

Selecting this option disables retention of change history at the level of individual triples (for production graphs). It records summary counts of changed triples added or deleted. This significantly reduces storage and memory impacts at the cost of losing detailed change information and the ability to undo (revert) the changes. Working copy graphs and existing change histories are not affected by this setting.

Custom Match Predicate

By default, crosswalks use the predicate crosswalk:closeMatch as the relationship type for linking matched resources. This function lets managers select a different predicate type to use for match-links. Changing the type does not affect any existing links, but the crosswalk GUI only addresses links of the currently selected type.

Archive Working Copies on Commit

If true, then working copies will be archived automatically when committed. (Note that the archive will always contain the full history, regardless of the Record Triple Counts only setting.)

Include this asset collection in the index for Search the EDG

Enabling this adds the collection content into the Lucene index used by the Search the EDG function.

Enable Simple Search

For very large collections, enabling this reduces editor overloading by disabling both: (1) automatic table loading and (2) advanced filters (which can have a large impact). Text filtering, based on Lucene indexing, remains available.

Configure Features

This allows managers to selectively remove particular features (functions) that will be applicable for the particular Crosswalk. Performance-intensive features are indicated. Note that all features always remain for administrators.

  • No labels