| Viewer module | ||
|---|---|---|
| Previous | Next | |
| The web application runtime module | Batch module | |
The viewer module is the main runtime component of iKnowBase, responsible for serving content (pages and documents) to end users over a web interface. The module is almost always enabled, and we rarely recommend that it be disabled.
The ViewerConfiguration accepts these configuration properties:
| Property name | Description |
|---|---|
| com.iknowbase.viewer.enabled | Toggles whether the viewer server modules are available. |
The Content Server is the unit responsible for serving file content, such as word documents or PDFs. The ContentServerConfiguration accepts these configuration properties:
| Property name | Description |
|---|---|
| com.iknowbase.contentServer.defaultContentDisposition | Set to “inline” to have the browser try to open documents in-line, or to start Office for viewing. Set to “attachment” to have “save as” as the default browser behaviour. |
| com.iknowbase.contentServer.createResponseHeaders | Toggles whether to include HTML-headers for document information. Normally left unchanged. |
The Page Engine is the unit responsible for composing portlets and data, and rendering information to web clients.
The PageEngineConfiguration accepts these configuration properties:
| Property name | Description |
|---|---|
| com.iknowbase.pageEngine.contentCacheEnabled | Toggles whether content caching is used at all. The legal values are either “true” or “false”. |
The Search Client, using SOLR, handles connections to a SOLR search server. iKnowBase is capable of using multiple search engines for searching. The administrative interface uses a logical “search engine name” when mapping content for searching; for each such there is a corresponding SearchEngineConfiguration accepting these configuration properties:
| Property name | Description |
|---|---|
com.iknowbase.searchEngine.
<searchEngineName>.search.URL
|
URL to index server, e.g.
http://solr.example.com/solr.
|
com.iknowbase.searchEngine.
<searchEngineName>.search.connectionTimeoutMillis
|
Max number of milliseconds to wait for the connection. |
com.iknowbase.searchEngine.
<searchEngineName>.search.operationTimeoutMillis
|
Max number of milliseconds to wait for the operation. |
iKnowBase comes with an embedded process engine based on the Activity BPM Platform. This engine must be explicitly enabled if you want to use it.
The ActivitiProcessEngineConfiguration accepts these configuration properties:
| Property name | Description |
|---|---|
| com.iknowbase.process.activiti.enabled | Toggles whether the activiti engine is enabled |
| com.iknowbase.process.activiti.jobExecutorEnabled | Toggles whether the activiti engine will pick up jobs from the database, or only respond to online requests |
| com.iknowbase.process.activiti.processEngineName | Sets the name of the process engine. Should normally not be changed. |
| com.iknowbase.process.activiti.mailServerDefaultFrom | Sets default “from” address for email sent from activiti. |
| com.iknowbase.process.activiti.mailServerHost | Hostname for smtp server used when sending email. |
| com.iknowbase.process.activiti.mailServerPort | Port number for smtp server. |
| com.iknowbase.process.activiti.mailServerUsername | Username used for logging in to email server when sending email. |
| com.iknowbase.process.activiti.mailServerPassword | Password used for logging in to email server when sending email. |
When iKnowBase Process Services is installed, the runtime application(s) will need to know how to connect to the iKnowBase Process Services engine (ikbProcessServices), and how to log on to the underlying Oracle BPEL engine.
The BpelProcessServicesConfiguration accepts these configuration properties:
| Property name | Description |
|---|---|
| com.iknowbase.ProcessServices.WorkflowService.initialContextFactory | Name of the java-class to use for the InitialContextFactory when connecting to the Process Services Server |
| com.iknowbase.ProcessServices.WorkflowService.providerURL | URL used to connect to the Process Services Server |
| com.iknowbase.ProcessServices.WorkflowService.securityPrincipal | Username used for connecting to the Process Services server. This username is used by the application server itself, and is often not a real user. |
| com.iknowbase.ProcessServices.WorkflowService.securityCredentials | Password for the given user |
| com.iknowbase.ProcessServices.BPELWorkflowService.domain | The domain id for the BPEL-domain. The default value of “domain” is often correct. |
| com.iknowbase.ProcessServices.BPELWorkflowService.securityRealm | The realm used by Process Services when connecting on to the BPEL server. |
| com.iknowbase.ProcessServices.BPELWorkflowService.securityPrincipal | The username used by Process Services when connecting to the BPEL-server |
| com.iknowbase.ProcessServices.BPELWorkflowService.securityCredentials | The password used by Process Services when connecting to the BPEL-server. |
The values for WorkflowService.initialContextFactory and WorkflowService.providerURL vary between application servers. Typical values are as follows:
| Application server | Property | Format of typical value |
|---|---|---|
| Oracle WebLogic Server | WorkflowService.initialContextFactory | weblogic.jndi.WLInitialContextFactory |
| WorkflowService.providerURL | t3://localhost:8001 |
| Previous | Top | Next |
| The web application runtime module | Batch module |