CQE Repository Script Management Guide
Learn how to manage, execute, and monitor script registration in the CQE (Custom Query Engine) Repository.
📋 Overview
The CQE Repo List provides a centralized repository for your maintenance and diagnostic scripts. You can store scripts once and deploy them across any number of logical servers (LSVR) with custom execution parameters.
🔍 Script Details & Execution
When you click on a script in the list, the detail modal opens with the following capabilities:
1. Script Content
View the full source code of the script. This is read-only in the list view; use the edit feature if modifications are needed.
2. Execution Settings (NEW)
Before registering a script to a server, you can configure how it should run:
- Active: Toggle whether the script is enabled for the selected servers.
- Repeat: If enabled, the script will run periodically.
- Interval (min): Set the frequency for repeated execution (in minutes).
- Start Date: Specify when the first execution should occur.
3. Server Registration (LSVR Queue Put)
You can select one or more servers from your current project to receive this script.
- LSVR Selector: Use the checkboxes to choose target servers.
- Add to Queue: Click this button to register the script with the defined settings for all selected servers.
📊 Script Usage Status
At the bottom of the modal, the Usage Status Table displays all servers currently registered for this specific script.
- Hostname: The name of the server using the script.
- Usage: The logical server's defined purpose.
- Settings: View the active/repeat/interval status for each registration.
- Last Run: Tracks the last time the script was successfully executed on that machine.
API Reference
For the detailed API specification of this feature, refer to the dedicated guide.
Troubleshooting
| Symptom | Cause | Solution |
|---|---|---|
| Script does not run after adding to the queue | Active is turned off in the execution settings | Enable Active in the detail modal, then add to the queue again. |
| Target servers are missing from the LSVR selector | The selected project has no servers, or the servers belong to another project | Confirm that the correct project is selected at the top. |
| Repeated execution does not work | Repeat is on but Interval (min) is empty | Set the interval to 1 or higher, then register again. |
| Last Run in the usage status is not updated | The target server's agent has not yet received the queue | Check the agent connection and that the start date is in the past. |
🔌 CQE API (for automation)
The UI actions above map to these CQE API verbs (byAK/bySk dispatcher). Each request sends text (verb + parameter names), jsondata (values) and token.
- CQERepoPut
msName msDetail msBody msPer msPrice msType— register a script into the repository.msTypeis one ofps1/cmd/wsf. - CQEQueuePut
mssn lssngroup csn interval active script_type custom_values repeat startdate auid— assign a script to servers.lssngroup: comma-separated LSSN list (one assignment per server).interval: minutes.repeat: 0/1 = one-time, 2 = recursive (re-runs every interval).custom_values: per-server injection → replaces{{CustomVariables}}in the script body.
- CQEQueueGet
lssn hostname os op— the agent polls this to receive the next script body.
Script-body placeholders: {{CustomVariables}} (per-assignment custom_values, injected server-side), {{sk}} (agent token), {{lssn}} (agent LSSN).
Execution limit: the agent runs each script from a temp file with a 60-second timeout; ps1 runs under Windows PowerShell 5.1. Keep scripts short.
Full specification: giipdb
docs/30_Specs/CQE_SPECIFICATION.md.
Version: 1.2
Last Updated: 2026-07-23
Source File: giipv3/public/help/cqerepolist.en.md