You are not logged in. Click here to log in.

codeBeamer ALM

Search In Project

Search inClear

Tags:  not added yet

This wiki page is about documenting the various settings of the Application configuration.

You can reach Application configuration in System Admin --> Application configuration.

Application configuration 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.


"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
}

"interactive" section

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

A typical example

"interactive" : {
  "exportTypes" : "excel",
  "itemsPerPage" : 25,
  "recentHistoryItems" : 5,
  "verboseErrorPage" : true,
  "registration-text" : {
    "format" : "W"
  },
  "slogan-text" : {
    "format" : "H"
  },
  "welcome-text" : {
    "format" : "W"
  },
  "login-text" : {
    "format" : "W"
  },
  "warnLowDiskSpace" : {
    "enabled" : true,
    "minFreeDisk" : 10240,
    "minPercentage" : 5
  }
}

"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" : {
  "text" : "/home/codebeamer/CB/repository/src directory"
}

"officeedit" section

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

A typical example

"officeedit" : {
  "enabled" : true
}

"breadcrumbs" section

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

A typical example

"breadcrumbs": {
  "middle" : true,
  "replacementString" : "~"
}

"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
}

"sysadmin" section

(deprecated)


"serviceDesk" section

This contains the Service Desk configuration: Service Desk

A typical example

"serviceDesk" : {
  "trackerOrder" : "1,2,3",
  "title" : {
    "text" : "myTitle"
  }
}

"ie-strict-mode" section

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

A typical example

"ie-strict-mode" : {
  "enabled" : true
}

CB:/images/space.gif

"monitor" section

Configures built in monitoring for CB.

A typical example

"monitor" : {
  "mbeanEnabled" : true
}

"database" section

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

A typical example

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

"background" section

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

A typical example

"background" : {
  "hour" : 1,
  "inboxPolling" : 900,
  "minute" : 5,
  "period" : 86400
}

"login" section

Configures login/authentication handling.

A typical example

"login": {
  "accountLink" : "",
  "allowToEditEmail" : true,
  "anonymous" : "",
  "captchaEnabled" : false,
  "companyMandatory" : false,
  "cookiesAllowed" : true,
  "displayLastActivityDate" : true,
  "forgetCookies" : true,
  "gravatars" : false,
  "log-expiration" : 30,
  "logoffURL" : "/login.spr",
  "newAccountRole" : "user",
  "passwordPolicy" : "",
  "permission" : "",
  "phoneMandatory" : false,
  "postalAddressMandatory" : false,
  "registration" : "",
  "sendLostPasswordPerMail" : true,
  "showDenyCause" : true,
  "showPresence" : true,
  "showRecovery" : false,
  "single-signon" : {
    "user-id-header" : "x-user-global-id"
  }
}

"pdfHandler" section

Configure the maximum main memory for pdf handler in bytes.

A typical example

"pdfHandler" : {
    "max-memory" : ‭104857600‬
  }

"audit" section

We can set which events are stored in audit log.

A typical example

"audit": {
  "removerjob" : {
    "days" : 180
  },
  "loginlog" : {
    "login" : true,
    "logout" : true,
    "systemlogout" : true
  },
  "workitemlog" : {
    "create" : true,
    "delete" : true,
    "remove" : true,
    "restore" : true,
    "update" : true
  },
  "artifactlog" : {
    "create" : true,
    "delete" : true,
    "remove" : true,
    "restore" : true,
    "update" : true
  },
  "permissionlog" : {
    "create" : true,
    "delete" : true,
    "update" : true
  }
}

"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

  "hierarchy" : {
    "rule" : [ {
      "class" : "com.intland.codebeamer.manager.hierarchy.MinimumRule",
      "desc" : "Set parent value to smallest child value",
      "id" : 1,
      "name" : "Minimum"
    }, {
      "class" : "com.intland.codebeamer.manager.hierarchy.MaximumRule",
      "desc" : "Set parent value to largest child value",
      "id" : 2,
      "name" : "Maximum"
    }, {
      "class" : "com.intland.codebeamer.manager.hierarchy.SummationRule",
      "desc" : "Set parent value to sum/total of child values",
      "id" : 3,
      "name" : "Sum/Total"
    }, {
      "class" : "com.intland.codebeamer.manager.hierarchy.AverageRule",
      "desc" : "Set parent value to average of child values",
      "id" : 4,
      "name" : "Average"
    }, {
      "class" : "com.intland.codebeamer.manager.hierarchy.UnionRule",
      "desc" : "Set parent value to the union of child values",
      "id" : 5,
      "name" : "Union"
    }, {
      "class" : "com.intland.codebeamer.manager.hierarchy.IntersectionRule",
      "desc" : "Set parent value to the intersection of child values",
      "id" : 6,
      "name" : "Intersection"
    }, {
      "class" : "com.intland.codebeamer.manager.hierarchy.DistributionRule",
      "desc" : "Set child value to parent value",
      "id" : 7,
      "name" : "Set"
    }, {
      "class" : "com.intland.codebeamer.manager.hierarchy.DefaultRule",
      "desc" : "Use parent value as default child value",
      "id" : 8,
      "name" : "Default"
    }, {
      "class" : "com.intland.codebeamer.manager.hierarchy.LeastRule",
      "desc" : "Set child value to least of parent/child value",
      "id" : 9,
      "name" : "Least"
    }, {
      "class" : "com.intland.codebeamer.manager.hierarchy.GreatestRule",
      "desc" : "Set child value to greatest of parent/child value",
      "id" : 10,
      "name" : "Greatest"
    }, {
      "class" : "com.intland.codebeamer.manager.hierarchy.FractionRule",
      "desc" : "Set child value to fraction of parent value",
      "id" : 11,
      "name" : "Fraction"
    }, {
      "class" : "com.intland.codebeamer.manager.hierarchy.RetainRule",
      "desc" : "Retain only child values that are also parent values",
      "id" : 12,
      "name" : "Subset"
    }, {
      "class" : "com.intland.codebeamer.manager.hierarchy.MergeRule",
      "desc" : "Add missing parent values to child values",
      "id" : 13,
      "name" : "Superset"
    }, {
      "class" : "com.intland.codebeamer.manager.hierarchy.MeanStatusRule",
      "desc" : "Set parent status to mean children status",
      "id" : 14,
      "name" : "Mean status"
    }, {
      "class" : "com.intland.codebeamer.manager.hierarchy.CloseChildrenOnParentCloseRule",
      "desc" : "On parent close, close children recursively",
      "id" : 15,
      "name" : "Close recursively"
    }, {
      "class" : "com.intland.codebeamer.manager.hierarchy.CloseOnlyIfAllChildrenClosedRule",
      "desc" : "On parent close, all children must be closed",
      "id" : 16,
      "name" : "Close restricted"
    }, {
      "class" : "com.intland.codebeamer.manager.hierarchy.CloseParentAfterLastChildCloseRule",
      "desc" : "Close parent after closing last child",
      "id" : 17,
      "name" : "Close upwards"
    } ]
  }

CB:/images/space.gif

"listeners" section

(deprecated)

"scc" section


Configures source code control modules.

A typical example

  "scc" : {
    "hg" : {
      "mr-pull-url" : "http://localhost:8080/cb/hg/,ssh://soma@localhost/hg/,http://localhost:8000/",
      "mr-push-url" : "http://localhost:8080/cb/hg/,ssh://soma@localhost/hg/",
      "webconf" : "scmweb/hgweb.config",
      "hgserve" : {
        "port" : 8000,
        "start" : true,
        "stop" : true
      }
    },
    "git" : {
      "http-backend" : "/usr/lib/git-core/git-http-backend",
      "mr-pull-url" : "http://localhost:8080/cb/git/,ssh://soma@localhost/git/,git://localhost/",
      "mr-push-url" : "http://localhost:8080/cb/git/,ssh://soma@localhost/git/",
      "use-git-auth-script" : true,
      "daemon" : {
        "port" : 9418,
        "start" : true,
        "stop" : true
      }
    },
    "svn" : {
      "mr-access-url" : "svn://localhost/",
      "svnserve_start" : false,
      "svnserve" : {
        "start" : false
      }
    }
  }

