Command Explanation
All pages rendered on the system use UDB commands to insert different elements on to the page.
For example, if you want to put the page title onto a template then you can insert the command {PAGE_TITLE}. This will be replaced with the current page title whatever page is being displayed.
If you want to add a link to a another page on the system then you can add {LINK(1013, Contact)}. This will create a link to the page number 1013 and add the text "Contact" (Contact).
All of the commands need to be enclosed in { } when used on the page and the command needs to be entered in upper case. They may also have parameters. These are enclosed in ( ). Most of the time it is easier to enter the parameters by position separated by commas. So in the LINK example above, the first parameter is the Object ID of the page you want to link to and the second parameter is the text you want to be displayed on the page. Sometimes there may be a larger number of parameter options and using lots of commas to get to the correct parameter can be awkward and confusing to read. In this case, you can use a JSON list of parameters. So for the example above, you can use {LINK(1013, {"text":"Contact","class":"btn btn-primary"})}. The JSON list of parameters can only be used as the last parameter. A list of all the parameters are detailed in the command help.
You can also pass in an array of parameters using an array variable. To do this add a JSON parameter "param_array":"V_ARRAY". All the values in the V_ARRAY variable will be used as parameters.
When adding an Object ID as a parameter, it is a good idea to precede it with "#:". This helps the system to identify the number as an Object ID. This is essential if you are writing an application to be shared by other organisations as the Object IDs will need to be changed by the system when they import your application. So the example above, should be written {LINK(#:1013, Contact)}. See OBJ_ID for more info.
If a parameter includes a comma it must be quoted {LINK(1013, "Contact John Doe or, a member of the team")}. If the parameter includes quotes and commas, quotes are escaped with another quote {LINK(1013, "Contact John ""The Man"" Doe or, a member of the team")}.
Parameter values are individually interpreted before they are passed to the command for processing. This can be prevented by preceeding the parameter value with two exclamation marks!!
See below for a full list of commands and their explanations.
| Name | Description | Structure |
|---|---|---|
| ABS | Return the absolute(positive) value of the provided value. | {ABS(val)} |
| AGE | Determine the age between two dates | {AGE(format, date, date_format)} |
| BETWEEN | Return TRUE if the first value is between the second two values. | {BETWEEN(check, from, to)} |
| COMPARE | Compare two values in a number of ways | {COMPARE(value1, method, value2)} |
| EMPTY | Check if a string value is Empty | {EMPTY(value)} |
| EVAL | Evaluates a mathematical or logical expression | {EVAL(expression)} |
| IN_LIST | Return TRUE or FALSE if a string (or list of strings) is in a list of strings | {IN_LIST(find, list)} |
| INT | Returns the integer of a value or expression | {INT(expression)} |
| IS_BACKUP | Returns TRUE if running on the Backup server | {IS_BACKUP} |
| IS_EMAIL | Check if string is an email address. Returns TRUE or FALSE | {IS_EMAIL(val)} |
| IS_NUMERIC | Check if string is numeric. Returns TRUE or FALSE | {IS_NUMERIC(val)} |
| IS_VAL | Check if string has the potential to be a value. | {IS_VAL(val)} |
| MATH_AND/OR/XOR | Returns the result of a bitwise AND/OR/XOR operation on the provided values. | {MATH_AND(val1, val2)} |
| MATH_ASIN/ACOS/ATAN | Return the ArcSine, ArcCosine or ArcTangent of a value | {MATH_ASIN(val)} |
| MATH_ATAN2 | Return the arc tangent of two values | {MATH_ATAN2(y, x)} |
| MATH_DEG2RAD | Converts Degrees to Radians | {MATH_DEG2RAD(val)} |
| MATH_DISTANCE | Get the distance between two points. 2D, 3D or GLOBE | {MATH_DISTANCE(type, point1, point2, unit)} |
| MATH_RAD2DEG | Converts Radians to Degrees | {MATH_RAD2DEG(val)} |
| MATH_RAND | Returns a random integer number between two values | {MATH_RAND(from, to)} |
| MATH_SIN/COS/TAN | Return the Sine, Cosine, Tangent of an angle | {MATH_SIN(val)} |
| MATH_SQRT | Returns the square root of a value | {MATH_SQRT(val)} |
| MAX | Return the Maximun of a series of numbers | {MAX(...)} |
| MIN | Return the Minimum of a series of numbers | {MIN(...)} |
| MIN_POS | Return the Minimum positive value of a series of numbers | {MIN_POS(...)} |
| NOT | Boolean NOT statement to use in expressions | {NOT(expression)} |
| ROUND | Round a value to n decimal places | {ROUND(expression, places)} |
| SIG_CHECK | Determines a Signatures Validity | {SIG_CHECK(obj_id, tag)} |
| SIGN | Return the sign of a value | {SIGN(expression)} |
| TOT | Display a Total | {TOT(id)} |
| TOT_IF | Add a value to a total if a condition is true. | {TOT_IF(id, argument, value)} |
| TOT_RESET | Reset a total Value | {TOT_RESET(id)} |
| VAL | Return the Numeric value of a character string | {VAL(value)} |