Back to contents pageHow to create and install a service package

How to create and install a service package

Summary

This article shows how to create a service package from your user-defined service so that you can install it into a Ubisense dataset.



Prerequisites

You should know the information in the following articles:



Example material

Save this link to get a zip file of the example material


Guide

Why create and install a package?

If you have written a server program to maintain some user-defined schema, you will want it to run automatically in the background, along with all the other Ubisense services. You can install your own services alongside the Ubisense services in your dataset.



Creating a package

In the Data Dictionary Editor, click on Deployment > Package Builder. The following dialogue box will appear. This article assumes we are generating a package for the CarModule example from How to create a user model using Data Dictionary. Enter the Vendor and Package names. You can choose your own names. The relevance of these names is that they will be shown in the list of services in Service Manager, so you can check the standard Ubisense services in the list for example names.



Define your service

Click on Add... to add your service to the package. The following dialogue box will appear. Enter the service name and version. Again, the relevance of this name is that it will be shown in the list of services in Service Manager. Leave the level as "Site". Select your service executable and add the libraries on which it depends, which are usually all located in the same compilation output directory.





Add your service to the package

Click OK and your service will appear in the list.





Save and generate your package

It is now a good idea to save the options that you have just entered. Click on File > Save As... to do this.

Now you need to generate the package that you have defined. Click on File > Generate package... to do this, specifying the location and the name of the XML file that will contain your package definition.





Installing your package

Finally, you can install the package that you just generated by using the Service Installer tool. Find this from the Start menu > All Programs > Ubisense 2.1 > Service Installer. Click through and locate the directory that you chose when you clicked on "Generate package" in the previous step. You will then find your package description file. Select it by checking the box and click through to the end.



Check your service status

Now your service will have been automatically deployed. Find it in Service Manager to confirm that it is running without any problems.







What's next?

Now you can run any client applications that connect to the schema serviced by your service without having to start the service yourself. If you have not already gone through it, see How to create a client application for a user-defined schema.





Back to top