Application Configuration

This wiki page is about documenting the various settings of general.xml which is the main configuration file for codeBeamer.

The general.xml contains various sections (top level tags), typically each section configures one feature/area of codeBeamer. The sections can contain sub-elements, and each can have several attributes too. This wiki page documents them.

If the attribute has some default value that will be listed here too, like: setup="false" means that the setup attribute has false as default value.

See also: Post-installation Configuration

"installation" section

Configures installation location and the most important installation attributes.

A typical example

<installation cbhome="/home/zluspai/cbhome/cb/"
	remoteURL="http://localhost:8080/cb/remote-api"
	setup="false"
></installation>

Attributes

Internal Attributes

"interactive" section

Configures interactive parts; allow personalization of texts. Personalize the logo and welcome texts appearing on Codebeamer pages.

A typical example

<interactive recentHistoryItems="5" itemsPerPage="25" verboseErrorPage="true" exportTypes="excel">
   <registration-text format="W"></registration-text>
   <slogan-text format="H"></slogan-text>
   <welcome-text format="W"></welcome-text>
   <login-text format="W"></login-text>
   <!-- <logo width="0" height="0" ></logo> -->
   <warnLowDiskSpace enabled="true" minFreeDisk="10240" minPercentage="5"/>
</interactive>

Attributes

"interactive" sub-elements

Interactive section contains few sub-elements which can be used to customize Company logo, login page as described here: Branding: Company Logo, Colors and Texts

The sub elements are look like this, each element can contain a wiki text (if the format="W") which configures the appropriate text appears on codeBeamer pages.

<interactive ...>
  <registration-text format="W"></registration-text>
  <slogan-text format="H"></slogan-text>
  <welcome-text format="W"></welcome-text>
  <login-text format="W"></login-text>
  <!-- <logo width="0" height="0" /> -->
<interactive>

warnLowDiskSpace

User can configure if/when codeBeamer should send email about low disk space to System administrators. For details see: Monitoring, Logging & Profiling

"projectsDir" section

Configures project directory, work directory where projects are built and SCM repositories are stored. That is: ${cbhome}/repository/src directory as default

A typical example

<projectsDir>/home/codebeamer/CB/repository/src directory</projectsDir>

Attributes

None

"officeedit" section

Office-edit can be configured in this section, see: Office Edit for configuration options see: Office Launcher Installation

A typical example

<officeedit enabled="true"/>

Attributes

"breadcrumbs" section

Breadcrumbs configuration: configures how the breadcrumbs of CB look like: how the labels in the breadcrumb shortened see: You must login to see this link. Register now, if you have no user account yet.

A typical example

<breadcrumbs replacementString="~" middle="true"></breadcrumbs>

Attributes

"pagingconfig" section

Paging subconfig: configures how the paging works on few UI elements: the comment and history tabs of items

A typical example

<pagingconfig commentPageSize="20" historyPageSize="20" />

Attributes

"sysadmin" section

Configuration for the default system admin user , see: You must login to see this link. Register now, if you have no user account yet.

A typical example

<sysadmin userName="bond"/>

Attributes

"serviceDesk" section

This contains the Service Desk configuration: Service Desk

A typical example

<serviceDesk title="myTitle" trackerOrder="1,2,3"/>

Attributes

"ie-strict-mode" section

Configures of Internet Explorer can access CB in compatibility mode. See: You must login to see this link. Register now, if you have no user account yet.

A typical example

<ie-strict-mode enabled="false"/>

Attributes

"monitor" section

Configures built in monitoring for CB, see You must login to see this link. Register now, if you have no user account yet.

A typical example

<monitoring enabled="false"

Attributes

"database" section

This part configures database connection. See: Post-installation Configuration

A typical example

<database
	JDBC_Driver="com.mysql.jdbc.Driver"
 	JDBC_ConnectionURL="jdbc:mysql://localhost:3306/codebeamer?autoReconnect=true&zeroDateTimeBehavior=convertToNull&emulateLocators=true&characterEncoding=UTF-8"
	JDBC_Username="cbroot"
	JDBC_Password="..."
/>

Attributes

