iKnowBase Development Guide

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

  1. iKnowBase Development Guide
  2. Introduction
    1. Preface
      1. About this guide
      2. Audience
      3. Conventions used in this guide
    2. Overview
      1. Development
      2. Meta-modeling
  3. iKnowBase Development Studio
    1. The Work Area
      1. Navigation pane
      2. List pane
      3. Edit pane
    2. Navigating the Work Area
      1. Development Tools and Advanced
      2. User Directory and Metadata Management
    3. Searching for Information
      1. Development Tools and Advanced
      2. User Directory and Metadata Management
    4. Sorting the lists
    5. Basic Tasks
      1. Creating a New Object
      2. Viewing an Object
      3. Copying an Object
      4. Editing an object
      5. Deleting an object
      6. Adding an object to a patch set
      7. Displaying identifiers, audit- and storage information
  4. iKnowBase Content Studio
    1. Image Variants
      1. Add Image Variant Definition
      2. Change Image Variant Definition
      3. Remove Image Variant Definition
      4. Create Image Variants
    2. Quicklinks
    3. Searchfields
  5. iKnowBase Content Services
  6. Building iKnowBase Applications
    1. Key components
    2. Building Web Pages
      1. Standalone Pages
      2. Embedded pages
      3. Layout Pages
    3. Adding Content to Web Pages
    4. Tooltip functions
      1. Predefined tooltip functions
      2. Define your own tooltip functions
    5. Executing business logic
      1. Script Targets
  7. Using Scripts and Templates
    1. Template concepts
    2. Available components
    3. Model objects
    4. Available template languages
      1. FreeMarker
      2. Groovy
        1. Implicit objects
        2. Examples
      3. JavaScript
      4. HTML script
    5. Template chaining
    6. Error handling
  8. Advanced Configuration
    1. Domains
      1. The Default Domain
      2. Custom Access Control
      3. Public user
      4. Weight on free-text search
    2. Attribute Security Function
      1. Enable and Disable the Attribute Security Function
      2. Signature of the Attribute Security Function
    3. Run custom access control
      1. Enable and Disable the custom access control
      2. Signature of run_custom_access_control
  9. Using Apache Solr for Content Search
    1. Concept
    2. Installation and setup
      1. iKnowBase security
    3. Configuring the indexing process
    4. Building a search page
      1. Sample search page structure
    5. Configuring search suggestions
    6. Monitoring the Solr solution
  10. Using iKnowBase Instant
    1. Concept
      1. JavaScript API and transport mechanisms
        1. Synchronous HTTP
        2. Asynchronous HTTP
          1. long-polling
          2. websocket
        3. Transport failover
        4. Blocking and non-blocking I/O
      2. Topics
      3. Message formats
      4. Public and private messages
      5. User list support
        1. requestUserList
        2. subscribeUserListChanges
      6. APIs
    2. Installation and setup
    3. Deployment and scaling
    4. Security
      1. Authentication
        1. Authenticating with Secure Token
        2. Authenticating with direct application container authentication
      2. Authorization
      3. Private messages
    5. Monitoring
    6. Building solutions
      1. Project wide settings
        1. Project wide sample basic
        2. Project wide sample with secure token authentication
        3. Project wide sample with secure token authentication and CORS enabled
        4. Instant subscribe with CORS
      2. Simple Web to Web Client using text messages
      3. Simple Web to Web Client using IKB messages and secure token authentication
      4. Chat With User List Support
      5. Content updates notifications Using Database Integration
        1. Instant publish/subscribe sample code
        2. Event
        3. IKB database function mapping
        4. Database procedure PUBLISH_TOPIC1
      6. Livefeed Using Database Integration
      7. Livefeed Using Cache Refresh Events
  11. Performance
    1. Concept
    2. Monitoring
    3. Caching on the client
      1. Static shared resources (/ressurs)
      2. Caching content from the content server (/Content)
        1. HTTP Response cache directives to client based on client input
        2. HTTP Response cache directives to client for autogenerated URLs to iKnowBase content
    4. Caching on the application server
      1. Metadata Cache
      2. Page engine content cache
        1. Configure content caching
        2. Access control
        3. Refreshing the content cache
        4. Instant notifications of content cache updates
        5. Setup
      3. Clustering and the application server cache
    5. Render Strategy
  12. Integrating with an LDAP Directory
    1. Understanding LDAP synchronization
    2. Synchronizing users
      1. User objects
      2. Organization objects
      3. Optional Attributes
      4. Pre and Post Plug-Ins
        1. Pre user synch plug-in
        2. Post user synch plug-in
    3. Synchronizing groups
      1. Decide which groups to map
      2. Hierarchical groups
      3. Scheduling a Synchronization
    4. LDAP provider specific requirements - OpenDJ
  13. Integrating with Oracle Secure Enterprise Search
    1. Concept
    2. Install the iKnowBase adapter into Oracle SES
    3. Create a source
    4. Schedule a source for indexing
    5. Security
    6. Search User Interface
    7. Custom filter plugin
  14. Integrating with an E-mail Server
    1. Configuring E-mail Accounts
    2. Process Flow of the E-mail Reader
    3. E-mail Reader data model
    4. Message Handler
    5. Reliable Messaging
    6. Running the iKnowBase E-mail Reader
    7. Configuring logging
  15. Integration Using External Attribute Types
    1. External Source API
      1. Example: Topic Map API
  16. iKnowBase Service API
    1. Security considerations
    2. API documentation
    3. Sample code
      1. Instantiate a reference object
        1. Java
        2. PL/SQL
      2. Instantiate a document attribute
        1. Java
        2. PL/SQL
      3. Document properties
        1. Java
        2. PL/SQL
      4. Create document
        1. Java
        2. PL/SQL
      5. Delete document attribute
        1. Java
        2. PL/SQL
  17. iKnowBase Process Services for Activiti
    1. Preparations
    2. Developing process applications
      1. Accessing Activiti data from a ScriptViewer
      2. Accessing iKnowBase data from a ScriptTask
      3. Using a form to start processes and complete UserTasks
  18. iKnowBase Development Toolkit
    1. Getting started
      1. About the build system
      2. Requirements
      3. Distribution files for development
        1. sample-build-root
        2. sample-plugin-projects
      4. Step-by-step setup
        1. 1. Extract the provided development .zip files
        2. 2. Configure build
          1. gradle.properties
          2. settings.gradle
          3. build.gradle for your plugin projects
          4. build.gradle for your root project
        3. 3. Configure iKnowBase properties
        4. 4. Test from command line
        5. 5. Import in your favorite IDE
          1. IntelliJ IDEA
          2. Eclipse
        6. 6. Setup iKnowBase web server run configuration in IDE
      5. Assemble your plugins
      6. Patch iKnowBase web application with your plugins
        1. Run using the iKnowBase web server
      7. Deploy
    2. Plugin assembly
      1. .jar plugin
      2. .war plugin
      3. Libraries
    3. The iKnowBase application container
      1. Extension points
      2. Configuring the application container
      3. Spring @Beans
        1. Inject services
        2. Inject configuration
      4. Spring MVC Controller
        1. Inject services and configurations
        2. Inject method arguments
        3. Security
      5. Static web resources
      6. Activiti
      7. Using a plugin from iKnowBase Development Studio groovy components
      8. Logging configuration
      9. Solr Server
      10. Form
        1. Bean-to-document mapping
        2. Form Processor
        3. Form integration with iKnowBase Classic components
    4. Available samples
      1. iKnowBase Reference Plugins
    5. Troubleshooting
      1. Classpath issues in Eclipse based IDEs
      2. Out of memory issues when building gradle project model
      3. Accented (Norwegian) text loaded using resource bundle has wrong encoding
      4. My Spring MVC Controller is not available as expected on the mapped path
      5. Run from IDE does not start iKnowBase. Seems like application is missing.
  19. User Administration
    1. Overview of User Administration
    2. Manage Users
      1. Automatic User Synchronization
      2. Manual User Synchronization
    3. Manage Groups
  20. Security Administration
    1. Overview of Security Administration
    2. Manage Access Control Lists
    3. Assign Access Control Lists to Objects
      1. Overview of Document Access
      2. Overview of Dimension Access
      3. Overview of Form Access
      4. Overview of Task Wizard Access
      5. Overview of Page Access
      6. Overview of Subsystem Access
  21. Metadata Administration