Business Data Services Properties (bds.properties)

Configure where and how case data is created and managed.

Property Default Value Description
autogenerateDB true Defines how the case data tables for a case data model are created, updated or deleted when that case data model is deployed or undeployed:
  • true: ActiveMatrix BPM automatically creates, updates or deletes the required case data tables when a case data model is deployed or undeployed.
  • false: ActiveMatrix BPM generates SQL scripts to create, update or delete the required case data tables when a case data model is deployed or undeployed. A DBA must subsequently obtain and manually run these scripts.
caseDataStoreTableNameMaxLength 30 Defines the maximum number of characters in a case data table name. Changing this value may have an impact if you decide in future to migrate the case data store to a different database vendor (which may or may not support the maximum length that is specified here).
caseDataStoreColumnNameMaxLength 30 Defines the maximum number of characters in a case data column name. Changing this value may have an impact if you decide in future to migrate the case data store to a different database vendor (which may or may not support the maximum length that is specified here).
caseDataStoreIndexNameMaxLength 30 Defines the maximum number of characters in a case data index name. Changing this value may have an impact if you decide in future to migrate the case data store to a different database vendor (which may or may not support the maximum length that is specified here).
caseModelIdCacheSize 50 Defines the number of Ids (of each specific type) that will be returned in a single operation.
caseModelVersionIdCacheSize 50
caseModelSpecIdCacheSize 50
caseModelPackageSpecIdCacheSize 50
caseModelTableMappingIdCacheSize 50
caseDataStoreIdCacheSize 50
caseModelAuditIdCacheSize 50
checkValidUpgradeChanges true Defines whether ActiveMatrix BPM validates the changes made when an updated global data model is deployed:
  • true. If you attempt to deploy an updated case data model that contains destructive changes as a new minor version, deployment will fail.
  • false. If you attempt to deploy an updated case data model that contains destructive changes as a new minor version, validation will not be performed.
    Note: TIBCO recommend that you do not use this option unless advised to do so by TIBCO Support.

See "Upgrading a Case Data Model" in the TIBCO ActiveMatrix BPM Case Data User Guide.

deleteFolderOnUndeploymentOrCaseObjectDeletion true Defines how case folders are deleted:
  • true: Folders are deleted implicitly by deleteCase or undeploying a model.
  • false: Folders are not deleted implicitly. A call to deleteOrphanedFolders is necessary to delete them.

This property is not added to the file on upgrade; it is added only on install. Therefore, if you want to change the default value of true, you must add the property to the file first.

ensureReadConsistency true Defines whether the operation that reads a case object from the database guarantees consistency. When the value is true, the operation detects if some other operation changes the case object while it is being read, thus causing the result of the read operation to be inconsistent. If the result is inconsistent, the read operation is retried until a consistent result is returned.

Do not modify this value unless advised to do so by TIBCO Support.

pessimisticLockTimeoutMilliseconds 5000 Defines the timeout period for a lock on a case object:
  • 0. No timeout is set. An exception is thrown if BDS cannot get a lock on the requested case object.
  • >0. A timeout is set with the specified number of milliseconds. An exception is thrown if BDS cannot get a lock on the requested case object within this time period.

(This lock is used by User tasks.) Do not modify this value unless advised to do so by TIBCO Support.

readConsistencyRetryLimit 1 Defines the maximum number of times that the operation that reads a case object is retried until a consistent result is returned.

Do not modify this value unless advised to do so by TIBCO Support.

supportTimeZoneInDateTime true Controls time zone support for the "Date Time" data type, when that type is used in a case data model (and case objects created from that model).

If supportTimeZoneInDateTime=true, or if supportTimeZoneInDateTime is not present in the bds.properties file (the default), time zone information is supported. In this case:

  • A "Date Time" value that is written to a case object (for example, from a script or form) can optionally specify a time zone. If the value does not specify a time zone, it is assumed to be in UTC. In either case, the value written to the case object is stored internally (in the case data store) in UTC.
  • A "Date Time" value that is read from a case object is always qualified with the 'Z' suffix to indicate that it is in UTC.

If supportTimeZoneInDateTime=false, time zone support is disabled for the "Date Time" data type. In this case:

  • A "Date Time" value that is written to a case object must not specify a time zone. If the value does specify a time zone, it will be rejected and the case object will not be created or updated.
  • A "Date Time" value that is read from a case object does not include a time zone.

To disable time zone support, add the following entry to the bds.properties file:

   supportTimeZoneInDateTime=false

Note: The supportTimeZoneInDateTime property does not affect the behavior of the "Date Time and Time Zone" data type.
timerInterval 60 Defines the period between internal process housekeeping checks.

Do not modify this value unless advised to do so by TIBCO Support.

useCMISRepository false Defines whether BDS uses a CMS for the case folder feature.