Attribute	Description
JDBC_Driver	The jdbc driver class name
JDBC_ConnectionURL	The jdbc url points to the database
JDBC_Username	The database user name
JDBC_Password	The password for the db user
JDBC_Default_Statement_Timeout	The timeout of sql statements in seconds.
JDBC_Password_Storage	The type of the storage: external, encrypted, plain. By default plain. Storage types of database password

"database" section sub-elements

Optionally can contain sub-elements JDBC connection properties like:

<props>
   <prop key="defaultRowPrefetch">50</prop>
</props>

Optionally can contain sub-elements for properties for the database provider. Can be used to configure Derby database, see here: You must login to see this link. Register now, if you have no user account yet.

<databaseprovider>
  <props>
	<prop key="jvmArgs">-Xss2048k -Xmx512M</prop>
	<prop key="startupArgs">...something...</prop>
  </props>
</databaseprovider>

"background" section

Configure scheduling of background processes like document indexing (for search).

A typical example

<background hour="1" minute="5" period="86400" inboxPolling="900" />

Attributes

"login" section

Configures login/authentication handling.

A typical example

See general.xml shipped with CB to see a complete example.

<login permission="" logoffURL="/login.spr" registration="" showDenyCause="true" showPresence="true"
		accountLink="" newAccountRole="user" anonymous="" gravatars="false"
		cookiesAllowed="true" forgetCookies="true" displayLastActivityDate="true" sendLostPasswordPerMail="true"
		phoneMandatory="false" companyMandatory="false" postalAddressMandatory="false" passwordPolicy=""
		log-expiration="30" captchaEnabled="false" showRecovery="false" allowToEditEmail="true"
                inviteByEmailTimeoutInDays="1" passwordResetEmailTimeout="PT5M">
		<single-signon user-id-header="x-user-global-id">
...more...
</login>

Attributes

Attribute	Description
registration == ""	mode of registration: "" means Immediate registration, "email" for email registration, "sysadmin" for sysadmin registration, see: Managing Users and User Groups
newAccountType	The new account type: the user License type + ":" + followed by the user-license
newAccountRole= USER	comma separated ids of roles used as default roles for new accounts
permission	name of the permission required to login
logoffURL	The url to forward to after logoff
accountLink	alias name for the users, can use parameters ${id} ${account} ${email} ${lastName} ${firstName} ${company} ${city}
displayLastActivityDate	whether to display accounts' last activity date
anonymous	user name or id for anonymous user
notificationSender	email address of the sender for notification emails
notificationAddress	this email address will also be notified during registration
cookiesAllowed=true	if cookies are allowed for auto-login
forgetCookies=false	should be forgot after logout
recoverablePasswords	Whether passwords should be recoverable this option is mandatory fon SVN managed repositories
passwordPolicy	Regular expression to check the validity of entered passwords, e.g. "^.*(?=.{6,})(?=.*\d)(?=.*[a-z])(?=.*[A-Z])(?=.*[@#$%^&+=]).*$" requires passwords to be at least 6 chars long and to contain at least one lower case letter, one upper case letter, one digit and one special character
log-expiration	User session log entries older than this number of days will be purged from the session history, or 0 to keep log entries forever.
showDenyCause=true	Should in case of failed authentication, the cause be shown (could be used to improve attacks)
gravatars = false	If using the gravatars is enabled.
showPresence = true	If the User interface can show presence information about logged in users.
systemAdminProjectTakeover = false	If system admins can join as project admin to any project.
captchaEnabled = false	If the captcha authenticaion is enabled
phoneMandatory = false	If these fields are mandatory during registration ?
companyMandatory = false
postalAddressMandatory = false
synchronizationHost	The optional hostname of the account synchronization server, see: You must login to see this link. Register now, if you have no user account yet.
showRecovery = false	If the password recovery is enabled, see: You must login to see this link. Register now, if you have no user account yet.
allowToEditEmail = true	If sysadmin can edit email addressed: see: You must login to see this link. Register now, if you have no user account yet.
social-providers-enabled = false	If the login using social providers (Facebook etc...) is enabled. The providers are configured by the "social-provider" sub-element individually.
inviteByEmailTimeoutInDays	It is used to set the timeout in days for email invitation. The default value is 1 day.
passwordResetEmailTimeout	It is used to set the timeout in days or in ISO-8601 duration format PnDTnHnMn.nS for password reset link. The default value is 5 minutes (PT5M). If the value provided is less than the default or is in wrong format, it is ignored and the default will be used.

