There are different ways to configure the three working modes of Azure IoT adapter. The Initial Configuration Loader from the OSGi module helps you provide initial configuration values, through embedding properties file in the Bosch IoT Gateway image.

The com.prosyst.mbs.osgi.cm.bundle.jar provides the functionality of the Initial Configuration Loader by default. It calls the factory for each FPID to create configurations with PID's corresponding to the names of the .properties files inside each FPID folder. The number of the files inside a FPID folder equals the number of the configurations created with the initial values of the properties described in each .properties file.

Once you have obtained your desired Bosch IoT Gateway image, follow the steps below to create folders and sub-folders with the properties files, which will be used by the corresponding factory to create configurations with the initial values you want.

1. Create a config sub-folder in the ../runtime/osgi folder of the Bosch IoT Gateway image:

   

2. Decide which profiles you will use:

   the common profile, which comes with the Initial Configuration Loader

   With the common profile, you skip specifying the system property com.prosyst.mbs.osgi.cm.config.profiles, which is used for creating customer profiles.

   • your own profiles, which you have to set via com.prosyst.mbs.osgi.cm.config.profiles system property in common.prs file, located in osgi/bin/vms folder

   To provide your own profiles, you have to use the com.prosyst.mbs.osgi.cm.config.profiles system property. Its value is a comma separated list of profile names.

   For example, to create the new mySolution profile, you have to edit and save the common.prs file via adding the com.prosyst.mbs.osgi.cm.config.profiles= mySolution line as follows:

   

3. Create a folder for each profile right under the ../osgi/config folder with the same name as the profile you have decided to use in step 2. This folder is for holding the different sets of initial configuration values per profile you will provide in step 4.
   • If you have decided to use common profile of the Initial Configuration Loader, create a common set. The directory structure will be ../osgi/config/common:

     

   • If you want to use your own profile, e.g. mySolution, the directory structure for it will be ../osgi/config/mySolution:

     

4. Create a special folder for each of the factory configurations. The name of the folder will be later used as FPID for each of them.
   •  ../osgi/config/common/<FPID> – when using the common profile

     

   •  ../osgi/config/<your_Profile>/<FPID> – when using your own profile.

     For mySolution profile it is the factory com.prosyst.mbs.azure.iot.adapter.messages.fpid used for creating configurations as in the screenshot below.

5. Provide separate PROPERTIES file in the folders above for each configuration the factory you want to build. Refer to the Example below. In its step 5 see the following configurations that will be created, at the end of the list under Azure IoT Adapter Message Configuration.

   

   The name of the file will be used as PID of the configuration:
     • ../osgi/config/../<FPID>/<PID>.properties
   For more information refer to the Initial Configuration Loader.

Example

Let's use the common profile to provide properties for one configuration that will be generated by the factory with FPID com.prosyst.mbs.azure.iot.adapter.devicetwin.fpid.

1. Go into the ../osgi folder of your Bosch IoT Gateway image.
2. Add config/common/com.prosyst.mbs.azure.iot.adapter.devicetwin.fpid set of folders.
3. Add a file with the name of DIGITAL_TWIN_PID.properties, If you want to use DIGITAL_TWIN_PID as PID of your configuration.
4. Provide key:value pairs for the properties you want in the file above – for more information on key:value pairs, refer to Initial Configuration Loader.

   You are not obligated to set all properties in this file.

   As a result the directory structure and the properties file will be as the following:

   ../bosch-iot-edge-services-sdk/runtime/osgi/config/common/com.prosyst.mbs.azure.iot.adapter.devicetwin.fpid

    

   # version = 2.0

   name:String=<NAME_OF_CONFIGURATION>

   connectionString:String=<CONNECTION_STRING_FOR_IOT_HUB_OR_PROXY_DEVICE>

   connectionTransport:String=<ONE_OF_SUPPORTED_CONNECTION_PROTOCOLS - HTTPS|AMQPS|MQTT|AMQPS_WS|MQTT_WS>

   edgeGatewayHostname:String=<HOSTNAME_OF_AZURE_EDGE_DEVICE>

   edgePathToCertificate:String=<PATH_TO_ROOT_CERTIFICATE_OF_EDGE_DEVICE>

   functionalItemExclusionFilter:String=<LDAP_FILTER_FOR_DEVICES_NOT_TRACKED_BY_THIS_ADAPTER>

   functionalItemInclusionFilter:String=<LDAP_FILTER_FOR_DEVICES_TO_BE_TRACKED_BY_THIS_ADAPTER>

   snapshotReportInterval:Integer=<NUMBER_OF_SECONDS>

   sendOnlySnapshot:Boolean=<TRUE/FALSE>

    

   If you want to provide configurations for any of the other working modes of the Azure IoT Adapter, simply add the corresponding folders and properties files following the pattern:
        •  ../osgi/config/common/<FPID>/<PID>.properties.

   e.g. for the following factories:

   • com.prosyst.mbs.azure.iot.adapter.devicetwin.fpid
   • com.prosyst.mbs.azure.iot.adapter.messages.fpid
   • com.prosyst.mbs.azure.iot.adapter.devicemessages.fpid

   you have to create the corresponding folders:

   

   with the properties files for your custom configuration in each of them.

5. Run the Bosch IoT Gateway Software with Azure IoT Integration module and Web Console installed to view and edit the configurations created.

   If you have set the system property of com.prosyst.mbs.osgi.cm.config.profiles in common.prs file equal to your custom profile name and if you have provided properties files in its FPID folder, your custom configurations would also be available in the list after successful installation of the gateway.

   From the list of the configurations select one:

   

   Its initial configuration values are present in the corresponding fields of the properties, according its .properties file you have provided: