WebSphere brand IBM WebSphere XML Document Management Server, Version 7.0

Resource Environment Providers for the XDMS enablers

Several Resource Environment Providers (REPs) exist for the XDMS enablers.

Resource Environment Providers for each enabler

Table 1. Enabler Resource Environment Providers. Each enabler has the following Resource Environment Provider properties:
Property name Example value Property type Required? Property description
superAdminUser superadmin String Required A user configured with the super-admin role (recommended value: superadmin)

Can be changed dynamically at runtime

superAdminPassword password String Required Password for the super-admin role (recommended value: none)

Can be dynamically changed at runtime

xcapRoot http://localhost:9080/services String Required The XCAP Root of the Aggregation Proxy, if installed, or the XCAP Root of the local server (recommended value: http(s)://hostname:ports/services)

Can be changed dynamically at runtime

preserveWhitespace false Boolean Required Whether the DataStore function should preserve whitespace in the XML documents (recommended value: true)

Can be changed dynamically at runtime

alarmInterval 15 Integer Not required The number of minutes between Alarm notifications for the same alarm (recommended value: 15)

Can be changed dynamically at runtime

includeNotifyTransaction false Boolean Required If an error occurs during JMS notification (system error), this Boolean flag determines whether the system error causes the database transaction to roll back database updates. If true, the JMS error causes a rollback and if false, it has no effect on the database transaction (recommended value: false)

Cannot be changed dynamically at runtime

enableDraftPutConditionalSupport false Boolean Not required Enables draft support of conditional headers (If-None-Match and If-Match) (recommended value: false, unless this support is needed)

Draft versions of RFC 4825 allowed requests with conditional headers set to '*' to test for existence of a particular element/attribute of a document, rather than the document itself. Only applies if the request has a node selector and the headers only contain '*'

Can be changed dynamically at runtime

repRefreshInterval 5 Integer Not required Refresh interval, in minutes, of REP custom properties (recommended value: 5 or more)

For values that can be changed dynamically, the custom property information is read at this interval, allowing the configuration to be updated without a restart of the server. A value of zero will mean the information is never refreshed

Cannot be changed dynamically at runtime

initialNotifyWaitTime 0 Integer Not required Milliseconds to pad between the sending out of a 200 response for a SUBSCRIBE request and the initial notify for that SUBSCRIBE request

Resource Environment Providers for each AUID

Table 2. Resource Environment Providers. Each AUID has the following Resource Environment Provider properties:
Property name Example value Property type Required? Property description
enableSchemaValidation true Boolean Required Enables or disables XML schema validation (recommended value: true)

Can be changed dynamically at runtime

listMinimumMembers -1 Integer Not required Minimum number of members in a list (recommended range: 0-10000)

If not specified or a negative number, the minimum members policy is disabled

Can be changed dynamically at runtime

listMaximumMembers -1 Integer Not required Maximum number of members in a list (recommended range: 0-10000)

If not specified or a negative number, the maximum members policy is disabled

Can be changed dynamically at runtime

db!default!datasource jdbc/xdms String Required Data source used for communicating with the XDMS database (recommended value: jdbc/xdms)

Cannot be changed dynamically at runtime

The application must be restarted for this setting to take effect

db!default!table resourcelists String Required Database table to use for storing documents (recommended value: resourcelists)

Cannot be changed dynamically at runtime

The application must be restarted for this setting to take effect

enableStandardAuthorization true Boolean Required Enables or disables standard authorization (recommended value: true)

Users with standard authorization have admin permission to their own home directory and read permission to global documents

Can be changed dynamically at runtime

authorizationPolicyAuid com.ibm.resource-lists-acls String Required AUID for authorization policy rules that represents ACLs for rls-services. (recommended value: com.ibm.resource-lists-acls)

Cannot be changed dynamically at runtime

sipRespondPending false Boolean Required Whether to respond immediately to SIP SUBSCRIBE requests with a 202 status code meaning "accepted but pending" (recommended value: false)

Can be changed dynamically at runtime

sipDefaultExpire 3600 Integer Required Default expire time in seconds if no expire time is specified in the SIP SUBSCRIBE request (recommended value: 3600)

Can be changed dynamically at runtime

sipMinimumExpire -1 Integer Not required Minimum required expire time in seconds that is specified in the SIP SUBSCRIBE request (recommended range: 0-3600)

If not specified or a negative number, the minimum expires policy is disabled

Can be changed dynamically at runtime

sipMaximumExpire -1 Integer Not required Maximum allowed expire time in seconds that is specified in the SIP SUBSCRIBE request (recommended range: 60-86400)

If not specified or a negative number, the maximum expires policy is disabled

Can be changed dynamically at runtime

usageRecordDatasource jdbc/xdmsur String Not required Data source used for communicating with the XDMSUR database that is used to store usage records (recommended value: jdbc/xdmsur)

Cannot be changed dynamically at runtime

The application must be restarted for this setting to take effect

enableXcapPutUsageRecordLogging false Boolean Not required Enables or disables usage record logging for XCAP PUT requests (recommended value: false)

If enabled, the usageRecordDatasource must be configured

Can be changed dynamically at runtime

enableXcapGetUsageRecordLogging false Boolean Not required Enables or disables usage record logging for XCAP GET requests (recommended value: false)

If enabled, the usageRecordDatasource must be configured