"login/single-signon" sub-element

The login section can optionally contain a "single-signon" sub-element which can configure Single Signon feature.

An example of this:

<single-signon user-id-header="x-user-global-id">
	<map>
		<header>x-mail</header>
		<property>email</property>
	</map>
</single-signon>

Attributes of "single-signon"

"login/extraNotification" sub-element

Configure extra notification when a user data changes.

If the regexp specified in the phone, country or email attributes matches with the changed user's data the target "notificationAddress" will receive an extra email.

Attributes of "extraNotification"

"login/project" sub-element

Defines defaults projects and roles per project which the registered user will be assigned to.

Attributes of "login/project"

"login/social-provider" sub-element

Defines social provider integration, like Facebook for login/signon

Attributes of "login/social-provider"

"pdfHandler" section

Configure the maximum main memory for pdf handler in bytes.

Typical example

<pdfHandler max-memory="‭104857600‬" />

"audit" section

We can set which events are stored in audit log.

An example:

    <audit>
        <removerjob days="180" />
        <loginlog login="true" logout="true" systemlogout="true" />
        <workitemlog create="true" update="true" remove="true" restore="true" delete="true" />
        <artifactlog create="true" update="true" remove="true" restore="true" delete="true" />
        <permissionlog create="true" update="true" delete="true" />
    </audit>

Attributes of "removerjob" entry:

Attributes of "loginlog" entry:

Attributes of "workitemlog" entry:

Attributes of "artifactlog" entry:

Attributes of "permissionlog" entry:

"hierarchy" section

Rules how field values should be aggregated up/distributed down the issue/item hierarchy

Defines a rule how to aggregate a field value up the a item/issue hierarchy, or how to distribute a field value down the item/issue hierarchy

A typical example

See general.xml for an example.

Attributes

"listeners" section

Defines Listeners for various events in the event system.

An example:

<listeners>
  <listener id="my" class="com.acme.myListener" >
    <init-param param-name="x" param-value="y" />
  </listener>
</listeners>

Attributes of "listener" entries:

The init-param section defines the initialization parameters

"scc" section

Configures source code control modules.

A typical example

See general.xml shipped with CB for a complete example.

<scc text-encoding="Cp1252" htaccess="true" scm-change-set-text-editable="true">
...more..
</scc>

Attributes

Attribute	Description
text_encoding = "Cp1252"	The text encoding used for source files.
task_expression	Regular expression for valid task-ids in SCC commit comments. As default accepts ids like "#1234".
extract_tracker_item_ids_from_commit = true	If tracker-item's ids are extracted from commit comments
scm-change-set-text-editable= true	If the change set information can be edited
loadDiffs = false	whether to load the scm diffs in the changeset lists or not: see: You must login to see this link. Register now, if you have no user account yet.
htaccess = true	If apache .htaccess file is generated. Used only for SVN Repositories.
htaccessEncrypt = "md5"	Encoding logic to store user passwords in Apache .htaccess file
authorizedKeysFile	The location of the authorized_keys file that must be used by SshAuthorizedKeyWriter
cygwinInstallPath = "c: cygwin"	see: You must login to see this link. Register now, if you have no user account yet.
cygwinDriveMountPoint = "/cygdrive"	see: You must login to see this link. Register now, if you have no user account yet.
location	Optional absolute path: All managed repositories must be under this directory
loopUrl	Optional, see: You must login to see this link. Register now, if you have no user account yet.
sshpass-path = "sshpass"	Configure sshpass access, see: See: You must login to see this link. Register now, if you have no user account yet. and Administering Projects
sshpass-option = "-e"	Comma separated command-line options for sshpass

"scc/synergy" sub-element

Configuration options for Synergy.

An example, which configures Synergy start options

