Skip to content

Script execution process

Scripts and script applications in Octoplant run only when triggered by defined events on the server or client side.

Info

The process below applies to both script files and script applications (EXE, BAT).

  1. Scripting is enabled and configured
    An administrator enables Scripting in the AdminClient under Global settings → Scripting and assigns scripts to events in the Script management module.

  2. An event occurs
    A user or system operation (for example, upload, check-in, compare, open editor) triggers an event that has a script assigned.

  3. Octoplant checks the initialization file to determine what script to run.

  4. Octoplant creates the interface file
    Octoplant generates an interface file that contains information about the component, user, job, paths, and context of the event. Example: ScriptBeforeEdit.ini specifies which SCRIPT file or EXE should be used for a given component type.

  5. Octoplant calls the script or script application
    Octoplant passes the path to the interface file as a parameter.

  6. The script reads the interface file
    The script reads the interface file, performs its configured action (for example, validation, file operations, calls to external tools), and writes results, warnings, or error codes.

  7. Octoplant evaluates the result
    Depending on the event and configuration, Octoplant:

    • Continues the standard workflow
    • Modifies the workflow (for example, skip upload, use prepared backup)
    • Displays warnings or error messages based on the script output

For analysis and troubleshooting, use the Script management module, log files, and diagnostic tools in the AdminClient.

Related topics