Additional IBase Procedures

The following procedures provide additional information on accessing and executing IBase Scripts.

Manually Execute the IBase Script

  • A valid IBaseConfigurationScript.json file for the extension modules that you want to include in the IBase report is available at the location
    [Installation Drive]:\[Installation Folder]\[Project Name]\libraries\[Library Name]\Scripts.
  1. In System Browser select Application View.
  1. Select Applications > Logics > Scripts > System Information > IBase Script.
  1. In the Operation tab, select the Status property.
  1. Click Start.
    NOTE: You can only manually start the script if the Status property is Idle.
  • The script starts and the Status property changes to Running.
  • When the script finishes, it generates the IBase report at the following path on the Server station of the management platform:
    [drive:]\[installation folder]\[project]\shared\scripting\IBaseReport.

 

Check the Progress and Outcome of the IBase Script in Script Editor

  • The IBase script was executed manually and you want to view information about its progress or outcome.
  1. In System Browser, select Applications > Advanced Applications > System Information > IBase Script.
  1. In the Scripts Editor tab, open the Console expander.
  • It displays information about the currently executing IBase Script, including the location of the report generated, the total number of IBaseConfiguration files executed, whether execution was successful, and so on.
    Any warnings or errors are displayed in the Error List expander.

Related topics

IBase Script in Script Editor

Script Execution Credentials

 

Access the IBase Report

  • The IBase script was previously executed, either manually or automatically. You now want to access the resulting IBase report.
  1. Navigate to the following path on the Server station of the management platform: [drive:]\[installation folder]\[project]\shared\scripting\IBaseReport.
  • The IBase report is an XML file with the naming convention:
    SiteInfo_[CSID]_[System Name].xml.
  1. Open the IBase report that you want to view in an XML editor, for example Notepad ++.
  1. Depending on the configurations provided in the IBaseConfigurationScript.json, the report provides information related to management platform and the extension module-specific objects.
    NOTE: You may verify the report with the information provided in IBaseConfigurationScript.json for the extension modules.

 

Configure Automatic Execution of the IBase Script

When you install the IBase extension, a preconfigured timing reaction is added that can be enabled to automatically generate the IBase report at regular intervals.

NOTE:
To carry out this task the reaction license must be installed.

Enable the Timing Reaction

  • System Manager is in Engineering mode.
  1. In System Browser, select Application View.
  1. Select Applications > Logics > Scripts > System Information > IBase Script.
  1. In the Operation tab, do the following:
  • Enable the Operational Status of the script.
  • Stop the script.
  1. Select Applications > Advanced Applications > System Information.
  1. In the Extended Operations tab, do the following:
  • Set Active = True and click Apply.
  • Set Policy Compliance = Confirmed and click Apply.
  • The IBase Script is now automated and will run at the time and date set in the preconfigured reaction (Timing).

Set When the Timing Reaction Executes

Perform these steps only if you want to modify the time or date when Timing reaction runs the IBase Script.

  1. In System Browser, select Applications > Logics > Reactions > System Information > Timing.
  1. In the Time and Organization Mode expander, click the preconfigured row that by default sets Time and Effective Days. See Time and Organization Mode Conditions Reference.
  1. To change the time of day when the IBase report is generated, click in the Time field and set a different Start Time.
  1. To change the days when the IBase report is generated, click the Effective days field. From the drop-down list, set the desired type of recurrence.
    NOTE: It is recommended not to change the other conditions of the preconfigured Timing reaction.
  1. Click Save.
  • The IBase Script will automatically run and generate the IBase report at the time/date specified in the Timing reaction.
    On successful execution, it generates the IBase report under
    [Installation Drive:]\[Installation Folder]\[Project Name]\shared\scripting\IBaseReport.

Disable Automatic Execution of the IBase Script

  • System Manager is in Engineering mode.
  1. In System Browser, select Applications View.
  1. Select Applications > Advanced Applications > System Information.
  1. In the Extended Operations tab, do one of the following:
  • Set Active = False
    OR
  • Set Policy Compliance = Unconfirmed.
  1. Click Apply.
  • The IBase Script is deactivated and will not start according to the configured reaction (Timing).

 

Disable Automatic Execution of the IBase Script

  • System Manager is in Engineering mode.
  1. In System Browser, select Applications View.
  1. Select Applications > Advanced Applications > System Information.
  1. In the Extended Operations tab, do one of the following:
  • Set Active = False
    OR
  • Set Policy Compliance = Unconfirmed.
  1. Click Apply.
  • The IBase Script is deactivated and will not start according to the configured reaction (Timing).