<synergy>
  <start option="-nogui -m -q" ></start>
</synergy>

"scc/svn" sub-element

Configures managed SubVersion repositories.

"scc/svn/svnserve" sub-element

Configures managed svnserve service started by Codebeamer.

An example configuration:

<svn export_passwords="true" password_chmod="0600" add_bugtraq="false">
<!--
	If "start" is "true" "svnserve" will be started during CodeBeamer startup.
	If "start" and "stop" are "true" "svnserve" will be stopped during CodeBeamer shutdown.
-->
	<svnserve start="true" stop="true" port="3690">
<!--
				<env key="LANG" value="en_US" />
-->
	</svnserve>
</svn>

An env sub-element can be used to configure environment variables for svnserve process. See above.

"scc/cvs" sub-element

Configures CVS access

Attibutes:

"scc/hg" sub-element

Configures managed Mercurial.

Attibutes:

The

hgserve

sub-section may contain parameter to start Mercurial service "hgserve":

An example:

<scc>...
  <hg mr-pull-url="" mr-push-url="" webconf="">
 	<hgserve start="false" stop="true" port="8000" ></hgserve>
  </hg>
</scc>

"hgserve" attributes

"scc/git" sub-element

Configures managed GIT repositories

The

git/daemon

sub-element configures how the Git daemon is started. An example:

<scc>
   <git mr-pull-url="" mr-push-url="">
 	<daemon start="false" stop="true" port="9418" />
  </git>
</scc>

"git/daemon"'s Attributes:

"date" section

Configures date formats.

This is the default date and time formatting. Every user can configure his own format, thus you should NOT modify this value here.

A typical example

<date datetime="MMM dd HH:mm yyyy" date="MMM dd yyyy" />

Attributes

"mail" section

Configures email: outgoing SMTP server and related attributes.

A typical example

<mail host="#" localname="" serverPort="8080" usePersonal="true" onlyToProjectMembers="false" showProjectNameInSubjects="false">
	<props>
		<prop key="mail.smtp.connectiontimeout">3000</prop>
		<prop key="mail.smtp.timeout">5000</prop>
		<!-- The setting below might help if you have problems with Microsoft Exchange:
			http://www.oracle.com/technetwork/java/faq-135477.html
		<prop key="mail.pop3.disabletop">true</prop>
		<prop key="mail.pop3.forgettopheaders">true</prop>
		-->
	</props>
</mail>

Attributes

Optionally use a props sub-element to define additional sub properties like this:

<mail ...>
 <props>
	<prop key="mail.smtp.connectiontimeout">3000</prop>
	<prop key="mail.smtp.timeout">5000</prop>
 </props>
</mail>

"document" section

Configures document handling/Document Management

A typical example

<document display-plain-text-as-html="false" storage-path="" access-log="true" log-expiration="0" auto_restore_from_trash="30s"/>

Attributes

If you have customized documents directory with "storage-path" application key, please ensure a copy of docs/1 subfolder is still present in cbhome/repository in order to ensure after upgrade the initial directory-check will be passed.

"search" section

Configures searching and indexing

A typical example

See general.xml for an example:

<search delay="90" period="60" incremental-indexing="true" max-indexing-size="standard" pattern-sufix="*" />

Attributes

"search/mime-mapping" sub-element

Configures the handler class for the indexer and the character encoding per mime-type

An example:

<search>
  <mime-mapping class="handler..." mime-type="text/html" character-encoding="UTF-8"/>
  <mime-mapping>...more...</mime-mapping>
</search>

"wiki" section

Configures how the wiki and wysiwyg editor behaves in the system.

A typical example

See general.xml for an example

Attributes

"wiki/styles" and "wiki/interwiki" sub-elements

The wiki element contains some sub-elements allows configuring how some Wiki elements are rendered. See: You must login to see this link. Register now, if you have no user account yet.

"licenses" section

Defines multiple licenses for (clustered) CodeBeamer servers using the same/shared installation.

This may contain several license entries inside: CB tries to load the appropriate one matching with the current host's ID.

Note: typically users should not edit this section, but just copy-paste licenses provided by Intland !

