Built-In Keywords

The base_url (alternatively baseUrl) keyword returns the base URL for the application. The value is assembled from the protocol, hostname and port of the server instance Structr is running on.

It produces http(s)://<host>(:<port>) depending on the configuration.

${base_url}

https://foo.bar:1234

The children keyword returns the child nodes of the current node.

${render(children)}

The current keyword returns the object returned by URI Object Resolution, if available.

The data keyword returns the current element in an each() loop iteration or in a filter() expression.

The host keyword returns the host name of the server to which the request was sent.

It is the value of the part before “:” in the Host header value, if any, or the resolved server name, or the server IP address.

The id keyword returns the id of the object returned by URI Object Resolution, if available.

Available from v3.6:
The ip keyword returns the Internet Protocol (IP) address of the interface on which the request was received.

The input keyword returns the current object (of the Virtual Type) when used in a VirtualProperty context.

The link keyword references the linked node of an element.

Only works in a, link, script or img tags/nodes. See Filesystem and Pages Tree View for more info.

The link keyword can only be accessed if a node of the above types is actually linked to a filesystem element. It can be linked via the link icon which is displayed when hovering over a node.

The locale keyword returns the current locale. It is determined like this in descending priority:

1. Request parameter locale
2. User locale
3. Cookie locale
4. Browser locale
5. Default locale which was used to start the java process (evaluated via java.util.Locale.getDefault();)

The keyword me contains a reference to the current user.

The keyword can be used in all Template Expressions, in Hide and show Conditions etc. It is often used to show/hide individual parts of a page depending on the permissions / status of a user etc.

Hello ${me.name}!

Hello admin!

The page keyword returns the page object currently being rendered.

${page.name}

Used in the page URL = https://localhost:8082/people?sort=lastName&order=asc

people

The parameter_map returns a map (String, String) containing all request parameters of the current request.

parameterMap is an alias for this keyword.

${parameter_map}

(1) Used in the page URL = https://localhost:8082/people?sort=lastName&order=asc
(2) Used in the page URL = https://localhost:8082/people?sort=lastName&sort=firstName&order=asc

(1) {sort=[lastName],order=[asc]}
(2) {sort=[lastName, firstName],order=[asc]}

The path_info returns any extra path information associated with the URL the client sent when it made this request.

The extra path information follows the servlet path but precedes the query string and will start with a “/” character.

pathInfo is an alias for this keyword.

The port keyword returns the port number to which the request was sent.

It is the value of the part after “:” in the Host header value, if any, or the server port where the client connection was accepted on.

The query_string returns the complete query string of the current request.

queryString is an alias for this keyword.

Used in the page URL = https://localhost:8082/people?sort=lastName&sort=firstName&order=asc

${query_string}

sort=lastName&sort=firstName&order=asc

The request keyword returns a reference to the current HTTP request object (see javax.servlet.http.HttpServletRequest). It can be used to access HTTP GET request parameters.

(1) Used in the page URL = https://localhost:8082/people?sort=lastName&order=asc

${request.sort}

(2) Used in the page URL = https://localhost:8082/people?sort=firstName&sort=lastName&order=asc

${first(request.sort)}

(1) lastName
(2) firstName

The remote_address keyword returns the IP from which the current request originated.

${remote_address}

127.0.0.1

The response keyword returns a reference to the current output stream of the HTTP response that is sent to the client when the rendering process is finished.

The response keyword can be used in the special functions create_jar_file() and exec_binary() to allow direct streaming of binary data from a StructrScript to the client.

The status_code returns the HTTP status code for the current response.

statusCode is an alias for this keyword.

The template keyword returns the Template element closest to the current element in the page tree.

The tenant_identifier keyword returns the tenant identifier from structr.conf (database.tenant.identifier).

tenantIdentifier is an alias for this keyword.

The value keyword returns the value passed to the write function of a FunctionProperty.

Can be used to store data in-memory as long as the instance is running. The applicationStore can be accessed like a simple JavaScript object and can store arbitrary things.

${{
  if (!$.applicationStore['code_was_run']) {

    $.log('running some code only once...');

    $.applicationStore['code_was_run'] = true;

  }
}}

Returns all method parameters in schema methods as a map.

{
    $.log($.methodParameters.param1);

    $.log($.methodParameters['param1']);
}

Can be used to store data in-memory for the duration of the current request. The requestStore can be accessed like a simple JavaScript object and can store arbitrary things.

This keywords uses the same data store as the $.store() and $.retrieve() functions but is easier to use in JavaScript. The newer set of helper functions for this keyword is preferred versus store() and retrieve().

{
  for (let cnt = 0; cnt < 10; cnt++) {
		
    $.log(cnt);

      if (!$.requestStore['code_was_run']) {

        $.log('running some code only once per request...');

        $.requestStore['code_was_run'] = true;

      }
   }
}