Chapter 0 - Command Index
First draft. This chapter has not been reviewed yet and may contain mistakes. Please read it with that in mind, and tell us about anything that does not match what you see.
Every qRules command in alphabetical order. Click a command to open its section. New to qRules? Read Chapter 1 - Basics first: it explains the command syntax, dynamic parameter values and where results go.
| Command | What it does | Chapter |
|---|---|---|
| AdjustDbxlConnections | Repoints DBXL data connections to a new location, and sets their user key values. | 9 - DBXL |
| AlterImage | Resizes and/or adjusts the quality of a base64 image. | 10 - Files, attachments and images |
| AssignDocument | Creates a QdFlow document, which provides assignment and status workflow for a specific document. | 9 - DBXL |
| ChangeConnectionUrl | Changes the URL for a data connection (web service, XML file, etc.). | 7 - Data connections and web requests |
| ChangeSubmitUrl | Modifies the URL in a SharePoint submit data connection so that forms submit to a different library by specifying /url. | 7 - Data connections and web requests |
| ClearErrors | Clears all current validation errors in the form. | 5 - Validation and errors |
| ConvertBase64 | Converts base64-encoded values to text values. | 3 - Text, XML and JSON |
| Copy | Copies xml nodes to a new destination. | 2 - Values and nodes |
| CopyRichText | Copies a rich text field. | 3 - Text, XML and JSON |
| CopyTable | Copies data from the source table to the destination table. | 2 - Values and nodes |
| CreateSharePointFolder | Allows users to create a folder in a SharePoint library or list. | 8 - SharePoint |
| DateAdd | Adds to a date or datetime field. | 4 - Dates and numbers |
| DateDiff | Calculates the difference between two dates. | 4 - Dates and numbers |
| Decrypt | This command transforms encrypted data into the original underlying text value or attachment. | 3 - Text, XML and JSON |
| Delete | Deletes an xml node specified by an XPath. | 2 - Values and nodes |
| DeleteFile | Delete a local network file. | 10 - Files, attachments and images |
| DeleteFromSharePoint | Allows users to delete a document in SharePoint. | 8 - SharePoint |
| DelimitedList | Concatenates the values of a repeating field (or field in a repeating group), separating each value with the specified delimiter. | 3 - Text, XML and JSON |
| DiffRichText | Compares two rich text values, or multiple pairs of rich text values, and produces a rich text diff of their values. | 3 - Text, XML and JSON |
| DownloadAttachment | Download a file that is stored as base64 in a form field, or open it in a new browser tab. | 10 - Files, attachments and images |
| Encode | Returns an encoded or decoded string. | 3 - Text, XML and JSON |
| Encrypt | This command transforms texts and attachments into a set of random characters and provides security by using a password to protect data. | 3 - Text, XML and JSON |
| ExecuteSqlQuery | Uses an SQL Data connection to execute a given SQL command. | 7 - Data connections and web requests |
| FormatDate | Formats a date into a specified format. | 4 - Dates and numbers |
| FormatNumber | Formats a number into the specified format. | 4 - Dates and numbers |
| GenerateGuid | Returns a new GUID in the format specified. | 3 - Text, XML and JSON |
| GetAttachmentAttribute | Allows you the ability to obtain attributes from an attachment included in an InfoPath form in a File Control. | 10 - Files, attachments and images |
| GetConnectionUrl | Returns the current URL of the specified data connection. | 7 - Data connections and web requests |
| GetDayOfYear | Returns an integer value indicating the day number in the year for a date value. | 4 - Dates and numbers |
| GetEnvironmentVariable | Retrieves the value of an environment variable | 6 - Form, view and UI |
| GetErrorCount | Returns the number of current validation errors in the form. | 5 - Validation and errors |
| GetErrors | Provides a list of the form's current validation errors (if any) as a string value. | 5 - Validation and errors |
| GetFormProperty | Obtain the value of a form property. | 6 - Form, view and UI |
| GetInputParameter | Returns the value of a FormsViewer input parameter (for example the template name), or FAIL if the key does not exist. | 6 - Form, view and UI |
| GetListGuid | Returns the GUID for the list named in /listname. | 8 - SharePoint |
| GetNetworkFile | Retrieves a file from a local network. | 10 - Files, attachments and images |
| GetTermPath | Queries SharePoint’s TaxonomyClientService to obtain the path for a given Term. | 8 - SharePoint |
| GetTermsByLabel | Queries SharePoint’s TaxonomyClientService to obtain a list of TermSets that match the label (search term) provided by the user. | 8 - SharePoint |
| GetTermSetIds | Queries SharePoint to obtain a list of available TermSetsIds. | 8 - SharePoint |
| GetTermSets | Queries SharePoint’s TaxonomyClientService to obtain a list of available TermSets. | 8 - SharePoint |
| GetUserProfileByName | Retrieves user information from SharePoint’s user profile store and uses it to populate a GetUserProfileByName SOAP connection. | 8 - SharePoint |
| GetValue | Returns the value for a given XPath as a string. | 2 - Values and nodes |
| GetWeekDay | Returns the date of a specific weekday within a given week. | 4 - Dates and numbers |
| GetXml | Returns the full inner or outer XML of a node in one of the form's data sources. | 3 - Text, XML and JSON |
| Insert | Inserts new rows into a repeating group or table, in any view. | 2 - Values and nodes |
| InsertPi | Insert a processing instruction into the xml file. | 9 - DBXL |
| Irr | Returns a value specifying the internal rate of return for a series of periodic cash flows (payments and receipts). | 4 - Dates and numbers |
| JsonToXml | Converts a JSON string to XML and places the converted XML into one of the form’s data sources. | 3 - Text, XML and JSON |
| ListDirectory | Lists all of the files or directories in a file system directory and places the results in a repeating group. | 10 - Files, attachments and images |
| LoadResource | Allows loading a CSS or JS file into the page. | 6 - Form, view and UI |
| MakeRequest | Carries out a network request and provides the result | 7 - Data connections and web requests |
| ModifySqlQuery | This command will allow you to add a WHERE clause to an existing SQL data connection. | 7 - Data connections and web requests |
| Move | Moves xml nodes to a new destination. | 2 - Values and nodes |
| Npv | Returns a value specifying the net present value of an investment based on a series of periodic cash flows (payments and receipts) and a discount rate. | 4 - Dates and numbers |
| Prompt | Prompts the user with a popup dialog and produces a result based on the user's selection | 6 - Form, view and UI |
| RefreshSharePointListItems | This command is used in tandem with SubmitToSharePointList to update list items with most recent edits to the list. | 8 - SharePoint |
| RegisterMultiDrop | Enables multi-file drop support for certain form fields. | 6 - Form, view and UI |
| RemoveDbxlPi | Removes the DBXL Processing Instructions from an xml document. | 9 - DBXL |
| RemovePi | Remove a processing instruction from the xml file. | 9 - DBXL |
| RenderForm | Renders form data using a view from the current template or another template. | 10 - Files, attachments and images |
| ReplaceString | Returns the value of a field with every occurrence of /string1 replaced by /string2, or with a regular expression (/pattern). | 3 - Text, XML and JSON |
| SaveToDbxl | Saves a file, a set of files, an image or a set of images to a DBXL DocType called QdFile (please refer to the qRules User Guide for details). | 9 - DBXL |
| SaveToNetwork | Saves files stored in form fields to a directory on the local network. | 10 - Files, attachments and images |
| SaveToSharePoint | Saves a file, a set of files, an image or a set of images to a SharePoint Document Library. | 8 - SharePoint |
| SendCopilotMessage | Sends a message in an existing Copilot conversation and returns the response | 11 - E-mail and AI |
| SendEmail | Sends an e-mail message, optionally including the current form view in the body and/or a PDF attachment of any view. | 11 - E-mail and AI |
| SetAutocomplete | Sets the autocomplete mode for a control or all controls. | 6 - Form, view and UI |
| SetCase | Returns a string with the value of the source node in the case requested. | 3 - Text, XML and JSON |
| SetCharacterLimit | Limits the number of characters a user can type into a text control. | 6 - Form, view and UI |
| SetDefaultView | Switches the form's view to the indicated view. | 6 - Form, view and UI |
| SetValidationMode | Sets the form's validation behavior, determining how frequently validation takes place and whether schema-required field validation is included. | 5 - Validation and errors |
| SetValue | Sets the value of one or more fields. | 2 - Values and nodes |
| SetXml | Allows setting the XML content of a node based on a string. | 3 - Text, XML and JSON |
| SortTable | Sorts a table according to the specified column(s) and order(s). | 2 - Values and nodes |
| StartCopilotConversation | Starts a new Copilot conversation and returns a conversation ID | 11 - E-mail and AI |
| SubmitToDbxl | Submits the document to Qdabra DBXL. | 9 - DBXL |
| SubmitToNetwork | Submits the contents of a data source to a local network location. | 10 - Files, attachments and images |
| SubmitToSharePoint | Submits an XML document to a SharePoint form library. | 8 - SharePoint |
| SubmitToSharePointList | Submits data to the SharePoint list it has been mapped to. | 8 - SharePoint |
| SwapDomWithDocument | After retrieving documents by passing in the DBXL document ID in the input parameters, this command replaces the main DOM with the retrieved XML. | 9 - DBXL |
| Transform | Performs an XSL transform on data in any data source and stores the result somewhere else in the form. | 3 - Text, XML and JSON |
| UseOption | Allows setting FormsViewer options that affect form behavior. | 6 - Form, view and UI |
| WriteLog | Writes a message to the logging system | 5 - Validation and errors |
| XmlToJson | Converts XML in one of the form’s data sources to a JSON string. | 3 - Text, XML and JSON |
Next: Chapter 1 - Basics