A typical example

<licenses>
	<license hostid="WIN-29-26-ED-D4" code="34932A47089C0922" expire="Dec-31-2008" />
	<license hostid="WIN-1D-48-29-CE" code="2D412757B4846E21" expire="Dec-31-2008" />
</licenses>

Attributes

The license sub-element has these attributes:

"cryptography" section

Configure globally used cryptography key

A typical example

<cryptography key="...."/>

Attributes

"LDAP" section

Configuration for LDAP authentication. Typically configured using the UI, see here: Post-installation Configuration

A typical example

See general.xml for an exmaple

Attributes

  The <server> section defines the connection to the LDAP server.

	- You must provide a valid server hostname/ip-address and port in the "url" attribute, e.g.:
		<server url="ldaps://ldap.intland.com:389" ... ></server>

	- To specify multiple (alternative) servers, use the "urls" attribute and separate servers with commas, e.g.:
			<server urls="ldaps://ldap.intland.com:389, ldaps://ldap.javaforge.com:389" ... ></server>

	- If anonymous access is allowed, you must set attribute "anonymousReadOnly" to "true" and can ommit the attributes "userDn" and "password". E.g.:
		<server url="..." anonymousReadOnly="true" ... ></server>

	- If anonymous access is not possible, you must provide the full distinguished name of an LDAP user to login (userDn) plus the password. E.g.:
		<server url="..." userDn="cn=Manager,dc=intland,dc=com" password="topsecret" ... ></server>

	- You can define custom timeouts (in milliseconds) for establishing connections to the LDAP server (default 10s) and waiting for responses (default 30s), e.g.
		<server url="..." connectTimeout="10000" readTimeout="30000" ... ></server>

	- If codebeamer users are all stored in a single sub-domain of the directory, you can specify the base domain also, e.g.:
		<server url="..." base="dc=intland,dc=com" ... ></server>

	- For an Active-Directory server, you must also set: referral="follow"
		<server url="..." referral="follow" ></server>


	The <mapping> section defines the mapping from LDAP user attributes to codeBeamer account properties:

	- For Active-Directory, the user/account name will be typically stored in attribute "sAMAccountName", e.g.:
		<mapping name="sAMAccountName" ... ></mapping>

	- For other LDAP servers, the user/account name could be stored in "uid", e.g.:
		<mapping name="uid" ... ></mapping>

	Please map the other attributes accordingly. If an attribute is not available, map it to empty, e.g.: title="".
		- The mailSuffix is special, because this is a constant, that will be appended to the fetched email value, e.g.:
				<mapping name="uid" ... mailSuffix="@intland.com" ... ></mapping>

	The <realm> section configures user authentication against the LDAP server.
	       - To enable user authentication against the LDAP server, you must enable the LDAP realm:
			<realm enabled="true" ... ></realm>

	- To enable mixed authentication, first against the LDAP server, next (if necessary) against the CodeBeamer database, enable the "fallback" option:
		<realm enabled="true" fallback="true" ... ></realm>

	Fallback mode also allows to authenticate internal accounts not known to the LDAP server at all.

	- After each successful authentication against the LDAP server, LDAP account information will be synchronized with CodeBeamer account information,
		according to the defined <mapping>. Via the optional "storePassword" attribute, you can define, whether the LDAP password should also be stored in
		CodeBeamer, or not:
			<realm enabled="true" ... storePassword="false" ... ></realm>

	- To authenticate an LDAP user, you must either specify the user's unique Distinguished Name (DN) pattern, where {0} will be replaced by the login name of the user, e.g.:
		<realm ... userPattern="uid={0},ou=people,dc=intland,dc=com" ... ></realm>
			or you have to specify search criteria to find a  single user in a specific directory branch, e.g. to search for a user with 'sAMAccountName={0}' in
		the branch 'ou=people,dc=intland,dc=com' of an Active Directory recursivley, use:
			<realm ... userSearch="sAMAccountName={0}" userBase="ou=people" userSubtree="true" ... ></realm>

		Note: the <realm userBase=...> is relative to <server base=...> (if any)

	        If the <realm> section is not present, or <realm enabled="false" ...> all user authentication will be done against the codeBeamer database.


	The optional <cache> section configures LDAP authentication caching:

		- To enable the authentication cache:
			<cache enabled="true" ... ></cache>

		- You can also specify, how long CodeBeamer remembers successful and failed authentications (in milliseconds):
			<cache enabled="true" successTTL="300000" failureTTL="60000"></cache>

		If the <cache> section is not present, or <cache enabled="false" ...> no authentication caching will occur.

