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.
| Tag | Description | Structure |
|---|---|---|
| ACCORDION | Add Bootstrap Accordion to the Page | {ACCORDION(query, sub_temp_query)} |
| AJAX_EMBED | Embed the contents on to the page using AJAX | {AJAX_EMBED(obj_id, param)} |
| BASIC_DISP | Return the object data according to the Basic Display format specified in the objects list setup. | {BASIC_DISP} |
| BLINK | Add a button to the page to Link to another page. | {BLINK(obj_id, text, param)} |
| CALENDAR | Displays a Calendar or Diary of events | {CALENDAR(obj_id, date_mode, query, relobj)} |
| COMMENT | This will create an area for users to enter comments. | {COMMENT(obj_id, options, login-text)} |
| EMBED | Embed an object in the page | {EMBED(obj_id, sub_temp, minutes, mode)} |
| FAVICON | Specify the url of the favicon to be used on the site | {FAVICON(url)} |
| GLINK | Glossary Link | {GLINK(obj_id, text, sub_temp)} |
| GLINK_OFF | Turn Glossary Links Off | {GLINK_OFF} |
| GLINK_ON | Turn Glossary Links back on again | {GLINK_ON} |
| GOOGLE_CHART_BTN | Add a google chart to the page | {GOOGLE_CHART_BTN(table id, div id, chart type)} |
| LABEL | Specify a Form Label | {LABEL(desc, id)} |
| LINK | Create a link to another Object | {LINK(obj_id, text, param)} |
| LIST | List Processing | {LIST(root, rel_id, list_id, query, temp_id, disp_opt, page_size)} |
| LIST_NAV | List Navigation | {LIST_NAV} |
| LOGIN | Provide a Login Prompt with associated menu options once logged in | {LOGIN(options)} |
| LOGIN_FACEBOOK | Allow users to login with their Facebook account | {LOGIN_FACEBOOK(auto_login, text)} |
| LOGIN_FORM | Start a Login Form | {LOGIN_FORM(error_div_id, class, style)} |
| LOGIN_GOOGLE | Google Login Prompt | {LOGIN_GOOGLE()} |
| LOGIN_LINK | Add a Login prompt to the page | {LOGIN_LINK(text, form_object_id)} |
| LOGIN_NAME | Display the Login Name Input Box on a Login Form | {LOGIN_NAME(tooltip, placeholder, class, style)} |
| LOGIN_PASSWORD | Display The password Input Box on a Login Form | {LOGIN_PASSWORD(tooltip, placeholder)} |
| LOGIN_REM_ME | Remember me checkbox on a Login Form | {LOGIN_REM_ME} |
| LOGIN_SUBMIT | Submit Button for Login Form | {LOGIN_SUBMIT(text, tooltip, class, style)} |
| MENU | Add a menu to the page | {MENU(root_id, options, collapse_text)} |
| NOTIFY | Display a pop-up message for the user | {NOTIFY(message, type_id, position, duration)} |
| PAGE_TITLE | Display the page title | {PAGE_TITLE} |
| PANEL | Add a fixed Panel to the page | {PANEL(heading)} |
| PANEL_CLOSED | Add a closed Panel to the page. | {PANEL_CLOSED(heading)} |
| PANEL_OPEN | Add an open panel to the page. | {PANEL_OPEN(heading)} |
| PILLS | Add Bootstrap Pill Selector | {PILLS(query, sub_temp_query)} |
| PRINT_BUTTON | Displays a button that prints the current page | {PRINT_BUTTON} |
| REGISTER | Registration Link | {REGISTER(text, class)} |
| RENDER_TREE | Render a tree structure of Objects | {RENDER_TREE(obj_id, rel_id, sub_temp, options)} |
| SEQN | An automatically incrementing Sequence Number | {SEQN} |
| SET_PAGE_TITLE | Set the page Title to overide the default | {SET_PAGE_TITLE(title)} |
| SIDEBAR_LEFT/RIGHT | Set the object to be displayed in the left or right sidebar. | {SIDEBAR_LEFT(obj_id)} |
| SLIDES | Add Bootstrap Slides to the Page. | {SLIDES(query, sub_temp_query)} |
| SYMBOL | Returns a symbol of the specified ID | {SYMBOL(symb_id)} |
| TAB | Add a Tab to a TABS, PILLS or ACCORDION | {TAB(text)} |
| TABS | Add Bootstrap Tabs | {TABS(query, sub_temp_query)} |
| WRAP | Wrap the specified part of the page with a sub template | {WRAP(obj_id)} |
| Tag | Description | Structure |
|---|---|---|
| ABS | Return the absolute(positive) value of the provided value. | {ABS(val)} |
| ACCORDION | Add Bootstrap Accordion to the Page | {ACCORDION(query, sub_temp_query)} |
| ADD | Add a numeric value to a variable | {ADD(name, value)} |
| AGE | Determine the age between two dates | {AGE(format, date, date_format)} |
| AJAX_EMBED | Embed the contents on to the page using AJAX | {AJAX_EMBED(obj_id, param)} |
| ALPHA_INC | Increase the value of an Alpha Numeric string | {ALPHA_INC(val)} |
| API_CALL | Make a call to a prepared API service | {API_CALL(api_alias, result_alias, path, method, params)} |
| API_CLEAR_RESULT | Clears an API result from memory | {API_CLEAR_RESULT(result_alias)} |
| API_DATA | Returns a data field from an API response | {API_DATA(result_alias, data_field)} |
| API_DATA_TO_XML | Converts one or more API resource fields to an XML string | {API_DATA_TO_XML(result_alias, data_fields)} |
| API_FOR_EACH | Itterates over items in an API result | {API_FOR_EACH(result_alias, data_field, row_alias)} |
| API_HEADER_SET | Adds an HTTP header to send with an API call | {API_HEADER_SET(alias, name, value)} |
| API_HEADER_UNSET | Unsets a previously set HTTP header, or all, for the API call. | {API_HEADER_UNSET(alias, name)} |
| API_QTY | Returns the number of elements in an API result | {API_QTY(result_alias, data_field)} |
| API_SETUP | Prepares for use of an API service | {API_SETUP(api_alias, url, params, method, response)} |
| APP | Append a string to the end of a variable. | {APP(name, value, separator)} |
| ARRAY_CLEAR | Clear the contents of an array | {ARRAY_CLEAR(name)} |
| ARRAY_FOR_EACH | Loop through all elements in an array | {ARRAY_FOR_EACH(name, var)} |
| ARRAY_JOIN | Join all the elements in an array using the specified character | {ARRAY_JOIN(name, char)} |
| ARRAY_JSON | Return an arrays content as a JSON string | {ARRAY_JSON(name)} |
| ARRAY_QTY_IN | Return the number of times a value occurs in an array. | {ARRAY_QTY_IN(name, string)} |
| ARRAY_SIZE | Return the size of an array | {ARRAY_SIZE(name)} |
| ASTRING_APP | Append a Key:Value Pair to the beginning of a Key:Value pair string | {ASTRING_APP(string, key, val)} |
| ASTRING_CREATE | Return a String of elements in a list [1:A,2:B,3:C] | {ASTRING_CREATE(query, part} |
| ASTRING_PRE | Prepend a Key:Value Pair to the beginning of a Key:Value pair string | {ASTRING_PRE(string, key, val)} |
| BACKGROUND_TASK | Run a background task | {BACKGROUND_TASK(obj_id, param)} |
| BASIC_DISP | Return the object data according to the Basic Display format specified in the objects list setup. | {BASIC_DISP} |
| BETWEEN | Return TRUE if the first value is between the second two values. | {BETWEEN(check, from, to)} |
| BLINK | Add a button to the page to Link to another page. | {BLINK(obj_id, text, param)} |
| BSWAP | Swap individual characters in a string | {BSWAP(string, search, replace)} |
| CALENDAR | Displays a Calendar or Diary of events | {CALENDAR(obj_id, date_mode, query, relobj)} |
| CALL | Call a predefined Function | {CALL(name)} |
| CHAR | Return a series of characters specified by their ascii value | {CHAR(...)} |
| CHAT_SEND | Send a Chat Message to another User | {CHAT_SEND(user_id, text, level)} |
| CHAT_USERS | Displays a list of Users for use in the Chat System. | {CHAT_USERS(user_qty)} |
| CHOICE | Display a checkbox that allows you to choose if other text is displayed. | {CHOICE(obj_id, tag, class, target)} |
| CHOICES | Displays a drop-down box on the page to allow for the selection of text to be inserted. | {CHOICES(rel_id)} |
| CODE_LOOKUP | Provide an input box and search button to lookup an object based on its ID, Code or Friendly Name | {CODE_LOOKUP(list_id, part)} |
| COID | Return the current Object ID | {COID} |
| COMMA | Returns a comma , | {COMMA} |
| COMMENT | This will create an area for users to enter comments. | {COMMENT(obj_id, options, login-text)} |
| COMPARE | Compare two values in a number of ways | {COMPARE(value1, method, value2)} |
| COMPONENT | Add one or more components to the current page. Use a list of IDs | {COMPONENT(...)} |
| COOKIE_DEL | Delete a cookie | {COOKIE_DEL(name)} |
| COOKIE_GET | Get the value of a cookie | {COOKIE_GET(name, default)} |
| COOKIE_SET | Set a cookie | {COOKIE_SET(name, life, value)} |
| CRLF | Returns Carriage return & Line Feed characters | {CRLF} |
| CSV_DATA | Get date from imported CSV | {CSV_DATA(alias, column)} |
| CSV_DATA_TO_XML | Convert the imported CSV data to XML | {CSV_DATA_TO_XML(alias, data_fields)} |
| CSV_FOR_EACH | Loop through all CSV data rows | {CSV_FOR_EACH(alias)} |