PhpStorm 2016.3 Help

Meet PhpStormTime Tracking

Servers

File | Settings | Tools | Tasks | Servers for Windows and Linux
PhpStorm | Preferences | Tools | Tasks | Servers for OS X
Ctrl+Alt+S
/help/img/idea/2016.3/settings.png

Use this page to associate your account in the bug tracking system you use with the PhpStorm project. The page is divided into the following sections:

Configured servers

ItemShortcutDescription
/help/img/idea/2016.3/add.pngAlt+InsertClick to add a new server of one of the supported types. For example:

Click /help/img/idea/2016.3/add.png to explore the list of the supported servers.

/help/img/idea/2016.3/delete.pngAlt+DeleteClick to remove the selected server.

Server options

General tab

ItemAvailable forDescription
Share URLAll serversIf this check box is selected, the server URL of your issue tracking system, specified in the field below becomes available to the other team members.
Server URLAll serversSpecify here the server URL of your issue tracking system.
Username / PasswordAll except for Lighthouse, Trello, GitLab, GitHubSpecify here login name and password for your account.
RepositoryGitHubSpecify here the name of the desired Git repository.
SearchYouTrackSpecify here the default search string.
Project IDLighthouse, Pivotal Tracker, RedmineSpecify here the name of your project in the tracker.
API TokenLighthouse, Pivotal TrackerSpecify here the desired API token for the project in question.
Use proxyAll serversSelect this check box to use the specified proxy server.
Proxy settingsAll serversClick this button to set up proxy settings.
Use HTTP authenticationJIRASelect this check box to enable HTTP authentication.
TestAll serversClick this button to make sure the connection is established.
<Template variables>More fields may be added to this tab depending upon the selected or cleared check box Show on first tab in the Template Variables dialog in the Server Configuration tab.

Commit Message tab

ItemDescription
Add commit messageIf this check box is selected, a commit message for a changelist, created from an issue in a bug tracking system, is formed according to the syntax defined below.
MessageUse the placeholders to define the commit message syntax. The available placeholders are {id}, {summary}, {number}, {project}.

Server Configuration tab

This tab only shows for the following servers:

ItemDescription
Login URLSpecify here the resource for authentication (if any). The request to this resource will take place every time the issues are retrieved from server.

This field is disabled, if the check box Use HTTP authentication in the General tab is selected.

The resource consists of a URL with possible template variables:

  • {serverUrl}: URL of the server, specified in the General tab.
  • {password}, {username}: correspond to the settings specified in the General tab.
  • {max}: maximum number of issues to be retrieved from the server.

Also it contains the combo-box with the request type: GET or POST.

Tasks list URLThis resource enables obtaining the list of issues from the server and is requested every time the user opens tasks.

The resource consists of a URL with possible template variables:

  • {serverUrl}: URL of the server, specified in the General tab.
  • {password}, {username}: correspond to the settings specified in the General tab.
  • {max}: maximum number of issues to be retrieved from the server.

Also it contains the combo-box with the request type: GET or POST.

Single task URLThis resource makes it possible to obtain a more detailed information about a specific issue, using its ID.

This field is mandatory, when the check box Each task in separate request is selected.

The resource consists of a URL with possible template variables:

  • {serverUrl}: URL of the server, specified in the General tab.
  • {password}, {username}: correspond to the settings specified in the General tab.
  • {max}: maximum number of issues to be retrieved from the server.

Also it contains the combo-box with the request type: GET or POST.

Response typeThis section contains three radio buttons:
  • XML: click this radio button to return the server response in XML format. So doing, the selectors are described in the format XPath.
  • JSON: click this radio button to return the server response in JSON format. So doing, the selectors are described in the format JSONPath.
  • Text: click this radio button to retrieve issues fields using regular expressions.
Each task in separate requestSelect this check box to make the field Single task URL mandatory.
Table of selectorsThese selectors help specifying how exactly the detailed issue information will be extracted from the server response.

The selectors have the following meanings:

  • tasks: path in the server response to the descriptions of specific issues (mandatory selector).
  • id: path to the unique ID within the description of a specific issue (mandatory selector).
  • summary: path to the title/header of an issue inside its description (mandatory selector).
  • description: path to the detailed description of an issue (optional selector).
  • updated/created: path to the time of updating or creating the issue respectively, in the format ISO-8601, inside its description (optional selector).
  • closed: path to a flag that defines whether a specific issue is opened or closed (optional selector).
  • issueUrl: path to a URL inside the issue description. It is possible to open information about this issue in your browser.

Depending on the choice of response type, these selectors are described in XPath or JSONPath format, or as regular expressions.

Reset to DefaultsClick this button to discard all settings and return to the default values.
Manage Template Variables...Click this button to show the dialog box Template Variables with the list of existing template variables. Use /help/img/idea/2016.3/new.png and /help/img/idea/2016.3/delete.png buttons to manage the list.

Note the check boxes in the columns Show on first tab and Hide.

  • If a check box in the column Show on first tab next to a custom template variable is selected, this custom variable is displayed in the General tab.
  • If a check box in the column Hide next to a custom template variable is selected, the value of this variable is shown dots. Otherwise, it is shown as is.

Note that default variables cannot be deleted or changed!

TestClick this button to make sure the settings are correct.
Meet PhpStormTime Tracking

See Also

Procedures:

External Links:

Tutorials and Examples:

Last modified: 23 March 2017