Changing settings

You can alter your environment settings either by changing System Properties or Bundle Configurations.

There are two different types of settings you can change in your Runtime to modify its behavior:

• System properties: shared across the entire runtime environment
• Bundle configurations: specific values affecting only a bundle, managed by the OSGi Config Admin service.

Runtime system properties

System properties are setup values that are valid to the entire runtime environment.

The path separator used for configuration strings on Windows development machines is always "/" - i.e. Linux slash

When the mbs.metatype.use80Serialization system property is set to true, metatype objects serialization from 8.0 release is used. This excludes enum and attribute order support and enables old Remote Manager versions to work with newer Bosch IoT Edge Services Runtime versions. Its default value is false.

Setting up system properties before starting your runtime

You can have system properties ready at runtime setup by using Java system properties specified in text property files. You can specify system properties in the default files common.prs from the bin/vms directory and default.prs from the bin/vms/<vm_name> in your runtime installation. The common.prs is applied to the runtime no matter which JVM you are using and the default.prs properties are only applied for the specific JVM where the file is included.

An example of three system properties in the common.prs file:

mbs.output = remote
mbs.output.remote.host = 127.0.0.1
mbs.output.remote.port = 2020

Viewing your current system properties

• Use the console commands:

  set

  to view all current system properties.

  set mbs.output

  to view the mbs.output system property value

  set -c mbs.

  to view all system properties that contain the word "mbs.", the "-c" argument works as a string searcher.

• Use the Web Console, refer to the Administrating the Framework section in Working with web console.
• Use the getProperty method of the org.osgi.framework.BundleContext bundle-specific object or the getter methods of the com.prosyst.util.common.PropertyUtils framework utility.

More information about the system properties can be found in the List of system properties section in the Framework's Setup guide.

Setting up system properties after starting your runtime

Via console commands

To modify a system property at runtime use the text console (Command Prompt or via Telnet) to invoke the set command:

set mbs.output=remote

If the bundle whose system properties you have set is already started, a restart is necessary to apply the changes.

Runtime configuration values

Configuration is the process of providing configuration data to bundles running in the framework, using the OSGi Configuration Admin service. An application that needs to have configurable objects has previously registered a Managed Service or a Managed Service Factory.

Default configurations can be initiated at bundle installation by adding such configurations as an XML file in the bundle JAR. When a bundle is installed in the OSGi framework, the Metatype Bundle inspects the bundle for availability of configuration metadata. This is determined by looking for Config and FactoryConfig as headers in the bundle manifest, or by Metatype XMLs within the OSGI-INF/metatype directory of the bundle JAR file.

Each configuration object is a property that belongs to a specific PID or FPID - the PID or FPID are associated with the service.

• PID: A PID uniquely identifies a service or object within the OSGi stack that requires a configuration dictionary to be provided by the Configuration Admin service.
• FPID - Factory PID: A factory PID is used to group a set of services or objects sharing a common type but having different configuration parameters.

Viewing your current configuration values

Via console commands:

• Display all available PIDs or FPIDs for all bundles in the runtime

  config.ls

  Since all of these PIDs or FPIDs will include properties you can change, you can also list all the properties as shown below:

• Display all available PIDs and FPIDs with their properties for all bundles in the runtime

  config.details

• Display all available properties for a specific PID or FPID

  config.details <PID/FPID>

Setting up configuration values

Via console commands:

• The command structure is: config.update PID_name {prop1=value1,prop2=value2...}
• Example:

  Change the property tostore from true to false on PID mbs.log.pid

  config.update mbs.log.pid {tostore=false}