CQE Queue Registration Guide

Learn how to register a CQE (Custom Query Engine) script as a schedule on a specific logical server (LSSN). Set the target server, execution interval, and start time, then register it to the queue.

🚀 Go to CQE Queue Registration →

🔄 End-to-End Flow (CQE Flow)

flowchart TD
    A[Admin: CQERepoPut<br/>Register script in repo] --> B[tMgmtScript<br/>Script Repository]
    B --> C[Admin: CQEQueuePut<br/>Assign schedule to servers]
    C --> D[tMgmtScriptList<br/>Per-LSSN schedules]
    D --> E[Agent: CQEQueueGet<br/>Periodic polling]
    E --> F[tMgmtQue<br/>Receive ms_body from queue]
    F --> G[Agent: Execute<br/>script locally]
    G --> H[KVSPut<br/>Report result]
    style A fill:#e1f5fe
    style B fill:#b3e5fc
    style C fill:#e1f5fe
    style D fill:#b3e5fc
    style E fill:#e8f5e9
    style F fill:#c8e6c9
    style G fill:#fff9c4
    style H fill:#ffccbc

📋 Overview

CQE Queue Registration assigns a registered script as a schedule on one or more logical servers (LSSN). Once you set the target server, execution interval, and start time, and register to the queue, each server's agent polls the queue periodically to receive and execute the script.

Script registration and execution settings are managed on the CQE Repository List (/en/cqeRepoList). This page is for assigning an already-registered script to servers.

🔍 Screen Layout

1. Script Selection (mssn)

Select the script to execute from the list of registered scripts. Only scripts registered in the CQE repository are shown.

2. Target Servers (lssngroup)

Enter the logical server IDs (LSSN) to assign the script to, separated by commas. Example: 70371,70372,70373 Click the server-select button to open a popup listing servers registered under the current project (csn).

3. Execution Settings

• Active: Whether to activate the schedule immediately after registration. If off, the script is registered but will not run.
• Repeat: 0 or 1 = one-off, 2 = recursive (repeats every interval).
• Execution Interval (minutes): Set the repeat interval in minutes.
• Start Date: The UTC time when the first execution begins.

4. Script Type (script_type)

Select the execution type: ps1 (PowerShell), cmd, wsf, cmdui, ps1ui. See the "🔌 CQE API" section of the CQE Repository Script Management Guide for detailed differences.

5. Custom Variables (custom_values)

An optional field. Enter server-specific values to be substituted for {{CustomVariables}} in the script body.

6. Queue Registration

Once all settings are configured, click this button to register the script as a schedule on the selected servers.

⚙️ Requirements

• Requires a logged-in session (CSN).
• The script must already be registered in the CQE repository.
• Target LSSN must be registered under the current project.

💡 Important Notes

• Start date must be entered in UTC. Entering a local time directly may cause the agent to treat it as a future time, permanently preventing script execution.
• The {{sk}} and {{lssn}} placeholders in the script are automatically injected by the agent at runtime.
• For one-off (repeat=1) schedules, active drops to 0 after a forced run. To continue recursive execution, you must manually reactivate it.

🔌 CQE API (for automation)

The UI actions above map to these CQE API verbs.

• CQEQueuePut mssn lssngroup csn interval active script_type custom_values repeat startdate auid
  • mssn: script unique ID
  • lssngroup: comma-separated LSSN list
  • interval: execution interval in minutes
  • repeat: 0/1=one-off, 2=recursive
  • startdate: start date (UTC)
  • custom_values: value for {{CustomVariables}} substitution
• CQERepoPut — register script in repo
• CQEQueueGet — agent polling the queue

Full specification: CQE Repository Script Management Guide, giipdb docs/30_Specs/CQE_SPECIFICATION.md.

---

Version: 1.0 Last Updated: 2026-09-19 Source File: giipv3/public/help/cqeQueuePut.en.md