"jvm" section

Configure who and how often gets a notification email if Codebeamer's memory grows too high

A typical example

<jvm recipients="admins@intland.com" />

Attributes

"CTI" section

Configures Computer Telephone Integration (CTI)

A typical example

<CTI enabled="false" defaultTrackerId="0" country="DE"/>

Attributes

"reports" section

Configures limits for Vintage Reports, e.g. the max. number of rows that can be exported

A typical example

<reports export="5000"></reports>

Attributes

"traceability" section

Traceability Browser default configuration, see: Traceability Browser

A typical example

<traceability maxFirstLevelElements="25000" maxAdditionalLevelElements="25000" maxFirstLevelElementsPerItem="500" maxAdditionalLevelElementsPerItem="200" pageSize="50" ignoreRedundantsInBrowser="true" ignoreRedundantsInTab="true"/>

Attributes

"review" section

Configuration for Reviews

Attributes

Attribute	Description
hideTrackerItemReview= true	hides the original (workflow transition based) tracker item review from codebeamer: see:Start a new review

"IPFilters" section

Configures IP filters, see: You must login to see this link. Register now, if you have no user account yet.

A typical example

<IPFilters>
   <IPFilter name="global">Allow from 10.1.2.3</IPFilter>
  <IPFilter name="source_view">Allow from 10.1.2.3</IPFilter>
</IPFilters>

Attributes

IPFilters attributes:

To add filter (global and/or source view) use the simple Allow/Deny rules as described in Apache's mod_authz_host configuration.

An example configuration:

# name="global" IP addresses filtered out in the global filter will not be able to see any codeBeamer pages.
# name="source_view" IP addresses filtered out here will not be able to see full-length of the source-code files, only partial diffs.
<IPFilters>
   <IPFilter name="global">Allow from 10.1.2.3</IPFilter>
   <IPFilter name="source_view">Allow from 10.1.2.3</IPFilter>
</IPFilters>

"testManagement" section

Configures TestManagement

A typical example

see general.xml for an example

Attributes

"graphviz" section

Graphviz configuration: configures fonts.

An example:

  <graphviz graphvizBoldFont="Sans Bold"	graphvizFont="Sans" />

"slack" section

ChatOps / Slack integration configuration, see: codebeamer Integration with Slack

Attributes

"GeoIP" section

Configure GeoIP service: how the IP address of a new registered user is translated to country/geo-location

A typical example

<geoIP requestUrl="http://geoip1.maxmind.com/f?l=...."/>

Attributes

"projectImport" section

Project-import configuration

A typical example

<projectImport showConfirmDialogFileSizeLimit="5" />

Attributes

"uploads" section

Configures which kind of files can be uploaded to codeBeamer.

For details see: Configuring which files can be uploaded to codeBeamer

A typical example

<uploads>
	<filter orderAllowDeny="false">
		<!-- deny SVG and HTML files -->
		<!-- you could use denyMimeRegexp too -->
		<denyMime>image/svg+xml</denyMime>
		<denyMime>text/html</denyMime>
		<allowMimeRegexp>.*</allowMimeRegexp>
	</filter>
</uploads>

Attributes

See documentation link above

"metadatas" section

See: Entity Metadata

Document/Directory custom attribute definitions in display order.

A typical example

<metadatas>
	<metadata object="1" key="sapDocNo"  displayName="SAP Document Number"  type="text" />
	<metadata object="1" key="sapDocRev" displayName="SAP Document Version" type="int" />
</metadatas>

Attributes

"trash" section

Configures project trash behaviour. In earlier versions it was not allowed to delete work items permanently from trash. Staring from version 9.1.0, it is configurable (not allowed by default). If you delete items from the trash then it may have effect on baselines.