Can be changed dynamically at runtime

enableXcapDeleteUsageRecordLogging false Boolean Not required Enables or disables usage record logging for XCAP DELETE requests (recommended value: false)

If enabled, the usageRecordDatasource must be configured

Can be changed dynamically at runtime

enableXcapPostUsageRecordLogging false Boolean Not required Enables or disables usage record logging for XCAP POST requests (recommended value: false)

If enabled, the usageRecordDatasource must be configured

Can be changed dynamically at runtime

enableSipSubscribeUsageRecordLogging false Boolean Not required Enables or disables usage record logging for SIP SUBSCRIBE requests (recommended value: false)

If enabled, the usageRecordDatasource must be configured

Can be changed dynamically at runtime

enableExternalElementValidation false Boolean Not required Whether newly inserted external elements should be validated to ensure that there are no recursive references (recommended value: false)

Can be changed dynamically at runtime

auditLogByRole super-admin String Not required Comma-separated list of users

If specified, requests and responses are logged only for these users

maxSearchResults 0 Integer Not required Number of search results to return from the query (default value: 0)

If equal to or less than 0, all search results are returned

Can be changed dynamically at runtime

sendUAProfileChangeLog False Boolean Not required Enables change log information within XCAP Diff of a UA Profile event notify

ACLS Resource Environment Providers

Table 3. ACLS Resource Environment Providers. Each ACLS AUID has the following Resource Environment Provider properties:
Property name Example value Property type Required? Property description
enableSchemaValidation true Boolean Required Enables or disables XML schema validation (recommended value: true)

Can be changed dynamically at runtime

db!default!datasource jdbc/xdms String Required Data source used for communicating with the XDMS database (recommended value: jdbc/xdms)

Cannot be changed dynamically at runtime

The application must be restarted for this setting to take effect

db!default!table resourcelistsacls String Required Database table to use for storing documents (recommended value: resourcelistsacls)

Cannot be changed dynamically at runtime

The application must be restarted for this setting to take effect

enableStandardAuthorization true Boolean Required Enables or disables standard authorization (recommended value: true)

Users with standard authorization have admin permission to their own home directory and read permission to global documents

Can be changed dynamically at runtime

authorizedAuid resource-lists String Required Specifies the AUID that these authorization policy rules represent (Recommended value: resource-lists)

Cannot be changed dynamically at runtime

sipRespondPending false Boolean Required Whether to respond immediately to SIP SUBSCRIBE requests with a 202 status code meaning "accepted but pending" (recommended value: false)

Can be changed dynamically at runtime

sipDefaultExpire 3600 Integer Required Default expire time in seconds if no expire time is specified in the SIP SUBSCRIBE request (recommended value: 3600)

Can be changed dynamically at runtime

sipMinimumExpire -1 Integer Not required Minimum required expire time in seconds that is specified in the SIP SUBSCRIBE request (recommended range: 0-3600)

If not specified or a negative number, the minimum expires policy is disabled

Can be changed dynamically at runtime

sipMaximumExpire -1 Integer Not required Maximum allowed expire time in seconds that is specified in the SIP SUBSCRIBE request (recommended range: 60-86400)

If not specified or a negative number, the maximum expires policy is disabled

Can be changed dynamically at runtime

usageRecordDatasource jdbc/xdmsur String Not required Data source used for communicating with the XDMSUR database that is used to store usage records (recommended value: jdbc/xdmsur)

Cannot be changed dynamically at runtime

The application must be restarted for this setting to take effect

enableXcapPutUsageRecordLogging false Boolean Not required Enables or disables usage record logging for XCAP PUT requests (recommended value: false)

If enabled, the usageRecordDatasource must be configured

Can be changed dynamically at runtime

enableXcapGetUsageRecordLogging false Boolean Not required Enables or disables usage record logging for XCAP GET requests (recommended value: false)

If enabled, the usageRecordDatasource must be configured

Can be changed dynamically at runtime

enableXcapDeleteUsageRecordLogging false Boolean Not required Enables or disables usage record logging for XCAP DELETE requests (recommended value: false)

If enabled, the usageRecordDatasource must be configured

Can be changed dynamically at runtime

enableXcapPostUsageRecordLogging false Boolean Not required Enables or disables usage record logging for XCAP POST requests (recommended value: false)

If enabled, the usageRecordDatasource must be configured

Can be changed dynamically at runtime

enableSipSubscribeUsageRecordLogging false Boolean Not required Enables or disables usage record logging for SIP SUBSCRIBE requests (recommended value: false)

If enabled, the usageRecordDatasource must be configured

Can be changed dynamically at runtime

auditLogByRole super-admin String Not required Comma-separated list of users

If specified, requests and responses are logged only for these users

maxSearchResults 0 Integer Not required Number of search results to return from the query (default value: 0)

If equal to or less than 0, all search results are returned

Can be changed dynamically at runtime

sendUAProfileChangeLog false Boolean Not required Enables change log information within XCAP Diff of a UA Profile event notify.

Example property

enableSchemaValidation=true
enableSchemaValidation.type=java.lang.Boolean
enableSchemaValidation.req=false
enableSchemaValidation.desc=Enables or disables XML schema validation [Recommended value: true].  This property can be dynamically changed at runtime. If this property is removed then schema validation is disabled.



Terms of use
(C) Copyright IBM Corporation 2009. All Rights Reserved.