Open the menu

    Installation Script

    This script will be executed when the component is installed. This file is an XML format file that must follow the lumis-component-install.xsd schema, the link to which is included in API and XSD. In addition to this script, the portal may execute additional steps, such as:

    • Service registration
    • Theme registration
    • Business context registration
    • Observer registration
    • File copying
    • Structure import

    These additional steps are automatically handled by the portal and, therefore, do not need to be explicitly described in the script. It is important to note, however, that these steps will be taken for resources belonging to the component in question. Even if the component does not have this script, the additional steps will be executed by the portal.

    The types of steps available for the installation script

    The installation script provides the following types of steps:

    • Execute SQL command: Executes an SQL command on the database.
    • Execute database definition file: Takes a database definition file as input and executes the commands generated from that file.
    • Execute a Java class: Executes a Java class on the server.
    • Display a message: Displays an informational message.
    • Cleanup of unreferenced global items: Removes global items (global styles of interface instances, CSS records, and file transformation parameters) that are unreferenced.
    • Cleanup of Document Types from the standard Big Data repository.