Setup Guide

Installation and configuration of the Functional Item Management in the OSGi environment.

Prerequisites

As mentioned in the Module Description page the following modules need to be installed as well:

• Functional Item Management
• Database SQlite

Installation

Automated Installation

The Kit Manager is a utility that enables you to automatically install a component or a group of components by executing a predefined install script.

To use the Kit Manager to install a component:

1. Go to the text console and make sure the the Kit Manager bundle is available on your runtime.
2. To initiate the installation type:

   kitman.install "History"

   If you want to view or edit the content of this script you can find them in the <bosch.iot.sdk_home>/runtime/osgi/bin/pscripts directory.

3. To use the Web Console plugins, type:

   kitman.install "History Web Admin"

Manual Installation

You can install (and start) one by one only the bundles you need, taking into account their dependencies on other bundles. All the bundles for this module can be found in the <bosch.iot.gateway.sdk_home>/runtime/osgi/bundles directory.

In order to install the History module, you have to install and start the following bundles in the this order:

• com.prosyst.mbs.db.sqlite.natives.win_x86_64
• com.prosyst.mbs.db.sqlite
• com.prosyst.mbs.db.sqlite.commands
• com.prosyst.mbs.fim.api
• com.prosyst.mbs.fim.core
• com.prosyst.mbs.fim.commands
• com.prosyst.mbs.history.api
• com.prosyst.mbs.history.core.sqlite
• com.prosyst.mbs.history.core
• com.prosyst.mbs.history.producers
• com.prosyst.mbs.history.commands

If you want to use the History Web Console plugin, you have to install its bundle - com.prosyst.mbs.history.webconsole.jar as well the bundles of:

• Web Console – refer to the web.txt from the <bosch.iot.sdk_home>/runtime/osgi/bin/pscripts folder to explore which are the required bundles.
• Functional Item Management Web API – refer to the fim.web.api.txt from <bosch.iot.sdk_home>/runtime/osgi/bin/pscripts folder to explore which are the required bundles.

As a result the bundles to be installed for managing history entries would be:

• com.prosyst.mbs.web.console.branding
• org.osgi.service.obr
• org.apache.commons.fileupload
• org.apache.felix.inventory
• org.apache.felix.webconsole
• org.apache.felix.webconsole.plugins.useradmin
• org.apache.felix.webconsole.plugins.event
• com.prosyst.mbs.web.api
• com.prosyst.mbs.web.console.auth.pass
• com.prosyst.mbs.web.console.shell
• com.prosyst.mbs.web.console.top
• com.prosyst.mbs.util.inventory
• com.prosyst.mbs.websockets.api
• com.prosyst.mbs.websockets.core
• com.prosyst.mbs.websockets.commands
• com.prosyst.mbs.websockets.javax
• com.prosyst.mbs.websockets.javax.commands8
• com.prosyst.mbs.policyadmin.api
• com.prosyst.mbs.policyadmin.commands
• com.prosyst.mbs.policyadmin.identity.condition
• com.prosyst.mbs.policyadmin.identity.useradmin9
• com.prosyst.mbs.policyadmin.policy
• com.prosyst.mbs.policyadmin.core
• com.prosyst.mbs.policyadmin.http.websockets
• com.prosyst.mbs.websockets.wa.events.handler
• com.prosyst.mbs.websockets.events.endpoint
• com.prosyst.mbs.webservices.jsonrpc.api
• com.prosyst.mbs.webservices.jsonrpc.core
• com.prosyst.mbs.webservices.jsonrpc.handler.backup
• com.prosyst.mbs.webservices.jsonrpc.handler.config
• com.prosyst.mbs.webservices.jsonrpc.handler.event
• com.prosyst.mbs.webservices.jsonrpc.handler.platformstate
• com.prosyst.mbs.webservices.jsonrpc.handler.resourceprovider
• com.prosyst.mbs.webservices.jsonrpc.handler.useradmin
• com.prosyst.mbs.webservices.jsonrpc.invoker.policy
• com.prosyst.mbs.webservices.jsonrpc.event.websocket.endpoint
• com.prosyst.mbs.webservices.jsonrpc.event.websocket
• com.prosyst.mbs.fim.jsonrpc
• com.prosyst.mbs.fim.web.jslib
• com.prosyst.mbs.fim.web.api
• com.prosyst.mbs.history.webconsole

System Properties

Configuration Properties

There are no configuration properties defined for this module.

Troubleshooting

No troubleshooting information is available for this module.