Skip to content

Execution, configuration and interface files

Octoplant scripting uses several file types. Each file plays a specific role in how scripts are selected, started, and executed.

File type Purpose Created by Editable
Script file (SCRIPT) Contains script logic interpreted at runtime. Administrator Yes
Script application (EXE, BAT) Runs compiled script files or external tools. Octoplant calls these files with parameters. Administrator Yes (BAT only; EXE is compiled and available in the Script Package)
Initialization file (INI for script applications) Defines which script file or application runs for specific component types. Administrator Yes
Configuration file (INI for script buttons or script parameters) Defines how scripts are called or displayed (for example, button labels, visibility, or assigned script files). Administrator Yes
Interface file Provides runtime event, component, and user data when the script runs. Octoplant No

Configuration files

  • Stored in the script directories in the AdminClient.
  • Read by Octoplant or the script interpreter to select the correct script file or control button behavior.
  • Include:
    • Initialization files for script applications (component-type mappings).
    • Script button configuration files (labels, icons, permissions, assigned scripts).
  • Typical examples:
    • ScriptBeforeEdit.ini — assigns script files or applications to component types.
    • ScriptButton1.ini — defines button labels, visibility, and assigned scripts.

Interface files

  • Created automatically every time a script runs.
  • Passed to the script or script application as a command-line argument.
  • Contain event, component, and user data that the script uses for execution.
  • Deleted when the script execution finishes.

How they work together

  1. Octoplant reads the initialization file to determine which script to run.
  2. It creates an interface file with event, component, and user data.
  3. It passes the interface file path to the script file or script application.
  4. The script uses the interface file to execute its logic.

Related topics