Specifies the parameters that can be used when configuring the Content Engine API.

This class provides a set of constants to specify values for:

Configuring connections to the IBM FileNet P8 domain.
Specifying client metadata cache (CMC) configuration options.

This class includes support for parsing configuration values. Comparisons and lookups are case-insensitive, so the case of string key equivalents is not significant.

This class also includes an array of valid types, such as {Integer.Class, Boolean.Class}, to assist you in parsing and validating parameter values. The list is Null if not applicable, or is dependent on the context of where the parameter is used. A non-null list always has a length of at least one.

To set parameter values, create an instance of ConfigurationParameters, call ConfigurationParameters.SetParameter, passing in the desired parameter values, and then call Configuration.Init. The code snippet below sets the block size for retrieving content:

            ConfigurationParameters parameters = new ConfigurationParameters();
            Object value = new Integer(64);
            parameters.SetParameter(ConfigurationParameter.CONTENT_GET_BLOCK_SIZE_KB, value);
            Configuration.Init(parameters);

Namespace: FileNet.Api.Constants
Assembly: FileNet.Api (in FileNet.Api.dll)

Syntax

Visual Basic (Declaration)
Public Enumeration ConfigurationParameter

C#
public enum ConfigurationParameter

Visual C++
public enum class ConfigurationParameter

JavaScript
FileNet.Api.Constants.ConfigurationParameter = function(); FileNet.Api.Constants.ConfigurationParameter.createEnum('FileNet.Api.Constants.ConfigurationParameter', false);

Members

Type	Member name	Description
	CONNECTION_PARTICIPATES_IN_TRANSACTION	A constant representing a ConfigurationParameter instance of type CONNECTION_PARTICIPATES_IN_TRANSACTION. Setting this value is not supported. Since the .NET API always uses Content Engine web services connections, transactions are never propagated when using the .NET API.
	CONNECTION_CLIENT_METADATA_CACHE	A constant representing a ConfigurationParameter instance of type CONNECTION_CLIENT_METADATA_CACHE. This configuration parameter specifies whether to use caching for operations with the given connection. The default is Factory.MetadataCache.GetDefaultInstance(), equivalent to Boolean.True, which specifies that caching is used.
	CMC_ENABLED	A constant representing a ConfigurationParameter instance of type CMC_ENABLED. The default is Boolean.True, which enables client metadata caching. Refer to Boolean.ValueOf(String) for parsing. Note:This setting can only be configured during initialization. See Configuration.Init. This setting affects global client metadata caching. For example, if set to Boolean.False at initialization, you cannot subsequently use ConfigurationParameter.CONNECTION_CLIENT_METADATA_CACHE to enable client metadata caching for a connection.
	CMC_TIME_TO_LIVE	A constant representing a ConfigurationParameter instance of type CMC_TIME_TO_LIVE. The Time-To-Live (TTL) value is specified in milliseconds; the default is 10 hours. Items are removed from the cache when their TTL expires. Note: This can only be configured during initialization. See Configuration.Init.
	CONNECTION_FULL_WSSPEC_HEADERS	A constant representing a ConfigurationParameter instance of type CONNECTION_FULL_WSSPEC_HEADERS. This member accepts a boolean value, and controls whether or not the client sends certain SOAP WS-Security and WS-Addressing header elements that ordinarily the Content Engine server does not require. If the value is false (the default if no setting is specified), those headers are not sent, which can improve performance in some configurations. Setting the value to true causes the full set of headers to be sent. Note that when this value is set in a configuration file, it affects all connections. Programmatically setting this /// parameter on an individual connection overrides the configuration file setting for that individual connection.
	CONTENT_MAX_UPLOAD_THREADS	A constant representing a ConfigurationParameter instance of type CONTENT_MAX_UPLOAD_THREADS. This value is the maximum number of threads per document that can be used to upload content to the Content Engine server. The default value is 3.
	CONTENT_PUT_BLOCK_SIZE_KB	A constant representing a ConfigurationParameter instance of type CONTENT_PUT_BLOCK_SIZE_KB. This value is the size of the buffer used for each PutContent request to upload content to the Content Engine Server, measured in kilobytes. The default value is 1024. The maximum limit on chunk size for PutContent is 10*1024 (10MB).
	CONTENT_GET_BLOCK_SIZE_KB	A constant representing a ConfigurationParameter instance of type CONTENT_GET_BLOCK_SIZE_KB. This value is the number of bytes to get from the Content Engine server on each GetContent request, measured in kilobytes. The default value is 1024 (1 MB). As an example, if this value is set to 64, then 64*1024 bytes of content are requested from the Content Engine server for each GetContent request.
	WSI_TRANSPORT_CONNECTION_TIMEOUT	A constant representing a ConfigurationParameter instance of type WSI_TRANSPORT_CONNECTION_TIMEOUT. This value determines the amount of time allowed before a connection timeout occurs when using the web services transport of the API. There is no default for this setting. If not set, there will be no timeout; that is, an infinite amount of time is allowed for the API call to complete.
	WSI_TRANSPORT_PREFER_WCF	A constant representing a ConfigurationParameter instance of type WSI_TRANSPORT_PREFER_WCF. This member accepts a boolean value, and controls whether or not the client prefers to use the Windows Communication Foundation (WCF) for web service operations instead of the Web Services Extensions (WSE), on systems where both are installed. Setting the values to true causes WCF to be used if possible, while a setting of false (the default if no setting is specified), results in WSE being used. When this value is set in a configuration file, it affects all connections. Programmatically setting this parameter on an individual connection overrides the configuration file setting for that individual connection.
	CONNECTION_MAX_POOLED_SESSIONS	A constant representing a ConfigurationParameter instance of type CONNECTION_MAX_POOLED_SESSIONS. This member accepts an integer value defining the maximum number of sessions to hold in a pool for a connection. A session is required for each individual web service operation made on behalf of the connection, and sessions are allocated on demand to match the level of concurrency of operations per connection. Once an operation has completed, the session may be re-used for a subsequent operation so a pool of such sessions is kept, up to the maximum size specified by this parameter, allowing subsequent operations to avoid the overhead of creating a new session. When this value is set in a configuration file, it affects all connections. Programmatically setting this parameter on an individual connection overrides the configuration file setting for that individual connection. The default if no value is specified is 5.
	CMC_USER_SPECIFIC	A constant representing a ConfigurationParameter instance of type CMC_USER_SPECIFIC. This member accepts a boolean value specifying whether the client metadata cache should be sensitive to user identity. The default value is false.

Syntax

Members

See Also