Skip to main content

XProtect Smart Client

Generate a script reference

Last Updated: 1 minute read
Version2026 R2
LanguageEnglish

You can generate a Markdown reference file (.md) with all available script commands, syntax examples, and actions supported by your current installation of XProtect Smart Client. The script reference is your on-demand quick reference for supported commands and syntax, eliminating guesswork and syntax errors when authoring scripts.

Steps

  1. In XProtect Smart Client, on the global toolbar, select Settings and more SC_GlobalToolbar_SettingsAndMore_icon.jpg and then Settings.

  2. Select the Scripts tab.

  3. Select Generate script reference….

  4. In the dialog that appears:

    • Select Include configuration items if you want the reference to include items specific to your VMS setup, such as views, user-defined events, and outputs.

    • Deselect Include configuration items  if you only want general, built-in client commands.

  5. Select a destination folder and name the Markdown file (.md), then select Save.