Unless otherwise noted, the migration items are cumulative. Thus, beginning with one's current version level, all items from all subsequent sections, i.e., (increasing) version levels, should be checked for possible applicability. TopBraid version 5.2+ has upgraded to RDF 1.1 as well as modified the schema for RDBMS (SDB) for enhanced functionality. Therefore, upgrading to 5.2+ will require administrators to migrate data from any existing TopBraid 5.1 relational database to a new one. A migration utility tool, ‘sdbconvert’, has been created to assist in this process. The tool will invoke a program to connect to your 5.1 database and migrate data into the new relational tables. Please note: The following instructions create a new relational database, load existing data into it, create a new workspace, and migrate projects into it. You must reinstall your 5.2+ license file. The commands in italics are examples for reference. Please read this entire document prior to beginning to ensure you understand the migration steps and can apply them to your environment. This may affect users of RDM/EDG and some users of EVN. These users may have to edit or delete customized forms for certain classes. Background: Up until version 5.1, RDM and EVN included an automated mechanism that created or modified the SWA form layouts of classes if certain vocabularies were included. These vocabularies are When such includes were added, forms were modified to include sections for the new properties. The mechanism based on form manipulation was causing issues and was unnecessary fragile and complex. As of version 5.2, a different mechanism was implemented that internally uses SHACL definitions to represent form templates. Instead of modifying the forms for each class, a generic mechanism determines dynamically which sections need to be added, regardless of whether the class has a customized form or not. Migrating to 5.2+: If you have included any of the 3 vocabularies mentioned above, you may see duplicate sections, e.g. two RACI sections, on your forms. The duplicates are the result of "legacy" form customizations which are now unnecessary. In order to get rid of the duplicate forms, either delete the customized forms or remove the sections that were automatically inserted by the previous mechanism. Running the 5.2+ Auto Classifier will require downloading and using the latest version of the Maui server. https://github.com/TopQuadrant/MauiServer/releases In 5.3+, TBL LDAP supports multiple configurations, which requires migration of LDAP configurations from TBL 5.2 or earlier. In the following steps, set up the LDAP password immediately as indicated to ensure access to the server (and avoid a shutdown and manual editing of the config.ttl file). By default in TopBraid 5.4+, schema definitions for classes, properties, and shapes (constraints) are restricted to ontologies. Other collection types should contain only instances, using include references to ontologies (etc.) as needed. Among other things, this allows performance enhancements for some operations. See Ontology Editor: Classes vs. Instances for more information about this recommended practice. One change from previous versions, 5.3 and earlier, is that schema-related editing and importing is no longer supported for non-ontologies, i.e., taxonomies, etc. If necessary, EDG Administrators can disable this restriction via the Enable Ontology Optimizations parameter; see Server Configuration Parameters > Advanced Parameters for details. In TopBraid 5.4+, introduces new Organizational Structure components as part of a new Governance Model , which provides enterprise contexts for other asset collections. This changes some organization, user, and email implementations from TopBraid versions 5.3 and earlier. The organizational context provides hierarchical groupings of users according to job titles. This allows users to be associated to various governance roles indirectly and abstractly via their job titles. A new Users page shows role assignments. For installations based on Tomcat-provided authentications (i.e., non-LDAP), email addresses for notifications can be set in the users page. Users not conveyed through one of the Tomcat authentications options (Tomcat-users or LDAP) can no longer receive notifications. In TopBraid 5.4+, associating keywords to a collection (as in TopBraid 5.3 and earlier), has been replaced by assigning a collection to one or more "goverance areas", either business or data-subject areas. To assign a subject area, simply create the collection for that area in the Governance Area page or edit the metadata for the collection. See Governance Model Overview: Governance Areas for details. To filter collections, use the Find Asset Collection page. Search results from the editor screens have been limited to 1000 entries by default to improve initial load times. When viewing larger collections, filter the results to narrow down under 1000. The number of results returned can be configured through the administrative section by updating the parameter 'maximum number of table rows'. Search the EDG is now backed by a Lucene index. This change will greatly improve performance over large or many collections. With the index, partial matching is not supported. See Lucene integration for more details. In TBL 5.4 and earlier, if an imported URI was not found in the workspace, then TBL would default to loading it from the web. This default loading behavior could be disabled via administration parameter: Server Configuration Parameters > Advanced Parameters > Disable URL graph loading. Now, in 5.5+, remote loading is disabled by default to avoid accessing unvetted data. The parameter for URL loading is no longer configurable through administrative views, but if it must be enabled, an administrator can add (or modify): Graphs that previously relied on the default loading behavior can generate errors on non-local includes (i.e., The 5.4 Server Configuration Parameter Installations that have In TBL 5.5+, SKOS forms have moved to a SHACL basis, which means that taxonomies and (possibly) ontologies might need to update their imports as follows. A failure to import SKOS-XL Shapes now means that users will see a SKOS form, not a SKOS-XL form, even if SKOS-XL data exists. Hence, it will look like the SKOS-XL relationships have disappeared. The Data Platform client-side database is moving to Phase-out of Job Titles: The EDG Governance Model allows the creation of an organizational structure, and the assignment of users and security roles to the organizational hierarchy. In previous versions, it was necessary to create Job Titles for each organization. Users and security roles were then assigned to those Job Titles. This indirect assignment through Job Titles has proven to be cumbersome and to add little value. Starting with EDG 6.0, Job Titles will be phased out. In 6.0, there is a setting “Enable Job Titles” in the EDG Configuration. It is off by default, and should be left off for new deployments. In this mode, Job Titles are disabled, and users and security roles are assigned directly to organizations. If you already have created Job Titles in the Governance Model, you must set this setting to true. In this mode, EDG 6.0 will behave the same as the previous version with regards to Job Titles. We expect to remove support for Job Titles completely in a future release. Therefore, if you currently use job titles, please contact TopQuadrant support to discuss migration options. In some previous versions, permission to create new working copies/workflows was affected by a configuration option: Viewers cannot create working copies. This option has been removed. If the option was OFF (the default), EDG 6.0.0 will behave the same as before. If the option was ON, then the following needs to be considered: Asset collections can no longer be assigned to multiple governance areas. Any collection with multiple areas should delete its area associations, leaving at most one (see collection utilities: Settings > Metadata > subject area). From 6.0, these features have been disabled, and users are encouraged to migrate to SHACL. If required, these features can be reactivated locally (contact customer support), but keep in mind that they will be removed in a future release. Ontologies no longer import SPIN by default, neither does the standard teamworkconstraints. If your ontologies have relied on the latter owl:imports (transitively), you need to add the SPIN Standard Library (SPL) to your includes by hand. (cf. Developer Guide: Creating and maintaining new SPIN constraint libraries - DEPRECATED)) The non-SHACL approach for customizing form layouts is now deprecated and will be removed in a future release. Please use SHACL constraints to customize form layouts. See the Developer Guide: Customizing Form Layouts. Beginning in 6.0, there is a new mechanism for adding custom tabs to asset collection views.Page Contents
Overview
Migration from 5.1.x
Data Migration
bin/shutdown.sh
http://docs.oracle.com/cd/B28359_01/server.111/b28319/dp_export.htm#g1022624
https://msdn.microsoft.com/en-us/library/ms187510.aspx
mysqldump -u username -h hostname -p databaseName > locallySavedDatabase.sql
mv webapps webapps-51
mv workspace workspace-51
rm -Rf work/* temp/*
mv logs logs-51
mkdir logs
If you would like to use a different workspace name for 5.2+, you can edit the web.xml under the init-param commandline –data section to change to another workspace directory. Otherwise, you can use the old name, and it will create a new workspace for you since you already moved the old one to another name in step 4.
java -jar tq-jena-cmds.jar sdbconvert --jdbc "<jdbc connection string for the database>" --dbUser "<database userid>" --dbPassword "<database password>" --dbType <dbType>
Where database type can be one of MySQL, Oracle, SQLServer.config.ttl
file from the old workspace to the new one so that you don’t have to re-configure the server.
cp oldworkspace/server.topbraidlive.org/dynamic/config.ttl newworkspace/server.topbraidlive.org/dynamic
cd workspace-51
zip ../EVNProjects.zip .project * -r
After this restart, you should be able to see all your vocabularies just as before. This concludes your data migration to 5.2+.Changes to the Form Inclusion Mechanism
AutoClassifier Maui Update
Migration from 5.2.x
LDAP Migration
$TOMCAT_HOME/webapps/tbl/WEB-INF/web.xml
.$TOMCAT_HOME/webapps/tbl.war
.webapps/tbl
folder. Otherwise, with Tomcat shut down, manually remove the folder and its contents.$TOMCAT_HOME/work/Catalina/[HOSTNAME]/tbl
and its contents have been removed.edg.war
into the $TOMCAT_HOME/webapps/
directory.webapps/TBL
folder (restarting if necessary).web.xml
file in $TOMCAT_HOME/webapps/tbl/WEB-INF/
by the saved web.xml
.Migration from 5.3.x
Schema Definitions Are Restricted to Ontologies (Configurable)
Organizations, Users, and Emails
Users and emails
Keywords
Search Results
Search the EDG (TopBraid EDG only)
Migration from 5.4.x
URL Loading from Remote Graphs
cfg:enableWebImports "true"^^xsd:boolean ;
in TBL's config.ttl
file (located within the workspace's server.topbraidlive.org
project).owl:import
), which can be seen in the Server Administration > TBL Log. To address this, provide local copies of the referents, transitively, as needed.Server Configuration Parameters: ui link base and Server URL
ui link base
has been removed (its 5.4 documentation is here). Use the Server URL
parameter instead. Installations that had a setting for ui link base
should ensure that on that same configuration page, the Server URL
parameter (doc here) is set correctly. Installations using email notifications should verify that web links in notification emails still work correctly after migration. If not, the Server URL
setting should be double-checked.Server URL
left at the previous default of http://localhost:8083/tbl
, for TopBraid Composer, must either delete or replace this setting, leaving it either empty or with the correct URL-base for the TBL server.SHACL-based SKOS
Migration from 5.5.x
Data Platform
<workspace>/_Data/db-cache.tdb
(from <workspace>/Cache/db-cache.tdb
)EDG
Job Titles in the Governance Framework:
Viewers cannot create working copies:
An asset collection is in at most one governance area
Manage utilities > SPIN Constraint Libraries and See Customized Forms
Migration of Development Customizations
Ontologies
Forms
Teamwork project type
teamwork:ProjectType
should be extended with a teamwork:isReadOnlyTypeFunction
triple similar to the value of the original project type that they were cloned from.teamwork:projectHeaderBar
extension point for teamwork:ProjectType
has been removed. Contact TopBraid Support for migration advice.Tabs
teamwork:ProjectTab
or teamwork:TagTab
. These need to be modified as described in the DeveloperGuide: Adding New Tabs for Asset Collections.swa:TabsActivationScript
element or the swa.initTabs
JavaScript function might need updating. To retain the SWA-specific styling, add class="swa-tabs"
to the tab container. Otherwise, the tabs will use the jQuery UI tabs style. Furthermore, the active tab is no longer remembered between page reloads, and is no longer reflected as a #fragment
in the URL.