Overview of IBase

• You can generate the report for management platform version 3.0 and above.
• You need to install the Scripts extension module before installing IBase.
• There is no separate license required for working with IBase.
  Using the license for working with the Scripts extension and the appropriate user group rights (application rights on the Script Editor), you can view, configure IBase script.
  For more information, see sections Script License and Access Rights in the Help.

When installed, the IBase extension module adds the IBase script. This IBase script collects the data for a customer project including:

• Information related to date and time when the report was generated, the system or domain or local user with which the project is created (Pmon user) and the host name of the system.
• Management station profile including the software version, project name, extensions and languages configured and so on.
• Objects used by the management station such as graphics, printers and so on. It also includes their properties.
• Subsystems connected to the management station including information about their:
• Panels and their properties
• Controllers
• Areas, doors, IOs, and readers, modules
• Firmware version and serial number, when available
• Number and type of devices monitored and their properties
• Network
• Drivers

The data collected is presented as IBase report. For more details, see IBase Report. The field service representative then must upload the IBase report to the IBase Server.

The IBase report provides field service representatives the information necessary to anticipate requirements prior to arriving at the customer site.

For example, the IBase report can be used to determine the number of installed devices at a customer site. The report can also be useful in product improvements and quality management by tracking services performed on products and installations.

This helps in planning, selling and executing new and existing services.

The IBase script is a pre-configured script (in JavaScript), that becomes available in the Script Editor when you install the IBase along with the Scripts extension module.

• The IBase script (IBaseScript.js file) is located on the disk under
  [Installation Drive]:\[Installation Folder]\[Project Name]\libraries\Global_IBase_HQ_1\Scripts.
• By default, the IBase script is displayed in the Script Editor when you log onto the management station and select Logics > Scripts > System Information > IBase Script in the Application View.
• Operators can manually start IBase script from the Extended Operation tab.
  More typically, however, you will plan an automatic execution of the IBase script using the pre-configured reaction (Timing). See Additional IBase Procedures.
• During IBase script execution, the IBase script traces information messages which can be viewed in the Console expander of the Script Editor.
  For example, if the same configuration is delivered by multiple subsystems, it will be reported in the Console expander and duplicate configuration will be ignored for IBase reporting.
  Similarly the error messages can be viewed in the Error List expander.
• Depending on the customer project size the report execution time can take up to several hours.
• When the IBase script is executed, it internally searches and also executes the configuration file IBaseConfigurationScript.json and generates a report based on the parameters included in the configuration file for the extension module.
• Each time the IBase script is run, the previously generated IBase report is overwritten with the latest report.
• The IBase script can be edited using the Script Editor. The Script Editor guides you in editing the IBase script and checks its validity when the script is saved.
  An invalid script is not executed during runtime operation.

• A sample configuration file (IBaseSampleConfiguration.json) is provided along with IBase that helps you in preparing libraries configuration specific for the extension module for which you want the report to be generated. See Adding a Subsystem to the IBase Report.
• The location of this file is
  [Installation Drive]:\[Installation Folder]\[Project Name]\libraries\Global_IBase_HQ_1\Scripts.
• In order to provide its information, the extension module has to deliver an extension module -specific IBaseConfigurationScript.json containing the list of Object Models and properties that are relevant to the IBase report.
• Unless you include the information related to the libraries of your extension module in the IBaseConfigurationScript.json file, the IBase report cannot include information related to that extension module in the IBase report.
• To do this you must rename the configuration file for an extension module as ibaseconfigurationscript.json by saving a local copy, then modify it as required and later import it in the extension module scripts library, so that the IBase script, when executed, can identify the configuration file and include it when generating the IBase report.
• When the library is imported in to the system (upon project creation via SMC or addition of an extension module to the project or through the library upgrade) the IBase script is loaded in the system.

When you install and configure IBase in the project, the IBase system library including the IBase scripts, Object Model and Texts is added under Libraries.

Only Headquarter experts and customer support are authorized to handle any scripts library located under:

• System Settings > Libraries > L1-Headquarter > Global > IBase > Scripts

If you are authorized, you can customize the IBase library depending on the customization level (for example, L4-Project). You can import the IBase scripts as a part of a scripts library into the system.

Once the IBase library is customized, you can import or delete the IBase scripts in the scripts library using the Scripts Library application. For more information, see Scripts Library.

In a distributed system, you must consider:

• The IBase extension module along with the scripts extension module must be installed and configured in the project on each system in distribution on the single server or different servers.
• Depending on the distribution connection, you run the IBase script for the partner system in distribution. The IBase report is generated for each system for which the IBase script is run. The IBase report is saved in the respective project folder location on each system in distribution
  [Installation Drive:]\[Installation Folder]\[Project Name]\shared\scripting\IBaseReport.
• To view or collect the IBase report (on the partner system), the user must have access to the folder where the IBase report is saved.