Content viewer

Overview

The figure below gives a quick overview of the models available to the ContentViewer.

• viewer
  • data
    • isEmpty
    • count
    • lastLevel
    • level/recurse
      • fields
        • <name> (String, Number, Date)
          • text
          • date
          • number
          • externalKey
          • hasValue
          • label
          • style
          • xml
          • url
          • script
          • nodeText
      • documentLevel
      • documentId
      • isFirst
      • isLast
      • isOdd
      • isEven
      • sub
        • data
        • style
• style
  • fields
    • <name>
      • label
      • isSortActive
      • isSortActiveAscending
      • isSortActiveDescending
      • sortAction
      • sortActionAscending
      • sortActionDescending
      • sortIconActive
      • sortIconAscending
      • sortIconDescending
  • hasQuickLink
  • quickLink
    • text
    • url
    • script
    • nodeText
  • portletTitle
• logic
  • languageId
  • noRecordsFound
  • currentDate
  • dbExecute
• navigation
  • pageSize
  • firstRow
  • totalRows
  • startRow
  • maxRow
  • lastRow
  • text
  • isEmpty
  • range
  • first
  • previous
  • next
  • last
  • goto
  • showMore
• param
  • username
  • pageurl
  • referencepath
  • servername
  • serverport
  • guid
  • <name>
• strings
  • <name>
    • style
    • viewer
    • domain
• context
  • user
    • id
    • username
    • token
      • name
      • value
  • date
  • time
  • datetime
  • millis
• request
  • pageurl
  • servername
  • serverport
• component
  • id

Global objects

These are the global (top level) objects available when using FreeMarker from a ContentViewer.

ViewerModel

This object contains information about the ContentViewer itself, its definition and data.

RowSetModel

This object contains a set of rows/documents. The top level RowSetModel (as returned from viewer.data) contains all rows/documents returned from the content viewer, whereas RowSetModels accessed differently (for example through row.sub from a specific row) contains only a partial set of documents.