"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.

Timezone: Sets time zone code default for dates like "Europe/London". See the full list on create/update user form Time zone droplist.

A typical example

"date" : {
  "date" : "MMM dd yyyy",
  "datetime" : "MMM dd HH:mm yyyy"
  "timezone": "Europe/London"
}

"mail" section

Configures email: outgoing SMTP server and related attributes.

A typical example

  "mail" : {
    "background" : true,
    "checkConnection" : false,
    "host" : "YOURHOST",
    "localname" : "localhost",
    "onlyToProjectMembers" : false,
    "password" : "YOURPASSWORD",
    "recipientsLimit" : -1,
    "serverPort" : 8080,
    "serverScheme" : "http",
    "showProjectNameInSubjects" : false,
    "smtp-port" : 587,
    "ssl" : false,
    "startTLS" : true,
    "usePersonal" : true,
    "user" : "YOURUSER",
    "props" : {
      "prop" : {
        "key" : "mail.smtp.starttls.enable",
        "text" : "true"
      }
    }
  }

"document" section

Configures document handling/Document Management

A typical example

"document": {
  "access-log" : true,
  "auto_restore_from_trash" : "30s",
  "display-plain-text-as-html" : false,
  "log-expiration" : 0,
  "storage-path" : ""
}

storage-path can be a path on the local hard drive.

"search" section

Configures searching and indexing

A typical example

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

"wiki" section

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

A typical example

{
  "defaultMode" : "wysiwyg",
  "jsCompressingMode" : "none",
  "styles" : {
    "style" : [ {
      "name" : "commentbox",
      "text" : "float: right; width: 20%; border: 2px solid #E5E5E5; background: #F5F5F5; font-size: 7pt; padding: 4px; margin-left: 4px;"
    }, {
      "name" : "blue",
      "text" : "color: blue;"
    }, {
      "name" : "cyan",
      "text" : "color: cyan;"
    }, {
      "name" : "gray",
      "text" : "color: gray;"
    }, {
      "name" : "green",
      "text" : "color: green;"
    }, {
      "name" : "magenta",
      "text" : "color: magenta;"
    }, {
      "name" : "orange",
      "text" : "color: orange;"
    }, {
      "name" : "pink",
      "text" : "color: pink;"
    }, {
      "name" : "red",
      "text" : "color: red;"
    }, {
      "name" : "yellow",
      "text" : "color: yellow;"
    } ]
  }
}

"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

{
  "license" : [ {
    "code" : "34932A47089C0922",
    "expire" : "Dec-31-2008",
    "hostid" : "WIN-29-26-ED-D4"
  }, {
    "code" : "2D412757B4846E21",
    "expire" : "Dec-31-2008",
    "hostid" : "WIN-1D-48-29-CE"
  } ]
}

"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

"LDAP": {
  "server" : {
    "anonymousReadOnly" : false,
    "base" : "",
    "password" : "",
    "referral" : "follow",
    "url" : "ldap://your-ldap-server:389",
    "userDn" : ""
  },
  "mapping" : {
    "address" : "streetAddress",
    "city" : "L",
    "company" : "company",
    "country" : "c",
    "email" : "mail",
    "firstName" : "givenName",
    "lastName" : "sn",
    "mailSuffix" : "",
    "mobile" : "mobile",
    "name" : "sAMAccountName",
    "password" : "",
    "phone" : "telephoneNumber",
    "state" : "st",
    "status" : "",
    "timeZonePattern" : "tz",
    "title" : "",
    "zip" : "postalCode"
  },
  "realm" : {
    "enabled" : false,
    "fallback" : true,
    "storePassword" : true,
    "userBase" : "",
    "userPattern" : "",
    "userSearch" : "sAMAccountName={0}",
    "userSubtree" : true
  },
  "cache" : {
    "enabled" : true,
    "failureTTL" : 60000,
    "successTTL" : 300000
  }
}

