Skip to content

About Scripting in Octoplant

Scripting in Octoplant extends system functionality and automates workflows. Scripts can:

  • Validate parameters and configurations
  • Transfer or preprocess project data
  • Create and manage backups
  • Start external applications or tools, such as engineering editors or diagnostic utilities. For concrete examples, refer to Script package.

Scripts run as part of the Octoplant process flow. Octoplant creates an interface file, starts the script, and evaluates the result.
For the full workflow overview, see Script execution process.

Script types

You can extend Octoplant functionality with Scripting in two ways:

  • Script files: Plain-text files (for example, SCRIPT) interpreted by the script engine. They contain commands and functions written in the script language.
  • Script applications: Compiled executables (for example, EXE or BAT) that Octoplant calls with parameters.

Scripts are triggered by defined events on the server or client side. Typical trigger events include:

  • Before and after check-in
  • Before and after check-out
  • Before and after upload
  • Before and after backup creation
  • Before and after comparison
  • When opening components or editors
  • When closing components or editors

For a complete list of events see:

Data handling and synchronization

Scripts and related files are stored in different directories depending on where and how they are used. After creating your script files, you place them in the required directories in the AdminClient so that Octoplant can synchronize and use them.

Script directories

  • Local scripting directory: Contains script files used only where the AdminClient is installed. These files remain local and are not synchronized.
  • Server scripting directory: Contains scripts that run exclusively on the server. These files are not distributed to clients.
  • Server scripting directory for automatic update of client: Contains client-side scripts and related files that must be available on all UserClient installations. Octoplant automatically synchronizes this directory with connected clients.

Data consistency and security

Use Scripting to:

  • Enforce validation rules before storing or comparing data
  • Standardize backup handling
  • Integrate external analysis or conversion tools
  • Log relevant process information in a consistent format

Warning

Only use script files and applications from trusted sources. Malicious or modified files can compromise system security.

For configuration, management, and deployment of scripts, use the Script management module in the AdminClient.

Related topics