General configuration
From the General Configuration page, you can configure the exporter options for the federator service and identify specific MIME types.
- Exporter options
- Exporter options are grouped into the following categories: General, Date and Time, Logging, Content Integrator, Scheduler, Run Workers, and Export Workers (multi-threading), and Federation Query (chunking and sweeping).
- MIME types
- Configure MIME types for applications that are not installed on the content integration server.
IBM®
FileNet® CFS for Content Integrator uses this information to set the Content Type property
for federated documents. For example, you can configure application types by entering the following
extensions and types and clicking Add: For more information, see About MIME types.
Extension Description doc application/msword ppt application/vnd.ms-powerpoint xls application/vnd.ms-excel html text/html jpeg image/jpeg png image/png
You can also export or import the content federation configuration from or to an XML format file.
Federation configuration parameter settings
The general configuration settings can greatly affect the performance of the federation process. The default settings are adequate to successfully federate a large number of documents. However, if your site experiences performance problems, you might want to modify the configuration settings to increase the throughput. In particular, modifying the batch size, chunk size, number of run workers, number of export workers, and number of Content Integrator RMI proxy servers can improve the performance of federation.
The following table describes the federation service options available on the General Configuration page.
General Configuration
Field | Type | Description |
---|---|---|
Documentation URL | String | You can link to IBM Knowledge Center online documentation on
www.ibm.com or to a local information center that you install and deploy. Internet access is
required for the online documentation. For more information, see Installing IBM
FileNet P8 Platform documentation. Choose one of the following options:
where:
|
Max Retries | Integer | If an item cannot be federated, it is put in an error queue. This setting determines how many times to try federating the item again. The default is 3. |
Max Display Errors | Integer | The maximum number of errors to display for each rule in the error list panel. The default is 1000. |
Max Display Errors Per Page | Integer | The maximum number of errors to display per page for each rule in the error list panel. The default is 20. |
Configuration Refresh Interval | Integer | Determines how often, in milliseconds, the federation manager (main thread) checks for any configuration changes, such as logging level or batch size. The default is 60000 milliseconds. |
Monitor Enabled | Boolean | Enable a Java™ applet that is started with each instance of an exporter to allow monitoring of run workers and export workers. The default is FALSE. |
Accessibility | Boolean | Enable or disable the accessibility feature. The default is ON. |
Data and Time
Field | Type | Description |
---|---|---|
Date Format | List | Examples of date formats:
|
Time Format | List | Examples of time formats:
|
Time Zone | List | Examples of time zone formats:
|
Logging
Field | Type | Description |
---|---|---|
Logging level | List | Determines the logging level. The default is INFO.
|
Log File Name | String | The log file name. By default, the log file is in CFS_HOME\FedExporter\logs\federator.log. |
IBM Content Integrator
Field | Type | Description |
---|---|---|
Configuration Server URL | String | Content Integrator configuration server URL. A comma-separated list of URLs can be provided. For example, rmi://localhost:1250/ConfigurationServer |
Single Sign-On Server URL | String | Content Integrator SSO server URL. A comma-separated list of URLs can be provided. For example, rmi://localhost:1250/SSOServer |
Administrator User Name | String | Content Integrator administrator user name. |
Use Session Pool | Boolean | Determines whether to use theContent Integrator session pool or not. The default is TRUE. |
Session Pool Pooling Period | Integer | Sets the polling period, in milliseconds, for each Content Integrator session pool to check with the configuration server for updates to the session pool configuration. Use 0 to never check for updates and fix the pool configuration at startup. The default is 300000 milliseconds. |
Max Session Checkout Time | Integer | Sets the maximum time, in milliseconds, that a Content Integrator session can be used. If the maximum check-out time is reached, a new session is retrieved to continue the work in progress. The default is 900000 milliseconds. |
Scheduler
Field | Type | Description |
---|---|---|
Refresh Interval | Integer | Determines how often, in milliseconds, the scheduler checks to see whether rules are available to run or if any rules are ready for a state transition. The default is 60000 milliseconds. |
Run Workers
Field | Type | Description |
---|---|---|
Run Lease | Integer | The wait time, in seconds, before a run worker can start processing a rule that was locked or leased by another worker. The default is 900 seconds. |
Max Number of Workers | Integer | The number of run workers (threads) that can process runs concurrently. Range is 1-10. The default is 2 run workers. |
Max Runs In Queue | Integer | The maximum number of runs that can be locked or leased at the same time for the run workers to process. Range is 5-50. The default is 10. |
Batch Size | Integer | The maximum size of each batch of items to federate. The default is 500. |
Export workers
Field | Type | Description |
---|---|---|
Request Lease | Integer | The wait time, in seconds, before an export worker can start processing a batch that was locked or leased by another worker. The default is 900 seconds. |
Max Number of Workers | Integer | The number of export workers (threads) that can process runs concurrently. Range is 1-20. The default is 10 export workers. |
Max Requests In Queue | Integer | The maximum number of batches that can be locked or leased at the same time for the export workers to process. Range is 5-50. The default is 20. |
Federation Query
Field | Type | Description |
---|---|---|
Unique ID Property | String | The default unique ID property to use for chunking if no such property is defined by the repository or in the data map. |
Revision Date Property | String | The default revision date property to use for sweeping if no such property is defined by the repository or in the data map. |
Data Map Lookup Only | Boolean | Use the data map definitions for the unique ID (chunking) and revision date (sweeping) properties. Do not use the predefined properties from the repositories. |
Chunk Size | Integer | The maximum number of documents to retrieve in a single chunk (query). The default is 2000. |