Execute SQL Query Templates

Sometimes you need to execute a SQL query to accomplish something. However, there is no need for a rule author to know the technical details involved with such a query. Instead, you can use an Execute SQL Query template to make the operation easier to read and write.

For example, you could use a language rule to run the query as follows:

The same language rule written using an Execute SQL Query template might be as follows:

Here is how this template would be defined:

Here are the possible settings on this screen:

Name

Specifies the name of the vocabulary template. The name is used for irSDK access.

Display Name

Name of the template to be displayed in the business language template list.

Menu Group

Menu group under which the template will be listed. The user can choose to add his template to an existing menu group or can create his own menu group.

Scope

The scope of the template availability can be limited to only the context of the previously selected entity by checking "Available in rules and calculations for this entity." The availability can also be extended to those rule elements which have a reference to the previously selected entity by checking "Available in rules and calculations for entities referencing this entity."

Placeholders

The placeholders created in business language are configured here. For a detailed description of placeholders refer to "Configuring Placeholders".

Business Language

Business language to be displayed in the business language editor. Placeholders can be added to the template by enclosing them within $ symbols.

SQL Query

Select the query that will be executed.

Assign Return To

If the query has a return value, specify the field where that return value should be assigned. You may specify a field, or you may use one of the placeholders surrounded by $ symbols, e.g. $FreeShipping$.

Parameters

Specify an expressions, including placeholders, to be used passing parameters to the function or method.