"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"
}

"CTI" section

(deprecated)

"reports" section

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

A typical example

"reports": {
  "export" : 5000
}

"traceability" section

Traceability Browser default configuration, see: Traceability Browser

A typical example

"traceability": {
  "ignoreRedundantsInBrowser" : true,
  "ignoreRedundantsInTab" : true,
  "maxAdditionalLevelElements" : 25000,
  "maxAdditionalLevelElementsPerItem" : 200,
  "maxFirstLevelElements" : 25000,
  "maxFirstLevelElementsPerItem" : 500,
  "pageSize" : 50
}

"review" section

Configuration for Reviews

A typical example

 "review" : {
   "hideTrackerItemReview" : true
 }

"IPFilters" section

Configures IP filters, see: CB:/images/issuetypes/task.gifYou must login to see this link. Register now, if you have no user account yet.

A typical example

"IPFilters": {
  "IPFilter" : [ {
    "name" : "global",
    "text" : "Allow from 10.1.2.3"
  }, {
    "name" : "source_view",
    "text" : "Allow from 10.1.2.3"
  } ]
}

"testManagement" section

Configures TestManagement

A typical example

"testManagement": {
  "allowTiming" : true,
  "autoCopyExpectedResults" : true,
  "createTestRunForEachTestCase" : false,
  "forceCopyOnReRun" : true,
  "includeTestsRecursively" : false,
  "rerunClearsResults" : true,
  "runOnlyAcceptedTestCases" : true,
  "stopTimerWhileRepotingBug" : false,
  "testRunnerShowsBlock" : true,
  "testRunnerShowsEndRun" : true,
  "testSetAllowDuplicates" : false
}

"graphviz" section

(deprecated)

"slack" section

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

A typical example

"slack": {
  "enabled" : true,
  "slackWorkspaceConfig" : {
    "botOauthToken" : "xoxb-293664950436-nt431xjdRPi0yNXTn5FUfLEl",
    "clientId" : 2.9467519112729364E11,
    "clientSecret" : "6552958917b339ca9f827b241752487f",
    "notificationsEnabled" : true,
    "slackWorkspaceName" : "MTS",
    "slackWorkspaceUrl" : "https://team-mts.slack.com",
    "teamId" : "T8NKV5M3R",
    "verificationToken" : "JfiBw7Pc1cHaROjYHyVbykE7",
    "notificationChannel" : {
      "text" : "notifications"
    }
  }
}

"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=...."
}[https://codebeamer.com/cb/images/space.gif]

"projectImport" section

Project-import configuration

A typical example

"projectImport": {
  "showConfirmDialogFileSizeLimit" : 5
}

"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,
    "denyMime" : [ {
      "text" : "image/svg+xml"
    }, {
      "text" : "text/html"
    } ],
    "allowMimeRegexp" : {
      "text" : ".*"
    }
  }
}

"metadatas" section

See: Entity Metadata

Document/Directory custom attribute definitions in display order.

A typical example

 "metadatas": {
  "metadata" : [ {
    "displayName" : "SAP Document Number",
    "key" : "sapDocNo",
    "object" : 1,
    "type" : "text"
  }, {
    "displayName" : "SAP Document Version",
    "key" : "sapDocRev",
    "object" : 1,
    "type" : "int"
  } ]
}

"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
}

"cbSystemProperties" section

Set JVM system properties.

A typical example

"cbSystemProperties": {
  "props" : {
    "prop" : {
      "key" : "svnkit.http.methods",
      "text" : "Basic,Digest,Negotiate,NTLM"
    }
  }
}

CB:/images/space.gif

"websocket" section

(deprecated)