qRules Command Guide
What every qRules command does, its parameters, what it returns, and the behavior that is easy to miss, written from the qRules source code.
Looking for a command? Start at the Command Index: every command A to Z.
First draft. All chapters are written from the qRules engine itself but have not been reviewed yet. Comments are welcome at [email protected].
| # | Chapter | What you learn | Status |
|---|---|---|---|
| 0 | Command Index | Every command A to Z, with what it does and where it is explained | draft |
| 1 | Basics | Running commands, syntax, dynamic parameters, results and errors | draft |
| 2 | Values and nodes | SetValue, GetValue, Copy, Move, Insert, Delete, CopyTable, SortTable | draft |
| 3 | Text, XML and JSON | GetXml, SetXml, Transform, ReplaceString, SetCase, DelimitedList, JsonToXml, XmlToJson, Encode, ConvertBase64, CopyRichText, DiffRichText, GenerateGuid, Encrypt, Decrypt | draft |
| 4 | Dates and numbers | DateAdd, DateDiff, FormatDate, FormatNumber, GetDayOfYear, GetWeekDay, Irr, Npv | draft |
| 5 | Validation and errors | GetErrorCount, GetErrors, ClearErrors, SetValidationMode, WriteLog | draft |
| 6 | Form, view and UI | GetInputParameter, GetFormProperty, GetEnvironmentVariable, LoadResource, SetDefaultView, SetAutocomplete, SetCharacterLimit, UseOption, Prompt, RegisterMultiDrop | draft |
| 7 | Data connections and web requests | ChangeConnectionUrl, ChangeSubmitUrl, GetConnectionUrl, ExecuteSqlQuery, ModifySqlQuery, MakeRequest | draft |
| 8 | SharePoint | SubmitToSharePoint, SubmitToSharePointList, RefreshSharePointListItems, SaveToSharePoint, DeleteFromSharePoint, CreateSharePointFolder, GetListGuid, GetUserProfileByName, GetTermPath, GetTermSetIds, GetTermSets, GetTermsByLabel | draft |
| 9 | DBXL | SubmitToDbxl, SaveToDbxl, AdjustDbxlConnections, AssignDocument, SwapDomWithDocument, RemoveDbxlPi, InsertPi, RemovePi | draft |
| 10 | Files, attachments and images | AlterImage, DownloadAttachment, GetAttachmentAttribute, DeleteFile, GetNetworkFile, ListDirectory, SaveToNetwork, SubmitToNetwork, RenderForm | draft |
| 11 | E-mail and AI | SendEmail, StartCopilotConversation, SendCopilotMessage | draft |
Conventions
- Bold names are things you click or see on screen.
Monospaceis text you type or an exact value: commands, parameters, XPaths.<XPath>and similar placeholders stand for your own values;[...]marks optional parameters and|separates alternatives.