Generic models

These models are used across components and portlets.

ObjectReferenceModel

This object contains a single reference to an external object (value list, dimension, etc).

ComponentModel

This object contains information about the currently execution component (the ContentViewer).

Example:

function refreshThisComponent() {
   iKnowBase.PageEngine.reloadComponent ('${component.id}');
}

ContextModel

The ContextModel-object contains general information related to an execution context. Use this object to find information about current time and current user.

Example:

<p>
This information was last refreshed on ${context.datetime}
</p>

UserModel

The UserModel-object contains information about the executing user, either a logged on user or the guest user applicable to the request.

UserTokenModel

The UserTokenModel-object contains a token for secure authentication without logging in, for ajax-based processing.

SocialAuthenticationModel

The SocialAuthenticationModel-object contains information regarding the users profile from the external social provider. Only applicable if social connection is used for authentication.

DomainMode

The DomainModel-object contains information about the domain applicable to the current request.

RequestModel

This object contains parameters available to the component.

The properties username, referencepath and guid were earlier available in this model. They have been deprecated.

ParametersModel

This object contains information about request parameters from the current HTTP-request. The model supports several of the basic FreeMarker model types:

• It is a TemplateHashModel, supporting one property per parameter
• It is a TemplateHashModelEx, supporting the built-ins ?keys and ?values.

ParameterModel

This model contains all values for a given parameter. The model supports several of the basic FreeMarker model types:

• It is a String (ScalarModel), returning the first (or only) value for the parameter
• It is a TemplateSequenceModel containing Strings, supporting index-based lookups ( request.parameters.paramname[index]) and iteration ( ...[/#list]).

TextMapModel

This model object contains language specific texts defined with various iKnowBase objects. The model object is a compound object. First is the actual TextMapModel, which enables you to find a TextString based on a user defined key. Next is the TextStringModel, which decides which definition of the string to use, for example the one stored with a Page or the one stored with a Template.

You may use only the TextMapModel object (as in @${viewer.strings.contactEmail}), which will then search for the string in any of the available locations. You may also specify the location “any” for the same purpose (as in @${viewer.strings.contactEmail.any}). If you want complete control of the string location, specify it directly (as in @${viewer.strings.contactEmail.template}).

The locations available vary from portlet to portlet. See the definition of the portlet object for description of which locations apply to that portlet.

TextMapModel

TextStringModel

Examples:

<!-- The text specified in the "contactEmail" string, in any available location. -->
${viewer.strings.contactEmail}

<!-- The text specified in the "contactEmail" string, in any available location. -->
${viewer.strings.contactEmail.any}

<!-- The text specified in the "contactEmail" string, on the template only -->
${viewer.strings.contactEmail.template}

<!-- The freemarker default value operator does not work without a location -->
${viewer.strings.contactEmail!"default-email@example.com"}

<!-- The freemarker default value operator works only when specifying a location -->
${viewer.strings.contactEmail.any!"default-email@example.com"}
${viewer.strings.contactEmail.template!"default-email@example.com"}

LoadXML macro

Use this macro to load XML from a specified URL, for further processing using FreeMarker.

Examples:

<@ikb.loadXML 'myxml' 'http://www.example.com/xmlfeed' />
<#list ikb.myxml.entries as entry>
    ${entry.title}
</#list>

<@ikb.loadXML 'myxml' 'http://www.example.com/xmlfeed' 2000 />
<#if ikb.myxml! == "">
   No data was returned; possibly timeout
</#if>

LoadURL macro

Use this macro to load arbitrary text from a specified URL, for further processing using FreeMarker.

Example:

<@ikb.loadURL 'myurl' 'http://my.domain.com/htmlfeed '/>
<div>
    ${ikb.myurl}
</div>

AssignDate macro

Use this macro for simple date arithmetic, where you start with a certain date and then add a duration.

Example:

<@ikb.assignDate 'dueWarning' viewer.logic.currentDate 259200000 />
<div>
    ${ikb.dueWarning}
</div>