Skip to content

Introduction

"Hello World" Example

XML
1
2
3
4
5
<srs label="Hello">
  <def>
    <itm>select 'Hello World'</itm>
  </def>
</srs>

Overview of the XML Structure

This is a list of all the elements that can be used in the XML structure of an SRS file.

srs Node Attributes

  • label: Given name.
  • cache: Cache duration in seconds.
  • acl: Access control list.
  • opts: Options.
    • jq-SkipOptimization - disables various engine optimization; commands are run in the order of appearance.

srs Node Internal Attributes

  • name: File name, e.g., 100-warehouse-stock.
  • id: ID, e.g., 100, valid range is 100-999.
  • success: true or false.
  • message: Empty if successful.
  • apipath
  • apimethod: GET or POST.
  • basepath
  • filepath
  • executed_at
  • tables
  • def
  • data
  • debugger

itm Node Attributes

  • model: Default is command. Other options: column, param, renderer, option, dsn.
  • name: Default is auto-number.
  • label: Default is name.
  • title: Default is the first non-empty label or name.
  • opts: Options specific to the model, e.g., for command: clipboard, uiheader, uifooter, uimenu.
  • css: Class, e.g., xd-red, xd-blue, xd-green, xd-orange, xd-orange0 to xd-orange10.
  • acl: Permission allowed on command or column.
    • Default ACL schema if empty: app_[app_name].
    • e.g., <itm acl="admin" ...> requires admin role.
    • e.g., <itm acl="@manager" ...> requires manager team access.
    • e.g., <itm acl="[email protected]" ...> requires specific username.
    • e.g., <itm acl="public" ...> allows public access.
    • Authenticated users have default permissions: public, authenticated, username, roles, @team_short.
    • Non-authenticated users have default permissions: public.
  • type
    • When model="command": v_srs_table, v_srs_map, v_srs_tiles.
    • When model="column": tguid, tdate, tbool, tinteger, tdecimal, tstring.
    • When model="column": UI extended types.
    • When model="dsn": self, mssql.
    • When model="option": pa_post, pa_download, pa_post_single.
  • scope: Limit scope to name, e.g., for param and option models. Can be separated by commas, e.g., name1,name2.
  • req: Default is false.
  • cache: Cache duration in minutes. When POST is executed, the cache is cleared.
  • width
  • link: Default is self, srs. More...
  • lg: Display on large screens, default is true.
  • sm: Display on small screens, default is lg.
  • ex: Export, default is lg. Export to Excel, HTML.
  • active: Default is true.
  • itm.value
    • When model="columns": Support for templating variables, e.g., [[app_name]], [[kv.v.*]], [[kv.v.user.username]].

itm Node Internal Attributes

  • ix: Item index, column ordinal.
  • ec: Estimated characters.
  • aclv: ACL validation result, true or false