Chapter 6 - SCM Connectors
SCM Connectors are the "bridge" between content found in SCM systems, databases, etc. and the Krugle Enterprise system. SCM Connectors run as individual processes, separate from Krugle Enterprise. They provide a mechanism for Krugle Enterprise to retrieve additions, deletions and modifications to these data sources, as well as "SCM Comments", which are records of changes made to data.
This document provides information about how to create Data Sets using each of the supported SCM Connectors.
To define a Data Set that uses one of these SCM Connectors, make sure that the appropriate SCM Connector has been installed and configured on the Krugle Enterprise server or a host system in your network. If you are using a host system, make sure to open the necessary SCMI port(s) on the firewall for the Krugle Enterprise server. - see the Krugle Enterprise SCMI Integration Guide for complete information.
Supported SCM Connectors
ClearCase
Download the latest version of the ClearCase SCM Connector here.
The ClearCase SCM Connector works with Rational ClearCase 6 and 7, and has support for dynamic UCM.
Note that snapshot views are not yet supported, and the only views which can be accessed are those which are authorized given the Clearcase credentials for the user running the SCM Connector process.
When defining a Data Set using a ClearCase-based Data Repository, these fields have specific meanings.
| Field | Description |
|---|---|
| Location (SCMI Data Set Location) | This field defines the location of the Data Set's content within the Data Repository. The location should be set to the name of the view. |
| Parameter (Params for SCMI Data Set Location) |
This field defines additional URL-encoded parameters that are used when querying the Data Repository for the Data Set's content. The only supported parameter currently is 'vobs'. For example, vobs=project,qa Note that the values for all parameters must be URL-encoded, so any characters which are not 0-9 a-z A-Z ._-* must be encoded. See w3schools.com for more details. The optional 'vobs' parameter should be a comma-separated list of terms. If this parameter is present, only vobtags in the view which contain at least one of the vob strings will be indexed. For example, if the vobtags in this view are /vob/project1 /vob/project2 /vob/documentation /vob/qa, and the parameters field is set to vobs=project,qa then /vob/project1 /vob/project2 and /vob/qa will all be indexed, while /vob/documentation will be omitted because it did not match any of the terms in the 'vobs' parameter list. Note that UCM ClearCase activities may still contain references to vobs otherwise omitted by this method. |
Filesystem
Download the latest version of the Filesystem SCM Connector here.
When defining a Data Set using a Filesystem-based Data Repository, these fields have specific meanings.
| Field | Description |
|---|---|
| Location (SCMI Data Set Location) |
This field defines the location of the Data Set's content within the Data Repository. The location can be one of the following:
|
| Parameter (Params for SCMI Data Set Location) |
Leave this field blank. |
Git
Download the latest version of the Git SCM Connector here.
When defining a Data Set using a Git-based Data Repository, these fields have specific meanings.
| Field | Description |
|---|---|
| Location (SCMI Data Set Location) |
This field defines the location of the Data Set's content within the Data Repository. The location field should be a valid Git URL:
|
| Parameter (Params for SCMI Data Set Location) |
This field defines additional URL-encoded parameters that are used when querying the Data Repository for the Data Set's content. The only supported parameters currently are 'username', 'password', 'branch', and 'auth-file'. For example, username=bob&password=secretpassword1&auth-file=ssh-key&branch=branch1 Note that the values for all parameters must be URL-encoded, so any characters which are not 0-9 a-z A-Z ._-* must be encoded. See w3schools.com for more details. If the 'password' parameter is omitted, a blank one will be used. If you provide an 'auth-file' parameter, this must reference a private key file used by ssh, and the file location (plus optional path) must be relative to the SCMI_HOME directory. If you don't provide an 'auth-file' parameter, but your Git repository's URL uses ssh, then the private key file must be located at /home/$USER/.ssh/id_rsa |
Jira
Download the latest version of the Jira SCM Connector here.
When defining a Data Set using a Jira-based Data Repository, these fields have specific meanings.
| Field | Description |
|---|---|
| Location (SCMI Data Set Location) | This field defines the location of the Data Set's content within the Data Repository. xxx |
| Parameter (Params for SCMI Data Set Location) |
This field defines additional URL-encoded parameters that are used when querying the Data Repository for the Data Set's content. xxx |
RAM (IBM Rational Asset Manager)
Download the latest version of the RAM SCM Connector here.
When defining a Data Set using a RAM-based Data Repository, these fields have specific meanings.
| Field | Description |
|---|---|
| Location (SCMI Data Set Location) | This field defines the location of the Data Set's content within the Data Repository. xxx |
| Parameter (Params for SCMI Data Set Location) |
This field defines additional URL-encoded parameters that are used when querying the Data Repository for the Data Set's content. xxx |
RTC (IBM Rational Team Concert)
Download the latest version of the RTC SCM Connector here.
When defining a Data Set using an RTC-based Data Repository, these fields have specific meanings.
| Field | Description |
|---|---|
| Location (SCMI Data Set Location) | This field defines the location of the Data Set's content within the Data Repository. xxx |
| Parameter (Params for SCMI Data Set Location) |
This field defines additional URL-encoded parameters that are used when querying the Data Repository for the Data Set's content. xxx |
Sharepoint
Download the latest version of the Sharepoint SCM Connector here.
When defining a Data Set using a Sharepoint-based Data Repository, these fields have specific meanings.
| Field | Description |
|---|---|
| Location (SCMI Data Set Location) | This field defines the location of the Data Set's content within the Data Repository. Enter the URL for a SharePoint Site Collection, for example http://192.168.100.122:48582. If you want to crawl the documents from a subsite, the field should contain a valid sub site url, for example http://192.168.100.125/subsite. |
| Parameter (Params for SCMI Data Set Location) |
This field defines additional URL-encoded parameters that are used when querying the Data Repository for the Data Set's content. The only supported parameters currently are 'account', 'password', 'domain', 'listname', 'folder' and 'params-file'. For example, account=account1&password=password1&domain=domain1&listname=List Name&folder=folder. Note that the values for all parameters must be URL-encoded, so any characters which are not 0-9 a-z A-Z ._-* must be encoded. See w3schools.com for more details. You can omit the 'domain' parameter if there is no domain control for the SharePoint Service. You can omit the 'folder' parameter if you want to crawl all files in a SharePoint Site Collection. Otherwise set the 'folder' parameter to the value of "RootFolder" in the browser address bar when you have selected the folder containing the subset of files that you want to crawl. If you don't want to store your parameters in plaintext on Krugle Enterprise, you can use a parameters file. You can pass in a file name by setting the 'params-file' parameter in the parameters field. If you do not provide a 'account' or 'params-file' parameter, the SharePoint SCM Connector will attempt to use values found in the "default-params.properties" file which was included with this SCM Connector. This file must live in the SCMI_HOME directory. See the default-params.properties file for more details. |
SVN (Subversion)
Download the latest version of the SVN SCM Connector here.
When defining a Data Set using an SVN-based Data Repository, these fields have specific meanings.
| Field | Description |
|---|---|
| Location (SCMI Data Set Location) | This field defines the location of the Data Set's content within the Data Repository. Enter the URL for your project's location in the Subversion repository. The URL path should include the the branch or tag you want Krugle to crawl, for example http://svn.apache.org/repos/asf/subversion/tags/1.9.9/ or svn://gcc.gnu.org/svn/gcc/trunk. |
| Parameter (Params for SCMI Data Set Location) |
This field defines additional URL-encoded parameters that are used when querying the Data Repository for the Data Set's content. The only supported parameters currently are 'username', 'password', and 'auth-file'. For example, username=bob&password=secretpassword1, or username=anonymous. Note that the values for all parameters must be URL-encoded, so any characters which are not 0-9 a-z A-Z ._-* must be encoded. See w3schools.com for more details. If the 'password' parameter is omitted, a blank one will be used. If you don't want to store your credentials in plaintext on Krugle Enterprise, you can use an authentication file. You can pass in an file name by setting the 'auth-file' parameter in the parameters field. If you do not provide a 'username' or 'auth-file' parameter, the SVN SCM Connector will attempt to use values found in the "default-authentication.properties" file which was included with this SCM Connector. This file must live in the SCMI_HOME directory. See the default-authentication.properties file for more details. |
Note that the svn+ssh option is untested. If the connection uses SSL, the svn library this SCMI uses (SVNKit) will trust all SSL servers, but not cache certificates. See the SVNKit Config Settings documentation for more details.
TFS (Microsoft Team Foundation Server)
Download the latest version of the TFS SCM Connector here.
Note that this SCM Connector provides access to code and other files stored in TFS; it does not provide access to TFS work items.
When defining a Data Set using a TFS-based Data Repository, these fields have specific meanings.
| Field | Description |
|---|---|
| Location (SCMI Data Set Location) | This field defines the location of the Data Set's content within the Data Repository. xxx |
| Parameter (Params for SCMI Data Set Location) |
This field defines additional URL-encoded parameters that are used when querying the Data Repository for the Data Set's content. xxx |