Case Folder Configuration

Some of the configuration for case folders occurs in the TIBCO Configuration Tool (TCT) during installation of ActiveMatrix BPM, and some is available using configuration files.

The following table describes the configuration properties available for case folder functionality, as well as where each property is configurable.

For information about the location of the configuration files, see the Configuration File Location section below the table.

Property Configured In Description
useCMISRepository TCT

bds.properties

Enables the Document Service used for case folders. This property must be set to true to use any of the Document Service API calls. It also enables calling of the Document Service by core BDS (Business Data Services). If set to true, case folders are automatically created upon deployment.

Default = false

deleteFolderOnUndeploymentOrCaseObjectDeletion bds.properties If true, folders for a particular case are automatically deleted when the case is deleted, as well as when a model is undeployed. If this property is set to false, folders must be deleted using the deleteOrphanedFolders API call.

Default = true

Note: This parameter is added to the bds.properties file only during installation; it is not added during an upgrade. Therefore, if you have upgraded your software, and this parameter is not in the bds.properties file, you must manually add it if you want to change the value.
repoConnectionURL TCT

cm.properties

The URL used to connect to the CMS. This must be in the form:

http://CMSMachine:Port/cmsPath

where:
  • CMSMachine is the machine on which the CMS is running.
  • Port is the port using by the CMS.
  • cmsPath is the connection path used by your CMS.

For example:

http://localhost:9080/alfresco/api/-default-/public/cmis/versions/1.0/atom

repoBindingType TCT

cm.properties

The binding type used by the CMS.

Currently, this must be set to "atompub".

repoID TCT

cm.properties

The repository ID used by the CMS.
repoRootFolderPath TCT

cm.properties

The folder under which all sub-folders will be created in the CMS. You must ensure that this folder exists. Unlike the folders beneath it, this folder is not created on demand.
repoConnectionTimeout cm.properties The number of milliseconds in which a timeout will occur if a connection cannot be made with the CMS. This value can be increased if a "connection timed out" message appears in the BPM.log.

Default = 10000

repoReadTimeout cm.properties The number of milliseconds in which a timeout will occur if a read operation cannot be completed. This value can be increased if a "read timed out" message appears in the BPM.log.

Default = 60000

trustStoreLocation TCT

cm.properties

The TrustStore file used when connecting to an HTTPS-enabled CMS. This is needed only if using HTTPS-based communications.
trustStoreType TCT

cm.properties

The TrustStore type. For example, JCEKS, JKS, etc. This is needed only if using HTTPS-based communications.
monitor.enable cm.properties Specifies whether or not the ActiveMatrix server will automatically detect and load changes made to this file at runtime.

This should normally be set to true.

CMS Administrative username and password TCT These values are stored in the Keystore for security purposes. They are configurable only via TCT.

Configuration File Location

Both the bds.properties and cm.properties files are located in the following directory on the machine in which ActiveMatrix BPM is installed:

CONFIG_HOME/bpm/bpm_app_name/configuration

where:
  • CONFIG_HOME is the root directory for ActiveMatrix BPM runtime files. This can be specified during installation.

    On Windows systems, this defaults to:

    C:\ProgramData\amx-bpm\tibco\data

    On UNIX systems, this defaults to:

    /opt/tibco/data

  • bpm_app_name is the name of the ActiveMatrix BPM application, which can be specified during installation.

    This defaults to:

    amx.bpm.app