Setup Guide

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

Prerequisites

OPTIONAL – Only if you need a user friendly Web interface.

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:

Go to the text console and make sure the the Kit Manager bundle is available on your runtime.
To initiate the installation type:
kitman.install "<kit_ID>"

where <kit_ID> is the ID of the component's install script. The following scripts are available in the bin/pscripts directory:

"Functional Item Management"
"Functional Item Management Web API"
"Functional Item Management Web JS Lib"
"Functional Item Management Web Admin"
"Functional Item Management JSON-RPC"
"Functional Item Management REST"

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

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 FIM module, please install and start the following bundles:

com.prosyst.mbs.fim.api.jar
com.prosyst.mbs.fim.core.jar
com.prosyst.mbs.fim.commands.jar
com.prosyst.mbs.fim.inventory.jar
com.prosyst.mbs.fim.jsonrpc.jar
com.prosyst.mbs.fim.web.api.jar
com.prosyst.mbs.fim.webconsole.jar
com.prosyst.mbs.fim.web.jslib.jar
com.prosyst.mbs.fim.rest.api.jar
com.prosyst.mbs.fim.rest.core.jar
com.prosyst.mbs.fim.rest.groups.api.jar

System Properties

Property	Type	Default Value	Description
mbs.fim.validation.enable	boolean	false	Enables the validation mode for abstract functional items. Checks the FI UID, object classes list, property names, getter/setter methods, operation names and methods.
mbs.fim.data.clean.onUninstall	boolean	true	Defines if the user data stored for a functional item should be automatically removed on its bundle uninstall. It has no influence on a FI bundle restart (in this case all data is stored and as a result after next FI registration it will have its name/tags automatically loaded from the DB). Additionally it will be automatically added in its groups again.

Configuration Properties

There are no configuration properties defined for this module.

Troubleshooting

No troubleshooting information is available for this module.