A typical example

<trash possibleToDeleteOnlyItems="true"></trash>

Attributes

"cbSystemProperties" section

Use <props> sub-element to set JVM system properties.

A typical example

<cbSystemProperties>
	<props>
		<prop key="svnkit.http.methods">Basic,Digest,Negotiate,NTLM</prop>
        </props>
</cbSystemProperties>

Properties

"websocket" section

Websocket configuration (enable/disable).

A typical example

<websocket enabled="true"></websocket>

Properties

Application configuration (JSON)

Print users' name

You can configure user name printing in "login" section with "accountLink" attribute.

"login": {
  "accountLink" : "${property1} ${property2}...",
  ...
}

Common example

"login": {
  "accountLink" : "${firstName} ${lastName}",
  ...
}

The property inside ${} will be replaced with the value of the property and the formatting will be kept.

i.e:

"login": {
  "accountLink" : "${firstName} ${lastName}",
  ...
}

prints Soma Györe

"login": {
  "accountLink" : "${firstName}, ${lastName}",
  ...
}

prints Soma, Györe

Available properties

• firstName
• lastName
• email
• company

Rendering the tracker item key and id

You can configure tracker item key and id label rendering in "interactive" section with "itemKeyAndIdTemplate" attribute.

"interactive" : {
  "itemKeyAndIdTemplate" : "${property1} ${property2}...",
  ...
}

Common example

"interactive" : {
  "itemKeyAndIdTemplate" : "${masterKey}:${masterId}",
  ...
}

It will print the key and id in the following format: [BUG:123456]

Example with branching

"interactive" : {
  "itemKeyAndIdTemplate" : "{branchId}--${masterKey}:${masterId}",
  ...
}

It will print the key and id in the following format: [5566341--TASK:2085478]

Available properties

• masterId: if the item is a branch item then this is the ID of the respective item on the Master branch otherwise the ID of the item itself
• masterKey: if the item is a branch item then this is the key of the Master branch otherwise the key of the tracker itself
• id: the ID of the item
• key: the key of the tracker of the item
• branchId: the ID of the branch (if the item is a branch item)
• branchKey: the key of the branch (if the item is a branch item)

Search indexing configuration

You can configure search indexing in "search" section.

Common example

"search" : {
  "delay" : 9000,
  "fuzzy-similarity-factor" : 0.6,
  "incremental-indexing" : true,
  "length" : 2,
  "lucene-cfs-ratio" : 0.1,
  "matches" : 1000,
  "max-clause-count" : 26000,
  "max-fuzzy-terms" : 10,
  "max-indexing-size" : "standard",
  "operator" : "and",
  "pattern-sufix" : "*",
  "period" : 6000,
  "short-word-length" : 3
}

Available properties

• analyzer: Customized search analyzer implementation class name
• max-indexing-size: The maximum size of the document to index. Use "10k" pattern for kilobytes, "xM" for megabytes
• operator: Search operator to use as default. This defaults to "and"
• commit-indexing-block: Integer defines the maximum number of SCM commits to index at once. Negative value disables indexing of commits
• incremental-indexing: If the incremental indexing is enabled
• length: Integer Minimum length of search expression required
• matches: Integer Maximum number of search results matched
• pattern-sufix: This text is always added to the end of search expression. Defaults to "*"
• max-clause-count: Integer, maximum number of search clauses in search expression
• symbolTypes: Comma separated symbol types to search for. Default: 'cl','md','mi','fd','fi','ma','ty'
• period: Integer Indexing should run that often in seconds
• delay: Integer delay before indexing starts in seconds
• fuzzy-similarity-factor: The minimum similarity of the term variants
• lucene-cfs-ratio: If a merged segment will be more than this percentage of the total size of the index, leave the segment as non-compound file even if compound file is enabled. Set to 1.0 to always use CFS regardless of merge
• max-fuzzy-terms: The total number of terms clauses that will appear once
• operator: Default operator ('and' or 'or')
• period: The frequency the search should run in seconds
• short-word-length: Length of required common prefix on variant terms