TopBraid Live Administration Guide: Administration: The TopBraid Suite Console

This chapter describes the tasks you can perform using the web-based interface available for TopBraid Live administration.

The TopBraid Suite Console

For both the Personal Server and the Enterprise Server editions of TopBraid Live, the TopBraid Suite Console lets you control your server and deployed applications.

The Main Console Screen

In the upper-right of the console are a link that lets you send your error log to TopQuadrant and a link to information about support. Below that, the console has four sections:

Applications Assembly & Deployment for creating and managing applications.
Preview TopBraid Live Enterprise Vocabulary Net
Download SDK
TopBraid Live Server Administration for managing the running server's sessions, configuration, memory, and logs.

TopBraid Ensemble Application Assembly & Deployment

This section shows TBE applications available for running and editing. They're divided into two lists:

Application Templates lists applications in the server.topbraidlive.org project's system-applications folder that are designed to provide the basis for new applications. When you first install TopBraid Composer, this includes one application titled "New Application" with no components and several applications that demonstrate the use of most TBE components. Each of these applications can be used with nearly any data set, so they provide a good starting point for most application development, particularly to learn how components post and listen to events to communicate among themselves.
Applications lists applications in each project's user-applications folder. When you pick Save App during application development, the server puts the application you're developing in this folder. When your application is ready for deployment, move it to the server.topbraidlive.org project's system-application folder.

Preview TopBraid Enterprise Vocabulary Net

Clicking this leads the main screen for TopBraid EVN, TopQuadrant's web-based solution for simplified development and management of interconnected controlled vocabularies. It supports business stakeholders who need to collaborate on defining and linking enterprise vocabularies, taxonomies, thesauri and ontologies used for information integration, customization and search.

See TopBraid Enterprise Vocabulary Net User and Reference Guide for this product's documentation.

Download SDK

This menu choice lets you download the TopBraid Ensemble Software Development Kit to use with Adobe Flex Builder so that you can create new components to use in TBE applications. The SDK will be saved on your computer as a zip file; once you unzip it, the README.txt file in the root of the TopBraidEnsemble-SDK directory created by unzipping the file will orient you so that you can use SDK with Flex Builder to create new components.

TopBraid Live Server Administration

This displays a menu whose choices give you more information and greater control over your running copy of the TBL server:

Clear All Sessions Each running TBE application communicates with the server to exchange data. This menu choice, which is a button in which "n" will show you the number of these sessions currently being managed by the server, will end all of these sessions. This can be very useful in application development, because after reconfiguring details of an application you often want to restart it from the beginning with no data in memory from earlier sessions.
Session Management This displays a screen with details on each of the sessions currently underway: the user who started the session, its base URI, its start time and most recent time of use, the number of changes made to it, and the session ID. This screen also lets you kill individual sessions and rebuild their indexes, and the Enterprise Server edition of TBL lets you kill all the sessions of a particular user.
Dictionaries Management For each data graph being used, TBL stores a set of label-related metadata in memory known as a dictionary. The dictionary consists of a Lucene index to speed text-based searching and to implement the typeahead feature on TBE forms. This screen lets you create and recreate indexes.
Base URI Management This displays a screen showing which URIs represent which data graphs. Information icons on this screen indicate projects and URIs that import missing ontologies, and Warning icons indicate URIs being used for multiple files.
Server Configuration Parameters This leads to a screen of parameters about the running server that can be adjusted from this screen. See below for further information on Server Configuration Parameters.
Server Version Information Information about the copy of TopBraid Live being used and the system on which it is running.
OSGI Bundle Information A list of the Open Services Gateway Initiative (OSGI) bundles (Eclipse plugins) in use and their release numbers.
Component Upload This menu choice lets you upload customized components developed with the TopBraid Ensemble SDK to add to your collection of Tree, Results Grid, and other components to use in TBE application development.

The Plugin Name is the name that will be added to the Add Components menu for your new component to make it available for TBE application development.

The Plugin SWF and Manifest files will be created by Adobe Flex Builder when you compile a project there. See the section "Building Custom Flex Components" below and documentation accompanying the TopBraid SDK for more information.
Project Upload This menu choice lets you add a project developed elsewhere to run on this server. The Project Upload screen 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.
Project Delete 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.
Access Control (TopBraid Live Enterprise Server only) Selecting this leads to a a screen that that lets you configure the access that users have to data on the server. See the Access Control section for more details.
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.
TBL Log The error log about current and past sessions.

Server Configuration

Server configuration is done by adjusting values on the following screen. After changing any values, remember to click the Save Data button at the top.

Server Configuration Parameters

Server Parameters

Name	Description
Security On	Enables/Disables security. If Servlet Container's security is not enabled, then this parameter has no effect.
Cache Size (in triples) for flex clients	Reducing this number decreases the memory requirement in the Flash VM, possibly reducing performance.
Show Hidden Files	During data selection, show all the files that are present on each project.
Nightly Restart On	Enables/Disables Nightly Restart.
Nightly Restart Time	Time in which Nightly Restart is executed (e.g. 20:00:00 for 8 p.m.).
Cache All Enabled	Enable Cache All Option (after modifying this, a server reset is recommended).
Server URL	This must be a localhost URL, and needs to have another /tbl added to give the main page.

