The HTML items are CMS elements delivered with open bi. They can be accessed via special tags in the HTML code and used in all pages that are played out by open bi.
This documentation explains the purpose of each HTML item and the parameters available.
But part of the philosophy of open bi is the possibility to create your own HTML items. To do this, visit the "Tutorials" category of the open bi Blog.
The open bi CMS uses HTML Items, which can alter and enhance the HTML output and provide access to open bi features. It is also possible to call actions on the items with HTTP POST requests.
Custom HTML tags are used to reference a HTML Item. They work the same way as regular HTML tags and can be configured via attributes. By default, all HTML Item attributes are prefixed with "data-":
<customelement data-requires-auth="true">some text</customelement>
The following list shows all default attributes, which can be set on all open bi HTML Items.
POST requests can be used to communicate with the HTML Items on the current page. They allow for definition of actions for the HTML Item and also for dynamical creation of the HTML Item.
The POST request must contain an "application/x-www-form- urlencoded" or "multipart/form-data" encoded body. The body must contain a "cms_item" field with the value of either the ID of an existing HTML Item on the current page or the tag name of an HTML Item which then will be created dynamically. The HTML Item specific "data-" attributes can also be added as fields to the body which then will be set onto the HTML Item.
Often HTML Items require a specific "action" which can also be added as a field to the body. So one HTML Item can do different things based on the provided action.
The rendering of HTML Items can be freely configured by the use of HTML Item Templates. HTML Item Templates are HTML snippets that can be made dynamic by using Placeholders. Placeholders are defined with a leading and trailing "%":
<a href="%LINK%">%NAME%<a/>
The list of Placeholders, which are available for an HTML Item, depends on the type of HTML Item Template being used. For the <login> HTML Item, for example, %USERNAME% only makes sense if the user has logged in successfully - so it is only available in the "data-tpl-auth" HTML Item Template.
The <content> HTML item will display the HTML snippet maintained in the Role Content Element of the CMS Role. The Role Content Element is determined automatically from the URL path and user language.
The <login> HTML item will display different templates depending if a user is logged in or not. It also provides actions for user login and logout.
The <openbi:translate> item returns the language text value for a language text.
The <openbi:changelanguage> item only provides a POST request action which changes the language of the current session.
The <openbi:dbitem> reads the first row of a database table and replaces all values in a template. It supports static filters, filters from URL parameters and can change the page title with the values of the row.
Static filters can be set in the "data-filter" attribute and are merged with filters from URL parameters. By default, if a URL parameter name matches the name of a column of the table it will be used as a filter. E.g. "?COLUMN1=VALUE1" will automatically filter the result where "COLUMN1 = ‘VALUE1’". This behavior can be customized with the "data-url-filter-whitelist" attribute.
COLUMN1=VALUE1;COLUMN2=VALUE2COLUMN1 ASC, COLUMN2 DESC%PlaceholderPrefixColumnName_JSON% All column names of the referenced table can be used as placeholders.
Placeholder format (the column name is always uppercase): %data-placeholder-prefix+COLUMN_NAME%
Example of placeholder if prefix is empty: "%COLUMN1%", "%COLUMN2%"
Example of placeholder if prefix is "Test": "%TestCOLUMN1%", "%TestCOLUMN2%"
The <openbi:dblist> reads rows from a database table and replaces all values in a template. It supports static filters, filters from URL parameters and pagination.
Static filters can be set in the "data-filter" attribute and are merged with filters from URL parameters. By default, if a URL parameter name matches the name of a column of the table it will be used as a filter. E.g. "?COLUMN1=VALUE1" will automatically filter the result where "COLUMN1 = ‘VALUE1’". This behavior can be customized with the "data-url-filter-whitelist" attribute.
COLUMN1=VALUE1;COLUMN2=VALUE2COLUMN1, COLUMN2COLUMN1 ASC, COLUMN2 DESC?sort=COLUMN1
?sort=COLUMN1?sortdir=DESC
%PlaceholderPrefixColumnName_JSON%%PlaceholderPrefixColumnName.ChildColumnName%"
/list/mycategory/mystatus ... which corresponds to: /list?CATEGORY=mycategory&STATUS=mystatus
[{
"COLUMN1": "VALUE1"
}, {
"COLUMN1": "VALUE2"
}]In the "data-tpl-item" template, all column names of the referenced table can be used as placeholders.
Example of placeholder if prefix is empty: "%COLUMN%", "%COLUMN2%
Example of placeholder if prefix is "Test": "%TestCOLUMN1%", "%TestCOLUMN2%"
In the "data-tpl-container" template, the following placeholders can be used:
The <openbi:redirect> item redirects the browser to another host, port, path or query based on the current URL, which means by specifying only a different host only the host part of the current URL is changed and redirected to, keeping all the other parts intact. It also supports redirects to the HTTPS protocol and to "www" subdomains. Optionally a status code (other than the default 302) can be provided. When the created redirect URL is the same as the original URL no redirect will be done.
The <openbi:httpheader> item adds HTTP response headers base on the "data-name" and "data-value".
Example:
<openbi:httpheader data-name="My-Custom-Response-Header" data-value="My Custom Value"></openbi:httpheader>
The <navbar> item adds a navigation menu to the website. To create the menu, the subtree of the CMS Role element with the lowest position is used.
Example:
<navbar data-levels="1"></navbar>
The <footerbar> item adds a second navigation to the website. It can be used e.g. to render links to contact, sitemap and imprint at the footer of the page. To create the menu, the subtree of the CMS Role element with the second lowest position is used.
Example:
<footerbar></footerbar>
The <sitemap> item adds all subpages of the a navigation menu to the website. To create the menu, the subtree of the CMS Role with the lowest position is used.
Example:
<sitemap></sitemap>
The <openbi:dropbox> item renders a UI to upload, organize and download documents to an open bi Document Role.
Example:
<openbi:dropbox data-id-role="bd546b43-bb3a-4e87-a803-24b677cee9d6" data-requires-auth="true"></openbi:dropbox>
The <openbi:usermaintenance> item allows the maintenance and creation of open bi users.
Example:
<openbi:usermaintenance></openbi:usermaintenance>
The <openbi:registration> item allows a visitor of the CMS page to register. This will create a new open bi user.
Example:
<openbi:registration></openbi:registration>
The <openbi:logininitial> item allows a user to set an iniital password and to activate the account. Needs an activationid to be passed as a URL parameter.
Example:
<openbi:logininitial></openbi:logininitial>
The <openbi:forgotpassword> item allows a visitor of the CMS page to start the "forgot password" process by providing the mail address.
Example:
<openbi:forgotpassword></openbi:forgotpassword>
The <openbi:changepassword> item allows a user to change the password.
Example:
<openbi:changepassword></openbi:changepassword>
The <openbi:contactinformation> item allows a user to change the password.
Example:
<openbi:contactinformation></openbi:contactinformation>