Child pages
  • TBL Methods to Deploy Projects to Servers
Skip to end of metadata
Go to start of metadata


Page Contents

TopBraid projects are workspace directories that contain multiple resources, such as asset collections, teamwork settings and working copies, and various configurations, etc. This section describes three methods for deploying projects to a TopBraid Suite server from three different project sources: (1) a TopBraid Composer IDE - Maestro Edition (TBC-ME), (2) a .zip file of a project (directory), or (3) another TopBraid server. The appendix also describes web services calls to create a new collection such as taxonomy or ontology and import a .ttl file into it. 

TopBraid Composer Export

Developers can design and test semantic content and web applications using TBC-ME, and then deploy those projects to a TopBraid server. TBC-ME has a custom Export wizard that deploys projects from its workspace into an existing TopBraid server. In TBC-ME, select a project (in a Project Explorer or Navigator view), and then either right-click the project or use File and select Export... > TopBraid Composer > Deploy Project to TopBraid Live Server

 

Click next in this wizard:

NOTEThis should only be used with projects that contain TTL files. If used with a repositories project checking the Overwrite existing project with the same name box will clear the database of triples before uploading. Please zip the project and use the Project Upload feature inside TBL instead. 

If necessary to send RDBMS files you will need to check the Send necessary connection credentials checkbox (to include the database credentials of the RDBMS connection in secured storage). Checking Overwrite existing project with the same credentials will replace the destination files and database content with the source files/data and is meant to be used mainly for .ttl files.  Clicking Finish will zip up the entire selected project with all the RDBMS connection files, and other project files, and send it to the server specified in the ‘Server URL’. And it will unzip it at the destination server in the workspace directory.

Upload Project to Server

Users can click the ‘Project Upload’ link from the admin page.

First create a zip file for the project folder (including the .project file) in your system. And click the ‘Choose file’ button to select such zip file. It should upload the zip file into the server, and unzip it properly in its workspace directory. This method will not create any database credentials in the server.

Send Projects between Servers

TBL administrators can send projects from one TBL server to another one, e.g., from a test server to a production server. From the Admin page, select Server Administration > Send Projects to Another Server.

Select the list of projects to send, and also check the box whether you want to send the database triples also to the destination server. It essentially zip up the entire project from the source server and unzip it at the destination server workspace. And also create the appropriate triples for all the graphs involved at the destination server. This essentially will eliminate the steps in copying database information from one test server to the production server. And all the imported vocabulary are sent properly also. This functionality should create the vocabulary and its import properly at the destination server.

Appendix: Web Services For Deployment

We also provide REST web service to perform HTTP requests for the following tasks if you have such needs to do so. You can perform the following using simple HTTP requests.

The following tables show the exact HTTP requests and parameters required to perform the specified tasks. The bold words are required system keyword, whereas the italics words (e.g. ${xxx}) should be replaced with your specific details.

  • To create a new TBL Asset Collection, use the createProjectService by specifying a new asset collection name and new asset collection name space. 

Send this http request to the destination server

Http requestGET request
Pathtbl/tbl/swp
Parameters: 
_viewClass http://topbraid.org/teamwork#CreateProjectService
_snippettrue
projectType http://tbl.topbraidlive.org/tblprojects#ProjectType
owlImports http://www.w3.org/2004/02/skos/core
spinImports http://topbraid.org/spin/tblconstraints
name${newVocabName}
defaultNamespace${newVocabNameSpace}
  • To load rdf file into the asset collection Use importRDFFileService to load a .ttl file into an existing asset collection.

send this http request to the destination server

Http requestPOST request
Pathtbl/tbl/swp
Parameters:(use Multipart-form data) 
_viewClass http://topbraid.org/teamwork#ImportRDFFileService
_base

urn:x-evn-master:${vocabName} 

projectGraph

urn:x-evn-master:${vocabName} 

formatturtle
recordtrue
file${RDFFileName} (should be the absolute path to that ttl file e.g. C:\Users\user1\Downloads\DBPediaCountryCapitals.sms.ttl, mime-type is application/octet-stream)
  • To deploy a project Use unzipProject service to deploy an entire project (in .zip file) to a destination server. This is the behavior in EDG UI "Send Projects to another server".

create a zip file of the directory of the project first, and send this http request to the destination server

Http requestPOST request
Pathtbl/tbl/unzipProject
Parameters: (use Multipart-form data) 
old_projectupdate
projectName${ProjectName}
project${ProjectName.zip} (the absolute path to that zip file location.
  • To delete a project Use deleteProject service to delete an entire project in the server.

Http requestPOST request
Pathtbl/tbl/deleteProject
Parameters: 
appName${project name}
delNameproject



  • No labels