Adding a Subsystem to the IBase Report

Scenario: You installed and added IBase to a project. By default, the IBase script generates a report that covers only the management platform objects. You now want to expand the report so that it also covers the objects of an integrated subsystem. This requires creating an IBaseConfigurationScript.json file for the subsystem, that will be invoked whenever you run the main IBase script.

 

Reference: For background information see IBase Configuration File.

 

Workflow diagram:

 

Prerequisites:

  • You configured the IBase report functionality in Desigo CC. See Setting Up IBase.

 

Steps:

1 – Create the Subsystem-Specific IBaseConfigurationScript.json File
  • The IBaseSampleConfiguration.json file is available under
    [Installation Drive]:\[Installation Folder]\[Project Name]\libraries\Global_IBase_HQ_1\Scripts.
  • You obtained the subsystem-specific configuration details that you want to add in the IBaseConfigurationScript.json file including their networks, drivers, and devices along with their properties.
  1. Save a local copy of the IBaseSampleConfiguration.json file on the disk and rename it IBaseConfigurationScript.json.
    NOTE:     You must rename the configuration file so that the IBase Script, when executed, can identify the configuration file and include it when generating the IBase report.
  1. Open the file in a JavaScript editor.
  1. Add the following configuration details, adhering to the sample structure provided. Make sure that the parent Object Model name is provided, wherever indicated.
  • Network containing Object Model and its properties
  • Driver containing Object Model, its properties and the parent OM
  • Device containing Object Model, its properties and the parent OM
  1. Save the file.

 

2 – Import the IBaseConfigurationScript.json File in the Scripts Block
  • The subsystem extension for which you want to import the IBaseConfigurationScript.json file is installed and configured in the project.
    NOTE: For a subsystem extension, there may be two IBaseConfigurationScript.json files, one for devices and another containing the Network and Driver configuration details.
  • System Manager is in Engineering mode.
  1. In System Browser, select Management View.
  1. To verify if the scripts library for the extension is available at the defined customization level—below HQ or L-4 project, depending on your access rights—do the following.
    a. Expand Project > System Settings > Libraries.
    b. Under Libraries, navigate to the extension library.
    NOTE: For example, the 3rd party BACnet extension module has two script libraries and hence you need to verify the following two scripts
    L1-Headquarter > Global > BACnet > Scripts and
    L1-Headquarter > BA > Device > BACnet > Scripts
    If the scripts block is not available, you must first create the Script block for the extension library.
  • Scripts block added as per the defined customization level below HQ or L-4 project, depending on your access rights.
  1. Select the newly created Scripts folder in the library and import the scripts (IBaseConfigurationScript.json files that you created for the extension module).
    NOTE: For example, for a 3rd party BACnet extension module, you must import two configuration files, one for network and drivers and another for devices.
    For more information, see the section Configuring Scripts Libraries.
  • The scripts are imported under the Scripts folder in the extension module scripts library in the project.
    When the IBase Script is executed, the IBaseConfigurationScript.json file for the extension is searched and executed providing the report for that extension.