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:

• RESTful Web Services (REST)
• Functional Item Management (FIM)
• Ditto bundles from Externals module

Installation

Automated Installation

The Kit Manager is a utility that enables you to automatically install one or a group of components by executing a predefined install script. For the Things REST API module the kitman scripts are:

• Things REST
• Things REST Compact when using the compact versions of the RESTful web services.

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 "Things REST"

If you want to view or edit the content of this script you can find it in the <bosch.iot.sdk_home>/runtime/osgi/bin/pscripts directory in things.rest.txt and things.rest.compact.txt.

To use the compact versions of the RESTful web services, type:

kitman.install "Things REST Compact"

Now your runtime is running together with:

• REST module to provide the Web Services;
• FIM and Things Agent, for creating functional items and converting them to Things.
• Ditto External bundles.

Manual Installation

You can install (and start) one by one only the bundles you need. Take into account their dependencies on other bundles. Find which are the bundles you need to install in the kitman scripts of:

• Web Services REST (refer to webservices.rest.txt) or Web Services REST Compact (refer to webservices.rest.compact.txt)
• Functional Item Management (refer to fim.txt)
• Things Agent (refer to things.agent.txt)

All module bundles themselves are located in the <bosch-iot-edge-services-sdk>/runtime/osgi/bundles directory.

After installing successfully the bundles of the dependent modules, refer to things.rest.txt and install the bundles of the Things REST API module:

• com.prosyst.mbs.things.agent.api.jar
• com.prosyst.mbs.things.agent.core.jar

• minimal-json.jar
• ditto-json.jar
• ditto-model-base.jar
• ditto-model-policies.jar
• ditto-model-things.jar
• ditto-model-rql.jar
• ditto-model-rql-parser.jar
• ditto-model-query.jar
• ditto-model-thingsearch.jar
• ditto-model-thingsearch-parser.jar
• ditto-protocol-adapter.jar

• com.prosyst.mbs.things.rest.api.jar
• com.prosyst.mbs.things.rest.core.jar

After successful installation of the module and after the setup of the configuration via:

• Thing Agent and its configuration or
• ThingAdmin, selfConfig and system properties set,

the RESTful API is available under localhost and you can access the endpoints.

System and Configuration Properties

There are no properties defined for this module.

Troubleshooting

No troubleshooting information is available for this module.