iKnowBase API Reference

Welcome to iKnowBase! This is the on-line documentation for iKnowBase. Please enjoy!

1. iKnowBase API Reference
2. API Reference
3. FreeMarker Templates
   1. About FreeMarker
   2. Includes and imports
   3. FreeMarker Directives
   4. Built-in Functions
      1. Built-ins for strings
      2. Built-ins for numbers
      3. Built-ins for dates
4. Groovy Templates
   1. About Groovy
   2. Where can you use Groovy
   3. Implicit objects
   4. Examples
5. FreeMarker model reference
   1. Understanding the notation
   2. Wrapped objects
6. Generic models
   1. ObjectReferenceModel
   2. ComponentModel
   3. ContextModel
   4. UserModel
   5. UserTokenModel
   6. SocialAuthenticationModel
   7. DomainMode
   8. RequestModel
   9. ParametersModel
   10. ParameterModel
   11. TextMapModel
       1. TextMapModel
       2. TextStringModel
   12. LoadXML macro
   13. LoadURL macro
   14. AssignDate macro
7. Content viewer
   1. Overview
   2. Global objects
   3. ViewerModel
   4. RowSetModel
   5. RowModel
   6. DocumentModel
   7. DataFields
   8. DataFieldString
   9. DataFieldNumber
   10. DataFieldDate
   11. DataFieldClob
   12. DataFieldFiles
   13. DataFieldFile
   14. DataFieldReferences
   15. DataFieldReference
   16. DataFieldActions
   17. DataFieldAction
   18. AttributeModel
   19. StyleModel
   20. QuickLinkModel
   21. StyleFields
   22. StyleField
   23. Logic
   24. Navigation
   25. GotoModel
   26. HtmlLink
   27. NavigationLink
8. Content search
   1. Global objects
   2. ViewerModel
   3. SearchModel
9. XML viewer
   1. Overview
   2. Global objects
   3. ViewerModel
10. Dimension viewer
    1. Overview
    2. Global objects
    3. ViewerModel
    4. DimensionListModel
    5. DimensionModel
    6. DimensionActionModel
11. Menu viewer
    1. Overview
    2. Global objects
    3. ViewerModel
    4. MenuItemListModel
    5. MenuItemModel
    6. MenuItemActionModel
12. HTML Viewer
    1. Overview
    2. Global objects
13. BPEL Task form
    1. Overview
    2. Global objects
    3. TaskFormModel
    4. XMLFormModel
    5. AttributesModel
    6. AttributeModel
    7. SubmitModel
    8. Definition
14. BPEL Task viewer
    1. Overview
    2. Global objects
    3. TaskModel
    4. TaskDataModel
    5. TaskFieldModel
    6. TaskStyle
    7. TaskStyleField
15. BPEL Process viewer
    1. Overview
    2. Global objects
    3. ProcessModel
16. Activiti Form viewer
    1. Overview
    2. FormModel
    3. FormDataModel
    4. FormComponentModel
    5. FormDirective
    6. FormInputDirective
    7. FormLabelDirective
    8. FormButtonDirective
    9. FormMessageDirective
17. Page
    1. Overview
    2. Global objects
    3. PageModel
    4. ResourcesModel
    5. RegionsModel
    6. RegionModel
    7. PageComponentModel
18. Javascript library
    1. Global objects
    2. iKnowBase root object
       1. busyIndicator
          1. Parameters
          2. Methods
          3. Example
       2. notify
          1. Parameters
          2. Methods
          3. Example
    3. iKnowBase.PageEngine
       1. reloadComponent
          1. Syntax and parameters
          2. Finding the id of the page component
          3. Deprecated syntax and parameters
    4. iKnowBase.PageEngine.InstantContentCache
       1. start
          1. Syntax and parameters
    5. iKnowBase.Instant
       1. Atmosphere.subscribe
          1. Syntax
          2. Options
          3. Topic name and topic options
          4. Examples
       2. Atmosphere.publish
          1. Syntax
          2. Example
       3. Atmosphere.unsubscribe
          1. Syntax
       4. Atmosphere.requestUserListUpdate
          1. Syntax
          2. Requirements
          3. Example
       5. Atmosphere.requestUserList
          1. Syntax
          2. Requirements
          3. Example
       6. Atmosphere.requestSubscribeUserListChanges
          1. Syntax
          2. Requirements
          3. Example
       7. setDefaultOptions
          1. Syntax
       8. Complete example
19. Content Server
    1. Download content
    2. Download multiple files
    3. Upload content
       1. Existing documents
       2. New documents
20. Page Engine
    1. General use
    2. Language support
    3. Database trace functionality
    4. Refresh content cache
21. Form HTML Template support
    1. Overview of iKnowBase-specific tags
    2. ikb:form
    3. ikb:formname
    4. ikb:label
    5. ikb:input
    6. ikb:dimension
    7. ikb:favorite_select
    8. ikb:space
    9. ikb:calendar
    10. ikb:radio
    11. ikb:check
    12. ikb:select
    13. ikb:button
    14. ikb:related_object
    15. ikb:related_image
    16. ikb:file
    17. ikb:filelink
    18. ikb:fileurl
    19. ikb:attachment
    20. ikb:textarea
    21. ikb:imagevariant
    22. ikb:addattribute
    23. ikb:display_add_attr
    24. ikb:prompt
    25. ikb:display
    26. ikb:conditional
    27. ikb:masterselect
    28. ikb:condition
    29. oracle
22. SOLR Schema model
    1. Overview of iKnowBase fields in solr/Schema.xml
23. Instant Server
    1. HTTP API
       1. /ikb$service/v1/sendMessage:
       2. /private/ikb$service/v1/sendMessage:
       3. Sending messageFormat=IKB
       4. /ikb$service/v1/requestUserList:
       5. /private/ikb$service/v1/requestUserList:
       6. /ikb$service/v1/requestUserListUpdate:
       7. /private/ikb$service/v1/requestUserListUpdate:
    2. PLSQL API
       1. Publish message
       2. Server request: requestUserList
       3. Server request: requestUserListUpdate