Connection Test Tools - techtalk/SpecLog-Resources GitHub Wiki

When installing the SpecLog server, two command line tools are installed that you can use to test your connection to TFS and JIRA. These tools are located in the \Server\Plugins directory of your SpecLog installation (by default, c:\Program Files (x86)\TechTalk\SpecLog\Server\Plugins):

  • SpecLog.TfsPlugin.Console.exe or SpecLog.TfsPlugin.TestClient.exe*: Tests your TFS connection
    *As of version 1.18, SpecLog.TfsPlugin.TestClient.exe has been replaced by SpecLog.TfsPlugin.Console.exe.
  • SpecLog.JiraPluginV2.TestClient.exe: Test your JIRA connection

The TFS connection tool outputs a log file called TFS.log, provided the user running the tool has write access to the directory. As the default location is in Program Files (x86), this means that you need to start a command prompt with administrator privileges or move the tool to a directory where you have write access to generate the log file.

Parameters

To display help on the command line tool, run the corresponding tool from the command line using the help option, e.g. (for the TFS tool):
>SpecLog.TfsPlugin.Console.exe help

TFS

Testing Your Connection

Use SpecLog.TfsPlugin.Console.exe testconnection or SpecLog.TfsPlugin.TestClient.exe (legacy) to test your connection to TFS. The following parameters are supported:

  • <tfsURL> (required): The URL of your TFS server, e.g. https://tfs.location/tfs
  • /userName:<user>: The name of the user to test the connection with. If not specified, the current Windows user is used.
  • /userDomain:<domain>: The user's domain.
  • /password:<password>: The user's password.

Example: SpecLog.TfsPlugin.Console.exe https://MyTFS.location/tfs /username:John /userDomain:DOMAIN /password:P@55w0rD1234

JIRA Test Parameters

SpecLog.JiraPluginV2.TestClient.exe supports the following parameters:

  • <jiraURL> (required): The URL of your JIRA server, e.g. https://MySite.atlassian.net
  • <projectCode> (required): The JIRA project's code.
  • <userName> (required): The name of the user to test the connection with.
  • <password> (required): The user's password.
  • /issueType:<issue>: The name of the issue type in JIRA that SpecLog entries are synchronised with. The default value is UserStory.

Example: SpecLog.JiraPluginV2.TestClient.exe https://MySite.tlassian.net MyCode John P@55w0rD1234

⚠️ **GitHub.com Fallback** ⚠️