SMTP Parameters

Name	Description
SMTP Authentication On	Tells if smtp server requires authentication.
SSL Enabled	If SSL for mail is on
SMTP Server	Smtp Server to be used for sending emails in TopBraid Live.
SMTP Password	Password for authenticating on smtp server.
SMTP Username	Username for authenticating on smtp server.
SMTP Server Port Number	Port used by smtp Server.

Advanced Parameters — Timeouts

Name	Description
Max Time per SM lock	Maximum allowed time that a SPARQLMotion Script can hold an exclusive lock on a resource (in minutes). Locks will be released after this amount of time and exclusive access will no longer be guaranteed.
Max Server Pre-sort	The server pre-sorts this number of items for simple searches.
Max Time per Request	Maximum allowed execution time per request before timing out (in minutes).
Temporary Graphs Time Out	The length of time to wait before a temporary graph can be garbage collected (minutes).
Requests Out of Order Time Out	The length of time to wait before a individual request that is out of order times out (seconds).
Disable Teamwork Permission Module	The default behavior (false) uses a different permissions module for team graphs and EVN. Set to true to disable that module, and to use TBL access control.
Client side auto-retry failed request counter.	The number of times that TopBraid Ensemble will automatically retry an individual request after it has timed out, without prompting the user.
Client side Requests Time Out	The length of time that TopBraid Ensemble waits before an individual request times out (seconds); this value should be long enough for SPARQLMotion scripts to complete.
Change queue length	Maximum length of the queue of changes being held on the server for any one TopBraid Ensemble client; if more than this number of changes is made by other users (including SPARQLMotion scripts) then the session is aborted.

Advanced Parameters — Thread Pool

Name	Description
Capacity	Number of simultaneous requests that TBL will accept before sending 'wait' commands back to the requester. On TBE, a wait response will cause the request to be resubmitted, after a short wait.
Wait/Compute Ratio	The average ratio between wait operations (IO, network) and computations for typical TBL usage.
CPU Target Utilization	Recommended values range from 0.5 (50%) to 1 (100%).

Session Timeouts

Name	Description
TBE Session Time	Length of time after which idle sessions will normally be timed out.
Triggering Percentage of Memory	If less than this percentage of memory is used, then sessions will not be timed out.
TBE Session Time Out when Memory Low	Minimum length of time after which idle sessions may be timed out if memory is low.
Higher Triggering Percentage of Memory	If more than this percentage of memory is used, then sessions will be aggressively timed out.

Tracing Parameters

Name	Description
Max Length of Readable IDs	Length limit for readable IDs
Tracing On	Prints out communication between server and client.
Readable IDs On	Provide more readable IDs in traces (requires a server restart)
Tracing to Console	Trace to standard output (alpha) (if Tracing is On)

Dictionary Parameters

Name	Description
Minimum length for autocomplete	Until this number of characters have been typed autocomplete does not operate.
Label properties are defined in this ontology.	All properties used for labels in TopBraid Ensemble are defined (or duplicated) in this ontology, and are subproperties of rdfs:label.
Label Cache Size	Each TBE/SDK client has two or three label caches of this size, can be 0, but that will impact performance.
Index Resources without rdf:type	During indexing of the dictionary, include resources with label triples, but without type triples. If all resources have type triples, then set it to false. If true, indexing operation takes longer to complete.

Teamwork Parameters

Name	Description
SDB password	The SDB password.
teamwork root project	The name of a root project in the workspace that shall contain any newly created vocabularies.
SDB user name	The SDB user name.
SDB URL	The URL of the SDB database server.
SDB database type	The type of the SDB database to use. Must be "MySQL", "Oracle", "PostgreSQL" or "SQLServer".

SPARQL Web Page Parameters

Name	Description
ui label function URI	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 link base	The server URL to prepend in calls of ui:createLink. If set, then ui:createLink will create absolute URLs.

Uploading Semantic Applications and Data to TopBraid Live

The TopBraid Live workspace holds all user-defined files for data, scripts, applications, and related files. Uploading data to the TBL Enterprise server must occur through a project upload, where a project is an Eclipse project created through TopBraid Composer. There are two ways to deploy data to TopBraid Live:

In TopBraid Composer-Maestro Edition, right-click on the project name in the Navigator window and choose Export... > TopBraid Composer > Deploy Project to TopBraid Live Server. Specify the server, login name, and password, and click Finish to upload files to TopBraid Live. In addition to uploading files, all passwords for data back-ends, saved in Eclipse secure storage, will be uploaded to the TopBraid Live server and saved using secure storage.
Locate the project in the TopBraid Composer workspace and create a zip archive for the full project, including the .project file. Open the TopBraid Suite Console for your TBL Enterprise server, select TopBraid Live Server Administration, and then choose Project Upload. Locate the zip archive on your local machine and click the submit button to upload the project to TopBraid Live.
This method does not support uploading secure storage passwords.

For more on creating files and applications for TopBraid Live, please consult TopBraid Composer Help files.

Administration: The TopBraid Suite Console