The object is a freemarker sequence model, so you can access the nodes directly using ${data[index]}, or you can traverse it using the ...[/#list] syntax.

The object is also a freemarker node, so you can also use the built-ins ?children, ?parent, ?root, ?ancestors, ?node_name, ?node_type and ?node_namespace. The ?node_name and ?node_type properties are both “DocumentList”.

RowModel

This model object contains information about a single row / document returned from the viewer.

The model is a freemarker node, so you can also use the built-ins ?children, ?parent, ?root, ?ancestors, ?node_name, ?node_type and ?node_namespace.

Note that part of the information is context sensitive. For example, a document might be the second document in the collection data.viewer.level (and thus have isOdd=false), while also being available as the third document in the collection data.viewer.recurse (and thus have isOdd=true).

DocumentModel

This object represents an iKnowBase document. The structure of the DocumentModel is more or less the same as the “Document” object in the ServiceAPI.

Note that this model may not be fully populated. In particular, the various ObjectReferences will probably only contain an id or a guid, and the list of attributes is often not present.

DataFields

This object is a FreeMarker “hash” container containing the data fields for a given document in the ContentViewer. The object can be accessed by field name, as defined in the presentation style defintion.

DataFieldString

This object contains the data field of type String.

DataFieldNumber

This object contains the data field of type Number.

DataFieldDate

This object contains the data field of type Number.

DataFieldClob

This object contains the data field of type Clob.

DataFieldFiles

This object contains the data field of type Files, e.g. where the value is one or more files. This is of course used for attachments, but also for derived image formats (such as thumbnails) for image documents.

DataFieldFile

This object represents a File value.

DataFieldReference

This object contains an ObjectReference, e.g. a reference to an object in the iKnowBase repository. Exactly what is being pointed to cannot be found from this object; this must be derived from the context (such as the containing attribute): A value list attribute would contain a reference to a value list, while a dimension attribute would contain a reference to a dimension.

DataFieldReferences

This object contains the data field of type References, e.g. where the value is one or more
references to external objects (value lists, dimensions, etc).

DataFieldAction

This object represents a single action, typically represented as a HTML <a>-tag.

DataFieldUserAction

This object is an extension of the DataFieldAction-object, and represents an action that applies to a specific user. In addition to the action information in the DataFieldAction-object, you can also find information about the referred user:

DataFieldObjectAction

This object is an extension of the DataFieldAction-object, and represents an action that applies to a specific object. In addition to the action information in the DataFieldAction-object, you can also find information about the referred object; the type of the object should be apparent from the type of the field:

DataFieldDocumentAction

This object is an extension of the DataFieldAction-object, and represents an action that applies to a specific document. In addition to the action information in the DataFieldAction-object, you can also find information about the referred object:

DataFieldActions

This object is used for data fields that represent multiple actions, for example when retrieving document and image links.

Note that the Actions (plural) object typically will return HTML corresponding to all of the linked objects, while you can access each individual link through the sequence operator. Also, detailed information about the referenced object (such as the object label / document title) is only available by referencing the individual objects.

AttributeModel

This object contains information about a defined attribute. Most DataField model objects have a reference to an AttributeModel object.

StyleModel

This object contains the presentation style definition for a ContentViewer, or for a specific level inside the Content Viewer.

QuickLinkModel

This object represents a quick link, as defined in a ContentViewer.

StyleFields

This object is a FreeMarker “hash” container containing the field specifications for a given presentation style. The object can be accessed by field name, as defined in the presentation style defintion.

StyleField

This object contains the properties defined on a single field in a presentation style.

The term “next sorting” is used to indicate that the property adapts to current state: If the field is not sorted, it returns a value suitable for ascending sort; if the field already has ascending sort, it returns a value suitable for descending sort; finally, if it already has descending sort, it returns a value suitable for ascending sort.

Logic

This object contains the set of fields defined in the presentation style

Example:

[@viewer.logic.dbExecute]
BEGIN
    HTP.prn ('<div>');
    HTP.prn ('You are currently connect to instance number ' || DBMS_UTILITY.CURRENT_INSTANCE);
    HTP.prn ('</div>');
END;
[/@viewer.logic.dbExecute]

Navigation

This object contains information supporting navigation in the viewer.

GotoModel

This object is a method model that lets you generate links to specific row numbers. As the object is a method, you call it using a method syntax as shown below.

To generate a simple link, use the syntax with a single argument:

To generate a link that both navigates to a specific row and sets the page size, use the syntax with two arguments:

To generate a list of links, use the syntax with three arguments. The method will return a list of links, useful for generating navigating bars with many links, for many pages:

The list method will not return any illegal links. If you request goto(50,10,10), you are asking for 10 links to rows 50, 60, 70 ... 140. However, the method will not return links beyond the last record, so if the viewer has only 65 records, you would get two links only, to rows 50 and 60.

The list method will also allow you to generate links “backwards”, using a negative interval. goto(50,-10,10) will generate ten links 10 record intervals, up to row 50. Since it will not generate illegal links, this will in fact return five links: 10,20,30,40 and 50.

Examples:

<!-- To generate a single link to row number 50 -->
${viewer.navigation.goto(50)}

<!-- To generate five links before "this row", then "this row", then five links after -->
[#list viewer.navigation.goto(viewer.navigation.firstRow-10, -10, 5) as link]${link}[/#list]
${viewer.navigation.goto(viewer.navigation.firstRow)}
[#list viewer.navigation.goto(viewer.navigation.firstRow-10, +10, 5) as link]${link}[/#list]

HtmlLink

This object represents a single html link.

When used directly, the HtmlLink returns a string with the full link ( <a>...</a>);

NavigationLink

This object represents a single navigation link.

When used directly, the NavigationLink returns a string with the full link ( <a>...</a>);

An invalid link has a start row outside the legal range. Both previous, next and last can return in invalid links, for example if you try to refer to the “previous” value when already on the first page. An invalid link has startRow set to null, url and onclick set to null, while the label contains the proper value.