Skip to main content

Parameters

Script execution parameters

--scriptPath to the Oculix script to execute. This parameter is mandatory. Supports commas for multiple phases: --script a.py,b.py,c.py
--jarPath to the Oculix JAR file. This parameter is mandatory.
--confPath to the .conf configuration file with Pandora and connection parameters. This parameter is mandatory.
--workspaceWorking directory for Oculix script execution. Optional.
--debugDebug verbosity (0 silent → 3 very verbose)
--consoleEnables Oculix console mode. Activated with the flag.
--native-accessEnables --enable-native-access=ALL-UNNAMED in Java execution. Activated with the flag.
--checkpointEnables baseline logic: if no reference image exists, creates one from the current screenshot. Activated with the flag.
--artifactsDirectory where screenshots, baselines, and diffs are stored. Default "artifacts".
--phase-namesPhase names separated by commas (e.g. Login,Search,Logout). If omitted, the script stem is used. Also configurable in .conf as phase_names. CLI overrides .conf.
--transactionGlobal transaction name. If set, Global_Status_{name}, Global_Time_{name} and Global_Last_Image_{name} modules are generated. Also configurable in .conf as transaction_name. CLI overrides .conf.
--retriesNumber of retries for the full transaction (default: 1). If any phase fails, all phases are retried from the start. Also configurable in .conf as phase_retries. CLI overrides .conf.

Pandora configuration parameters (.conf file)

separated by commas (e.g. Login,Search,Logout). If omitted, the script stem is used. Overridable by --phase-names CLI.
agent_nameName of the agent that will contain the modules. Default: "{script} Oculix".
agents_group_nameAgent group in PandoraFMS. Default "Oculix".
module_prefixPrefix for all modules created by the plugin.
intervalAgent monitoring interval in seconds. Default 300.
agent_pluginOutput mode: 1 prints XML to console, 0 writes to file and transfers. Default 0.
temporalTemporary directory for XML files. Default "/tmp".
transfer_modeTransfer mode: "tentacle" or "local". Default "tentacle".
tentacle_clientPath to the tentacle_client binary. Default "tentacle_client".
tentacle_ipIP address of the tentacle server. Default "127.0.0.1".
tentacle_portTentacle connection port. Default "41121".
tentacle_optsExtra options for tentacle connection.
data_dirPandoraFMS data directory for local transfer. Default "/var/spool/pandora/data_in/".
phase_namesPhase names
transaction_nameGlobal transaction name. If set, Global_* modules are generated. Overridable by --transaction CLI.
phase_retriesNumber of retries for the full transaction (default: 1). Overridable by --retries CLI.